@ibm-aspera/sdk 0.2.7 → 0.2.9

package/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ibm-mend-config/mend-config@main"
+}

package/README.md

@@ -1,5 +1,5 @@
 # IBM Aspera JavaScript SDK
-This JavaScript SDK allows web applications to integrate with IBM Aspera to perform high-speed Aspera file transfers.
+This JavaScript SDK allows web applications to integrate with `IBM Aspera for desktop` to perform high-speed Aspera file transfers.
 
 Documentation is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js/docs/)
 

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

@@ -1,5 +1,5 @@
 import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent } from '../models/models';
+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.
@@ -8,11 +8,13 @@ import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTr
  */
 export declare const testConnection: () => Promise<any>;
 /**
- * Initialize drag and drop.
+ * 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: () => Promise<boolean>;
+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.
@@ -36,7 +38,7 @@ 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
+ * @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
  */
@@ -89,22 +91,6 @@ export declare const registerStatusCallback: (callback: (status: WebsocketEvent)
  * @param id the ID returned by `registerStatusCallback`
  */
 export declare const deregisterStatusCallback: (id: string) => void;
-/**
- * Register a callback for getting updates about the Safari extension status.
- *
- * This can be useful if you want to handle the case where the user enable or disable the Safari extension.
- *
- * @param callback callback function to receive events
- *
- * @returns ID representing the callback for deregistration purposes
- */
-export declare const registerSafariExtensionStatusCallback: (callback: (status: SafariExtensionEvent) => void) => string;
-/**
- * Remove a callback from getting Safari extension status events.
- *
- * @param id the ID returned by `registerStatusCallback`
- */
-export declare const deregisterSafariExtensionStatusCallback: (id: string) => void;
 /**
  * Remove a transfer. This will stop the transfer if it is in progress.
  *
@@ -202,7 +188,7 @@ export declare const setBranding: (id: string, options: CustomBrandingOptions) =
  * @param elementSelector the selector of the element on the page that should watch for drop events
  */
 export declare const createDropzone: (callback: (data: {
-    event: any;
+    event: DragEvent;
     files: DataTransferResponse;
 }) => void, elementSelector: string) => void;
 /**

package/dist/commonjs/app/core.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = exports.getTransfer = exports.getAllTransfers = exports.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.resumeTransfer = exports.stopTransfer = exports.removeTransfer = exports.deregisterSafariExtensionStatusCallback = exports.registerSafariExtensionStatusCallback = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.deregisterRemovedCallback = exports.registerRemovedCallback = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.startTransfer = exports.init = exports.initDragDrop = exports.testConnection = void 0;
+exports.getInfo = exports.removeDropzone = exports.createDropzone = exports.setBranding = exports.modifyTransfer = exports.showDirectory = exports.getTransfer = exports.getAllTransfers = exports.showPreferences = exports.showSelectFolderDialog = exports.showSelectFileDialog = exports.resumeTransfer = exports.stopTransfer = exports.removeTransfer = exports.deregisterStatusCallback = exports.registerStatusCallback = exports.deregisterRemovedCallback = exports.registerRemovedCallback = exports.deregisterActivityCallback = exports.registerActivityCallback = exports.startTransfer = exports.init = exports.initDragDrop = exports.testConnection = void 0;
 var messages_1 = require("../constants/messages");
 var client_1 = require("../helpers/client/client");
 var helpers_1 = require("../helpers/helpers");
+var http_gateway_1 = require("../http-gateway");
+var core_1 = require("../http-gateway/core");
 var index_1 = require("../index");
+var http_gateway_sdk_js_1 = require("@ibm-aspera/http-gateway-sdk-js");
 /**
  * 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.
@@ -14,19 +17,24 @@ var index_1 = require("../index");
 var testConnection = function () {
     return client_1.client.request('get_info')
         .then(function (data) {
-        index_1.asperaSdk.globals.AsperaSdkInfo = data;
+        index_1.asperaSdk.globals.asperaSdkInfo = data;
         index_1.asperaSdk.globals.asperaAppVerified = true;
-        return data;
+        return index_1.asperaSdk.globals.sdkResponseData;
     });
 };
 exports.testConnection = testConnection;
 /**
- * Initialize drag and drop.
+ * 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
  */
-var initDragDrop = function () {
-    if (!index_1.asperaSdk.isReady) {
+var initDragDrop = function (initCall) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return Promise.resolve(true);
+    }
+    else if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
@@ -34,7 +42,13 @@ var initDragDrop = function () {
         .then(function (data) { return promiseInfo.resolver(data); })
         .catch(function (error) {
         (0, helpers_1.errorLog)(messages_1.messages.dragDropInitFailed, error);
-        promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.dragDropInitFailed, error));
+        if (initCall) {
+            promiseInfo.resolver(false);
+            (0, helpers_1.errorLog)(messages_1.messages.dragDropInitFailedInit, error);
+        }
+        else {
+            promiseInfo.rejecter((0, helpers_1.generateErrorBody)(messages_1.messages.dragDropInitFailed, error));
+        }
     });
     return promiseInfo.promise;
 };
