Fix empty request / response bodies

Author: Piet van Agtmaal

.changeset/mighty-ligers-cheat.md

@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+Fix invalid typescript for empty request bodies, fix headers being left out when response body is omitted

packages/openapi-typescript/src/transform/request-body-object.ts

@@ -13,8 +13,12 @@ export default function transformRequestBodyObject(requestBodyObject: RequestBod
   const output: string[] = ["{"];
   indentLv++;
   output.push(indent(ctx.immutableTypes ? tsReadonly("content: {") : "content: {", indentLv));
-  if (!Object.keys(requestBodyObject.content).length) return `${escStr("*/*")}: never`;
   indentLv++;
+
+  if (!Object.keys(requestBodyObject.content).length) {
+    output.push(indent('"*/*": never;', indentLv));
+  }
+
   for (const [contentType, mediaTypeObject] of getEntries(requestBodyObject.content, ctx.alphabetize, ctx.excludeDeprecated)) {
     const c = getSchemaObjectComment(mediaTypeObject, indentLv);
     if (c) output.push(indent(c, indentLv));

packages/openapi-typescript/src/transform/response-object.ts

@@ -9,11 +9,6 @@ export interface TransformResponseObjectOptions {
 }
 
 export default function transformResponseObject(responseObject: ResponseObject, { path, ctx }: TransformResponseObjectOptions): string {
-  // never
-  if (!responseObject.content) {
-    return "never";
-  }
-
   const output: string[] = ["{"];
   let { indentLv } = ctx;
 
@@ -68,6 +63,10 @@ export default function transformResponseObject(responseObject: ResponseObject,
     indentLv--;
     output.push(indent("};", indentLv));
     indentLv--;
+  } else {
+    indentLv++;
+    output.push(indent("content: never;", indentLv));
+    indentLv--;
   }
 
   output.push(indent("}", indentLv));

packages/openapi-typescript/test/request-body-object.test.ts

@@ -48,4 +48,14 @@ describe("Request Body Object", () => {
   };
 }`);
   });
+
+  test("empty", () => {
+    const schema: RequestBodyObject = { content: {} };
+    const generated = transformRequestBodyObject(schema, options);
+    expect(generated).toBe(`{
+  content: {
+    "*/*": never;
+  };
+}`)
+  });
 });

packages/openapi-typescript/test/response-object.test.ts

@@ -0,0 +1,78 @@
+import transformResponseObject, { TransformResponseObjectOptions } from "../src/transform/response-object.js";
+import type { ResponseObject } from "../src/types.js";
+
+const options: TransformResponseObjectOptions = {
+  path: "#/test/response-object",
+  ctx: {
+    additionalProperties: false,
+    alphabetize: false,
+    emptyObjectsUnknown: false,
+    defaultNonNullable: false,
+    discriminators: {},
+    immutableTypes: false,
+    indentLv: 0,
+    operations: {},
+    parameters: {},
+    pathParamsAsTypes: false,
+    postTransform: undefined,
+    silent: true,
+    supportArrayLength: false,
+    transform: undefined,
+    excludeDeprecated: false,
+  },
+};
+
+describe("Response Object", () => {
+  test("basic", () => {
+    const schema: ResponseObject = {
+      description: "basic",
+      headers: {
+        foo: {
+          schema: { type: "string" }
+        }
+      },
+      content: {
+        "application/json": {
+          schema: {
+            type: "object",
+            properties: {
+              url: { type: "string" },
+              "content-type": { type: "string" },
+            },
+            required: ["url"],
+          },
+        },
+      },
+    };
+    const generated = transformResponseObject(schema, options);
+    expect(generated).toBe(`{
+  headers: {
+    foo?: string;
+  };
+  content: {
+    "application/json": {
+      url: string;
+      "content-type"?: string;
+    };
+  };
+}`);
+  });
+
+  test("empty", () => {
+    const schema: ResponseObject = {
+      description: "empty",
+      headers: {
+        "some-header": {
+          schema: { type: "string" }
+        }
+      }
+    };
+    const generated = transformResponseObject(schema, options);
+    expect(generated).toBe(`{
+  headers: {
+    "some-header"?: string;
+  };
+  content: never;
+}`)
+  });
+});