configurapi-handler-ws 1.2.0 → 1.3.0

package/README.md

@@ -35,8 +35,10 @@ Configurapi request handlers for websocket
 
   * Use WebSocketClient to connect to a WebSocket runner, send data over the connection, and disconnect from the runner when finished.
   * To pass data (such as a protocol or authentication token) when establishing the WebSocket connection, provide it as the second parameter to the constructor.
+    * If a connection could not be made (e.g. the on_connect route returns 400+ status code), an error will be sent to onPush().
+  * The client has a default timeout of 27 seconds. To increase the wait time for results, set the `replyTimeoutMs` parameter in the constructor's second argument.
 
   ```
   const { WebSocketClient } = require("configurapi-handler-ws");
-  let client = new WebSocketClient(WEBSOCKET_BASE_URL, {onPush: (data:IResponse)=>console.log(data)});
+  let client = new WebSocketClient(WEBSOCKET_BASE_URL, {replyTimeoutMs: 300000, onPush: (data:IResponse)=>console.log(data)});
   ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configurapi-handler-ws",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "main": "src/index",
   "files": [
     "src/*",

package/src/webSocketClient.d.ts

@@ -9,6 +9,7 @@ export interface ClientOptions
     /** If a response arrives without an id, deliver it here (or ignore if omitted) */
     onPush?: (data: {
         body: any;
+        error: string;
         statusCode: number;
         headers: Record<string, string>;
     }) => Promise<void>;

package/src/webSocketClient.js

@@ -199,7 +199,7 @@ module.exports = class WebSocketClient
         }
 
         const id = this.getHeaderCaseInsensitive(msg.headers, MessageIdHeaderName);
-
+        
         if (msg?.statusCode && msg.statusCode !== 202 && id && this.inflight.has(id)) 
         {
             const waiter = this.inflight.get(id);
@@ -222,14 +222,25 @@ module.exports = class WebSocketClient
         } 
         else 
         {
+            //no inflight ws connections.
             if(msg?.statusCode > 299)
             {
-                const error = new Error(`${msg.message} - (${msg.statusCode})`)   
-                throw error;
+                const error = new Error(`${msg.message} - (${msg.statusCode})`);
+
+                if(this.onPush)
+                {
+                    this.onPush(msg)
+                }
+                else
+                {
+                    throw error;
+                }
+            }
+            else
+            {
+                // No id or unknown id. Treat as push/unsolicited.
+                if (this.onPush) this.onPush(msg);
             }
-            
-            // No id or unknown id. Treat as push/unsolicited.
-            if (this.onPush) this.onPush(msg);
         }
     }