@ibm-aspera/sdk 0.2.9 → 0.2.29

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

@@ -1,76 +0,0 @@
-import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer } from '../models/models';
-/**
- * HTTP Gateway Core Logic
- * - File/Folder picking
- * - Starting and testing
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-/**
- * Remove a transfer from HTTP Gateway systems
- * @param id - ID of the transfer
- *
- * @returns Promise indicating success
- */
-export declare const httpRemoveTransfer: (id: string) => Promise<any>;
-/**
- * Get the list of http gateway transfers
- *
- * @returns list of HTTP Gateway
- */
-export declare const httpGetAllTransfers: () => AsperaSdkTransfer[];
-/**
- * Get a HTTP Gateway transfer by ID
- *
- * @returns a transfer or null
- */
-export declare const httpGetTransfer: (id: string) => AsperaSdkTransfer | null;
-/**
- * Create HTML input element for file picking
- */
-export declare const createHtmlInputElement: () => HTMLInputElement;
-/**
- * Handle drop events and store files for HTTP Gateway
- * This works on top of desktop.
- */
-export declare const handleHttpGatewayDrop: (items: DataTransferItemList, callback: (data: {
-    event: DragEvent;
-    files: DataTransferResponse;
-}) => void, event: DragEvent) => void;
-/**
- * Open native browser file or folder picker for files
- *
- * @param options - File picker options
- * @param folder - Indicate if choosing folders
- *
- * @returns Promise that resolves with info about the files picked
- */
-export declare const httpGatewaySelectFileFolderDialog: (options?: FileDialogOptions, folder?: boolean) => Promise<DataTransferResponse>;
-/**
- * Get a generic transfer object for HTTP Gateway transfers.
- *
- * @param transferSpec - TransferSpec being provided for the HTTP Gateway transfer
- *
- * @returns a transfer object to track status and send to consumers
- */
-export declare const getSdkTransfer: (transferSpec: TransferSpec) => AsperaSdkTransfer;
-/**
- * Send a transfer update through the SDK
- *
- * @param transfer - Transsfer object to send to consumers
- */
-export declare const sendTransferUpdate: (transfer: AsperaSdkTransfer) => void;
-/**
- * Try to parse and get a useful string from API calls for HTTP Gateway
- *
- * @param error - Error from API call for Gateway
- *
- * @returns a string to use for errors
- */
-export declare const getMessageFromError: (error: any) => {
-    message: string;
-    code: number;
-};
-export declare const base64Encoding: (jsonString: string) => string;

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

@@ -1,254 +0,0 @@
-"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;
-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");
-/**
- * HTTP Gateway Core Logic
- * - File/Folder picking
- * - Starting and testing
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-/**
- * Remove a transfer from HTTP Gateway systems
- * @param id - ID of the transfer
- *
- * @returns Promise indicating success
- */
-var httpRemoveTransfer = function (id) {
-    if (index_1.asperaSdk.useOldHttpGateway) {
-        (0, http_gateway_sdk_js_1.removeTransfer)(id);
-        return Promise.resolve({ removed: true });
-    }
-    var transfer = index_1.asperaSdk.httpGatewayTransferStore.get(id);
-    if (transfer) {
-        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' }));
-    }
-};
-exports.httpRemoveTransfer = httpRemoveTransfer;
-/**
- * Get the list of http gateway transfers
- *
- * @returns list of HTTP Gateway
- */
-var httpGetAllTransfers = function () {
-    if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.getAllTransfers)().transfers;
-    }
-    return Array.from(index_1.asperaSdk.httpGatewayTransferStore.values());
-};
-exports.httpGetAllTransfers = httpGetAllTransfers;
-/**
- * Get a HTTP Gateway transfer by ID
- *
- * @returns a transfer or null
- */
-var httpGetTransfer = function (id) {
-    if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.getTransferById)(id);
-    }
-    return index_1.asperaSdk.httpGatewayTransferStore.get(id);
-};
-exports.httpGetTransfer = httpGetTransfer;
-/**
- * Create HTML input element for file picking
- */
-var createHtmlInputElement = function () {
-    var element = window.document.createElement('input');
-    element.type = 'file';
-    element.style = 'display: none;';
-    window.document.body.appendChild(element);
-    return element;
-};
-exports.createHtmlInputElement = createHtmlInputElement;
-/**
- * Handle drop events and store files for HTTP Gateway
- * This works on top of desktop.
- */
-var handleHttpGatewayDrop = function (items, callback, event) {
-    var files = [];
-    var callbackCount = 0;
-    var callbackFinishCount = 0;
-    var finalCallback = function () {
-        if (callbackFinishCount >= callbackCount) {
-            var finalFiles = files.map(function (file) {
-                index_1.asperaSdk.httpGatewaySelectedFiles.set(file.name, file);
-                return {
-                    lastModified: file.lastModified,
-                    name: file.name,
-                    size: file.size,
-                    type: file.type
-                };
-            });
-            callback({ event: event, files: { dataTransfer: { files: finalFiles } } });
-        }
-    };
-    var traverse = function (item) {
-        if (item.isFile) {
-            item.file(function (file) {
-                files.push(file);
-                callbackFinishCount++;
-                finalCallback();
-            });
-        }
-        else if (item.isDirectory) {
-            var dirReader = item.createReader();
-            dirReader.readEntries(function (entries) {
-                for (var k = 0; k < entries.length; k++) {
-                    callbackCount++;
-                    traverse(entries[k]);
-                }
-            });
-            callbackFinishCount++;
-        }
-        else {
-            callbackFinishCount++;
-            finalCallback();
-        }
-    };
-    for (var i = 0; i < items.length; i++) {
-        var item = items[i].webkitGetAsEntry();
-        if (item) {
-            callbackCount++;
-            traverse(item);
-        }
-    }
-};
-exports.handleHttpGatewayDrop = handleHttpGatewayDrop;
-/**
- * Open native browser file or folder picker for files
- *
- * @param options - File picker options
- * @param folder - Indicate if choosing folders
- *
- * @returns Promise that resolves with info about the files picked
- */
-var httpGatewaySelectFileFolderDialog = function (options, folder) {
-    if (index_1.asperaSdk.useOldHttpGateway) {
-        return (folder ? (0, http_gateway_sdk_js_1.getFoldersForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || '') : (0, http_gateway_sdk_js_1.getFilesForUploadPromise)((options === null || options === void 0 ? void 0 : options.http_gateway_v2_transfer_id) || ''));
-    }
-    var _a = (0, helpers_1.generatePromiseObjects)(), promise = _a.promise, rejecter = _a.rejecter, resolver = _a.resolver;
-    var element = (0, exports.createHtmlInputElement)();
-    element.multiple = !!(options === null || options === void 0 ? void 0 : options.multiple);
-    if (folder) {
-        element.webkitdirectory = true;
-    }
-    element.oncancel = function () {
-        rejecter({ debugData: { code: -32002, message: messages_1.messages.filePickerCancel } });
-    };
-    element.onchange = function () {
-        var returnFiles = [];
-        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);
-        }
-        resolver({
-            dataTransfer: {
-                files: returnFiles.map(function (file) {
-                    return {
-                        size: file.size,
-                        lastModified: file.lastModified,
-                        name: file.webkitRelativePath || file.name,
-                        type: file.type,
-                    };
-                })
-            }
-        });
-    };
-    element.click();
-    return promise;
-};
-exports.httpGatewaySelectFileFolderDialog = httpGatewaySelectFileFolderDialog;
-/**
- * Get a generic transfer object for HTTP Gateway transfers.
- *
- * @param transferSpec - TransferSpec being provided for the HTTP Gateway transfer
- *
- * @returns a transfer object to track status and send to consumers
- */
-var getSdkTransfer = function (transferSpec) {
-    return {
-        uuid: (0, helpers_1.randomUUID)(),
-        transfer_spec: transferSpec,
-        current_file: '',
-        add_time: new Date().toISOString(),
-        file_counts: {
-            attempted: 0,
-            completed: 0,
-            failed: 0,
-            skipped: 0,
-        },
-        end_time: '',
-        explorer_path: '',
-        status: 'queued',
-        bytes_written: 0,
-        bytes_expected: 0,
-        calculated_rate_kbps: 0,
-        elapsed_usec: 0,
-        percentage: 0,
-        title: '',
-        remaining_usec: 0,
-        httpGatewayTransfer: true,
-        httpDownloadExternalHandle: false,
-    };
-};
-exports.getSdkTransfer = getSdkTransfer;
-/**
- * Send a transfer update through the SDK
- *
- * @param transfer - Transsfer object to send to consumers
- */
-var sendTransferUpdate = function (transfer) {
-    index_1.asperaSdk.httpGatewayTransferStore.set(transfer.uuid, transfer);
-    index_1.asperaSdk.activityTracking.handleTransferActivity({
-        type: 'transferUpdated',
-        data: { transfers: [transfer] },
-    });
-};
-exports.sendTransferUpdate = sendTransferUpdate;
-/**
- * Try to parse and get a useful string from API calls for HTTP Gateway
- *
- * @param error - Error from API call for Gateway
- *
- * @returns a string to use for errors
- */
-var getMessageFromError = function (error) {
-    var data = (0, helpers_1.safeJsonParse)(error);
-    var message = messages_1.messages.httpNetworkFail;
-    var code = 500;
-    if (data && typeof data === 'object') {
-        message = data.message || data.description || messages_1.messages.httpNetworkFail;
-        code = data.code || 500;
-    }
-    else if (error && typeof error === 'object') {
-        message = error.message || error.description || messages_1.messages.httpNetworkFail;
-        code = error.code || 500;
-    }
-    else if (typeof error === 'string') {
-        message = error;
-    }
-    return {
-        message: message,
-        code: code,
-    };
-};
-exports.getMessageFromError = getMessageFromError;
-var base64Encoding = function (jsonString) {
-    var bytes = new TextEncoder().encode(jsonString);
-    var binString = Array.from(bytes, function (byte) {
-        return String.fromCodePoint(byte);
-    }).join('');
-    return btoa(binString);
-};
-exports.base64Encoding = base64Encoding;

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

