json-schema-library 11.4.0 → 11.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 11.5.0
+
+- added: option `remotes: JsonSchema[]` for `compileSchema` to simplify adding remotes
+- fixed: annotation warnings should not be reported for title, description or default
+- deprecated: DraftEditor Draft
+
 ### v11.4.0
 
 - added schema annotation on `compileSchema` for unknown format

package/README.md

@@ -6,6 +6,14 @@
     json-schema-library
 </h1>
 
+_json-schema-library_ is the [most compliant JSON Schema validator](https://bowtie.report/#/?language=typescript&language=javascript) for the web, fully supporting all major JSON Schema draft versions. Read [Draft Support](#draft-support) for more details.
+
+![draft-04](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sagold/60138b5d728d1f8f92ba29546dee7c00/raw/jsl-draft04.json)
+![draft-06](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sagold/60138b5d728d1f8f92ba29546dee7c00/raw/jsl-draft06.json)
+![draft-07](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sagold/60138b5d728d1f8f92ba29546dee7c00/raw/jsl-draft07.json)
+![draft-2019-09](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sagold/60138b5d728d1f8f92ba29546dee7c00/raw/jsl-draft2019-09.json)
+![draft-2020-12](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sagold/60138b5d728d1f8f92ba29546dee7c00/raw/jsl-draft2020-12.json)
+
 > **json-schema-library** provides tools and utilities for working with JSON Schema - enabling creation, validation, and schema exploration. Unlike most validators and editors, which hide the inner workings, this library is designed for developers building custom tools around JSON Schema. It runs in both Node and browser environments, prioritizing flexibility and extensibility over minimal memory footprint or raw performance.
 
 ---
@@ -107,18 +115,11 @@ 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:
+All JSON Schema passed to `compileSchema` are validated automatically. To retrieve any schema errors you can access the property `schemaErrors` of the main node. `schemaAnnotations` contains all JSON Schema keywords that are not part of the used draft and any custom keyword that does not start with `x-`.
 
 ```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
+const { schemaErrors, schemaAnnotations } = root; // JsonError[]
 ```
 
 <details><summary>Example for schema validation errors</summary>
@@ -145,15 +146,6 @@ console.log(schemaErrors[0]);
 
 </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>
 
 ---
@@ -180,6 +172,13 @@ console.log(schemaAnnotations[0]);
 
 </details>
 
+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
+```
+
 ### SchemaNode
 
 `compileSchema` builds a tree where each sub-schema becomes its own SchemaNode. Every node in the tree offers the same set of methods.
@@ -225,41 +224,30 @@ assert(root === childNode.parent);
 
 </details>
 
-<details><summary>All nodes share a context</summary>
-
----
-
-A context is shared across all nodes of a schema
+### Draft Support
 
-```ts
-const root = compileSchema(mySchema);
-const { node: childNode } = root.getNode("#/image");
-assert(root.context === childNode.context);
-```
+_json-schema-library_ fully supports all draft versions _draft-04, draft-06, draft-07, draft-2019-09 and draft-2020-12_.
 
-And some context properties are shared across all schema added as remotes. The property `rootNode` refers to the root-schema for the current node
+<details><summary>References</summary>
 
-```ts
-const root = compileSchema(mySchema);
-const { node: childNode } = root.getNode("#/image");
-assert(root === childNode.context.rootNode);
-```
+---
 
-Note that rootNodes will change when working across remote schema (using $ref).
+- Draft support is defined by running a validator against the official [json-schema-test-suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite).
+- _json-schema-library_ passes all tests from [json-schema-test-suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite) which can be inspected in [github actions](https://github.com/sagold/json-schema-library/actions/workflows/ci.yaml)
+- To compare _json-schema-library_ to other validators refer to the official [Bowtie Report](https://bowtie.report/#/?language=typescript&language=javascript), which runs a subset of _json-schema-test-suite_ on all registered validators
 
 ---
 
 </details>
 
-> [!CAUTION]
-> It is not advised to work on context directly, but it might be useful in some situations
+> Please note that these reports refer to validation only. _json-schema-library_ offers tooling outside of validation and strives to be as spec-compliant as possible.
 
-### Draft Support
+**format validators**
 
-_json-schema-library_ fully supports all core features of draft versions draft-04, draft-06, draft-07, draft-2019-09 and draft-2020-12. Additionally, all JSON Schema format validators are supported:
+All JSON Schema format validators are supported:
 
-- The following formats are **available per default**: `date`, `date-time`, `duration`, `email`, `json-pointer`, `relative-json-pointer`, `regex`, `time`, `url`, `uuid`
-- **Add remaining format** validators `hostname`, `idn-email`, `ipv4`, `ipv6`, `uri`, `uri-reference`, `uri-template` to drafts with:
+- **per default** the following formats available: `date`, `date-time`, `duration`, `email`, `json-pointer`, `relative-json-pointer`, `regex`, `time`, `url`, `uuid`
+- **add remaining format** validators `hostname`, `idn-email`, `ipv4`, `ipv6`, `uri`, `uri-reference`, `uri-template` to drafts with:
 
 ```ts
 import { addFormats } from "json-schema-library/formats";
@@ -270,21 +258,6 @@ addFormats([draft04, draft06, draft07, draft2019, draft2020]);
 
 You can always override or extend format validation as is documented in [draft customization](#draft-customization).
 
-<details><summary>Overview draft support</summary>
-
----
-
-Draft support is defined by running a validator against the official [json-schema-test-suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite).
-
-- Test results for _json-schema-library_ can be inspected in [github actions](https://github.com/sagold/json-schema-library/actions/workflows/ci.yaml)
-- A comparison to other validators is listed on [json-schema-benchmark](https://github.com/sagold/json-schema-benchmark)
-
-Please note that these benchmarks refer to validation only. _json-schema-library_ offers tooling outside of validation and strives to be as spec-compliant as possible.
-
----
-
-</details>
-
 ## SchemaNode methods
 
 [addRemoteSchema](#addremoteschema) ·