@refinedev/core 4.58.0 → 5.0.1

package/src/hooks/form/types.ts

@@ -28,6 +28,7 @@ import type {
 import type { LiveModeProps } from "../../contexts/live/types";
 import type { SuccessErrorNotification } from "../../contexts/notification/types";
 import type { Action } from "../../contexts/router/types";
+import type { MakeOptional } from "../../definitions/types";
 
 export type FormAction = Extract<Action, "create" | "edit" | "clone">;
 
@@ -35,11 +36,6 @@ export type RedirectAction =
   | Extract<Action, "create" | "edit" | "list" | "show">
   | false;
 
-/**
- * @deprecated use RedirectAction type instead
- */
-export type RedirectionTypes = RedirectAction;
-
 export type AutoSaveProps<TVariables> = {
   autoSave?: {
     enabled: boolean;
@@ -56,7 +52,7 @@ export type AutoSaveReturnType<
   TVariables = {},
 > = {
   autoSaveProps: Pick<
-    UseUpdateReturnType<TData, TError, TVariables>,
+    UseUpdateReturnType<TData, TError, TVariables>["mutation"],
     "data" | "error" | "status"
   >;
   onFinishAutoSave: (
@@ -104,11 +100,6 @@ type ActionFormProps<
    * Metadata query for dataProvider
    */
   meta?: MetaQuery;
-  /**
-   * Metadata query for dataProvider
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    * Metadata to pass for the `useOne` query
    */
@@ -158,10 +149,13 @@ type ActionFormProps<
   /**
    * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
    */
-  queryOptions?: UseQueryOptions<
-    GetOneResponse<TQueryFnData>,
-    TError,
-    GetOneResponse<TData>
+  queryOptions?: MakeOptional<
+    UseQueryOptions<
+      GetOneResponse<TQueryFnData>,
+      TError,
+      GetOneResponse<TData>
+    >,
+    "queryFn" | "queryKey"
   >;
   /**
    * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
@@ -227,19 +221,10 @@ export type UseFormReturnType<
   id?: BaseKey;
   setId: Dispatch<SetStateAction<BaseKey | undefined>>;
   query?: QueryObserverResult<GetOneResponse<TData>, TError>;
-  /**
-   * @deprecated use `query` instead
-   */
-  queryResult?: QueryObserverResult<GetOneResponse<TData>, TError>;
+
   mutation:
-    | UseUpdateReturnType<TResponse, TResponseError, TVariables>
-    | UseCreateReturnType<TResponse, TResponseError, TVariables>;
-  /**
-   * @deprecated use `mutation` instead
-   */
-  mutationResult:
-    | UseUpdateReturnType<TResponse, TResponseError, TVariables>
-    | UseCreateReturnType<TResponse, TResponseError, TVariables>;
+    | UseUpdateReturnType<TResponse, TResponseError, TVariables>["mutation"]
+    | UseCreateReturnType<TResponse, TResponseError, TVariables>["mutation"];
   formLoading: boolean;
   onFinish: (
     values: TVariables,

package/src/hooks/i18n/useGetLocale.ts

@@ -2,7 +2,7 @@ import { useCallback, useContext } from "react";
 
 import { I18nContext } from "@contexts/i18n";
 
-export type UseGetLocaleType = () => () => string | undefined;
+export type UseGetLocaleType = () => () => string;
 
 /**
  * If you need to know the current locale, refine provides the `useGetLocale` hook.
@@ -13,5 +13,11 @@ export type UseGetLocaleType = () => () => string | undefined;
 export const useGetLocale: UseGetLocaleType = () => {
   const { i18nProvider } = useContext(I18nContext);
 
-  return useCallback(() => i18nProvider?.getLocale(), []);
+  if (!i18nProvider) {
+    throw new Error(
+      "useGetLocale cannot be called without i18n provider being defined.",
+    );
+  }
+
+  return useCallback(() => i18nProvider.getLocale(), []);
 };

package/src/hooks/import/index.tsx

@@ -3,12 +3,8 @@ import { useEffect, useState } from "react";
 import chunk from "lodash/chunk";
 import papaparse from "papaparse";
 
-import {
-  importCSVMapper,
-  pickNotDeprecated,
-  sequentialPromises,
-} from "@definitions";
-import { useCreate, useCreateMany, useMeta, useResource } from "@hooks";
+import { importCSVMapper, sequentialPromises } from "@definitions";
+import { useCreate, useCreateMany, useMeta, useResourceParams } from "@hooks";
 
 import type {
   BaseRecord,
@@ -46,12 +42,6 @@ export type ImportOptions<
   TVariables = any,
   TData extends BaseRecord = BaseRecord,
 > = {
-  /**
-   * Resource name for API data interactions.
-   * @default Resource name that it reads from route
-   * @deprecated `resourceName` is deprecated. Use `resource` instead.
-   */
-  resourceName?: string;
   /**
    * Resource name for API data interactions.
    * @default Resource name that it reads from route
@@ -80,9 +70,6 @@ export type ImportOptions<
   meta?: MetaQuery;
   /**
    *  Metadata query for `dataProvider`
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    *  A callback function that returns a current state of uploading process.
    *
@@ -139,14 +126,12 @@ export const useImport = <
   TError extends HttpError = HttpError,
   TVariables = any,
 >({
-  resourceName,
   resource: resourceFromProps,
   mapData = (item) => item as unknown as TVariables,
   paparseOptions,
   batchSize = Number.MAX_SAFE_INTEGER,
   onFinish,
   meta,
-  metaData,
   onProgress,
   dataProviderName,
 }: ImportOptions<TItem, TVariables, TData> = {}): UseImportReturnType<
@@ -158,9 +143,9 @@ export const useImport = <
   const [totalAmount, setTotalAmount] = useState<number>(0);
   const [isLoading, setIsLoading] = useState(false);
 
-  const { resource, identifier } = useResource(
-    resourceFromProps ?? resourceName,
-  );
+  const { resource, identifier } = useResourceParams({
+    resource: resourceFromProps,
+  });
 
   const getMeta = useMeta();
 
@@ -169,7 +154,7 @@ export const useImport = <
 
   const combinedMeta = getMeta({
     resource,
-    meta: pickNotDeprecated(meta, metaData),
+    meta: meta,
   });
 
   let mutationResult:
@@ -229,7 +214,6 @@ export const useImport = <
                   errorNotification: false,
                   dataProviderName,
                   meta: combinedMeta,
-                  metaData: combinedMeta,
                 });
 
                 return { response, value };
@@ -273,7 +257,6 @@ export const useImport = <
                   errorNotification: false,
                   dataProviderName,
                   meta: combinedMeta,
-                  metaData: combinedMeta,
                 });
 
                 return {

package/src/hooks/index.ts

@@ -1,7 +1,6 @@
 export * from "./auth";
 export * from "./data";
 export * from "./live";
-export * from "./resource";
 export * from "./notification";
 export * from "./i18n";
 export * from "./refine";
@@ -13,8 +12,6 @@ export * from "./show";
 export * from "./import";
 export * from "./modal";
 export * from "./router";
-export { useRouterType } from "../contexts/router/picker";
-export * from "./legacy-router";
 export * from "./accessControl";
 export * from "./useSelect";
 export * from "./useTable";

package/src/hooks/invalidate/index.tsx

@@ -7,7 +7,7 @@ import {
 } from "@tanstack/react-query";
 
 import { pickDataProvider } from "@definitions";
-import { useKeys, useResource } from "@hooks";
+import { useKeys, useResourceParams } from "@hooks";
 
 import type { BaseKey, IQueryKeys } from "../../contexts/data/types";
 
@@ -23,9 +23,9 @@ export type UseInvalidateProp = {
 export const useInvalidate = (): ((
   props: UseInvalidateProp,
 ) => Promise<void>) => {
-  const { resources } = useResource();
+  const { resources } = useResourceParams();
   const queryClient = useQueryClient();
-  const { keys, preferLegacyKeys } = useKeys();
+  const { keys } = useKeys();
 
   const invalidate = useCallback(
     async ({
@@ -49,38 +49,38 @@ export const useInvalidate = (): ((
         invalidates.map((key) => {
           switch (key) {
             case "all":
-              return queryClient.invalidateQueries(
-                keys().data(dp).get(preferLegacyKeys),
-                invalidationFilters,
-                invalidationOptions,
-              );
+              return queryClient.invalidateQueries({
+                queryKey: keys().data(dp).get(),
+                ...invalidationFilters,
+                ...invalidationOptions,
+              });
             case "list":
-              return queryClient.invalidateQueries(
-                queryKey.action("list").get(preferLegacyKeys),
-                invalidationFilters,
-                invalidationOptions,
-              );
+              return queryClient.invalidateQueries({
+                queryKey: queryKey.action("list").get(),
+                ...invalidationFilters,
+                ...invalidationOptions,
+              });
             case "many":
-              return queryClient.invalidateQueries(
-                queryKey.action("many").get(preferLegacyKeys),
-                invalidationFilters,
-                invalidationOptions,
-              );
+              return queryClient.invalidateQueries({
+                queryKey: queryKey.action("many").get(),
+                ...invalidationFilters,
+                ...invalidationOptions,
+              });
             case "resourceAll":
-              return queryClient.invalidateQueries(
-                queryKey.get(preferLegacyKeys),
-                invalidationFilters,
-                invalidationOptions,
-              );
+              return queryClient.invalidateQueries({
+                queryKey: queryKey.get(),
+                ...invalidationFilters,
+                ...invalidationOptions,
+              });
             case "detail":
-              return queryClient.invalidateQueries(
-                queryKey
+              return queryClient.invalidateQueries({
+                queryKey: queryKey
                   .action("one")
                   .id(id || "")
-                  .get(preferLegacyKeys),
-                invalidationFilters,
-                invalidationOptions,
-              );
+                  .get(),
+                ...invalidationFilters,
+                ...invalidationOptions,
+              });
             default:
               return;
           }

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

@@ -3,7 +3,7 @@ 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 { useResourceParams } from "@hooks";
 
 import type {
   BaseKey,
@@ -20,23 +20,6 @@ export type UseResourceSubscriptionProps = {
   params?: {
     ids?: BaseKey[];
     id?: BaseKey;
-    /**
-     * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
-     */
-    meta?: MetaQuery;
-    /**
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery;
-    pagination?: Pagination;
-    /**
-     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
-     */
-    hasPagination?: boolean;
-    /**
-     * @deprecated `sort` is deprecated. Use `sorters` instead.
-     */
-    sort?: CrudSort[];
     sorters?: CrudSort[];
     filters?: CrudFilter[];
     subscriptionType: "useList" | "useOne" | "useMany";
@@ -45,10 +28,6 @@ export type UseResourceSubscriptionProps = {
   types: LiveEvent["type"][];
   resource?: string;
   enabled?: boolean;
-  /**
-   * @deprecated use `meta.dataProviderName` instead.
-   */
-  dataProviderName?: string;
   meta?: MetaQuery & { dataProviderName?: string };
 } & LiveModeProps;
 
@@ -62,10 +41,11 @@ export const useResourceSubscription = ({
   enabled = true,
   liveMode: liveModeFromProp,
   onLiveEvent,
-  dataProviderName: dataProviderNameFromProps,
   meta,
 }: UseResourceSubscriptionProps): void => {
-  const { resource, identifier } = useResource(resourceFromProp);
+  const { resource, identifier } = useResourceParams({
+    resource: resourceFromProp,
+  });
 
   const { liveProvider } = useContext(LiveContext);
   const {
@@ -78,9 +58,7 @@ export const useResourceSubscription = ({
   const invalidate = useInvalidate();
 
   const dataProviderName =
-    dataProviderNameFromProps ??
-    meta?.dataProviderName ??
-    resource?.meta?.dataProviderName;
+    meta?.dataProviderName ?? resource?.meta?.dataProviderName;
 
   useEffect(() => {
     let subscription: any;
@@ -112,7 +90,6 @@ export const useResourceSubscription = ({
         },
         types,
         callback,
-        dataProviderName,
         meta: {
           ...meta,
           dataProviderName,

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

@@ -33,33 +33,12 @@ export type UseSubscriptionProps = {
   params?: {
     ids?: BaseKey[];
     id?: BaseKey;
-    /**
-     * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
-     */
-    meta?: MetaQuery;
-    /**
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery;
-    pagination?: Pagination;
-    /**
-     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
-     */
-    hasPagination?: boolean;
-    /**
-     * @deprecated `sort` is deprecated, use `sorters` instead.
-     */
-    sort?: CrudSort[];
     sorters?: CrudSort[];
     filters?: CrudFilter[];
     subscriptionType?: "useList" | "useOne" | "useMany";
     resource?: string;
     [key: string]: any;
   };
-  /**
-   * @deprecated use `meta.dataProviderName` instead.
-   */
-  dataProviderName?: string;
   meta?: MetaQuery & { dataProviderName?: string };
 };
 
@@ -69,7 +48,6 @@ export const useSubscription = ({
   types = ["*"],
   enabled = true,
   onLiveEvent,
-  dataProviderName = "default",
   meta,
 }: UseSubscriptionProps): void => {
   const { liveProvider } = useContext(LiveContext);
@@ -83,10 +61,9 @@ export const useSubscription = ({
         params,
         types,
         callback: onLiveEvent,
-        dataProviderName,
         meta: {
           ...meta,
-          dataProviderName,
+          dataProviderName: meta?.dataProviderName ?? "default",
         },
       });
     }

package/src/hooks/menu/useMenu.tsx

@@ -1,10 +1,9 @@
 import React from "react";
 
-import { pickNotDeprecated, useUserFriendlyName } from "@definitions";
+import { useUserFriendlyName } from "@definitions";
 import { getParentResource } from "@definitions/helpers/router";
 
-import { useParsed, useResource, useRouterContext, useTranslate } from "..";
-import { useRouterType } from "../../contexts/router/picker";
+import { useParsed, useResourceParams, useTranslate } from "..";
 import { createResourceKey } from "../../definitions/helpers/menu/create-resource-key";
 import {
   type FlatTreeItem,
@@ -23,14 +22,15 @@ export type UseMenuProps = {
   hideOnMissingParameter?: boolean;
 };
 
-export type TreeMenuItem =
-  // Omitted because `label` and `route` are deprecated in `resource` but not in `menuItems`. These are populated in `prepareItem` for ease of use.
-  Omit<FlatTreeItem, "label" | "route" | "children"> & {
-    route?: string;
-    icon?: React.ReactNode;
-    label?: string;
-    children: TreeMenuItem[];
-  };
+export type TreeMenuItem = Omit<
+  FlatTreeItem,
+  "label" | "route" | "children"
+> & {
+  route?: string;
+  icon?: React.ReactNode;
+  label?: string;
+  children: TreeMenuItem[];
+};
 
 const getCleanPath = (pathname: string) => {
   return pathname
@@ -55,24 +55,16 @@ export const useMenu = (
   const translate = useTranslate();
 
   const getToPath = useGetToPath();
-  const routerType = useRouterType();
-  const { resource, resources } = useResource();
+  const { resource, resources } = useResourceParams();
   const { pathname } = useParsed();
-  const { useLocation } = useRouterContext();
-  const { pathname: legacyPath } = useLocation();
   const getFriendlyName = useUserFriendlyName();
 
-  const cleanPathname =
-    routerType === "legacy"
-      ? getCleanPath(legacyPath)
-      : pathname
-        ? getCleanPath(pathname)
-        : undefined;
+  const cleanPathname = pathname ? getCleanPath(pathname) : undefined;
 
   const cleanRoute = `/${(cleanPathname ?? "").replace(/^\//, "")}`;
 
   const selectedKey = resource
-    ? createResourceKey(resource, resources, routerType === "legacy")
+    ? createResourceKey(resource, resources)
     : cleanRoute ?? "";
 
   const defaultOpenKeys = React.useMemo(() => {
@@ -88,7 +80,7 @@ export const useMenu = (
 
   const prepareItem = React.useCallback(
     (item: FlatTreeItem): TreeMenuItem | undefined => {
-      if (pickNotDeprecated(item?.meta?.hide, item?.options?.hide)) {
+      if (item?.meta?.hide) {
         return undefined;
       }
       if (!item?.list && item.children.length === 0) return undefined;
@@ -97,7 +89,6 @@ export const useMenu = (
         ? getToPath({
             resource: item,
             action: "list",
-            legacy: routerType === "legacy",
             meta,
           })
         : undefined;
@@ -112,20 +103,20 @@ export const useMenu = (
       return {
         ...item,
         route: composed,
-        icon: pickNotDeprecated(item.meta?.icon, item.options?.icon, item.icon),
+        icon: item.meta?.icon,
         label:
-          pickNotDeprecated(item?.meta?.label, item?.options?.label) ??
+          item?.meta?.label ??
           translate(
             `${item.name}.${item.name}`,
             getFriendlyName(item.name, "plural"),
           ),
       };
     },
-    [routerType, meta, getToPath, translate, hideOnMissingParameter],
+    [meta, getToPath, translate, hideOnMissingParameter],
   );
 
   const treeItems = React.useMemo(() => {
-    const treeMenuItems = createTree(resources, routerType === "legacy");
+    const treeMenuItems = createTree(resources);
 
     // add paths to items and their nodes recursively
     const prepare = (items: TreeMenuItem[]): TreeMenuItem[] => {
@@ -143,7 +134,7 @@ export const useMenu = (
     };
 
     return prepare(treeMenuItems);
-  }, [resources, routerType, prepareItem]);
+  }, [resources, prepareItem]);
 
   return {
     defaultOpenKeys,