@wallavi/widget 1.6.8 → 1.7.0

package/dist/index.d.mts

@@ -66,6 +66,27 @@ interface UserContext {
     pageContext?: PageContext;
     metadata?: Record<string, unknown>;
 }
+/**
+ * Plug-in backend for non-AI modes (e.g. human support chat).
+ * When provided, ChatWidget/useChat skip all Wallavi AI API calls and
+ * use these values directly — same UI, different message source.
+ */
+interface CustomBackend {
+    messages: Message[];
+    streaming: boolean;
+    send: (text: string, attachments?: AttachmentPayload[]) => Promise<void>;
+    reset?: () => void;
+    /** Current chat mode — used to display a status indicator in the widget. */
+    mode?: "ai" | "human";
+    /** Optional action button rendered between messages and input (e.g. "Talk to a human"). */
+    footerAction?: {
+        label: string;
+        sublabel?: string;
+        icon?: "human" | "ai";
+        onClick: () => Promise<void>;
+        loading?: boolean;
+    };
+}
 interface ChatWidgetConfig {
     agentId: string;
     workspaceId?: string;
@@ -120,6 +141,8 @@ interface ChatWidgetConfig {
      * Default: false.
      */
     enableAttachments?: boolean;
+    /** When set, bypasses Wallavi AI and routes messages through this backend instead. */
+    customBackend?: CustomBackend;
 }
 interface ChatWidgetProps extends ChatWidgetConfig {
     className?: string;
@@ -129,6 +152,8 @@ interface ChatWidgetProps extends ChatWidgetConfig {
     onExpand?: () => void;
     /** Controls which icon the expand button shows (expand vs minimize). */
     expanded?: boolean;
+    /** When true, removes border-radius, border, and shadow — use when ChatWidget is rendered inside an iframe whose container already provides those styles. */
+    embedded?: boolean;
 }
 type AttachmentContentType = "text" | "image" | "unsupported";
 /** Wire-format DTO included in /api/chat/stream request when files are attached. */
@@ -159,7 +184,18 @@ interface Attachment {
 declare function getContrastColor(hex: string): string;
 declare function formatToolName(name: string): string;
 
-interface BubbleWidgetProps extends ChatWidgetConfig {
+interface BubbleWidgetProps extends Partial<ChatWidgetConfig> {
+    /**
+     * Inbox token from Wallavi Support dashboard.
+     * When provided, the widget connects to the support inbox (human agents + optional AI)
+     * instead of a direct AI agent. Mutually exclusive with agentId.
+     */
+    inboxToken?: string;
+    /**
+     * Base URL of the Wallavi app. Only needed when using inboxToken from an external domain.
+     * @default "https://app.wallavi.com"
+     */
+    supportApiBase?: string;
     /** Where the bubble is anchored. Default: "bottom-right" */
     position?: "bottom-right" | "bottom-left";
     /** Chat panel width in px. Default: 360 */
@@ -213,10 +249,21 @@ interface BubbleWidgetProps extends ChatWidgetConfig {
      * Use together with isOpen to fully control open/close from outside.
      */
     onOpenChange?: (open: boolean) => void;
+    /**
+     * Label for the footer button shown while AI mode is active (prompts user to escalate).
+     * @default "Hablar con un agente"
+     */
+    requestHumanLabel?: string;
+    /**
+     * Label for the footer button shown while a human agent is handling the chat.
+     * When omitted the button is not rendered and the user cannot return to AI.
+     * @example "Volver a chatear con la IA"
+     */
+    returnToAiLabel?: string;
 }
-declare function BubbleWidget({ position: positionProp, width: widthProp, height: heightProp, expandedWidth, expandedHeight, keyboardShortcut: keyboardShortcutProp, shortcutKey, autoOpen: autoOpenProp, bubbleIconUrl: bubbleIconUrlProp, bubbleSize: bubbleSizeProp, panelClassName, autoConfig, hideBubble, isOpen: isOpenProp, onOpenChange, ...chatProps }: BubbleWidgetProps): react_jsx_runtime.JSX.Element;
+declare function BubbleWidget({ inboxToken, supportApiBase, requestHumanLabel, returnToAiLabel, position: positionProp, width: widthProp, height: heightProp, expandedWidth, expandedHeight, keyboardShortcut: keyboardShortcutProp, shortcutKey, autoOpen: autoOpenProp, bubbleIconUrl: bubbleIconUrlProp, bubbleSize: bubbleSizeProp, panelClassName, autoConfig, hideBubble, isOpen: isOpenProp, onOpenChange, ...chatProps }: BubbleWidgetProps): react_jsx_runtime.JSX.Element;
 
-declare function ChatWidget({ agentId, workspaceId, agentName, displayName, profilePicture, userMessageColor, initialMessages, suggestedMessages, messagePlaceholder, watermark, watermarkLogoUrl, footer, theme, showThinking, regenerateMessage, persist, onNavigate, hideCloseButton, source, userContext, playgroundOverrides, enableVoice, voiceAutoSend, enableAttachments, className, onClose, onReset, onExpand, expanded, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ agentId, workspaceId, agentName, displayName, profilePicture, userMessageColor, initialMessages, suggestedMessages, messagePlaceholder, watermark, watermarkLogoUrl, footer, theme, showThinking, regenerateMessage, persist, onNavigate, hideCloseButton, source, userContext, playgroundOverrides, enableVoice, voiceAutoSend, enableAttachments, customBackend, className, onClose, onReset, onExpand, expanded, embedded, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface UseChatOptions {
     agentId: string;
@@ -230,6 +277,7 @@ interface UseChatOptions {
         mcpIds?: string[];
         actionIds?: string[];
     };
+    customBackend?: CustomBackend;
 }
 interface UseChatReturn {
     messages: Message[];
@@ -244,7 +292,29 @@ interface UseChatReturn {
     reset: () => void;
     selectPickerOption: (pickerId: string, paramName: string, value: string, label: string) => Promise<void>;
 }
-declare function useChat({ agentId, workspaceId, source, userContext, persist, onNavigate, playgroundOverrides, }: UseChatOptions): UseChatReturn;
+declare function useChat({ agentId, workspaceId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, }: UseChatOptions): UseChatReturn;
+
+interface UseSupportChatOptions {
+    /** Inbox token from Wallavi Support dashboard. */
+    inboxToken: string;
+    /**
+     * Base URL of the Wallavi app that hosts the support-chat API routes.
+     * @default "https://app.wallavi.com"
+     */
+    apiBase?: string;
+    /**
+     * Label for the footer button shown when AI mode is active.
+     * @default "Hablar con un agente"
+     */
+    requestHumanLabel?: string;
+    /**
+     * Label for the footer button shown when human agent mode is active.
+     * If not set, no "return to AI" button is shown.
+     * @example "Volver a chatear con la IA"
+     */
+    returnToAiLabel?: string;
+}
+declare function useSupportChat({ inboxToken, apiBase, requestHumanLabel, returnToAiLabel, }: UseSupportChatOptions): CustomBackend;
 
 type VoiceState = "idle" | "recording" | "transcribing" | "error";
 interface UseVoiceOptions {
@@ -284,4 +354,4 @@ interface UseAttachmentsReturn {
 }
 declare function useAttachments({ agentId, apiUrl, maxFiles, }: UseAttachmentsOptions): UseAttachmentsReturn;
 
-export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, type Message, type MessagePart, type PageContext, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useVoice };
+export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, type CustomBackend, type Message, type MessagePart, type PageContext, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };

package/dist/index.d.ts

@@ -66,6 +66,27 @@ interface UserContext {
     pageContext?: PageContext;
     metadata?: Record<string, unknown>;
 }
+/**
+ * Plug-in backend for non-AI modes (e.g. human support chat).
+ * When provided, ChatWidget/useChat skip all Wallavi AI API calls and
+ * use these values directly — same UI, different message source.
+ */
+interface CustomBackend {
+    messages: Message[];
+    streaming: boolean;
+    send: (text: string, attachments?: AttachmentPayload[]) => Promise<void>;
+    reset?: () => void;
+    /** Current chat mode — used to display a status indicator in the widget. */
+    mode?: "ai" | "human";
+    /** Optional action button rendered between messages and input (e.g. "Talk to a human"). */
+    footerAction?: {
+        label: string;
+        sublabel?: string;
+        icon?: "human" | "ai";
+        onClick: () => Promise<void>;
+        loading?: boolean;
+    };
+}
 interface ChatWidgetConfig {
     agentId: string;
     workspaceId?: string;
@@ -120,6 +141,8 @@ interface ChatWidgetConfig {
      * Default: false.
      */
     enableAttachments?: boolean;
+    /** When set, bypasses Wallavi AI and routes messages through this backend instead. */
+    customBackend?: CustomBackend;
 }
 interface ChatWidgetProps extends ChatWidgetConfig {
     className?: string;
@@ -129,6 +152,8 @@ interface ChatWidgetProps extends ChatWidgetConfig {
     onExpand?: () => void;
     /** Controls which icon the expand button shows (expand vs minimize). */
     expanded?: boolean;
+    /** When true, removes border-radius, border, and shadow — use when ChatWidget is rendered inside an iframe whose container already provides those styles. */
+    embedded?: boolean;
 }
 type AttachmentContentType = "text" | "image" | "unsupported";
 /** Wire-format DTO included in /api/chat/stream request when files are attached. */
@@ -159,7 +184,18 @@ interface Attachment {
 declare function getContrastColor(hex: string): string;
 declare function formatToolName(name: string): string;
 
-interface BubbleWidgetProps extends ChatWidgetConfig {
+interface BubbleWidgetProps extends Partial<ChatWidgetConfig> {
+    /**
+     * Inbox token from Wallavi Support dashboard.
+     * When provided, the widget connects to the support inbox (human agents + optional AI)
+     * instead of a direct AI agent. Mutually exclusive with agentId.
+     */
+    inboxToken?: string;
+    /**
+     * Base URL of the Wallavi app. Only needed when using inboxToken from an external domain.
+     * @default "https://app.wallavi.com"
+     */
+    supportApiBase?: string;
     /** Where the bubble is anchored. Default: "bottom-right" */
     position?: "bottom-right" | "bottom-left";
     /** Chat panel width in px. Default: 360 */
@@ -213,10 +249,21 @@ interface BubbleWidgetProps extends ChatWidgetConfig {
      * Use together with isOpen to fully control open/close from outside.
      */
     onOpenChange?: (open: boolean) => void;
+    /**
+     * Label for the footer button shown while AI mode is active (prompts user to escalate).
+     * @default "Hablar con un agente"
+     */
+    requestHumanLabel?: string;
+    /**
+     * Label for the footer button shown while a human agent is handling the chat.
+     * When omitted the button is not rendered and the user cannot return to AI.
+     * @example "Volver a chatear con la IA"
+     */
+    returnToAiLabel?: string;
 }
-declare function BubbleWidget({ position: positionProp, width: widthProp, height: heightProp, expandedWidth, expandedHeight, keyboardShortcut: keyboardShortcutProp, shortcutKey, autoOpen: autoOpenProp, bubbleIconUrl: bubbleIconUrlProp, bubbleSize: bubbleSizeProp, panelClassName, autoConfig, hideBubble, isOpen: isOpenProp, onOpenChange, ...chatProps }: BubbleWidgetProps): react_jsx_runtime.JSX.Element;
+declare function BubbleWidget({ inboxToken, supportApiBase, requestHumanLabel, returnToAiLabel, position: positionProp, width: widthProp, height: heightProp, expandedWidth, expandedHeight, keyboardShortcut: keyboardShortcutProp, shortcutKey, autoOpen: autoOpenProp, bubbleIconUrl: bubbleIconUrlProp, bubbleSize: bubbleSizeProp, panelClassName, autoConfig, hideBubble, isOpen: isOpenProp, onOpenChange, ...chatProps }: BubbleWidgetProps): react_jsx_runtime.JSX.Element;
 
-declare function ChatWidget({ agentId, workspaceId, agentName, displayName, profilePicture, userMessageColor, initialMessages, suggestedMessages, messagePlaceholder, watermark, watermarkLogoUrl, footer, theme, showThinking, regenerateMessage, persist, onNavigate, hideCloseButton, source, userContext, playgroundOverrides, enableVoice, voiceAutoSend, enableAttachments, className, onClose, onReset, onExpand, expanded, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ agentId, workspaceId, agentName, displayName, profilePicture, userMessageColor, initialMessages, suggestedMessages, messagePlaceholder, watermark, watermarkLogoUrl, footer, theme, showThinking, regenerateMessage, persist, onNavigate, hideCloseButton, source, userContext, playgroundOverrides, enableVoice, voiceAutoSend, enableAttachments, customBackend, className, onClose, onReset, onExpand, expanded, embedded, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface UseChatOptions {
     agentId: string;
@@ -230,6 +277,7 @@ interface UseChatOptions {
         mcpIds?: string[];
         actionIds?: string[];
     };
+    customBackend?: CustomBackend;
 }
 interface UseChatReturn {
     messages: Message[];
@@ -244,7 +292,29 @@ interface UseChatReturn {
     reset: () => void;
     selectPickerOption: (pickerId: string, paramName: string, value: string, label: string) => Promise<void>;
 }
-declare function useChat({ agentId, workspaceId, source, userContext, persist, onNavigate, playgroundOverrides, }: UseChatOptions): UseChatReturn;
+declare function useChat({ agentId, workspaceId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, }: UseChatOptions): UseChatReturn;
+
+interface UseSupportChatOptions {
+    /** Inbox token from Wallavi Support dashboard. */
+    inboxToken: string;
+    /**
+     * Base URL of the Wallavi app that hosts the support-chat API routes.
+     * @default "https://app.wallavi.com"
+     */
+    apiBase?: string;
+    /**
+     * Label for the footer button shown when AI mode is active.
+     * @default "Hablar con un agente"
+     */
+    requestHumanLabel?: string;
+    /**
+     * Label for the footer button shown when human agent mode is active.
+     * If not set, no "return to AI" button is shown.
+     * @example "Volver a chatear con la IA"
+     */
+    returnToAiLabel?: string;
+}
+declare function useSupportChat({ inboxToken, apiBase, requestHumanLabel, returnToAiLabel, }: UseSupportChatOptions): CustomBackend;
 
 type VoiceState = "idle" | "recording" | "transcribing" | "error";
 interface UseVoiceOptions {
@@ -284,4 +354,4 @@ interface UseAttachmentsReturn {
 }
 declare function useAttachments({ agentId, apiUrl, maxFiles, }: UseAttachmentsOptions): UseAttachmentsReturn;
 
-export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, type Message, type MessagePart, type PageContext, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useVoice };
+export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, type CustomBackend, type Message, type MessagePart, type PageContext, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };