@refinedev/core 4.47.2 → 4.49.0

package/src/hooks/i18n/useTranslation.tsx

@@ -0,0 +1,24 @@
+import { useGetLocale } from "./useGetLocale";
+import { useSetLocale } from "./useSetLocale";
+import { useTranslate } from "./useTranslate";
+
+/**
+ * It combines `useTranslate`, `useSetLocale` and `useGetLocale` hooks for a better developer experience.
+ * It returns `i18nProvider` methods under the hood.
+ * @returns `translate` method to translate the texts.
+ * @returns `changeLocale` method to change the locale
+ * @returns `getLocale` method to get the current locale.
+ *
+ * @see {@link https://refine.dev/docs/i18n/i18n-provider/} for more details.
+ */
+export const useTranslation = () => {
+  const translate = useTranslate();
+  const changeLocale = useSetLocale();
+  const getLocale = useGetLocale();
+
+  return {
+    translate,
+    changeLocale,
+    getLocale,
+  };
+};

package/src/hooks/import/index.tsx

@@ -1,118 +1,121 @@
 import { useEffect, useState } from "react";
-import { parse, ParseConfig } from "papaparse";
+
 import chunk from "lodash/chunk";
+import papaparse from "papaparse";
 
-import { useCreate, useCreateMany, useMeta, useResource } from "@hooks";
-import { MapDataFn, BaseRecord, HttpError, MetaQuery } from "../../interfaces";
 import {
-    importCSVMapper,
-    sequentialPromises,
-    pickNotDeprecated,
+  importCSVMapper,
+  pickNotDeprecated,
+  sequentialPromises,
 } from "@definitions";
+import { useCreate, useCreateMany, useMeta, useResource } from "@hooks";
+
+import { BaseRecord, HttpError, MetaQuery } from "../../contexts/data/types";
 import { UseCreateReturnType } from "../../hooks/data/useCreate";
 import { UseCreateManyReturnType } from "../../hooks/data/useCreateMany";
+import { MapDataFn } from "../export/types";
 
 export type ImportSuccessResult<TVariables, TData> = {
-    request: TVariables[];
-    type: "success";
-    response: TData[];
+  request: TVariables[];
+  type: "success";
+  response: TData[];
 };
 
 export type ImportErrorResult<TVariables> = {
-    request: TVariables[];
-    type: "error";
-    response: HttpError[];
+  request: TVariables[];
+  type: "error";
+  response: HttpError[];
 };
 
 export type OnFinishParams<TVariables, TData> = {
-    succeeded: ImportSuccessResult<TVariables, TData>[];
-    errored: ImportErrorResult<TVariables>[];
+  succeeded: ImportSuccessResult<TVariables, TData>[];
+  errored: ImportErrorResult<TVariables>[];
 };
 
 export type OnProgressParams = {
-    totalAmount: number;
-    processedAmount: number;
+  totalAmount: number;
+  processedAmount: number;
 };
 
 export type ImportOptions<
-    TItem,
-    TVariables = any,
-    TData extends BaseRecord = BaseRecord,
+  TItem,
+  TVariables = any,
+  TData extends BaseRecord = BaseRecord,
 > = {
-    /**
-     * 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<TItem, TVariables>;
-    /**
-     * Custom Papa Parse options.
-     * @type [`ParseConfig`](https://www.papaparse.com/docs)
-     */
-    paparseOptions?: ParseConfig;
-    /**
-     * Requests batch size. If it is 1, all records are sent one by one. By default, it is [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) to send all records in one batch. If it is more than 1, `createMany` should be implemented on DataProvider.
-     */
-    batchSize?: number;
-    /**
-     * Called with errors and successful responses when all requests are sent.
-     */
-    onFinish?: (results: OnFinishParams<TVariables, TData>) => void;
-    /**
-     *  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;
-    /**
-     *  A callback function that returns a current state of uploading process.
-     *
-     *  Ex: `percentage = onProgressParams.processedAmount / onProgressParams.totalAmount * 100`
-     */
-    onProgress?: (onProgressParams: OnProgressParams) => void;
-    /**
-     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
-     */
-    dataProviderName?: string;
+  /**
+   * 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<TItem, TVariables>;
+  /**
+   * Custom Papa Parse options.
+   * @type [`ParseConfig`](https://www.papaparse.com/docs)
+   */
+  paparseOptions?: papaparse.ParseConfig;
+  /**
+   * Requests batch size. If it is 1, all records are sent one by one. By default, it is [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) to send all records in one batch. If it is more than 1, `createMany` should be implemented on DataProvider.
+   */
+  batchSize?: number;
+  /**
+   * Called with errors and successful responses when all requests are sent.
+   */
+  onFinish?: (results: OnFinishParams<TVariables, TData>) => void;
+  /**
+   *  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;
+  /**
+   *  A callback function that returns a current state of uploading process.
+   *
+   *  Ex: `percentage = onProgressParams.processedAmount / onProgressParams.totalAmount * 100`
+   */
+  onProgress?: (onProgressParams: OnProgressParams) => void;
+  /**
+   * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
+   */
+  dataProviderName?: string;
 };
 
 export type CreatedValuesType<TVariables, TData> =
