@refinedev/core 4.48.0 → 4.49.0

package/src/contexts/router/legacy/types.ts

@@ -0,0 +1,50 @@
+import React from "react";
+
+import { Action } from "../types";
+
+export interface LegacyRouterProvider {
+  useHistory: () => {
+    push: (...args: any) => any;
+    replace: (...args: any) => any;
+    goBack: (...args: any) => any;
+  };
+  useLocation: () => {
+    search: string;
+    pathname: string;
+  };
+  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
+  Prompt: React.FC<PromptProps>;
+  Link: React.FC<any>;
+  RouterComponent?: React.FC<any>;
+  routes?: any;
+}
+
+export interface ILegacyRouterContext {
+  useHistory: () => any;
+  useLocation: () => any;
+  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
+  Prompt: React.FC<PromptProps>;
+  Link: React.FC<any>;
+  routes?: any;
+}
+
+export type PromptProps = {
+  message: string;
+  when?: boolean;
+  setWarnWhen?: (warnWhen: boolean) => void;
+};
+
+export type RouteAction = Exclude<Action, "list"> | undefined;
+
+export type ActionWithPage = Extract<Action, "show" | "create" | "edit">;
+
+export type ResourceRouterParams = {
+  resource: string;
+  id?: string;
+  action: RouteAction;
+};
+
+export type ResourceErrorRouterParams = {
+  resource: string;
+  action: ActionWithPage | undefined;
+};

package/src/contexts/router/types.ts

@@ -0,0 +1,79 @@
+/**
+ * @author aliemir
+ *
+ * Router bindings interface, used to define the router bindings of refine.
+ *
+ * We're marking of the functions as optional, some features may not work properly but this is intentional.
+ * Users can choose to use the router bindings or not, or use their own router bindings.
+ * Leaving the control to the user is the best way to go.
+ *
+ * We're defining the functions as function generators, this is to allow the user to use hooks inside the functions.
+ *
+ * `go` function is used to navigate to a specific route. We're expecting a `GoConfig` object as the only parameter.
+ * Passing `query` as an object, will also let users to stringify the object as they like or ignore it completely or even use a custom logic to handle query strings.
+ *
+ * `back` function is used to navigate back to the previous route. It doesn't take any parameters.
+ * This one is a basic function for the back buttons, absence of this function can also hide the back button,
+ * but this depends on the UI package implementations.
+ *
+ * `parse` function is used to parse the current route, query parameters and other information.
+ * We're expecting this function to lead refine to the correct resource, action and id (again, not required but recommended).
+ * Also there's `params` property, which is used in data hooks and other places.
+ * This property has an interface to match but not restricted to it.
+ *
+ * Instead of a single `useNavigation` hook,
+ * we can separate those functions into three different hooks,
+ * `useGo`, `useBack` and `useParsed`
+ */
+
+import { BaseKey, CrudFilter, CrudSort } from "../data/types";
+import { IResourceItem } from "../resource/types";
+
+export type Action = "create" | "edit" | "list" | "show" | "clone";
+
+export type GoConfig = {
+  to?: string;
+  query?: Record<string, unknown>;
+  hash?: string;
+  options?: {
+    keepQuery?: boolean;
+    keepHash?: boolean;
+  };
+  type?: "push" | "replace" | "path";
+};
+
+export type ParsedParams<
+  TParams extends Record<string, any> = Record<string, any>,
+> = {
+  filters?: CrudFilter[];
+  sorters?: CrudSort[];
+  current?: number;
+  pageSize?: number;
+} & TParams;
+
+export type ParseResponse<
+  TParams extends Record<string, any> = Record<string, any>,
+> = {
+  params?: ParsedParams<TParams>;
+  resource?: IResourceItem;
+  id?: BaseKey;
+  action?: Action;
+  pathname?: string;
+};
+
+export type GoFunction = (config: GoConfig) => void | string;
+
+export type BackFunction = () => void;
+
+export type ParseFunction<
+  TParams extends Record<string, any> = Record<string, any>,
+> = () => ParseResponse<TParams>;
+
+export type RouterProvider = {
+  go?: () => GoFunction;
+  back?: () => BackFunction;
+  parse?: () => ParseFunction;
+  Link?: React.ComponentType<
+    React.PropsWithChildren<{ to: string; [prop: string]: any }>
+  >;
+};

package/src/contexts/undoableQueue/index.tsx

@@ -0,0 +1,82 @@
+import React, { createContext, useReducer, PropsWithChildren } from "react";
+
+import isEqual from "lodash/isEqual";
+
+import { UndoableQueue } from "../../components";
+import { ActionTypes, IUndoableQueue, IUndoableQueueContext } from "./types";
+
+export const UndoableQueueContext = 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<PropsWithChildren> = ({
+  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}
+            />
+          ))
+        : null}
+    </UndoableQueueContext.Provider>
+  );
+};

