import { ButtonProps, UploadProps } from "antd"; import { MapDataFn, BaseRecord, HttpError, MetaDataQuery } from "../../interfaces"; import { ParseConfig } from "papaparse"; import { UseCreateReturnType } from "@hooks/data/useCreate"; import { UseCreateManyReturnType } from "@hooks/data/useCreateMany"; export declare type ImportSuccessResult = { request: TVariables[]; type: "success"; response: TData[]; }; export declare type ImportErrorResult = { request: TVariables[]; type: "error"; response: HttpError[]; }; export declare type OnFinishParams = { succeeded: ImportSuccessResult[]; errored: ImportErrorResult[]; }; declare type ImportOptions = { resourceName?: string; mapData?: MapDataFn; paparseOptions?: ParseConfig; batchSize?: number; onFinish?: (results: OnFinishParams) => void; metaData?: MetaDataQuery; }; export declare type CreatedValuesType = ImportSuccessResult | ImportErrorResult; /** * `useImport` hook allows you to handle your csv import logic easily. * * @see {@link https://refine.dev/docs/api-references/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-references/interfaceReferences#baserecord `BaseRecord`} * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-references/interfaceReferences#httperror `HttpError`} * @typeParam TVariables - Values for mutation function * */ export declare const useImport: ({ resourceName, mapData, paparseOptions, batchSize, onFinish, metaData, }?: ImportOptions) => { uploadProps: UploadProps; buttonProps: ButtonProps; mutationResult: ({ data: undefined; error: null; isError: false; isIdle: true; isLoading: false; isSuccess: false; status: "idle"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: undefined; error: null; isError: false; isIdle: false; isLoading: true; isSuccess: false; status: "loading"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: undefined; error: TError; isError: true; isIdle: false; isLoading: false; isSuccess: false; status: "error"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: import("../../interfaces").CreateResponse; error: null; isError: false; isIdle: false; isLoading: false; isSuccess: true; status: "success"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: undefined; error: null; isError: false; isIdle: true; isLoading: false; isSuccess: false; status: "idle"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: undefined; error: null; isError: false; isIdle: false; isLoading: true; isSuccess: false; status: "loading"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: undefined; error: TError; isError: true; isIdle: false; isLoading: false; isSuccess: false; status: "error"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }) | ({ data: import("../../interfaces").CreateManyResponse; error: null; isError: false; isIdle: false; isLoading: false; isSuccess: true; status: "success"; mutate: import("react-query").UseMutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; reset: () => void; context: unknown; failureCount: number; isPaused: boolean; variables: ({ resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification) | undefined; } & { mutateAsync: import("react-query").MutateFunction, TError, { resource: string; values: TVariables[]; metaData?: MetaDataQuery | undefined; } & import("../../interfaces").SuccessErrorNotification, unknown>; }); }; export {};