@ibm-aspera/sdk 0.11.0 → 0.16.0

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

@@ -1,5 +1,5 @@
 import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
-import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse, ReadDirectoryOptions, ReadDirectoryResponse } from '../models/models';
+import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, SaveFileDialogOptions, InitOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse, ReadDirectoryOptions, ReadDirectoryResponse, ShowPreferencesPageOptions, TestSshPortsOptions } from '../models/models';
 /**
  * Check if IBM Aspera for Desktop connection works. This function is called by init
  * when initializing the SDK. This function can be used at any point for checking.
@@ -34,6 +34,26 @@ export declare const initDragDrop: (initCall?: boolean) => Promise<boolean>;
  * rejects if unable to connect
  */
 export declare const init: (options?: InitOptions) => Promise<any>;
+/**
+ * Tests SSH port connectivity to a transfer server.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options options including the remote host, SSH port, and timeout.
+ *
+ * @returns a promise that resolves if the SSH port test is successful and rejects otherwise.
+ */
+export declare const testSshPorts: (options: TestSshPortsOptions) => Promise<any>;
+/**
+ * Authenticates a transfer specification against the remote server.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param transferSpec the transfer specification to authenticate.
+ *
+ * @returns a promise that resolves if authentication is successful and rejects otherwise.
+ */
+export declare const authenticate: (transferSpec: TransferSpec) => Promise<any>;
 /**
  * Start a transfer
  *
@@ -116,6 +136,16 @@ export declare const showSelectFileDialog: (options?: FileDialogOptions) => Prom
  * @returns a promise that resolves with the selected folder(s) and rejects if user cancels dialog
  */
 export declare const showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>;
+/**
+ * Displays a save file dialog for the user to choose a save location and filename.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options save file dialog options
+ *
+ * @returns a promise that resolves with the selected save path and rejects if user cancels dialog
+ */
+export declare const showSaveFileDialog: (options?: SaveFileDialogOptions) => Promise<DataTransferResponse>;
 /**
  * Shows the about page of the transfer client.
  *
@@ -138,6 +168,26 @@ export declare const showPreferences: () => Promise<any>;
  * @returns a promise that resolves when the transfer manager is opened.
  */
 export declare const showTransferManager: () => Promise<any>;
