@ibm-aspera/sdk 0.2.9 → 0.2.29

package/dist/commonjs/helpers/helpers.d.ts

@@ -1,109 +0,0 @@
-import { ErrorResponse, InstallerUrlInfo, PromiseObject, TransferSpec } from '../models/models';
-/**
- * Generates promise object that can be resolved or rejected via functions
- *
- * @returns an object containing the promise, the resolver and rejecter
- */
-export declare const generatePromiseObjects: () => PromiseObject;
-/**
- * Log errors from Aspera SDK
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- */
-export declare const errorLog: (message: string, debugData?: any) => void;
-/**
- * Generate error object for rejecter responses
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- *
- * @returns object containing standardized error response
- */
-export declare const generateErrorBody: (message: string, debugData?: any) => ErrorResponse;
-/**
- * Validate if transferSpec is valid for server communication
- *
- * @param transferSpec the transferSpec to test
- *
- * @returns boolean indicating whether supplied transferSpec is valid
- */
-export declare const isValidTransferSpec: (transferSpec: TransferSpec) => boolean;
-/**
- * Returns a string indicating the websocket URL to use for talking to the server
- *
- * @returns a string of the full Websocket URL
- */
-export declare const getWebsocketUrl: (serverUrl: string) => string;
-/**
- * Simple function to get the current platform.
- *
- * @returns a string indicating the current platform
- */
-export declare const getCurrentPlatform: () => "macos" | "windows" | "linux" | "unknown";
-/**
- * Function used to create a random UUID
- *
- * @returns string
- */
-export declare const randomUUID: () => string;
-/**
- * Return a rejected promise
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- *
- * @returns a rejected promise
- */
-export declare const throwError: (message: string, debugData?: any) => Promise<any>;
-/**
- * Check if the given string is a valid URL
- *
- * @param url string to check if valid URL
- *
- * @returns boolean
- */
-export declare const isValidURL: (url: string) => boolean;
-/**
- * Checks if the current browser is Safari.
- * @returns {boolean} Whether the browser is Safari.
- */
-export declare const isSafari: () => boolean;
-/**
- * Get the URLs for installer management.
- *
- * @returns Info on URLs where installers live
- */
-export declare const getInstallerUrls: () => InstallerUrlInfo;
-/**
- * Try to stringify a JSON string and log failures
- *
- * @param json - Object to make into a string
- *
- * @returns string representing JSON or empty string on error
- */
-export declare const safeJsonString: (json: unknown) => string;
-/**
- * Try to parse a JSON string and log failures
- *
- * @param json - String to make into an object
- *
- * @returns object or array from the JSON string. Or undefined
- */
-export declare const safeJsonParse: (json: string) => any | undefined;
-declare const _default: {
-    errorLog: (message: string, debugData?: any) => void;
-    generateErrorBody: (message: string, debugData?: any) => ErrorResponse;
-    generatePromiseObjects: () => PromiseObject;
-    getCurrentPlatform: () => "macos" | "windows" | "linux" | "unknown";
-    getWebsocketUrl: (serverUrl: string) => string;
-    isSafari: () => boolean;
-    isValidURL: (url: string) => boolean;
-    isValidTransferSpec: (transferSpec: TransferSpec) => boolean;
-    randomUUID: () => string;
-    throwError: (message: string, debugData?: any) => Promise<any>;
-    getInstallerUrls: () => InstallerUrlInfo;
-    safeJsonString: (json: unknown) => string;
-    safeJsonParse: (json: string) => any | undefined;
-};
-export default _default;

package/dist/commonjs/helpers/helpers.js

