feat: mutationOptions + .mutation (if input is not available before)

Author: astahmer

.changeset/quick-ends-listen.md

@@ -0,0 +1,5 @@
+---
+"typed-openapi": patch
+---
+
+feat: mutationOptions + .mutation (if input is not available before)

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

@@ -84,18 +84,50 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
                             ...params,
                             ...queryKey[0],
                             signal,
-                            throwOnError: true
                         });
                         return res as TEndpoint["response"];
                     },
                     queryKey: queryKey
                 }),
+                mutationOptions: {
+                    mutationKey: queryKey,
+                    mutationFn: async (localOptions) => {
+                        const res = await this.client.${method}(path, {
+                            ...params,
+                            ...queryKey[0],
+                            ...localOptions,
+                        });
+                        return res as TEndpoint["response"];
+                    }
+                }
             };
 
             return query
         }
-        // </ApiClient.get>
+        // </ApiClient.${method}>
         `).join("\n")}
+
+        // <ApiClient.request>
+        /**
+         * Generic mutation method with full type-safety for any endpoint that doesnt require parameters to be passed initially
+         */
+        mutation<
+        TMethod extends keyof EndpointByMethod,
+        TPath extends keyof EndpointByMethod[TMethod],
+        TEndpoint extends EndpointByMethod[TMethod][TPath]
+        >(
+          method: TMethod,
+          path: TPath) {
+            const mutationKey = [{ method, path }] as const;
+            return {
+                mutationKey: mutationKey,
+                mutationOptions: {
+                    mutationKey: mutationKey,
+                    mutationFn: async (params: TEndpoint extends { parameters: infer Parameters} ? Parameters: never) => this.client.request(method, path, params)
+                }
+            }
+        }
+        // </ApiClient.request>
   }
 `;
 

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

@@ -88,17 +88,27 @@ describe("generator", () => {
                   ...params,
                   ...queryKey[0],
                   signal,
-                  throwOnError: true,
                 });
                 return res as TEndpoint["response"];
               },
               queryKey: queryKey,
             }),
+            mutationOptions: {
+              mutationKey: queryKey,
+              mutationFn: async (localOptions) => {
+                const res = await this.client.put(path, {
+                  ...params,
+                  ...queryKey[0],
+                  ...localOptions,
+                });
+                return res as TEndpoint["response"];
+              },
+            },
           };
 
           return query;
         }
-        // </ApiClient.get>
+        // </ApiClient.put>
 
         // <ApiClient.post>
         post<Path extends keyof PostEndpoints, TEndpoint extends PostEndpoints[Path]>(
@@ -116,17 +126,27 @@ describe("generator", () => {
                   ...params,
                   ...queryKey[0],
                   signal,
-                  throwOnError: true,
                 });
                 return res as TEndpoint["response"];
               },
               queryKey: queryKey,
             }),
+            mutationOptions: {
+              mutationKey: queryKey,
+              mutationFn: async (localOptions) => {
+                const res = await this.client.post(path, {
+                  ...params,
+                  ...queryKey[0],
+                  ...localOptions,
+                });
+                return res as TEndpoint["response"];
+              },
+            },
           };
 
           return query;
         }
-        // </ApiClient.get>
+        // </ApiClient.post>
 
         // <ApiClient.get>
         get<Path extends keyof GetEndpoints, TEndpoint extends GetEndpoints[Path]>(
@@ -144,12 +164,22 @@ describe("generator", () => {
                   ...params,
                   ...queryKey[0],
                   signal,
-                  throwOnError: true,
                 });
                 return res as TEndpoint["response"];
               },
               queryKey: queryKey,
             }),
+            mutationOptions: {
+              mutationKey: queryKey,
+              mutationFn: async (localOptions) => {
+                const res = await this.client.get(path, {
+                  ...params,
+                  ...queryKey[0],
+                  ...localOptions,
+                });
+                return res as TEndpoint["response"];
+              },
+            },
           };
 
           return query;
@@ -172,17 +202,48 @@ describe("generator", () => {
                   ...params,
                   ...queryKey[0],
                   signal,
-                  throwOnError: true,
                 });
                 return res as TEndpoint["response"];
               },
               queryKey: queryKey,
             }),
+            mutationOptions: {
+              mutationKey: queryKey,
+              mutationFn: async (localOptions) => {
+                const res = await this.client.delete(path, {
+                  ...params,
+                  ...queryKey[0],
+                  ...localOptions,
+                });
+                return res as TEndpoint["response"];
+              },
+            },
           };
 
           return query;
         }
-        // </ApiClient.get>
+        // </ApiClient.delete>
+
+        // <ApiClient.request>
+        /**
+         * Generic mutation method with full type-safety for any endpoint that doesnt require parameters to be passed initially
+         */
+        mutation<
+          TMethod extends keyof EndpointByMethod,
+          TPath extends keyof EndpointByMethod[TMethod],
+          TEndpoint extends EndpointByMethod[TMethod][TPath],
+        >(method: TMethod, path: TPath) {
+          const mutationKey = [{ method, path }] as const;
+          return {
+            mutationKey: mutationKey,
+            mutationOptions: {
+              mutationKey: mutationKey,
+              mutationFn: async (params: TEndpoint extends { parameters: infer Parameters } ? Parameters : never) =>
+                this.client.request(method, path, params),
+            },
+          };
+        }
+        // </ApiClient.request>
       }
       "
     `);