filemail-sdk 3.0.3

package/dist/src/downloader/chunkDownloader.js

@@ -0,0 +1,172 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ChunkDownloader_instances, _ChunkDownloader_transferId, _ChunkDownloader_chunk, _ChunkDownloader_file, _ChunkDownloader_downloadState, _ChunkDownloader_options, _ChunkDownloader_fileServerClientFactory, _ChunkDownloader_chunkStreamProviderFactory, _ChunkDownloader_eventsEngine, _ChunkDownloader_chunkDownloadClient, _ChunkDownloader_bytesTransferred, _ChunkDownloader_running, _ChunkDownloader_throwIfRunning, _ChunkDownloader_addEventListeners, _ChunkDownloader_removeEventListeners, _ChunkDownloader_canRetry, _ChunkDownloader_onAbortRequested, _ChunkDownloader_onFileFailed, _ChunkDownloader_onProgress;
+/* eslint-disable no-await-in-loop */
+import { RequestError } from "got";
+import TransferStatus from "../utils/types/transferStatus.js";
+import DownloadError from "./dtos/downloadError.js";
+import DownloadEvent from "./dtos/downloadEvent.js";
+import sleep from "../utils/sleep.js";
+class ChunkDownloader {
+    constructor(transferId, file, chunk, downloadState, options, fileServerClientFactory, chunkStreamProviderFactory, eventsEngine) {
+        _ChunkDownloader_instances.add(this);
+        _ChunkDownloader_transferId.set(this, void 0);
+        _ChunkDownloader_chunk.set(this, void 0);
+        _ChunkDownloader_file.set(this, void 0);
+        _ChunkDownloader_downloadState.set(this, void 0);
+        _ChunkDownloader_options.set(this, void 0);
+        _ChunkDownloader_fileServerClientFactory.set(this, void 0);
+        _ChunkDownloader_chunkStreamProviderFactory.set(this, void 0);
+        _ChunkDownloader_eventsEngine.set(this, void 0);
+        _ChunkDownloader_chunkDownloadClient.set(this, void 0);
+        _ChunkDownloader_bytesTransferred.set(this, 0);
+        _ChunkDownloader_running.set(this, false);
+        _ChunkDownloader_onAbortRequested.set(this, () => {
+            __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f")?.release();
+        });
+        _ChunkDownloader_onFileFailed.set(this, (args) => {
+            if (__classPrivateFieldGet(this, _ChunkDownloader_file, "f").externalId === args.file.id)
+                __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f")?.release();
+        });
+        _ChunkDownloader_onProgress.set(this, (args) => {
+            __classPrivateFieldSet(this, _ChunkDownloader_bytesTransferred, args.transferredBytesTotal, "f");
+            __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").chunkDownloadProgressed(__classPrivateFieldGet(this, _ChunkDownloader_file, "f"), __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f"), args);
+        });
+        __classPrivateFieldSet(this, _ChunkDownloader_transferId, transferId, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_options, options, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_file, file, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_chunk, chunk, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_downloadState, downloadState, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_fileServerClientFactory, fileServerClientFactory, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_chunkStreamProviderFactory, chunkStreamProviderFactory, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_eventsEngine, eventsEngine, "f");
+        __classPrivateFieldSet(this, _ChunkDownloader_chunkDownloadClient, __classPrivateFieldGet(this, _ChunkDownloader_fileServerClientFactory, "f").createFileServerDownloadClient(__classPrivateFieldGet(this, _ChunkDownloader_file, "f").url, __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").start, __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").end, __classPrivateFieldGet(this, _ChunkDownloader_transferId, "f"), __classPrivateFieldGet(this, _ChunkDownloader_file, "f").name, __classPrivateFieldGet(this, _ChunkDownloader_options, "f")), "f");
+    }
+    async download() {
+        __classPrivateFieldGet(this, _ChunkDownloader_instances, "m", _ChunkDownloader_throwIfRunning).call(this);
+        __classPrivateFieldSet(this, _ChunkDownloader_running, true, "f");
+        let writtenCorrectly = false;
+        let attempts = 0;
+        let writeErrors = 0;
+        let networkErrors = 0;
+        let lastError = null;
+        let unhandledError = null;
+        try {
+            __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").chunkDownloadStarted(__classPrivateFieldGet(this, _ChunkDownloader_file, "f"), __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f"));
+            __classPrivateFieldGet(this, _ChunkDownloader_instances, "m", _ChunkDownloader_addEventListeners).call(this);
+            const fileserverMd5Promise = __classPrivateFieldGet(this, _ChunkDownloader_options, "f").checkChunksMd5
+                ? __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f").getMd5Checksum()
+                : null;
+            while (writtenCorrectly === false && __classPrivateFieldGet(this, _ChunkDownloader_instances, "m", _ChunkDownloader_canRetry).call(this, lastError, writeErrors, networkErrors)) {
+                attempts += 1;
+                __classPrivateFieldSet(this, _ChunkDownloader_bytesTransferred, 0, "f");
+                const chunkWriter = __classPrivateFieldGet(this, _ChunkDownloader_chunkStreamProviderFactory, "f").provide(__classPrivateFieldGet(this, _ChunkDownloader_file, "f").downloadPath, __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").start ?? 0, __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkSize);
+                try {
+                    await __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f").download(chunkWriter);
+                    if (__classPrivateFieldGet(this, _ChunkDownloader_bytesTransferred, "f") !== __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkSize) {
+                        if (__classPrivateFieldGet(this, _ChunkDownloader_bytesTransferred, "f") > __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkSize)
+                            __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").possibleSupersizedFile(__classPrivateFieldGet(this, _ChunkDownloader_file, "f"));
+                        throw new DownloadError(`Download request returned incorrect amount of data. Expected=${__classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkSize} Received=${__classPrivateFieldGet(this, _ChunkDownloader_bytesTransferred, "f")}`);
+                    }
+                    networkErrors = 0;
+                    __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").networkOk();
+                    if (__classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").status !== TransferStatus.Aborting) {
+                        if (fileserverMd5Promise !== null) {
+                            const remoteMd5 = await fileserverMd5Promise;
+                            const localMd5 = await chunkWriter.getMd5Checksum(`hex`);
+                            if (remoteMd5.toLowerCase() === localMd5.toLowerCase())
+                                writtenCorrectly = true;
+                            else {
+                                writeErrors += 1;
+                                lastError = new DownloadError(`MD5 checksum incorrect: fileserver=${remoteMd5} local=${localMd5}`);
+                            }
+                        }
+                        else
+                            writtenCorrectly = true;
+                    }
+                }
+                catch (error) {
+                    lastError = error;
+                    if (lastError instanceof RequestError) {
+                        networkErrors += 1;
+                        __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").networkFailure();
+                    }
+                    else
+                        writeErrors += 1;
+                }
+                finally {
+                    chunkWriter?.release();
+                    __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f")?.release();
+                    let sleepTime = 0;
+                    if (__classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").isThereNetworkProblem)
+                        sleepTime = __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverOfflineCheckIntervalMillis;
+                    else if (networkErrors > 0) {
+                        const pow = Math.min(networkErrors, __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverOfflineAfterConsecutiveAttempts);
+                        sleepTime = __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverOfflineCheckIntervalMillis * (2 ** (pow - __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverOfflineAfterConsecutiveAttempts));
+                    }
+                    if (sleepTime > 0)
+                        await sleep(sleepTime);
+                }
+            }
+        }
+        catch (error) {
+            unhandledError = error;
+        }
+        finally {
+            __classPrivateFieldGet(this, _ChunkDownloader_instances, "m", _ChunkDownloader_removeEventListeners).call(this);
+        }
+        let downloadError = null;
+        if (unhandledError)
+            downloadError = new DownloadError(`Unhandled chunk download error for file ${__classPrivateFieldGet(this, _ChunkDownloader_file, "f").url} chunk ${__classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkNumber}`, { cause: unhandledError });
+        else if (__classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").status === TransferStatus.Aborting)
+            downloadError = new DownloadError(`Chunk download aborted for file ${__classPrivateFieldGet(this, _ChunkDownloader_file, "f").url} chunk ${__classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkNumber} attempt ${attempts}.`);
+        else if (!writtenCorrectly) {
+            downloadError = new DownloadError(`Chunk download failed for file ${__classPrivateFieldGet(this, _ChunkDownloader_file, "f").url} chunk ${__classPrivateFieldGet(this, _ChunkDownloader_chunk, "f").chunkNumber} attempt ${attempts}.`);
+            if (lastError) {
+                downloadError.message += ` See "cause" for more information.`;
+                downloadError.cause = lastError;
+            }
+        }
+        if (downloadError) {
+            if (__classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").status !== TransferStatus.Aborting) {
+                // once abort has been called we are not really interested in files or chunks state - just cancel the entire download
+                // so fail the chunk only if we are not aborting
+                __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").chunkDownloadFailed(__classPrivateFieldGet(this, _ChunkDownloader_file, "f"), __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f"), downloadError);
+            }
+        }
+        else
+            __classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").chunkDownloadCompleted(__classPrivateFieldGet(this, _ChunkDownloader_file, "f"), __classPrivateFieldGet(this, _ChunkDownloader_chunk, "f"));
+        __classPrivateFieldSet(this, _ChunkDownloader_running, false, "f");
+    }
+}
+_ChunkDownloader_transferId = new WeakMap(), _ChunkDownloader_chunk = new WeakMap(), _ChunkDownloader_file = new WeakMap(), _ChunkDownloader_downloadState = new WeakMap(), _ChunkDownloader_options = new WeakMap(), _ChunkDownloader_fileServerClientFactory = new WeakMap(), _ChunkDownloader_chunkStreamProviderFactory = new WeakMap(), _ChunkDownloader_eventsEngine = new WeakMap(), _ChunkDownloader_chunkDownloadClient = new WeakMap(), _ChunkDownloader_bytesTransferred = new WeakMap(), _ChunkDownloader_running = new WeakMap(), _ChunkDownloader_onAbortRequested = new WeakMap(), _ChunkDownloader_onFileFailed = new WeakMap(), _ChunkDownloader_onProgress = new WeakMap(), _ChunkDownloader_instances = new WeakSet(), _ChunkDownloader_throwIfRunning = function _ChunkDownloader_throwIfRunning() {
+    if (__classPrivateFieldGet(this, _ChunkDownloader_running, "f"))
+        throw new DownloadError(`Thist instance of chunk downloader is already in use. Please create a new one.`);
+}, _ChunkDownloader_addEventListeners = function _ChunkDownloader_addEventListeners() {
+    __classPrivateFieldGet(this, _ChunkDownloader_eventsEngine, "f").addEventListener(DownloadEvent.Aborting, __classPrivateFieldGet(this, _ChunkDownloader_onAbortRequested, "f"));
+    __classPrivateFieldGet(this, _ChunkDownloader_eventsEngine, "f").addEventListener(DownloadEvent.FileDownloadFailed, __classPrivateFieldGet(this, _ChunkDownloader_onFileFailed, "f"));
+    __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f").addEventListener(`progress`, __classPrivateFieldGet(this, _ChunkDownloader_onProgress, "f"));
+}, _ChunkDownloader_removeEventListeners = function _ChunkDownloader_removeEventListeners() {
+    __classPrivateFieldGet(this, _ChunkDownloader_eventsEngine, "f").removeEventListener(DownloadEvent.Aborting, __classPrivateFieldGet(this, _ChunkDownloader_onAbortRequested, "f"));
+    __classPrivateFieldGet(this, _ChunkDownloader_eventsEngine, "f").removeEventListener(DownloadEvent.FileDownloadFailed, __classPrivateFieldGet(this, _ChunkDownloader_onFileFailed, "f"));
+    __classPrivateFieldGet(this, _ChunkDownloader_chunkDownloadClient, "f").removeEventListener(`progress`, __classPrivateFieldGet(this, _ChunkDownloader_onProgress, "f"));
+}, _ChunkDownloader_canRetry = function _ChunkDownloader_canRetry(error, writeErrors, networkErrors) {
+    if (__classPrivateFieldGet(this, _ChunkDownloader_downloadState, "f").status === TransferStatus.Aborting)
+        return false;
+    if (__classPrivateFieldGet(this, _ChunkDownloader_file, "f").isFailed)
+        return false;
+    if (error && error instanceof RequestError)
+        return __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverAttemptLimit <= 0 || networkErrors < __classPrivateFieldGet(this, _ChunkDownloader_options, "f").fileserverAttemptLimit;
+    return __classPrivateFieldGet(this, _ChunkDownloader_options, "f").maxWriteAttempts < 0 || writeErrors < __classPrivateFieldGet(this, _ChunkDownloader_options, "f").maxWriteAttempts;
+};
+export default ChunkDownloader;
+//# sourceMappingURL=chunkDownloader.js.map

