json-schema-library 11.0.5 → 11.1.0

package/CHANGELOG.md

@@ -1,8 +1,19 @@
 ## Changelog
 
+### v11.1.0
+
+- introduced upcoming keyword `propertyDependenciesKeyword` to package export
+- added support for keyword `deprecatedMessage`
+- introduced schema validation
+
+### v11.0.4, v11.0.5
+
+- removed enforcing packageManager as this failed build-jobs
+
 ### v11.0.3
 
 - fixed type of main input-schema to support boolean
+- enforced yarn as a package manager
 
 ### v11.0.2
 

package/README.md

@@ -94,6 +94,79 @@ compileSchema(mySchema, { getDataDefaultOptions: { addOptionalProps: true } });
 Details on _drafts_ are documented in [draft customization](#draft-customization).
 Details on `getDataDefaultOptions` are documented in [getData](#getData).
 
+### validate input schema
+
+All JSON Schema passed to `compileSchema` are validated automatically. To retrieve any schema errors you can access the property `schemaErrors` of the main node:
+
+```ts
+const root = compileSchema(mySchema);
+const { schemaErrors } = root; // JsonError[]
+```
+
+Use the option `throwOnInvalidSchema:true` of `compileSchema` to throw an Error for a input schema containing errors:
+
+```ts
+const root = compileSchema({ properties: 123 }, { throwOnInvalidSchema: true });
+// throws Error
+```
+
+<details><summary>Example for validation errors</summary>
+
+---
+
+```ts
+const { schemaErrors } = compileSchema({ $defs: 999 });
+console.log(schemaErrors[0]);
+{
+  type: 'error',
+  code: 'schema-error',
+  message: 'Invalid schema found at #: $defs must be an object - received: number',
+  data: {
+    pointer: '#',
+    schema: { '$defs': 999 },
+    value: 999,
+    message: '$defs must be an object - received: number'
+  }
+}
+```
+
+---
+
+</details>
+
+To collect JSON Schema annotations for unused keywords you can opt in with option `withSchemaAnnotations`:
+
+```ts
+const root = compileSchema(mySchema, { withSchemaAnnotations: true });
+const { schemaAnnotations } = root; // JsonAnnotation[]
+```
+
+This collects all JSON Schema keywords not part of the used draft and any custom keywords. Custom keywords starting with `x-` are allowed and thus will not create an annotation.
+
+<details><summary>Example for validation annotations</summary>
+
+---
+
+```ts
+const { schemaErrors } = compileSchema({ options: {} }, { withSchemaAnnotations: true });
+console.log(schemaErrors[0]);
+{
+   type: 'annotation',
+   code: 'unknown-keyword-warning',
+   message: "Keyword 'options' is not a valid keyword to draft 'draft-2020-12'",
+   data: {
+     pointer: '#/options',
+     schema: { options: {} },
+     value: 'options',
+     draft: 'draft-2020-12'
+   }
+ }
+```
+
+---
+
+</details>
+
 ### SchemaNode
 
 `compileSchema` builds a tree where each sub-schema becomes its own SchemaNode. Every node in the tree offers the same set of methods.
@@ -1379,6 +1452,45 @@ const dependentSchemasKeyword = draft2020.keywords.find((f) => f.keyword === "de
 
 ## Keyword extensions
 
+### propertyDependencies
+
+Resolves an object-schema by `propertyName:propertyValue`
+
+```ts
+{
+  type: "object",
+  propertyDependencies: {
+     propertyName: {
+         propertyValue: {
+          properties: {
+            id: { type: "string" }
+          }
+         }
+     }
+}
+
+// matches and returns error for id
+{
+  "propertyName": "propertyValue",
+  "id": 123
+}
+```
+
+Note that this keyword is not added by default as it is not part yet of the JSONSchema spec. Add this keyword with:
+
+```ts
+import { compileSchema, draft2020, extendDraft, propertyDependenciesKeyword } from "json-schema-library";
+
+const draft = extendDraft(draft2020, {
+  keywords: [propertyDependenciesKeyword]
+});
+
+const node = compileSchema({ propertyDependencies: {} }, { drafts: [draft] });
+```
+
+- Note: this keyword may replace `OneOfProperty`
+- Reference: https://docs.google.com/presentation/d/1ajXlCQcsjjiMLsluFIILR7sN5aDRBnfqQ9DLbcFbqjI/mobilepresent?slide=id.g3ae4fb2e16d_0_15
+
 ### oneOfProperty
 
 For `oneOf` resolution, JSON Schema states that data is valid if it validates against exactly one of those sub-schemas. In some scenarios this is unwanted behaviour, as the actual `oneOf` schema is known and only validation errors of this exact sub-schema should be returned.