-    | ImportSuccessResult<TVariables, TData>
-    | ImportErrorResult<TVariables>;
+  | ImportSuccessResult<TVariables, TData>
+  | ImportErrorResult<TVariables>;
 
 export type HandleChangeType<TVariables, TData> = (onChangeParams: {
-    file: Partial<File>;
+  file: Partial<File>;
 }) => Promise<CreatedValuesType<TVariables, TData>[]>;
 
 export type UseImportInputPropsType = {
-    type: "file";
-    accept: string;
-    onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+  type: "file";
+  accept: string;
+  onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
 };
 
 export type UseImportReturnType<
-    TData extends BaseRecord = BaseRecord,
-    TVariables = {},
-    TError extends HttpError = HttpError,
+  TData extends BaseRecord = BaseRecord,
+  TVariables = {},
+  TError extends HttpError = HttpError,
 > = {
-    inputProps: UseImportInputPropsType;
-    mutationResult:
-        | UseCreateReturnType<TData, TError, TVariables>
-        | UseCreateManyReturnType<TData, TError, TVariables>;
-    isLoading: boolean;
-    handleChange: HandleChangeType<TVariables, TData>;
+  inputProps: UseImportInputPropsType;
+  mutationResult:
+    | UseCreateReturnType<TData, TError, TVariables>
+    | UseCreateManyReturnType<TData, TError, TVariables>;
+  isLoading: boolean;
+  handleChange: HandleChangeType<TVariables, TData>;
 };
 
 /**
@@ -127,210 +130,204 @@ export type UseImportReturnType<
  *
  */
 export const useImport = <
-    TItem = any,
-    TData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = any,
+  TItem = any,
+  TData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = any,
 >({
-    resourceName,
-    resource: resourceFromProps,
-    mapData = (item) => item as unknown as TVariables,
-    paparseOptions,
-    batchSize = Number.MAX_SAFE_INTEGER,
-    onFinish,
-    meta,
-    metaData,
-    onProgress,
-    dataProviderName,
+  resourceName,
+  resource: resourceFromProps,
+  mapData = (item) => item as unknown as TVariables,
+  paparseOptions,
+  batchSize = Number.MAX_SAFE_INTEGER,
+  onFinish,
+  meta,
+  metaData,
+  onProgress,
+  dataProviderName,
 }: ImportOptions<TItem, TVariables, TData> = {}): UseImportReturnType<
