@ibm-aspera/sdk 0.2.12 → 0.2.29

package/dist/commonjs/app/installer.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstallerInfo = void 0;
-var index_1 = require("../index");
-var helpers_1 = require("../helpers/helpers");
-var http_1 = require("../helpers/http");
-var messages_1 = require("../constants/messages");
-/**
- * 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
- */
-var getInstallerInfo = function (options) {
-    if (options === void 0) { options = {}; }
-    var url = options.endpoint || index_1.asperaSdk.globals.installerUrl;
-    if (url.endsWith('/latest.json')) {
-        url = url.replace('/latest.json', '');
-    }
-    if (!(0, helpers_1.isValidURL)(url)) {
-        return (0, helpers_1.throwError)(messages_1.messages.invalidEndpoint, { url: url });
-    }
-    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
-    (0, http_1.apiGet)("".concat(url, "/latest.json")).then(function (response) {
-        response.json().then(function (data) {
-            if (options.endpoint) {
-                for (var _i = 0, _a = data.entries; _i < _a.length; _i++) {
-                    var entry = _a[_i];
-                    if (!(0, helpers_1.isValidURL)(entry.url)) {
-                        entry.url = "".concat(options.endpoint, "/").concat(entry.url);
-                    }
-                }
-            }
-            if (options.all) {
-                promiseInfo.resolver(data);
-            }
-            else {
-                var platform_1 = (0, helpers_1.getCurrentPlatform)();
-                data.entries = data.entries.filter(function (entry) { return entry.platform === platform_1; });
-                promiseInfo.resolver(data);
-            }
-        });
-    }).catch(function (error) {
-        (0, helpers_1.errorLog)(messages_1.messages.getInstallerError, error);
-        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.getInstallerError, error));
-    });
-    return promiseInfo.promise;
-};
-exports.getInstallerInfo = getInstallerInfo;

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

@@ -1,11 +0,0 @@
-import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
-/**
- * Connect Core Logic
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-export declare const handleTransfers: (transfers: ConnectTypes.TransferInfo[]) => void;
-export declare const connectInstallationFlow: () => void;
-export declare const initConnect: (useIncludedInstaller?: boolean) => Promise<unknown>;

package/dist/commonjs/connect/core.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initConnect = exports.connectInstallationFlow = exports.handleTransfers = void 0;
-var index_1 = require("../index");
-var connect_sdk_js_1 = require("@ibm-aspera/connect-sdk-js");
-var transferMonitorActivated = false;
-var installerFlowActivated = false;
-/**
- * Connect Core Logic
- *
- * @remarks
- * Most logic is called directly by Desktop SDK functions
- * You may not need to import anything from this file.
- */
-var handleTransfers = function (transfers) {
-    index_1.asperaSdk.activityTracking.handleTransferActivity({
-        type: 'transferUpdated',
-        data: { transfers: transfers },
-    });
-};
-exports.handleTransfers = handleTransfers;
-var connectInstallationFlow = function () {
-    if (installerFlowActivated) {
-        return;
-    }
-    installerFlowActivated = true;
-    var handleInstallerEvent = function (eventType, eventStatus) {
-        // Verify that the event matches
-        if (index_1.asperaSdk.globals.connectAW4.Connect.EVENT.STATUS !== eventType) {
-            return;
-        }
-        // Depending on status show the proper installer screen
-        switch (eventStatus) {
-            case index_1.asperaSdk.globals.connectAW4.Connect.STATUS.INITIALIZING:
-                index_1.asperaSdk.globals.connectInstaller.showLaunching();
-                break;
-            case index_1.asperaSdk.globals.connectAW4.Connect.STATUS.EXTENSION_INSTALL:
-                index_1.asperaSdk.globals.connectInstaller.showExtensionInstall();
-                break;
-            case index_1.asperaSdk.globals.connectAW4.Connect.STATUS.FAILED:
-                index_1.asperaSdk.globals.connectInstaller.showDownload();
-                break;
-            case index_1.asperaSdk.globals.connectAW4.Connect.STATUS.OUTDATED:
-                index_1.asperaSdk.globals.connectInstaller.showUpdate();
-                break;
-            case index_1.asperaSdk.globals.connectAW4.Connect.STATUS.RUNNING:
-                index_1.asperaSdk.globals.connectInstaller.connected();
-                break;
-        }
-    };
-    index_1.asperaSdk.globals.connect.addEventListener(index_1.asperaSdk.globals.connectAW4.Connect.EVENT.STATUS, handleInstallerEvent);
-};
-exports.connectInstallationFlow = connectInstallationFlow;
-var initConnect = function (useIncludedInstaller) {
-    index_1.asperaSdk.globals.connect.addEventListener(connect_sdk_js_1.Connect.EVENT.STATUS, function (eventType, eventStatus) {
-        if (eventType === connect_sdk_js_1.Connect.EVENT.STATUS) {
-            index_1.asperaSdk.globals.connectStatus = eventStatus;
-            index_1.asperaSdk.activityTracking.sendManualEventCallback(eventStatus);
-            if (eventStatus === 'RUNNING' && !transferMonitorActivated) {
-                transferMonitorActivated = true;
-                index_1.asperaSdk.globals.connect.addEventListener(connect_sdk_js_1.Connect.EVENT.TRANSFER, function (_event, data) {
-                    (0, exports.handleTransfers)(data.transfers);
-                });
-            }
-        }
-    });
-    index_1.asperaSdk.globals.connect.initSession(index_1.asperaSdk.globals.appId);
-    if (useIncludedInstaller) {
-        (0, exports.connectInstallationFlow)();
-    }
-    return Promise.resolve({ connectMode: true });
-};
-exports.initConnect = initConnect;

