@refinedev/core 4.58.0 → 5.0.1

package/src/hooks/navigation/index.ts

@@ -1,13 +1,11 @@
-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 { useResourceParams } from "@hooks";
 import { useGo } from "@hooks/router/use-go";
 import { useParsed } from "@hooks/router/use-parsed";
 
-import type { BaseKey, MetaDataQuery } from "../../contexts/data/types";
+import type { BaseKey, MetaQuery } from "../../contexts/data/types";
 import type { IResourceItem } from "../../contexts/resource/types";
 
 export type HistoryType = "push" | "replace";
@@ -22,52 +20,18 @@ export type HistoryType = "push" | "replace";
  * @see {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation} for more details.
  */
 export const useNavigation = () => {
-  const { resources } = useResource();
-  const routerType = useRouterType();
-  const { useHistory } = useRouterContext();
-  const history = useHistory();
+  const { resources } = useResourceParams();
   const parsed = useParsed();
   const go = useGo();
-  const back = useBack();
 
   const handleUrl = (url: string, type: HistoryType = "push") => {
-    if (routerType === "legacy") {
-      history[type](url);
-    } else {
-      go({ to: url, type });
-    }
+    go({ to: url, type });
   };
 
   const createUrl = (
     resource: string | IResourceItem,
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
-    if (routerType === "legacy") {
-      const resourceItem =
-        typeof resource === "string"
-          ? pickResource(resource, resources, true) ?? {
-              name: resource,
-              route: resource,
-            }
-          : resource;
-
-      const createActionRoute = getActionRoutesFromResource(
-        resourceItem,
-        resources,
-        true,
-      ).find((r) => r.action === "create");
-
-      if (!createActionRoute) {
-        return "";
-      }
-
-      return composeRoute(
-        createActionRoute.route,
-        resourceItem?.meta,
-        parsed,
-        meta,
-      );
-    }
     const resourceItem =
       typeof resource === "string"
         ? pickResource(resource, resources) ?? { name: resource }
@@ -92,33 +56,9 @@ export const useNavigation = () => {
   const editUrl = (
     resource: string | IResourceItem,
     id: BaseKey,
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     const encodedId = encodeURIComponent(id);
-    if (routerType === "legacy") {
-      const resourceItem =
-        typeof resource === "string"
-          ? pickResource(resource, resources, true) ?? {
-              name: resource,
-              route: resource,
-            }
-          : resource;
-
-      const editActionRoute = getActionRoutesFromResource(
-        resourceItem,
-        resources,
-        true,
-      ).find((r) => r.action === "edit");
-
-      if (!editActionRoute) {
-        return "";
-      }
-
-      return composeRoute(editActionRoute.route, resourceItem?.meta, parsed, {
-        ...meta,
-        id: encodedId,
-      });
-    }
     const resourceItem =
       typeof resource === "string"
         ? pickResource(resource, resources) ?? { name: resource }
@@ -146,34 +86,9 @@ export const useNavigation = () => {
   const cloneUrl = (
     resource: string | IResourceItem,
     id: BaseKey,
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     const encodedId = encodeURIComponent(id);
-
-    if (routerType === "legacy") {
-      const resourceItem =
-        typeof resource === "string"
-          ? pickResource(resource, resources, true) ?? {
-              name: resource,
-              route: resource,
-            }
-          : resource;
-
-      const cloneActionRoute = getActionRoutesFromResource(
-        resourceItem,
-        resources,
-        true,
-      ).find((r) => r.action === "clone");
-
-      if (!cloneActionRoute) {
-        return "";
-      }
-
-      return composeRoute(cloneActionRoute.route, resourceItem?.meta, parsed, {
-        ...meta,
-        id: encodedId,
-      });
-    }
     const resourceItem =
       typeof resource === "string"
         ? pickResource(resource, resources) ?? { name: resource }
@@ -201,33 +116,9 @@ export const useNavigation = () => {
   const showUrl = (
     resource: string | IResourceItem,
     id: BaseKey,
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     const encodedId = encodeURIComponent(id);
-    if (routerType === "legacy") {
-      const resourceItem =
-        typeof resource === "string"
-          ? pickResource(resource, resources, true) ?? {
-              name: resource,
-              route: resource,
-            }
-          : resource;
-
-      const showActionRoute = getActionRoutesFromResource(
-        resourceItem,
-        resources,
-        true,
-      ).find((r) => r.action === "show");
-
-      if (!showActionRoute) {
-        return "";
-      }
-
-      return composeRoute(showActionRoute.route, resourceItem?.meta, parsed, {
-        ...meta,
-        id: encodedId,
-      });
-    }
     const resourceItem =
       typeof resource === "string"
         ? pickResource(resource, resources) ?? { name: resource }
@@ -252,36 +143,7 @@ export const useNavigation = () => {
     }) as string;
   };
 
-  const listUrl = (
-    resource: string | IResourceItem,
-    meta: MetaDataQuery = {},
-  ) => {
-    if (routerType === "legacy") {
-      const resourceItem =
-        typeof resource === "string"
-          ? pickResource(resource, resources, true) ?? {
-              name: resource,
-              route: resource,
-            }
-          : resource;
-
-      const listActionRoute = getActionRoutesFromResource(
-        resourceItem,
-        resources,
-        true,
-      ).find((r) => r.action === "list");
-
-      if (!listActionRoute) {
-        return "";
-      }
-
-      return composeRoute(
-        listActionRoute.route,
-        resourceItem?.meta,
-        parsed,
-        meta,
-      );
-    }
+  const listUrl = (resource: string | IResourceItem, meta: MetaQuery = {}) => {
     const resourceItem =
       typeof resource === "string"
         ? pickResource(resource, resources) ?? { name: resource }
@@ -306,7 +168,7 @@ export const useNavigation = () => {
   const create = (
     resource: string | IResourceItem,
     type: HistoryType = "push",
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     handleUrl(createUrl(resource, meta), type);
   };
@@ -315,7 +177,7 @@ export const useNavigation = () => {
     resource: string | IResourceItem,
     id: BaseKey,
     type: HistoryType = "push",
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     handleUrl(editUrl(resource, id, meta), type);
   };
@@ -324,7 +186,7 @@ export const useNavigation = () => {
     resource: string | IResourceItem,
     id: BaseKey,
     type: HistoryType = "push",
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     handleUrl(cloneUrl(resource, id, meta), type);
   };
@@ -333,7 +195,7 @@ export const useNavigation = () => {
     resource: string | IResourceItem,
     id: BaseKey,
     type: HistoryType = "push",
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     handleUrl(showUrl(resource, id, meta), type);
   };
@@ -341,44 +203,11 @@ export const useNavigation = () => {
   const list = (
     resource: string | IResourceItem,
     type: HistoryType = "push",
-    meta: MetaDataQuery = {},
+    meta: MetaQuery = {},
   ) => {
     handleUrl(listUrl(resource, meta), type);
   };
 
-  /**
-   * @deprecated Please use `useGo` hook instead.
-   */
-  const push = (path: string, ...rest: unknown[]) => {
-    if (routerType === "legacy") {
-      history.push(path, ...rest);
-    } else {
-      go({ to: path, type: "push" });
-    }
-  };
-
-  /**
-   * @deprecated Please use `useGo` hook instead.
-   */
-  const replace = (path: string, ...rest: unknown[]) => {
-    if (routerType === "legacy") {
-      history.replace(path, ...rest);
-    } else {
-      go({ to: path, type: "replace" });
-    }
-  };
-
-  /**
-   * @deprecated Please use `useBack` hook instead.
-   */
-  const goBack = () => {
-    if (routerType === "legacy") {
-      history.goBack();
-    } else {
-      back();
-    }
-  };
-
   return {
     create,
     createUrl,
@@ -390,8 +219,5 @@ export const useNavigation = () => {
     showUrl,
     list,
     listUrl,
-    push,
-    replace,
-    goBack,
   };
 };

package/src/hooks/redirection/index.ts

@@ -2,7 +2,7 @@ import { useCallback } from "react";
 
 import { useNavigation } from "@hooks";
 
-import type { BaseKey, MetaDataQuery } from "../../contexts/data/types";
+import type { BaseKey, MetaQuery } from "../../contexts/data/types";
 import type { IResourceItem } from "../../contexts/resource/types";
 import type { RedirectAction } from "../form/types";
 
@@ -10,7 +10,7 @@ export type UseRedirectionAfterSubmissionType = () => (options: {
   redirect: RedirectAction;
   resource?: IResourceItem;
   id?: BaseKey;
-  meta?: MetaDataQuery;
+  meta?: MetaQuery;
 }) => void;
 
 export const useRedirectionAfterSubmission: UseRedirectionAfterSubmissionType =
@@ -27,7 +27,7 @@ export const useRedirectionAfterSubmission: UseRedirectionAfterSubmissionType =
         redirect: RedirectAction;
         resource?: IResourceItem;
         id?: BaseKey;
-        meta?: MetaDataQuery;
+        meta?: MetaQuery;
       }) => {
         if (redirect && resource) {
           if (!!resource.show && redirect === "show" && id) {

package/src/hooks/refine/index.ts

@@ -1,5 +1,4 @@
 export { useMutationMode } from "./useMutationMode";
 export { useWarnAboutChange } from "./useWarnAboutChange";
 export { useSyncWithLocation } from "./useSyncWithLocation";
-export { useTitle } from "./useTitle";
 export { useRefineContext } from "./useRefineContext";

package/src/hooks/refine/useRefineContext.ts

@@ -4,40 +4,24 @@ import { RefineContext } from "@contexts/refine";
 
 export const useRefineContext = () => {
   const {
-    Footer,
-    Header,
-    Layout,
-    OffLayoutArea,
-    Sider,
-    Title,
-    hasDashboard,
     mutationMode,
     syncWithLocation,
     undoableTimeout,
     warnWhenUnsavedChanges,
-    DashboardPage,
-    LoginPage,
-    catchAll,
+    liveMode,
+    onLiveEvent,
     options,
     __initialized,
   } = useContext(RefineContext);
 
   return {
     __initialized,
-    Footer,
-    Header,
-    Layout,
-    OffLayoutArea,
-    Sider,
-    Title,
-    hasDashboard,
     mutationMode,
     syncWithLocation,
     undoableTimeout,
     warnWhenUnsavedChanges,
-    DashboardPage,
-    LoginPage,
-    catchAll,
+    liveMode,
+    onLiveEvent,
     options,
   };
 };

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

@@ -1,18 +1,16 @@
 import React from "react";
 
 import type { IResourceItem } from "../../../contexts/resource/types";
-import { useRouterType } from "../../../contexts/router/picker";
 import type { Action } from "../../../contexts/router/types";
 import { getActionRoutesFromResource } from "../../../definitions/helpers/router";
 import { composeRoute } from "../../../definitions/helpers/router/compose-route";
-import { useResource } from "../../resource";
+import { useResourceParams } from "../../use-resource-params";
 import { useParsed } from "../use-parsed";
 
 type UseToPathParams = {
   resource?: IResourceItem;
   action: Action;
   meta?: Record<string, unknown>;
-  legacy?: boolean;
 };
 
 type GetToPathFn = (params: UseToPathParams) => string | undefined;
@@ -25,8 +23,7 @@ type GetToPathFn = (params: UseToPathParams) => string | undefined;
  * `meta` can be provided to compose the routes with parameters. (Can be used for nested routes.)
  */
 export const useGetToPath = (): GetToPathFn => {
-  const routerType = useRouterType();
-  const { resource: resourceFromRoute, resources } = useResource();
+  const { resource: resourceFromRoute, resources } = useResourceParams();
   const parsed = useParsed();
 
   const fn = React.useCallback(
@@ -40,7 +37,6 @@ export const useGetToPath = (): GetToPathFn => {
       const actionRoutes = getActionRoutesFromResource(
         selectedResource,
         resources,
-        routerType === "legacy",
       );
 
       const actionRoute = actionRoutes.find(

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

@@ -1,7 +1,7 @@
 import React, { useCallback, useContext } from "react";
 
 import { RouterContext } from "@contexts/router";
-import { useResource } from "@hooks/resource";
+import { useResourceParams } from "@hooks/use-resource-params";
 
 import type { BaseKey } from "../../../contexts/data/types";
 import type { IResourceItem } from "../../../contexts/resource/types";
@@ -39,7 +39,7 @@ export type GoConfigWithResource = Omit<GoConfigBase, "to"> & {
 
 export const useGo = () => {
   const routerContext = useContext(RouterContext);
-  const { select: resourceSelect } = useResource();
+  const { select: resourceSelect } = useResourceParams();
   const getToPath = useGetToPath();
 
   const useGo = React.useMemo(

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

@@ -6,7 +6,6 @@ type UseToPathParams = {
   resource?: IResourceItem;
   action: Action;
   meta?: Record<string, unknown>;
-  legacy?: boolean;
 };
 
 /**
@@ -20,9 +19,8 @@ export const useToPath = ({
   resource,
   action,
   meta,
-  legacy,
 }: UseToPathParams): string | undefined => {
   const getToPath = useGetToPath();
 
-  return getToPath({ resource, action, meta, legacy });
+  return getToPath({ resource, action, meta });
 };

package/src/hooks/show/index.ts

@@ -1,6 +1,5 @@
 import warnOnce from "warn-once";
 import { useMeta, useOne, useResourceParams } from "@hooks";
-import { pickNotDeprecated } from "@definitions/helpers";
 
 import type { UseShowProps, UseShowReturnType } from "./types";
 import type { BaseKey, BaseRecord, HttpError } from "../../contexts/data/types";
@@ -8,8 +7,6 @@ import type { BaseKey, BaseRecord, HttpError } from "../../contexts/data/types";
 export type {
   UseShowProps,
   UseShowReturnType,
-  useShowProps,
-  useShowReturnType,
 } from "./types";
 
 /**
@@ -32,7 +29,6 @@ export const useShow = <
   resource: resourceFromProp,
   id,
   meta,
-  metaData,
   queryOptions,
   overtimeOptions,
   ...useOneProps
@@ -54,7 +50,7 @@ export const useShow = <
 
   const combinedMeta = getMeta({
     resource,
-    meta: pickNotDeprecated(meta, metaData),
+    meta: meta,
   });
 
   warnOnce(
@@ -70,14 +66,13 @@ export const useShow = <
       ...queryOptions,
     },
     meta: combinedMeta,
-    metaData: combinedMeta,
     overtimeOptions,
     ...useOneProps,
   });
 
   return {
-    queryResult,
-    query: queryResult,
+    query: queryResult.query,
+    result: queryResult.result,
     showId,
     setShowId,
     overtime: queryResult.overtime,

package/src/hooks/show/types.ts

@@ -19,16 +19,14 @@ import type {
 } from "../../contexts/data/types";
 import type { LiveModeProps } from "../../contexts/live/types";
 import type { SuccessErrorNotification } from "../../contexts/notification/types";
+import type { MakeOptional } from "../../definitions/types";
 
 export type UseShowReturnType<
   TData extends BaseRecord = BaseRecord,
   TError extends HttpError = HttpError,
 > = {
   query: QueryObserverResult<GetOneResponse<TData>, TError>;
-  /**
-   * @deprecated Use `query` instead.
-   */
-  queryResult: QueryObserverResult<GetOneResponse<TData>, TError>;
+  result: TData | undefined;
   showId?: BaseKey;
   setShowId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
 } & UseLoadingOvertimeReturnType;
@@ -51,10 +49,13 @@ export type UseShowProps<
   /**
    * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
    */
-  queryOptions?: UseQueryOptions<
-    GetOneResponse<TQueryFnData>,
-    TError,
-    GetOneResponse<TData>
+  queryOptions?: MakeOptional<
+    UseQueryOptions<
+      GetOneResponse<TQueryFnData>,
+      TError,
+      GetOneResponse<TData>
+    >,
+    "queryKey" | "queryFn"
   >;
   /**
    * Additional meta data to pass to the data provider's `getOne`
@@ -62,9 +63,6 @@ export type UseShowProps<
   meta?: MetaQuery;
   /**
    * Additional meta data to pass to the data provider's `getOne`
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    * Target data provider name for API call to be made
    * @default `"default"`
@@ -77,20 +75,3 @@ export type UseShowProps<
     Prettify<{ id?: BaseKey } & MetaQuery>
   > &
   UseLoadingOvertimeOptionsProps;
-
-/**
- * @deprecated use `UseShowReturnType` instead
- */
-export type useShowReturnType<
-  TData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-> = UseShowReturnType<TData, TError>;
-
-/**
- * @deprecated use `UseShowProps` instead
- */
-export type useShowProps<
-  TQueryFnData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-  TData extends BaseRecord = TQueryFnData,
-> = UseShowProps<TQueryFnData, TError, TData>;

package/src/hooks/use-resource-params/index.ts

@@ -1,12 +1,13 @@
-import React from "react";
+import React, { useContext } from "react";
 
+import { ResourceContext } from "@contexts/resource";
 import { useId } from "./use-id";
 import { useAction } from "./use-action";
-import { useResource } from "../resource";
 import type { BaseKey } from "../../contexts/data/types";
 import type { IResourceItem } from "../../contexts/resource/types";
 import type { Action } from "../../contexts/router/types";
 import type { FormAction } from "../form/types";
+import { type SelectReturnType, useResource } from "./use-resource";
 
 type Props = {
   id?: BaseKey;
@@ -18,9 +19,14 @@ type ResourceParams = {
   id?: BaseKey;
   setId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
   resource?: IResourceItem;
+  resources: IResourceItem[];
   action?: Action;
   identifier?: string;
   formAction: FormAction;
+  select: <T extends boolean = true>(
+    resourceName: string,
+    force?: T,
+  ) => SelectReturnType<T>;
 };
 
 /**
@@ -46,7 +52,13 @@ type ResourceParams = {
  * - Same as `id`, if passed resource is different from inferred resource, `formAction` will fallback to "create" and ignore the action from the route.
  */
 export function useResourceParams(props?: Props): ResourceParams {
-  const { select, identifier: inferredIdentifier } = useResource();
+  const { resources } = useContext(ResourceContext);
+
+  const {
+    select,
+    identifier: inferredIdentifier,
+    resource: inferredResource,
+  } = useResource();
   const resourceToCheck = props?.resource ?? inferredIdentifier;
   const { identifier = undefined, resource = undefined } = resourceToCheck
     ? select(resourceToCheck, true)
@@ -81,9 +93,11 @@ export function useResourceParams(props?: Props): ResourceParams {
   return {
     id,
     setId,
-    resource,
+    resource: resource || inferredResource,
+    resources,
     action,
     identifier,
     formAction,
+    select,
   };
 }

package/src/hooks/use-resource-params/use-action/index.tsx

@@ -1,27 +1,15 @@
 import { useParsed } from "../../router/use-parsed";
-import { useRouterContext } from "../../legacy-router/useRouterContext";
 import type { Action } from "../../../contexts/router/types";
-import { useRouterType } from "../../../contexts/router/picker";
-import type { ResourceRouterParams } from "../../../contexts/router/legacy/types";
 
 /**
- * Returns the action from the router regardless of the router type.
- * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
- * To make it easier to get the action from the router, this hook can be used.
+ * Returns the action from the router.
  *
  * Additionally, if an action is provided as a parameter, it will be used instead of the inferred action.
  *
  * @internal usage only
  */
 export const useAction = (action?: Action) => {
-  const routerType = useRouterType();
-  const { useParams } = useRouterContext();
-
   const parsed = useParsed();
-  const legacyParams = useParams<Partial<ResourceRouterParams>>();
-
-  const inferredAction =
-    routerType === "legacy" ? legacyParams.action : parsed.action;
 
-  return action ?? inferredAction;
+  return action ?? parsed.action;
 };

package/src/hooks/use-resource-params/use-id/index.tsx

@@ -1,26 +1,15 @@
 import { useParsed } from "../../router/use-parsed";
-import { useRouterContext } from "../../legacy-router/useRouterContext";
 import type { BaseKey } from "../../../contexts/data/types";
-import { useRouterType } from "../../../contexts/router/picker";
-import type { ResourceRouterParams } from "../../../contexts/router/legacy/types";
 
 /**
- * Returns the id from the router regardless of the router type.
- * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
- * To make it easier to get the id from the router, this hook can be used.
+ * Returns the id from the router.
  *
  * Additionally, if an id is provided as a parameter, it will be used instead of the inferred id.
  *
  * @internal usage only
  */
 export const useId = (id?: BaseKey) => {
-  const routerType = useRouterType();
-  const { useParams } = useRouterContext();
-
   const parsed = useParsed();
-  const legacyParams = useParams<Partial<ResourceRouterParams>>();
-
-  const inferredId = routerType === "legacy" ? legacyParams.id : parsed.id;
 
-  return id ?? inferredId;
+  return id ?? parsed.id;
 };