freelock/reststate-client

This package is forked from @reststate/client, which is no longer maintained, and updated with fixes to support Drupal's JSONAPI.

A lightweight client for making requests to a JSON:API service.

It doesn't attempt to provide a way to utilize every possible feature of JSON:API; instead, it offers a core set of functionality sufficient for most apps.
It doesn't attempt to abstract away the JSON:API object format; instead, it returns JSON:API data as-is.

@reststate/client provides a simple Promise-based API suitable for just about any JavaScript application. It doesn't handle persistence, though; for that, wrappers are available for a variety of popular state stores:

Vuex
MobX
Coming soon: Redux

Synopsis

const resource = new ResourceClient({
  name: 'widgets',
  httpClient: axios.create(...),
});

resource.all()
  .then(widgets => widgets);

resource.create({
  attributes: {
    title: 'My Widget',
  },
});

Installation

$ npm install --save @reststate/client

@reststate/client needs to be configured with an httpClient object that handles the requests and responses. The easiest way to do this is to provide an axios instance configured with your server's base URL, the standard JSON:API content type, and optionally any authentication info your server requires.

import axios from 'axios';
import { ResourceClient } from '@reststate/client';

const token = "FILL_ME";

const httpClient = axios.create({
  baseURL: 'https://jsonapi-sandbox.herokuapp.com',
  headers: {
    'Content-Type': 'application/vnd.api+json',
    'Authentication': `Bearer ${token}`,
  },
});
const client = new ResourceClient({ name: 'widgets', httpClient });

client.all().then(results => console.log(results));

Changes

4/22/2022 -- With version 0.2.0, this library now automatically converts a double-dash (--) in a request to a slash (/), to natively support Drupal's JSON:API patterns. It does this only for the endpoint, and not for anything in the query string.

This allows it to support relationships that specify a type of "--", to get automatically converted to an endpoint of "/".

Usage

For more information on usage, see the @reststate/client docs.

License

Apache-2.0