npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@amedia/gaia-client

v7.1.2

Published

A [node.js][nodejs] client for the [Gaia][gaia] REST service.

Downloads

2,042

Readme

Gaia Node Client

A node.js client for the Gaia REST service.

The methods in this client retrieve data from the endpoints in the Gaia REST service. Iow; one do need access to a running Gaia REST service.

Installation

$ npm install @amedia/gaia-client --save

Basic usage

Example on getting the property aid.use Object for www.ba.no:

const { GaiaClient } = require('gaia-client');

// use the HeaderManager from your app

const gaiaClient = new GaiaClient('http://varnish-local.api.no/gaia', {
  headerManager,
});

gaiaClient
  .getProperty('www.ba.no', 'aid.use')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

Take a look at bin/example.js for a simple script which uses all the methods of gaiaClient.

Constructor

This constructs a new client:

const gaiaClient = new GaiaClient(urlRoot, { headerManager });

The constructor take the following parameters:

  • urlRoot is the url to the Gaia server you want to use. This should be the hostname to the server without any paths. This parameter is required.
  • options - config object. All options are optional
  • options.headerManager is the HeaderManager from your app. Default null.
  • options.timeout Default 2000ms
  • options.agent is the http.Agent for the fetchOptions for gaia backend. Default undefined
  • options.keepAlive Keep alivie on the request. Default false.

API

All methods returns a promise which resolve to an object.

If an error happens, either if the endpoint returns something else than 200 or the endpoint is not accessible, the Promise will be rejected with an error describing why.

The client has the following methods:

.getProperty(publicationDomain, propertyName) -> Promise

Retrieves the property with the given name from the publication with the given domain.

Example

gaiaClient
  .getProperty('www.tangotidende.no', 'shall.esi.be.used')
  .then((result) => console.log(result['shall.esi.be.used']))
  .catch((err) => console.error(err));

.getProperties(publicationDomain, propertyNames) -> Promise

propertyNames is a list of names.

Retrieves the properties with the given names from the publication with the given domain. Returns a list of properties.

Example

gaiaClient
  .getProperties('www.tangotidende.no', [
    'arena.design.version',
    'custom.css.url.large',
  ])
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

.getGlobalProperty(propertyName) -> Promise

Retrieves the global property with the given name.

Example

gaiaClient
  .getGlobalProperty('castor.arena.version')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

.getFooter(publication) -> Promise

Retrieves the footer for the publication.

Example

gaiaClient
  .getFooter('www.ba.no')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

.getMenu(publication) -> Promise

Retrieves the menu for the publication.

Example

gaiaClient
  .getMenu('www.ba.no')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

Tests

$ npm test

Tests are written in Mocha.

Breaking changes version 4

Promise not Bluebird

The promise returned is no longer a Bluebird Promise. This means catch is no longer a filtered catch and the Promise does not support the spread method

Removed site config methods

We have a dedicated site-config module

  • getAllPublications
  • getPublicationById
  • getPublicationByDomain
  • getSiteconfig

New property result format

All property methods return a key value map, not dictionary.

  {
      'aid.use': 'true'
  }

not

[
  {
    value: 'true',
    medusa: false,
    overridable: false,
    name: 'aid.use',
  },
];

New result format for menu

We have switched to the new v3 version of gaia API. The data structure for menu is changed.