bpmn-io / json-schema-validator Goto Github PK

What should we do?

Currently, we use ajv as the underlying provider to validate objects against a schema (cf. decision was made here: #1). ajv gives us the possibility to provide custom errorMessage properties in a flexible manner via ajv-errors, especially to make them human-readable.

However ajv comes with a big bundle size. In the meantime, there are alternatives who might fit better in this regard. On the other hand, ajv is forcing us a bit into their way of doing stuff (cf. #4, migration to v7 does not work well on node@14).

Why should we do it?

We could investigate a lightweight alternative for ajv to drop the downsides described above. The following criteria have to be considered

• Extensibility (adding custom keywords, adding transformers on top)
• Configurable
• Return all schema errors, have the control what do with them
• Custom error messages defined in the Schema
• Support the latest JSON Schema definition (we use draft-07 inside our own Camunda Element Templates Schema which relies on newer features)

Resources

Adapted JSON Schema Validators for Javascript