@humeai/voice-embed 0.1.10 → 0.1.11-beta.2

package/README.md

@@ -8,9 +8,9 @@
 
 ## Overview
 
-This package enables you to integrate a widget that runs Hume's Empathic Voice Interface any Javascript application. It abstracts away the complexities of managing websocket connections, capturing user audio via the client's microphone, and handling the playback of the interface's audio responses. The widget is embedded into your web page through an iframe. 
+This package enables you to integrate a widget that runs Hume's Empathic Voice Interface any Javascript application. It abstracts away the complexities of managing websocket connections, capturing user audio via the client's microphone, and handling the playback of the interface's audio responses. The widget is embedded into your web page through an iframe.
 
-There are two packages needed to embed your own widget. Install this package to embed the widget to your application. Code for the widget itself can be found at [https://github.com/HumeAI/empathic-voice-embed-renderer](https://github.com/HumeAI/empathic-voice-embed-renderer). 
+There are two packages needed to embed your own widget. Install this package to embed the widget to your application. Code for the widget itself can be found at [https://github.com/HumeAI/empathic-voice-embed-renderer](https://github.com/HumeAI/empathic-voice-embed-renderer).
 
 ## Prerequisites
 
@@ -40,7 +40,7 @@ This will download and include the package in your project, making it ready for
 import { EmbeddedVoice } from '@humeai/voice-embed';
 ```
 
-__NOTE:__ If you are building a React application, you can use our React voice embed SDK instead of this one. [Documentation can be found here](https://github.com/HumeAI/empathic-voice-api-js/blob/main/packages/embed-react).
+**NOTE:** If you are building a React application, you can use our React voice embed SDK instead of this one. [Documentation can be found here](https://github.com/HumeAI/empathic-voice-api-js/blob/main/packages/embed-react).
 
 ## Usage
 
@@ -57,7 +57,7 @@ import {
 } from '@humeai/voice-embed';
 
 const embeddedVoice = EA.create({
-    // Configuration options
+  // Configuration options
 });
 ```
 
@@ -69,13 +69,13 @@ Configuration options for the embedded voice include all props that are accepted
 
 In addition, it accepts a few other configurations specific to creating a widget:
 
-| Option              | Required | Description                                                                                                                                                                                                                                                                                                                         |
-| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `isEmbedOpen`       | yes      | Determines the initial visibility of the widget. Assign `true` to render the widget as open on initial load, and `false` to start with the widget closed. While the widget's UI provides a trigger to toggle its visibility, this prop also enables external control over the widget's visibility state through a parent component. |
-| rendererUrl       | no       | URL where the widget itself is hosted. If blank, this defaults the Hume AI widget, https://voice-widget.hume.ai. An example of this widget can be found at [http://hume.ai](http://hume.ai).                                                                                                                                                                                                                                      |
-| `onMessage`         | no       | Callback function to invoke upon receiving a message through the web socket.                                                                                                                                                                                                                                                        |
-| `onClose`           | no       | Callback function to invoke upon the web socket connection being closed.                                                                                                                                                                                                                                                            |
-| `openOnMount`           | no       | Boolean which indicates whether the widget should be initialized in an open or closed state. Set as `true` if you want it to be open. The default value is `false`.                                                                                                                                                                                                                                                             |
+| Option        | Required | Description                                                                                                                                                                                                                                                                                                                         |
+| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `isEmbedOpen` | yes      | Determines the initial visibility of the widget. Assign `true` to render the widget as open on initial load, and `false` to start with the widget closed. While the widget's UI provides a trigger to toggle its visibility, this prop also enables external control over the widget's visibility state through a parent component. |
+| rendererUrl   | no       | URL where the widget itself is hosted. If blank, this defaults the Hume AI widget, https://voice-widget.hume.ai. An example of this widget can be found at [http://hume.ai](http://hume.ai).                                                                                                                                        |
+| `onMessage`   | no       | Callback function to invoke upon receiving a message through the web socket.                                                                                                                                                                                                                                                        |
+| `onClose`     | no       | Callback function to invoke upon the web socket connection being closed.                                                                                                                                                                                                                                                            |
+| `openOnMount` | no       | Boolean which indicates whether the widget should be initialized in an open or closed state. Set as `true` if you want it to be open. The default value is `false`.                                                                                                                                                                 |
 
 ## Support
 

package/dist/index.d.mts

@@ -1,39 +1,6 @@
-import { SocketConfig, UserTranscriptMessage, AssistantTranscriptMessage } from '@humeai/voice';
-export { AssistantTranscriptMessage, ChatMetadataMessage, EmotionScores, JSONMessage, LanguageModelOption, SocketConfig, ToolCall, ToolError, ToolResponse, UserTranscriptMessage } from '@humeai/voice';
+import { Hume } from 'hume';
 import { z } from 'zod';
-
-type EmbeddedVoiceConfig = {
-    rendererUrl: string;
-    iframeTitle?: string;
-} & SocketConfig;
-type TranscriptMessageHandler = (message: UserTranscriptMessage | AssistantTranscriptMessage) => void;
-type CloseHandler = () => void;
-declare class EmbeddedVoice {
-    private iframe;
-    private isMounted;
-    private managedContainer;
-    private config;
-    private onMessage;
-    private onClose;
-    private openOnMount;
-    private constructor();
-    static create({ rendererUrl, onMessage, onClose, openOnMount, ...config }: Partial<EmbeddedVoiceConfig> & {
-        onMessage?: TranscriptMessageHandler;
-        onClose?: CloseHandler;
-        openOnMount?: boolean;
-    } & NonNullable<Pick<EmbeddedVoiceConfig, 'auth'>>): EmbeddedVoice;
-    mount(container?: HTMLElement): () => void;
-    private createContainer;
-    private createIframe;
-    private messageHandler;
-    openEmbed(): void;
-    private sendConfigObject;
-    private sendWindowSize;
-    private sendMessageToFrame;
-    private showIframe;
-    private hideIframe;
-    private resizeIframe;
-}
+export { AssistantMessage, AssistantMessage as AssistantTranscriptMessage, ChatMetadata, ChatMetadata as ChatMetadataMessage, EmotionScores, SubscribeEvent as JSONMessage, SubscribeEvent, ToolCallMessage as ToolCall, ToolCallMessage, ToolErrorMessage as ToolError, ToolErrorMessage, ToolResponseMessage as ToolResponse, ToolResponseMessage, UserMessage, UserMessage as UserTranscriptMessage } from 'hume/api/resources/empathicVoice';
 
 /**
                                                                          
@@ -79,97 +46,77 @@ declare const WindowDimensionsSchema: z.ZodObject<{
     height: number;
 }>;
 type WindowDimensions = z.infer<typeof WindowDimensionsSchema>;
-declare const ClientToFrameActionSchema: z.ZodUnion<[z.ZodObject<{
-    type: z.ZodLiteral<"update_config">;
-    payload: z.ZodObject<{
-        hostname: z.ZodString;
-        reconnectAttempts: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-        debug: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        auth: z.ZodUnion<[z.ZodObject<{
-            type: z.ZodLiteral<"apiKey">;
-            value: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "apiKey";
-            value: string;
-        }, {
-            type: "apiKey";
-            value: string;
-        }>, z.ZodObject<{
-            type: z.ZodLiteral<"accessToken">;
-            value: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "accessToken";
-            value: string;
-        }, {
-            type: "accessToken";
-            value: string;
-        }>]>;
-        configId: z.ZodOptional<z.ZodString>;
-        configVersion: z.ZodOptional<z.ZodNumber>;
-        resumedChatGroupId: z.ZodOptional<z.ZodString>;
+declare const SocketConnect: z.ZodType<Hume.empathicVoice.chat.Chat.ConnectArgs, z.ZodTypeDef, Hume.empathicVoice.chat.Chat.ConnectArgs>;
+type SocketConnectSchema = z.infer<typeof SocketConnect>;
+declare const BaseSocketConfig: z.ZodObject<{
+    auth: z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"apiKey">;
+        value: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        hostname: string;
-        reconnectAttempts: number;
-        debug: boolean;
-        auth: {
-            type: "apiKey";
-            value: string;
-        } | {
-            type: "accessToken";
-            value: string;
-        };
-        configId?: string | undefined;
-        configVersion?: number | undefined;
-        resumedChatGroupId?: string | undefined;
+        value: string;
+        type: "apiKey";
     }, {
-        hostname: string;
-        auth: {
-            type: "apiKey";
-            value: string;
-        } | {
-            type: "accessToken";
-            value: string;
-        };
-        reconnectAttempts?: number | undefined;
-        debug?: boolean | undefined;
-        configId?: string | undefined;
-        configVersion?: number | undefined;
-        resumedChatGroupId?: string | undefined;
-    }>;
+        value: string;
+        type: "apiKey";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"accessToken">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "accessToken";
+    }, {
+        value: string;
+        type: "accessToken";
+    }>]>;
+    hostname: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    auth: {
+        value: string;
+        type: "apiKey";
+    } | {
+        value: string;
+        type: "accessToken";
+    };
+    hostname?: string | undefined;
+}, {
+    auth: {
+        value: string;
+        type: "apiKey";
+    } | {
+        value: string;
+        type: "accessToken";
+    };
+    hostname?: string | undefined;
+}>;
+type SocketAuthSchema = z.infer<typeof BaseSocketConfig>;
+type SocketConfig = SocketAuthSchema & SocketConnectSchema;
+declare const ClientToFrameActionSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"update_config">;
+    payload: z.ZodType<SocketConfig, z.ZodTypeDef, SocketConfig>;
 }, "strip", z.ZodTypeAny, {
     type: "update_config";
     payload: {
-        hostname: string;
-        reconnectAttempts: number;
-        debug: boolean;
         auth: {
-            type: "apiKey";
             value: string;
+            type: "apiKey";
         } | {
-            type: "accessToken";
             value: string;
+            type: "accessToken";
         };
-        configId?: string | undefined;
-        configVersion?: number | undefined;
-        resumedChatGroupId?: string | undefined;
-    };
+        hostname?: string | undefined;
+    } & Hume.empathicVoice.chat.Chat.ConnectArgs;
 }, {
     type: "update_config";
     payload: {
-        hostname: string;
         auth: {
-            type: "apiKey";
             value: string;
+            type: "apiKey";
         } | {
-            type: "accessToken";
             value: string;
+            type: "accessToken";
         };
-        reconnectAttempts?: number | undefined;
-        debug?: boolean | undefined;
-        configId?: string | undefined;
-        configVersion?: number | undefined;
-        resumedChatGroupId?: string | undefined;
-    };
+        hostname?: string | undefined;
+    } & Hume.empathicVoice.chat.Chat.ConnectArgs;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"cancel">;
 }, "strip", z.ZodTypeAny, {
@@ -253,316 +200,13 @@ declare const FrameToClientActionSchema: z.ZodUnion<[z.ZodObject<{
     type: "widget_iframe_is_ready";
 }>, z.ZodObject<{
     type: z.ZodLiteral<"transcript_message">;
-    payload: z.ZodUnion<[z.ZodEffects<z.ZodObject<{
-        type: z.ZodLiteral<"user_message">;
-        message: z.ZodObject<{
-            role: z.ZodLiteral<"user">;
-            content: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            role: "user";
-            content: string;
-        }, {
-            role: "user";
-            content: string;
-        }>;
-        models: z.ZodObject<{
-            prosody: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-                scores: z.ZodRecord<z.ZodString, z.ZodNumber>;
-            }, "strip", z.ZodTypeAny, {
-                scores: Record<string, number>;
-            }, {
-                scores: Record<string, number>;
-            }>>>;
-            time: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-                begin: z.ZodNumber;
-                end: z.ZodNumber;
-            }, "strip", z.ZodTypeAny, {
-                begin: number;
-                end: number;
-            }, {
-                begin: number;
-                end: number;
-            }>>>;
-        }, "strip", z.ZodTypeAny, {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        }, {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        }>;
-        from_text: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>>;
-    }, "strip", z.ZodTypeAny, {
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: boolean | null | undefined;
-    }, {
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    }>, {
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: boolean | null | undefined;
-    } & {
-        receivedAt: Date;
-    }, {
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    }>, z.ZodEffects<z.ZodObject<{
-        type: z.ZodLiteral<"assistant_message">;
-        id: z.ZodString;
-        message: z.ZodObject<{
-            role: z.ZodLiteral<"assistant">;
-            content: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            role: "assistant";
-            content: string;
-        }, {
-            role: "assistant";
-            content: string;
-        }>;
-        models: z.ZodObject<{
-            prosody: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-                scores: z.ZodRecord<z.ZodString, z.ZodNumber>;
-            }, "strip", z.ZodTypeAny, {
-                scores: Record<string, number>;
-            }, {
-                scores: Record<string, number>;
-            }>>>;
-            time: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-                begin: z.ZodNumber;
-                end: z.ZodNumber;
-            }, "strip", z.ZodTypeAny, {
-                begin: number;
-                end: number;
-            }, {
-                begin: number;
-                end: number;
-            }>>>;
-        }, "strip", z.ZodTypeAny, {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        }, {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        }>;
-        from_text: z.ZodCatch<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text: boolean;
-    }, {
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    }>, {
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text: boolean;
-    } & {
-        receivedAt: Date;
-    }, {
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    }>]>;
+    payload: z.ZodType<Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage, z.ZodTypeDef, Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage>;
 }, "strip", z.ZodTypeAny, {
     type: "transcript_message";
-    payload: ({
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: boolean | null | undefined;
-    } & {
-        receivedAt: Date;
-    }) | ({
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text: boolean;
-    } & {
-        receivedAt: Date;
-    });
+    payload: Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage;
 }, {
     type: "transcript_message";
-    payload: {
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    } | {
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: unknown;
-    };
+    payload: Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"resize_frame">;
     payload: z.ZodObject<{
@@ -601,46 +245,9 @@ declare const MINIMIZE_WIDGET_ACTION: {
 declare const WIDGET_IFRAME_IS_READY_ACTION: {
     type: "widget_iframe_is_ready";
 };
-declare const TRANSCRIPT_MESSAGE_ACTION: (message: UserTranscriptMessage | AssistantTranscriptMessage) => {
+declare const TRANSCRIPT_MESSAGE_ACTION: (message: Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage) => {
     type: "transcript_message";
-    payload: ({
-        type: "user_message";
-        message: {
-            role: "user";
-            content: string;
-        };
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text?: boolean | null | undefined;
-    } & {
-        receivedAt: Date;
-    }) | ({
-        type: "assistant_message";
-        message: {
-            role: "assistant";
-            content: string;
-        };
-        id: string;
-        models: {
-            prosody?: {
-                scores: Record<string, number>;
-            } | null | undefined;
-            time?: {
-                begin: number;
-                end: number;
-            } | null | undefined;
-        };
-        from_text: boolean;
-    } & {
-        receivedAt: Date;
-    });
+    payload: Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage;
 };
 declare const RESIZE_FRAME_ACTION: (dimensions: {
     width: number;
@@ -653,4 +260,49 @@ declare const RESIZE_FRAME_ACTION: (dimensions: {
     };
 };
 
-export { COLLAPSE_WIDGET_ACTION, type CloseHandler, EXPAND_WIDGET_ACTION, EmbeddedVoice, type EmbeddedVoiceConfig, type FrameToClientAction, MINIMIZE_WIDGET_ACTION, RESIZE_FRAME_ACTION, TRANSCRIPT_MESSAGE_ACTION, type TranscriptMessageHandler, WIDGET_IFRAME_IS_READY_ACTION, type WindowDimensions, parseClientToFrameAction };
+type EmbeddedVoiceConfig = {
+    rendererUrl?: string;
+    iframeTitle?: string;
+} & SocketConfig;
+type TranscriptMessageHandler = (message: Hume.empathicVoice.UserMessage | Hume.empathicVoice.AssistantMessage) => void;
+type CloseHandler = () => void;
+declare class EmbeddedVoice {
+    private iframe;
+    private isMounted;
+    private managedContainer;
+    private config;
+    private onMessage;
+    private onClose;
+    private openOnMount;
+    private constructor();
+    static create({ rendererUrl, onMessage, onClose, openOnMount, ...config }: EmbeddedVoiceConfig & {
+        onMessage?: TranscriptMessageHandler;
+        onClose?: CloseHandler;
+        openOnMount?: boolean;
+    }): EmbeddedVoice;
+    mount(container?: HTMLElement): () => void;
+    private createContainer;
+    private createIframe;
+    private messageHandler;
+    openEmbed(): void;
+    private sendConfigObject;
+    private sendWindowSize;
+    private sendMessageToFrame;
+    private showIframe;
+    private hideIframe;
+    private resizeIframe;
+}
+
+declare enum LanguageModelOption {
+    CLAUDE_3_OPUS = "CLAUDE_3_OPUS",
+    CLAUDE_3_SONNET = "CLAUDE_3_SONNET",
+    CLAUDE_3_HAIKU = "CLAUDE_3_HAIKU",
+    CLAUDE_21 = "CLAUDE_21",
+    CLAUDE_INSTANT_12 = "CLAUDE_INSTANT_12",
+    GPT_4_TURBO_PREVIEW = "GPT_4_TURBO_PREVIEW",
+    GPT_35_TURBO_0125 = "GPT_35_TURBO_0125",
+    GPT_35_TURBO = "GPT_35_TURBO",
+    FIREWORKS_MIXTRAL_8X7B = "FIREWORKS_MIXTRAL_8X7B"
+}
+
+export { COLLAPSE_WIDGET_ACTION, type CloseHandler, EXPAND_WIDGET_ACTION, EmbeddedVoice, type EmbeddedVoiceConfig, type FrameToClientAction, LanguageModelOption, MINIMIZE_WIDGET_ACTION, RESIZE_FRAME_ACTION, type SocketConfig, TRANSCRIPT_MESSAGE_ACTION, type TranscriptMessageHandler, WIDGET_IFRAME_IS_READY_ACTION, type WindowDimensions, parseClientToFrameAction };