-    TData,
-    TVariables,
-    TError
+  TData,
+  TVariables,
+  TError
 > => {
-    const [processedAmount, setProcessedAmount] = useState<number>(0);
-    const [totalAmount, setTotalAmount] = useState<number>(0);
-    const [isLoading, setIsLoading] = useState(false);
+  const [processedAmount, setProcessedAmount] = useState<number>(0);
+  const [totalAmount, setTotalAmount] = useState<number>(0);
+  const [isLoading, setIsLoading] = useState(false);
 
-    const { resource, identifier } = useResource(
-        resourceFromProps ?? resourceName,
-    );
+  const { resource, identifier } = useResource(
+    resourceFromProps ?? resourceName,
+  );
 
-    const getMeta = useMeta();
+  const getMeta = useMeta();
 
-    const createMany = useCreateMany<TData, TError, TVariables>();
-    const create = useCreate<TData, TError, TVariables>();
+  const createMany = useCreateMany<TData, TError, TVariables>();
+  const create = useCreate<TData, TError, TVariables>();
 
-    const combinedMeta = getMeta({
-        resource,
-        meta: pickNotDeprecated(meta, metaData),
-    });
+  const combinedMeta = getMeta({
+    resource,
+    meta: pickNotDeprecated(meta, metaData),
+  });
 
-    let mutationResult:
-        | UseCreateReturnType<TData, TError, TVariables>
-        | UseCreateManyReturnType<TData, TError, TVariables>;
+  let mutationResult:
+    | UseCreateReturnType<TData, TError, TVariables>
+    | UseCreateManyReturnType<TData, TError, TVariables>;
 
-    if (batchSize === 1) {
-        mutationResult = create;
-    } else {
-        mutationResult = createMany;
-    }
+  if (batchSize === 1) {
+    mutationResult = create;
+  } else {
+    mutationResult = createMany;
+  }
 
-    const handleCleanup = () => {
-        setTotalAmount(0);
-        setProcessedAmount(0);
-        setIsLoading(false);
-    };
+  const handleCleanup = () => {
+    setTotalAmount(0);
+    setProcessedAmount(0);
+    setIsLoading(false);
+  };
 
-    const handleFinish = (
-        createdValues: CreatedValuesType<TVariables, TData>[],
-    ) => {
-        const result = {
-            succeeded: createdValues.filter(
-                (item) => item.type === "success",
-            ) as unknown as ImportSuccessResult<TVariables, TData>[],
-            errored: createdValues.filter(
-                (item) => item.type === "error",
-            ) as unknown as ImportErrorResult<TVariables>[],
-        };
-
-        onFinish?.(result);
-        setIsLoading(false);
+  const handleFinish = (
+    createdValues: CreatedValuesType<TVariables, TData>[],
+  ) => {
+    const result = {
+      succeeded: createdValues.filter(
+        (item) => item.type === "success",
+      ) as unknown as ImportSuccessResult<TVariables, TData>[],
+      errored: createdValues.filter(
+        (item) => item.type === "error",
+      ) as unknown as ImportErrorResult<TVariables>[],
     };
 
-    useEffect(() => {
-        onProgress?.({ totalAmount, processedAmount });
-    }, [totalAmount, processedAmount]);
-
-    const handleChange: HandleChangeType<TVariables, TData> = ({ file }) => {
-        handleCleanup();
-        return new Promise<CreatedValuesType<TVariables, TData>[]>(
-            (resolve) => {
-                setIsLoading(true);
-                parse(file as any, {
-                    complete: async ({ data }: { data: unknown[][] }) => {
-                        const values = importCSVMapper(data, mapData);
-
-                        setTotalAmount(values.length);
-
-                        if (batchSize === 1) {
-                            // Create Processor Functions
-                            const valueFns = values.map((value) => {
-                                const fn = async () => {
-                                    const response = await create.mutateAsync({
-                                        resource: identifier ?? "",
-                                        values: value,
-                                        successNotification: false,
-                                        errorNotification: false,
-                                        dataProviderName,
-                                        meta: combinedMeta,
-                                        metaData: combinedMeta,
-                                    });
-
-                                    return { response, value };
-                                };
-                                return fn;
-                            });
-                            // Sequentially run processor functions and process resolves/rejects
-                            const createdValues = await sequentialPromises(
-                                valueFns,
-                                ({ response, value }) => {
-                                    setProcessedAmount((currentAmount) => {
-                                        return currentAmount + 1;
-                                    });
-
-                                    return {
-                                        response: [response.data],
-                                        type: "success",
-                                        request: [value],
-                                    } as ImportSuccessResult<TVariables, TData>;
-                                },
-                                (error: HttpError, index) => {
-                                    return {
-                                        response: [error],
-                                        type: "error",
-                                        request: [values[index]],
-                                    } as ImportErrorResult<TVariables>;
-                                },
-                            );
-                            // Resolve with created values
-                            resolve(createdValues);
-                        } else {
-                            // Create Chunks
-                            const chunks = chunk(values, batchSize);
-                            // Create Chunk Processor Functions
-                            const chunkedFns = chunks.map((chunkedValues) => {
-                                const fn = async () => {
-                                    const response =
-                                        await createMany.mutateAsync({
-                                            resource: identifier ?? "",
-                                            values: chunkedValues,
-                                            successNotification: false,
-                                            errorNotification: false,
-                                            dataProviderName,
-                                            meta: combinedMeta,
-                                            metaData: combinedMeta,
-                                        });
-
-                                    return {
-                                        response,
-                                        value: chunkedValues,
-                                        currentBatchLength:
-                                            chunkedValues.length,
-                                    };
-                                };
-
-                                return fn;
-                            });
-                            // Sequentially run chunked functions and process resolves/rejects
-                            const createdValues = await sequentialPromises(
-                                chunkedFns,
-                                ({ response, currentBatchLength, value }) => {
-                                    setProcessedAmount((currentAmount) => {
-                                        return (
-                                            currentAmount + currentBatchLength
-                                        );
-                                    });
-
-                                    return {
-                                        response: response.data,
-                                        type: "success",
-                                        request: value,
-                                    } as ImportSuccessResult<TVariables, TData>;
-                                },
-                                (error: HttpError, index) => {
-                                    return {
-                                        response: [error],
-                                        type: "error",
-                                        request: chunks[index],
-                                    } as ImportErrorResult<TVariables>;
-                                },
-                            );
-                            // resolve with all created values
-                            resolve(createdValues);
-                        }
-                    },
-
-                    ...paparseOptions,
+    onFinish?.(result);
+    setIsLoading(false);
+  };
+
+  useEffect(() => {
+    onProgress?.({ totalAmount, processedAmount });
+  }, [totalAmount, processedAmount]);
+
+  const handleChange: HandleChangeType<TVariables, TData> = ({ file }) => {
+    handleCleanup();
+    return new Promise<CreatedValuesType<TVariables, TData>[]>((resolve) => {
+      setIsLoading(true);
+      papaparse.parse(file as any, {
+        complete: async ({ data }: { data: unknown[][] }) => {
+          const values = importCSVMapper(data, mapData);
+
+          setTotalAmount(values.length);
+
+          if (batchSize === 1) {
+            // Create Processor Functions
+            const valueFns = values.map((value) => {
+              const fn = async () => {
+                const response = await create.mutateAsync({
+                  resource: identifier ?? "",
+                  values: value,
+                  successNotification: false,
+                  errorNotification: false,
+                  dataProviderName,
+                  meta: combinedMeta,
+                  metaData: combinedMeta,
                 });
-            },
-        ).then((createdValues) => {
-            handleFinish(createdValues);
-            return createdValues;
-        });
-    };
 
-    return {
-        inputProps: {
-            type: "file",
-            accept: ".csv",
-            onChange: (event: React.ChangeEvent<HTMLInputElement>) => {
-                if (event.target.files && event.target.files.length > 0) {
-                    handleChange({ file: event.target.files[0] });
-                }
-            },
+                return { response, value };
+              };
+              return fn;
+            });
+            // Sequentially run processor functions and process resolves/rejects
+            const createdValues = await sequentialPromises(
+              valueFns,
+              ({ response, value }) => {
+                setProcessedAmount((currentAmount) => {
+                  return currentAmount + 1;
+                });
+
+                return {
+                  response: [response.data],
+                  type: "success",
+                  request: [value],
+                } as ImportSuccessResult<TVariables, TData>;
+              },
+              (error: HttpError, index) => {
+                return {
+                  response: [error],
+                  type: "error",
+                  request: [values[index]],
+                } as ImportErrorResult<TVariables>;
+              },
+            );
+            // Resolve with created values
+            resolve(createdValues);
+          } else {
+            // Create Chunks
+            const chunks = chunk(values, batchSize);
+            // Create Chunk Processor Functions
+            const chunkedFns = chunks.map((chunkedValues) => {
+              const fn = async () => {
+                const response = await createMany.mutateAsync({
+                  resource: identifier ?? "",
+                  values: chunkedValues,
+                  successNotification: false,
+                  errorNotification: false,
+                  dataProviderName,
+                  meta: combinedMeta,
+                  metaData: combinedMeta,
+                });
+
+                return {
+                  response,
+                  value: chunkedValues,
+                  currentBatchLength: chunkedValues.length,
+                };
+              };
+
+              return fn;
+            });
+            // Sequentially run chunked functions and process resolves/rejects
+            const createdValues = await sequentialPromises(
+              chunkedFns,
+              ({ response, currentBatchLength, value }) => {
+                setProcessedAmount((currentAmount) => {
+                  return currentAmount + currentBatchLength;
+                });
+
+                return {
+                  response: response.data,
+                  type: "success",
+                  request: value,
+                } as ImportSuccessResult<TVariables, TData>;
+              },
+              (error: HttpError, index) => {
+                return {
+                  response: [error],
+                  type: "error",
+                  request: chunks[index],
+                } as ImportErrorResult<TVariables>;
+              },
+            );
+            // resolve with all created values
+            resolve(createdValues);
+          }
         },
-        mutationResult,
-        isLoading,
-        handleChange,
-    };
+
+        ...paparseOptions,
+      });
+    }).then((createdValues) => {
+      handleFinish(createdValues);
+      return createdValues;
+    });
+  };
+
+  return {
+    inputProps: {
+      type: "file",
+      accept: ".csv",
+      onChange: (event: React.ChangeEvent<HTMLInputElement>) => {
+        if (event.target.files && event.target.files.length > 0) {
+          handleChange({ file: event.target.files[0] });
+        }
+      },
+    },
+    mutationResult,
+    isLoading,
+    handleChange,
+  };
 };

package/src/hooks/index.ts

@@ -3,7 +3,7 @@ export * from "./data";
 export * from "./live";
 export * from "./resource";
 export * from "./notification";
-export * from "./translate";
+export * from "./i18n";
 export * from "./refine";
 export * from "./export";
 export * from "./form";
@@ -13,7 +13,7 @@ export * from "./show";
 export * from "./import";
 export * from "./modal";
 export * from "./router";
-export { useRouterType } from "../contexts/router-picker";
+export { useRouterType } from "../contexts/router/picker";
 export * from "./legacy-router";
 export * from "./accessControl";
 export * from "./useSelect";
@@ -24,3 +24,7 @@ export * from "./breadcrumb";
 export * from "./menu";
 export * from "./useMeta";
 export * from "./useLoadingOvertime";
+export * from "./useKeys";
+export * from "./use-refine-options";
+export * from "./use-resource-params";
+export * from "./button";