@@ -1,14 +0,0 @@
-import { AsperaSdkSpec, AsperaSdkTransfer, TransferSpec } from '../models/models';
-/**
- * HTTP Gateway Download Logic
- *
- * @param transferSpec - TransferSpec for the download
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer.
- *
- * @returns Promise that resolves on success invoke or rejects if unable to start
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-export declare const httpDownload: (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;

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

@@ -1,186 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpDownload = void 0;
-var index_1 = require("../index");
-var helpers_1 = require("../helpers/helpers");
-var messages_1 = require("../constants/messages");
-var core_1 = require("./core");
-var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
-/**
- * HTTP Gateway Download Logic for presigned flow
- * Presigned flow is when used files are too large or unknown file size
- *
- * @param transferSpec - TransferSpec for the download
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer.
- *
- * @returns Promise that resolves on success invoke or rejects if unable to start
- *
- * @remarks
- * This function is used internally and not exported.
- */
-var httpDownloadPresigned = function (transferSpec, asperaSdkSpec) {
-    // create a transfer sdk object
-    var transferObject = (0, core_1.getSdkTransfer)(transferSpec);
-    transferObject.httpDownloadExternalHandle = true;
-    (0, core_1.sendTransferUpdate)(transferObject);
-    var triggerFailed = function (error) {
-        var errorData = (0, core_1.getMessageFromError)(error.response || error);
-        transferObject.status = 'failed';
-        transferObject.error_code = errorData.code;
-        transferObject.error_desc = errorData.message;
-        (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 headers = {
-        'Content-Type': 'application/json',
-        accept: 'application/json',
-    };
-    if (asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_authentication) {
-        headers['Authorization'] = "Bearer ".concat(asperaSdkSpec.http_gateway_authentication.token);
-        headers['X-Aspera-AccessKey'] = asperaSdkSpec.http_gateway_authentication.access_key;
-    }
-    return fetch("".concat(url.toString(), "/presign"), {
-        method: 'POST',
-        headers: headers,
-        body: (0, helpers_1.safeJsonString)({
-            transfer_spec: transferSpec,
-            method: 'GET',
-            protocol: 'http',
-            headers: {
-                host: url.host,
-            },
-        }),
-    }).then(function (response) {
-        return response.json().then(function (data) {
-            return {
-                headers: response.headers,
-                body: data,
-                status: response.status,
-            };
-        });
-    }).then(function (response) {
-        if (response.status >= 400) {
-            triggerFailed(response.body);
-            return transferObject;
-        }
-        transferObject.httpRequestId = response.headers.get('X-Request-Id');
-        transferObject.status = 'running';
-        (0, core_1.sendTransferUpdate)(transferObject);
-        var iframe = document.createElement('iframe');
-        iframe.src = response.body.signed_url;
-        iframe.width = '1px';
-        iframe.height = '1px';
-        index_1.asperaSdk.globals.httpGatewayIframeContainer.appendChild(iframe);
-        return transferObject;
-    }).catch(function (error) {
-        triggerFailed(error);
-        return transferObject;
-    });
-};
-/**
- * HTTP Gateway Download Logic for in browser download with progress
- * This is used when the transfer size is known and under the threshold
- *
- * @param transferSpec - TransferSpec for the download
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer.
- *
- * @returns Promise that resolves on success invoke or rejects if unable to start
- *
- * @remarks
- * This function is used internally and not exported.
- */
-var httpDownloadInBrowser = function (transferSpec, asperaSdkSpec) {
-    // create a transfer sdk object
-    var transferObject = (0, core_1.getSdkTransfer)(transferSpec);
-    var triggerFailed = function (error) {
-        var errorData = (0, core_1.getMessageFromError)(error.response || error);
-        transferObject.status = 'failed';
-        transferObject.error_code = errorData.code;
-        transferObject.error_desc = errorData.message;
-        (0, core_1.sendTransferUpdate)(transferObject);
-    };
-    (0, core_1.sendTransferUpdate)(transferObject);
-    var headers = {
-        'X-Aspera-Spec': (0, core_1.base64Encoding)((0, helpers_1.safeJsonString)(transferSpec)),
-    };
-    if (asperaSdkSpec === null || asperaSdkSpec === void 0 ? void 0 : asperaSdkSpec.http_gateway_authentication) {
-        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) {
-        var responseHeaders = data.headers;
-        transferObject.httpRequestId = responseHeaders.get('X-Request-Id');
-        var chunks = [];
-        var reader = data.body.getReader();
-        transferObject.status = 'running';
-        (0, core_1.sendTransferUpdate)(transferObject);
-        transferObject.bytes_expected = Number(responseHeaders.get('Content-Length') || 0);
-        var readBytes = function () {
-            reader.read().then(function (content) {
-                var _a;
-                if (content.done) {
-                    if (data.status >= 400 || !transferObject.bytes_written) {
-                        triggerFailed(data.body);
-                        return;
-                    }
-                    transferObject.status = 'completed';
-                    (0, core_1.sendTransferUpdate)(transferObject);
-                    var blobData = new Blob(chunks, { type: responseHeaders.get('Content-Type') });
-                    var objectURL = URL.createObjectURL(blobData);
-                    var a = document.createElement('a');
-                    a.href = objectURL;
-                    a.setAttribute('style', 'display: none;');
-                    a.download = (responseHeaders.get('Content-Disposition') || 'download').replace('attachment; filename="', '').replace('"', '');
-                    document.body.appendChild(a);
-                    a.click();
-                    document.body.removeChild(a);
-                    URL.revokeObjectURL(objectURL);
-                }
-                else {
-                    chunks.push(content.value);
-                    transferObject.status = 'running';
-                    transferObject.bytes_written += ((_a = content.value) === null || _a === void 0 ? void 0 : _a.length) || 0;
-                    transferObject.percentage = (transferObject.bytes_written / transferObject.bytes_expected);
-                    (0, core_1.sendTransferUpdate)(transferObject);
-                    readBytes();
-                }
-            }).catch(function (error) {
-                triggerFailed(error);
-            });
-        };
-        readBytes();
-    }).catch(function (error) {
-        triggerFailed(error);
-    });
-    return Promise.resolve(transferObject);
-};
-/**
- * HTTP Gateway Download Logic
- *
- * @param transferSpec - TransferSpec for the download
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer.
- *
- * @returns Promise that resolves on success invoke or rejects if unable to start
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-var httpDownload = function (transferSpec, asperaSdkSpec) {
-    if (!index_1.asperaSdk.httpGatewayIsReady) {
-        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified, { type: 'download' });
-    }
-    if (index_1.asperaSdk.useOldHttpGateway) {
-        return (0, http_gateway_sdk_js_1.download)(transferSpec);
-    }
-    if (transferSpec.tags &&
-        transferSpec.tags.aspera &&
-        transferSpec.tags.aspera['http-gateway'] &&
-        transferSpec.tags.aspera['http-gateway'].expected_size <= index_1.asperaSdk.httpGatewayInBrowserDownloadThreshold) {
-        return httpDownloadInBrowser(transferSpec, asperaSdkSpec);
-    }
-    else {
-        return httpDownloadPresigned(transferSpec, asperaSdkSpec);
-    }
-};
-exports.httpDownload = httpDownload;

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

@@ -1,11 +0,0 @@
-import { httpDownload } from './download';
-import { httpUpload } from './upload';
-import { handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement } from './core';
-/**
- * HTTP Gateway Exports
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-export { httpUpload, httpDownload, handleHttpGatewayDrop, httpGatewaySelectFileFolderDialog, createHtmlInputElement, };

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

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHtmlInputElement = exports.httpGatewaySelectFileFolderDialog = exports.handleHttpGatewayDrop = exports.httpDownload = exports.httpUpload = void 0;
-var download_1 = require("./download");
-Object.defineProperty(exports, "httpDownload", { enumerable: true, get: function () { return download_1.httpDownload; } });
-var upload_1 = require("./upload");
-Object.defineProperty(exports, "httpUpload", { enumerable: true, get: function () { return upload_1.httpUpload; } });
-var core_1 = require("./core");
-Object.defineProperty(exports, "handleHttpGatewayDrop", { enumerable: true, get: function () { return core_1.handleHttpGatewayDrop; } });
-Object.defineProperty(exports, "httpGatewaySelectFileFolderDialog", { enumerable: true, get: function () { return core_1.httpGatewaySelectFileFolderDialog; } });
-Object.defineProperty(exports, "createHtmlInputElement", { enumerable: true, get: function () { return core_1.createHtmlInputElement; } });

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

@@ -1,16 +0,0 @@
-export interface HttpGatewayInfo {
-    version: string;
-    name: string;
-    upload_endpoint: string[];
-    download_endpoint: string[];
-    endpoints: string[];
-}
-export interface HttpGatewayDownloadLegacy {
-    transfer_spec_id: string;
-    url: string;
-}
-export type HttpGatewayDownload = ReadableStream<Uint8Array<ArrayBuffer>>;
-export type HttpGatewayUpload = null;
-export interface HttpGatewayPresign {
-    signed_url: string;
-}

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,14 +0,0 @@
-import { AsperaSdkSpec, AsperaSdkTransfer, TransferSpec } from '../models/models';
-/**
- * HTTP Gateway Upload Logic
- *
- * @param transferSpec - TransferSpec for the upload
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer.
- *
- * @returns Promise that resolves on success invoke or rejects if unable to start
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-export declare const httpUpload: (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;