Refine mutationFn typing in mutation hooks

Author: WiXSL

packages/ra-core/src/controller/create/useCreateController.ts

@@ -1,12 +1,7 @@
 import { useCallback } from 'react';
-import { UseMutationOptions } from '@tanstack/react-query';
 
 import { useAuthenticated, useRequireAccess } from '../../auth';
-import {
-    HttpError,
-    useCreate,
-    UseCreateMutateParams,
-} from '../../dataProvider';
+import { HttpError, useCreate, UseCreateOptions } from '../../dataProvider';
 import { useRedirect, RedirectionSideEffect } from '../../routing';
 import { useNotify } from '../../notification';
 import {
@@ -225,10 +220,10 @@ export interface CreateControllerProps<
     redirect?: RedirectionSideEffect;
     resource?: string;
     mutationMode?: MutationMode;
-    mutationOptions?: UseMutationOptions<
-        ResultRecordType,
+    mutationOptions?: UseCreateOptions<
+        RecordType,
         MutationOptionsError,
-        UseCreateMutateParams<RecordType>
+        ResultRecordType
     > & { meta?: any };
     transform?: TransformData;
 }

packages/ra-core/src/dataProvider/useCreate.ts

@@ -97,11 +97,6 @@ export const useCreate = <
         onSettled,
         ...mutationOptions
     } = options;
