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

normaliz

v0.2.0

Published

A tiny library that normalizes data according to a schema.

Downloads

885

Readme

normaliz

Npm Build Status Coverage Status Minzipped size

A tiny library that normalizes data according to a schema.

Inspired by normalizr which is a great library. I just needed something more intuitive and lightweight.

Features

  • 💸 Lightweight (~ 800 bytes minzipped)

  • 💪 Simple but powerful and intuitive API

  • Battle tested

Setup

npm i normaliz

Usage

import { normaliz, denormaliz } from 'normaliz'

const payload = {
  id: 1,
  title: 'My Item',
  post: { id: 4, date: '01-01-1970' },
  users: [
    {
      userId: 1,
      name: 'john'
    }, {
      userId: 2,
      name: 'jane',
      comments: [{
        id: 3,
        sub_id: 1,
        content: 'Hello'
      }]
    }
  ]
}
// Note: payload can also be an array of items.

const entities = normaliz(payload, {
  entity: 'items',
  schema: [
    // An 'item' contains:
    // - a post, stored under the 'posts' key…
    ['post', { mapping: 'posts' }]
    // - and a list of users.
    [ 'users',
      [
        // An 'item.user' contains a list of comments.
        // A comment has a custom id value made with the concatenation of the  'id' and the 'sub_id' fields.
        [ 'comments', { key: comment => comment.id + ' - ' + comment.sub_id } ]
      ],
      // Use the 'userId' field as the key instead of the default ('id' field).
      { key: 'userId' }
    ]
  ],
  // If the payload belongs to an existing entity pointed out by its id
  from: {
    itemsContainer: 'container_1'
  }
})

// Normalized entities:

{
  items : {
    1: {
      id: 1,
      title: 'My Item',
      post: 4,
      users: [ 1, 2 ]
    }
  },
  users: {
    1: { userId: 1, name: 'john' },
    2: { userId: 2, name: 'jane', comments: [ '3 - 1' ] }
  },
  posts: {
    4: { id: 4, date: '01-01-1970' }
  },
  comments: {
    '3 - 1': { id: 3, sub_id: 1, content: 'Hello' }
  },
  itemsContainer: {
    container_1: {
      items: 1
    }
  },
}

// De-normalize an entity
const originalData = denormaliz(entities.items[1], {
  entities,
  schema: [
    [ 'post', { mapping: 'posts' }],
    [ 'users', [ 'comments' ]]
  ]
})