@ibm-aspera/sdk 0.2.9 → 0.2.29

package/tests/client.spec.ts

@@ -0,0 +1,52 @@
+import {mockFetch} from './mocks';
+import {httpClient, getRpcServerUrl} from '../src/helpers/client/http-client';
+
+let id = 0;
+
+const getHeaders = () => {
+  return {
+    'content-type': 'application/json',
+  };
+};
+
+const getMethod = () => {
+  return 'POST';
+};
+
+const getBody = (method: string, params: any = {}) => {
+  return JSON.stringify({
+    jsonrpc: '2.0',
+    id,
+    method,
+    params,
+  });
+};
+
+const getExpectedRequest = (method: string, params: any = {}) => {
+  id++;
+
+  return {
+    method: getMethod(),
+    headers: getHeaders(),
+    body: getBody(method, params),
+  };
+};
+
+describe('request', () => {
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  const fakeData = {data: 'testing'};
+  const rpcServerURL = getRpcServerUrl();
+
+  test('POST with no params should call url with no params', () => {
+    httpClient.request('fake');
+    expect(fetch).toHaveBeenCalledWith(rpcServerURL, getExpectedRequest('fake'));
+  });
+
+  test('POST with params should call url with params', () => {
+    httpClient.request('fake', fakeData);
+    expect(fetch).toHaveBeenCalledWith(rpcServerURL, getExpectedRequest('fake', fakeData));
+  });
+});

package/tests/core.spec.ts

@@ -0,0 +1,13 @@
+import {mockFetch} from './mocks';
+import {init} from '../src';
+
+describe('initHttpGateway', () => {
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  test('calls default URL', async () => {
+    init({appId: 'fake'}).catch(() => {});
+    // expect(fetch).toBeCalled();
+  });
+});

package/tests/helpers.spec.ts

