fix: add overrides?: RequestInit; on mutationFn

test: abort signal example

Author: astahmer

.changeset/slow-pianos-obey.md

@@ -1,6 +1,9 @@
 ---
-"typed-openapi": patch
+"typed-openapi": minor
 ---
 
-feat: allow specifying headers with HeadersInit on any request
+feat: allow specifying overrides on any request
 fix: infer/narrow response with multiple json media types
+fix: properly handle mutation errors while retaining genericity on output based on mutationFn withResponse: true/false
+feat: decodePathParams/encodeSearchParams/parseResponseData
+feat: allow passing overrides/withResponse even if there's no endpoint parameters

packages/typed-openapi/src/tanstack-query.generator.ts

@@ -156,11 +156,16 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
             (params: (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
                 withResponse?: TLocalWithResponse;
                 throwOnStatusError?: boolean;
+                overrides?: RequestInit;
             }): 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 });
+                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);

packages/typed-openapi/tests/integration-runtime-msw.test.ts

@@ -46,6 +46,12 @@ const server = setupServer(
       status: "sold",
     });
   }),
+  // Slow endpoint to allow testing AbortController cancellation
+  http.get("http://localhost/pet/111", async () => {
+    // artificial delay so we have time to abort
+    await new Promise((resolve) => setTimeout(resolve, 200));
+    return HttpResponse.json({ id: 500, name: "Slow", photoUrls: [], status: "pending" }, { status: 200 });
+  }),
   // GET with path (404 error)
   http.get("http://localhost/pet/9999", () => {
     return HttpResponse.json({ code: 404, message: "Pet not found" }, { status: 404 });
@@ -209,6 +215,29 @@ describe("Example API Client", () => {
     ]);
   });
 
+  it("should allow aborting requests via AbortController signal", async () => {
+    // custom client that forwards the provided signal to fetch
+    const mini = createApiClient(
+      {
+        fetch(input) {
+          return fetch(input.url.toString(), {
+            method: input.method,
+            signal: input.overrides?.signal ?? null,
+          });
+        },
+      },
+      "http://localhost",
+    );
+
+    const controller = new AbortController();
+    const promise = mini.get("/pet/{petId}", { path: { petId: 111 }, overrides: { signal: controller.signal } });
+
+    // abort immediately
+    controller.abort();
+
+    await expect(promise).rejects.toHaveProperty("name", "AbortError");
+  });
+
   it("should fetch /pet/findByStatus and receive mocked pets", async () => {
     const result = await api.get("/pet/findByStatus", { query: {} });
     expect(result).toEqual(mockPets);
@@ -455,6 +484,21 @@ describe("Example API Client", () => {
       expect(result.data).toEqual({ code: 404, message: expect.any(String) });
     });
 
+    it("should allow aborting requests via AbortController signal (tanstack)", async () => {
+      const mutation = tanstack.mutation("get", "/pet/{petId}");
+      const controller = new AbortController();
+
+      const promise = mutation.mutationOptions.mutationFn!({
+        path: { petId: 111 },
+        overrides: { signal: controller.signal },
+      });
+
+      // abort immediately
+      controller.abort();
+
+      await expect(promise).rejects.toHaveProperty("name", "AbortError");
+    });
+
     it("should throw when throwOnStatusError is true (tanstack)", async () => {
       const mutation = tanstack.mutation("get", "/pet/{petId}", { withResponse: true });
       let err: unknown;

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

@@ -299,6 +299,7 @@ describe("generator", () => {
             params: (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
               withResponse?: TLocalWithResponse;
               throwOnStatusError?: boolean;
+              overrides?: RequestInit;
             },
           ): Promise<TLocalSelection> => {
             const withResponse = params.withResponse ?? options?.withResponse ?? false;