@refinedev/core 4.48.0 → 4.49.0

package/src/hooks/i18n/useTranslation.tsx

@@ -0,0 +1,24 @@
+import { useGetLocale } from "./useGetLocale";
+import { useSetLocale } from "./useSetLocale";
+import { useTranslate } from "./useTranslate";
+
+/**
+ * It combines `useTranslate`, `useSetLocale` and `useGetLocale` hooks for a better developer experience.
+ * It returns `i18nProvider` methods under the hood.
+ * @returns `translate` method to translate the texts.
+ * @returns `changeLocale` method to change the locale
+ * @returns `getLocale` method to get the current locale.
+ *
+ * @see {@link https://refine.dev/docs/i18n/i18n-provider/} for more details.
+ */
+export const useTranslation = () => {
+  const translate = useTranslate();
+  const changeLocale = useSetLocale();
+  const getLocale = useGetLocale();
+
+  return {
+    translate,
+    changeLocale,
+    getLocale,
+  };
+};

package/src/hooks/import/index.tsx

@@ -1,16 +1,19 @@
 import { useEffect, useState } from "react";
-import { parse, ParseConfig } from "papaparse";
+
 import chunk from "lodash/chunk";
+import papaparse from "papaparse";
 
-import { useCreate, useCreateMany, useMeta, useResource } from "@hooks";
-import { MapDataFn, BaseRecord, HttpError, MetaQuery } from "../../interfaces";
 import {
   importCSVMapper,
-  sequentialPromises,
   pickNotDeprecated,
+  sequentialPromises,
 } from "@definitions";
+import { useCreate, useCreateMany, useMeta, useResource } from "@hooks";
+
+import { BaseRecord, HttpError, MetaQuery } from "../../contexts/data/types";
 import { UseCreateReturnType } from "../../hooks/data/useCreate";
 import { UseCreateManyReturnType } from "../../hooks/data/useCreateMany";