@@ -0,0 +1,127 @@
+import {JSONRPCErrorException} from 'json-rpc-2.0';
+import {
+  errorLog,
+  generateErrorBody,
+  generatePromiseObjects,
+  isValidTransferSpec,
+  isValidURL
+} from '../src/helpers/helpers';
+import {TransferSpec} from '../src/models/models';
+
+describe('generatePromiseObjects', () => {
+
+  test('returns object containg promise, rejecter and resolver', () => {
+    const promiseItem = generatePromiseObjects();
+    expect(typeof promiseItem.promise.then).toBe('function');
+    expect(typeof promiseItem.resolver).toBe('function');
+    expect(typeof promiseItem.rejecter).toBe('function');
+  });
+});
+
+describe('errorLog', () => {
+
+  beforeEach(() => {
+    (<any>window).asperaSdkLogs = undefined;
+    jest.spyOn(global.console, 'warn');
+  });
+
+  test('with message and no debug data should store in array and console', () => {
+    const consoleWarnCall = jest.fn();
+    console.warn = consoleWarnCall;
+    const testMessage = 'Test message';
+    expect((<any>window).asperaSdkLogs).toBe(undefined);
+    errorLog(testMessage);
+    expect(consoleWarnCall).toHaveBeenCalled();
+    expect((<any>window).asperaSdkLogs[0].message).toBe(testMessage);
+    expect((<any>window).asperaSdkLogs[0].debugData).toBe(undefined);
+  });
+
+  test('with message and debug data should store in array and console', () => {
+    const consoleWarnCall = jest.fn();
+    console.warn = consoleWarnCall;
+    const testMessage = 'Test message';
+    expect((<any>window).asperaSdkLogs).toBe(undefined);
+    const error = {error: true};
+    errorLog(testMessage, {error: true});
+    expect(consoleWarnCall).toHaveBeenLastCalledWith('Aspera SDK: Test message', error);
+    expect((<any>window).asperaSdkLogs[0].message).toBe(testMessage);
+    expect((<any>window).asperaSdkLogs[0].debugData.error).toBe(true);
+  });
+});
+
+describe('generateErrorBody', () => {
+
+  test('should return error object without debugData if nothing is passed', () => {
+    const errorResponse = generateErrorBody('testing');
+    expect(errorResponse.message).toBe('testing');
+    expect(errorResponse.error).toBe(true);
+    expect(errorResponse.debugData).toBe(undefined);
+  });
+
+  test('should return error object with debugData if data is passed', () => {
+    const errorTest = new JSONRPCErrorException('testing error body', -32002, {foo: 'bar'});
+    const errorResponse = generateErrorBody('testing', errorTest);
+    expect(errorResponse.message).toBe('testing');
+    expect(errorResponse.error).toBe(true);
+    expect(errorResponse.debugData.message).toBe('testing error body');
+    expect(errorResponse.debugData.code).toBe(-32002);
+    expect(errorResponse.debugData.data).toStrictEqual({foo: 'bar'});
+  });
+});
+
+describe('isValidTransferSpec', () => {
+  const transferSpec: TransferSpec = {
+    authentication: 'token',
+    paths: [
+      {
+        source: '/foo'
+      }
+    ],
+    direction: 'receive',
+    remote_host: 'localhost'
+  };
+  const invalidTransferSpecs: any[] = [
+    null,
+    undefined,
+    'transfer',
+    85
+  ];
+
+  test('should return true if valid transferSpec', () => {
+    expect(isValidTransferSpec(transferSpec)).toBe(true);
+  });
+
+  test('should return false if invalid transferSpec', () => {
+    invalidTransferSpecs.forEach(element => {
+      expect(isValidTransferSpec(element)).toBe(false);
+    });
+  });
+});
+
+describe('isValidURL', () => {
+  const validUrls = [
+    'http://www.aspera.us',
+    'https://www.aspera.us',
+    'https://aspera.us',
+    'https://aspera.us/aspera/sdk/latest.json',
+    'https://aspera.us///aspera/sdk',
+  ];
+  const invalidUrls = [
+    'aspera.us',
+    '/aspera/sdk',
+    'aspera',
+  ];
+
+  test('should return true if valid url', () => {
+    validUrls.forEach(url => {
+      expect(isValidURL(url)).toBe(true);
+    });
+  });
+
+  test('should return false if invalid url', () => {
+    invalidUrls.forEach(url => {
+      expect(isValidURL(url)).toBe(false);
+    });
+  });
+});
+

package/tests/http.spec.ts

@@ -0,0 +1,14 @@
+import {apiGet} from '../src/helpers/http';
+import {mockFetch} from './mocks';
+
+describe('apiGet', () => {
+
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  test('GET should call url', () => {
+    apiGet('aspera.us');
+    expect(fetch).toHaveBeenCalledWith('aspera.us', {headers: {'Content-Type': 'application/json'}});
+  });
+});

package/tests/installer.spec.ts

