@ibm-aspera/sdk 0.4.18 → 0.7.0

package/README.md

@@ -29,4 +29,4 @@ Along with the examples, you can find an example test application [here](https:/
 
 ## Migration from Connect SDK
 
-Refer to [MIGRATION](MIGRATION.md) for recommended changes when migrating your web application from the Connect SDK (`@ibm-aspera/connect-sdk-js`).
+Refer to [MIGRATION](https://github.com/IBM/aspera-sdk-js/blob/main/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, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities } from '../models/models';
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } 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
@@ -137,6 +137,15 @@ export declare const getAllTransfers: () => Promise<AsperaSdkTransfer[]>;
  * @returns a promise that resolves with the transfer.
  */
 export declare const getTransfer: (id: string) => Promise<AsperaSdkTransfer>;
+/**
+ * Get paginated file-level progress for a specific transfer.
+ *
+ * @param id transfer uuid
+ * @param pagination optional pagination options (limit and offset)
+ *
+ * @returns a promise that resolves with the paginated file progress list
+ */
+export declare const getFilesList: (id: string, pagination?: Pagination) => Promise<PaginatedFilesResponse>;
 /**
  * Opens and highlights the downloaded file in Finder or Windows Explorer. If multiple files,
  * then only the first file will be selected.
@@ -211,6 +220,14 @@ export declare const readAsArrayBuffer: (path: string) => Promise<ReadAsArrayBuf
  * @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>;
+/**
+ * Get a checksum of the specified chunk size of the file.
+ *
+ * @param options checksum options including path, offset, chunkSize, and checksumMethod
+ *
+ * @returns a promise that resolves with the checksum information
+ */
+export declare const getChecksum: (options: GetChecksumOptions) => Promise<ChecksumFileResponse>;
 /**
  * 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).

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.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;
+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;
 var messages_1 = require("../constants/messages");
 var client_1 = require("../helpers/client/client");
 var helpers_1 = require("../helpers/helpers");
@@ -316,6 +316,9 @@ exports.removeTransfer = removeTransfer;
  * @returns a promise that resolves if transfer is stopped and rejects if transfer cannot be stopped
  */
 var stopTransfer = function (id) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpStopTransfer)(id);
+    }
     if (index_1.asperaSdk.useConnect) {
         return index_1.asperaSdk.globals.connect.stopTransfer(id);
     }
@@ -527,6 +530,34 @@ var getTransfer = function (id) {
     return promiseInfo.promise;
 };
 exports.getTransfer = getTransfer;
+/**
+ * Get paginated file-level progress for a specific transfer.
+ *
+ * @param id transfer uuid
+ * @param pagination optional pagination options (limit and offset)
+ *
+ * @returns a promise that resolves with the paginated file progress list
+ */
+var getFilesList = function (id, pagination) {
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        transfer_id: id,
+    };
+    if (pagination) {
+        payload.pagination = pagination;
+    }
+    client_1.client.request('get_files_list', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.getFilesListFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.getFilesListFailed, error));
+    });
+    return promiseInfo.promise;
+};
+exports.getFilesList = getFilesList;
 /**
  * Opens and highlights the downloaded file in Finder or Windows Explorer. If multiple files,
  * then only the first file will be selected.
@@ -789,7 +820,48 @@ var readChunkAsArrayBuffer = function (path, offset, chunkSize) {
     return promiseInfo.promise;
 };
 exports.readChunkAsArrayBuffer = readChunkAsArrayBuffer;
+/**
+ * Get a checksum of the specified chunk size of the file.
+ *
+ * @param options checksum options including path, offset, chunkSize, and checksumMethod
+ *
+ * @returns a promise that resolves with the checksum information
+ */
+var getChecksum = function (options) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, helpers_1.throwError)(messages_1.messages.getChecksumNotSupported);
+    }
+    if (index_1.asperaSdk.useConnect) {
+        return index_1.asperaSdk.globals.connect.getChecksum(options);
+    }
+    if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
+    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
+    var payload = {
+        request: {
+            path: options.path,
+            offset: options.offset || 0,
+            chunkSize: options.chunkSize || 0,
+            checksumMethod: options.checksumMethod || 'md5',
+        },
+        app_id: index_1.asperaSdk.globals.appId,
+    };
+    client_1.client.request('get_checksum', payload)
+        .then(function (data) { return promiseInfo.resolver(data); })
+        .catch(function (error) {
+        (0, helpers_1.errorLog)(messages_1.messages.getChecksumFailed, error);
+        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.getChecksumFailed, error));
+    });
+    return promiseInfo.promise;
+};
+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') {
+        return false;
+    }
     // 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;
