@ibm-aspera/sdk 0.2.29 → 0.4.12

package/README.md

@@ -1,7 +1,12 @@
 # IBM Aspera JavaScript SDK
-This JavaScript SDK allows web applications to integrate with `IBM Aspera for desktop` to perform high-speed Aspera file transfers.
+This JavaScript SDK allows web applications to integrate with Aspera transfer clients to perform high-speed Aspera file transfers.
 
-Documentation is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js/docs/)
+Supported transfer clients:
+- IBM Aspera for desktop
+- IBM Aspera HTTP Gateway
+- IBM Aspera Connect
+
+Example code is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js) with TypeDoc documentation [here](https://ibm.github.io/aspera-sdk-js/docs/).
 
 ## Installation
 Install via npm:
@@ -10,19 +15,18 @@ Install via npm:
 $ npm install --save @ibm-aspera/sdk
 ```
 
-Install from source:
+To include this SDK via `script` tag directly in your web application's HTML, refer to third-party CDNs such as jsDelivr:
 
-```shell
-$ git clone https://github.com/IBM/aspera-sdk-js.git
-$ cd aspera-sdk-js
-$ npm install
+```html
+<script src="https://cdn.jsdelivr.net/npm/@ibm-aspera/sdk@0.2.30/dist/js/aspera-sdk.js"></script>
 ```
 
-When installing from source, the `dist` directory includes a `js` directory that contains the bundled JavaScript SDK that can be included via `script` tag
-or copied to a web server for hosting.
+## Usage
+
+The full API of this SDK can be found [here](https://ibm.github.io/aspera-sdk-js/docs/) with many [code examples](https://github.com/IBM/aspera-sdk-js/blob/main/examples).
+
+Along with the examples, you can find an example test application [here](https://ibm.github.io/aspera-sdk-js/all).
 
-## Development
-To get started with development, take a look [here](https://github.com/IBM/aspera-sdk-js/blob/main/docs/DEVELOPMENT.md).
+## Migration from Connect SDK
 
-## Code Example and test application
-You can run the test appp by running `npm run start:example` which will launch the browser to the test app.
+Refer to [MIGRATION](MIGRATION.md) for recommended changes when migrating your web application from the Connect SDK (`@ibm-aspera/connect-sdk-js`).

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

@@ -0,0 +1,234 @@
+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 * 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
+ * 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 and Connect 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 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
+ * @param connectOptions options for connect
+ */
+export declare const createDropzone: (callback: (data: {
+    event: DragEvent;
+    files: DataTransferResponse;
+}) => void, elementSelector: string, connectOptions?: ConnectTypes.DragDropOptions) => 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>;
+/**
+ * Read an entire file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum file size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ *
+ * @returns a promise that resolves with the file data as a base64-encoded string and mime type
+ */
+export declare const readAsArrayBuffer: (path: string) => Promise<ReadAsArrayBufferResponse>;
+/**
+ * Read a chunk of a file as an array buffer (base64-encoded).
+ *
+ * Note: The maximum chunk size allowed is 50 MiB.
+ *
+ * @param path path to the file to read
+ * @param offset offset to start reading the file, in bytes
+ * @param chunkSize the size of the chunk to read, in bytes
+ *
+ * @returns a promise that resolves with the file chunk data as a base64-encoded string and mime type
+ */
+export declare const readChunkAsArrayBuffer: (path: string, offset: number, chunkSize: number) => Promise<ReadChunkAsArrayBufferResponse>;
+/**
+ * Returns an object describing the high-level capabilities supported by the user's
+ * transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).
+ *
+ * Use this for feature detection at a semantic level rather than checking individual RPC methods.
+ * Capabitilies may depend on multiple underlying RPC methods and also may vary by transfer client.
+ *
+ * Some capabitilies may depend on newer versions of the transfer client. This function may be useful
+ * if you want to conditionally perform certain actions rather than potentially getting an error.
+ *
+ * @returns an object with boolean flags for each capability.
+ *
+ * @example
+ * // Conditionally render UI based on capabilities
+ * const caps = asperaSdk.getCapabilities();
+ * // Determine if your web application can render image previews for user selected files
+ * if (caps.imagePreview) {
+ *   asperaSdk.readAsArrayBuffer(path);
+ * }
+ */
+export declare const getCapabilities: () => SdkCapabilities;