-    const wrappedCustomMutationFn = customMutationFn as
-        | ((
-              params: Partial<UseCreateMutateParams<RecordType>>
-          ) => Promise<ResultRecordType>)
-        | undefined;
 
     const dataProviderCreate = useEvent((resource: string, params) =>
         dataProvider.create<RecordType, ResultRecordType>(
@@ -120,9 +115,9 @@ export const useCreate = <
             ...mutationOptions,
             mutationKey: [resource, 'create', params],
             mutationMode,
-            mutationFn: wrappedCustomMutationFn
+            mutationFn: customMutationFn
                 ? async params => ({
-                      data: await wrappedCustomMutationFn(params),
+                      data: await customMutationFn(params),
                   })
                 : ({ resource, ...params }) => {
                       if (resource == null) {
@@ -196,9 +191,9 @@ export const useCreate = <
                     // Immediately get the function with middlewares applied so that even if the middlewares gets unregistered (because of a redirect for instance),
                     // we still have them applied when users have called the mutate function.
                     const mutateWithMiddlewares = getMutateWithMiddlewares(
-                        wrappedCustomMutationFn
+                        customMutationFn
                             ? (resource, params) =>
-                                  wrappedCustomMutationFn({
+                                  customMutationFn({
                                       resource,
                                       ...params,
                                   } as Partial<
@@ -280,11 +275,17 @@ export type UseCreateOptions<
     RecordType extends Omit<RaRecord, 'id'> = any,
     MutationError = unknown,
     ResultRecordType extends RaRecord = RecordType & { id: Identifier },
-> = UseMutationOptions<
-    ResultRecordType,
-    MutationError,
-    Partial<UseCreateMutateParams<RecordType>>
+> = Omit<
+    UseMutationOptions<
+        ResultRecordType,
+        MutationError,
+        Partial<UseCreateMutateParams<RecordType>>
+    >,
+    'mutationFn'
 > & {
+    mutationFn?: (
+        params: Partial<UseCreateMutateParams<RecordType>>
+    ) => Promise<ResultRecordType>;
     mutationMode?: MutationMode;
     returnPromise?: boolean;
     getMutateWithMiddlewares?: <

packages/ra-core/src/dataProvider/useDelete.ts

@@ -96,11 +96,6 @@ export const useDelete = <
         onSettled,
         ...mutationOptions
     } = options;
-    const wrappedCustomMutationFn = customMutationFn as
-        | ((
-              params: Partial<UseDeleteMutateParams<RecordType>>
-          ) => Promise<RecordType>)
-        | undefined;
 
     const [mutate, mutationResult] = useMutationWithMutationMode<
         MutationError,
@@ -112,9 +107,9 @@ export const useDelete = <
             ...mutationOptions,
             mutationKey: [resource, 'delete', params],
             mutationMode,
-            mutationFn: wrappedCustomMutationFn
+            mutationFn: customMutationFn
                 ? async params => ({
-                      data: await wrappedCustomMutationFn(params),
+                      data: await customMutationFn(params),
                   })
                 : ({ resource, ...params }) => {
                       if (resource == null) {
@@ -289,11 +284,17 @@ export interface UseDeleteMutateParams<RecordType extends RaRecord = any> {
 export type UseDeleteOptions<
     RecordType extends RaRecord = any,
     MutationError = unknown,
-> = UseMutationOptions<
-    RecordType,
-    MutationError,
-    Partial<UseDeleteMutateParams<RecordType>>
+> = Omit<
+    UseMutationOptions<
+        RecordType,
+        MutationError,
+        Partial<UseDeleteMutateParams<RecordType>>
+    >,
+    'mutationFn'
 > & {
+    mutationFn?: (
+        params: Partial<UseDeleteMutateParams<RecordType>>
+    ) => Promise<RecordType>;
     mutationMode?: MutationMode;
     returnPromise?: boolean;
 };

packages/ra-core/src/dataProvider/useDeleteMany.ts

@@ -96,11 +96,6 @@ export const useDeleteMany = <
         onSettled,
         ...mutationOptions
     } = options;
-    const wrappedCustomMutationFn = customMutationFn as
-        | ((
-              params: Partial<UseDeleteManyMutateParams<RecordType>>
-          ) => Promise<Array<RecordType['id']> | undefined>)
-        | undefined;
 
     const [mutate, mutationResult] = useMutationWithMutationMode<
         MutationError,
@@ -112,9 +107,9 @@ export const useDeleteMany = <
             ...mutationOptions,
             mutationKey: [resource, 'deleteMany', params],
             mutationMode,
-            mutationFn: wrappedCustomMutationFn
+            mutationFn: customMutationFn
                 ? async params => ({
-                      data: await wrappedCustomMutationFn(params),
+                      data: await customMutationFn(params),
                   })
                 : ({ resource, ...params }) => {
                       if (resource == null) {
@@ -313,11 +308,20 @@ export type UseDeleteManyOptions<
     RecordType extends RaRecord = any,
     MutationError = unknown,
     TReturnPromise extends boolean = boolean,
-> = UseMutationOptions<
-    Array<RecordType['id']> | undefined,
-    MutationError,
-    Partial<UseDeleteManyMutateParams<RecordType>>
-> & { mutationMode?: MutationMode; returnPromise?: TReturnPromise };
+> = Omit<
+    UseMutationOptions<
+        Array<RecordType['id']> | undefined,
+        MutationError,
+        Partial<UseDeleteManyMutateParams<RecordType>>
+    >,
+    'mutationFn'
+> & {
+    mutationFn?: (
+        params: Partial<UseDeleteManyMutateParams<RecordType>>
+    ) => Promise<Array<RecordType['id']> | undefined>;
+    mutationMode?: MutationMode;
+    returnPromise?: TReturnPromise;
+};
 
 export type UseDeleteManyResult<
     RecordType extends RaRecord = any,

packages/ra-core/src/dataProvider/useUpdate.ts

@@ -95,11 +95,6 @@ export const useUpdate = <RecordType extends RaRecord = any, ErrorType = Error>(
         mutationFn: customMutationFn,
         ...mutationOptions
     } = options;
-    const wrappedCustomMutationFn = customMutationFn as
-        | ((
-              params: Partial<UseUpdateMutateParams<RecordType>>
-          ) => Promise<RecordType>)
-        | undefined;
 
     const dataProviderUpdate = useEvent(
         (resource: string, params: UpdateParams<RecordType>) =>
@@ -116,9 +111,9 @@ export const useUpdate = <RecordType extends RaRecord = any, ErrorType = Error>(
             ...mutationOptions,
             mutationKey: [resource, 'update', params],
             mutationMode,
-            mutationFn: wrappedCustomMutationFn
+            mutationFn: customMutationFn
                 ? async params => ({
-                      data: await wrappedCustomMutationFn(params),
+                      data: await customMutationFn(params),
                   })
                 : ({ resource, ...params }) => {
                       if (resource == null) {
@@ -264,9 +259,9 @@ export const useUpdate = <RecordType extends RaRecord = any, ErrorType = Error>(
                     // Immediately get the function with middlewares applied so that even if the middlewares gets unregistered (because of a redirect for instance),
                     // we still have them applied when users have called the mutate function.
                     const mutateWithMiddlewares = getMutateWithMiddlewares(
-                        wrappedCustomMutationFn
+                        customMutationFn
                             ? (resource, params) =>
-                                  wrappedCustomMutationFn({
+                                  customMutationFn({
                                       resource,
                                       ...params,
                                   } as Partial<
@@ -325,11 +320,17 @@ export interface UseUpdateMutateParams<RecordType extends RaRecord = any> {
 export type UseUpdateOptions<
     RecordType extends RaRecord = any,
     ErrorType = Error,
-> = UseMutationOptions<
-    RecordType,
-    ErrorType,
-    Partial<UseUpdateMutateParams<RecordType>>
+> = Omit<
+    UseMutationOptions<
+        RecordType,
+        ErrorType,
+        Partial<UseUpdateMutateParams<RecordType>>
+    >,
+    'mutationFn'
 > & {
+    mutationFn?: (
+        params: Partial<UseUpdateMutateParams<RecordType>>
+    ) => Promise<RecordType>;
     mutationMode?: MutationMode;
     returnPromise?: boolean;
     getMutateWithMiddlewares?: <

packages/ra-core/src/dataProvider/useUpdateMany.ts

@@ -91,11 +91,6 @@ export const useUpdateMany = <
         mutationFn: customMutationFn,
         ...mutationOptions
     } = options;
-    const wrappedCustomMutationFn = customMutationFn as
-        | ((
-              params: Partial<UseUpdateManyMutateParams<RecordType>>
-          ) => Promise<Array<RecordType['id']>>)
-        | undefined;
 
     const dataProviderUpdateMany = useEvent(
         (resource: string, params: UpdateManyParams<RecordType>) =>
@@ -112,9 +107,9 @@ export const useUpdateMany = <
             ...mutationOptions,
             mutationKey: [resource, 'updateMany', params],
             mutationMode,
-            mutationFn: wrappedCustomMutationFn
+            mutationFn: customMutationFn
                 ? async params => ({
-                      data: await wrappedCustomMutationFn(params),
+                      data: await customMutationFn(params),
                   })
                 : ({ resource, ...params }) => {
                       if (resource == null) {
@@ -245,9 +240,9 @@ export const useUpdateMany = <
                     // Immediately get the function with middlewares applied so that even if the middlewares gets unregistered (because of a redirect for instance),
                     // we still have them applied when users have called the mutate function.
                     const mutateWithMiddlewares = getMutateWithMiddlewares(
-                        wrappedCustomMutationFn
+                        customMutationFn
                             ? (resource, params) =>
-                                  wrappedCustomMutationFn({
+                                  customMutationFn({
                                       resource,
                                       ...params,
                                   } as Partial<
@@ -305,11 +300,17 @@ export interface UseUpdateManyMutateParams<RecordType extends RaRecord = any> {
 export type UseUpdateManyOptions<
     RecordType extends RaRecord = any,
     MutationError = unknown,
-> = UseMutationOptions<
-    Array<RecordType['id']>,
-    MutationError,
-    Partial<UseUpdateManyMutateParams<RecordType>>
+> = Omit<
+    UseMutationOptions<
+        Array<RecordType['id']>,
+        MutationError,
+        Partial<UseUpdateManyMutateParams<RecordType>>
+    >,
+    'mutationFn'
 > & {
+    mutationFn?: (
+        params: Partial<UseUpdateManyMutateParams<RecordType>>
+    ) => Promise<Array<RecordType['id']>>;
     mutationMode?: MutationMode;
     returnPromise?: boolean;
     getMutateWithMiddlewares?: <