@ibm-aspera/sdk 0.2.30 → 0.4.12

package/README.md

@@ -1,7 +1,12 @@
 # IBM Aspera JavaScript SDK
-This JavaScript SDK allows web applications to integrate with `IBM Aspera for desktop` to perform high-speed Aspera file transfers.
+This JavaScript SDK allows web applications to integrate with Aspera transfer clients to perform high-speed Aspera file transfers.
 
-Documentation is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js/docs/)
+Supported transfer clients:
+- IBM Aspera for desktop
+- IBM Aspera HTTP Gateway
+- IBM Aspera Connect
+
+Example code is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js) with TypeDoc documentation [here](https://ibm.github.io/aspera-sdk-js/docs/).
 
 ## Installation
 Install via npm:
@@ -10,19 +15,18 @@ Install via npm:
 $ npm install --save @ibm-aspera/sdk
 ```
 
-Install from source:
+To include this SDK via `script` tag directly in your web application's HTML, refer to third-party CDNs such as jsDelivr:
 
-```shell
-$ git clone https://github.com/IBM/aspera-sdk-js.git
-$ cd aspera-sdk-js
-$ npm install
+```html
+<script src="https://cdn.jsdelivr.net/npm/@ibm-aspera/sdk@0.2.30/dist/js/aspera-sdk.js"></script>
 ```
 
-When installing from source, the `dist` directory includes a `js` directory that contains the bundled JavaScript SDK that can be included via `script` tag
-or copied to a web server for hosting.
+## Usage
+
+The full API of this SDK can be found [here](https://ibm.github.io/aspera-sdk-js/docs/) with many [code examples](https://github.com/IBM/aspera-sdk-js/blob/main/examples).
+
+Along with the examples, you can find an example test application [here](https://ibm.github.io/aspera-sdk-js/all).
 
-## Development
-To get started with development, take a look [here](https://github.com/IBM/aspera-sdk-js/blob/main/docs/DEVELOPMENT.md).
+## Migration from Connect SDK
 
-## Code Example and test application
-You can run the test appp by running `npm run start:example` which will launch the browser to the test app.
+Refer to [MIGRATION](MIGRATION.md) for recommended changes when migrating your web application from the Connect SDK (`@ibm-aspera/connect-sdk-js`).

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

@@ -1,5 +1,5 @@
 import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, TransferSpec, WebsocketEvent } from '../models/models';
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities } from '../models/models';
 import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
 /**
  * Check if IBM Aspera for Desktop connection works. This function is called by init
@@ -189,3 +189,46 @@ export declare const removeDropzone: (elementSelector: string) => void;
  * @returns a promise that returns information about the user's IBM Aspera installation.
  */
 export declare const getInfo: () => Promise<AsperaSdkInfo>;
+/**
+ * Read an entire file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum file size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ *
+ * @returns a promise that resolves with the file data as a base64-encoded string and mime type
+ */
+export declare const readAsArrayBuffer: (path: string) => Promise<ReadAsArrayBufferResponse>;
+/**
+ * Read a chunk of a file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum chunk size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns a promise that resolves with the file chunk data as a base64-encoded string and mime type
+ */
+export declare const readChunkAsArrayBuffer: (path: string, offset: number, chunkSize: number) => Promise<ReadChunkAsArrayBufferResponse>;
+/**
+ * Returns an object describing the high-level capabilities supported by the user's
+ * transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).
+ *
+ * Use this for feature detection at a semantic level rather than checking individual RPC methods.
+ * Capabitilies may depend on multiple underlying RPC methods and also may vary by transfer client.
+ *
+ * Some capabitilies may depend on newer versions of the transfer client. This function may be useful
+ * if you want to conditionally perform certain actions rather than potentially getting an error.
+ *
+ * @returns an object with boolean flags for each capability.
+ *
+ * @example
+ * // Conditionally render UI based on capabilities
+ * const caps = asperaSdk.getCapabilities();
+ * // Determine if your web application can render image previews for user selected files
+ * if (caps.imagePreview) {
+ *   asperaSdk.readAsArrayBuffer(path);
+ * }
+ */
+export declare const getCapabilities: () => SdkCapabilities;

package/dist/commonjs/app/core.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = 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.getCapabilities = exports.readChunkAsArrayBuffer = exports.readAsArrayBuffer = exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = 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;
 var messages_1 = require("../constants/messages");
 var client_1 = require("../helpers/client/client");
 var helpers_1 = require("../helpers/helpers");
@@ -28,6 +28,28 @@ var testConnection = function () {
     });
 };
 exports.testConnection = testConnection;