@@ -0,0 +1,135 @@
+import {getInstallerInfo} from '../src/app/installer';
+import {installerUrl} from '../src/constants/constants';
+import {mockFetch} from './mocks';
+
+describe('getInstallerInfo', () => {
+  const defaultHeaders = {headers: {'Content-Type': 'application/json'}};
+
+  beforeEach(() => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'https://downloads.ibmaspera.com/downloads/desktop/macos/1.2.0/stable/universal/ibm-aspera-sdk_1.2.0_macos.dmg'
+        },
+        {
+          'version': '1.2.0',
+          'platform': 'windows',
+          'type': 'msi',
+          'arch': 'x64',
+          'url': 'https://downloads.ibmaspera.com/downloads/desktop/windows/1.2.0/stable/x64/ibm-aspera-sdk_1.2.0.msi'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'rpm',
+          'arch': 'x64',
+          'url': 'https://downloads.ibmaspera.com/downloads/desktop/linux/1.1.9/stable/x64/ibm-aspera-sdk_1.1.9.rpm'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'appimage',
+          'arch': 'x64',
+          'url': 'https://downloads.ibmaspera.com/downloads/desktop/linux/1.1.9/stable/x64/ibm-aspera-sdk_1.1.9.AppImage'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    console.warn = jest.fn();
+  });
+
+  test('called with no options fetches from downloads server by default', () => {
+    getInstallerInfo().catch(() => {});
+    expect(fetch).toHaveBeenCalledWith(`${installerUrl}/latest.json`, defaultHeaders);
+  });
+
+  test('called with no options returns results for specific platform', async () => {
+    Object.defineProperty(window.navigator, 'userAgent', {value : 'Macintosh'});
+    const exp = [
+      {
+        'version': '1.2.0',
+        'platform': 'macos',
+        'type': 'dmg',
+        'arch': 'universal',
+        'url': 'https://downloads.ibmaspera.com/downloads/desktop/macos/1.2.0/stable/universal/ibm-aspera-sdk_1.2.0_macos.dmg'
+      }
+    ];
+    const data = await getInstallerInfo();
+    expect(data.entries).toEqual(exp);
+  });
+
+  test('called with all returns results for all platforms', async () => {
+    const data = await getInstallerInfo({all: true});
+    expect(data.entries.length).toBe(4);
+  });
+
+  test('called with endpoint', () => {
+    getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk'}).catch(() => {});
+    expect(fetch).toHaveBeenCalledWith('https://aspera.us/aspera/sdk/latest.json', defaultHeaders);
+  });
+
+  test('called with endpoint with trailing json file', () => {
+    getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk/latest.json'}).catch(() => {});
+    expect(fetch).toHaveBeenCalledWith('https://aspera.us/aspera/sdk/latest.json', defaultHeaders);
+  });
+
+  test('called with endpoint returns URLs relative to endpoint', async () => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0_macos.dmg'
+        },
+        {
+          'version': '1.2.0',
+          'platform': 'windows',
+          'type': 'msi',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0.msi'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'rpm',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.1.9.rpm'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'appimage',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.1.9.AppImage'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    const data = await getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk', all: true});
+    for (const entry of data.entries) {
+      expect(entry.url.startsWith('https://aspera.us/aspera/sdk/downloads/ibm-aspera-sdk')).toBe(true);
+    }
+  });
+
+  test('called with invalid endpoint rejects', () => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0_macos.dmg'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    return expect(getInstallerInfo({endpoint: 'aspera.us'})).rejects.toMatchObject({error: true});
+  });
+});

package/tests/mocks.ts

@@ -0,0 +1,11 @@
+export const mockFetch = (data: any) =>  {
+  const returnPromise = new Promise(resolver => {
+    resolver(data);
+  });
+  return jest.fn().mockImplementation(() => {
+    return Promise.resolve({
+      ok: true,
+      json:() => returnPromise.catch(() => {}),
+    });
+  });
+};

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/js",
+    "noImplicitAny": true,
+    "module": "node16",
+    "target": "es5",
+    "esModuleInterop": true,
+    "moduleResolution": "node16",
+    "isolatedModules": true
+  },
+  "exclude": [
+    "./example"
+  ]
+}

package/tsconfig.module.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "outDir": "dist/commonjs",
+    "esModuleInterop": true
+  },
+  "exclude": [
+    "node_modules",
+    "example",
+    "dist",
+    "tests"
+  ]
+}

package/typedoc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  out: 'docs',
+  theme: 'default',
+  excludePrivate: false,
+  name: 'IBM Aspera JavaScript Library',
+  hideGenerator: true
+};

package/webpack.config.js

@@ -0,0 +1,35 @@
+const path = require('path');
+const webpack = require('webpack');
+
+const packageFile = require('./package.json');
+let version = '';
+
+if (packageFile.version) {
+  version = `v${packageFile.version}`;
+}
+
+const banner = `IBM Aspera SDK ${version}\nLicensed Materials – Property of IBM\n© Copyright IBM Corp. 2024, 2025\nU.S. Government Users Restricted Rights: Use, duplication or disclosure restricted by\nGSA ADP Schedule Contract with IBM Corp.`;
+
+module.exports = {
+  entry: './src/index.ts',
+  devtool: 'source-map',
+  output: {
+    path: path.resolve(__dirname, 'dist/js'),
+    filename: 'aspera-sdk.js'
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js', '.json']
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: ['ts-loader'],
+        exclude: /node_modules/
+      }
+    ]
+  },
+  plugins: [
+    new webpack.BannerPlugin(banner)
+  ]
+};

