@refinedev/core 4.47.2 → 4.49.0

package/src/components/containers/refine/index.tsx

@@ -1,182 +1,33 @@
 import React from "react";
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+
 import { useQuerySubscription } from "@refinedev/devtools-internal";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 
 import { ReadyPage as DefaultReadyPage, RouteChangeHandler } from "@components";
 import { Telemetry } from "@components/telemetry";
-import { AccessControlContextProvider } from "@contexts/accessControl";
-import { AuditLogContextProvider } from "@contexts/auditLog";
-import {
-    AuthBindingsContextProvider,
-    LegacyAuthContextProvider,
-} from "@contexts/auth";
-import { DataContextProvider } from "@contexts/data";
-import { LegacyRouterContextProvider } from "@contexts/legacy-router";
-import { LiveContextProvider } from "@contexts/live";
-import { NotificationContextProvider } from "@contexts/notification";
-import { RefineContextProvider } from "@contexts/refine";
-import { ResourceContextProvider } from "@contexts/resource";
-import { TranslationContextProvider } from "@contexts/translation";
-import { UndoableQueueContextProvider } from "@contexts/undoableQueue";
-import { UnsavedWarnContextProvider } from "@contexts/unsavedWarn";
 import { handleRefineOptions } from "@definitions";
 import { useDeepMemo } from "@hooks/deepMemo";
-import { RouterBindings } from "src/interfaces/bindings";
 
-import { RouterPickerProvider } from "@contexts/router-picker";
-import { RouterBindingsProvider } from "../../../contexts/router";
-import { useRouterMisuseWarning } from "../../../hooks/router/use-router-misuse-warning/index";
+import { AccessControlContextProvider } from "../../../contexts/accessControl";
+import { AuditLogContextProvider } from "../../../contexts/auditLog";
 import {
-    AccessControlProvider,
-    AuditLogProvider,
-    AuthProvider,
-    DashboardPageProps,
-    I18nProvider,
-    IDataContextProvider,
-    IDataMultipleContextProvider,
-    ILiveContext,
-    INotificationContext,
-    IRefineOptions,
-    IRouterProvider,
-    LayoutProps,
-    LegacyAuthProvider,
-    LiveModeProps,
-    NotificationProvider,
-    TitleProps,
-} from "../../../interfaces";
-import { ResourceProps } from "../../../interfaces/bindings/resource";
+  AuthBindingsContextProvider,
+  LegacyAuthContextProvider,
+} from "../../../contexts/auth";
+import { DataContextProvider } from "../../../contexts/data";
+import { I18nContextProvider } from "../../../contexts/i18n";
+import { LiveContextProvider } from "../../../contexts/live";
+import { NotificationContextProvider } from "../../../contexts/notification";
+import { RefineContextProvider } from "../../../contexts/refine";
+import { ResourceContextProvider } from "../../../contexts/resource";
+import { RouterContextProvider } from "../../../contexts/router";
+import { LegacyRouterContextProvider } from "../../../contexts/router/legacy";
+import { RouterPickerProvider } from "../../../contexts/router/picker";
+import { UndoableQueueContextProvider } from "../../../contexts/undoableQueue";
+import { UnsavedWarnContextProvider } from "../../../contexts/unsavedWarn";
 
