@react-md/core 1.0.0-next.16 → 1.0.0-next.18

package/dist/{form → files}/useFileUpload.js

@@ -1,7 +1,8 @@
 "use client";
 import { nanoid } from "nanoid";
 import { useCallback, useEffect, useReducer } from "react";
-import { FileAccessError, getFileParser as defaultGetFileParser, isValidFileName as defaultIsValidFileName, validateFiles as defaultValidateFiles } from "./fileUtils.js";
+import { getFileParser as defaultGetFileParser } from "./utils.js";
+import { FileAccessError, isValidFileName as defaultIsValidFileName, validateFiles as defaultValidateFiles } from "./validation.js";
 const noop = ()=>{
 // do nothing
 };
@@ -13,9 +14,6 @@ const noop = ()=>{
  * can also be used to upload the files as an `ArrayBuffer` and then uploaded to
  * a server.
  *
- * Note: If using the `aws-sdk` to upload files directly to S3, **do not use
- * this hook** since it uses its own upload process.
- *
  * @typeParam E - An optional HTMLElement type that is used for the
  * {@link FileUploadHandlers}.
  * @typeParam CustomError - An optional error type that gets returned from the
@@ -23,7 +21,8 @@ const noop = ()=>{
  * @param options - All the {@link FileUploadOptions}
  * @returns the {@link FileUploadHookReturnValue}
  * @since 2.9.0
- */ export function useFileUpload({ maxFiles = -1, extensions = EMPTY_LIST, minFileSize = -1, maxFileSize = -1, totalFileSize = -1, concurrency = -1, onDrop: propOnDrop = noop, onChange: propOnChange = noop, validateFiles = defaultValidateFiles, getFileParser = defaultGetFileParser, isValidFileName = defaultIsValidFileName } = {}) {
+ */ export function useFileUpload(options = {}) {
+    const { maxFiles = -1, extensions = EMPTY_LIST, minFileSize = -1, maxFileSize = -1, totalFileSize = -1, concurrency = -1, onDrop: propOnDrop = noop, onChange: propOnChange = noop, validateFiles = defaultValidateFiles, getFileParser = defaultGetFileParser, isValidFileName = defaultIsValidFileName } = options;
     const [state, dispatch] = useReducer(function reducer(state, action) {
         switch(action.type){
             case "reset":
@@ -291,8 +290,7 @@ const noop = ()=>{
             /* istanbul ignore next */ if (process.env.NODE_ENV !== "production" && ![
                 "readAsText",
                 "readAsDataURL",
-                "readAsArrayBuffer",
-                "readAsBinaryString"
+                "readAsArrayBuffer"
             ].includes(parser)) {
                 throw new Error("Invalid file reader parser");
             }

package/dist/files/useFileUpload.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/files/useFileUpload.ts"],"sourcesContent":["\"use client\";\nimport { nanoid } from \"nanoid\";\nimport {\n  useCallback,\n  useEffect,\n  useReducer,\n  type ChangeEvent,\n  type DragEvent,\n} from \"react\";\nimport {\n  getFileParser as defaultGetFileParser,\n  type CompletedFileUploadStats,\n  type FileReaderResult,\n  type FileUploadHandlers,\n  type FileUploadStats,\n  type GetFileParser,\n  type ProcessingFileUploadStats,\n} from \"./utils.js\";\nimport {\n  FileAccessError,\n  isValidFileName as defaultIsValidFileName,\n  validateFiles as defaultValidateFiles,\n  type FileValidationError,\n  type FileValidationOptions,\n  type FilesValidator,\n} from \"./validation.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n *\n * @typeParam CustomError - An optional error type that gets returned from the\n * {@link FilesValidator}.\n * @since 2.9.0\n */\nexport interface FileUploadState<CustomError = never> {\n  /**\n   * All the files that have been validated and are either:\n   * - pending upload\n   * - uploading\n   * - complete\n   *\n   * Each key in this object is the {@link BaseFileUploadStats.key} generated\n   * once the upload starts pending.\n   */\n  stats: Readonly<Record<string, Readonly<FileUploadStats>>>;\n\n  /**\n   * A list of validation errors that have occurred before starting the upload\n   * process.\n   *\n   * @see {@link FileAccessError}\n   * @see {@link TooManyFilesError}\n   * @see {@link FileValidationError}\n   */\n  errors: readonly FileValidationError<CustomError>[];\n}\n\n/**\n *\n * @typeParam CustomError - An optional error type that gets returned from the\n * {@link FilesValidator}.\n * @since 2.9.0\n * @internal\n */\nexport interface FileUploadHookState<CustomError = never>\n  extends FileUploadState<CustomError> {\n  /**\n   * All the current readers used for uploading files to the browser.\n   *\n   * Note: Once an upload has completed, the reader will be removed.\n   */\n  readers: Readonly<Record<string, FileReader>>;\n}\n\n/**\n *\n * @typeParam E - An optional HTMLElement type that is used for the\n * {@link FileUploadHandlers}.\n * @typeParam CustomError - An optional error type that gets returned from the\n * {@link FilesValidator}.\n * @since 2.9.0\n */\nexport interface FileUploadOptions<E extends HTMLElement, CustomError = never>\n  extends FileUploadHandlers<E>,\n    FileValidationOptions {\n  /**\n   * Setting this value to a number greater than `0` will update the browser\n   * upload process to queue the uploads in chunks instead of all at once. This\n   * can help prevent the browser from freezing if dealing with large files that\n   * are being converted to data urls.\n   *\n   * @defaultValue `-1`\n   */\n  concurrency?: number;\n\n  /** {@inheritDoc FilesValidator} */\n  validateFiles?: FilesValidator<CustomError>;\n  /** {@inheritDoc GetFileParser} */\n  getFileParser?: GetFileParser;\n}\n\n/** @internal */\ntype Action<E = never> =\n  | {\n      type: \"queue\";\n      errors: readonly FileValidationError<E>[];\n      files: readonly File[];\n    }\n  | { type: \"reset\" }\n  | { type: \"remove\"; files: readonly string[] }\n  | { type: \"start\"; key: string; reader: FileReader }\n  | { type: \"progress\"; key: string; progress: number }\n  | { type: \"complete\"; key: string; result: FileReaderResult }\n  | { type: \"clearErrors\" };\n\n/** @since 2.9.0 */\nexport interface FileUploadActions {\n  /**\n   * Reset everything related to uploads ensuring that all file readers have\n   * been aborted.\n   */\n  reset: () => void;\n\n  /**\n   * Removes all the errors that exist in state without canceling any of the\n   * uploads already in progress.\n   */\n  clearErrors: () => void;\n\n  /**\n   * This function is used to cancel pending and uploading files or removing\n   * completed files.\n   *\n   * @param keyOrKeys - A single or list of {@link BaseFileUploadStats.key} to\n   * remove from state.\n   */\n  remove: (keyOrKeys: string | readonly string[]) => void;\n}\n\n/**\n *\n * @typeParam E - An optional HTMLElement type that is used for the\n * {@link FileUploadHandlers}.\n * @typeParam CustomError - An optional error type that gets returned from the\n * {@link FilesValidator}.\n * @since 2.9.0\n */\nexport interface FileUploadHookReturnValue<\n  E extends HTMLElement = HTMLElement,\n  CustomError = never,\n> extends FileUploadActions,\n    Required<FileUploadHandlers<E>> {\n  /** {@inheritDoc FileUploadState.errors} */\n  errors: readonly FileValidationError<CustomError>[];\n\n  /**\n   * A list of all the {@link FileUploadStats}.\n   *\n   * @see {@link getSplitFileUploads} for separating by status\n   */\n  stats: readonly Readonly<FileUploadStats>[];\n\n  /**\n   * The total number of bytes for all the files that exist in the\n   * {@link stats} list.\n   */\n  totalBytes: number;\n\n  /**\n   * The total number of files in the {@link stats} list.\n   */\n  totalFiles: number;\n\n  /**\n   * An `accept` string that can be passed to the {@link FileInput} component\n   * when the {@link FileValidationOptions.extensions} list has been provided to\n   * limit which files the OS will _attempt_ to allow access to.\n   *\n   * @example Simple example\n   * ```ts\n   * const extensions = ['pdf', 'docx', 'ppt'];\n   * const { accept } = useFileUpload({ extensions, ...others });\n   *\n   * expect(accept).toBe(\"*.pdf,*.docx,*.ppt\")\n   * ```\n   *\n   * @defaultValue `\"*\"`\n   */\n  accept: string;\n}\n\n/** @internal */\nconst EMPTY_LIST = [] as const;\n/** @internal */\nconst EMPTY_OBJECT = {} as const;\n\n/**\n * This hook is generally used to upload files **to the browser** in different\n * formats to be previewed `<img>`, `<video>`, `<embed>`, etc tags. However, it\n * can also be used to upload the files as an `ArrayBuffer` and then uploaded to\n * a server.\n *\n * @typeParam E - An optional HTMLElement type that is used for the\n * {@link FileUploadHandlers}.\n * @typeParam CustomError - An optional error type that gets returned from the\n * {@link FilesValidator}.\n * @param options - All the {@link FileUploadOptions}\n * @returns the {@link FileUploadHookReturnValue}\n * @since 2.9.0\n */\nexport function useFileUpload<E extends HTMLElement, CustomError = never>(\n  options: FileUploadOptions<E, CustomError> = {}\n): Readonly<FileUploadHookReturnValue<E, CustomError>> {\n  const {\n    maxFiles = -1,\n    extensions = EMPTY_LIST,\n    minFileSize = -1,\n    maxFileSize = -1,\n    totalFileSize = -1,\n    concurrency = -1,\n    onDrop: propOnDrop = noop,\n    onChange: propOnChange = noop,\n    validateFiles = defaultValidateFiles,\n    getFileParser = defaultGetFileParser,\n    isValidFileName = defaultIsValidFileName,\n  } = options;\n\n  const [state, dispatch] = useReducer(\n    function reducer(\n      state: FileUploadHookState<CustomError>,\n      action: Action<CustomError>\n    ): FileUploadHookState<CustomError> {\n      switch (action.type) {\n        case \"reset\":\n          // need to reuse constants so that calling reset doesn't cause an\n          // infinite loop in an effect\n          return {\n            stats: EMPTY_OBJECT,\n            errors: EMPTY_LIST,\n            readers: EMPTY_OBJECT,\n          };\n        case \"remove\": {\n          const stats: Record<string, FileUploadStats> = {};\n          for (const key in state.stats) {\n            if (!action.files.includes(key)) {\n              stats[key] = state.stats[key];\n            }\n          }\n\n          return {\n            ...state,\n            stats,\n          };\n        }\n        case \"queue\":\n          return {\n            ...state,\n            stats: {\n              ...state.stats,\n              ...action.files.reduce<Record<string, ProcessingFileUploadStats>>(\n                (files, file) => {\n                  const key = nanoid();\n                  files[key] = {\n                    key,\n                    file,\n                    progress: 0,\n                    status: \"pending\",\n                  };\n\n                  return files;\n                },\n                {}\n              ),\n            },\n            errors: [...state.errors, ...action.errors],\n          };\n        case \"start\": {\n          const { key, reader } = action;\n          const fileStats: ProcessingFileUploadStats = {\n            key,\n            file: state.stats[key].file,\n            progress: 0,\n            status: \"uploading\",\n          };\n\n          return {\n            ...state,\n            readers: {\n              ...state.readers,\n              [key]: reader,\n            },\n            stats: {\n              ...state.stats,\n              [key]: fileStats,\n            },\n          };\n        }\n        case \"progress\": {\n          const { key, progress } = action;\n          return {\n            ...state,\n            stats: {\n              ...state.stats,\n              [key]: {\n                ...state.stats[key],\n                progress,\n              },\n            },\n          };\n        }\n        case \"complete\": {\n          const { key, result } = action;\n          const file: CompletedFileUploadStats = {\n            key,\n            file: state.stats[key].file,\n            status: \"complete\",\n            result,\n            progress: 100,\n          };\n          const { [key]: _reader, ...readers } = state.readers;\n\n          return {\n            ...state,\n            readers,\n            stats: {\n              ...state.stats,\n              [key]: file,\n            },\n          };\n        }\n        case \"clearErrors\":\n          return { ...state, errors: [] };\n      }\n    },\n    {\n      stats: EMPTY_OBJECT,\n      errors: EMPTY_LIST,\n      readers: EMPTY_OBJECT,\n    }\n  );\n  const { stats, errors, readers } = state;\n\n  const statsList = Object.values(stats);\n  const totalFiles = statsList.length;\n  const totalBytes = statsList.reduce(\n    (result, { file: { size } }) => result + size,\n    0\n  );\n  const queueFiles = useCallback(\n    (files: readonly File[]) => {\n      const { pending, errors } = validateFiles(files, {\n        maxFiles,\n        extensions,\n        minFileSize,\n        maxFileSize,\n        totalBytes,\n        totalFiles,\n        totalFileSize,\n        isValidFileName,\n      });\n\n      dispatch({ type: \"queue\", errors, files: pending });\n    },\n    [\n      validateFiles,\n      maxFiles,\n      extensions,\n      minFileSize,\n      maxFileSize,\n      totalBytes,\n      totalFiles,\n      totalFileSize,\n      isValidFileName,\n    ]\n  );\n  const onDrop = useCallback(\n    (event: DragEvent<E>) => {\n      propOnDrop(event);\n      event.preventDefault();\n      event.stopPropagation();\n\n      try {\n        const files = event.dataTransfer.files;\n        if (files) {\n          queueFiles(Array.from(files));\n        }\n      } catch (e) {\n        dispatch({\n          type: \"queue\",\n          files: [],\n          errors: [\n            new FileAccessError(e instanceof Error ? e.message : undefined),\n          ],\n        });\n      }\n    },\n    [queueFiles, propOnDrop]\n  );\n  const onChange = useCallback(\n    (event: ChangeEvent<HTMLInputElement>) => {\n      propOnChange(event);\n      try {\n        const files = event.currentTarget.files;\n        if (files) {\n          queueFiles(Array.from(files));\n        } else {\n          throw new Error();\n        }\n      } catch (e) {\n        dispatch({\n          type: \"queue\",\n          files: [],\n          errors: [\n            new FileAccessError(e instanceof Error ? e.message : undefined),\n          ],\n        });\n      }\n    },\n    [queueFiles, propOnChange]\n  );\n\n  const remove = useCallback(\n    (keyOrKeys: string | readonly string[]) => {\n      const files = typeof keyOrKeys === \"string\" ? [keyOrKeys] : keyOrKeys;\n      files.forEach((fileKey) => {\n        readers[fileKey]?.abort();\n      });\n\n      dispatch({ type: \"remove\", files });\n    },\n    [readers]\n  );\n  const reset = useCallback(() => {\n    Object.values(readers).forEach((reader) => {\n      reader.abort();\n    });\n\n    dispatch({ type: \"reset\" });\n  }, [readers]);\n  const clearErrors = useCallback(() => {\n    dispatch({ type: \"clearErrors\" });\n  }, []);\n  const start = useCallback((key: string, reader: FileReader) => {\n    dispatch({ type: \"start\", key, reader });\n  }, []);\n  const complete = useCallback(\n    (key: string, result: FileReaderResult = null) => {\n      dispatch({ type: \"complete\", key, result });\n    },\n    []\n  );\n  const createProgressEventHandler = useCallback(\n    (key: string) => (event: ProgressEvent) => {\n      if (event.lengthComputable) {\n        const percentage = Math.round((event.loaded * 100) / event.total);\n        dispatch({ type: \"progress\", key, progress: percentage });\n      }\n    },\n    []\n  );\n\n  useEffect(() => {\n    const pending: ProcessingFileUploadStats[] = [];\n    const uploading: ProcessingFileUploadStats[] = [];\n    Object.values(stats).forEach((file) => {\n      if (file.status === \"pending\") {\n        pending.push(file);\n      } else if (file.status === \"uploading\") {\n        uploading.push(file);\n      }\n    });\n\n    const lastIndex =\n      concurrency === -1\n        ? pending.length\n        : Math.max(0, concurrency - uploading.length);\n    const queue = pending.slice(0, lastIndex);\n    if (!queue.length) {\n      return;\n    }\n\n    queue.forEach((stats) => {\n      const { key, file } = stats;\n      const reader = new FileReader();\n\n      // using `addEventListener` instead of directly setting to\n      // `reader.progress`/`reader.load` so it's easier to test\n      reader.addEventListener(\"progress\", createProgressEventHandler(key));\n      reader.addEventListener(\"load\", () => {\n        complete(key, reader.result);\n      });\n\n      start(key, reader);\n      const parser = getFileParser(file);\n      /* istanbul ignore next */\n      if (\n        process.env.NODE_ENV !== \"production\" &&\n        ![\"readAsText\", \"readAsDataURL\", \"readAsArrayBuffer\"].includes(parser)\n      ) {\n        throw new Error(\"Invalid file reader parser\");\n      }\n\n      reader[parser](file);\n    });\n  }, [\n    concurrency,\n    stats,\n    getFileParser,\n    createProgressEventHandler,\n    start,\n    complete,\n  ]);\n\n  let accept = \"\";\n  if (extensions.length) {\n    accept = extensions.reduce((s, ext) => `${s ? `${s},` : \"\"}.${ext}`, \"\");\n  }\n\n  return {\n    stats: statsList,\n    errors,\n    accept,\n    totalBytes,\n    totalFiles,\n    onDrop,\n    onChange,\n    reset,\n    remove,\n    clearErrors,\n  };\n}\n"],"names":["nanoid","useCallback","useEffect","useReducer","getFileParser","defaultGetFileParser","FileAccessError","isValidFileName","defaultIsValidFileName","validateFiles","defaultValidateFiles","noop","EMPTY_LIST","EMPTY_OBJECT","useFileUpload","options","maxFiles","extensions","minFileSize","maxFileSize","totalFileSize","concurrency","onDrop","propOnDrop","onChange","propOnChange","state","dispatch","reducer","action","type","stats","errors","readers","key","files","includes","reduce","file","progress","status","reader","fileStats","result","_reader","statsList","Object","values","totalFiles","length","totalBytes","size","queueFiles","pending","event","preventDefault","stopPropagation","dataTransfer","Array","from","e","Error","message","undefined","currentTarget","remove","keyOrKeys","forEach","fileKey","abort","reset","clearErrors","start","complete","createProgressEventHandler","lengthComputable","percentage","Math","round","loaded","total","uploading","push","lastIndex","max","queue","slice","FileReader","addEventListener","parser","process","env","NODE_ENV","accept","s","ext"],"mappings":"AAAA;AACA,SAASA,MAAM,QAAQ,SAAS;AAChC,SACEC,WAAW,EACXC,SAAS,EACTC,UAAU,QAGL,QAAQ;AACf,SACEC,iBAAiBC,oBAAoB,QAOhC,aAAa;AACpB,SACEC,eAAe,EACfC,mBAAmBC,sBAAsB,EACzCC,iBAAiBC,oBAAoB,QAIhC,kBAAkB;AAEzB,MAAMC,OAAO;AACX,aAAa;AACf;AAqKA,cAAc,GACd,MAAMC,aAAa,EAAE;AACrB,cAAc,GACd,MAAMC,eAAe,CAAC;AAEtB;;;;;;;;;;;;;CAaC,GACD,OAAO,SAASC,cACdC,UAA6C,CAAC,CAAC;IAE/C,MAAM,EACJC,WAAW,CAAC,CAAC,EACbC,aAAaL,UAAU,EACvBM,cAAc,CAAC,CAAC,EAChBC,cAAc,CAAC,CAAC,EAChBC,gBAAgB,CAAC,CAAC,EAClBC,cAAc,CAAC,CAAC,EAChBC,QAAQC,aAAaZ,IAAI,EACzBa,UAAUC,eAAed,IAAI,EAC7BF,gBAAgBC,oBAAoB,EACpCN,gBAAgBC,oBAAoB,EACpCE,kBAAkBC,sBAAsB,EACzC,GAAGO;IAEJ,MAAM,CAACW,OAAOC,SAAS,GAAGxB,WACxB,SAASyB,QACPF,KAAuC,EACvCG,MAA2B;QAE3B,OAAQA,OAAOC,IAAI;YACjB,KAAK;gBACH,iEAAiE;gBACjE,6BAA6B;gBAC7B,OAAO;oBACLC,OAAOlB;oBACPmB,QAAQpB;oBACRqB,SAASpB;gBACX;YACF,KAAK;gBAAU;oBACb,MAAMkB,QAAyC,CAAC;oBAChD,IAAK,MAAMG,OAAOR,MAAMK,KAAK,CAAE;wBAC7B,IAAI,CAACF,OAAOM,KAAK,CAACC,QAAQ,CAACF,MAAM;4BAC/BH,KAAK,CAACG,IAAI,GAAGR,MAAMK,KAAK,CAACG,IAAI;wBAC/B;oBACF;oBAEA,OAAO;wBACL,GAAGR,KAAK;wBACRK;oBACF;gBACF;YACA,KAAK;gBACH,OAAO;oBACL,GAAGL,KAAK;oBACRK,OAAO;wBACL,GAAGL,MAAMK,KAAK;wBACd,GAAGF,OAAOM,KAAK,CAACE,MAAM,CACpB,CAACF,OAAOG;4BACN,MAAMJ,MAAMlC;4BACZmC,KAAK,CAACD,IAAI,GAAG;gCACXA;gCACAI;gCACAC,UAAU;gCACVC,QAAQ;4BACV;4BAEA,OAAOL;wBACT,GACA,CAAC,EACF;oBACH;oBACAH,QAAQ;2BAAIN,MAAMM,MAAM;2BAAKH,OAAOG,MAAM;qBAAC;gBAC7C;YACF,KAAK;gBAAS;oBACZ,MAAM,EAAEE,GAAG,EAAEO,MAAM,EAAE,GAAGZ;oBACxB,MAAMa,YAAuC;wBAC3CR;wBACAI,MAAMZ,MAAMK,KAAK,CAACG,IAAI,CAACI,IAAI;wBAC3BC,UAAU;wBACVC,QAAQ;oBACV;oBAEA,OAAO;wBACL,GAAGd,KAAK;wBACRO,SAAS;4BACP,GAAGP,MAAMO,OAAO;4BAChB,CAACC,IAAI,EAAEO;wBACT;wBACAV,OAAO;4BACL,GAAGL,MAAMK,KAAK;4BACd,CAACG,IAAI,EAAEQ;wBACT;oBACF;gBACF;YACA,KAAK;gBAAY;oBACf,MAAM,EAAER,GAAG,EAAEK,QAAQ,EAAE,GAAGV;oBAC1B,OAAO;wBACL,GAAGH,KAAK;wBACRK,OAAO;4BACL,GAAGL,MAAMK,KAAK;4BACd,CAACG,IAAI,EAAE;gCACL,GAAGR,MAAMK,KAAK,CAACG,IAAI;gCACnBK;4BACF;wBACF;oBACF;gBACF;YACA,KAAK;gBAAY;oBACf,MAAM,EAAEL,GAAG,EAAES,MAAM,EAAE,GAAGd;oBACxB,MAAMS,OAAiC;wBACrCJ;wBACAI,MAAMZ,MAAMK,KAAK,CAACG,IAAI,CAACI,IAAI;wBAC3BE,QAAQ;wBACRG;wBACAJ,UAAU;oBACZ;oBACA,MAAM,EAAE,CAACL,IAAI,EAAEU,OAAO,EAAE,GAAGX,SAAS,GAAGP,MAAMO,OAAO;oBAEpD,OAAO;wBACL,GAAGP,KAAK;wBACRO;wBACAF,OAAO;4BACL,GAAGL,MAAMK,KAAK;4BACd,CAACG,IAAI,EAAEI;wBACT;oBACF;gBACF;YACA,KAAK;gBACH,OAAO;oBAAE,GAAGZ,KAAK;oBAAEM,QAAQ,EAAE;gBAAC;QAClC;IACF,GACA;QACED,OAAOlB;QACPmB,QAAQpB;QACRqB,SAASpB;IACX;IAEF,MAAM,EAAEkB,KAAK,EAAEC,MAAM,EAAEC,OAAO,EAAE,GAAGP;IAEnC,MAAMmB,YAAYC,OAAOC,MAAM,CAAChB;IAChC,MAAMiB,aAAaH,UAAUI,MAAM;IACnC,MAAMC,aAAaL,UAAUR,MAAM,CACjC,CAACM,QAAQ,EAAEL,MAAM,EAAEa,IAAI,EAAE,EAAE,GAAKR,SAASQ,MACzC;IAEF,MAAMC,aAAanD,YACjB,CAACkC;QACC,MAAM,EAAEkB,OAAO,EAAErB,MAAM,EAAE,GAAGvB,cAAc0B,OAAO;YAC/CnB;YACAC;YACAC;YACAC;YACA+B;YACAF;YACA5B;YACAb;QACF;QAEAoB,SAAS;YAAEG,MAAM;YAASE;YAAQG,OAAOkB;QAAQ;IACnD,GACA;QACE5C;QACAO;QACAC;QACAC;QACAC;QACA+B;QACAF;QACA5B;QACAb;KACD;IAEH,MAAMe,SAASrB,YACb,CAACqD;QACC/B,WAAW+B;QACXA,MAAMC,cAAc;QACpBD,MAAME,eAAe;QAErB,IAAI;YACF,MAAMrB,QAAQmB,MAAMG,YAAY,CAACtB,KAAK;YACtC,IAAIA,OAAO;gBACTiB,WAAWM,MAAMC,IAAI,CAACxB;YACxB;QACF,EAAE,OAAOyB,GAAG;YACVjC,SAAS;gBACPG,MAAM;gBACNK,OAAO,EAAE;gBACTH,QAAQ;oBACN,IAAI1B,gBAAgBsD,aAAaC,QAAQD,EAAEE,OAAO,GAAGC;iBACtD;YACH;QACF;IACF,GACA;QAACX;QAAY7B;KAAW;IAE1B,MAAMC,WAAWvB,YACf,CAACqD;QACC7B,aAAa6B;QACb,IAAI;YACF,MAAMnB,QAAQmB,MAAMU,aAAa,CAAC7B,KAAK;YACvC,IAAIA,OAAO;gBACTiB,WAAWM,MAAMC,IAAI,CAACxB;YACxB,OAAO;gBACL,MAAM,IAAI0B;YACZ;QACF,EAAE,OAAOD,GAAG;YACVjC,SAAS;gBACPG,MAAM;gBACNK,OAAO,EAAE;gBACTH,QAAQ;oBACN,IAAI1B,gBAAgBsD,aAAaC,QAAQD,EAAEE,OAAO,GAAGC;iBACtD;YACH;QACF;IACF,GACA;QAACX;QAAY3B;KAAa;IAG5B,MAAMwC,SAAShE,YACb,CAACiE;QACC,MAAM/B,QAAQ,OAAO+B,cAAc,WAAW;YAACA;SAAU,GAAGA;QAC5D/B,MAAMgC,OAAO,CAAC,CAACC;YACbnC,OAAO,CAACmC,QAAQ,EAAEC;QACpB;QAEA1C,SAAS;YAAEG,MAAM;YAAUK;QAAM;IACnC,GACA;QAACF;KAAQ;IAEX,MAAMqC,QAAQrE,YAAY;QACxB6C,OAAOC,MAAM,CAACd,SAASkC,OAAO,CAAC,CAAC1B;YAC9BA,OAAO4B,KAAK;QACd;QAEA1C,SAAS;YAAEG,MAAM;QAAQ;IAC3B,GAAG;QAACG;KAAQ;IACZ,MAAMsC,cAActE,YAAY;QAC9B0B,SAAS;YAAEG,MAAM;QAAc;IACjC,GAAG,EAAE;IACL,MAAM0C,QAAQvE,YAAY,CAACiC,KAAaO;QACtCd,SAAS;YAAEG,MAAM;YAASI;YAAKO;QAAO;IACxC,GAAG,EAAE;IACL,MAAMgC,WAAWxE,YACf,CAACiC,KAAaS,SAA2B,IAAI;QAC3ChB,SAAS;YAAEG,MAAM;YAAYI;YAAKS;QAAO;IAC3C,GACA,EAAE;IAEJ,MAAM+B,6BAA6BzE,YACjC,CAACiC,MAAgB,CAACoB;YAChB,IAAIA,MAAMqB,gBAAgB,EAAE;gBAC1B,MAAMC,aAAaC,KAAKC,KAAK,CAAC,AAACxB,MAAMyB,MAAM,GAAG,MAAOzB,MAAM0B,KAAK;gBAChErD,SAAS;oBAAEG,MAAM;oBAAYI;oBAAKK,UAAUqC;gBAAW;YACzD;QACF,GACA,EAAE;IAGJ1E,UAAU;QACR,MAAMmD,UAAuC,EAAE;QAC/C,MAAM4B,YAAyC,EAAE;QACjDnC,OAAOC,MAAM,CAAChB,OAAOoC,OAAO,CAAC,CAAC7B;YAC5B,IAAIA,KAAKE,MAAM,KAAK,WAAW;gBAC7Ba,QAAQ6B,IAAI,CAAC5C;YACf,OAAO,IAAIA,KAAKE,MAAM,KAAK,aAAa;gBACtCyC,UAAUC,IAAI,CAAC5C;YACjB;QACF;QAEA,MAAM6C,YACJ9D,gBAAgB,CAAC,IACbgC,QAAQJ,MAAM,GACd4B,KAAKO,GAAG,CAAC,GAAG/D,cAAc4D,UAAUhC,MAAM;QAChD,MAAMoC,QAAQhC,QAAQiC,KAAK,CAAC,GAAGH;QAC/B,IAAI,CAACE,MAAMpC,MAAM,EAAE;YACjB;QACF;QAEAoC,MAAMlB,OAAO,CAAC,CAACpC;YACb,MAAM,EAAEG,GAAG,EAAEI,IAAI,EAAE,GAAGP;YACtB,MAAMU,SAAS,IAAI8C;YAEnB,0DAA0D;YAC1D,yDAAyD;YACzD9C,OAAO+C,gBAAgB,CAAC,YAAYd,2BAA2BxC;YAC/DO,OAAO+C,gBAAgB,CAAC,QAAQ;gBAC9Bf,SAASvC,KAAKO,OAAOE,MAAM;YAC7B;YAEA6B,MAAMtC,KAAKO;YACX,MAAMgD,SAASrF,cAAckC;YAC7B,wBAAwB,GACxB,IACEoD,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBACzB,CAAC;gBAAC;gBAAc;gBAAiB;aAAoB,CAACxD,QAAQ,CAACqD,SAC/D;gBACA,MAAM,IAAI5B,MAAM;YAClB;YAEApB,MAAM,CAACgD,OAAO,CAACnD;QACjB;IACF,GAAG;QACDjB;QACAU;QACA3B;QACAsE;QACAF;QACAC;KACD;IAED,IAAIoB,SAAS;IACb,IAAI5E,WAAWgC,MAAM,EAAE;QACrB4C,SAAS5E,WAAWoB,MAAM,CAAC,CAACyD,GAAGC,MAAQ,GAAGD,IAAI,GAAGA,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,EAAEC,KAAK,EAAE;IACvE;IAEA,OAAO;QACLhE,OAAOc;QACPb;QACA6D;QACA3C;QACAF;QACA1B;QACAE;QACA8C;QACAL;QACAM;IACF;AACF"}

package/dist/files/utils.d.ts

@@ -0,0 +1,169 @@
+import { type ChangeEventHandler, type DragEventHandler } from "react";
+/** @since 2.9.0 */
+export interface BaseFileUploadStats {
+    /**
+     * A unique key associated with each upload generated by `nanoid`.
+     */
+    key: string;
+    /**
+     * The file instance that is being uploaded.
+     */
+    file: File;
+    /**
+     * The current upload progress as a percentage from 0 - 100 percent.
+     */
+    progress: number;
+}
+/** @since 2.9.0 */
+export interface ProcessingFileUploadStats extends BaseFileUploadStats {
+    status: "pending" | "uploading";
+}
+/** @since 2.9.0 */
+export type FileReaderResult = FileReader["result"];
+/** @since 2.9.0 */
+export interface CompletedFileUploadStats extends BaseFileUploadStats {
+    status: "complete";
+    /**
+     * The result after a `FileReader` has read a file completely.
+     *
+     * Note: This _should_ be an `ArrayBuffer` if the next step is to upload to a
+     * server.
+     *
+     * @see {@link FileReaderParser}
+     * @see {@link getFileParser}
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader | FileReader}
+     */
+    result: FileReaderResult;
+}
+/** @since 2.9.0 */
+export type FileUploadStats = ProcessingFileUploadStats | CompletedFileUploadStats;
+/** @since 2.9.0 */
+export type FileUploadStatus = FileUploadStats["status"];
+/** @since 2.9.0 */
+export interface FileUploadHandlers<E extends HTMLElement> {
+    onDrop?: DragEventHandler<E>;
+    onChange?: ChangeEventHandler<HTMLInputElement>;
+}
+/**
+ * This will first check if the mime-type of the file starts with `text/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * text.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a text-content file.
+ * @since 2.9.0
+ */
+export declare function isTextFile(file: File): boolean;
+/**
+ * This will first check if the mime-type of the file starts with `text\/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * text.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a text content file.
+ * @since 2.9.0
+ */
+export declare function isImageFile(file: File): boolean;
+/**
+ * This will first check if the mime-type of the file starts with `audio/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * audio.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a audio content file.
+ * @since 2.9.0
+ */
+export declare function isAudioFile(file: File): boolean;
+/**
+ * This will first check if the mime-type of the file starts with `video/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * video.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a video content file.
+ * @since 2.9.0
+ */
+export declare function isVideoFile(file: File): boolean;
+/**
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file matches an image, audio, or video file.
+ * @since 2.9.0
+ */
+export declare function isMediaFile(file: File): boolean;
+/**
+ * One of the function names from a `FileReader` to upload a file to the
+ * client.
+ *
+ * Note: If this file does not need to be previewed in the browser and will
+ * immediately be uploaded to a server, use `readAsArrayBuffer`.
+ *
+ * @since 2.9.0
+ * @since 6.0.0 Removed `"readAsBinaryString` since it is deprecated
+ * {@see https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsBinaryString}
+ */
+export type FileReaderParser = "readAsText" | "readAsDataURL" | "readAsArrayBuffer";
+/**
+ * A function that should return one of the {@link FileReaderParser} functions
+ * to start uploading a file to the browser.
+ *
+ * @example The Default File Upload Parser
+ * ```ts
+ * export const getFileParser: GetFileParser = (file) => {
+ *   if (isMediaFile(file)) {
+ *     return "readAsDataURL";
+ *   }
+ *
+ *   if (isTextFile(file)) {
+ *     return "readAsText";
+ *   }
+ *
+ *   return "readAsArrayBuffer";
+ * };
+ * ```
+ *
+ * @param file - The file to get a parser for
+ * @returns the {@link FileReaderParser} string.
+ * @since 2.9.0
+ */
+export type GetFileParser = (file: File) => FileReaderParser;
+/**
+ * This function will attempt to read:
+ * - media (image, audio, and video) files as a data url so they can be
+ *   previewed in `<img>`, `<audio>`, and `<video>` tags
+ * - text files as plain text
+ * - everything else as an `ArrayBuffer` which can be manually converted into a
+ *   data url if needed with `URL.createObjectURL`
+ *
+ * @since 2.9.0
+ */
+export declare const getFileParser: GetFileParser;
+/** @since 2.9.0 */
+export interface SplitFileUploads {
+    readonly pending: readonly ProcessingFileUploadStats[];
+    readonly uploading: readonly ProcessingFileUploadStats[];
+    readonly complete: readonly CompletedFileUploadStats[];
+}
+/**
+ * This util will split all the current upload stats by status.
+ *
+ * @param stats - The {@link FileUploadStats} list generally returned by the
+ * {@link useFileUpload} hook.
+ * @returns the {@link SplitFileUploads}.
+ * @since 2.9.0
+ */
+export declare function getSplitFileUploads(stats: readonly FileUploadStats[]): SplitFileUploads;

package/dist/files/utils.js

@@ -0,0 +1,114 @@
+/**
+ * This will first check if the mime-type of the file starts with `text/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * text.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a text-content file.
+ * @since 2.9.0
+ */ export function isTextFile(file) {
+    return /\.((j|t)sx?|json|lock|hbs|ya?ml|log|txt|md)$/i.test(file.name);
+}
+/**
+ * This will first check if the mime-type of the file starts with `text\/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * text.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a text content file.
+ * @since 2.9.0
+ */ export function isImageFile(file) {
+    return /\.(a?png|avif|svg|tiff|gifv?|jpe?g)/i.test(file.name);
+}
+/**
+ * This will first check if the mime-type of the file starts with `audio/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * audio.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a audio content file.
+ * @since 2.9.0
+ */ export function isAudioFile(file) {
+    return /\.(mp3|wav|ogg|m4p|flac)$/i.test(file.name);
+}
+/**
+ * This will first check if the mime-type of the file starts with `video/` and
+ * fallback to checking a few file names or extensions that should be considered
+ * video.
+ *
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file should be considered as a video content file.
+ * @since 2.9.0
+ */ export function isVideoFile(file) {
+    return /\.(mkv|mpe?g|mov|avi|flv|webm|mp4)$/i.test(file.name);
+}
+/**
+ * This function is not guaranteed to be 100% correct and is only useful if
+ * trying to generate a preview of files uploaded to the browser.
+ *
+ * @param file - The file to check
+ * @returns `true` if the file matches an image, audio, or video file.
+ * @since 2.9.0
+ */ export function isMediaFile(file) {
+    return isImageFile(file) || isAudioFile(file) || isVideoFile(file);
+}
+/**
+ * This function will attempt to read:
+ * - media (image, audio, and video) files as a data url so they can be
+ *   previewed in `<img>`, `<audio>`, and `<video>` tags
+ * - text files as plain text
+ * - everything else as an `ArrayBuffer` which can be manually converted into a
+ *   data url if needed with `URL.createObjectURL`
+ *
+ * @since 2.9.0
+ */ export const getFileParser = (file)=>{
+    if (isMediaFile(file)) {
+        return "readAsDataURL";
+    }
+    if (isTextFile(file)) {
+        return "readAsText";
+    }
+    return "readAsArrayBuffer";
+};
+/**
+ * This util will split all the current upload stats by status.
+ *
+ * @param stats - The {@link FileUploadStats} list generally returned by the
+ * {@link useFileUpload} hook.
+ * @returns the {@link SplitFileUploads}.
+ * @since 2.9.0
+ */ export function getSplitFileUploads(stats) {
+    const pending = [];
+    const uploading = [];
+    const complete = [];
+    stats.forEach((stat)=>{
+        if (stat.status === "pending") {
+            pending.push(stat);
+        } else if (stat.status === "uploading") {
+            uploading.push(stat);
+        } else if (stat.status === "complete") {
+            complete.push(stat);
+        } else {
+            /* istanbul ignore next */ throw new Error("Invalid upload stat");
+        }
+    });
+    return {
+        pending,
+        uploading,
+        complete
+    };
+}
+
+//# sourceMappingURL=utils.js.map

package/dist/files/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/files/utils.ts"],"sourcesContent":["import { type ChangeEventHandler, type DragEventHandler } from \"react\";\n\n/** @since 2.9.0 */\nexport interface BaseFileUploadStats {\n  /**\n   * A unique key associated with each upload generated by `nanoid`.\n   */\n  key: string;\n\n  /**\n   * The file instance that is being uploaded.\n   */\n  file: File;\n\n  /**\n   * The current upload progress as a percentage from 0 - 100 percent.\n   */\n  progress: number;\n}\n\n/** @since 2.9.0 */\nexport interface ProcessingFileUploadStats extends BaseFileUploadStats {\n  status: \"pending\" | \"uploading\";\n}\n\n/** @since 2.9.0 */\nexport type FileReaderResult = FileReader[\"result\"];\n\n/** @since 2.9.0 */\nexport interface CompletedFileUploadStats extends BaseFileUploadStats {\n  status: \"complete\";\n\n  /**\n   * The result after a `FileReader` has read a file completely.\n   *\n   * Note: This _should_ be an `ArrayBuffer` if the next step is to upload to a\n   * server.\n   *\n   * @see {@link FileReaderParser}\n   * @see {@link getFileParser}\n   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader | FileReader}\n   */\n  result: FileReaderResult;\n}\n\n/** @since 2.9.0 */\nexport type FileUploadStats =\n  | ProcessingFileUploadStats\n  | CompletedFileUploadStats;\n\n/** @since 2.9.0 */\nexport type FileUploadStatus = FileUploadStats[\"status\"];\n\n/** @since 2.9.0 */\nexport interface FileUploadHandlers<E extends HTMLElement> {\n  onDrop?: DragEventHandler<E>;\n  onChange?: ChangeEventHandler<HTMLInputElement>;\n}\n\n/**\n * This will first check if the mime-type of the file starts with `text/` and\n * fallback to checking a few file names or extensions that should be considered\n * text.\n *\n * This function is not guaranteed to be 100% correct and is only useful if\n * trying to generate a preview of files uploaded to the browser.\n *\n * @param file - The file to check\n * @returns `true` if the file should be considered as a text-content file.\n * @since 2.9.0\n */\nexport function isTextFile(file: File): boolean {\n  return /\\.((j|t)sx?|json|lock|hbs|ya?ml|log|txt|md)$/i.test(file.name);\n}\n\n/**\n * This will first check if the mime-type of the file starts with `text\\/` and\n * fallback to checking a few file names or extensions that should be considered\n * text.\n *\n * This function is not guaranteed to be 100% correct and is only useful if\n * trying to generate a preview of files uploaded to the browser.\n *\n * @param file - The file to check\n * @returns `true` if the file should be considered as a text content file.\n * @since 2.9.0\n */\nexport function isImageFile(file: File): boolean {\n  return /\\.(a?png|avif|svg|tiff|gifv?|jpe?g)/i.test(file.name);\n}\n\n/**\n * This will first check if the mime-type of the file starts with `audio/` and\n * fallback to checking a few file names or extensions that should be considered\n * audio.\n *\n * This function is not guaranteed to be 100% correct and is only useful if\n * trying to generate a preview of files uploaded to the browser.\n *\n * @param file - The file to check\n * @returns `true` if the file should be considered as a audio content file.\n * @since 2.9.0\n */\nexport function isAudioFile(file: File): boolean {\n  return /\\.(mp3|wav|ogg|m4p|flac)$/i.test(file.name);\n}\n\n/**\n * This will first check if the mime-type of the file starts with `video/` and\n * fallback to checking a few file names or extensions that should be considered\n * video.\n *\n * This function is not guaranteed to be 100% correct and is only useful if\n * trying to generate a preview of files uploaded to the browser.\n *\n * @param file - The file to check\n * @returns `true` if the file should be considered as a video content file.\n * @since 2.9.0\n */\nexport function isVideoFile(file: File): boolean {\n  return /\\.(mkv|mpe?g|mov|avi|flv|webm|mp4)$/i.test(file.name);\n}\n\n/**\n * This function is not guaranteed to be 100% correct and is only useful if\n * trying to generate a preview of files uploaded to the browser.\n *\n * @param file - The file to check\n * @returns `true` if the file matches an image, audio, or video file.\n * @since 2.9.0\n */\nexport function isMediaFile(file: File): boolean {\n  return isImageFile(file) || isAudioFile(file) || isVideoFile(file);\n}\n\n/**\n * One of the function names from a `FileReader` to upload a file to the\n * client.\n *\n * Note: If this file does not need to be previewed in the browser and will\n * immediately be uploaded to a server, use `readAsArrayBuffer`.\n *\n * @since 2.9.0\n * @since 6.0.0 Removed `\"readAsBinaryString` since it is deprecated\n * {@see https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsBinaryString}\n */\nexport type FileReaderParser =\n  | \"readAsText\"\n  | \"readAsDataURL\"\n  | \"readAsArrayBuffer\";\n\n/**\n * A function that should return one of the {@link FileReaderParser} functions\n * to start uploading a file to the browser.\n *\n * @example The Default File Upload Parser\n * ```ts\n * export const getFileParser: GetFileParser = (file) => {\n *   if (isMediaFile(file)) {\n *     return \"readAsDataURL\";\n *   }\n *\n *   if (isTextFile(file)) {\n *     return \"readAsText\";\n *   }\n *\n *   return \"readAsArrayBuffer\";\n * };\n * ```\n *\n * @param file - The file to get a parser for\n * @returns the {@link FileReaderParser} string.\n * @since 2.9.0\n */\nexport type GetFileParser = (file: File) => FileReaderParser;\n\n/**\n * This function will attempt to read:\n * - media (image, audio, and video) files as a data url so they can be\n *   previewed in `<img>`, `<audio>`, and `<video>` tags\n * - text files as plain text\n * - everything else as an `ArrayBuffer` which can be manually converted into a\n *   data url if needed with `URL.createObjectURL`\n *\n * @since 2.9.0\n */\nexport const getFileParser: GetFileParser = (file) => {\n  if (isMediaFile(file)) {\n    return \"readAsDataURL\";\n  }\n\n  if (isTextFile(file)) {\n    return \"readAsText\";\n  }\n\n  return \"readAsArrayBuffer\";\n};\n\n/** @since 2.9.0 */\nexport interface SplitFileUploads {\n  readonly pending: readonly ProcessingFileUploadStats[];\n  readonly uploading: readonly ProcessingFileUploadStats[];\n  readonly complete: readonly CompletedFileUploadStats[];\n}\n\n/**\n * This util will split all the current upload stats by status.\n *\n * @param stats - The {@link FileUploadStats} list generally returned by the\n * {@link useFileUpload} hook.\n * @returns the {@link SplitFileUploads}.\n * @since 2.9.0\n */\nexport function getSplitFileUploads(\n  stats: readonly FileUploadStats[]\n): SplitFileUploads {\n  const pending: ProcessingFileUploadStats[] = [];\n  const uploading: ProcessingFileUploadStats[] = [];\n  const complete: CompletedFileUploadStats[] = [];\n  stats.forEach((stat) => {\n    if (stat.status === \"pending\") {\n      pending.push(stat);\n    } else if (stat.status === \"uploading\") {\n      uploading.push(stat);\n    } else if (stat.status === \"complete\") {\n      complete.push(stat);\n    } else {\n      /* istanbul ignore next */\n      throw new Error(\"Invalid upload stat\");\n    }\n  });\n\n  return { pending, uploading, complete };\n}\n"],"names":["isTextFile","file","test","name","isImageFile","isAudioFile","isVideoFile","isMediaFile","getFileParser","getSplitFileUploads","stats","pending","uploading","complete","forEach","stat","status","push","Error"],"mappings":"AA2DA;;;;;;;;;;;CAWC,GACD,OAAO,SAASA,WAAWC,IAAU;IACnC,OAAO,gDAAgDC,IAAI,CAACD,KAAKE,IAAI;AACvE;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASC,YAAYH,IAAU;IACpC,OAAO,uCAAuCC,IAAI,CAACD,KAAKE,IAAI;AAC9D;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASE,YAAYJ,IAAU;IACpC,OAAO,6BAA6BC,IAAI,CAACD,KAAKE,IAAI;AACpD;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASG,YAAYL,IAAU;IACpC,OAAO,uCAAuCC,IAAI,CAACD,KAAKE,IAAI;AAC9D;AAEA;;;;;;;CAOC,GACD,OAAO,SAASI,YAAYN,IAAU;IACpC,OAAOG,YAAYH,SAASI,YAAYJ,SAASK,YAAYL;AAC/D;AA2CA;;;;;;;;;CASC,GACD,OAAO,MAAMO,gBAA+B,CAACP;IAC3C,IAAIM,YAAYN,OAAO;QACrB,OAAO;IACT;IAEA,IAAID,WAAWC,OAAO;QACpB,OAAO;IACT;IAEA,OAAO;AACT,EAAE;AASF;;;;;;;CAOC,GACD,OAAO,SAASQ,oBACdC,KAAiC;IAEjC,MAAMC,UAAuC,EAAE;IAC/C,MAAMC,YAAyC,EAAE;IACjD,MAAMC,WAAuC,EAAE;IAC/CH,MAAMI,OAAO,CAAC,CAACC;QACb,IAAIA,KAAKC,MAAM,KAAK,WAAW;YAC7BL,QAAQM,IAAI,CAACF;QACf,OAAO,IAAIA,KAAKC,MAAM,KAAK,aAAa;YACtCJ,UAAUK,IAAI,CAACF;QACjB,OAAO,IAAIA,KAAKC,MAAM,KAAK,YAAY;YACrCH,SAASI,IAAI,CAACF;QAChB,OAAO;YACL,wBAAwB,GACxB,MAAM,IAAIG,MAAM;QAClB;IACF;IAEA,OAAO;QAAEP;QAASC;QAAWC;IAAS;AACxC"}

package/dist/{form/fileUtils.d.ts → files/validation.d.ts}

@@ -1,49 +1,3 @@
-import { type ChangeEventHandler, type DragEventHandler } from "react";
-/** @since 2.9.0 */
-export interface BaseFileUploadStats {
-    /**
-     * A unique key associated with each upload generated by `nanoid`.
-     */
-    key: string;
-    /**
-     * The file instance that is being uploaded.
-     */
-    file: File;
-    /**
-     * The current upload progress as a percentage from 0 - 100 percent.
-     */
-    progress: number;
-}
-/** @since 2.9.0 */
-export interface ProcessingFileUploadStats extends BaseFileUploadStats {
-    status: "pending" | "uploading";
-}
-/** @since 2.9.0 */
-export type FileReaderResult = FileReader["result"];
-/** @since 2.9.0 */
-export interface CompletedFileUploadStats extends BaseFileUploadStats {
-    status: "complete";
-    /**
-     * The result after a `FileReader` has read a file completely.
-     *
-     * Note: This _should_ be an `ArrayBuffer` if the next step is to upload to a
-     * server.
-     *
-     * @see {@link FileReaderParser}
-     * @see {@link getFileParser}
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader | FileReader}
-     */
-    result: FileReaderResult;
-}
-/** @since 2.9.0 */
-export type FileUploadStats = ProcessingFileUploadStats | CompletedFileUploadStats;
-/** @since 2.9.0 */
-export type FileUploadStatus = FileUploadStats["status"];
-/** @since 2.9.0 */
-export interface FileUploadHandlers<E extends HTMLElement> {
-    onDrop?: DragEventHandler<E>;
-    onChange?: ChangeEventHandler<HTMLInputElement>;
-}
 /**
  * An error that will be created if a user tries dragging and dropping files
  * from a shared directory that they do not have access to. This error will not
@@ -146,7 +100,7 @@ export type FileValidationError<E = GenericFileError> = FileAccessError | TooMan
  * @param error - The error to check
  * @returns true if the error is a {@link FileAccessError}
  */
-export declare function isGenericFileError<CustomError extends {}>(error: FileValidationError<CustomError>): error is GenericFileError;
+export declare function isGenericFileError<CustomError extends object>(error: FileValidationError<CustomError>): error is GenericFileError;
 /**
  * A simple type-guard that can be used to check if the
  * {@link FileValidationError} is the {@link FileAccessError} which can be
@@ -155,7 +109,7 @@ export declare function isGenericFileError<CustomError extends {}>(error: FileVa
  * @param error - The error to check
  * @returns true if the error is a {@link FileAccessError}
  */
-export declare function isFileAccessError<CustomError extends {}>(error: FileValidationError<CustomError>): error is FileAccessError;
+export declare function isFileAccessError<CustomError extends object>(error: FileValidationError<CustomError>): error is FileAccessError;
 /**
  * A simple type-guard that can be used to check if the
  * {@link FileValidationError} is the {@link TooManyFilesError} which can be
@@ -164,7 +118,7 @@ export declare function isFileAccessError<CustomError extends {}>(error: FileVal
  * @param error - The error to check
  * @returns true if the error is a {@link TooManyFilesError}
  */
-export declare function isTooManyFilesError<CustomError extends {}>(error: FileValidationError<CustomError>): error is TooManyFilesError;
+export declare function isTooManyFilesError<CustomError extends object>(error: FileValidationError<CustomError>): error is TooManyFilesError;
 /**
  * A simple type-guard that can be used to check if the
  * {@link FileValidationError} is the {@link FileSizeError} which can be
@@ -173,7 +127,7 @@ export declare function isTooManyFilesError<CustomError extends {}>(error: FileV
  * @param error - The error to check
  * @returns true if the error is a {@link FileSizeError}
  */
-export declare function isFileSizeError<CustomError extends {}>(error: FileValidationError<CustomError>): error is FileSizeError;
+export declare function isFileSizeError<CustomError extends object>(error: FileValidationError<CustomError>): error is FileSizeError;
 /**
  * A simple type-guard that can be used to check if the
  * {@link FileValidationError} is the {@link FileExtensionError} which can be
@@ -182,7 +136,7 @@ export declare function isFileSizeError<CustomError extends {}>(error: FileValid
  * @param error - The error to check
  * @returns true if the error is a {@link FileExtensionError}
  */
-export declare function isFileExtensionError<CustomError extends {}>(error: FileValidationError<CustomError>): error is FileExtensionError;
+export declare function isFileExtensionError<CustomError extends object>(error: FileValidationError<CustomError>): error is FileExtensionError;
 /**
  * This function is used to determine if a file should be added to the
  * {@link FileExtensionError}. The default implementation should work for most
@@ -267,7 +221,9 @@ export interface FilesValidationOptions extends Required<FileValidationOptions>
      */
     totalFiles: number;
 }
-/** @since 2.9.0 */
+/**
+ * @since 2.9.0
+ */
 export interface ValidatedFilesResult<CustomError> {
     /**
      * A filtered list of files that have been validated and can be queued for the
@@ -309,7 +265,7 @@ export interface ValidatedFilesResult<CustomError> {
  * };
  * ```
  *
- * @typeparam E - An optional custom file validation error.
+ * @typeParam E - An optional custom file validation error.
  * @param files - The list of files to check
  * @param options - The {@link FilesValidationOptions}
  * @returns the {@link ValidatedFilesResult}
@@ -322,131 +278,10 @@ export type FilesValidator<CustomError = never> = (files: readonly File[], optio
  * {@link useFileUpload} that ensures the {@link FilesValidationOptions} are
  * enforced before allowing a file to be uploaded.
  *
- * @typeparam E - An optional custom file validation error.
+ * @typeParam E - An optional custom file validation error.
  * @param files - The list of files to check
  * @param options - The {@link FilesValidationOptions}
  * @returns the {@link ValidatedFilesResult}
  * @since 2.9.0
  */
-export declare function validateFiles<CustomError>(files: readonly File[], { maxFiles, extensions, minFileSize, maxFileSize, totalBytes, totalFiles, totalFileSize, isValidFileName, }: FilesValidationOptions): ValidatedFilesResult<CustomError>;
-/**
- * This will first check if the mime-type of the file starts with `text/` and
- * fallback to checking a few file names or extensions that should be considered
- * text.
- *
- * This function is not guaranteed to be 100% correct and is only useful if
- * trying to generate a preview of files uploaded to the browser.
- *
- * @param file - The file to check
- * @returns `true` if the file should be considered as a text-content file.
- * @since 2.9.0
- */
-export declare function isTextFile(file: File): boolean;
-/**
- * This will first check if the mime-type of the file starts with `text\/` and
- * fallback to checking a few file names or extensions that should be considered
- * text.
- *
- * This function is not guaranteed to be 100% correct and is only useful if
- * trying to generate a preview of files uploaded to the browser.
- *
- * @param file - The file to check
- * @returns `true` if the file should be considered as a text content file.
- * @since 2.9.0
- */
-export declare function isImageFile(file: File): boolean;
-/**
- * This will first check if the mime-type of the file starts with `audio/` and
- * fallback to checking a few file names or extensions that should be considered
- * audio.
- *
- * This function is not guaranteed to be 100% correct and is only useful if
- * trying to generate a preview of files uploaded to the browser.
- *
- * @param file - The file to check
- * @returns `true` if the file should be considered as a audio content file.
- * @since 2.9.0
- */
-export declare function isAudioFile(file: File): boolean;
-/**
- * This will first check if the mime-type of the file starts with `video/` and
- * fallback to checking a few file names or extensions that should be considered
- * video.
- *
- * This function is not guaranteed to be 100% correct and is only useful if
- * trying to generate a preview of files uploaded to the browser.
- *
- * @param file - The file to check
- * @returns `true` if the file should be considered as a video content file.
- * @since 2.9.0
- */
-export declare function isVideoFile(file: File): boolean;
-/**
- * This function is not guaranteed to be 100% correct and is only useful if
- * trying to generate a preview of files uploaded to the browser.
- *
- * @param file - The file to check
- * @returns `true` if the file matches an image, audio, or video file.
- * @since 2.9.0
- */
-export declare function isMediaFile(file: File): boolean;
-/**
- * One of the function names from a `FileReader` to upload a file to the
- * client.
- *
- * Note: If this file does not need to be previewed in the browser and will
- * immediately be uploaded to a server, use `readAsArrayBuffer`.
- *
- * @since 2.9.0
- */
-export type FileReaderParser = "readAsText" | "readAsDataURL" | "readAsBinaryString" | "readAsArrayBuffer";
-/**
- * A function that should return one of the {@link FileReaderParser} functions
- * to start uploading a file to the browser.
- *
- * @example The Default File Upload Parser
- * ```ts
- * export const getFileParser: GetFileParser = (file) => {
- *   if (isMediaFile(file)) {
- *     return "readAsDataURL";
- *   }
- *
- *   if (isTextFile(file)) {
- *     return "readAsText";
- *   }
- *
- *   return "readAsArrayBuffer";
- * };
- * ```
- *
- * @param file - The file to get a parser for
- * @returns the {@link FileReaderParser} string.
- * @since 2.9.0
- */
-export type GetFileParser = (file: File) => FileReaderParser;
-/**
- * This function will attempt to read:
- * - media (image, audio, and video) files as a data url so they can be
- *   previewed in `<img>`, `<audio>`, and `<video>` tags
- * - text files as plain text
- * - everything else as an `ArrayBuffer` which can be manually converted into a
- *   data url if needed with `URL.createObjectURL`
- *
- * @since 2.9.0
- */
-export declare const getFileParser: GetFileParser;
-/** @since 2.9.0 */
-export interface SplitFileUploads {
-    readonly pending: readonly ProcessingFileUploadStats[];
-    readonly uploading: readonly ProcessingFileUploadStats[];
-    readonly complete: readonly CompletedFileUploadStats[];
-}
-/**
- * This util will split all the current upload stats by status.
- *
- * @param stats - The {@link FileUploadStats} list generally returned by the
- * {@link useFileUpload} hook.
- * @returns the {@link SplitFileUploads}.
- * @since 2.9.0
- */
-export declare function getSplitFileUploads(stats: readonly FileUploadStats[]): SplitFileUploads;
+export declare function validateFiles<CustomError>(files: readonly File[], options: FilesValidationOptions): ValidatedFilesResult<CustomError>;