vanilla-agent 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,370 @@
+/**
+ * Plugin interface for customizing widget components
+ */
+interface ChatWidgetPlugin {
+    /**
+     * Unique identifier for the plugin
+     */
+    id: string;
+    /**
+     * Optional priority (higher = runs first). Default: 0
+     */
+    priority?: number;
+    /**
+     * Custom renderer for message bubbles
+     * Return null to use default renderer
+     */
+    renderMessage?: (context: {
+        message: ChatWidgetMessage;
+        defaultRenderer: () => HTMLElement;
+        config: ChatWidgetConfig;
+    }) => HTMLElement | null;
+    /**
+     * Custom renderer for launcher button
+     * Return null to use default renderer
+     */
+    renderLauncher?: (context: {
+        config: ChatWidgetConfig;
+        defaultRenderer: () => HTMLElement;
+        onToggle: () => void;
+    }) => HTMLElement | null;
+    /**
+     * Custom renderer for panel header
+     * Return null to use default renderer
+     */
+    renderHeader?: (context: {
+        config: ChatWidgetConfig;
+        defaultRenderer: () => HTMLElement;
+        onClose?: () => void;
+    }) => HTMLElement | null;
+    /**
+     * Custom renderer for composer/input area
+     * Return null to use default renderer
+     */
+    renderComposer?: (context: {
+        config: ChatWidgetConfig;
+        defaultRenderer: () => HTMLElement;
+        onSubmit: (text: string) => void;
+        disabled: boolean;
+    }) => HTMLElement | null;
+    /**
+     * Custom renderer for reasoning bubbles
+     * Return null to use default renderer
+     */
+    renderReasoning?: (context: {
+        message: ChatWidgetMessage;
+        defaultRenderer: () => HTMLElement;
+        config: ChatWidgetConfig;
+    }) => HTMLElement | null;
+    /**
+     * Custom renderer for tool call bubbles
+     * Return null to use default renderer
+     */
+    renderToolCall?: (context: {
+        message: ChatWidgetMessage;
+        defaultRenderer: () => HTMLElement;
+        config: ChatWidgetConfig;
+    }) => HTMLElement | null;
+    /**
+     * Called when plugin is registered
+     */
+    onRegister?: () => void;
+    /**
+     * Called when plugin is unregistered
+     */
+    onUnregister?: () => void;
+}
+
+type ChatWidgetFeatureFlags = {
+    showReasoning?: boolean;
+    showToolCalls?: boolean;
+};
+type ChatWidgetTheme = {
+    primary?: string;
+    secondary?: string;
+    surface?: string;
+    muted?: string;
+    accent?: string;
+    container?: string;
+    border?: string;
+    divider?: string;
+    messageBorder?: string;
+    inputBackground?: string;
+    callToAction?: string;
+    callToActionBackground?: string;
+    sendButtonBackgroundColor?: string;
+    sendButtonTextColor?: string;
+    sendButtonBorderColor?: string;
+    closeButtonColor?: string;
+    closeButtonBackgroundColor?: string;
+    closeButtonBorderColor?: string;
+    micIconColor?: string;
+    micBackgroundColor?: string;
+    micBorderColor?: string;
+    recordingIconColor?: string;
+    recordingBackgroundColor?: string;
+    recordingBorderColor?: string;
+    inputFontFamily?: "sans-serif" | "serif" | "mono";
+    inputFontWeight?: string;
+    radiusSm?: string;
+    radiusMd?: string;
+    radiusLg?: string;
+    launcherRadius?: string;
+    buttonRadius?: string;
+};
+type ChatWidgetLauncherConfig = {
+    enabled?: boolean;
+    title?: string;
+    subtitle?: string;
+    textHidden?: boolean;
+    iconUrl?: string;
+    agentIconText?: string;
+    agentIconName?: string;
+    agentIconHidden?: boolean;
+    position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
+    autoExpand?: boolean;
+    width?: string;
+    callToActionIconText?: string;
+    callToActionIconName?: string;
+    callToActionIconColor?: string;
+    callToActionIconBackgroundColor?: string;
+    callToActionIconHidden?: boolean;
+    callToActionIconPadding?: string;
+    agentIconSize?: string;
+    callToActionIconSize?: string;
+    headerIconSize?: string;
+    headerIconName?: string;
+    headerIconHidden?: boolean;
+    closeButtonSize?: string;
+    closeButtonColor?: string;
+    closeButtonBackgroundColor?: string;
+    closeButtonBorderWidth?: string;
+    closeButtonBorderColor?: string;
+    closeButtonBorderRadius?: string;
+    closeButtonPlacement?: "inline" | "top-right";
+};
+type ChatWidgetSendButtonConfig = {
+    borderWidth?: string;
+    borderColor?: string;
+    paddingX?: string;
+    paddingY?: string;
+    iconText?: string;
+    iconName?: string;
+    useIcon?: boolean;
+    tooltipText?: string;
+    showTooltip?: boolean;
+    backgroundColor?: string;
+    textColor?: string;
+    size?: string;
+};
+type ChatWidgetStatusIndicatorConfig = {
+    visible?: boolean;
+    idleText?: string;
+    connectingText?: string;
+    connectedText?: string;
+    errorText?: string;
+};
+type ChatWidgetVoiceRecognitionConfig = {
+    enabled?: boolean;
+    pauseDuration?: number;
+    iconName?: string;
+    iconSize?: string;
+    iconColor?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    borderWidth?: string;
+    paddingX?: string;
+    paddingY?: string;
+    tooltipText?: string;
+    showTooltip?: boolean;
+    recordingIconColor?: string;
+    recordingBackgroundColor?: string;
+    recordingBorderColor?: string;
+    showRecordingIndicator?: boolean;
+};
+type ChatWidgetConfig = {
+    apiUrl?: string;
+    flowId?: string;
+    headers?: Record<string, string>;
+    copy?: {
+        welcomeTitle?: string;
+        welcomeSubtitle?: string;
+        inputPlaceholder?: string;
+        sendButtonLabel?: string;
+    };
+    theme?: ChatWidgetTheme;
+    features?: ChatWidgetFeatureFlags;
+    launcher?: ChatWidgetLauncherConfig;
+    initialMessages?: ChatWidgetMessage[];
+    suggestionChips?: string[];
+    debug?: boolean;
+    formEndpoint?: string;
+    launcherWidth?: string;
+    sendButton?: ChatWidgetSendButtonConfig;
+    statusIndicator?: ChatWidgetStatusIndicatorConfig;
+    voiceRecognition?: ChatWidgetVoiceRecognitionConfig;
+    postprocessMessage?: (context: {
+        text: string;
+        message: ChatWidgetMessage;
+        streaming: boolean;
+    }) => string;
+    plugins?: ChatWidgetPlugin[];
+};
+type ChatWidgetMessageRole = "user" | "assistant" | "system";
+type ChatWidgetReasoning = {
+    id: string;
+    status: "pending" | "streaming" | "complete";
+    chunks: string[];
+    startedAt?: number;
+    completedAt?: number;
+    durationMs?: number;
+};
+type ChatWidgetToolCall = {
+    id: string;
+    name?: string;
+    status: "pending" | "running" | "complete";
+    args?: unknown;
+    chunks?: string[];
+    result?: unknown;
+    duration?: number;
+    startedAt?: number;
+    completedAt?: number;
+    durationMs?: number;
+};
+type ChatWidgetMessageVariant = "assistant" | "reasoning" | "tool";
+type ChatWidgetMessage = {
+    id: string;
+    role: ChatWidgetMessageRole;
+    content: string;
+    createdAt: string;
+    streaming?: boolean;
+    variant?: ChatWidgetMessageVariant;
+    sequence?: number;
+    reasoning?: ChatWidgetReasoning;
+    toolCall?: ChatWidgetToolCall;
+    tools?: ChatWidgetToolCall[];
+};
+type ChatWidgetEvent = {
+    type: "message";
+    message: ChatWidgetMessage;
+} | {
+    type: "status";
+    status: "connecting" | "connected" | "error" | "idle";
+} | {
+    type: "error";
+    error: Error;
+};
+type ChatWidgetInitOptions = {
+    target: string | HTMLElement;
+    config?: ChatWidgetConfig;
+    useShadowDom?: boolean;
+    onReady?: () => void;
+};
+
+type Controller = {
+    update: (config: ChatWidgetConfig) => void;
+    destroy: () => void;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+};
+declare const createChatExperience: (mount: HTMLElement, initialConfig?: ChatWidgetConfig) => Controller;
+type ChatWidgetController = Controller;
+
+type ChatWidgetInitHandle = ChatWidgetController & {
+    host: HTMLElement;
+};
+declare const initChatWidget: (options: ChatWidgetInitOptions) => ChatWidgetInitHandle;
+
+type ChatWidgetSessionStatus = "idle" | "connecting" | "connected" | "error";
+type SessionCallbacks = {
+    onMessagesChanged: (messages: ChatWidgetMessage[]) => void;
+    onStatusChanged: (status: ChatWidgetSessionStatus) => void;
+    onStreamingChanged: (streaming: boolean) => void;
+    onError?: (error: Error) => void;
+};
+declare class ChatWidgetSession {
+    private config;
+    private callbacks;
+    private client;
+    private messages;
+    private status;
+    private streaming;
+    private abortController;
+    private sequenceCounter;
+    constructor(config: ChatWidgetConfig | undefined, callbacks: SessionCallbacks);
+    updateConfig(next: ChatWidgetConfig): void;
+    getMessages(): ChatWidgetMessage[];
+    getStatus(): ChatWidgetSessionStatus;
+    isStreaming(): boolean;
+    sendMessage(rawInput: string): Promise<void>;
+    cancel(): void;
+    private handleEvent;
+    private setStatus;
+    private setStreaming;
+    private appendMessage;
+    private upsertMessage;
+    private ensureSequence;
+    private nextSequence;
+    private sortMessages;
+}
+
+type DispatchOptions = {
+    messages: ChatWidgetMessage[];
+    signal?: AbortSignal;
+};
+type SSEHandler = (event: ChatWidgetEvent) => void;
+declare class ChatWidgetClient {
+    private config;
+    private readonly apiUrl;
+    private readonly headers;
+    private readonly debug;
+    constructor(config?: ChatWidgetConfig);
+    dispatch(options: DispatchOptions, onEvent: SSEHandler): Promise<void>;
+    private streamResponse;
+}
+
+/**
+ * Basic markdown renderer. Remember to sanitize the returned HTML if you render
+ * untrusted content in your host page.
+ */
+declare const markdownPostprocessor: (text: string) => string;
+/**
+ * Escapes HTML entities. Used as the default safe renderer.
+ */
+declare const escapeHtml: (text: string) => string;
+/**
+ * Converts special directives (either `<Form type="init" />` or
+ * `<Directive>{"component":"form","type":"init"}</Directive>`) into placeholder
+ * elements that the widget upgrades after render. Remaining text is rendered as
+ * Markdown.
+ */
+declare const directivePostprocessor: (text: string) => string;
+
+declare class PluginRegistry {
+    private plugins;
+    /**
+     * Register a plugin
+     */
+    register(plugin: ChatWidgetPlugin): void;
+    /**
+     * Unregister a plugin
+     */
+    unregister(pluginId: string): void;
+    /**
+     * Get all plugins sorted by priority
+     */
+    getAll(): ChatWidgetPlugin[];
+    /**
+     * Get plugins for a specific instance (from config)
+     * Merges instance plugins with globally registered plugins
+     */
+    getForInstance(instancePlugins?: ChatWidgetPlugin[]): ChatWidgetPlugin[];
+    /**
+     * Clear all plugins
+     */
+    clear(): void;
+}
+declare const pluginRegistry: PluginRegistry;
+
+export { ChatWidgetClient, type ChatWidgetConfig, type ChatWidgetController, type ChatWidgetEvent, type ChatWidgetFeatureFlags, type ChatWidgetInitHandle, type ChatWidgetInitOptions, type ChatWidgetLauncherConfig, type ChatWidgetMessage, type ChatWidgetPlugin, ChatWidgetSession, type ChatWidgetSessionStatus, type ChatWidgetTheme, createChatExperience, initChatWidget as default, directivePostprocessor, escapeHtml, initChatWidget, markdownPostprocessor, pluginRegistry };