update: docs and configuration of getTemplate *addOptionalProps*

Author: Sascha Goldhofer

CHANGELOG.md

@@ -1,33 +1,34 @@
 ## Changelog
 
-- [Breaking] renamed `JSON` types and variables to `Json`
-- [Breaking] remove `oneOfSchema` helper property in favor of `getOneOfOrigin()` non-enumerable function
-- [Breaking] `getTemplate` will add only required properties per default. Use `addOptionalProps:true` to change this behaviour
-- [add] introduce `mergeSchema`, `reduceSchema` and `resolveDynamicSchema`
-- [refactor] move dynamic resolvers `anyOf`, `allOf`, `oneOf`, `dependencies` and `if` to features modules
+-   [Breaking] renamed `JSON` types and variables to `Json`
+-   [Breaking] remove `oneOfSchema` helper property in favor of `getOneOfOrigin()` non-enumerable function
+-   [Breaking] `getTemplate` will add only required properties per default. Use `addOptionalProps:true` to change this behaviour
+-   [Breaking] change `unique-items-error` to point to error for duplicated item.
+
+-   [add] introduce `mergeSchema`, `reduceSchema` and `resolveDynamicSchema`
+-   [refactor] move dynamic resolvers `anyOf`, `allOf`, `oneOf`, `dependencies` and `if` to features modules
 
 ### 7.0.0
 
 -   changed core interface to draft for simpler configuration using a configuration map
 
 **Breaking Changes**
 
-- replaced `Core` interface by new `Draft` interface
-- changed export of `Interface` to `Draft`
-- changed export of `Interface` to `Draft`
-- renamed `addSchema` to `addRemoteSchema`
-- changed api of `compileSchema` to have an additional schema-parameter for rootSchema reference
-- changed `compileSchema` and `addRemoteSchema` to work on instance state, instead of global state
-- `addRemoteSchema`, `compileSchema` now requires draft instance as first parameter
-- removed direct export of following functions: `addValidator`, `compileSchema`, `createSchemaOf`, `each`, `eachSchema`, `getChildSchemaSelection`, `getSchema`, `getTemplate`, `isValid`, `step`, `validate`. They are still accessible under the draftConfigs of each draft-version
-- changed draft version of `JsonEditor` to draft07
+-   replaced `Core` interface by new `Draft` interface
+-   changed export of `Interface` to `Draft`
+-   changed export of `Interface` to `Draft`
+-   renamed `addSchema` to `addRemoteSchema`
+-   changed api of `compileSchema` to have an additional schema-parameter for rootSchema reference
+-   changed `compileSchema` and `addRemoteSchema` to work on instance state, instead of global state
+-   `addRemoteSchema`, `compileSchema` now requires draft instance as first parameter
+-   removed direct export of following functions: `addValidator`, `compileSchema`, `createSchemaOf`, `each`, `eachSchema`, `getChildSchemaSelection`, `getSchema`, `getTemplate`, `isValid`, `step`, `validate`. They are still accessible under the draftConfigs of each draft-version
+-   changed draft version of `JsonEditor` to draft07
 
 **Milestone**
 
-- [✓] configurable and consistent draft api
-- [✓] expose all function under their draft-version
-- [✓] remove global states in remotes
-
+-   [✓] configurable and consistent draft api
+-   [✓] expose all function under their draft-version
+-   [✓] remove global states in remotes
 
 ### 6.1.0
 
@@ -37,76 +38,77 @@
 
 ### version 4.0
 
