@refinedev/core 4.47.2 → 4.49.0

package/src/hooks/deepMemo/index.tsx

@@ -6,12 +6,12 @@ import { useMemoized } from "@hooks/memoized";
  * @internal
  */
 export const useDeepMemo = <T,>(
-    fn: () => T,
-    dependencies: React.DependencyList,
+  fn: () => T,
+  dependencies: React.DependencyList,
 ): T => {
-    const memoizedDependencies = useMemoized(dependencies);
+  const memoizedDependencies = useMemoized(dependencies);
 
-    const value = useMemo(fn, memoizedDependencies);
+  const value = useMemo(fn, memoizedDependencies);
 
-    return value;
+  return value;
 };

package/src/hooks/export/index.ts

@@ -1,111 +1,114 @@
 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,
-    pickDataProvider,
-    pickNotDeprecated,
-    downloadInBrowser,
+  downloadInBrowser,
+  pickDataProvider,
+  pickNotDeprecated,
+  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
 export interface ExportOptions {
-    filename?: string;
-    fieldSeparator?: string;
-    quoteStrings?: string;
-    decimalSeparator?: string;
-    showLabels?: boolean;
-    showTitle?: boolean;
-    title?: string;
-    useTextFile?: boolean;
-    useBom?: boolean;
-    headers?: string[];
-    useKeysAsHeaders?: boolean;
+  filename?: string;
+  fieldSeparator?: string;
+  quoteStrings?: string;
+  decimalSeparator?: string;
+  showLabels?: boolean;
+  showTitle?: boolean;
+  title?: string;
+  useTextFile?: boolean;
+  useBom?: boolean;
+  headers?: string[];
+  useKeysAsHeaders?: boolean;
 }
 
 type UseExportOptionsType<