+/**
+ * RPC discovery used internally when initializing the SDK.
+ *
+ * @returns a promise that resolves if discovery is successful
+ */
+var rpcDiscover = function () {
+    if (index_1.asperaSdk.useConnect || index_1.asperaSdk.useHttpGateway) {
+        return Promise.resolve({ methods: [] });
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    return client_1.client.request('rpc.discover')
+        .then(function (data) {
+        index_1.asperaSdk.globals.rpcMethods = data.methods.map(function (m) { return m.name; });
+        return data;
+    })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.rpcDiscoverFailed, error);
+        return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.rpcDiscoverFailed, error));
+    });
+};
 /**
  * Initialize drag and drop. HTTP Gateway and Connect does not need to init.
  * Ignore if only HTTP Gateway
@@ -116,6 +138,7 @@ var init = function (options) {
     var getDesktopStartCalls = function () {
         return index_1.asperaSdk.activityTracking.setup()
             .then(function () { return (0, exports.testConnection)(); })
+            .then(function () { return rpcDiscover(); })
             .then(function () { return (0, exports.initDragDrop)(true); })
             .then(function () { return index_1.asperaSdk.globals.sdkResponseData; })
             .catch(handleErrors);
@@ -680,3 +703,110 @@ var getInfo = function () {
     });
 };
 exports.getInfo = getInfo;
+/**
+ * Read an entire file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum file size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ *
+ * @returns a promise that resolves with the file data as a base64-encoded string and mime type
+ */
+var readAsArrayBuffer = function (path) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpGatewayReadAsArrayBuffer)(path);
+    }
+    else if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.readAsArrayBuffer({ path: path });
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        request: {
+            path: path,
+        },
+        app_id: index_1.asperaSdk.globals.appId,
+    };
+    client_1.client.request('read_as_array_buffer', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.readAsArrayBufferFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.readAsArrayBufferFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.readAsArrayBuffer = readAsArrayBuffer;
+/**
+ * Read a chunk of a file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum chunk size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns a promise that resolves with the file chunk data as a base64-encoded string and mime type
+ */
+var readChunkAsArrayBuffer = function (path, offset, chunkSize) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpGatewayReadChunkAsArrayBuffer)(path, offset, chunkSize);
+    }
+    else if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.readChunkAsArrayBuffer({ path: path, offset: offset, chunkSize: chunkSize });
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        request: {
+            path: path,
+            offset: offset,
+            chunkSize: chunkSize,
+        },
+        app_id: index_1.asperaSdk.globals.appId,
+    };
+    client_1.client.request('read_chunk_as_array_buffer', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.readChunkAsArrayBufferFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.readChunkAsArrayBufferFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.readChunkAsArrayBuffer = readChunkAsArrayBuffer;
+var supportsMethod = function (method) {
+    // HTTP Gateway and Connect do not have any RPC methods so fallback to true
+    if (index_1.asperaSdk.useHttpGateway || index_1.asperaSdk.useConnect) {
+        return true;
+    }
+    return index_1.asperaSdk.globals.rpcMethods.includes(method);
+};
+/**
+ * Returns an object describing the high-level capabilities supported by the user's
+ * transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).
+ *
+ * Use this for feature detection at a semantic level rather than checking individual RPC methods.
+ * Capabitilies may depend on multiple underlying RPC methods and also may vary by transfer client.
+ *
+ * Some capabitilies may depend on newer versions of the transfer client. This function may be useful
+ * if you want to conditionally perform certain actions rather than potentially getting an error.
+ *
+ * @returns an object with boolean flags for each capability.
+ *
+ * @example
+ * // Conditionally render UI based on capabilities
+ * const caps = asperaSdk.getCapabilities();
+ * // Determine if your web application can render image previews for user selected files
+ * if (caps.imagePreview) {
+ *   asperaSdk.readAsArrayBuffer(path);
+ * }
+ */
+var getCapabilities = function () {
+    return {
+        imagePreview: supportsMethod('read_as_array_buffer') && supportsMethod('read_chunk_as_array_buffer'),
+    };
+};
+exports.getCapabilities = getCapabilities;

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

@@ -32,4 +32,7 @@ export declare const messages: {
     filePickerCancel: string;
     fileNotAllowed: string;
     httpNetworkFail: string;
+    readAsArrayBufferFailed: string;
+    readChunkAsArrayBufferFailed: string;
+    rpcDiscoverFailed: string;
 };

package/dist/commonjs/constants/messages.js

@@ -33,6 +33,9 @@ exports.messages = {
     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.',
-    fileNotAllowed: 'TransferSpec contained file not selected by user.',
+    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',
+    readChunkAsArrayBufferFailed: 'Unable to read file chunk as array buffer',
+    rpcDiscoverFailed: 'Unable to discover RPC endpoints',
 };

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

@@ -1,4 +1,4 @@
-import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer } from '../models/models';
+import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse } from '../models/models';
 /**
  * HTTP Gateway Core Logic
  * - File/Folder picking
@@ -74,3 +74,25 @@ export declare const getMessageFromError: (error: any) => {
     code: number;
 };
 export declare const base64Encoding: (jsonString: string) => string;
+/**
+ * Returns the specified file's contents as a base64-encoded string.
+ *
+ * Note: The maximum file size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ *
+ * @returns a promise that resolves with the file data as a base64-encoded string and mime type
+ */
+export declare const httpGatewayReadAsArrayBuffer: (path: string) => Promise<ReadAsArrayBufferResponse>;
+/**
+ * Read a chunk of a file as a base64-encoded string.
+ *
+ * Note: The maximum chunk size allowed is 50 MiB.
+ *
+ * @param path path to the file to read. For pure JS this will just be the filename.
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns a promise that resolves with the file chunk data as a base64-encoded string and mime type
+ */
+export declare const httpGatewayReadChunkAsArrayBuffer: (path: string, offset: number, chunkSize: number) => Promise<ReadChunkAsArrayBufferResponse>;

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

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.base64Encoding = exports.getMessageFromError = exports.sendTransferUpdate = exports.getSdkTransfer = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.createHtmlInputElement = exports.httpGetTransfer = exports.httpGetAllTransfers = exports.httpRemoveTransfer = void 0;
+exports.httpGatewayReadChunkAsArrayBuffer = exports.httpGatewayReadAsArrayBuffer = exports.base64Encoding = exports.getMessageFromError = exports.sendTransferUpdate = exports.getSdkTransfer = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.createHtmlInputElement = exports.httpGetTransfer = exports.httpGetAllTransfers = exports.httpRemoveTransfer = void 0;
 var messages_1 = require("../constants/messages");
 var helpers_1 = require("../helpers/helpers");
 var index_1 = require("../index");
 var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
