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-mapify

v1.0.4

Published

A simple tool for mapping data to a specific object schema

Downloads

5

Readme

JSON Mapify

JSON Mapify is a lightweight npm package that simplifies the process of mapping JavaScript objects to specific schemas. Whether you need to transform data into a view model or revert it back to its original structure, this package provides two essential functions: toViewModel() and toDataModel().

Installation

Install the package using npm:

npm install json-mapify

Usage

toViewModel(data, map)

Transforms the input data object to match the specified schema.

toDataModel(data, map)

Converts the input data object back to its original structure based on the provided schema.

Both functions accept two parameters:

  1. data: The object to parse to the schema.

  2. map: The schema, represented as an array of objects, with the following properties:

    • name: Name of the attribute (for documentation).

    • dataPath: The source object property (supports nested paths, e.g., User.name).

    • viewPath: The property in the output object to assign the data to.

    • viewContent: (Optional) A function that takes in the source data and returns the view content. Data path may be omitted if no input is needed.

Example

Consider the following data object:

const data = {
  User: {
    name: 'John Doe',
    age: 30,
  },
  // ... other properties
};

And a schema map with a custom viewContent function:

const schemaMap = [
  {
    name: 'UserName',
    viewPath: 'username',
    viewContent: (user) => `Hello, ${user.name}!`,
  },
  {
    name: 'UserAge',
    dataPath: 'User.age',
    viewPath: 'age' 
  },
  // ... other schema mappings
];

Using the toViewModel() function:

const viewModel = toViewModel(data, schemaMap);
console.log(viewModel); 

The resulting viewModel will be:

{
  username: 'Hello, John Doe!',
  age: 30,
  // ... other mapped properties
}

And using the toDataModel() function:

const dataModel = toDataModel(viewModel, schemaMap);
console.log(dataModel);

The resulting dataModel will be the original data object.