package/dist/commonjs/constants/constants.d.ts

@@ -1,8 +0,0 @@
-/** @ignore */
-export declare const hiddenStyleList = "\n  display: none !important;\n  width: 1px !important;\n  height: 1px !important;\n  position: fixed !important;\n  z-index: -99 !important;\n  bottom: 0px !important;\n  right: 0px !important;\n";
-/** @ignore */
-export declare const protocol = "aspera://";
-/** @ignore */
-export declare const baseInstallerUrl = "https://downloads.ibmaspera.com/downloads/desktop";
-/** @ignore */
-export declare const installerUrl = "https://downloads.ibmaspera.com/downloads/desktop/latest/stable";

package/dist/commonjs/constants/constants.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.installerUrl = exports.baseInstallerUrl = exports.protocol = exports.hiddenStyleList = void 0;
-/** @ignore */
-exports.hiddenStyleList = "\n  display: none !important;\n  width: 1px !important;\n  height: 1px !important;\n  position: fixed !important;\n  z-index: -99 !important;\n  bottom: 0px !important;\n  right: 0px !important;\n";
-/** @ignore */
-exports.protocol = 'aspera://';
-/** @ignore */
-exports.baseInstallerUrl = 'https://downloads.ibmaspera.com/downloads/desktop';
-/** @ignore */
-exports.installerUrl = "".concat(exports.baseInstallerUrl, "/latest/stable");

package/dist/commonjs/constants/messages.d.ts

@@ -1,35 +0,0 @@
-/** @ignore */
-export declare const messages: {
-    callbackIsNotFunction: string;
-    dragDropInitFailed: string;
-    dragDropInitFailedInit: string;
-    failedToGenerateIframe: string;
-    getInstallerError: string;
-    getAllTransfersFailed: string;
-    getTransferFailed: string;
-    invalidEndpoint: string;
-    loadingProtocol: string;
-    modifyTransferFailed: string;
-    notValidTransferSpec: string;
-    removeTransferFailed: string;
-    resumeTransferFailed: string;
-    serverError: string;
-    serverNotVerified: string;
-    setBrandingFailed: string;
-    showDirectoryFailed: string;
-    showSelectFileDialogFailed: string;
-    showSelectFolderDialogFailed: string;
-    showPreferencesFailed: string;
-    stopTransferFailed: string;
-    transferFailed: string;
-    unableToFindElementOnPage: string;
-    unableToReadDropped: string;
-    websocketClosedError: string;
-    websocketClosedUnexpect: string;
-    websocketNotReady: string;
-    httpNotAvailable: string;
-    httpInitFail: string;
-    filePickerCancel: string;
-    fileNotAllowed: string;
-    httpNetworkFail: string;
-};

package/dist/commonjs/constants/messages.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.messages = void 0;
-/** @ignore */
-exports.messages = {
-    callbackIsNotFunction: 'The provided callback is not a function',
-    dragDropInitFailed: 'Unable to initialize drag-drop',
-    dragDropInitFailedInit: 'Unable to initialize drag-drop as part of init flow',
-    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',
-    httpNotAvailable: 'IBM Aspera HTTP Gateway is not available',
-    httpInitFail: 'IBM Aspera HTTP Gateway could not be started',
-    filePickerCancel: 'User canceled the select file or folder dialog.',
-    fileNotAllowed: 'TransferSpec contained file not selected by user.',
-    httpNetworkFail: 'HTTP network encountered unknown error.',
-};

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

