@glydeunity/voice-sdk 1.6.24 → 1.6.27

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  *
  * ### 1. CDN Users (Minimal Code)
  * ```html
- * <script src="https://cdn.glyde.com/voice-sdk/v1.4.0/glyde-chat.umd.js"></script>
+ * <script src="https://unpkg.com/@glydeunity/voice-sdk@latest/dist/glyde-chat.umd.js"></script>
  * <script>
  *   GlydeChat.init({
  *     publishableKey: 'pk_...',
@@ -39,6 +39,21 @@ import { default as default_2 } from 'react';
  */
 export declare const ActivityIcon: default_2.FC<IconProps>;
 
+/**
+ * Agent metadata returned by the voice config endpoint.
+ * Used to populate dynamic headers in both VoiceChat and TextChat.
+ */
+export declare interface AgentMetadata {
+    /** Display name for the AI agent (e.g. "Chris") */
+    agent_name?: string;
+    /** Company or staffing agency name (e.g. "Acme Staffing") */
+    company_name?: string;
+    /** Job title when in a job-specific context */
+    job_title?: string;
+    /** Greeting phrase (server-controlled first message) */
+    greeting?: string;
+}
+
 /**
  * Authentication method used by the client
  */
@@ -556,42 +571,6 @@ declare interface ConversationSummaryResponse {
  * Deepgram agent configuration for LLM and voice settings
  */
 export declare interface DeepgramAgentConfig {
-    tags?: string[];
-    think?: {
-        provider?: {
-            type: string;
-            model?: string;
-        };
-        functions?: Array<{
-            name: string;
-            description: string;
-            parameters: unknown;
-            endpoint?: {
-                url: string;
-                method?: string;
-                headers?: Record<string, string>;
-            };
-        }>;
-    };
-    speak?: {
-        provider?: {
-            type: string;
-            model?: string;
-        };
-    };
-    listen?: {
-        provider?: {
-            type: string;
-            model?: string;
-            version?: string;
-        };
-    };
-}
-
-/**
- * Deepgram agent configuration for LLM and voice settings
- */
-declare interface DeepgramAgentConfig_2 {
     tags?: string[];
     /** Greeting phrase for the agent (server-controlled). Only used when provided by server. */
     greeting?: string;
@@ -756,6 +735,7 @@ export declare class GlydeText extends BaseGlydeClient<GlydeTextConfig, TextChat
     private conversationSummary;
     private contextSwitchManager;
     private currentContextType;
+    private agentMetadata;
     /**
      * Create a new GlydeText instance
      * @param config - Configuration options
@@ -837,16 +817,20 @@ export declare class GlydeText extends BaseGlydeClient<GlydeTextConfig, TextChat
      * @returns True if initialized
      */
     getIsInitialized(): boolean;
-    /**
-     * Alias for isInitialized() for backward compatibility
-     * @returns True if initialized
-     * @deprecated Use isInitialized() from base class instead
-     */
-    isInitialized(): boolean;
     /**
      * Get the current context type
      */
     getContextType(): VoiceContextType;
+    /**
+     * Fetch agent metadata from the voice config endpoint.
+     * Populates `agentMetadata` with agent name, company, job title, and greeting.
+     * Called during initialize(); failures are non-fatal.
+     */
+    fetchMetadata(): Promise<AgentMetadata | null>;
+    /**
+     * Get the agent metadata (available after initialize or fetchMetadata)
+     */
+    getAgentMetadata(): AgentMetadata | null;
     /**
      * Perform smooth context update (no full reinit)
      * For text chat, this just updates internal state
@@ -908,9 +892,7 @@ export declare interface GlydeTextConfig extends BaseGlydeConfig {
  * - Playback: AudioWorklet (audio-playback-processor.js) with ring buffer
  * - Ring buffer enables instant interruption (clear buffer when user speaks)
  */
-export declare class GlydeVoice {
-    private config;
-    private unityUrl;
+export declare class GlydeVoice extends BaseGlydeClient<GlydeVoiceConfig, VoiceEvent> {
     private active;
     private serverConfig;
     private ws;
@@ -924,23 +906,14 @@ export declare class GlydeVoice {
     private readonly inputSampleRate;
     private isAgentSpeaking;
     private agentAudioDoneReceived;
-    /** Pending context reinit after context_switch; run when agent stops speaking or after fallback timeout */
-    private pendingContextReinit;
-    private pendingContextReinitFallbackTimer;
-    private static readonly PENDING_REINIT_FALLBACK_MS;
+    private contextSwitchManager;
     private conversationHistory;
     private sessionContext;
     /**
      * Create a new GlydeVoice instance
      * @param config - Configuration options
      */
-    constructor(config: GlydeVoiceConfig_2);
-    /**
-     * Get authentication headers based on configured auth method
-     * Supports publishableKey, apiKey, and JWT token (authToken)
-     * @returns Headers object with appropriate authentication
-     */
-    private getAuthHeaders;
+    constructor(config: GlydeVoiceConfig);
     /**
      * Fetch voice configuration from Unity API for the current config context.
      * @returns Voice configuration including system prompt, tools, and Deepgram settings
@@ -965,10 +938,6 @@ export declare class GlydeVoice {
      * @returns A blob URL that can be used with audioWorklet.addModule()
      */
     private createWorkletBlobUrl;
-    /**
-     * Initialize the audio system with both capture and playback worklets.
-     * Uses inline blob URLs to avoid CORS issues when SDK is embedded in external apps.
-     */
     /**
      * Initialize the audio system: AudioContext, worklet modules, playback node,
      * and pre-acquire the microphone stream.
@@ -1000,9 +969,6 @@ export declare class GlydeVoice {
      * Clear the playback buffer (for interruption handling)
      */
     private clearPlaybackBuffer;
-    /**
-     * Start capturing microphone audio using AudioWorklet
-     */
     /**
      * Wire the pre-acquired microphone stream to the capture worklet so audio
      * data starts flowing to the WebSocket.  The stream itself was already
@@ -1029,7 +995,7 @@ export declare class GlydeVoice {
     /**
      * Get the current server configuration
      */
-    getServerConfig(): VoiceConfig_2 | null;
+    getServerConfig(): VoiceConfig | null;
     /**
      * Stop the voice session
      */
@@ -1039,9 +1005,9 @@ export declare class GlydeVoice {
      */
     private cleanup;
     /**
-     * Emit event to callback
+     * Emit event to the configured callback (implements BaseGlydeClient abstract method)
      */
-    private emit;
+    protected emitEvent(event: VoiceEvent): void;
     /**
      * Render a simple UI widget (optional)
      */
@@ -1090,12 +1056,6 @@ export declare class GlydeVoice {
         currentJobUuid?: string;
         candidateUuid?: string;
     }): void;
-    /**
-     * If a context reinit was pending (after context_switch), run it now. Called when the agent
-     * stops speaking (playback buffer empty) or when the fallback timeout fires.
-     * Prefers smooth update (UpdatePrompt) over full reinit; falls back to reinit if update fails.
-     */
-    private tryFlushPendingContextReinit;
     /**
      * Update context and system prompt in-place over the existing WebSocket (no reconnect).
      * Fetches the new config from Unity, sends Deepgram UpdatePrompt so the agent uses the new
@@ -1129,34 +1089,6 @@ export declare class GlydeVoice {
  * Configuration options for GlydeVoice
  */
 export declare interface GlydeVoiceConfig extends BaseGlydeConfig {
-    /** Voice context type - determines which prompt and tools to use */
-    contextType: VoiceContextType;
-    /** DOM element to render the widget UI (optional) */
-    container?: HTMLElement | string;
-    /** Event callback for voice agent events */
-    onEvent?: (event: VoiceEvent) => void;
-    /** Transcript callback for conversation text */
-    onTranscript?: (text: string, role: 'user' | 'agent') => void;
-    /** Override system prompt (skips config fetch) */
-    systemPrompt?: string;
-    /** Override Deepgram configuration */
-    deepgramConfig?: DeepgramAgentConfig;
-    /** When true, skip last-3-messages continuity limit for screening (e.g. cdn-test) */
-    skipContinuityLimit?: boolean;
-    /** Max last N messages when skipContinuityLimit is false (default 3; cdn-test use 5; CareerBuddy use 50). */
-    limitToLast?: number;
-}
-
-/**
- * Configuration options for GlydeVoice
- */
-declare interface GlydeVoiceConfig_2 {
-    /** Publishable key for external apps (Screen) */
-    publishableKey?: string;
-    /** API key for programmatic access */
-    apiKey?: string;
-    /** JWT token for GLYDEBuddy passthrough (Teams app) */
-    authToken?: string;
     /**
      * Voice context type - determines which prompt and tools to use
      *
@@ -1170,17 +1102,6 @@ declare interface GlydeVoiceConfig_2 {
      * - 'candidate_apply': Known candidate applying to job (contextId = candidate_uuid:job_uuid)
      */
     contextType: VoiceContextType;
-    /**
-     * Context identifier - format depends on contextType:
-     * - screening: application_uuid (required)
-     * - job_apply: job_uuid (required)
-     * - candidate_discover: candidate_uuid (required)
-     * - candidate_apply: "candidate_uuid:job_uuid" (required)
-     * - discovery, recruiter, custom, phone: optional
-     */
-    contextId?: string;
-    /** Unity API base URL - defaults to https://api.glydeunity.com */
-    unityBaseUrl?: string;
     /** DOM element to render the widget UI (optional) */
     container?: HTMLElement | string;
     /** Event callback for voice agent events */
@@ -1192,16 +1113,12 @@ declare interface GlydeVoiceConfig_2 {
         role: 'user' | 'agent';
         content: string;
     }>;
-    /**
-     * When true, request full chat history for screening. Default false = server sends only last limitToLast messages.
-     */
+    /** When true, skip last-3-messages continuity limit for screening (e.g. cdn-test) */
     skipContinuityLimit?: boolean;
-    /**
-     * Max last N messages to include when skipContinuityLimit is false (default 3). Use 5 for cdn-test; 50 for CareerBuddy/discovery/candidate_discover.
-     */
+    /** Max last N messages when skipContinuityLimit is false (default 3; cdn-test use 5; CareerBuddy use 50). */
     limitToLast?: number;
     /** Override Deepgram configuration (e.g. model, tags). System prompt and greeting remain server-controlled. */
-    deepgramConfig?: DeepgramAgentConfig_2;
+    deepgramConfig?: DeepgramAgentConfig;
     /**
      * Additional tool/function definitions to merge with server-provided functions.
      * Server-defined functions are always included; this allows adding extra tools only.
@@ -1257,15 +1174,6 @@ export declare interface MCPTool {
     inputSchema?: unknown;
 }
 
-/**
- * MCP Tool definition for voice agent
- */
-declare interface MCPTool_2 {
-    name: string;
-    description: string;
-    inputSchema?: unknown;
-}
-
 /**
  * Message / chat icon
  */
@@ -1346,8 +1254,6 @@ export declare interface TextChatProps {
     unityApiUrl?: string;
     /** Fixed height for the component */
     height?: string | number;
-    /** Header title */
-    title?: string;
     /** Placeholder text for input */
     placeholder?: string;
     /** Auto-initialize chat on mount */
@@ -1356,6 +1262,8 @@ export declare interface TextChatProps {
     onMessage?: (message: ChatMessage) => void;
     /** Callback when error occurs */
     onError?: (error: Error) => void;
+    /** Callback when context switches (e.g. screening -> candidate_discover) */
+    onContextSwitch?: (contextType: string, contextId: string) => void;
 }
 
 /**
@@ -1455,6 +1363,8 @@ export declare function useTextChat(config: UseTextChatConfig): UseTextChatRetur
 export declare interface UseTextChatConfig extends Omit<GlydeTextConfig, 'onEvent' | 'onMessage' | 'onTyping'> {
     /** Auto-initialize the chat on mount */
     autoInit?: boolean;
+    /** Callback when context switches (e.g. screening -> candidate_discover) */
+    onContextSwitch?: (payload: ContextSwitchPayload) => void;
 }
 
 /**
@@ -1469,6 +1379,8 @@ export declare interface UseTextChatReturn {
     isLoading: boolean;
     /** Error message if status is 'error' */
     errorMessage: string | null;
+    /** Agent metadata from voice config (agent_name, company_name, etc.) */
+    agentMetadata: AgentMetadata | null;
     /** Initialize the chat session */
     initialize: () => Promise<void>;
     /** Send a message */
@@ -1511,6 +1423,8 @@ export declare interface UseVoiceAgentReturn {
     isMuted: boolean;
     /** Error message if status is 'error' */
     errorMessage: string | null;
+    /** Agent metadata from voice config (agent_name, company_name, etc.) */
+    agentMetadata: AgentMetadata | null;
     /** Start the voice session */
     start: () => Promise<void>;
     /** Stop the voice session */
@@ -1584,19 +1498,8 @@ export declare interface VoiceConfig {
         type: VoiceContextType;
         id: string | null;
     };
-}
-
-/**
- * Voice configuration response from Unity API
- */
-declare interface VoiceConfig_2 {
-    system_prompt: string;
-    available_tools: MCPTool_2[];
-    deepgram_config: DeepgramAgentConfig_2;
-    context: {
-        type: VoiceContextType;
-        id: string | null;
-    };
+    /** Agent/company metadata for dynamic UI headers */
+    metadata?: AgentMetadata;
 }
 
 /**