package/dist/src/downloader/chunkDownloader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunkDownloader.js","sourceRoot":"","sources":["../../../src/downloader/chunkDownloader.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAqC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,KAAK,CAAC;AAEnC,OAAO,cAAc,MAAM,kCAAkC,CAAC;AAK9D,OAAO,aAAa,MAAM,yBAAyB,CAAC;AAIpD,OAAO,aAAa,MAAM,yBAAyB,CAAC;AAIpD,OAAO,KAAK,MAAM,mBAAmB,CAAC;AAEtC,MAAqB,eAAe;IAahC,YACI,UAAkB,EAClB,IAAsB,EACtB,KAA4B,EAC5B,aAA4B,EAC5B,OAAwB,EACxB,uBAAgD,EAChD,0BAAsD,EACtD,YAA0B;;QApB9B,8CAAoB;QACpB,yCAA8B;QAC9B,wCAAwB;QACxB,iDAA8B;QAC9B,2CAA0B;QAC1B,2DAAkD;QAClD,8DAAwD;QACxD,gDAA4B;QAC5B,uDAA+C;QAC/C,4CAAoB,CAAC,EAAC;QACtB,mCAAW,KAAK,EAAC;QA6KjB,4CAAoB,GAAG,EAAE;YACrB,uBAAA,IAAI,4CAAqB,EAAE,OAAO,EAAE,CAAC;QACzC,CAAC,EAAC;QAEF,wCAAgB,CAAC,IAAiC,EAAE,EAAE;YAClD,IAAI,uBAAA,IAAI,6BAAM,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtC,uBAAA,IAAI,4CAAqB,EAAE,OAAO,EAAE,CAAC;QAC7C,CAAC,EAAC;QAEF,sCAAc,CAAC,IAAwB,EAAE,EAAE;YACvC,uBAAA,IAAI,qCAAqB,IAAI,CAAC,qBAAqB,MAAA,CAAC;YACpD,uBAAA,IAAI,sCAAe,CAAC,uBAAuB,CAAC,uBAAA,IAAI,6BAAM,EAAE,uBAAA,IAAI,8BAAO,EAAE,IAAI,CAAC,CAAC;QAC/E,CAAC,EAAC;QA7KE,uBAAA,IAAI,+BAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,4BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,yBAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,0BAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,kCAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,4CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,+CAA+B,0BAA0B,MAAA,CAAC;QAC9D,uBAAA,IAAI,iCAAiB,YAAY,MAAA,CAAC;QAClC,uBAAA,IAAI,wCAAwB,uBAAA,IAAI,gDAAyB,CAAC,8BAA8B,CAAC,uBAAA,IAAI,6BAAM,CAAC,GAAG,EAAE,uBAAA,IAAI,8BAAO,CAAC,KAAK,EAAE,uBAAA,IAAI,8BAAO,CAAC,GAAG,EAAE,uBAAA,IAAI,mCAAY,EAAE,uBAAA,IAAI,6BAAM,CAAC,IAAI,EAAE,uBAAA,IAAI,gCAAS,CAAC,MAAA,CAAC;IACnM,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,uBAAA,IAAI,mEAAgB,MAApB,IAAI,CAAkB,CAAC;QAEvB,uBAAA,IAAI,4BAAY,IAAI,MAAA,CAAC;QAErB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,IAAI,SAAS,GAAiB,IAAI,CAAC;QACnC,IAAI,cAAc,GAAiB,IAAI,CAAC;QAExC,IAAI;YACA,uBAAA,IAAI,sCAAe,CAAC,oBAAoB,CAAC,uBAAA,IAAI,6BAAM,EAAE,uBAAA,IAAI,8BAAO,CAAC,CAAC;YAElE,uBAAA,IAAI,sEAAmB,MAAvB,IAAI,CAAqB,CAAC;YAE1B,MAAM,oBAAoB,GAA2B,uBAAA,IAAI,gCAAS,CAAC,cAAc;gBAC7E,CAAC,CAAC,uBAAA,IAAI,4CAAqB,CAAC,cAAc,EAAE;gBAC5C,CAAC,CAAC,IAAI,CAAC;YAEX,OAAO,gBAAgB,KAAK,KAAK,IAAI,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,SAAkB,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE;gBACjG,QAAQ,IAAI,CAAC,CAAC;gBAEd,uBAAA,IAAI,qCAAqB,CAAC,MAAA,CAAC;gBAE3B,MAAM,WAAW,GAAG,uBAAA,IAAI,mDAA4B,CAAC,OAAO,CAAC,uBAAA,IAAI,6BAAM,CAAC,YAAY,EAAE,uBAAA,IAAI,8BAAO,CAAC,KAAK,IAAI,CAAC,EAAE,uBAAA,IAAI,8BAAO,CAAC,SAAS,CAAC,CAAC;gBAErI,IAAI;oBACA,MAAM,uBAAA,IAAI,4CAAqB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;oBAEtD,IAAI,uBAAA,IAAI,yCAAkB,KAAK,uBAAA,IAAI,8BAAO,CAAC,SAAS,EAAE;wBAClD,IAAI,uBAAA,IAAI,yCAAkB,GAAG,uBAAA,IAAI,8BAAO,CAAC,SAAS;4BAC9C,uBAAA,IAAI,sCAAe,CAAC,sBAAsB,CAAC,uBAAA,IAAI,6BAAM,CAAC,CAAC;wBAE3D,MAAM,IAAI,aAAa,CAAC,gEAAgE,uBAAA,IAAI,8BAAO,CAAC,SAAS,aAAa,uBAAA,IAAI,yCAAkB,EAAE,CAAC,CAAC;qBACvJ;oBAED,aAAa,GAAG,CAAC,CAAC;oBAClB,uBAAA,IAAI,sCAAe,CAAC,SAAS,EAAE,CAAC;oBAEhC,IAAI,uBAAA,IAAI,sCAAe,CAAC,MAAM,KAAK,cAAc,CAAC,QAAQ,EAAE;wBACxD,IAAI,oBAAoB,KAAK,IAAI,EAAE;4BAC/B,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC;4BAC7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;4BACzD,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE;gCAClD,gBAAgB,GAAG,IAAI,CAAC;iCACvB;gCACD,WAAW,IAAI,CAAC,CAAC;gCACjB,SAAS,GAAG,IAAI,aAAa,CAAC,sCAAsC,SAAS,UAAU,QAAQ,EAAE,CAAC,CAAC;6BACtG;yBACJ;;4BAEG,gBAAgB,GAAG,IAAI,CAAC;qBAC/B;iBACJ;gBACD,OAAO,KAAK,EAAE;oBACV,SAAS,GAAG,KAAc,CAAC;oBAC3B,IAAI,SAAS,YAAY,YAAY,EAAE;wBACnC,aAAa,IAAI,CAAC,CAAC;wBACnB,uBAAA,IAAI,sCAAe,CAAC,cAAc,EAAE,CAAC;qBACxC;;wBAEG,WAAW,IAAI,CAAC,CAAC;iBACxB;wBACO;oBACJ,WAAW,EAAE,OAAO,EAAE,CAAC;oBACvB,uBAAA,IAAI,4CAAqB,EAAE,OAAO,EAAE,CAAC;oBAErC,IAAI,SAAS,GAAG,CAAC,CAAC;oBAClB,IAAI,uBAAA,IAAI,sCAAe,CAAC,qBAAqB;wBACzC,SAAS,GAAG,uBAAA,IAAI,gCAAS,CAAC,oCAAoC,CAAC;yBAC9D,IAAI,aAAa,GAAG,CAAC,EAAE;wBACxB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,uBAAA,IAAI,gCAAS,CAAC,yCAAyC,CAAC,CAAC;wBAC7F,SAAS,GAAG,uBAAA,IAAI,gCAAS,CAAC,oCAAoC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,uBAAA,IAAI,gCAAS,CAAC,yCAAyC,CAAC,CAAC,CAAC;qBAC3I;oBAED,IAAI,SAAS,GAAG,CAAC;wBACb,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;iBAC9B;aACJ;SACJ;QACD,OAAO,KAAK,EAAE;YACV,cAAc,GAAG,KAAc,CAAC;SACnC;gBACO;YACJ,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,CAAwB,CAAC;SAChC;QAED,IAAI,aAAa,GAAyB,IAAI,CAAC;QAE/C,IAAI,cAAc;YACd,aAAa,GAAG,IAAI,aAAa,CAAC,2CAA2C,uBAAA,IAAI,6BAAM,CAAC,GAAG,UAAU,uBAAA,IAAI,8BAAO,CAAC,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,cAAuB,EAAE,CAAC,CAAC;aACnK,IAAI,uBAAA,IAAI,sCAAe,CAAC,MAAM,KAAK,cAAc,CAAC,QAAQ;YAC3D,aAAa,GAAG,IAAI,aAAa,CAAC,mCAAmC,uBAAA,IAAI,6BAAM,CAAC,GAAG,UAAU,uBAAA,IAAI,8BAAO,CAAC,WAAW,YAAY,QAAQ,GAAG,CAAC,CAAC;aAC5I,IAAI,CAAC,gBAAgB,EAAE;YACxB,aAAa,GAAG,IAAI,aAAa,CAAC,kCAAkC,uBAAA,IAAI,6BAAM,CAAC,GAAG,UAAU,uBAAA,IAAI,8BAAO,CAAC,WAAW,YAAY,QAAQ,GAAG,CAAC,CAAC;YAC5I,IAAI,SAAS,EAAE;gBACX,aAAa,CAAC,OAAO,IAAI,oCAAoC,CAAC;gBAC9D,aAAa,CAAC,KAAK,GAAG,SAAkB,CAAC;aAC5C;SACJ;QAED,IAAI,aAAa,EAAE;YACf,IAAI,uBAAA,IAAI,sCAAe,CAAC,MAAM,KAAK,cAAc,CAAC,QAAQ,EAAE;gBACxD,qHAAqH;gBACrH,gDAAgD;gBAChD,uBAAA,IAAI,sCAAe,CAAC,mBAAmB,CACnC,uBAAA,IAAI,6BAAM,EACV,uBAAA,IAAI,8BAAO,EACX,aAAa,CAChB,CAAC;aACL;SACJ;;YAEG,uBAAA,IAAI,sCAAe,CAAC,sBAAsB,CAAC,uBAAA,IAAI,6BAAM,EAAE,uBAAA,IAAI,8BAAO,CAAC,CAAC;QAExE,uBAAA,IAAI,4BAAY,KAAK,MAAA,CAAC;IAC1B,CAAC;CA6CJ;;IA1CO,IAAI,uBAAA,IAAI,gCAAS;QACb,MAAM,IAAI,aAAa,CAAC,gFAAgF,CAAC,CAAC;AAClH,CAAC;IAGG,uBAAA,IAAI,qCAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,QAAQ,EAAE,uBAAA,IAAI,yCAAkB,CAAC,CAAC;IACpF,uBAAA,IAAI,qCAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,kBAAkB,EAAE,uBAAA,IAAI,qCAAc,CAAC,CAAC;IAC1F,uBAAA,IAAI,4CAAqB,CAAC,gBAAgB,CAAC,UAAU,EAAE,uBAAA,IAAI,mCAAY,CAAC,CAAC;AAC7E,CAAC;IAGG,uBAAA,IAAI,qCAAc,CAAC,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,uBAAA,IAAI,yCAAkB,CAAC,CAAC;IACvF,uBAAA,IAAI,qCAAc,CAAC,mBAAmB,CAAC,aAAa,CAAC,kBAAkB,EAAE,uBAAA,IAAI,qCAAc,CAAC,CAAC;IAC7F,uBAAA,IAAI,4CAAqB,CAAC,mBAAmB,CAAC,UAAU,EAAE,uBAAA,IAAI,mCAAY,CAAC,CAAC;AAChF,CAAC,iEAES,KAAmB,EAAE,WAAmB,EAAE,aAAqB;IACrE,IAAI,uBAAA,IAAI,sCAAe,CAAC,MAAM,KAAK,cAAc,CAAC,QAAQ;QACtD,OAAO,KAAK,CAAC;IAEjB,IAAI,uBAAA,IAAI,6BAAM,CAAC,QAAQ;QACnB,OAAO,KAAK,CAAC;IAEjB,IAAI,KAAK,IAAI,KAAK,YAAY,YAAY;QACtC,OAAO,uBAAA,IAAI,gCAAS,CAAC,sBAAsB,IAAI,CAAC,IAAI,aAAa,GAAG,uBAAA,IAAI,gCAAS,CAAC,sBAAuB,CAAC;IAE9G,OAAO,uBAAA,IAAI,gCAAS,CAAC,gBAAiB,GAAG,CAAC,IAAI,WAAW,GAAG,uBAAA,IAAI,gCAAS,CAAC,gBAAiB,CAAC;AAChG,CAAC;eAtLgB,eAAe"}

