fix: render void for empty response status codes in experimental parser

hey-api · Nov 8, 2024 · 9e07675 · 9e07675
1 parent be27628
commit 9e07675
Show file tree

Hide file tree

Showing 45 changed files with 239 additions and 133 deletions.
diff --git a/.changeset/silver-dolphins-retire.md b/.changeset/silver-dolphins-retire.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: render void for empty response status codes in experimental parser
diff --git a/packages/openapi-ts/src/compiler/types.ts b/packages/openapi-ts/src/compiler/types.ts
@@ -255,7 +255,8 @@ export const createKeywordTypeNode = ({
     | 'number'
     | 'string'
     | 'undefined'
-    | 'unknown';
+    | 'unknown'
+    | 'void';
 }) => {
   let kind: ts.KeywordTypeSyntaxKind = ts.SyntaxKind.AnyKeyword;
   switch (keyword) {
@@ -277,6 +278,9 @@ export const createKeywordTypeNode = ({
     case 'unknown':
       kind = ts.SyntaxKind.UnknownKeyword;
       break;
+    case 'void':
+      kind = ts.SyntaxKind.VoidKeyword;
+      break;
   }
   return ts.factory.createKeywordTypeNode(kind);
 };

diff --git a/packages/openapi-ts/src/ir/ir.d.ts b/packages/openapi-ts/src/ir/ir.d.ts
@@ -138,6 +138,7 @@ export interface IRSchemaObject
     | 'object'
     | 'string'
     | 'tuple'
+    | 'undefined'
     | 'unknown'
     | 'void';
 }
diff --git a/packages/openapi-ts/src/plugins/@hey-api/types/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/types/plugin.ts
@@ -436,7 +436,7 @@ const objectTypeToIdentifier = ({
 
     if (hasOptionalProperties) {
       indexPropertyItems.push({
-        type: 'void',
+        type: 'undefined',
       });
     }
 
@@ -594,13 +594,17 @@ const schemaTypeToIdentifier = ({
         namespace,
         schema: schema as SchemaWithType<'tuple'>,
       });
+    case 'undefined':
+      return compiler.keywordTypeNode({
+        keyword: 'undefined',
+      });
     case 'unknown':
       return compiler.keywordTypeNode({
         keyword: 'unknown',
       });
     case 'void':
       return compiler.keywordTypeNode({
-        keyword: 'undefined',
+        keyword: 'void',
       });
   }
 };

diff --git a/packages/openapi-ts/test/3.0.x.spec.ts b/packages/openapi-ts/test/3.0.x.spec.ts
@@ -62,6 +62,19 @@ describe(`OpenAPI ${VERSION}`, () => {
       }),
       description: 'handles null enums',
     },
+    {
+      config: createConfig({
+        input: 'operation-204.json',
+        output: 'operation-204',
+        plugins: [
+          {
+            name: '@hey-api/types',
+            tree: true,
+          },
+        ],
+      }),
+      description: 'handles empty response status codes',
+    },
   ];
 
   it.each(scenarios)('$description', async ({ config }) => {

diff --git a/packages/openapi-ts/test/3.1.x.spec.ts b/packages/openapi-ts/test/3.1.x.spec.ts
@@ -93,6 +93,19 @@ describe(`OpenAPI ${VERSION}`, () => {
       description:
         'sets correct logical operator and brackets on object with properties and oneOf composition',
     },
+    {
+      config: createConfig({
+        input: 'operation-204.json',
+        output: 'operation-204',
+        plugins: [
+          {
+            name: '@hey-api/types',
+            tree: true,
+          },
+        ],
+      }),
+      description: 'handles empty response status codes',
+    },
     {
       config: createConfig({
         input: 'required-all-of-ref.json',

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/operation-204/index.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/operation-204/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/operation-204/types.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/operation-204/types.gen.ts
@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type PostFooResponse = string | void;
diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/services/default/types.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/services/default/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...est/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/asClass/types.gen.ts b/...est/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/asClass/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/types.gen.ts b/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/fetch/types.gen.ts b/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/fetch/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...es/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/asClass/types.gen.ts b/...es/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/asClass/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/axios/types.gen.ts b/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/axios/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/fetch/types.gen.ts b/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/fetch/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...es/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/asClass/types.gen.ts b/...es/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/asClass/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/axios/types.gen.ts b/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/axios/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/fetch/types.gen.ts b/...ages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/fetch/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;
 

diff --git a/...s/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/svelte-query/asClass/types.gen.ts b/...s/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/svelte-query/asClass/types.gen.ts
@@ -1136,7 +1136,7 @@ export type PostCallWithOptionalParamData = {
     };
 };
 
-export type PostCallWithOptionalParamResponse = number | undefined;
+export type PostCallWithOptionalParamResponse = number | void;
 
 export type PostApiVbyApiVersionRequestBodyData = {
     /**
@@ -1259,13 +1259,13 @@ export type CallToTestOrderOfParamsData = {
     };
 };
 
-export type CallWithNoContentResponseResponse = undefined;
+export type CallWithNoContentResponseResponse = void;
 
-export type CallWithResponseAndNoContentResponseResponse = number | undefined;
+export type CallWithResponseAndNoContentResponseResponse = number | void;
 
 export type DummyAResponse = _400;
 
-export type DummyBResponse = undefined;
+export type DummyBResponse = void;
 
 export type CallWithResponseResponse = _import;