json-schema-library 11.3.0 → 11.4.0

package/CHANGELOG.md

@@ -1,9 +1,28 @@
 ## Changelog
 
+### v11.4.0
+
+- added schema annotation on `compileSchema` for unknown format
+- replaced option `withSchemaAnnotations` in favor of always creating all annotations
+
+**Breaking change**: Moved some large format-validators to separate entry point:
+
+- the following format-validators have been moved to a separate entry point "json-schema-library/formats": `hostname`, `idn-email`, `ipv4`, `ipv6`, `uri`, `uri-reference`, `uri-template`
+- the following additional format-validators are available through "json-schema-library/formats": `iri`, `iri-reference`, `idn-hostname`
+
+_Use the following to add the additional format validators to drafts per default:_
+
+```ts
+import { addFormats } from "json-schema-library/formats";
+import { draft04, draft06, draft07, draft2019, draft2020 } from "json-schema-library";
+// add additional formats to the following drafts
+addFormats([draft04, draft06, draft07, draft2019, draft2020]);
+```
+
 ### v11.3.0
 
-- added option 'draft' as fallback for a missing `$schema` id
-- added properties to merge when resolvinf a $ref to `settings.PROPERTIES_TO_MERGE`
+- added option `draft` as fallback for a missing `$schema` id
+- added setting for properties to merge when resolving a `$ref` to `settings.PROPERTIES_TO_MERGE`
 
 ### v11.2.0
 

package/README.md

@@ -46,6 +46,11 @@ console.log(schemaNode.getDraftVersion()); // draft-07
 
 ## Overview
 