package/src/contexts/undoableQueue/types.ts

@@ -0,0 +1,22 @@
+import { BaseKey } from "../data/types";
+
+export enum ActionTypes {
+  ADD = "ADD",
+  REMOVE = "REMOVE",
+  DECREASE_NOTIFICATION_SECOND = "DECREASE_NOTIFICATION_SECOND",
+}
+
+export interface IUndoableQueue {
+  id: BaseKey;
+  resource: string;
+  cancelMutation: () => void;
+  doMutation: () => void;
+  seconds: number;
+  isRunning: boolean;
+  isSilent: boolean;
+}
+
+export interface IUndoableQueueContext {
+  notifications: IUndoableQueue[];
+  notificationDispatch: React.Dispatch<any>;
+}

package/src/contexts/unsavedWarn/index.tsx

@@ -1,10 +1,10 @@
-import React, { ReactNode, useState } from "react";
+import React, { useState, PropsWithChildren } from "react";
 
-import { IUnsavedWarnContext } from "./IUnsavedWarnContext";
+import { IUnsavedWarnContext } from "./types";
 
 export const UnsavedWarnContext = React.createContext<IUnsavedWarnContext>({});
 
-export const UnsavedWarnContextProvider: React.FC<{ children: ReactNode }> = ({
+export const UnsavedWarnContextProvider: React.FC<PropsWithChildren> = ({
   children,
 }) => {
   const [warnWhen, setWarnWhen] = useState(false);

package/src/definitions/helpers/async-debounce/index.ts

@@ -0,0 +1,67 @@
+import debounce from "lodash/debounce";
+
+// biome-ignore lint/suspicious/noExplicitAny: any is used to accept any function
+type Callbacks<T extends (...args: any) => any> = {
+  resolve?: (value: Awaited<ReturnType<T>>) => void;
+  // biome-ignore lint/suspicious/noExplicitAny: any is used to match the type of Promise.reject
+  reject?: (reason?: any) => void;
+};
+
+// biome-ignore lint/suspicious/noExplicitAny: any is used to accept any function
+type DebouncedFunction<T extends (...args: any) => any> = {
+  (...args: Parameters<T>): Promise<Awaited<ReturnType<T>>>;
+  flush: () => void;
+  cancel: () => void;
+};
+
+/**
+ * Debounces sync and async functions with given wait time. The debounced function returns a promise which can be awaited or catched.
+ * Only the last call of the debounced function will resolve or reject.
+ * Previous calls will be rejected with the given cancelReason.
+ *
+ * The original debounce function doesn't work well with async functions,
+ * It won't return a promise to resolve/reject and therefore it's not possible to await the result.
+ * This will always return a promise to handle and await the result.
+ * Previous calls will be rejected immediately after a new call made.
+ */
+// biome-ignore lint/suspicious/noExplicitAny: any is used to accept any function
+export const asyncDebounce = <T extends (...args: any[]) => any>(
+  func: T,
+  wait = 1000,
+  cancelReason?: string,
+): DebouncedFunction<T> => {
+  let callbacks: Array<Callbacks<T>> = [];
+
+  const cancelPrevious = () => {
+    callbacks.forEach((cb) => cb.reject?.(cancelReason));
+    callbacks = [];
+  };
+
+  const debouncedFunc = debounce((...args: Parameters<T>) => {
+    const { resolve, reject } = callbacks.pop() || {};
+    Promise.resolve(func(...args))
+      .then(resolve)
+      .catch(reject);
+  }, wait);
+
+  const runner = (...args: Parameters<T>) => {
+    return new Promise<Awaited<ReturnType<T>>>((resolve, reject) => {
+      cancelPrevious();
+
+      callbacks.push({
+        resolve,
+        reject,
+      });
+
+      debouncedFunc(...args);
+    });
+  };
+
+  runner.flush = () => debouncedFunc.flush();
+  runner.cancel = () => {
+    debouncedFunc.cancel();
+    cancelPrevious();
+  };
+
+  return runner;
+};

package/src/definitions/helpers/check-router-prop-misuse/index.ts

@@ -1,7 +1,8 @@
-import { IRouterProvider, RouterBindings } from "src/interfaces";
+import { LegacyRouterProvider } from "../../../contexts/router/legacy/types";
+import { RouterProvider } from "../../../contexts/router/types";
 
 export const checkRouterPropMisuse = (
-  value: IRouterProvider | RouterBindings,
+  value: LegacyRouterProvider | RouterProvider,
 ) => {
   // check if `routerProvider` prop is passed with legacy properties.
   // If yes, console.warn the user to use `legacyRuterProvider` prop instead.

package/src/definitions/helpers/defer-execution/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Delays the execution of a callback function asynchronously.
+ * This utility function is used to defer the execution of the provided
+ * callback, allowing the current call stack to clear before the callback
+ * is invoked. It is particularly useful for ensuring non-blocking behavior
+ * and providing a clear intent when a 0 ms timeout is used.
+ */
+export const deferExecution = (fn: Function) => {
+  setTimeout(fn, 0);
+};

package/src/definitions/helpers/generateDocumentTitle/index.ts

@@ -1,7 +1,8 @@
-import { IResourceItem } from "@contexts/resource";
-import { userFriendlyResourceName } from "../userFriendlyResourceName";
-import type { useTranslate } from "@hooks/translate";
+import type { useTranslate } from "@hooks/i18n";
+
+import { IResourceItem } from "../../../contexts/resource/types";
 import { safeTranslate } from "../safe-translate";
+import { userFriendlyResourceName } from "../userFriendlyResourceName";
 
 /**
  * Generates document title for the given resource and action.

package/src/definitions/helpers/handlePaginationParams/index.ts

@@ -1,4 +1,4 @@
-import { Pagination } from "../../../interfaces";
+import { Pagination } from "../../../contexts/data/types";
 import { pickNotDeprecated } from "../pickNotDeprecated";
 
 type HandlePaginationParamsProps = {

package/src/definitions/helpers/handleRefineOptions/index.ts

@@ -1,12 +1,13 @@
 import { QueryClient, QueryClientConfig } from "@tanstack/react-query";
 
 import { defaultRefineOptions } from "@contexts/refine";
+
+import { MutationMode } from "../../../contexts/data/types";
+import { LiveModeProps } from "../../../contexts/live/types";
 import {
   IRefineContextOptions,
   IRefineOptions,
-  LiveModeProps,
-  MutationMode,
-} from "src/interfaces";
+} from "../../../contexts/refine/types";
 
 type HandleRefineOptionsProps = {
   options?: IRefineOptions;

package/src/definitions/helpers/importCSVMapper/index.ts

@@ -1,6 +1,7 @@
-import zip from "lodash/zip";
 import fromPairs from "lodash/fromPairs";
-import { MapDataFn } from "../../../interfaces";
+import zip from "lodash/zip";
+
+import { MapDataFn } from "../../../hooks/export/types";
 
 export const importCSVMapper = <TItem = any, TVariables = any>(
   data: any[][],

package/src/definitions/helpers/index.ts

@@ -31,3 +31,5 @@ export { KeyBuilder } from "./keys";
 export { flattenObjectKeys } from "./flatten-object-keys";
 export { propertyPathToArray } from "./property-path-to-array";
 export { downloadInBrowser } from "./downloadInBrowser";
+export { deferExecution } from "./defer-execution";
+export { asyncDebounce } from "./async-debounce";

package/src/definitions/helpers/keys/index.ts

@@ -1,4 +1,4 @@
-import { BaseKey } from "src/interfaces";
+import { BaseKey } from "../../../contexts/data/types";
 
 type ParametrizedDataActions = "list" | "infinite";
 type IdRequiredDataActions = "one";

package/src/definitions/helpers/legacy-resource-transform/index.ts

@@ -1,8 +1,4 @@
-import {
-  IResourceItem,
-  ResourceProps,
-} from "../../../interfaces/bindings/resource";
-
+import { IResourceItem, ResourceProps } from "../../../contexts/resource/types";
 import { routeGenerator } from "../routeGenerator";
 
 /**

package/src/definitions/helpers/menu/create-resource-key.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "../../../interfaces";
+import { IResourceItem } from "../../../contexts/resource/types";
 import {
   getParentResource,
   removeLeadingTrailingSlashes,

package/src/definitions/helpers/menu/create-tree.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "../../../contexts/resource";
+import { IResourceItem } from "../../../contexts/resource/types";
 import { getParentResource } from "../router";
 import { createResourceKey } from "./create-resource-key";
 

package/src/definitions/helpers/pick-resource/index.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "src/interfaces/bindings/resource";
+import { IResourceItem } from "../../../contexts/resource/types";
 import { removeLeadingTrailingSlashes } from "../router/remove-leading-trailing-slashes";
 
 /**

package/src/definitions/helpers/pickDataProvider/index.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "src/interfaces/bindings/resource";
+import { IResourceItem } from "../../../contexts/resource/types";
 import { pickResource } from "../pick-resource";
 import { pickNotDeprecated } from "../pickNotDeprecated";
 

package/src/definitions/helpers/queryKeys/index.ts

@@ -1,9 +1,8 @@
-import { IQueryKeys } from "src/interfaces";
 import { QueryKey } from "@tanstack/react-query";
 
-import { MetaQuery } from "src/interfaces";
-import { pickNotDeprecated } from "../pickNotDeprecated";
+import { IQueryKeys, MetaQuery } from "../../../contexts/data/types";
 import { keys as newKeys } from "../keys";
+import { pickNotDeprecated } from "../pickNotDeprecated";
 
 /**
  * @deprecated `queryKeys` is deprecated. Please use `keys` instead.

package/src/definitions/helpers/redirectPage/index.ts

@@ -1,4 +1,6 @@
-import { Action, IRefineContextOptions, RedirectAction } from "src/interfaces";
+import { IRefineContextOptions } from "../../../contexts/refine/types";
+import { Action } from "../../../contexts/router/types";
+import { RedirectAction } from "../../../hooks/form/types";
 
 type RedirectPageProps = {
   redirectFromProps?: RedirectAction;

package/src/definitions/helpers/routeGenerator/index.ts

@@ -1,6 +1,6 @@
-import { ResourceProps } from "src/interfaces/bindings/resource";
-import { getParentPrefixForResource } from "../router";
+import { ResourceProps } from "../../../contexts/resource/types";
 import { pickNotDeprecated } from "../pickNotDeprecated";
+import { getParentPrefixForResource } from "../router";
 
 /**
  * generates route for the resource based on parents and custom routes

package/src/definitions/helpers/router/compose-route.ts

@@ -1,4 +1,5 @@
-import { MetaQuery, ParseResponse } from "src/interfaces";
+import { MetaQuery } from "../../../contexts/data/types";
+import { ParseResponse } from "../../../contexts/router/types";
 import { pickRouteParams } from "./pick-route-params";
 import { prepareRouteParams } from "./prepare-route-params";
 

package/src/definitions/helpers/router/get-action-routes-from-resource.ts

@@ -1,4 +1,5 @@
-import { Action, IResourceItem } from "src/interfaces";
+import { IResourceItem } from "../../../contexts/resource/types";
+import { Action } from "../../../contexts/router/types";
 import { getDefaultActionPath } from "./get-default-action-path";
 import { getParentPrefixForResource } from "./get-parent-prefix-for-resource";
 

package/src/definitions/helpers/router/get-default-action-path.ts

@@ -1,4 +1,4 @@
-import { Action } from "src/interfaces";
+import { Action } from "../../../contexts/router/types";
 import { removeLeadingTrailingSlashes } from "./remove-leading-trailing-slashes";
 
 /**

package/src/definitions/helpers/router/get-parent-prefix-for-resource.ts

@@ -1,4 +1,4 @@
-import { ResourceProps } from "src/interfaces/bindings/resource";
+import { ResourceProps } from "../../../contexts/resource/types";
 import { getParentResource } from "./get-parent-resource";
 import { removeLeadingTrailingSlashes } from "./remove-leading-trailing-slashes";
 

package/src/definitions/helpers/router/get-parent-resource.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "src/interfaces";
+import { IResourceItem } from "../../../contexts/resource/types";
 import { pickNotDeprecated } from "../pickNotDeprecated";
 
 /**

package/src/definitions/helpers/router/match-resource-from-route.ts

@@ -1,4 +1,5 @@
-import { Action, IResourceItem } from "../../../interfaces";
+import { IResourceItem } from "../../../contexts/resource/types";
+import { Action } from "../../../contexts/router/types";
 import { checkBySegments } from "./check-by-segments";
 import { getActionRoutesFromResource } from "./get-action-routes-from-resource";
 import { pickMatchedRoute } from "./pick-matched-route";

package/src/definitions/helpers/safe-translate/index.ts

@@ -1,4 +1,4 @@
-import type { useTranslate } from "@hooks/translate";
+import type { useTranslate } from "@hooks/i18n";
 
 export const safeTranslate = (
   translate: ReturnType<typeof useTranslate>,

package/src/definitions/helpers/sanitize-resource/index.ts

@@ -1,4 +1,4 @@
-import { IResourceItem } from "../../../interfaces/bindings/resource";
+import { IResourceItem } from "../../../contexts/resource/types";
 
 /**
  * Remove all properties that are non-serializable from a resource object.

package/src/definitions/helpers/treeView/createTreeView/index.ts

@@ -1,5 +1,10 @@
 import { pickNotDeprecated } from "@definitions/helpers/pickNotDeprecated";
-import { IResourceItem, ITreeMenu, IMenuItem } from "src/interfaces";
+
+import {
+  IMenuItem,
+  IResourceItem,
+  ITreeMenu,
+} from "../../../../contexts/resource/types";
 
 /**
  * @deprecated This helper is deprecated. Please use `createTree` instead.

package/src/definitions/helpers/useInfinitePagination/index.ts

@@ -1,4 +1,4 @@
-import { GetListResponse } from "../../../interfaces";
+import { GetListResponse } from "../../../contexts/data/types";
 
 export const getNextPageParam = (lastPage: GetListResponse) => {
   const { pagination, cursor } = lastPage;