@refinedev/core 4.47.2 → 4.48.0

package/src/contexts/legacy-router/index.tsx

@@ -3,43 +3,43 @@ import React from "react";
 import { IRouterContext } from "../../interfaces";
 
 export const defaultProvider: IRouterContext = {
-    useHistory: () => false,
-    useLocation: () => false,
-    useParams: () => ({} as any),
-    Prompt: () => null,
-    Link: () => null,
+  useHistory: () => false,
+  useLocation: () => false,
+  useParams: () => ({}) as any,
+  Prompt: () => null,
+  Link: () => null,
 };
 
 export const LegacyRouterContext =
-    React.createContext<IRouterContext>(defaultProvider);
+  React.createContext<IRouterContext>(defaultProvider);
 
 export const RouterContext = LegacyRouterContext;
 
 export const LegacyRouterContextProvider: React.FC<
-    Partial<IRouterContext> & {
-        children?: React.ReactNode;
-    }
+  Partial<IRouterContext> & {
+    children?: React.ReactNode;
+  }
 > = ({
-    children,
-    useHistory,
-    useLocation,
-    useParams,
-    Prompt,
-    Link,
-    routes,
+  children,
+  useHistory,
+  useLocation,
+  useParams,
+  Prompt,
+  Link,
+  routes,
 }) => {
-    return (
-        <RouterContext.Provider
-            value={{
-                useHistory: useHistory ?? defaultProvider.useHistory,
-                useLocation: useLocation ?? defaultProvider.useLocation,
-                useParams: useParams ?? defaultProvider.useParams,
-                Prompt: Prompt ?? defaultProvider.Prompt,
-                Link: Link ?? defaultProvider.Link,
-                routes: routes ?? defaultProvider.routes,
-            }}
-        >
-            {children}
-        </RouterContext.Provider>
-    );
+  return (
+    <RouterContext.Provider
+      value={{
+        useHistory: useHistory ?? defaultProvider.useHistory,
+        useLocation: useLocation ?? defaultProvider.useLocation,
+        useParams: useParams ?? defaultProvider.useParams,
+        Prompt: Prompt ?? defaultProvider.Prompt,
+        Link: Link ?? defaultProvider.Link,
+        routes: routes ?? defaultProvider.routes,
+      }}
+    >
+      {children}
+    </RouterContext.Provider>
+  );
 };

package/src/contexts/live/ILiveContext.ts

@@ -1,56 +1,56 @@
 import {
-    BaseKey,
-    CrudFilters,
-    CrudSorting,
-    LiveEvent,
-    MetaQuery,
-    Pagination,
+  BaseKey,
+  CrudFilters,
+  CrudSorting,
+  LiveEvent,
+  MetaQuery,
+  Pagination,
 } from "../../interfaces";
 
 export type ILiveContext =
-    | {
-          publish?: (event: LiveEvent) => void;
-          subscribe: (options: {
-              channel: string;
-              params?: {
-                  ids?: BaseKey[];
-                  id?: BaseKey;
-                  /**
-                   * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
-                   */
-                  meta?: MetaQuery;
-                  /**
-                   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-                   */
-                  metaData?: MetaQuery;
-                  pagination?: Pagination;
-                  /**
-                   * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
-                   */
-                  hasPagination?: boolean;
-                  /**
-                   * @deprecated `sort` is deprecated, use `sorters` instead.
-                   */
-                  sort?: CrudSorting;
-                  sorters?: CrudSorting;
-                  filters?: CrudFilters;
-                  subscriptionType?: "useList" | "useOne" | "useMany";
-                  resource?: string;
-                  [key: string]: any;
-              };
-              types: LiveEvent["type"][];
-              /**
-               * @deprecated use `meta.dataProviderName` instead.
-               */
-              dataProviderName?: string;
-              meta?: MetaQuery & { dataProviderName?: string };
-              callback: (event: LiveEvent) => void;
-          }) => any;
-          unsubscribe: (subscription: any) => void;
-      }
-    | undefined;
+  | {
+      publish?: (event: LiveEvent) => void;
+      subscribe: (options: {
+        channel: string;
+        params?: {
+          ids?: BaseKey[];
+          id?: BaseKey;
+          /**
+           * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
+           */
+          meta?: MetaQuery;
+          /**
+           * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+           */
+          metaData?: MetaQuery;
+          pagination?: Pagination;
+          /**
+           * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
+           */
+          hasPagination?: boolean;
+          /**
+           * @deprecated `sort` is deprecated, use `sorters` instead.
+           */
+          sort?: CrudSorting;
+          sorters?: CrudSorting;
+          filters?: CrudFilters;
+          subscriptionType?: "useList" | "useOne" | "useMany";
+          resource?: string;
+          [key: string]: any;
+        };
+        types: LiveEvent["type"][];
+        /**
+         * @deprecated use `meta.dataProviderName` instead.
+         */
+        dataProviderName?: string;
+        meta?: MetaQuery & { dataProviderName?: string };
+        callback: (event: LiveEvent) => void;
+      }) => any;
+      unsubscribe: (subscription: any) => void;
+    }
+  | undefined;
 
 export type ILiveContextProvider = {
-    liveProvider: ILiveContext;
-    children: React.ReactNode;
+  liveProvider: ILiveContext;
+  children: React.ReactNode;
 };

package/src/contexts/live/index.tsx

@@ -5,12 +5,10 @@ import { ILiveContext, ILiveContextProvider } from "./ILiveContext";
 export const LiveContext = React.createContext<ILiveContext>(undefined);
 
 export const LiveContextProvider: React.FC<ILiveContextProvider> = ({
-    liveProvider,
-    children,
+  liveProvider,
+  children,
 }) => {
-    return (
-        <LiveContext.Provider value={liveProvider}>
-            {children}
-        </LiveContext.Provider>
-    );
+  return (
+    <LiveContext.Provider value={liveProvider}>{children}</LiveContext.Provider>
+  );
 };

package/src/contexts/notification/INotificationContext.ts

@@ -1,15 +1,15 @@
 export interface OpenNotificationParams {
-    key?: string;
-    message: string;
-    type: "success" | "error" | "progress";
-    description?: string;
-    cancelMutation?: () => void;
-    undoableTimeout?: number;
+  key?: string;
+  message: string;
+  type: "success" | "error" | "progress";
+  description?: string;
+  cancelMutation?: () => void;
+  undoableTimeout?: number;
 }
 
 export interface INotificationContext {
-    open?: (params: OpenNotificationParams) => void;
-    close?: (key: string) => void;
+  open?: (params: OpenNotificationParams) => void;
+  close?: (key: string) => void;
 }
 
 export type NotificationProvider = Required<INotificationContext>;

package/src/contexts/notification/index.tsx

@@ -8,13 +8,13 @@ export const defaultNotificationProvider: INotificationContext = {};
 export const NotificationContext = createContext<INotificationContext>({});
 
 export const NotificationContextProvider: React.FC<
-    INotificationContext & {
-        children?: React.ReactNode;
-    }
+  INotificationContext & {
+    children?: React.ReactNode;
+  }
 > = ({ open, close, children }) => {
-    return (
-        <NotificationContext.Provider value={{ open, close }}>
-            {children}
-        </NotificationContext.Provider>
-    );
+  return (
+    <NotificationContext.Provider value={{ open, close }}>
+      {children}
+    </NotificationContext.Provider>
+  );
 };

package/src/contexts/refine/IRefineContext.ts

