refactor(core): allow passing optional check params to Authenticated …

.changeset/orange-eels-bake.md

@@ -0,0 +1,7 @@
+---
+"@refinedev/core": patch
+---
+
+refactor: modified the Authenticated component to receive optional params prop to be passed to the useIsAuthenticated hook.
+
+Fixes #6309

packages/core/src/components/authenticated/index.spec.tsx

@@ -606,4 +606,47 @@ describe("Authenticated", () => {
       ),
     );
   });
+
+  it("should not authenticate and redirect if params indicate failed authentication", async () => {
+    const mockGo = jest.fn();
+    const mockParams = { allowAuth: false }; // Parameter that simulates failed authentication
+
+    const { queryByText } = render(
+      <Authenticated key="auth-with-params" params={mockParams}>
+        Custom Authenticated
+      </Authenticated>,
+      {
+        wrapper: TestWrapper({
+          dataProvider: MockJSONServer,
+          authProvider: {
+            ...mockAuthProvider,
+            check: async ({ params }) => {
+              // Simulate failed authentication based on params
+              return params?.allowAuth
+                ? { authenticated: true }
+                : { authenticated: false, redirectTo: "/login" };
+            },
+          },
+          routerProvider: {
+            go: () => mockGo,
+          },
+          resources: [{ name: "posts", route: "posts" }],
+        }),
+      },
+    );
+
+    // Since requireAuth is false, the component should redirect to /login
+    await act(async () => {
+      expect(queryByText("Custom Authenticated")).toBeNull();
+    });
+
+    await waitFor(() =>
+      expect(mockGo).toBeCalledWith(
+        expect.objectContaining({
+          to: "/login",
+          type: "replace",
+        }),
+      ),
+    );
+  });
 });

packages/core/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.
@@ -47,6 +49,10 @@ export type AuthenticatedCommonProps = {
    * Content to show if user is logged in
    */
   children?: React.ReactNode;
+  /**
+   * optional params to pass to the auth check 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
@@ -158,8 +166,8 @@ export function Authenticated({
       ? redirectOnFail
       : "/login"
     : typeof redirectOnFail === "string"
-      ? redirectOnFail
-      : (authenticatedRedirect as string | undefined);
+    ? redirectOnFail
+    : (authenticatedRedirect as string | undefined);
 
   // Current pathname to append to the redirect url.
   // User will be redirected to this url after successful mutation. (like login)