package/dist/commonjs/app/core.d.ts

@@ -1,205 +0,0 @@
-import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, 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 declare const testConnection: () => Promise<any>;
-/**
- * Initialize drag and drop. HTTP Gateway does not need to init.
- * Ignore if only HTTP Gateway
- * @param initCall - Indicate if called via init flow and should not reject
- *
- * @returns a promise that resolves if the initialization was successful or not
- */
-export declare const initDragDrop: (initCall?: boolean) => Promise<boolean>;
-/**
- * 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 declare const init: (options?: InitOptions) => Promise<any>;
-/**
- * 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 declare const startTransfer: (transferSpec: TransferSpec, asperaSdkSpec: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;
-/**
- * Register a callback event for getting transfer updates
- *
- * @param callback callback function to receive transfers
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export declare const registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string;
-/**
- * Remove a callback from the transfer callback
- *
- * @param id the ID returned by `registerActivityCallback`
- */
-export declare const deregisterActivityCallback: (id: string) => void;
-/**
- * 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 declare const registerRemovedCallback: (callback: (transfer: AsperaSdkTransfer) => void) => string;
-/**
- * Remove a callback from the removed transfer callback
- *
- * @param id the ID returned by `registerRemovedCallback`
- */
-export declare const deregisterRemovedCallback: (id: string) => void;
-/**
- * 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 declare const registerStatusCallback: (callback: (status: WebsocketEvent) => void) => string;
-/**
- * Remove a callback from getting connection status events.
- *
- * @param id the ID returned by `registerStatusCallback`
- */
-export declare const deregisterStatusCallback: (id: string) => void;
-/**
- * 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 declare const removeTransfer: (id: string) => Promise<any>;
-/**
- * Stop a transfer.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves if transfer is stopped and rejects if transfer cannot be stopped
- */
-export declare const stopTransfer: (id: string) => Promise<any>;
-/**
- * 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 declare const resumeTransfer: (id: string, options?: ResumeTransferOptions) => Promise<AsperaSdkTransfer>;
-/**
- * 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 declare const showSelectFileDialog: (options?: FileDialogOptions) => Promise<DataTransferResponse>;
-/**
- * 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 declare const showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>;
-/**
- * Opens the IBM Aspera preferences page.
- *
- * @returns a promise that resolves when the preferences page is opened.
- */
-export declare const showPreferences: () => Promise<any>;
-/**
- * Get all transfers associated with the current application.
- *
- * @returns a promise that resolves with an array of transfers.
- */
-export declare const getAllTransfers: () => Promise<AsperaSdkTransfer[]>;
-/**
- * Get a specific transfer by ID.
- *
- * @param id transfer uuid
- *
- * @returns a promise that resolves with the transfer.
- */
-export declare const getTransfer: (id: string) => Promise<AsperaSdkTransfer>;
-/**
- * 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 declare const showDirectory: (id: string) => Promise<any>;
-/**
- * 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 declare const modifyTransfer: (id: string, options: ModifyTransferOptions) => Promise<AsperaSdkTransfer>;
-/**
- * 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 declare const setBranding: (id: string, options: CustomBrandingOptions) => Promise<any>;
-/**
- * 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 declare const createDropzone: (callback: (data: {
-    event: DragEvent;
-    files: DataTransferResponse;
-}) => void, elementSelector: string) => void;
-/**
- * Remove dropzone.
- *
- * @param elementSelector the selector of the element on the page that should remove
- */
-export declare const removeDropzone: (elementSelector: string) => void;
-/**
- * Get metadata about the IBM Aspera installation.
- *
- * @returns a promise that returns information about the user's IBM Aspera installation.
- */
-export declare const getInfo: () => Promise<AsperaSdkInfo>;