@refinedev/core 4.56.0 → 4.57.5

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@refinedev/core",
-  "version": "4.56.0",
+  "version": "4.57.5",
   "private": false,
-  "description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
+  "description": "Refine is a React meta-framework for building enterprise-level, data-intensive applications rapidly with support for modern UI libraries and headless integrations.",
   "repository": {
     "type": "git",
     "url": "https://github.com/refinedev/refine.git",
@@ -27,7 +27,7 @@
   "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
   "dependencies": {
-    "@refinedev/devtools-internal": "1.1.14",
+    "@refinedev/devtools-internal": "1.1.16",
     "@tanstack/react-query": "^4.10.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",

package/src/components/authenticated/index.tsx

@@ -11,6 +11,8 @@ import {
 } from "@hooks";
 import type { GoConfig } from "../../contexts/router/types";
 
+export type AuthCheckParams = any;
+
 export type AuthenticatedCommonProps = {
   /**
    * Unique key to identify the component.
@@ -44,9 +46,13 @@ export type AuthenticatedCommonProps = {
    */
   loading?: React.ReactNode;
   /**
-   * Content to show if user is logged in
+   * Content to show if user is logged in.
    */
   children?: React.ReactNode;
+  /**
+   * optional params to be passed to the Auth Provider's check method via the useIsAuthenticated hook.
+   */
+  params?: AuthCheckParams;
 };
 
 export type LegacyAuthenticatedProps = {
@@ -97,6 +103,7 @@ export function Authenticated({
   children,
   fallback: fallbackContent,
   loading: loadingContent,
+  params,
 }: AuthenticatedProps | LegacyAuthenticatedProps): JSX.Element | null {
   const activeAuthProvider = useActiveAuthProvider();
   const routerType = useRouterType();
@@ -119,6 +126,7 @@ export function Authenticated({
     } = {},
   } = useIsAuthenticated({
     v3LegacyAuthProviderCompatible: isLegacyAuth,
+    params,
   });
 
   // Authentication status

package/src/contexts/refine/index.tsx

@@ -51,6 +51,7 @@ export const defaultRefineOptions: IRefineContextOptions = {
     afterEdit: "list",
   },
   overtime: {
+    enabled: true,
     interval: 1000,
   },
   textTransformers: {

package/src/hooks/auth/useLogin/index.ts

@@ -175,7 +175,9 @@ export function useLogin<TVariables = {}>({
         }
       }
 
-      await invalidateAuthStore();
+      setTimeout(() => {
+        invalidateAuthStore();
+      }, 32);
     },
     onError: (error: any) => {
       open?.(buildNotification(error));
@@ -219,7 +221,9 @@ export function useLogin<TVariables = {}>({
         }
       }
 
-      await invalidateAuthStore();
+      setTimeout(() => {
+        invalidateAuthStore();
+      }, 32);
 
       close?.("login-error");
     },

package/src/hooks/data/useCreate.ts

@@ -315,9 +315,8 @@ export const useCreate = <
   const { mutate, mutateAsync, ...mutation } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   // this function is used to make the `variables` parameter optional

package/src/hooks/data/useCreateMany.ts

@@ -293,9 +293,8 @@ export const useCreateMany = <
   const { mutate, mutateAsync, ...mutation } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   // this function is used to make the `variables` parameter optional

package/src/hooks/data/useCustom.ts

@@ -217,9 +217,8 @@ export const useCustom = <
       },
     });
     const { elapsedTime } = useLoadingOvertime({
+      ...overtimeOptions,
       isLoading: queryResponse.isFetching,
-      interval: overtimeOptions?.interval,
-      onInterval: overtimeOptions?.onInterval,
     });
 
     return { ...queryResponse, overtime: { elapsedTime } };

package/src/hooks/data/useCustomMutation.ts

@@ -215,9 +215,8 @@ export const useCustomMutation = <
   );
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...mutation, overtime: { elapsedTime } };

package/src/hooks/data/useDelete.ts

@@ -493,9 +493,8 @@ export const useDelete = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...mutation, overtime: { elapsedTime } };

package/src/hooks/data/useDeleteMany.ts

