json-schema-migrate

json-schema-migrate

Migrate JSON-Schema from draft-04 to draft-07, draft-2019-09 or draft-2020-12

Install

npm install json-schema-migrate

Usage

const migrate = require("json-schema-migrate")
const schema = {
  id: "my-schema",
  minimum: 1,
  exclusiveMinimum: true,
}
migrate.draft7(schema)
// or migrate.draft2019(schema)
// or migrate.draft2020(schema)

console.log(schema)
// {
//  $id: 'my-schema',
//  exclusiveMinimum: 1
// }

You can access Ajv instance that is used to migrate schema using migrate.getAjv function:

console.log(migrate.getAjv().errorsText(errors))

Changes in schemas after migration

• id is replaced with $id
• $schema value becomes draft-07, draft-2019-09 or draft-2020-12 meta-schema
• draft-04 boolean form of exclusiveMaximum/Minimum is replaced with the current number form
• enum with a single allowed value is replaced with const
• Non-standard constant is replaced with const
• empty schema is replaced with true
• schema {"not":{}} is replaced with false
• draft2019 function additionally replaces:
  • definitions with $defs
  • dependencies with dependentRequired and dependentSchemas
  • "id": "#foo" with "$anchor": "foo"
  • "id": "schema#foo" with "$id": "schema", "$anchor": "foo"
• draft2020 function additionally replaces array form of items with prefixItems (and additionalItems with items)

License

MIT

Similar packages

Other packages similar to json-schema-migrate

ajv

Ajv is a popular JSON schema validator that supports multiple JSON schema drafts, including draft-04, draft-06, draft-07, and draft-2019-09. While Ajv is primarily focused on validation, it also provides some utilities for schema transformation and migration. However, json-schema-migrate is more specialized in the migration process itself, making it a more focused tool for schema version upgrades.

json-schema-ref-parser

json-schema-ref-parser is a library for parsing, resolving, and dereferencing JSON schema $ref pointers. While it does not directly handle schema migration, it is often used in conjunction with tools like json-schema-migrate to manage complex schemas with references. json-schema-migrate specifically targets the migration of schema versions, whereas json-schema-ref-parser focuses on schema resolution and dereferencing.