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

common-catalog-schema

v0.3.0

Published

A Common Catalog Schema that allows for full relationship and classification

Downloads

12

Readme

Common Schema for Catalog Data

This is a json schema declaration for a fully relational data structure designed for catalog data

Motivation

  • Full taxonomy of all base items
  • Information about base items
  • Group abstract concepts for richer information on base items
  • Provide sufficient relational information for:
    • Identifying missing attributes in order to derive to a base item
    • Transforming one base item to another base item by applying operations on its components or addOns
    • Finding minimal operations to transform one base item to another base item

Core Concepts

Classification: A classfication is the type of a base item.
A classification object can have a parent property that points to another classification object. For Example: a classification path for the Tesla car would be [Tesla] => [Sedan] => [Model 3].

ItemDefinition: A ItemDefinition is the base item. A base item is usually an item in a catalog that has a specific sku. For Example: a base item for a Tesla car would be a "Tesla Model 3 P100D"

Concept: A Concept is an abstract grouping of discrete values or collection of base items. Concepts are used within the ItemDefinitions to augment the base item's choices or addOns, and to provide logical relational mapping of same concepts to different base items.

To See the docs:

  1. clone the repo
  2. npm install
  3. pip install json-schema-for-humans (Yes, it's a python package 😬, because I can't find a good nodejs tool for generating docs from JSON Schemas)
  4. npm start

To generate the docs separatly use generate-schema-doc ./json-schema/ docs/spec

  1. Follow the URL in the output to see the docs.