@@ -524,9 +524,8 @@ export const useDeleteMany = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...mutation, overtime: { elapsedTime } };

package/src/hooks/data/useInfiniteList.ts

@@ -320,9 +320,8 @@ export const useInfiniteList = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: queryResponse.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...queryResponse, overtime: { elapsedTime } };

package/src/hooks/data/useList.ts

@@ -326,9 +326,8 @@ export const useList = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: queryResponse.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...queryResponse, overtime: { elapsedTime } };

package/src/hooks/data/useMany.ts

@@ -37,6 +37,7 @@ import {
   type UseLoadingOvertimeReturnType,
   useLoadingOvertime,
 } from "../useLoadingOvertime";
+import warnOnce from "warn-once";
 
 export type UseManyProps<TQueryFnData, TError, TData> = {
   /**
@@ -133,17 +134,24 @@ export const useMany = <
 
   const combinedMeta = getMeta({ resource, meta: preferredMeta });
 
+  const hasIds = Array.isArray(ids);
+  const hasResource = Boolean(resource?.name);
+  const manuallyEnabled = queryOptions?.enabled === true;
+
+  warnOnce(!hasIds && !manuallyEnabled, idsWarningMessage(ids, resource?.name));
+  warnOnce(!hasResource && !manuallyEnabled, resourceWarningMessage());
+
   useResourceSubscription({
     resource: identifier,
     types: ["*"],
     params: {
-      ids: ids,
+      ids: ids ?? [],
       meta: combinedMeta,
       metaData: combinedMeta,
       subscriptionType: "useMany",
       ...liveParams,
     },
-    channel: `resources/${resource.name}`,
+    channel: `resources/${resource?.name ?? ""}`,
     enabled: isEnabled,
     liveMode,
     onLiveEvent,
@@ -163,7 +171,7 @@ export const useMany = <
       .data(pickedDataProvider)
       .resource(identifier)
       .action("many")
-      .ids(...ids)
+      .ids(...(ids ?? []))
       .params({
         ...(preferredMeta || {}),
       })
@@ -193,6 +201,7 @@ export const useMany = <
         ),
       );
     },
+    enabled: hasIds && hasResource,
     ...queryOptions,
     onSuccess: (data) => {
       queryOptions?.onSuccess?.(data);
@@ -231,10 +240,20 @@ export const useMany = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: queryResponse.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...queryResponse, overtime: { elapsedTime } };
 };
+
+const idsWarningMessage = (
+  ids: BaseKey[],
+  resource: string,
+) => `[useMany]: Missing "ids" prop. Expected an array of ids, but got "${typeof ids}". Resource: "${resource}"
+
+See https://refine.dev/docs/data/hooks/use-many/#ids-`;
+
+const resourceWarningMessage = () => `[useMany]: Missing "resource" prop. Expected a string, but got undefined.
+
+See https://refine.dev/docs/data/hooks/use-many/#resource-`;

package/src/hooks/data/useOne.ts

@@ -244,9 +244,8 @@ export const useOne = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: queryResponse.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   return { ...queryResponse, overtime: { elapsedTime } };

package/src/hooks/data/useUpdate.ts

@@ -240,7 +240,7 @@ export const useUpdate = <
       metaData = metaDataFromProps,
       dataProviderName = dataProviderNameFromProps,
     }) => {
-      if (!id) throw missingIdError;
+      if (typeof id === "undefined") throw missingIdError;
       if (!values) throw missingValuesError;
       if (!resourceName) throw missingResourceError;
 
@@ -321,7 +321,7 @@ export const useUpdate = <
         detail: true,
       },
     }) => {
-      if (!id) throw missingIdError;
+      if (typeof id === "undefined") throw missingIdError;
       if (!values) throw missingValuesError;
       if (!resourceName) throw missingResourceError;
 
@@ -462,7 +462,7 @@ export const useUpdate = <
         dataProviderName = dataProviderNameFromProps,
         invalidates = invalidatesFromProps ?? ["list", "many", "detail"],
       } = variables;
-      if (!id) throw missingIdError;
+      if (typeof id === "undefined") throw missingIdError;
       if (!resourceName) throw missingResourceError;
 
       const { identifier } = select(resourceName);
@@ -495,7 +495,7 @@ export const useUpdate = <
         meta = metaFromProps,
         metaData = metaDataFromProps,
       } = variables;
-      if (!id) throw missingIdError;
+      if (typeof id === "undefined") throw missingIdError;
       if (!values) throw missingValuesError;
       if (!resourceName) throw missingResourceError;
 
@@ -586,7 +586,7 @@ export const useUpdate = <
         errorNotification = errorNotificationFromProps,
         values = valuesFromProps,
       } = variables;
-      if (!id) throw missingIdError;
+      if (typeof id === "undefined") throw missingIdError;
       if (!values) throw missingValuesError;
       if (!resourceName) throw missingResourceError;
 
@@ -639,9 +639,8 @@ export const useUpdate = <
   const { mutate, mutateAsync, ...mutation } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   // this function is used to make the `variables` parameter optional

package/src/hooks/data/useUpdateMany.ts

@@ -676,9 +676,8 @@ export const useUpdateMany = <
   const { mutate, mutateAsync, ...mutation } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: mutation.isLoading,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   // this function is used to make the `variables` parameter optional

package/src/hooks/form/index.ts

@@ -169,14 +169,17 @@ export const useForm = <
     liveParams: props.liveParams,
     meta: { ...combinedMeta, ...props.queryMeta },
     dataProviderName: props.dataProviderName,
+    overtimeOptions: { enabled: false },
   });
 
   const createMutation = useCreate<TResponse, TResponseError, TVariables>({
     mutationOptions: props.createMutationOptions,
+    overtimeOptions: { enabled: false },
   });
 
   const updateMutation = useUpdate<TResponse, TResponseError, TVariables>({
     mutationOptions: props.updateMutationOptions,
+    overtimeOptions: { enabled: false },
   });
 
   const mutationResult = isEdit ? updateMutation : createMutation;
@@ -184,9 +187,8 @@ export const useForm = <
   const formLoading = isMutationLoading || queryResult.isFetching;
 
   const { elapsedTime } = useLoadingOvertime({
+    ...props.overtimeOptions,
     isLoading: formLoading,
-    interval: props.overtimeOptions?.interval,
-    onInterval: props.overtimeOptions?.onInterval,
   });
 
   React.useEffect(() => {

package/src/hooks/navigation/index.ts

@@ -85,6 +85,7 @@ export const useNavigation = () => {
     return go({
       to: composeRoute(createActionRoute, resourceItem?.meta, parsed, meta),
       type: "path",
+      query: meta.query,
     }) as string;
   };
 
@@ -138,6 +139,7 @@ export const useNavigation = () => {
         id: encodedId,
       }),
       type: "path",
+      query: meta.query,
     }) as string;
   };
 
@@ -192,6 +194,7 @@ export const useNavigation = () => {
         id: encodedId,
       }),
       type: "path",
+      query: meta.query,
     }) as string;
   };
 
@@ -245,6 +248,7 @@ export const useNavigation = () => {
         id: encodedId,
       }),
       type: "path",
+      query: meta.query,
     }) as string;
   };
 
@@ -295,6 +299,7 @@ export const useNavigation = () => {
     return go({
       to: composeRoute(listActionRoute, resourceItem?.meta, parsed, meta),
       type: "path",
+      query: meta.query,
     }) as string;
   };
 

package/src/hooks/show/index.ts

@@ -1,5 +1,5 @@
 import warnOnce from "warn-once";
-import { useMeta, useOne, useResourceParams, useLoadingOvertime } from "@hooks";
+import { useMeta, useOne, useResourceParams } from "@hooks";
 import { pickNotDeprecated } from "@definitions/helpers";
 
 import type { UseShowProps, UseShowReturnType } from "./types";
@@ -71,21 +71,16 @@ export const useShow = <
     },
     meta: combinedMeta,
     metaData: combinedMeta,
+    overtimeOptions,
     ...useOneProps,
   });
 
-  const { elapsedTime } = useLoadingOvertime({
-    isLoading: queryResult.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
-  });
-
   return {
     queryResult,
     query: queryResult,
     showId,
     setShowId,
-    overtime: { elapsedTime },
+    overtime: queryResult.overtime,
   };
 };
 

package/src/hooks/useLoadingOvertime/index.ts

@@ -27,6 +27,13 @@ type UseLoadingOvertimeCoreReturnType = {
 };
 
 export type UseLoadingOvertimeCoreProps = {
+  /**
+   * If true, the elapsed time will be calculated. If set to false; the elapsed time will be `undefined`.
+   *
+   * @default: true
+   */
+  enabled?: boolean;
+
   /**
    * The loading state. If true, the elapsed time will be calculated.
    */
@@ -63,6 +70,7 @@ export type UseLoadingOvertimeCoreProps = {
  * });
  */
 export const useLoadingOvertime = ({
+  enabled: enabledProp,
   isLoading,
   interval: intervalProp,
   onInterval: onIntervalProp,
@@ -75,11 +83,17 @@ export const useLoadingOvertime = ({
   // pick props or refine context options
   const interval = intervalProp ?? overtime.interval;
   const onInterval = onIntervalProp ?? overtime?.onInterval;
+  const enabled =
+    typeof enabledProp !== "undefined"
+      ? enabledProp
+      : typeof overtime.enabled !== "undefined"
+        ? overtime.enabled
+        : true;
 
   useEffect(() => {
     let intervalFn: ReturnType<typeof setInterval>;
 
-    if (isLoading) {
+    if (enabled && isLoading) {
       intervalFn = setInterval(() => {
         // increase elapsed time
         setElapsedTime((prevElapsedTime) => {
@@ -93,11 +107,13 @@ export const useLoadingOvertime = ({
     }
 
     return () => {
-      clearInterval(intervalFn);
+      if (typeof intervalFn !== "undefined") {
+        clearInterval(intervalFn);
+      }
       // reset elapsed time
       setElapsedTime(undefined);
     };
-  }, [isLoading, interval]);
+  }, [isLoading, interval, enabled]);
 
   useEffect(() => {
     // call onInterval callback

package/src/hooks/useSelect/index.ts

@@ -303,6 +303,7 @@ export const useSelect = <
         defaultValueQueryOptions?.onSuccess?.(data);
       },
     },
+    overtimeOptions: { enabled: false },
     meta: combinedMeta,
     metaData: combinedMeta,
     liveMode: "off",
@@ -341,6 +342,7 @@ export const useSelect = <
         queryOptions?.onSuccess?.(data);
       },
     },
+    overtimeOptions: { enabled: false },
     successNotification,
     errorNotification,
     meta: combinedMeta,
@@ -352,9 +354,8 @@ export const useSelect = <
   });
 
   const { elapsedTime } = useLoadingOvertime({
+    ...overtimeOptions,
     isLoading: queryResult.isFetching || defaultValueQueryResult.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
   });
 
   const combinedOptions = useMemo(

package/src/hooks/useTable/index.ts

@@ -44,10 +44,9 @@ import type {
 import type { LiveModeProps } from "../../contexts/live/types";
 import type { SuccessErrorNotification } from "../../contexts/notification/types";
 import type { BaseListProps } from "../data/useList";
-import {
-  type UseLoadingOvertimeOptionsProps,
-  type UseLoadingOvertimeReturnType,
-  useLoadingOvertime,
+import type {
+  UseLoadingOvertimeOptionsProps,
+  UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
 
 type SetFilterBehavior = "merge" | "replace";
@@ -510,6 +509,7 @@ export function useTable<
       ? unionSorters(preferredPermanentSorters, sorters)
       : undefined,
     queryOptions,
+    overtimeOptions,
     successNotification,
     errorNotification,
     meta: combinedMeta,
@@ -571,12 +571,6 @@ export function useTable<
     [preferredPermanentSorters],
   );
 
-  const { elapsedTime } = useLoadingOvertime({
-    isLoading: queryResult.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
-  });
-
   return {
     tableQueryResult: queryResult,
     tableQuery: queryResult,
@@ -594,8 +588,6 @@ export function useTable<
       ? Math.ceil((queryResult.data?.total ?? 0) / pageSize)
       : 1,
     createLinkForSyncWithLocation,
-    overtime: {
-      elapsedTime,
-    },
+    overtime: queryResult.overtime,
   };
 }