@@ -62,35 +76,85 @@ var init = function (options) {
     var appId = (_a = options === null || options === void 0 ? void 0 : options.appId) !== null && _a !== void 0 ? _a : (0, helpers_1.randomUUID)();
     var supportMultipleUsers = (_b = options === null || options === void 0 ? void 0 : options.supportMultipleUsers) !== null && _b !== void 0 ? _b : false;
     index_1.asperaSdk.globals.appId = appId;
+    // Watch for old HTTP Gateway transfers in case used.
+    (0, http_gateway_sdk_js_1.registerActivityCallback)(function (oldHttpTransfers) {
+        oldHttpTransfers.transfers.forEach(function (oldHttpTransfer) {
+            (0, core_1.sendTransferUpdate)(oldHttpTransfer);
+        });
+    });
     if (supportMultipleUsers) {
         index_1.asperaSdk.globals.supportMultipleUsers = true;
         index_1.asperaSdk.globals.sessionId = (0, helpers_1.randomUUID)();
     }
-    return index_1.asperaSdk.activityTracking.setup()
-        .then(function () { return (0, exports.testConnection)(); })
-        .then(function () { return (0, exports.initDragDrop)(); })
-        .catch(function (error) {
+    var handleErrors = function (error) {
         (0, helpers_1.errorLog)(messages_1.messages.serverError, error);
         index_1.asperaSdk.globals.asperaAppVerified = false;
         throw (0, helpers_1.generateErrorBody)(messages_1.messages.serverError, error);
-    });
+    };
+    var getDesktopStartCalls = function () {
+        return index_1.asperaSdk.activityTracking.setup()
+            .then(function () { return (0, exports.testConnection)(); })
+            .then(function () { return (0, exports.initDragDrop)(true); })
+            .then(function () { return index_1.asperaSdk.globals.sdkResponseData; })
+            .catch(handleErrors);
+    };
+    if (options.httpGatewayUrl && !index_1.asperaSdk.globals.httpGatewayVerified) {
+        var finalHttpGatewayUrl = options.httpGatewayUrl.trim();
+        if (finalHttpGatewayUrl.indexOf('http') !== 0) {
+            finalHttpGatewayUrl = "https://".concat(finalHttpGatewayUrl);
+        }
+        if (finalHttpGatewayUrl.endsWith('/')) {
+            finalHttpGatewayUrl = finalHttpGatewayUrl.slice(0, -1);
+        }
+        index_1.asperaSdk.globals.httpGatewayUrl = finalHttpGatewayUrl;
+        return fetch("".concat(index_1.asperaSdk.globals.httpGatewayUrl, "/info"), { method: 'GET' }).then(function (response) {
+            return response.json().then(function (responseData) {
+                if (response.status >= 400) {
+                    throw Error(responseData);
+                }
+                return responseData;
+            });
+        }).then(function (response) {
+            index_1.asperaSdk.globals.httpGatewayInfo = response;
+            index_1.asperaSdk.globals.httpGatewayVerified = true;
+            var iframeContainer = document.createElement('div');
+            iframeContainer.id = 'aspera-http-gateway-iframes';
+            iframeContainer.style = 'display: none;';
+            document.body.appendChild(iframeContainer);
+            index_1.asperaSdk.globals.httpGatewayIframeContainer = iframeContainer;
+            if (options.forceHttpGateway) {
+                return Promise.resolve(index_1.asperaSdk.globals.sdkResponseData);
+            }
+            else {
+                return getDesktopStartCalls();
+            }
+        }).catch(function (error) {
+            // If HTTP Gateway fails log and move on to desktop
+            (0, helpers_1.errorLog)(messages_1.messages.httpInitFail, error);
+            return getDesktopStartCalls();
+        });
+    }
+    return getDesktopStartCalls();
 };
 exports.init = init;
 /**
  * Start a transfer
  *
  * @param transferSpec standard transferSpec for transfer
- * @param asperaSdkSpec IBM Aspera settings when starting a 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
  */
 var startTransfer = function (transferSpec, asperaSdkSpec) {
-    if (!index_1.asperaSdk.isReady) {
-        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
-    }
     if (!(0, helpers_1.isValidTransferSpec)(transferSpec)) {
         return (0, helpers_1.throwError)(messages_1.messages.notValidTransferSpec, { transferSpec: transferSpec });
     }
+    if (index_1.asperaSdk.useHttpGateway) {
+        return transferSpec.direction === 'receive' ? (0, http_gateway_1.httpDownload)(transferSpec, asperaSdkSpec) : (0, http_gateway_1.httpUpload)(transferSpec, asperaSdkSpec);
+    }
+    else if (!index_1.asperaSdk.isReady) {
+        return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
+    }
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
     var payload = {
         transfer_spec: transferSpec,
@@ -172,28 +236,6 @@ var deregisterStatusCallback = function (id) {
     index_1.asperaSdk.activityTracking.removeWebSocketEventCallback(id);
 };
 exports.deregisterStatusCallback = deregisterStatusCallback;
-/**
- * Register a callback for getting updates about the Safari extension status.
- *
- * This can be useful if you want to handle the case where the user enable or disable the Safari extension.
- *
- * @param callback callback function to receive events
- *
- * @returns ID representing the callback for deregistration purposes
- */
-var registerSafariExtensionStatusCallback = function (callback) {
-    return index_1.asperaSdk.activityTracking.setSafariExtensionEventCallback(callback);
-};
-exports.registerSafariExtensionStatusCallback = registerSafariExtensionStatusCallback;
-/**
- * Remove a callback from getting Safari extension status events.
- *
- * @param id the ID returned by `registerStatusCallback`
- */
-var deregisterSafariExtensionStatusCallback = function (id) {
-    index_1.asperaSdk.activityTracking.removeSafariExtensionEventCallback(id);
-};
-exports.deregisterSafariExtensionStatusCallback = deregisterSafariExtensionStatusCallback;
 /**
  * Remove a transfer. This will stop the transfer if it is in progress.
  *
@@ -202,6 +244,9 @@ exports.deregisterSafariExtensionStatusCallback = deregisterSafariExtensionStatu
  * @returns a promise that resolves if transfer is removed and rejects if transfer cannot be removed
  */
 var removeTransfer = function (id) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpRemoveTransfer)(id);
+    }
     if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