@@ -1,5 +0,0 @@
-interface Client {
-    request(method: String, payload?: any): Promise<any>;
-}
-export declare const client: Client;
-export default Client;

package/dist/commonjs/helpers/client/client.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.client = void 0;
-var http_client_1 = require("./http-client");
-var safari_client_1 = require("./safari-client");
-var helpers_1 = require("../helpers");
-exports.client = (0, helpers_1.isSafari)() ? safari_client_1.safariClient : http_client_1.httpClient;

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

@@ -1,42 +0,0 @@
-import { JSONRPCClient } from 'json-rpc-2.0';
-import Client from './client';
-export declare const getRpcServerUrl: () => string;
-/**
- * Wraps a promise like object and returns a promise that supports catch.
- *
- * @param promise the HTTP promise like to wrap
- *
- * @returns promise for the HTTP connection with catch supporting error
- */
-export declare const handlePromiseLikeErrors: (promise: PromiseLike<any>) => Promise<any>;
-/**
- * JSON RPC client using HTTP (fetch) as transport.
- */
-declare class JSONRPCHttpClient {
-    /** JSON-RPC client used to make requests */
-    client: JSONRPCClient;
-    constructor();
-    /**
-     * Request handler for the JSON-RPC client. This function is called by the JSON-RPC library
-     * after forming the RPC request.
-     *
-     * @param request JSON-RPC request to send to the server
-     */
-    private handleRequest;
-    request: (method: string, data: any) => PromiseLike<any>;
-}
-/**
- * Client used for making requests to Aspera.
- */
-declare class HttpClient implements Client {
-    /** HTTP client used to make requests */
-    httpClient: JSONRPCHttpClient;
-    constructor();
-    request: (method: string, payload?: any) => Promise<any>;
-}
-export declare const httpClient: HttpClient;
-declare const _default: {
-    httpClient: HttpClient;
-    handlePromiseLikeErrors: (promise: PromiseLike<any>) => Promise<any>;
-};
-export default _default;

package/dist/commonjs/helpers/client/http-client.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpClient = exports.handlePromiseLikeErrors = exports.getRpcServerUrl = void 0;
-var json_rpc_2_0_1 = require("json-rpc-2.0");
-var helpers_1 = require("../helpers");
-var index_1 = require("../../index");
-var getRpcServerUrl = function () {
-    return "".concat(index_1.asperaSdk.globals.asperaAppUrl, ":").concat(index_1.asperaSdk.globals.rpcPort);
-};
-exports.getRpcServerUrl = getRpcServerUrl;
-/**
- * Wraps a promise like object and returns a promise that supports catch.
- *
- * @param promise the HTTP promise like to wrap
- *
- * @returns promise for the HTTP connection with catch supporting error
- */
-var handlePromiseLikeErrors = function (promise) {
-    var promiseInfo = (0, helpers_1.generatePromiseObjects)();
-    promise.then(function (response) {
-        promiseInfo.resolver(response);
-    }, function (error) {
-        promiseInfo.rejecter(error);
-    });
-    return promiseInfo.promise;
-};
-exports.handlePromiseLikeErrors = handlePromiseLikeErrors;
-/**
- * JSON RPC client using HTTP (fetch) as transport.
- */
-var JSONRPCHttpClient = /** @class */ (function () {
-    function JSONRPCHttpClient() {
-        var _this = this;
-        /**
-         * Request handler for the JSON-RPC client. This function is called by the JSON-RPC library
-         * after forming the RPC request.
-         *
-         * @param request JSON-RPC request to send to the server
-         */
-        this.handleRequest = function (request) {
-            var options = {
-                method: 'POST',
-                headers: {
-                    'content-type': 'application/json',
-                },
-                body: (0, helpers_1.safeJsonString)(request),
-            };
-            var rpcServerURL = (0, exports.getRpcServerUrl)();
-            return fetch(rpcServerURL, options).then(function (response) {
-                if (response.ok) {
-                    return response.json().then(function (rpcResponse) { return _this.client.receive(rpcResponse); });
-                }
-                else if (request.id !== undefined) {
-                    throw Promise.reject(response.statusText);
-                }
-            });
-        };
-        this.request = function (method, data) {
-            return _this.client.request(method, data);
-        };
-        this.client = new json_rpc_2_0_1.JSONRPCClient(this.handleRequest);
-    }
-    return JSONRPCHttpClient;
-}());
-/**
- * Client used for making requests to Aspera.
- */
-var HttpClient = /** @class */ (function () {
-    function HttpClient() {
-        var _this = this;
-        this.request = function (method, payload) {
-            if (payload === void 0) { payload = {}; }
-            return (0, exports.handlePromiseLikeErrors)(_this.httpClient.request(method, payload));
-        };
-        this.httpClient = new JSONRPCHttpClient();
-    }
-    ;
-    return HttpClient;
-}());
-exports.httpClient = new HttpClient();
-exports.default = {
-    httpClient: exports.httpClient,
-    handlePromiseLikeErrors: exports.handlePromiseLikeErrors,
-};

