typed-openapi 1.4.5 → 1.5.0

package/dist/{chunk-52X6V4N5.js → chunk-N6BWPZUB.js}

@@ -104,15 +104,17 @@ var openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }) => {
       if (schemaType === "null") return t.literal("null");
     }
     if (!schemaType && schema.enum) {
-      return t.union(schema.enum.map((value) => {
-        if (typeof value === "string") {
-          return t.literal(`"${value}"`);
-        }
-        if (value === null) {
-          return t.literal("null");
-        }
-        return t.literal(value);
-      }));
+      return t.union(
+        schema.enum.map((value) => {
+          if (typeof value === "string") {
+            return t.literal(`"${value}"`);
+          }
+          if (value === null) {
+            return t.literal("null");
+          }
+          return t.literal(value);
+        })
+      );
     }
     if (schemaType === "array") {
       if (schema.items) {
@@ -360,6 +362,20 @@ var parameterObjectToString = (parameters) => {
   }
   return str + "}";
 };
+var responseHeadersObjectToString = (responseHeaders, ctx) => {
+  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},
+`;
+  }
+  return str + "}";
+};
 var generateEndpointSchemaList = (ctx) => {
   let file = `
   ${ctx.runtime === "none" ? "export namespace Endpoints {" : ""}
@@ -391,6 +407,7 @@ var generateEndpointSchemaList = (ctx) => {
       }
       return box;
     }).value : endpoint.response.value},
+      ${endpoint.responseHeaders ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders, ctx)},` : ""}
     }
 `;
   });
@@ -446,6 +463,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 export type DefaultEndpoint = {
   parameters?: EndpointParameters | undefined;
   response: unknown;
+  responseHeaders?: Record<string, unknown>;
 };
 
 export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
@@ -460,6 +478,7 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responseHeaders?: TConfig["responseHeaders"]
 };
 
 export type Fetcher = (method: Method, url: string, parameters?: EndpointParameters | undefined) => Promise<Response>;
@@ -852,6 +871,17 @@ var mapOpenApiEndpoints = (doc) => {
           });
         }
       }
+      const headers = responseObject?.headers;
+      if (headers) {
+        endpoint.responseHeaders = Object.entries(headers).reduce(
+          (acc, [name, headerOrRef]) => {
+            const header = refs.unwrap(headerOrRef);
+            acc[name] = openApiSchemaToTs({ schema: header.schema ?? {}, ctx });
+            return acc;
+          },
+          {}
+        );
+      }
       endpointList.push(endpoint);
     });
   });

package/dist/{chunk-F4UA5MLD.js → chunk-RGFFCU3R.js}

@@ -4,7 +4,7 @@ import {
   generateTanstackQueryFile,
   mapOpenApiEndpoints,
   prettify
-} from "./chunk-52X6V4N5.js";
+} from "./chunk-N6BWPZUB.js";
 
 // src/generate-client-files.ts
 import SwaggerParser from "@apidevtools/swagger-parser";
@@ -30,11 +30,13 @@ async function generateClientFiles(input, options) {
   const openApiDoc = await SwaggerParser.bundle(input);
   const ctx = mapOpenApiEndpoints(openApiDoc);
   console.log(`Found ${ctx.endpointList.length} endpoints`);
-  const content = await prettify(generateFile({
-    ...ctx,
-    runtime: options.runtime,
-    schemasOnly: options.schemasOnly
-  }));
+  const content = await prettify(
+    generateFile({
+      ...ctx,
+      runtime: options.runtime,
+      schemasOnly: options.schemasOnly
+    })
+  );
   const outputPath = join(
     cwd,
     options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`
@@ -47,7 +49,10 @@ async function generateClientFiles(input, options) {
       ...ctx,
       relativeApiClientPath: "./" + basename(outputPath)
     });
-    const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
+    const tanstackOutputPath = join(
+      dirname(outputPath),
+      typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`
+    );
     console.log("Generating tanstack client...", tanstackOutputPath);
     await ensureDir(dirname(tanstackOutputPath));
     await writeFile(tanstackOutputPath, tanstackContent);

package/dist/cli.js

@@ -1,9 +1,9 @@
 import {
   generateClientFiles
-} from "./chunk-F4UA5MLD.js";
+} from "./chunk-RGFFCU3R.js";
 import {
   allowedRuntimes
-} from "./chunk-52X6V4N5.js";
+} from "./chunk-N6BWPZUB.js";
 
 // src/cli.ts
 import { cac } from "cac";
