@osmandvc/react-upload-control 0.3.0 → 0.3.1

package/README.md

@@ -101,8 +101,6 @@ The upload handler receives two parameters:
 1. `files`: An array of `UploadedFile` objects to be uploaded
 2. `onProgressChange`: A callback function to update the upload progress
 
-The upload handler should return an array of `UploadFileResult` objects, which specify the success, error, and metadata for each file upload. The library will handle the UI updates based on the progress updates and final results you provide.
-
 Here are two examples of implementing an upload handler:
 
 ### Example 1: Simple Batch Upload
@@ -299,6 +297,58 @@ function MyFileUpload() {
 }
 ```
 
+### Understanding UploadFileResult
+
+The upload handler must return an array of `UploadFileResult` objects - one for each uploaded file. Here's the structure:
+
+```typescript
+type UploadFileResult = {
+  // The ID of the file that was uploaded (must match the original file.id)
+  fileId: string;
+
+  // Whether the upload was successful
+  success: boolean;
+
+  // Optional error information if success is false
+  error?: {
+    text: string; // Human-readable error message
+    code: string; // Error code for programmatic handling
+  };
+
+  // Optional metadata to attach to the file
+  metadata?: {
+    [key: string]: any; // Any additional data you want to store with the file
+  };
+};
+```
+
+Example of a successful upload result:
+
+```typescript
+{
+  fileId: "file123",
+  success: true,
+  metadata: {
+    url: "https://example.com/uploads/file123.jpg",
+    uploadedAt: "2025-01-02T12:00:00Z",
+    size: 1024000
+  }
+}
+```
+
+Example of a failed upload result:
+
+```typescript
+{
+  fileId: "file456",
+  success: false,
+  error: {
+    text: "File size exceeds server limit",
+    code: "SIZE_LIMIT_EXCEEDED"
+  }
+}
+```
+
 ## onDelete Handler
 
 The `onDelete` handler is designed to be non-blocking and does not include progress tracking. This is intentional for better UX - since it's primarily used for cleanup when resetting a control with already finished uploads. Users should be able to reset the control immediately without waiting for deletion to complete or being blocked by deletion errors.
@@ -369,41 +419,6 @@ The provider component that manages the upload state and configuration.
 | disableFileSystem | boolean                | false     | Disable file system uploads |
 | className         | string                 | undefined | Additional CSS classes      |
 
-## Understanding the UploadedFile Type
-
-When implementing your upload handlers, you'll work with the `UploadedFile` type, which provides access to various file properties:
-
-```typescript
-interface UploadedFile {
-  id: string; // Unique identifier for the file
-  file?: File; // The actual File object
-  name: string; // File name
-  size?: number; // File size in bytes
-  type: string; // MIME type
-  base64Uri?: string; // Base64 encoded file content
-  previewImg?: {
-    // Preview image data (for images)
-    imgBase64Uri: string;
-    width?: number;
-    height?: number;
-  };
-  uploadStatus: {
-    // Current upload status
-    stage?: "IDLE" | "FINISHED" | "FAILED" | "UPLOADING" | "REMOVING";
-    progress?: number; // Upload progress (0-100)
-    error?: {
-      text: string; // Error message
-      code: string; // Error code
-    };
-  };
-  order?: number; // File order in the list
-  metadata?: {
-    // Custom metadata
-    [key: string]: any;
-  };
-}
-```
-
 ## File Processing
 
 React Upload Control supports file processing through the optional [@osmandvc/react-upload-control-processors](https://www.npmjs.com/package/@osmandvc/react-upload-control-processors) package. This enables you to process files before or after upload, with built-in support for PDF manipulation and extensible architecture for custom processors.

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@osmandvc/react-upload-control",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A completely free and open-source file uploader library designed for modern react applications. This package focuses on delivering a feature-rich experience while prioritizing an exceptional developer experience (DX). Whether you're handling simple uploads or complex multi-file scenarios, this library offers powerful customization, seamless integration, and a smooth workflow for developers. Perfect for those who need an efficient, flexible, and easy-to-use file uploader solution in their projects.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/osmandvc/react-upload-control.git"
+  },
   "files": [
     "dist",
     "dist/**/*.d.ts",