typed-openapi 1.5.1 → 2.0.1

package/src/generator.ts

@@ -8,10 +8,26 @@ 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>;
 
@@ -62,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"
@@ -98,6 +121,7 @@ export const generateFile = (options: GeneratorOptions) => {
 
   const file = `
   ${transform(schemaList + endpointSchemaList)}
+  ${endpointByMethod}
   ${apiClient}
   `;
 
@@ -125,8 +149,19 @@ const generateSchemaList = ({ refs, runtime }: GeneratorContext) => {
   );
 };
 
-const parameterObjectToString = (parameters: Box<AnyBoxDef> | Record<string, AnyBox>) => {
-  if (parameters instanceof Box) return parameters.value;
+const parameterObjectToString = (parameters: Box<AnyBoxDef> | Record<string, AnyBox>, ctx: GeneratorContext) => {
+  if (parameters instanceof Box) {
+    if (ctx.runtime === "none") {
+      return parameters.recompute((box) => {
+        if (Box.isReference(box) && !box.params.generics && box.value !== "null") {
+          box.value = `Schemas.${box.value}`;
+        }
+        return box;
+      }).value;
+    }
+
+    return parameters.value;
+  }
 
   let str = "{";
   for (const [key, box] of Object.entries(parameters)) {
@@ -153,6 +188,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 {" : ""}
@@ -168,9 +221,9 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
       ${
         endpoint.meta.hasParameters
           ? `parameters: {
-            ${parameters.query ? `query:  ${parameterObjectToString(parameters.query)},` : ""}
-        ${parameters.path ? `path:  ${parameterObjectToString(parameters.path)},` : ""}
-        ${parameters.header ? `header:  ${parameterObjectToString(parameters.header)},` : ""}
+            ${parameters.query ? `query:  ${parameterObjectToString(parameters.query, ctx)},` : ""}
+        ${parameters.path ? `path:  ${parameterObjectToString(parameters.path, ctx)},` : ""}
+        ${parameters.header ? `header:  ${parameterObjectToString(parameters.header, ctx)},` : ""}
         ${
           parameters.body
             ? `body:  ${parameterObjectToString(
@@ -182,6 +235,7 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
                       return box;
                     })
                   : parameters.body,
+                ctx,
               )},`
             : ""
         }
@@ -199,6 +253,7 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
             }).value
           : endpoint.response.value
       },
+      ${endpoint.responses ? `responses: ${generateResponsesObject(endpoint.responses, ctx)},` : ""}
       ${
         endpoint.responseHeaders
           ? `responseHeaders: ${responseHeadersObjectToString(endpoint.responseHeaders, ctx)},`
@@ -227,9 +282,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")}
@@ -251,9 +308,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>
@@ -272,6 +332,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>;
 };
 
@@ -287,11 +348,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];
@@ -302,9 +416,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) {}
 
@@ -333,16 +461,47 @@ 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)
-            .with("zod", "yup", () => `as Promise<${infer(`TEndpoint["response"]`)}>`)
-            .with("arktype", "io-ts", "typebox", "valibot", () => `as Promise<${infer(`TEndpoint`) + `["response"]`}>`)
-            .otherwise(() => `as Promise<TEndpoint["response"]>`)};
+      .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"]>`)}
     }
     // </ApiClient.${method}>
     `
@@ -373,11 +532,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>
 }
@@ -395,10 +551,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

@@ -105,13 +105,20 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject, options?: { nameTransfor
 
       // Make parameters optional if all or some of them are not required
       if (params) {
-        const t = createBoxFactory({}, ctx);
         const filtered_params = ["query", "path", "header"] as Array<
           keyof Pick<typeof params, "query" | "path" | "header">
         >;
 
         for (const k of filtered_params) {
           if (params[k] && lists[k].length) {
+            const properties = Object.entries(params[k]!).reduce(
+              (acc, [key, value]) => {
+                if (value.schema) acc[key] = value.schema;
+                return acc;
+              },
+              {} as Record<string, NonNullable<AnyBox["schema"]>>,
+            );
+            const t = createBoxFactory({ type: "object", properties: properties }, ctx);
             if (lists[k].every((param) => !param.required)) {
               params[k] = t.reference("Partial", [t.object(params[k]!)]) as any;
             } else {
@@ -130,14 +137,56 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject, options?: { nameTransfor
 
       // 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;
@@ -184,7 +233,7 @@ const isAllowedParamMediaTypes = (
   allowedParamMediaTypes.includes(mediaType as any) ||
   mediaType.includes("text/");
 
-const isResponseMediaType = (mediaType: string) => mediaType === "application/json";
+const isResponseMediaType = (mediaType: string) => mediaType === "application/json" || mediaType === "*/*";
 const getAlias = ({ path, method, operation }: Endpoint) =>
   sanitizeName(
     (method + "_" + capitalize(operation.operationId ?? pathToVariableName(path))).replace(/-/g, "__"),
@@ -206,6 +255,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>;
 };
 
@@ -221,5 +271,6 @@ export type Endpoint<TConfig extends DefaultEndpoint = DefaultEndpoint> = {
     areParametersRequired: boolean;
   };
   response: TConfig["response"];
+  responses?: TConfig["responses"];
   responseHeaders?: TConfig["responseHeaders"];
 };

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

@@ -16,7 +16,6 @@ export const openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }: Openapi
   const getTs = () => {
     if (isReferenceObject(schema)) {
       const refInfo = ctx.refs.getInfosByRef(schema.$ref);
-
       return t.reference(refInfo.normalized);
     }
 
@@ -153,7 +152,9 @@ export const openApiSchemaToTs = ({ schema, meta: _inheritedMeta, ctx }: Openapi
           });
         }
 
-        additionalProperties = t.object({ [t.string().value]: additionalPropertiesType! });
+        additionalProperties = t.literal(
+          `Record<string, ${additionalPropertiesType ? additionalPropertiesType.value : t.any().value}>`,
+        );
       }
 
       const hasRequiredArray = schema.required && schema.required.length > 0;

package/src/tanstack-query.generator.ts

@@ -3,14 +3,17 @@ import { prettify } from "./format.ts";
 import type { mapOpenApiEndpoints } from "./map-openapi-endpoints.ts";
 
 type GeneratorOptions = ReturnType<typeof mapOpenApiEndpoints>;
-type GeneratorContext = Required<GeneratorOptions>;
+type GeneratorContext = Required<GeneratorOptions> & {
+  errorStatusCodes?: readonly number[];
+};
 
 export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relativeApiClientPath: string }) => {
   const endpointMethods = new Set(ctx.endpointList.map((endpoint) => endpoint.method.toLowerCase()));
 
   const file = `
   import { queryOptions } from "@tanstack/react-query"