-- [✓] Fix -- latest benchmark tests
-- [✓] Fix -- iterate schema (using typeDefs)
-- [✓] Fix -- scopes per schema-instance
-- [✓] Fix -- insane $ref resolution 'node' can be in 'root/node' or 'root/folder/node'
-- [✓] Refactor -- remove duplication from resolveRef.strict and resolveRef.withOverwrite
-- [✓] Change -- improve function apis (param order, rootSchema per default)
-- [✓] Fix -- `getTemplate` to resolve $ref to infinity
+-   [✓] Fix -- latest benchmark tests
+-   [✓] Fix -- iterate schema (using typeDefs)
+-   [✓] Fix -- scopes per schema-instance
+-   [✓] Fix -- insane $ref resolution 'node' can be in 'root/node' or 'root/folder/node'
+-   [✓] Refactor -- remove duplication from resolveRef.strict and resolveRef.withOverwrite
+-   [✓] Change -- improve function apis (param order, rootSchema per default)
+-   [✓] Fix -- `getTemplate` to resolve $ref to infinity
 
 **Breaking Changes**
 
-- `iterateSchema` renamed to `eachSchema`
-- `validate` and `isValid` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
-- `validateAsync` changed signature from (schema, data, [pointer], [onError]) to (data, [{ schema, pointer, onError }])
-- `getTemplate` changed signature from (schema, data) to (data, [schema])
-- `getSchema` changed signature from (schema, data, [pointer]) to (pointer, [data], [schema])
-- `each` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
-- `resolveOneOf` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
-- `precompileSchema` renamed to `compileSchema`
+-   `iterateSchema` renamed to `eachSchema`
+-   `validate` and `isValid` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
+-   `validateAsync` changed signature from (schema, data, [pointer], [onError]) to (data, [{ schema, pointer, onError }])
+-   `getTemplate` changed signature from (schema, data) to (data, [schema])
+-   `getSchema` changed signature from (schema, data, [pointer]) to (pointer, [data], [schema])
+-   `each` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
+-   `resolveOneOf` changed signature from (schema, data, [pointer]) to (data, [schema], [pointer])
+-   `precompileSchema` renamed to `compileSchema`
 
 **Milestone** consistent feature support
 
-- [✓] no side-effects on added remote-schemas
-- [✓] rootSchema should always be compiled
-- [✓] Add missing support for allOf and anyOf type definitions in 'step' and 'getTemplate'
-- [✓] Complete schema support in iterateSchema
-
+-   [✓] no side-effects on added remote-schemas
+-   [✓] rootSchema should always be compiled
+-   [✓] Add missing support for allOf and anyOf type definitions in 'step' and 'getTemplate'
+-   [✓] Complete schema support in iterateSchema
 
 ## 2017
 
-- [~] Features -- Improve validation maps to add & hook (!) custom entries (WIP, Add tests)
-- [✓] Fix -- Return all errors in oneOf-validation
-- [✓] Feature -- Error progress notification for async validation
-- [✓] Refactor -- Keyword validators should only be called for defined keyword
-- [✓] Feature -- getSchema of patternProperties
+-   [~] Features -- Improve validation maps to add & hook (!) custom entries (WIP, Add tests)
+-   [✓] Fix -- Return all errors in oneOf-validation
+-   [✓] Feature -- Error progress notification for async validation
+-   [✓] Refactor -- Keyword validators should only be called for defined keyword
+-   [✓] Feature -- getSchema of patternProperties
 
 **Milestone** add remaining draft04 features
-- [✓] remote references
-- [✓] default format validations
-- [✓] definitions
-- [✓] dependencies
-- [✓] Features -- allOf
-- [✓] Features -- anyOf
-- [✓] Features -- type-array
-- [✓] Features -- patternProperties
-- [✓] Features -- uniqueItems
-- [✓] Features -- oneOf: fail for multiple matching oneof-schemas
-- [✓] Features -- oneOf: for non-arrays
-- [✓] Features -- required (array of properties). Currently every property is required by default
 
+-   [✓] remote references
+-   [✓] default format validations
+-   [✓] definitions
+-   [✓] dependencies
+-   [✓] Features -- allOf
+-   [✓] Features -- anyOf
+-   [✓] Features -- type-array
+-   [✓] Features -- patternProperties
+-   [✓] Features -- uniqueItems
+-   [✓] Features -- oneOf: fail for multiple matching oneof-schemas
+-   [✓] Features -- oneOf: for non-arrays
+-   [✓] Features -- required (array of properties). Currently every property is required by default
 
 ## 16/12
 