-export interface RefineProps {
-    children?: React.ReactNode;
-    /**
-     * `resources` is the predefined interaction points for a refine app. A resource represents an entity in an endpoint in the API.
-     * While this is not a required property, it is used in resource detection and creation of routes for the app.
-     * @type [`ResourceProps[]`](https://refine.dev/docs/api-reference/core/components/refine-config/#resources)
-     */
-    resources?: ResourceProps[];
-    /**
-     * **refine** needs some router functions to create resource pages, handle navigation, etc. This provider allows you to use the router library you want
-     * @type [`IRouterProvider`](https://refine.dev/docs/api-reference/core/providers/router-provider/)
-     * @deprecated This property is deprecated and was the legacy way of routing. Please use `routerProvider` with new router bindings instead.
-     */
-    legacyRouterProvider?: IRouterProvider;
-    /**
-     * Router bindings for **refine**. A simple interface for **refine** to interact with your router in a flexible way.
-     * @type [`RouterBindings`](https://refine.dev/docs/api-reference/core/bindings/router/)
-     */
-    routerProvider?: RouterBindings;
-    /**
-     * A `dataProvider` is the place where a refine app communicates with an API. Data providers also act as adapters for refine, making it possible for it to consume different API's and data services.
-     * @type [`IDataContextProvider` | `IDataMultipleContextProvider`](https://refine.dev/docs/api-reference/core/providers/data-provider/)
-     */
-    dataProvider?: IDataContextProvider | IDataMultipleContextProvider;
-    /**
-     * `authProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
-     * @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
-     */
-    authProvider?: AuthProvider;
-    /**
-     * `legacyAuthProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
-     * @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
-     * @deprecated `legacyAuthProvider` is deprecated with refine@4, use `authProvider` instead.
-     */
-    legacyAuthProvider?: LegacyAuthProvider;
-    /**
-     * **refine** lets you add Realtime support to your app via `liveProvider`. It can be used to update and show data in Realtime throughout your app.
-     * @type [`ILiveContext`](https://refine.dev/docs/api-reference/core/providers/live-provider/)
-     */
-    liveProvider?: ILiveContext;
-    /**
-     * `notificationProvider` handles notification logics. It is an object with methods that refine uses when necessary.
-     * @type [`NotificationProvider` | `(() => NotificationProvider)`](https://refine.dev/docs/api-reference/core/providers/notification-provider/)
-     */
-    notificationProvider?: NotificationProvider | (() => NotificationProvider);
-    /**
-     * `accessControlProvider` is the entry point for implementing access control for refine apps.
-     * @type [`AccessControlProvider`](https://refine.dev/docs/api-reference/core/providers/accessControl-provider/)
-     */
-    accessControlProvider?: AccessControlProvider;
-    /**
-     * **refine** allows you to track changes in your data and keep track of who made the changes.
-     * @type [`AuditLogProvider`](https://refine.dev/docs/api-reference/core/providers/audit-log-provider#overview)
-     */
-    auditLogProvider?: AuditLogProvider;
-    /**
-     * `i18nProvider` property lets you add i18n support to your app. Making you able to use any i18n framework.
-     * @type [`i18nProvider`](https://refine.dev/docs/api-reference/core/providers/i18n-provider/)
-     */
-    i18nProvider?: I18nProvider;
-    /**
-     * A custom error component.
-     * @type [`ReactNode`](https://refine.dev/docs/api-reference/core/components/refine-config/#catchall)
-     * @deprecated Please use the `catchAll` element in your routes instead.
-     */
-    catchAll?: React.ReactNode;
-    /**
-     * Custom login component can be passed to the `LoginPage` property.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage)
-     * @deprecated Please use the `LoginPage` component in your routes instead.
-     */
-    LoginPage?: React.FC;
-    /**
-     * A custom dashboard page can be passed to the `DashboardPage` prop which is accessible on root route.
-     * @type [`React.FC<DashboardPageProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#dashboardpage)
-     * @deprecated Please use the `DashboardPage` component in your routes instead.
-     */
-    DashboardPage?: React.FC<DashboardPageProps>;
-    /**
-     * Custom ready page component can be set by passing to `ReadyPage` property.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#readypage)
-     * @deprecated This component is only used with the legacy router and will be removed in the future.
-     */
-    ReadyPage?: React.FC;
-    /**
-     * Default layout can be customized by passing the `Layout` property.
-     * @type [`React.FC<LayoutProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#layout)
-     * @deprecated Please use the `Layout` component as a children instead of a prop.
-     */
-    Layout?: React.FC<LayoutProps>;
-    /**
-     * The default sidebar can be customized by using refine hooks and passing custom components to `Sider` property.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#sider)
-     * @deprecated Please pass the `Sider` component to your `Layout` component.
-     */
-    Sider?: React.FC;
-    /**
-     * The default app header can be customized by passing the `Header` property.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#header)
-     * @deprecated Please pass the `Header` component to your `Layout` component.
-     */
-    Header?: React.FC;
-    /**
-     *The default app footer can be customized by passing the `Footer` property.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#footer)
-     * @deprecated Please pass the `Footer` component to your `Layout` component.
-     */
-    Footer?: React.FC;
-    /**
-     * The component wanted to be placed out of app layout structure can be set by passing to `OffLayoutArea` prop.
-     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#offlayoutarea)
-     * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
-     */
-    OffLayoutArea?: React.FC;
-    /**
-     * TThe app title can be set by passing the `Title` property.
-     * @type [`React.FC<TitleProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#title)
-     * @deprecated Please pass the `Title` component to your `Layout` component.
-     */
-    Title?: React.FC<TitleProps>;
-    /**
-     * Callback to handle all live events.
-     * @type [`(event: LiveEvent) => void`](https://refine.dev/docs/api-reference/core/providers/live-provider/#onliveevent)
-     */
-    onLiveEvent?: LiveModeProps["onLiveEvent"];
-    /**
-     * `options` is used to configure the app.
-     * @type [`IRefineOptions`](https://refine.dev/docs/api-reference/core/components/refine-config/#options)
-     * */
-    options?: IRefineOptions;
-}
+import { RefineProps } from "../../../contexts/refine/types";
+import { useRouterMisuseWarning } from "../../../hooks/router/use-router-misuse-warning/index";
 
 /**
  * {@link https://refine.dev/docs/api-reference/core/components/refine-config `<Refine> component`} is the entry point of a refine app.
@@ -186,222 +37,181 @@ export interface RefineProps {
  * @see {@link https://refine.dev/docs/api-reference/core/components/refine-config} for more details.
  */
 export const Refine: React.FC<RefineProps> = ({
-    legacyAuthProvider,
-    authProvider,
-    dataProvider,
-    legacyRouterProvider,
-    routerProvider,
-    notificationProvider,
-    accessControlProvider,
-    auditLogProvider,
-    resources,
-    DashboardPage,
-    ReadyPage,
-    LoginPage,
-    catchAll,
-    children,
-    liveProvider,
-    i18nProvider,
-    Title,
-    Layout,
-    Sider,
-    Header,
-    Footer,
-    OffLayoutArea,
-    onLiveEvent,
-    options,
+  legacyAuthProvider,
+  authProvider,
+  dataProvider,
+  legacyRouterProvider,
+  routerProvider,
+  notificationProvider,
+  accessControlProvider,
+  auditLogProvider,
+  resources,
+  DashboardPage,
+  ReadyPage,
+  LoginPage,
+  catchAll,
+  children,
+  liveProvider,
+  i18nProvider,
+  Title,
+  Layout,
+  Sider,
+  Header,
+  Footer,
+  OffLayoutArea,
+  onLiveEvent,
+  options,
 }) => {
-    const {
-        optionsWithDefaults,
-        disableTelemetryWithDefault,
-        reactQueryWithDefaults,
-    } = handleRefineOptions({
-        options,
-    });
+  const {
+    optionsWithDefaults,
+    disableTelemetryWithDefault,
+    reactQueryWithDefaults,
+  } = handleRefineOptions({
+    options,
+  });
 
-    const queryClient = useDeepMemo(() => {
-        if (reactQueryWithDefaults.clientConfig instanceof QueryClient) {
-            return reactQueryWithDefaults.clientConfig;
-        }
+  const queryClient = useDeepMemo(() => {
+    if (reactQueryWithDefaults.clientConfig instanceof QueryClient) {
+      return reactQueryWithDefaults.clientConfig;
+    }
 
-        return new QueryClient({
-            ...reactQueryWithDefaults.clientConfig,
-            defaultOptions: {
-                ...reactQueryWithDefaults.clientConfig.defaultOptions,
-                queries: {
-                    refetchOnWindowFocus: false,
-                    keepPreviousData: true,
-                    ...reactQueryWithDefaults.clientConfig.defaultOptions
-                        ?.queries,
-                },
-            },
-        });
-    }, [reactQueryWithDefaults.clientConfig]);
+    return new QueryClient({
+      ...reactQueryWithDefaults.clientConfig,
+      defaultOptions: {
+        ...reactQueryWithDefaults.clientConfig.defaultOptions,
+        queries: {
+          refetchOnWindowFocus: false,
+          keepPreviousData: true,
+          ...reactQueryWithDefaults.clientConfig.defaultOptions?.queries,
+        },
+      },
+    });
+  }, [reactQueryWithDefaults.clientConfig]);
 
-    useQuerySubscription(queryClient);
+  useQuerySubscription(queryClient);
 
-    const useNotificationProviderValues = React.useMemo(() => {
-        return typeof notificationProvider === "function"
-            ? notificationProvider
-            : () => notificationProvider ?? ({} as INotificationContext);
-    }, [notificationProvider]);
+  const useNotificationProviderValues = React.useMemo(() => {
+    return typeof notificationProvider === "function"
+      ? notificationProvider
+      : () => notificationProvider;
+  }, [notificationProvider]);
 
-    const notificationProviderContextValues = useNotificationProviderValues();
+  const notificationProviderContextValues = useNotificationProviderValues();
 
-    /**
-     * Warn our users if they are using the old way of routing in the wrong prop.
-     */
-    useRouterMisuseWarning(routerProvider);
-    /** */
+  /**
+   * Warn our users if they are using the old way of routing in the wrong prop.
+   */
+  useRouterMisuseWarning(routerProvider);
+  /** */
 
-    /**
-     * `<ReadyPage />` is only used in the legacy routing and is not used in the new routing.
-     * If `legacyRouterProvider` is provided and `routerProvider` is not, we'll check for the `resources` prop to be empty.
-     * If `resources` is empty, then we'll render `<ReadyPage />` component.
-     */
-    if (
-        legacyRouterProvider &&
-        !routerProvider &&
-        (resources ?? []).length === 0
-    ) {
-        return ReadyPage ? <ReadyPage /> : <DefaultReadyPage />;
-    }
+  /**
+   * `<ReadyPage />` is only used in the legacy routing and is not used in the new routing.
+   * If `legacyRouterProvider` is provided and `routerProvider` is not, we'll check for the `resources` prop to be empty.
+   * If `resources` is empty, then we'll render `<ReadyPage />` component.
+   */
+  if (
+    legacyRouterProvider &&
+    !routerProvider &&
+    (resources ?? []).length === 0
+  ) {
+    return ReadyPage ? <ReadyPage /> : <DefaultReadyPage />;
+  }
 
-    /** Router
-     *
-     * Handle routing from `RouterBindingsProvider` and `router` prop for the brand new way
-     * If `router` is not provided, then we'r checking for `routerProvider` prop
-     * If `routerProvider` is provided, then `RouterContextProvider` is used
-     * If none of them is provided, then `RouterBindingsProvider` is used because it supports undefined router
-     *
-     * `RouterContextProvider` is skipped whenever possible and by this way,
-     * we can achieve backward compability only when its provided by user
-     *
-     */
-    const { RouterComponent = React.Fragment } = !routerProvider
-        ? legacyRouterProvider ?? {}
-        : {};
-    /** */
+  /** Router
+   *
+   * Handle routing from `RouterContextProvider` and `router` prop for the brand new way
+   * If `router` is not provided, then we'r checking for `routerProvider` prop
+   * If `routerProvider` is provided, then `RouterContextProvider` is used
+   * If none of them is provided, then `RouterContextProvider` is used because it supports undefined router
+   *
+   * `RouterContextProvider` is skipped whenever possible and by this way,
+   * we can achieve backward compability only when its provided by user
+   *
+   */
+  const { RouterComponent = React.Fragment } = !routerProvider
+    ? legacyRouterProvider ?? {}
+    : {};
+  /** */
 
-    return (
-        <QueryClientProvider client={queryClient}>
-            <NotificationContextProvider {...notificationProviderContextValues}>
-                <LegacyAuthContextProvider
-                    {...(legacyAuthProvider ?? {})}
-                    isProvided={Boolean(legacyAuthProvider)}
+  return (
+    <QueryClientProvider client={queryClient}>
+      <NotificationContextProvider {...notificationProviderContextValues}>
+        <LegacyAuthContextProvider
+          {...(legacyAuthProvider ?? {})}
+          isProvided={Boolean(legacyAuthProvider)}
+        >
+          <AuthBindingsContextProvider
+            {...(authProvider ?? {})}
+            isProvided={Boolean(authProvider)}
+          >
+            <DataContextProvider dataProvider={dataProvider}>
+              <LiveContextProvider liveProvider={liveProvider}>
+                <RouterPickerProvider
+                  value={
+                    legacyRouterProvider && !routerProvider ? "legacy" : "new"
+                  }
                 >
-                    <AuthBindingsContextProvider
-                        {...(authProvider ?? {})}
-                        isProvided={Boolean(authProvider)}
-                    >
-                        <DataContextProvider {...dataProvider}>
-                            <LiveContextProvider liveProvider={liveProvider}>
-                                <RouterPickerProvider
-                                    value={
-                                        legacyRouterProvider && !routerProvider
-                                            ? "legacy"
-                                            : "new"
-                                    }
+                  <RouterContextProvider router={routerProvider}>
+                    <LegacyRouterContextProvider {...legacyRouterProvider}>
+                      <ResourceContextProvider resources={resources ?? []}>
+                        <I18nContextProvider i18nProvider={i18nProvider}>
+                          <AccessControlContextProvider
+                            {...(accessControlProvider ?? {})}
+                          >
+                            <AuditLogContextProvider
+                              {...(auditLogProvider ?? {})}
+                            >
+                              <UndoableQueueContextProvider>
+                                <RefineContextProvider
+                                  mutationMode={
+                                    optionsWithDefaults.mutationMode
+                                  }
+                                  warnWhenUnsavedChanges={
+                                    optionsWithDefaults.warnWhenUnsavedChanges
+                                  }
+                                  syncWithLocation={
+                                    optionsWithDefaults.syncWithLocation
+                                  }
+                                  Title={Title}
+                                  undoableTimeout={
+                                    optionsWithDefaults.undoableTimeout
+                                  }
+                                  catchAll={catchAll}
+                                  DashboardPage={DashboardPage}
+                                  LoginPage={LoginPage}
+                                  Layout={Layout}
+                                  Sider={Sider}
+                                  Footer={Footer}
+                                  Header={Header}
+                                  OffLayoutArea={OffLayoutArea}
+                                  hasDashboard={!!DashboardPage}
+                                  liveMode={optionsWithDefaults.liveMode}
+                                  onLiveEvent={onLiveEvent}
+                                  options={optionsWithDefaults}
                                 >
-                                    <RouterBindingsProvider
-                                        router={routerProvider}
-                                    >
-                                        <LegacyRouterContextProvider
-                                            {...legacyRouterProvider}
-                                        >
-                                            <ResourceContextProvider
-                                                resources={resources ?? []}
-                                            >
-                                                <TranslationContextProvider
-                                                    i18nProvider={i18nProvider}
-                                                >
-                                                    <AccessControlContextProvider
-                                                        {...(accessControlProvider ??
-                                                            {})}
-                                                    >
-                                                        <AuditLogContextProvider
-                                                            {...(auditLogProvider ??
-                                                                {})}
-                                                        >
-                                                            <UndoableQueueContextProvider>
-                                                                <RefineContextProvider
-                                                                    mutationMode={
-                                                                        optionsWithDefaults.mutationMode
-                                                                    }
-                                                                    warnWhenUnsavedChanges={
-                                                                        optionsWithDefaults.warnWhenUnsavedChanges
-                                                                    }
-                                                                    syncWithLocation={
-                                                                        optionsWithDefaults.syncWithLocation
-                                                                    }
-                                                                    Title={
-                                                                        Title
-                                                                    }
-                                                                    undoableTimeout={
-                                                                        optionsWithDefaults.undoableTimeout
-                                                                    }
-                                                                    catchAll={
-                                                                        catchAll
-                                                                    }
-                                                                    DashboardPage={
-                                                                        DashboardPage
-                                                                    }
-                                                                    LoginPage={
-                                                                        LoginPage
-                                                                    }
-                                                                    Layout={
-                                                                        Layout
-                                                                    }
-                                                                    Sider={
-                                                                        Sider
-                                                                    }
-                                                                    Footer={
-                                                                        Footer
-                                                                    }
-                                                                    Header={
-                                                                        Header
-                                                                    }
-                                                                    OffLayoutArea={
-                                                                        OffLayoutArea
-                                                                    }
-                                                                    hasDashboard={
-                                                                        !!DashboardPage
-                                                                    }
-                                                                    liveMode={
-                                                                        optionsWithDefaults.liveMode
-                                                                    }
-                                                                    onLiveEvent={
-                                                                        onLiveEvent
-                                                                    }
-                                                                    options={
-                                                                        optionsWithDefaults
-                                                                    }
-                                                                >
-                                                                    <UnsavedWarnContextProvider>
-                                                                        <RouterComponent>
-                                                                            {
-                                                                                children
-                                                                            }
-                                                                            {!disableTelemetryWithDefault && (
-                                                                                <Telemetry />
-                                                                            )}
-                                                                            <RouteChangeHandler />
-                                                                        </RouterComponent>
-                                                                    </UnsavedWarnContextProvider>
-                                                                </RefineContextProvider>
-                                                            </UndoableQueueContextProvider>
-                                                        </AuditLogContextProvider>
-                                                    </AccessControlContextProvider>
-                                                </TranslationContextProvider>
-                                            </ResourceContextProvider>
-                                        </LegacyRouterContextProvider>
-                                    </RouterBindingsProvider>
-                                </RouterPickerProvider>
-                            </LiveContextProvider>
-                        </DataContextProvider>
-                    </AuthBindingsContextProvider>
-                </LegacyAuthContextProvider>
-            </NotificationContextProvider>
-        </QueryClientProvider>
-    );
+                                  <UnsavedWarnContextProvider>
+                                    <RouterComponent>
+                                      {children}
+                                      {!disableTelemetryWithDefault && (
+                                        <Telemetry />
+                                      )}
+                                      <RouteChangeHandler />
+                                    </RouterComponent>
+                                  </UnsavedWarnContextProvider>
+                                </RefineContextProvider>
+                              </UndoableQueueContextProvider>
+                            </AuditLogContextProvider>
+                          </AccessControlContextProvider>
+                        </I18nContextProvider>
+                      </ResourceContextProvider>
+                    </LegacyRouterContextProvider>
+                  </RouterContextProvider>
+                </RouterPickerProvider>
+              </LiveContextProvider>
+            </DataContextProvider>
+          </AuthBindingsContextProvider>
+        </LegacyAuthContextProvider>
+      </NotificationContextProvider>
+    </QueryClientProvider>
+  );
 };