@abcnews/terminus-fetch

Fetch one or more documents from the Preview / Live Terminus content API, based on the current execution domain

$ npm i @abcnews/terminus-fetch

Usage

To use this library, you must have a Terminus API key, and expose it on the enviromnent variable TERMINUS_FETCH_API_KEY. For @abcnews/aunty-based projects, we currently recommend placing it in a .env file in your project directory, so that it is bundled with your app.

import { fetchOne, search } from '@abcnews/terminus-fetch';

// By default, we assume you want an Article document from Core Media so you can pass a CMID:

fetchOne(10736062).then(console.log);
// > { id: 10736062, docType: "Article", contentSource: "coremedia", ... }

// ...or you can pass an options object to override the defaults (see API below):

fetchOne({ id: 10734902, type: 'video' }).then(console.log);
// > {id: 10734902, docType: "Video", contentSource: "coremedia", ... }

// Searching is also supported:

search({ limit: 3, doctype: 'image' })).then(console.log);
// > [
//     { id: 11405582, docType: "Image", contentSource: "coremedia", ... },
//     { id: 11404970, docType: "Image", contentSource: "coremedia", ... },
//     { id: 11405258, docType: "Image", contentSource: "coremedia", ... }
//   ]

// ...for all sources...:

search({ limit: 1, source: 'mapi', service: 'triplej'})
  .then(docs => {
    console.log(docs);
    // > [
    //     { id: "maaYa1B4YP", docType: "Artist", ... },
    //     { id: "mpr9PpbkRd", docType: "Play", ... },
    //     { id: "mtOKj2DbNK", docType: "Recording", ... },
    //     { id: "mrDXgzL4Ry", docType: "Release", ... }
    //   ]
  })
  .catch(err => console.error(err));

If your project's JS is currently executing in a page on a preview domain, requests will be made to Preview Terminus, otherwise they'll be made to Live Terminus.

If you want to direct a single request to Live Terminus, regardless of the current execution domain, pass force: "live" as an option.

If you want to direct a single request to Preview Terminus, regardless of the current execution domain, pass force: "preview" as an option.

If you want only need a document's metadata (e.g. an article without full text content), pass isTeasable: true as an option and the document will be fetched from the /teasablecontent/ API, instead of the /content/ API.

API

fetchOne

declare function fetchOne(
  options:
    | string
    | number
    | {
        source?: string;
        type?: string;
        id?: string | number;
        force?: 'preview' | 'live';
        isTeasable?: string;
      }
): Promise<TerminusDocument>;

If the done callback is omitted then the return value will be a Promise.

Default options

{
  source: 'coremedia',
  type: 'article',
}

search

declare function search(
  options: {
    source?: string;
    force?: "preview" | "live";
    ...searchParams: Object;
  }
): Promise<TerminusDocument[]>;

...where your searchParams are additional properties on your options object, to query the API.

For example, if you wanted the last 20 images added to Core Media, your searchParams would be:

{
  limit: 20,
  doctype: 'image'
}

Default options

These are the same as fetchOne, only split across two options arguments.

getImages

This takes an image document returned from terminus (Image, ImageProxy or CustomImage doctypes) and returns a normalised object including available image renditions.

declare function getImages(doc: any, targetWidths?: number[]): ImageData;

targetWidths argument (optional)

There is no guarantee that the returned object will contain the widths requested using the targetWidths argument. Consumers of this library should always check the result to see if they got what they wanted and behave accordingly.

Default for this argument is: [160, 240, 480, 700, 940, 1400, 2150]

Note: There is no guarantee about which aspect ratios are available for a given image.

Returned object

The results have the following type:

declare type ImageData = {
  cmid: string;
  title?: string;
  alt?: string;
  caption?: string;
  attribution?: string;
  canonicalURL: string;
  defaultRatio?: string;
  renditions: ImageRendition[];
};
declare type ImageRendition = {
  width: number;
  height: number;
  ratio: string;
  url: string;
  isUndersizedBinary: boolean;
};

There are a couple of gotchas in here related to image proxies. The cmid and canonicalURL properties will be those of the proxy, not the target image.

It's possible that the binary URL a rendition points to is actually smaller than the dimensions in the object. This is because small originals are never upscaled by the image resizer, but can still be requested. This situation is flagged by the isUndersizedBinary property.

Releasing

npm run release will handle version bumping, git pushing and npm publication for you.

Authors

• Colin Gourlay ([email protected])