@ibm-aspera/sdk 0.7.4 → 0.9.0

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

@@ -116,6 +116,14 @@ 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>;
+/**
+ * Shows the about page of the transfer client.
+ *
+ * This is supported when using Connect or IBM Aspera for desktop, but not HTTP Gateway.
+ *
+ * @returns a promise that resolves when the about page is shown.
+ */
+export declare const showAbout: () => Promise<any>;
 /**
  * Opens the IBM Aspera preferences page.
  *
@@ -245,3 +253,22 @@ export declare const getChecksum: (options: GetChecksumOptions) => Promise<Check
  * }
  */
 export declare const getCapabilities: () => SdkCapabilities;
+/**
+ * Check if the SDK and underlying transfer client supports a specific capability.
+ *
+ * Capabilities depend on the transfer client being used (HTTP Gateway, Connect, or IBM Aspera for desktop).
+ * Use this function to conditionally enable/disable features in your application.
+ *
+ * @param capability the capability to check.
+ *
+ * @returns `true` if the capability is supported, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * // Determine if your web application can render image previews for user selected files
+ * if (asperaSdk.hasCapability('imagePreview')) {
+ *   asperaSdk.readAsArrayBuffer(path);
+ * }
+ * ```
+ */
+export declare const hasCapability: (capability: keyof SdkCapabilities) => boolean;

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.getCapabilities = 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.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.resumeTransfer = exports.stopTransfer = exports.removeTransfer = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.startTransfer = exports.init = exports.initDragDrop = exports.testConnection = void 0;
+exports.hasCapability = exports.getCapabilities = 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.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;
 var messages_1 = require("../constants/messages");
 var client_1 = require("../helpers/client/client");
 var helpers_1 = require("../helpers/helpers");
@@ -435,6 +435,33 @@ var showSelectFolderDialog = function (options) {
     return promiseInfo.promise;
 };
 exports.showSelectFolderDialog = showSelectFolderDialog;
+/**
+ * Shows the about page of the transfer client.
+ *
+ * This is supported when using Connect or IBM Aspera for desktop, but not HTTP Gateway.
+ *
+ * @returns a promise that resolves when the about page is shown.
+ */
+var showAbout = function () {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.showAboutNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.showAbout();
+    }
+    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_about')
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.showAboutFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.showAboutFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.showAbout = showAbout;
 /**
  * Opens the IBM Aspera preferences page.
  *
@@ -924,8 +951,9 @@ var getChecksum = function (options) {
 exports.getChecksum = getChecksum;
 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 direclty in the browser similar to how `readAsArrayBuffer()` is implemented.
-    if (index_1.asperaSdk.useHttpGateway && method === 'get_checksum') {
+    // 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')) {
         return false;
     }
     // HTTP Gateway and Connect do not have any RPC methods so fallback to true
@@ -958,6 +986,30 @@ var getCapabilities = function () {
     return {
         imagePreview: supportsMethod('read_as_array_buffer') && supportsMethod('read_chunk_as_array_buffer'),
         fileChecksum: supportsMethod('get_checksum'),
+        showAbout: supportsMethod('show_about'),
+        showPreferences: supportsMethod('open_preferences'),
     };
 };
 exports.getCapabilities = getCapabilities;
+/**
+ * Check if the SDK and underlying transfer client supports a specific capability.
+ *
+ * Capabilities depend on the transfer client being used (HTTP Gateway, Connect, or IBM Aspera for desktop).
+ * Use this function to conditionally enable/disable features in your application.
+ *
+ * @param capability the capability to check.
+ *
+ * @returns `true` if the capability is supported, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * // Determine if your web application can render image previews for user selected files
+ * if (asperaSdk.hasCapability('imagePreview')) {
+ *   asperaSdk.readAsArrayBuffer(path);
+ * }
+ * ```
+ */
+var hasCapability = function (capability) {
+    return !!(0, exports.getCapabilities)()[capability];
+};
+exports.hasCapability = hasCapability;

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

@@ -39,4 +39,6 @@ export declare const messages: {
     getFilesListFailed: string;
     getChecksumFailed: string;
     getChecksumNotSupported: string;
+    showAboutFailed: string;
+    showAboutNotSupported: string;
 };

package/dist/commonjs/constants/messages.js

@@ -42,4 +42,6 @@ exports.messages = {
     getFilesListFailed: 'Unable to get files list for transfer',
     getChecksumFailed: 'Unable to get file checksum',
     getChecksumNotSupported: 'File checksum not supported for current transfer client',
+    showAboutFailed: 'Unable to show about page',
+    showAboutNotSupported: 'Show about is not supported for current transfer client',
 };

package/dist/commonjs/index.d.ts

@@ -1,10 +1,10 @@
 import { AsperaSdk } from './models/aspera-sdk.model';
