@refinedev/core 4.47.2 → 4.49.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.47.2",
+  "version": "4.49.0",
   "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.",
   "repository": {
@@ -11,24 +11,39 @@
   "license": "MIT",
   "author": "refine",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "build": "tsup --format esm,cjs,iife --minify --legacy-output",
-    "dev": "tsup --watch --format esm,cjs,iife --legacy-output",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "prepare": "npm run build",
-    "test": "jest --passWithNoTests --runInBand"
+    "publint": "publint --strict=true --level=suggestion",
+    "test": "jest --passWithNoTests --runInBand",
+    "test:dev": "jest --silent --noStackTrace",
+    "types": "node ../shared/generate-declarations.js"
   },
   "dependencies": {
-    "@refinedev/devtools-internal": "1.1.5",
+    "@refinedev/devtools-internal": "1.1.7",
     "@tanstack/react-query": "^4.10.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
     "papaparse": "^5.3.0",
     "pluralize": "^8.0.0",
     "qs": "^6.10.1",
-    "tslib": "^2.3.1",
+    "tslib": "^2.6.2",
     "warn-once": "^0.1.0"
   },
   "devDependencies": {
@@ -50,9 +65,9 @@
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.3.1",
     "jest-environment-jsdom": "^29.3.1",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.1.2",
     "tsup": "^6.7.0",
-    "typescript": "^4.7.4"
+    "typescript": "^5.4.2"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^4.10.1",

package/refine.config.js

@@ -2,112 +2,107 @@ const { getImports, appendAfterImports } = require("@refinedev/cli");
 
 /** @type {import('@refinedev/cli').RefineConfig} */
 module.exports = {
-    group: "UI Framework",
-    swizzle: {
-        items: [
-            {
-                group: "Pages",
-                label: "ErrorPage",
-                message: `
+  group: "UI Framework",
+  swizzle: {
+    items: [
+      {
+        group: "Pages",
+        label: "ErrorPage",
+        message: `
                 **\`Info:\`**
                 If you want to see an example of error page in use, you can refer to the documentation at https://refine.dev/docs/packages/documentation/routers
                 `,
-                files: [
-                    {
-                        src: "./src/components/pages/error/index.tsx",
-                        dest: "./components/pages/error.tsx",
-                    },
-                ],
-            },
-            {
-                group: "Pages",
-                label: "AuthPage",
-                message: `
+        files: [
+          {
+            src: "./src/components/pages/error/index.tsx",
+            dest: "./components/pages/error.tsx",
+          },
+        ],
+      },
+      {
+        group: "Pages",
+        label: "AuthPage",
+        message: `
                 **\`Info:\`**
                 If you want to see examples of authentication pages in use, you can refer to the documentation at https://refine.dev/docs/packages/documentation/routers
                 `,
-                files: [
-                    {
-                        src: "./src/components/pages/auth/index.tsx",
-                        dest: "./components/pages/auth/index.tsx",
-                    },
-                    {
-                        src: "./src/components/pages/auth/components/forgotPassword/index.tsx",
-                        dest: "./components/pages/auth/components/forgotPassword.tsx",
-                    },
-                    {
-                        src: "./src/components/pages/auth/components/login/index.tsx",
-                        dest: "./components/pages/auth/components/login.tsx",
-                    },
-                    {
-                        src: "./src/components/pages/auth/components/register/index.tsx",
-                        dest: "./components/pages/auth/components/register.tsx",
-                    },
-                    {
-                        src: "./src/components/pages/auth/components/updatePassword/index.tsx",
-                        dest: "./components/pages/auth/components/updatePassword.tsx",
-                    },
-                    {
-                        src: "./src/components/pages/auth/components/index.ts",
-                        dest: "./components/pages/auth/components/index.ts",
-                    },
-                ],
-            },
-            {
-                group: "Other",
-                label: "CanAccess",
-                files: [
-                    {
-                        src: "./src/components/canAccess/index.tsx",
-                        dest: "./components/canAccess.tsx",
-                    },
-                ],
-            },
-            {
-                group: "Other",
-                label: "Authenticated",
-                files: [
-                    {
-                        src: "./src/components/authenticated/index.tsx",
-                        dest: "./components/authenticated.tsx",
-                    },
-                ],
-            },
-            {
-                group: "Other",
-                label: "AutoSaveIndicator",
-                files: [
-                    {
-                        src: "./src/components/autoSaveIndicator/index.tsx",
-                        dest: "./components/autoSaveIndicator.tsx",
-                    },
-                ],
-            },
+        files: [
+          {
+            src: "./src/components/pages/auth/index.tsx",
+            dest: "./components/pages/auth/index.tsx",
+          },
+          {
+            src: "./src/components/pages/auth/components/forgotPassword/index.tsx",
+            dest: "./components/pages/auth/components/forgotPassword.tsx",
+          },
+          {
+            src: "./src/components/pages/auth/components/login/index.tsx",
+            dest: "./components/pages/auth/components/login.tsx",
+          },
+          {
+            src: "./src/components/pages/auth/components/register/index.tsx",
+            dest: "./components/pages/auth/components/register.tsx",
+          },
+          {
+            src: "./src/components/pages/auth/components/updatePassword/index.tsx",
+            dest: "./components/pages/auth/components/updatePassword.tsx",
+          },
+          {
+            src: "./src/components/pages/auth/components/index.ts",
+            dest: "./components/pages/auth/components/index.ts",
+          },
+        ],
+      },
+      {
+        group: "Other",
+        label: "CanAccess",
+        files: [
+          {
+            src: "./src/components/canAccess/index.tsx",
+            dest: "./components/canAccess.tsx",
+          },
+        ],
+      },
+      {
+        group: "Other",
+        label: "Authenticated",
+        files: [
+          {
+            src: "./src/components/authenticated/index.tsx",
+            dest: "./components/authenticated.tsx",
+          },
+        ],
+      },
+      {
+        group: "Other",
+        label: "AutoSaveIndicator",
+        files: [
+          {
+            src: "./src/components/autoSaveIndicator/index.tsx",
+            dest: "./components/autoSaveIndicator.tsx",
+          },
         ],
-        transform: (content) => {
-            let newContent = content;
-            const imports = getImports(content);
+      },
+    ],
+    transform: (content) => {
+      let newContent = content;
+      const imports = getImports(content);
 
-            imports.map((importItem) => {
-                if (
-                    importItem.importPath === "../../../../../interfaces" ||
-                    importItem.importPath === "../../../interfaces" ||
-                    importItem.importPath === "../../interfaces" ||
-                    importItem.importPath === "@hooks" ||
-                    importItem.importPath === "@hooks/translate" ||
-                    importItem.importPath === "@definitions/index" ||
-                    importItem.importPath === "@definitions/helpers"
-                ) {
-                    const newStatement = `import ${importItem.namedImports} from "@refinedev/core";`;
+      imports.map((importItem) => {
+        if (
+          importItem.importPath.includes("/types") ||
+          importItem.importPath === "@hooks" ||
+          importItem.importPath === "@hooks/translate" ||
+          importItem.importPath === "@definitions/index" ||
+          importItem.importPath === "@definitions/helpers"
+        ) {
+          const newStatement = `import ${importItem.namedImports} from "@refinedev/core";`;
 
-                    newContent = newContent.replace(
-                        importItem.statement,
-                        newStatement,
-                    );
-                }
+          newContent = newContent.replace(importItem.statement, newStatement);
+        }
 
-                if (importItem.importPath === "../..") {
-                    const typesLine = `
+        if (importItem.importPath === "../..") {
+          const typesLine = `
                     type DivPropsType = React.DetailedHTMLProps<
                         React.HTMLAttributes<HTMLDivElement>,
                         HTMLDivElement
@@ -118,13 +113,13 @@ module.exports = {
                     >;
                     `;
 
-                    newContent = newContent.replace(importItem.statement, "");
+          newContent = newContent.replace(importItem.statement, "");
 
-                    newContent = appendAfterImports(newContent, typesLine);
-                }
-            });
+          newContent = appendAfterImports(newContent, typesLine);
+        }
+      });
 
-            return newContent;
-        },
+      return newContent;
     },
+  },
 };

package/src/components/authenticated/index.tsx

@@ -1,60 +1,60 @@
 import React from "react";
 
+import { useActiveAuthProvider } from "@definitions/index";
 import {
-    useGo,
-    useNavigation,
-    useParsed,
-    useRouterContext,
-    useRouterType,
-    useIsAuthenticated,
+  useGo,
+  useIsAuthenticated,
+  useNavigation,
+  useParsed,
+  useRouterContext,
+  useRouterType,
 } from "@hooks";
-import { useActiveAuthProvider } from "@definitions/index";
-import { GoConfig } from "src/interfaces";
+import { GoConfig } from "../../contexts/router/types";
 
 export type AuthenticatedCommonProps = {
-    /**
-     * Unique key to identify the component.
-     * This is required if you have multiple `Authenticated` components at the same level.
-     * @required
-     */
-    key: React.Key;
-    /**
-     * Whether to redirect user if not logged in or not.
-     * If not set, user will be redirected to `redirectTo` property of the `check` function's response.
-     * This behavior is only available for new auth providers.
-     * Legacy auth providers will redirect to `/login` by default if this property is not set.
-     * If set to a string, user will be redirected to that string.
-     *
-     * This property only works if `fallback` is **not set**.
-     */
-    redirectOnFail?: string | true;
-    /**
-     * Whether to append current path to search params of the redirect url at `to` property.
-     *
-     * By default, `to` parameter is used by successful invocations of the `useLogin` hook.
-     * If `to` present, it will be used as the redirect url after successful login.
-     */
-    appendCurrentPathToQuery?: boolean;
-    /**
-     * Content to show if user is not logged in.
-     */
-    fallback?: React.ReactNode;
-    /**
-     * Content to show while checking whether user is logged in or not.
-     */
-    loading?: React.ReactNode;
-    /**
-     * Content to show if user is logged in
-     */
-    children?: React.ReactNode;
+  /**
+   * Unique key to identify the component.
+   * This is required if you have multiple `Authenticated` components at the same level.
+   * @required
+   */
+  key: React.Key;
+  /**
+   * Whether to redirect user if not logged in or not.
+   * If not set, user will be redirected to `redirectTo` property of the `check` function's response.
+   * This behavior is only available for new auth providers.
+   * Legacy auth providers will redirect to `/login` by default if this property is not set.
+   * If set to a string, user will be redirected to that string.
+   *
+   * This property only works if `fallback` is **not set**.
+   */
+  redirectOnFail?: string | true;
+  /**
+   * Whether to append current path to search params of the redirect url at `to` property.
+   *
+   * By default, `to` parameter is used by successful invocations of the `useLogin` hook.
+   * If `to` present, it will be used as the redirect url after successful login.
+   */
+  appendCurrentPathToQuery?: boolean;
+  /**
+   * Content to show if user is not logged in.
+   */
+  fallback?: React.ReactNode;
+  /**
+   * Content to show while checking whether user is logged in or not.
+   */
+  loading?: React.ReactNode;
+  /**
+   * Content to show if user is logged in
+   */
+  children?: React.ReactNode;
 };
 
 export type LegacyAuthenticatedProps = {
-    v3LegacyAuthProviderCompatible: true;
+  v3LegacyAuthProviderCompatible: true;
 } & AuthenticatedCommonProps;
 
 export type AuthenticatedProps = {
-    v3LegacyAuthProviderCompatible?: false;
+  v3LegacyAuthProviderCompatible?: false;
 } & AuthenticatedCommonProps;
 
 /**
@@ -72,7 +72,7 @@ export type AuthenticatedProps = {
  * @see {@link https://refine.dev/docs/core/components/auth/authenticated `<Authenticated>`} component for more details.
  */
 export function Authenticated(
-    props: LegacyAuthenticatedProps,
+  props: LegacyAuthenticatedProps,
 ): JSX.Element | null;
 
 /**
@@ -92,131 +92,129 @@ export function Authenticated(
 export function Authenticated(props: AuthenticatedProps): JSX.Element | null;
 
 export function Authenticated({
-    redirectOnFail = true,
-    appendCurrentPathToQuery = true,
-    children,
-    fallback: fallbackContent,
-    loading: loadingContent,
+  redirectOnFail = true,
+  appendCurrentPathToQuery = true,
+  children,
+  fallback: fallbackContent,
+  loading: loadingContent,
 }: AuthenticatedProps | LegacyAuthenticatedProps): JSX.Element | null {
-    const activeAuthProvider = useActiveAuthProvider();
-    const routerType = useRouterType();
-
-    const hasAuthProvider = Boolean(activeAuthProvider?.isProvided);
-    const isLegacyAuth = Boolean(activeAuthProvider?.isLegacy);
-    const isLegacyRouter = routerType === "legacy";
-
-    const parsed = useParsed();
-    const go = useGo();
-    const { useLocation } = useRouterContext();
-    const legacyLocation = useLocation();
-
-    const {
-        isFetching,
-        isSuccess,
-        data: {
-            authenticated: isAuthenticatedStatus,
-            redirectTo: authenticatedRedirect,
-        } = {},
-    } = useIsAuthenticated({
-        v3LegacyAuthProviderCompatible: isLegacyAuth,
-    });
-
-    // Authentication status
-    const isAuthenticated = hasAuthProvider
-        ? isLegacyAuth
-            ? isSuccess
-            : isAuthenticatedStatus
-        : true;
-
-    // when there is no auth provider
-    if (!hasAuthProvider) {
-        return <>{children ?? null}</>;
-    }
-
-    // when checking authentication status
-    if (isFetching) {
-        return <>{loadingContent ?? null}</>;
-    }
-
-    // when user is authenticated return children
-    if (isAuthenticated) {
-        return <>{children ?? null}</>;
-    }
-    // when user is not authenticated redirect or render fallbackContent
-    else {
-        // render fallbackContent if it is exist
-        if (typeof fallbackContent !== "undefined") {
-            return <>{fallbackContent ?? null}</>;
-        }
-        // if there is no fallbackContent, redirect page
-
-        // Redirect url to use. use redirectOnFail if it is set.
-        // Otherwise use redirectTo property of the check function's response.
-        // If both are not set, use `/login` as the default redirect url. (only for legacy auth providers)
-        const appliedRedirect = isLegacyAuth
-            ? typeof redirectOnFail === "string"
-                ? redirectOnFail
-                : "/login"
-            : typeof redirectOnFail === "string"
-            ? 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)
-        const pathname = `${
-            isLegacyRouter ? legacyLocation?.pathname : parsed.pathname
-        }`.replace(/(\?.*|#.*)$/, "");
-        // Redirect if appliedRedirect is set, otherwise return null.
-        //  Uses `replace` for legacy router and `go` for new router.
-        if (appliedRedirect) {
-            if (isLegacyRouter) {
-                const toQuery = appendCurrentPathToQuery
-                    ? `?to=${encodeURIComponent(pathname)}`
-                    : "";
-                return <RedirectLegacy to={`${appliedRedirect}${toQuery}`} />;
-            } else {
-                return (
-                    <Redirect
-                        config={{
-                            to: appliedRedirect,
-                            query: appendCurrentPathToQuery
-                                ? {
-                                      to: parsed.params?.to
-                                          ? parsed.params.to
-                                          : go({
-                                                to: pathname,
-                                                options: { keepQuery: true },
-                                                type: "path",
-                                            }),
-                                  }
-                                : undefined,
-                            type: "replace",
-                        }}
-                    />
-                );
-            }
-        }
-
-        return null;
+  const activeAuthProvider = useActiveAuthProvider();
+  const routerType = useRouterType();
+
+  const hasAuthProvider = Boolean(activeAuthProvider?.isProvided);
+  const isLegacyAuth = Boolean(activeAuthProvider?.isLegacy);
+  const isLegacyRouter = routerType === "legacy";
+
+  const parsed = useParsed();
+  const go = useGo();
+  const { useLocation } = useRouterContext();
+  const legacyLocation = useLocation();
+
+  const {
+    isFetching,
+    isSuccess,
+    data: {
+      authenticated: isAuthenticatedStatus,
+      redirectTo: authenticatedRedirect,
+    } = {},
+  } = useIsAuthenticated({
+    v3LegacyAuthProviderCompatible: isLegacyAuth,
+  });
+
+  // Authentication status
+  const isAuthenticated = hasAuthProvider
+    ? isLegacyAuth
+      ? isSuccess
+      : isAuthenticatedStatus
+    : true;
+
+  // when there is no auth provider
+  if (!hasAuthProvider) {
+    return <>{children ?? null}</>;
+  }
+
+  // when checking authentication status
+  if (isFetching) {
+    return <>{loadingContent ?? null}</>;
+  }
+
+  // when user is authenticated return children
+  if (isAuthenticated) {
+    return <>{children ?? null}</>;
+  }
+  // when user is not authenticated redirect or render fallbackContent
+
+  // render fallbackContent if it is exist
+  if (typeof fallbackContent !== "undefined") {
+    return <>{fallbackContent ?? null}</>;
+  }
+  // if there is no fallbackContent, redirect page
+
+  // Redirect url to use. use redirectOnFail if it is set.
+  // Otherwise use redirectTo property of the check function's response.
+  // If both are not set, use `/login` as the default redirect url. (only for legacy auth providers)
+  const appliedRedirect = isLegacyAuth
+    ? typeof redirectOnFail === "string"
+      ? redirectOnFail
+      : "/login"
+    : typeof redirectOnFail === "string"
+      ? 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)
+  const pathname = `${
+    isLegacyRouter ? legacyLocation?.pathname : parsed.pathname
+  }`.replace(/(\?.*|#.*)$/, "");
+  // Redirect if appliedRedirect is set, otherwise return null.
+  //  Uses `replace` for legacy router and `go` for new router.
+  if (appliedRedirect) {
+    if (isLegacyRouter) {
+      const toQuery = appendCurrentPathToQuery
+        ? `?to=${encodeURIComponent(pathname)}`
+        : "";
+      return <RedirectLegacy to={`${appliedRedirect}${toQuery}`} />;
     }
+    return (
+      <Redirect
+        config={{
+          to: appliedRedirect,
+          query: appendCurrentPathToQuery
+            ? {
+                to: parsed.params?.to
+                  ? parsed.params.to
+                  : go({
+                      to: pathname,
+                      options: { keepQuery: true },
+                      type: "path",
+                    }),
+              }
+            : undefined,
+          type: "replace",
+        }}
+      />
+    );
+  }
+
+  return null;
 }
 
 const Redirect = ({ config }: { config: GoConfig }) => {
-    const go = useGo();
+  const go = useGo();
 
-    React.useEffect(() => {
-        go(config);
-    }, [go, config]);
+  React.useEffect(() => {
+    go(config);
+  }, [go, config]);
 
-    return null;
+  return null;
 };
 
 const RedirectLegacy = ({ to }: { to: string }) => {
-    const { replace } = useNavigation();
+  const { replace } = useNavigation();
 
-    React.useEffect(() => {
-        replace(to);
-    }, [replace, to]);
+  React.useEffect(() => {
+    replace(to);
+  }, [replace, to]);
 
-    return null;
+  return null;
 };