-  import type { EndpointByMethod, ApiClient } from "${ctx.relativeApiClientPath}"
+  import type { EndpointByMethod, ApiClient, SuccessStatusCode, ErrorStatusCode, InferResponseByStatus } from "${ctx.relativeApiClientPath}"
+  import { errorStatusCodes, TypedResponseError } from "${ctx.relativeApiClientPath}"
 
   type EndpointQueryKey<TOptions extends EndpointParameters> = [
       TOptions & {
@@ -77,30 +80,36 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
             path: Path,
             ...params: MaybeOptionalArg<TEndpoint["parameters"]>
         ) {
-            const queryKey = createQueryKey(path, params[0]);
+            const queryKey = createQueryKey(path as string, params[0]);
             const query = {
                 /** type-only property if you need easy access to the endpoint params */
                 "~endpoint": {} as TEndpoint,
                 queryKey,
+                queryFn: {} as "You need to pass .queryOptions to the useQuery hook",
                 queryOptions: queryOptions({
                     queryFn: async ({ queryKey, signal, }) => {
-                        const res = await this.client.${method}(path, {
-                            ...params,
-                            ...queryKey[0],
+                        const requestParams = {
+                            ...(params[0] || {}),
+                            ...(queryKey[0] || {}),
                             signal,
-                        });
+                            withResponse: false as const
+                        };
+                        const res = await this.client.${method}(path, requestParams);
                         return res as TEndpoint["response"];
                     },
                     queryKey: queryKey
                 }),
+                mutationFn: {} as "You need to pass .mutationOptions to the useMutation hook",
                 mutationOptions: {
                     mutationKey: queryKey,
                     mutationFn: async (localOptions: TEndpoint extends { parameters: infer Parameters} ? Parameters: never) => {
-                        const res = await this.client.${method}(path, {
-                            ...params,
-                            ...queryKey[0],
-                            ...localOptions,
-                        });
+                        const requestParams = {
+                            ...(params[0] || {}),
+                            ...(queryKey[0] || {}),
+                            ...(localOptions || {}),
+                            withResponse: false as const
+                        };
+                        const res = await this.client.${method}(path, requestParams);
                         return res as TEndpoint["response"];
                     }
                 }
@@ -115,32 +124,67 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
 
         // <ApiClient.request>
         /**
-         * Generic mutation method with full type-safety for any endpoint that doesnt require parameters to be passed initially
+         * Generic mutation method with full type-safety for any endpoint; it doesnt require parameters to be passed initially
+         * but instead will require them to be passed when calling the mutation.mutate() method
          */
         mutation<
             TMethod extends keyof EndpointByMethod,
             TPath extends keyof EndpointByMethod[TMethod],
             TEndpoint extends EndpointByMethod[TMethod][TPath],
-            TSelection,
-        >(method: TMethod, path: TPath, selectFn?: (res: Omit<Response, "json"> & {
-            /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */
-            json: () => Promise<TEndpoint extends { response: infer Res } ? Res : never>;
-        }) => TSelection) {
+            TWithResponse extends boolean = false,
+            TSelection = TWithResponse extends true
+                ? InferResponseByStatus<TEndpoint, SuccessStatusCode>
+                : TEndpoint extends { response: infer Res } ? Res : never,
+            TError = TEndpoint extends { responses: infer TResponses }
+                ? TResponses extends Record<string | number, unknown>
+                    ? InferResponseByStatus<TEndpoint, ErrorStatusCode>
+                    : Error
+                : Error
+        >(method: TMethod, path: TPath, options?: {
+            withResponse?: TWithResponse;
+            selectFn?: (res: TWithResponse extends true
+                ? InferResponseByStatus<TEndpoint, SuccessStatusCode>
+                : TEndpoint extends { response: infer Res } ? Res : never
+            ) => TSelection;
+             throwOnStatusError?: boolean
+        }) {
             const mutationKey = [{ method, path }] as const;
             return {
             /** type-only property if you need easy access to the endpoint params */
             "~endpoint": {} as TEndpoint,
             mutationKey: mutationKey,
+            mutationFn: {} as "You need to pass .mutationOptions to the useMutation hook",
             mutationOptions: {
                 mutationKey: mutationKey,
-                mutationFn: async (params: TEndpoint extends { parameters: infer Parameters } ? Parameters : never) => {
-                const response = await this.client.request(method, path, params);
-                const res = selectFn ? selectFn(response) : response
-                return res as unknown extends TSelection ? typeof response : Awaited<TSelection>
-                },
-            },
-            };
+                mutationFn: async <TLocalWithResponse extends boolean = TWithResponse, TLocalSelection = TLocalWithResponse extends true
+                    ? InferResponseByStatus<TEndpoint, SuccessStatusCode>
+                    : TEndpoint extends { response: infer Res }
+                        ? Res
+                        : never>
+                (params: (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
+                    withResponse?: TLocalWithResponse;
+                    throwOnStatusError?: boolean;
+                }): Promise<TLocalSelection> => {
+                    const withResponse = params.withResponse ??options?.withResponse ?? false;
+                    const throwOnStatusError = params.throwOnStatusError ?? options?.throwOnStatusError ?? (withResponse ? false : true);
+                    const selectFn = options?.selectFn;
+                    const response = await (this.client as any)[method](path, { ...params as any, withResponse: true, throwOnStatusError: false });
+
+                    if (throwOnStatusError && errorStatusCodes.includes(response.status as never)) {
+                        throw new TypedResponseError(response as never);
+                    }
+
+                    // Return just the data if withResponse is false, otherwise return the full response
+                    const finalResponse = withResponse ? response : response.data;
+                    const res = selectFn ? selectFn(finalResponse as any) : finalResponse;
+                    return res as never;
+                }
+            } satisfies import("@tanstack/react-query").UseMutationOptions<TSelection, TError, (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
+                    withResponse?: boolean;
+                    throwOnStatusError?: boolean;
+                }>,
         }
+    }
         // </ApiClient.request>
   }
 `;