@ibm-aspera/sdk 0.2.7 → 0.2.9

package/src/app/core.ts

@@ -1,611 +0,0 @@
-import {messages} from '../constants/messages';
-import {client} from '../helpers/client/client';
-import {errorLog, generateErrorBody, generatePromiseObjects, isValidTransferSpec, randomUUID, throwError} from '../helpers/helpers';
-import {asperaSdk} from '../index';
-import {AsperaSdkInfo, TransferResponse} from '../models/aspera-sdk.model';
-import {CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, BrowserStyleFile, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent} from '../models/models';
-
-/**
- * Check if IBM Aspera for Desktop connection works. This function is called by init
- * when initializing the SDK. This function can be used at any point for checking.
- *
- * @returns a promise that resolves if server can connect or rejects if not
- */
-export const testConnection = (): Promise<any> => {
-  return client.request('get_info')
-    .then((data: AsperaSdkInfo) => {
-      asperaSdk.globals.AsperaSdkInfo = data;
-      asperaSdk.globals.asperaAppVerified = true;
-      return data;
-    });
-};
-
-/**
- * Initialize drag and drop.
- *
- * @returns a promise that resolves if the initialization was successful or not
- */
-export const initDragDrop = (): Promise<boolean> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  client.request('init_drag_drop')
-    .then((data: boolean) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.dragDropInitFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.dragDropInitFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Initialize IBM Aspera client. If client cannot (reject/catch), then
- * client should attempt fixing server URL or trying again. If still fails disable UI elements.
- *
- * @param options initialization options:
- *
- * - `appId` the unique ID for the website. Transfers initiated during this session
- * will be associated with this ID. It is recommended to use a unique ID to keep transfer
- * information private from other websites.
- *
- * - `supportMultipleUsers` when enabled (defaults to false), the SDK will iterate over a port
- * range and generate a session id to determine the running instance of the desktop app for the
- * current user. This is needed when multiple users may be logged into the same machine
- * simultaneously, for example on a Windows Server.
- *
- * @returns a promise that resolves if IBM Aspera Desktop is running properly or
- * rejects if unable to connect
- */
-export const init = (options?: InitOptions): Promise<any> => {
-  const appId = options?.appId ?? randomUUID();
-  const supportMultipleUsers = options?.supportMultipleUsers ?? false;
-
-  asperaSdk.globals.appId = appId;
-
-  if (supportMultipleUsers) {
-    asperaSdk.globals.supportMultipleUsers = true;
-    asperaSdk.globals.sessionId = randomUUID();
-  }
-
-  return asperaSdk.activityTracking.setup()
-    .then(() => testConnection())
-    .then(() => initDragDrop())
-    .catch(error => {
-      errorLog(messages.serverError, error);
-      asperaSdk.globals.asperaAppVerified = false;
-      throw generateErrorBody(messages.serverError, error);
-    });
-};
-
-/**
- * Start a transfer
- *
- * @param transferSpec standard transferSpec for transfer
- * @param asperaSdkSpec IBM Aspera settings when starting a transfer
- *
- * @returns a promise that resolves if transfer initiation is successful and rejects if transfer cannot be started
- */
-export const startTransfer = (transferSpec: TransferSpec, asperaSdkSpec: AsperaSdkSpec): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  if (!isValidTransferSpec(transferSpec)) {
-    return throwError(messages.notValidTransferSpec, {transferSpec});
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_spec: transferSpec,
-    desktop_spec: asperaSdkSpec,
-    app_id: asperaSdk.globals.appId,
-  };
-
-  client.request('start_transfer', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.transferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.transferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Register a callback event for getting transfer updates
- *
- * @param callback callback function to receive transfers
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export const registerActivityCallback = (callback: (transfers: TransferResponse) => void): string => {
-  return asperaSdk.activityTracking.setCallback(callback);
-};
-
-/**
- * Remove a callback from the transfer callback
- *
- * @param id the ID returned by `registerActivityCallback`
- */
-export const deregisterActivityCallback = (id: string): void => {
-  asperaSdk.activityTracking.removeCallback(id);
-};
-
-/**
- * Register a callback event for when a user removes or cancels a transfer
- * directly from IBM Aspera. This may also be called if IBM Aspera
- * is configured to automatically remove completed transfers.
- *
- * @param callback callback function to receive transfers
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export const registerRemovedCallback = (callback: (transfer: AsperaSdkTransfer) => void): string => {
-  return asperaSdk.activityTracking.setRemovedCallback(callback);
-};
-
-/**
- * Remove a callback from the removed transfer callback
- *
- * @param id the ID returned by `registerRemovedCallback`
- */
-export const deregisterRemovedCallback = (id: string): void => {
-  asperaSdk.activityTracking.removeRemovedCallback(id);
-};
-
-/**
- * Register a callback for getting updates about the connection status of IBM Aspera SDK.
- *
- * For example, to be notified of when the SDK loses connection with the application or connection
- * is re-established. This can be useful if you want to handle the case where the user quits IBM Aspera
- * after `init` has already been called, and want to prompt the user to relaunch the application.
- *
- * @param callback callback function to receive events
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export const registerStatusCallback = (callback: (status: WebsocketEvent) => void): string => {
-  return asperaSdk.activityTracking.setWebSocketEventCallback(callback);
-};
-
-/**
- * Remove a callback from getting connection status events.
- *
- * @param id the ID returned by `registerStatusCallback`
- */
-export const deregisterStatusCallback = (id: string): void => {
-  asperaSdk.activityTracking.removeWebSocketEventCallback(id);
-};
-
-/**
- * Register a callback for getting updates about the Safari extension status.
- *
- * This can be useful if you want to handle the case where the user enable or disable the Safari extension.
- *
- * @param callback callback function to receive events
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export const registerSafariExtensionStatusCallback = (callback: (status: SafariExtensionEvent) => void): string => {
-  return asperaSdk.activityTracking.setSafariExtensionEventCallback(callback);
-};
-
-/**
- * Remove a callback from getting Safari extension status events.
- *
- * @param id the ID returned by `registerStatusCallback`
- */
-export const deregisterSafariExtensionStatusCallback = (id: string): void => {
-  asperaSdk.activityTracking.removeSafariExtensionEventCallback(id);
-};
-
-/**
- * Remove a transfer. This will stop the transfer if it is in progress.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves if transfer is removed and rejects if transfer cannot be removed
- */
-export const removeTransfer = (id: string): Promise<any> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-  };
-
-  client.request('remove_transfer', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.removeTransferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.removeTransferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Stop a transfer.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves if transfer is stopped and rejects if transfer cannot be stopped
- */
-export const stopTransfer = (id: string): Promise<any> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-  };
-
-  client.request('stop_transfer', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.stopTransferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.stopTransferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Resume a paused or failed transfer.
- *
- * @param id transfer uuid
- * @param options resume transfer options
- *
- * @returns a promise that resolves with the new transfer object if transfer is resumed
- */
-export const resumeTransfer = (id: string, options?: ResumeTransferOptions): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-    transfer_spec: options,
-  };
-
-  client.request('resume_transfer', payload)
-    .then((data: AsperaSdkTransfer) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.resumeTransferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.resumeTransferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Displays a file browser dialog for the user to select files.
- *
- * @param options file dialog options
- *
- * @returns a promise that resolves with the selected file(s) and rejects if user cancels dialog
- */
-export const showSelectFileDialog = (options?: FileDialogOptions): Promise<DataTransferResponse> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    options: options || {},
-    app_id: asperaSdk.globals.appId,
-  };
-
-  client.request('show_file_dialog', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.showSelectFileDialogFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.showSelectFileDialogFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Displays a folder browser dialog for the user to select folders.
- *
- * @param options folder dialog options
- *
- * @returns a promise that resolves with the selected folder(s) and rejects if user cancels dialog
- */
-export const showSelectFolderDialog = (options?: FolderDialogOptions): Promise<DataTransferResponse> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    options: options || {},
-    app_id: asperaSdk.globals.appId,
-  };
-
-  client.request('show_folder_dialog', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.showSelectFolderDialogFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.showSelectFolderDialogFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Opens the IBM Aspera preferences page.
- *
- * @returns a promise that resolves when the preferences page is opened.
- */
-export const showPreferences = (): Promise<any> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  client.request('open_preferences')
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.showPreferencesFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.showPreferencesFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Get all transfers associated with the current application.
- *
- * @returns a promise that resolves with an array of transfers.
- */
-export const getAllTransfers = (): Promise<AsperaSdkTransfer[]> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    app_id: asperaSdk.globals.appId,
-  };
-
-  client.request('get_all_transfers', payload)
-    .then((data: AsperaSdkTransfer[]) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.getAllTransfersFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.getAllTransfersFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Get a specific transfer by ID.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves with the transfer.
- */
-export const getTransfer = (id: string): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-  };
-
-  client.request('get_transfer', payload)
-    .then((data: AsperaSdkTransfer) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.getTransferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.getTransferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Opens and highlights the downloaded file in Finder or Windows Explorer. If multiple files,
- * then only the first file will be selected.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves if the file can be shown and rejects if not
- */
-export const showDirectory = (id: string): Promise<any> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-  };
-
-  client.request('show_directory', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.showDirectoryFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.showDirectoryFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Modify the speed of a running transfer.
- *
- * @param id transfer uuid
- * @param options transfer rate options
- *
- * @returns a promise that resolves if the transfer rate can be modified and rejects if not
- */
-export const modifyTransfer = (id: string, options: ModifyTransferOptions): Promise<AsperaSdkTransfer> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const payload = {
-    transfer_id: id,
-    transfer_spec: options,
-  };
-
-  client.request('modify_transfer', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.modifyTransferFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.modifyTransferFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Set the custom branding template to be used by IBM Aspera. If the app is already
- * configured to use a different branding, then the branding template you specify will be
- * stored by the app, allowing the end user to switch at any point.
- *
- * @param id custom branding template id. This should be consistent across page loads.
- * @param options custom branding options
- *
- * @returns a promise that resolves if the branding was properly set.
- */
-export const setBranding = (id: string, options: CustomBrandingOptions): Promise<any> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  const branding = {
-    id,
-    name: options.name,
-    theme: options.theme,
-  };
-
-  const payload = {
-    branding,
-  };
-
-  client.request('update_branding', payload)
-    .then((data: any) => promiseInfo.resolver(data))
-    .catch(error => {
-      errorLog(messages.setBrandingFailed, error);
-      promiseInfo.rejecter(generateErrorBody(messages.setBrandingFailed, error));
-    });
-
-  return promiseInfo.promise;
-};
-
-/**
- * Create a dropzone for the given element selector.
- *
- * @param callback the function to call once the files are dropped
- * @param elementSelector the selector of the element on the page that should watch for drop events
- */
-export const createDropzone = (
-  callback: (data: {event: any; files: DataTransferResponse}) => void,
-  elementSelector: string,
-): void => {
-  const elements = document.querySelectorAll(elementSelector);
-  if (!elements || !elements.length) {
-    errorLog(messages.unableToFindElementOnPage);
-    return;
-  }
-
-  const dragEvent = (event: any) => {
-    event.preventDefault();
-  };
-
-  const dropEvent = (event: any) => {
-    event.preventDefault();
-    const files: BrowserStyleFile[] = [];
-    if (event.dataTransfer && event.dataTransfer.files && event.dataTransfer.files.length && event.dataTransfer.files[0]) {
-      for (let i = 0; i < event.dataTransfer.files.length; i++) {
-        const file = event.dataTransfer.files[i];
-        files.push({
-          lastModified: file.lastModified,
-          name: file.name,
-          size: file.size,
-          type: file.type
-        });
-      }
-
-      const payload = {
-        files,
-        app_id: asperaSdk.globals.appId,
-      };
-
-      client.request('dropped_files', payload)
-        .then((data: any) => callback({event, files: data}))
-        .catch(error => {
-          errorLog(messages.unableToReadDropped, error);
-        });
-    }
-  };
-
-  elements.forEach(element => {
-    element.addEventListener('dragover', dragEvent);
-    element.addEventListener('drop', dropEvent);
-    asperaSdk.globals.dropZonesCreated.set(elementSelector, [{event: 'dragover', callback: dragEvent}, {event: 'drop', callback: dropEvent}]);
-  });
-};
-
-/**
- * Remove dropzone.
- *
- * @param elementSelector the selector of the element on the page that should remove
- */
-export const removeDropzone = (elementSelector: string): void => {
-  const foundDropzone = asperaSdk.globals.dropZonesCreated.get(elementSelector);
-
-  if (foundDropzone) {
-    foundDropzone.forEach(data => {
-      const elements = document.querySelectorAll(elementSelector);
-
-      if (elements && elements.length) {
-        elements.forEach(element => {
-          element.removeEventListener(data.event, data.callback);
-        });
-      }
-    });
-  }
-};
-
-/**
- * Get metadata about the IBM Aspera installation.
- *
- * @returns a promise that returns information about the user's IBM Aspera installation.
- */
-export const getInfo = (): Promise<AsperaSdkInfo> => {
-  if (!asperaSdk.isReady) {
-    return throwError(messages.serverNotVerified);
-  }
-
-  return new Promise((resolve, _) => {
-    resolve(asperaSdk.globals.AsperaSdkInfo);
-  });
-};

package/src/app/installer.ts

@@ -1,53 +0,0 @@
-import {asperaSdk} from '../index';
-import {errorLog, generateErrorBody, generatePromiseObjects, getCurrentPlatform, isValidURL, throwError} from '../helpers/helpers';
-import {apiGet} from '../helpers/http';
-import {messages} from '../constants/messages';
-import {InstallerInfoResponse, InstallerOptions} from '../models/models';
-
-/**
- * Get the latest Aspera SDK installer information such as download URL and version.
- *
- * @param options Installer info options
- *
- * @returns a promise that resolves with the installer info and rejects if there is an error
- */
-export const getInstallerInfo = (options: InstallerOptions = {}): Promise<InstallerInfoResponse> => {
-  let url = options.endpoint || asperaSdk.globals.installerUrl;
-
-  if (url.endsWith('/latest.json')) {
-    url = url.replace('/latest.json', '');
-  }
-
-  if (!isValidURL(url)) {
-    return throwError(messages.invalidEndpoint, {url});
-  }
-
-  const promiseInfo = generatePromiseObjects();
-
-  apiGet(`${url}/latest.json`).then(response => {
-    response.json().then((data: InstallerInfoResponse) => {
-      if (options.endpoint) {
-        for (const entry of data.entries) {
-          if (!isValidURL(entry.url)) {
-            entry.url = `${options.endpoint}/${entry.url}`;
-          }
-        }
-      }
-
-      if (options.all) {
-        promiseInfo.resolver(data);
-      } else {
-        const platform = getCurrentPlatform();
-        data.entries = data.entries.filter(entry => entry.platform === platform);
-
-        promiseInfo.resolver(data);
-      }
-    });
-  }).catch(error => {
-    errorLog(messages.getInstallerError, error);
-
-    promiseInfo.rejecter(generateErrorBody(messages.getInstallerError, error));
-  });
-
-  return promiseInfo.promise;
-};

package/src/constants/constants.ts

@@ -1,19 +0,0 @@
-/** @ignore */
-export const hiddenStyleList = `
-  display: none !important;
-  width: 1px !important;
-  height: 1px !important;
-  position: fixed !important;
-  z-index: -99 !important;
-  bottom: 0px !important;
-  right: 0px !important;
-`;
-
-/** @ignore */
-export const protocol = 'aspera://';
-
-/** @ignore */
-export const baseInstallerUrl = 'https://downloads.ibmaspera.com/downloads/desktop';
-
-/** @ignore */
-export const installerUrl = `${baseInstallerUrl}/latest/stable`;

package/src/constants/messages.ts

@@ -1,29 +0,0 @@
-/** @ignore */
-export const messages = {
-  callbackIsNotFunction: 'The provided callback is not a function',
-  dragDropInitFailed: 'Unable to initialize drag-drop',
-  failedToGenerateIframe: 'Unable to generate IFRAME for download. Using new window',
-  getInstallerError: 'Unable to get latest installers',
-  getAllTransfersFailed: 'Unable to get all transfers',
-  getTransferFailed: 'Unable to get transfer',
-  invalidEndpoint: 'The specified endpoint is not a valid URL',
-  loadingProtocol: 'Launching IBM Aspera for Desktop',
-  modifyTransferFailed: 'Unable to modify transfer',
-  notValidTransferSpec: 'The supplied transferSpec is not valid',
-  removeTransferFailed: 'Unable to remove transfer',
-  resumeTransferFailed: 'Unable to resume transfer',
-  serverError: 'Unable to connect to IBM Aspera for Desktop server',
-  serverNotVerified: 'IBM Aspera SDK has not been verified. Run test or init first',
-  setBrandingFailed: 'Unable to set custom branding',
-  showDirectoryFailed: 'Unable to show transfer directory',
-  showSelectFileDialogFailed: 'Unable to show select file dialog',
-  showSelectFolderDialogFailed: 'Unable to show select folder dialog',
-  showPreferencesFailed: 'Unable to show preferences',
-  stopTransferFailed: 'Unable to stop transfer',
-  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',
-  websocketClosedError: 'The websocket was closed due to an error',
-  websocketClosedUnexpect: 'The websocket was closed unexpectedly',
-  websocketNotReady: 'The websocket is not ready. Run init first',
-};