@wlindabla/file_uploader 1.0.0 → 2.0.1

package/dist/cjs/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/cache/index.ts"],"sourcesContent":["/*\n * This file is part of the project by AGBOKOUDJO Franck.\n *\n * (c) AGBOKOUDJO Franck <internationaleswebservices@gmail.com>\n * Phone: +229 0167 25 18 86\n * LinkedIn: https://www.linkedin.com/in/internationales-web-apps-services-120520193/\n * Company: INTERNATIONALES WEB APPS & SERVICES\n *\n * For more information, please feel free to contact the author.\n */\n\nimport { ResumeData } from \"../types\"\n\n/**\n * Interface for caching upload resume data.\n * \n * This interface extends the base cache functionality to specifically\n * handle resume data for file uploads, allowing uploads to be paused\n * and resumed across browser sessions.\n * \n * \n * @example\n * ```typescript\n * const cache: UploadResumeCacheInterface = new LocalStorageUploadResumeCache();\n * \n * // Save progress\n * await cache.setItem('video.mp4', {\n *   uploadedChunks: 45,\n *   totalChunks: 100,\n *   lastBytePosition: 47185920\n * });\n * \n * // Resume later\n * const data = await cache.getItem('video.mp4');\n * console.log(`Resume from chunk ${data.uploadedChunks}`);\n * ```\n */\nexport interface UploadResumeCacheInterface {\n    /**\n     * Retrieves cached resume data for a specific upload.\n     * \n     * @param key - Unique identifier for the upload (typically filename or file hash)\n     * @returns Promise resolving to the cached resume data\n     * @throws {Error} If the key doesn't exist or data is corrupted\n     */\n    getItem(key: string): Promise<ResumeData>;\n\n    /**\n     * Stores resume data for an upload session.\n     * \n     * @param key - Unique identifier for the upload\n     * @param data - Resume data containing upload progress information\n     * @returns Promise that resolves when data is successfully cached\n     * @throws {Error} If storage quota is exceeded or data is invalid\n     */\n    setItem(key: string, data: ResumeData): Promise<void>;\n}\n\n/**\n * Default adapter for caching resume data during file uploads.\n * \n * Implements an in-memory storage strategy with secure serialization,\n * strict data validation, and comprehensive error handling.\n * \n * This implementation serves as a foundation for specialized adapters\n * (localStorage, IndexedDB, sessionStorage, etc.).\n * \n * @implements {UploadResumeCacheInterface}\n * \n * @example\n * ```typescript\n * const adapter = new DefaultUploadResumeCacheAdapter();\n * \n * // Save resume data\n * await adapter.setItem('upload-123', {\n *   fileId: 'file-abc',\n *   fileName: 'document.pdf',\n *   fileSize: 5242880,\n *   uploadedChunks: 12,\n *   lastChunkIndex: 11,\n *   lastBytePosition: 1258291,\n *   chunkSize: 1048576\n * });\n * \n * // Retrieve and resume\n * const resumeData = await adapter.getItem('upload-123');\n * console.log(`Resume from chunk ${resumeData.uploadedChunks}`);\n * \n * // Remove specific item\n * await adapter.removeItem('upload-123');\n * \n * // Clear all cache\n * await adapter.clear();\n * ```\n */\nexport class DefaultUploadResumeCacheAdapter implements UploadResumeCacheInterface {\n\n    private cache: Map<string, ResumeData> = new Map();\n    private readonly maxCacheSize: number = 100;\n\n    constructor() {\n        this.validateEnvironment();\n    }\n\n    /**\n     * Validates that the runtime environment is appropriate.\n     * \n     * @private\n     * @throws {UploadCacheError} If the environment is incompatible\n     */\n    private validateEnvironment(): void {\n        if (typeof window === 'undefined') {\n            console.warn(\n                '[UploadResumeCacheAdapter] Server-side execution detected. ' +\n                'Consider a server-compatible adapter for persistent storage.'\n            );\n        }\n    }\n\n    /**\n     * Validates resume data according to strict criteria.\n     * \n     * @private\n     * @param data - The data to validate\n     * @throws {UploadCacheError} If the data is invalid\n     */\n    private validateResumeData(data: ResumeData): void {\n        if (!data || typeof data !== 'object') {\n            throw new UploadCacheError(\n                'Resume data must be a valid object',\n                'INVALID_DATA'\n            );\n        }\n\n        // Validate required fields\n        const requiredFields: (keyof ResumeData)[] = [\n            'fileId',\n            'fileName',\n            'fileSize',\n            'uploadedChunks',\n            'lastChunkIndex',\n            'lastBytePosition',\n            'chunkSize'\n        ];\n\n        for (const field of requiredFields) {\n            if (!(field in data)) {\n                throw new UploadCacheError(\n                    `Required field '${field}' is missing`,\n                    'MISSING_FIELD'\n                );\n            }\n        }\n\n        // Validate types\n        if (typeof data.fileId !== 'string' || !data.fileId.trim()) {\n            throw new UploadCacheError(\n                'fileId must be a non-empty string',\n                'INVALID_FILE_ID'\n            );\n        }\n\n        if (typeof data.fileName !== 'string' || !data.fileName.trim()) {\n            throw new UploadCacheError(\n                'fileName must be a non-empty string',\n                'INVALID_FILE_NAME'\n            );\n        }\n\n        // Validate numbers\n        if (!Number.isFinite(data.fileSize) || data.fileSize <= 0) {\n            throw new UploadCacheError(\n                'fileSize must be a positive number',\n                'INVALID_FILE_SIZE'\n            );\n        }\n\n        if (!Number.isFinite(data.chunkSize) || data.chunkSize <= 0) {\n            throw new UploadCacheError(\n                'chunkSize must be a positive number',\n                'INVALID_CHUNK_SIZE'\n            );\n        }\n\n        if (!Number.isInteger(data.uploadedChunks) || data.uploadedChunks < 0) {\n            throw new UploadCacheError(\n                'uploadedChunks must be a non-negative integer',\n                'INVALID_UPLOADED_CHUNKS'\n            );\n        }\n\n        if (!Number.isInteger(data.lastChunkIndex) || data.lastChunkIndex < -1) {\n            throw new UploadCacheError(\n                'lastChunkIndex must be an integer >= -1',\n                'INVALID_LAST_CHUNK_INDEX'\n            );\n        }\n\n        if (!Number.isFinite(data.lastBytePosition) || data.lastBytePosition < 0) {\n            throw new UploadCacheError(\n                'lastBytePosition must be a non-negative number',\n                'INVALID_BYTE_POSITION'\n            );\n        }\n\n        // Validate logical consistency\n        if (data.uploadedChunks > 0 && data.lastBytePosition === 0) {\n            throw new UploadCacheError(\n                'lastBytePosition cannot be 0 if chunks have been uploaded',\n                'INCONSISTENT_DATA'\n            );\n        }\n\n        const expectedMaxChunks = Math.ceil(data.fileSize / data.chunkSize);\n        if (data.uploadedChunks > expectedMaxChunks) {\n            throw new UploadCacheError(\n                `uploadedChunks (${data.uploadedChunks}) exceeds maximum expected (${expectedMaxChunks})`,\n                'INCONSISTENT_DATA'\n            );\n        }\n    }\n\n    /**\n     * Retrieves resume data for a specific upload.\n     * \n     * @param key - Unique identifier for the upload\n     * @returns Promise resolved with the resume data\n     * @throws {UploadCacheError} If the key does not exist or data is corrupted\n     * \n     * @example\n     * ```typescript\n     * try {\n     *   const data = await adapter.getItem('upload-123');\n     *   console.log(`${data.uploadedChunks}/${Math.ceil(data.fileSize / data.chunkSize)} chunks`);\n     * } catch (error) {\n     *   console.error('Failed to retrieve data:', error.message);\n     * }\n     * ```\n     */\n    async getItem(key: string): Promise<ResumeData> {\n        return new Promise((resolve, reject) => {\n            try {\n                if (!key || typeof key !== 'string') {\n                    reject(new UploadCacheError(\n                        'Key must be a non-empty string',\n                        'INVALID_KEY'\n                    ));\n                    return;\n                }\n\n                const data = this.cache.get(key);\n\n                if (!data) {\n                    reject(new UploadCacheError(\n                        `Resume data for key '${key}' was not found`,\n                        'NOT_FOUND'\n                    ));\n                    return;\n                }\n\n                // Return a deep copy to prevent external mutations\n                resolve(JSON.parse(JSON.stringify(data)));\n            } catch (error) {\n                reject(new UploadCacheError(\n                    `Error retrieving data: ${error instanceof Error ? error.message : String(error)}`,\n                    'RETRIEVAL_ERROR'\n                ));\n            }\n        });\n    }\n\n    /**\n     * Stores resume data for an upload session.\n     * \n     * @param key - Unique identifier for the upload\n     * @param data - Resume data containing upload progress information\n     * @returns Promise resolved when data is successfully cached\n     * @throws {UploadCacheError} If quota is exceeded or data is invalid\n     * \n     * @example\n     * ```typescript\n     * try {\n     *   await adapter.setItem('upload-123', {\n     *     fileId: 'file-abc',\n     *     fileName: 'video.mp4',\n     *     fileSize: 10737418240,\n     *     uploadedChunks: 45,\n     *     lastChunkIndex: 44,\n     *     lastBytePosition: 47185920,\n     *     chunkSize: 1048576\n     *   });\n     *   console.log('Data successfully saved');\n     * } catch (error) {\n     *   console.error('Storage error:', error.message);\n     * }\n     * ```\n     */\n    async setItem(key: string, data: ResumeData): Promise<void> {\n        return new Promise((resolve, reject) => {\n            try {\n                if (!key || typeof key !== 'string') {\n                    reject(new UploadCacheError(\n                        'Key must be a non-empty string',\n                        'INVALID_KEY'\n                    ));\n                    return;\n                }\n\n                this.validateResumeData(data);\n\n                // Check cache limit\n                if (this.cache.size >= this.maxCacheSize && !this.cache.has(key)) {\n                    reject(new UploadCacheError(\n                        `Cache limit (${this.maxCacheSize} entries) has been reached. ` +\n                        'Remove obsolete entries or use an adapter with persistent storage.',\n                        'CACHE_LIMIT_EXCEEDED'\n                    ));\n                    return;\n                }\n\n                // Store a deep copy\n                this.cache.set(key, JSON.parse(JSON.stringify(data)));\n                resolve();\n            } catch (error) {\n                if (error instanceof UploadCacheError) {\n                    reject(error);\n                } else {\n                    reject(new UploadCacheError(\n                        `Error storing data: ${error instanceof Error ? error.message : String(error)}`,\n                        'STORAGE_ERROR'\n                    ));\n                }\n            }\n        });\n    }\n\n    /**\n     * Removes resume data for a specific upload.\n     * \n     * @param key - Unique identifier for the upload\n     * @returns Promise resolved after removal\n     * \n     * @example\n     * ```typescript\n     * await adapter.removeItem('upload-123');\n     * ```\n     */\n    async removeItem(key: string): Promise<void> {\n        return new Promise((resolve, reject) => {\n            try {\n                if (!key || typeof key !== 'string') {\n                    reject(new UploadCacheError(\n                        'Key must be a non-empty string',\n                        'INVALID_KEY'\n                    ));\n                    return;\n                }\n\n                this.cache.delete(key);\n                resolve();\n            } catch (error) {\n                reject(new UploadCacheError(\n                    `Error removing data: ${error instanceof Error ? error.message : String(error)}`,\n                    'DELETION_ERROR'\n                ));\n            }\n        });\n    }\n\n    /**\n     * Clears all cached resume data.\n     * \n     * @returns Promise resolved after complete cleanup\n     * \n     * @example\n     * ```typescript\n     * await adapter.clear();\n     * console.log('Cache cleared');\n     * ```\n     */\n    async clear(): Promise<void> {\n        return new Promise((resolve) => {\n            this.cache.clear();\n            resolve();\n        });\n    }\n\n    /**\n     * Returns the number of entries currently in cache.\n     * \n     * @returns Number of cache entries\n     */\n    get size(): number {\n        return this.cache.size;\n    }\n\n    /**\n     * Returns cache usage as a percentage.\n     * \n     * @returns Usage percentage (0-100)\n     */\n    get usage(): number {\n        return (this.cache.size / this.maxCacheSize) * 100;\n    }\n}\n\n/**\n * Custom error for upload cache operations.\n * \n * @example\n * ```typescript\n * throw new UploadCacheError('Resume data not found', 'NOT_FOUND');\n * ```\n */\nexport class UploadCacheError extends Error {\n    constructor(\n        message: string,\n        public readonly code: string\n    ) {\n        super(message);\n        this.name = 'UploadCacheError';\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+FO,MAAM,gCAAsE;AAAA,EA/FnF,OA+FmF;AAAA;AAAA;AAAA,EAEvE,QAAiC,oBAAI,IAAI;AAAA,EAChC,eAAuB;AAAA,EAExC,cAAc;AACV,SAAK,oBAAoB;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,sBAA4B;AAChC,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ;AAAA,QACJ;AAAA,MAEJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,mBAAmB,MAAwB;AAC/C,QAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACnC,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAGA,UAAM,iBAAuC;AAAA,MACzC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAEA,eAAW,SAAS,gBAAgB;AAChC,UAAI,EAAE,SAAS,OAAO;AAClB,cAAM,IAAI;AAAA,UACN,mBAAmB,KAAK;AAAA,UACxB;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAGA,QAAI,OAAO,KAAK,WAAW,YAAY,CAAC,KAAK,OAAO,KAAK,GAAG;AACxD,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,OAAO,KAAK,aAAa,YAAY,CAAC,KAAK,SAAS,KAAK,GAAG;AAC5D,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAGA,QAAI,CAAC,OAAO,SAAS,KAAK,QAAQ,KAAK,KAAK,YAAY,GAAG;AACvD,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,CAAC,OAAO,SAAS,KAAK,SAAS,KAAK,KAAK,aAAa,GAAG;AACzD,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,CAAC,OAAO,UAAU,KAAK,cAAc,KAAK,KAAK,iBAAiB,GAAG;AACnE,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,CAAC,OAAO,UAAU,KAAK,cAAc,KAAK,KAAK,iBAAiB,IAAI;AACpE,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,CAAC,OAAO,SAAS,KAAK,gBAAgB,KAAK,KAAK,mBAAmB,GAAG;AACtE,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAGA,QAAI,KAAK,iBAAiB,KAAK,KAAK,qBAAqB,GAAG;AACxD,YAAM,IAAI;AAAA,QACN;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAEA,UAAM,oBAAoB,KAAK,KAAK,KAAK,WAAW,KAAK,SAAS;AAClE,QAAI,KAAK,iBAAiB,mBAAmB;AACzC,YAAM,IAAI;AAAA,QACN,mBAAmB,KAAK,cAAc,+BAA+B,iBAAiB;AAAA,QACtF;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,MAAM,QAAQ,KAAkC;AAC5C,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACpC,UAAI;AACA,YAAI,CAAC,OAAO,OAAO,QAAQ,UAAU;AACjC,iBAAO,IAAI;AAAA,YACP;AAAA,YACA;AAAA,UACJ,CAAC;AACD;AAAA,QACJ;AAEA,cAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAE/B,YAAI,CAAC,MAAM;AACP,iBAAO,IAAI;AAAA,YACP,wBAAwB,GAAG;AAAA,YAC3B;AAAA,UACJ,CAAC;AACD;AAAA,QACJ;AAGA,gBAAQ,KAAK,MAAM,KAAK,UAAU,IAAI,CAAC,CAAC;AAAA,MAC5C,SAAS,OAAO;AACZ,eAAO,IAAI;AAAA,UACP,0BAA0B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;AAAA,UAChF;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BA,MAAM,QAAQ,KAAa,MAAiC;AACxD,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACpC,UAAI;AACA,YAAI,CAAC,OAAO,OAAO,QAAQ,UAAU;AACjC,iBAAO,IAAI;AAAA,YACP;AAAA,YACA;AAAA,UACJ,CAAC;AACD;AAAA,QACJ;AAEA,aAAK,mBAAmB,IAAI;AAG5B,YAAI,KAAK,MAAM,QAAQ,KAAK,gBAAgB,CAAC,KAAK,MAAM,IAAI,GAAG,GAAG;AAC9D,iBAAO,IAAI;AAAA,YACP,gBAAgB,KAAK,YAAY;AAAA,YAEjC;AAAA,UACJ,CAAC;AACD;AAAA,QACJ;AAGA,aAAK,MAAM,IAAI,KAAK,KAAK,MAAM,KAAK,UAAU,IAAI,CAAC,CAAC;AACpD,gBAAQ;AAAA,MACZ,SAAS,OAAO;AACZ,YAAI,iBAAiB,kBAAkB;AACnC,iBAAO,KAAK;AAAA,QAChB,OAAO;AACH,iBAAO,IAAI;AAAA,YACP,uBAAuB,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;AAAA,YAC7E;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,WAAW,KAA4B;AACzC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACpC,UAAI;AACA,YAAI,CAAC,OAAO,OAAO,QAAQ,UAAU;AACjC,iBAAO,IAAI;AAAA,YACP;AAAA,YACA;AAAA,UACJ,CAAC;AACD;AAAA,QACJ;AAEA,aAAK,MAAM,OAAO,GAAG;AACrB,gBAAQ;AAAA,MACZ,SAAS,OAAO;AACZ,eAAO,IAAI;AAAA,UACP,wBAAwB,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;AAAA,UAC9E;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,QAAuB;AACzB,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC5B,WAAK,MAAM,MAAM;AACjB,cAAQ;AAAA,IACZ,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,OAAe;AACf,WAAO,KAAK,MAAM;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,QAAgB;AAChB,WAAQ,KAAK,MAAM,OAAO,KAAK,eAAgB;AAAA,EACnD;AACJ;AAUO,MAAM,yBAAyB,MAAM;AAAA,EACxC,YACI,SACgB,MAClB;AACE,UAAM,OAAO;AAFG;AAGhB,SAAK,OAAO;AAAA,EAChB;AAAA,EAJoB;AAAA,EAjaxB,OA8Z4C;AAAA;AAAA;AAQ5C;","names":[]}

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

