@refinedev/core 4.22.0 → 4.24.0

package/src/hooks/data/useUpdate.ts

@@ -39,6 +39,11 @@ import {
     pickNotDeprecated,
     useActiveAuthProvider,
 } from "@definitions/helpers";
+import {
+    useLoadingOvertime,
+    UseLoadingOvertimeOptionsProps,
+    UseLoadingOvertimeReturnType,
+} from "../useLoadingOvertime";
 
 export type UpdateParams<TData, TError, TVariables> = {
     /**
@@ -98,7 +103,8 @@ export type UseUpdateReturnType<
     TError,
     UpdateParams<TData, TError, TVariables>,
     UpdateContext<TData>
->;
+> &
+    UseLoadingOvertimeReturnType;
 
 export type UseUpdateProps<
     TData extends BaseRecord = BaseRecord,
@@ -114,7 +120,7 @@ export type UseUpdateProps<
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
     >;
-};
+} & UseLoadingOvertimeOptionsProps;
 
 /**
  * `useUpdate` is a modified version of `react-query`'s {@link https://react-query.tanstack.com/reference/useMutation `useMutation`} for update mutations.
@@ -134,12 +140,13 @@ export const useUpdate = <
     TVariables = {},
 >({
     mutationOptions,
+    overtimeOptions,
 }: UseUpdateProps<TData, TError, TVariables> = {}): UseUpdateReturnType<
     TData,
     TError,
     TVariables
 > => {
-    const { resources } = useResource();
+    const { resources, select } = useResource();
     const queryClient = useQueryClient();
     const dataProvider = useDataProvider();
 
@@ -168,7 +175,7 @@ export const useUpdate = <
         ({
             id,
             values,
-            resource,
+            resource: resourceName,
             mutationMode,
             undoableTimeout,
             onCancel,
@@ -176,7 +183,10 @@ export const useUpdate = <
             metaData,
             dataProviderName,
         }) => {
+            const { resource, identifier } = select(resourceName);
+
             const combinedMeta = getMeta({
+                resource,
                 meta: pickNotDeprecated(meta, metaData),
             });
 
@@ -188,9 +198,9 @@ export const useUpdate = <
 
             if (!(mutationModePropOrContext === "undoable")) {
                 return dataProvider(
-                    pickDataProvider(resource, dataProviderName, resources),
+                    pickDataProvider(identifier, dataProviderName, resources),
                 ).update<TData, TVariables>({
-                    resource,
+                    resource: resource.name,
                     id,
                     variables: values,
                     meta: combinedMeta,
@@ -202,13 +212,13 @@ export const useUpdate = <
                     const doMutation = () => {
                         dataProvider(
                             pickDataProvider(
-                                resource,
+                                identifier,
                                 dataProviderName,
                                 resources,
                             ),
                         )
                             .update<TData, TVariables>({
-                                resource,
+                                resource: resource.name,
                                 id,
                                 variables: values,
                                 meta: combinedMeta,
@@ -230,7 +240,7 @@ export const useUpdate = <
                         type: ActionTypes.ADD,
                         payload: {
                             id: id,
-                            resource: resource,
+                            resource: identifier,
                             cancelMutation: cancelMutation,
                             doMutation: doMutation,
                             seconds: undoableTimeoutPropOrContext,
@@ -243,7 +253,7 @@ export const useUpdate = <
         },
         {
             onMutate: async ({
-                resource,
+                resource: resourceName,
                 id,
                 mutationMode,
                 values,
@@ -251,11 +261,13 @@ export const useUpdate = <
                 meta,
                 metaData,
             }) => {
+                const { identifier } = select(resourceName);
+
                 const preferredMeta = pickNotDeprecated(meta, metaData);
+
                 const queryKey = queryKeys(
-                    resource,
-                    pickDataProvider(resource, dataProviderName, resources),
-                    preferredMeta,
+                    identifier,
+                    pickDataProvider(identifier, dataProviderName, resources),
                     preferredMeta,
                 );
 
@@ -351,15 +363,17 @@ export const useUpdate = <
                 _error,
                 {
                     id,
-                    resource,
+                    resource: resourceName,
                     dataProviderName,
                     invalidates = ["list", "many", "detail"],
                 },
             ) => {
+                const { identifier } = select(resourceName);
+
                 invalidateStore({
-                    resource,
+                    resource: identifier,
                     dataProviderName: pickDataProvider(
-                        resource,
+                        identifier,
                         dataProviderName,
                         resources,
                     ),
@@ -369,14 +383,14 @@ export const useUpdate = <
 
                 notificationDispatch({
                     type: ActionTypes.REMOVE,
-                    payload: { id, resource },
+                    payload: { id, resource: identifier },
                 });
             },
             onSuccess: (
                 data,
                 {
                     id,
-                    resource,
+                    resource: resourceName,
                     successNotification,
                     dataProviderName,
                     values,
@@ -385,15 +399,17 @@ export const useUpdate = <
                 },
                 context,
             ) => {
-                const resourceSingular = pluralize.singular(resource);
+                const { resource, identifier } = select(resourceName);
+
+                const resourceSingular = pluralize.singular(identifier);
 
                 const notificationConfig =
                     typeof successNotification === "function"
-                        ? successNotification(data, { id, values }, resource)
+                        ? successNotification(data, { id, values }, identifier)
                         : successNotification;
 
                 handleNotification(notificationConfig, {
-                    key: `${id}-${resource}-notification`,
+                    key: `${id}-${identifier}-notification`,
                     description: translate(
                         "notifications.success",
                         "Successful",
@@ -402,7 +418,7 @@ export const useUpdate = <
                         "notifications.editSuccess",
                         {
                             resource: translate(
-                                `${resource}.${resource}`,
+                                `${identifier}.${identifier}`,
                                 resourceSingular,
                             ),
                         },
@@ -412,7 +428,7 @@ export const useUpdate = <
                 });
 
                 publish?.({
-                    channel: `resources/${resource}`,
+                    channel: `resources/${resource.name}`,
                     type: "updated",
                     payload: {
                         ids: data.data?.id ? [data.data.id] : undefined,
@@ -440,13 +456,13 @@ export const useUpdate = <
 
                 log?.mutate({
                     action: "update",
-                    resource,
+                    resource: resource.name,
                     data: values,
                     previousData,
                     meta: {
                         id,
                         dataProviderName: pickDataProvider(
-                            resource,
+                            identifier,
                             dataProviderName,
                             resources,
                         ),
@@ -456,11 +472,12 @@ export const useUpdate = <
             },
             onError: (
                 err: TError,
-                { id, resource, errorNotification, values },
+                { id, resource: resourceName, errorNotification, values },
                 context,
             ) => {
-                // set back the queries to the context:
+                const { identifier } = select(resourceName);
 
+                // set back the queries to the context:
                 if (context) {
                     for (const query of context.previousQueries) {
                         queryClient.setQueryData(query[0], query[1]);
@@ -470,20 +487,20 @@ export const useUpdate = <
                 if (err.message !== "mutationCancelled") {
                     checkError?.(err);
 
-                    const resourceSingular = pluralize.singular(resource);
+                    const resourceSingular = pluralize.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"
-                            ? errorNotification(err, { id, values }, resource)
+                            ? errorNotification(err, { id, values }, identifier)
                             : errorNotification;
 
                     handleNotification(notificationConfig, {
-                        key: `${id}-${resource}-notification`,
+                        key: `${id}-${identifier}-notification`,
                         message: translate(
                             "notifications.editError",
                             {
                                 resource: translate(
-                                    `${resource}.${resource}`,
+                                    `${identifier}.${identifier}`,
                                     resourceSingular,
                                 ),
                                 statusCode: err.statusCode,
@@ -499,5 +516,11 @@ export const useUpdate = <
         },
     );
 
-    return mutation;
+    const { elapsedTime } = useLoadingOvertime({
+        isLoading: mutation.isLoading,
+        interval: overtimeOptions?.interval,
+        onInterval: overtimeOptions?.onInterval,
+    });
+
+    return { ...mutation, overtime: { elapsedTime } };
 };

package/src/hooks/data/useUpdateMany.ts

@@ -40,6 +40,11 @@ import {
     pickNotDeprecated,
     useActiveAuthProvider,
 } from "@definitions/helpers";
+import {
+    useLoadingOvertime,
+    UseLoadingOvertimeOptionsProps,
+    UseLoadingOvertimeReturnType,
+} from "../useLoadingOvertime";
 
 type UpdateManyParams<TData, TError, TVariables> = {
     ids: BaseKey[];
@@ -74,7 +79,8 @@ type UseUpdateManyReturnType<
     TError,
     UpdateManyParams<TData, TError, TVariables>,
     UpdateContext<TData>
->;
+> &
+    UseLoadingOvertimeReturnType;
 
 export type UseUpdateManyProps<
     TData extends BaseRecord = BaseRecord,
@@ -90,7 +96,7 @@ export type UseUpdateManyProps<
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
     >;
-};
+} & UseLoadingOvertimeOptionsProps;
 
 /**
  * `useUpdateMany` is a modified version of `react-query`'s {@link https://react-query.tanstack.com/reference/useMutation `useMutation`} for multiple update mutations.
@@ -110,12 +116,13 @@ export const useUpdateMany = <
     TVariables = {},
 >({
     mutationOptions,
+    overtimeOptions,
 }: UseUpdateManyProps<TData, TError, TVariables> = {}): UseUpdateManyReturnType<
     TData,
     TError,
     TVariables
 > => {
-    const { resources } = useResource();
+    const { resources, select } = useResource();
     const queryClient = useQueryClient();
     const dataProvider = useDataProvider();
     const translate = useTranslate();
@@ -143,7 +150,7 @@ export const useUpdateMany = <
         ({
             ids,
             values,
-            resource,
+            resource: resourceName,
             onCancel,
             mutationMode,
             undoableTimeout,
@@ -151,7 +158,10 @@ export const useUpdateMany = <
             metaData,
             dataProviderName,
         }: UpdateManyParams<TData, TError, TVariables>) => {
+            const { resource, identifier } = select(resourceName);
+
             const combinedMeta = getMeta({
+                resource,
                 meta: pickNotDeprecated(meta, metaData),
             });
 
@@ -162,13 +172,13 @@ export const useUpdateMany = <
                 undoableTimeout ?? undoableTimeoutContext;
 
             const selectedDataProvider = dataProvider(
-                pickDataProvider(resource, dataProviderName, resources),
+                pickDataProvider(identifier, dataProviderName, resources),
             );
 
             const mutationFn = () => {
                 if (selectedDataProvider.updateMany) {
                     return selectedDataProvider.updateMany<TData, TVariables>({
-                        resource,
+                        resource: resource.name,
                         ids,
                         variables: values,
                         meta: combinedMeta,
@@ -178,7 +188,7 @@ export const useUpdateMany = <
                     return handleMultiple(
                         ids.map((id) =>
                             selectedDataProvider.update<TData, TVariables>({
-                                resource,
+                                resource: resource.name,
                                 id,
                                 variables: values,
                                 meta: combinedMeta,
@@ -213,7 +223,7 @@ export const useUpdateMany = <
                         type: ActionTypes.ADD,
                         payload: {
                             id: ids,
-                            resource: resource,
+                            resource: identifier,
                             cancelMutation: cancelMutation,
                             doMutation: doMutation,
                             seconds: undoableTimeoutPropOrContext,
@@ -227,7 +237,7 @@ export const useUpdateMany = <
 
         {
             onMutate: async ({
-                resource,
+                resource: resourceName,
                 ids,
                 values,
                 mutationMode,
@@ -235,10 +245,11 @@ export const useUpdateMany = <
                 meta,
                 metaData,
             }) => {
+                const { identifier } = select(resourceName);
+
                 const queryKey = queryKeys(
-                    resource,
-                    pickDataProvider(resource, dataProviderName, resources),
-                    pickNotDeprecated(meta, metaData),
+                    identifier,
+                    pickDataProvider(identifier, dataProviderName, resources),
                     pickNotDeprecated(meta, metaData),
                 );
 
@@ -344,13 +355,19 @@ export const useUpdateMany = <
                     queryKey,
                 };
             },
-            onSettled: (_data, _error, { ids, resource, dataProviderName }) => {
+            onSettled: (
+                _data,
+                _error,
+                { ids, resource: resourceName, dataProviderName },
+            ) => {
+                const { identifier } = select(resourceName);
+
                 // invalidate the cache for the list and many queries:
                 invalidateStore({
-                    resource,
+                    resource: identifier,
                     invalidates: ["list", "many"],
                     dataProviderName: pickDataProvider(
-                        resource,
+                        identifier,
                         dataProviderName,
                         resources,
                     ),
@@ -358,10 +375,10 @@ export const useUpdateMany = <
 
                 ids.forEach((id) =>
                     invalidateStore({
-                        resource,
+                        resource: identifier,
                         invalidates: ["detail"],
                         dataProviderName: pickDataProvider(
-                            resource,
+                            identifier,
                             dataProviderName,
                             resources,
                         ),
@@ -371,14 +388,14 @@ export const useUpdateMany = <
 
                 notificationDispatch({
                     type: ActionTypes.REMOVE,
-                    payload: { id: ids, resource },
+                    payload: { id: ids, resource: identifier },
                 });
             },
             onSuccess: (
                 data,
                 {
                     ids,
-                    resource,
+                    resource: resourceName,
                     meta,
                     metaData,
                     dataProviderName,
@@ -387,15 +404,17 @@ export const useUpdateMany = <
                 },
                 context,
             ) => {
-                const resourceSingular = pluralize.singular(resource);
+                const { resource, identifier } = select(resourceName);
+
+                const resourceSingular = pluralize.singular(identifier);
 
                 const notificationConfig =
                     typeof successNotification === "function"
-                        ? successNotification(data, { ids, values }, resource)
+                        ? successNotification(data, { ids, values }, identifier)
                         : successNotification;
 
                 handleNotification(notificationConfig, {
-                    key: `${ids}-${resource}-notification`,
+                    key: `${ids}-${identifier}-notification`,
                     description: translate(
                         "notifications.success",
                         "Successful",
@@ -404,8 +423,8 @@ export const useUpdateMany = <
                         "notifications.editSuccess",
                         {
                             resource: translate(
-                                `${resource}.${resource}`,
-                                resource,
+                                `${identifier}.${identifier}`,
+                                identifier,
                             ),
                         },
                         `Successfully updated ${resourceSingular}`,
@@ -414,7 +433,7 @@ export const useUpdateMany = <
                 });
 
                 publish?.({
-                    channel: `resources/${resource}`,
+                    channel: `resources/${resource.name}`,
                     type: "updated",
                     payload: {
                         ids: ids.map(String),
@@ -441,18 +460,23 @@ export const useUpdateMany = <
                     });
                 }
 
+                const combinedMeta = getMeta({
+                    resource,
+                    meta: pickNotDeprecated(meta, metaData),
+                });
+
                 const { fields, operation, variables, ...rest } =
-                    pickNotDeprecated(meta, metaData) || {};
+                    combinedMeta || {};
 
                 log?.mutate({
                     action: "updateMany",
-                    resource,
+                    resource: resource.name,
                     data: values,
                     previousData,
                     meta: {
                         ids,
                         dataProviderName: pickDataProvider(
-                            resource,
+                            identifier,
                             dataProviderName,
                             resources,
                         ),
@@ -462,9 +486,11 @@ export const useUpdateMany = <
             },
             onError: (
                 err: TError,
-                { ids, resource, errorNotification, values },
+                { ids, resource: resourceName, errorNotification, values },
                 context,
             ) => {
+                const { identifier } = select(resourceName);
+
                 // set back the queries to the context:
                 if (context) {
                     for (const query of context.previousQueries) {
@@ -475,15 +501,19 @@ export const useUpdateMany = <
                 if (err.message !== "mutationCancelled") {
                     checkError?.(err);
 
-                    const resourceSingular = pluralize.singular(resource);
+                    const resourceSingular = pluralize.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"
-                            ? errorNotification(err, { ids, values }, resource)
+                            ? errorNotification(
+                                  err,
+                                  { ids, values },
+                                  identifier,
+                              )
                             : errorNotification;
 
                     handleNotification(notificationConfig, {
-                        key: `${ids}-${resource}-updateMany-error-notification`,
+                        key: `${ids}-${identifier}-updateMany-error-notification`,
                         message: translate(
                             "notifications.editError",
                             {
@@ -501,5 +531,11 @@ export const useUpdateMany = <
         },
     );
 
-    return mutation;
+    const { elapsedTime } = useLoadingOvertime({
+        isLoading: mutation.isLoading,
+        interval: overtimeOptions?.interval,
+        onInterval: overtimeOptions?.onInterval,
+    });
+
+    return { ...mutation, overtime: { elapsedTime } };
 };

package/src/hooks/export/index.ts

@@ -1,5 +1,5 @@
 import { useState } from "react";
-import { useResource, useDataProvider } from "@hooks";
+import { useResource, useDataProvider, useMeta } from "@hooks";
 import {
     BaseRecord,
     MapDataFn,
@@ -110,24 +110,25 @@ export const useExport = <
     const [isLoading, setIsLoading] = useState(false);
 
     const dataProvider = useDataProvider();
-
-    const { resource, resources } = useResource(
+    const getMeta = useMeta();
+    const { resource, resources, identifier } = useResource(
         pickNotDeprecated(resourceFromProps, resourceName),
     );
 
     const filename = `${userFriendlyResourceName(
-        resource?.name,
+        identifier,
         "plural",
     )}-${new Date().toLocaleString()}`;
 
     const { getList } = dataProvider(
-        pickDataProvider(
-            resource?.identifier ?? resource?.name,
-            dataProviderName,
-            resources,
-        ),
+        pickDataProvider(identifier, dataProviderName, resources),
     );
 
+    const combinedMeta = getMeta({
+        resource,
+        meta: pickNotDeprecated(meta, metaData),
+    });
+
     const triggerExport = async () => {
         setIsLoading(true);
 
@@ -147,8 +148,8 @@ export const useExport = <
                         pageSize,
                         mode: "server",
                     },
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                 });
 
                 current++;