@@ -819,6 +891,7 @@ var supportsMethod = function (method) {
 var getCapabilities = function () {
     return {
         imagePreview: supportsMethod('read_as_array_buffer') && supportsMethod('read_chunk_as_array_buffer'),
+        fileChecksum: supportsMethod('get_checksum'),
     };
 };
 exports.getCapabilities = getCapabilities;

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

@@ -21,6 +21,7 @@ export declare const messages: {
     showSelectFolderDialogFailed: string;
     showPreferencesFailed: string;
     stopTransferFailed: string;
+    stopTransferFailedExternal: string;
     transferFailed: string;
     unableToFindElementOnPage: string;
     unableToReadDropped: string;
@@ -35,4 +36,7 @@ export declare const messages: {
     readAsArrayBufferFailed: string;
     readChunkAsArrayBufferFailed: string;
     rpcDiscoverFailed: string;
+    getFilesListFailed: string;
+    getChecksumFailed: string;
+    getChecksumNotSupported: string;
 };

package/dist/commonjs/constants/messages.js

@@ -24,6 +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',
     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',
@@ -38,4 +39,7 @@ exports.messages = {
     readAsArrayBufferFailed: 'Unable to read file as array buffer',
     readChunkAsArrayBufferFailed: 'Unable to read file chunk as array buffer',
     rpcDiscoverFailed: 'Unable to discover RPC endpoints',
+    getFilesListFailed: 'Unable to get files list for transfer',
+    getChecksumFailed: 'Unable to get file checksum',
+    getChecksumNotSupported: 'File checksum not supported for current transfer client',
 };

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

@@ -25,6 +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>;
+/**
+ * Stop an in-progress HTTP Gateway transfer.
+ * Aborts the underlying HTTP request and sets the transfer status to 'canceled'.
+ *
+ * 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.
+ *
+ * @param id - ID of the transfer
+ *
+ * @returns Promise indicating success
+ */
+export declare const httpStopTransfer: (id: string) => Promise<void>;
 /**
  * Remove a transfer from HTTP Gateway systems
  * @param id - ID of the transfer

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.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.initHttpGateway = exports.sendTransferUpdate = void 0;
 var messages_1 = require("../constants/messages");
 var helpers_1 = require("../helpers/helpers");
 var index_1 = require("../index");
@@ -41,6 +41,8 @@ exports.sendTransferUpdate = sendTransferUpdate;
 var initHttpGateway = function (response) {
     index_1.asperaSdk.globals.httpGatewayInfo = response;
     index_1.asperaSdk.globals.httpGatewayVerified = true;
+    var majorVersion = Number(response.version.split('.')[0] || 3);
+    index_1.asperaSdk.globals.httpGatewayRoutePrefix = majorVersion >= 3 ? '/v3' : '';
     if (index_1.asperaSdk.useOldHttpGateway) {
         // Watch for old HTTP Gateway transfers in case used.
         (0, http_gateway_sdk_js_1.registerActivityCallback)(function (oldHttpTransfers) {
@@ -58,6 +60,39 @@ var initHttpGateway = function (response) {
     return Promise.resolve();
 };
 exports.initHttpGateway = initHttpGateway;
+/**
+ * Stop an in-progress HTTP Gateway transfer.
+ * Aborts the underlying HTTP request and sets the transfer status to 'canceled'.
+ *
+ * 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.
+ *
+ * @param id - ID of the transfer
+ *
+ * @returns Promise indicating success
+ */
+var httpStopTransfer = function (id) {
+    if (index_1.asperaSdk.useOldHttpGateway) {
+        (0, http_gateway_sdk_js_1.cancelTransfer)(id);
+        return Promise.resolve();
+    }
+    var transfer = index_1.asperaSdk.httpGatewayTransferStore.get(id);
+    if (!transfer) {
+        return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.stopTransferFailed, { reason: 'Not found' }));
+    }
+    else if (transfer.httpDownloadExternalHandle) {
+        return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.stopTransferFailedExternal, { reason: 'External handle' }));
+    }
+    transfer.status = 'canceled';
+    var request = index_1.asperaSdk.httpGatewayRequestStore.get(id);
+    if (request) {
+        request.abort();
+        index_1.asperaSdk.httpGatewayRequestStore.delete(id);
+    }
+    (0, exports.sendTransferUpdate)(transfer);
+    return Promise.resolve();
+};
+exports.httpStopTransfer = httpStopTransfer;
 /**
  * Remove a transfer from HTTP Gateway systems
  * @param id - ID of the transfer
@@ -69,14 +104,18 @@ var httpRemoveTransfer = function (id) {
         (0, http_gateway_sdk_js_1.removeTransfer)(id);
         return Promise.resolve({ removed: true });
     }
-    var transfer = index_1.asperaSdk.httpGatewayTransferStore.get(id);
-    if (transfer) {
+    /* Cancel the transfer before removing it.
+     *
+     * Note: This is slightly different from the behavior in the v2 JS SDK. When removing
+     * a transfer, v2 will NOT cancel it beforehand. In the desktop and Connect transfer clients,
+     * removing a transfer also stops it, so we do the same here for HTTP Gateway v3.
+     */
+    return (0, exports.httpStopTransfer)(id)
+        .catch(function () { })
+        .then(function () {
         index_1.asperaSdk.httpGatewayTransferStore.delete(id);
-        return Promise.resolve({ removed: true });
-    }
-    else {
-        return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.removeTransferFailed, { reason: 'Not found' }));
-    }
+        return { removed: true };
+    });
 };
 exports.httpRemoveTransfer = httpRemoveTransfer;
 /**

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

@@ -31,6 +31,7 @@ var httpDownloadPresigned = function (transferSpec, asperaSdkSpec) {
         (0, core_1.sendTransferUpdate)(transferObject);
     };
     var url = new URL((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_override_server_url) || index_1.asperaSdk.globals.httpGatewayUrl);
+    var baseUrl = (url.origin + url.pathname).replace(/\/+$/, '');
     var headers = {
         'Content-Type': 'application/json',
         accept: 'application/json',
@@ -40,7 +41,7 @@ var httpDownloadPresigned = function (transferSpec, asperaSdkSpec) {
         headers['X-Aspera-AccessKey'] = asperaSdkSpec.http_gateway_authentication.access_key;
     }
     var protocol = url.protocol === 'https:' ? 'https' : 'http';
-    return fetch("".concat(url.toString(), "/presign"), {
+    return fetch("".concat(baseUrl).concat(index_1.asperaSdk.globals.httpGatewayRoutePrefix, "/presign"), {
         method: 'POST',
         headers: headers,
         body: (0, helpers_1.safeJsonString)({
@@ -108,7 +109,7 @@ var httpDownloadInBrowser = function (transferSpec, asperaSdkSpec) {
         headers['Authorization'] = "Bearer ".concat(asperaSdkSpec.http_gateway_authentication.token);
         headers['X-Aspera-AccessKey'] = asperaSdkSpec.http_gateway_authentication.access_key;
     }
-    fetch("".concat((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_override_server_url) || index_1.asperaSdk.globals.httpGatewayUrl, "/download"), { method: 'GET', headers: headers }).then(function (data) {
+    fetch("".concat((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_override_server_url) || index_1.asperaSdk.globals.httpGatewayUrl).concat(index_1.asperaSdk.globals.httpGatewayRoutePrefix, "/download"), { method: 'GET', headers: headers }).then(function (data) {
         var responseHeaders = data.headers;
         transferObject.httpRequestId = responseHeaders.get('X-Request-Id');
         var chunks = [];

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

@@ -44,20 +44,25 @@ var httpUpload = function (transferSpec, asperaSdkSpec) {
         return (0, helpers_1.throwError)(messages_1.messages.fileNotAllowed, { type: 'upload', invalidFiles: hasBadFile, transferSpec: transferSpec });
     }
     var transferObject = (0, core_1.getSdkTransfer)(transferSpec);
+    index_1.asperaSdk.httpGatewayRequestStore.set(transferObject.uuid, request);
     if (asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_authentication) {
         request.setRequestHeader('Authorization', "Bearer ".concat(asperaSdkSpec.http_gateway_authentication.token));
         request.setRequestHeader('X-Aspera-AccessKey', asperaSdkSpec.http_gateway_authentication.access_key);
     }
-    request.open('POST', "".concat((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_override_server_url) || index_1.asperaSdk.globals.httpGatewayUrl, "/upload"), true);
+    request.open('POST', "".concat((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_override_server_url) || index_1.asperaSdk.globals.httpGatewayUrl).concat(index_1.asperaSdk.globals.httpGatewayRoutePrefix, "/upload"), true);
     var triggerUpdate = function () {
         (0, core_1.sendTransferUpdate)(transferObject);
     };
     var triggerFailed = function () {
+        if (transferObject.status === 'canceled') {
+            return;
+        }
         var errorData = (0, core_1.getMessageFromError)(request.response);
         transferObject.httpRequestId = request.getResponseHeader('X-Request-Id');
         transferObject.status = 'failed';
         transferObject.error_code = errorData.code;
         transferObject.error_desc = errorData.message;
+        index_1.asperaSdk.httpGatewayRequestStore.delete(transferObject.uuid);
         triggerUpdate();
     };
     request.upload.addEventListener('progress', function (event) {
@@ -87,6 +92,7 @@ var httpUpload = function (transferSpec, asperaSdkSpec) {
             transferObject.bytes_written = event.loaded;
             transferObject.percentage = (event.loaded / event.total);
         }
+        index_1.asperaSdk.httpGatewayRequestStore.delete(transferObject.uuid);
         triggerUpdate();
     });
     request.upload.addEventListener('loadstart', function () {

package/dist/commonjs/index.d.ts

@@ -1,11 +1,11 @@
 import { AsperaSdk } from './models/aspera-sdk.model';
-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 { 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 { 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, 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 { 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 type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, 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';
 export type { HttpGatewayInfo } from './http-gateway/models';

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.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;
+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;
 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; } });
@@ -41,6 +41,8 @@ Object.defineProperty(exports, "deregisterActivityCallback", { enumerable: true,
 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, "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, "getTransfer", { enumerable: true, get: function () { return core_1.getTransfer; } });
 Object.defineProperty(exports, "init", { enumerable: true, get: function () { return core_1.init; } });
@@ -79,6 +81,7 @@ exports.asperaSdk.stopTransfer = core_1.stopTransfer;
 exports.asperaSdk.resumeTransfer = core_1.resumeTransfer;
 exports.asperaSdk.getAllTransfers = core_1.getAllTransfers;
 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.showPreferences = core_1.showPreferences;
@@ -96,6 +99,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.getChecksum = core_1.getChecksum;
 exports.asperaSdk.httpGatewayCalls = httpGatewayCalls;
 var launch = exports.asperaSdk.globals.launch;
 exports.launch = launch;

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

@@ -1,4 +1,4 @@
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities } from './models';
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } 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';
@@ -28,6 +28,8 @@ export declare class AsperaSdkGlobals {
     }[]>;
     /** HTTP Gateway URL after successful passing */
     httpGatewayUrl?: string;