@@ -1,249 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJsonParse = exports.safeJsonString = exports.getInstallerUrls = exports.isSafari = exports.isValidURL = exports.throwError = exports.randomUUID = exports.getCurrentPlatform = exports.getWebsocketUrl = exports.isValidTransferSpec = exports.generateErrorBody = exports.errorLog = exports.generatePromiseObjects = void 0;
-var constants_1 = require("../constants/constants");
-/**
- * Generates promise object that can be resolved or rejected via functions
- *
- * @returns an object containing the promise, the resolver and rejecter
- */
-var generatePromiseObjects = function () {
-    var resolver;
-    var rejecter;
-    var promise = new Promise(function (resolve, reject) {
-        resolver = resolve;
-        rejecter = reject;
-    });
-    return {
-        promise: promise,
-        resolver: resolver,
-        rejecter: rejecter
-    };
-};
-exports.generatePromiseObjects = generatePromiseObjects;
-/**
- * Log errors from Aspera SDK
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- */
-var errorLog = function (message, debugData) {
-    if (debugData && debugData.code && debugData.message) {
-        debugData = {
-            code: debugData.code,
-            message: debugData.message,
-            data: debugData.data
-        };
-    }
-    if (typeof window === 'object') {
-        if (!Array.isArray(window.asperaSdkLogs)) {
-            window.asperaSdkLogs = [];
-        }
-        window.asperaSdkLogs.push({ message: message, debugData: debugData });
-    }
-    console.warn("Aspera SDK: ".concat(message), debugData);
-};
-exports.errorLog = errorLog;
-/**
- * Generate error object for rejecter responses
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- *
- * @returns object containing standardized error response
- */
-var generateErrorBody = function (message, debugData) {
-    var errorResponse = {
-        error: true,
-        message: message
-    };
-    if (debugData && debugData.code && debugData.message) {
-        errorResponse.debugData = {
-            code: debugData.code,
-            message: debugData.message,
-            data: debugData.data
-        };
-    }
-    return errorResponse;
-};
-exports.generateErrorBody = generateErrorBody;
-/**
- * Validate if transferSpec is valid for server communication
- *
- * @param transferSpec the transferSpec to test
- *
- * @returns boolean indicating whether supplied transferSpec is valid
- */
-var isValidTransferSpec = function (transferSpec) {
-    if (transferSpec &&
-        typeof transferSpec === 'object' &&
-        typeof transferSpec.direction === 'string' &&
-        typeof transferSpec.remote_host === 'string' &&
-        Array.isArray(transferSpec.paths)) {
-        return true;
-    }
-    return false;
-};
-exports.isValidTransferSpec = isValidTransferSpec;
-/**
- * Returns a string indicating the websocket URL to use for talking to the server
- *
- * @returns a string of the full Websocket URL
- */
-var getWebsocketUrl = function (serverUrl) {
-    var wsProtocol;
-    if (serverUrl.indexOf('http:') === 0) {
-        wsProtocol = 'ws';
-    }
-    else if (serverUrl.indexOf('https:') === 0) {
-        wsProtocol = 'wss';
-    }
-    var url = serverUrl.replace('http://', '//').replace('https://', '//');
-    return "".concat(wsProtocol, ":").concat(url);
-};
-exports.getWebsocketUrl = getWebsocketUrl;
-/**
- * Simple function to get the current platform.
- *
- * @returns a string indicating the current platform
- */
-var getCurrentPlatform = function () {
-    var ua = navigator.userAgent;
-    if (/Mac/.test(ua)) {
-        return 'macos';
-    }
-    else if (/Win/.test(ua)) {
-        return 'windows';
-    }
-    else if (/Linux/.test(ua)) {
-        return 'linux';
-    }
-    else {
-        return 'unknown';
-    }
-};
-exports.getCurrentPlatform = getCurrentPlatform;
-/**
- * Function used to create a random UUID
- *
- * @returns string
- */
-var randomUUID = function () {
-    var _a;
-    var fallback = function () {
-        return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-            var r = Number(((new Date().getTime() + 16) * Math.random()).toFixed()) % 16;
-            if (c !== 'x') {
-                // eslint-disable-next-line no-bitwise
-                r = r & 0x3 | 0x8;
-            }
-            return r.toString(16);
-        });
-    };
-    return ((_a = window.crypto) === null || _a === void 0 ? void 0 : _a.randomUUID) ? window.crypto.randomUUID() : fallback();
-};
-exports.randomUUID = randomUUID;
-/**
- * Return a rejected promise
- *
- * @param message the message indicating the error encountered
- * @param debugData the data with useful debugging information
- *
- * @returns a rejected promise
- */
-var throwError = function (message, debugData) {
-    (0, exports.errorLog)(message, debugData);
-    return new Promise(function (resolve, reject) {
-        reject((0, exports.generateErrorBody)(message, debugData));
-    });
-};
-exports.throwError = throwError;
-/**
- * Check if the given string is a valid URL
- *
- * @param url string to check if valid URL
- *
- * @returns boolean
- */
-var isValidURL = function (url) {
-    try {
-        new URL(url);
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-};
-exports.isValidURL = isValidURL;
-/**
- * Checks if the current browser is Safari.
- * @returns {boolean} Whether the browser is Safari.
- */
-var isSafari = function () {
-    return /^((?!chrome|android).)*safari/i.test(navigator.userAgent) && !window.MSStream;
-};
-exports.isSafari = isSafari;
-/**
- * Get the URLs for installer management.
- *
- * @returns Info on URLs where installers live
- */
-var getInstallerUrls = function () {
-    return {
-        base: constants_1.baseInstallerUrl,
-        latest: constants_1.installerUrl,
-    };
-};
-exports.getInstallerUrls = getInstallerUrls;
-/**
- * Try to stringify a JSON string and log failures
- *
- * @param json - Object to make into a string
- *
- * @returns string representing JSON or empty string on error
- */
-var safeJsonString = function (json) {
-    try {
-        return JSON.stringify(json);
-    }
-    catch (error) {
-        (0, exports.errorLog)('safeJsonString: unable to stringify JSON', { error: error, json: json });
-        return '';
-    }
-};
-exports.safeJsonString = safeJsonString;
-/**
- * Try to parse a JSON string and log failures
- *
- * @param json - String to make into an object
- *
- * @returns object or array from the JSON string. Or undefined
- */
-var safeJsonParse = function (json) {
-    if (json && typeof json === 'object') {
-        return json;
-    }
-    try {
-        return JSON.parse(json);
-    }
-    catch (error) {
-        (0, exports.errorLog)('safeJsonParse: unable to parse JSON', { error: error, json: json });
-        return undefined;
-    }
-};
-exports.safeJsonParse = safeJsonParse;
-exports.default = {
-    errorLog: exports.errorLog,
-    generateErrorBody: exports.generateErrorBody,
-    generatePromiseObjects: exports.generatePromiseObjects,
-    getCurrentPlatform: exports.getCurrentPlatform,
-    getWebsocketUrl: exports.getWebsocketUrl,
-    isSafari: exports.isSafari,
-    isValidURL: exports.isValidURL,
-    isValidTransferSpec: exports.isValidTransferSpec,
-    randomUUID: exports.randomUUID,
-    throwError: exports.throwError,
-    getInstallerUrls: exports.getInstallerUrls,
-    safeJsonString: exports.safeJsonString,
-    safeJsonParse: exports.safeJsonParse,
-};

package/dist/commonjs/helpers/http.d.ts

@@ -1,16 +0,0 @@
-/**
- * Check HTTP promise response for server error response (non 2XX status) and reject promise is error
- *
- * @param promise the HTTP promise to check for HTTP status code of 2XX for success
- *
- * @returns promise for the HTTP connection with catch supporting error
- */
-export declare const handlePromiseErrors: (promise: Promise<any>) => Promise<any>;
-/**
- * Make a GET for retrieving data from a server
- *
- * @param url the url string of the resource on the server
- *
- * @returns a promise that will resolve with the response from the server or reject if network/server error
- */
-export declare const apiGet: (url: string) => Promise<any>;

package/dist/commonjs/helpers/http.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiGet = exports.handlePromiseErrors = void 0;
-var helpers_1 = require("./helpers");
-/**
- * Check HTTP promise response for server error response (non 2XX status) and reject promise is error
- *
- * @param promise the HTTP promise to check for HTTP status code of 2XX for success
- *
- * @returns promise for the HTTP connection with catch supporting error
- */
-var handlePromiseErrors = function (promise) {
-    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
-    promise.then(function (response) {
-        if (response.ok) {
-            promiseInfo.resolver(response);
-        }
-        else {
-            promiseInfo.rejecter(response);
-        }
-        return response;
-    }).catch(function (error) {
-        promiseInfo.rejecter(error);
-    });
-    return promiseInfo.promise;
-};
-exports.handlePromiseErrors = handlePromiseErrors;
-/**
- * Make a GET for retrieving data from a server
- *
- * @param url the url string of the resource on the server
- *
- * @returns a promise that will resolve with the response from the server or reject if network/server error
- */
-var apiGet = function (url) {
-    return (0, exports.handlePromiseErrors)(fetch(url, {
-        headers: {
-            'Content-Type': 'application/json',
-        },
-    }));
-};
-exports.apiGet = apiGet;

package/dist/commonjs/helpers/ws.d.ts

@@ -1,62 +0,0 @@
-import { WebsocketTopics } from '../models/models';
-export declare class WebsocketService {
-    /** The main websocket connection to Aspera App*/
-    private globalSocket;
-    /** A map of requested subscription names and the callback for them */
-    private sockets;
-    /** The callback for websocket events */
-    private eventListener;
-    /** Indicator if the websocket is already connected */
-    private isConnected;
-    /** Global promise object that resolves when init completes */
-    private initPromise;
-    /** Log call for not being ready */
-    private handleNotReady;
-    /**
-     * This function handles when a connection is opened
-     */
-    private handleOpen;
-    /**
-     * This function handles completed subscription
-     */
-    private handleClose;
-    /**
-     * This function handles errors received from the websocket
-     */
-    private handleError;
-    /**
-     * This function handles messages received from the websocket
-     */
-    private handleMessage;
-    /**
-     * This function joins the channel to be able to subscribe to events
-     */
-    private joinChannel;
-    /**
-     * This function registers clients to listen to a certain message name. Returns any to allow functions to declare proper type
-     *
-     * @param messageName - the name of messages to listen to (one message name per subscription)
-     * @param callback - the callback function
-     */
-    registerMessage(messageName: WebsocketTopics, callback: Function): void;
-    /**
-     *
-     * @param callback This function registers clients to a certain WebSocket event.
-     *
-     * @param callback - the callback function to call with the event name.
-     */
-    registerEvent(callback: Function): void;
-    /**
-     * This function starts the websocket subscription with the websocket provider
-     *
-     * @returns a promise that resolves when the websocket connection is established
-     */
-    init(): Promise<unknown>;
-    private connect;
-    private reconnect;
-    private getWebSocketConnection;
-    private notifyEvent;
-    private updateRpcPort;
-}
-export declare const websocketService: WebsocketService;
-export default WebsocketService;

package/dist/commonjs/helpers/ws.js

@@ -1,176 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.websocketService = exports.WebsocketService = void 0;
-var helpers_1 = require("./helpers");
-var messages_1 = require("../constants/messages");
-var index_1 = require("../index");
-var WebsocketService = /** @class */ (function () {
-    function WebsocketService() {
-        var _this = this;
-        /** A map of requested subscription names and the callback for them */
-        this.sockets = new Map();
-        /** Indicator if the websocket is already connected */
-        this.isConnected = false;
-        /** Global promise object that resolves when init completes */
-        this.initPromise = (0, helpers_1.generatePromiseObjects)();
-        /**
-         * This function handles when a connection is opened
-         */
-        this.handleOpen = function () {
-            if (_this.isConnected || !_this.joinChannel()) {
-                return;
-            }
-            _this.isConnected = true;
-            _this.updateRpcPort();
-            _this.notifyEvent('RECONNECT');
-        };
-        /**
-         * This function handles completed subscription
-         */
-        this.handleClose = function () {
-            if (_this.isConnected) {
-                _this.isConnected = false;
-                _this.notifyEvent('CLOSED');
-            }
-            if (!_this.globalSocket) {
-                _this.handleNotReady();
-                return;
-            }
-            _this.reconnect();
-        };
-        /**
-         * This function handles errors received from the websocket
-         */
-        this.handleError = function () {
-            (0, helpers_1.errorLog)(messages_1.messages.websocketClosedError);
-        };
-        /**
-         * This function handles messages received from the websocket
-         */
-        this.handleMessage = function (message) {
-            var data = (0, helpers_1.safeJsonParse)(message.data);
-            // Message we get on subscription
-            if (data && data.id === 1) {
-                _this.initPromise.resolver(data);
-                return;
-            }
-            var socket = _this.sockets.get(data.method);
-            if (socket && data.params) {
-                socket(data.params);
-            }
-        };
-    }
-    /** Log call for not being ready */
-    WebsocketService.prototype.handleNotReady = function () {
-        (0, helpers_1.errorLog)(messages_1.messages.websocketNotReady);
-    };
-    /**
-     * This function joins the channel to be able to subscribe to events
-     */
-    WebsocketService.prototype.joinChannel = function () {
-        if (!this.globalSocket) {
-            this.handleNotReady();
-            return false;
-        }
-        this.globalSocket.send((0, helpers_1.safeJsonString)({ jsonrpc: '2.0', method: 'subscribe_transfer_activity', params: [index_1.asperaSdk.globals.appId], id: 1 }));
-        return true;
-    };
-    /**
-     * This function registers clients to listen to a certain message name. Returns any to allow functions to declare proper type
-     *
-     * @param messageName - the name of messages to listen to (one message name per subscription)
-     * @param callback - the callback function
-     */
-    WebsocketService.prototype.registerMessage = function (messageName, callback) {
-        if (!this.sockets.get(messageName)) {
-            this.sockets.set(messageName, function (data) {
-                callback(data.result);
-            });
-        }
-    };
-    /**
-     *
-     * @param callback This function registers clients to a certain WebSocket event.
-     *
-     * @param callback - the callback function to call with the event name.
-     */
-    WebsocketService.prototype.registerEvent = function (callback) {
-        this.eventListener = callback;
-        this.eventListener(this.isConnected ? 'RECONNECT' : 'CLOSED');
-    };
-    /**
-     * This function starts the websocket subscription with the websocket provider
-     *
-     * @returns a promise that resolves when the websocket connection is established
-     */
-    WebsocketService.prototype.init = function () {
-        this.connect();
-        return this.initPromise.promise;
-    };
-    WebsocketService.prototype.connect = function () {
-        var _this = this;
-        this.getWebSocketConnection(33024, index_1.asperaSdk.globals.supportMultipleUsers ? 33029 : 33024)
-            .then(function (webSocket) {
-            _this.globalSocket = webSocket;
-            _this.globalSocket.onerror = _this.handleError;
-            _this.globalSocket.onclose = _this.handleClose;
-            _this.globalSocket.onopen = _this.handleOpen;
-            _this.globalSocket.onmessage = _this.handleMessage;
-            _this.handleOpen();
-        }).catch(function () {
-            _this.reconnect();
-        });
-    };
-    WebsocketService.prototype.reconnect = function () {
-        var _this = this;
-        if (this.globalSocket) {
-            this.globalSocket.close();
-        }
-        setTimeout(function () {
-            _this.connect();
-        }, 1000);
-    };
-    WebsocketService.prototype.getWebSocketConnection = function (startPort, endPort) {
-        var webSocketUrl = (0, helpers_1.getWebsocketUrl)(index_1.asperaSdk.globals.asperaAppUrl);
-        var checkPort = function (port) {
-            return new Promise(function (resolve, reject) {
-                var webSocket = new WebSocket("".concat(webSocketUrl, ":").concat(port));
-                webSocket.onopen = function () {
-                    resolve(webSocket);
-                };
-                webSocket.onerror = function () {
-                    reject("Connection failed on port ".concat(port));
-                };
-            });
-        };
-        return new Promise(function (resolve, reject) {
-            var connectPort = function (port) {
-                if (port > endPort) {
-                    return reject('No available WebSocket connection found');
-                }
-                checkPort(port)
-                    .then(function (ws) { return resolve(ws); })
-                    .catch(function (error) {
-                    connectPort(port + 1);
-                });
-            };
-            connectPort(startPort);
-        });
-    };
-    WebsocketService.prototype.notifyEvent = function (event) {
-        if (typeof this.eventListener === 'function') {
-            this.eventListener(event);
-        }
-    };
-    WebsocketService.prototype.updateRpcPort = function () {
-        if (!this.globalSocket) {
-            return;
-        }
-        var url = new URL(this.globalSocket.url);
-        index_1.asperaSdk.globals.rpcPort = Number(url.port);
-    };
-    return WebsocketService;
-}());
-exports.WebsocketService = WebsocketService;
-exports.websocketService = new WebsocketService();
-exports.default = WebsocketService;