uplofile 2.0.0 → 2.2.0

package/README.md

@@ -10,6 +10,7 @@ Accessible, unstyled primitives for building your own upload UI — with drag‑
 - React 16+ compatible  
 - Drag‑and‑drop or click‑to‑upload  
 - Upload progress, plus cancel/retry/remove actions  
+- **Custom Validation:** Use `beforeUpload` to validate files before they start uploading
 - Hidden input for form submissions  
 - Unstyled — bring your own design
 
@@ -29,53 +30,17 @@ pnpm add uplofile
 
 ## Quick Start
 
-Import the primitives:
+Import and use the components in your React component:
 
-```typescript
-import * as Uplofile from "uplofile";
-
-const UplofileRoot = Uplofile.Root;
-
-const UplofileTrigger = Uplofile.Trigger;
-
-const UplofileHiddenInput = Uplofile.HiddenInput;
-
-const UplofileDropzone = Uplofile.Dropzone;
-
-const UplofilePreview = Uplofile.Preview;
-
-const UplofileCancel = Uplofile.Cancel;
-
-const UplofileRetry = Uplofile.Retry;
-
-const UplofileRemove = Uplofile.Remove;
-
-export {
-  UplofileRoot,
-  UplofileTrigger,
-  UplofileHiddenInput,
-  UplofileDropzone,
-  UplofilePreview,
-  UplofileCancel,
-  UplofileRetry,
-  UplofileRemove,
-};
-
-```
-
-Then use them in your React component:
 ```tsx
 "use client";
 
 import {
-    UplofileCancel,
     UplofileDropzone,
     UplofilePreview,
-    UplofileRemove,
-    UplofileRetry,
     UplofileRoot,
     UplofileTrigger,
-} from "./components/ui/uplofile";
+} from "uplofile";
 
 export default function Basic() {
   return (

package/dist/index.d.ts

@@ -6,6 +6,7 @@ declare const Dropzone: ({ asChild, ...rest }: {
     asChild?: boolean;
 } & HTMLAttributes<HTMLElement>) => react_jsx_runtime.JSX.Element;
 
+type MaybePromise<T> = T | Promise<T>;
 type UploadStatus = "idle" | "uploading" | "done" | "error" | "canceled" | "removing";
 type UploadFileItem<TMeta = any> = {
     uid: string;
@@ -19,9 +20,11 @@ type UploadFileItem<TMeta = any> = {
     error?: string;
     meta?: TMeta;
 };
-type UploadResult = {
+type UploadResult<TMeta = any> = {
     url: string;
     id?: string;
+    meta?: TMeta;
+    previewUrl?: string;
 };
 type UplofileRootRef<TMeta = any> = {
     setItems: (items: UploadFileItem<TMeta>[] | ((prev: UploadFileItem<TMeta>[]) => UploadFileItem<TMeta>[])) => void;
@@ -31,9 +34,16 @@ type UplofileRootRef<TMeta = any> = {
     openFileDialog: () => void;
     actions: ItemActions;
 };
+type BeforeUploadResult<TMeta = any> = boolean | Array<{
+    valid: boolean;
+    meta?: TMeta;
+    id?: string;
+    uid: string;
+    reason?: string;
+}>;
 type RootProps<TMeta = any> = PropsWithChildren<{
     multiple?: boolean;
-    initial?: Array<Pick<UploadFileItem<TMeta>, "uid" | "id" | "name" | "url" | "meta">>;
+    initial?: MaybePromise<Array<Pick<UploadFileItem<TMeta>, "uid" | "id" | "name" | "url" | "meta">>>;
     /**
      * optimistic (default): remove from UI immediately, call onRemove in the background; if it fails, restore the item and show error.
      * strict: call onRemove first; only remove from UI if it succeeds.
@@ -43,8 +53,9 @@ type RootProps<TMeta = any> = PropsWithChildren<{
     maxCount?: number;
     disabled?: boolean;
     accept?: string;
+    beforeUpload?: (items: UploadFileItem<TMeta>[]) => BeforeUploadResult<TMeta> | Promise<BeforeUploadResult<TMeta>>;
     onChange?: (items: UploadFileItem<TMeta>[]) => Promise<void> | void;
-    upload: (file: File, signal: AbortSignal, setProgress?: (pct: number) => void) => Promise<UploadResult>;
+    upload: (file: File, signal: AbortSignal, setProgress?: (pct: number) => void) => Promise<UploadResult<TMeta>>;
     onRemove?: (item: UploadFileItem<TMeta>, signal: AbortSignal) => Promise<void | any>;
 }>;
 type ItemActions = {
@@ -97,7 +108,7 @@ type PreviewRenderProps<TMeta = any> = {
 type Props<TMeta = any> = {
     render?: (api: PreviewRenderProps<TMeta>) => React.ReactNode;
 };
-declare const Preview: <TMeta = any>({ render }: Props<TMeta>) => string | number | boolean | Iterable<React.ReactNode> | react_jsx_runtime.JSX.Element | null | undefined;
+declare const Preview: <TMeta = any>({ render }: Props<TMeta>) => string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<React.ReactNode> | null | undefined;
 declare const HiddenInput: ({ name }: {
     name?: string;
 }) => react_jsx_runtime.JSX.Element;
@@ -112,14 +123,15 @@ declare const Remove: ({ uid, asChild, ...rest }: ButtonProps) => react_jsx_runt
 
 declare const Root: React.ForwardRefExoticComponent<{
     multiple?: boolean;
-    initial?: Pick<UploadFileItem<unknown>, "name" | "uid" | "id" | "url" | "meta">[] | undefined;
+    initial?: MaybePromise<Pick<UploadFileItem<unknown>, "id" | "name" | "uid" | "url" | "meta">[]> | undefined;
     removeMode?: "optimistic" | "strict";
     name?: string;
     maxCount?: number;
     disabled?: boolean;
     accept?: string;
+    beforeUpload?: ((items: UploadFileItem<unknown>[]) => BeforeUploadResult<unknown> | Promise<BeforeUploadResult<unknown>>) | undefined;
     onChange?: ((items: UploadFileItem<unknown>[]) => Promise<void> | void) | undefined;
-    upload: (file: File, signal: AbortSignal, setProgress?: (pct: number) => void) => Promise<UploadResult>;
+    upload: (file: File, signal: AbortSignal, setProgress?: (pct: number) => void) => Promise<UploadResult<unknown>>;
     onRemove?: ((item: UploadFileItem<unknown>, signal: AbortSignal) => Promise<void | any>) | undefined;
 } & {
     children?: React.ReactNode | undefined;
@@ -138,4 +150,4 @@ declare const isVideoFile: (item: UploadFileItem<any>, extraExtensions?: string[
 declare const isImageFile: (item: UploadFileItem<any>, extraExtensions?: string[]) => boolean;
 
 export { Cancel, Dropzone, HiddenInput, Preview, Remove, Retry, Root, Trigger, getExtension, isImageFile, isVideoFile, useUplofile };
-export type { ImageUploaderContextValue, ItemActions, RootProps, UploadFileItem, UploadResult, UploadStatus, UplofileRootRef };
+export type { BeforeUploadResult, ImageUploaderContextValue, ItemActions, RootProps, UploadFileItem, UploadResult, UploadStatus, UplofileRootRef };

package/dist/index.mjs

@@ -115,7 +115,7 @@ const acceptsFile = (file, accept)=>{
 };
 
 const UploaderCtx = /*#__PURE__*/ createContext(null);
-const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange, upload, removeMode = "optimistic", onRemove, accept = "image/*", name = "image", maxCount, disabled, children }, ref)=>{
+const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange, upload, removeMode = "optimistic", onRemove, accept = "image/*", beforeUpload, name = "image", maxCount, disabled, children }, ref)=>{
     const [items, setItems] = useState([]);
     const controllers = useRef(new Map());
     const removeControllers = useRef(new Map());
@@ -124,21 +124,24 @@ const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange
     // Hydrate initial items from the server and keep them marked as done
     useEffect(()=>{
         if (hasHydratedInitialRef.current) return;
-        const arr = initial ?? [];
-        if (!Array.isArray(arr) || arr.length === 0) return;
-        const mapped = arr.map((it)=>{
-            return {
-                uid: it.uid || it.id,
-                id: it.id,
-                name: it.name,
-                url: it.url,
-                status: "done",
-                meta: it.meta
-            };
-        });
-        // Only hydrate if the user hasn't already added/modified items locally
-        setItems((prev)=>prev.length === 0 ? mapped : prev);
-        hasHydratedInitialRef.current = true;
+        const hydrate = async ()=>{
+            const arr = await initial;
+            if (!Array.isArray(arr) || arr.length === 0) return;
+            const mapped = arr.map((it)=>{
+                return {
+                    uid: it.uid || it.id,
+                    id: it.id,
+                    name: it.name,
+                    url: it.url,
+                    status: "done",
+                    meta: it.meta
+                };
+            });
+            // Only hydrate if the user hasn't already added/modified items locally
+            setItems((prev)=>prev.length === 0 ? mapped : prev);
+            hasHydratedInitialRef.current = true;
+        };
+        void hydrate();
     }, [
         initial
     ]);
@@ -183,13 +186,14 @@ const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange
                         } catch  {
                         /*fail silently*/ }
                     }
-                    const serverPreview = result?.preview || result.url;
+                    const serverPreview = result.previewUrl ?? result.preview ?? result.url;
                     return {
                         ...it,
                         status: "done",
                         url: result.url,
-                        id: result.id,
+                        id: result.id ?? it.id,
                         previewUrl: serverPreview,
+                        meta: result.meta ?? it.meta,
                         progress: 100
                     };
                 }));
@@ -207,13 +211,13 @@ const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange
         emitChange,
         upload
     ]);
-    const selectFiles = useCallback((files)=>{
+    const selectFiles = useCallback(async (files)=>{
         if (!files) return;
         const selected = Array.isArray(files) ? files : Array.from(files);
         if (selected.length === 0) return;
         const remaining = maxCount ? Math.max(0, maxCount - items.filter((i)=>i.status !== "canceled").length) : undefined;
         const toUse = typeof remaining === "number" ? selected.slice(0, remaining) : selected;
-        const newItems = toUse.map((file)=>({
+        let newItems = toUse.map((file)=>({
                 uid: uid(),
                 name: file.name,
                 file,
@@ -221,12 +225,59 @@ const Root = /*#__PURE__*/ forwardRef(({ multiple = true, initial = [], onChange
                 status: "idle",
                 progress: 0
             }));
-        emitChange([
-            ...items,
-            ...newItems
-        ]);
-        newItems.forEach((it)=>startUpload(it));
+        if (beforeUpload) {
+            const result = await beforeUpload(newItems);
+            if (result === false) {
+                newItems.forEach((it)=>{
+                    if (it.previewUrl) URL.revokeObjectURL(it.previewUrl);
+                });
+                return;
+            }
+            if (Array.isArray(result)) {
+                const resultMap = new Map(result.map((r)=>[
+                        r.uid,
+                        r
+                    ]));
+                const processedItems = [];
+                for (const item of newItems){
+                    const validation = resultMap.get(item.uid);
+                    if (!validation) {
+                        if (item.previewUrl) URL.revokeObjectURL(item.previewUrl);
+                        continue;
+                    }
+                    if (validation.valid) {
+                        processedItems.push({
+                            ...item,
+                            meta: validation.meta !== undefined ? validation.meta : item.meta,
+                            id: validation.id !== undefined ? validation.id : item.id
+                        });
+                    } else if (validation.reason) {
+                        processedItems.push({
+                            ...item,
+                            status: "error",
+                            error: validation.reason,
+                            meta: validation.meta !== undefined ? validation.meta : item.meta,
+                            id: validation.id !== undefined ? validation.id : item.id
+                        });
+                    } else {
+                        if (item.previewUrl) URL.revokeObjectURL(item.previewUrl);
+                    }
+                }
+                newItems = processedItems;
+            }
+        }
+        if (newItems.length === 0) return;
+        emitChange((prev)=>[
+                ...prev,
+                ...newItems
+            ]);
+        newItems.forEach((it)=>{
+            if (it.status === "idle") {
+                startUpload(it);
+            }
+        });
     }, [
+        beforeUpload,
         emitChange,
         items,
         maxCount,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uplofile",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Composable file‑upload components for React.",
   "license": "MIT",
   "author": "Chris Josh <KristofaJosh>",