+[compileSchema](#compileschema) ·
+[validate input schema](#validate-input-schema) ·
+[SchemaNode](#schemanode) ·
+[Draft Support](#draft-support)
+
 ### compileSchema
 
 Use `compileSchema` once to turn a JSON Schema into a tree of SchemaNodes. After that, you'll work with individual nodes in the tree. You can also pass an options object to `compileSchema` to customize how the nodes are created.
@@ -54,25 +59,25 @@ Use `compileSchema` once to turn a JSON Schema into a tree of SchemaNodes. After
 type CompileOptions = {
   // set of drafts to use
   drafts: Draft[];
+  /** fallback draft version in case no draft_is specified by `schema.$schema` */
+  draft?: string;
   // a context to share
   remote: SchemaNode;
   // if format-validations should create errors. Defaults to true
   formatAssertion: boolean | "meta-schema";
   /** set to true to throw an Error on errors in input schema. Defaults to false */
   throwOnInvalidSchema?: boolean;
-  /** set to true to collect unknown keywords of input schema in `node.schemaAnnotations`. Defaults to false */
-  withSchemaAnnotations?: boolean;
   /** set to true to throw an Error when encountering an unresolvable ref  */
   throwOnInvalidRef?: boolean;
   // default options for all calls to node.getData()
   getDataDefaultOptions?: {
-    // Add all properties (required and optional) to the generated data
+    // add all properties (required and optional) to the generated data
     addOptionalProps?: boolean;
-    // Remove data that does not match input schema. Defaults to false
+    // remove data that does not match input schema. Defaults to false
     removeInvalidData?: boolean;
-    // Set to false to take default values as they are and not extend them. Defaults to true
+    // set to false to take default values as they are and not extend them. Defaults to true
     extendDefaults?: boolean;
-    // Limits how often a $ref should be followed before aborting. Prevents infinite data-structure. Defaults to 1
+    // limits how often a $ref should be followed before aborting. Prevents infinite data-structure. Defaults to 1
     recursionLimit?: number;
   };
 };
@@ -251,7 +256,19 @@ Note that rootNodes will change when working across remote schema (using $ref).
 
 ### Draft Support
 
-_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, most format-validations are supported per default besides the listed format below. You can always override or extend format validation as is documented in [draft customization](#draft-customization).
+_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:
+
+- 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:
+
+```ts
+import { addFormats } from "json-schema-library/formats";
+import { draft04, draft06, draft07, draft2019, draft2020 } from "json-schema-library";
+// add additional formats to the following drafts
+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>
 
@@ -268,17 +285,6 @@ Please note that these benchmarks refer to validation only. _json-schema-library
 
 </details>
 
-<details><summary>Overview format validation support</summary>
-
----
-
-- **`❌ unsupported formats`** iri, iri-reference, idn-hostname
-- **`✅ supported formats`**: date, date-time, date, duration, ecmascript-regex, email, hostname, idn-email, ipv4, ipv6, json-pointer, regex, relative-json-pointer, time, unknown, uri-reference, uri-template, uri, uuid
-
----
-
-</details>
-
 ## SchemaNode methods
 
 [addRemoteSchema](#addremoteschema) ·
@@ -435,6 +441,22 @@ schemaNode.getNodeRef("https://sagold.com/remote#/properties/character");
 const someNode = node.compileSchema({ prefixItems: [{ type: "string" }, { $ref: "#/$defs/string" }] });
 ```
 
+#### custom error messages
+
+You can set custom errors messages locally by using the errors-keyword:
+
+```ts
+const { errors } = compileSchema({
+  type: "array",
+  minItems: 2,
+  errorMessages: {
+    "min-items-error": "Custom error {{minItems}}"
+  }
+}).validate([1]);
+
+assert.deepEqual(errors[0].message, "Custom error 2");
+```
+
 ### createSchema
 
 `createSchema` returns a simple JSON Schema for the input data.
@@ -892,7 +914,8 @@ if (node) {
 }
 ```
 
----
+> [!CAUTION]
+> `getNode` returns the root of the current schema. If a remote schema was resolved, the returned node will be the remote-schema root - not the initial schema-root you passed in to compileSchema
 
 ### reduceNode
 
@@ -1150,7 +1173,7 @@ console.log(errors); /// [{ code: "type-error", value: "data", pointer: "#", ...
 
 ## Draft Customization
 
-[**Extending a Draft**](#extending-a-draft) · [**Keyword**](#keyword)
+[Extending a Draft](#extending-a-draft) · [Overwrite format validator](#overwrite-a-format-validator) · [Keyword](#keyword)
 
 _json-schema-library_ uses the concept of **drafts** to support different versions of the JSON Schema specification — such as Draft 04, Draft 07, or 2020-12 — and to allow customization of schema behavior.
 
@@ -1549,21 +1572,7 @@ const myDraft = extendDraft(draft2020, {
 });
 ```
 
-### errorMessages
-
-You can set custom errors messages locally by using the errors-keyword:
-
-```ts
-const { errors } = compileSchema({
-  type: "array",
-  minItems: 2,
-  errorMessages: {
-    "min-items-error": "Custom error {{minItems}}"
-  }
-}).validate([1]);
-
-assert.deepEqual(errors[0].message, "Custom error 2");
-```
+## Settings
 
 ### regexFlags
 

package/bowtie/bowtie.test.ts

@@ -14,6 +14,86 @@ const isErrorResponse = (value: unknown): value is ErrorResponse =>
 const remote = compileSchema({ $id: "draft2020-12" });
 remotes.map((schema: JsonSchema) => remote.addRemoteSchema(schema.$id ?? schema.id, schema));
 
+describe("bowtie (draft4)", async () => {
+    before(async () => {
+        await runCommand({ cmd: "start", version: 1 });
+        await runCommand({ cmd: "dialect", dialect: "http://json-schema.org/draft-04/schema#" });
+    });
+    after(async () => runCommand({ cmd: "stop" }));
+
+    const registry = {
+        "http://localhost:1234/draft4/name.json": {
+            definitions: { orNull: { anyOf: [{ type: "null" }, { $ref: "#" }] } },
+            type: "string"
+        },
+        "http://localhost:1234/v1/nested-absolute-ref-to-string.json": {
+            $defs: { bar: { $id: "http://localhost:1234/v1/the-nested-id.json", type: "string" } },
+            $ref: "http://localhost:1234/v1/the-nested-id.json"
+        },
+        "http://localhost:1234/nested/string.json": { type: "string" },
+        "http://localhost:1234/baseUriChange/folderInteger.json": { type: "integer" },
+        "http://localhost:1234/draft4/subSchemas.json": {
+            definitions: { integer: { type: "integer" }, refToInteger: { $ref: "#/definitions/integer" } }
+        },
+        "http://localhost:1234/v1/different-id-ref-string.json": {
+            $id: "http://localhost:1234/v1/real-id-ref-string.json",
+            $defs: { bar: { type: "string" } },
+            $ref: "#/$defs/bar"
+        },
+        "http://localhost:1234/v1/urn-ref-string.json": {
+            $id: "urn:uuid:feebdaed-ffff-0000-ff01-0000deadbeef",
+            $defs: { bar: { type: "string" } },
+            $ref: "#/$defs/bar"
+        },
+        "http://localhost:1234/integer.json": { type: "integer" },
+        "http://localhost:1234/nested/foo-ref-string.json": {
+            type: "object",
+            properties: { foo: { $ref: "string.json" } }
+        },
+        "http://localhost:1234/baseUriChangeFolder/folderInteger.json": { type: "integer" },
+        "http://localhost:1234/draft4/locationIndependentIdentifier.json": {
+            definitions: { refToInteger: { $ref: "#foo" }, A: { id: "#foo", type: "integer" } }
+        },
+        "http://localhost:1234/baseUriChangeFolderInSubschema/folderInteger.json": { type: "integer" }
+    };
+
+    it("Location-independent identifier in remote ref - additional items match schema", async () => {
+        const response = await runCommand({
+            cmd: "run",
+            seq: 1,
+            case: {
+                description: "Location-independent identifier in remote ref",
+                schema: {
+                    $ref: "http://localhost:1234/draft4/locationIndependentIdentifier.json#/definitions/refToInteger"
+                },
+                registry,
+                tests: [{ description: "integer is valid", instance: 1, valid: true }]
+            }
+        });
+        assert(isRunCmdResponse(response));
+        assert(!isErrorResponse(response.results[0]));
+        assert.equal(response.results[0].valid, true);
+    });
+
+    it("Location-independent identifier in remote ref - additional items do not match schema", async () => {
+        const response = await runCommand({
+            cmd: "run",
+            seq: 1,
+            case: {
+                description: "Location-independent identifier in remote ref",
+                schema: {
+                    $ref: "http://localhost:1234/draft4/locationIndependentIdentifier.json#/definitions/refToInteger"
+                },
+                registry,
+                tests: [{ description: "string is invalid", instance: "foo", valid: false }]
+            }
+        });
+        assert(isRunCmdResponse(response));
+        assert(!isErrorResponse(response.results[0]));
+        assert.equal(response.results[0].valid, false);
+    });
+});
+
 describe("bowtie (draft7)", async () => {
     before(async () => {
         await runCommand({ cmd: "start", version: 1 });

package/bowtie/package.json

@@ -5,7 +5,7 @@
     "format": "prettier -w ."
   },
   "dependencies": {
-    "json-schema-library": ">=11.2.0",
+    "json-schema-library": ">=11.3.1",
     "prettier": "^3.8.1"
   }
 }

package/dist/chunk-350yNsax.cjs

@@ -0,0 +1 @@
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),s=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},c=(n,r,a)=>(a=n==null?{}:e(i(n)),s(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));Object.defineProperty(exports,`n`,{enumerable:!0,get:function(){return c}}),Object.defineProperty(exports,`t`,{enumerable:!0,get:function(){return o}});