-- [✓] Testing (validate real json files)
-- [✓] Test + document core differences
-- [✓] Add async validation
+-   [✓] Testing (validate real json files)
+-   [✓] Test + document core differences
+-   [✓] Add async validation
 
 **Milestone** customizable default and form (json-editor) validation
-- [✓] Sanitize Errors 
-- [✓] Features -- Add core: Form, fix core: Draft04 - by using separate functions
-- [✓] Add getTemplate to core (resolveOneOf)
-- [✓] Breaking -- Add sort of 'core' to customize validation, stepper, errors etc and reduce requried arguments
+
+-   [✓] Sanitize Errors
+-   [✓] Features -- Add core: Form, fix core: Draft04 - by using separate functions
+-   [✓] Add getTemplate to core (resolveOneOf)
+-   [✓] Breaking -- Add sort of 'core' to customize validation, stepper, errors etc and reduce requried arguments
 
 **Milestone** custom validator (form-validation, oneOfProperty)
-- [✓] Features -- additionalProperties: Boolean | Schema
-- [✓] Features -- additionalItems: Boolean | Schema
-- [✓] Features -- Add support for type "integer"
-- [✓] Features -- oneOf -> oneOfProperty ( + Documentation)
-- [✓] Breaking -- change isValid to return boolean
-- [✓] Breaking -- use `step` in isValid -- bad: circular dependencies with step -> guessOneOfSchema -> isValid --X-> step
-- [✓] Features -- items: [] schema (order/defined indices)
-- [✓] Features -- not
-- [✓] Features -- return custom errors in data validation
-- [✓] Basics
+
+-   [✓] Features -- additionalProperties: Boolean | Schema
+-   [✓] Features -- additionalItems: Boolean | Schema
+-   [✓] Features -- Add support for type "integer"
+-   [✓] Features -- oneOf -> oneOfProperty ( + Documentation)
+-   [✓] Breaking -- change isValid to return boolean
+-   [✓] Breaking -- use `step` in isValid -- bad: circular dependencies with step -> guessOneOfSchema -> isValid --X-> step
+-   [✓] Features -- items: [] schema (order/defined indices)
+-   [✓] Features -- not
+-   [✓] Features -- return custom errors in data validation
+-   [✓] Basics

README.md

