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

schema-mapper-spec

v0.4.2

Published

Schema Mapper data specifications and validators.

Downloads

23

Readme

schema-mapper-spec

build status Dependencies License

Schema mapper defines a specification for data and is specifically designed to make storing data in different data stores less painful (especially for the ones that need a schema to be more useful).

It provides:

  • A definition for a Project containing a name, a version and schemas.
  • A definition for a Schema that is easy to write by humans but also easy to parse for computers.
  • A definitions for Changes that describe modifications made to a project.
  • A definition for DataInfo which describes a transport format for data and includes information about the project and schema.

A Project groups a bunch of schemas and versions them.

A Schema describes the type of the data and the columns it has.

Changes represent individual modifications to the schema. These changes can be used to transform a DataInfo object from a old version to a newer one and because we can easily invert changes because they contain the previous value, you can transform new data to data that is compatible with older versions of the schema as well.

A DataInfo object describes data and includes schema, project and version information.

Using the specifications

There are a couple of ways to use this specification.

Validation

npm install --save schema-mapper-validator

Usage:

var validator = require('schema-mapper-validator');

var dataInfoValidationResult = validator.validateDataInfo(dataInfo);
var schemaValidationResult = validator.validateProject(project);
var schemaValidationResult = validator.validateSchema(schema);
var changesValidationResult = validator.validateChanges(changes);
console.log(dataInfoValidationResult, schemaValidationResult, changesValidationResult);

Types

Below is a specification of the types

ProjectCollection

A ProjectCollection groups projects together. It is an object where the key is the id of the project and the value is a Project.

Project

The project is an object that contains:

  • A name property, that will for example be used for determining the name of a database.
  • A version property, that will for example be used for determining the name of a database.
  • A schemas property that contains the schemas of the project.

SchemaCollection

A SchemaCollection groups schemas together. It is an object where the key is the id of the schema and the value is a Schema.

Schema

The schema is an object that contains:

  • A name property, that will for example be used for determining the name of a database table.
  • A columns property that describe the properties of the data.

Example:

{
  "name": "users",
  "columns": {
    "1": {
      "name": "id",
      "type": "uuid"
    },
    "2": {
      "name": "name",
      "type": "string"
    },
    "3": {
      "name": "email",
      "type": "string"
    },
    "4": {
      "name": "location",
      "type": "point"
    }
  }
}

Columns

Columns describe all the properties of data. It is an object where the key is the id of the column and the value is a Column.

Column

A column describes a single property of data.

Example:

{
  "name": "id",
  "type": "uuid"
}

ColumnType

The column type is a string indicating the type of the value in the data. Here is a table to see what a the different types are and what their data format looks like.

DataInfo

An object describing a piece of data. This object is used as input for the transformer. The transformer will apply changes to this object and modify the name, version and data if needed.

Example:

{
  "projectId": "1",
  "projectName": "demo",
  "projectVersion": 3,
  "schemaId": "1",
  "schemaName": "users",
  "data": {
    "id": "088ea6d5-fd14-4460-aed0-1a4b0ceed555",
    "name": "Koen"
  }
}

Changes

Changes describe a set of changes, changes are usually grouped a versioning mechachnism that spans across / locks the individual schema versions. The data format is a simple array, containing changes as described below.

ProjectCreateChange

TODO

ProjectTagChange

TODO

ProjectRenameChange

TODO

ProjectRemoveChange

TODO

SchemaCreateChange

This change indicates that a schema is created.

Example:

{
  "change": "schema.create",
  "projectId": "1",
  "schemaId": "1",
  "schema": {
    "name": "users",
    "columns": {
      "1": {
        "name": "id",
        "type": "uuid"
      }
    }
  }
}

SchemaRemoveChange

This change indicates that a schema is removed.

Example:

{
  "change": "schema.remove",
  "schemaId": "1",
  "oldSchema": {
    "name": "users",
    "columns": {}
  }
}

SchemaRenameChange

This change indicates that a schema is renamed.

Example:

{
  "change": "schema.rename",
  "schemaId": "1",
  "name": "users",
  "oldName": "user"
}

ColumnCreateChange

This change indicates that a column is added to a schema.

Example:

{
  "change": "column.create",
  "schemaId": "1",
  "columnId": "1",
  "column": {
    "name": "id",
    "type": "uuid"
  }
}

ColumnRemoveChange

This change indicates that a column is removed from a schema.

Example:

{
  "change": "column.remove",
  "schemaId": "1",
  "columnId": "2",
  "oldColumn": {
    "name": "name",
    "type": "string"
  }
}

ColumnRenameChange

This change indicates that a column is removed from a schema.

Example:

{
  "change": "column.rename",
  "schemaId": "1",
  "columnId": "1",
  "name": "id",
  "oldName": "user_id"
}

ColumnTypechangeChange

This change indicates that the type of a column is changed.

Example:

{
  "change": "column.typechange",
  "schemaId": "1",
  "columnId": "1",
  "type": "integer",
  "oldType": "uuid"
}

API docs

API Docs

Licence

MIT