npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

simple-json-api-normalize

v1.1.1

Published

Normalizer to simple object for json-api-spec

Downloads

6

Readme

SIMPLE json-api normalize

A simple way to normalize datasets based on JSON API specification to powerful objects and their relationships so that you can use directly and natively. Normalizer is a lightweight javascript library with simple and powerful api.

json:api is a specification for building apis in JSON. If you are new to JSON api we recommend you browse json api website and examples to familiarize yourself with specification. This library is built upon standards and conventions of JSON api and provides a simple way to traverse and retrieve all those attributes and relations.

Examples

This normalizer only works with json:api response having key jsonapi at root, or at least having key data.

jsonapi: {
  version: 'xxx';
}

Lets start with a typical JSON api formatted dataset:

Single resource object

const response = {
  data: {
    id: '55',
    type: 'task',
    attributes: {
      subject: 'Re: [To: ["[email protected]"]]Hi Max Redis',
      body: 'Will you be free for a call sometime this or next week',
    },
  },
  jsonapi: { version: '1.0' },
};
const data = normalize(response);

expect(data).toEqual({
  id: '55',
  type: 'task',
  subject: 'Re: [To: ["[email protected]"]]Hi Max Redis',
  body: 'Will you be free for a call sometime this or next week',
  meta: {},
});

The normalzer will append meta key to each object.

Array of resource objects

const response = {
  data: [
    {
      id: '55',
      type: 'task',
      attributes: {
        subject: 'mysubject',
        body: 'mybody',
      },
    },
    {
      id: '56',
      type: 'task',
      attributes: {
        subject: 'mysubject',
        body: 'mybody',
      },
    },
  ],
  meta: { currentPage: 1 },
  jsonapi: { version: '1.0' },
};

const data = normalize(response);

expect(data).toEqual([
  {
    id: '55',
    type: 'task',
    subject: 'mysubject',
    body: 'mybody',
    meta: { currentPage: 1 },
  },
  {
    id: '56',
    type: 'task',
    subject: 'mysubject',
    body: 'mybody',
    meta: { currentPage: 1 },
  },
]);

The normalzer will append meta key to each object.

Resource object with relationships and included

const response = {
  data: {
    id: '55',
    type: 'task',
    attributes: {
      subject: 'Re: [To: ["[email protected]"]]Hi Max Redis',
      body: 'Will you be free for a call sometime this or next week',
    },
    relationships: {
      campaign: {
        data: {
          id: '12',
          type: 'campaign',
        },
      },
    },
  },
  included: [
    {
      id: '12',
      type: 'campaign',
      attributes: { name: 'test campaign', description: 'this is a test campaign' },
      relationships: {
        topic: {
          data: {
            id: '42',
            type: 'topic',
          },
        },
      },
    },
    { id: '42', type: 'topic', attributes: { name: 'test topic' } },
  ],
  jsonapi: { version: '1.0' },
};

const data = normalize(response);

expect(data).toEqual({
  id: '55',
  type: 'task',
  subject: 'Re: [To: ["[email protected]"]]Hi Max Redis',
  body: 'Will you be free for a call sometime this or next week',
  campaign: {
    id: '12',
    type: 'campaign',
    name: 'test campaign',
    description: 'this is a test campaign',
    topic: {
      id: '42',
      type: 'topic',
      name: 'test topic',
    },
  },
  meta: {},
});

Installation

Json api normalize is packaged so you can use it both on client and server (CommonJS and AMD environment) or with browser globals.

// install via npm
npm install simple-json-api-normalize --save

// install via yarn
yarn install simple-json-api-normalize

// if you use bundler
const normalize = require('json-api-normalize');