@refinedev/core 4.58.0 → 5.0.1

package/src/components/pages/auth/components/register/index.tsx

@@ -1,14 +1,6 @@
 import React, { useState } from "react";
 
-import {
-  useLink,
-  useRegister,
-  useRouterContext,
-  useRouterType,
-  useTranslate,
-} from "@hooks";
-
-import { useActiveAuthProvider } from "@definitions/helpers";
+import { useLink, useRegister, useTranslate } from "@hooks";
 
 import type { DivPropsType, FormPropsType } from "../..";
 import type { RegisterPageProps } from "../../types";
@@ -30,24 +22,17 @@ export const RegisterPage: React.FC<RegisterProps> = ({
   hideForm,
   mutationVariables,
 }) => {
-  const routerType = useRouterType();
   const Link = useLink();
-  const { Link: LegacyLink } = useRouterContext();
-
-  const ActiveLink = routerType === "legacy" ? LegacyLink : Link;
 
   const [email, setEmail] = useState("");
   const [password, setPassword] = useState("");
 
   const translate = useTranslate();
 
-  const authProvider = useActiveAuthProvider();
-  const { mutate: register, isLoading } = useRegister({
-    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-  });
+  const { mutate: register, isPending } = useRegister();
 
   const renderLink = (link: string, text?: string) => {
-    return <ActiveLink to={link}>{text}</ActiveLink>;
+    return <Link to={link}>{text}</Link>;
   };
 
   const renderProviders = () => {
@@ -136,7 +121,7 @@ export const RegisterPage: React.FC<RegisterProps> = ({
               <input
                 type="submit"
                 value={translate("pages.register.buttons.submit", "Sign up")}
-                disabled={isLoading}
+                disabled={isPending}
               />
               {loginLink ?? (
                 <>

package/src/components/pages/auth/components/updatePassword/index.tsx

@@ -26,10 +26,8 @@ export const UpdatePasswordPage: React.FC<UpdatePasswordProps> = ({
   const translate = useTranslate();
 
   const authProvider = useActiveAuthProvider();
-  const { mutate: updatePassword, isLoading } =
-    useUpdatePassword<UpdatePasswordFormTypes>({
-      v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-    });
+  const { mutate: updatePassword, isPending } =
+    useUpdatePassword<UpdatePasswordFormTypes>();
 
   const [newPassword, setNewPassword] = useState("");
   const [confirmPassword, setConfirmPassword] = useState("");
@@ -87,7 +85,7 @@ export const UpdatePasswordPage: React.FC<UpdatePasswordProps> = ({
           />
           <input
             type="submit"
-            disabled={isLoading}
+            disabled={isPending}
             value={translate("pages.updatePassword.buttons.submit", "Update")}
           />
         </div>

package/src/components/pages/error/index.tsx

@@ -1,12 +1,6 @@
 import React, { useEffect, useState } from "react";
 
-import {
-  useNavigation,
-  useTranslate,
-  useResource,
-  useGo,
-  useRouterType,
-} from "@hooks";
+import { useTranslate, useGo, useResourceParams } from "@hooks";
 
 /**
  * When the app is navigated to a non-existent route, refine shows a default error page.
@@ -17,11 +11,9 @@ import {
 export const ErrorComponent: React.FC = () => {
   const [errorMessage, setErrorMessage] = useState<string>();
   const translate = useTranslate();
-  const { push } = useNavigation();
   const go = useGo();
-  const routerType = useRouterType();
 
-  const { resource, action } = useResource();
+  const { action, resource } = useResourceParams();
 
   useEffect(() => {
     if (resource && action) {
@@ -50,11 +42,7 @@ export const ErrorComponent: React.FC = () => {
       {errorMessage && <p>{errorMessage}</p>}
       <button
         onClick={() => {
-          if (routerType === "legacy") {
-            push("/");
-          } else {
-            go({ to: "/" });
-          }
+          go({ to: "/" });
         }}
       >
         {translate("pages.error.backHome", undefined, "Back Home")}

package/src/components/pages/index.tsx

@@ -1,7 +1,5 @@
 export { ErrorComponent } from "./error";
-export { LoginPage } from "./login";
 export { AuthPage } from "./auth";
-export { ReadyPage } from "./ready";
 export { WelcomePage } from "./welcome";
 
 export type { AuthProps } from "./auth";

package/src/components/routeChangeHandler/index.tsx

@@ -1,16 +1,16 @@
-import { useEffect } from "react";
-import { useRouterContext } from "@hooks";
-import { useLegacyAuthContext } from "@contexts/auth";
+import { useEffect, useContext } from "react";
+import { useActiveAuthProvider } from "@definitions/index";
+import { RouterContext } from "../../contexts/router";
 
 export const RouteChangeHandler: React.FC = () => {
-  const { useLocation } = useRouterContext();
-
-  const { checkAuth } = useLegacyAuthContext();
-  const location = useLocation();
+  const routerContext = useContext(RouterContext);
+  const authProvider = useActiveAuthProvider();
+  const parse = routerContext.parse?.();
+  const pathname = parse?.()?.pathname || "";
 
   useEffect(() => {
-    checkAuth?.().catch(() => false);
-  }, [location?.pathname]);
+    authProvider?.check?.().catch(() => false);
+  }, [pathname]);
 
   return null;
 };

package/src/contexts/accessControl/index.tsx

@@ -5,9 +5,6 @@ import type {
   IAccessControlContextReturnType,
 } from "./types";
 
-/** @deprecated default value for access control context has no use and is an empty object. */
-export const defaultAccessControlContext = {} as IAccessControlContext;
-
 export const AccessControlContext =
   React.createContext<IAccessControlContextReturnType>({
     options: {

package/src/contexts/accessControl/types.ts

@@ -1,27 +1,13 @@
-/**
- * @author aliemir
- *
- * `AccessControlProvider` interface, used to define the access control bindings of refine.
- *
- * Currently, there's no change in the interface, but only in the `params.resource` property.
- *
- * This also had `{ children?: ITreeMenu[] }` type extension but we can remove it now.
- *
- * There's an error behind this extension, since we're using `Tanstack Query` to check the `can` function,
- * params are stringified and Nodes can't be stringified properly, which throws an error.
- *
- * These kinds of errors should be handled by the user of the `can` function, not by the `can` function itself.
- *
- * In this case, its the `CanAccess` component, which wraps the `can` function and is used in the `Sider` components.
- * `Sider` should sanitize the `params.resource` property and remove the `children` property (if exists).
- *
- * This may also apply to `resource.icon` property.
- *
- */
 import type { UseQueryOptions } from "@tanstack/react-query";
 
 import type { BaseKey } from "../data/types";
-import type { IResourceItem, ITreeMenu } from "../resource/types";
+import type { IResourceItem } from "../resource/types";
+import type { MakeOptional } from "../../definitions/types/index";
+
+type ITreeResource = IResourceItem & {
+  key?: string;
+  children: ITreeResource[];
+};
 
 export type CanResponse = {
   can: boolean;
@@ -46,7 +32,7 @@ export type CanParams = {
    * }
    */
   params?: {
-    resource?: IResourceItem & { children?: ITreeMenu[] };
+    resource?: IResourceItem & { children?: ITreeResource[] };
     id?: BaseKey;
     [key: string]: any;
   };
@@ -68,7 +54,10 @@ type AccessControlOptions = {
     enableAccessControl?: boolean;
     hideIfUnauthorized?: boolean;
   };
-  queryOptions?: UseQueryOptions<CanReturnType>;
+  queryOptions?: MakeOptional<
+    UseQueryOptions<CanReturnType>,
+    "queryFn" | "queryKey"
+  >;
 };
 
 export interface IAccessControlContext {
@@ -83,7 +72,10 @@ export type IAccessControlContextReturnType = {
       enableAccessControl: boolean;
       hideIfUnauthorized: boolean;
     };
-    queryOptions?: UseQueryOptions<CanReturnType>;
+    queryOptions?: MakeOptional<
+      UseQueryOptions<CanReturnType>,
+      "queryFn" | "queryKey"
+    >;
   };
 };
 

package/src/contexts/auditLog/types.ts

@@ -1,4 +1,4 @@
-import type { BaseKey, MetaDataQuery } from "../data/types";
+import type { BaseKey } from "../data/types";
 
 export type ILog<TData = any> = {
   id: BaseKey;
@@ -33,7 +33,6 @@ export type IAuditLogContext = {
     action?: string;
     meta?: Record<number | string, any>;
     author?: Record<number | string, any>;
-    metaData?: MetaDataQuery;
   }) => Promise<any>;
   update?: (params: {
     id: BaseKey;

package/src/contexts/auth/index.tsx

@@ -1,91 +1,17 @@
 import React, { type PropsWithChildren } from "react";
 
-import { useNavigation } from "@hooks";
+import type { IAuthContext } from "./types";
 
-import type { IAuthContext, ILegacyAuthContext } from "./types";
-
-/**
- * @deprecated `LegacyAuthContext` is deprecated with refine@4, use `AuthBindingsContext` instead, however, we still support `LegacyAuthContext` for backward compatibility.
- */
-export const LegacyAuthContext = React.createContext<ILegacyAuthContext>({});
-
-/**
- * @deprecated `LegacyAuthContextProvider` is deprecated with refine@4, use `AuthBindingsContextProvider` instead, however, we still support `LegacyAuthContextProvider` for backward compatibility.
- */
-export const LegacyAuthContextProvider: React.FC<
-  PropsWithChildren<ILegacyAuthContext>
-> = ({ children, isProvided, ...authOperations }) => {
-  const { replace } = useNavigation();
-
-  const loginFunc = async (params: any) => {
-    try {
-      const result = await authOperations.login?.(params);
-
-      return result;
-    } catch (error) {
-      return Promise.reject(error);
-    }
-  };
-
-  const registerFunc = async (params: any) => {
-    try {
-      const result = await authOperations.register?.(params);
-
-      return result;
-    } catch (error) {
-      return Promise.reject(error);
-    }
-  };
-
-  const logoutFunc = async (params: any) => {
-    try {
-      const redirectPath = await authOperations.logout?.(params);
-
-      return redirectPath;
-    } catch (error) {
-      return Promise.reject(error);
-    }
-  };
-
-  const checkAuthFunc = async (params: any) => {
-    try {
-      await authOperations.checkAuth?.(params);
-      return Promise.resolve();
-    } catch (error) {
-      if ((error as { redirectPath?: string })?.redirectPath) {
-        replace((error as { redirectPath: string }).redirectPath);
-      }
-
-      return Promise.reject(error);
-    }
-  };
-
-  return (
-    <LegacyAuthContext.Provider
-      value={{
-        ...authOperations,
-        login: loginFunc,
-        logout: logoutFunc,
-        checkAuth: checkAuthFunc,
-        register: registerFunc,
-        isProvided,
-      }}
-    >
-      {children}
-    </LegacyAuthContext.Provider>
-  );
-};
-
-export const AuthBindingsContext = React.createContext<Partial<IAuthContext>>(
+export const AuthProviderContext = React.createContext<Partial<IAuthContext>>(
   {},
 );
 
-export const AuthBindingsContextProvider: React.FC<
+export const AuthProviderContextProvider: React.FC<
   PropsWithChildren<IAuthContext>
-> = ({ children, isProvided, ...authBindings }) => {
+> = ({ children, isProvided, ...authProvider }) => {
   const handleLogin = async (params: unknown) => {
     try {
-      const result = await authBindings.login?.(params);
+      const result = await authProvider.login?.(params);
 
       return result;
     } catch (error) {
@@ -99,7 +25,7 @@ export const AuthBindingsContextProvider: React.FC<
 
   const handleRegister = async (params: unknown) => {
     try {
-      const result = await authBindings.register?.(params);
+      const result = await authProvider.register?.(params);
 
       return result;
     } catch (error) {
@@ -113,7 +39,7 @@ export const AuthBindingsContextProvider: React.FC<
 
   const handleLogout = async (params: unknown) => {
     try {
-      const result = await authBindings.logout?.(params);
+      const result = await authProvider.logout?.(params);
 
       return result;
     } catch (error) {
@@ -127,7 +53,7 @@ export const AuthBindingsContextProvider: React.FC<
 
   const handleCheck = async (params: unknown) => {
     try {
-      const result = await authBindings.check?.(params);
+      const result = await authProvider.check?.(params);
 
       return Promise.resolve(result);
     } catch (error) {
@@ -141,7 +67,7 @@ export const AuthBindingsContextProvider: React.FC<
 
   const handleForgotPassword = async (params: unknown) => {
     try {
-      const result = await authBindings.forgotPassword?.(params);
+      const result = await authProvider.forgotPassword?.(params);
 
       return Promise.resolve(result);
     } catch (error) {
@@ -155,7 +81,7 @@ export const AuthBindingsContextProvider: React.FC<
 
   const handleUpdatePassword = async (params: unknown) => {
     try {
-      const result = await authBindings.updatePassword?.(params);
+      const result = await authProvider.updatePassword?.(params);
       return Promise.resolve(result);
     } catch (error) {
       console.warn(
@@ -167,9 +93,9 @@ export const AuthBindingsContextProvider: React.FC<
   };
 
   return (
-    <AuthBindingsContext.Provider
+    <AuthProviderContext.Provider
       value={{
-        ...authBindings,
+        ...authProvider,
         login: handleLogin as IAuthContext["login"],
         logout: handleLogout as IAuthContext["logout"],
         check: handleCheck as IAuthContext["check"],
@@ -180,21 +106,12 @@ export const AuthBindingsContextProvider: React.FC<
       }}
     >
       {children}
-    </AuthBindingsContext.Provider>
+    </AuthProviderContext.Provider>
   );
 };
 
-/**
- * @deprecated `useLegacyAuthContext` is deprecated with refine@4, use `useAuthBindingsContext` instead, however, we still support `useLegacyAuthContext` for backward compatibility.
- */
-export const useLegacyAuthContext = () => {
-  const context = React.useContext(LegacyAuthContext);
-
-  return context;
-};
-
-export const useAuthBindingsContext = () => {
-  const context = React.useContext(AuthBindingsContext);
+export const useAuthProviderContext = () => {
+  const context = React.useContext(AuthProviderContext);
 
   return context;
 };

package/src/contexts/auth/types.ts

@@ -77,11 +77,6 @@ export type AuthProvider = {
   getIdentity?: (params?: any) => Promise<IdentityResponse>;
 };
 
-/**
- * @deprecated use `AuthProvider` instead.
- */
-export type AuthBindings = AuthProvider;
-
 export interface IAuthContext extends Partial<AuthProvider> {
   isProvided: boolean;
 }
@@ -91,25 +86,3 @@ export type TLoginData = void | false | string | object;
 export type TRegisterData = void | false | string;
 export type TForgotPasswordData = void | false | string;
 export type TUpdatePasswordData = void | false | string;
-
-/**
- * @deprecated `LegacyAuthProvider` is deprecated with refine@4, use `AuthProvider` instead, however, we still support `LegacyAuthProvider` for backward compatibility.
- */
-export interface LegacyAuthProvider {
-  login: (params: any) => Promise<TLoginData>;
-  register?: (params: any) => Promise<TRegisterData>;
-  forgotPassword?: (params: any) => Promise<TForgotPasswordData>;
-  updatePassword?: (params: any) => Promise<TUpdatePasswordData>;
-  logout: (params: any) => Promise<TLogoutData>;
-  checkAuth: (params?: any) => Promise<any>;
-  checkError: (error: any) => Promise<void>;
-  getPermissions?: (params?: Record<string, any>) => Promise<any>;
-  getUserIdentity?: (params?: any) => Promise<any>;
-}
-
-/**
- * @deprecated `ILegacyAuthContext` is deprecated with refine@4, use `IAuthContext` instead, however, we still support `ILegacyAuthContext` for backward compatibility.
- */
-export interface ILegacyAuthContext extends Partial<LegacyAuthProvider> {
-  isProvided?: boolean;
-}

package/src/contexts/data/types.ts

@@ -1,8 +1,6 @@
 import type { QueryFunctionContext, QueryKey } from "@tanstack/react-query";
 import type { DocumentNode } from "graphql";
 
-import type { UseListConfig } from "../../hooks/data/useList";
-
 export type Prettify<T> = {
   [K in keyof T]: T[K];
 } & {};
@@ -17,11 +15,6 @@ export type BaseOption = {
   value: any;
 };
 
-/**
- * @deprecated Use `BaseOption` instead.
- */
-export interface Option extends BaseOption {}
-
 export type NestedField = {
   operation: string;
   variables: QueryBuilderOptions[];
@@ -181,7 +174,7 @@ export interface Pagination {
    * Initial page index
    * @default 1
    */
-  current?: number;
+  currentPage?: number;
   /**
    * Initial number of items per page
    * @default 10
@@ -194,20 +187,11 @@ export interface Pagination {
   mode?: "client" | "server" | "off";
 }
 
-/**
- * @deprecated `MetaDataQuery` is deprecated with refine@4, use `MetaQuery` instead, however, we still support `MetaDataQuery` for backward compatibility.
- */
-export type MetaDataQuery = {
-  [k: string]: any;
-  queryContext?: Omit<QueryFunctionContext, "meta">;
-} & QueryBuilderOptions;
-
 export interface IQueryKeys {
   all: QueryKey;
   resourceAll: QueryKey;
   list: (
     config?:
-      | UseListConfig
       | {
           pagination?: Required<Pagination>;
           hasPagination?: boolean;
@@ -247,10 +231,6 @@ export type PreviousQuery<TData> = [QueryKey, TData | unknown];
 
 export type PrevContext<TData> = {
   previousQueries: PreviousQuery<TData>[];
-  /**
-   * @deprecated `QueryKeys` is deprecated in favor of `keys`. Please use `keys` instead to construct query keys for queries and mutations.
-   */
-  queryKey: IQueryKeys;
 };
 
 export type Context = {
@@ -384,21 +364,9 @@ export interface DeleteManyResponse<TData = BaseRecord> {
 export interface GetListParams {
   resource: string;
   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[];
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   dataProviderName?: string;
 }
 
@@ -406,10 +374,6 @@ export interface GetManyParams {
   resource: string;
   ids: BaseKey[];
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   dataProviderName?: string;
 }
 
@@ -417,30 +381,18 @@ export interface GetOneParams {
   resource: string;
   id: BaseKey;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface CreateParams<TVariables = {}> {
   resource: string;
   variables: TVariables;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface CreateManyParams<TVariables = {}> {
   resource: string;
   variables: TVariables[];
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface UpdateParams<TVariables = {}> {
@@ -448,10 +400,6 @@ export interface UpdateParams<TVariables = {}> {
   id: BaseKey;
   variables: TVariables;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface UpdateManyParams<TVariables = {}> {
@@ -459,10 +407,6 @@ export interface UpdateManyParams<TVariables = {}> {
   ids: BaseKey[];
   variables: TVariables;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface DeleteOneParams<TVariables = {}> {
@@ -470,10 +414,6 @@ export interface DeleteOneParams<TVariables = {}> {
   id: BaseKey;
   variables?: TVariables;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface DeleteManyParams<TVariables = {}> {
@@ -481,29 +421,17 @@ export interface DeleteManyParams<TVariables = {}> {
   ids: BaseKey[];
   variables?: TVariables;
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export interface CustomParams<TQuery = unknown, TPayload = unknown> {
   url: string;
   method: "get" | "delete" | "head" | "options" | "post" | "put" | "patch";
-  /**
-   * @deprecated `sort` is deprecated, use `sorters` instead.
-   */
-  sort?: CrudSort[];
   sorters?: CrudSort[];
   filters?: CrudFilter[];
   payload?: TPayload;
   query?: TQuery;
   headers?: {};
   meta?: MetaQuery;
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
 }
 
 export type DataProvider = {

package/src/contexts/i18n/index.tsx

@@ -1,9 +1,6 @@
 import React, { type PropsWithChildren } from "react";
 
-import type { I18nProvider, II18nContext } from "./types";
-
-/** @deprecated default value for translation context has no use and is an empty object.  */
-export const defaultProvider: Partial<I18nProvider> = {};
+import type { II18nContext } from "./types";
 
 export const I18nContext = React.createContext<II18nContext>({});