package/dist/src/downloader/downloadFolderResolver.d.ts

@@ -0,0 +1,6 @@
+import type GetCompanyResponse from "../utils/api/dtos/getCompanyResponse";
+import type GetTransferResponse from "../utils/api/dtos/getTransferResponse";
+export default class DownloadFolderResolver {
+    #private;
+    static prepareDownloadFolder(template: string, transfer: GetTransferResponse, company?: GetCompanyResponse): string;
+}

package/dist/src/downloader/downloadFolderResolver.js

@@ -0,0 +1,72 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _DownloadFolderResolver_pathFriendlyDate, _DownloadFolderResolver_sanitizePathElement, _DownloadFolderResolver_getDomain;
+import SimpleDateFormatter from "../utils/dateAndTime/simpleDateFormatter.js";
+class DownloadFolderResolver {
+    static prepareDownloadFolder(template, transfer, company) {
+        let result = template;
+        if (transfer.from) {
+            const domain = __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_getDomain).call(DownloadFolderResolver, transfer.from);
+            result = result
+                .replaceAll(`<domain>`, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, domain))
+                .replaceAll(`<emailfrom>`, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, transfer.from));
+        }
+        result = result.replaceAll(`<id>`, transfer.id);
+        const rx = /<datesent(:(.*?))?>/ig;
+        result = result.replace(rx, (_0, _1, dateFormatString) => {
+            let dateFormatted = ``;
+            if (dateFormatString)
+                dateFormatted = SimpleDateFormatter.formatDateAndTimeLocal(transfer.sentdate, dateFormatString);
+            else
+                dateFormatted = SimpleDateFormatter.defaultFormat(transfer.sentdate);
+            return __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_pathFriendlyDate).call(DownloadFolderResolver, dateFormatted));
+        });
+        if (transfer.message)
+            result = result.replaceAll(`<description>`, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, transfer.message).substring(0, 30));
+        if (transfer.subject)
+            result = result.replaceAll(`<subject>`, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, transfer.subject).substring(0, 30));
+        if (transfer.to && transfer.to.length)
+            result = result.replaceAll(`<emailto>`, __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, transfer.to.join(`,`)));
+        if (transfer.customfields && transfer.customfields.length) {
+            for (const cf of transfer.customfields) {
+                if (cf.label && cf.value)
+                    result = result.replace(new RegExp(`<${cf.label}>`, `ig`), __classPrivateFieldGet(DownloadFolderResolver, _a, "m", _DownloadFolderResolver_sanitizePathElement).call(DownloadFolderResolver, cf.value));
+            }
+        }
+        // remaining custom fields which have not bee replaced from transfer - remove them
+        if (company && company.customfields && company.customfields.length) {
+            for (const cf of company.customfields)
+                result = result.replace(new RegExp(`<${cf.label}>`, `ig`), ``);
+        }
+        return result;
+    }
+}
+_a = DownloadFolderResolver, _DownloadFolderResolver_pathFriendlyDate = function _DownloadFolderResolver_pathFriendlyDate(date) {
+    return date
+        .replace(/(\s+|:+|,+|Z+|T+)/g, `-`)
+        .replace(/-+/g, `-`);
+}, _DownloadFolderResolver_sanitizePathElement = function _DownloadFolderResolver_sanitizePathElement(value) {
+    if (!value)
+        return ``;
+    return value
+        ?.replaceAll(`..\\`, ``)
+        .replaceAll(`../`, ``)
+        .replaceAll(`..`, ``)
+        .replaceAll(`:`, ``)
+        .replaceAll(`<`, ``)
+        .replaceAll(`>`, ``)
+        .replaceAll(`\\`, ``)
+        .replaceAll(`/`, ``);
+}, _DownloadFolderResolver_getDomain = function _DownloadFolderResolver_getDomain(fromEmail) {
+    if (fromEmail) {
+        const idx = fromEmail.indexOf(`@`);
+        if (idx > -1)
+            return fromEmail.substring(idx + 1);
+    }
+    return ``;
+};
+export default DownloadFolderResolver;
+//# sourceMappingURL=downloadFolderResolver.js.map

