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

json-api-denormalizer

v1.0.1

Published

Node utility function to denormalize json api data.

Downloads

32

Readme

json-api-denormalizer

Build Status

Denormalize a state build by https://github.com/redux-json-api/redux-json-api.

Install

yarn add json-api-denormalizer
npm install --save json-api-denormalizer

Usage

With a state looking like this:

{
    "providers": {
        "data": [
            {
                "attributes": {
                    "provider": "facebook",
                    "uid": "1015511500"
                },
                "id": "1",
                "links": {
                    "self": "http://127.0.0.1:8000/providers/1"
                },
                "type": "providers"
            },
            {
                "attributes": {
                    "provider": "google",
                    "uid": "10805182745064"
                },
                "id": "2",
                "links": {
                    "self": "http://127.0.0.1:8000/providers/2"
                },
                "type": "providers"
            }
        ]
    },
    "stats": {
        "data": [
            {
                "attributes": {
                    "data": {
                        "ranking": 36457
                    },
                    "date": "2018-01-30"
                },
                "id": "2",
                "relationships": {
                    "user": {
                        "data": {
                            "id": "1",
                            "type": "users"
                        },
                        "links": {
                            "related": "http://127.0.0.1:8000/users/1"
                        }
                    }
                },
                "type": "stats"
            }
        ]
    },
    "users": {
        "data": [
            {
                "attributes": {
                    "birthday": "1970-01-01",
                    "place-of-birth": "Paris",
                    "email": "[email protected]",
                    "first-name": "Michaël",
                    "gender": "male",
                    "last-name": "Corleone"
                },
                "id": "1",
                "links": {
                    "self": "http://127.0.0.1:8000/users/1"
                },
                "relationships": {
                    "current-stats": {
                        "data": {
                            "id": "2",
                            "type": "stats"
                        },
                        "links": {
                            "related": "http://127.0.0.1:8000/users/1/current_stats"
                        }
                    },
                    "providers": {
                        "data": [
                            {
                                "id": "2",
                                "type": "providers"
                            },
                            {
                                "id": "1",
                                "type": "providers"
                            }
                        ],
                        "links": {
                            "related": "http://127.0.0.1:8000/users/1/providers",
                            "self": "http://127.0.0.1:8000/users/1/relationships/providers"
                        },
                        "meta": {
                            "count": 2
                        }
                    }
                },
                "type": "users"
            }
        ]
    }
}

You get something like this:

{
  users: {
    1: {
      birthday: "1970-01-01",
      place_of_birth: "Paris",
      email: "[email protected]",
      first_name: "Michaël",
      gender: "male",
      last_name: "Corleone",
      current_stats: [Current stats],
      providers: [
        [Provider 2],
        [Provider 1],
      ]
    }
  },
  stats: {
    2: {
      data: {
        ranking: 36457,
      },
      date: "2018-01-30",
      user: [User 1]
    }
  },
  providers: {
    1: {
      provider: "facebook",
      uid: "1015511500",
    },
    2: {
      provider: "google",
      uid: "10805182745064"
    }
  }
}

Relationships are made by reference, not copied, so [User 1] have a current_stats key which points to [Stats 2] which in turn have a user key which point to [User 1]. That way we don't end up in a infinite loop when denormalizing, we use less space and if for whatever reason you change an object, all relationships are updated as well.

This can become a problem if you need serializing, for example when using nextjs and denormalized data in initial props, it will be serialized and send to server. If this is a problem, you can use this :

import denormalizer, { removeCircularReferences } from 'json-api-denormalizer';

// state.api is redux-json-api default state location
const me = denormalizer(state.api).users[1];

// If you can't control serialization, for example inside getInitialProps of nextjs
me.toJSON = () => removeCircularReferences(me);

// If you can control serialization :
fetch('/some/api/requiring/plain/json', removeCircularReferences(me));

Tests

npm run test