+// 50MiB which matches the limits in Connect and IBM Aspera for desktop
+var MAX_FILE_SIZE = 50 * 1024 * 1024;
 /**
  * HTTP Gateway Core Logic
  * - File/Folder picking
@@ -150,7 +152,7 @@ var httpGatewaySelectFileFolderDialog = function (options, folder) {
         for (var i = 0; i < element.files.length; i++) {
             var file = element.files[i];
             returnFiles.push(file);
-            index_1.asperaSdk.httpGatewaySelectedFiles.set(file.name, file);
+            index_1.asperaSdk.httpGatewaySelectedFiles.set(file.webkitRelativePath || file.name, file);
         }
         resolver({
             dataTransfer: {
@@ -252,3 +254,135 @@ var base64Encoding = function (jsonString) {
     return btoa(binString);
 };
 exports.base64Encoding = base64Encoding;
+/**
+ * Attempt to read the specified `File` object contents as a base64-encoded string.
+ *
+ * @param file - File previously selected by the user
+ *
+ * @returns an object with base64 data and mime type
+ */
+var readFileAsBase64 = function (file) {
+    return new Promise(function (resolve, reject) {
+        var reader = new FileReader();
+        reader.onload = function (event) {
+            var _a;
+            try {
+                var dataUrl = (_a = event.target) === null || _a === void 0 ? void 0 : _a.result;
+                if (typeof dataUrl !== 'string') {
+                    reject((0, helpers_1.generateErrorBody)('FileReader did not return a data URL'));
+                    return;
+                }
+                // Remove `data:*/*;base64,` from the start of the data URL (https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL)
+                var base64 = dataUrl.split(';base64,')[1];
+                if (base64 === undefined) {
+                    reject((0, helpers_1.generateErrorBody)('Invalid data URL format'));
+                    return;
+                }
+                resolve({
+                    data: base64,
+                    type: file.type || 'application/octet-stream'
+                });
+            }
+            catch (err) {
+                reject((0, helpers_1.generateErrorBody)('Failed to process file data', err));
+            }
+        };
+        reader.onerror = function () {
+            reject((0, helpers_1.generateErrorBody)('Failed to read file', reader.error));
+        };
+        reader.readAsDataURL(file);
+    });
+};
+/**
+ * Returns the specified file's contents as a base64-encoded string.
+ *
+ * Note: The maximum file size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ *
+ * @returns a promise that resolves with the file data as a base64-encoded string and mime type
+ */
+var httpGatewayReadAsArrayBuffer = function (path) {
+    // Pre-condition: Caller must have previously selected file via `showSelectFileDialog()`
+    var file = index_1.asperaSdk.httpGatewaySelectedFiles.get(path);
+    if (!file) {
+        return (0, helpers_1.throwError)(messages_1.messages.fileNotAllowed);
+    }
+    if (file.size > MAX_FILE_SIZE) {
+        return (0, helpers_1.throwError)('File exceeds allowed maximum');
+    }
+    return readFileAsBase64(file);
+};
+exports.httpGatewayReadAsArrayBuffer = httpGatewayReadAsArrayBuffer;
+/**
+ * Attempt to read the specified `File` object contents as a base64-encoded string.
+ *
+ * @param file - File previously selected by the user
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns an object with base64 data and mime type
+ */
+var readFileChunkAsBase64 = function (file, offset, chunkSize) {
+    return new Promise(function (resolve, reject) {
+        if (offset > file.size) {
+            resolve({ data: '', type: file.type || 'application/octet-stream' });
+            return;
+        }
+        var chunk = file.slice(offset, offset + chunkSize);
+        var reader = new FileReader();
+        reader.onload = function (event) {
+            var _a;
+            try {
+                var dataUrl = (_a = event.target) === null || _a === void 0 ? void 0 : _a.result;
+                if (typeof dataUrl !== 'string') {
+                    reject((0, helpers_1.generateErrorBody)('FileReader did not return a data URL'));
+                    return;
+                }
+                // Remove `data:*/*;base64,` from the start of the data URL (https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL)
+                var base64 = dataUrl.split(';base64,')[1];
+                if (base64 === undefined) {
+                    reject((0, helpers_1.generateErrorBody)('Invalid data URL format'));
+                    return;
+                }
+                resolve({
+                    data: base64,
+                    type: file.type || 'application/octet-stream'
+                });
+            }
+            catch (err) {
+                reject((0, helpers_1.generateErrorBody)('Failed to process file data', err));
+            }
+        };
+        reader.onerror = function () {
+            reject((0, helpers_1.generateErrorBody)('Failed to read file', reader.error));
+        };
+        reader.readAsDataURL(chunk);
+    });
+};
+/**
+ * Read a chunk of a file as a base64-encoded string.
+ *
+ * Note: The maximum chunk size allowed is 50 MiB.
+ *
+ * @param path path to the file to read. For pure JS this will just be the filename.
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns a promise that resolves with the file chunk data as a base64-encoded string and mime type
+ */
+var httpGatewayReadChunkAsArrayBuffer = function (path, offset, chunkSize) {
+    if (offset < 0 || chunkSize <= 0) {
+        return (0, helpers_1.throwError)('Invalid offset or chunk size');
+    }
+    // Pre-condition: Caller must have previously selected file via `showSelectFileDialog()`
+    var file = index_1.asperaSdk.httpGatewaySelectedFiles.get(path);
+    if (!file) {
+        return (0, helpers_1.throwError)(messages_1.messages.fileNotAllowed);
+    }
+    if (chunkSize > MAX_FILE_SIZE) {
+        return (0, helpers_1.throwError)('Chunk size exceeds allowed maximum');
+    }
+    return readFileChunkAsBase64(file, offset, chunkSize);
+};
+exports.httpGatewayReadChunkAsArrayBuffer = httpGatewayReadChunkAsArrayBuffer;

