@refinedev/core 4.48.0 → 4.49.0

package/src/hooks/data/useInfiniteList.ts

@@ -2,8 +2,8 @@ import { getXRay } from "@refinedev/devtools-internal";
 import {
   InfiniteData,
   InfiniteQueryObserverResult,
-  useInfiniteQuery,
   UseInfiniteQueryOptions,
+  useInfiniteQuery,
 } from "@tanstack/react-query";
 
 import {
@@ -17,37 +17,37 @@ import {
 import {
   useDataProvider,
   useHandleNotification,
+  useKeys,
   useMeta,
   useOnError,
   useResource,
   useResourceSubscription,
   useTranslate,
 } from "@hooks";
+
 import {
   BaseRecord,
-  CrudFilters,
-  CrudSorting,
+  CrudFilter,
+  CrudSort,
   GetListResponse,
   HttpError,
-  LiveModeProps,
   MetaQuery,
   Pagination,
   Prettify,
-  SuccessErrorNotification,
-} from "../../interfaces";
-
-import { useKeys } from "@hooks/useKeys";
+} from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
 export interface UseInfiniteListConfig {
   pagination?: Pagination;
   hasPagination?: boolean;
-  sort?: CrudSorting;
-  filters?: CrudFilters;
+  sort?: CrudSort[];
+  filters?: CrudFilter[];
 }
 
 type BaseInfiniteListProps = {
@@ -78,11 +78,11 @@ type BaseInfiniteListProps = {
   /**
    * Sorter parameters
    */
-  sorters?: CrudSorting;
+  sorters?: CrudSort[];
   /**
    * Filter parameters
    */
-  filters?: CrudFilters;
+  filters?: CrudFilter[];
   /**
    * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use
    */

package/src/hooks/data/useList.ts

@@ -1,8 +1,8 @@
 import { getXRay } from "@refinedev/devtools-internal";
 import {
   QueryObserverResult,
-  useQuery,
   UseQueryOptions,
+  useQuery,
 } from "@tanstack/react-query";
 
 import {
@@ -14,36 +14,37 @@ import {
 import {
   useDataProvider,
   useHandleNotification,
+  useKeys,
   useMeta,
   useOnError,
   useResource,
   useResourceSubscription,
   useTranslate,
 } from "@hooks";
-import { useKeys } from "@hooks/useKeys";
+
 import {
   BaseRecord,
-  CrudFilters,
-  CrudSorting,
+  CrudFilter,
+  CrudSort,
   GetListResponse,
   HttpError,
-  LiveModeProps,
   MetaQuery,
   Pagination,
   Prettify,
-  SuccessErrorNotification,
-} from "../../interfaces";
+} from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
 export interface UseListConfig {
   pagination?: Pagination;
   hasPagination?: boolean;
-  sort?: CrudSorting;
-  filters?: CrudFilters;
+  sort?: CrudSort[];
+  filters?: CrudFilter[];
 }
 
 export type BaseListProps = {
@@ -65,11 +66,11 @@ export type BaseListProps = {
   /**
    * Sorter parameters
    */
-  sorters?: CrudSorting;
+  sorters?: CrudSort[];
   /**
    * Filter parameters
    */
-  filters?: CrudFilters;
+  filters?: CrudFilter[];
   /**
    * Meta data query for `dataProvider`
    */

package/src/hooks/data/useMany.ts

@@ -1,8 +1,8 @@
 import { getXRay } from "@refinedev/devtools-internal";
 import {
   QueryObserverResult,
-  useQuery,
   UseQueryOptions,
+  useQuery,
 } from "@tanstack/react-query";
 
 import {
@@ -14,26 +14,27 @@ import {
 import {
   useDataProvider,
   useHandleNotification,
+  useKeys,
   useMeta,
   useOnError,
   useResource,
   useResourceSubscription,
   useTranslate,
 } from "@hooks";
-import { useKeys } from "@hooks/useKeys";
+
 import {
   BaseKey,
   BaseRecord,
   GetManyResponse,
   HttpError,
-  LiveModeProps,
   MetaQuery,
-  SuccessErrorNotification,
-} from "../../interfaces";
+} from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
 export type UseManyProps<TQueryFnData, TError, TData> = {

package/src/hooks/data/useOne.ts

@@ -1,8 +1,8 @@
 import { getXRay } from "@refinedev/devtools-internal";
 import {
   QueryObserverResult,
-  useQuery,
   UseQueryOptions,
+  useQuery,
 } from "@tanstack/react-query";
 
 import {
@@ -13,27 +13,28 @@ import {
 import {
   useDataProvider,
   useHandleNotification,
+  useKeys,
   useMeta,
   useOnError,
   useResource,
   useResourceSubscription,
   useTranslate,
 } from "@hooks";
-import { useKeys } from "@hooks/useKeys";
+
 import {
   BaseKey,
   BaseRecord,
   GetOneResponse,
   HttpError,
-  LiveModeProps,
   MetaQuery,
   Prettify,
-  SuccessErrorNotification,
-} from "../../interfaces";
+} from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
 export type UseOneProps<TQueryFnData, TError, TData> = {

package/src/hooks/data/useUpdate.ts

@@ -1,12 +1,11 @@
 import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
   useQueryClient,
 } from "@tanstack/react-query";
 
-import { ActionTypes } from "@contexts/undoableQueue";
 import {
   pickDataProvider,
   pickNotDeprecated,
@@ -18,6 +17,7 @@ import {
   useDataProvider,
   useHandleNotification,
   useInvalidate,
+  useKeys,
   useLog,
   useMeta,
   useMutationMode,
@@ -27,7 +27,7 @@ import {
   useResource,
   useTranslate,
 } from "@hooks";
-import { useKeys } from "@hooks/useKeys";
+
 import {
   BaseKey,
   BaseRecord,
@@ -38,18 +38,42 @@ import {
   IQueryKeys,
   MetaQuery,
   MutationMode,
-  OptimisticUpdateMapType,
   PrevContext as UpdateContext,
   PreviousQuery,
-  SuccessErrorNotification,
   UpdateResponse,
-} from "../../interfaces";
+} from "../../contexts/data/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
+import { ActionTypes } from "../../contexts/undoableQueue/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
+export type OptimisticUpdateMapType<TData, TVariables> = {
+  list?:
+    | ((
+        previous: GetListResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetListResponse<TData> | null)
+    | boolean;
+  many?:
+    | ((
+        previous: GetManyResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetManyResponse<TData> | null)
+    | boolean;
+  detail?:
+    | ((
+        previous: GetOneResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetOneResponse<TData> | null)
+    | boolean;
+};
+
 export type UpdateParams<TData, TError, TVariables> = {
   /**
    * Resource name for API data interactions

package/src/hooks/data/useUpdateMany.ts

@@ -1,12 +1,11 @@
 import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
   useQueryClient,
 } from "@tanstack/react-query";
 
-import { ActionTypes } from "@contexts/undoableQueue";
 import {
   handleMultiple,
   pickDataProvider,
@@ -19,6 +18,7 @@ import {
   useDataProvider,
   useHandleNotification,
   useInvalidate,
+  useKeys,
   useLog,
   useMeta,
   useMutationMode,
@@ -28,7 +28,7 @@ import {
   useResource,
   useTranslate,
 } from "@hooks";
-import { useKeys } from "@hooks/useKeys";
+
 import {
   BaseKey,
   BaseRecord,
@@ -39,18 +39,43 @@ import {
   IQueryKeys,
   MetaQuery,
   MutationMode,
-  OptimisticUpdateManyMapType,
   PrevContext as UpdateContext,
   QueryResponse,
-  SuccessErrorNotification,
   UpdateManyResponse,
-} from "../../interfaces";
+} from "../../contexts/data/types";
 import {
-  useLoadingOvertime,
   UseLoadingOvertimeOptionsProps,
   UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
 } from "../useLoadingOvertime";
 
+import { SuccessErrorNotification } from "../../contexts/notification/types";
+import { ActionTypes } from "../../contexts/undoableQueue/types";
+
+export type OptimisticUpdateManyMapType<TData, TVariables> = {
+  list?:
+    | ((
+        previous: GetListResponse<TData> | null | undefined,
+        values: TVariables,
+        ids: BaseKey[],
+      ) => GetListResponse<TData> | null)
+    | boolean;
+  many?:
+    | ((
+        previous: GetManyResponse<TData> | null | undefined,
+        values: TVariables,
+        ids: BaseKey[],
+      ) => GetManyResponse<TData> | null)
+    | boolean;
+  detail?:
+    | ((
+        previous: GetOneResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetOneResponse<TData> | null)
+    | boolean;
+};
+
 type UpdateManyParams<TData, TError, TVariables> = {
   /**
    * ids for mutation function

package/src/hooks/export/index.ts

@@ -1,20 +1,23 @@
 import { useState } from "react";
-import { unparse, UnparseConfig } from "papaparse";
+
+import papaparse from "papaparse";
 import warnOnce from "warn-once";
-import { useResource, useDataProvider, useMeta } from "@hooks";
-import {
-  BaseRecord,
-  MapDataFn,
-  CrudSorting,
-  CrudFilters,
-  MetaQuery,
-} from "../../interfaces";
+
 import {
-  useUserFriendlyName,
+  downloadInBrowser,
   pickDataProvider,
   pickNotDeprecated,
-  downloadInBrowser,
+  useUserFriendlyName,
 } from "@definitions";
+import { useDataProvider, useMeta, useResource } from "@hooks";
+
+import {
+  BaseRecord,
+  CrudFilter,
+  CrudSort,
+  MetaQuery,
+} from "../../contexts/data/types";
+import { MapDataFn } from "./types";
 
 // Old options interface taken from export-to-csv-fix-source-map@0.2.1
 // Kept here to ensure backward compatibility
@@ -55,15 +58,15 @@ type UseExportOptionsType<
    *  Sorts records
    *  @deprecated `sorter` is deprecated. Use `sorters` instead.
    */
-  sorter?: CrudSorting;
+  sorter?: CrudSort[];
   /**
    *  Sorts records
    */
-  sorters?: CrudSorting;
+  sorters?: CrudSort[];
   /**
    *  Filters records
    */
-  filters?: CrudFilters;
+  filters?: CrudFilter[];
   maxItemCount?: number;
   /**
    *  Requests to fetch data are made as batches by page size. By default, it is 20. Used for `getList` method of `DataProvider`
@@ -79,7 +82,7 @@ type UseExportOptionsType<
    *  Used for exporting options
    *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
    */
-  unparseConfig?: UnparseConfig;
+  unparseConfig?: papaparse.UnparseConfig;
   /**
    *  Metadata query for `dataProvider`
    */
@@ -246,7 +249,7 @@ export const useExport = <
       };
     }
 
-    let csv = unparse(rawData.map(mapData as any), unparseConfig);
+    let csv = papaparse.unparse(rawData.map(mapData as any), unparseConfig);
     if (options.showTitle) {
       csv = `${options.title}\r\n\n${csv}`;
     }

package/src/hooks/export/types.ts

@@ -0,0 +1,31 @@
+import { MouseEventHandler } from "react";
+
+export interface MapDataFn<TItem, TVariables> {
+  (item: TItem, index?: number, items?: TItem[]): TVariables;
+}
+
+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;
+}