-    TData extends BaseRecord = BaseRecord,
-    TVariables = any,
+  TData extends BaseRecord = BaseRecord,
+  TVariables = any,
 > = {
-    /**
-     * Resource name for API data interactions
-     * @default Resource name that it reads from route
-     * @deprecated `resourceName` is deprecated. Use `resource` instead.
-     */
-    resourceName?: string;
-    /**
-     * Resource name for API data interactions
-     * @default Resource name that it reads from route
-     */
-    resource?: string;
-    /**
-     * A mapping function that runs for every record. Mapped data will be included in the file contents
-     */
-    mapData?: MapDataFn<TData, TVariables>;
-    /**
-     *  Sorts records
-     *  @deprecated `sorter` is deprecated. Use `sorters` instead.
-     */
-    sorter?: CrudSorting;
-    /**
-     *  Sorts records
-     */
-    sorters?: CrudSorting;
-    /**
-     *  Filters records
-     */
-    filters?: CrudFilters;
-    maxItemCount?: number;
-    /**
-     *  Requests to fetch data are made as batches by page size. By default, it is 20. Used for `getList` method of `DataProvider`
-     */
-    pageSize?: number;
-    /**
-     *  Used for exporting options
-     *  @type [Options](https://github.com/alexcaza/export-to-csv)
-     * @deprecated `exportOptions` is deprecated. Use `unparseConfig` instead.
-     */
-    exportOptions?: ExportOptions;
-    /**
-     *  Used for exporting options
-     *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
-     */
-    unparseConfig?: UnparseConfig;
-    /**
-     *  Metadata query for `dataProvider`
-     */
-    meta?: MetaQuery;
-    /**
-     *  Metadata query for `dataProvider`
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery;
-    /**
-     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
-     */
-    dataProviderName?: string;
-    /**
-     *  Callback to handle error events of this hook
-     */
-    onError?: (error: any) => void;
-    /**
-     *  Whether to generate download of the CSV in browser environments, defaults to true.
-     */
-    download?: boolean;
+  /**
+   * Resource name for API data interactions
+   * @default Resource name that it reads from route
+   * @deprecated `resourceName` is deprecated. Use `resource` instead.
+   */
+  resourceName?: string;
+  /**
+   * Resource name for API data interactions
+   * @default Resource name that it reads from route
+   */
+  resource?: string;
+  /**
+   * A mapping function that runs for every record. Mapped data will be included in the file contents
+   */
+  mapData?: MapDataFn<TData, TVariables>;
+  /**
+   *  Sorts records
+   *  @deprecated `sorter` is deprecated. Use `sorters` instead.
+   */
+  sorter?: CrudSort[];
+  /**
+   *  Sorts records
+   */
+  sorters?: CrudSort[];
+  /**
+   *  Filters records
+   */
+  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`
+   */
+  pageSize?: number;
+  /**
+   *  Used for exporting options
+   *  @type [Options](https://github.com/alexcaza/export-to-csv)
+   * @deprecated `exportOptions` is deprecated. Use `unparseConfig` instead.
+   */
+  exportOptions?: ExportOptions;
+  /**
+   *  Used for exporting options
+   *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
+   */
+  unparseConfig?: papaparse.UnparseConfig;
+  /**
+   *  Metadata query for `dataProvider`
+   */
+  meta?: MetaQuery;
+  /**
+   *  Metadata query for `dataProvider`
+   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+   */
+  metaData?: MetaQuery;
+  /**
+   * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
+   */
+  dataProviderName?: string;
+  /**
+   *  Callback to handle error events of this hook
+   */
+  onError?: (error: any) => void;
+  /**
+   *  Whether to generate download of the CSV in browser environments, defaults to true.
+   */
+  download?: boolean;
 };
 
 type UseExportReturnType = {
-    isLoading: boolean;
-    triggerExport: () => Promise<string | undefined>;
+  isLoading: boolean;
+  triggerExport: () => Promise<string | undefined>;
 };
 
 /**
@@ -118,157 +121,163 @@ type UseExportReturnType = {
  *
  */
 export const useExport = <
-    TData extends BaseRecord = BaseRecord,
-    TVariables = any,
+  TData extends BaseRecord = BaseRecord,
+  TVariables = any,
 >({
-    resourceName,
-    resource: resourceFromProps,
-    sorter,
-    sorters,
-    filters,
-    maxItemCount,
-    pageSize = 20,
-    mapData = (item) => item as any,
-    exportOptions,
-    unparseConfig,
-    meta,
-    metaData,
-    dataProviderName,
-    onError,
-    download
+  resourceName,
+  resource: resourceFromProps,
+  sorter,
+  sorters,
+  filters,
+  maxItemCount,
+  pageSize = 20,
+  mapData = (item) => item as any,
+  exportOptions,
+  unparseConfig,
+  meta,
+  metaData,
+  dataProviderName,
+  onError,
+  download,
 }: UseExportOptionsType<TData, TVariables> = {}): UseExportReturnType => {
-    const [isLoading, setIsLoading] = useState(false);
+  const [isLoading, setIsLoading] = useState(false);
 
-    const dataProvider = useDataProvider();
-    const getMeta = useMeta();
-    const { resource, resources, identifier } = useResource(
-        pickNotDeprecated(resourceFromProps, resourceName),
-    );
-    const getFriendlyName = useUserFriendlyName();
+  const dataProvider = useDataProvider();
+  const getMeta = useMeta();
+  const { resource, resources, identifier } = useResource(
+    pickNotDeprecated(resourceFromProps, resourceName),
+  );
+  const getFriendlyName = useUserFriendlyName();
 
-    const filename = `${getFriendlyName(
-        identifier,
-        "plural",
-    )}-${new Date().toLocaleString()}`;
+  const filename = `${getFriendlyName(
+    identifier,
+    "plural",
+  )}-${new Date().toLocaleString()}`;
 
-    const { getList } = dataProvider(
-        pickDataProvider(identifier, dataProviderName, resources),
-    );
+  const { getList } = dataProvider(
+    pickDataProvider(identifier, dataProviderName, resources),
+  );
 
-    const combinedMeta = getMeta({
-        resource,
-        meta: pickNotDeprecated(meta, metaData),
-    });
+  const combinedMeta = getMeta({
+    resource,
+    meta: pickNotDeprecated(meta, metaData),
+  });
 
-    const triggerExport = async () => {
-        setIsLoading(true);
+  const triggerExport = async () => {
+    setIsLoading(true);
 
-        let rawData: BaseRecord[] = [];
+    let rawData: BaseRecord[] = [];
 
-        let current = 1;
-        let preparingData = true;
-        while (preparingData) {
-            try {
-                const { data, total } = await getList<TData>({
-                    resource: resource?.name ?? "",
-                    filters,
-                    sort: pickNotDeprecated(sorters, sorter),
-                    sorters: pickNotDeprecated(sorters, sorter),
-                    pagination: {
-                        current,
-                        pageSize,
-                        mode: "server",
-                    },
-                    meta: combinedMeta,
-                    metaData: combinedMeta,
-                });
+    let current = 1;
+    let preparingData = true;
+    while (preparingData) {
+      try {
+        const { data, total } = await getList<TData>({
+          resource: resource?.name ?? "",
+          filters,
+          sort: pickNotDeprecated(sorters, sorter),
+          sorters: pickNotDeprecated(sorters, sorter),
+          pagination: {
+            current,
+            pageSize,
+            mode: "server",
+          },
+          meta: combinedMeta,
+          metaData: combinedMeta,
+        });
 
-                current++;
+        current++;
 
-                rawData.push(...data);
+        rawData.push(...data);
 
-                if (maxItemCount && rawData.length >= maxItemCount) {
-                    rawData = rawData.slice(0, maxItemCount);
-                    preparingData = false;
-                }
+        if (maxItemCount && rawData.length >= maxItemCount) {
+          rawData = rawData.slice(0, maxItemCount);
+          preparingData = false;
+        }
 
-                if (total === rawData.length) {
-                    preparingData = false;
-                }
-            } catch (error) {
-                setIsLoading(false);
-                preparingData = false;
+        if (total === rawData.length) {
+          preparingData = false;
+        }
+      } catch (error) {
+        setIsLoading(false);
+        preparingData = false;
 
-                onError?.(error);
+        onError?.(error);
 
-                return;
-            }
-        }
+        return;
+      }
+    }
 
-        const hasUnparseConfig = typeof unparseConfig !== "undefined" && unparseConfig !== null;
+    const hasUnparseConfig =
+      typeof unparseConfig !== "undefined" && unparseConfig !== null;
 
-        warnOnce(hasUnparseConfig && typeof exportOptions !== "undefined" && exportOptions !== null,
-            `[useExport]: resource: "${identifier}" \n\n` +
-            `Both \`unparseConfig\` and \`exportOptions\` are set, \`unparseConfig\` will take precedence`,
-        )
+    warnOnce(
+      hasUnparseConfig &&
+        typeof exportOptions !== "undefined" &&
+        exportOptions !== null,
+      `[useExport]: resource: "${identifier}" \n\nBoth \`unparseConfig\` and \`exportOptions\` are set, \`unparseConfig\` will take precedence`,
+    );
 
