@ibm-aspera/sdk 0.11.0 → 0.19.0

package/dist/commonjs/app/status.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statusService = void 0;
+var helpers_1 = require("../helpers/helpers");
+var index_1 = require("../index");
+var StatusService = /** @class */ (function () {
+    function StatusService() {
+        this.currentStatus = undefined;
+        this.callbacks = new Map();
+        this.pollTimerId = null;
+        this.failTimeoutId = null;
+    }
+    StatusService.prototype.getStatus = function () {
+        return this.currentStatus;
+    };
+    StatusService.prototype.setStatus = function (status) {
+        // When Desktop disconnects, remap to DEGRADED if HTTP Gateway is available
+        if (status === 'DISCONNECTED' && index_1.asperaSdk.httpGatewayIsReady) {
+            status = 'DEGRADED';
+        }
+        if (this.currentStatus === status) {
+            return;
+        }
+        // Manage Desktop verification state based on status transitions
+        if (status === 'DISCONNECTED' || status === 'DEGRADED') {
+            index_1.asperaSdk.globals.asperaAppVerified = false;
+        }
+        else if (status === 'RUNNING' && (this.currentStatus === 'DISCONNECTED' || this.currentStatus === 'DEGRADED')) {
+            index_1.asperaSdk.globals.asperaAppVerified = true;
+        }
+        this.currentStatus = status;
+        this.callbacks.forEach(function (cb) { return cb(status); });
+    };
+    StatusService.prototype.registerCallback = function (cb) {
+        var id = "status-".concat((0, helpers_1.randomUUID)());
+        this.callbacks.set(id, cb);
+        if (this.currentStatus !== undefined) {
+            cb(this.currentStatus);
+        }
+        return id;
+    };
+    StatusService.prototype.deregisterCallback = function (id) {
+        this.callbacks.delete(id);
+    };
+    /**
+     * Start Desktop detection polling loop.
+     *
+     * @param detectFn async function that resolves if Desktop is found, rejects if not
+     * @param interval ms between attempts
+     * @param failTimeout ms before transitioning to FAILED or DEGRADED
+     */
+    StatusService.prototype.startPolling = function (detectFn, interval, failTimeout) {
+        var _this = this;
+        this.stopPolling();
+        this.setStatus('INITIALIZING');
+        this.failTimeoutId = setTimeout(function () {
+            if (_this.currentStatus !== 'RUNNING') {
+                if (index_1.asperaSdk.httpGatewayIsReady) {
+                    _this.setStatus('DEGRADED');
+                }
+                else {
+                    _this.setStatus('FAILED');
+                }
+            }
+        }, failTimeout);
+        var attempt = function () {
+            detectFn()
+                .then(function () {
+                _this.stopPolling();
+                _this.setStatus('RUNNING');
+            })
+                .catch(function () {
+                // Stay in current status (INITIALIZING or FAILED), poll continues
+            });
+        };
+        attempt();
+        this.pollTimerId = setInterval(attempt, interval);
+    };
+    StatusService.prototype.stopPolling = function () {
+        if (this.pollTimerId) {
+            clearInterval(this.pollTimerId);
+            this.pollTimerId = null;
+        }
+        if (this.failTimeoutId) {
+            clearTimeout(this.failTimeoutId);
+            this.failTimeoutId = null;
+        }
+    };
+    StatusService.prototype.reset = function () {
+        this.stopPolling();
+        this.currentStatus = undefined;
+        this.callbacks.clear();
+    };
+    return StatusService;
+}());
+exports.statusService = new StatusService();

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

@@ -1,4 +1,5 @@
 import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
+import { InitOptions } from '../models/models';
 /**
  * Connect Core Logic
  *
@@ -8,4 +9,4 @@ import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
  */
 export declare const handleTransfers: (transfers: ConnectTypes.TransferInfo[]) => void;
 export declare const connectInstallationFlow: () => void;