@@ -3,138 +3,138 @@ import React, { ReactNode } from "react";
 import { QueryClientConfig, QueryClient } from "@tanstack/react-query";
 
 import {
-    MutationMode,
-    TitleProps,
-    LayoutProps,
-    LiveModeProps,
-    RedirectAction,
-    TextTransformers,
+  MutationMode,
+  TitleProps,
+  LayoutProps,
+  LiveModeProps,
+  RedirectAction,
+  TextTransformers,
 } from "../../interfaces";
 import { UseLoadingOvertimeRefineContext } from "../../hooks/useLoadingOvertime";
 
 export interface IRefineOptions {
-    breadcrumb?: ReactNode;
-    mutationMode?: MutationMode;
-    syncWithLocation?: boolean;
-    warnWhenUnsavedChanges?: boolean;
-    undoableTimeout?: number;
-    liveMode?: LiveModeProps["liveMode"];
-    disableTelemetry?: boolean;
-    redirect?: {
-        afterCreate?: RedirectAction;
-        afterClone?: RedirectAction;
-        afterEdit?: RedirectAction;
-    };
-    reactQuery?: {
-        clientConfig?: QueryClientConfig | InstanceType<typeof QueryClient>;
-        /**
-         * @deprecated `@tanstack/react-query`'s devtools are removed from the core. Please use the `@tanstack/react-query-devtools` package manually in your project. This option will be removed in the next major version and has no effect on the `@tanstack/react-query-devtools` package usage.
-         */
-        devtoolConfig?: any | false;
-    };
-    overtime?: UseLoadingOvertimeRefineContext;
-    textTransformers?: TextTransformers;
+  breadcrumb?: ReactNode;
+  mutationMode?: MutationMode;
+  syncWithLocation?: boolean;
+  warnWhenUnsavedChanges?: boolean;
+  undoableTimeout?: number;
+  liveMode?: LiveModeProps["liveMode"];
+  disableTelemetry?: boolean;
+  redirect?: {
+    afterCreate?: RedirectAction;
+    afterClone?: RedirectAction;
+    afterEdit?: RedirectAction;
+  };
+  reactQuery?: {
+    clientConfig?: QueryClientConfig | InstanceType<typeof QueryClient>;
     /**
-     * Disables server-side validation globally for the useForm hook
-     * @default false
-     * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+     * @deprecated `@tanstack/react-query`'s devtools are removed from the core. Please use the `@tanstack/react-query-devtools` package manually in your project. This option will be removed in the next major version and has no effect on the `@tanstack/react-query-devtools` package usage.
      */
-    disableServerSideValidation?: boolean;
-    /**
-     * The project id of your refine project. Will be set automatically. Don't modify.
-     */
-    projectId?: string;
-    useNewQueryKeys?: boolean;
+    devtoolConfig?: any | false;
+  };
+  overtime?: UseLoadingOvertimeRefineContext;
+  textTransformers?: TextTransformers;
+  /**
+   * Disables server-side validation globally for the useForm hook
+   * @default false
+   * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+   */
+  disableServerSideValidation?: boolean;
+  /**
+   * The project id of your refine project. Will be set automatically. Don't modify.
+   */
+  projectId?: string;
+  useNewQueryKeys?: boolean;
 }
 
 export interface IRefineContextOptions {
-    breadcrumb?: ReactNode;
-    mutationMode: MutationMode;
-    syncWithLocation: boolean;
-    warnWhenUnsavedChanges: boolean;
-    undoableTimeout: number;
-    liveMode: LiveModeProps["liveMode"];
-    redirect: {
-        afterCreate: RedirectAction;
-        afterClone: RedirectAction;
-        afterEdit: RedirectAction;
-    };
-    overtime: UseLoadingOvertimeRefineContext;
-    textTransformers: Required<TextTransformers>;
-    disableServerSideValidation: boolean;
-    projectId?: string;
-    useNewQueryKeys?: boolean;
+  breadcrumb?: ReactNode;
+  mutationMode: MutationMode;
+  syncWithLocation: boolean;
+  warnWhenUnsavedChanges: boolean;
+  undoableTimeout: number;
+  liveMode: LiveModeProps["liveMode"];
+  redirect: {
+    afterCreate: RedirectAction;
+    afterClone: RedirectAction;
+    afterEdit: RedirectAction;
+  };
+  overtime: UseLoadingOvertimeRefineContext;
+  textTransformers: Required<TextTransformers>;
+  disableServerSideValidation: boolean;
+  projectId?: string;
+  useNewQueryKeys?: boolean;
 }
 
 export interface IRefineContext {
-    __initialized?: boolean;
-    hasDashboard: boolean;
-    mutationMode: MutationMode;
-    /**
-     * @deprecated Please use `UnsavedChangesNotifier` components from router packages instead.
-     */
-    warnWhenUnsavedChanges: boolean;
-    syncWithLocation: boolean;
-    undoableTimeout: number;
-    catchAll?: React.ReactNode;
-    DashboardPage?: RefineProps["DashboardPage"];
-    LoginPage?: React.FC | false;
-    Title?: React.FC<TitleProps>;
-    Layout: React.FC<LayoutProps>;
-    Sider?: React.FC;
-    Header?: React.FC;
-    Footer?: React.FC;
-    OffLayoutArea?: React.FC;
-    liveMode: LiveModeProps["liveMode"];
-    onLiveEvent?: LiveModeProps["onLiveEvent"];
-    options: IRefineContextOptions;
+  __initialized?: boolean;
+  hasDashboard: boolean;
+  mutationMode: MutationMode;
+  /**
+   * @deprecated Please use `UnsavedChangesNotifier` components from router packages instead.
+   */
+  warnWhenUnsavedChanges: boolean;
+  syncWithLocation: boolean;
+  undoableTimeout: number;
+  catchAll?: React.ReactNode;
+  DashboardPage?: RefineProps["DashboardPage"];
+  LoginPage?: React.FC | false;
+  Title?: React.FC<TitleProps>;
+  Layout: React.FC<LayoutProps>;
+  Sider?: React.FC;
+  Header?: React.FC;
+  Footer?: React.FC;
+  OffLayoutArea?: React.FC;
+  liveMode: LiveModeProps["liveMode"];
+  onLiveEvent?: LiveModeProps["onLiveEvent"];
+  options: IRefineContextOptions;
 }
 
 export interface IRefineContextProvider {
-    __initialized?: boolean;
-    hasDashboard: boolean;
-    mutationMode: MutationMode;
-    warnWhenUnsavedChanges: boolean;
-    syncWithLocation: boolean;
-    undoableTimeout: number;
-    /**
-     * @deprecated Please use the `catchAll` element in your routes instead.
-     */
-    catchAll?: React.ReactNode;
-    /**
-     * @deprecated Please use the `DashboardPage` component in your routes instead.
-     */
-    DashboardPage?: RefineProps["DashboardPage"];
-    /**
-     * @deprecated Please use the `LoginPage` component in your routes instead.
-     */
-    LoginPage?: React.FC | false;
-    /**
-     * @deprecated Please pass the `Title` component to your `Layout` component.
-     */
-    Title?: React.FC<TitleProps>;
-    /**
-     * @deprecated Please use the `Layout` component as a children instead of a prop.
-     */
-    Layout?: React.FC<LayoutProps>;
-    /**
-     * @deprecated Please pass the `Sider` component to your `Layout` component.
-     */
-    Sider?: React.FC;
-    /**
-     * @deprecated Please pass the `Header` component to your `Layout` component.
-     */
-    Header?: React.FC;
-    /**
-     * @deprecated Please pass the `Footer` component to your `Layout` component.
-     */
-    Footer?: React.FC;
-    /**
-     * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
-     */
-    OffLayoutArea?: React.FC;
-    liveMode: LiveModeProps["liveMode"];
-    onLiveEvent?: LiveModeProps["onLiveEvent"];
-    options: IRefineContextOptions;
-    children?: ReactNode;
+  __initialized?: boolean;
+  hasDashboard: boolean;
+  mutationMode: MutationMode;
+  warnWhenUnsavedChanges: boolean;
+  syncWithLocation: boolean;
+  undoableTimeout: number;
+  /**
+   * @deprecated Please use the `catchAll` element in your routes instead.
+   */
+  catchAll?: React.ReactNode;
+  /**
+   * @deprecated Please use the `DashboardPage` component in your routes instead.
+   */
+  DashboardPage?: RefineProps["DashboardPage"];
+  /**
+   * @deprecated Please use the `LoginPage` component in your routes instead.
+   */
+  LoginPage?: React.FC | false;
+  /**
+   * @deprecated Please pass the `Title` component to your `Layout` component.
+   */
+  Title?: React.FC<TitleProps>;
+  /**
+   * @deprecated Please use the `Layout` component as a children instead of a prop.
+   */
+  Layout?: React.FC<LayoutProps>;
+  /**
+   * @deprecated Please pass the `Sider` component to your `Layout` component.
+   */
+  Sider?: React.FC;
+  /**
+   * @deprecated Please pass the `Header` component to your `Layout` component.
+   */
+  Header?: React.FC;
+  /**
+   * @deprecated Please pass the `Footer` component to your `Layout` component.
+   */
+  Footer?: React.FC;
+  /**
+   * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
+   */
+  OffLayoutArea?: React.FC;
+  liveMode: LiveModeProps["liveMode"];
+  onLiveEvent?: LiveModeProps["onLiveEvent"];
+  options: IRefineContextOptions;
+  children?: ReactNode;
 }