@refinedev/core 4.47.2 → 4.49.0

package/src/contexts/live/ILiveContext.ts

@@ -1,56 +0,0 @@
-import {
-    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;
-
-export type ILiveContextProvider = {
-    liveProvider: ILiveContext;
-    children: React.ReactNode;
-};

package/src/contexts/notification/INotificationContext.ts

@@ -1,15 +0,0 @@
-export interface OpenNotificationParams {
-    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;
-}
-
-export type NotificationProvider = Required<INotificationContext>;

package/src/contexts/refine/IRefineContext.ts

@@ -1,140 +0,0 @@
-import { RefineProps } from "@components/containers";
-import React, { ReactNode } from "react";
-import { QueryClientConfig, QueryClient } from "@tanstack/react-query";
-
-import {
-    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;
-    /**
-     * 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;
-}
-
-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;
-}
-
-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;
-}

package/src/contexts/resource/IResourceContext.ts

@@ -1,68 +0,0 @@
-import { ComponentType } from "react";
-import { UseQueryResult } from "@tanstack/react-query";
-import { ILogData } from "../../interfaces";
-import {
-    IResourceItem,
-    ResourceMeta,
-    ResourceProps,
-} from "../../interfaces/bindings/resource";
-const auditLogPermissions = ["create", "update", "delete"] as const;
-
-export type ResourceRouteComponent = ComponentType<
-    IResourceComponentsProps<any, any>
->;
-
-export type ResourceRoutePath = string;
-
-export type ResourceRouteDefinition = {
-    path: ResourceRoutePath;
-    component: ResourceRouteComponent;
-};
-
-export type ResourceRouteComposition =
-    | ResourceRouteDefinition
-    | ResourceRoutePath
-    | ResourceRouteComponent;
-
-export interface IResourceComponents {
-    list?: ResourceRouteComposition;
-    create?: ResourceRouteComposition;
-    clone?: ResourceRouteComposition;
-    edit?: ResourceRouteComposition;
-    show?: ResourceRouteComposition;
-}
-
-type MetaProps<TExtends = { [key: string]: any }> = ResourceMeta & TExtends;
-
-export interface RouteableProperties {
-    canCreate?: boolean;
-    canEdit?: boolean;
-    canShow?: boolean;
-    canDelete?: boolean;
-    canList?: boolean;
-}
-
-export interface IResourceComponentsProps<
-    TCrudData = any,
-    TMetaPropsExtends = { [key: string]: any },
-    TLogQueryResult = ILogData,
-> {
-    canCreate?: boolean;
-    canEdit?: boolean;
-    canDelete?: boolean;
-    canShow?: boolean;
-    name?: string;
-    initialData?: TCrudData;
-    /**
-     * @deprecated `options` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `options` for backward compatibility.
-     */
-    options?: MetaProps<TMetaPropsExtends>;
-    meta?: MetaProps<TMetaPropsExtends>;
-    logQueryResult?: UseQueryResult<TLogQueryResult>;
-}
-
-export { IResourceItem, ResourceProps };
-
-export interface IResourceContext {
-    resources: IResourceItem[];
-}

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

@@ -1,21 +0,0 @@
-import React from "react";
-
-/**
- * This context is used to determine which router to use.
- *
- * This is a temporary solution until we remove the legacy router.
- */
-
-export const RouterPickerContext = React.createContext<"legacy" | "new">("new");
-
-export const RouterPickerProvider = RouterPickerContext.Provider;
-
-/**
- * This is a temporary hook to determine which router to use.
- * It will be removed once the legacy router is removed.
- * @internal This is an internal hook.
- */
-export const useRouterType = () => {
-    const value = React.useContext(RouterPickerContext);
-    return value;
-};

package/src/contexts/translation/ITranslationContext.ts

@@ -1,19 +0,0 @@
-import { ReactNode } from "react";
-
-export type Translate = (
-    key: string,
-    options?: any,
-    defaultMessage?: string,
-) => string;
-
-export interface I18nProvider {
-    translate: Translate;
-    changeLocale: (locale: string, options?: any) => Promise<any>;
-    getLocale: () => string;
-}
-
-export interface ITranslationContext {
-    i18nProvider?: I18nProvider;
-}
-
-export type TranslationProvider = Required<ITranslationContext>;

package/src/contexts/translation/index.tsx

@@ -1,24 +0,0 @@
-import React from "react";
-
-import { ITranslationContext } from "../../interfaces";
-
-/** @deprecated default value for translation context has no use and is an empty object.  */
-export const defaultProvider: ITranslationContext = {};
-
-export const TranslationContext = React.createContext<ITranslationContext>({});
-
-export const TranslationContextProvider: React.FC<
-    ITranslationContext & {
-        children?: React.ReactNode;
-    }
-> = ({ children, i18nProvider }) => {
-    return (
-        <TranslationContext.Provider
-            value={{
-                i18nProvider: i18nProvider,
-            }}
-        >
-            {children}
-        </TranslationContext.Provider>
-    );
-};

package/src/contexts/undoableQueue/IUndoableQueueContext.ts

@@ -1,6 +0,0 @@
-import { IUndoableQueue } from "../../interfaces";
-
-export interface IUndoableQueueContext {
-    notifications: IUndoableQueue[];
-    notificationDispatch: React.Dispatch<any>;
-}

package/src/contexts/undoableQueue/actionTypes.ts

@@ -1,5 +0,0 @@
-export enum ActionTypes {
-    ADD = "ADD",
-    REMOVE = "REMOVE",
-    DECREASE_NOTIFICATION_SECOND = "DECREASE_NOTIFICATION_SECOND",
-}

package/src/contexts/undoableQueue/index.ts

@@ -1,5 +0,0 @@
-export { ActionTypes } from "./actionTypes";
-export {
-    UndoableQueueContextProvider,
-    UndoableQueueContext,
-} from "./undoableQueueContext";

package/src/contexts/undoableQueue/undoableQueueContext.tsx

@@ -1,83 +0,0 @@
-import React, { ReactNode, useReducer } from "react";
-import isEqual from "lodash/isEqual";
-
-import { UndoableQueue } from "@components";
-
-import { IUndoableQueue, IUndoableQueueContext } from "../../interfaces";
-import { ActionTypes } from "./actionTypes";
-
-export const UndoableQueueContext = React.createContext<IUndoableQueueContext>({
-    notifications: [],
-    notificationDispatch: () => false,
-});
-
-const initialState: IUndoableQueue[] = [];
-
-export const undoableQueueReducer = (state: IUndoableQueue[], action: any) => {
-    switch (action.type) {
-        case ActionTypes.ADD:
-            const newState = state.filter(
-                (notificationItem: IUndoableQueue) => {
-                    return !(
-                        isEqual(notificationItem.id, action.payload.id) &&
-                        notificationItem.resource == action.payload.resource
-                    );
-                },
-            );
-
-            return [
-                ...newState,
-                {
-                    ...action.payload,
-                    isRunning: true,
-                },
-            ];
-        case ActionTypes.REMOVE:
-            return state.filter(
-                (notificationItem: IUndoableQueue) =>
-                    !(
-                        isEqual(notificationItem.id, action.payload.id) &&
-                        notificationItem.resource == action.payload.resource
-                    ),
-            );
-        case ActionTypes.DECREASE_NOTIFICATION_SECOND:
-            return state.map((notificationItem: IUndoableQueue) => {
-                if (
-                    isEqual(notificationItem.id, action.payload.id) &&
-                    notificationItem.resource == action.payload.resource
-                ) {
-                    return {
-                        ...notificationItem,
-                        seconds: action.payload.seconds - 1000,
-                    };
-                }
-                return notificationItem;
-            });
-        default:
-            return state;
-    }
-};
-
-export const UndoableQueueContextProvider: React.FC<{
-    children: ReactNode;
-}> = ({ children }) => {
-    const [notifications, notificationDispatch] = useReducer(
-        undoableQueueReducer,
-        initialState,
-    );
-
-    const notificationData = { notifications, notificationDispatch };
-
-    return (
-        <UndoableQueueContext.Provider value={notificationData}>
-            {children}
-            {typeof window !== "undefined" &&
-                notifications.map((notification) => (
-                    <UndoableQueue
-                        key={`${notification.id}-${notification.resource}-queue`}
-                        notification={notification}
-                    />
-                ))}
-        </UndoableQueueContext.Provider>
-    );
-};

package/src/contexts/unsavedWarn/IUnsavedWarnContext.ts

@@ -1,4 +0,0 @@
-export interface IUnsavedWarnContext {
-    warnWhen?: boolean;
-    setWarnWhen?: (value: boolean) => void;
-}

package/src/hooks/export/csvDownload.interface.ts

@@ -1,27 +0,0 @@
-import { MouseEventHandler } from "react";
-
-export interface LabelKeyObject {
-    label: string;
-    key: string;
-}
-
-export type Data = object[];
-export type Headers = LabelKeyObject[] | string[];
-export type SyncClickHandler = (
-    event: MouseEventHandler<HTMLAnchorElement>,
-) => boolean | void;
-export type AsyncClickHandler = (
-    event: MouseEventHandler<HTMLAnchorElement>,
-    done: (proceed?: boolean) => void,
-) => void;
-
-export interface CSVDownloadProps {
-    data: string | Data;
-    headers?: Headers;
-    enclosingCharacter?: string;
-    separator?: string;
-    filename?: string;
-    uFEFF?: boolean;
-    onClick?: SyncClickHandler | AsyncClickHandler;
-    asyncOnClick?: boolean;
-}