@ibm-aspera/sdk 0.11.0 → 0.19.0

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

@@ -12,6 +12,7 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AsperaSdk = exports.ActivityTracking = exports.AsperaSdkGlobals = void 0;
+var status_1 = require("../app/status");
 var constants_1 = require("../constants/constants");
 var messages_1 = require("../constants/messages");
 var safari_client_1 = require("../helpers/client/safari-client");
@@ -88,12 +89,6 @@ var ActivityTracking = /** @class */ (function () {
     function ActivityTracking() {
         /** Map of callbacks that receive transfer update events */
         this.activity_callbacks = new Map();
-        /** Map of callbacks that receive connection events */
-        this.event_callbacks = new Map();
-        /** Keep track of the last WebSocket event **/
-        this.lastWebSocketEvent = 'CLOSED';
-        /** Keep track of the last notified WebSocket event **/
-        this.lastNotifiedWebSocketEvent = undefined;
     }
     /**
      * Notify all consumers when a message is received from the transfer client.
@@ -113,41 +108,27 @@ var ActivityTracking = /** @class */ (function () {
         }
     };
     /**
-     * Handle and notify if needed when a connection webSocketEvent occurs. For example, when the SDK
+     * Handle and notify when a connection webSocketEvent occurs. For example, when the SDK
      * websocket connection to IBM Aspera App is closed or reconnected.
      *
+     * Bridges WebSocket events to StatusService as SdkStatus values.
+     *
      * @param webSocketEvent the event type.
      */
     ActivityTracking.prototype.handleWebSocketEvents = function (webSocketEvent) {
-        if (this.lastWebSocketEvent === webSocketEvent) {
-            return;
+        if (webSocketEvent === 'CLOSED') {
+            status_1.statusService.setStatus('DISCONNECTED');
+        }
+        else if (webSocketEvent === 'RECONNECT') {
+            status_1.statusService.setStatus('RUNNING');
         }
-        this.lastWebSocketEvent = webSocketEvent;
-        this.notifyWebSocketEvent(webSocketEvent);
     };
     /**
-     * Notify all consumers when a connection webSocketEvent occurs.
-     *
-     * @param webSocketEvent the event type.
+     * Trigger manual event for other event types (e.g. Connect status strings).
+     * Bridges to StatusService.
      */
-    ActivityTracking.prototype.notifyWebSocketEvent = function (webSocketEvent) {
-        if (this.lastNotifiedWebSocketEvent === webSocketEvent) {
-            return;
-        }
-        this.lastNotifiedWebSocketEvent = webSocketEvent;
-        this.event_callbacks.forEach(function (callback) {
-            if (typeof callback === 'function') {
-                callback(webSocketEvent);
-            }
-        });
-    };
-    /** Trigger manual event for other event types. */
     ActivityTracking.prototype.sendManualEventCallback = function (status) {
-        this.event_callbacks.forEach(function (callback) {
-            if (typeof callback === 'function') {
-                callback(status);
-            }
-        });
+        status_1.statusService.setStatus(status);
     };
     /**
      * Notify all consumers when the client changes status. For example, when
@@ -156,14 +137,9 @@ var ActivityTracking = /** @class */ (function () {
      * @param running whether the client is running or not.
      */
     ActivityTracking.prototype.handleClientEvents = function (running) {
-        var webSocketEvent;
         if (!running) {
-            webSocketEvent = 'CLOSED';
-        }
-        else {
-            webSocketEvent = this.lastWebSocketEvent;
+            status_1.statusService.setStatus('DISCONNECTED');
         }
-        this.notifyWebSocketEvent(webSocketEvent);
     };
     /**
      * Notify all consumers when a Safari extension safariExtensionEvent occurs (enabled/disabled).
@@ -249,31 +225,6 @@ var ActivityTracking = /** @class */ (function () {
     ActivityTracking.prototype.removeCallback = function (id) {
         this.activity_callbacks.delete(id);
     };
-    /**
-     * Register a callback for getting websocket events back to the consumer
-     *
-     * @param callback the function to call with the websocket event
-     *
-     * @returns the ID of the callback index
-     */
-    ActivityTracking.prototype.setWebSocketEventCallback = function (callback) {
-        if (typeof callback !== 'function') {
-            (0, helpers_1.errorLog)(messages_1.messages.callbackIsNotFunction);
-            return;
-        }
-        var id = "callback-".concat(this.event_callbacks.size + 1);
-        this.event_callbacks.set(id, callback);
-        callback(this.lastWebSocketEvent);
-        return id;
-    };
-    /**
-     * Remove the callback (deregister) from the list of callbacks
-     *
-     * @param id the string of the callback to remove
-     */
-    ActivityTracking.prototype.removeWebSocketEventCallback = function (id) {
-        this.event_callbacks.delete(id);
-    };
     ActivityTracking.prototype.registerDesktopAppSession = function () {
         var iframe = document.createElement('iframe');
         iframe.style.display = 'none';
@@ -306,9 +257,9 @@ var AsperaSdk = /** @class */ (function () {
     }
     Object.defineProperty(AsperaSdk.prototype, "isReady", {
         /**
-         * Check if IBM Aspera is ready to be used and has been verified.
+         * Check if IBM Aspera for desktop is ready to be used and has been verified.
          *
-         * @returns a boolean indicating if SDK can be used for requests
+         * @returns a boolean indicating if IBM Aspera for desktop can be used for requests
          */
         get: function () {
             return this.globals.asperaAppVerified && this.globals.appId !== '';

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

@@ -28,6 +28,14 @@ export interface FolderDialogOptions {
     /** Allow user to select multiple folders */
     multiple?: boolean;
 }
+export interface SaveFileDialogOptions {
+    /** Filter the files displayed by file extension. */
+    allowedFileTypes?: any;
+    /** The filename to pre-fill the dialog with. */
+    suggestedName?: string;
+    /** The name of the dialog window. */
+    title?: string;
+}
 /**
  * Options related to fetching the latest Aspera installer information.
  *
@@ -176,7 +184,23 @@ export interface DirectoryListFilters {
     /** Whether to include hidden files and directories in the results. */
     hidden?: boolean;
 }
+/** Options for testing SSH port connectivity to a transfer server. */
+export interface TestSshPortsOptions {
+    /** Domain name of the transfer server */
+    remote_host: string;
+    /** SSH port */
+    ssh_port?: number;
+    /** Timeout value in seconds */
+    timeout_sec?: number;
+}
 /** Options for reading directory contents */
+/** Valid page names for the preferences page. */
+export type PreferencesPage = 'general' | 'transfers' | 'network' | 'bandwidth' | 'security';
+/** Options for opening the preferences page to a specific tab. */
+export interface ShowPreferencesPageOptions {
+    /** The preferences page (tab) to open. */
+    page: PreferencesPage;
+}
 export interface ReadDirectoryOptions {
     /** Absolute path to the directory to enumerate. Must have been previously allowed via dialog selection or drag-drop. */
     path: string;
@@ -364,6 +388,15 @@ export interface TransferSpec {
     delete_source?: boolean;
     /** Directon of transfer, whether send (upload) or receive (download) */
     direction?: 'send' | 'receive';
+    /**
+     * The name of the ZIP file created when downloading more than one file.
+     * For example, `download_name: 'project_files'` results in `project_files.zip`.
+     *
+     * Only applicable when `zip_required` is `true` or downloading multiple files.
+     *
+     * This field is only used by HTTP Gateway and is ignored by other transfer clients.
+     */
+    download_name?: string;
     /**
      * Exclude files (but not directories) that are newer than a specific time from the transfer, based on when the file was last modified.
      * Express in ISO 8601 format (for exanple, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.
@@ -550,8 +583,18 @@ export interface TransferSpec {
     token?: string;
     /** Use ascp4 as the transfer engine. */
     use_ascp4?: boolean;
+    /**
+     * **Required when downloading a folder via HTTP Gateway.** Set to `true` to have
+     * HTTP Gateway stream the folder contents back as a ZIP archive. Without this flag,
+     * HTTP Gateway cannot serve folder downloads.
+     *
+     * Use `download_name` to control the filename of the resulting ZIP (defaults to `download.zip`).
+     *
+     * This field is only used by HTTP Gateway and is ignored by other transfer clients.
+     */
+    zip_required?: boolean;
 }
-export type TransferStatus = 'failed' | 'completed' | 'running' | 'queued' | 'removed' | 'canceled' | 'orphaned' | 'paused';
+export type TransferStatus = 'initiating' | 'failed' | 'completed' | 'running' | 'queued' | 'removed' | 'cancelled' | 'orphaned' | 'paused' | 'willretry';
 /** Pagination options for paginated API requests. */
 export interface Pagination {
     /** Maximum number of entries to return. (Default: 1000) */
@@ -664,6 +707,7 @@ export interface InstallerInfoResponse {
 export type WebsocketTopics = 'subscribe_transfer_activity' | 'transfer_activity';
 export type WebsocketEvent = 'CLOSED' | 'RECONNECT';
 export type SafariExtensionEvent = 'ENABLED' | 'DISABLED';
+export type SdkStatus = 'INITIALIZING' | 'RETRYING' | 'RUNNING' | 'DEGRADED' | 'FAILED' | 'OUTDATED' | 'EXTENSION_INSTALL' | 'DISCONNECTED';
 export interface WebsocketMessage {
     jsonrpc: '2.0';
     method: WebsocketTopics;
@@ -861,6 +905,10 @@ export interface InitOptions {
     appId?: string;
     /** Indicate if the computer is running multiple users possibly (avoid port crossing). */
     supportMultipleUsers?: boolean;
+    /** Timeout in ms before status transitions to FAILED. Default: 5000. */
+    retryTimeout?: number;
+    /** Interval in ms between detection attempts. Default: 2000. */
+    retryInterval?: number;
     /** HTTP Gateway Settings */
     httpGatewaySettings?: {
         /** Aspera HTTP Gateway URL to use if desktop is not available. Include gateway route but not versions (example: https://example.com/aspera/http-gwy). */
@@ -938,6 +986,34 @@ export interface SdkCapabilities {
      * but not HTTP Gateway.
      */
     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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    showSaveFileDialog: boolean;
     /**
      * Whether the SDK can read directory contents.
      *