@@ -0,0 +1,271 @@
+import { EventDispatcherInterface } from '@wlindabla/event_dispatcher';
+import { UploadOptions, UploadEndpoints, UploadState, ResumeData } from '../types/index.js';
+import { UploadResumeCacheInterface } from '../cache/index.js';
+import '@wlindabla/http_client';
+
+/**
+ * ChunkedFileUploader
+ *
+ * A production-ready, event-driven chunked file upload engine for Browser and Node.js.
+ *
+ * Designed and developed by **AGBOKOUDJO Franck** at
+ * **INTERNATIONALES WEB APPS & SERVICES**, this class provides a robust,
+ * framework-agnostic solution for uploading large files to a remote server
+ * by splitting them into smaller chunks and sending them in parallel with
+ * configurable concurrency control.
+ *
+ * ---
+ *
+ * ### How It Works
+ *
+ * The upload process follows a strict three-phase lifecycle:
+ *
+ * 1. **Initialization** — A session is opened with the server via the `init` endpoint.
+ *    The file is identified by its name, size, type, and a SHA-256 hash of its
+ *    first megabyte. The server returns a unique `mediaId` that identifies the session.
+ *
+ * 2. **Chunk Upload** — The file is sliced into fixed-size chunks and uploaded
+ *    concurrently using `p-limit`. Each chunk carries its index, the total number
+ *    of chunks, and the session `mediaId`. Failed chunks are retried automatically
+ *    with exponential backoff up to `maxRetries` attempts.
+ *
+ * 3. **Finalization** — Once all chunks are successfully uploaded, the `finalize`
+ *    endpoint is called to instruct the server to assemble the chunks into the
+ *    final file.
+ *
+ * ---
+ *
+ * ### Event-Driven Architecture
+ *
+ * This class follows the **Symfony EventDispatcher pattern** via
+ * `@wlindabla/event_dispatcher`. Every meaningful moment in the upload
+ * lifecycle emits a typed event that your application can listen to:
+ *
+ * ```
+ * IDLE → INITIALIZING → UPLOADING → FINALIZING → COMPLETED
+ *                ↓            ↓
+ *             FAILED        PAUSED ↔ UPLOADING
+ *                              ↓
+ *                          CANCELLED
+ * ```
+ *
+ * All event name constants are centralized in {@link HttpFileUploaderEvents}.
+ *
+ * ---
+ *
+ * ### Subscriber Registration (Required)
+ *
+ * Before calling `.upload()`, you **must** register the two built-in subscribers
+ * on your dispatcher. They handle the HTTP communication for the init and finalize phases:
+ *
+ * ```typescript
+ * // Browser
+ * const dispatcher = new BrowserEventDispatcher(document);
+ * dispatcher.addSubscriber(new InitializeUploadSubscriber(dispatcher));
+ * dispatcher.addSubscriber(new FinalizeUploadSubscriber(dispatcher));
+ *
+ * // Node.js
+ * const dispatcher = new NodeEventDispatcher();
+ * dispatcher.addSubscriber(new InitializeUploadSubscriber(dispatcher));
+ * dispatcher.addSubscriber(new FinalizeUploadSubscriber(dispatcher));
+ * ```
+ *
+ * ---
+ *
+ * ### Fluent Builder API
+ *
+ * The class exposes a fluent API to configure the upload before starting:
+ *
+ * ```typescript
+ * const uploader = new ChunkedFileUploader(dispatcher, cache, options);
+ *
+ * await uploader
+ *   .withFile(file)
+ *   .withEndpoints({
+ *     init:     'https://api.example.com/upload/init',
+ *     upload:   'https://api.example.com/upload/chunk',
+ *     finalize: 'https://api.example.com/upload/finalize'
+ *   })
+ *   .upload();
+ * ```
+ *
+ * ---
+ *
+ * ### Resumable Uploads
+ *
+ * When `autoSave: true` is set in options, the upload progress is persisted
+ * after each successful chunk via the {@link UploadResumeCacheInterface}.
+ * A failed or interrupted upload can be resumed later:
+ *
+ * ```typescript
+ * const resumeData = await uploader.loadResumeData(file.name);
+ *
+ * if (resumeData) {
+ *   await uploader
+ *     .withFile(file)
+ *     .withEndpoints(endpoints)
+ *     .resumeUpload(resumeData);
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### Concurrency
+ *
+ * Multiple chunks can be uploaded simultaneously. The `concurrency` option
+ * controls how many parallel uploads are active at any given time.
+ * The default value is `3`, which provides a good balance between speed
+ * and server/network load:
+ *
+ * ```typescript
+ * // Upload 5 chunks in parallel
+ * new ChunkedFileUploader(dispatcher, cache, { concurrency: 5 });
+ * ```
+ *
+ * ---
+ *
+ * ### Pause, Resume and Cancel
+ *
+ * The upload can be paused, resumed, or cancelled at any time:
+ *
+ * ```typescript
+ * uploader.pause();   // Pauses after the current chunk finishes
+ * uploader.resume();  // Resumes from where it was paused
+ * uploader.cancel();  // Aborts immediately via AbortController
+ * ```
+ *
+ * ---
+ *
+ * ### Cache
+ *
+ * The library does **not** provide a built-in cache implementation to stay
+ * lightweight and environment-agnostic. You must implement
+ * {@link UploadResumeCacheInterface} with your preferred storage backend
+ * (localStorage, IndexedDB, Redis, filesystem, etc.).
+ *
+ * ---
+ *
+ * @author    AGBOKOUDJO Franck <internationaleswebservices@gmail.com>
+ * @company   INTERNATIONALES WEB APPS & SERVICES
+ * @phone     +229 0167 25 18 86
+ * @linkedin  https://www.linkedin.com/in/internationales-web-apps-services-120520193/
+ * @github    https://github.com/Agbokoudjo/file_uploader
+ *
+ * @version   2.0.1
+ * @since     1.0.0
+ * @license   MIT
+ *
+ * @see {@link HttpFileUploaderEvents}        All event name constants
+ * @see {@link UploadResumeCacheInterface}    Cache interface to implement
+ * @see {@link InitializeUploadSubscriber}    Handles the init HTTP phase
+ * @see {@link FinalizeUploadSubscriber}      Handles the finalize HTTP phase
+ * @see {@link UploadOptions}                 Full configuration reference
+ * @see {@link https://github.com/Agbokoudjo/file_uploader | GitHub Repository}
+ */
+declare class ChunkedFileUploader {
+    private readonly _uploadEventDispatcher;
+    private readonly uploadResumeData;
+    private options;
+    private _file;
+    private _endpoints;
+    private isPaused;
+    private startTime;
+    private uploadedBytes;
+    private abortController;
+    private state;
+    private totalChunks;
+    private percentage;
+    private uploadedChunks;
+    private lastUploadedChunkIndex;
+    /**
+      * @param  _uploadEventDispatcher: new BrowserEventDispatcher(), //or new NodeJSEventDispatcher() if you have an environment NodeJs
+      * @param uploadResumeData: UploadResumeCacheInterface
+      * @param options: UploadOptions
+     */
+    constructor(_uploadEventDispatcher: EventDispatcherInterface, uploadResumeData: UploadResumeCacheInterface, options: UploadOptions);
+    /**
+     * Starts the chunked file upload process.
+     *
+     * @throws {Error} If file or endpoints are not set
+     * @throws {InitializeUploadFailureException} If server initialization fails
+     * @throws {FileUploadChunkError} If a chunk fails after all retries
+     *
+     * @example
+     * ```typescript
+     * const uploader = new ChunkedFileUploader(dispatcher, cache, options);
+     *
+     * uploader
+     *   .withFile(file)
+     *   .withEndpoints({ init, upload, finalize });
+     *
+     * await uploader.upload();
+     * ```
+     */
+    upload(): Promise<void>;
+    withFile(file: File): this;
+    withEndpoints(endpoints: UploadEndpoints): this;
+    private get endPointOptions();
+    private get file();
+    /**
+     * Upload all chunks with concurrency control using p-limit
+     *
+     * @param file - File to upload
+     * @param chunkSize - Size of each chunk
+     * @param fileId - Server file ID
+     * @param fileHash - File hash
+     * @param maxRetries - Max retry attempts per chunk
+     * @param concurrency - Number of concurrent uploads (default: 3)
+     */
+    private uploadChunksWithConcurrency;
+    /**
+     * Process a single chunk: slice, upload with retry, and save progress.
+     *
+     * @param file - The file being uploaded
+     * @param currentChunkIndex - Index of the current chunk (0-based)
+     * @param chunkSize - Size of each chunk in bytes
+     * @param fileId - Server-provided file/session ID
+     * @param fileHash - SHA-256 hash of the file
+     * @param maxRetries - Maximum number of retry attempts
+     *
+     * @throws {UploadCancelledException} If upload is cancelled
+     * @throws {FileUploadChunkError} If chunk upload fails after all retries
+     */
+    private processChunk;
+    private uploadChunkWithRetry;
+    private uploadChunk;
+    private createChunkAbortSignal;
+    private notifyProgress;
+    private sleep;
+    /**
+     * Save current upload progress to cache for resume capability
+     *
+     * @param fileId - Server-provided file/session ID
+     * @param chunkSize - Size of each chunk in bytes
+     * @returns Saved resume data
+     */
+    private saveResumeData;
+    private setState;
+    getState(): UploadState;
+    private handleUploadFailure;
+    cancel(): void;
+    pause(): void;
+    resume(): void;
+    /**
+    * Load previously saved resume data
+    *
+    * @param fileName - Name of the file to resume
+    * @returns Resume data or null if not found
+    */
+    loadResumeData(fileName: string): Promise<ResumeData | null>;
+    /**
+    * Resume upload from saved state
+    *
+    * @param resumeData - Previously saved resume data
+    * @returns Upload result
+    */
+    resumeUpload(resumeData: ResumeData): Promise<void>;
+    private updateProgress;
+    private finalizeUpload;
+}
+
+export { ChunkedFileUploader };