-export declare const initConnect: (useIncludedInstaller?: boolean) => Promise<unknown>;
+export declare const initConnect: (connectSettings: InitOptions["connectSettings"]) => Promise<unknown>;

package/dist/commonjs/connect/core.js

@@ -51,7 +51,22 @@ var connectInstallationFlow = function () {
     index_1.asperaSdk.globals.connect.addEventListener(index_1.asperaSdk.globals.connectAW4.Connect.EVENT.STATUS, handleInstallerEvent);
 };
 exports.connectInstallationFlow = connectInstallationFlow;
-var initConnect = function (useIncludedInstaller) {
+var initConnect = function (connectSettings) {
+    index_1.asperaSdk.globals.connect = new connect_sdk_js_1.Connect({
+        minVersion: connectSettings.minVersion || '3.10.1',
+        dragDropEnabled: connectSettings.dragDropEnabled,
+        connectMethod: connectSettings.method,
+    });
+    index_1.asperaSdk.globals.connectInstaller = new connect_sdk_js_1.ConnectInstaller({
+        sdkLocation: connectSettings.sdkLocation,
+        correlationId: connectSettings.correlationId,
+        style: 'carbon',
+        version: connectSettings.version,
+    });
+    index_1.asperaSdk.globals.connectAW4 = {
+        Connect: connect_sdk_js_1.Connect,
+        ConnectInstaller: connect_sdk_js_1.ConnectInstaller,
+    };
     index_1.asperaSdk.globals.connect.addEventListener(connect_sdk_js_1.Connect.EVENT.STATUS, function (eventType, eventStatus) {
         if (eventType === connect_sdk_js_1.Connect.EVENT.STATUS) {
             index_1.asperaSdk.globals.connectStatus = eventStatus;
@@ -65,7 +80,7 @@ var initConnect = function (useIncludedInstaller) {
         }
     });
     index_1.asperaSdk.globals.connect.initSession(index_1.asperaSdk.globals.appId);
-    if (useIncludedInstaller) {
+    if (!connectSettings.hideIncludedInstaller) {
         (0, exports.connectInstallationFlow)();
     }
     return Promise.resolve({ connectMode: true });

package/dist/commonjs/constants/messages.d.ts

@@ -45,4 +45,14 @@ export declare const messages: {
     readDirectoryNotSupported: string;
     showTransferManagerFailed: string;
     showTransferManagerNotSupported: string;
+    openPreferencesPageFailed: string;
+    openPreferencesPageNotSupported: string;
+    showTransferMonitorFailed: string;
+    showTransferMonitorNotSupported: string;
+    authenticateFailed: string;
+    authenticateNotSupported: string;
+    testSshPortsFailed: string;
+    testSshPortsNotSupported: string;
+    showSaveFileDialogFailed: string;
+    showSaveFileDialogNotSupported: string;
 };

package/dist/commonjs/constants/messages.js

@@ -24,7 +24,7 @@ exports.messages = {
     showSelectFolderDialogFailed: 'Unable to show select folder dialog',
     showPreferencesFailed: 'Unable to show preferences',
     stopTransferFailed: 'Unable to stop transfer',
-    stopTransferFailedExternal: 'Unable to stop transfer. The download must be canceled from the browser\'s download manager',
+    stopTransferFailedExternal: 'Unable to stop transfer. The download must be cancelled from the browser\'s download manager',
     transferFailed: 'The transfer failed to initiate',
     unableToFindElementOnPage: 'Unable to find the element on the current page',
     unableToReadDropped: 'The dropped item could not be parsed. Please try selecting via the select file/folder option',
@@ -33,7 +33,7 @@ exports.messages = {
     websocketNotReady: 'The websocket is not ready. Run init first',
     httpNotAvailable: 'IBM Aspera HTTP Gateway is not available',
     httpInitFail: 'IBM Aspera HTTP Gateway could not be started',
-    filePickerCancel: 'User canceled the select file or folder dialog.',
+    filePickerCancel: 'User cancelled the select file or folder dialog.',
     fileNotAllowed: 'The specified path has not been allowed by the user.',
     httpNetworkFail: 'HTTP network encountered unknown error.',
     readAsArrayBufferFailed: 'Unable to read file as array buffer',
@@ -48,4 +48,14 @@ exports.messages = {
     readDirectoryNotSupported: 'Read directory is not supported for current transfer client',
     showTransferManagerFailed: 'Unable to show transfer manager',
     showTransferManagerNotSupported: 'Show transfer manager is not supported for current transfer client',
+    openPreferencesPageFailed: 'Unable to open preferences page',
+    openPreferencesPageNotSupported: 'Open preferences page is not supported for current transfer client',
+    showTransferMonitorFailed: 'Unable to show transfer monitor',
+    showTransferMonitorNotSupported: 'Show transfer monitor is not supported for current transfer client',
+    authenticateFailed: 'Unable to authenticate',
+    authenticateNotSupported: 'Authenticate is not supported for current transfer client',
+    testSshPortsFailed: 'Unable to test SSH ports',
+    testSshPortsNotSupported: 'Test SSH ports is not supported for current transfer client',
+    showSaveFileDialogFailed: 'Unable to show save file dialog',
+    showSaveFileDialogNotSupported: 'Show save file dialog is not supported for current transfer client',
 };

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

@@ -25,9 +25,18 @@ export declare const sendTransferUpdate: (transfer: AsperaSdkTransfer) => void;
  * @returns a promise that resolves when the HTTP Gateway is initialized
  */
 export declare const initHttpGateway: (response: HttpGatewayInfo) => Promise<void>;
+/**
+ * Set up the HTTP Gateway by normalizing the URL, fetching the /info endpoint,
+ * and calling initHttpGateway with the response.
+ *
+ * @param url - The HTTP Gateway URL provided by the consumer
+ *
+ * @returns a promise that resolves when the HTTP Gateway is initialized
+ */
+export declare const setupHttpGateway: (url: string) => Promise<void>;
 /**
  * Stop an in-progress HTTP Gateway transfer.
- * Aborts the underlying HTTP request and sets the transfer status to 'canceled'.
+ * Aborts the underlying HTTP request and sets the transfer status to 'cancelled'.
  *
  * Note: If the download is being directly handled by the browser's download manager, this will return
  * an error. The user must cancel the download themselves in the browser's download manger.

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpGatewayReadChunkAsArrayBuffer = exports.httpGatewayReadAsArrayBuffer = exports.base64Encoding = exports.getMessageFromError = exports.getSdkTransfer = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.createHtmlInputElement = exports.httpGetTransfer = exports.httpGetAllTransfers = exports.httpRemoveTransfer = exports.httpStopTransfer = exports.initHttpGateway = exports.sendTransferUpdate = 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.httpStopTransfer = exports.setupHttpGateway = exports.initHttpGateway = exports.sendTransferUpdate = void 0;
 var messages_1 = require("../constants/messages");
 var helpers_1 = require("../helpers/helpers");
 var index_1 = require("../index");
@@ -47,7 +47,12 @@ var initHttpGateway = function (response) {
         // 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);
+                var transfer = oldHttpTransfer;
+                // The HTTP Gateway v2 SDK uses "canceled" but we standardize on "cancelled"
+                if (transfer.status === 'canceled') {
+                    transfer.status = 'cancelled';
+                }
+                (0, exports.sendTransferUpdate)(transfer);
             });
         });
         return (0, http_gateway_sdk_js_1.initHttpGateway)(index_1.asperaSdk.globals.httpGatewayUrl).then(function () { });
@@ -60,9 +65,38 @@ var initHttpGateway = function (response) {
     return Promise.resolve();
 };
 exports.initHttpGateway = initHttpGateway;
+/**
+ * Set up the HTTP Gateway by normalizing the URL, fetching the /info endpoint,
+ * and calling initHttpGateway with the response.
+ *
+ * @param url - The HTTP Gateway URL provided by the consumer
+ *
+ * @returns a promise that resolves when the HTTP Gateway is initialized
+ */
+var setupHttpGateway = function (url) {
+    var finalUrl = url.trim();
+    if (finalUrl.indexOf('http') !== 0) {
+        finalUrl = "https://".concat(finalUrl);
+    }
+    if (finalUrl.endsWith('/')) {
+        finalUrl = finalUrl.slice(0, -1);
+    }
+    index_1.asperaSdk.globals.httpGatewayUrl = finalUrl;
+    return fetch("".concat(finalUrl, "/info"), { method: 'GET' }).then(function (response) {
+        return response.json().then(function (responseData) {
+            if (response.status >= 400) {
+                throw Error(responseData);
+            }
+            return responseData;
+        });
+    }).then(function (response) {
+        return (0, exports.initHttpGateway)(response);
+    });
+};
+exports.setupHttpGateway = setupHttpGateway;
 /**
  * Stop an in-progress HTTP Gateway transfer.
- * Aborts the underlying HTTP request and sets the transfer status to 'canceled'.
+ * Aborts the underlying HTTP request and sets the transfer status to 'cancelled'.
  *
  * Note: If the download is being directly handled by the browser's download manager, this will return
  * an error. The user must cancel the download themselves in the browser's download manger.
@@ -83,7 +117,7 @@ var httpStopTransfer = function (id) {
     else if (transfer.httpDownloadExternalHandle) {
         return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.stopTransferFailedExternal, { reason: 'External handle' }));
     }
-    transfer.status = 'canceled';
+    transfer.status = 'cancelled';
     var request = index_1.asperaSdk.httpGatewayRequestStore.get(id);
     if (request) {
         request.abort();

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

@@ -1,6 +1,6 @@
 import { httpDownload } from './download';
 import { httpUpload } from './upload';
-import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, initHttpGateway } from './core';
+import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, initHttpGateway, setupHttpGateway } 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, initHttpGateway, };
+export { httpUpload, httpDownload, handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, initHttpGateway, setupHttpGateway, };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initHttpGateway = exports.createHtmlInputElement = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.httpDownload = exports.httpUpload = void 0;
+exports.setupHttpGateway = 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");
@@ -10,3 +10,4 @@ Object.defineProperty(exports, "handleHttpGatewayDrop", { enumerable: true, get:
 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; } });
+Object.defineProperty(exports, "setupHttpGateway", { enumerable: true, get: function () { return core_1.setupHttpGateway; } });

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

@@ -54,7 +54,7 @@ var httpUpload = function (transferSpec, asperaSdkSpec) {
         (0, core_1.sendTransferUpdate)(transferObject);
     };
     var triggerFailed = function () {
-        if (transferObject.status === 'canceled') {
+        if (transferObject.status === 'cancelled') {
             return;
         }
         var errorData = (0, core_1.getMessageFromError)(request.response);

package/dist/commonjs/index.d.ts

@@ -1,11 +1,11 @@
 import { AsperaSdk } from './models/aspera-sdk.model';
-import { createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getCapabilities, getChecksum, getFilesList, getInfo, getTransfer, hasCapability, init, initDragDrop, modifyTransfer, readAsArrayBuffer, readChunkAsArrayBuffer, readDirectory, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, showAbout, showDirectory, showPreferences, showSelectFileDialog, showSelectFolderDialog, showTransferManager, startTransfer, stopTransfer, testConnection } from './app/core';
+import { authenticate, createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getCapabilities, getChecksum, getFilesList, getInfo, getStatus, getTransfer, hasCapability, init, initDragDrop, initSession, modifyTransfer, showPreferencesPage, readAsArrayBuffer, readChunkAsArrayBuffer, readDirectory, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, showAbout, showDirectory, showPreferences, showSaveFileDialog, showSelectFileDialog, showSelectFolderDialog, showTransferManager, showTransferMonitor, startTransfer, stopTransfer, testConnection, testSshPorts } from './app/core';
 import { getInstallerInfo } from './app/installer';
 import { getInstallerUrls, isSafari } from './helpers/helpers';
 export declare const asperaSdk: AsperaSdk;
 declare const launch: () => void;
-export { isSafari, init, testConnection, startTransfer, launch, registerActivityCallback, deregisterActivityCallback, removeTransfer, showAbout, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, getFilesList, showSelectFileDialog, showSelectFolderDialog, showPreferences, showTransferManager, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, hasCapability, getChecksum, readDirectory, };
-export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, DirectoryEntry, DirectoryListFilters, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, DropzoneEventData, DropzoneEventType, EntryType, DropzoneOptions, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, GetChecksumOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, OverwritePolicy, PaginatedFilesResponse, Pagination, Path, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse, ReadDirectoryOptions, ReadDirectoryResponse, ResumePolicy, ResumeTransferOptions, SafariExtensionEvent, SdkCapabilities, TransferSpec, TransferStatus, WebsocketEvent, } from './models/models';
+export { isSafari, init, authenticate, testSshPorts, testConnection, startTransfer, launch, registerActivityCallback, deregisterActivityCallback, removeTransfer, showAbout, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, getFilesList, showSelectFileDialog, showSelectFolderDialog, showSaveFileDialog, showPreferences, showTransferManager, showTransferMonitor, showPreferencesPage as openPreferencesPage, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, initSession, getStatus, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, hasCapability, getChecksum, readDirectory, };
+export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, DirectoryEntry, DirectoryListFilters, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, DropzoneEventData, DropzoneEventType, EntryType, DropzoneOptions, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, SaveFileDialogOptions, GetChecksumOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, ShowPreferencesPageOptions as OpenPreferencesPageOptions, OverwritePolicy, PaginatedFilesResponse, Pagination, Path, PreferencesPage, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse, ReadDirectoryOptions, ReadDirectoryResponse, ResumePolicy, ResumeTransferOptions, SafariExtensionEvent, SdkCapabilities, TestSshPortsOptions, TransferSpec, TransferStatus, SdkStatus, WebsocketEvent, } from './models/models';
 export type { ActivityMessage, ActivityMessageTypes, AsperaSdkClientInfo, AsperaSdkInfo, TransferResponse, } from './models/aspera-sdk.model';
 export { AsperaSdk, AsperaSdkGlobals } from './models/aspera-sdk.model';
 export type { HttpGatewayInfo } from './http-gateway/models';

package/dist/commonjs/index.js

@@ -33,9 +33,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsperaSdkGlobals = exports.AsperaSdk = exports.readDirectory = exports.getChecksum = exports.hasCapability = exports.getCapabilities = exports.getInstallerUrls = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.setBranding = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.getInstallerInfo = exports.initDragDrop = exports.removeDropzone = exports.createDropzone = exports.modifyTransfer = exports.showTransferManager = exports.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.getFilesList = exports.getTransfer = exports.getAllTransfers = exports.resumeTransfer = exports.stopTransfer = exports.showDirectory = exports.showAbout = exports.removeTransfer = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.launch = exports.startTransfer = exports.testConnection = exports.init = exports.isSafari = exports.asperaSdk = void 0;
+exports.AsperaSdkGlobals = exports.AsperaSdk = exports.readDirectory = exports.getChecksum = exports.hasCapability = exports.getCapabilities = exports.getInstallerUrls = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.setBranding = exports.getStatus = exports.initSession = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.getInstallerInfo = exports.initDragDrop = exports.removeDropzone = exports.createDropzone = exports.modifyTransfer = exports.openPreferencesPage = exports.showTransferMonitor = exports.showTransferManager = exports.showPreferences = exports.showSaveFileDialog = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.getFilesList = exports.getTransfer = exports.getAllTransfers = exports.resumeTransfer = exports.stopTransfer = exports.showDirectory = exports.showAbout = exports.removeTransfer = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.launch = exports.startTransfer = exports.testConnection = exports.testSshPorts = exports.authenticate = exports.init = exports.isSafari = exports.asperaSdk = void 0;
 var aspera_sdk_model_1 = require("./models/aspera-sdk.model");
 var core_1 = require("./app/core");
+Object.defineProperty(exports, "authenticate", { enumerable: true, get: function () { return core_1.authenticate; } });
 Object.defineProperty(exports, "createDropzone", { enumerable: true, get: function () { return core_1.createDropzone; } });
 Object.defineProperty(exports, "deregisterActivityCallback", { enumerable: true, get: function () { return core_1.deregisterActivityCallback; } });
 Object.defineProperty(exports, "deregisterStatusCallback", { enumerable: true, get: function () { return core_1.deregisterStatusCallback; } });
@@ -44,11 +45,14 @@ Object.defineProperty(exports, "getCapabilities", { enumerable: true, get: funct
 Object.defineProperty(exports, "getChecksum", { enumerable: true, get: function () { return core_1.getChecksum; } });
 Object.defineProperty(exports, "getFilesList", { enumerable: true, get: function () { return core_1.getFilesList; } });
 Object.defineProperty(exports, "getInfo", { enumerable: true, get: function () { return core_1.getInfo; } });
+Object.defineProperty(exports, "getStatus", { enumerable: true, get: function () { return core_1.getStatus; } });
 Object.defineProperty(exports, "getTransfer", { enumerable: true, get: function () { return core_1.getTransfer; } });
 Object.defineProperty(exports, "hasCapability", { enumerable: true, get: function () { return core_1.hasCapability; } });
 Object.defineProperty(exports, "init", { enumerable: true, get: function () { return core_1.init; } });
 Object.defineProperty(exports, "initDragDrop", { enumerable: true, get: function () { return core_1.initDragDrop; } });
+Object.defineProperty(exports, "initSession", { enumerable: true, get: function () { return core_1.initSession; } });
 Object.defineProperty(exports, "modifyTransfer", { enumerable: true, get: function () { return core_1.modifyTransfer; } });
+Object.defineProperty(exports, "openPreferencesPage", { enumerable: true, get: function () { return core_1.showPreferencesPage; } });
 Object.defineProperty(exports, "readAsArrayBuffer", { enumerable: true, get: function () { return core_1.readAsArrayBuffer; } });
 Object.defineProperty(exports, "readChunkAsArrayBuffer", { enumerable: true, get: function () { return core_1.readChunkAsArrayBuffer; } });
 Object.defineProperty(exports, "readDirectory", { enumerable: true, get: function () { return core_1.readDirectory; } });
@@ -61,12 +65,15 @@ Object.defineProperty(exports, "setBranding", { enumerable: true, get: function
 Object.defineProperty(exports, "showAbout", { enumerable: true, get: function () { return core_1.showAbout; } });
 Object.defineProperty(exports, "showDirectory", { enumerable: true, get: function () { return core_1.showDirectory; } });
 Object.defineProperty(exports, "showPreferences", { enumerable: true, get: function () { return core_1.showPreferences; } });
+Object.defineProperty(exports, "showSaveFileDialog", { enumerable: true, get: function () { return core_1.showSaveFileDialog; } });
 Object.defineProperty(exports, "showSelectFileDialog", { enumerable: true, get: function () { return core_1.showSelectFileDialog; } });
 Object.defineProperty(exports, "showSelectFolderDialog", { enumerable: true, get: function () { return core_1.showSelectFolderDialog; } });
 Object.defineProperty(exports, "showTransferManager", { enumerable: true, get: function () { return core_1.showTransferManager; } });
+Object.defineProperty(exports, "showTransferMonitor", { enumerable: true, get: function () { return core_1.showTransferMonitor; } });
 Object.defineProperty(exports, "startTransfer", { enumerable: true, get: function () { return core_1.startTransfer; } });
 Object.defineProperty(exports, "stopTransfer", { enumerable: true, get: function () { return core_1.stopTransfer; } });
 Object.defineProperty(exports, "testConnection", { enumerable: true, get: function () { return core_1.testConnection; } });
+Object.defineProperty(exports, "testSshPorts", { enumerable: true, get: function () { return core_1.testSshPorts; } });
 var installer_1 = require("./app/installer");
 Object.defineProperty(exports, "getInstallerInfo", { enumerable: true, get: function () { return installer_1.getInstallerInfo; } });
 var helpers_1 = require("./helpers/helpers");
@@ -75,6 +82,8 @@ Object.defineProperty(exports, "isSafari", { enumerable: true, get: function ()
 var httpGatewayCalls = __importStar(require("./http-gateway"));
 exports.asperaSdk = new aspera_sdk_model_1.AsperaSdk();
 exports.asperaSdk.init = core_1.init;
+exports.asperaSdk.authenticate = core_1.authenticate;
+exports.asperaSdk.testSshPorts = core_1.testSshPorts;
 exports.asperaSdk.testConnection = core_1.testConnection;
 exports.asperaSdk.startTransfer = core_1.startTransfer;
 exports.asperaSdk.registerActivityCallback = core_1.registerActivityCallback;
@@ -89,14 +98,19 @@ exports.asperaSdk.getTransfer = core_1.getTransfer;
 exports.asperaSdk.getFilesList = core_1.getFilesList;
 exports.asperaSdk.showSelectFileDialog = core_1.showSelectFileDialog;
 exports.asperaSdk.showSelectFolderDialog = core_1.showSelectFolderDialog;
+exports.asperaSdk.showSaveFileDialog = core_1.showSaveFileDialog;
 exports.asperaSdk.showPreferences = core_1.showPreferences;
 exports.asperaSdk.showTransferManager = core_1.showTransferManager;
+exports.asperaSdk.showTransferMonitor = core_1.showTransferMonitor;
+exports.asperaSdk.showPreferencesPage = core_1.showPreferencesPage;
 exports.asperaSdk.modifyTransfer = core_1.modifyTransfer;
 exports.asperaSdk.createDropzone = core_1.createDropzone;
 exports.asperaSdk.removeDropzone = core_1.removeDropzone;
 exports.asperaSdk.getInstallerInfo = installer_1.getInstallerInfo;
 exports.asperaSdk.registerStatusCallback = core_1.registerStatusCallback;
 exports.asperaSdk.deregisterStatusCallback = core_1.deregisterStatusCallback;
+exports.asperaSdk.initSession = core_1.initSession;
+exports.asperaSdk.getStatus = core_1.getStatus;
 exports.asperaSdk.initDragDrop = core_1.initDragDrop;
 exports.asperaSdk.setBranding = core_1.setBranding;
 exports.asperaSdk.getInfo = core_1.getInfo;

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

@@ -1,4 +1,4 @@
-import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneEventType, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse, ReadDirectoryOptions, ReadDirectoryResponse } from './models';
+import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneEventType, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, SaveFileDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, SafariExtensionEvent, SdkStatus, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse, ReadDirectoryOptions, ReadDirectoryResponse, ShowPreferencesPageOptions, TestSshPortsOptions } from './models';
 import { HttpGatewayInfo } from '../http-gateway/models';
 import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
 import { Connect, ConnectInstaller } from '@ibm-aspera/connect-sdk-js';
@@ -84,12 +84,6 @@ export interface ActivityMessage {
 export declare class ActivityTracking {
     /** Map of callbacks that receive transfer update events */
     private activity_callbacks;
-    /** Map of callbacks that receive connection events */
-    private event_callbacks;
-    /** Keep track of the last WebSocket event **/
-    private lastWebSocketEvent;
-    /** Keep track of the last notified WebSocket event **/
-    private lastNotifiedWebSocketEvent;
     /**
      * Notify all consumers when a message is received from the transfer client.
      *
@@ -97,19 +91,18 @@ export declare class ActivityTracking {
      */
     handleTransferActivity(message: ActivityMessage): void;
     /**
-     * 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.
      */
     handleWebSocketEvents(webSocketEvent: WebsocketEvent): void;
     /**
-     * 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.
      */
-    private notifyWebSocketEvent;
-    /** Trigger manual event for other event types. */
     sendManualEventCallback(status: string): void;
     /**
      * Notify all consumers when the client changes status. For example, when
@@ -145,20 +138,6 @@ export declare class ActivityTracking {
      * @param id the string of the callback to remove
      */
     removeCallback(id: string): void;
-    /**
-     * 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
-     */
-    setWebSocketEventCallback(callback: (status: WebsocketEvent) => void): string;
-    /**
-     * Remove the callback (deregister) from the list of callbacks
-     *
-     * @param id the string of the callback to remove
-     */
-    removeWebSocketEventCallback(id: string): void;
     private registerDesktopAppSession;
 }
 export declare class AsperaSdk {
@@ -182,9 +161,13 @@ export declare class AsperaSdk {
     /** Deregister callback to remove it from the callbacks getting transfer data */
     deregisterActivityCallback: (id: string) => void;
     /** Register callback for connection status events from the app */
-    registerStatusCallback: (callback: (status: WebsocketEvent) => void) => string;
+    registerStatusCallback: (callback: (status: SdkStatus) => void) => string;
     /** Deregister callback to remove it from the callbacks getting connection events */
     deregisterStatusCallback: (id: string) => void;
+    /** Non-blocking initialization. Status events communicate lifecycle via registerStatusCallback. */
+    initSession: (options?: InitOptions) => void;
+    /** Get current SDK lifecycle status synchronously. */
+    getStatus: () => SdkStatus | undefined;
     /** Function to remove a transfer */
     removeTransfer: (transferId: string) => Promise<any>;
     /** Function to show the transfer's download directory in Finder or Windows Explorer */
@@ -201,12 +184,22 @@ export declare class AsperaSdk {
     showSelectFileDialog: (options?: FileDialogOptions) => Promise<DataTransferResponse>;
     /** Function to display a folder dialog for the user to select folders. */
     showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>;
+    /** Function to display a save file dialog for the user to choose a save location */
+    showSaveFileDialog: (options?: SaveFileDialogOptions) => Promise<DataTransferResponse>;
     /** Function to show the about page of the transfer client */
     showAbout: () => Promise<any>;
     /** Function to display the IBM Aspera preferences page */
     showPreferences: () => Promise<any>;
     /** Function to show the transfer manager UI */
     showTransferManager: () => Promise<any>;
+    /** Function to open a specific preferences page */
+    showPreferencesPage: (options: ShowPreferencesPageOptions) => Promise<any>;
+    /** Function to show the transfer rate monitor for a specific transfer */
+    showTransferMonitor: (transferId: string) => Promise<any>;
+    /** Function to authenticate a transfer specification against the remote server */
+    authenticate: (transferSpec: TransferSpec) => Promise<any>;
+    /** Function to test SSH port connectivity to a transfer server */
+    testSshPorts: (options: TestSshPortsOptions) => Promise<any>;
     /** Function to modify a running transfer */
     modifyTransfer: (transferId: string, options: ModifyTransferOptions) => Promise<AsperaSdkTransfer>;
     /** Function to set custom branding for IBM Aspera */
@@ -256,9 +249,9 @@ export declare class AsperaSdk {
     /** HTTP Gateway in app threshold limit. This can be changed globally for the app. */
     httpGatewayInBrowserDownloadThreshold: number;
     /**
-     * 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 isReady(): boolean;
     /** Indicate that Connect is available. */