@@ -276,7 +321,10 @@ exports.resumeTransfer = resumeTransfer;
  * @returns a promise that resolves with the selected file(s) and rejects if user cancels dialog
  */
 var showSelectFileDialog = function (options) {
-    if (!index_1.asperaSdk.isReady) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpGatewaySelectFileFolderDialog)(options, false);
+    }
+    else if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
@@ -301,7 +349,10 @@ exports.showSelectFileDialog = showSelectFileDialog;
  * @returns a promise that resolves with the selected folder(s) and rejects if user cancels dialog
  */
 var showSelectFolderDialog = function (options) {
-    if (!index_1.asperaSdk.isReady) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return (0, core_1.httpGatewaySelectFileFolderDialog)(options, true);
+    }
+    else if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
     var promiseInfo = (0, helpers_1.generatePromiseObjects)();
@@ -343,6 +394,9 @@ exports.showPreferences = showPreferences;
  * @returns a promise that resolves with an array of transfers.
  */
 var getAllTransfers = function () {
+    if (index_1.asperaSdk.useHttpGateway) {
+        return Promise.resolve((0, core_1.httpGetAllTransfers)());
+    }
     if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
@@ -367,6 +421,15 @@ exports.getAllTransfers = getAllTransfers;
  * @returns a promise that resolves with the transfer.
  */
 var getTransfer = function (id) {
+    if (index_1.asperaSdk.useHttpGateway) {
+        var transfer = (0, core_1.httpGetTransfer)(id);
+        if (transfer) {
+            return Promise.resolve(transfer);
+        }
+        else {
+            return Promise.reject((0, helpers_1.generateErrorBody)(messages_1.messages.getTransferFailed, { reason: 'Not found' }));
+        }
+    }
     if (!index_1.asperaSdk.isReady) {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
@@ -483,8 +546,8 @@ var createDropzone = function (callback, elementSelector) {
     };
     var dropEvent = function (event) {
         event.preventDefault();
-        var files = [];
         if (event.dataTransfer && event.dataTransfer.files && event.dataTransfer.files.length && event.dataTransfer.files[0]) {
+            var files = [];
             for (var i = 0; i < event.dataTransfer.files.length; i++) {
                 var file = event.dataTransfer.files[i];
                 files.push({
@@ -498,11 +561,16 @@ var createDropzone = function (callback, elementSelector) {
                 files: files,
                 app_id: index_1.asperaSdk.globals.appId,
             };
-            client_1.client.request('dropped_files', payload)
-                .then(function (data) { return callback({ event: event, files: data }); })
-                .catch(function (error) {
-                (0, helpers_1.errorLog)(messages_1.messages.unableToReadDropped, error);
-            });
+            if (index_1.asperaSdk.isReady) {
+                client_1.client.request('dropped_files', payload)
+                    .then(function (data) { return callback({ event: event, files: data }); })
+                    .catch(function (error) {
+                    (0, helpers_1.errorLog)(messages_1.messages.unableToReadDropped, error);
+                });
+            }
+            else if (index_1.asperaSdk.httpGatewayIsReady) {
+                (0, core_1.handleHttpGatewayDrop)(event.dataTransfer.items, callback, event);
+            }
         }
     };
     elements.forEach(function (element) {
@@ -541,7 +609,7 @@ var getInfo = function () {
         return (0, helpers_1.throwError)(messages_1.messages.serverNotVerified);
     }
     return new Promise(function (resolve, _) {
-        resolve(index_1.asperaSdk.globals.AsperaSdkInfo);
+        resolve(index_1.asperaSdk.globals.sdkResponseData);
     });
 };
 exports.getInfo = getInfo;

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

@@ -5,4 +5,4 @@ export declare const protocol = "aspera://";
 /** @ignore */
 export declare const baseInstallerUrl = "https://downloads.ibmaspera.com/downloads/desktop";
 /** @ignore */
-export declare const installerUrl: string;
+export declare const installerUrl = "https://downloads.ibmaspera.com/downloads/desktop/latest/stable";

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

@@ -2,6 +2,7 @@
 export declare const messages: {
     callbackIsNotFunction: string;
     dragDropInitFailed: string;
+    dragDropInitFailedInit: string;
     failedToGenerateIframe: string;
     getInstallerError: string;
     getAllTransfersFailed: string;
@@ -26,4 +27,9 @@ export declare const messages: {
     websocketClosedError: string;
     websocketClosedUnexpect: string;
     websocketNotReady: string;
+    httpNotAvailable: string;
+    httpInitFail: string;
+    filePickerCancel: string;
+    fileNotAllowed: string;
+    httpNetworkFail: string;
 };

package/dist/commonjs/constants/messages.js

@@ -5,6 +5,7 @@ exports.messages = void 0;
 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',
@@ -29,4 +30,9 @@ exports.messages = {
     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/http-client.js

@@ -43,7 +43,7 @@ var JSONRPCHttpClient = /** @class */ (function () {
                 headers: {
                     'content-type': 'application/json',
                 },
-                body: JSON.stringify(request),
+                body: (0, helpers_1.safeJsonString)(request),
             };
             var rpcServerURL = (0, exports.getRpcServerUrl)();
             return fetch(rpcServerURL, options).then(function (response) {

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

@@ -120,7 +120,7 @@ var SafariClient = /** @class */ (function () {
             }
             else {
                 console.warn('The Safari extension is disabled or unresponsive (dispatch event)');
-                console.warn("Failed event: ".concat(JSON.stringify(request)));
+                console.warn("Failed event: ".concat((0, helpers_1.safeJsonString)(request)));
                 reject('The Safari extension is disabled or unresponsive (dispatch event)');
             }
         });

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

@@ -40,7 +40,7 @@ export declare const getWebsocketUrl: (serverUrl: string) => string;
  *
  * @returns a string indicating the current platform
  */
-export declare const getCurrentPlatform: () => 'macos' | 'windows' | 'linux' | 'unknown';
+export declare const getCurrentPlatform: () => "macos" | "windows" | "linux" | "unknown";
 /**
  * Function used to create a random UUID
  *
@@ -75,11 +75,27 @@ export declare const isSafari: () => boolean;
  * @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: () => "unknown" | "macos" | "windows" | "linux";
+    getCurrentPlatform: () => "macos" | "windows" | "linux" | "unknown";
     getWebsocketUrl: (serverUrl: string) => string;
     isSafari: () => boolean;
     isValidURL: (url: string) => boolean;
@@ -87,5 +103,7 @@ declare const _default: {
     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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstallerUrls = exports.isSafari = exports.isValidURL = exports.throwError = exports.randomUUID = exports.getCurrentPlatform = exports.getWebsocketUrl = exports.isValidTransferSpec = exports.generateErrorBody = exports.errorLog = exports.generatePromiseObjects = void 0;
+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
@@ -180,7 +180,6 @@ exports.isValidURL = isValidURL;
  * @returns {boolean} Whether the browser is Safari.
  */
 var isSafari = function () {
-    // eslint-disable-next-line
     return /^((?!chrome|android).)*safari/i.test(navigator.userAgent) && !window.MSStream;
 };
 exports.isSafari = isSafari;
@@ -196,6 +195,43 @@ var getInstallerUrls = function () {
     };
 };
 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,
@@ -208,4 +244,6 @@ exports.default = {
     randomUUID: exports.randomUUID,
     throwError: exports.throwError,
     getInstallerUrls: exports.getInstallerUrls,
+    safeJsonString: exports.safeJsonString,
+    safeJsonParse: exports.safeJsonParse,
 };

package/dist/commonjs/helpers/ws.js

@@ -48,13 +48,7 @@ var WebsocketService = /** @class */ (function () {
          * This function handles messages received from the websocket
          */
         this.handleMessage = function (message) {
-            var data;
-            try {
-                data = JSON.parse(message.data);
-            }
-            catch (error) {
-                (0, helpers_1.errorLog)('Unable to parse Websocket message', { error: error, message: message });
-            }
+            var data = (0, helpers_1.safeJsonParse)(message.data);
             // Message we get on subscription
             if (data && data.id === 1) {
                 _this.initPromise.resolver(data);
@@ -78,7 +72,7 @@ var WebsocketService = /** @class */ (function () {
             this.handleNotReady();
             return false;
         }
-        this.globalSocket.send(JSON.stringify({ jsonrpc: '2.0', method: 'subscribe_transfer_activity', params: [index_1.asperaSdk.globals.appId], id: 1 }));
+        this.globalSocket.send((0, helpers_1.safeJsonString)({ jsonrpc: '2.0', method: 'subscribe_transfer_activity', params: [index_1.asperaSdk.globals.appId], id: 1 }));
         return true;
     };
     /**

package/dist/commonjs/http-gateway/core.d.ts

@@ -0,0 +1,76 @@
+import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer } from '../models/models';
+/**
+ * HTTP Gateway Core Logic
+ * - File/Folder picking
+ * - Starting and testing
+ *
+ * @remarks
+ * Most logic is called directly by Desktop SDK functions
+ * You may not need to import anything from this file.
+ */
+/**
+ * Remove a transfer from HTTP Gateway systems
+ * @param id - ID of the transfer
+ *
+ * @returns Promise indicating success
+ */
+export declare const httpRemoveTransfer: (id: string) => Promise<any>;
+/**
+ * Get the list of http gateway transfers
+ *
+ * @returns list of HTTP Gateway
+ */
+export declare const httpGetAllTransfers: () => AsperaSdkTransfer[];
+/**
+ * Get a HTTP Gateway transfer by ID
+ *
+ * @returns a transfer or null
+ */
+export declare const httpGetTransfer: (id: string) => AsperaSdkTransfer | null;
+/**
+ * Create HTML input element for file picking
+ */
+export declare const createHtmlInputElement: () => HTMLInputElement;
+/**
+ * Handle drop events and store files for HTTP Gateway
+ * This works on top of desktop.
+ */
+export declare const handleHttpGatewayDrop: (items: DataTransferItemList, callback: (data: {
+    event: DragEvent;
+    files: DataTransferResponse;
+}) => void, event: DragEvent) => void;
+/**
+ * Open native browser file or folder picker for files
+ *
+ * @param options - File picker options
+ * @param folder - Indicate if choosing folders
+ *
+ * @returns Promise that resolves with info about the files picked
+ */
+export declare const httpGatewaySelectFileFolderDialog: (options?: FileDialogOptions, folder?: boolean) => Promise<DataTransferResponse>;
+/**
+ * Get a generic transfer object for HTTP Gateway transfers.
+ *
+ * @param transferSpec - TransferSpec being provided for the HTTP Gateway transfer
+ *
+ * @returns a transfer object to track status and send to consumers
+ */
+export declare const getSdkTransfer: (transferSpec: TransferSpec) => AsperaSdkTransfer;
+/**
+ * Send a transfer update through the SDK
+ *
+ * @param transfer - Transsfer object to send to consumers
+ */
+export declare const sendTransferUpdate: (transfer: AsperaSdkTransfer) => void;
+/**
+ * Try to parse and get a useful string from API calls for HTTP Gateway
+ *
+ * @param error - Error from API call for Gateway
+ *
+ * @returns a string to use for errors
+ */
+export declare const getMessageFromError: (error: any) => {
+    message: string;
+    code: number;
+};
+export declare const base64Encoding: (jsonString: string) => string;