@ibm-aspera/sdk 0.19.0 → 0.19.1

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

@@ -437,11 +437,12 @@ export declare const readDirectory: (options: ReadDirectoryOptions) => Promise<R
  * Returns an object describing the high-level capabilities supported by the user's
  * transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).
  *
- * Use this for feature detection at a semantic level rather than checking individual RPC methods.
- * Capabitilies may depend on multiple underlying RPC methods and also may vary by transfer client.
+ * Use this for feature detection at a semantic level as capabilities may change depending on the
+ * transfer client.
  *
- * Some capabitilies may depend on newer versions of the transfer client. This function may be useful
- * if you want to conditionally perform certain actions rather than potentially getting an error.
+ * Rather than caching the return value of this function, it's recommended to call it on the fly as
+ * capabilities may change if your application supports multiple transfer clients. As a result, it's
+ * recommend to use the slightly more ergonomic {@link hasCapability}.
  *
  * @returns an object with boolean flags for each capability.
  *
@@ -455,10 +456,18 @@ export declare const readDirectory: (options: ReadDirectoryOptions) => Promise<R
  */
 export declare const getCapabilities: () => SdkCapabilities;
 /**
- * Check if the SDK and underlying transfer client supports a specific capability.
+ * Check if the SDK and underlying transfer client supports a specific capability or feature.
  *
  * Capabilities depend on the transfer client being used (HTTP Gateway, Connect, or IBM Aspera for desktop).
- * Use this function to conditionally enable/disable features in your application.
+ *
+ * This function may be useful if you want to conditionally perform certain actions rather than
+ * potentially getting an error.
+ *
+ * For example, only IBM Aspera for desktop supports traversing a folder's contents. An application can
+ * check `hasCapability('readDirectory')` to optionally show a folder browser only when the feature is available.
+ * For example, when a user does not have IBM Aspera for desktop installed and is using HTTP Gateway, your
+ * application can disable this feature. Later, if that same user installs IBM Aspera for desktop, your application
+ * will show the feature as enabled without any additional changes.
  *
  * @param capability the capability to check.
  *
@@ -468,7 +477,7 @@ export declare const getCapabilities: () => SdkCapabilities;
  * ```typescript
  * // Determine if your web application can render image previews for user selected files
  * if (asperaSdk.hasCapability('imagePreview')) {
- *   asperaSdk.readAsArrayBuffer(path);
+ *   const response = await asperaSdk.readAsArrayBuffer(path);
  * }
  * ```
  */

package/dist/commonjs/app/core.js

@@ -1342,6 +1342,10 @@ var readDirectory = function (options) {
 };
 exports.readDirectory = readDirectory;
 var supportsMethod = function (method) {
+    // HTTP Gateway v2 specific overrides
+    if (index_1.asperaSdk.useOldHttpGateway && (method === 'read_as_array_buffer' || method === 'read_chunk_as_array_buffer')) {
+        return false;
+    }
     // We currently do not support calculating file checksums when using HTTP Gateway. In theory it should be possible
     // to calculate this directly in the browser similar to how `readAsArrayBuffer()` is implemented.
     // HTTP Gateway also does not support showing native transfer client UI (about, preferences, etc.).
@@ -1362,11 +1366,12 @@ var supportsMethod = function (method) {
  * Returns an object describing the high-level capabilities supported by the user's
  * transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).
  *
- * Use this for feature detection at a semantic level rather than checking individual RPC methods.
- * Capabitilies may depend on multiple underlying RPC methods and also may vary by transfer client.
+ * Use this for feature detection at a semantic level as capabilities may change depending on the
+ * transfer client.
  *
- * Some capabitilies may depend on newer versions of the transfer client. This function may be useful
- * if you want to conditionally perform certain actions rather than potentially getting an error.
+ * Rather than caching the return value of this function, it's recommended to call it on the fly as
+ * capabilities may change if your application supports multiple transfer clients. As a result, it's
+ * recommend to use the slightly more ergonomic {@link hasCapability}.
  *
  * @returns an object with boolean flags for each capability.
  *
@@ -1394,10 +1399,18 @@ var getCapabilities = function () {
 };
 exports.getCapabilities = getCapabilities;
 /**
- * Check if the SDK and underlying transfer client supports a specific capability.
+ * Check if the SDK and underlying transfer client supports a specific capability or feature.
  *
  * Capabilities depend on the transfer client being used (HTTP Gateway, Connect, or IBM Aspera for desktop).
- * Use this function to conditionally enable/disable features in your application.
+ *
+ * This function may be useful if you want to conditionally perform certain actions rather than
+ * potentially getting an error.
+ *
+ * For example, only IBM Aspera for desktop supports traversing a folder's contents. An application can
+ * check `hasCapability('readDirectory')` to optionally show a folder browser only when the feature is available.
+ * For example, when a user does not have IBM Aspera for desktop installed and is using HTTP Gateway, your
+ * application can disable this feature. Later, if that same user installs IBM Aspera for desktop, your application
+ * will show the feature as enabled without any additional changes.
  *
  * @param capability the capability to check.
  *
@@ -1407,7 +1420,7 @@ exports.getCapabilities = getCapabilities;
  * ```typescript
  * // Determine if your web application can render image previews for user selected files
  * if (asperaSdk.hasCapability('imagePreview')) {
- *   asperaSdk.readAsArrayBuffer(path);
+ *   const response = await asperaSdk.readAsArrayBuffer(path);
  * }
  * ```
  */

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

@@ -53,6 +53,11 @@ export declare class WebsocketService {
      */
     init(): Promise<unknown>;
     private connect;
+    /**
+     * Detach event handlers from the current socket so it cannot fire
+     * stale CLOSED/RECONNECT events after being replaced.
+     */
+    private detachSocket;
     private reconnect;
     private getWebSocketConnection;
     private notifyEvent;

package/dist/commonjs/helpers/ws.js

@@ -109,6 +109,7 @@ var WebsocketService = /** @class */ (function () {
     };
     WebsocketService.prototype.connect = function () {
         var _this = this;
+        this.detachSocket();
         this.getWebSocketConnection(index_1.asperaSdk.globals.rpcPort)
             .then(function (webSocket) {
             _this.globalSocket = webSocket;
@@ -121,8 +122,21 @@ var WebsocketService = /** @class */ (function () {
             _this.reconnect();
         });
     };
+    /**
+     * Detach event handlers from the current socket so it cannot fire
+     * stale CLOSED/RECONNECT events after being replaced.
+     */
+    WebsocketService.prototype.detachSocket = function () {
+        if (this.globalSocket) {
+            this.globalSocket.onopen = null;
+            this.globalSocket.onclose = null;
+            this.globalSocket.onerror = null;
+            this.globalSocket.onmessage = null;
+        }
+    };
     WebsocketService.prototype.reconnect = function () {
         var _this = this;
+        this.detachSocket();
         if (this.globalSocket) {
             this.globalSocket.close();
         }