import papaparse from "papaparse"; import type { BaseRecord, HttpError, MetaQuery } from "../../contexts/data/types"; import type { UseCreateReturnType } from "../../hooks/data/useCreate"; import type { UseCreateManyReturnType } from "../../hooks/data/useCreateMany"; import type { MapDataFn } from "../export/types"; export type ImportSuccessResult = { request: TVariables[]; type: "success"; response: TData[]; }; export type ImportErrorResult = { request: TVariables[]; type: "error"; response: HttpError[]; }; export type OnFinishParams = { succeeded: ImportSuccessResult[]; errored: ImportErrorResult[]; }; export type OnProgressParams = { totalAmount: number; processedAmount: number; }; export type ImportOptions = { /** * 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; /** * 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) => void; /** * Metadata query for `dataProvider` */ meta?: MetaQuery; /** * Metadata query for `dataProvider` /** * 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 = ImportSuccessResult | ImportErrorResult; export type HandleChangeType = (onChangeParams: { file: Partial; }) => Promise[]>; export type UseImportInputPropsType = { type: "file"; accept: string; onChange: (event: React.ChangeEvent) => void; }; export type UseImportReturnType = { inputProps: UseImportInputPropsType; mutationResult: UseCreateReturnType | UseCreateManyReturnType; isLoading: boolean; handleChange: HandleChangeType; }; /** * `useImport` hook allows you to handle your csv import logic easily. * * @see {@link https://refine.dev/docs/api-reference/core/hooks/import-export/useImport} for more details. * * @typeParam TItem - Interface of parsed csv data * @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`} * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`} * @typeParam TVariables - Values for mutation function * */ export declare const useImport: ({ resource: resourceFromProps, mapData, paparseOptions, batchSize, onFinish, meta, onProgress, dataProviderName, }?: ImportOptions) => UseImportReturnType; //# sourceMappingURL=index.d.ts.map