-            const options: ExportOptions = {
-                filename,
-                useKeysAsHeaders: true,
-                useBom: true, // original default
-                title: 'My Generated Report', // original default
-                quoteStrings: '"', // original default
-                ...exportOptions
-            }
+    const options: ExportOptions = {
+      filename,
+      useKeysAsHeaders: true,
+      useBom: true, // original default
+      title: "My Generated Report", // original default
+      quoteStrings: '"', // original default
+      ...exportOptions,
+    };
 
-            warnOnce(exportOptions?.decimalSeparator !== undefined,
-                `[useExport]: resource: "${identifier}" \n\n` +
-                `Use of \`decimalSeparator\` no longer supported, please use \`mapData\` instead.\n\n` +
-                `See https://refine.dev/docs/api-reference/core/hooks/import-export/useExport/`,
-            )
+    warnOnce(
+      exportOptions?.decimalSeparator !== undefined,
+      `[useExport]: resource: "${identifier}" \n\nUse of \`decimalSeparator\` no longer supported, please use \`mapData\` instead.\n\nSee https://refine.dev/docs/api-reference/core/hooks/import-export/useExport/`,
+    );
 
-        if(!hasUnparseConfig) {
-            unparseConfig = {
-                // useKeysAsHeaders takes priority over options.headers
-                columns: options.useKeysAsHeaders ? undefined : options.headers,
-                delimiter: options.fieldSeparator,
-                header: options.showLabels || options.useKeysAsHeaders,
-                quoteChar: options.quoteStrings,
-                quotes: true
-            }
-        } else {
-            unparseConfig = {
-                // Set to force quote for better compatibility
-                quotes: true,
-                ...unparseConfig
-            }
-        }
+    if (!hasUnparseConfig) {
+      unparseConfig = {
+        // useKeysAsHeaders takes priority over options.headers
+        columns: options.useKeysAsHeaders ? undefined : options.headers,
+        delimiter: options.fieldSeparator,
+        header: options.showLabels || options.useKeysAsHeaders,
+        quoteChar: options.quoteStrings,
+        quotes: true,
+      };
+    } else {
+      unparseConfig = {
+        // Set to force quote for better compatibility
+        quotes: true,
+        ...unparseConfig,
+      };
+    }
 
-        let csv = unparse(rawData.map(mapData as any), unparseConfig);
-        if (options.showTitle) {
-            csv = options.title + '\r\n\n' + csv
-        }
+    let csv = papaparse.unparse(rawData.map(mapData as any), unparseConfig);
+    if (options.showTitle) {
+      csv = `${options.title}\r\n\n${csv}`;
+    }
 
-        // Backward compatibility support for downloadInBrowser of the exported file, only works for browsers.
-        if(typeof window !== "undefined" && csv.length > 0 && (download ?? true)){
-            const fileExtension = options.useTextFile ? '.txt' : '.csv';
-            const fileType = `text/${options.useTextFile ? "plain" : "csv"};charset=utf8;`;
-            const downloadFilename =
-                `${(options.filename ?? 'download').replace(/ /g, "_")}${fileExtension}`
+    // Backward compatibility support for downloadInBrowser of the exported file, only works for browsers.
+    if (typeof window !== "undefined" && csv.length > 0 && (download ?? true)) {
+      const fileExtension = options.useTextFile ? ".txt" : ".csv";
+      const fileType = `text/${
+        options.useTextFile ? "plain" : "csv"
+      };charset=utf8;`;
+      const downloadFilename = `${(options.filename ?? "download").replace(
+        / /g,
+        "_",
+      )}${fileExtension}`;
 
-            downloadInBrowser(
-                downloadFilename,
-                `${options?.useBom ? "\ufeff" : ""}${csv}`,
-                fileType
-            );
-        }
+      downloadInBrowser(
+        downloadFilename,
+        `${options?.useBom ? "\ufeff" : ""}${csv}`,
+        fileType,
+      );
+    }
 
-        setIsLoading(false);
-        return csv;
-    };
+    setIsLoading(false);
+    return csv;
+  };
 
-    return {
-        isLoading,
-        triggerExport,
-    };
+  return {
+    isLoading,
+    triggerExport,
+  };
 };

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;
+}