Add new option with expectation as new test

Author: luqasn

packages/openapi-typescript/src/index.ts

@@ -95,6 +95,7 @@ export default async function openapiTS(
     resolve($ref) {
       return resolveRef(schema, $ref, { silent: options.silent ?? false });
     },
+    makeParametersWithDefaultNotUndefined: options.makeParametersWithDefaultNotUndefined ?? false,
   };
 
   const transformT = performance.now();

packages/openapi-typescript/src/types.ts

@@ -679,6 +679,10 @@ export interface OpenAPITSOptions {
   makePathsEnum?: boolean;
   /** Generate path params based on path even if they are not defiend in the open api schema */
   generatePathParams?: boolean;
+  /** Generate non-optional parameter types if the parameter has a default. This is useful
+   * for server implementations that automatically set the default from the spec for the user.
+   */
+  makeParametersWithDefaultNotUndefined?: boolean;
 }
 
 /** Context passed to all submodules */
@@ -714,6 +718,7 @@ export interface GlobalContext {
   inject?: string;
   makePathsEnum: boolean;
   generatePathParams: boolean;
+  makeParametersWithDefaultNotUndefined: boolean;
 }
 
 export type $defs = Record<string, SchemaObject>;

packages/openapi-typescript/test/fixtures/parameters-test-default.yaml

@@ -0,0 +1,19 @@
+openapi: "3.0"
+info:
+  title: test
+  version: "1.0"
+paths:
+  /endpoint:
+    get:
+      description: OK
+      parameters:
+        - in: query
+          name: optional_nodefault
+          schema:
+            type: string
+          required: false
+        - in: query
+          name: optional_default
+          schema:
+            type: string
+          required: false

packages/openapi-typescript/test/test-helpers.ts

@@ -34,6 +34,7 @@ export const DEFAULT_CTX: GlobalContext = {
   transformProperty: undefined,
   makePathsEnum: false,
   generatePathParams: false,
+  makeParametersWithDefaultNotUndefined: false,
 };
 
 /** Generic test case */

packages/openapi-typescript/test/transform/parameters-with-default.test.ts

@@ -45,6 +45,44 @@ describe("parametersWithDefaults", () => {
         },
       },
     ],
+    [
+      "options > makeParametersWithDefaultNotUndefined: true",
+      {
+        given: {
+          "/api/{version}/user/{user_id}": {
+            parameters: [
+              { in: "query", name: "no_default", required: false, schema: { type: "number" } },
+              { in: "query", name: "with_default", required: false, schema: { type: "number", default: 1337 } },
+            ],
+          },
+        },
+        want: `{
+    "/api/{version}/user/{user_id}": {
+        parameters: {
+            query: {
+                no_default?: number;
+                with_default: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}`,
+        options: {
+          ...DEFAULT_OPTIONS,
+          makeParametersWithDefaultNotUndefined: true,
+        },
+      },
+    ],
   ];
 
   for (const [testName, { given, want, options = DEFAULT_OPTIONS, ci }] of tests) {