Revert default values being non-nullable; add --default-non-nullable …

…flag #613
openapi-ts · Jun 3, 2021 · 6942fb4 · 6942fb4
1 parent e2fb371
commit 6942fb4
Show file tree

Hide file tree

Showing 24 changed files with 4,504 additions and 6,017 deletions.
diff --git a/README.md b/README.md
@@ -106,14 +106,15 @@ For anything more complicated, or for generating specs dynamically, you can also
 
 #### CLI Options
 
-| Option                         | Alias | Default  | Description                                                      |
-| :----------------------------- | :---- | :------: | :--------------------------------------------------------------- |
-| `--output [location]`          | `-o`  | (stdout) | Where should the output file be saved?                           |
-| `--auth [token]`               |       |          | (optional) Provide an auth token to be passed along in the request (only if accessing a private schema). |
-| `--immutable-types`            |       | `false`  | (optional) Generates immutable types (readonly properties and readonly array). |
-| `--additional-properties`      | `-ap` | `false`  | (optional) Allow arbitrary properties for all schema objects without `additionalProperties: false` |
-| `--prettier-config [location]` |       |          | (optional) Path to your custom Prettier configuration for output |
-| `--raw-schema`                 |       | `false`  | Generate TS types from partial schema (e.g. having `components.schema` at the top level) |
+| Option                         | Alias | Default  | Description                                                                                             |
+| :----------------------------- | :---- | :------: | :------------------------------------------------------------------------------------------------------ |
+| `--output [location]`          | `-o`  | (stdout) | Where should the output file be saved?                                                                  |
+| `--auth [token]`               |       |          | (optional) Provide an auth token to be passed along in the request (only if accessing a private schema) |
+| `--immutable-types`            | `-it` | `false`  | (optional) Generates immutable types (readonly properties and readonly array)                           |
+| `--additional-properties`      | `-ap` | `false`  | (optional) Allow arbitrary properties for all schema objects without `additionalProperties: false`      |
+| `--default-non-nullable`       |       | `false`  | (optional) Treat schema objects with default values as non-nullable                                     |
+| `--prettier-config [location]` | `-c`  |          | (optional) Path to your custom Prettier configuration for output                                        |
+| `--raw-schema`                 |       | `false`  | Generate TS types from partial schema (e.g. having `components.schema` at the top level)                |
 
 ### 🐢 Node
 

diff --git a/bin/cli.js b/bin/cli.js
@@ -18,6 +18,7 @@ Options
   --auth                       (optional) Provide an authentication token for private URL
   --immutable-types, -it       (optional) Generates immutable types (readonly properties and readonly array)
   --additional-properties, -ap (optional) Allow arbitrary properties for all schema objects without "additionalProperties: false"
+  --default-non-nullable       (optional) If a schema object has a default value set, don’t mark it as nullable
   --prettier-config, -c        (optional) specify path to Prettier config file
   --raw-schema                 (optional) Parse as partial schema (raw components)
   --version                    (optional) Force schema parsing version
@@ -35,6 +36,9 @@ Options
         type: "boolean",
         alias: "it",
       },