package/dist/commonjs/index.d.ts

@@ -1,8 +1,12 @@
 import { AsperaSdk } from './models/aspera-sdk.model';
-import { createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getInfo, getTransfer, init, initDragDrop, modifyTransfer, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, showDirectory, showPreferences, showSelectFileDialog, showSelectFolderDialog, startTransfer, stopTransfer, testConnection } from './app/core';
+import { createDropzone, deregisterActivityCallback, deregisterStatusCallback, getAllTransfers, getCapabilities, getInfo, getTransfer, init, initDragDrop, modifyTransfer, readAsArrayBuffer, readChunkAsArrayBuffer, registerActivityCallback, registerStatusCallback, removeDropzone, removeTransfer, resumeTransfer, setBranding, 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, showSelectFileDialog, showSelectFolderDialog, showPreferences, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, getInstallerUrls, };
+export { isSafari, init, testConnection, startTransfer, launch, registerActivityCallback, deregisterActivityCallback, removeTransfer, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, showSelectFileDialog, showSelectFolderDialog, showPreferences, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, };
+export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, FileDialogOptions, FileFilter, FolderDialogOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, OverwritePolicy, 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';
+export type { HttpGatewayInfo } from './http-gateway/models';
 export default asperaSdk;

package/dist/commonjs/index.js

