JSON API-Compliant Serialization for your Node ORM
TypeScript
Latest commit bc96ab5 Oct 25, 2016 @chamini2 chamini2 committed on GitHub Merge pull request #83 from scoutforpets/ts2
upgraded to Typescript 2 🔥

README.md

JSON API Mapper

Build Status npm version david dm

JSON API Mapper (formerly Oh My JSON API) is a wrapper around @Seyz's excellent JSON API-compliant serializer, jsonapi-serializer, that removes the pain of generating the necessary options needed to serialize each of your ORM models.

Join the chat at https://gitter.im/scoutforpets/oh-my-jsonapi

Breaking Changes

This project has recently been renamed and rewritten using Typescript. While most functionality is generally the same, there have been a few deprecations and changes to how the Mapper is initialized. Please see the migration guide below.

How does it work?

A serializer requires some sort of 'template' to understand how to convert what you're passing in to whatever you want to come out. When you're dealing with an ORM, such as Bookshelf, it would be a real pain to have to generate the 'template' for every one of your Bookshelf models in order to convert them to JSON API. JSON API Mapper handles this by dynamically analyzing your models and automatically generating the necessary 'template' to pass to the serializer.

What ORMs do you support?

Initially, we only provide a mapper for Bookshelf. However, the library can be easily extended with new mappers to support other ORMs. PR's are more than welcome!

How do I install it?

npm install jsonapi-mapper --save

How do I use it?

It's pretty simple. You only need to configure the mapper and then use it as many times you need.

import Mapper = require('jsonapi-mapper');

// Create the mapper
var mapper = new Mapper.Bookshelf('https://api.hotapp.com');

// Use the mapper to output JSON API-compliant using your ORM-provided data
return mapper.map(myData, 'appointment');

How can I contribute?

God bless you if you're reading this! Check out our Contributing page

Migrating from OhMyJSONAPI

The migration process is painless:

  • Remove oh-my-jsonapi from your project.
  • Run npm install jsonapi-mapper --save
  • Convert any instances of the constructor:

    new OhMyJSONAPI('bookshelf', 'https://api.hotapp.com');

    to

    new Mapper.Bookshelf('https://api.hotapp.com');
  • Convert any instances of:

    jsonApi.toJSONAPI(myData, 'appointment');

    to

    mapper.map(myData, 'appointment');

API

new Mapper.Bookshelf(baseUrl, serializerOptions)
  • (optional) baseUrl (string): the base URL to be used in all links objects returned.
  • (optional) serializerOptions (string): options to be passed to the serializer. These options will override any options generated by the mapper. For more information on the raw serializer, please see the documentation here.
mapper#map(data, type, mapperOptions)
  • data (object): The data object from Bookshelf (either a Model or a Collection) to be serialized.
  • type (string): The type of the resource being returned. For example, if you passed in an Appointment model, your type might be appointment.
  • (optional) mapperOptions (object):
    • (optional) omitAttrs (RegExp | string)[]: List of model attributes to omit from the resulting payload. For example, you may wish to exclude any foreign keys (as recommended by the JSON API-spec). Note: the model's idAttribute is automatically excluded by default.
    • (optional) keyForAttr (function (string => string)): Function to customize the attributes keys. The function is passed as input the attribute key (string) and output the new attribute key (string).
    • (optional) relations (boolean | object): Flag to enable (true) or disable (false) serializing of related models on the response. Alternatively, you can provide an object containing the following options:
      • included (boolean | string[]) (default: true) - includes data for all relations in the response. You may optionally specify an array containing the names of specific relations to be included.
      • fields string[] - an array of relation names that should be included in the response.
    • (optional) typeForModel (object | function): To customize the type of a relation. If the value returned is falsy, then it's automatically pluralized. This function also affects the type passed as the second parameter of the map function.
      • object: The object should have the structure {"<relation-name>": "<type-to-use>"} (e.g. {"best-friend": "people"}).
      • function (string => string): The function is passed as input the relation name (string) and output the type for that relation (string) (e.g. (x) => x + '-resources').
    • (optional) enableLinks (boolean): Flag to enable (true) or disable (false) the generation of links in the payload. This may be useful if the consuming system doesn't take advantage of links and you want to save on payload size and maybe a bit of performance. Defaults to true.
    • (optional) query (object): An object containing the original query parameters. These will be appended to self and pagination links. Developer Note: This is not fully implemented yet, but following releases will fix that.
    • (optional) pagination (object): Pagination-related parameters for building pagination links for collections.
      • (required) offset (integer)
      • (required) limit (integer)
      • (optional) total or rowCount (integer)

How can I contribute?

The project is very open to collaboration from the public, especially on providing the groundwork for other ORM's (like Sequelize or Mongoose). Just open a PR!

The project source has been recently rewritten using Typescript, which has been proven useful for static checks and overall development.

Credits

  • Thanks to @Seyz. Without his work, the project would not be possible.
  • Thanks to the ZOI Travel team (especially @ShadowManu) for their hard work in migrating the codebase to Typescript and writing a comprehensive test suite.