Skip to main content

@exodus/schemasafe-babel-plugin

Compiles imported JSON schemas into validator functions using @exodus/schemasafe.

[!WARNING] This is a codegen library and therefore poses a risk if used with untrusted input.

Usage

Usage:​

  1. Add the plugin in babel.config.js, e.g.:
module.exports = {
  plugins: [['@exodus/schemasafe-babel-plugin', pluginParams]],
}

pluginParams should be a valid SchemasafeBabelPluginParams object.

  1. Import a JSON schema in your project:
import validateData from './data.schemasafe.json'
import { validateMeta } from './meta.schemasafe.json' // Named imports also work.
  1. After compilation the imported variables become a validator function so a consumer can use it like a normal JS function:
try {
  validateData(data)
} catch (err) {
  console.log(err.message) // 'JSON validation failed for...'
}

API reference​

/*
  See https://github.com/ExodusMovement/schemasafe#options for all available options.
*/
interface SchemasafeOptions {
  schemas?: JsonSchema[] // Extra schemas to be referenced from a master schema.
  formats?: Object // Extra formats to be used in the supplied schemas.
  removeAdditional?: boolean // Removes non-valid properties from the original object if true.
}

interface SchemasafeBabelPluginParams {
  options: {
    globs: string[] // Global patterns to match against particular schemas.
    schemasafeOptions?: SchemasafeOptions
  }[]
}

Example:

plugins: [
  [
    '@exodus/schemasafe-babel-plugin',
    {
      options: [
        {
          globs: ['**/src/schemas/*.schema.json'],
          schemasafeOptions: {
            formats: { 'no-foo': (str) => !str.includes('foo') },
          },
        },
        {
          globs: ['**/node_modules/some-package/**/*.schemasafe.json'],
          schemasafeOptions: {
            enableExtra: true,
            removeAdditional: true,
          },
        },
      ],
    },
  ],
]