Add additionalProperties option (fix bcherny#335)

Author: Boris Cherny

README.md

@@ -83,6 +83,7 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 
 | key | type | default | description |
 |-|-|-|-|
+| additionalProperties | boolean | `true` | Default value for `additionalProperties`, when it is not explicitly set |
 | bannerComment | string | `"/* tslint:disable */\n/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"` | Disclaimer comment prepended to the top of each generated file |
 | cwd | string | `process.cwd()` | Root directory for resolving [`$ref`](https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html)s |
 | declareExternallyReferenced | boolean | `true` | Declare external schemas referenced via `$ref`? |

src/cli.ts

@@ -151,6 +151,8 @@ With no OUT_FILE nor IN_FILE, write to standard output.
 You can use any of the following options by adding them at the end.
 Boolean values can be set to false using the 'no-' prefix.
 
+  --additionalProperties
+      Default value for additionalProperties, when it is not explicitly set
   --cwd=XXX
       Root directory for resolving $ref
   --declareExternallyReferenced

src/index.ts

@@ -18,6 +18,14 @@ import {link} from './linker'
 export {EnumJSONSchema, JSONSchema, NamedEnumJSONSchema, CustomTypeJSONSchema} from './types/JSONSchema'
 
 export interface Options {
+  /**
+   * [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s
+   */
+  $refOptions: $RefOptions
+  /**
+   * Default value for additionalProperties, when it is not explicitly set.
+   */
+  additionalProperties: boolean
   /**
    * Disclaimer comment prepended to the top of each generated file.
    */
@@ -60,14 +68,11 @@ export interface Options {
    * Generate unknown type instead of any
    */
   unknownAny: boolean
-  /**
-   * [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s
-   */
-  $refOptions: $RefOptions
 }
 
 export const DEFAULT_OPTIONS: Options = {
   $refOptions: {},
+  additionalProperties: true, // TODO: default to empty schema (as per spec) instead
   bannerComment: `/* tslint:disable */
 /**
 * This file was automatically generated by json-schema-to-typescript.

src/normalizer.ts

@@ -44,10 +44,9 @@ rules.set('Transform `required`=false to `required`=[]', schema => {
   }
 })
 
-// TODO: default to empty schema (as per spec) instead
-rules.set('Default additionalProperties to true', schema => {
+rules.set('Default additionalProperties', (schema, _, options) => {
   if (isObjectType(schema) && !('additionalProperties' in schema) && schema.patternProperties === undefined) {
-    schema.additionalProperties = true
+    schema.additionalProperties = options.additionalProperties
   }
 })
 

test/__snapshots__/test/test.ts.md

@@ -95,9 +95,9 @@ Generated by [AVA](https://avajs.dev).
     }␊
     `
 
-## additionalProperties.js
+## additionalProperties.1.js
 
-> Expected output to match snapshot for e2e test: additionalProperties.js
+> Expected output to match snapshot for e2e test: additionalProperties.1.js
 
     `/* tslint:disable */␊
     /**␊
@@ -112,6 +112,61 @@ Generated by [AVA](https://avajs.dev).
     }␊
     `
 
+## additionalProperties.2.js
+
+> Expected output to match snapshot for e2e test: additionalProperties.2.js
+
+    `/* tslint:disable */␊
+    /**␊
+     * This file was automatically generated by json-schema-to-typescript.␊
+     * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊
+     * and run json-schema-to-typescript to regenerate this file.␊
+     */␊
+    ␊
+    export interface AdditionalPropertiesConfiguredToDefaultToFalse {␊
+      a?: {};␊
+      b?: {};␊
+      c?: {␊
+        [k: string]: unknown;␊
+      };␊
+      d?: {␊
+        [k: string]: number;␊
+      };␊
+      e?: E;␊
+    }␊
+    export interface E {}␊
+    `
+
+## additionalProperties.3.js
+
+> Expected output to match snapshot for e2e test: additionalProperties.3.js
+
+    `/* tslint:disable */␊
+    /**␊
+     * This file was automatically generated by json-schema-to-typescript.␊
+     * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊
+     * and run json-schema-to-typescript to regenerate this file.␊
+     */␊
+    ␊
+    export interface AdditionalPropertiesDefaultToTrue {␊
+      a?: {␊
+        [k: string]: unknown;␊
+      };␊
+      b?: {};␊
+      c?: {␊
+        [k: string]: unknown;␊
+      };␊
+      d?: {␊
+        [k: string]: number;␊
+      };␊
+      e?: E;␊
+      [k: string]: unknown;␊
+    }␊
+    export interface E {␊
+      [k: string]: unknown;␊
+    }␊
+    `
+
 ## allOf.js
 
 > Expected output to match snapshot for e2e test: allOf.js
@@ -11270,6 +11325,28 @@ Generated by [AVA](https://avajs.dev).
       ]␊
     }`
 
+## Default additionalProperties to false
+
+> Snapshot 1
+
+    `{␊
+      "id": "foo",␊
+      "type": "object",␊
+      "properties": {␊
+        "a": {␊
+          "type": "integer",␊
+          "id": "a"␊
+        },␊
+        "b": {␊
+          "type": "object",␊
+          "required": [],␊
+          "additionalProperties": false␊
+        }␊
+      },␊
+      "required": [],␊
+      "additionalProperties": false␊
+    }`
+
 ## Default additionalProperties to true
 
 > Snapshot 1

test/__snapshots__/test/test.ts.snap

@@ -0,0 +1,35 @@
+export const input = {
+  title: 'AdditionalProperties (configured to default to false)',
+  type: 'object',
+  definitions: {
+    e: {
+      type: 'object'
+    }
+  },
+  properties: {
+    a: {
+      type: 'object'
+    },
+    b: {
+      type: 'object',
+      additionalProperties: false
+    },
+    c: {
+      type: 'object',
+      additionalProperties: true
+    },
+    d: {
+      type: 'object',
+      additionalProperties: {
+        type: 'number'
+      }
+    },
+    e: {
+      $ref: '#/definitions/e'
+    }
+  }
+}
+
+export const options = {
+  additionalProperties: false
+}

test/e2e/additionalProperties.ts test/e2e/additionalProperties.1.ts

@@ -0,0 +1,31 @@
+export const input = {
+  title: 'AdditionalProperties (default to true)',
+  type: 'object',
+  definitions: {
+    e: {
+      type: 'object'
+    }
+  },
+  properties: {
+    a: {
+      type: 'object'
+    },
+    b: {
+      type: 'object',
+      additionalProperties: false
+    },
+    c: {
+      type: 'object',
+      additionalProperties: true
+    },
+    d: {
+      type: 'object',
+      additionalProperties: {
+        type: 'number'
+      }
+    },
+    e: {
+      $ref: '#/definitions/e'
+    }
+  }
+}

test/e2e/additionalProperties.2.ts

@@ -0,0 +1,39 @@
+{
+  "name": "Default additionalProperties to false",
+  "in": {
+    "id": "foo",
+    "type": [
+      "object"
+    ],
+    "properties": {
+      "a": {
+        "type": "integer",
+        "id": "a"
+      },
+      "b": {
+        "type": "object"
+      }
+    },
+    "required": []
+  },
+  "options": {
+    "additionalProperties": false
+  },
+  "out": {
+    "id": "foo",
+    "type": "object",
+    "properties": {
+      "a": {
+        "type": "integer",
+        "id": "a"
+      },
+      "b": {
+        "additionalProperties": false,
+        "required": [],
+        "type": "object"
+      }
+    },
+    "required": [],
+    "additionalProperties": false
+  }
+}