node-jsonapi-serializer

Description

JSONApi lib for GOintegro use cases (support N included compound document levels (aka "megapost"))

Documentation

Deserialization

import{JSONAPIDeserializer}from"node-jsonapi-serializer";JSONAPIDeserializer.deserialize(jsonapiResponse,{keepRelationshipsTypes: false,});

Available deserialize config params

• keepRelationshipsTypes: (optional boolean default:false) Defines if relationships should keep type property. If the flag is false, the relationship value will be a string | []string | null | []. If the flag is true, the value will be {id, type} | []{id, type}.

  Note: if the relationship has a related included object, the included object will be set as the relationship value.

Serialization

import{JSONAPISerializer}from"node-jsonapi-serializer";classFileSerializerextendsJSONAPISerializer{publicserializerConfig=()=>{return{type: "files",attributes: ["url"],canBeIncluded: true};};}classProfileSerializerextendsJSONAPISerializer{publicserializerConfig=()=>{return{type: "profiles",attributes: ["gender","phone"],relationships: {avatar: {config: newFileSerializer().serializerConfig,options: {allowInclude: true}}},canBeIncluded: true};};}classUserSerializerextendsJSONAPISerializer{publicserializerConfig=()=>{return{type: "users",attributes: ["name","last"],relationships: {profile: {config: newProfileSerializer().serializerConfig,options: {allowInclude: true}}},canBeIncluded: true};};}classMovieSerializerextendsJSONAPISerializer{publicserializerConfig=()=>{return{type: "movies",attributes: ["name","duration"],relationships: {director: {config: newUserSerializer().serializerConfig,options: {allowInclude: true}}},canBeIncluded: true};};}classListItemSerializerextendsJSONAPISerializer{publicserializerConfig=()=>{return{type: "list-items",attributes: [],relationships: {items: {config: (item)=>{const{ type }=item;switch(type){case"movies":
returnnewMovieSerializer().serializerConfig();case"books":
returnnewBookSerializer().serializerConfig();}},options: {allowInclude: true}},},canBeIncluded: true};};}newListItemSerializer.serialize({data,meta,lang,includeWhitelistKeys,compound})

Available serialize config params

• data: The data to serialize in POJO format
• meta: (optional) object to set as meta response
• lang: (optional) string for i18n purposes
• includeWhitelistKeys: (optional) csv string for bounding included entities. If not set all entities will be set on included array response
• compound: (optional default:false) serialize as megapost

Available serializerConfig return object props

• type: The type of the entity to serialize
• attributes: An array of camelCase strings with the attribute names
• relationships: An object with camelCase key props with function values that resolves to an object with config key related to another serializerConfig entity and relationship options
• canBeIncluded: (optional boolean default:true) allows resource to be appended to included results

Examples

Deserializer

Polymorphic megapost

constinputData={data: {id: "1",type: "list-items",relationships: {items: {data: [{type: "books",attributes: {title: "title book number 1","total-pages": 250,},relationships: {author: {data: {type: "users",attributes: {name: "John",last: "Doe",},relationships: {profile: {data: {type: "profiles",attributes: {gender: "male",phone: 1234,},relationships: {avatar: {data: {type: "files",attributes: {url: "avatar-1.jpg",},},},},},},},},},},},{id: "1",type: "movies",attributes: {title: "title movie number 1",duration: 120,},relationships: {director: {data: {id: "2",type: "users",attributes: {name: "Jhon2",last: "Doe2",},relationships: {profile: {data: {type: "profiles",attributes: {gender: "female",phone: 5678,},relationships: {avatar: {data: {type: "files",attributes: {url: "avatar-2.jpg",},},},},},},},},},},},],},},},};constoutput=JSONAPIDeserializer.deserialize(inputData);console.log(output);/*{ items: [ { title: "title book number 1", totalPages: 250, author: { name: "John", last: "Doe", profile: { gender: "male", phone: 1234, avatar: { url: "avatar-1.jpg", type: "files" }, type: "profiles", }, type: "users", }, type: "books", }, { title: "title movie number 1", duration: 120, director: { name: "Jhon2", last: "Doe2", profile: { gender: "male", phone: 1234, avatar: { url: "avatar-1.jpg", type: "files" }, type: "profiles", }, id: "2", type: "users", }, id: "1", type: "movies", }, ], id: "1", type: "list-items",};*/

Serializer

Polymorphic megapost (client side case)

constinputData={items: [{type: "books",title: "title book number 1",totalPages: 250,author: {name: "John",last: "Doe",profile: {gender: "male",phone: 1234,avatar: {url: "avatar.jpg",},},},},{type: "movies",title: "title movie number 1",duration: 120,director: {name: "George",last: "Lukas",profile: {gender: "male",phone: 5678,avatar: {url: "avatar-2.jpg",},},},},],};constlistItemSerializer=newListItemSerializer();// nested with includesconstoutput=listItemSerializer.serialize({data: inputData,compound: true,});console.log(output);/*{ data: { type: "list-items", relationships: { items: { data: [ { type: "books", attributes: { title: "title book number 1", "total-pages": 250 }, relationships: { author: { data: { type: "users", attributes: { name: "John", last: "Doe" }, relationships: { profile: { data: { type: "profiles", attributes: { gender: "male", phone: 1234 }, relationships: { avatar: { data: { type: "files", attributes: { url: "avatar.jpg" }, }, }, }, }, }, }, }, }, }, }, { type: "movies", attributes: { name: null, duration: 120 }, relationships: { director: { data: { type: "users", attributes: { name: "George", last: "Lukas" }, relationships: { profile: { data: { type: "profiles", attributes: { gender: "male", phone: 5678 }, relationships: { avatar: { data: { type: "files", attributes: { url: "avatar-2.jpg" }, }, }, }, }, }, }, }, }, }, }, ], }, }, },};*/