@availity/mui-file-selector 2.0.6 → 3.0.0

package/dist/index.d.mts

@@ -1,450 +0,0 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { MouseEvent, Dispatch, ChangeEvent, RefObject, ReactNode } from 'react';
-import MuiBox from '@mui/material/Box';
-import { DropEvent, FileRejection, FileError, DropzoneInputProps } from 'react-dropzone';
-import Upload, { UploadOptions } from '@availity/upload-core';
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseQueryOptions } from '@tanstack/react-query';
-import { OnSuccessPayload } from 'tus-js-client';
-import { ButtonProps } from '@availity/mui-button';
-import { FileRejection as FileRejection$1, DropEvent as DropEvent$1, FileError as FileError$1 } from 'react-dropzone/typings/react-dropzone';
-
-declare const outerBoxStyles: {
-    backgroundColor: string;
-    border: string;
-    borderColor: string;
-    borderRadius: string;
-    padding: string;
-    '&:hover': {
-        backgroundColor: string;
-        borderColor: string;
-    };
-};
-declare const innerBoxStyles: {
-    width: string;
-    height: string;
-};
-/** Counter for creating unique id */
-declare const createCounter: () => {
-    id: number;
-    increment: () => number;
-};
-type DropzoneProps = {
-    /**
-     * Name given to the input field. Used by react-hook-form
-     */
-    name: string;
-    /**
-     * List of allowed file extensions (e.g. ['.pdf', '.doc']). Each extension must start with a dot
-     */
-    allowedFileTypes?: `.${string}`[];
-    /**
-     * Regular expression pattern of allowed characters in file names
-     * @example "a-zA-Z0-9-_."
-     */
-    allowedFileNameCharacters?: string;
-    /**
-     * Whether the dropzone is disabled
-     */
-    disabled?: boolean;
-    /**
-     * Whether to enable the dropzone area
-     */
-    enableDropArea?: boolean;
-    /**
-     * Maximum number of files that can be uploaded
-     */
-    maxFiles?: number;
-    /**
-     * Maximum size of each file in bytes
-     */
-    maxSize?: number;
-    /**
-     * Maximum size of total upload in bytes
-     */
-    maxTotalSize?: number;
-    /**
-     * Whether multiple file selection is allowed
-     */
-    multiple?: boolean;
-    /**
-     * Handler called when the file input's value changes
-     */
-    onChange?: (event: DropEvent) => void;
-    /**
-     * Handler called when the file picker button is clicked
-     */
-    onClick?: (event: MouseEvent<HTMLButtonElement>) => void;
-    /**
-     * More sophisticated version of "onChange". This is the recommend function to use for changes to the form state
-     */
-    onDrop?: (acceptedFiles: File[], fileRejections: (FileRejection & {
-        id: number;
-    })[], event: DropEvent) => void;
-    /**
-     * Callback to handle rejected files that don't meet validation criteria
-     */
-    setFileRejections?: (fileRejections: (FileRejection & {
-        id: number;
-    })[]) => void;
-    /**
-     * Callback to update the total size of all uploaded files
-     */
-    setTotalSize: Dispatch<React.SetStateAction<number>>;
-    /**
-     * Validation function used for custom validation that is not covered with the other props
-     * */
-    validator?: (file: File) => FileError | FileError[] | null;
-};
-declare const DropzoneContainer: typeof MuiBox;
-declare const Dropzone: ({ allowedFileTypes, allowedFileNameCharacters, disabled, enableDropArea, maxFiles, maxSize, maxTotalSize, multiple, name, onChange, onClick, onDrop, setFileRejections, setTotalSize, validator, }: DropzoneProps) => react_jsx_runtime.JSX.Element;
-
-type Dropzone2Props = DropzoneProps & {
-    uploadOptions: UploadOptions;
-};
-/**
- * `<Dropzone2 />` is the future of the the `<Dropzone />` component. In a
- * future release, the `<Dropzone />` and `<Dropzone2 />` components will be
- * consolidated into a single component.
- *
- * `<Dropzone2 />` adds the `uploadOptions` prop that previously existed on
- * `<FileSelector />`.
- */
-declare const Dropzone2: ({ allowedFileTypes, disabled, enableDropArea, maxFiles, maxSize, maxTotalSize, multiple, name, onChange, onClick, onDrop, setFileRejections, setTotalSize, uploadOptions, validator, }: Dropzone2Props) => react_jsx_runtime.JSX.Element;
-
-type ErrorAlertProps = {
-    /**
-     * Array of file rejection errors
-     */
-    errors: FileRejection['errors'];
-    /**
-     * Name of the file that encountered errors
-     */
-    fileName: string;
-    /**
-     * Unique identifier for the error alert
-     */
-    id: number;
-    onClose: () => void;
-};
-declare const formatFileTooLarge: (message: string) => string;
-declare const ErrorAlert: ({ errors, fileName, id, onClose }: ErrorAlertProps) => react_jsx_runtime.JSX.Element | null;
-
-type Options = {
-    onError?: (error: Error) => void;
-    onSuccess?: (response: OnSuccessPayload) => void;
-    onProgress?: () => void;
-    onChunkComplete?: (chunkSize: number, bytesAccepted: number, bytesTotal: number | null) => void;
-} & UploadOptions;
-type UploadQueryOptions = UseQueryOptions<Upload, Error, Upload, [string, string, Options]>;
-declare function useUploadCore(file: File, options: Options, queryOptions?: UploadQueryOptions): _tanstack_react_query.UseQueryResult<Upload, Error>;
-
-type FileRowProps = {
-    /**
-     * The File object containing information about the uploaded file
-     * */
-    file: File;
-    /**
-     * Callback function called when a file is removed
-     * @param id - The unique identifier of the file being removed
-     * @param upload - The Upload instance associated with the file
-     */
-    onRemoveFile: (id: string, upload: Upload) => void;
-    /**
-     * Configuration options for the upload call
-     * */
-    options: Options;
-    /**
-     * Query options from `react-query` for the upload call
-     * */
-    queryOptions?: UploadQueryOptions;
-    customFileRow?: React.ElementType<{
-        upload?: Upload;
-        options: Options;
-        onRemoveFile: (id: string, upload: Upload) => void;
-    }>;
-    /**
-     * Whether the remove button is disabled
-     * @default false
-     */
-    disableRemove?: boolean;
-};
-declare const FileRow: ({ file, options, onRemoveFile, queryOptions, customFileRow: CustomRow, disableRemove, }: FileRowProps) => react_jsx_runtime.JSX.Element | null;
-type FileListProps = {
-    /**
-     * Array of File objects to be displayed in the list
-     */
-    files: File[];
-} & Omit<FileRowProps, 'file'>;
-declare const FileList: ({ files, options, onRemoveFile, queryOptions, customFileRow, disableRemove, }: FileListProps) => React.JSX.Element | null;
-
-type FileRow2Props = Omit<FileRowProps, 'file' | 'queryOptions'> & {
-    /**
-     * The File object containing information about the uploaded file
-     * */
-    upload: Upload;
-};
-/**
- * `<FileRow2 />` is the future of the the `<FileRow />` component. In a
- * future release, the `<FileRow />` and `<FileRow2 />` components will be
- * consolidated into a single component.
- *
- * `<FileRow2 />` replaces the `file` prop with the `upload` prop and
- * removes the `queryOptions` prop.
- */
-declare const FileRow2: ({ upload, options, onRemoveFile, customFileRow: CustomRow, disableRemove, }: FileRow2Props) => react_jsx_runtime.JSX.Element | null;
-type FileList2Props = Omit<FileListProps, 'files'> & {
-    /**
-     * Array of File objects to be displayed in the list
-     */
-    uploads: Upload[];
-} & Omit<FileRow2Props, 'upload'>;
-/**
- * `<FileList2 />` is the future of the the `<FileList />` component. In a
- * future release, the `<FileList />` and `<FileList2 />` components will
- * be consolidated into a single component.
- *
- * `<FileList2 />` replaces the `files` prop with the `uploads` prop.
- */
-declare const FileList2: ({ uploads, options, onRemoveFile, customFileRow, disableRemove, }: FileList2Props) => React.JSX.Element | null;
-
-type FilePickerBtnProps = {
-    /**
-     * Name attribute for the input field, used by react-hook-form for form state management.
-     */
-    name: string;
-    /**
-     *  Callback function triggered when files are selected through the input.
-     */
-    onChange: (event: ChangeEvent<HTMLInputElement>) => void;
-    /**
-     * Optional ID attribute for the file input element.
-     */
-    inputId?: string;
-    /**
-     * Additional props to customize the underlying input element.
-     */
-    inputProps?: DropzoneInputProps & {
-        ref?: RefObject<HTMLInputElement | null>;
-    };
-    /**
-     * Maximum allowed size per file in bytes. Files exceeding this size will be rejected.
-     */
-    maxSize?: number;
-} & Omit<ButtonProps, 'onChange'>;
-declare const FilePickerBtn: ({ name, children, color, inputId, inputProps, maxSize, onChange, onClick, ...rest }: FilePickerBtnProps) => react_jsx_runtime.JSX.Element;
-
-declare const CLOUD_URL = "/cloud/web/appl/vault/upload/v1/resumable";
-type FileSelectorProps = {
-    /**
-     * Name attribute for the form field. Used by react-hook-form for form state management
-     * and must be unique within the form context
-     */
-    name: string;
-    /**
-     * The ID of the bucket where files will be uploaded
-     */
-    bucketId: string;
-    /**
-     * The customer ID associated with the upload
-     */
-    customerId: string;
-    /**
-     * Regular expression pattern of allowed characters in file names
-     * @example "a-zA-Z0-9-_."
-     */
-    allowedFileNameCharacters?: string;
-    /**
-     * List of allowed file extensions. Each extension must start with a dot
-     * @example ['.pdf', '.doc', '.docx']
-     * @default []
-     */
-    allowedFileTypes?: `.${string}`[];
-    /**
-     * Optional content to render below the file upload area
-     */
-    children?: ReactNode;
-    /**
-     * Client identifier used for upload authentication
-     */
-    clientId: string;
-    /**
-     * Whether the file selector is disabled
-     * @default false
-     */
-    disabled?: boolean;
-    /**
-     * Overrides the standard file size message
-     */
-    customSizeMessage?: React.ReactNode;
-    /**
-     * Overrides the standard total upload size message
-     */
-    customTotalSizeMessage?: React.ReactNode;
-    /**
-     * Overrides the standard file types message
-     */
-    customTypesMessage?: React.ReactNode;
-    /**
-     * Whether to enable the dropzone area
-     */
-    enableDropArea?: boolean;
-    /**
-     * Custom endpoint URL for file uploads. If not provided, default endpoint will be used
-     */
-    endpoint?: string;
-    /**
-     * Component to render the File information. This should return a `ListItem`
-     */
-    customFileRow?: React.ElementType<{
-        upload?: Upload;
-        options: Options;
-        onRemoveFile: (id: string, upload: Upload) => void;
-    }>;
-    /**
-     * Whether to use the cloud upload endpoint
-     * When true, uses '/cloud/web/appl/vault/upload/v1/resumable'
-     * @default true
-     */
-    isCloud?: boolean;
-    /**
-     * Label text or element displayed above the upload area
-     * @default 'Upload file'
-     */
-    label?: ReactNode;
-    /**
-     * Maximum number of files that can be uploaded simultaneously
-     */
-    maxFiles: number;
-    /**
-     * Maximum file size allowed per file in bytes
-     * Use Kibi or Mibibytes. eg: 1kb = 1024 bytes; 1mb = 1024kb
-     */
-    maxSize: number;
-    /**
-     * Maximum size allowed for total upload in bytes
-     * Use Kibi or Mibibytes. eg: 1kb = 1024 bytes; 1mb = 1024kb
-     */
-    maxTotalSize?: number;
-    /**
-     * Whether multiple file selection is allowed
-     * @default true
-     */
-    multiple?: boolean;
-    /**
-     * Callback fired when files are selected
-     * @param event - The change event containing the selected file(s)
-     */
-    onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
-    /**
-     *
-     */
-    onDrop?: (acceptedFiles: File[], fileRejections: (FileRejection$1 & {
-        id: number;
-    })[], event: DropEvent$1) => void;
-    /**
-     * Callback fired when a file is removed from the upload list
-     * @param files - Array of remaining files
-     * @param removedUploadId - ID of the removed upload
-     */
-    onUploadRemove?: (files: File[], removedUploadId: string) => void;
-    /**
-     * Query options from `react-query` for the upload call
-     * */
-    queryOptions?: UploadQueryOptions;
-    /**
-     * Options that are passed to the Upload class from `@availity/upload-core`
-     */
-    uploadOptions?: Partial<Options>;
-    /**
-     * Validation function used for custom validation that is not covered with the other props
-     * */
-    validator?: (file: File) => FileError$1 | FileError$1[] | null;
-    /**
-     * Whether the remove button is disabled
-     * @default false
-     */
-    disableRemove?: boolean;
-};
-declare const FileSelector: ({ name, allowedFileNameCharacters, allowedFileTypes, bucketId, clientId, children, customSizeMessage, customTotalSizeMessage, customTypesMessage, customerId, customFileRow, disabled, enableDropArea, endpoint, isCloud, label, maxFiles, maxSize, maxTotalSize, multiple, onChange, onDrop, onUploadRemove, queryOptions, uploadOptions, validator, disableRemove, }: FileSelectorProps) => react_jsx_runtime.JSX.Element;
-
-type FileSelector2Props = Omit<FileSelectorProps, 'onUploadRemove' | 'queryOptions'> & {
-    onUploadRemove?: (uploads: Upload[], removedUploadId: string) => void;
-};
-/**
- * `<FileSelector2 />` is the future of the the `<FileSelector />`
- * component. In a future major release, the `<FileSelector />` and
- * `<FileSelector2 />` components will be consolidated into a single
- * component.
- *
- * `<FileSelector2 />` removes the reliance on `@tanstack/react-query`. The
- * `Upload` object can now be accessed from the form state.
- */
-declare const FileSelector2: ({ name, allowedFileNameCharacters, allowedFileTypes, bucketId, clientId, children, customSizeMessage, customTotalSizeMessage, customTypesMessage, customerId, customFileRow, disabled, enableDropArea, endpoint, isCloud, label, maxFiles, maxSize, maxTotalSize, multiple, onChange, onDrop, onUploadRemove, uploadOptions, validator, disableRemove, }: FileSelector2Props) => react_jsx_runtime.JSX.Element;
-
-type FileTypesMessageProps = {
-    /**
-     * Allowed file type extensions. Each extension should be prefixed with a ".". eg: .txt, .pdf, .png
-     */
-    allowedFileTypes?: `.${string}`[];
-    /**
-     * Overrides the standard file size message
-     */
-    customSizeMessage?: React.ReactNode;
-    /**
-     * Overrides the standard total upload size message
-     */
-    customTotalSizeMessage?: React.ReactNode;
-    /**
-     * Overrides the standard file types message
-     */
-    customTypesMessage?: React.ReactNode;
-    /**
-     * Maximum size per file in bytes. This will be formatted. eg: 1024 * 20 = 20 KB
-     */
-    maxFileSize?: number;
-    /**
-     * Maximum size of the total upload in bytes. This will be formatted. eg: 1024 * 20 = 20 KB
-     */
-    maxTotalSize?: number;
-    variant?: 'caption' | 'body2';
-};
-declare const FileTypesMessage: ({ allowedFileTypes, customSizeMessage, customTotalSizeMessage, customTypesMessage, maxFileSize, maxTotalSize, variant, }: FileTypesMessageProps) => react_jsx_runtime.JSX.Element;
-
-type HeaderMessageProps = {
-    /**
-     * Maximum number of files allowed
-     */
-    maxFiles: number;
-    /**
-     * Maximum size of each file
-     */
-    maxSize: number;
-    /**
-     * Maximum combined total size of all files
-     */
-    maxTotalSize?: number;
-};
-declare const HeaderMessage: ({ maxFiles, maxSize, maxTotalSize }: HeaderMessageProps) => react_jsx_runtime.JSX.Element;
-
-type UploadProgressBarProps = {
-    /**
-     * The upload instance returned by creating a new Upload via @availity/upload-core.
-     */
-    upload: Upload;
-    /**
-     * Callback function to hook into the onProgress within the Upload instance provided in the upload prop.
-     */
-    onProgress?: (upload: Upload) => void;
-    /**
-     * Callback function to hook into the onSuccess within the Upload instance provided in the upload prop.
-     */
-    onSuccess?: (upload: Upload) => void;
-    /**
-     * Callback function to hook into the onError within the Upload instance provided in the upload prop.
-     */
-    onError?: (upload: Upload) => void;
-};
-declare const UploadProgressBar: ({ upload, onProgress, onError, onSuccess }: UploadProgressBarProps) => react_jsx_runtime.JSX.Element;
-
-export { CLOUD_URL, Dropzone, Dropzone2, type Dropzone2Props, DropzoneContainer, type DropzoneProps, ErrorAlert, type ErrorAlertProps, FileList, FileList2, type FileList2Props, type FileListProps, FilePickerBtn, type FilePickerBtnProps, FileRow, FileRow2, type FileRow2Props, type FileRowProps, FileSelector, FileSelector2, type FileSelector2Props, type FileSelectorProps, FileTypesMessage, type FileTypesMessageProps, HeaderMessage, type HeaderMessageProps, type Options, UploadProgressBar, type UploadProgressBarProps, type UploadQueryOptions, createCounter, formatFileTooLarge, innerBoxStyles, outerBoxStyles, useUploadCore };