package/dist/src/downloader/downloadFolderResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadFolderResolver.js","sourceRoot":"","sources":["../../../src/downloader/downloadFolderResolver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,mBAAmB,MAAM,6CAA6C,CAAC;AAI9E,MAAqB,sBAAsB;IA+BvC,MAAM,CAAC,qBAAqB,CAAC,QAAgB,EAAE,QAA6B,EAAE,OAA4B;QACtG,IAAI,MAAM,GAAG,QAAQ,CAAC;QACtB,IAAI,QAAQ,CAAC,IAAI,EAAE;YACf,MAAM,MAAM,GAAG,uBAAA,sBAAsB,6CAAW,MAAjC,sBAAsB,EAAY,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChE,MAAM,GAAG,MAAM;iBACV,UAAU,CAAC,UAAU,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,MAAM,CAAC,CAAC;iBAC3E,UAAU,CAAC,aAAa,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9F;QACD,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEhD,MAAM,EAAE,GAAG,uBAAuB,CAAC;QACnC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,EAAO,EAAE,EAAO,EAAE,gBAAwB,EAAU,EAAE;YAC/E,IAAI,aAAa,GAAG,EAAE,CAAC;YACvB,IAAI,gBAAgB;gBAChB,aAAa,GAAG,mBAAmB,CAAC,sBAAsB,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;;gBAEhG,aAAa,GAAG,mBAAmB,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAEzE,OAAO,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,uBAAA,sBAAsB,oDAAkB,MAAxC,sBAAsB,EAAmB,aAAa,CAAC,CAAC,CAAC;QAChH,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,OAAO;YAChB,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAEhI,IAAI,QAAQ,CAAC,OAAO;YAChB,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAE5H,IAAI,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,EAAE,CAAC,MAAM;YACjC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAEhH,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE;YACvD,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,YAAY,EAAE;gBACpC,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK;oBACpB,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,GAAG,EAAE,IAAI,CAAC,EAAE,uBAAA,sBAAsB,uDAAqB,MAA3C,sBAAsB,EAAsB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;aACzH;SACJ;QACD,kFAAkF;QAClF,IAAI,OAAO,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE;YAChE,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,YAAY;gBACjC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;SACtE;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;0HA1E4B,IAAY;IACjC,OAAO,IAAI;SACN,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC;SAClC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC7B,CAAC,qGAE2B,KAAgC;IACxD,IAAI,CAAC,KAAK;QACN,OAAO,EAAE,CAAC;IAEd,OAAO,KAAK;QACR,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC;SACrB,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;SACpB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;SACpB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC,iFAEiB,SAAoC;IAClD,IAAI,SAAS,EAAE;QACX,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,GAAG,GAAG,CAAC,CAAC;YACR,OAAO,SAAS,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;KAC3C;IACD,OAAO,EAAE,CAAC;AACd,CAAC;eA7BgB,sBAAsB"}

