The ts-jsonschema-builder from justeat

ts-jsonschema-builder's Issues

Static factories for schema builders.

As per the suggestion in #8 PR review.

Create static builder factories for creating schema objects.
Such fluent builders will be more convenient to use and easier to discover the API with IntelliSense.
For example:

const schema = new Schema<Model>()
        .with(m => m.StringProp, new AnyOf([
          "specificValueNotMatchingRegex",
          /^[A-z]+\.[A-z]+$/,
          new StringSchema({
            enum: ["123"]
          })
        ]))
        .build();

could be expressed as something like

      const schema = new Schema<Model>()
        .with(m => m.StringProp, jsonschema.matching.anyOf([
          "specificValueNotMatchingRegex",
          /^[A-z]+\.[A-z]+$/,
          jsonschema.string.exactMatch("123")
        ]))
        .build();

Security issue detected

See Security tab in repo (lodash library should be updated).

Properties with string names not supported

Objects which have properties using quote strings for names break if any schema rules are setup which validate that property.

repro steps.

Change Model like so:

export class Model {
  public "Quote-Prop"?: string;
  public StringProp?: string;
  // SNIP

And add the following test:

it("Should pass when string property name is a string", () => {

      const model: Model = {};
      model["Quote Prop"] = "abc.def";

      const schema = new Schema<Model>()
        .with(m => m["Quote Prop"], new StringSchema())
        .build();

      assertValid(schema, model);
    });

The the test fails with the following output:

Error: schema is invalid: data.required[0] should be string
    at Ajv.validateSchema (node_modules\ajv\lib\ajv.js:177:16)
    at Ajv._addSchema (node_modules\ajv\lib\ajv.js:306:10)
    at Ajv.compile (node_modules\ajv\lib\ajv.js:112:24)
    at assert (tests\assertion.ts:20:25)
    at Object.assertValid (tests\assertion.ts:10:3)
    at Context.<anonymous> (tests\string.spec.ts:36:7)

This might be an underlying issue with Ajv, I haven't had time to create a reproduction in that library.

This was an issue, as I was trying to validate a json document which had spaces/dashes in the property name.

justeat / ts-jsonschema-builder Goto Github PK

ts-jsonschema-builder's People

Contributors

Stargazers

Watchers

Forkers

ts-jsonschema-builder's Issues

Static factories for schema builders.

Security issue detected

Properties with string names not supported

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent