@ibm-aspera/sdk 0.4.16 → 0.5.0

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 } 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.

package/dist/commonjs/app/core.js

@@ -1,6 +1,17 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    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.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");
@@ -190,6 +201,17 @@ var startTransfer = function (transferSpec, asperaSdkSpec) {
         return transferSpec.direction === 'receive' ? (0, http_gateway_1.httpDownload)(transferSpec, asperaSdkSpec) : (0, http_gateway_1.httpUpload)(transferSpec, asperaSdkSpec);
     }
     else if (index_1.asperaSdk.useConnect) {
+        /**
+         * There is a bug in the Connect transfer client where Connect's HTTP server will no longer return ANY responses if a dialog was opened
+         * when starting the transfer (ex: request or file overwrite confirmation).
+         */
+        if ((asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.allow_dialogs) !== false) {
+            console.warn('[Aspera SDK] `allow_dialogs` was not set to `false` in AsperaSdkSpec and has been overridden. ' +
+                'Connect dialogs block all subsequent HTTP responses. ' +
+                'Set `allow_dialogs: false` explicitly to suppress this warning. ' +
+                'More info: https://github.com/IBM/aspera-sdk-js/issues/196');
+            asperaSdkSpec = __assign(__assign({}, asperaSdkSpec), { allow_dialogs: false });
+        }
         return index_1.asperaSdk.globals.connect.startTransferPromise(transferSpec, asperaSdkSpec).then(function (response) {
             return response.transfer_specs[0];
         });
@@ -505,6 +527,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.

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

@@ -35,4 +35,5 @@ export declare const messages: {
     readAsArrayBufferFailed: string;
     readChunkAsArrayBufferFailed: string;
     rpcDiscoverFailed: string;
+    getFilesListFailed: string;
 };

package/dist/commonjs/constants/messages.js

@@ -38,4 +38,5 @@ 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',
 };

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, 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, };
+export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, 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.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,7 @@ 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, "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 +80,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;

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 } 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';
@@ -89,9 +89,9 @@ export declare class ActivityTracking {
     /** Keep track of the last notified WebSocket event **/
     private lastNotifiedWebSocketEvent;
     /**
-     * Notify all consumers when a message is received from the websocket
+     * Notify all consumers when a message is received from the transfer client.
      *
-     * @param message the message received from the websocket
+     * @param message the message received
      */
     handleTransferActivity(message: ActivityMessage): void;
     /**
@@ -216,6 +216,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) */

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

@@ -94,15 +94,18 @@ var ActivityTracking = /** @class */ (function () {
         this.lastNotifiedWebSocketEvent = undefined;
     }
     /**
-     * Notify all consumers when a message is received from the websocket
+     * Notify all consumers when a message is received from the transfer client.
      *
-     * @param message the message received from the websocket
+     * @param message the message received
      */
     ActivityTracking.prototype.handleTransferActivity = function (message) {
+        var data = message.data && typeof message.data === 'object' && 'transfers' in message.data
+            ? message.data
+            : { transfers: [message.data] };
         if (message.type === 'transferUpdated' || message.type === 'transferRemoved') {
             this.activity_callbacks.forEach(function (callback) {
                 if (typeof callback === 'function') {
-                    callback(message.data);
+                    callback(data);
                 }
             });
         }

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

@@ -445,6 +445,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;