Spec compliance

Based on the official v1.0 specification, all the features should be implemented. If something is missing or not behaving correctly, feel free to open an issue.

Content Negotiation

Official docs

Client Responsibilities

Official docs

The lib is already setting the required headers, but you can also extend/override them if needed

Server Responsibilities

Official docs

If the server returns any HTTP status 400 or greater (including 406 and 415 mentioned in the spec), the request promise will reject with a Response object that has its error property set (message & HTTP status)

Document Structure

Official docs

Top Level

Official docs

• The lib supports data, errors, meta, links, included, and jsonapi properties:
  • data, error and jsonapi are exsposed in the Response object
  • included is consumed by the sync method
  • meta and links values are available on the model with getModelMeta, getModelLinks, fetchModelLink, getModelRefLinks, fetchModelRefLink and getModelRefMeta.

Resource Objects

Official docs

• The lib expects id and type properties, and they're available on the Model instance

• If the resource has attributes, they will be available as regular properties on the Model instance

• If the resource has relationships

  • links will be available using the getModelRefpLinks method on the record
    • Use fetchModelRefLink to fetch the link
  • data will be used to build the references between models
    • If the store already contains the referenced model or includes contains the model it will be available right away on the record: model[relName]. Also, the id is available on model.meta.refs[relName]
    • If the model is "unknown", the id will be available on model.meta.refs[relName]
  • meta is available with getModelRefMeta

• If the resource has links or meta, they will be available with the getLinks and getMeta methods on the record

  • Use fetchLink to fetch the link

Resource Identifier Objects

Official docs

• The lib expects id and type
• meta is available with (getModelMeta)[jsonapi-utils#getmodelmeta]

Compound Objects

Official docs

• The lib supports included property
• The lib will add included resources as references to the data resources
• The included resources are treated as regular records, just like the data resources, with same features and limitations

Meta Information

Official docs

The meta property will be available directly on the Response object

Links

Official docs

• The links property is supported, and exposes all links directly on the Response object
• They are also available in raw form as a links property on the Response object
• response[linkName] is a Promise that will resolve to a Response with either the data or error property set
  • The link is lazily evaluated, so the request won't be made until you access the property
  • The link can be a string with an URL

JSON API Object

Official docs

The jsonapi property is available on the Response object instance

Member Names

Official docs

• All member names are treated as strings, therefore adhere to the specification
• If a name is not a valid variable name, e.g. "first-name", you can access it as model['first-name']

Fetching Data

Official docs

Fetching Resources

Official docs

• Fetch top-level links
• Fetch resource-level links with fetchModelLink
• Fetch related link from relationship-level links with fetchModelRefLink

Fetching Relationships

Official docs

Fetch relationship-level links with fetchModelRefLink

Inclusion of Related Resources

Official docs

Supported by providing a include property in the request options (IRequestOptions)

Sparse Fieldsets

Official docs

Supported by providing a fields property in the request options (IRequestOptions)

Sorting

Official docs

Supported by providing a sort property in the request options (IRequestOptions)

Pagination

Official docs

• The lib supports top-level links
• The lib allows access to raw links in the links property of the Response object instance
• The lib allows pagination with links, e.g. response.next will return a Promise that will resolve to a Response object with either the data or error property set
  • The link is lazily evaluated, so the request won't be made until you access the property

Filtering

Official docs

Supported by providing a filter property in the request options (IRequestOptions)

Creating, Updating and Deleting Resources

Official docs

Creating Resources

Official docs

• Creating resources is supported using the save method if the record was created on the client
• Client-Generated IDs are supported
  • set useAutogeneratedIds to true
  • override autoIdFunction so it returns a valid UUID

Updating Resources

Official docs

Updating resources is supported using the save method if the record was not created on the client

Updating Relationships

Official docs

• Direct update of relationships is supported with the saveRelationship method
• Tip: If you want to add a new relationship, use initModelRef

Deleting Resources

Official docs

The resource can be deleted with the destroy method on the record

Query Parameters

Official docs

All current communication with the server is using the required naming method

Errors

Official docs

Processing Errors

Official docs

The lib will process all HTTP status 400+ as errors

Error Objects

Official docs

The error objects will be available in the Response object under the error property (without any modification)