@ibm-aspera/sdk 0.2.6 → 0.2.7

package/src/helpers/client/safari-client.ts

@@ -48,11 +48,9 @@ let keepAliveTimeout: ReturnType<typeof setTimeout>;
  * Handles communication with the Safari extension using JSON-RPC over custom events.
  */
 export class SafariClient implements Client {
-  private statusInterval = 100;
   private keepAliveInterval = 1000;
   private promiseExecutors: Map<string, PromiseExecutor>;
 
-  private isFirstPing = true;
   private lastPing: number|null = null;
   private lastPong: number|null = null;
   private safariExtensionEnabled = false;
@@ -67,6 +65,7 @@ export class SafariClient implements Client {
     this.listenResponseEvents();
     this.listenTransferActivityEvents();
     this.listenStatusEvents();
+    this.listenClientStatusEvents();
     this.listenPongEvents();
 
     if (keepAliveTimeout) {
@@ -207,6 +206,10 @@ export class SafariClient implements Client {
    */
   private listenResponseEvents() {
     document.addEventListener('AsperaDesktop.Response', (event: CustomEvent<JSONRPCResponse>) => {
+      if (!event.detail) {
+        return;
+      }
+
       this.handleResponse(event.detail);
     });
   }
@@ -216,6 +219,10 @@ export class SafariClient implements Client {
    */
   private listenTransferActivityEvents() {
     document.addEventListener('AsperaDesktop.TransferActivity', (event: any) => {
+      if (!event.detail) {
+        return;
+      }
+
       asperaSdk.activityTracking.handleTransferActivity(event.detail);
     });
   }
@@ -225,10 +232,27 @@ export class SafariClient implements Client {
    */
   private listenStatusEvents() {
     document.addEventListener('AsperaDesktop.Status', (event: any) => {
+      if (!event.detail) {
+        return;
+      }
+
       asperaSdk.activityTracking.handleWebSocketEvents(event.detail);
     });
   }
 
+  /**
+   * Listens for 'isAppAlive' events. This was introduced in version 1.0.9.
+   */
+  private listenClientStatusEvents() {
+    document.addEventListener('isAppAlive', (event: any) => {
+      if (!event.detail?.running) {
+        return;
+      }
+
+      asperaSdk.activityTracking.handleClientEvents(event.detail.running);
+    });
+  }
+
   /**
    * Listens for 'AsperaDesktop.Pong' events.
    */
@@ -246,14 +270,6 @@ export class SafariClient implements Client {
     this.lastPing = Date.now();
     this.dispatchEvent(SafariExtensionEventType.Ping);
 
-    if (this.isFirstPing) {
-      this.isFirstPing = false;
-    } else {
-      setTimeout(() => {
-        this.checkSafariExtensionStatus();
-      }, this.statusInterval);
-    }
-
     keepAliveTimeout = setTimeout(() => {
       this.keepAlive();
     }, this.keepAliveInterval);

package/src/index.ts

@@ -64,6 +64,7 @@ export {
   modifyTransfer,
   createDropzone,
   removeDropzone,
+  initDragDrop,
   getInstallerInfo,
   registerStatusCallback,
   deregisterStatusCallback,

package/src/models/aspera-sdk.model.ts

@@ -82,6 +82,8 @@ export class ActivityTracking {
 
   /** Keep track of the last WebSocket event **/
   private lastWebSocketEvent: WebsocketEvent = 'CLOSED';
+  /** Keep track of the last notified WebSocket event **/
+  private lastNotifiedWebSocketEvent: WebsocketEvent = undefined;
   /** Keep track of the last Safari extension event **/
   private lastSafariExtensionEvent: SafariExtensionEvent = 'DISABLED';
 
@@ -109,7 +111,7 @@ export class ActivityTracking {
   }
 
   /**
-   * Notify all consumers when a connection webSocketEvent occurs. For example, when the SDK
+   * Handle and notify if needed 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.
@@ -119,13 +121,46 @@ export class ActivityTracking {
       return;
     }
 
+    this.lastWebSocketEvent = webSocketEvent;
+
+    this.notifyWebSocketEvent(webSocketEvent);
+  }
+
+  /**
+   * Notify all consumers when a connection webSocketEvent occurs.
+   *
+   * @param webSocketEvent the event type.
+   */
+  private notifyWebSocketEvent(webSocketEvent: WebsocketEvent): void {
+    if (this.lastNotifiedWebSocketEvent === webSocketEvent) {
+      return;
+    }
+
+    this.lastNotifiedWebSocketEvent = webSocketEvent;
+
     this.event_callbacks.forEach(callback => {
       if (typeof callback === 'function') {
         callback(webSocketEvent);
       }
     });
+  }
 
-    this.lastWebSocketEvent = webSocketEvent;
+  /**
+   * Notify all consumers when the client changes status. For example, when
+   * IBM Aspera App is launched or closed.
+   *
+   * @param running whether the client is running or not.
+   */
+  handleClientEvents(running: boolean): void {
+    let webSocketEvent: WebsocketEvent;
+
+    if (!running) {
+      webSocketEvent = 'CLOSED';
+    } else {
+      webSocketEvent = this.lastWebSocketEvent;
+    }
+
+    this.notifyWebSocketEvent(webSocketEvent);
   }
 
   /**

package/tsconfig.json

@@ -6,5 +6,8 @@
     "target": "es5",
     "esModuleInterop": true,
     "moduleResolution": "node",
-  }
+  },
+  "exclude": [
+    "./example"
+  ]
 }

package/tsconfig.module.json

@@ -9,6 +9,7 @@
   },
   "exclude": [
     "node_modules",
+    "example",
     "dist",
     "tests"
   ]

package/webpack.config.js

@@ -8,7 +8,7 @@ if (packageFile.version) {
   version = `v${packageFile.version}`;
 }
 
-const banner = `IBM Aspera SDK ${version}\nLicensed Materials – Property of IBM\n© Copyright IBM Corp. 2024\nU.S. Government Users Restricted Rights: Use, duplication or disclosure restricted by\nGSA ADP Schedule Contract with IBM Corp.`;
+const banner = `IBM Aspera SDK ${version}\nLicensed Materials – Property of IBM\n© Copyright IBM Corp. 2024, 2025\nU.S. Government Users Restricted Rights: Use, duplication or disclosure restricted by\nGSA ADP Schedule Contract with IBM Corp.`;
 
 module.exports = {
   entry: './src/index.ts',
@@ -29,24 +29,6 @@ module.exports = {
       }
     ]
   },
-  devServer: {
-    server: {
-      type: 'https',
-    },
-    open: true,
-    static: [
-      {
-        publicPath: '/',
-        directory: './src',
-      },
-      {
-        publicPath: '/aspera-sdk-js/docs',
-        directory: './dist/js/docs',
-      },
-    ],
-    host: 'js-sdk.aspera.us',
-    port: 4205
-  },
   plugins: [
     new webpack.BannerPlugin(banner)
   ]

package/src/index.html

@@ -1,404 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <script src="aspera-sdk.js"></script>
-    <title>JavaScript SDK Test Server</title>
-    <style>
-      body {
-        padding: 30px;
-      }
-      .test-buttons {
-        margin: 30px 0;
-      }
-      .test-buttons button {
-        margin: 0 10px;
-        padding: 10px;
-      }
-      .flex-page {
-        display: flex;
-      }
-      .text-area, .transfer-monitor {
-        flex: 1;
-        padding-right: 20px;
-      }
-      .text-area * {
-        display: block;
-      }
-      .text-area textarea {
-        width: 600px;
-        padding: 3px;
-        font-size: 16px;
-        font-family: monospace;
-        height: 300px;
-      }
-      .text-area input {
-        font-size: 16px;
-        font-family: monospace;
-        padding: 3px;
-        width: 600px;
-      }
-      label {
-        font-weight: bold;
-        margin-top: 25px;
-      }
-      .transfer {
-        display: block;
-        margin-bottom: 20px;
-        position: relative;
-      }
-      .transfer .progress {
-        background-color: grey;
-        width: 100%;
-        height: 30px;
-      }
-
-      .transfer .bar {
-        background-color: green;
-        height: 100%;
-      }
-
-      .transfer .status {
-        position: absolute;
-        top: 5px;
-        left: 10px;
-        color: white;
-        font-weight: bold;
-      }
-
-      .drop-area {
-        height: 80px;
-        background-color: rgba(0,0,255,0.3);
-        text-align: center;
-        padding-top: 40px;
-        font-size: 18px;
-        margin-bottom: 20px;
-        font-weight: bold;
-      }
-
-      .loader {
-        border: 16px solid #f3f3f3;
-        border-top: 16px solid #3498db;
-        border-radius: 50%;
-        width: 120px;
-        height: 120px;
-        animation: spin 2s linear infinite;
-        margin: 0 auto;
-      }
-
-      @keyframes spin {
-        0% { transform: rotate(0deg); }
-        100% { transform: rotate(360deg); }
-      }
-
-      .error {
-        color: red;
-        margin: 15px 0;
-        text-align: center;
-        font-size: 32px;
-      }
-
-      .docs {
-        color: #343a40;
-        text-decoration: none;
-        font-family: Arial, sans-serif;
-        font-size: 16px;
-        border-bottom: 1px dashed #343a40;
-        transition: color 0.3s ease, border-bottom-color 0.3s ease;
-      }
-
-      .doc-link:hover {
-        color: #1d2124;
-        border-bottom-color: #1d2124;
-      }
-    </style>
-    <script>
-      function bytesCalc(value) {
-        if (value === null || value === '' || value === undefined) {
-          return '\u2014';
-        }
-        const base = 1024;
-        const units = [
-          'B',
-          'KB',
-          'MB',
-          'GB',
-          'TB'
-        ];
-
-        let unitIndex = 0;
-
-        if (Math.abs(value) > base) {
-          do {
-            value /= base;
-            ++unitIndex;
-          } while ( Math.abs(value) >= base && unitIndex < units.length - 1 );
-        }
-        value = value.toFixed(2);
-        return `${value} ${units[unitIndex]}`;
-      }
-
-      function generateObjectText() {
-        const text = JSON.stringify(asperaSdk, undefined, 2);
-        document.querySelector('#test-output').value = text;
-        setTimeout(() => {
-          generateObjectText();
-        }, 1000);
-      }
-
-      function init(supportMultipleUsers) {
-        console.log('INITIALIZING...');
-
-        const appId = document.querySelector('#app-id').value;
-        const options = {appId, supportMultipleUsers};
-
-        asperaSdk.init(options).then(() => {
-          console.log('INIT SUCCESS');
-
-          asperaSdk.getAllTransfers().then(response => {
-            monitorTransfers({ transfers: response });
-          }).catch(error => {
-            console.log('GET ALL TRANSFERS FAIL', error);
-          });
-        }).catch(error => {
-          console.log('INIT FAIL', error);
-        })
-      }
-
-      function testServer() {
-        asperaSdk.testConnection().then(response => {
-          console.log('TEST SUCCESS', response);
-        }).catch(error => {
-          console.log('TEST FAIL', error);
-        })
-      }
-
-      function getInfo() {
-        asperaSdk.getInfo().then(response => {
-          console.log('GET INFO SUCCESS', response);
-        }).catch(error => {
-          console.log('GET INFO FAIL', error);
-        })
-      }
-
-      function transfer() {
-        const asperaSpec = {
-          use_absolute_destination_path: false
-        };
-
-        try {
-          const transferSpec = JSON.parse(document.querySelector('#test-input').value);
-          asperaSdk.startTransfer(transferSpec, asperaSpec).then(response => {
-            console.log('TRANSFER SUCCESS', response);
-          }).catch(error => {
-            console.log('TRANSFER FAIL', error);
-          })
-        } catch (error) {
-          console.log('Unable to parse transferSpec', error);
-        }
-      }
-
-      function remove(id) {
-        asperaSdk.removeTransfer(id).then(response => {
-          console.log('REMOVE SUCCESS', response);
-        }).catch(error => {
-          console.log('REMOVE FAIL', error);
-        })
-      }
-
-      function stopTransfer(id) {
-        asperaSdk.stopTransfer(id).then(response => {
-          console.log('STOP SUCCESS', response);
-        }).catch(error => {
-          console.log('STOP FAIL', error);
-        })
-      }
-
-      function resumeTransfer(id) {
-        try {
-          const transferSpec = JSON.parse(document.querySelector('#test-input').value);
-          asperaSdk.resumeTransfer(id, transferSpec).then(response => {
-            console.log('RESUME SUCCESS', response);
-          }).catch(error => {
-            console.log('RESUME FAIL', error);
-          })
-        } catch (error) {
-          console.log('Unable to parse transferSpec for resume', error);
-        }
-      }
-
-      function getAllTransfers() {
-        asperaSdk.getAllTransfers().then(response => {
-          console.log('GET ALL TRANSFERS SUCCESS', response);
-        }).catch(error => {
-          console.log('GET ALL TRANSFERS FAIL', error);
-        });
-      }
-
-      function getTransfer(id) {
-        asperaSdk.getTransfer(id).then(response => {
-          console.log('GET TRANSFER SUCCESS', response);
-        }).catch(error => {
-          console.log('GET TRANSFER FAIL', error);
-        });
-      }
-
-      function showDirectory(id) {
-        asperaSdk.showDirectory(id).then(response => {
-          console.log('SHOW DIRECTORY SUCCESS', response);
-        }).catch(error => {
-          console.log('SHOW DIRECTORY FAIL', error);
-        });
-      }
-
-      function showSelectFileDialog() {
-        asperaSdk.showSelectFileDialog().then(response => {
-          console.log('SHOW FILE DIALOG SUCCESS', response);
-        }).catch(error => {
-          console.log('SHOW FILE DIALOG FAIL', error);
-        });
-      }
-
-      function showSelectFolderDialog() {
-        asperaSdk.showSelectFolderDialog().then(response => {
-          console.log('SHOW FOLDER DIALOG SUCCESS', response);
-        }).catch(error => {
-          console.log('SHOW FOLDER DIALOG FAIL', error);
-        });
-      }
-
-      function openPreferences() {
-        asperaSdk.showPreferences().then(response => {
-          console.log('SHOW PREFERENCES SUCCESS', response);
-        }).catch(error => {
-          console.log('SHOW PREFERENCES FAIL', error);
-        });
-      }
-
-      function modifyTransfer(id) {
-        const options = {
-          target_rate_kbps: 10,
-        };
-
-        asperaSdk.modifyTransfer(id, options).then(response => {
-          console.log('MODIFY TRANSFER SUCCESS', response);
-        }).catch(error => {
-          console.log('MODIFY TRANSFER FAIL', error);
-        });
-      }
-
-      function testDrop() {
-        const callback = files => {
-          console.log('DROP ZONE CALLBACK', files);
-        }
-
-        asperaSdk.createDropzone(callback, '#drop-area');
-      }
-
-      function getInstallerInfo() {
-        asperaSdk.getInstallerInfo().then(response => {
-          console.log('INSTALLER INFO SUCCESS', response);
-        }).catch(error => {
-          console.log('INSTALLER INFO FAIL', error);
-        })
-      }
-
-      function monitorRemovedTransfers(transfer) {
-        console.log('TRANSFER WAS REMOVED', transfer);
-      }
-
-      function monitorTransfers(transfers) {
-        const transferDom = document.querySelector('#transfer');
-        while (transferDom.firstChild) {
-          transferDom.removeChild(transferDom.firstChild);
-        }
-        if (!transfers.transfers.length) {
-          const element = document.createElement('div');
-          element.setAttribute('class', 'transfer');
-          element.innerHTML = `
-            <div class="name">No transfers</div>
-          `;
-          transferDom.appendChild(element);
-          return;
-        }
-        transfers.transfers.forEach(transfer => {
-          const element = document.createElement('div');
-          element.setAttribute('class', 'transfer-item');
-          element.innerHTML = `
-            <div class="progress">
-              <div class="bar" style="width: ${(transfer.percentage * 100).toFixed(2)}%;"></div>
-            </div>
-            <div class="status">${transfer.status} - ${bytesCalc(transfer.bytes_written)} / ${bytesCalc(transfer.bytes_expected)}</div>
-            <button onclick=remove("${transfer.uuid}")>Remove</button>
-            <button onclick=stopTransfer("${transfer.uuid}")>Stop</button>
-            <button onclick=resumeTransfer("${transfer.uuid}")>Resume</button>
-            <button onclick=getTransfer("${transfer.uuid}")>Info</button>
-            <button onclick=showDirectory("${transfer.uuid}")>Show</button>
-            <button onclick=modifyTransfer("${transfer.uuid}")>Modify</button>
-          `;
-          transferDom.appendChild(element);
-        });
-      }
-
-      function launch() {
-        asperaSdk.launch();
-      }
-
-      function initDragDrop() {
-        asperaSdk.initDragDrop();
-      }
-
-      setTimeout(() => {
-        generateObjectText();
-      }, 3000);
-
-      asperaSdk.registerActivityCallback(monitorTransfers);
-      asperaSdk.registerRemovedCallback(monitorRemovedTransfers);
-
-      asperaSdk.registerStatusCallback((status) => {
-        console.log('Websocket status changed to:', status);
-      });
-
-      if (asperaSdk.isSafari()) {
-        asperaSdk.registerSafariExtensionStatusCallback((status) => {
-          console.log('Safari extension status changed to:', status);
-        });
-      }
-    </script>
-  </head>
-  <body>
-    <h1>Aspera SDK Test Server</h1>
-    <a href="/aspera-sdk-js/docs/index.html" class="docs" target="_blank">Documentation</a>
-    <div class="test-buttons">
-      <button onclick="init(false)" type="button">Init SDK</button>
-      <button onclick="init(true)" type="button">Init SDK with session</button>
-      <button onclick="testServer()" type="button">Test desktop</button>
-      <button onclick="getInfo()" type="button">Get Info</button>
-      <button onclick="transfer()" type="button">Start transfer</button>
-      <button onclick="getAllTransfers()" type="button">Get transfers</button>
-      <button onclick="showSelectFileDialog()" type="button">Select File</button>
-      <button onclick="showSelectFolderDialog()" type="button">Select Folder</button>
-      <button onclick="openPreferences()" type="button">Open Preferences</button>
-      <button onclick="launch()" type="button">Launch</button>
-      <button onclick="testDrop()" type="button">Set dropzone</button>
-      <button onclick="getInstallerInfo()" type="button">Installers</button>
-      <button onclick="initDragDrop()" type="button">Init drag-drop</button>
-    </div>
-    <div class="flex-page">
-      <div class="text-area">
-        <label for="app-id">App ID</label>
-        <input type="text" id="app-id" value="test1"></input>
-        <label for="test-input">transferSpec for download/upload</label>
-        <textarea id="test-input"></textarea>
-        <label for="test-output">Current values in asperaSdk</label>
-        <textarea id="test-output" readonly></textarea>
-      </div>
-      <div id="transfer-monitor" class="transfer-monitor">
-        <br />
-        <hl />
-        <p>Drop test</p>
-        <div class="drop-area" id="drop-area">Drop area</div>
-        <div id="transfer" class="transfer"><div class="name">No transfers</div></div>
-      </div>
-    </div>
-  </body>
-</html>