jsonapi-normalizr v0.0.4

Schema-based JSON API data parser

Quick and dirty implementation. Do not use in production!

Usage

Installation

npm i --save jsonapi-normalizr

Imports

import {schema, fields, normalize} from 'jsonapi-normalizr'

Schemas

const userSchema = schema('users', {
    email: fields.string(),
    fullName: fields.string({fromName: 'full_name'})
})

const commentSchema = schema('comments', {
    author: fields.relationship(userSchema),
    text: fields.string()
}, {jsonApiType: 'blog_comments'})

const postSchema = schema('posts', {
    created: fields.date(),
    title: fields.string(),
    text: fields.string(),
    comments: fields.relationship(commentSchema, {many: true})
}, {jsonApiType: 'blog_posts'})

Source data

const jsonApiData = {
    data: {
        id: '1',
        type: 'blog_posts',
        attributes: {
            created: '2017-02-02T12:30:41Z',
            title: 'Hello world!',
            text: 'This is the post about jsonapi-normalizr'
        },
        relationships: {
            comments: {
                data: [
                    {type: 'blog_comments', id: '1'},
                    {type: 'blog_comments', id: '2'}
                ]
            }
        }
    },
    included: [
        {
            id: '1',
            type: 'blog_comments',
            attributes: {text: 'First comment'},
            relationships: {
                author: {data: {type: 'users', id: '1'}}
            }
        },
        {
            id: '2',
            type: 'blog_comments',
            attributes: {text: 'Second comment'},
            relationships: {
                author: {data: {type: 'users', id: '2'}}
            }
        },
        {
            id: '1',
            type: 'users',
            attributes: {email: 'user1@example.com', full_name: 'John Doe'}
        },
        {
            id: '2',
            type: 'users',
            attributes: {email: 'user2@example.com', full_name: 'Dow Jones'}
        }
    ]
}

Parsing

const normalized = normalize(
    postSchema({include: ['comments', 'comments.author']}),
    jsonApiData
)

Result data

{
    "result": {"type": "posts", "id": "1"},
    "entities": {
        "posts": {
            "1": {
                "id": "1",
                "created": new Date('2017-02-02T12:30:41Z'),
                "title": "Hello world!",
                "text": "This is the post about jsonapi-normalizr",
                "comments": [
                    {"type": "comments", "id": "1"},
                    {"type": "comments", "id": "2"}
                ]
            }
        },
        "comments": {
            "1": {
                "id": "1",
                "author": {"type": "users", "id": "1"},
                "text": "First comment"
            },
            "2": {
                "id": "2",
                "author": {"type": "users", "id": "2"},
                "text": "Second comment"
            }
        },
        "users": {
            "1": {
                "id": "1",
                "email": "user1@example.com",
                "fullName": "John Doe"
            },
            "2": {
                "id": "2",
                "email": "user2@example.com",
                "fullName": "Dow Jones"
            }
        }
    }
}