+      defaultNonNullable: {
+        type: "boolean",
+      },
       additionalProperties: {
         type: "boolean",
         alias: "ap",
@@ -82,6 +86,7 @@ async function generateSchema(pathToSpec) {
     auth: cli.flags.auth,
     additionalProperties: cli.flags.additionalProperties,
     immutableTypes: cli.flags.immutableTypes,
+    defaultNonNullable: cli.flags.defaultNonNullable,
     prettierConfig: cli.flags.prettierConfig,
     rawSchema: cli.flags.rawSchema,
     version: cli.flags.version,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -71,8 +71,8 @@
     "eslint": "^7.26.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^26.6.3",
-    "ts-jest": "^26.5.6",
+    "jest": "^27.0.3",
+    "ts-jest": "^27.0.2",
     "typescript": "^4.2.4"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -20,8 +20,9 @@ export default function openapiTS(
 ): string {
   // 1. set up context
   const ctx: GlobalContext = {
-    auth: options.auth,
     additionalProperties: options.additionalProperties || false,
+    auth: options.auth,
+    defaultNonNullable: options.defaultNonNullable || false,
     formatter: typeof options.formatter === "function" ? options.formatter : undefined,
     immutableTypes: options.immutableTypes || false,
     rawSchema: options.rawSchema || false,

diff --git a/src/transform/schema.ts b/src/transform/schema.ts
@@ -32,7 +32,8 @@ export function transformSchemaObjMap(obj: Record<string, any>, options: Transfo
 
     // 2. name (with “?” if optional property)
     const readonly = tsReadonly(options.immutableTypes);
-    const required = options.required.has(k) || hasDefaultValue(v.schema || v) ? "" : "?";
+    const required =
+      options.required.has(k) || (options.defaultNonNullable && hasDefaultValue(v.schema || v)) ? "" : "?";
     output += `${readonly}"${k}"${required}: `;
 
     // 3. transform

diff --git a/src/types.ts b/src/types.ts
@@ -124,6 +124,8 @@ export interface SwaggerToTSOptions {
   formatter?: SchemaFormatter;
   /** Generates immutable types (readonly properties and readonly array) */
   immutableTypes?: boolean;
+  /** (optional) Treat schema objects with default values as non-nullable */
+  defaultNonNullable?: boolean;
   /** (optional) Path to Prettier config */
   prettierConfig?: string;
   /** (optional) Parsing input document as raw schema rather than OpenAPI document */
@@ -138,6 +140,7 @@ export interface GlobalContext {
   auth?: string;
   formatter?: SchemaFormatter;
   immutableTypes: boolean;
+  defaultNonNullable: boolean;
   /** (optional) Should logging be suppressed? (necessary for STDOUT) */
   silent?: boolean;
   namespace?: string;

diff --git a/tests/bin/expected/petstore.ts b/tests/bin/expected/petstore.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     };
     Category: {
       id?: number;

diff --git a/tests/bin/expected/prettier-js.ts b/tests/bin/expected/prettier-js.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string
       /** Order Status */
       status?: 'placed' | 'approved' | 'delivered'
-      complete: boolean
+      complete?: boolean
     }
     Category: {
       id?: number

diff --git a/tests/bin/expected/prettier-json.ts b/tests/bin/expected/prettier-json.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string
       /** Order Status */
       status?: 'placed' | 'approved' | 'delivered'
-      complete: boolean
+      complete?: boolean
     }
     Category: {
       id?: number

diff --git a/tests/bin/expected/stdout.ts b/tests/bin/expected/stdout.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     };
     Category: {
       id?: number;

diff --git a/tests/operation.test.ts b/tests/operation.test.ts
@@ -1,6 +1,11 @@
 import { transformOperationObj } from "../src/transform/operation";
 
-const defaults = { additionalProperties: false, immutableTypes: false, rawSchema: false };
+const defaults = {
+  additionalProperties: false,
+  immutableTypes: false,
+  defaultNonNullable: false,
+  rawSchema: false,
+};
 
 describe("requestBody", () => {
   const basicSchema = {

diff --git a/tests/parameters.test.ts b/tests/parameters.test.ts
@@ -1,6 +1,11 @@
 import { transformParametersArray } from "../src/transform/parameters";
 
-const defaults = { additionalProperties: false, immutableTypes: false, rawSchema: false };
+const defaults = {
+  additionalProperties: false,
+  immutableTypes: false,
+  defaultNonNullable: false,
+  rawSchema: false,
+};
 
 describe("transformParametersArray()", () => {
   describe("v2", () => {

diff --git a/tests/paths.test.ts b/tests/paths.test.ts
@@ -9,6 +9,7 @@ const defaults = {
   additionalProperties: false,
   globalParameters: {},
   immutableTypes: false,
+  defaultNonNullable: false,
   operations: {},
   rawSchema: false,
   version: 3, // both 2 and 3 should generate the same

diff --git a/tests/request.test.ts b/tests/request.test.ts
@@ -1,7 +1,12 @@
 import prettier from "prettier";
 import { transformRequestBodies } from "../src/transform/request";
 
-const defaults = { additionalProperties: false, immutableTypes: false, rawSchema: false };
+const defaults = {
+  additionalProperties: false,
+  immutableTypes: false,
+  defaultNonNullable: false,
+  rawSchema: false,
+};
 
 function format(source: string) {
   return prettier.format(`type requestBodies = {${source.trim()}}`, { parser: "typescript" });

diff --git a/tests/schema.test.ts b/tests/schema.test.ts
@@ -7,6 +7,7 @@ import { transformSchemaObj as transform } from "../src/transform/schema";
 const defaults = {
   additionalProperties: false,
   immutableTypes: false,
+  defaultNonNullable: false,
   required: new Set<string>(),
   rawSchema: false,
   version: 3,
@@ -368,6 +369,29 @@ describe("SchemaObject", () => {
 /** user photo */
 "avatar"?: string;
 
+}`);
+    });
+  });
+
+  describe("--default-non-nullable", () => {
+    it("default: objects with default values are nullable", () => {
+      expect(
+        transform({ type: "object", properties: { default: { type: "boolean", default: true } } }, { ...defaults })
+      ).toBe(`{
+"default"?: boolean;
+
+}`);
+    });
+
+    it("enabled: objects with default values are non-nullable", () => {
+      expect(
+        transform(
+          { type: "object", properties: { default: { type: "boolean", default: true } } },
+          { ...defaults, defaultNonNullable: true }
+        )
+      ).toBe(`{
+"default": boolean;
+
 }`);
     });
   });

diff --git a/tests/v2/expected/petstore.immutable.ts b/tests/v2/expected/petstore.immutable.ts
@@ -71,7 +71,7 @@ export interface definitions {
     readonly shipDate?: string;
     /** Order Status */
     readonly status?: "placed" | "approved" | "delivered";
-    readonly complete: boolean;
+    readonly complete?: boolean;
   };
   readonly Category: {
     readonly id?: number;

diff --git a/tests/v2/expected/petstore.ts b/tests/v2/expected/petstore.ts
@@ -71,7 +71,7 @@ export interface definitions {
     shipDate?: string;
     /** Order Status */
     status?: "placed" | "approved" | "delivered";
-    complete: boolean;
+    complete?: boolean;
   };
   Category: {
     id?: number;

diff --git a/tests/v3/expected/petstore-openapitools.additional.ts b/tests/v3/expected/petstore-openapitools.additional.ts
@@ -73,7 +73,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     } & { [key: string]: any };
     /** A category for a pet */
     Category: {

diff --git a/tests/v3/expected/petstore-openapitools.immutable.ts b/tests/v3/expected/petstore-openapitools.immutable.ts
@@ -73,7 +73,7 @@ export interface components {
       readonly shipDate?: string;
       /** Order Status */
       readonly status?: "placed" | "approved" | "delivered";
-      readonly complete: boolean;
+      readonly complete?: boolean;
     };
     /** A category for a pet */
     readonly Category: {

diff --git a/tests/v3/expected/petstore-openapitools.ts b/tests/v3/expected/petstore-openapitools.ts
@@ -73,7 +73,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     };
     /** A category for a pet */
     Category: {

diff --git a/tests/v3/expected/petstore.additional.ts b/tests/v3/expected/petstore.additional.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     } & { [key: string]: any };
     Category: {
       id?: number;

diff --git a/tests/v3/expected/petstore.immutable.ts b/tests/v3/expected/petstore.immutable.ts
@@ -72,7 +72,7 @@ export interface components {
       readonly shipDate?: string;
       /** Order Status */
       readonly status?: "placed" | "approved" | "delivered";
-      readonly complete: boolean;
+      readonly complete?: boolean;
     };
     readonly Category: {
       readonly id?: number;

diff --git a/tests/v3/expected/petstore.ts b/tests/v3/expected/petstore.ts
@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     };
     Category: {
       id?: number;