Initial Validator

[pinussilvestrus]

Related to camunda/element-templates-json-schema#11

Which issue does this PR address?

• Move validation library from bpmn-io/element-templates-json-schema
• Add test coverage with example schema

Related to camunda/element-templates-json-schema#11

Acceptance Criteria

• Corresponds to the concept
• Corresponds to the design

Definition of Done

• corresponds to the design principles
• corresponds to the code standards
• passes Continuous Integration checks
• available as feature branch on GitHub
  • contains the cleaned up commit history
  • commit messages satisfy our commit message guidelines
  • a single commit closes the issue via Closes #issuenr

[nikku]

Added two comments, other than that 👍

[pinussilvestrus]

I'll update the project to make it even more generic and not element-template specific.

[pinussilvestrus]

I'd even go for

Validator#validate
Validator#validateAll

Instead of

Validator#validateTemplate
Validator#validateTemplates

[nikku]

I've pushed a few commits on top:

• Using named exports, rather than default exports as these better operate with CJS / ESM
• Unifying the validator functions so that both return { valid: true|false } (3fc8232)
• Providing the validated object with the validation result, i.e. it changed to { valid, object, errors } (9eafa28)

The last two things are up for debate. I personally believe whoever uses the library will do his / her filtering / collecting of errors anyway, so the more generic API would work for me, too.

Added a test case, how extracting of valid templates looks: https://github.com/bpmn-io/json-schema-validator/pull/1/files#diff-8f573ab0dcdbf810d70135136d063a35a616b34aafaa78566ba814952eb1dc89R66.

Note, as mentioned, that an app likely does more. It will likely collect both valid templates and errors at the same time.

[pinussilvestrus]

I like the more generic approach. Let's make the most out of it 👍

[nikku]

I guess this one is ready to be released?

[pinussilvestrus]

Yes! I plan to do the initial release for it today 👍

[pinussilvestrus]

I would assume the API is stable, so v1.0.0 would be appropriate? What do you think?

[nikku]

Yes. Starting with a 0.0.1 works, too.

[nikku]

I'd start with 0.x, to be fair.

[pinussilvestrus]

Yeah, let's keep the stableness open.