JsonApiEntityProvider.TS is an implementation of EntityProvider for EntityStore.TS package. You can find detailed information on the project page.

If you like or are using this project please give it a star. Thanks!

• What issues it solves?
• Installation
• Configuration
• Versioning
• Contributing
• Authors
• Notes
• License

JsonApi entity provider aims to cover JSON:API specification. It supports the latest version (v1.0) and allows you easily connect to any backend API which follows described conventions. Besides it provides you extension points for different filtering and pagination strategies which might be used by a server.

JsonApiEntityProvider.TS is available from NPM, both for browser (e.g. using webpack) and NodeJS:

npm i @dipscope/json-api-entity-provider

This package is a plugin for EntityStore.TS package. Please read documentation after installation.

First step is to create a provider and pass options you want to apply.

import { JsonApiEntityProvider, JsonApiEntityProviderOptions } from '@dipscope/json-api-entity-provider';
import { JsonApiNetFilterExpressionVisitor, JsonApiNetPaginateExpressionVisitor } from '@dipscope/json-api-entity-provider';
import { AppEntityStore } from './app';

// Create entity provider.
const jsonApiEntityProvider = new JsonApiEntityProvider({
    baseUrl: 'https://localhost:20001', // Url to you backend endpoint.
    jsonApiRequestInterceptor: (request: Request) => request, // You might intercept requests by adding headers. 
    jsonApiFilterExpressionVisitor: new JsonApiNetFilterExpressionVisitor(), // You might override filtering strategy used by a server.
    jsonApiPaginateExpressionVisitor: new JsonApiNetPaginateExpressionVisitor(), // You might override pagination strategy used by a server.
    ... // Other options to override.
});

// Create entity store.
const appEntityStore = new AppEntityStore(jsonApiEntityProvider);

Second step is to define resource configuration for your entities as required by JSON:API specification.

import { Type, Property } from '@dipscope/type-manager';
import { EntityCollection } from '@dipscope/entity-store';
import { JsonApiResource } from '@dipscope/json-api-entity-provider';
import { Company, Message } from './app/entities';

@Type()
@JsonApiResource({
    type: 'users' // Specify resource type.
})
export class User
{
    @Property(String) public id?: string;
    @Property(String) public name: string;
    @Property(String) public email: string;
    @Property(Company) public company: Company;
    @Property(EntityCollection, [Message]) public messages: EntityCollection<Message>;

    // Omitted for brevity ...
}

After that you have to follow EntityStore.TS documentation. Supported methods which you can use through EntitySet is dependent from backend implementation of JSON:API specification.

We use SemVer for versioning. For the versions available, see the versions section on NPM project page.

See information about breaking changes, release notes and migration steps between versions in CHANGELOG.md file.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

• Dmitry Pimonov - Initial work - dpimonov

See also the list of contributors who participated in this project.

Thanks for checking this package.

Feel free to create an issue if you find any mistakes in documentation or have any improvements in mind.

We wish you good luck and happy coding!

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.