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

mutent-json-schema

v2.0.0

Published

JSON Schema validation plugin for Mutent based on Ajv.

Downloads

102

Readme

mutent-json-schema

npm JavaScript Style Guide

This plugin for Mutent will inject a set of Hooks that will validate that all Entities match with the desired JSON Schema.

The validation will be performed when any Entity is loaded (onEntity hook) and before any Adapter's write op (beforeCreate and beforeUpdate hooks).

Install

npm i mutent-json-schema

API

mutentJsonSchema(options)

Returns a new Mutent's Plugin that enforces a JSON Schema to all Entities.

  • options <Object>
  • [options.ajv] <Ajv> A customized instance of Ajv. Optional.
  • [options.ajvOptions] <Object> Custom options for the Ajv constructor function. Optional defaults are documented below.
  • options.schema <*> The required JSON Schema to enforce. Schemas generated with fluent-json-schema are also supported.
  • Returns: <Plugin>

Default Ajv options

Those are the default options used to create the internal Ajv instance.

new Ajv({
  allErrors: process.env.NODE_ENV !== 'production',
  coerceTypes: true,
  removeAdditional: true,
  useDefaults: true,
  ...pluginOptions.ajvOptions
})

JSON Schema errors

When an Entity with an invalid schema is detected, an error will be thrown. The error is an instance of MutentError with the "EMUT_INVALID_ENTITY" code.

You can access the raw Ajv-generated errors, and the Entity that has generated those errors, from the .info.errors and .info.data properties respectively.

Example

import { MutentError, Store } from 'mutent'
import ArrayAdapter from 'mutent-array'
import mutentJsonSchema from 'mutent-json-schema'

const store = new Store({
  adapter: new ArrayAdapter(),
  plugins: [
    mutentJsonSchema({
      schema: {
        type: 'object',
        additionalProperties: false,
        properties: {
          id: {
            type: 'string'
          },
          value: {
            type: 'integer'
          }
        },
        required: ['id', 'value']
      }
    })
  ]
})

try {
  await store.create({ value: 7 }).unwrap()
} catch (err) {
  // Handle mutent-json-schema error
  if (err instanceof MutentError && err.code === 'EMUT_INVALID_ENTITY') {
    // Invalid data: { value: 7 }
    console.error('Invalid data:', err.info.data)

    // Schema errors: [
    //   {
    //     instancePath: '',
    //     schemaPath: '#/required',
    //     keyword: 'required',
    //     params: { missingProperty: 'id' },
    //     message: "must have required property 'id'"
    //   }
    // ]
    console.error('Schema errors:', err.info.errors)
  } else {
    throw err
  }
}

await store.create({ id: 'my_entity', value: 42 }).unwrap()

console.log(store.raw) // [ { id: 'my_entity', value: 42 } ]

License

Licensed under MIT.