@stantanasi/jsonapi-client NPM

JSON:API Client

A TypeScript client to support JSON:API specification

Installation

npm install @stantanasi/jsonapi-client

Usage

Create JSON:API model

JavaScript

import { model, Schema } from '@stantanasi/jsonapi-client';

export const ArticleSchema = new Schema({
  attributes: {
    title: {},
  },

  relationships: {
    author: {},
    comments: {},
  },
});


class Article extends model(ArticleSchema) { }

Article.register('articles')

export default Article

TypeScript

import { model, Schema } from '@stantanasi/jsonapi-client';
import Comment from './comment.model';
import People from './people.model';

export interface IArticle {
  title: string;

  author: People;
  comments: Comment[];
}

export const ArticleSchema = new Schema<IArticle>({
  attributes: {
    title: {},
  },

  relationships: {
    author: {},
    comments: {},
  },
});


class Article extends model(ArticleSchema) { }

Article.register('articles')

export default Article

Use methods

import { connect } from '@stantanasi/jsonapi-client'

connect({
  baseURL: 'https://example.com',
})

const article = new Article({
  title: 'JSON:API paints my bikeshed!',
})

// POST /articles HTTP/1.1
await article.save()
article.id // '1'


// GET /articles HTTP/1.1
await Article.find()


// GET /articles/1 HTTP/1.1
await Article.findById('1')


// GET /articles/1/comments HTTP/1.1
await Article.findById('1').get('comments')


// PATCH /articles/1 HTTP/1.1
await article.save()


// DELETE /articles/1 HTTP/1.1
await article.delete()

Inclusion of Related Resources

// GET /articles?include=author.comments HTTP/1.1
await Article.find()
  .include({ author: { comments: true } })

Sparse Fieldsets

// GET /articles?fields[articles]=title,author HTTP/1.1
await Article.find()
  .fields({
    articles: ['title', 'author'],
  })

Sorting

// GET /articles?sort=-createdAt HTTP/1.1
await Article.find()
  .sort({ createdAt: 'desc' })

Pagination

// GET /articles?page[limit]=10&page[offset]=0 HTTP/1.1
await Article.find()
  .limit(10)
  .offset(0)

Filtering

// GET /articles?filter[title]=JSON:API%20paints%20my%20bikeshed! HTTP/1.1
await Article.find({
  title: 'JSON:API paints my bikeshed!',
})

Please refer to the example folder to see how to use it

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.