+    /** Version-based route prefix for HTTP Gateway API endpoints (e.g. "/v3" for v3+, "" for v2) */
+    httpGatewayRoutePrefix: string;
     /** Indicate that the HTTP Gateway has been verified as working */
     httpGatewayVerified: boolean;
     /** HTTP Gateway info */
@@ -216,6 +218,8 @@ export declare class AsperaSdk {
     getInstallerInfo: (options: InstallerOptions) => Promise<InstallerInfoResponse>;
     /** Initialize drag and drop */
     initDragDrop: () => Promise<any>;
+    /** Function to get paginated file-level progress for a transfer */
+    getFilesList: (transferId: string, pagination?: Pagination) => Promise<PaginatedFilesResponse>;
     /** Function to get information about the IBM Aspera instance */
     getInfo: () => Promise<AsperaSdkInfo>;
     /** Function to read an entire file as an array buffer (base64-encoded) */
@@ -234,12 +238,16 @@ export declare class AsperaSdk {
     getInstallerUrls: () => InstallerUrlInfo;
     /** Function to get the SDK capabilities. */
     getCapabilities: () => SdkCapabilities;
+    /** 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. */
     SAFARI_EXTENSION_STATUS: SafariExtensionEvent;
     /** Aspera HTTP Gateway calls. This normally is not needed by clients but expose just in case. */
     httpGatewayCalls: unknown;
     /** Store of HTTP Gateway transfers */
     httpGatewayTransferStore: Map<string, AsperaSdkTransfer>;
+    /** Store of active HTTP Gateway XMLHttpRequests for cancellation. Key is transfer UUID. */
+    httpGatewayRequestStore: Map<string, XMLHttpRequest>;
     /** HTTP Gateway in app threshold limit. This can be changed globally for the app. */
     httpGatewayInBrowserDownloadThreshold: number;
     /**

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

@@ -35,6 +35,8 @@ var AsperaSdkGlobals = /** @class */ (function () {
         this.supportMultipleUsers = false;
         /** Map of drop zones created by querySelector */
         this.dropZonesCreated = new Map();
+        /** Version-based route prefix for HTTP Gateway API endpoints (e.g. "/v3" for v3+, "" for v2) */
+        this.httpGatewayRoutePrefix = '';
         /** Indicate that the HTTP Gateway has been verified as working */
         this.httpGatewayVerified = false;
         /** Connect status */
@@ -297,6 +299,8 @@ var AsperaSdk = /** @class */ (function () {
         this.SAFARI_EXTENSION_STATUS = 'DISABLED';
         /** Store of HTTP Gateway transfers */
         this.httpGatewayTransferStore = new Map();
+        /** Store of active HTTP Gateway XMLHttpRequests for cancellation. Key is transfer UUID. */
+        this.httpGatewayRequestStore = new Map();
         /** HTTP Gateway in app threshold limit. This can be changed globally for the app. */
         this.httpGatewayInBrowserDownloadThreshold = 1000000000;
     }

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

@@ -96,6 +96,24 @@ export interface ReadChunkAsArrayBufferResponse {
     /** Mime type of the file */
     type: string;
 }
+/** Request to get a file checksum */
+export interface GetChecksumOptions {
+    /** Absolute path to the file */
+    path: string;
+    /** Byte offset to start reading from. Default: 0 */
+    offset?: number;
+    /** Number of bytes to read. If 0, read entire file from offset to end. Default: 0 */
+    chunkSize?: number;
+    /** Hash algorithm to use. Default: 'md5' */
+    checksumMethod?: 'md5' | 'sha1' | 'sha256' | 'sha512';
+}
+/** Response containing file checksum information */
+export interface ChecksumFileResponse {
+    /** Hexadecimal string representation of the computed hash */
+    checksum: string;
+    /** The algorithm used */
+    checksumMethod: 'md5' | 'sha1' | 'sha256' | 'sha512';
+}
 export interface ModifyTransferOptions {
     /**
      * @deprecated Use `lock_min_rate_kbps` instead.
@@ -445,6 +463,48 @@ export interface TransferSpec {
     use_ascp4?: boolean;
 }
 export type TransferStatus = 'failed' | 'completed' | 'running' | 'queued' | 'removed' | 'canceled' | 'orphaned' | 'paused';
+/** Pagination options for paginated API requests. */
+export interface Pagination {
+    /** Maximum number of entries to return. (Default: 1000) */
+    limit?: number;
+    /** Number of entries to skip from the beginning. (Default: 0) */
+    offset?: number;
+}
+/** Paginated response containing file-level transfer progress. */
+export interface PaginatedFilesResponse {
+    /** The file entries for this page. */
+    entries: FileStat[];
+    /** Total number of files in the transfer. */
+    total_count: number;
+    /** The limit used for the request. */
+    limit: number;
+    /** The offset used for the request. */
+    offset: number;
+}
+/** Status of an individual file within a transfer. */
+export type FileStatus = 'failed' | 'skipped' | 'finished' | 'running';
+/** Error information for a file that failed to transfer. */
+export interface FileError {
+    /** Error code */
+    code: number;
+    /** Human-readable error description */
+    description: string;
+}
+/** Progress information for an individual file within a transfer. */
+export interface FileStat {
+    /** The file path */
+    file: string;
+    /** Number of bytes written for this file */
+    bytes_written: number;
+    /** Number of bytes expected for this file */
+    bytes_expected: number;
+    /** Time elapsed in microseconds for this file */
+    elapsed_usec: number;
+    /** Error information if the file failed */
+    error?: FileError;
+    /** Status of this file */
+    status: FileStatus;
+}
 export interface AsperaSdkTransfer {
     /** The ID of the transfer */
     uuid: string;
@@ -762,4 +822,8 @@ export interface SdkCapabilities {
      * with the required RPC methods.
     */
     imagePreview: boolean;
+    /**
+     * Whether the SDK can calculate checksums of a file chunk.
+     */
+    fileChecksum: boolean;
 }