package/dist/src/downloader/downloadOptions.d.ts

@@ -0,0 +1,147 @@
+declare class DownloadOptions {
+    /**
+     * logintoken of the current user - used to fetch company setup, register download
+     * @default null
+     */
+    logintoken: string | null;
+    /**
+     *  Path template where files should be downloaded. Provide this OR {@link downloadFolder}. Supports placeholders:
+     *  <id> - transferId
+     *  <subject>
+     *  <description>
+     *  <domain> - domain based on "from" email (e.g. user@example.com --> example.com)
+     *  <emailfrom>
+     *  <datesent> - will be formatted as "YYYY-MM-DD-hh-mm"
+     *  <datesent:format> - will be formatted according to "format"; supported placeholders in "format": YYYY, MM, DD, hh, mm
+     *  <emailto> - all recipients emails comma-separated
+     *  <{custom_field_label}> - specified custom field named by label will replaced with that custom field's value
+     * @default null
+     */
+    downloadFolderTemplate: string | null;
+    /**
+     * The path where files should be downloaded. No placeholders. Provide this OR {@link downloadFolderTemplate}.
+     * When {@link downloadFolderTemplate} is specified this value will be overwritten with the resolved (final) path.
+     * @default null
+     */
+    downloadFolder: string | null;
+    /**
+     * HTTP request timeout for web api (not Fileserver) in milliseconds.
+     * @default 30000
+     */
+    apiRequestTotalTimeoutInMs: number;
+    /**
+     *  How many times to attempt HTTP requests towards web API (not Fileserver) e.g. when getting a transfer from the API.
+     *  @see https://github.com/sindresorhus/got#documentation
+     *  @default 3
+     */
+    apiRetryLimit: number;
+    /**
+     *  Maximum number (N) of chunks that can be downloaded in parallel. As soon as any single chunk is complete then next available chunk is started (to keep parallel chunks always at N).
+     *  - If there is one huge file with X chunks (X>N) - first N chunks will be picked up.
+     *  - If there are 2 files, each with 3 chunks and N=4 - both files will be started (all 3 chunks of first file and only 1st chunk of the 2nd file).
+     * @default 8
+     */
+    parallelChunks: number;
+    /**
+     * How many times to try write downloaded bytes of a chunk and optionally verify its MD5. Set to -1 to keep trying forever.
+     * @default 20
+     */
+    maxWriteAttempts: number;
+    /**
+     * The user-agent header that will be used for all fileserver GetFile requests.
+     * @default null
+     */
+    userAgent: string | null;
+    /**
+     * Maximum size (S) of a chunk in bytes. When set to a number - downloader will split files into chunks of this size (size of last chunk) <= S. Set to null to download every file in one HTTPS request.
+     * @default 5000000 (5MB)
+     */
+    maxChunkSize: number | null;
+    /**
+     * When set to **true** downloader will verify MD5 after every chunk.
+     * @efault true
+     */
+    checkChunksMd5: boolean;
+    /**
+     * When set to **true** downloader will verify MD5 for every completed file (entire file). To use this feature provided the MD5 value in DownloadFileInfo passed to the downloader.
+     * @note NOT SUPPORTED (YET)
+     */
+    checkFileMd5: boolean;
+    /**
+     * How long should it take for HTTP library to throw error when no download data is pumped to response (milliseconds).
+     * @default 30000
+     */
+    fileserverDownloadIdleTimeMs: number;
+    /**
+     * How many times to attempt a single HTTP download request against Fileserver's GetFile. Set this options to 0 to keep trying forever.
+     * When set to 0 (retring forever) the downloader will report "network problem" after 10 failed attempts (via event and a status field).
+     * When connectivity is back it will be reported with an event as well.
+     * @default 0
+     */
+    fileserverAttemptLimit: number;
+    /**
+     * Downloader will assume there is a "network problem" after this many consecutive network errors without any successful progress.
+     * Set to -1 to disable this feature.
+     * @default 10;
+     */
+    fileserverOfflineAfterConsecutiveAttempts: number;
+    /**
+     * Once downloader sees a "network problem" it will retry every pending chunk with this interval (in milliseconds).
+     * This interval will be also used to calculate exponential backoff between first network error and getting into "network problem" state
+     * and also is the maximum interval of the exponential backoff.
+     * @default 5000;
+     */
+    fileserverOfflineCheckIntervalMillis: number;
+    /**
+     * When set to **true** the downloader will fail or skip (see {@link this.failFileWhenPreventingOverwrite}) a file when attempting to download to a location which already exists (no matter its size).
+     * When set to **false** downloader will just re-download the file and overwrite existing file on disk.
+     * @default false
+     */
+    preventOverwrites: boolean;
+    /**
+     * When set to **true** downloader will fail a file when attempting to download to location which already exists (no matter its size).
+     * When set to **false** downloader will skip the file and advance the total progress as if it downloaded that file.
+     * Applies only when {@link preventOverwrites} is set to **true**.
+     * @default false
+     */
+    failFileWhenPreventingOverwrite: boolean;
+    /**
+     * Number of milliseconds between progress events emitted by the downloader (throttling - they won't be emitted more often that this amount of time).
+     * @default 100
+     */
+    progressTickMillis: number;
+    /**
+     * If set to **true** ==> the downloader will delete those files which were being downloaded, but failed.
+     * @default true
+     */
+    deleteFailedFilesFromDisk: boolean;
+    /**
+     * When set to **true* ==> after user requests download abort - the downloader will delete all files which it tried to download, no matter their size and status.
+     * @default true
+     */
+    deleteAbortedDownloadsFromDisk: boolean;
+    /**
+     * When set to **true** ==> after download completes or is aborted - the downloader will delete the main download folder if it is empty (no files have been downloaded and there are no other files left over).
+     * @default true
+     */
+    deleteEmptyDownloadFoldersAfterDownload: boolean;
+    /**
+     * When set to **true** ==> after download completes with at least one successful file - the downloader will report the download to api.
+     * @default true
+     */
+    registerDownloadsToApi: boolean;
+    /**
+     * When this path is specified (not null) then downloader will track download progress of each file within this folder.
+     * Every download gets own subfolder (transferID_downloadID) with dumped options of the download (options.json) and files.json
+     * which tracks all pending files. It will not contain completed files or those that have not started yet. Tracking is performed with
+     * chunk-precision (not byte-precision). Worst case the download tracker may lose N chunks (N being the number of {@link parallelChunks}).
+     * @default null
+     */
+    downloadTrackingBaseFolder: string | null;
+    /**
+     * Minimum time interval (in milliseconds) between consecutive dumps of downloader state to disk.
+     * @default 5000
+     */
+    downloadTrackingIntervalMillis: number;
+}
+export default DownloadOptions;

