@wallavi/widget 1.12.7 → 1.13.0

package/dist/index.d.mts

@@ -53,15 +53,37 @@ interface ContextEntity {
     name: string;
 }
 /** RAG topic summary surfaced in the Command Center sidebar. */
+/**
+ * Keywords of a topic or document: a plain list, or a list per language.
+ * Mirrors RagKeywords in @wallavi/protocol (checked in protocol-compat.ts).
+ */
+type RagKeywords = string[] | Record<string, string[]>;
+/** RAG topic surfaced in the Command Center sidebar. */
 interface RagTopicInfo {
     name: string;
     summary: string | null;
+    keywords?: RagKeywords | null;
 }
 /** RAG document summary surfaced in the Command Center sidebar. */
 interface RagDocumentInfo {
     name: string;
     summary: string | null;
     url: string | null;
+    keywords?: RagKeywords | null;
+}
+/**
+ * A client-side interface the agent can run. The public widget types are
+ * self-contained because the published .d.ts cannot import a private package;
+ * protocol-compat.ts makes the compiler fail if they drift from
+ * PublicClientAction in @wallavi/protocol.
+ */
+interface WidgetClientAction {
+    name: string;
+    description: string;
+    /** Declarative browser steps; each has at least its action name. */
+    steps: Array<{
+        action: string;
+    }>;
 }
 interface PageContext {
     /** Current URL or path (e.g. "/dashboard/agent/abc/agent-studio") */
@@ -73,8 +95,14 @@ interface PageContext {
     /** Any custom key-value pairs the developer wants the agent to know about */
     vars?: Record<string, unknown>;
 }
+/**
+ * Headers the host wants forwarded to tools with `authType: forwarded`. Pass a
+ * function when they carry a short-lived token: it is called before every
+ * message, e.g. `async () => ({ Authorization: `Bearer ${await getToken()}` })`.
+ */
+type UserHeaders = Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
 interface UserContext {
-    headers?: Record<string, string>;
+    headers?: UserHeaders;
     userId?: string;
     userName?: string;
     userEmail?: string;
@@ -114,6 +142,12 @@ interface CustomBackend {
 }
 interface ChatWidgetConfig {
     agentId: string;
+    /**
+     * Origin of the Wallavi API (e.g. "https://api.wallavi.com"). Defaults to
+     * NEXT_PUBLIC_API_URL, then Wallavi production. Hosts whose API origin is
+     * decided at runtime pass it here.
+     */
+    apiUrl?: string;
     workspaceId?: string;
     agentName: string;
     displayName?: string | null;
@@ -132,7 +166,7 @@ interface ChatWidgetConfig {
     showRagDocuments?: boolean;
     showQuickActions?: boolean;
     locale?: "en" | "es" | null;
-    clientActions?: any[];
+    clientActions?: WidgetClientAction[];
     /** RAG topics from the agent's knowledge base — used in Command Center */
     ragTopics?: RagTopicInfo[];
     /** RAG documents from the agent's knowledge base — used in Command Center */
@@ -302,7 +336,7 @@ interface BubbleWidgetProps extends Partial<ChatWidgetConfig> {
 }
 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, customBackend, className, onClose, onReset, onExpand, expanded, embedded, envId, onDebugTrace, widgetLayout, showCommandPanel, showRagTopics, showRagDocuments, showQuickActions, locale, clientActions, ragTopics, ragDocuments, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ agentId, apiUrl, 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, envId, onDebugTrace, widgetLayout, showCommandPanel, showRagTopics, showRagDocuments, showQuickActions, locale, clientActions, ragTopics, ragDocuments, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
 
 declare function IconTarget({ className }: {
     className?: string;
@@ -318,7 +352,7 @@ interface CommandPanelProps {
     pageParams?: Record<string, string>;
     pageVars?: Record<string, unknown>;
     metadata?: Record<string, unknown>;
-    clientActions?: any[];
+    clientActions?: WidgetClientAction[];
     ragTopics?: RagTopicInfo[];
     ragDocuments?: RagDocumentInfo[];
     onSend: (text: string) => void;
@@ -334,6 +368,8 @@ declare function CommandPanel({ mode, pageUrl, pageTitle, pageParams, pageVars,
 
 interface UseChatOptions {
     agentId: string;
+    /** Overrides NEXT_PUBLIC_API_URL for every chat request. */
+    apiUrl?: string;
     workspaceId?: string;
     envId?: string;
     source?: string;
@@ -346,6 +382,12 @@ interface UseChatOptions {
         actionIds?: string[];
     };
     customBackend?: CustomBackend;
+    copilotColor?: string;
+    /**
+     * Page context for a request when the host passes none in `userContext`.
+     * Called at send time so client-side navigation is reflected.
+     */
+    resolvePageContext?: () => PageContext | undefined;
 }
 interface UseChatReturn {
     messages: Message[];
@@ -412,7 +454,7 @@ interface DebugTrace {
     executionStatus: string;
     flags: string[];
 }
-declare function useChat({ agentId, workspaceId, envId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, }: UseChatOptions): UseChatReturn;
+declare function useChat({ agentId, apiUrl, workspaceId, envId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, copilotColor, resolvePageContext, }: UseChatOptions): UseChatReturn;
 
 declare function PlanCard({ part, onSend, disabled, locale, }: {
     part: PlanPart;
@@ -491,4 +533,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, CommandPanel, type CustomBackend, type DebugTrace, IconTarget, LiveDot, type Message, type MessagePart, type PageContext, PlanCard, type PlanPart, type RagDocumentInfo, type RagTopicInfo, ReasoningBlock, ToolCallBadge, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseChatOptions, type UseChatReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };
+export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, CommandPanel, type CustomBackend, type DebugTrace, IconTarget, LiveDot, type Message, type MessagePart, type PageContext, PlanCard, type PlanPart, type RagDocumentInfo, type RagTopicInfo, ReasoningBlock, ToolCallBadge, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseChatOptions, type UseChatReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type UserHeaders, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };

package/dist/index.d.ts

@@ -53,15 +53,37 @@ interface ContextEntity {
     name: string;
 }
 /** RAG topic summary surfaced in the Command Center sidebar. */
+/**
+ * Keywords of a topic or document: a plain list, or a list per language.
+ * Mirrors RagKeywords in @wallavi/protocol (checked in protocol-compat.ts).
+ */
+type RagKeywords = string[] | Record<string, string[]>;
+/** RAG topic surfaced in the Command Center sidebar. */
 interface RagTopicInfo {
     name: string;
     summary: string | null;
+    keywords?: RagKeywords | null;
 }
 /** RAG document summary surfaced in the Command Center sidebar. */
 interface RagDocumentInfo {
     name: string;
     summary: string | null;
     url: string | null;
+    keywords?: RagKeywords | null;
+}
+/**
+ * A client-side interface the agent can run. The public widget types are
+ * self-contained because the published .d.ts cannot import a private package;
+ * protocol-compat.ts makes the compiler fail if they drift from
+ * PublicClientAction in @wallavi/protocol.
+ */
+interface WidgetClientAction {
+    name: string;
+    description: string;
+    /** Declarative browser steps; each has at least its action name. */
+    steps: Array<{
+        action: string;
+    }>;
 }
 interface PageContext {
     /** Current URL or path (e.g. "/dashboard/agent/abc/agent-studio") */
@@ -73,8 +95,14 @@ interface PageContext {
     /** Any custom key-value pairs the developer wants the agent to know about */
     vars?: Record<string, unknown>;
 }
+/**
+ * Headers the host wants forwarded to tools with `authType: forwarded`. Pass a
+ * function when they carry a short-lived token: it is called before every
+ * message, e.g. `async () => ({ Authorization: `Bearer ${await getToken()}` })`.
+ */
+type UserHeaders = Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
 interface UserContext {
-    headers?: Record<string, string>;
+    headers?: UserHeaders;
     userId?: string;
     userName?: string;
     userEmail?: string;
@@ -114,6 +142,12 @@ interface CustomBackend {
 }
 interface ChatWidgetConfig {
     agentId: string;
+    /**
+     * Origin of the Wallavi API (e.g. "https://api.wallavi.com"). Defaults to
+     * NEXT_PUBLIC_API_URL, then Wallavi production. Hosts whose API origin is
+     * decided at runtime pass it here.
+     */
+    apiUrl?: string;
     workspaceId?: string;
     agentName: string;
     displayName?: string | null;
@@ -132,7 +166,7 @@ interface ChatWidgetConfig {
     showRagDocuments?: boolean;
     showQuickActions?: boolean;
     locale?: "en" | "es" | null;
-    clientActions?: any[];
+    clientActions?: WidgetClientAction[];
     /** RAG topics from the agent's knowledge base — used in Command Center */
     ragTopics?: RagTopicInfo[];
     /** RAG documents from the agent's knowledge base — used in Command Center */
@@ -302,7 +336,7 @@ interface BubbleWidgetProps extends Partial<ChatWidgetConfig> {
 }
 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, customBackend, className, onClose, onReset, onExpand, expanded, embedded, envId, onDebugTrace, widgetLayout, showCommandPanel, showRagTopics, showRagDocuments, showQuickActions, locale, clientActions, ragTopics, ragDocuments, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ agentId, apiUrl, 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, envId, onDebugTrace, widgetLayout, showCommandPanel, showRagTopics, showRagDocuments, showQuickActions, locale, clientActions, ragTopics, ragDocuments, }: ChatWidgetProps): react_jsx_runtime.JSX.Element;
 
 declare function IconTarget({ className }: {
     className?: string;
@@ -318,7 +352,7 @@ interface CommandPanelProps {
     pageParams?: Record<string, string>;
     pageVars?: Record<string, unknown>;
     metadata?: Record<string, unknown>;
-    clientActions?: any[];
+    clientActions?: WidgetClientAction[];
     ragTopics?: RagTopicInfo[];
     ragDocuments?: RagDocumentInfo[];
     onSend: (text: string) => void;
@@ -334,6 +368,8 @@ declare function CommandPanel({ mode, pageUrl, pageTitle, pageParams, pageVars,
 
 interface UseChatOptions {
     agentId: string;
+    /** Overrides NEXT_PUBLIC_API_URL for every chat request. */
+    apiUrl?: string;
     workspaceId?: string;
     envId?: string;
     source?: string;
@@ -346,6 +382,12 @@ interface UseChatOptions {
         actionIds?: string[];
     };
     customBackend?: CustomBackend;
+    copilotColor?: string;
+    /**
+     * Page context for a request when the host passes none in `userContext`.
+     * Called at send time so client-side navigation is reflected.
+     */
+    resolvePageContext?: () => PageContext | undefined;
 }
 interface UseChatReturn {
     messages: Message[];
@@ -412,7 +454,7 @@ interface DebugTrace {
     executionStatus: string;
     flags: string[];
 }
-declare function useChat({ agentId, workspaceId, envId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, }: UseChatOptions): UseChatReturn;
+declare function useChat({ agentId, apiUrl, workspaceId, envId, source, userContext, persist, onNavigate, playgroundOverrides, customBackend, copilotColor, resolvePageContext, }: UseChatOptions): UseChatReturn;
 
 declare function PlanCard({ part, onSend, disabled, locale, }: {
     part: PlanPart;
@@ -491,4 +533,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, CommandPanel, type CustomBackend, type DebugTrace, IconTarget, LiveDot, type Message, type MessagePart, type PageContext, PlanCard, type PlanPart, type RagDocumentInfo, type RagTopicInfo, ReasoningBlock, ToolCallBadge, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseChatOptions, type UseChatReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };
+export { type Attachment, type AttachmentContentType, type AttachmentPayload, type AttachmentStatus, BubbleWidget, type BubbleWidgetProps, ChatWidget, type ChatWidgetConfig, type ChatWidgetProps, CommandPanel, type CustomBackend, type DebugTrace, IconTarget, LiveDot, type Message, type MessagePart, type PageContext, PlanCard, type PlanPart, type RagDocumentInfo, type RagTopicInfo, ReasoningBlock, ToolCallBadge, type ToolPart, type UseAttachmentsOptions, type UseAttachmentsReturn, type UseChatOptions, type UseChatReturn, type UseSupportChatOptions, type UseVoiceOptions, type UseVoiceReturn, type UserContext, type UserHeaders, type VoiceState, formatToolName, getContrastColor, useAttachments, useChat, useSupportChat, useVoice };