Javascript Client SDK

This SDK provides convenient access to the Piksel Palette RESTful services through a set of easy to use JS abstractions. You easily integrate Piksel Palette services into your website, webapp or node.js app and be running in no time.

Documentation

In depth instructions and the full API can be found in our developer documentation.

More information about Piksel Palette services is available in the Piksel website.

Install

npm i @pikselpalette/sequoia-js-client-sdk

Usage

ES6 Web bundle (using webpack/browserify)

// point to @pikselpalette/sequoia-js-client-sdk/dist/web/sequoia-client for a minified bundle
import Client from '@pikselpalette/sequoia-js-client-sdk/lib/client';
import { where, field } from '@pikselpalette/sequoia-js-client-sdk/lib/query';

// Create a client:
const client = new Client({
  directory: 'piksel',
  registryUri: 'https://registry-sandbox.sequoia.piksel.com'
});

client
  .login('username', 'password')
  .then(session => {
    // You can now query the session provided as the first argument (or
    // client.session); e.g. `session.isActive()`

    // Get a service::
    client.serviceDescriptors('metadata').then([metadata] => {
      // Get a resourceful endpoint (this is synchronous as the service passed
      // all the necessary data):
      const contents = metadata.resourcefulEndpoint('contents');

      contents
        .browse(
          where()
            .fields('title', 'mediumSynopsis', 'duration', 'ref')
            .include('assets')
            .page(1)
            .perPage(24)
            .orderByUpdatedAt()
            .desc()
            .count()
        )
        .then(collection => {
          // Do something with the ResourceCollection returned
        });
    });
  })
  .catch(error => {
    // Not logged in, inspect `error` to see why
  });

Node/React Native

// If you find a fetch alternative that works well with AWS, and is in active development, let us know.
// Until then, we are using isomorphic-fetch.
require('isomorphic-fetch');
const Client = require('@pikselpalette/sequoia-js-client-sdk/dist/node/sequoia-client');
const { where, field, param, textSearch } = Client;

// Create a client:
const client = new Client({
  directory: 'piksel',
  registryUri: 'https://registry-sandbox.sequoia.piksel.com',
  token: bearerToken
});

(async function init() {
  const services = await client.serviceDescriptors('metadata');
  const contents = services[0].resourcefulEndpoint('contents');
  const collection = await contents.browse(
    where()
      .fields('title', 'mediumSynopsis', 'duration', 'ref')
      .include('assets')
      .page(1)
      .perPage(24)
      .orderByUpdatedAt()
      .desc()
      .count()
  );

  // Do something with the ResourceCollection returned
})();

A note on fetch()

The SDK uses the WHATWG fetch() standard which is available in most modern browsers, and in React Native. In order to use the SDK in older browsers, or in a Node environment where fetch() is not available, you need to supply your own fetch() polyfill.

Some choices are:

• Isomorphic fetch - Web & Node
• Cross Fetch - Web & Node
• WHATWG Fetch - Web only

Development

Built using Node 10. Use avn to handle auto switching node versions.

Building:

  npm run build

Testing:

  npm run test
  npm run test:watch

Mutation testing:

  npm run test:mutate
  npm run test:mutate -- --file=path/to/file/**/*.js

Generate documentation (jsdoc):

  npm run doc

Samples

Here are some samples which make use of the SDK:

• AWS Lambda function running on the nodejs8.10 runtime.