@jaak/playback

Simplified interactions with the JAAK Playback API

⚠️ This repo is under active development and the API is likely to change without warning ⚠️

Installation

npm install @jaak/playback

Usage

For high level usage of this package in both web browsers and Node.js environments, see the jaak.js usage guide.

The following are examples of making arbitrary API requests using the Playback.API class.

Create an API object using a Key:

const Playback = require('@jaak/playback')

const jwk = {
  "kty": "EC",
  "kid": "D6LJKdvD1gcmuyU7G5JeWltFV0AiXpxUx6_UyhsIg80",
  "crv": "P-256",
  "x": "m8ouXM1o0f7cOPmMzN_vfsFouab-n0S86hUegEZb0Ks",
  "y": "iqbequlfZJF1fubrAh2Hmrly9ZWup83NJZc5vsNt4xQ",
  "d": "kyWdoePrPNDWrVkEhXo8KlnA61JvwcRT-DmJIGb_W7A"
}

const key = await Playback.Key.fromJWK(jwk)

const api = new Playback.API(key)

You can also create an API object pointing at a custom URL:

const api = new Playback.API(key, { uri: 'https://playback.custom.jaak.io' })

Send a GraphQL request:

const payload = {
  query: 'query { application { id } }',
}

try {
  const { data, errors } = await api.request(payload)

  if (errors) {
    // GraphQL errors were returned from the server
    // client can choose how to handle them
  }

  // Operate on success data
  console.log(data.application.id)

} catch (error) {
  // A 4xx or 5xx HTTP status code was returned from the request
}

Contributing 🙋‍♀️

See the jaak.js contributing guide.