(feat): export tillSocketOpen on ChatSocket (#60)

Author: dsinghvi

package.json

@@ -1,6 +1,6 @@
 {
     "name": "hume",
-    "version": "0.8.1-beta8",
+    "version": "0.8.1-beta9",
     "private": false,
     "repository": "https://github.com/HumeAI/hume-typescript-sdk",
     "main": "./index.js",

src/api/resources/empathicVoice/resources/chat/client/Client.ts

@@ -36,9 +36,9 @@ export class Chat {
         const queryParams: Record<string, string | string[] | object | object[]> = {};
 
         if (this._options.accessToken != null) {
-            queryParams["accessToken"] = core.Supplier.get(this._options.accessToken);
+            queryParams["accessToken"] = this._options.accessToken;
         } else if (this._options.apiKey != null) {
-            queryParams["apiKey"] = core.Supplier.get(this._options.apiKey);
+            queryParams["apiKey"] = this._options.apiKey;
         }
         if (args.configId != null) {
             queryParams["config_id"] = args.configId;
@@ -57,9 +57,8 @@ export class Chat {
         }
 
         const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs.stringify(queryParams)}`, [], {
-            startClosed: true,
             debug: args.debug ?? false,
-            maxRetries: args.reconnectAttempts, 
+            maxRetries: args.reconnectAttempts ?? 30, 
         });
 
         return new ChatSocket({

src/api/resources/empathicVoice/resources/chat/client/Socket.ts

@@ -141,7 +141,7 @@ export class ChatSocket{
     /**
      * @name connect
      * @description
-     * Connect to the websocket.
+     * Connect to the core.ReconnectingWebSocket.
      */
     public connect(): ChatSocket {
         this.socket.reconnect();
@@ -168,12 +168,27 @@ export class ChatSocket{
         this.socket.removeEventListener('error', this.handleError);
     }
 
+    public async tillSocketOpen(): Promise<core.ReconnectingWebSocket> {
+        if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+            return this.socket;
+        }
+        return new Promise((resolve, reject) => {
+            this.socket.addEventListener("open", () => {
+                resolve(this.socket);
+            });
+
+            this.socket.addEventListener("error", (event: any) => {
+                reject(event);
+            });
+        });
+    }
+
     private assertSocketIsOpen(): void {
         if (!this.socket) {
             throw new errors.HumeError({ message: 'Socket is not connected.'});
         }
 
-        if (this.socket.readyState !== WebSocket.OPEN) {
+        if (this.socket.readyState !== core.ReconnectingWebSocket.OPEN) {
             throw new errors.HumeError({ message: 'Socket is not open.' });
         }
     }
@@ -210,7 +225,7 @@ export class ChatSocket{
     };
 
     private handleError = (event: core.ErrorEvent) => {
-        const message = event.message ?? 'WebSocket error';
+        const message = event.message ?? 'core.ReconnectingWebSocket error';
         this.eventHandlers.error?.(new Error(message));
     };
 }

src/core/websocket/ws.ts

@@ -1,10 +1,8 @@
 import * as Events from './events';
+import { WebSocket as NodeWebSocket } from 'ws';
 
 const getGlobalWebSocket = (): WebSocket | undefined => {
-    if (typeof WebSocket !== 'undefined') {
-        // @ts-ignore
-        return WebSocket;
-    }
+    return (global as any).WebSocket ??= NodeWebSocket;
 };
 
 /**

tests/empathicVoice/chat.test.ts

@@ -3,18 +3,24 @@ import { HumeClient } from "../../src/";
 describe("Empathic Voice Interface", () => {
     it.skip("Chat", async () => {
         const hume = new HumeClient({
-            apiKey: "<>",
-            secretKey: "<>",
+            accessToken: '<>'
         });
 
-        const socket = hume.empathicVoice.chat.connect();
+        const socket = hume.empathicVoice.chat.connect({
+            debug: true,
+            reconnectAttempts: 30,
+        });
+
+        await socket.tillSocketOpen();
 
         socket.on("message", (message) => {
             if (message.type === "audio_output") {
                 Buffer.from(message.data, "base64");
             }
         });
 
-        await socket.sendUserInput("Hello, how are you?");
+        socket.sendUserInput("Hello, how are you?");
+
+
     }, 100000);
 });