hume 0.8.1-beta4 → 0.8.1-beta6

package/api/resources/empathicVoice/resources/chat/client/Client.d.ts

@@ -6,12 +6,18 @@ export declare namespace Chat {
         accessToken?: core.Supplier<string | undefined>;
     }
     interface ConnectArgs {
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
         /** The ID of the configuration. */
         configId?: string;
         /** The version of the configuration. */
         configVersion?: string;
         /** The ID of a chat group, used to resume a previous chat. */
         resumedChatGroupId?: string;
+        /** Extra query parameters sent at WebSocket connection */
+        queryParams?: Record<string, string | string[] | object | object[]>;
     }
 }
 export declare class Chat {

package/api/resources/empathicVoice/resources/chat/client/Client.js

@@ -35,6 +35,7 @@ class Chat {
         this._options = _options;
     }
     connect(args = {}) {
+        var _a;
         const queryParams = {};
         if (this._options.accessToken != null) {
             queryParams["accessToken"] = core.Supplier.get(this._options.accessToken);
@@ -51,7 +52,16 @@ class Chat {
         if (args.resumedChatGroupId != null) {
             queryParams["resumed_chat_group_id"] = args.resumedChatGroupId;
         }
-        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`);
+        if (args.queryParams != null) {
+            for (const [name, value] of Object.entries(args.queryParams)) {
+                queryParams[name] = value;
+            }
+        }
+        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`, [], {
+            startClosed: true,
+            debug: (_a = args.debug) !== null && _a !== void 0 ? _a : false,
+            maxRetries: args.reconnectAttempts,
+        });
         return new Socket_1.ChatSocket({
             socket,
         });

package/api/resources/empathicVoice/resources/chat/client/Socket.d.ts

@@ -64,10 +64,17 @@ export declare class ChatSocket {
      * Send text input
      */
     sendUserInput(text: string): void;
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect(): ChatSocket;
     /**
      * Closes the underlying socket.
      */
     close(): void;
+    private assertSocketIsOpen;
     private sendJson;
     private handleOpen;
     private handleMessage;

package/api/resources/empathicVoice/resources/chat/client/Socket.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatSocket = void 0;
+const errors = __importStar(require("../../../../../../errors"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 class ChatSocket {
     constructor({ socket }) {
@@ -83,63 +84,93 @@ class ChatSocket {
      * Send audio input
      */
     sendAudioInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "audio_input" }, message));
     }
     /**
      * Send session settings
      */
     sendSessionSettings(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "session_settings" }, message));
     }
     /**
      * Send assistant input
      */
     sendAssistantInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "assistant_input" }, message));
     }
     /**
      * Send pause assistant message
      */
     pauseAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "pause_assistant_message" }, message));
     }
     /**
      * Send resume assistant message
      */
     resumeAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "resume_assistant_message" }, message));
     }
     /**
      * Send tool response message
      */
     sendToolResponseMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_response" }, message));
     }
     /**
      * Send tool error message
      */
     sendToolErrorMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_error" }, message));
     }
     /**
      * Send text input
      */
     sendUserInput(text) {
+        this.assertSocketIsOpen();
         this.sendJson({
             type: "user_input",
             text,
         });
     }
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener('open', this.handleOpen);
+        this.socket.addEventListener('message', this.handleMessage);
+        this.socket.addEventListener('close', this.handleClose);
+        this.socket.addEventListener('error', this.handleError);
+        return this;
+    }
     /**
      * Closes the underlying socket.
      */
     close() {
         this.socket.close();
+        this.handleClose({ code: 1000 });
         this.socket.removeEventListener('open', this.handleOpen);
         this.socket.removeEventListener('message', this.handleMessage);
         this.socket.removeEventListener('close', this.handleClose);
         this.socket.removeEventListener('error', this.handleError);
     }
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new errors.HumeError({ message: 'Socket is not connected.' });
+        }
+        if (this.socket.readyState !== WebSocket.OPEN) {
+            throw new errors.HumeError({ message: 'Socket is not open.' });
+        }
+    }
     sendJson(payload) {
         const jsonPayload = serializers.empathicVoice.PublishEvent.jsonOrThrow(payload, {
             unrecognizedObjectKeys: "strip",

package/dist/api/resources/empathicVoice/resources/chat/client/Client.d.ts

@@ -6,12 +6,18 @@ export declare namespace Chat {
         accessToken?: core.Supplier<string | undefined>;
     }
     interface ConnectArgs {
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
         /** The ID of the configuration. */
         configId?: string;
         /** The version of the configuration. */
         configVersion?: string;
         /** The ID of a chat group, used to resume a previous chat. */
         resumedChatGroupId?: string;
+        /** Extra query parameters sent at WebSocket connection */
+        queryParams?: Record<string, string | string[] | object | object[]>;
     }
 }
 export declare class Chat {

package/dist/api/resources/empathicVoice/resources/chat/client/Client.js

@@ -35,6 +35,7 @@ class Chat {
         this._options = _options;
     }
     connect(args = {}) {
+        var _a;
         const queryParams = {};
         if (this._options.accessToken != null) {
             queryParams["accessToken"] = core.Supplier.get(this._options.accessToken);
@@ -51,7 +52,16 @@ class Chat {
         if (args.resumedChatGroupId != null) {
             queryParams["resumed_chat_group_id"] = args.resumedChatGroupId;
         }
-        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`);
+        if (args.queryParams != null) {
+            for (const [name, value] of Object.entries(args.queryParams)) {
+                queryParams[name] = value;
+            }
+        }
+        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`, [], {
+            startClosed: true,
+            debug: (_a = args.debug) !== null && _a !== void 0 ? _a : false,
+            maxRetries: args.reconnectAttempts,
+        });
         return new Socket_1.ChatSocket({
             socket,
         });

package/dist/api/resources/empathicVoice/resources/chat/client/Socket.d.ts

@@ -64,10 +64,17 @@ export declare class ChatSocket {
      * Send text input
      */
     sendUserInput(text: string): void;
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect(): ChatSocket;
     /**
      * Closes the underlying socket.
      */
     close(): void;
+    private assertSocketIsOpen;
     private sendJson;
     private handleOpen;
     private handleMessage;

package/dist/api/resources/empathicVoice/resources/chat/client/Socket.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatSocket = void 0;
+const errors = __importStar(require("../../../../../../errors"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 class ChatSocket {
     constructor({ socket }) {
@@ -83,63 +84,93 @@ class ChatSocket {
      * Send audio input
      */
     sendAudioInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "audio_input" }, message));
     }
     /**
      * Send session settings
      */
     sendSessionSettings(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "session_settings" }, message));
     }
     /**
      * Send assistant input
      */
     sendAssistantInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "assistant_input" }, message));
     }
     /**
      * Send pause assistant message
      */
     pauseAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "pause_assistant_message" }, message));
     }
     /**
      * Send resume assistant message
      */
     resumeAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "resume_assistant_message" }, message));
     }
     /**
      * Send tool response message
      */
     sendToolResponseMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_response" }, message));
     }
     /**
      * Send tool error message
      */
     sendToolErrorMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_error" }, message));
     }
     /**
      * Send text input
      */
     sendUserInput(text) {
+        this.assertSocketIsOpen();
         this.sendJson({
             type: "user_input",
             text,
         });
     }
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener('open', this.handleOpen);
+        this.socket.addEventListener('message', this.handleMessage);
+        this.socket.addEventListener('close', this.handleClose);
+        this.socket.addEventListener('error', this.handleError);
+        return this;
+    }
     /**
      * Closes the underlying socket.
      */
     close() {
         this.socket.close();
+        this.handleClose({ code: 1000 });
         this.socket.removeEventListener('open', this.handleOpen);
         this.socket.removeEventListener('message', this.handleMessage);
         this.socket.removeEventListener('close', this.handleClose);
         this.socket.removeEventListener('error', this.handleError);
     }
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new errors.HumeError({ message: 'Socket is not connected.' });
+        }
+        if (this.socket.readyState !== WebSocket.OPEN) {
+            throw new errors.HumeError({ message: 'Socket is not open.' });
+        }
+    }
     sendJson(payload) {
         const jsonPayload = serializers.empathicVoice.PublishEvent.jsonOrThrow(payload, {
             unrecognizedObjectKeys: "strip",

package/dist/wrapper/fetchAccessToken.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Fetches a new access token from the Hume API using the provided API key and Secret key.
+ *
+ * @param args - The arguments for the request.
+ * @returns Promise that resolves to the new access token.
+ * @throws If the base64 encoding fails.
+ * @throws If the network request fails.
+ * @example
+ * ```typescript
+ * async function getToken() {
+ *   const accessToken = await fetchAccessToken({
+ *     apiKey: 'test',
+ *     secretKey: 'test',
+ *   });
+ *   console.log(accessToken); // Outputs the access token
+ * }
+ * ```
+ */
+export declare const fetchAccessToken: (args: {
+    apiKey: string;
+    secretKey: string;
+    host?: string;
+}) => Promise<string>;

package/dist/wrapper/fetchAccessToken.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAccessToken = void 0;
+const base64Encode_1 = require("./base64Encode");
+/**
+ * Fetches a new access token from the Hume API using the provided API key and Secret key.
+ *
+ * @param args - The arguments for the request.
+ * @returns Promise that resolves to the new access token.
+ * @throws If the base64 encoding fails.
+ * @throws If the network request fails.
+ * @example
+ * ```typescript
+ * async function getToken() {
+ *   const accessToken = await fetchAccessToken({
+ *     apiKey: 'test',
+ *     secretKey: 'test',
+ *   });
+ *   console.log(accessToken); // Outputs the access token
+ * }
+ * ```
+ */
+const fetchAccessToken = (args) => __awaiter(void 0, void 0, void 0, function* () {
+    const { apiKey, secretKey, host = 'api.hume.ai' } = args;
+    const authString = `${apiKey}:${secretKey}`;
+    const encoded = (0, base64Encode_1.base64Encode)(authString);
+    const res = yield fetch(`https://${host}/oauth2-cc/token`, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Authorization: `Basic ${encoded}`,
+        },
+        body: new URLSearchParams({
+            grant_type: 'client_credentials',
+        }).toString(),
+        cache: 'no-cache',
+    });
+    const data = (yield res.json());
+    const accessToken = String(data['access_token']);
+    return accessToken;
+});
+exports.fetchAccessToken = fetchAccessToken;

package/dist/wrapper/index.d.ts

@@ -4,6 +4,7 @@ export { convertBase64ToBlob } from "./convertBase64ToBlob";
 export { convertBlobToBase64 } from "./convertBlobToBase64";
 export { ensureSingleValidAudioTrack } from "./ensureSingleValidAudioTrack";
 export { checkForAudioTracks } from "./checkForAudioTracks";
+export { fetchAccessToken } from "./fetchAccessToken";
 export { getAudioStream } from "./getAudioStream";
 export { MimeType, getBrowserSupportedMimeType } from "./getBrowserSupportedMimeType";
 export { HumeClient } from "./HumeClient";

package/dist/wrapper/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HumeClient = exports.getBrowserSupportedMimeType = exports.MimeType = exports.getAudioStream = exports.checkForAudioTracks = exports.ensureSingleValidAudioTrack = exports.convertBlobToBase64 = exports.convertBase64ToBlob = exports.base64Encode = exports.base64Decode = void 0;
+exports.HumeClient = exports.getBrowserSupportedMimeType = exports.MimeType = exports.getAudioStream = exports.fetchAccessToken = exports.checkForAudioTracks = exports.ensureSingleValidAudioTrack = exports.convertBlobToBase64 = exports.convertBase64ToBlob = exports.base64Encode = exports.base64Decode = void 0;
 var base64Decode_1 = require("./base64Decode");
 Object.defineProperty(exports, "base64Decode", { enumerable: true, get: function () { return base64Decode_1.base64Decode; } });
 var base64Encode_1 = require("./base64Encode");
@@ -13,6 +13,8 @@ var ensureSingleValidAudioTrack_1 = require("./ensureSingleValidAudioTrack");
 Object.defineProperty(exports, "ensureSingleValidAudioTrack", { enumerable: true, get: function () { return ensureSingleValidAudioTrack_1.ensureSingleValidAudioTrack; } });
 var checkForAudioTracks_1 = require("./checkForAudioTracks");
 Object.defineProperty(exports, "checkForAudioTracks", { enumerable: true, get: function () { return checkForAudioTracks_1.checkForAudioTracks; } });
+var fetchAccessToken_1 = require("./fetchAccessToken");
+Object.defineProperty(exports, "fetchAccessToken", { enumerable: true, get: function () { return fetchAccessToken_1.fetchAccessToken; } });
 var getAudioStream_1 = require("./getAudioStream");
 Object.defineProperty(exports, "getAudioStream", { enumerable: true, get: function () { return getAudioStream_1.getAudioStream; } });
 var getBrowserSupportedMimeType_1 = require("./getBrowserSupportedMimeType");

package/package.json

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

package/wrapper/fetchAccessToken.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Fetches a new access token from the Hume API using the provided API key and Secret key.
+ *
+ * @param args - The arguments for the request.
+ * @returns Promise that resolves to the new access token.
+ * @throws If the base64 encoding fails.
+ * @throws If the network request fails.
+ * @example
+ * ```typescript
+ * async function getToken() {
+ *   const accessToken = await fetchAccessToken({
+ *     apiKey: 'test',
+ *     secretKey: 'test',
+ *   });
+ *   console.log(accessToken); // Outputs the access token
+ * }
+ * ```
+ */
+export declare const fetchAccessToken: (args: {
+    apiKey: string;
+    secretKey: string;
+    host?: string;
+}) => Promise<string>;

package/wrapper/fetchAccessToken.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAccessToken = void 0;
+const base64Encode_1 = require("./base64Encode");
+/**
+ * Fetches a new access token from the Hume API using the provided API key and Secret key.
+ *
+ * @param args - The arguments for the request.
+ * @returns Promise that resolves to the new access token.
+ * @throws If the base64 encoding fails.
+ * @throws If the network request fails.
+ * @example
+ * ```typescript
+ * async function getToken() {
+ *   const accessToken = await fetchAccessToken({
+ *     apiKey: 'test',
+ *     secretKey: 'test',
+ *   });
+ *   console.log(accessToken); // Outputs the access token
+ * }
+ * ```
+ */
+const fetchAccessToken = (args) => __awaiter(void 0, void 0, void 0, function* () {
+    const { apiKey, secretKey, host = 'api.hume.ai' } = args;
+    const authString = `${apiKey}:${secretKey}`;
+    const encoded = (0, base64Encode_1.base64Encode)(authString);
+    const res = yield fetch(`https://${host}/oauth2-cc/token`, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Authorization: `Basic ${encoded}`,
+        },
+        body: new URLSearchParams({
+            grant_type: 'client_credentials',
+        }).toString(),
+        cache: 'no-cache',
+    });
+    const data = (yield res.json());
+    const accessToken = String(data['access_token']);
+    return accessToken;
+});
+exports.fetchAccessToken = fetchAccessToken;