+/**
+ * Opens the preferences page of the transfer client to a specific tab.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options options including the page (tab) to open
+ *
+ * @returns a promise that resolves when the preferences page is opened.
+ */
+export declare const showPreferencesPage: (options: ShowPreferencesPageOptions) => Promise<any>;
+/**
+ * Opens the transfer rate monitor graph for a specific transfer.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param transferId the unique identifier of the transfer to monitor.
+ *
+ * @returns a promise that resolves when the transfer monitor is opened.
+ */
+export declare const showTransferMonitor: (transferId: string) => Promise<any>;
 /**
  * Get all transfers associated with the current application.
  *

package/dist/commonjs/app/core.js

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasCapability = exports.getCapabilities = exports.readDirectory = exports.getChecksum = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = exports.getFilesList = exports.getTransfer = exports.getAllTransfers = exports.showTransferManager = exports.showPreferences = exports.showAbout = 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;
+exports.hasCapability = exports.getCapabilities = exports.readDirectory = exports.getChecksum = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = exports.getFilesList = exports.getTransfer = exports.getAllTransfers = exports.showTransferMonitor = exports.showPreferencesPage = exports.showTransferManager = exports.showPreferences = exports.showAbout = exports.showSaveFileDialog = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.resumeTransfer = exports.stopTransfer = exports.removeTransfer = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.startTransfer = exports.authenticate = exports.testSshPorts = exports.init = exports.initDragDrop = exports.testConnection = void 0;
 var messages_1 = require("../constants/messages");
 var client_1 = require("../helpers/client/client");
 var helpers_1 = require("../helpers/helpers");
@@ -185,6 +185,70 @@ var init = function (options) {
     return ((_c = options === null || options === void 0 ? void 0 : options.connectSettings) === null || _c === void 0 ? void 0 : _c.useConnect) ? getConnectStartCalls() : getDesktopStartCalls();
 };
 exports.init = init;
+/**
+ * Tests SSH port connectivity to a transfer server.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options options including the remote host, SSH port, and timeout.
+ *
+ * @returns a promise that resolves if the SSH port test is successful and rejects otherwise.
+ */
+var testSshPorts = function (options) {
+    var _a, _b;
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.testSshPortsNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.testSshPorts(options);
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        remote_host: options.remote_host,
+        ssh_port: (_a = options.ssh_port) !== null && _a !== void 0 ? _a : 33001,
+        timeout_sec: (_b = options.timeout_sec) !== null && _b !== void 0 ? _b : 3,
+    };
+    client_1.client.request('test_ssh_ports', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.testSshPortsFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.testSshPortsFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.testSshPorts = testSshPorts;
+/**
+ * Authenticates a transfer specification against the remote server.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param transferSpec the transfer specification to authenticate.
+ *
+ * @returns a promise that resolves if authentication is successful and rejects otherwise.
+ */
+var authenticate = function (transferSpec) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.authenticateNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.authenticate(transferSpec);
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    client_1.client.request('authenticate', { transfer_spec: transferSpec })
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.authenticateFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.authenticateFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.authenticate = authenticate;
 /**
  * Start a transfer
  *
@@ -435,6 +499,44 @@ var showSelectFolderDialog = function (options) {
     return promiseInfo.promise;
 };
 exports.showSelectFolderDialog = showSelectFolderDialog;
+/**
+ * Displays a save file dialog for the user to choose a save location and filename.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options save file dialog options
+ *
+ * @returns a promise that resolves with the selected save path and rejects if user cancels dialog
+ */
+var showSaveFileDialog = function (options) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.showSaveFileDialogNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        var connectPromiseInfo_1 = (0, helpers_1.generatePromiseObjects)();
+        index_1.asperaSdk.globals.connect.showSaveFileDialog({
+            success: function (data) { return connectPromiseInfo_1.resolver(data); },
+            error: function (error) { return connectPromiseInfo_1.rejecter(error); },
+        }, options);
+        return connectPromiseInfo_1.promise;
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        options: options || {},
+        app_id: index_1.asperaSdk.globals.appId,
+    };
+    client_1.client.request('show_save_file_dialog', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.showSaveFileDialogFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.showSaveFileDialogFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.showSaveFileDialog = showSaveFileDialog;
 /**
  * Shows the about page of the transfer client.
  *
@@ -511,6 +613,78 @@ var showTransferManager = function () {
     return promiseInfo.promise;
 };
 exports.showTransferManager = showTransferManager;
+/**
+ * Maps consumer-facing preference page names to the page names supported by
+ * the IBM Aspera for desktop RPC server.
+ */
+var mapPreferencesPageForDesktop = function (page) {
+    switch (page) {
+        case 'network': return 'proxies';
+        case 'bandwidth': return 'transfers';
+        default: return page;
+    }
+};
+/**
+ * Opens the preferences page of the transfer client to a specific tab.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param options options including the page (tab) to open
+ *
+ * @returns a promise that resolves when the preferences page is opened.
+ */
+var showPreferencesPage = function (options) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.openPreferencesPageNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.showPreferencesPage(options);
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        tab: mapPreferencesPageForDesktop(options.page),
+    };
+    client_1.client.request('open_preferences', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.openPreferencesPageFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.openPreferencesPageFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.showPreferencesPage = showPreferencesPage;
+/**
+ * Opens the transfer rate monitor graph for a specific transfer.
+ *
+ * Supported for Connect and IBM Aspera for desktop. Not supported for HTTP Gateway.
+ *
+ * @param transferId the unique identifier of the transfer to monitor.
+ *
+ * @returns a promise that resolves when the transfer monitor is opened.
+ */
+var showTransferMonitor = function (transferId) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.showTransferMonitorNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.showTransferMonitor(transferId);
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    client_1.client.request('show_transfer_monitor', { transfer_id: transferId })
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.showTransferMonitorFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.showTransferMonitorFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.showTransferMonitor = showTransferMonitor;
 /**
  * Get all transfers associated with the current application.
  *
@@ -1017,7 +1191,7 @@ 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 === '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')) {
         return false;
     }
     // Reading directory contents is only supported by the Desktop App (not Connect).
@@ -1057,6 +1231,10 @@ var getCapabilities = function () {
         showAbout: supportsMethod('show_about'),
         showPreferences: supportsMethod('open_preferences'),
         showTransferManager: supportsMethod('show_transfer_manager'),
+        showTransferMonitor: supportsMethod('show_transfer_monitor'),
+        authenticate: supportsMethod('authenticate'),
+        testSshPorts: supportsMethod('test_ssh_ports'),
+        showSaveFileDialog: supportsMethod('show_save_file_dialog'),
         readDirectory: supportsMethod('read_directory'),
     };
 };

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

@@ -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/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, getTransfer, hasCapability, init, initDragDrop, 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, 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, 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.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; } });
@@ -49,6 +50,7 @@ Object.defineProperty(exports, "hasCapability", { enumerable: true, get: functio
 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, "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 +63,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 +80,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,8 +96,11 @@ 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;

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, 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';
@@ -201,12 +201,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 */

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;
@@ -938,6 +962,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.
      *