change: rename reduce to reduceSchema

Author: sagold

README.md

@@ -163,7 +163,7 @@ Please note that these benchmarks refer to validation only. _json-schema-library
 
 ## SchemaNode methods
 
-[**validate**](#validate) · [**validateAsync**](#validateasync) · [**getData**](#getData) · [**getSchema**](#getschema) · [**getChild**](#getchild) · [**reduce**](#reduce) · [**toDataNodes**](#todatanodes) · [**toSchemaNodes**](#toschemanodes) · [**addRemote**](#addremote) · [**compileSchema**](#compileSchema-1) · [createSchema](#createSchema) · [getChildSchemaSelection](#getchildschemaselection)
+[**validate**](#validate) · [**validateAsync**](#validateasync) · [**getData**](#getdata) · [**getSchema**](#getschema) · [**getChild**](#getchild) · [**reduceSchema**](#reduceschema) · [**toDataNodes**](#todatanodes) · [**toSchemaNodes**](#toschemanodes) · [**addRemote**](#addremote) · [**compileSchema**](#compileSchema-1) · [createSchema](#createSchema) · [getChildSchemaSelection](#getchildschemaselection)
 
 ### validate
 
@@ -548,9 +548,38 @@ expect(schema).to.deep.eq({ type: "number" });
 
 </details>
 
-### reduce
+### reduceSchema
 
-`reduce` compiles dynamic schema-keywords of a SchemaNode according to the given data.
+`reduceSchema` compiles dynamic JSON schema keywords of a SchemaNode according to the given data.
+This utility helps walking down the schema-tree with a set of data and it helps getting a mostly
+complete json-schema for a specific data-value.
+
+```ts
+const reducedNode = compileSchema({
+    properties: {
+        trigger: { type: "boolean"}
+    }
+    dependentSchemas: {
+        trigger: {
+            required: ["title"],
+            properties: {
+                title: { type: "string" }
+            }
+        }
+    }
+}).reduceSchema({ trigger: true });
+
+expect(reducedNode.schema).to.deep.eq({
+    required: ["title"],
+    properties: {
+        trigger: { type: "boolean"},
+        title: { type: "string" }
+    }
+});
+```
+
+⚠️ Please be aware that certain schema-definitions are lost when resolving or merging sub-schemas.
+This mainly refers to validation-properties, but also some ambigiuous schema might get overriden.
 
 ### toDataNodes
 
@@ -1052,8 +1081,17 @@ expect(resolvedNode?.schema).to.deep.eq({
 
 ## Breaking Changes
 
--   `each(data, callback)` has been replaced by `const nodes = toDataNodes(data)`
--   `eachSchema(callback)` has been replaced by `const nodes = toSchemaNodes()`
+-   `compileSchema` is a standalone function which replaces `Draft`-Class
+-   all return values for JSON Schema are `SchemaNode` that contain a schema-property
+-   `draft.getTemplate(inputData)` has been **renamed** to `node.getData(inputData)`
+-   `draft.each(data, callback)` has been **replaced** by `const nodes = node.toDataNodes(data)`
+-   `draft.eachSchema(callback)` has been **replaced** by `const nodes = node.toSchemaNodes()`
+-   `draft.isValid(data)` has been **replaced** by `node.validate(data).valid`
+-   `draft.getSchema(options)` has been **changed** to `node.getSchema(pointer, data, options)`
+-   `draft.step(property, data)` has been **renamed** to `node.getChild(property, data)`
+-   `draft.addRemoteSchema(schema)` has been **renamed** to `node.addRemote(schema)`
+-   `draft.createSchemaOf(schema)` has been **renamed** to `node.createSchema(schema)`
+-   draft customization has completely changed
 
 ### v10.0.0
 

src/SchemaNode.ts

@@ -230,7 +230,7 @@ export const SchemaNodeMethods = {
 
         let node = this as SchemaNode;
         if (node.reducers.length) {
-            const result = node.reduce(data, { key, path, pointer });
+            const result = node.reduceSchema(data, { key, path, pointer });
             if (result.error) {
                 return result;
             }
@@ -287,16 +287,13 @@ export const SchemaNodeMethods = {
         return node.context.methods.getData(node, data, opts);
     },
 
-    reduce(
+    reduceSchema(
         data: unknown,
         options: { key?: string | number; pointer?: string; path?: ValidationPath } = {}
     ): OptionalNodeAndError {
         const { key, pointer, path } = options;
         const resolvedNode = { ...this.resolveRef({ pointer, path }) } as SchemaNode;
-        // const resolvedSchema = mergeSchema(this.schema, resolvedNode?.schema);
-        // const node = (this as SchemaNode).compileSchema(resolvedSchema, this.spointer, resolvedSchema.schemaId);
         const node = mergeNode(this, resolvedNode, "$ref");
-        // const node = resolvedNode;
 
         // @ts-expect-error bool schema
         if (node.schema === false) {

src/compileSchema.getChild.test.ts

@@ -277,7 +277,7 @@ describe("compileSchema : getChild", () => {
                 }
             }).getChild("dynamicSchema");
 
-            const { node } = res.reduce({ trigger: true });
+            const { node } = res.reduceSchema({ trigger: true });
 
             assert.deepEqual(node.schema, {
                 type: "object",
@@ -624,7 +624,7 @@ describe("step", () => {
                 }
             }).getChild(0, [{ title: 2 }]);
 
-            const { node } = res.reduce({ title: 2 });
+            const { node } = res.reduceSchema({ title: 2 });
 
             assert.deepEqual(node.schema, {
                 type: "object",
@@ -643,7 +643,7 @@ describe("step", () => {
                 }
             }).getChild(1, [{ title: "two" }, { title: 4 }]);
 
-            const { node } = res.reduce({ title: 4 });
+            const { node } = res.reduceSchema({ title: 4 });
 
             assert.deepEqual(node.schema, { type: "object", properties: { title: { type: "number" } } });
         });
@@ -660,7 +660,7 @@ describe("step", () => {
                 }
             }).getChild(1, [{ title: "two" }, { title: 4 }]);
 
-            const { node } = res.reduce({ title: 4 });
+            const { node } = res.reduceSchema({ title: 4 });
 
             assert.deepEqual(node.schema, { type: "object", properties: { title: { type: "number", minimum: 2 } } });
         });
@@ -676,7 +676,7 @@ describe("step", () => {
                 }
             }).getChild(1, [{ title: "two" }, { title: 4 }]);
 
-            const { node } = res.reduce({ title: "two" });
+            const { node } = res.reduceSchema({ title: "two" });
 
             assert.deepEqual(node.schema, {
                 type: "object",