@ibm-aspera/sdk 0.20.1 → 0.21.1

package/dist/commonjs/app/core.js

@@ -1274,15 +1274,28 @@ exports.removeDropzone = removeDropzone;
  * @returns a promise that returns information about the user's IBM Aspera installation.
  */
 var getInfo = function () {
+    // Fetch the Connect application version on demand the first time it's requested.
+    // Cached on `asperaSdk.globals.connectVersion` so subsequent calls return immediately.
+    if (index_1.asperaSdk.useConnect && !index_1.asperaSdk.globals.connectVersion) {
+        var promiseInfo_1 = (0, helpers_1.generatePromiseObjects)();
+        index_1.asperaSdk.globals.connect.version()
+            .then(function (info) {
+            index_1.asperaSdk.globals.connectVersion = info === null || info === void 0 ? void 0 : info.version;
+            promiseInfo_1.resolver(index_1.asperaSdk.globals.sdkResponseData);
+        })
+            .catch(function () {
+            // Best-effort — leave connectVersion undefined if Connect's version() rejects.
+            promiseInfo_1.resolver(index_1.asperaSdk.globals.sdkResponseData);
+        });
+        return promiseInfo_1.promise;
+    }
     if (index_1.asperaSdk.useHttpGateway || index_1.asperaSdk.useConnect) {
         return Promise.resolve(index_1.asperaSdk.globals.sdkResponseData);
     }
     if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
-    return new Promise(function (resolve, _) {
-        resolve(index_1.asperaSdk.globals.sdkResponseData);
-    });
+    return Promise.resolve(index_1.asperaSdk.globals.sdkResponseData);
 };
 exports.getInfo = getInfo;
 /**
@@ -1440,11 +1453,11 @@ var supportsMethod = function (method) {
     // We currently do not support calculating file checksums when using HTTP Gateway. In theory it should be possible
     // to calculate this directly in the browser similar to how `readAsArrayBuffer()` is implemented.
     // HTTP Gateway also does not support showing native transfer client UI (about, preferences, etc.).
-    if (index_1.asperaSdk.useHttpGateway && (method === 'get_checksum' || method === 'show_about' || method === 'open_preferences' || method === 'show_transfer_manager' || method === 'show_transfer_monitor' || method === 'authenticate' || method === 'test_ssh_ports' || method === 'show_save_file_dialog' || method === 'read_directory')) {
+    if (index_1.asperaSdk.useHttpGateway && (method === 'get_checksum' || method === 'show_about' || method === 'open_preferences' || method === 'show_transfer_manager' || method === 'show_transfer_monitor' || method === 'authenticate' || method === 'test_ssh_ports' || method === 'show_save_file_dialog' || method === 'read_directory' || method === 'get_files_list' || method === 'update_branding' || method === 'show_directory' || method === 'modify_transfer' || method === 'resume_transfer')) {
         return false;
     }
     // Reading directory contents is only supported by the Desktop App (not Connect).
-    if (index_1.asperaSdk.useConnect && method === 'read_directory') {
+    if (index_1.asperaSdk.useConnect && (method === 'read_directory' || method === 'get_files_list' || method === 'update_branding')) {
         return false;
     }
     // HTTP Gateway and Connect do not have any RPC methods so fallback to true
@@ -1486,6 +1499,12 @@ var getCapabilities = function () {
         testSshPorts: supportsMethod('test_ssh_ports'),
         showSaveFileDialog: supportsMethod('show_save_file_dialog'),
         readDirectory: supportsMethod('read_directory'),
+        getFilesList: supportsMethod('get_files_list'),
+        setBranding: supportsMethod('update_branding'),
+        showDirectory: supportsMethod('show_directory'),
+        folderUpload: !index_1.asperaSdk.useOldHttpGateway,
+        modifyTransfer: supportsMethod('modify_transfer'),
+        resumeTransfer: supportsMethod('resume_transfer'),
     };
 };
 exports.getCapabilities = getCapabilities;

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

@@ -283,6 +283,33 @@ var httpGatewaySelectFileFolderDialog = function (options, folder) {
     return promise;
 };
 exports.httpGatewaySelectFileFolderDialog = httpGatewaySelectFileFolderDialog;
+/**
+ * Generate a human-readable title for an HTTP Gateway transfer. The desktop and Connect
+ * transfer clients populate `title` themselves; HTTP Gateway transfers are constructed
+ * client-side and need a synthesized title for consumer UIs.
+ *
+ * If the caller already supplied a `title` on the spec, that wins. Otherwise we use the
+ * basename of the first source path, suffixed with `(+N)` when there are additional paths.
+ */
+var getTitle = function (transferSpec) {
+    var _a, _b;
+    if (transferSpec.title) {
+        return transferSpec.title;
+    }
+    var paths = transferSpec.paths;
+    if (!paths || paths.length === 0) {
+        return '';
+    }
+    var path = (_a = paths[0]) === null || _a === void 0 ? void 0 : _a.source;
+    if (!path) {
+        return '';
+    }
+    var first = (_b = path.split('/').filter(Boolean).pop()) !== null && _b !== void 0 ? _b : '';
+    if (paths.length === 1) {
+        return first;
+    }
+    return "".concat(first, " (+").concat(paths.length - 1, ")");
+};
 /**
  * Get a generic transfer object for HTTP Gateway transfers.
  *
@@ -291,6 +318,7 @@ exports.httpGatewaySelectFileFolderDialog = httpGatewaySelectFileFolderDialog;
  * @returns a transfer object to track status and send to consumers
  */
 var getSdkTransfer = function (transferSpec) {
+    var title = getTitle(transferSpec);
     return {
         uuid: (0, helpers_1.randomUUID)(),
         transfer_spec: transferSpec,
@@ -311,7 +339,7 @@ var getSdkTransfer = function (transferSpec) {
         calculated_rate_kbps: 0,
         elapsed_usec: 0,
         percentage: 0,
-        title: '',
+        title: title,
         remaining_usec: 0,
         transfer_client: 'http-gateway',
         httpGatewayTransfer: true,

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

@@ -47,6 +47,8 @@ export declare class AsperaSdkGlobals {
     connectInstaller?: ConnectTypes.ConnectInstallerClientType;
     /** Connect status */
     connectStatus: ConnectTypes.ConnectStatusStrings;
+    /** Connect application version, populated when Connect transitions to RUNNING. */
+    connectVersion?: string;
     backupLaunchMethod(url: string): void;
     /**
      * Launch the IBM Aspera App via protocol url. By default, a hidden IFRAME attempts to
@@ -71,6 +73,8 @@ export type AsperaSdkInfo = AsperaSdkClientInfo & {
     connect: {
         active: boolean;
         status: ConnectTypes.ConnectStatusStrings;
+        /** Connect application version, available once Connect has reached the RUNNING status. */
+        version?: string;
     };
 };
 export interface TransferResponse {

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

@@ -77,6 +77,7 @@ var AsperaSdkGlobals = /** @class */ (function () {
                 }, connect: {
                     active: this.connectStatus === 'RUNNING',
                     status: this.connectStatus,
+                    version: this.connectVersion,
                 } });
         },
         enumerable: false,
@@ -124,10 +125,24 @@ var ActivityTracking = /** @class */ (function () {
      * @param webSocketEvent the event type.
      */
     ActivityTracking.prototype.handleWebSocketEvents = function (webSocketEvent) {
+        var current_status = status_1.statusService.getStatus();
         if (webSocketEvent === 'CLOSED') {
             status_1.statusService.setStatus('DISCONNECTED');
+            return;
+        }
+        if (webSocketEvent !== 'RECONNECT') {
+            return;
         }
-        else if (webSocketEvent === 'RECONNECT') {
+        // Only treat RECONNECT as a transition to RUNNING when we have prior verification of
+        // IBM Aspera for desktop. For example, if IBM Aspera for desktop was RUNNING and verified,
+        // and then the user quits and restarts the application.
+        //
+        // TODO: This potentially leads to a data race if the application was quit/restarted because it was being
+        // upgraded. The new application may have newer RPC methods, but transitioning to RUNNING here could
+        // potentially lead to an application seeing stale RPC methods if they call `hasCapability()`, for example,
+        // in the status event listener.
+        var wasPreviouslyVerified = index_1.asperaSdk.globals.rpcMethods.length > 0;
+        if (current_status === 'DISCONNECTED' || (current_status === 'DEGRADED' && wasPreviouslyVerified)) {
             status_1.statusService.setStatus('RUNNING');
         }
     };

package/dist/commonjs/models/models.d.ts

@@ -966,70 +966,99 @@ export interface RpcMethod {
  */
 export interface SdkCapabilities {
     /**
-     * Whether the SDK can read file contents for generating image previews.
+     * Whether the transfer client can read file contents for generating image previews.
      *
-     * Image preview is supported if the SDK is using HTTP Gateway, Connect, or IBM Aspera for desktop
-     * with the required RPC methods.
+     * This is supported when using HTTP Gateway, Connect, or IBM Aspera for desktop.
     */
     imagePreview: boolean;
     /**
-     * Whether the SDK can calculate checksums of a file chunk.
+     * Whether the transfer client can calculate checksums of a file chunk.
      */
     fileChecksum: boolean;
     /**
      * Whether the transfer client supports showing the about page.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     showAbout: boolean;
     /**
      * Whether the transfer client supports showing the preferences page.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     showPreferences: boolean;
     /**
      * Whether the transfer client supports showing the transfer manager.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     showTransferManager: boolean;
     /**
      * Whether the transfer client supports showing the transfer rate monitor.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     showTransferMonitor: boolean;
     /**
      * Whether the transfer client supports authenticating a transfer specification.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     authenticate: boolean;
     /**
      * Whether the transfer client supports testing SSH port connectivity.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     testSshPorts: boolean;
     /**
      * Whether the transfer client supports showing the save file dialog.
      *
-     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
-     * but not HTTP Gateway.
+     * This is supported when using Connect or IBM Aspera for desktop.
      */
     showSaveFileDialog: boolean;
     /**
-     * Whether the SDK can read directory contents.
+     * Whether the transfer client can read directory contents.
      *
-     * This is supported when using IBM Aspera for desktop with the required RPC methods,
-     * but not Connect or HTTP Gateway.
+     * This is only supported when using IBM Aspera for desktop.
      */
     readDirectory: boolean;
+    /**
+     * Whether the transfer client supports getting file-level progress for a given transfer.
+     *
+     * This is supported when using IBM Aspera for desktop.
+     */
+    getFilesList: boolean;
+    /**
+     * Whether the transfer client supports customized branding settings.
+     *
+     * This is supported when using IBM Aspera for desktop.
+     */
+    setBranding: boolean;
+    /**
+     * Whether the transfer client supports highlighting the destination directory of the transfer
+     * using the system's file browser (ex: Finder or Windows Explorer).
+     *
+     * This is supported when using Connect or IBM Aspera for desktop.
+     */
+    showDirectory: boolean;
+    /**
+     * Whether the transfer client supports uploading folders.
+     *
+     * This is supported when using Connect, IBM Aspera for desktop, and HTTP Gateway v3 or newer. HTTP Gateway v2 and older
+     * do not support uploading folders.
+     */
+    folderUpload: boolean;
+    /**
+     * Whether the transfer client can modify a running transfer.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop.
+     */
+    modifyTransfer: boolean;
+    /**
+     * Whether the transfer client resume a stopped transfer.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop.
+     */
+    resumeTransfer: boolean;
 }