package/dist/src/downloader/downloadOptions.js

@@ -0,0 +1,150 @@
+class DownloadOptions {
+    constructor() {
+        /**
+         * logintoken of the current user - used to fetch company setup, register download
+         * @default null
+         */
+        this.logintoken = null;
+        /**
+         *  Path template where files should be downloaded. Provide this OR {@link downloadFolder}. Supports placeholders:
+         *  <id> - transferId
+         *  <subject>
+         *  <description>
+         *  <domain> - domain based on "from" email (e.g. user@example.com --> example.com)
+         *  <emailfrom>
+         *  <datesent> - will be formatted as "YYYY-MM-DD-hh-mm"
+         *  <datesent:format> - will be formatted according to "format"; supported placeholders in "format": YYYY, MM, DD, hh, mm
+         *  <emailto> - all recipients emails comma-separated
+         *  <{custom_field_label}> - specified custom field named by label will replaced with that custom field's value
+         * @default null
+         */
+        this.downloadFolderTemplate = null;
+        /**
+         * The path where files should be downloaded. No placeholders. Provide this OR {@link downloadFolderTemplate}.
+         * When {@link downloadFolderTemplate} is specified this value will be overwritten with the resolved (final) path.
+         * @default null
+         */
+        this.downloadFolder = null;
+        /**
+         * HTTP request timeout for web api (not Fileserver) in milliseconds.
+         * @default 30000
+         */
+        this.apiRequestTotalTimeoutInMs = 30000;
+        /**
+         *  How many times to attempt HTTP requests towards web API (not Fileserver) e.g. when getting a transfer from the API.
+         *  @see https://github.com/sindresorhus/got#documentation
+         *  @default 3
+         */
+        this.apiRetryLimit = 3;
+        /**
+         *  Maximum number (N) of chunks that can be downloaded in parallel. As soon as any single chunk is complete then next available chunk is started (to keep parallel chunks always at N).
+         *  - If there is one huge file with X chunks (X>N) - first N chunks will be picked up.
+         *  - If there are 2 files, each with 3 chunks and N=4 - both files will be started (all 3 chunks of first file and only 1st chunk of the 2nd file).
+         * @default 8
+         */
+        this.parallelChunks = 8;
+        /**
+         * How many times to try write downloaded bytes of a chunk and optionally verify its MD5. Set to -1 to keep trying forever.
+         * @default 20
+         */
+        this.maxWriteAttempts = 20;
+        /**
+         * The user-agent header that will be used for all fileserver GetFile requests.
+         * @default null
+         */
+        this.userAgent = null;
+        /**
+         * Maximum size (S) of a chunk in bytes. When set to a number - downloader will split files into chunks of this size (size of last chunk) <= S. Set to null to download every file in one HTTPS request.
+         * @default 5000000 (5MB)
+         */
+        this.maxChunkSize = 5000000;
+        /**
+         * When set to **true** downloader will verify MD5 after every chunk.
+         * @efault true
+         */
+        this.checkChunksMd5 = true;
+        /**
+         * When set to **true** downloader will verify MD5 for every completed file (entire file). To use this feature provided the MD5 value in DownloadFileInfo passed to the downloader.
+         * @note NOT SUPPORTED (YET)
+         */
+        this.checkFileMd5 = false;
+        /**
+         * How long should it take for HTTP library to throw error when no download data is pumped to response (milliseconds).
+         * @default 30000
+         */
+        this.fileserverDownloadIdleTimeMs = 30000;
+        /**
+         * How many times to attempt a single HTTP download request against Fileserver's GetFile. Set this options to 0 to keep trying forever.
+         * When set to 0 (retring forever) the downloader will report "network problem" after 10 failed attempts (via event and a status field).
+         * When connectivity is back it will be reported with an event as well.
+         * @default 0
+         */
+        this.fileserverAttemptLimit = 0;
+        /**
+         * Downloader will assume there is a "network problem" after this many consecutive network errors without any successful progress.
+         * Set to -1 to disable this feature.
+         * @default 10;
+         */
+        this.fileserverOfflineAfterConsecutiveAttempts = 10;
+        /**
+         * Once downloader sees a "network problem" it will retry every pending chunk with this interval (in milliseconds).
+         * This interval will be also used to calculate exponential backoff between first network error and getting into "network problem" state
+         * and also is the maximum interval of the exponential backoff.
+         * @default 5000;
+         */
+        this.fileserverOfflineCheckIntervalMillis = 5000;
+        /**
+         * When set to **true** the downloader will fail or skip (see {@link this.failFileWhenPreventingOverwrite}) a file when attempting to download to a location which already exists (no matter its size).
+         * When set to **false** downloader will just re-download the file and overwrite existing file on disk.
+         * @default false
+         */
+        this.preventOverwrites = false;
+        /**
+         * When set to **true** downloader will fail a file when attempting to download to location which already exists (no matter its size).
+         * When set to **false** downloader will skip the file and advance the total progress as if it downloaded that file.
+         * Applies only when {@link preventOverwrites} is set to **true**.
+         * @default false
+         */
+        this.failFileWhenPreventingOverwrite = false;
+        /**
+         * Number of milliseconds between progress events emitted by the downloader (throttling - they won't be emitted more often that this amount of time).
+         * @default 100
+         */
+        this.progressTickMillis = 100;
+        /**
+         * If set to **true** ==> the downloader will delete those files which were being downloaded, but failed.
+         * @default true
+         */
+        this.deleteFailedFilesFromDisk = true;
+        /**
+         * When set to **true* ==> after user requests download abort - the downloader will delete all files which it tried to download, no matter their size and status.
+         * @default true
+         */
+        this.deleteAbortedDownloadsFromDisk = true;
+        /**
+         * When set to **true** ==> after download completes or is aborted - the downloader will delete the main download folder if it is empty (no files have been downloaded and there are no other files left over).
+         * @default true
+         */
+        this.deleteEmptyDownloadFoldersAfterDownload = true;
+        /**
+         * When set to **true** ==> after download completes with at least one successful file - the downloader will report the download to api.
+         * @default true
+         */
+        this.registerDownloadsToApi = true;
+        /**
+         * When this path is specified (not null) then downloader will track download progress of each file within this folder.
+         * Every download gets own subfolder (transferID_downloadID) with dumped options of the download (options.json) and files.json
+         * which tracks all pending files. It will not contain completed files or those that have not started yet. Tracking is performed with
+         * chunk-precision (not byte-precision). Worst case the download tracker may lose N chunks (N being the number of {@link parallelChunks}).
+         * @default null
+         */
+        this.downloadTrackingBaseFolder = null;
+        /**
+         * Minimum time interval (in milliseconds) between consecutive dumps of downloader state to disk.
+         * @default 5000
+         */
+        this.downloadTrackingIntervalMillis = 5000;
+    }
+}
+export default DownloadOptions;
+//# sourceMappingURL=downloadOptions.js.map