@@ -33,18 +33,21 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstallerUrls = 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.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.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.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;
 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; } });
 Object.defineProperty(exports, "deregisterActivityCallback", { enumerable: true, get: function () { return core_1.deregisterActivityCallback; } });
 Object.defineProperty(exports, "deregisterStatusCallback", { enumerable: true, get: function () { return core_1.deregisterStatusCallback; } });
 Object.defineProperty(exports, "getAllTransfers", { enumerable: true, get: function () { return core_1.getAllTransfers; } });
+Object.defineProperty(exports, "getCapabilities", { enumerable: true, get: function () { return core_1.getCapabilities; } });
 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, "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, "readAsArrayBuffer", { enumerable: true, get: function () { return core_1.readAsArrayBuffer; } });
+Object.defineProperty(exports, "readChunkAsArrayBuffer", { enumerable: true, get: function () { return core_1.readChunkAsArrayBuffer; } });
 Object.defineProperty(exports, "registerActivityCallback", { enumerable: true, get: function () { return core_1.registerActivityCallback; } });
 Object.defineProperty(exports, "registerStatusCallback", { enumerable: true, get: function () { return core_1.registerStatusCallback; } });
 Object.defineProperty(exports, "removeDropzone", { enumerable: true, get: function () { return core_1.removeDropzone; } });
@@ -88,8 +91,11 @@ exports.asperaSdk.deregisterStatusCallback = core_1.deregisterStatusCallback;
 exports.asperaSdk.initDragDrop = core_1.initDragDrop;
 exports.asperaSdk.setBranding = core_1.setBranding;
 exports.asperaSdk.getInfo = core_1.getInfo;
+exports.asperaSdk.readAsArrayBuffer = core_1.readAsArrayBuffer;
+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.httpGatewayCalls = httpGatewayCalls;
 var launch = exports.asperaSdk.globals.launch;
 exports.launch = launch;
@@ -97,4 +103,7 @@ exports.asperaSdk.launch = launch;
 if (typeof window === 'object') {
     window.asperaSdk = exports.asperaSdk;
 }
+var aspera_sdk_model_2 = require("./models/aspera-sdk.model");
+Object.defineProperty(exports, "AsperaSdk", { enumerable: true, get: function () { return aspera_sdk_model_2.AsperaSdk; } });
+Object.defineProperty(exports, "AsperaSdkGlobals", { enumerable: true, get: function () { return aspera_sdk_model_2.AsperaSdkGlobals; } });
 exports.default = exports.asperaSdk;

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

