fix: responseHeaders generation by inlining the type instead of referencing it

Author: astahmer

.changeset/good-showers-stare.md

@@ -0,0 +1,5 @@
+---
+"typed-openapi": patch
+---
+
+Fix responseHeaders generation by inlining the type instead of referencing it.

packages/typed-openapi/src/generator.ts

@@ -170,20 +170,10 @@ const parameterObjectToString = (parameters: Box<AnyBoxDef> | Record<string, Any
   return str + "}";
 };
 
-const responseHeadersObjectToString = (responseHeaders: Record<string, Box<BoxObject>>, ctx: GeneratorContext) => {
+const responseHeadersObjectToString = (responseHeaders: Record<string, Box<BoxObject>>) => {
   let str = "{";
   for (const [key, responseHeader] of Object.entries(responseHeaders)) {
-    const value =
-      ctx.runtime === "none"
-        ? responseHeader.recompute((box) => {
-            if (Box.isReference(box) && !box.params.generics && box.value !== "null") {
-              box.value = `Schemas.${box.value}`;
-            }
-
-            return box;
-          }).value
-        : responseHeader.value;
-    str += `${wrapWithQuotesIfNeeded(key.toLowerCase())}: ${value},\n`;
+    str += `${wrapWithQuotesIfNeeded(key.toLowerCase())}: ${responseHeader.value},\n`;
   }
   return str + "}";
 };
@@ -245,7 +235,7 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
       ${endpoint.responses ? `responses: ${generateResponsesObject(endpoint.responses, ctx)},` : ""}
       ${
         endpoint.responseHeaders
-          ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders, ctx)},`
+          ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders)},`
           : ""
       }
     }\n`;

packages/typed-openapi/tests/generator.test.ts

@@ -186,7 +186,7 @@ describe("generator", () => {
             query: Partial<{ username: string; password: string }>;
           };
           responses: { 200: string; 400: unknown };
-          responseHeaders: { 200: { "X-Rate-Limit": unknown; "X-Expires-After": unknown }; 400: { "X-Error": unknown } };
+          responseHeaders: { 200: { "X-Rate-Limit": number; "X-Expires-After": string }; 400: { "X-Error": string } };
         };
         export type get_LogoutUser = {
           method: "GET";

packages/typed-openapi/tests/issue-header-namespace-ref.test.ts

@@ -0,0 +1,80 @@
+import { describe, test } from "vitest";
+import { mapOpenApiEndpoints } from "../src/map-openapi-endpoints.ts";
+import type { OpenAPIObject } from "openapi3-ts/oas31";
+import { generateFile } from "../src/generator.ts";
+import { prettify } from "../src/pretty.export.ts";
+
+const openApiDoc: OpenAPIObject = {
+  openapi: "3.0.3",
+  info: { title: "Test API Spec", version: "1.0.0" },
+  paths: {
+    "/test": {
+      get: {
+        operationId: "getTest",
+        responses: {
+          "200": {
+            description: "Response",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "string"
+                },
+              },
+            },
+            headers: {
+              "X-RateLimit-Limit": {
+                $ref: "#/components/headers/x-rate-limit-limit",
+              },
+              "X-RateLimit-Remaining": {
+                $ref: "#/components/headers/x-rate-limit-remaining",
+              },
+              "X-RateLimit-Reset": {
+                $ref: "#/components/headers/x-rate-limit-reset",
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  components: {
+    headers: {
+      "x-rate-limit-limit": {
+        example: 5000,
+        schema: {
+          type: "integer",
+        },
+      },
+      "x-rate-limit-remaining": {
+        example: 4999,
+        schema: {
+          type: "integer",
+        },
+      },
+      "x-rate-limit-reset": {
+        example: 1590701888,
+        schema: {
+          type: "integer",
+          format: "timestamp",
+        },
+      },
+    },
+  },
+};
+
+describe("namespaced header ref is wrong", () => {
+  test("should not resolve response as unknown", async ({ expect }) => {
+    const result = mapOpenApiEndpoints(openApiDoc);
+    // Find the endpoint by alias (see getAlias logic: 'get_GetTest')
+    const endpoint = result.endpointList.find((e) => e.meta.alias === "get_GetTest");
+    expect(endpoint).toBeDefined();
+
+    const response200 = endpoint?.responseHeaders?.["200"];
+    expect(response200?.value).toBe('{ "X-RateLimit-Limit": number, "X-RateLimit-Remaining": number, "X-RateLimit-Reset": number }')
+
+
+    const file = generateFile(result);
+    const output = await prettify(file);
+    expect(output).toContain(`{ "X-RateLimit-Limit": number; "X-RateLimit-Remaining": number; "X-RateLimit-Reset": number }`);
+  });
+});

packages/typed-openapi/tests/snapshots/docker.openapi.client.ts

@@ -1189,7 +1189,7 @@ export namespace Endpoints {
       path: { id: string };
     };
     responses: { 200: unknown; 400: Schemas.ErrorResponse; 404: Schemas.ErrorResponse; 500: Schemas.ErrorResponse };
-    responseHeaders: { 200: { "X-Docker-Container-Path-Stat": unknown } };
+    responseHeaders: { 200: { "X-Docker-Container-Path-Stat": string } };
   };
   export type post_ContainerPrune = {
     method: "POST";
@@ -1411,14 +1411,14 @@ export namespace Endpoints {
     responses: { 200: unknown; 500: unknown };
     responseHeaders: {
       200: {
-        Swarm: unknown;
-        "Docker-Experimental": unknown;
-        "Cache-Control": unknown;
-        Pragma: unknown;
-        "API-Version": unknown;
-        "Builder-Version": unknown;
+        Swarm: "inactive" | "pending" | "error" | "locked" | "active/worker" | "active/manager";
+        "Docker-Experimental": boolean;
+        "Cache-Control": string;
+        Pragma: string;
+        "API-Version": string;
+        "Builder-Version": string;
       };
-      500: { "Cache-Control": unknown; Pragma: unknown };
+      500: { "Cache-Control": string; Pragma: string };
     };
   };
   export type head_SystemPingHead = {
@@ -1429,12 +1429,12 @@ export namespace Endpoints {
     responses: { 200: unknown; 500: unknown };
     responseHeaders: {
       200: {
-        Swarm: unknown;
-        "Docker-Experimental": unknown;
-        "Cache-Control": unknown;
-        Pragma: unknown;
-        "API-Version": unknown;
-        "Builder-Version": unknown;
+        Swarm: "inactive" | "pending" | "error" | "locked" | "active/worker" | "active/manager";
+        "Docker-Experimental": boolean;
+        "Cache-Control": string;
+        Pragma: string;
+        "API-Version": string;
+        "Builder-Version": string;
       };
     };
   };

packages/typed-openapi/tests/snapshots/petstore.client.ts

@@ -175,7 +175,7 @@ export namespace Endpoints {
       query: Partial<{ username: string; password: string }>;
     };
     responses: { 200: string; 400: unknown };
-    responseHeaders: { 200: { "X-Rate-Limit": unknown; "X-Expires-After": unknown }; 400: { "X-Error": unknown } };
+    responseHeaders: { 200: { "X-Rate-Limit": number; "X-Expires-After": string }; 400: { "X-Error": string } };
   };
   export type get_LogoutUser = {
     method: "GET";