package/dist/src/downloader/downloadOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadOptions.js","sourceRoot":"","sources":["../../../src/downloader/downloadOptions.ts"],"names":[],"mappings":"AAAA,MAAM,eAAe;IAArB;QACI;;;WAGG;QACH,eAAU,GAAkB,IAAI,CAAC;QACjC;;;;;;;;;;;;WAYG;QACH,2BAAsB,GAAkB,IAAI,CAAC;QAC7C;;;;WAIG;QACH,mBAAc,GAAkB,IAAI,CAAC;QACrC;;;WAGG;QACH,+BAA0B,GAAG,KAAK,CAAC;QACnC;;;;WAIG;QACH,kBAAa,GAAG,CAAC,CAAC;QAClB;;;;;WAKG;QACH,mBAAc,GAAG,CAAC,CAAC;QACnB;;;WAGG;QACH,qBAAgB,GAAG,EAAE,CAAC;QACtB;;;WAGG;QACH,cAAS,GAAkB,IAAI,CAAC;QAChC;;;WAGG;QACH,iBAAY,GAAkB,OAAO,CAAC;QACtC;;;WAGG;QACH,mBAAc,GAAG,IAAI,CAAC;QACtB;;;WAGG;QACH,iBAAY,GAAG,KAAK,CAAC;QACrB;;;WAGG;QACH,iCAA4B,GAAG,KAAK,CAAC;QACrC;;;;;WAKG;QACH,2BAAsB,GAAG,CAAC,CAAC;QAC3B;;;;WAIG;QACH,8CAAyC,GAAG,EAAE,CAAC;QAC/C;;;;;WAKG;QACH,yCAAoC,GAAG,IAAI,CAAC;QAC5C;;;;WAIG;QACH,sBAAiB,GAAG,KAAK,CAAC;QAC1B;;;;;WAKG;QACH,oCAA+B,GAAG,KAAK,CAAC;QACxC;;;WAGG;QACH,uBAAkB,GAAG,GAAG,CAAC;QACzB;;;WAGG;QACH,8BAAyB,GAAG,IAAI,CAAC;QACjC;;;WAGG;QACH,mCAA8B,GAAG,IAAI,CAAC;QACtC;;;WAGG;QACH,4CAAuC,GAAG,IAAI,CAAC;QAC/C;;;WAGG;QACH,2BAAsB,GAAG,IAAI,CAAC;QAC9B;;;;;;WAMG;QACH,+BAA0B,GAAkB,IAAI,CAAC;QACjD;;;WAGG;QACH,mCAA8B,GAAG,IAAI,CAAC;IAC1C,CAAC;CAAA;AAED,eAAe,eAAe,CAAC"}

