@shipstatic/drop 0.1.7 → 0.1.9

package/README.md

@@ -4,10 +4,26 @@
 
 A focused React hook for preparing files for deployment with [@shipstatic/ship](https://github.com/shipstatic/ship). Handles ZIP extraction, path normalization, and validation - everything needed before calling `ship.deploy()`.
 
-**v0.1.6 Update:** Now includes built-in drag & drop support with prop getters! No need to manually implement drag & drop handlers - just spread `{...drop.getDropzoneProps()}` on your container and `{...drop.getInputProps()}` on the input element. Folder structure preservation is handled automatically.
+Built-in drag & drop support with prop getters! No need to manually implement drag & drop handlers - just spread `{...drop.getDropzoneProps()}` on your container and `{...drop.getInputProps()}` on the input element. Folder structure preservation is handled automatically.
 
 **Note:** MD5 calculation is handled by Ship SDK during deployment. Drop focuses on file processing and UI state management.
 
+## Table of Contents
+
+- [Why Headless?](#why-headless)
+- [Features](#features)
+- [Installation](#installation)
+- [Requirements](#requirements)
+- [Quick Start](#quick-start)
+- [Configuration Architecture](#️-configuration-architecture)
+- [Advanced Usage](#advanced-programmatic-file-picker)
+- [API Reference](#api)
+- [State Machine](#state-machine)
+- [Error Handling](#error-handling)
+- [Types](#types)
+- [Ship SDK Integration](#direct-ship-sdk-integration)
+- [Architecture Decisions](#architecture-decisions)
+
 ## Why Headless?
 
 This package provides **zero UI components** - just a React hook with built-in drag & drop functionality. You bring your own styling.
@@ -16,8 +32,7 @@ This package provides **zero UI components** - just a React hook with built-in d
 1. **Built-in drag & drop** - Proper folder support with `webkitGetAsEntry` API, all handled internally
 2. **Prop getters API** - Similar to `react-dropzone`, just spread props on your elements
 3. **Full styling control** - No imposed CSS, design system, or theming
-4. **Smaller bundle** - No UI components means less bloat
-5. **Ship SDK integration** - Purpose-built for Ship deployments, not a generic file upload library
+4. **Ship SDK integration** - Purpose-built for Ship deployments, not a generic file upload library
 
 **What's different from other libraries:**
 - Generic dropzone libraries don't preserve folder structure properly
@@ -34,6 +49,7 @@ This package provides **zero UI components** - just a React hook with built-in d
 - 🔒 **Path Sanitization** - Defense-in-depth protection against directory traversal attacks
 - 📁 **Folder Structure Preservation** - Proper folder paths via `webkitRelativePath`
 - 🎨 **Headless UI** - No visual components, just logic and state management
+- 📘 **Full TypeScript Support** - Complete type definitions with discriminated unions for state machine
 - 🚀 **Focused Scope** - File processing and UI state only. MD5 calculation and deployment handled by Ship SDK
 
 ## Installation
@@ -44,6 +60,17 @@ npm install @shipstatic/drop
 pnpm add @shipstatic/drop
 ```
 
+## Requirements
+
+- **React**: ^18.0.0 or ^19.0.0
+- **TypeScript**: Full TypeScript support with exported types
+- **Browsers**: Modern browsers with support for:
+  - File API (universal support)
+  - DataTransfer API for drag & drop (universal support)
+  - `webkitGetAsEntry` for folder uploads (Chrome, Edge, Safari 11.1+, Firefox 50+)
+
+**Note on folder uploads**: The folder drag & drop feature uses the `webkitGetAsEntry` API. While widely supported, older browsers may only support file-by-file selection. ZIP extraction works universally as a fallback.
+
 ## Quick Start
 
 ```tsx
@@ -80,15 +107,15 @@ function MyUploader() {
         {drop.isDragging ? '📂 Drop here' : '📁 Click or drag files/folders'}
       </div>
 
-      {/* Status - using state machine */}
-      {drop.state.status && (
+      {/* Status - using state machine phase */}
+      {drop.status && (
         <p>
-          <strong>{drop.state.status.title}:</strong> {drop.state.status.details}
+          <strong>{drop.status.title}:</strong> {drop.status.details}
         </p>
       )}
 
       {/* File list */}
-      {drop.state.files.map(file => (
+      {drop.files.map(file => (
         <div key={file.id}>
           {file.name} - {file.status}
         </div>
@@ -97,7 +124,7 @@ function MyUploader() {
       {/* Upload button */}
       <button
         onClick={handleUpload}
-        disabled={drop.state.value !== 'ready'}
+        disabled={drop.phase !== 'ready'}
       >
         Upload {drop.getValidFiles().length} files
       </button>
@@ -205,17 +232,22 @@ interface DropOptions {
 
 **Returns:**
 
+```typescript
 ```typescript
 interface DropReturn {
-  // State machine
-  /** Current state of the drop hook */
-  state: DropState;
-
   // Convenience getters (computed from state)
+  /** Current phase of the state machine */
+  phase: DropStateValue;
   /** Whether currently processing files (ZIP extraction, etc.) */
   isProcessing: boolean;
   /** Whether user is currently dragging over the dropzone */
   isDragging: boolean;
+  /** Flattened access to files */
+  files: ProcessedFile[];
+  /** Flattened access to source name */
+  sourceName: string;
+  /** Flattened access to status */
+  status: DropStatus | null;
 
   // Primary API: Prop getters for easy integration
   /** Get props to spread on dropzone element (handles drag & drop) */
@@ -231,7 +263,7 @@ interface DropReturn {
     type: 'file';
     style: { display: string };
     multiple: boolean;
-    webkitdirectory: string;
+    webkitdirectory: string; // Note: React expects string ('') for boolean attributes
     onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
   };
 
@@ -262,22 +294,16 @@ type DropStateValue =
   | 'ready'      // Files are valid and ready for deployment
   | 'error';     // An error occurred during processing
 
-interface DropState {
-  value: DropStateValue;
-  files: ProcessedFile[];
-  sourceName: string;
-  status: DropStatus | null;
-}
-
 interface DropStatus {
   title: string;
   details: string;
+  errors?: string[];
 }
 ```
 
 ## State Machine
 
-The drop hook uses a state machine for predictable, clear state management. Instead of multiple boolean flags, you have a single `state.value` that represents exactly what's happening.
+The drop hook uses a state machine for predictable, clear state management. Instead of multiple boolean flags, you have a single `drop.phase` that represents exactly what's happening.
 
 ### State Flow
 
@@ -293,9 +319,8 @@ error → dragging → processing → ... (retry)
 
 ```tsx
 function StatusIndicator({ drop }) {
-  const { state } = drop;
-
-  switch (state.value) {
+  // Use drop.phase to switch-case on the state
+  switch (drop.phase) {
     case 'idle':
       return <p>Drop files here or click to select</p>;
 
@@ -303,12 +328,12 @@ function StatusIndicator({ drop }) {
       return <p>Drop your files now!</p>;
 
     case 'processing':
-      return <p>{state.status?.details || 'Processing...'}</p>;
+      return <p>{drop.status?.details || 'Processing...'}</p>;
 
     case 'ready':
       return (
         <div>
-          <p>✓ {state.files.length} files ready</p>
+          <p>✓ {drop.files.length} files ready</p>
           <button>Upload to Ship</button>
         </div>
       );
@@ -316,8 +341,8 @@ function StatusIndicator({ drop }) {
     case 'error':
       return (
         <div>
-          <p>✗ {state.status?.title}</p>
-          <p>{state.status?.details}</p>
+          <p>✗ {drop.status?.title}</p>
+          <p>{drop.status?.details}</p>
           <button onClick={drop.clearAll}>Try Again</button>
         </div>
       );
@@ -330,14 +355,14 @@ function StatusIndicator({ drop }) {
 For simpler use cases, boolean convenience getters are provided:
 
 ```tsx
-// These are computed from state.value (read-only projections)
-drop.isProcessing  // true when state.value === 'processing'
-drop.isDragging    // true when state.value === 'dragging'
-
-// For error information, use the state object
-drop.state.value === 'error'  // Check if in error state
-drop.state.status?.title      // Error title
-drop.state.status?.details    // Error details
+// These are computed from drop.phase (read-only projections)
+drop.isProcessing  // true when phase === 'processing'
+drop.isDragging    // true when phase === 'dragging'
+
+// For error information, use the flattened status object
+drop.phase === 'error'      // Check if in error state
+drop.status?.title          // Error title
+drop.status?.details        // Error details
 ```
 
 ### Benefits
@@ -357,7 +382,8 @@ Each file in the `state.files` array contains its own `status` and `statusMessag
 function FileList({ drop }) {
   return (
     <div>
-      {drop.state.files.map(file => (
+      {/* Flattened access to files array */}
+      {drop.files.map(file => (
         <div key={file.id}>
           <span>{file.path}</span>
 
@@ -374,7 +400,7 @@ function FileList({ drop }) {
       ))}
 
       {/* If validation fails, allow user to clear all and try again */}
-      {drop.state.value === 'error' && (
+      {drop.phase === 'error' && (
         <button onClick={drop.clearAll}>
           Clear All & Try Again
         </button>
@@ -395,10 +421,10 @@ function FileList({ drop }) {
 When files fail validation or processing, check the error state:
 
 ```tsx
-{drop.state.value === 'error' && drop.state.status && (
+{drop.phase === 'error' && drop.status && (
   <div>
-    <p>{drop.state.status.title}</p>
-    <p>{drop.state.status.details}</p>
+    <p>{drop.status.title}</p>
+    <p>{drop.status.details}</p>
   </div>
 )}
 ```
@@ -428,10 +454,10 @@ Use `clearAll()` to reset and try again:
 
 ```tsx
 // If validation fails, show user which files failed
-{drop.state.value === 'error' && (
+{drop.phase === 'error' && (
   <div>
     <p>Validation failed. Please fix the issues and try again:</p>
-    {drop.state.files.map(file => (
+    {drop.files.map(file => (
       <div key={file.id}>
         {file.path}: {file.statusMessage}
       </div>

package/dist/index.cjs

@@ -37,9 +37,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // node_modules/.pnpm/jszip@3.10.1/node_modules/jszip/dist/jszip.min.js
 var require_jszip_min = __commonJS({
-  "node_modules/.pnpm/jszip@3.10.1/node_modules/jszip/dist/jszip.min.js"(exports, module) {
+  "node_modules/.pnpm/jszip@3.10.1/node_modules/jszip/dist/jszip.min.js"(exports$1, module) {
     !(function(e) {
-      if ("object" == typeof exports && "undefined" != typeof module) module.exports = e();
+      if ("object" == typeof exports$1 && "undefined" != typeof module) module.exports = e();
       else if ("function" == typeof define && define.amd) define([], e);
       else {
         ("undefined" != typeof window ? window : "undefined" != typeof global ? global : "undefined" != typeof self ? self : this).JSZip = e();
@@ -2349,7 +2349,7 @@ var require_jszip_min = __commonJS({
 
 // node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/db.json
 var require_db = __commonJS({
-  "node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/db.json"(exports, module) {
+  "node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/db.json"(exports$1, module) {
     module.exports = {
       "application/1d-interleaved-parityfec": {
         source: "iana"
@@ -11697,7 +11697,7 @@ var require_db = __commonJS({
 
 // node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/index.js
 var require_mime_db = __commonJS({
-  "node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/index.js"(exports, module) {
+  "node_modules/.pnpm/mime-db@1.54.0/node_modules/mime-db/index.js"(exports$1, module) {
     module.exports = require_db();
   }
 });
@@ -11813,7 +11813,6 @@ async function createProcessedFile(file, options) {
     status: FILE_STATUSES.PENDING
   };
 }
-var getValidFiles = ship.getValidFiles;
 function stripCommonPrefix(files) {
   if (files.length === 0) return files;
   const paths = files.map((f) => f.path);
@@ -11835,35 +11834,39 @@ function stripCommonPrefix(files) {
   }));
 }
 async function traverseFileTree(entry, files, currentPath = "") {
-  if (entry.isFile) {
-    const file = await new Promise((resolve, reject) => {
-      entry.file(resolve, reject);
-    });
-    const relativePath = currentPath ? `${currentPath}/${file.name}` : file.name;
-    Object.defineProperty(file, "webkitRelativePath", {
-      value: relativePath,
-      writable: false
-    });
-    files.push(file);
-  } else if (entry.isDirectory) {
-    const dirReader = entry.createReader();
-    let allEntries = [];
-    const readEntriesBatch = async () => {
-      const batch = await new Promise(
-        (resolve, reject) => {
-          dirReader.readEntries(resolve, reject);
+  try {
+    if (entry.isFile) {
+      const file = await new Promise((resolve, reject) => {
+        entry.file(resolve, reject);
+      });
+      const relativePath = currentPath ? `${currentPath}/${file.name}` : file.name;
+      Object.defineProperty(file, "webkitRelativePath", {
+        value: relativePath,
+        writable: false
+      });
+      files.push(file);
+    } else if (entry.isDirectory) {
+      const dirReader = entry.createReader();
+      let allEntries = [];
+      const readEntriesBatch = async () => {
+        const batch = await new Promise(
+          (resolve, reject) => {
+            dirReader.readEntries(resolve, reject);
+          }
+        );
+        if (batch.length > 0) {
+          allEntries = allEntries.concat(batch);
+          await readEntriesBatch();
         }
-      );
-      if (batch.length > 0) {
-        allEntries = allEntries.concat(batch);
-        await readEntriesBatch();
+      };
+      await readEntriesBatch();
+      for (const childEntry of allEntries) {
+        const entryPath = childEntry.isDirectory ? currentPath ? `${currentPath}/${childEntry.name}` : childEntry.name : currentPath;
+        await traverseFileTree(childEntry, files, entryPath);
       }
-    };
-    await readEntriesBatch();
-    for (const childEntry of allEntries) {
-      const entryPath = childEntry.isDirectory ? currentPath ? `${currentPath}/${childEntry.name}` : childEntry.name : currentPath;
-      await traverseFileTree(childEntry, files, entryPath);
     }
+  } catch (error) {
+    console.warn(`Error traversing file tree for entry ${entry.name}:`, error);
   }
 }
 function useDrop(options) {
@@ -11884,6 +11887,7 @@ function useDrop(options) {
   const inputRef = react.useRef(null);
   const isProcessing = react.useMemo(() => state.value === "processing", [state.value]);
   const isDragging = react.useMemo(() => state.value === "dragging", [state.value]);
+  const validFiles = react.useMemo(() => ship.getValidFiles(state.files), [state.files]);
   const processFiles = react.useCallback(async (newFiles) => {
     if (isProcessingRef.current) {
       console.warn("File processing already in progress. Ignoring duplicate call.");
@@ -11949,7 +11953,11 @@ function useDrop(options) {
           value: "error",
           files: validation.files,
           sourceName: detectedSourceName,
-          status: { title: validation.error.error, details: validation.error.details }
+          status: {
+            title: validation.error.error,
+            details: validation.error.details,
+            errors: validation.error.errors
+          }
         });
         onValidationError?.(validation.error);
       } else if (validation.validFiles.length > 0) {
@@ -11994,9 +12002,6 @@ function useDrop(options) {
     setState(initialState);
     isProcessingRef.current = false;
   }, []);
-  const getValidFilesCallback = react.useCallback(() => {
-    return getValidFiles(state.files);
-  }, [state.files]);
   const updateFileStatus = react.useCallback((fileId, fileState) => {
     setState((prev) => ({
       ...prev,
@@ -12029,14 +12034,27 @@ function useDrop(options) {
     let hasEntries = false;
     for (const item of items) {
       if (item.kind === "file") {
-        const entry = item.webkitGetAsEntry?.();
-        if (entry) {
-          hasEntries = true;
-          await traverseFileTree(
-            entry,
-            files,
-            entry.isDirectory ? entry.name : ""
-          );
+        try {
+          const entry = item.webkitGetAsEntry?.();
+          if (entry) {
+            hasEntries = true;
+            await traverseFileTree(
+              entry,
+              files,
+              entry.isDirectory ? entry.name : ""
+            );
+          } else {
+            const file = item.getAsFile();
+            if (file) {
+              files.push(file);
+            }
+          }
+        } catch (error) {
+          console.warn("Error processing drop item:", error);
+          const file = item.getAsFile();
+          if (file) {
+            files.push(file);
+          }
         }
       }
     }
@@ -12074,10 +12092,14 @@ function useDrop(options) {
   }), [handleInputChange]);
   return {
     // State machine
-    state,
+    // state, // REMOVED
     // Convenience getters (computed from state)
+    phase: state.value,
     isProcessing,
     isDragging,
+    files: state.files,
+    sourceName: state.sourceName,
+    status: state.status,
     // Primary API: Prop getters
     getDropzoneProps,
     getInputProps,
@@ -12086,7 +12108,7 @@ function useDrop(options) {
     processFiles,
     clearAll,
     // Helpers
-    getValidFiles: getValidFilesCallback,
+    validFiles,
     updateFileStatus
   };
 }
@@ -12118,10 +12140,10 @@ exports.FILE_STATUSES = FILE_STATUSES;
 exports.createProcessedFile = createProcessedFile;
 exports.extractZipToFiles = extractZipToFiles;
 exports.formatFileSize = formatFileSize;
-exports.getValidFiles = getValidFiles;
 exports.isZipFile = isZipFile;
 exports.normalizePath = normalizePath;
 exports.stripCommonPrefix = stripCommonPrefix;
+exports.traverseFileTree = traverseFileTree;
 exports.useDrop = useDrop;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map