+import { MapDataFn } from "../export/types";
 
 export type ImportSuccessResult<TVariables, TData> = {
   request: TVariables[];
@@ -58,7 +61,7 @@ export type ImportOptions<
    * Custom Papa Parse options.
    * @type [`ParseConfig`](https://www.papaparse.com/docs)
    */
-  paparseOptions?: ParseConfig;
+  paparseOptions?: papaparse.ParseConfig;
   /**
    * Requests batch size. If it is 1, all records are sent one by one. By default, it is [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) to send all records in one batch. If it is more than 1, `createMany` should be implemented on DataProvider.
    */
@@ -205,7 +208,7 @@ export const useImport = <
     handleCleanup();
     return new Promise<CreatedValuesType<TVariables, TData>[]>((resolve) => {
       setIsLoading(true);
-      parse(file as any, {
+      papaparse.parse(file as any, {
         complete: async ({ data }: { data: unknown[][] }) => {
           const values = importCSVMapper(data, mapData);
 

package/src/hooks/index.ts

@@ -3,7 +3,7 @@ export * from "./data";
 export * from "./live";
 export * from "./resource";
 export * from "./notification";
-export * from "./translate";
+export * from "./i18n";
 export * from "./refine";
 export * from "./export";
 export * from "./form";
@@ -13,7 +13,7 @@ export * from "./show";
 export * from "./import";
 export * from "./modal";
 export * from "./router";
-export { useRouterType } from "../contexts/router-picker";
+export { useRouterType } from "../contexts/router/picker";
 export * from "./legacy-router";
 export * from "./accessControl";
 export * from "./useSelect";
@@ -24,3 +24,7 @@ export * from "./breadcrumb";
 export * from "./menu";
 export * from "./useMeta";
 export * from "./useLoadingOvertime";
+export * from "./useKeys";
+export * from "./use-refine-options";
+export * from "./use-resource-params";
+export * from "./button";

package/src/hooks/invalidate/index.tsx

@@ -1,14 +1,15 @@
 import { useCallback } from "react";
+
 import {
   InvalidateOptions,
   InvalidateQueryFilters,
   useQueryClient,
 } from "@tanstack/react-query";
 
-import { useResource } from "@hooks/resource";
 import { pickDataProvider } from "@definitions";
-import { BaseKey, IQueryKeys } from "../../interfaces";
-import { useKeys } from "@hooks/useKeys";
+import { useKeys, useResource } from "@hooks";
+
+import { BaseKey, IQueryKeys } from "../../contexts/data/types";
 
 export type UseInvalidateProp = {
   resource?: string;

package/src/hooks/legacy-router/useRouterContext.ts

@@ -1,8 +1,9 @@
 import { useContext } from "react";
-import { RouterContext, defaultProvider } from "@contexts/legacy-router";
+
+import { LegacyRouterContext, defaultProvider } from "@contexts/router/legacy";
 
 export const useRouterContext = () => {
-  const routerContextValues = useContext(RouterContext);
+  const routerContextValues = useContext(LegacyRouterContext);
 
   const { useHistory, useLocation, useParams, Prompt, Link, routes } =
     routerContextValues ?? defaultProvider;

package/src/hooks/live/useLiveMode/index.ts

@@ -1,7 +1,10 @@
 import { useContext } from "react";
-import { LiveModeProps, IRefineContext } from "../../../interfaces";
+
 import { RefineContext } from "@contexts/refine";
 
+import { LiveModeProps } from "../../../contexts/live/types";
+import { IRefineContext } from "../../../contexts/refine/types";
+
 export const useLiveMode = (
   liveMode: LiveModeProps["liveMode"],
 ): LiveModeProps["liveMode"] => {

package/src/hooks/live/usePublish/index.ts

@@ -1,10 +1,10 @@
 import { useContext } from "react";
 
 import { LiveContext } from "@contexts/live";
-import { ILiveContext } from "../../../interfaces";
+import { LiveProvider } from "../../../contexts/live/types";
 
-export const usePublish: () => NonNullable<ILiveContext>["publish"] = () => {
-  const liveContext = useContext<ILiveContext>(LiveContext);
+export const usePublish: () => NonNullable<LiveProvider>["publish"] = () => {
+  const { liveProvider } = useContext(LiveContext);
 
-  return liveContext?.publish;
+  return liveProvider?.publish;
 };

package/src/hooks/live/useResourceSubscription/index.ts

@@ -1,19 +1,19 @@
+import { useContext, useEffect } from "react";
+
 import { LiveContext } from "@contexts/live";
 import { RefineContext } from "@contexts/refine";
 import { useInvalidate } from "@hooks/invalidate";
 import { useResource } from "@hooks/resource";
-import { useContext, useEffect } from "react";
+
 import {
   BaseKey,
-  CrudFilters,
-  CrudSorting,
-  ILiveContext,
-  IRefineContext,
-  LiveEvent,
-  LiveModeProps,
+  CrudFilter,
+  CrudSort,
   MetaQuery,
   Pagination,
-} from "../../../interfaces";
+} from "../../../contexts/data/types";
+import { LiveEvent, LiveModeProps } from "../../../contexts/live/types";
+import { IRefineContext } from "../../../contexts/refine/types";
 
 export type UseResourceSubscriptionProps = {
   channel: string;
@@ -36,9 +36,9 @@ export type UseResourceSubscriptionProps = {
     /**
      * @deprecated `sort` is deprecated. Use `sorters` instead.
      */
-    sort?: CrudSorting;
-    sorters?: CrudSorting;
-    filters?: CrudFilters;
+    sort?: CrudSort[];
+    sorters?: CrudSort[];
+    filters?: CrudFilter[];
     subscriptionType: "useList" | "useOne" | "useMany";
     [key: string]: any;
   };
@@ -52,9 +52,7 @@ export type UseResourceSubscriptionProps = {
   meta?: MetaQuery & { dataProviderName?: string };
 } & LiveModeProps;
 
-export type PublishType = {
-  (event: LiveEvent): void;
-};
+export type PublishType = (event: LiveEvent) => void;
 
 export const useResourceSubscription = ({
   resource: resourceFromProp,
@@ -69,7 +67,7 @@ export const useResourceSubscription = ({
 }: UseResourceSubscriptionProps): void => {
   const { resource, identifier } = useResource(resourceFromProp);
 
-  const liveDataContext = useContext<ILiveContext>(LiveContext);
+  const { liveProvider } = useContext(LiveContext);
   const {
     liveMode: liveModeFromContext,
     onLiveEvent: onLiveEventContextCallback,
@@ -106,7 +104,7 @@ export const useResourceSubscription = ({
     };
 
     if (liveMode && liveMode !== "off" && enabled) {
-      subscription = liveDataContext?.subscribe({
+      subscription = liveProvider?.subscribe({
         channel,
         params: {
           resource: resource?.name,
@@ -124,7 +122,7 @@ export const useResourceSubscription = ({
 
     return () => {
       if (subscription) {
-        liveDataContext?.unsubscribe(subscription);
+        liveProvider?.unsubscribe(subscription);
       }
     };
   }, [enabled]);

package/src/hooks/live/useSubscription/index.ts

@@ -1,15 +1,15 @@
 import { useContext, useEffect } from "react";
 
 import { LiveContext } from "@contexts/live";
+
 import {
   BaseKey,
-  CrudFilters,
-  CrudSorting,
-  ILiveContext,
-  LiveEvent,
+  CrudFilter,
+  CrudSort,
   MetaQuery,
   Pagination,
-} from "../../../interfaces";
+} from "../../../contexts/data/types";
+import { LiveEvent } from "../../../contexts/live/types";
 
 export type UseSubscriptionProps = {
   /**
@@ -49,9 +49,9 @@ export type UseSubscriptionProps = {
     /**
      * @deprecated `sort` is deprecated, use `sorters` instead.
      */
-    sort?: CrudSorting;
-    sorters?: CrudSorting;
-    filters?: CrudFilters;
+    sort?: CrudSort[];
+    sorters?: CrudSort[];
+    filters?: CrudFilter[];
     subscriptionType?: "useList" | "useOne" | "useMany";
     resource?: string;
     [key: string]: any;
@@ -72,13 +72,13 @@ export const useSubscription = ({
   dataProviderName = "default",
   meta,
 }: UseSubscriptionProps): void => {
-  const liveDataContext = useContext<ILiveContext>(LiveContext);
+  const { liveProvider } = useContext(LiveContext);
 
   useEffect(() => {
     let subscription: any;
 
     if (enabled) {
-      subscription = liveDataContext?.subscribe({
+      subscription = liveProvider?.subscribe({
         channel,
         params,
         types,
@@ -93,7 +93,7 @@ export const useSubscription = ({
 
     return () => {
       if (subscription) {
-        liveDataContext?.unsubscribe(subscription);
+        liveProvider?.unsubscribe(subscription);
       }
     };
   }, [enabled]);

package/src/hooks/menu/useMenu.tsx

@@ -1,14 +1,16 @@
 import React from "react";
-import { useTranslate, useResource, useParsed, useRouterContext } from "..";
-import { useUserFriendlyName, pickNotDeprecated } from "@definitions";
-import { useRouterType } from "../../contexts/router-picker";
-import { createResourceKey } from "../../definitions/helpers/menu/create-resource-key";
-import { useGetToPath } from "../router/use-get-to-path/index";
+
+import { pickNotDeprecated, useUserFriendlyName } from "@definitions";
 import { getParentResource } from "@definitions/helpers/router";
+
+import { useParsed, useResource, useRouterContext, useTranslate } from "..";
+import { useRouterType } from "../../contexts/router/picker";
+import { createResourceKey } from "../../definitions/helpers/menu/create-resource-key";
 import {
   FlatTreeItem,
   createTree,
 } from "../../definitions/helpers/menu/create-tree";
+import { useGetToPath } from "../router/use-get-to-path/index";
 
 type UseMenuReturnType = {
   defaultOpenKeys: string[];

package/src/hooks/navigation/index.ts

@@ -1,12 +1,14 @@
-import { useRouterContext, useResource } from "@hooks";
-import { BaseKey, IResourceItem, MetaDataQuery } from "../../interfaces";
-import { useGo } from "@hooks/router/use-go";
-import { useParsed } from "@hooks/router/use-parsed";
-import { useRouterType } from "@contexts/router-picker";
-import { getActionRoutesFromResource } from "@definitions/helpers/router";
+import { useRouterType } from "@contexts/router/picker";
 import { pickResource } from "@definitions/helpers/pick-resource";
+import { getActionRoutesFromResource } from "@definitions/helpers/router";
 import { composeRoute } from "@definitions/helpers/router/compose-route";
+import { useResource, useRouterContext } from "@hooks";
 import { useBack } from "@hooks/router/use-back";
+import { useGo } from "@hooks/router/use-go";
+import { useParsed } from "@hooks/router/use-parsed";
+
+import { BaseKey, MetaDataQuery } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
 
 export type HistoryType = "push" | "replace";
 

package/src/hooks/notification/useCancelNotification/index.tsx

@@ -1,7 +1,7 @@
 import { useContext } from "react";
 
 import { UndoableQueueContext } from "@contexts/undoableQueue";
-import { IUndoableQueue, IUndoableQueueContext } from "../../../interfaces";
+import { IUndoableQueue } from "../../../contexts/undoableQueue/types";
 
 export type UseCancelNotificationType = () => {
   notifications: IUndoableQueue[];
@@ -10,7 +10,7 @@ export type UseCancelNotificationType = () => {
 
 export const useCancelNotification: UseCancelNotificationType = () => {
   const { notifications, notificationDispatch } =
-    useContext<IUndoableQueueContext>(UndoableQueueContext);
+    useContext(UndoableQueueContext);
 
   return { notifications, notificationDispatch };
 };

package/src/hooks/notification/useHandleNotification/index.ts

@@ -1,8 +1,9 @@
 import { useCallback } from "react";
 
-import { OpenNotificationParams } from "../../../interfaces";
 import { useNotification } from "@hooks";
 
+import { OpenNotificationParams } from "../../../contexts/notification/types";
+
 export const useHandleNotification = (): typeof handleNotification => {
   const { open } = useNotification();
 

package/src/hooks/notification/useNotification/index.ts

@@ -1,7 +1,7 @@
 import { useContext } from "react";
 
 import { NotificationContext } from "@contexts/notification";
-import { INotificationContext } from "../../../interfaces";
+import { INotificationContext } from "../../../contexts/notification/types";
 
 export const useNotification = (): INotificationContext => {
   const { open, close } = useContext(NotificationContext);

package/src/hooks/redirection/index.ts

@@ -1,13 +1,11 @@
 import { useCallback } from "react";
 
-import {
-  BaseKey,
-  IResourceItem,
-  MetaDataQuery,
-  RedirectAction,
-} from "../../interfaces";
 import { useNavigation } from "@hooks";
 
+import { BaseKey, MetaDataQuery } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
+import { RedirectAction } from "../form/types";
+
 export type UseRedirectionAfterSubmissionType = () => (options: {
   redirect: RedirectAction;
   resource?: IResourceItem;

package/src/hooks/refine/useMutationMode.ts

@@ -1,9 +1,13 @@
 import { useContext } from "react";
 
 import { RefineContext } from "@contexts/refine";
-import { IRefineContextOptions } from "../../interfaces";
+import { IRefineContextOptions } from "../../contexts/refine/types";
+import type { MutationMode } from "../../contexts/data/types";
 
-type UseMutationModeType = () => {
+type UseMutationModeType = (
+  preferredMutationMode?: MutationMode,
+  preferredUndoableTimeout?: number,
+) => {
   mutationMode: IRefineContextOptions["mutationMode"];
   undoableTimeout: IRefineContextOptions["undoableTimeout"];
 };
@@ -15,8 +19,14 @@ type UseMutationModeType = () => {
  *
  * @see {@link https://refine.dev/docs/guides-and-concepts/mutation-mode} for more details.
  */
-export const useMutationMode: UseMutationModeType = () => {
+export const useMutationMode: UseMutationModeType = (
+  preferredMutationMode?: MutationMode,
+  preferredUndoableTimeout?: number,
+) => {
   const { mutationMode, undoableTimeout } = useContext(RefineContext);
 
-  return { mutationMode, undoableTimeout };
+  return {
+    mutationMode: preferredMutationMode ?? mutationMode,
+    undoableTimeout: preferredUndoableTimeout ?? undoableTimeout,
+  };
 };

package/src/hooks/refine/useSyncWithLocation.ts

@@ -1,7 +1,7 @@
 import { useContext } from "react";
 
 import { RefineContext } from "@contexts/refine";
-import { IRefineContextOptions } from "../../interfaces";
+import { IRefineContextOptions } from "../../contexts/refine/types";
 
 type UseSyncWithLocationType = () => {
   syncWithLocation: IRefineContextOptions["syncWithLocation"];

package/src/hooks/refine/useTitle.tsx

@@ -1,6 +1,8 @@
 import { useContext } from "react";
+
 import { RefineContext } from "@contexts/refine";
-import { TitleProps } from "../../interfaces";
+
+import { TitleProps } from "../../contexts/refine/types";
 
 /**
  * `useTitle` returns a component that calls the `<Title>` passed to the `<Refine>`.

package/src/hooks/refine/useWarnAboutChange/index.ts

@@ -2,10 +2,8 @@ import { useContext } from "react";
 
 import { RefineContext } from "@contexts/refine";
 import { UnsavedWarnContext } from "@contexts/unsavedWarn";
-import {
-  IRefineContextOptions,
-  IUnsavedWarnContext,
-} from "../../../interfaces";
+import { IRefineContextOptions } from "../../../contexts/refine/types";
+import { IUnsavedWarnContext } from "../../../contexts/unsavedWarn/types";
 
 type UseWarnAboutChangeType = () => {
   warnWhenUnsavedChanges: IRefineContextOptions["warnWhenUnsavedChanges"];

package/src/hooks/resource/useResource/index.ts

@@ -1,16 +1,15 @@
 import { useContext } from "react";
 
 import { ResourceContext } from "@contexts/resource";
-import {
-  Action,
-  BaseKey,
-  IResourceItem,
-  ResourceRouterParams,
-} from "../../../interfaces";
-import { useRouterContext, useResourceWithRoute } from "@hooks";
-import { useRouterType } from "../../../contexts/router-picker";
-import { useParsed } from "../../router/use-parsed";
+import { useResourceWithRoute, useRouterContext } from "@hooks";
+
+import { BaseKey } from "../../../contexts/data/types";
+import { IResourceItem } from "../../../contexts/resource/types";
+import { ResourceRouterParams } from "../../../contexts/router/legacy/types";
+import { useRouterType } from "../../../contexts/router/picker";
+import { Action } from "../../../contexts/router/types";
 import { pickResource } from "../../../definitions/helpers/pick-resource";
+import { useParsed } from "../../router/use-parsed";
 
 export type UseResourceLegacyProps = {
   /**
@@ -48,7 +47,13 @@ export type UseResourceReturnType = {
    * @deprecated Use `resource.name` instead when you need to get the resource name.
    */
   resourceName?: string;
+  /**
+   * @deprecated This value may not always reflect the correct "id" value. Use `useResourceParams` to obtain the calculated "id"` or `useParsed` to obtain the id from the route instead.
+   */
   id?: BaseKey;
+  /**
+   * @deprecated This value may not always reflect the correct "action" value. Use `useResourceParams` to obtain the calculated "action" or `useParsed` to obtain the action from the route instead.
+   */
   action?: Action;
   select: <T extends boolean = true>(
     resourceName: string,

package/src/hooks/resource/useResourceWithRoute/index.ts

@@ -1,8 +1,10 @@
-import { useContext, useCallback } from "react";
+import { useCallback, useContext } from "react";
+
 import { ResourceContext } from "@contexts/resource";
-import { IResourceItem } from "../../../interfaces";
 import { pickResource } from "@definitions/helpers/pick-resource";
 
+import { IResourceItem } from "../../../contexts/resource/types";
+
 export type UseResourceWithRouteReturnType = (route: string) => IResourceItem;
 
 /**

package/src/hooks/router/use-back/index.tsx

@@ -1,12 +1,12 @@
-import { RouterBindingsContext } from "@contexts/router";
+import { RouterContext } from "@contexts/router";
 import React, { useContext } from "react";
 
 export const useBack = () => {
-  const bindings = useContext(RouterBindingsContext);
+  const routerContext = useContext(RouterContext);
 
   const useBack = React.useMemo(
-    () => bindings?.back ?? (() => () => undefined),
-    [bindings?.back],
+    () => routerContext?.back ?? (() => () => undefined),
+    [routerContext?.back],
   );
 
   const back = useBack();

package/src/hooks/router/use-get-to-path/index.ts

@@ -1,10 +1,12 @@
 import React from "react";
-import { useResource } from "../../resource";
-import { Action, IResourceItem } from "../../../interfaces";
+
+import { IResourceItem } from "../../../contexts/resource/types";
+import { useRouterType } from "../../../contexts/router/picker";
+import { Action } from "../../../contexts/router/types";
 import { getActionRoutesFromResource } from "../../../definitions/helpers/router";
-import { useParsed } from "../use-parsed";
 import { composeRoute } from "../../../definitions/helpers/router/compose-route";
-import { useRouterType } from "./../../../contexts/router-picker";
+import { useResource } from "../../resource";
+import { useParsed } from "../use-parsed";
 
 type UseToPathParams = {
   resource?: IResourceItem;

package/src/hooks/router/use-go/index.tsx

@@ -1,12 +1,14 @@
-import { RouterBindingsContext } from "@contexts/router";
-import { useResource } from "@hooks/resource";
 import React, { useCallback, useContext } from "react";
-import type {
+
+import { RouterContext } from "@contexts/router";
+import { useResource } from "@hooks/resource";
+
+import { BaseKey } from "../../../contexts/data/types";
+import { IResourceItem } from "../../../contexts/resource/types";
+import {
   Action,
-  BaseKey,
   GoConfig as GoConfigBase,
-  IResourceItem,
-} from "../../../interfaces";
+} from "../../../contexts/router/types";
 import { useGetToPath } from "../use-get-to-path";
 
 type ResourceWithoutId = {
@@ -36,13 +38,13 @@ export type GoConfigWithResource = Omit<GoConfigBase, "to"> & {
 };
 
 export const useGo = () => {
-  const bindings = useContext(RouterBindingsContext);
+  const routerContext = useContext(RouterContext);
   const { select: resourceSelect } = useResource();
   const getToPath = useGetToPath();
 
   const useGo = React.useMemo(
-    () => bindings?.go ?? (() => () => undefined),
-    [bindings?.go],
+    () => routerContext?.go ?? (() => () => undefined),
+    [routerContext?.go],
   );
 
   const goFromRouter = useGo();

package/src/hooks/router/use-link/index.tsx

@@ -1,16 +1,17 @@
-import { RouterBindingsContext } from "@contexts/router";
+import { RouterContext } from "@contexts/router";
 import React, { useContext } from "react";
 
 export const useLink = () => {
-  const bindings = useContext(RouterBindingsContext);
+  const routerContext = useContext(RouterContext);
 
-  if (bindings?.Link) {
-    return bindings.Link;
+  if (routerContext?.Link) {
+    return routerContext.Link;
   }
 
-  const FallbackLink: Required<typeof bindings>["Link"] = ({ to, ...rest }) => (
-    <a href={to} {...rest} />
-  );
+  const FallbackLink: Required<typeof routerContext>["Link"] = ({
+    to,
+    ...rest
+  }) => <a href={to} {...rest} />;
 
   return FallbackLink;
 };

package/src/hooks/router/use-parse/index.tsx

@@ -1,22 +1,22 @@
-import { RouterBindingsContext } from "@contexts/router";
+import { RouterContext } from "@contexts/router";
 import React, { useContext } from "react";
-import { ParseFunction, ParseResponse } from "src/interfaces";
+import { ParseFunction, ParseResponse } from "../../../contexts/router/types";
 
 type UseParseType = () => <
   TParams extends Record<string, any> = Record<string, any>,
 >() => ParseResponse<TParams>;
 
 export const useParse: UseParseType = () => {
-  const bindings = useContext(RouterBindingsContext);
+  const routerContext = useContext(RouterContext);
 
   const useParse = React.useMemo(
     () =>
-      bindings?.parse ??
+      routerContext?.parse ??
       (() =>
         (() => {
           return {};
         }) as ParseFunction),
-    [bindings?.parse],
+    [routerContext?.parse],
   );
 
   const parse = useParse();