Merge pull request #7234 from alanpoulain/fix/return-promise

Fix BC break v4: useCreate and useUpdate can return a promise

Author: fzaninotto

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

@@ -81,7 +81,7 @@ export const useCreateController = <
                     : transform
                     ? transform(data)
                     : data
-            ).then(data =>
+            ).then(data => {
                 create(
                     resource,
                     { data },
@@ -126,8 +126,8 @@ export const useCreateController = <
                                   );
                               },
                     }
-                )
-            );
+                );
+            });
         },
         [
             create,

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

@@ -109,17 +109,25 @@ export const useCreate = <RecordType extends RaRecord = any>(
     const create = (
         callTimeResource: string = resource,
         callTimeParams: Partial<CreateParams<RecordType>> = {},
-        createOptions?: MutateOptions<
+        createOptions: MutateOptions<
             RecordType,
             unknown,
             Partial<UseCreateMutateParams<RecordType>>,
             unknown
-        >
-    ) =>
+        > & { returnPromise?: boolean } = {}
+    ) => {
+        const { returnPromise, ...reactCreateOptions } = createOptions;
+        if (returnPromise) {
+            return mutation.mutateAsync(
+                { resource: callTimeResource, ...callTimeParams },
+                createOptions
+            );
+        }
         mutation.mutate(
             { resource: callTimeResource, ...callTimeParams },
-            createOptions
+            reactCreateOptions
         );
+    };
 
     return [create, mutation];
 };
@@ -138,7 +146,10 @@ export type UseCreateOptions<
     Partial<UseCreateMutateParams<RecordType>>
 >;
 
-export type UseCreateResult<RecordType extends RaRecord = any> = [
+export type UseCreateResult<
+    RecordType extends RaRecord = any,
+    TReturnPromise extends boolean = boolean
+> = [
     (
         resource?: string,
         params?: Partial<CreateParams<Partial<RecordType>>>,
@@ -147,8 +158,8 @@ export type UseCreateResult<RecordType extends RaRecord = any> = [
             unknown,
             Partial<UseCreateMutateParams<RecordType>>,
             unknown
-        >
-    ) => void,
+        > & { returnPromise?: TReturnPromise }
+    ) => TReturnPromise extends true ? Promise<RecordType> : void,
     UseMutationResult<
         RecordType,
         unknown,

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

@@ -263,9 +263,15 @@ export const useUpdate = <RecordType extends RaRecord = any>(
             unknown,
             Partial<UseUpdateMutateParams<RecordType>>,
             unknown
-        > & { mutationMode?: MutationMode } = {}
+        > & { mutationMode?: MutationMode; returnPromise?: boolean } = {}
     ) => {
-        const { mutationMode, onSuccess, onSettled, onError } = updateOptions;
+        const {
+            mutationMode,
+            returnPromise,
+            onSuccess,
+            onSettled,
+            onError,
+        } = updateOptions;
 
         // store the hook time params *at the moment of the call*
         // because they may change afterwards, which would break the undoable mode
@@ -276,7 +282,19 @@ export const useUpdate = <RecordType extends RaRecord = any>(
             mode.current = mutationMode;
         }
 
+        if (returnPromise && mode.current !== 'pessimistic') {
+            console.warn(
+                'The returnPromise parameter can only be used if the mutationMode is set to pessimistic'
+            );
+        }
+
         if (mode.current === 'pessimistic') {
+            if (returnPromise) {
+                return mutation.mutateAsync(
+                    { resource: callTimeResource, ...callTimeParams },
+                    { onSuccess, onSettled, onError }
+                );
+            }
             return mutation.mutate(
                 { resource: callTimeResource, ...callTimeParams },
                 { onSuccess, onSettled, onError }
@@ -411,7 +429,10 @@ export type UseUpdateOptions<
     Partial<UseUpdateMutateParams<RecordType>>
 > & { mutationMode?: MutationMode };
 
-export type UseUpdateResult<RecordType extends RaRecord = any> = [
+export type UseUpdateResult<
+    RecordType extends RaRecord = any,
+    TReturnPromise extends boolean = boolean
+> = [
     (
         resource?: string,
         params?: Partial<UpdateParams<RecordType>>,
@@ -420,8 +441,8 @@ export type UseUpdateResult<RecordType extends RaRecord = any> = [
             unknown,
             Partial<UseUpdateMutateParams<RecordType>>,
             unknown
-        > & { mutationMode?: MutationMode }
-    ) => Promise<void>,
+        > & { mutationMode?: MutationMode; returnPromise?: TReturnPromise }
+    ) => Promise<TReturnPromise extends true ? RecordType : void>,
     UseMutationResult<
         RecordType,
         unknown,