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

#613

Author: drwpow

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
 

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,

package-lock.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"
   }
 }

package.json

@@ -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,

src/index.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

src/transform/schema.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;

src/types.ts

@@ -618,11 +618,11 @@ export interface definitions {
       base_url?: string;
       sso_url?: string;
       version?: "v1";
-      features: {
+      features?: {
         access_code?: boolean;
         sso?: boolean;
         plan_change?: boolean;
-        credential: "none" | "single" | "multiple" | "unknown";
+        credential?: "none" | "single" | "multiple" | "unknown";
       };
     };
     /** An array of platform ids to restrict this product for. */
@@ -662,24 +662,24 @@ export interface definitions {
     name: definitions["Name"];
     type: "boolean" | "string" | "number";
     /** This sets whether or not the feature can be customized by a consumer. */
-    customizable: boolean;
+    customizable?: boolean;
     /**
      * This sets whether or not the feature can be upgraded by the consumer after the
      * resource has provisioned. Upgrading means setting a higher value or selecting a
      * higher element in the list.
      */
-    upgradable: boolean;
+    upgradable?: boolean;
     /**
      * This sets whether or not the feature can be downgraded by the consumer after the
      * resource has provisioned. Downgrading means setting a lower value or selecting a
      * lower element in the list.
      */
-    downgradable: boolean;
+    downgradable?: boolean;
     /**
      * Sets if this feature’s value is trackable from the provider,
      * this only really affects numeric constraints.
      */
-    measurable: boolean;
+    measurable?: boolean;
     values?: definitions["FeatureValuesList"];
   };
   /**
@@ -699,7 +699,7 @@ export interface definitions {
      * is selected or is default for the plan.
      * Cost is deprecated in favor of the `price.cost` field.
      */
-    cost: number;
+    cost?: number;
     /**
      * Price describes the cost of a feature. It should be preferred over
      * the `cost` property.
@@ -710,13 +710,13 @@ export interface definitions {
        * when this value is selected or is default for the plan.
        * Number features should use the cost range instead.
        */
-      cost: number;
+      cost?: number;
       /**
        * When a feature is used to multiply the cost of the plan or of
        * another feature, multiply factor is used for calculation.
        * A feature cannot have both a cost and a multiply factor.
        */
-      multiply_factor: number;
+      multiply_factor?: number;
       /** Price describes how the feature cost should be calculated. */
       formula?: definitions["PriceFormula"];
       /** Description explains how a feature is calculated to the user. */
@@ -737,9 +737,9 @@ export interface definitions {
      * means this numeric details has no scale, and will not be or customizable.
      * Some plans may not have a measureable or customizable feature.
      */
-    increment: number;
+    increment?: number;
     /** Minimum value that can be set by a user if customizable */
-    min: number;
+    min?: number;
     /** Maximum value that can be set by a user if customizable */
     max?: number;
     /** Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */
@@ -758,7 +758,7 @@ export interface definitions {
      * An integer in 10,000,000ths of cents, will be multiplied by the
      * numeric value set in the feature to determine the cost.
      */
-    cost_multiple: number;
+    cost_multiple?: number;
   };
   FeatureValue: {
     feature: definitions["Label"];
@@ -784,40 +784,40 @@ export interface definitions {
      * When true, everyone can see the product when requested. When false it will
      * not be visible to anyone except those on the provider team.
      */
-    public: boolean;
+    public?: boolean;
     /**
      * When true, the product will be displayed in product listings alongside
      * other products. When false the product will be excluded from listings,
      * but can still be provisioned directly if it's label is known.
      * Any pages that display information about the product when not listed,
      * should indicate to webcrawlers that the content should not be indexed.
      */
-    listed: boolean;
+    listed?: boolean;
     /**
      * Object to hold various flags for marketing purposes only. These are values
      * that need to be stored, but should not affect decision making in code. If
      * we find ourselves in a position where we think they should, we should
      * consider refactoring our listing definition.
      */
-    marketing: {
+    marketing?: {
       /**
        * Indicates whether or not the product is in `Beta` and should be
        * advertised as such. This does not have any impact on who can access the
        * product, it is just used to inform consumers through our clients.
        */
-      beta: boolean;
+      beta?: boolean;
       /**
        * Indicates whether or not the product is in `New` and should be
        * advertised as such. This does not have any impact on who can access the
        * product, it is just used to inform consumers through our clients.
        */
-      new: boolean;
+      new?: boolean;
       /**
        * Indicates whether or not the product is in `New` and should be
        * advertised as such. This does not have any impact on who can access the
        * product, it is just used to inform consumers through our clients.
        */
-      featured: boolean;
+      featured?: boolean;
     };
   };
   /**
@@ -858,7 +858,7 @@ export interface definitions {
      * * `multiple`: Multiple credentials are supported at the same time.
      * * `unknown`: The credential type is unknown.
      */
-    credential: "none" | "single" | "multiple" | "unknown";
+    credential?: "none" | "single" | "multiple" | "unknown";
   };
   ProductBody: {
     provider_id: definitions["ID"];

tests/bin/expected/manifold.ts

@@ -72,7 +72,7 @@ export interface components {
       shipDate?: string;
       /** Order Status */
       status?: "placed" | "approved" | "delivered";
-      complete: boolean;
+      complete?: boolean;
     };
     Category: {
       id?: number;

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

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

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;

tests/bin/expected/stdout.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 = {

tests/operation.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", () => {

tests/parameters.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

tests/paths.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" });

tests/request.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;
+
 }`);
     });
   });