@ibm-aspera/sdk 0.2.29 → 0.4.12

package/src/http-gateway/core.ts

@@ -1,273 +0,0 @@
-import {messages} from '../constants/messages';
-import {generateErrorBody, generatePromiseObjects, randomUUID, safeJsonParse} from '../helpers/helpers';
-import {asperaSdk} from '../index';
-import {removeTransfer as oldHttpRemoveTransfer, getAllTransfers as oldHttpGetAllTransfers, getTransferById as oldHttpGetTransfer, getFilesForUploadPromise as oldHttpGetFilesForUploadPromise, getFoldersForUploadPromise as oldHttpGetFoldersForUploadPromise} from '@ibm-aspera/http-gateway-sdk-js';
-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 const httpRemoveTransfer = (id: string): Promise<any> => {
-  if (asperaSdk.useOldHttpGateway) {
-    oldHttpRemoveTransfer(id);
-
-    return Promise.resolve({removed: true});
-  }
-
-  const transfer = asperaSdk.httpGatewayTransferStore.get(id);
-
-  if (transfer) {
-    asperaSdk.httpGatewayTransferStore.delete(id);
-    return Promise.resolve({removed: true});
-  } else {
-    return Promise.reject(generateErrorBody(messages.removeTransferFailed, {reason: 'Not found'}));
-  }
-};
-
-/**
- * Get the list of http gateway transfers
- *
- * @returns list of HTTP Gateway
- */
-export const httpGetAllTransfers = (): AsperaSdkTransfer[] => {
-  if (asperaSdk.useOldHttpGateway) {
-    return oldHttpGetAllTransfers().transfers as unknown as AsperaSdkTransfer[];
-  }
-
-  return Array.from(asperaSdk.httpGatewayTransferStore.values());
-};
-
-/**
- * Get a HTTP Gateway transfer by ID
- *
- * @returns a transfer or null
- */
-export const httpGetTransfer = (id: string): AsperaSdkTransfer|null => {
-  if (asperaSdk.useOldHttpGateway) {
-    return oldHttpGetTransfer(id) as unknown as AsperaSdkTransfer|null;
-  }
-
-  return asperaSdk.httpGatewayTransferStore.get(id);
-};
-
-/**
- * Create HTML input element for file picking
- */
-export const createHtmlInputElement = (): HTMLInputElement => {
-  const element = window.document.createElement('input');
-  element.type = 'file';
-  element.style = 'display: none;';
-  window.document.body.appendChild(element);
-  return element;
-};
-
-/**
- * Handle drop events and store files for HTTP Gateway
- * This works on top of desktop.
- */
-export const handleHttpGatewayDrop = (items: DataTransferItemList, callback: (data: {event: DragEvent; files: DataTransferResponse}) => void, event: DragEvent): void => {
-  const files: File[] = [];
-  let callbackCount = 0;
-  let callbackFinishCount = 0;
-
-  const finalCallback = (): void => {
-    if (callbackFinishCount >= callbackCount) {
-      const finalFiles = files.map(file => {
-        asperaSdk.httpGatewaySelectedFiles.set(file.name, file);
-
-        return {
-          lastModified: file.lastModified,
-          name: file.name,
-          size: file.size,
-          type: file.type
-        };
-      });
-      callback({event, files: {dataTransfer: {files: finalFiles}}});
-    }
-  };
-
-  const traverse = (item: FileSystemEntry) => {
-    if (item.isFile) {
-      (item as FileSystemFileEntry).file(file => {
-        files.push(file);
-        callbackFinishCount++;
-        finalCallback();
-      });
-
-    } else if (item.isDirectory) {
-      const dirReader = (item as FileSystemDirectoryEntry).createReader();
-
-      dirReader.readEntries(entries => {
-        for (let k = 0; k < entries.length; k++) {
-          callbackCount++;
-          traverse(entries[k]);
-        }
-      });
-
-      callbackFinishCount++;
-    } else {
-      callbackFinishCount++;
-      finalCallback();
-    }
-
-  };
-
-  for (let i = 0; i < items.length; i++) {
-    const item = items[i].webkitGetAsEntry();
-
-    if (item) {
-      callbackCount++;
-      traverse(item);
-    }
-  }
-};
-
-/**
- * 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 const httpGatewaySelectFileFolderDialog = (options?: FileDialogOptions, folder?: boolean): Promise<DataTransferResponse> => {
-  if (asperaSdk.useOldHttpGateway) {
-    return (folder ? oldHttpGetFoldersForUploadPromise(options?.http_gateway_v2_transfer_id || '') : oldHttpGetFilesForUploadPromise(options?.http_gateway_v2_transfer_id || '')) as Promise<DataTransferResponse>;
-  }
-
-  const {promise, rejecter, resolver} = generatePromiseObjects();
-  const element = createHtmlInputElement();
-
-  element.multiple = !!options?.multiple;
-
-  if (folder) {
-    element.webkitdirectory = true;
-  }
-
-  element.oncancel = () => {
-    rejecter({debugData: {code: -32002, message: messages.filePickerCancel}});
-  };
-
-  element.onchange = () => {
-    const returnFiles: File[] = [];
-
-    for (let i = 0; i < element.files.length; i++) {
-      const file = element.files[i];
-      returnFiles.push(file);
-      asperaSdk.httpGatewaySelectedFiles.set(file.name, file);
-    }
-
-    resolver({
-      dataTransfer: {
-        files: returnFiles.map(file => {
-          return {
-            size: file.size,
-            lastModified: file.lastModified,
-            name: file.webkitRelativePath || file.name,
-            type: file.type,
-          };
-        })
-      }
-    });
-  };
-
-  element.click();
-
-  return promise;
-};
-
-/**
- * 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 const getSdkTransfer = (transferSpec: TransferSpec): AsperaSdkTransfer => {
-  return {
-    uuid: 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,
-  };
-};
-
-/**
- * Send a transfer update through the SDK
- *
- * @param transfer - Transsfer object to send to consumers
- */
-export const sendTransferUpdate = (transfer: AsperaSdkTransfer): void => {
-  asperaSdk.httpGatewayTransferStore.set(transfer.uuid, transfer);
-  asperaSdk.activityTracking.handleTransferActivity({
-    type: 'transferUpdated',
-    data: {transfers: [transfer]},
-  });
-};
-
-/**
- * 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 const getMessageFromError = (error: any): {message: string, code: number} => {
-  const data = safeJsonParse(error);
-  let message = messages.httpNetworkFail;
-  let code = 500;
-
-  if (data && typeof data === 'object') {
-    message = data.message || data.description || messages.httpNetworkFail;
-    code = data.code || 500;
-  } else if (error && typeof error === 'object') {
-    message = error.message || error.description || messages.httpNetworkFail;
-    code = error.code || 500;
-  } else if (typeof error === 'string') {
-    message = error;
-  }
-
-  return {
-    message,
-    code,
-  };
-};
-
-export const base64Encoding = (jsonString: string): string => {
-  const bytes = new TextEncoder().encode(jsonString);
-  const binString = Array.from(bytes, (byte) =>
-    String.fromCodePoint(byte),
-  ).join('');
-  return btoa(binString);
-};

package/src/http-gateway/download.ts

@@ -1,217 +0,0 @@
-import {AsperaSdkSpec, AsperaSdkTransfer, TransferSpec} from '../models/models';
-import {asperaSdk} from '../index';
-import {safeJsonString, throwError} from '../helpers/helpers';
-import {messages} from '../constants/messages';
-import { base64Encoding, getMessageFromError, getSdkTransfer, sendTransferUpdate } from './core';
-import {download as oldHttpDownload} from '@ibm-aspera/http-gateway-sdk-js';
-import { HttpGatewayPresign } from './models';
-
-/**
- * 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.
- */
-const httpDownloadPresigned = (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec): Promise<AsperaSdkTransfer> => {
-  // create a transfer sdk object
-  const transferObject = getSdkTransfer(transferSpec);
-  transferObject.httpDownloadExternalHandle = true;
-  sendTransferUpdate(transferObject);
-
-  const triggerFailed = (error: any): void => {
-    const errorData = getMessageFromError(error.response || error);
-
-    transferObject.status = 'failed';
-    transferObject.error_code = errorData.code;
-    transferObject.error_desc = errorData.message;
-    sendTransferUpdate(transferObject);
-  };
-
-  const url = new URL(asperaSdkSpec?.http_gateway_override_server_url || asperaSdk.globals.httpGatewayUrl);
-
-  const headers: HeadersInit = {
-    'Content-Type': 'application/json',
-    accept: 'application/json',
-  };
-
-  if (asperaSdkSpec?.http_gateway_authentication) {
-    headers['Authorization'] = `Bearer ${asperaSdkSpec.http_gateway_authentication.token}`;
-    headers['X-Aspera-AccessKey'] = asperaSdkSpec.http_gateway_authentication.access_key;
-  }
-
-  const protocol = url.protocol === 'https:' ? 'https' : 'http';
-
-  return fetch(
-    `${url.toString()}/presign`,
-    {
-      method: 'POST',
-      headers,
-      body: safeJsonString({
-        transfer_spec: transferSpec,
-        method: 'GET',
-        protocol,
-        headers: {
-          host: url.host,
-        },
-      }),
-    },
-  ).then(response => {
-    return response.json().then(data => {
-      return {
-        headers: response.headers,
-        body: data as HttpGatewayPresign,
-        status: response.status,
-      };
-    });
-  }).then(response => {
-    if (response.status >= 400) {
-      triggerFailed(response.body);
-
-      return transferObject;
-    }
-
-    transferObject.httpRequestId = response.headers.get('X-Request-Id');
-    transferObject.status = 'running';
-    sendTransferUpdate(transferObject);
-
-    const iframe = document.createElement('iframe');
-    iframe.src = response.body.signed_url;
-    iframe.width = '1px';
-    iframe.height = '1px';
-
-    asperaSdk.globals.httpGatewayIframeContainer.appendChild(iframe);
-
-    return transferObject;
-  }).catch(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.
- */
-const httpDownloadInBrowser = (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec): Promise<AsperaSdkTransfer> => {
-  // create a transfer sdk object
-  const transferObject = getSdkTransfer(transferSpec);
-
-  const triggerFailed = (error: any): void => {
-    const errorData = getMessageFromError(error.response || error);
-
-    transferObject.status = 'failed';
-    transferObject.error_code = errorData.code;
-    transferObject.error_desc = errorData.message;
-    sendTransferUpdate(transferObject);
-  };
-
-  sendTransferUpdate(transferObject);
-
-  const headers: HeadersInit = {
-    'X-Aspera-Spec': base64Encoding(safeJsonString(transferSpec)),
-  };
-
-  if (asperaSdkSpec?.http_gateway_authentication) {
-    headers['Authorization'] = `Bearer ${asperaSdkSpec.http_gateway_authentication.token}`;
-    headers['X-Aspera-AccessKey'] = asperaSdkSpec.http_gateway_authentication.access_key;
-  }
-
-  fetch(`${asperaSdkSpec?.http_gateway_override_server_url || asperaSdk.globals.httpGatewayUrl}/download`, {method: 'GET', headers}).then(data => {
-    const responseHeaders = data.headers;
-    transferObject.httpRequestId = responseHeaders.get('X-Request-Id');
-    const chunks: Uint8Array<ArrayBuffer>[] = [];
-    const reader = data.body.getReader();
-    transferObject.status = 'running';
-    sendTransferUpdate(transferObject);
-
-    transferObject.bytes_expected = Number(responseHeaders.get('Content-Length') || 0);
-
-    const readBytes = () => {
-      reader.read().then(content => {
-        if (content.done){
-          if (data.status >= 400 || !transferObject.bytes_written) {
-            triggerFailed(data.body);
-
-            return;
-          }
-
-          transferObject.status = 'completed';
-          sendTransferUpdate(transferObject);
-          const blobData = new Blob(chunks, {type: responseHeaders.get('Content-Type')});
-          const objectURL = URL.createObjectURL(blobData);
-          const 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 += content.value?.length || 0;
-          transferObject.percentage = (transferObject.bytes_written /transferObject.bytes_expected);
-          sendTransferUpdate(transferObject);
-          readBytes();
-        }
-      }).catch(error => {
-        triggerFailed(error);
-      });
-    };
-
-    readBytes();
-  }).catch(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.
- */
-export const httpDownload = (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.httpGatewayIsReady) {
-    return throwError(messages.serverNotVerified, {type: 'download'});
-  }
-
-  if (asperaSdk.useOldHttpGateway) {
-    return oldHttpDownload(transferSpec);
-  }
-
-  if (
-    transferSpec.tags &&
-    transferSpec.tags.aspera &&
-    transferSpec.tags.aspera['http-gateway'] &&
-    transferSpec.tags.aspera['http-gateway'].expected_size <= asperaSdk.httpGatewayInBrowserDownloadThreshold
-  ) {
-    return httpDownloadInBrowser(transferSpec, asperaSdkSpec);
-  } else {
-    return httpDownloadPresigned(transferSpec, asperaSdkSpec);
-  }
-};

package/src/http-gateway/index.ts

@@ -1,19 +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/src/http-gateway/models.ts

@@ -1,20 +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/src/http-gateway/upload.ts

@@ -1,148 +0,0 @@
-import {AsperaSdkSpec, AsperaSdkTransfer, TransferSpec} from '../models/models';
-import {asperaSdk} from '../index';
-import {generatePromiseObjects, safeJsonString, throwError} from '../helpers/helpers';
-import {messages} from '../constants/messages';
-import {getMessageFromError, getSdkTransfer, sendTransferUpdate} from './core';
-import {upload as oldHttpUpload} from '@ibm-aspera/http-gateway-sdk-js';
-
-/**
- * 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 const httpUpload = (transferSpec: TransferSpec, asperaSdkSpec?: AsperaSdkSpec): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.httpGatewayIsReady) {
-    return throwError(messages.serverNotVerified, {type: 'upload'});
-  }
-
-  if (asperaSdk.useOldHttpGateway) {
-    return oldHttpUpload(transferSpec, asperaSdkSpec?.http_gateway_v2_transfer_id || '');
-  }
-
-  const promiseInfo = generatePromiseObjects();
-  const request = new XMLHttpRequest();
-  const body = new FormData();
-  body.append('x-aspera-spec', safeJsonString(transferSpec));
-  const hasBadFile: string[] = [];
-
-  transferSpec.paths.forEach(path => {
-    const foundFile = asperaSdk.httpGatewaySelectedFiles.get(path.source);
-
-    if (foundFile) {
-      body.append('Content-Length', String(foundFile.size));
-      body.append('file', foundFile);
-    } else {
-      hasBadFile.push(path.source);
-    }
-  });
-
-  if (hasBadFile.length) {
-    return throwError(messages.fileNotAllowed, {type: 'upload', invalidFiles: hasBadFile, transferSpec});
-  }
-
-  const transferObject = getSdkTransfer(transferSpec);
-
-  if (asperaSdkSpec?.http_gateway_authentication) {
-    request.setRequestHeader('Authorization', `Bearer ${asperaSdkSpec.http_gateway_authentication.token}`);
-    request.setRequestHeader('X-Aspera-AccessKey', asperaSdkSpec.http_gateway_authentication.access_key);
-  }
-
-  request.open('POST', `${asperaSdkSpec?.http_gateway_override_server_url || asperaSdk.globals.httpGatewayUrl}/upload`, true);
-
-  const triggerUpdate = (): void => {
-    sendTransferUpdate(transferObject);
-  };
-
-  const triggerFailed = (): void => {
-    const errorData = getMessageFromError(request.response);
-    transferObject.httpRequestId = request.getResponseHeader('X-Request-Id');
-    transferObject.status = 'failed';
-    transferObject.error_code = errorData.code;
-    transferObject.error_desc = errorData.message;
-    triggerUpdate();
-  };
-
-  request.upload.addEventListener('progress', event => {
-    if (transferObject.status === 'failed') {
-      return;
-    }
-    transferObject.status = 'running';
-    transferObject.elapsed_usec = (new Date().getTime() - new Date(transferObject.add_time).getTime()) * 1000;
-
-    if (event.lengthComputable) {
-      transferObject.bytes_expected = event.total;
-      transferObject.bytes_written = event.loaded;
-      transferObject.percentage = (event.loaded / event.total);
-    }
-
-    triggerUpdate();
-  });
-
-  request.addEventListener('load', () => {
-    transferObject.httpRequestId = request.getResponseHeader('X-Request-Id');
-  });
-
-  request.upload.addEventListener('load', event => {
-    if (transferObject.status === 'failed') {
-      return;
-    }
-
-    transferObject.status = 'completed';
-    transferObject.elapsed_usec = (new Date().getTime() - new Date(transferObject.add_time).getTime()) * 1000;
-
-    if (event.lengthComputable) {
-      transferObject.bytes_expected = event.total;
-      transferObject.bytes_written = event.loaded;
-      transferObject.percentage = (event.loaded / event.total);
-    }
-
-    triggerUpdate();
-  });
-
-  request.upload.addEventListener('loadstart', () => {
-    if (transferObject.status === 'failed') {
-      return;
-    }
-
-    transferObject.status = 'running';
-    promiseInfo.resolver(transferObject);
-    triggerUpdate();
-  });
-
-  request.addEventListener('readystatechange', () => {
-    if (request.status >= 400) {
-      triggerFailed();
-    }
-  });
-
-  request.upload.addEventListener('error', event => {
-    triggerFailed();
-    promiseInfo.rejecter(event);
-  });
-
-  request.upload.addEventListener('abort', event => {
-    triggerFailed();
-    promiseInfo.rejecter(event);
-  });
-
-  request.addEventListener('error', event => {
-    triggerFailed();
-    promiseInfo.rejecter(event);
-  });
-
-  request.addEventListener('abort', event => {
-    triggerFailed();
-    promiseInfo.rejecter(event);
-  });
-
-  request.send(body);
-
-  return promiseInfo.promise;
-};