@@ -14,11 +14,7 @@ cli.command("<input>", "Generate").option("-o, --output <path>", "Output path fo
   "-r, --runtime <name>",
   `Runtime to use for validation; defaults to \`none\`; available: ${allowedRuntimes.toString()}`,
   { default: "none" }
-).option(
-  "--schemas-only",
-  "Only generate schemas, skipping client generation (defaults to false)",
-  { default: false }
-).option(
+).option("--schemas-only", "Only generate schemas, skipping client generation (defaults to false)", { default: false }).option(
   "--tanstack [name]",
   "Generate tanstack client, defaults to false, can optionally specify a name for the generated file"
 ).action(async (input, _options) => {

package/dist/index.d.ts

@@ -219,6 +219,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 type DefaultEndpoint = {
     parameters?: EndpointParameters | undefined;
     response: AnyBox;
+    responseHeaders?: Record<string, AnyBox>;
 };
 type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     operation: OperationObject;
@@ -232,6 +233,7 @@ type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
         areParametersRequired: boolean;
     };
     response: TConfig["response"];
+    responseHeaders?: TConfig["responseHeaders"];
 };
 
 type GeneratorOptions$1 = ReturnType<typeof mapOpenApiEndpoints> & {

package/dist/index.js

@@ -8,7 +8,7 @@ import {
   openApiSchemaToTs,
   tsFactory,
   unwrap
-} from "./chunk-52X6V4N5.js";
+} from "./chunk-N6BWPZUB.js";
 export {
   createBoxFactory,
   createFactory,

package/dist/node.export.js

@@ -1,9 +1,9 @@
 import {
   generateClientFiles
-} from "./chunk-F4UA5MLD.js";
+} from "./chunk-RGFFCU3R.js";
 import {
   prettify
-} from "./chunk-52X6V4N5.js";
+} from "./chunk-N6BWPZUB.js";
 export {
   generateClientFiles,
   prettify

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typed-openapi",
   "type": "module",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "exports": {

package/src/cli.ts

@@ -15,11 +15,7 @@ cli
     `Runtime to use for validation; defaults to \`none\`; available: ${allowedRuntimes.toString()}`,
     { default: "none" },
   )
-  .option(
-    "--schemas-only",
-    "Only generate schemas, skipping client generation (defaults to false)",
-    { default: false },
-  )
+  .option("--schemas-only", "Only generate schemas, skipping client generation (defaults to false)", { default: false })
   .option(
     "--tanstack [name]",
     "Generate tanstack client, defaults to false, can optionally specify a name for the generated file",

package/src/generate-client-files.ts

@@ -32,11 +32,13 @@ export async function generateClientFiles(input: string, options: typeof options
   const ctx = mapOpenApiEndpoints(openApiDoc);
   console.log(`Found ${ctx.endpointList.length} endpoints`);
 
-  const content = await prettify(generateFile({
-    ...ctx,
-    runtime: options.runtime,
-    schemasOnly: options.schemasOnly,
-  }));
+  const content = await prettify(
+    generateFile({
+      ...ctx,
+      runtime: options.runtime,
+      schemasOnly: options.schemasOnly,
+    }),
+  );
   const outputPath = join(
     cwd,
     options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`,
@@ -49,9 +51,12 @@ export async function generateClientFiles(input: string, options: typeof options
   if (options.tanstack) {
     const tanstackContent = await generateTanstackQueryFile({
       ...ctx,
-      relativeApiClientPath: './' + basename(outputPath),
+      relativeApiClientPath: "./" + basename(outputPath),
     });
-    const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
+    const tanstackOutputPath = join(
+      dirname(outputPath),
+      typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`,
+    );
     console.log("Generating tanstack client...", tanstackOutputPath);
     await ensureDir(dirname(tanstackOutputPath));
     await writeFile(tanstackOutputPath, tanstackContent);

package/src/generator.ts

@@ -132,6 +132,25 @@ const parameterObjectToString = (parameters: Box<AnyBoxDef> | Record<string, Any
   }
   return str + "}";
 };
+
+const responseHeadersObjectToString = (responseHeaders: Record<string, AnyBox>, ctx: GeneratorContext) => {
+  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`;
+  }
+  return str + "}";
+};
+
 const generateEndpointSchemaList = (ctx: GeneratorContext) => {
   let file = `
   ${ctx.runtime === "none" ? "export namespace Endpoints {" : ""}
@@ -178,6 +197,11 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
             }).value
           : endpoint.response.value
       },