@@ -1,12 +1,14 @@
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo } from './models';
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities } 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';
-declare class AsperaSdkGlobals {
+export declare class AsperaSdkGlobals {
     /** The URL of the IBM Aspera HTTP server to use with the SDK */
     asperaAppUrl: string;
     /** The URL of the IBM Aspera Desktop HTTP server to use with the SDK */
     rpcPort: number;
+    /** The list of RPC methods supported by the running IBM Aspera for desktop application */
+    rpcMethods: string[];
     /** The default URL to check for latest Aspera installers */
     installerUrl: string;
     /** Aspera SDK info */
@@ -161,6 +163,7 @@ export declare class AsperaSdk {
     /** Global information about IBM Aspera */
     globals: AsperaSdkGlobals;
     /** Activity tracking for watching transfers */
+    /** @ignore */
     activityTracking: ActivityTracking;
     /** HTTP Gateway file store. Key is the file name. */
     httpGatewaySelectedFiles: Map<string, File>;
@@ -215,10 +218,22 @@ export declare class AsperaSdk {
     initDragDrop: () => Promise<any>;
     /** Function to get information about the IBM Aspera instance */
     getInfo: () => Promise<AsperaSdkInfo>;
+    /** Function to read an entire file as an array buffer (base64-encoded) */
+    readAsArrayBuffer: (path: string) => Promise<{
+        data: string;
+        type: string;
+    }>;
+    /** Function to read a chunk of a file as an array buffer (base64-encoded) */
+    readChunkAsArrayBuffer: (path: string, offset: number, chunkSize: number) => Promise<{
+        data: string;
+        type: string;
+    }>;
     /** Function to get whether IBM Aspera is running on Safari */
     isSafari: () => boolean;
     /** Function to get URLs for installer management. */
     getInstallerUrls: () => InstallerUrlInfo;
+    /** Function to get the SDK capabilities. */
+    getCapabilities: () => SdkCapabilities;
     /** Indicate if Safari Extension is enabled. If the extension is disabled during the lifecycle this will not update to disabled. */
     SAFARI_EXTENSION_STATUS: SafariExtensionEvent;
     /** Aspera HTTP Gateway calls. This normally is not needed by clients but expose just in case. */
@@ -242,4 +257,3 @@ export declare class AsperaSdk {
     /** Indicates if old HTTP Gateway SDK should be used (v2 and lower) */
     get useOldHttpGateway(): boolean;
 }
-export {};

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

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsperaSdk = exports.ActivityTracking = void 0;
+exports.AsperaSdk = exports.ActivityTracking = exports.AsperaSdkGlobals = void 0;
 var constants_1 = require("../constants/constants");
 var messages_1 = require("../constants/messages");
 var safari_client_1 = require("../helpers/client/safari-client");
@@ -25,6 +25,8 @@ var AsperaSdkGlobals = /** @class */ (function () {
         this.asperaAppUrl = 'http://127.0.0.1';
         /** The URL of the IBM Aspera Desktop HTTP server to use with the SDK */
         this.rpcPort = 33024;
+        /** The list of RPC methods supported by the running IBM Aspera for desktop application */
+        this.rpcMethods = [];
         /** The default URL to check for latest Aspera installers */
         this.installerUrl = constants_1.installerUrl;
         /** Indicate that the server has been verified as working */
@@ -79,6 +81,7 @@ var AsperaSdkGlobals = /** @class */ (function () {
     });
     return AsperaSdkGlobals;
 }());
+exports.AsperaSdkGlobals = AsperaSdkGlobals;
 var ActivityTracking = /** @class */ (function () {
     function ActivityTracking() {
         /** Map of callbacks that receive transfer update events */
@@ -283,6 +286,7 @@ var AsperaSdk = /** @class */ (function () {
         /** Global information about IBM Aspera */
         this.globals = new AsperaSdkGlobals();
         /** Activity tracking for watching transfers */
+        /** @ignore */
         this.activityTracking = new ActivityTracking();
         /** HTTP Gateway file store. Key is the file name. */
         this.httpGatewaySelectedFiles = new Map();