fix: generate correct optional key in types when using positional arg…

…uments (useOptions: false)
hey-api · May 15, 2024 · 86485c4 · 86485c4
1 parent 0277e29
commit 86485c4
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 49 deletions.
diff --git a/.changeset/selfish-waves-give.md b/.changeset/selfish-waves-give.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: generate correct optional key in types when using positional arguments (useOptions: false)
diff --git a/packages/openapi-ts/src/utils/required.ts b/packages/openapi-ts/src/utils/required.ts
diff --git a/packages/openapi-ts/src/utils/write/services.ts b/packages/openapi-ts/src/utils/write/services.ts
@@ -17,7 +17,6 @@ import type {
 import type { Client } from '../../types/client';
 import { getConfig } from '../config';
 import { escapeComment, escapeName } from '../escape';
-import { modelIsRequired } from '../required';
 import { transformServiceName } from '../transform';
 import { unique } from '../unique';
 import { uniqueTypeName } from './type';
@@ -82,11 +81,20 @@ const toOperationParamType = (
     ];
   }
 
+  const getDefaultPrintable = (
+    p: OperationParameter | Model,
+  ): string | undefined => {
+    if (p.default === undefined) {
+      return undefined;
+    }
+    return JSON.stringify(p.default, null, 4);
+  };
+
   return operation.parameters.map((p) => {
     const typePath = `${importedType}['${p.name}']`;
     return {
       default: p?.default,
-      isRequired: modelIsRequired(p) === '',
+      isRequired: (!p.isRequired && !getDefaultPrintable(p) ? '?' : '') === '',
       name: p.name,
       type: typePath,
     };

diff --git a/packages/openapi-ts/src/utils/write/type.ts b/packages/openapi-ts/src/utils/write/type.ts
@@ -4,7 +4,6 @@ import type { Client } from '../../types/client';
 import { getConfig } from '../config';
 import { enumValue } from '../enum';
 import { escapeComment } from '../escape';
-import { modelIsRequired } from '../required';
 import { unique } from '../unique';
 
 const base = (model: Model) => {
@@ -86,7 +85,7 @@ const typeInterface = (model: Model) => {
   }
 
   const properties: Property[] = model.properties.map((property) => {
-    let maybeRequired = modelIsRequired(property);
+    let maybeRequired = property.isRequired ? '' : '?';
     let value = toType(property);
     // special case for additional properties type
     if (property.name === '[key: string]' && maybeRequired) {

diff --git a/.../openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/types.gen.ts.snap b/.../openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/types.gen.ts.snap
@@ -24,65 +24,65 @@ export type CallWithDefaultParametersData = {
     /**
      * This is a simple boolean with default value
      */
-    parameterBoolean: boolean | null;
+    parameterBoolean?: boolean | null;
     /**
      * This is a simple enum with default value
      */
-    parameterEnum: 'Success' | 'Warning' | 'Error';
+    parameterEnum?: 'Success' | 'Warning' | 'Error';
     /**
      * This is a simple model with default value
      */
-    parameterModel: ModelWithString | null;
+    parameterModel?: ModelWithString | null;
     /**
      * This is a simple number with default value
      */
-    parameterNumber: number | null;
+    parameterNumber?: number | null;
     /**
      * This is a simple string with default value
      */
-    parameterString: string | null;
+    parameterString?: string | null;
 };
 
 export type CallWithDefaultOptionalParametersData = {
     /**
      * This is a simple boolean that is optional with default value
      */
-    parameterBoolean: boolean;
+    parameterBoolean?: boolean;
     /**
      * This is a simple enum that is optional with default value
      */
-    parameterEnum: 'Success' | 'Warning' | 'Error';
+    parameterEnum?: 'Success' | 'Warning' | 'Error';
     /**
      * This is a simple model that is optional with default value
      */
-    parameterModel: ModelWithString;
+    parameterModel?: ModelWithString;
     /**
      * This is a simple number that is optional with default value
      */
-    parameterNumber: number;
+    parameterNumber?: number;
     /**
      * This is a simple string that is optional with default value
      */
-    parameterString: string;
+    parameterString?: string;
 };
 
 export type CallToTestOrderOfParamsData = {
     /**
      * This is a optional string with default
      */
-    parameterOptionalStringWithDefault: string;
+    parameterOptionalStringWithDefault?: string;
     /**
      * This is a optional string with empty default
      */
-    parameterOptionalStringWithEmptyDefault: string;
+    parameterOptionalStringWithEmptyDefault?: string;
     /**
      * This is a optional string with no default
      */
     parameterOptionalStringWithNoDefault?: string;
     /**
      * This is a string that can be null with default
      */
-    parameterStringNullableWithDefault: string | null;
+    parameterStringNullableWithDefault?: string | null;
     /**
      * This is a string that can be null with no default
      */
@@ -108,67 +108,67 @@ export type $OpenApiTs = {
                 /**
                  * This is a simple boolean with default value
                  */
-                parameterBoolean: boolean | null;
+                parameterBoolean?: boolean | null;
                 /**
                  * This is a simple enum with default value
                  */
-                parameterEnum: 'Success' | 'Warning' | 'Error';
+                parameterEnum?: 'Success' | 'Warning' | 'Error';
                 /**
                  * This is a simple model with default value
                  */
-                parameterModel: ModelWithString | null;
+                parameterModel?: ModelWithString | null;
                 /**
                  * This is a simple number with default value
                  */
-                parameterNumber: number | null;
+                parameterNumber?: number | null;
                 /**
                  * This is a simple string with default value
                  */
-                parameterString: string | null;
+                parameterString?: string | null;
             };
         };
         post: {
             req: {
                 /**
                  * This is a simple boolean that is optional with default value
                  */
-                parameterBoolean: boolean;
+                parameterBoolean?: boolean;
                 /**
                  * This is a simple enum that is optional with default value
                  */
-                parameterEnum: 'Success' | 'Warning' | 'Error';
+                parameterEnum?: 'Success' | 'Warning' | 'Error';
                 /**
                  * This is a simple model that is optional with default value
                  */
-                parameterModel: ModelWithString;
+                parameterModel?: ModelWithString;
                 /**
                  * This is a simple number that is optional with default value
                  */
-                parameterNumber: number;
+                parameterNumber?: number;
                 /**
                  * This is a simple string that is optional with default value
                  */
-                parameterString: string;
+                parameterString?: string;
             };
         };
         put: {
             req: {
                 /**
                  * This is a optional string with default
                  */
-                parameterOptionalStringWithDefault: string;
+                parameterOptionalStringWithDefault?: string;
                 /**
                  * This is a optional string with empty default
                  */
-                parameterOptionalStringWithEmptyDefault: string;
+                parameterOptionalStringWithEmptyDefault?: string;
                 /**
                  * This is a optional string with no default
                  */
                 parameterOptionalStringWithNoDefault?: string;
                 /**
                  * This is a string that can be null with default
                  */
-                parameterStringNullableWithDefault: string | null;
+                parameterStringNullableWithDefault?: string | null;
                 /**
                  * This is a string that can be null with no default
                  */

diff --git a/packages/openapi-ts/test/sample.cjs b/packages/openapi-ts/test/sample.cjs
@@ -19,6 +19,7 @@ const main = async () => {
       // include: '^NestedAnyOfArraysNullable',
       // name: 'PascalCase',
     },
+    // useOptions: false,
   };
 
   const { createClient } = await import(