+      ${
+        endpoint.responseHeaders
+          ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders, ctx)},`
+          : ""
+      }
     }\n`;
   });
 
@@ -246,6 +270,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 export type DefaultEndpoint = {
   parameters?: EndpointParameters | undefined;
   response: unknown;
+  responseHeaders?: Record<string, unknown>;
 };
 
 export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
@@ -260,6 +285,7 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responseHeaders?: TConfig["responseHeaders"]
 };
 
 export type Fetcher = (method: Method, url: string, parameters?: EndpointParameters | undefined) => Promise<Response>;

package/src/map-openapi-endpoints.ts

@@ -145,6 +145,19 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
         }
       }
 
+      // Map response headers
+      const headers = responseObject?.headers;
+      if (headers) {
+        endpoint.responseHeaders = Object.entries(headers).reduce(
+          (acc, [name, headerOrRef]) => {
+            const header = refs.unwrap(headerOrRef);
+            acc[name] = openApiSchemaToTs({ schema: header.schema ?? {}, ctx });
+            return acc;
+          },
+          {} as Record<string, Box>,
+        );
+      }
+
       endpointList.push(endpoint);
     });
   });
@@ -184,6 +197,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 type DefaultEndpoint = {
   parameters?: EndpointParameters | undefined;
   response: AnyBox;
+  responseHeaders?: Record<string, AnyBox>;
 };
 
 export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
@@ -198,4 +212,5 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responseHeaders?: TConfig["responseHeaders"];
 };

package/src/openapi-schema-to-ts.ts

@@ -53,9 +53,9 @@ export const openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }: Openapi
 
     if (schema.allOf) {
       const types = schema.allOf.map((prop) => openApiSchemaToTs({ schema: prop, ctx, meta }));
-      const {allOf, externalDocs,  example, examples, description, title,  ...rest} = schema
+      const { allOf, externalDocs, example, examples, description, title, ...rest } = schema;
       if (Object.keys(rest).length > 0) {
-        types.push(openApiSchemaToTs({schema: rest, ctx, meta}))
+        types.push(openApiSchemaToTs({ schema: rest, ctx, meta }));
       }
       return t.intersection(types);
     }
@@ -72,7 +72,7 @@ export const openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }: Openapi
           } else if (value === false) {
             return t.literal("false");
           } else if (typeof value === "number") {
-            return t.literal(`${value}`)
+            return t.literal(`${value}`);
           } else {
             return t.literal(`"${value}"`);
           }
@@ -95,16 +95,18 @@ export const openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }: Openapi
       if (schemaType === "null") return t.literal("null");
     }
     if (!schemaType && schema.enum) {
-      return t.union(schema.enum.map((value) => {
-        if (typeof value === "string") {
-          return t.literal(`"${value}"`)
-        }
-        if (value === null) {
-          return t.literal("null")
-        }
-        // handle boolean and number literals
-        return t.literal(value)
-      }));
+      return t.union(
+        schema.enum.map((value) => {
+          if (typeof value === "string") {
+            return t.literal(`"${value}"`);
+          }
+          if (value === null) {
+            return t.literal("null");
+          }
+          // handle boolean and number literals
+          return t.literal(value);
+        }),
+      );
     }
 
     if (schemaType === "array") {