package/wrapper/index.d.ts

@@ -4,6 +4,7 @@ export { convertBase64ToBlob } from "./convertBase64ToBlob";
 export { convertBlobToBase64 } from "./convertBlobToBase64";
 export { ensureSingleValidAudioTrack } from "./ensureSingleValidAudioTrack";
 export { checkForAudioTracks } from "./checkForAudioTracks";
+export { fetchAccessToken } from "./fetchAccessToken";
 export { getAudioStream } from "./getAudioStream";
 export { MimeType, getBrowserSupportedMimeType } from "./getBrowserSupportedMimeType";
 export { HumeClient } from "./HumeClient";

package/wrapper/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HumeClient = exports.getBrowserSupportedMimeType = exports.MimeType = exports.getAudioStream = exports.checkForAudioTracks = exports.ensureSingleValidAudioTrack = exports.convertBlobToBase64 = exports.convertBase64ToBlob = exports.base64Encode = exports.base64Decode = void 0;
+exports.HumeClient = exports.getBrowserSupportedMimeType = exports.MimeType = exports.getAudioStream = exports.fetchAccessToken = exports.checkForAudioTracks = exports.ensureSingleValidAudioTrack = exports.convertBlobToBase64 = exports.convertBase64ToBlob = exports.base64Encode = exports.base64Decode = void 0;
 var base64Decode_1 = require("./base64Decode");
 Object.defineProperty(exports, "base64Decode", { enumerable: true, get: function () { return base64Decode_1.base64Decode; } });
 var base64Encode_1 = require("./base64Encode");
@@ -13,6 +13,8 @@ var ensureSingleValidAudioTrack_1 = require("./ensureSingleValidAudioTrack");
 Object.defineProperty(exports, "ensureSingleValidAudioTrack", { enumerable: true, get: function () { return ensureSingleValidAudioTrack_1.ensureSingleValidAudioTrack; } });
 var checkForAudioTracks_1 = require("./checkForAudioTracks");
 Object.defineProperty(exports, "checkForAudioTracks", { enumerable: true, get: function () { return checkForAudioTracks_1.checkForAudioTracks; } });
+var fetchAccessToken_1 = require("./fetchAccessToken");
+Object.defineProperty(exports, "fetchAccessToken", { enumerable: true, get: function () { return fetchAccessToken_1.fetchAccessToken; } });
 var getAudioStream_1 = require("./getAudioStream");
 Object.defineProperty(exports, "getAudioStream", { enumerable: true, get: function () { return getAudioStream_1.getAudioStream; } });
 var getBrowserSupportedMimeType_1 = require("./getBrowserSupportedMimeType");