@wlindabla/file_uploader 1.0.0 → 2.0.1

package/README.md

@@ -188,7 +188,7 @@ import {
   UploadStateChangedEvent,
   UploadProgressEvent,
   UploadMediaCompleteEvent
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/events';
 
 import { BrowserEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -319,8 +319,7 @@ The main class. Implements `ChunkedFileUploaderInterface`.
 new ChunkedFileUploader(
   uploadEventDispatcher: EventDispatcherInterface,
   uploadResumeData: UploadResumeCacheInterface,
-  options: UploadOptions,
-  logger?: LoggerInterface
+  options: UploadOptions
 )
 ```
 
@@ -329,7 +328,6 @@ new ChunkedFileUploader(
 | `uploadEventDispatcher` | `EventDispatcherInterface` | ✅ | Dispatcher for upload lifecycle events |
 | `uploadResumeData` | `UploadResumeCacheInterface` | ✅ | Cache implementation for resumable uploads |
 | `options` | `UploadOptions` | ✅ | Upload configuration options |
-| `logger` | `LoggerInterface` | ❌ | Custom logger (default: `NoopLogger`) |
 
 #### Methods
 
@@ -1011,7 +1009,7 @@ You are responsible for adding them to your dispatcher instance.
 import {
   InitializeUploadSubscriber,
   FinalizeUploadSubscriber
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/subscribers';
 
 import { BrowserEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -1031,7 +1029,7 @@ dispatcher.addSubscriber(new FinalizeUploadSubscriber(dispatcher));
 import {
   InitializeUploadSubscriber,
   FinalizeUploadSubscriber
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/subscribers';
 
 import { NodeEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -1054,15 +1052,23 @@ dispatcher.addSubscriber(new FinalizeUploadSubscriber(dispatcher));
 
 ```typescript
 import {
-  ChunkedFileUploader,
-  InitializeUploadSubscriber,
-  FinalizeUploadSubscriber,
   HttpFileUploaderEvents,
   InitializeUploadSuccessEvent,
   InitializeUploadFailureEvent,
   FinalizeUploadFailureEvent,
   UploadMediaCompleteEvent
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/events';
+
+import {
+  InitializeUploadSubscriber,
+  FinalizeUploadSubscriber
+} from
+ '@wlindabla/file_uploader/subscribers'
+
+import {
+  ChunkedFileUploader
+} from
+ '@wlindabla/file_uploader/core'
 
 import { BrowserEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -1122,13 +1128,23 @@ await uploader
 
 ```typescript
 import {
-  ChunkedFileUploader,
-  InitializeUploadSubscriber,
-  FinalizeUploadSubscriber,
   HttpFileUploaderEvents,
   InitializeUploadSuccessEvent,
-  FinalizeUploadFailureEvent
-} from '@wlindabla/file_uploader';
+  InitializeUploadFailureEvent,
+  FinalizeUploadFailureEvent,
+  UploadMediaCompleteEvent
+} from '@wlindabla/file_uploader/events';
+
+import {
+  InitializeUploadSubscriber,
+  FinalizeUploadSubscriber
+} from
+ '@wlindabla/file_uploader/subscribers'
+
+import {
+  ChunkedFileUploader
+} from
+ '@wlindabla/file_uploader/core'
 
 import { NodeEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -1740,8 +1756,7 @@ class MonitoringLogger implements LoggerInterface {
 const uploader = new ChunkedFileUploader(
   dispatcher,
   cache,
-  options,
-  new MonitoringLogger()
+  options
 );
 ```
 
@@ -1762,14 +1777,17 @@ Complete browser example with progress bar and UI controls.
 
 ```typescript
 import {
-  ChunkedFileUploader,
   HttpFileUploaderEvents,
   UploadProgressEvent,
   UploadStateChangedEvent,
   UploadMediaCompleteEvent,
   UploadCancelledEvent,
-  ConsoleLogger
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/events';
+
+import {
+  ChunkedFileUploader
+} from
+ '@wlindabla/file_uploader/core'
 
 import { BrowserEventDispatcher } from '@wlindabla/event_dispatcher';
 
@@ -1848,8 +1866,7 @@ const uploader = new ChunkedFileUploader(
     maxRetries: 3,
     autoSave: true,
     timeout: 60000
-  },
-  new ConsoleLogger()
+  }
 );
 
 // Wire up DOM
@@ -1891,8 +1908,11 @@ import {
   HttpFileUploaderEvents,
   UploadProgressEvent,
   UploadMediaCompleteEvent,
-  ConsoleLogger
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/events';
+
+import {
+  ChunkedFileUploader,
+} from '@wlindabla/file_uploader/core';
 
 import { NodeEventDispatcher } from '@wlindabla/event_dispatcher';
 import fs from 'fs';
@@ -2056,13 +2076,19 @@ uploadFile('/path/to/large-video.mp4').catch(console.error);
 
 ```typescript
 import {
-  ChunkedFileUploader,
-  HttpFileUploaderEvents,
-  InitializeUploadFailureEvent,
   FileUploadChunkError,
   InitializeUploadFailureException,
   UploadCancelledException
-} from '@wlindabla/file_uploader';
+} from '@wlindabla/file_uploader/exceptions';
+
+import {
+  HttpFileUploaderEvents,
+  InitializeUploadFailureEvent
+} from '@wlindabla/file_uploader/events';
+
+import {
+  ChunkedFileUploader
+} from '@wlindabla/file_uploader/core';
 
 // Listen to granular error events
 dispatcher.addListener(

package/dist/cjs/cache/index.d.ts

@@ -0,0 +1,198 @@
+import { ResumeData } from '../types/index.js';
+import '@wlindabla/http_client';
+
+/**
+ * Interface for caching upload resume data.
+ *
+ * This interface extends the base cache functionality to specifically
+ * handle resume data for file uploads, allowing uploads to be paused
+ * and resumed across browser sessions.
+ *
+ *
+ * @example
+ * ```typescript
+ * const cache: UploadResumeCacheInterface = new LocalStorageUploadResumeCache();
+ *
+ * // Save progress
+ * await cache.setItem('video.mp4', {
+ *   uploadedChunks: 45,
+ *   totalChunks: 100,
+ *   lastBytePosition: 47185920
+ * });
+ *
+ * // Resume later
+ * const data = await cache.getItem('video.mp4');
+ * console.log(`Resume from chunk ${data.uploadedChunks}`);
+ * ```
+ */
+interface UploadResumeCacheInterface {
+    /**
+     * Retrieves cached resume data for a specific upload.
+     *
+     * @param key - Unique identifier for the upload (typically filename or file hash)
+     * @returns Promise resolving to the cached resume data
+     * @throws {Error} If the key doesn't exist or data is corrupted
+     */
+    getItem(key: string): Promise<ResumeData>;
+    /**
+     * Stores resume data for an upload session.
+     *
+     * @param key - Unique identifier for the upload
+     * @param data - Resume data containing upload progress information
+     * @returns Promise that resolves when data is successfully cached
+     * @throws {Error} If storage quota is exceeded or data is invalid
+     */
+    setItem(key: string, data: ResumeData): Promise<void>;
+}
+/**
+ * Default adapter for caching resume data during file uploads.
+ *
+ * Implements an in-memory storage strategy with secure serialization,
+ * strict data validation, and comprehensive error handling.
+ *
+ * This implementation serves as a foundation for specialized adapters
+ * (localStorage, IndexedDB, sessionStorage, etc.).
+ *
+ * @implements {UploadResumeCacheInterface}
+ *
+ * @example
+ * ```typescript
+ * const adapter = new DefaultUploadResumeCacheAdapter();
+ *
+ * // Save resume data
+ * await adapter.setItem('upload-123', {
+ *   fileId: 'file-abc',
+ *   fileName: 'document.pdf',
+ *   fileSize: 5242880,
+ *   uploadedChunks: 12,
+ *   lastChunkIndex: 11,
+ *   lastBytePosition: 1258291,
+ *   chunkSize: 1048576
+ * });
+ *
+ * // Retrieve and resume
+ * const resumeData = await adapter.getItem('upload-123');
+ * console.log(`Resume from chunk ${resumeData.uploadedChunks}`);
+ *
+ * // Remove specific item
+ * await adapter.removeItem('upload-123');
+ *
+ * // Clear all cache
+ * await adapter.clear();
+ * ```
+ */
+declare class DefaultUploadResumeCacheAdapter implements UploadResumeCacheInterface {
+    private cache;
+    private readonly maxCacheSize;
+    constructor();
+    /**
+     * Validates that the runtime environment is appropriate.
+     *
+     * @private
+     * @throws {UploadCacheError} If the environment is incompatible
+     */
+    private validateEnvironment;
+    /**
+     * Validates resume data according to strict criteria.
+     *
+     * @private
+     * @param data - The data to validate
+     * @throws {UploadCacheError} If the data is invalid
+     */
+    private validateResumeData;
+    /**
+     * Retrieves resume data for a specific upload.
+     *
+     * @param key - Unique identifier for the upload
+     * @returns Promise resolved with the resume data
+     * @throws {UploadCacheError} If the key does not exist or data is corrupted
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const data = await adapter.getItem('upload-123');
+     *   console.log(`${data.uploadedChunks}/${Math.ceil(data.fileSize / data.chunkSize)} chunks`);
+     * } catch (error) {
+     *   console.error('Failed to retrieve data:', error.message);
+     * }
+     * ```
+     */
+    getItem(key: string): Promise<ResumeData>;
+    /**
+     * Stores resume data for an upload session.
+     *
+     * @param key - Unique identifier for the upload
+     * @param data - Resume data containing upload progress information
+     * @returns Promise resolved when data is successfully cached
+     * @throws {UploadCacheError} If quota is exceeded or data is invalid
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await adapter.setItem('upload-123', {
+     *     fileId: 'file-abc',
+     *     fileName: 'video.mp4',
+     *     fileSize: 10737418240,
+     *     uploadedChunks: 45,
+     *     lastChunkIndex: 44,
+     *     lastBytePosition: 47185920,
+     *     chunkSize: 1048576
+     *   });
+     *   console.log('Data successfully saved');
+     * } catch (error) {
+     *   console.error('Storage error:', error.message);
+     * }
+     * ```
+     */
+    setItem(key: string, data: ResumeData): Promise<void>;
+    /**
+     * Removes resume data for a specific upload.
+     *
+     * @param key - Unique identifier for the upload
+     * @returns Promise resolved after removal
+     *
+     * @example
+     * ```typescript
+     * await adapter.removeItem('upload-123');
+     * ```
+     */
+    removeItem(key: string): Promise<void>;
+    /**
+     * Clears all cached resume data.
+     *
+     * @returns Promise resolved after complete cleanup
+     *
+     * @example
+     * ```typescript
+     * await adapter.clear();
+     * console.log('Cache cleared');
+     * ```
+     */
+    clear(): Promise<void>;
+    /**
+     * Returns the number of entries currently in cache.
+     *
+     * @returns Number of cache entries
+     */
+    get size(): number;
+    /**
+     * Returns cache usage as a percentage.
+     *
+     * @returns Usage percentage (0-100)
+     */
+    get usage(): number;
+}
+/**
+ * Custom error for upload cache operations.
+ *
+ * @example
+ * ```typescript
+ * throw new UploadCacheError('Resume data not found', 'NOT_FOUND');
+ * ```
+ */
+declare class UploadCacheError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+
+export { DefaultUploadResumeCacheAdapter, UploadCacheError, type UploadResumeCacheInterface };

package/dist/cjs/cache/index.js

@@ -0,0 +1,318 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var cache_exports = {};
+__export(cache_exports, {
+  DefaultUploadResumeCacheAdapter: () => DefaultUploadResumeCacheAdapter,
+  UploadCacheError: () => UploadCacheError
+});
+module.exports = __toCommonJS(cache_exports);
+class DefaultUploadResumeCacheAdapter {
+  static {
+    __name(this, "DefaultUploadResumeCacheAdapter");
+  }
+  cache = /* @__PURE__ */ new Map();
+  maxCacheSize = 100;
+  constructor() {
+    this.validateEnvironment();
+  }
+  /**
+   * Validates that the runtime environment is appropriate.
+   * 
+   * @private
+   * @throws {UploadCacheError} If the environment is incompatible
+   */
+  validateEnvironment() {
+    if (typeof window === "undefined") {
+      console.warn(
+        "[UploadResumeCacheAdapter] Server-side execution detected. Consider a server-compatible adapter for persistent storage."
+      );
+    }
+  }
+  /**
+   * Validates resume data according to strict criteria.
+   * 
+   * @private
+   * @param data - The data to validate
+   * @throws {UploadCacheError} If the data is invalid
+   */
+  validateResumeData(data) {
+    if (!data || typeof data !== "object") {
+      throw new UploadCacheError(
+        "Resume data must be a valid object",
+        "INVALID_DATA"
+      );
+    }
+    const requiredFields = [
+      "fileId",
+      "fileName",
+      "fileSize",
+      "uploadedChunks",
+      "lastChunkIndex",
+      "lastBytePosition",
+      "chunkSize"
+    ];
+    for (const field of requiredFields) {
+      if (!(field in data)) {
+        throw new UploadCacheError(
+          `Required field '${field}' is missing`,
+          "MISSING_FIELD"
+        );
+      }
+    }
+    if (typeof data.fileId !== "string" || !data.fileId.trim()) {
+      throw new UploadCacheError(
+        "fileId must be a non-empty string",
+        "INVALID_FILE_ID"
+      );
+    }
+    if (typeof data.fileName !== "string" || !data.fileName.trim()) {
+      throw new UploadCacheError(
+        "fileName must be a non-empty string",
+        "INVALID_FILE_NAME"
+      );
+    }
+    if (!Number.isFinite(data.fileSize) || data.fileSize <= 0) {
+      throw new UploadCacheError(
+        "fileSize must be a positive number",
+        "INVALID_FILE_SIZE"
+      );
+    }
+    if (!Number.isFinite(data.chunkSize) || data.chunkSize <= 0) {
+      throw new UploadCacheError(
+        "chunkSize must be a positive number",
+        "INVALID_CHUNK_SIZE"
+      );
+    }
+    if (!Number.isInteger(data.uploadedChunks) || data.uploadedChunks < 0) {
+      throw new UploadCacheError(
+        "uploadedChunks must be a non-negative integer",
+        "INVALID_UPLOADED_CHUNKS"
+      );
+    }
+    if (!Number.isInteger(data.lastChunkIndex) || data.lastChunkIndex < -1) {
+      throw new UploadCacheError(
+        "lastChunkIndex must be an integer >= -1",
+        "INVALID_LAST_CHUNK_INDEX"
+      );
+    }
+    if (!Number.isFinite(data.lastBytePosition) || data.lastBytePosition < 0) {
+      throw new UploadCacheError(
+        "lastBytePosition must be a non-negative number",
+        "INVALID_BYTE_POSITION"
+      );
+    }
+    if (data.uploadedChunks > 0 && data.lastBytePosition === 0) {
+      throw new UploadCacheError(
+        "lastBytePosition cannot be 0 if chunks have been uploaded",
+        "INCONSISTENT_DATA"
+      );
+    }
+    const expectedMaxChunks = Math.ceil(data.fileSize / data.chunkSize);
+    if (data.uploadedChunks > expectedMaxChunks) {
+      throw new UploadCacheError(
+        `uploadedChunks (${data.uploadedChunks}) exceeds maximum expected (${expectedMaxChunks})`,
+        "INCONSISTENT_DATA"
+      );
+    }
+  }
+  /**
+   * Retrieves resume data for a specific upload.
+   * 
+   * @param key - Unique identifier for the upload
+   * @returns Promise resolved with the resume data
+   * @throws {UploadCacheError} If the key does not exist or data is corrupted
+   * 
+   * @example
+   * ```typescript
+   * try {
+   *   const data = await adapter.getItem('upload-123');
+   *   console.log(`${data.uploadedChunks}/${Math.ceil(data.fileSize / data.chunkSize)} chunks`);
+   * } catch (error) {
+   *   console.error('Failed to retrieve data:', error.message);
+   * }
+   * ```
+   */
+  async getItem(key) {
+    return new Promise((resolve, reject) => {
+      try {
+        if (!key || typeof key !== "string") {
+          reject(new UploadCacheError(
+            "Key must be a non-empty string",
+            "INVALID_KEY"
+          ));
+          return;
+        }
+        const data = this.cache.get(key);
+        if (!data) {
+          reject(new UploadCacheError(
+            `Resume data for key '${key}' was not found`,
+            "NOT_FOUND"
+          ));
+          return;
+        }
+        resolve(JSON.parse(JSON.stringify(data)));
+      } catch (error) {
+        reject(new UploadCacheError(
+          `Error retrieving data: ${error instanceof Error ? error.message : String(error)}`,
+          "RETRIEVAL_ERROR"
+        ));
+      }
+    });
+  }
+  /**
+   * Stores resume data for an upload session.
+   * 
+   * @param key - Unique identifier for the upload
+   * @param data - Resume data containing upload progress information
+   * @returns Promise resolved when data is successfully cached
+   * @throws {UploadCacheError} If quota is exceeded or data is invalid
+   * 
+   * @example
+   * ```typescript
+   * try {
+   *   await adapter.setItem('upload-123', {
+   *     fileId: 'file-abc',
+   *     fileName: 'video.mp4',
+   *     fileSize: 10737418240,
+   *     uploadedChunks: 45,
+   *     lastChunkIndex: 44,
+   *     lastBytePosition: 47185920,
+   *     chunkSize: 1048576
+   *   });
+   *   console.log('Data successfully saved');
+   * } catch (error) {
+   *   console.error('Storage error:', error.message);
+   * }
+   * ```
+   */
+  async setItem(key, data) {
+    return new Promise((resolve, reject) => {
+      try {
+        if (!key || typeof key !== "string") {
+          reject(new UploadCacheError(
+            "Key must be a non-empty string",
+            "INVALID_KEY"
+          ));
+          return;
+        }
+        this.validateResumeData(data);
+        if (this.cache.size >= this.maxCacheSize && !this.cache.has(key)) {
+          reject(new UploadCacheError(
+            `Cache limit (${this.maxCacheSize} entries) has been reached. Remove obsolete entries or use an adapter with persistent storage.`,
+            "CACHE_LIMIT_EXCEEDED"
+          ));
+          return;
+        }
+        this.cache.set(key, JSON.parse(JSON.stringify(data)));
+        resolve();
+      } catch (error) {
+        if (error instanceof UploadCacheError) {
+          reject(error);
+        } else {
+          reject(new UploadCacheError(
+            `Error storing data: ${error instanceof Error ? error.message : String(error)}`,
+            "STORAGE_ERROR"
+          ));
+        }
+      }
+    });
+  }
+  /**
+   * Removes resume data for a specific upload.
+   * 
+   * @param key - Unique identifier for the upload
+   * @returns Promise resolved after removal
+   * 
+   * @example
+   * ```typescript
+   * await adapter.removeItem('upload-123');
+   * ```
+   */
+  async removeItem(key) {
+    return new Promise((resolve, reject) => {
+      try {
+        if (!key || typeof key !== "string") {
+          reject(new UploadCacheError(
+            "Key must be a non-empty string",
+            "INVALID_KEY"
+          ));
+          return;
+        }
+        this.cache.delete(key);
+        resolve();
+      } catch (error) {
+        reject(new UploadCacheError(
+          `Error removing data: ${error instanceof Error ? error.message : String(error)}`,
+          "DELETION_ERROR"
+        ));
+      }
+    });
+  }
+  /**
+   * Clears all cached resume data.
+   * 
+   * @returns Promise resolved after complete cleanup
+   * 
+   * @example
+   * ```typescript
+   * await adapter.clear();
+   * console.log('Cache cleared');
+   * ```
+   */
+  async clear() {
+    return new Promise((resolve) => {
+      this.cache.clear();
+      resolve();
+    });
+  }
+  /**
+   * Returns the number of entries currently in cache.
+   * 
+   * @returns Number of cache entries
+   */
+  get size() {
+    return this.cache.size;
+  }
+  /**
+   * Returns cache usage as a percentage.
+   * 
+   * @returns Usage percentage (0-100)
+   */
+  get usage() {
+    return this.cache.size / this.maxCacheSize * 100;
+  }
+}
+class UploadCacheError extends Error {
+  constructor(message, code) {
+    super(message);
+    this.code = code;
+    this.name = "UploadCacheError";
+  }
+  code;
+  static {
+    __name(this, "UploadCacheError");
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DefaultUploadResumeCacheAdapter,
+  UploadCacheError
+});
+//# sourceMappingURL=index.js.map