package/dist/src/downloader/downloadStatus/downloadFileChunkProgress.d.ts

@@ -0,0 +1,12 @@
+export default class DownloadFileChunkProgress {
+    id: string;
+    chunkNumber: number;
+    start: number | null;
+    end: number | null;
+    size: number;
+    downloaded: number;
+    percent: number;
+    completed: boolean;
+    failed: boolean;
+    constructor(id: string, chunkNumber: number, start: number | null, end: number | null, size: number, downloaded: number, percent: number, completed: boolean, failed: boolean);
+}

package/dist/src/downloader/downloadStatus/downloadFileChunkProgress.js

@@ -0,0 +1,14 @@
+export default class DownloadFileChunkProgress {
+    constructor(id, chunkNumber, start, end, size, downloaded, percent, completed, failed) {
+        this.id = id;
+        this.chunkNumber = chunkNumber;
+        this.start = start;
+        this.end = end;
+        this.size = size;
+        this.downloaded = downloaded;
+        this.percent = percent;
+        this.completed = completed;
+        this.failed = failed;
+    }
+}
+//# sourceMappingURL=downloadFileChunkProgress.js.map

package/dist/src/downloader/downloadStatus/downloadFileChunkProgress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadFileChunkProgress.js","sourceRoot":"","sources":["../../../../src/downloader/downloadStatus/downloadFileChunkProgress.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,yBAAyB;IAW1C,YAAY,EAAU,EAAE,WAAmB,EAAE,KAAoB,EAAE,GAAkB,EAAE,IAAY,EAAE,UAAkB,EAAE,OAAe,EAAE,SAAkB,EAAE,MAAe;QACzK,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ"}

package/dist/src/downloader/downloadStatus/downloadFileProgress.d.ts

@@ -0,0 +1,16 @@
+import type DownloadError from "../dtos/downloadError";
+export default class DownloadFileProgress {
+    id: string;
+    name: string;
+    url: string;
+    downloadPath: string;
+    percent: number;
+    downloaded: number;
+    size: number;
+    completed: boolean;
+    failed: boolean;
+    failures: Array<DownloadError>;
+    chunks: number;
+    lastOkChunk: number | null;
+    constructor(externalId: string, name: string, url: string, downloadPath: string, size: number, downloaded: number, percent: number, completed: boolean, failed: boolean, failures: Array<DownloadError> | null, numberOfChunks: number, lastSuccessfulChunk: number | null);
+}