@@ -671,7 +671,7 @@ expect(resolvedSchema).to.deep.eq({
 
 ## Draft customization
 
-[custom resolvers](#custom-resolvers) | [custom validators](#custom-validators) | [custom errors](#custom-errors)
+[getTemplate default options](#get-template-default-options) | [custom resolvers](#custom-resolvers) | [custom validators](#custom-validators) | [custom errors](#custom-errors)
 
 Each `Draft` in `json-schema-library` is build around a [DraftConfig](./lib/draft/index.ts#19). A `DraftConfig` holds all _functions_ and _configurations_ for each json-schema drafts. The `DraftConfig` is your main way to alter or extend behaviour for `json-schema-library`. You can either create your own _draftConfig_ or adjust any existing _draftConfig_. For the current drafts (4-7), each _draftConfig_ is exposed along with its actual _class_. For example:
 
@@ -695,6 +695,26 @@ new Draft07(mySchema, { resolveOneOf: resolveOneOfFuzzy });
 new Draft({ ...draft07Config, resolveOneOf: resolveOneOfFuzzy }, mySchema);
 ```
 
+### getTemplate default options
+
+With **version 8** _json-schema-library_ has changed `getTemplate` to only add required properties per default. This can be changed on draft initialization, by passing `templateDefaultOptions` in the _draftConfig_:
+
+```js
+const draft = new Draft(schema, {
+    templateDefaultOptions: {
+        addOptionalProps: true
+    }
+});
+```
+
+**Note:** You can still pass options to getTemplate overriding the draft default settings by:
+
+```js
+const data = draft.getTemplate(data, draft.getSchema(), {
+    addOptionalProps: true
+});
+```
+
 ### custom resolvers
 
 A _resolver_ is a simple method implementing a specific feature of json-schema to retrieve a sub-schema. Implementing the signature of each resolver you can create and pass your own resolvers.
@@ -901,8 +921,9 @@ const error: JsonError = createError("EnumError", { data: { pointer: "#/location
 
 ### v8.0.0
 
--   Renamed JSON to JSON, mainly: `JSONError` to `JsonError` and `JSONSchema` to `JsonSchema`
--   `getTemplate` only adds required properties. Can be changed by setting `addOptionalProps:true`
+-   Renamed `JSONError` to `JsonError` and `JSONSchema` to `JsonSchema`
+-   `getTemplate` only adds required properties. Behaviour can be changed by [getTemplate default options](#get-template-default-options)
+-   internal schema property `oneOfSchema` has been replaced by `schema.getOneOfOrigin()`
 
 ### v7.0.0
 

lib/config/settings.ts

@@ -2,5 +2,9 @@ export default {
     DECLARATOR_ONEOF: "oneOfProperty",
     GET_TEMPLATE_RECURSION_LIMIT: 1,
     floatingPointPrecision: 10000,
-    propertyBlacklist: ["_id"]
+    propertyBlacklist: ["_id"],
+    templateDefaultOptions: {
+        addOptionalProps: false,
+        removeInvalidData: false
+    }
 };

lib/draft04/index.ts

@@ -20,6 +20,7 @@ import TYPES from "../validation/type";
 import validate from "../validate";
 import { DraftConfig, Draft } from "../draft";
 import { JsonSchema } from "../types";
+import settings from "../config/settings";
 
 const draft04Config: DraftConfig = {
     typeKeywords: {
@@ -93,7 +94,9 @@ const draft04Config: DraftConfig = {
     resolveOneOf,
     resolveRef,
     step,
-    validate
+    validate,
+
+    templateDefaultOptions: settings.templateDefaultOptions
 };
 
 class Draft04 extends Draft {

lib/draft06/index.ts

@@ -20,6 +20,7 @@ import TYPES from "../draft06/validation/type";
 import validate from "../validate";
 import { DraftConfig, Draft } from "../draft";
 import { JsonSchema } from "../types";
+import settings from "../config/settings";
 
 const draft06Config: DraftConfig = {
     typeKeywords: {
@@ -101,7 +102,9 @@ const draft06Config: DraftConfig = {
     resolveOneOf,
     resolveRef,
     step,
-    validate
+    validate,
+
+    templateDefaultOptions: settings.templateDefaultOptions
 };
 
 class Draft06 extends Draft {

lib/draft07/index.ts

@@ -20,6 +20,7 @@ import TYPES from "../draft06/validation/type";
 import validate from "../validate";
 import { DraftConfig, Draft } from "../draft";
 import { JsonSchema } from "../types";
+import settings from "../config/settings";
 
 const draft07Config: DraftConfig = {
     typeKeywords: {
@@ -101,7 +102,9 @@ const draft07Config: DraftConfig = {
     resolveOneOf,
     resolveRef,
     step,
-    validate
+    validate,
+
+    templateDefaultOptions: settings.templateDefaultOptions
 };
 
 class Draft07 extends Draft {

test/unit/issues/issue38.getTemplate.anyOf.test.ts

@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import { Draft07 as Draft } from "../../../lib/draft07";
 
-describe.only("issue#38 - getTemplate anyOf should not modify valid default value", () => {
+describe("issue#38 - getTemplate anyOf should not modify valid default value", () => {
     let draft: Draft;
     beforeEach(() => {
         draft = new Draft({