@ibm-aspera/sdk 0.4.14 → 0.4.18

package/dist/commonjs/app/core.d.ts

@@ -43,7 +43,7 @@ export declare const init: (options?: InitOptions) => Promise<any>;
  *
  * @returns a promise that resolves if transfer initiation is successful and rejects if transfer cannot be started
  */
-export declare const startTransfer: (transferSpec: TransferSpec, asperaSdkSpec: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;
+export declare const startTransfer: (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;
 /**
  * Register a callback event for getting transfer updates
  *

package/dist/commonjs/app/core.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCapabilities = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = exports.getTransfer = exports.getAllTransfers = exports.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.resumeTransfer = exports.stopTransfer = exports.removeTransfer = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.startTransfer = exports.init = exports.initDragDrop = exports.testConnection = void 0;
 var messages_1 = require("../constants/messages");
@@ -7,7 +18,6 @@ var helpers_1 = require("../helpers/helpers");
 var http_gateway_1 = require("../http-gateway");
 var core_1 = require("../http-gateway/core");
 var index_1 = require("../index");
-var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
 var connect_sdk_js_1 = require("@ibm-aspera/connect-sdk-js");
 var core_2 = require("../connect/core");
 /**
@@ -17,6 +27,7 @@ var core_2 = require("../connect/core");
  * @returns a promise that resolves if server can connect or rejects if not
  */
 var testConnection = function () {
+    // FIXME: If force HTTP gateway is false this ends up preventing SDK from verifying IBM Aspera for desktop is running.
     if (index_1.asperaSdk.useHttpGateway || index_1.asperaSdk.useConnect) {
         return Promise.resolve(index_1.asperaSdk.globals.sdkResponseData);
     }
@@ -102,12 +113,6 @@ var init = function (options) {
     var _a, _b, _c;
     var appId = (_a = options === null || options === void 0 ? void 0 : options.appId) !== null && _a !== void 0 ? _a : (0, helpers_1.randomUUID)();
     index_1.asperaSdk.globals.appId = appId;
-    // Watch for old HTTP Gateway transfers in case used.
-    (0, http_gateway_sdk_js_1.registerActivityCallback)(function (oldHttpTransfers) {
-        oldHttpTransfers.transfers.forEach(function (oldHttpTransfer) {
-            (0, core_1.sendTransferUpdate)(oldHttpTransfer);
-        });
-    });
     // For now ignore multi user support in Safari
     if ((options === null || options === void 0 ? void 0 : options.supportMultipleUsers) && !(0, helpers_1.isSafari)()) {
         index_1.asperaSdk.globals.supportMultipleUsers = true;
@@ -160,25 +165,21 @@ var init = function (options) {
                 return responseData;
             });
         }).then(function (response) {
+            return (0, http_gateway_1.initHttpGateway)(response);
+        }).then(function () {
             var _a, _b;
-            index_1.asperaSdk.globals.httpGatewayInfo = response;
-            index_1.asperaSdk.globals.httpGatewayVerified = true;
-            var iframeContainer = document.createElement('div');
-            iframeContainer.id = 'aspera-http-gateway-iframes';
-            iframeContainer.style = 'display: none;';
-            document.body.appendChild(iframeContainer);
-            index_1.asperaSdk.globals.httpGatewayIframeContainer = iframeContainer;
             if ((_a = options === null || options === void 0 ? void 0 : options.httpGatewaySettings) === null || _a === void 0 ? void 0 : _a.forceGateway) {
                 return Promise.resolve(index_1.asperaSdk.globals.sdkResponseData);
             }
-            else {
-                return ((_b = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _b === void 0 ? void 0 : _b.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
-            }
+            return ((_b = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _b === void 0 ? void 0 : _b.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
         }).catch(function (error) {
-            var _a;
-            // If HTTP Gateway fails log and move on to desktop
+            var _a, _b;
+            // If HTTP Gateway fails log and move on to transfer client
             (0, helpers_1.errorLog)(messages_1.messages.httpInitFail, error);
-            return ((_a = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _a === void 0 ? void 0 : _a.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
+            if ((_a = options === null || options === void 0 ? void 0 : options.httpGatewaySettings) === null || _a === void 0 ? void 0 : _a.forceGateway) {
+                throw (0, helpers_1.generateErrorBody)(messages_1.messages.httpInitFail, error);
+            }
+            return ((_b = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _b === void 0 ? void 0 : _b.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
         });
     }
     return ((_c = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _c === void 0 ? void 0 : _c.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
@@ -200,6 +201,17 @@ var startTransfer = function (transferSpec, asperaSdkSpec) {
         return transferSpec.direction === 'receive' ? (0, http_gateway_1.httpDownload)(transferSpec, asperaSdkSpec) : (0, http_gateway_1.httpUpload)(transferSpec, asperaSdkSpec);
     }
     else if (index_1.asperaSdk.useConnect) {
+        /**
+         * There is a bug in the Connect transfer client where Connect's HTTP server will no longer return ANY responses if a dialog was opened
+         * when starting the transfer (ex: request or file overwrite confirmation).
+         */
+        if ((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.allow_dialogs) !== false) {
+            console.warn('[Aspera SDK] `allow_dialogs` was not set to `false` in AsperaSdkSpec and has been overridden. ' +
+                'Connect dialogs block all subsequent HTTP responses. ' +
+                'Set `allow_dialogs: false` explicitly to suppress this warning. ' +
+                'More info: https://github.com/IBM/aspera-sdk-js/issues/196');
+            asperaSdkSpec = __assign(__assign({}, asperaSdkSpec), { allow_dialogs: false });
+        }
         return index_1.asperaSdk.globals.connect.startTransferPromise(transferSpec, asperaSdkSpec).then(function (response) {
             return response.transfer_specs[0];
         });
@@ -210,7 +222,7 @@ var startTransfer = function (transferSpec, asperaSdkSpec) {
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
     var payload = {
         transfer_spec: transferSpec,
-        desktop_spec: asperaSdkSpec,
+        desktop_spec: asperaSdkSpec || {},
         app_id: index_1.asperaSdk.globals.appId,
     };
     client_1.client.request('start_transfer', payload)

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

@@ -1,4 +1,5 @@
 import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse } from '../models/models';
+import { HttpGatewayInfo } from './models';
 /**
  * HTTP Gateway Core Logic
  * - File/Folder picking
@@ -8,6 +9,22 @@ import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfe
  * Most logic is called directly by Desktop SDK functions
  * You may not need to import anything from this file.
  */
+/**
+ * Send a transfer update through the SDK
+ *
+ * @param transfer - Transsfer object to send to consumers
+ */
+export declare const sendTransferUpdate: (transfer: AsperaSdkTransfer) => void;
+/**
+ * Initialize the HTTP Gateway after the /info response has been received and verified.
+ * For v2 gateways, delegates to the old HTTP Gateway SDK.
+ * For v3 gateways, sets up the iframe container for downloads.
+ *
+ * @param response - The /info response from the HTTP Gateway server
+ *
+ * @returns a promise that resolves when the HTTP Gateway is initialized
+ */
+export declare const initHttpGateway: (response: HttpGatewayInfo) => Promise<void>;
 /**
  * Remove a transfer from HTTP Gateway systems
  * @param id - ID of the transfer
@@ -56,12 +73,6 @@ export declare const httpGatewaySelectFileFolderDialog: (options?: FileDialogOpt
  * @returns a transfer object to track status and send to consumers
  */
 export declare const getSdkTransfer: (transferSpec: TransferSpec) => AsperaSdkTransfer;
-/**
- * Send a transfer update through the SDK
- *
- * @param transfer - Transsfer object to send to consumers
- */
-export declare const sendTransferUpdate: (transfer: AsperaSdkTransfer) => void;
 /**
  * Try to parse and get a useful string from API calls for HTTP Gateway
  *

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

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpGatewayReadChunkAsArrayBuffer = exports.httpGatewayReadAsArrayBuffer = exports.base64Encoding = exports.getMessageFromError = exports.sendTransferUpdate = exports.getSdkTransfer = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.createHtmlInputElement = exports.httpGetTransfer = exports.httpGetAllTransfers = exports.httpRemoveTransfer = void 0;
+exports.httpGatewayReadChunkAsArrayBuffer = exports.httpGatewayReadAsArrayBuffer = exports.base64Encoding = exports.getMessageFromError = exports.getSdkTransfer = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.createHtmlInputElement = exports.httpGetTransfer = exports.httpGetAllTransfers = exports.httpRemoveTransfer = exports.initHttpGateway = exports.sendTransferUpdate = void 0;
 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");
-// 50MiB which matches the limits in Connect and IBM Aspera for desktop
+// 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;
 /**
  * HTTP Gateway Core Logic
@@ -16,6 +16,48 @@ var MAX_FILE_SIZE = 50 * 1024 * 1024;
  * Most logic is called directly by Desktop SDK functions
  * You may not need to import anything from this file.
  */
+/**
+ * Send a transfer update through the SDK
+ *
+ * @param transfer - Transsfer object to send to consumers
+ */
+var sendTransferUpdate = function (transfer) {
+    index_1.asperaSdk.httpGatewayTransferStore.set(transfer.uuid, transfer);
+    index_1.asperaSdk.activityTracking.handleTransferActivity({
+        type: 'transferUpdated',
+        data: { transfers: [transfer] },
+    });
+};
+exports.sendTransferUpdate = sendTransferUpdate;
+/**
+ * Initialize the HTTP Gateway after the /info response has been received and verified.
+ * For v2 gateways, delegates to the old HTTP Gateway SDK.
+ * For v3 gateways, sets up the iframe container for downloads.
+ *
+ * @param response - The /info response from the HTTP Gateway server
+ *
+ * @returns a promise that resolves when the HTTP Gateway is initialized
+ */
+var initHttpGateway = function (response) {
+    index_1.asperaSdk.globals.httpGatewayInfo = response;
+    index_1.asperaSdk.globals.httpGatewayVerified = true;
+    if (index_1.asperaSdk.useOldHttpGateway) {
+        // Watch for old HTTP Gateway transfers in case used.
+        (0, http_gateway_sdk_js_1.registerActivityCallback)(function (oldHttpTransfers) {
+            oldHttpTransfers.transfers.forEach(function (oldHttpTransfer) {
+                (0, exports.sendTransferUpdate)(oldHttpTransfer);
+            });
+        });
+        return (0, http_gateway_sdk_js_1.initHttpGateway)(index_1.asperaSdk.globals.httpGatewayUrl).then(function () { });
+    }
+    var iframeContainer = document.createElement('div');
+    iframeContainer.id = 'aspera-http-gateway-iframes';
+    iframeContainer.style = 'display: none;';
+    document.body.appendChild(iframeContainer);
+    index_1.asperaSdk.globals.httpGatewayIframeContainer = iframeContainer;
+    return Promise.resolve();
+};
+exports.initHttpGateway = initHttpGateway;
 /**
  * Remove a transfer from HTTP Gateway systems
  * @param id - ID of the transfer
@@ -205,19 +247,6 @@ var getSdkTransfer = function (transferSpec) {
     };
 };
 exports.getSdkTransfer = getSdkTransfer;
-/**
- * Send a transfer update through the SDK
- *
- * @param transfer - Transsfer object to send to consumers
- */
-var sendTransferUpdate = function (transfer) {
-    index_1.asperaSdk.httpGatewayTransferStore.set(transfer.uuid, transfer);
-    index_1.asperaSdk.activityTracking.handleTransferActivity({
-        type: 'transferUpdated',
-        data: { transfers: [transfer] },
-    });
-};
-exports.sendTransferUpdate = sendTransferUpdate;
 /**
  * Try to parse and get a useful string from API calls for HTTP Gateway
  *

package/dist/commonjs/http-gateway/index.d.ts

@@ -1,6 +1,6 @@
 import { httpDownload } from './download';
 import { httpUpload } from './upload';
-import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement } from './core';
+import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, initHttpGateway } from './core';
 /**
  * HTTP Gateway Exports
  *
@@ -8,4 +8,4 @@ import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInp
  * Most logic is called directly by Desktop SDK functions
  * You may not need to import anything from this file.
  */
-export { httpUpload, httpDownload, handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, };
+export { httpUpload, httpDownload, handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, initHttpGateway, };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHtmlInputElement = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.httpDownload = exports.httpUpload = void 0;
+exports.initHttpGateway = exports.createHtmlInputElement = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.httpDownload = exports.httpUpload = void 0;
 var download_1 = require("./download");
 Object.defineProperty(exports, "httpDownload", { enumerable: true, get: function () { return download_1.httpDownload; } });
 var upload_1 = require("./upload");
@@ -9,3 +9,4 @@ var core_1 = require("./core");
 Object.defineProperty(exports, "handleHttpGatewayDrop", { enumerable: true, get: function () { return core_1.handleHttpGatewayDrop; } });
 Object.defineProperty(exports, "httpGatewaySelectFileFolderDialog", { enumerable: true, get: function () { return core_1.httpGatewaySelectFileFolderDialog; } });
 Object.defineProperty(exports, "createHtmlInputElement", { enumerable: true, get: function () { return core_1.createHtmlInputElement; } });
+Object.defineProperty(exports, "initHttpGateway", { enumerable: true, get: function () { return core_1.initHttpGateway; } });

package/dist/commonjs/models/aspera-sdk.model.d.ts

@@ -89,9 +89,9 @@ export declare class ActivityTracking {
     /** Keep track of the last notified WebSocket event **/
     private lastNotifiedWebSocketEvent;
     /**
-     * Notify all consumers when a message is received from the websocket
+     * Notify all consumers when a message is received from the transfer client.
      *
-     * @param message the message received from the websocket
+     * @param message the message received
      */
     handleTransferActivity(message: ActivityMessage): void;
     /**

package/dist/commonjs/models/aspera-sdk.model.js

@@ -94,15 +94,18 @@ var ActivityTracking = /** @class */ (function () {
         this.lastNotifiedWebSocketEvent = undefined;
     }
     /**
-     * Notify all consumers when a message is received from the websocket
+     * Notify all consumers when a message is received from the transfer client.
      *
-     * @param message the message received from the websocket
+     * @param message the message received
      */
     ActivityTracking.prototype.handleTransferActivity = function (message) {
+        var data = message.data && typeof message.data === 'object' && 'transfers' in message.data
+            ? message.data
+            : { transfers: [message.data] };
         if (message.type === 'transferUpdated' || message.type === 'transferRemoved') {
             this.activity_callbacks.forEach(function (callback) {
                 if (typeof callback === 'function') {
-                    callback(message.data);
+                    callback(data);
                 }
             });
         }