fix(query): type return of useMutation query

orval-labs · Feb 11, 2024 · 01f8d22 · 01f8d22
1 parent 288f488
commit 01f8d22
Show file tree

Hide file tree

Showing 8 changed files with 115 additions and 29 deletions.
diff --git a/packages/query/src/index.ts b/packages/query/src/index.ts
@@ -160,6 +160,7 @@ const REACT_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
       { name: 'UseInfiniteQueryResult' },
       { name: 'QueryKey' },
       { name: 'QueryClient' },
+      { name: 'UseMutationResult' },
     ],
     dependency: 'react-query',
   },
@@ -186,6 +187,7 @@ const REACT_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'QueryKey' },
       { name: 'QueryClient' },
       { name: 'InfiniteData' },
+      { name: 'UseMutationResult' },
     ],
     dependency: '@tanstack/react-query',
   },
@@ -728,6 +730,27 @@ const generateQueryReturnType = ({
   }
 };
 
+const generateMutatorReturnType = ({
+  outputClient,
+  dataType,
+  variableType,
+}: {
+  outputClient: OutputClient | OutputClientFunc;
+  dataType: unknown;
+  variableType: unknown;
+}) => {
+  if (outputClient !== OutputClient.REACT_QUERY) {
+    return '';
+  }
+
+  return `: UseMutationResult<
+        Awaited<ReturnType<${dataType}>>,
+        TError,
+        ${variableType},
+        TContext
+      >`;
+};
+
 const getQueryOptions = ({
   isRequestOptions,
   mutator,
@@ -1373,17 +1396,17 @@ const generateQueryHook = async (
 
     const mutationOptionsFn = `export const ${mutationOptionsFnName} = <TError = ${errorType},
     TContext = unknown>(${mutationArguments}): ${mutationOptionFnReturnType} => {
- ${
-   isRequestOptions
-     ? `const {mutation: mutationOptions${
-         !mutator
-           ? `, axios: axiosOptions`
-           : mutator?.hasSecondArg
-             ? ', request: requestOptions'
-             : ''
-       }} = options ?? {};`
-     : ''
- }
+${
+  isRequestOptions
+    ? `const {mutation: mutationOptions${
+        !mutator
+          ? `, axios: axiosOptions`
+          : mutator?.hasSecondArg
+            ? ', request: requestOptions'
+            : ''
+      }} = options ?? {};`
+    : ''
+}
 
       ${
         mutator?.isHook
@@ -1421,11 +1444,11 @@ const generateQueryHook = async (
         }
 
 
-   return  ${
-     !mutationOptionsMutator
-       ? '{ mutationFn, ...mutationOptions }'
-       : 'customOptions'
-   }}`;
+  return  ${
+    !mutationOptionsMutator
+      ? '{ mutationFn, ...mutationOptions }'
+      : 'customOptions'
+  }}`;
 
     const operationPrefix = hasSvelteQueryV4 ? 'create' : 'use';
 
@@ -1449,7 +1472,11 @@ ${mutationOptionsFn}
     ${doc}export const ${camel(
       `${operationPrefix}-${operationName}`,
     )} = <TError = ${errorType},
-    TContext = unknown>(${mutationArguments}) => {
+    TContext = unknown>(${mutationArguments})${generateMutatorReturnType({
+      outputClient,
+      dataType,
+      variableType: definitions ? `{${definitions}}` : 'void',
+    })} => {
 
       const ${mutationOptionsVarName} = ${mutationOptionsFnName}(${
         isRequestOptions ? 'options' : 'mutationOptions'

diff --git a/samples/react-query/basic/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/react-query/basic/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -19,6 +19,7 @@ import type {
   UseInfiniteQueryOptions,
   UseInfiniteQueryResult,
   UseMutationOptions,
+  UseMutationResult,
   UseQueryOptions,
   UseQueryResult,
   UseSuspenseInfiniteQueryOptions,
@@ -476,7 +477,12 @@ export const useCreatePets = <
     { data: CreatePetsBody; version?: number },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createPets>>,
+  TError,
+  { data: CreatePetsBody; version?: number },
+  TContext
+> => {
   const mutationOptions = getCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);
@@ -543,7 +549,12 @@ export const useUpdatePets = <
     { data: NonReadonly<Pet>; version?: number },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof updatePets>>,
+  TError,
+  { data: NonReadonly<Pet>; version?: number },
+  TContext
+> => {
   const mutationOptions = getUpdatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/custom-client/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/react-query/custom-client/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -10,6 +10,7 @@ import type {
   QueryFunction,
   QueryKey,
   UseMutationOptions,
+  UseMutationResult,
   UseQueryOptions,
   UseQueryResult,
 } from 'react-query';
@@ -191,7 +192,12 @@ export const useCreatePets = <
     { data: BodyType<CreatePetsBody>; version?: number },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<ReturnType<typeof useCreatePetsHook>>>,
+  TError,
+  { data: BodyType<CreatePetsBody>; version?: number },
+  TContext
+> => {
   const mutationOptions = useCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/form-data-mutator/endpoints.ts b/samples/react-query/form-data-mutator/endpoints.ts
@@ -5,7 +5,11 @@
  * OpenAPI spec version: 1.0.0
  */
 import { useMutation } from 'react-query';
-import type { MutationFunction, UseMutationOptions } from 'react-query';
+import type {
+  MutationFunction,
+  UseMutationOptions,
+  UseMutationResult,
+} from 'react-query';
 import type { CreatePetsBody, Error, Pet } from './models';
 import { customInstance } from './custom-instance';
 import { customFormData } from './custom-form-data';
@@ -73,7 +77,12 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
     { data: CreatePetsBody },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createPets>>,
+  TError,
+  { data: CreatePetsBody },
+  TContext
+> => {
   const mutationOptions = getCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/form-data/endpoints.ts b/samples/react-query/form-data/endpoints.ts
@@ -5,7 +5,11 @@
  * OpenAPI spec version: 1.0.0
  */
 import { useMutation } from 'react-query';
-import type { MutationFunction, UseMutationOptions } from 'react-query';
+import type {
+  MutationFunction,
+  UseMutationOptions,
+  UseMutationResult,
+} from 'react-query';
 import type { CreatePetsBody, Error, Pet } from './models';
 import { customInstance } from './custom-instance';
 
@@ -75,7 +79,12 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
     { data: CreatePetsBody },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createPets>>,
+  TError,
+  { data: CreatePetsBody },
+  TContext
+> => {
   const mutationOptions = getCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/form-url-encoded-mutator/endpoints.ts b/samples/react-query/form-url-encoded-mutator/endpoints.ts
@@ -5,7 +5,11 @@
  * OpenAPI spec version: 1.0.0
  */
 import { useMutation } from 'react-query';
-import type { MutationFunction, UseMutationOptions } from 'react-query';
+import type {
+  MutationFunction,
+  UseMutationOptions,
+  UseMutationResult,
+} from 'react-query';
 import type { CreatePetsBody, Error, Pet } from './models';
 import { customInstance } from './custom-instance';
 import { customFormUrlEncoded } from './custom-form-url-encoded';
@@ -73,7 +77,12 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
     { data: CreatePetsBody },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createPets>>,
+  TError,
+  { data: CreatePetsBody },
+  TContext
+> => {
   const mutationOptions = getCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/form-url-encoded/endpoints.ts b/samples/react-query/form-url-encoded/endpoints.ts
@@ -5,7 +5,11 @@
  * OpenAPI spec version: 1.0.0
  */
 import { useMutation } from 'react-query';
-import type { MutationFunction, UseMutationOptions } from 'react-query';
+import type {
+  MutationFunction,
+  UseMutationOptions,
+  UseMutationResult,
+} from 'react-query';
 import type { CreatePetsBody, Error, Pet } from './models';
 import { customInstance } from './custom-instance';
 
@@ -75,7 +79,12 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
     { data: CreatePetsBody },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createPets>>,
+  TError,
+  { data: CreatePetsBody },
+  TContext
+> => {
   const mutationOptions = getCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);

diff --git a/samples/react-query/hook-mutator/endpoints.ts b/samples/react-query/hook-mutator/endpoints.ts
@@ -10,6 +10,7 @@ import type {
   QueryFunction,
   QueryKey,
   UseMutationOptions,
+  UseMutationResult,
   UseQueryOptions,
   UseQueryResult,
 } from 'react-query';
@@ -167,7 +168,12 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
     { data: CreatePetsBody },
     TContext
   >;
-}) => {
+}): UseMutationResult<
+  Awaited<ReturnType<ReturnType<typeof useCreatePetsHook>>>,
+  TError,
+  { data: CreatePetsBody },
+  TContext
+> => {
   const mutationOptions = useCreatePetsMutationOptions(options);
 
   return useMutation(mutationOptions);