Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scoutforpets/jsonapi-mapper

JSON API-Compliant Serialization for your Node ORM
https://github.com/scoutforpets/jsonapi-mapper

bookshelf json-api orm serializer

Last synced: about 6 hours ago
JSON representation

JSON API-Compliant Serialization for your Node ORM

Awesome Lists containing this project

README 

        
# JSON API Mapper

[![Build Status](https://travis-ci.org/scoutforpets/jsonapi-mapper.svg?branch=master)](https://travis-ci.org/scoutforpets/jsonapi-mapper)

[![npm version](https://badge.fury.io/js/jsonapi-mapper.svg)](https://badge.fury.io/js/jsonapi-mapper)

[![david dm](https://david-dm.org/scoutforpets/jsonapi-mapper.svg)](https://david-dm.org/scoutforpets/jsonapi-mapper)



JSON API Mapper (_formerly Oh My JSON API_) is a wrapper around [@Seyz](https://github.com/SeyZ/)'s excellent [JSON API](http://jsonapi.org/)-compliant serializer, [jsonapi-serializer](https://github.com/SeyZ/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](https://badges.gitter.im/scoutforpets/jsonapi-mapper.svg)](https://gitter.im/scoutforpets/jsonapi-mapper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



## _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](#migrating-from-ohmyjsonapi) 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](https://github.com/tgriesser/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](https://github.com/tgriesser/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.



```javascript

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](https://github.com/scoutforpets/jsonapi-mapper/blob/master/CONTRIBUTING.md)



## 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:



  ```javascript

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

  ```



  to



  ```javascript

  new Mapper.Bookshelf('https://api.hotapp.com');

  ```

- Convert any instances of:



  ```javascript

  jsonApi.toJSONAPI(myData, 'appointment');

  ```



  to



  ```javascript

  mapper.map(myData, 'appointment');

  ```



## API

```javascript

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](https://github.com/SeyZ/jsonapi-serializer#documentation).



```javascript

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)_ `attributes` (object):

    - _(optional)_ `omit` _(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)_ `include` _(RegExp | string)[]_: List of model attributes to explicitly include from the resulting payload.

  - _(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 `{"": ""}` (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)_

  - _(optional)_ `meta` _(object)_: Top-level meta object to include in the document

  - _(optional)_ `outputVirtuals` _(boolean)_: Flag to include/omit the virtuals if the `virtuals` plugin is used, overrides the default `outputVirtuals` value.



# 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](http://docs.sequelizejs.com/) or [Mongoose](http://mongoosejs.com/)). Just open a PR!



The project source has been recently rewritten using [Typescript](http://www.typescriptlang.org/), which has been proven useful for static checks and overall development.



# Credits

- Thanks to [@Seyz](https://github.com/SeyZ/). Without his work, the project would not be possible.

- Thanks to the [zomoz team](https://github.com/zomoz) (especially [@ShadowManu](https://github.com/shadowmanu)) for their hard work in migrating the codebase to Typescript and writing a comprehensive test suite.