typed-openapi 1.5.0 → 2.0.0

package/src/generator.ts

@@ -6,10 +6,28 @@ import * as Codegen from "@sinclair/typebox-codegen";
 import { match } from "ts-pattern";
 import { type } from "arktype";
 import { wrapWithQuotesIfNeeded } from "./string-utils.ts";
+import type { NameTransformOptions } from "./types.ts";
 
-type GeneratorOptions = ReturnType<typeof mapOpenApiEndpoints> & {
+// Default success status codes (2xx and 3xx ranges)
+export const DEFAULT_SUCCESS_STATUS_CODES = [
+  200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308,
+] as const;
+
+// Default error status codes (4xx and 5xx ranges)
+export const DEFAULT_ERROR_STATUS_CODES = [
+  400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424,
+  425, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511,
+] as const;
+
+export type ErrorStatusCode = (typeof DEFAULT_ERROR_STATUS_CODES)[number];
+
+export type GeneratorOptions = ReturnType<typeof mapOpenApiEndpoints> & {
   runtime?: "none" | keyof typeof runtimeValidationGenerator;
   schemasOnly?: boolean;
+  nameTransform?: NameTransformOptions | undefined;
+  successStatusCodes?: readonly number[];
+  errorStatusCodes?: readonly number[];
+  includeClient?: boolean;
 };
 type GeneratorContext = Required<GeneratorOptions>;
 
@@ -60,11 +78,18 @@ const replacerByRuntime = {
 };
 
 export const generateFile = (options: GeneratorOptions) => {
-  const ctx = { ...options, runtime: options.runtime ?? "none" } as GeneratorContext;
+  const ctx = {
+    ...options,
+    runtime: options.runtime ?? "none",
+    successStatusCodes: options.successStatusCodes ?? DEFAULT_SUCCESS_STATUS_CODES,
+    errorStatusCodes: options.errorStatusCodes ?? DEFAULT_ERROR_STATUS_CODES,
+    includeClient: options.includeClient ?? true,
+  } as GeneratorContext;
 
   const schemaList = generateSchemaList(ctx);
   const endpointSchemaList = options.schemasOnly ? "" : generateEndpointSchemaList(ctx);
-  const apiClient = options.schemasOnly ? "" : generateApiClient(ctx);
+  const endpointByMethod = options.schemasOnly ? "" : generateEndpointByMethod(ctx);
+  const apiClient = options.schemasOnly || !ctx.includeClient ? "" : generateApiClient(ctx);
 
   const transform =
     ctx.runtime === "none"
@@ -96,6 +121,7 @@ export const generateFile = (options: GeneratorOptions) => {
 
   const file = `
   ${transform(schemaList + endpointSchemaList)}
+  ${endpointByMethod}
   ${apiClient}
   `;
 
@@ -151,6 +177,24 @@ const responseHeadersObjectToString = (responseHeaders: Record<string, AnyBox>,
   return str + "}";
 };
 
+const generateResponsesObject = (responses: Record<string, AnyBox>, ctx: GeneratorContext) => {
+  let str = "{";
+  for (const [statusCode, responseType] of Object.entries(responses)) {
+    const value =
+      ctx.runtime === "none"
+        ? responseType.recompute((box) => {
+            if (Box.isReference(box) && !box.params.generics && box.value !== "null") {
+              box.value = `Schemas.${box.value}`;
+            }
+
+            return box;
+          }).value
+        : responseType.value;
+    str += `${wrapWithQuotesIfNeeded(statusCode)}: ${value},\n`;
+  }
+  return str + "}";
+};
+
 const generateEndpointSchemaList = (ctx: GeneratorContext) => {
   let file = `
   ${ctx.runtime === "none" ? "export namespace Endpoints {" : ""}
@@ -197,6 +241,7 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
             }).value
           : endpoint.response.value
       },
+      ${endpoint.responses ? `responses: ${generateResponsesObject(endpoint.responses, ctx)},` : ""}
       ${
         endpoint.responseHeaders
           ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders, ctx)},`
@@ -225,9 +270,11 @@ const generateEndpointByMethod = (ctx: GeneratorContext) => {
      ${Object.entries(byMethods)
        .map(([method, list]) => {
          return `${method}: {
-           ${list.map(
-             (endpoint) => `"${endpoint.path}": ${ctx.runtime === "none" ? "Endpoints." : ""}${endpoint.meta.alias}`,
-           )}
+           ${list
+             .map(
+               (endpoint) => `"${endpoint.path}": ${ctx.runtime === "none" ? "Endpoints." : ""}${endpoint.meta.alias}`,
+             )
+             .join(",\n")}
          }`;
        })
        .join(",\n")}
@@ -249,9 +296,12 @@ const generateEndpointByMethod = (ctx: GeneratorContext) => {
 };
 
 const generateApiClient = (ctx: GeneratorContext) => {
+  if (!ctx.includeClient) {
+    return "";
+  }
+
   const { endpointList } = ctx;
   const byMethods = groupBy(endpointList, "method");
-  const endpointSchemaList = generateEndpointByMethod(ctx);
 
   const apiClientTypes = `
 // <ApiClientTypes>
@@ -270,6 +320,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 export type DefaultEndpoint = {
   parameters?: EndpointParameters | undefined;
   response: unknown;
+  responses?: Record<string, unknown>;
   responseHeaders?: Record<string, unknown>;
 };
 
@@ -285,11 +336,64 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responses?: TConfig["responses"];
   responseHeaders?: TConfig["responseHeaders"]
 };
 
 export type Fetcher = (method: Method, url: string, parameters?: EndpointParameters | undefined) => Promise<Response>;
 
+export const successStatusCodes = [${ctx.successStatusCodes.join(",")}] as const;
+export type SuccessStatusCode = typeof successStatusCodes[number];
+
+export const errorStatusCodes = [${ctx.errorStatusCodes.join(",")}] as const;
+export type ErrorStatusCode = typeof errorStatusCodes[number];
+
+// Error handling types
+/** @see https://developer.mozilla.org/en-US/docs/Web/API/Response */
+interface SuccessResponse<TSuccess, TStatusCode> extends Omit<Response, "ok" | "status" | "json"> {
+  ok: true;
+  status: TStatusCode;
+  data: TSuccess;
+  /** [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Response/json) */
+  json: () => Promise<TSuccess>;
+}
+
+/** @see https://developer.mozilla.org/en-US/docs/Web/API/Response */
+interface ErrorResponse<TData, TStatusCode> extends Omit<Response, "ok" | "status" | "json"> {
+  ok: false;
+  status: TStatusCode;
+  data: TData;
+  /** [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Response/json) */
+  json: () => Promise<TData>;
+}
+
+export type TypedApiResponse<TSuccess, TAllResponses extends Record<string | number, unknown> = {}> =
+  (keyof TAllResponses extends never
+    ? SuccessResponse<TSuccess, number>
+    : {
+        [K in keyof TAllResponses]: K extends string
+          ? K extends \`\${infer TStatusCode extends number}\`
+            ? TStatusCode extends SuccessStatusCode
+              ? SuccessResponse<TSuccess, TStatusCode>
+              : ErrorResponse<TAllResponses[K], TStatusCode>
+            : never
+          : K extends number
+            ? K extends SuccessStatusCode
+              ? SuccessResponse<TSuccess, K>
+              : ErrorResponse<TAllResponses[K], K>
+            : never;
+      }[keyof TAllResponses]);
+
+export type SafeApiResponse<TEndpoint> = TEndpoint extends { response: infer TSuccess; responses: infer TResponses }
+  ? TResponses extends Record<string, unknown>
+    ? TypedApiResponse<TSuccess, TResponses>
+    : SuccessResponse<TSuccess, number>
+  : TEndpoint extends { response: infer TSuccess }
+    ? SuccessResponse<TSuccess, number>
+    : never;
+
+export type InferResponseByStatus<TEndpoint, TStatusCode> = Extract<SafeApiResponse<TEndpoint>, { status: TStatusCode }>
+
 type RequiredKeys<T> = {
   [P in keyof T]-?: undefined extends T[P] ? never : P;
 }[keyof T];
@@ -300,9 +404,23 @@ type MaybeOptionalArg<T> = RequiredKeys<T> extends never ? [config?: T] : [confi
 `;
 
   const apiClient = `
+// <TypedResponseError>
+export class TypedResponseError extends Error {
+  response: ErrorResponse<unknown, ErrorStatusCode>;
+  status: number;
+  constructor(response: ErrorResponse<unknown, ErrorStatusCode>) {
+    super(\`HTTP \${response.status}: \${response.statusText}\`);
+    this.name = 'TypedResponseError';
+    this.response = response;
+    this.status = response.status;
+  }
+}
+// </TypedResponseError>
 // <ApiClient>
 export class ApiClient {
   baseUrl: string = "";
+  successStatusCodes = successStatusCodes;
+  errorStatusCodes = errorStatusCodes;
 
   constructor(public fetcher: Fetcher) {}
 
@@ -331,16 +449,53 @@ export class ApiClient {
       ...params: MaybeOptionalArg<${match(ctx.runtime)
         .with("zod", "yup", () => infer(`TEndpoint["parameters"]`))
         .with("arktype", "io-ts", "typebox", "valibot", () => infer(`TEndpoint`) + `["parameters"]`)
-        .otherwise(() => `TEndpoint["parameters"]`)}>
+        .otherwise(() => `TEndpoint["parameters"]`)} & { withResponse?: false; throwOnStatusError?: boolean }>
     ): Promise<${match(ctx.runtime)
       .with("zod", "yup", () => infer(`TEndpoint["response"]`))
       .with("arktype", "io-ts", "typebox", "valibot", () => infer(`TEndpoint`) + `["response"]`)
-      .otherwise(() => `TEndpoint["response"]`)}> {
-      return this.fetcher("${method}", this.baseUrl + path, params[0])
-          .then(response => this.parseResponse(response))${match(ctx.runtime)
+      .otherwise(() => `TEndpoint["response"]`)}>;
+
+    ${method}<Path extends keyof ${capitalizedMethod}Endpoints, TEndpoint extends ${capitalizedMethod}Endpoints[Path]>(
+      path: Path,
+      ...params: MaybeOptionalArg<${match(ctx.runtime)
+        .with("zod", "yup", () => infer(`TEndpoint["parameters"]`))
+        .with("arktype", "io-ts", "typebox", "valibot", () => infer(`TEndpoint`) + `["parameters"]`)
+        .otherwise(() => `TEndpoint["parameters"]`)} & { withResponse: true; throwOnStatusError?: boolean }>
+    ): Promise<SafeApiResponse<TEndpoint>>;
+
+    ${method}<Path extends keyof ${capitalizedMethod}Endpoints, TEndpoint extends ${capitalizedMethod}Endpoints[Path]>(
+      path: Path,
+      ...params: MaybeOptionalArg<any>
+    ): Promise<any> {
+      const requestParams = params[0];
+      const withResponse = requestParams?.withResponse;
+      const { withResponse: _, throwOnStatusError = withResponse ? false : true, ...fetchParams } = requestParams || {};
+
+      const promise = this.fetcher("${method}", this.baseUrl + path, Object.keys(fetchParams).length ? requestParams : undefined)
+        .then(async (response) => {
+          const data = await this.parseResponse(response);
+          const typedResponse = Object.assign(response, {
+            data: data,
+            json: () => Promise.resolve(data)
+          }) as SafeApiResponse<TEndpoint>;
+
+          if (throwOnStatusError && errorStatusCodes.includes(response.status as never)) {
+            throw new TypedResponseError(typedResponse as never);
+          }
+
+          return withResponse ? typedResponse : data;
+        });
+
+        return promise ${match(ctx.runtime)
             .with("zod", "yup", () => `as Promise<${infer(`TEndpoint["response"]`)}>`)
-            .with("arktype", "io-ts", "typebox", "valibot", () => `as Promise<${infer(`TEndpoint`) + `["response"]`}>`)
-            .otherwise(() => `as Promise<TEndpoint["response"]>`)};
+            .with(
+              "arktype",
+              "io-ts",
+              "typebox",
+              "valibot",
+              () => `as Promise<${infer(`TEndpoint`) + `["response"]`}>`,
+            )
+            .otherwise(() => `as Promise<TEndpoint["response"]>`)}
     }
     // </ApiClient.${method}>
     `
@@ -371,11 +526,8 @@ export class ApiClient {
           () => inferByRuntime[ctx.runtime](`TEndpoint`) + `["parameters"]`,
         )
         .otherwise(() => `TEndpoint extends { parameters: infer Params } ? Params : never`)}>)
-    : Promise<Omit<Response, "json"> & {
-      /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */
-      json: () => Promise<TEndpoint extends { response: infer Res } ? Res : never>;
-    }> {
-      return this.fetcher(method, this.baseUrl + (path as string), params[0] as EndpointParameters);
+    : Promise<SafeApiResponse<TEndpoint>> {
+      return this.fetcher(method, this.baseUrl + (path as string), params[0] as EndpointParameters) as Promise<SafeApiResponse<TEndpoint>>;
     }
     // </ApiClient.request>
 }
@@ -393,10 +545,25 @@ export function createApiClient(fetcher: Fetcher, baseUrl?: string) {
  api.get("/users").then((users) => console.log(users));
  api.post("/users", { body: { name: "John" } }).then((user) => console.log(user));
  api.put("/users/:id", { path: { id: 1 }, body: { name: "John" } }).then((user) => console.log(user));
+
+ // With error handling
+ const result = await api.get("/users/{id}", { path: { id: "123" }, withResponse: true });
+ if (result.ok) {
+   // Access data directly
+   const user = result.data;
+   console.log(user);
+
+   // Or use the json() method for compatibility
+   const userFromJson = await result.json();
+   console.log(userFromJson);
+ } else {
+   const error = result.data;
+   console.error(\`Error \${result.status}:\`, error);
+ }
 */
 
-// </ApiClient
+// </ApiClient>
 `;
 
-  return endpointSchemaList + apiClientTypes + apiClient;
+  return apiClientTypes + apiClient;
 };

package/src/map-openapi-endpoints.ts

@@ -8,11 +8,13 @@ import { createRefResolver } from "./ref-resolver.ts";
 import { tsFactory } from "./ts-factory.ts";
 import { AnyBox, BoxRef, OpenapiSchemaConvertContext } from "./types.ts";
 import { pathToVariableName } from "./string-utils.ts";
+import { NameTransformOptions } from "./types.ts";
 import { match, P } from "ts-pattern";
+import { sanitizeName } from "./sanitize-name.ts";
 
 const factory = tsFactory;
 
-export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
+export const mapOpenApiEndpoints = (doc: OpenAPIObject, options?: { nameTransform?: NameTransformOptions }) => {
   const refs = createRefResolver(doc, factory);
   const ctx: OpenapiSchemaConvertContext = { refs, factory };
   const endpointList = [] as Array<Endpoint>;
@@ -22,6 +24,10 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
     Object.entries(pathItem).forEach(([method, operation]) => {
       if (operation.deprecated) return;
 
+      let alias = getAlias({ path, method, operation } as Endpoint);
+      if (options?.nameTransform?.transformEndpointName) {
+        alias = options.nameTransform.transformEndpointName({ alias, path, method: method as Method, operation });
+      }
       const endpoint = {
         operation,
         method: method as Method,
@@ -29,7 +35,7 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
         requestFormat: "json",
         response: openApiSchemaToTs({ schema: {}, ctx }),
         meta: {
-          alias: getAlias({ path, method, operation } as Endpoint),
+          alias,
           areParametersRequired: false,
           hasParameters: false,
         },
@@ -84,7 +90,7 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
 
         if (matchingMediaType && content[matchingMediaType]) {
           params.body = openApiSchemaToTs({
-            schema: content[matchingMediaType]?.schema ?? {} ?? {},
+            schema: content[matchingMediaType]?.schema ?? {},
             ctx,
           });
         }
@@ -124,14 +130,56 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
 
       // Match the first 2xx-3xx response found, or fallback to default one otherwise
       let responseObject: ResponseObject | undefined;
+      const allResponses: Record<string, AnyBox> = {};
+
       Object.entries(operation.responses ?? {}).map(([status, responseOrRef]) => {
         const statusCode = Number(status);
-        if (statusCode >= 200 && statusCode < 300) {
-          responseObject = refs.unwrap<ResponseObject>(responseOrRef);
+        const responseObj = refs.unwrap<ResponseObject>(responseOrRef);
+
+        // Collect all responses for error handling
+        const content = responseObj?.content;
+        if (content) {
+          const matchingMediaType = Object.keys(content).find(isResponseMediaType);
+          if (matchingMediaType && content[matchingMediaType]) {
+            allResponses[status] = openApiSchemaToTs({
+              schema: content[matchingMediaType]?.schema ?? {},
+              ctx,
+            });
+          } else {
+            // If no JSON content, use unknown type
+            allResponses[status] = openApiSchemaToTs({ schema: {}, ctx });
+          }
+        } else {
+          // If no content defined, use unknown type
+          allResponses[status] = openApiSchemaToTs({ schema: {}, ctx });
+        }
+
+        // Keep the current logic for the main response (first 2xx-3xx)
+        if (statusCode >= 200 && statusCode < 300 && !responseObject) {
+          responseObject = responseObj;
         }
       });
+
       if (!responseObject && operation.responses?.default) {
         responseObject = refs.unwrap(operation.responses.default);
+        // Also add default to all responses if not already covered
+        if (!allResponses["default"]) {
+          const content = responseObject?.content;
+          if (content) {
+            const matchingMediaType = Object.keys(content).find(isResponseMediaType);
+            if (matchingMediaType && content[matchingMediaType]) {
+              allResponses["default"] = openApiSchemaToTs({
+                schema: content[matchingMediaType]?.schema ?? {},
+                ctx,
+              });
+            }
+          }
+        }
+      }
+
+      // Set the responses collection
+      if (Object.keys(allResponses).length > 0) {
+        endpoint.responses = allResponses;
       }
 
       const content = responseObject?.content;
@@ -139,7 +187,7 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
         const matchingMediaType = Object.keys(content).find(isResponseMediaType);
         if (matchingMediaType && content[matchingMediaType]) {
           endpoint.response = openApiSchemaToTs({
-            schema: content[matchingMediaType]?.schema ?? {} ?? {},
+            schema: content[matchingMediaType]?.schema ?? {},
             ctx,
           });
         }
@@ -180,10 +228,13 @@ const isAllowedParamMediaTypes = (
 
 const isResponseMediaType = (mediaType: string) => mediaType === "application/json";
 const getAlias = ({ path, method, operation }: Endpoint) =>
-  (method + "_" + capitalize(operation.operationId ?? pathToVariableName(path))).replace(/-/g, "__");
+  sanitizeName(
+    (method + "_" + capitalize(operation.operationId ?? pathToVariableName(path))).replace(/-/g, "__"),
+    "endpoint",
+  );
 
 type MutationMethod = "post" | "put" | "patch" | "delete";
-type Method = "get" | "head" | "options" | MutationMethod;
+export type Method = "get" | "head" | "options" | MutationMethod;
 
 export type EndpointParameters = {
   body?: Box<BoxRef>;
@@ -197,6 +248,7 @@ type RequestFormat = "json" | "form-data" | "form-url" | "binary" | "text";
 type DefaultEndpoint = {
   parameters?: EndpointParameters | undefined;
   response: AnyBox;
+  responses?: Record<string, AnyBox>;
   responseHeaders?: Record<string, AnyBox>;
 };
 
@@ -212,5 +264,6 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responses?: TConfig["responses"];
   responseHeaders?: TConfig["responseHeaders"];
 };

package/src/node.export.ts

@@ -1,2 +1 @@
-export { prettify } from "./format.ts";
 export { generateClientFiles } from "./generate-client-files.ts";

package/src/pretty.export.ts

@@ -0,0 +1 @@
+export { prettify } from "./format.ts";

package/src/ref-resolver.ts

@@ -5,8 +5,10 @@ import { Box } from "./box.ts";
 import { isReferenceObject } from "./is-reference-object.ts";
 import { openApiSchemaToTs } from "./openapi-schema-to-ts.ts";
 import { normalizeString } from "./string-utils.ts";
+import { NameTransformOptions } from "./types.ts";
 import { AnyBoxDef, GenericFactory, type LibSchemaObject } from "./types.ts";
 import { topologicalSort } from "./topological-sort.ts";
+import { sanitizeName } from "./sanitize-name.ts";
 
 const autocorrectRef = (ref: string) => (ref[1] === "/" ? ref : "#/" + ref.slice(1));
 const componentsWithSchemas = ["schemas", "responses", "parameters", "requestBodies", "headers"];
@@ -26,7 +28,11 @@ export type RefInfo = {
   kind: "schemas" | "responses" | "parameters" | "requestBodies" | "headers";
 };
 
-export const createRefResolver = (doc: OpenAPIObject, factory: GenericFactory) => {
+export const createRefResolver = (
+  doc: OpenAPIObject,
+  factory: GenericFactory,
+  nameTransform?: NameTransformOptions,
+) => {
   // both used for debugging purpose
   const nameByRef = new Map<string, string>();
   const refByName = new Map<string, string>();
@@ -48,7 +54,11 @@ export const createRefResolver = (doc: OpenAPIObject, factory: GenericFactory) =
 
     // "#/components/schemas/Something.jsonld" -> "Something.jsonld"
     const name = split[split.length - 1]!;
-    const normalized = normalizeString(name);
+    let normalized = normalizeString(name);
+    if (nameTransform?.transformSchemaName) {
+      normalized = nameTransform.transformSchemaName(normalized);
+    }
+    normalized = sanitizeName(normalized, "schema");
 
     nameByRef.set(correctRef, normalized);
     refByName.set(normalized, correctRef);

package/src/sanitize-name.ts

@@ -0,0 +1,79 @@
+const reservedWords = new Set([
+  // TS keywords and built-ins
+  "import",
+  "package",
+  "namespace",
+  "Record",
+  "Partial",
+  "Required",
+  "Readonly",
+  "Pick",
+  "Omit",
+  "String",
+  "Number",
+  "Boolean",
+  "Object",
+  "Array",
+  "Function",
+  "any",
+  "unknown",
+  "never",
+  "void",
+  "extends",
+  "super",
+  "class",
+  "interface",
+  "type",
+  "enum",
+  "const",
+  "let",
+  "var",
+  "if",
+  "else",
+  "for",
+  "while",
+  "do",
+  "switch",
+  "case",
+  "default",
+  "break",
+  "continue",
+  "return",
+  "try",
+  "catch",
+  "finally",
+  "throw",
+  "new",
+  "delete",
+  "in",
+  "instanceof",
+  "typeof",
+  "void",
+  "with",
+  "yield",
+  "await",
+  "static",
+  "public",
+  "private",
+  "protected",
+  "abstract",
+  "as",
+  "asserts",
+  "from",
+  "get",
+  "set",
+  "module",
+  "require",
+  "keyof",
+  "readonly",
+  "global",
+  "symbol",
+  "bigint",
+]);
+
+export function sanitizeName(name: string, type: "schema" | "endpoint") {
+  let n = name.replace(/[\W/]+/g, "_");
+  if (/^\d/.test(n)) n = "_" + n;
+  if (reservedWords.has(n)) n = (type === "schema" ? "Schema_" : "Endpoint_") + n;
+  return n;
+}