package/dist/commonjs/helpers/client/safari-client.d.ts

@@ -1,101 +0,0 @@
-import Client from './client';
-/**
- * Interface representing a promise executor used in a promise.
- */
-export interface PromiseExecutor {
-    resolve: (value: any) => void;
-    reject: (error: any) => void;
-}
-/**
- * Handles communication with the Safari extension using JSON-RPC over custom events.
- */
-export declare class SafariClient implements Client {
-    private keepAliveInterval;
-    private promiseExecutors;
-    private lastPing;
-    private lastPong;
-    private safariExtensionEnabled;
-    private subscribedTransferActivity;
-    /**
-     * Initializes the SafariExtensionHandler instance.
-     * Sets up the promise executor map and starts listening to extension events.
-     */
-    constructor();
-    /**
-     * Sends a JSON-RPC request to the Safari extension.
-     * @param method The method name to invoke on the extension.
-     * @param payload Optional payload for the request.
-     * @returns A Promise that resolves with the response from the extension.
-     */
-    request: (method: string, payload?: any) => Promise<any>;
-    /**
-     * Monitors transfer activity.
-     * @returns A Promise that resolves with the response from the extension.
-     */
-    monitorTransferActivity(): Promise<unknown>;
-    /**
-     * Builds a JSON-RPC request object with a unique identifier.
-     * @param method The method name to invoke on the extension.
-     * @param payload Optional parameters for the method.
-     * @returns The constructed JSON-RPC request object.
-     */
-    private buildRPCRequest;
-    /**
-     * Dispatches a custom event to the document to communicate with the Safari extension.
-     * @param type The type of Safari extension event to dispatch.
-     * @param request Optional JSON-RPC request payload to send with the event.
-     */
-    private dispatchEvent;
-    /**
-     * Dispatches a custom event to the document to communicate with the Safari extension.
-     * @param type The type of Safari extension event to dispatch.
-     * @param method The method name to invoke on the extension.
-     * @param payload Optional parameters for the method.
-     */
-    private dispatchPromiseEvent;
-    /**
-     * Handles incoming JSON-RPC responses from the Safari extension.
-     * Resolves or rejects promises based on the response.
-     * @param response The JSON-RPC response object received from the extension.
-     */
-    private handleResponse;
-    /**
-     * Listens for 'AsperaDesktop.Response' events.
-     */
-    private listenResponseEvents;
-    /**
-     * Listens for 'AsperaDesktop.TransferActivity' events.
-     */
-    private listenTransferActivityEvents;
-    /**
-     * Listens for 'AsperaDesktop.Status' events.
-     */
-    private listenStatusEvents;
-    /**
-     * Listens for 'isAppAlive' events. This was introduced in version 1.0.9.
-     */
-    private listenClientStatusEvents;
-    /**
-     * Listens for 'AsperaDesktop.Pong' events.
-     */
-    private listenPongEvents;
-    /**
-     * Sends a keep alive ping according to the defined interval.
-     */
-    private keepAlive;
-    /**
-     * Listens for Safari extension status changes.
-     * If the extension was disabled and enabled again after initializing the SDK, it
-     * will call 'monitorTransferActivity' to resume transfer activities.
-     */
-    private safariExtensionStatusChanged;
-    /**
-     * Checks if the last pong received was longer than the max interval.
-     */
-    private checkSafariExtensionStatus;
-}
-export declare const safariClient: SafariClient;
-declare const _default: {
-    safariClient: SafariClient;
-};
-export default _default;