@ibm-aspera/sdk 0.2.2

package/dist/commonjs/models/aspera-sdk.model.d.ts

@@ -0,0 +1,213 @@
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent } from './models';
+declare class AsperaSdkGlobals {
+    /** The URL of the IBM Aspera HTTP server to use with the SDK */
+    asperaAppUrl: string;
+    /** The URL of the IBM Aspera Desktop HTTP server to use with the SDK */
+    rpcPort: number;
+    /** The default URL to check for latest Aspera installers */
+    installerUrl: string;
+    /** Aspera SDK info */
+    AsperaSdkInfo: AsperaSdkInfo;
+    /** Indication that the server has been verified as working */
+    asperaAppVerified: boolean;
+    /** The unique ID for the website */
+    appId: string;
+    /** The session ID for the current user */
+    sessionId?: string;
+    /** Map of drop zones created by querySelector */
+    dropZonesCreated: Map<string, {
+        event: string;
+        callback: (event: any) => void;
+    }[]>;
+    backupLaunchMethod(url: string): void;
+    /**
+     * Launch the IBM Aspera App via protocol url. By default, a hidden IFRAME attempts to
+     * open the app but if that fails a fallback of opening a new window happens.
+     */
+    launch(): void;
+}
+export declare class AsperaSdkInfo {
+    /** The version of IBM Aspera SDK */
+    version: string;
+    /** The public key corresponding to the SSH private key generated by IBM Aspera */
+    client_pubkey?: string;
+}
+export declare class TransferResponse {
+    transfers: AsperaSdkTransfer[];
+}
+export type ActivityMessageTypes = 'transferUpdated' | 'transferRemoved';
+export declare class ActivityMessage {
+    type: ActivityMessageTypes;
+    data: unknown;
+}
+export declare class ActivityTracking {
+    /** Map of callbacks that receive transfer update events */
+    private activity_callbacks;
+    /** Map of callbacks that received removed transfer events */
+    private removed_callbacks;
+    /** Map of callbacks that receive connection events */
+    private event_callbacks;
+    /** Map of callbacks that receive Safari extension events */
+    private safari_extension_callbacks;
+    /** Keep track of the last WebSocket event **/
+    private lastWebSocketEvent;
+    /** Keep track of the last Safari extension event **/
+    private lastSafariExtensionEvent;
+    /**
+     * Notify all consumers when a message is received from the websocket
+     *
+     * @param message the message received from the websocket
+     */
+    handleTransferActivity(message: ActivityMessage): void;
+    /**
+     * Notify all consumers when a connection webSocketEvent occurs. For example, when the SDK
+     * websocket connection to IBM Aspera App is closed or reconnected.
+     *
+     * @param webSocketEvent the event type.
+     */
+    handleWebSocketEvents(webSocketEvent: WebsocketEvent): void;
+    /**
+     * Notify all consumers when a Safari extension safariExtensionEvent occurs (enabled/disabled).
+     *
+     * @param safariExtensionEvent the event type.
+     */
+    handleSafariExtensionEvents(safariExtensionEvent: SafariExtensionEvent): void;
+    /**
+     * Set up the activity tracking with IBM Aspera.
+     *
+     * @returns a promise that resolves when the websocket connection is established.
+     * Currently, this promise does not reject.
+     */
+    setup(): Promise<unknown>;
+    /**
+     * Register a callback for getting transfers back to the consumer
+     *
+     * @param callback the function to call with the array of transfers
+     *
+     * @returns the ID of the callback index
+     */
+    setCallback(callback: (transfers: TransferResponse) => void): string;
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    removeCallback(id: string): void;
+    /**
+     * Register a callback for getting transfers back to the consumer
+     *
+     * @param callback the function to call with the array of transfers
+     *
+     * @returns the ID of the callback index
+     */
+    setRemovedCallback(callback: (transfer: AsperaSdkTransfer) => void): string;
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    removeRemovedCallback(id: string): void;
+    /**
+     * Register a callback for getting websocket events back to the consumer
+     *
+     * @param callback the function to call with the websocket event
+     *
+     * @returns the ID of the callback index
+     */
+    setWebSocketEventCallback(callback: (status: WebsocketEvent) => void): string;
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    removeWebSocketEventCallback(id: string): void;
+    /**
+     * Register a callback for getting Safari extension events back to the consumer
+     *
+     * @param callback the function to call with the websocket event
+     *
+     * @returns the ID of the callback index
+     */
+    setSafariExtensionEventCallback(callback: (status: SafariExtensionEvent) => void): string;
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    removeSafariExtensionEventCallback(id: string): void;
+    private registerDesktopAppSession;
+}
+export declare class AsperaSdk {
+    /** Global information about IBM Aspera */
+    globals: AsperaSdkGlobals;
+    /** Activity tracking for watching transfers */
+    activityTracking: ActivityTracking;
+    /** Function to initialize IBM Aspera */
+    init: (options: InitOptions) => Promise<any>;
+    /** Function to test the IBM Aspera status */
+    testConnection: () => Promise<any>;
+    /** Function to initiate a transfer */
+    startTransfer: (transferSpec: TransferSpec, AsperaSdkSpec: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;
+    /** Function to launch IBM Aspera */
+    launch: () => void;
+    /** Register callback for the transfer activity monitor */
+    registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string;
+    /** Deregister callback to remove it from the callbacks getting transfer data */
+    deregisterActivityCallback: (id: string) => void;
+    /** Register callback for removed transfers from the app */
+    registerRemovedCallback: (callback: (transfer: AsperaSdkTransfer) => void) => string;
+    /** Deregister callback to remove it from the callbacks getting removed transfer data */
+    deregisterRemovedCallback: (id: string) => void;
+    /** Register callback for connection status events from the app */
+    registerStatusCallback: (callback: (status: WebsocketEvent) => void) => string;
+    /** Deregister callback to remove it from the callbacks getting connection events */
+    deregisterStatusCallback: (id: string) => void;
+    /** Register callback for Safari extension status events */
+    registerSafariExtensionStatusCallback: (callback: (status: SafariExtensionEvent) => void) => string;
+    /** Deregister callback to remove it from the callbacks getting Safari extension events */
+    deregisterSafariExtensionStatusCallback: (id: string) => void;
+    /** Function to remove a transfer */
+    removeTransfer: (transferId: string) => Promise<any>;
+    /** Function to show the transfer's download directory in Finder or Windows Explorer */
+    showDirectory: (transferId: string) => Promise<any>;
+    /** Function to stop a transfer */
+    stopTransfer: (transferId: string) => Promise<any>;
+    /** Function to resume a transfer */
+    resumeTransfer: (transferId: string, options?: ResumeTransferOptions) => Promise<AsperaSdkTransfer>;
+    /** Function to get a list of all transfers */
+    getAllTransfers: () => Promise<AsperaSdkTransfer[]>;
+    /** Function to get information for a specific transfer */
+    getTransfer: (transferId: string) => Promise<AsperaSdkTransfer>;
+    /** Function to display a file dialog for the user to select files. */
+    showSelectFileDialog: (options?: FileDialogOptions) => Promise<DataTransferResponse>;
+    /** Function to display a folder dialog for the user to select folders. */
+    showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>;
+    /** Function to display the IBM Aspera preferences page */
+    showPreferences: () => Promise<any>;
+    /** Function to modify a running transfer */
+    modifyTransfer: (transferId: string, options: ModifyTransferOptions) => Promise<AsperaSdkTransfer>;
+    /** Function to set custom branding for IBM Aspera */
+    setBranding: (id: string, options: CustomBrandingOptions) => Promise<any>;
+    /** Create dropzone for drop events of files */
+    createDropzone: (callback: (data: {
+        event: any;
+        files: DataTransferResponse;
+    }) => void, elementSelector: string) => void;
+    /** Remove dropzone for drop events of files */
+    removeDropzone: (elementSelector: string) => void;
+    /** Function to get latest installer information */
+    getInstallerInfo: (options: InstallerOptions) => Promise<InstallerInfoResponse>;
+    /** Initialize drag and drop */
+    initDragDrop: () => Promise<any>;
+    /** Function to get information about the IBM Aspera instance */
+    getInfo: () => Promise<AsperaSdkInfo>;
+    /** Function to get whether IBM Aspera is running on Safari */
+    isSafari: () => boolean;
+    /**
+     * Check if IBM Aspera is ready to be used and has been verified.
+     *
+     * @returns a boolean indicating if SDK can be used for requests
+     */
+    get isReady(): boolean;
+}
+export {};

package/dist/commonjs/models/aspera-sdk.model.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsperaSdk = exports.ActivityTracking = exports.ActivityMessage = exports.TransferResponse = exports.AsperaSdkInfo = void 0;
+var constants_1 = require("../constants/constants");
+var messages_1 = require("../constants/messages");
+var safari_client_1 = require("../helpers/client/safari-client");
+var helpers_1 = require("../helpers/helpers");
+var ws_1 = require("../helpers/ws");
+var index_1 = require("../index");
+var AsperaSdkGlobals = /** @class */ (function () {
+    function AsperaSdkGlobals() {
+        /** The URL of the IBM Aspera HTTP server to use with the SDK */
+        this.asperaAppUrl = 'http://127.0.0.1';
+        /** The URL of the IBM Aspera Desktop HTTP server to use with the SDK */
+        this.rpcPort = 33024;
+        /** The default URL to check for latest Aspera installers */
+        this.installerUrl = constants_1.installerUrl;
+        /** Indication that the server has been verified as working */
+        this.asperaAppVerified = false;
+        /** Map of drop zones created by querySelector */
+        this.dropZonesCreated = new Map();
+    }
+    AsperaSdkGlobals.prototype.backupLaunchMethod = function (url) {
+        window.alert(messages_1.messages.loadingProtocol);
+        window.location.href = url;
+    };
+    /**
+     * Launch the IBM Aspera App via protocol url. By default, a hidden IFRAME attempts to
+     * open the app but if that fails a fallback of opening a new window happens.
+     */
+    AsperaSdkGlobals.prototype.launch = function () {
+        var _this = this;
+        try {
+            var element = document.createElement('iframe');
+            element.src = constants_1.protocol;
+            element.onerror = function (error) {
+                (0, helpers_1.errorLog)(messages_1.messages.failedToGenerateIframe, error);
+                _this.backupLaunchMethod(constants_1.protocol);
+            };
+            element.setAttribute('style', constants_1.hiddenStyleList);
+            document.body.appendChild(element);
+        }
+        catch (error) {
+            (0, helpers_1.errorLog)(messages_1.messages.failedToGenerateIframe, error);
+            this.backupLaunchMethod(constants_1.protocol);
+        }
+    };
+    return AsperaSdkGlobals;
+}());
+var AsperaSdkInfo = /** @class */ (function () {
+    function AsperaSdkInfo() {
+    }
+    return AsperaSdkInfo;
+}());
+exports.AsperaSdkInfo = AsperaSdkInfo;
+var TransferResponse = /** @class */ (function () {
+    function TransferResponse() {
+    }
+    return TransferResponse;
+}());
+exports.TransferResponse = TransferResponse;
+var ActivityMessage = /** @class */ (function () {
+    function ActivityMessage() {
+    }
+    return ActivityMessage;
+}());
+exports.ActivityMessage = ActivityMessage;
+var ActivityTracking = /** @class */ (function () {
+    function ActivityTracking() {
+        /** Map of callbacks that receive transfer update events */
+        this.activity_callbacks = new Map();
+        /** Map of callbacks that received removed transfer events */
+        this.removed_callbacks = new Map();
+        /** Map of callbacks that receive connection events */
+        this.event_callbacks = new Map();
+        /** Map of callbacks that receive Safari extension events */
+        this.safari_extension_callbacks = new Map();
+        /** Keep track of the last WebSocket event **/
+        this.lastWebSocketEvent = 'CLOSED';
+        /** Keep track of the last Safari extension event **/
+        this.lastSafariExtensionEvent = 'DISABLED';
+    }
+    /**
+     * Notify all consumers when a message is received from the websocket
+     *
+     * @param message the message received from the websocket
+     */
+    ActivityTracking.prototype.handleTransferActivity = function (message) {
+        if (message.type === 'transferUpdated') {
+            this.activity_callbacks.forEach(function (callback) {
+                if (typeof callback === 'function') {
+                    callback(message.data);
+                }
+            });
+        }
+        if (message.type === 'transferRemoved') {
+            this.removed_callbacks.forEach(function (callback) {
+                if (typeof callback === 'function') {
+                    callback(message.data);
+                }
+            });
+        }
+    };
+    /**
+     * Notify all consumers when a connection webSocketEvent occurs. For example, when the SDK
+     * websocket connection to IBM Aspera App is closed or reconnected.
+     *
+     * @param webSocketEvent the event type.
+     */
+    ActivityTracking.prototype.handleWebSocketEvents = function (webSocketEvent) {
+        if (this.lastWebSocketEvent === webSocketEvent) {
+            return;
+        }
+        this.event_callbacks.forEach(function (callback) {
+            if (typeof callback === 'function') {
+                callback(webSocketEvent);
+            }
+        });
+        this.lastWebSocketEvent = webSocketEvent;
+    };
+    /**
+     * Notify all consumers when a Safari extension safariExtensionEvent occurs (enabled/disabled).
+     *
+     * @param safariExtensionEvent the event type.
+     */
+    ActivityTracking.prototype.handleSafariExtensionEvents = function (safariExtensionEvent) {
+        if (this.lastSafariExtensionEvent === safariExtensionEvent) {
+            return;
+        }
+        this.safari_extension_callbacks.forEach(function (callback) {
+            if (typeof callback === 'function') {
+                callback(safariExtensionEvent);
+            }
+        });
+        this.lastSafariExtensionEvent = safariExtensionEvent;
+    };
+    /**
+     * Set up the activity tracking with IBM Aspera.
+     *
+     * @returns a promise that resolves when the websocket connection is established.
+     * Currently, this promise does not reject.
+     */
+    ActivityTracking.prototype.setup = function () {
+        var _this = this;
+        if (index_1.asperaSdk.globals.sessionId) {
+            this.registerDesktopAppSession();
+        }
+        if ((0, helpers_1.isSafari)()) {
+            return safari_client_1.safariClient.monitorTransferActivity();
+        }
+        return ws_1.websocketService.init()
+            .then(function () {
+            ws_1.websocketService.registerMessage('transfer_activity', function (data) { return _this.handleTransferActivity(data); });
+            ws_1.websocketService.registerEvent(function (status) { return _this.handleWebSocketEvents(status); });
+        });
+    };
+    /**
+     * Register a callback for getting transfers back to the consumer
+     *
+     * @param callback the function to call with the array of transfers
+     *
+     * @returns the ID of the callback index
+     */
+    ActivityTracking.prototype.setCallback = function (callback) {
+        if (typeof callback !== 'function') {
+            (0, helpers_1.errorLog)(messages_1.messages.callbackIsNotFunction);
+            return;
+        }
+        var id = "callback-".concat(this.activity_callbacks.size + 1);
+        this.activity_callbacks.set(id, callback);
+        return id;
+    };
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    ActivityTracking.prototype.removeCallback = function (id) {
+        this.activity_callbacks.delete(id);
+    };
+    /**
+     * Register a callback for getting transfers back to the consumer
+     *
+     * @param callback the function to call with the array of transfers
+     *
+     * @returns the ID of the callback index
+     */
+    ActivityTracking.prototype.setRemovedCallback = function (callback) {
+        if (typeof callback !== 'function') {
+            (0, helpers_1.errorLog)(messages_1.messages.callbackIsNotFunction);
+            return;
+        }
+        var id = "callback-".concat(this.removed_callbacks.size + 1);
+        this.removed_callbacks.set(id, callback);
+        return id;
+    };
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    ActivityTracking.prototype.removeRemovedCallback = function (id) {
+        this.removed_callbacks.delete(id);
+    };
+    /**
+     * Register a callback for getting websocket events back to the consumer
+     *
+     * @param callback the function to call with the websocket event
+     *
+     * @returns the ID of the callback index
+     */
+    ActivityTracking.prototype.setWebSocketEventCallback = function (callback) {
+        if (typeof callback !== 'function') {
+            (0, helpers_1.errorLog)(messages_1.messages.callbackIsNotFunction);
+            return;
+        }
+        var id = "callback-".concat(this.event_callbacks.size + 1);
+        this.event_callbacks.set(id, callback);
+        callback(this.lastWebSocketEvent);
+        return id;
+    };
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    ActivityTracking.prototype.removeWebSocketEventCallback = function (id) {
+        this.event_callbacks.delete(id);
+    };
+    /**
+     * Register a callback for getting Safari extension events back to the consumer
+     *
+     * @param callback the function to call with the websocket event
+     *
+     * @returns the ID of the callback index
+     */
+    ActivityTracking.prototype.setSafariExtensionEventCallback = function (callback) {
+        if (typeof callback !== 'function') {
+            (0, helpers_1.errorLog)(messages_1.messages.callbackIsNotFunction);
+            return;
+        }
+        var id = "callback-".concat(this.safari_extension_callbacks.size + 1);
+        this.safari_extension_callbacks.set(id, callback);
+        callback(this.lastSafariExtensionEvent);
+        return id;
+    };
+    /**
+     * Remove the callback (deregister) from the list of callbacks
+     *
+     * @param id the string of the callback to remove
+     */
+    ActivityTracking.prototype.removeSafariExtensionEventCallback = function (id) {
+        this.safari_extension_callbacks.delete(id);
+    };
+    ActivityTracking.prototype.registerDesktopAppSession = function () {
+        var iframe = document.createElement('iframe');
+        iframe.style.display = 'none';
+        iframe.src = "aspera://initialize?app_id=".concat(index_1.asperaSdk.globals.appId, "&session_id=").concat(index_1.asperaSdk.globals.sessionId);
+        document.body.appendChild(iframe);
+        setTimeout(function () {
+            document.body.removeChild(iframe);
+        }, 1000);
+    };
+    return ActivityTracking;
+}());
+exports.ActivityTracking = ActivityTracking;
+var AsperaSdk = /** @class */ (function () {
+    function AsperaSdk() {
+        /** Global information about IBM Aspera */
+        this.globals = new AsperaSdkGlobals();
+        /** Activity tracking for watching transfers */
+        this.activityTracking = new ActivityTracking();
+    }
+    Object.defineProperty(AsperaSdk.prototype, "isReady", {
+        /**
+         * Check if IBM Aspera is ready to be used and has been verified.
+         *
+         * @returns a boolean indicating if SDK can be used for requests
+         */
+        get: function () {
+            return this.globals.asperaAppVerified && this.globals.appId !== '';
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return AsperaSdk;
+}());
+exports.AsperaSdk = AsperaSdk;