change: rename templateDefaultOptions to getDataDefaultOptions

Author: sagold

README.md

@@ -57,7 +57,7 @@ type CompileOptions = {
     // if format-validations should create errors. Defaults to true
     formatAssertion: boolean | "meta-schema";
     // default options for all calls to node.getData()
-    templateDefaultOptions?: TemplateOptions;
+    getDataDefaultOptions?: TemplateOptions;
 };
 ```
 
@@ -77,11 +77,11 @@ compileSchema(mySchema, { remote: anotherSchemaNode });
 compileSchema(mySchema, { formatAssertion: false });
 
 // for all calls to getData, `addOptionalProps` is `true` per default
-compileSchema(mySchema, { templateDefaultOptions: { addOptionalProps: true } });
+compileSchema(mySchema, { getDataDefaultOptions: { addOptionalProps: true } });
 ```
 
 Details on _drafts_ are documented in [draft customization](#draft-customization).
-Details on `templateDefaultOptions` are documented in [getData](#getData).
+Details on `getDataDefaultOptions` are documented in [getData](#getData).
 
 ### SchemaNode
 
@@ -1157,17 +1157,21 @@ The new implementation revolves around compiling schemas into a **SchemaNode** t
     -   `draft.addRemoteSchema(schema)` → `node.addRemote(schema)`
     -   `draft.createSchemaOf(schema)` → `node.createSchema(schema)`
 
+-   **Renamed Properties**:
+
+    -   `templateDefaultOptions` → `getDataDefaultOptions`
+
 -   **Draft Customization**: Customizing drafts has changed completely. The previous methods of extending drafts are no longer valid, and draft handling is now centered around `SchemaNode`.
 
--   **Remove Property**:
+-   **Removed Error Property `name`**:
     Error property `name` has been removed from `JsonError` in favor of `code`.
 
 -   **Removed Configuration Option**:  
     The `templateDefaultOptions` property has been removed from the global settings object. You should now configure it using the `compileSchema` options:
 
     ```ts
     compileSchema(schema, {
-        templateDefaultOptions: {
+        getDataDefaultOptions: {
             addOptionalProps: false,
             removeInvalidData: false,
             extendDefaults: true

src/SchemaNode.ts

@@ -61,7 +61,7 @@ export type Context = {
     /** draft formats & validators */
     formats: Draft["formats"];
     /** [SHARED USING ADD REMOTE] getData default options */
-    templateDefaultOptions?: TemplateOptions;
+    getDataDefaultOptions?: TemplateOptions;
 };
 
 export interface SchemaNode extends SchemaNodeMethodsType {
@@ -316,7 +316,7 @@ export const SchemaNodeMethods = {
         const node = this as SchemaNode;
         const opts = {
             recursionLimit: 1,
-            ...node.context.templateDefaultOptions,
+            ...node.context.getDataDefaultOptions,
             cache: {},
             ...(options ?? {})
         };

src/compileSchema.test.ts

@@ -53,8 +53,8 @@ describe("compileSchema vocabulary", () => {
     });
 });
 
-describe("compileSchema templateDefaultOptions", () => {
-    it("should apply `templateDefaultOptions.addOptionalProps` to getData", () => {
+describe("compileSchema getDataDefaultOptions", () => {
+    it("should apply `getDataDefaultOptions.addOptionalProps` to getData", () => {
         const schema = {
             properties: {
                 type: { const: "node" },
@@ -65,14 +65,14 @@ describe("compileSchema templateDefaultOptions", () => {
         let data = compileSchema(schema).getData();
         assert.deepEqual(data, {});
 
-        data = compileSchema(schema, { templateDefaultOptions: { addOptionalProps: true } }).getData();
+        data = compileSchema(schema, { getDataDefaultOptions: { addOptionalProps: true } }).getData();
         assert.deepEqual(data, {
             type: "node",
             nodes: []
         });
     });
 
-    it("should apply `templateDefaultOptions.recursiveLimit` to getData", () => {
+    it("should apply `getDataDefaultOptions.recursiveLimit` to getData", () => {
         const schema = {
             required: ["type", "nodes"],
             properties: {
@@ -92,7 +92,7 @@ describe("compileSchema templateDefaultOptions", () => {
             ]
         });
 
-        data = compileSchema(schema, { templateDefaultOptions: { recursionLimit: 2 } }).getData();
+        data = compileSchema(schema, { getDataDefaultOptions: { recursionLimit: 2 } }).getData();
         assert.deepEqual(data, {
             type: "node",
             nodes: [

src/compileSchema.ts

@@ -14,7 +14,7 @@ export type CompileOptions = {
     drafts: Draft[];
     remote: SchemaNode;
     formatAssertion: boolean | "meta-schema";
-    templateDefaultOptions?: TemplateOptions;
+    getDataDefaultOptions?: TemplateOptions;
 };
 
 const defaultDrafts: Draft[] = [draft04, draft06, draft07, draft2019, draft2020];
@@ -51,7 +51,7 @@ export function compileSchema(schema: JsonSchema, options: Partial<CompileOption
             anchors: {},
             refs: {},
             ...copy(pick(draft, "methods", "keywords", "version", "formats", "errors")),
-            templateDefaultOptions: options.templateDefaultOptions,
+            getDataDefaultOptions: options.getDataDefaultOptions,
             drafts
         },
         ...SchemaNodeMethods

src/draft2019-09/methods/getData.test.ts

@@ -1669,7 +1669,7 @@ describe("getData (2019)", () => {
                     additionalProperties: false
                 },
                 {
-                    templateDefaultOptions: { removeInvalidData: true }
+                    getDataDefaultOptions: { removeInvalidData: true }
                 }
             );
             const res = node.getData({ valid: "stays", invalid: "removes" });
@@ -1683,7 +1683,7 @@ describe("getData (2019)", () => {
                     additionalProperties: false
                 },
                 {
-                    templateDefaultOptions: { removeInvalidData: true }
+                    getDataDefaultOptions: { removeInvalidData: true }
                 }
             );
             const res = node.getData({ valid: "stays", invalid: "not removed" }, { removeInvalidData: false });

src/methods/getData.test.ts

@@ -1587,7 +1587,7 @@ describe("getData", () => {
                     additionalProperties: false
                 },
                 {
-                    templateDefaultOptions: { removeInvalidData: true }
+                    getDataDefaultOptions: { removeInvalidData: true }
                 }
             );
             const res = node.getData({ valid: "stays", invalid: "removes" });
@@ -1602,7 +1602,7 @@ describe("getData", () => {
                     additionalProperties: false
                 },
                 {
-                    templateDefaultOptions: { removeInvalidData: true }
+                    getDataDefaultOptions: { removeInvalidData: true }
                 }
             );
             const res = node.getData({ valid: "stays", invalid: "not removed" }, { removeInvalidData: false });