-import { createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getCapabilities, getChecksum, getFilesList, getInfo, getTransfer, init, initDragDrop, modifyTransfer, readAsArrayBuffer, readChunkAsArrayBuffer, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, showDirectory, showPreferences, showSelectFileDialog, showSelectFolderDialog, startTransfer, stopTransfer, testConnection } from './app/core';
+import { createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getCapabilities, getChecksum, getFilesList, getInfo, getTransfer, hasCapability, init, initDragDrop, modifyTransfer, readAsArrayBuffer, readChunkAsArrayBuffer, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, showAbout, showDirectory, showPreferences, showSelectFileDialog, showSelectFolderDialog, startTransfer, stopTransfer, testConnection } 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, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, getFilesList, showSelectFileDialog, showSelectFolderDialog, showPreferences, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, getChecksum, };
+export { isSafari, init, testConnection, startTransfer, launch, registerActivityCallback, deregisterActivityCallback, removeTransfer, showAbout, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, getFilesList, showSelectFileDialog, showSelectFolderDialog, showPreferences, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, hasCapability, getChecksum, };
 export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, DropzoneEventData, DropzoneEventType, DropzoneOptions, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, GetChecksumOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, OverwritePolicy, PaginatedFilesResponse, Pagination, Path, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse, ResumePolicy, ResumeTransferOptions, SafariExtensionEvent, SdkCapabilities, 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';

package/dist/commonjs/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsperaSdkGlobals = exports.AsperaSdk = exports.getChecksum = 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.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.getFilesList = exports.getTransfer = exports.getAllTransfers = exports.resumeTransfer = exports.stopTransfer = exports.showDirectory = 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.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.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;
 var aspera_sdk_model_1 = require("./models/aspera-sdk.model");
 var core_1 = require("./app/core");
 Object.defineProperty(exports, "createDropzone", { enumerable: true, get: function () { return core_1.createDropzone; } });
@@ -45,6 +45,7 @@ Object.defineProperty(exports, "getChecksum", { enumerable: true, get: function
 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, "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, "modifyTransfer", { enumerable: true, get: function () { return core_1.modifyTransfer; } });
@@ -56,6 +57,7 @@ Object.defineProperty(exports, "removeDropzone", { enumerable: true, get: functi
 Object.defineProperty(exports, "removeTransfer", { enumerable: true, get: function () { return core_1.removeTransfer; } });
 Object.defineProperty(exports, "resumeTransfer", { enumerable: true, get: function () { return core_1.resumeTransfer; } });
 Object.defineProperty(exports, "setBranding", { enumerable: true, get: function () { return core_1.setBranding; } });
+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, "showSelectFileDialog", { enumerable: true, get: function () { return core_1.showSelectFileDialog; } });
@@ -76,6 +78,7 @@ exports.asperaSdk.startTransfer = core_1.startTransfer;
 exports.asperaSdk.registerActivityCallback = core_1.registerActivityCallback;
 exports.asperaSdk.deregisterActivityCallback = core_1.deregisterActivityCallback;
 exports.asperaSdk.removeTransfer = core_1.removeTransfer;
+exports.asperaSdk.showAbout = core_1.showAbout;
 exports.asperaSdk.showDirectory = core_1.showDirectory;
 exports.asperaSdk.stopTransfer = core_1.stopTransfer;
 exports.asperaSdk.resumeTransfer = core_1.resumeTransfer;
@@ -99,6 +102,7 @@ exports.asperaSdk.readChunkAsArrayBuffer = core_1.readChunkAsArrayBuffer;
 exports.asperaSdk.isSafari = helpers_1.isSafari;
 exports.asperaSdk.getInstallerUrls = helpers_1.getInstallerUrls;
 exports.asperaSdk.getCapabilities = core_1.getCapabilities;
+exports.asperaSdk.hasCapability = core_1.hasCapability;
 exports.asperaSdk.getChecksum = core_1.getChecksum;
 exports.asperaSdk.httpGatewayCalls = httpGatewayCalls;
 var launch = exports.asperaSdk.globals.launch;

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

@@ -201,6 +201,8 @@ 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 show the about page of the transfer client */
+    showAbout: () => Promise<any>;
     /** Function to display the IBM Aspera preferences page */
     showPreferences: () => Promise<any>;
     /** Function to modify a running transfer */
@@ -235,6 +237,8 @@ export declare class AsperaSdk {
     getInstallerUrls: () => InstallerUrlInfo;
     /** Function to get the SDK capabilities. */
     getCapabilities: () => SdkCapabilities;
+    /** Function to check whether the SDK supports the specified capability */
+    hasCapability: (capability: keyof SdkCapabilities) => boolean;
     /** Function to get a checksum for a file */
     getChecksum: (options: GetChecksumOptions) => Promise<ChecksumFileResponse>;
     /** Indicate if Safari Extension is enabled. If the extension is disabled during the lifecycle this will not update to disabled. */

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

@@ -879,4 +879,18 @@ export interface SdkCapabilities {
      * Whether the SDK 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.
+     */
+    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.
+     */
+    showPreferences: boolean;
 }