@refinedev/core 4.55.0 → 4.57.1

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@refinedev/core",
-  "version": "4.55.0",
+  "version": "4.57.1",
   "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/components/link/index.tsx

@@ -13,9 +13,7 @@ type LinkPropsWithTo = {
 };
 
 export type LinkProps<TProps = {}> = React.PropsWithChildren<
-  (LinkPropsWithGo | LinkPropsWithTo) &
-    React.AnchorHTMLAttributes<HTMLAnchorElement> &
-    TProps
+  (LinkPropsWithGo | LinkPropsWithTo) & TProps
 >;
 
 /**
@@ -25,7 +23,7 @@ export type LinkProps<TProps = {}> = React.PropsWithChildren<
  */
 const LinkComponent = <TProps = {}>(
   props: LinkProps<TProps>,
-  ref: Ref<HTMLAnchorElement>,
+  ref: Ref<Element>,
 ) => {
   const routerContext = useContext(RouterContext);
   const LinkFromContext = routerContext?.Link;
@@ -33,9 +31,6 @@ const LinkComponent = <TProps = {}>(
   const goFunction = useGo();
 
   let resolvedTo = "";
-  if ("to" in props) {
-    resolvedTo = props.to;
-  }
   if ("go" in props) {
     if (!routerContext?.go) {
       warnOnce(
@@ -45,6 +40,9 @@ const LinkComponent = <TProps = {}>(
     }
     resolvedTo = goFunction({ ...props.go, type: "path" }) as string;
   }
+  if ("to" in props) {
+    resolvedTo = props.to;
+  }
 
   if (LinkFromContext) {
     return (
@@ -70,5 +68,5 @@ const LinkComponent = <TProps = {}>(
 };
 
 export const Link = forwardRef(LinkComponent) as <T = {}>(
-  props: LinkProps<T> & { ref?: Ref<HTMLAnchorElement> },
+  props: LinkProps<T> & { ref?: Ref<Element> },
 ) => ReturnType<typeof LinkComponent>;

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

@@ -27,6 +27,7 @@ export const ForgotPasswordPage: React.FC<ForgotPasswordProps> = ({
   renderContent,
   formProps,
   title = undefined,
+  mutationVariables,
 }) => {
   const translate = useTranslate();
   const routerType = useRouterType();
@@ -53,7 +54,7 @@ export const ForgotPasswordPage: React.FC<ForgotPasswordProps> = ({
       <form
         onSubmit={(e) => {
           e.preventDefault();
-          forgotPassword({ email });
+          forgotPassword({ ...mutationVariables, email });
         }}
         {...formProps}
       >

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

@@ -25,6 +25,7 @@ export const LoginPage: React.FC<LoginProps> = ({
   formProps,
   title = undefined,
   hideForm,
+  mutationVariables,
 }) => {
   const routerType = useRouterType();
   const Link = useLink();
@@ -62,6 +63,7 @@ export const LoginPage: React.FC<LoginProps> = ({
           <button
             onClick={() =>
               login({
+                ...mutationVariables,
                 providerName: provider.name,
               })
             }
@@ -91,7 +93,7 @@ export const LoginPage: React.FC<LoginProps> = ({
           <form
             onSubmit={(e) => {
               e.preventDefault();
-              login({ email, password, remember });
+              login({ ...mutationVariables, email, password, remember });
             }}
             {...formProps}
           >

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

@@ -28,6 +28,7 @@ export const RegisterPage: React.FC<RegisterProps> = ({
   formProps,
   title = undefined,
   hideForm,
+  mutationVariables,
 }) => {
   const routerType = useRouterType();
   const Link = useLink();
@@ -64,6 +65,7 @@ export const RegisterPage: React.FC<RegisterProps> = ({
           <button
             onClick={() =>
               register({
+                ...mutationVariables,
                 providerName: provider.name,
               })
             }
@@ -93,7 +95,7 @@ export const RegisterPage: React.FC<RegisterProps> = ({
           <form
             onSubmit={(e) => {
               e.preventDefault();
-              register({ email, password });
+              register({ ...mutationVariables, email, password });
             }}
             {...formProps}
           >

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

@@ -21,6 +21,7 @@ export const UpdatePasswordPage: React.FC<UpdatePasswordProps> = ({
   renderContent,
   formProps,
   title = undefined,
+  mutationVariables,
 }) => {
   const translate = useTranslate();
 
@@ -43,6 +44,7 @@ export const UpdatePasswordPage: React.FC<UpdatePasswordProps> = ({
         onSubmit={(e) => {
           e.preventDefault();
           updatePassword({
+            ...mutationVariables,
             password: newPassword,
             confirmPassword,
           });

package/src/components/pages/auth/types.tsx

@@ -144,6 +144,10 @@ export type AuthPageProps<
    * @optional
    *  */
   title?: React.ReactNode;
+  /**
+   * @description Can be used to pass additional variables to the mutation. This is useful when you need to pass other variables to the authProvider.
+   */
+  mutationVariables?: Record<string, any>;
 };
 
 /**
@@ -167,6 +171,7 @@ export type LoginPageProps<
   formProps?: TFormProps;
   title?: React.ReactNode;
   hideForm?: boolean;
+  mutationVariables?: Record<string, unknown>;
 }>;
 
 /**
@@ -188,6 +193,7 @@ export type RegisterPageProps<
   formProps?: TFormProps;
   title?: React.ReactNode;
   hideForm?: boolean;
+  mutationVariables?: Record<string, unknown>;
 }>;
 
 /**
@@ -207,6 +213,7 @@ export type ForgotPasswordPageProps<
   contentProps?: TContentProps;
   formProps?: TFormProps;
   title?: React.ReactNode;
+  mutationVariables?: Record<string, unknown>;
 }>;
 
 /**
@@ -225,4 +232,5 @@ export type UpdatePasswordPageProps<
   contentProps?: TContentProps;
   formProps?: TFormProps;
   title?: React.ReactNode;
+  mutationVariables?: Record<string, unknown>;
 }>;

package/src/contexts/metaContext/index.tsx

@@ -0,0 +1,45 @@
+import React, {
+  type ReactNode,
+  createContext,
+  useContext,
+  useMemo,
+} from "react";
+
+type MetaContextValue = Record<string, any>;
+
+export const MetaContext = createContext<MetaContextValue>({});
+
+/**
+ * Is used to provide meta data to the children components.
+ * @internal
+ */
+export const MetaContextProvider = ({
+  children,
+  value,
+}: { children: ReactNode; value: MetaContextValue }) => {
+  const currentValue = useMetaContext();
+
+  const metaContext = useMemo(() => {
+    return {
+      ...currentValue,
+      ...value,
+    };
+  }, [currentValue, value]);
+
+  return (
+    <MetaContext.Provider value={metaContext}>{children}</MetaContext.Provider>
+  );
+};
+
+/**
+ * @internal
+ * @returns The MetaContext value.
+ */
+export const useMetaContext = () => {
+  const context = useContext(MetaContext);
+  if (!context) {
+    throw new Error("useMetaContext must be used within a MetaContextProvider");
+  }
+
+  return useContext(MetaContext);
+};

package/src/hooks/auth/index.ts

@@ -8,3 +8,4 @@ export { useUpdatePassword } from "./useUpdatePassword";
 export { useAuthenticated, useIsAuthenticated } from "./useIsAuthenticated";
 export { useCheckError, useOnError } from "./useOnError";
 export { useIsExistAuthentication } from "./useIsExistAuthentication";
+export { useInvalidateAuthStore } from "./useInvalidateAuthStore";

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;
 

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/useMeta/index.ts

@@ -1,3 +1,4 @@
+import { useMetaContext } from "@contexts/metaContext";
 import { sanitizeResource } from "@definitions/helpers/sanitize-resource";
 import { useParsed } from "@hooks/router";
 
@@ -6,12 +7,14 @@ import type { IResourceItem } from "../../contexts/resource/types";
 
 /**
  * Hook that returns a function to get meta.
- * The meta is a combination of the resource meta, hook meta and query params.
+ * The meta is a combination of the resource meta, hook meta, query params and metaContext value.
  * @internal
  */
 export const useMeta = () => {
   const { params } = useParsed();
 
+  const metaContext = useMetaContext();
+
   const getMetaFn = ({
     resource,
     meta: metaFromProp,
@@ -30,7 +33,18 @@ export const useMeta = () => {
       ...additionalParams
     } = params ?? {};
 
-    return { ...meta, ...additionalParams, ...metaFromProp };
+    const result: Record<string, unknown> = {
+      ...meta,
+      ...additionalParams,
+      ...metaFromProp,
+    };
+
+    // when MultiTenancyProvider from "@refinedev-ee/multi-tenancy" is provided, we need to add tenantId to the meta
+    if (metaContext?.tenantId) {
+      result["tenantId"] = metaContext.tenantId;
+    }
+
+    return result;
   };
 
   return getMetaFn;

package/src/index.tsx

@@ -224,3 +224,8 @@ export {
 } from "./contexts/undoableQueue/types.js";
 
 export { IUnsavedWarnContext } from "./contexts/unsavedWarn/types.js";
+
+export {
+  MetaContextProvider,
+  useMetaContext,
+} from "./contexts/metaContext/index.js";