@ibm-aspera/sdk 0.19.0 → 0.20.0

package/dist/commonjs/helpers/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJsonParse = exports.safeJsonString = exports.getInstallerUrls = exports.isSafari = exports.isValidURL = exports.throwError = exports.randomUUID = exports.getCurrentPlatform = exports.getWebsocketUrl = exports.isValidTransferSpec = exports.generateErrorBody = exports.errorLog = exports.generatePromiseObjects = void 0;
+exports.withTimeout = exports.safeJsonParse = exports.safeJsonString = exports.getInstallerUrls = exports.isSafari = exports.isValidURL = exports.throwError = exports.randomUUID = exports.getCurrentPlatform = exports.getWebsocketUrl = exports.isValidTransferSpec = exports.generateErrorBody = exports.errorLog = exports.generatePromiseObjects = void 0;
 var constants_1 = require("../constants/constants");
 /**
  * Generates promise object that can be resolved or rejected via functions
@@ -232,6 +232,23 @@ var safeJsonParse = function (json) {
     }
 };
 exports.safeJsonParse = safeJsonParse;
+/**
+ * Race a promise against a timeout. Rejects with an Error('timeout') if the
+ * given milliseconds elapse before the promise settles.
+ */
+var withTimeout = function (promise, ms) {
+    return new Promise(function (resolve, reject) {
+        var timer = setTimeout(function () { return reject(new Error('timeout')); }, ms);
+        promise.then(function (val) {
+            clearTimeout(timer);
+            resolve(val);
+        }, function (err) {
+            clearTimeout(timer);
+            reject(err);
+        });
+    });
+};
+exports.withTimeout = withTimeout;
 exports.default = {
     errorLog: exports.errorLog,
     generateErrorBody: exports.generateErrorBody,
@@ -246,4 +263,5 @@ exports.default = {
     getInstallerUrls: exports.getInstallerUrls,
     safeJsonString: exports.safeJsonString,
     safeJsonParse: exports.safeJsonParse,
+    withTimeout: exports.withTimeout,
 };

package/dist/commonjs/helpers/ws.d.ts

@@ -8,6 +8,12 @@ export declare class WebsocketService {
     private eventListener;
     /** Indicator if the websocket is already connected */
     private isConnected;
+    /** When true, the reconnect loop is suppressed */
+    private stopped;
+    /** When true, the connection/reconnect loop is already running */
+    private active;
+    /** ID of the pending reconnect timer (so it can be cancelled) */
+    private reconnectTimerId;
     /** Global promise object that resolves when init completes */
     private initPromise;
     /** Log call for not being ready */
@@ -52,7 +58,17 @@ export declare class WebsocketService {
      * @returns a promise that resolves when the websocket connection is established
      */
     init(): Promise<unknown>;
+    /**
+     * Stop the WebSocket connection and suppress the automatic reconnect loop.
+     * Used when falling back to a different transfer client (e.g. Connect).
+     */
+    disconnect(): void;
     private connect;
+    /**
+     * Detach event handlers from the current socket so it cannot fire
+     * stale CLOSED/RECONNECT events after being replaced.
+     */
+    private detachSocket;
     private reconnect;
     private getWebSocketConnection;
     private notifyEvent;

package/dist/commonjs/helpers/ws.js

@@ -11,6 +11,12 @@ var WebsocketService = /** @class */ (function () {
         this.sockets = new Map();
         /** Indicator if the websocket is already connected */
         this.isConnected = false;
+        /** When true, the reconnect loop is suppressed */
+        this.stopped = false;
+        /** When true, the connection/reconnect loop is already running */
+        this.active = false;
+        /** ID of the pending reconnect timer (so it can be cancelled) */
+        this.reconnectTimerId = null;
         /** Global promise object that resolves when init completes */
         this.initPromise = (0, helpers_1.generatePromiseObjects)();
         /**
@@ -104,11 +110,35 @@ var WebsocketService = /** @class */ (function () {
      * @returns a promise that resolves when the websocket connection is established
      */
     WebsocketService.prototype.init = function () {
-        this.connect();
+        this.stopped = false;
+        if (!this.active) {
+            this.active = true;
+            this.connect();
+        }
         return this.initPromise.promise;
     };
+    /**
+     * Stop the WebSocket connection and suppress the automatic reconnect loop.
+     * Used when falling back to a different transfer client (e.g. Connect).
+     */
+    WebsocketService.prototype.disconnect = function () {
+        this.stopped = true;
+        this.active = false;
+        if (this.reconnectTimerId) {
+            clearTimeout(this.reconnectTimerId);
+            this.reconnectTimerId = null;
+        }
+        this.detachSocket();
+        if (this.globalSocket) {
+            this.globalSocket.close();
+            this.globalSocket = null;
+        }
+        this.isConnected = false;
+        this.initPromise = (0, helpers_1.generatePromiseObjects)();
+    };
     WebsocketService.prototype.connect = function () {
         var _this = this;
+        this.detachSocket();
         this.getWebSocketConnection(index_1.asperaSdk.globals.rpcPort)
             .then(function (webSocket) {
             _this.globalSocket = webSocket;
@@ -121,12 +151,29 @@ var WebsocketService = /** @class */ (function () {
             _this.reconnect();
         });
     };
+    /**
+     * Detach event handlers from the current socket so it cannot fire
+     * stale CLOSED/RECONNECT events after being replaced.
+     */
+    WebsocketService.prototype.detachSocket = function () {
+        if (this.globalSocket) {
+            this.globalSocket.onopen = null;
+            this.globalSocket.onclose = null;
+            this.globalSocket.onerror = null;
+            this.globalSocket.onmessage = null;
+        }
+    };
     WebsocketService.prototype.reconnect = function () {
         var _this = this;
+        if (this.stopped) {
+            return;
+        }
+        this.detachSocket();
         if (this.globalSocket) {
             this.globalSocket.close();
         }
-        setTimeout(function () {
+        this.reconnectTimerId = setTimeout(function () {
+            _this.reconnectTimerId = null;
             _this.connect();
         }, 1000);
     };

package/dist/commonjs/http-gateway/core.js

@@ -4,7 +4,7 @@ exports.httpGatewayReadChunkAsArrayBuffer = exports.httpGatewayReadAsArrayBuffer
 var messages_1 = require("../constants/messages");
 var helpers_1 = require("../helpers/helpers");
 var index_1 = require("../index");
-var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
+var v2_1 = require("./v2");
 // Maximum file size for generating image previews for files. 50MiB matches the limits in both Connect and IBM Aspera for desktop.
 var MAX_FILE_SIZE = 50 * 1024 * 1024;
 /**
@@ -45,17 +45,14 @@ var initHttpGateway = function (response) {
     index_1.asperaSdk.globals.httpGatewayRoutePrefix = majorVersion >= 3 ? '/v3' : '';
     if (index_1.asperaSdk.useOldHttpGateway) {
         // Watch for old HTTP Gateway transfers in case used.
-        (0, http_gateway_sdk_js_1.registerActivityCallback)(function (oldHttpTransfers) {
+        (0, v2_1.registerActivityCallback)(function (oldHttpTransfers) {
             oldHttpTransfers.transfers.forEach(function (oldHttpTransfer) {
                 var transfer = oldHttpTransfer;
-                // The HTTP Gateway v2 SDK uses "canceled" but we standardize on "cancelled"
-                if (transfer.status === 'canceled') {
-                    transfer.status = 'cancelled';
-                }
+                transfer.transfer_client = 'http-gateway';
                 (0, exports.sendTransferUpdate)(transfer);
             });
         });
-        return (0, http_gateway_sdk_js_1.initHttpGateway)(index_1.asperaSdk.globals.httpGatewayUrl).then(function () { });
+        return (0, v2_1.initHttpGateway)(index_1.asperaSdk.globals.httpGatewayUrl).then(function () { });
     }
     var iframeContainer = document.createElement('div');
     iframeContainer.id = 'aspera-http-gateway-iframes';
@@ -107,7 +104,7 @@ exports.setupHttpGateway = setupHttpGateway;
  */
 var httpStopTransfer = function (id) {
     if (index_1.asperaSdk.useOldHttpGateway) {
-        (0, http_gateway_sdk_js_1.cancelTransfer)(id);
+        (0, v2_1.cancelTransfer)(id);
         return Promise.resolve();
     }
     var transfer = index_1.asperaSdk.httpGatewayTransferStore.get(id);
@@ -135,7 +132,7 @@ exports.httpStopTransfer = httpStopTransfer;
  */
 var httpRemoveTransfer = function (id) {
     if (index_1.asperaSdk.useOldHttpGateway) {
-        (0, http_gateway_sdk_js_1.removeTransfer)(id);
+        (0, v2_1.removeTransfer)(id);
         return Promise.resolve({ removed: true });
     }
     /* Cancel the transfer before removing it.
@@ -159,7 +156,7 @@ exports.httpRemoveTransfer = httpRemoveTransfer;
  */
 var httpGetAllTransfers = function () {
     if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.getAllTransfers)().transfers;
+        return (0, v2_1.getAllTransfers)().transfers;
     }
     return Array.from(index_1.asperaSdk.httpGatewayTransferStore.values());
 };
@@ -171,7 +168,7 @@ exports.httpGetAllTransfers = httpGetAllTransfers;
  */
 var httpGetTransfer = function (id) {
     if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.getTransferById)(id);
+        return (0, v2_1.getTransferById)(id);
     }
     return index_1.asperaSdk.httpGatewayTransferStore.get(id);
 };
@@ -251,7 +248,7 @@ exports.handleHttpGatewayDrop = handleHttpGatewayDrop;
  */
 var httpGatewaySelectFileFolderDialog = function (options, folder) {
     if (index_1.asperaSdk.useOldHttpGateway) {
-        return (folder ? (0, http_gateway_sdk_js_1.getFoldersForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || '') : (0, http_gateway_sdk_js_1.getFilesForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || ''));
+        return (folder ? (0, v2_1.getFoldersForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || '') : (0, v2_1.getFilesForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || ''));
     }
     var _a = (0, helpers_1.generatePromiseObjects)(), promise = _a.promise, rejecter = _a.rejecter, resolver = _a.resolver;
     var element = (0, exports.createHtmlInputElement)();
@@ -315,6 +312,7 @@ var getSdkTransfer = function (transferSpec) {
         percentage: 0,
         title: '',
         remaining_usec: 0,
+        transfer_client: 'http-gateway',
         httpGatewayTransfer: true,
         httpDownloadExternalHandle: false,
     };

package/dist/commonjs/http-gateway/download.js

@@ -5,7 +5,7 @@ var index_1 = require("../index");
 var helpers_1 = require("../helpers/helpers");
 var messages_1 = require("../constants/messages");
 var core_1 = require("./core");
-var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
+var v2_1 = require("./v2");
 /**
  * HTTP Gateway Download Logic for presigned flow
  * Presigned flow is when used files are too large or unknown file size
@@ -173,7 +173,7 @@ var httpDownload = function (transferSpec, asperaSdkSpec) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified, { type: 'download' });
     }
     if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.download)(transferSpec);
+        return (0, v2_1.download)(transferSpec);
     }
     if (transferSpec.tags &&
         transferSpec.tags.aspera &&

package/dist/commonjs/http-gateway/upload.js

@@ -5,7 +5,7 @@ var index_1 = require("../index");
 var helpers_1 = require("../helpers/helpers");
 var messages_1 = require("../constants/messages");
 var core_1 = require("./core");
-var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
+var v2_1 = require("./v2");
 /**
  * HTTP Gateway Upload Logic
  *
@@ -23,7 +23,7 @@ var httpUpload = function (transferSpec, asperaSdkSpec) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified, { type: 'upload' });
     }
     if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.upload)(transferSpec, (asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_v2_transfer_id) || '');
+        return (0, v2_1.upload)(transferSpec, (asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_v2_transfer_id) || '');
     }
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
     var request = new XMLHttpRequest();

package/dist/commonjs/http-gateway/v2/app/core.d.ts

@@ -0,0 +1,84 @@
+import { TransferResponse } from '../models/http-gateway-global.model';
+import { HttpTransfer } from '../models/models';
+/**
+ * Check if HTTP Gateway server connection works. This function is called by init
+ * when initializing the SDK.  This function can be used at any point for sanity checking.
+ *
+ * @returns promise that resolves if server can connect or rejects if server unable to connect
+ */
+export declare const testHttpGatewayConnection: () => Promise<any>;
+export declare const cleanupServerUrl: (serverUrl: string) => string;
+/**
+ * Initialize HTTP gateway client. If client cannot (reject/catch)
+ * client should attempt fixing server URL or trying again. If still fails disable UI elements.
+ * If supportMultipleServers is used the failure of the first test will not lock out the SDK.
+ *
+ * @param serverUrl URL indicating location of the HTTP server
+ * @param softwareMode indicate if the SDK should run in software mode instead of DOM mode
+ * @param supportMultipleServers indicates if the SDK should support multiple servers (not restricting to setup server)
+ *
+ * @returns a promise that resolves if HTTP Gateway is running properly or rejects if unable to load
+ */
+export declare const initHttpGateway: (serverUrl: string, softwareMode?: boolean, supportMultipleServers?: boolean) => Promise<any>;
+/**
+ * Register a callback event for getting transfer data
+ *
+ * @param callback callback function to receive transfers
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+export declare const registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string;
+/**
+ * Remove a callback from the transfer callback
+ * @param id the ID returned by `registerActivityCallback`
+ */
+export declare const deregisterActivityCallback: (id: string) => void;
+/**
+ * Returns the transfer requested based on the uuid of the transfer.
+ * NOTE: transferId from Node is not accepted as an ID.  It must be the ID used by the HTTP Gateway.
+ *
+ * @param id gateway based ID of the HTTP part of the transfer
+ *
+ * @returns an object containing the transfer (or undefined if not found) located at key `transfer_info`
+ */
+export declare const getTransferById: (id: string) => {
+    transfer_info: HttpTransfer;
+};
+/**
+ * Get transfer response object including all transfers
+ *
+ * @returns transfer data object with transfers array
+ */
+export declare const getAllTransfers: () => TransferResponse;
+/**
+ * Remove all transfers that are not active
+ */
+export declare const clearNonActiveTransfers: () => void;
+/**
+ * Removes a transfer from the transfers list in HTTP Gateway
+ * If an active transfer is removed it will continue to be uploaded/downloaded but progress will not be tracked
+ *
+ * @param id HTTP Gateway transfer uuid
+ */
+export declare const removeTransfer: (id: string) => void;
+/**
+ * Cancel a transfer from the transfers list in HTTP Gateway
+ *
+ * @param id HTTP Gateway transfer uuid
+ */
+export declare const cancelTransfer: (id: string) => void;
+declare const _default: {
+    initHttpGateway: (serverUrl: string, softwareMode?: boolean, supportMultipleServers?: boolean) => Promise<any>;
+    testHttpGatewayConnection: () => Promise<any>;
+    registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string;
+    cleanupServerUrl: (serverUrl: string) => string;
+    deregisterActivityCallback: (id: string) => void;
+    getTransferById: (id: string) => {
+        transfer_info: HttpTransfer;
+    };
+    getAllTransfers: () => TransferResponse;
+    clearNonActiveTransfers: () => void;
+    removeTransfer: (id: string) => void;
+    cancelTransfer: (id: string) => void;
+};
+export default _default;

package/dist/commonjs/http-gateway/v2/app/core.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelTransfer = exports.removeTransfer = exports.clearNonActiveTransfers = exports.getAllTransfers = exports.getTransferById = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.initHttpGateway = exports.cleanupServerUrl = exports.testHttpGatewayConnection = void 0;
+var index_1 = require("../index");
+var helpers_1 = require("../helpers/helpers");
+var messages_1 = require("../constants/messages");
+var http_1 = require("../helpers/http");
+/**
+ * Check if HTTP Gateway server connection works. This function is called by init
+ * when initializing the SDK.  This function can be used at any point for sanity checking.
+ *
+ * @returns promise that resolves if server can connect or rejects if server unable to connect
+ */
+var testHttpGatewayConnection = function () {
+    if (!index_1.asperaHttpGateway.globals.serverUrl && !index_1.asperaHttpGateway.globals.supportMultipleServers) {
+        (0, helpers_1.errorLog)(messages_1.messages.serverUrlNotSet);
+        return new Promise(function (resolve, reject) {
+            reject((0, helpers_1.generateErrorBody)(messages_1.messages.serverUrlNotSet));
+        });
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var backupServerData = {
+        endpoints: [
+            '/aspera/http-gwy/v1/info',
+            '/aspera/http-gwy/v1/upload',
+            '/aspera/http-gwy/v2/upload',
+            '/aspera/http-gwy/v1/download'
+        ],
+        name: 'IBM Aspera HTTP Gateway',
+        version: '2.3.0',
+        sdkVerificationFailed: true,
+    };
+    (0, http_1.apiGet)("".concat(index_1.asperaHttpGateway.globals.serverUrl || '', "/v1/info")).then(function (response) {
+        response.json().then(function (data) {
+            index_1.asperaHttpGateway.globals.serverInfo = data;
+            index_1.asperaHttpGateway.globals.serverVerified = true;
+            if (Number(index_1.asperaHttpGateway.globals.serverInfo.version.split('.')[0] || 0) >= 3) {
+                promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.versionNotsupported, data));
+                return;
+            }
+            console.warn(messages_1.messages.deprecationWarning);
+            promiseInfo.resolver(data);
+        });
+    }).catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.serverError, error);
+        if (index_1.asperaHttpGateway.globals.supportMultipleServers) {
+            index_1.asperaHttpGateway.globals.serverInfo = backupServerData;
+            index_1.asperaHttpGateway.globals.serverVerified = true;
+            promiseInfo.resolver(backupServerData);
+        }
+        else {
+            index_1.asperaHttpGateway.globals.serverVerified = false;
+            promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.serverError, error));
+        }
+    });
+    return promiseInfo.promise;
+};
+exports.testHttpGatewayConnection = testHttpGatewayConnection;
+var cleanupServerUrl = function (serverUrl) {
+    if (typeof serverUrl !== 'string') {
+        return '';
+    }
+    if (serverUrl[serverUrl.length - 1] === '/') {
+        serverUrl = serverUrl.slice(0, -1);
+    }
+    return serverUrl.replace('/v1', '/').replace(/\/$/, '').replace(/\/$/, '');
+};
+exports.cleanupServerUrl = cleanupServerUrl;
+/**
+ * Initialize HTTP gateway client. If client cannot (reject/catch)
+ * client should attempt fixing server URL or trying again. If still fails disable UI elements.
+ * If supportMultipleServers is used the failure of the first test will not lock out the SDK.
+ *
+ * @param serverUrl URL indicating location of the HTTP server
+ * @param softwareMode indicate if the SDK should run in software mode instead of DOM mode
+ * @param supportMultipleServers indicates if the SDK should support multiple servers (not restricting to setup server)
+ *
+ * @returns a promise that resolves if HTTP Gateway is running properly or rejects if unable to load
+ */
+var initHttpGateway = function (serverUrl, softwareMode, supportMultipleServers) {
+    if (!(0, helpers_1.isValidUrl)(serverUrl)) {
+        return new Promise(function (resolve, reject) {
+            reject((0, helpers_1.generateErrorBody)(messages_1.messages.invalidServerUrl));
+        });
+    }
+    index_1.asperaHttpGateway.globals.setUpServer((0, exports.cleanupServerUrl)(serverUrl), softwareMode, supportMultipleServers);
+    return (0, exports.testHttpGatewayConnection)();
+};
+exports.initHttpGateway = initHttpGateway;
+/**
+ * Register a callback event for getting transfer data
+ *
+ * @param callback callback function to receive transfers
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+var registerActivityCallback = function (callback) {
+    return index_1.asperaHttpGateway.activityTracking.setCallback(callback);
+};
+exports.registerActivityCallback = registerActivityCallback;
+/**
+ * Remove a callback from the transfer callback
+ * @param id the ID returned by `registerActivityCallback`
+ */
+var deregisterActivityCallback = function (id) {
+    index_1.asperaHttpGateway.activityTracking.removeCallback(id);
+};
+exports.deregisterActivityCallback = deregisterActivityCallback;
+/**
+ * Returns the transfer requested based on the uuid of the transfer.
+ * NOTE: transferId from Node is not accepted as an ID.  It must be the ID used by the HTTP Gateway.
+ *
+ * @param id gateway based ID of the HTTP part of the transfer
+ *
+ * @returns an object containing the transfer (or undefined if not found) located at key `transfer_info`
+ */
+var getTransferById = function (id) {
+    return { transfer_info: index_1.asperaHttpGateway.activityTracking.getTransferById(id) };
+};
+exports.getTransferById = getTransferById;
+/**
+ * Get transfer response object including all transfers
+ *
+ * @returns transfer data object with transfers array
+ */
+var getAllTransfers = function () {
+    return index_1.asperaHttpGateway.activityTracking.getAllTransfersResponse();
+};
+exports.getAllTransfers = getAllTransfers;
+/**
+ * Remove all transfers that are not active
+ */
+var clearNonActiveTransfers = function () {
+    index_1.asperaHttpGateway.activityTracking.clearNonActiveTransfers();
+};
+exports.clearNonActiveTransfers = clearNonActiveTransfers;
+/**
+ * Removes a transfer from the transfers list in HTTP Gateway
+ * If an active transfer is removed it will continue to be uploaded/downloaded but progress will not be tracked
+ *
+ * @param id HTTP Gateway transfer uuid
+ */
+var removeTransfer = function (id) {
+    index_1.asperaHttpGateway.activityTracking.removeTransfer(id);
+};
+exports.removeTransfer = removeTransfer;
+/**
+ * Cancel a transfer from the transfers list in HTTP Gateway
+ *
+ * @param id HTTP Gateway transfer uuid
+ */
+var cancelTransfer = function (id) {
+    var transfer = index_1.asperaHttpGateway.activityTracking.getTransferById(id);
+    if (transfer) {
+        transfer.status = 'cancelled';
+    }
+};
+exports.cancelTransfer = cancelTransfer;
+exports.default = {
+    initHttpGateway: exports.initHttpGateway,
+    testHttpGatewayConnection: exports.testHttpGatewayConnection,
+    registerActivityCallback: exports.registerActivityCallback,
+    cleanupServerUrl: exports.cleanupServerUrl,
+    deregisterActivityCallback: exports.deregisterActivityCallback,
+    getTransferById: exports.getTransferById,
+    getAllTransfers: exports.getAllTransfers,
+    clearNonActiveTransfers: exports.clearNonActiveTransfers,
+    removeTransfer: exports.removeTransfer,
+    cancelTransfer: exports.cancelTransfer
+};

package/dist/commonjs/http-gateway/v2/app/download.d.ts

@@ -0,0 +1,15 @@
+import { DownloadOptions, TransferSpec } from '../models/models';
+/**
+ * Start a HTTP Gateway download. Progress is not provided on downloads, browser handles download directly
+ * When in software mode the promise will return transfer_spec_id and the URL. The URL has not been used
+ * therefore a client can open it and start the download using software specific methods (like file reader).
+ *
+ * @param transferSpec standard Connect transferSpec for downloading
+ *
+ * @returns a promise that resolves if download is started successfully or rejects if error occurs
+ */
+export declare const download: (transferSpec: TransferSpec, options?: DownloadOptions) => Promise<any>;
+declare const _default: {
+    download: (transferSpec: TransferSpec, options?: DownloadOptions) => Promise<any>;
+};
+export default _default;

package/dist/commonjs/http-gateway/v2/app/download.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = void 0;
+var http_1 = require("../helpers/http");
+var index_1 = require("../index");
+var helpers_1 = require("../helpers/helpers");
+var messages_1 = require("../constants/messages");
+var core_1 = require("./core");
+/**
+ * Start a HTTP Gateway download. Progress is not provided on downloads, browser handles download directly
+ * When in software mode the promise will return transfer_spec_id and the URL. The URL has not been used
+ * therefore a client can open it and start the download using software specific methods (like file reader).
+ *
+ * @param transferSpec standard Connect transferSpec for downloading
+ *
+ * @returns a promise that resolves if download is started successfully or rejects if error occurs
+ */
+var download = function (transferSpec, options) {
+    if (options === void 0) { options = {}; }
+    if (!index_1.asperaHttpGateway.isReady) {
+        (0, helpers_1.errorLog)(messages_1.messages.serverNotVerified);
+        return new Promise(function (resolve, reject) {
+            reject((0, helpers_1.generateErrorBody)(messages_1.messages.serverNotVerified));
+        });
+    }
+    if (!(0, helpers_1.isValidTransferSpec)(transferSpec)) {
+        (0, helpers_1.errorLog)(messages_1.messages.notValidTransferSpec);
+        return new Promise(function (resolve, reject) {
+            reject((0, helpers_1.generateErrorBody)(messages_1.messages.notValidTransferSpec, { transferSpec: transferSpec }));
+        });
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    if (typeof options.zipRequire === 'boolean') {
+        transferSpec.zip_required = options.zipRequire;
+    }
+    var payload = {
+        transfer_spec: transferSpec
+    };
+    var finalServerUrl = options.serverUrlOverride ? (0, core_1.cleanupServerUrl)(options.serverUrlOverride) : index_1.asperaHttpGateway.globals.serverUrl;
+    (0, http_1.apiPost)("".concat(finalServerUrl, "/v1/download"), payload).then(function (response) {
+        response.json().then(function (data) {
+            if (data.transfer_spec_id) {
+                var downloadUrl = "".concat(finalServerUrl, "/v1/download/").concat(data.transfer_spec_id);
+                if (index_1.asperaHttpGateway.globals.softwareMode || (options === null || options === void 0 ? void 0 : options.disableAutoDownload)) {
+                    promiseInfo.resolver({
+                        transfer_spec_id: data.transfer_spec_id,
+                        url: downloadUrl,
+                    });
+                    return;
+                }
+                index_1.asperaHttpGateway.globals.triggerDownloadFromUrl(downloadUrl);
+                promiseInfo.resolver();
+            }
+            else {
+                (0, helpers_1.errorLog)(messages_1.messages.failedToGetDownloadUrl, { response: data });
+                promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.failedToGetDownloadUrl, { response: data }));
+            }
+        });
+    }).catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.downloadFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.downloadFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.download = download;
+exports.default = {
+    download: exports.download
+};