@tylertech/forge-ai 0.4.1 → 0.6.0

package/dist/ai-chatbot/ai-chatbot.d.ts

@@ -0,0 +1,134 @@
+import { LitElement, PropertyValues, TemplateResult } from 'lit';
+import { AgentInfo } from '../ai-agent-info';
+import { Suggestion } from '../ai-suggestions';
+import { ForgeAiVoiceInputResultEvent } from '../ai-voice-input';
+import { AgentAdapter } from './agent-adapter.js';
+import { ChatMessage, ForgeAiChatbotFileSelectEventData, HeadingLevel, ThreadState } from './types.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'forge-ai-chatbot': AiChatbotComponent;
+    }
+    interface HTMLElementEventMap {
+        'forge-ai-chatbot-connected': CustomEvent<void>;
+        'forge-ai-chatbot-disconnected': CustomEvent<void>;
+        'forge-ai-chatbot-message-sent': CustomEvent<ForgeAiChatbotMessageEventData>;
+        'forge-ai-chatbot-message-received': CustomEvent<ForgeAiChatbotMessageEventData>;
+        'forge-ai-chatbot-tool-call': CustomEvent<ForgeAiChatbotToolCallEventData>;
+        'forge-ai-chatbot-error': CustomEvent<ForgeAiChatbotErrorEventData>;
+        'forge-ai-chatbot-expand': CustomEvent<void>;
+        'forge-ai-chatbot-minimize': CustomEvent<void>;
+        'forge-ai-chatbot-clear': CustomEvent<void>;
+        'forge-ai-chatbot-info': CustomEvent<void>;
+        'forge-ai-chatbot-file-select': CustomEvent<ForgeAiChatbotFileSelectEventData>;
+        'forge-ai-voice-input-result': CustomEvent<ForgeAiVoiceInputResultEvent>;
+        'forge-ai-chatbot-file-remove': CustomEvent<ForgeAiChatbotFileRemoveEventData>;
+    }
+}
+export interface ForgeAiChatbotMessageEventData {
+    message: ChatMessage;
+}
+export interface ForgeAiChatbotToolCallEventData {
+    toolCallId: string;
+    toolName: string;
+    arguments: Record<string, unknown>;
+}
+export interface ForgeAiChatbotErrorEventData {
+    error: string;
+}
+export interface ForgeAiChatbotFileRemoveEventData {
+    fileId: string;
+}
+export declare const AiChatbotComponentTagName: keyof HTMLElementTagNameMap;
+/**
+ * Type for feature toggle values
+ */
+export type FeatureToggle = 'on' | 'off';
+/**
+ * @tag forge-ai-chatbot
+ *
+ * @summary A complete, self-contained AI chatbot component that implements the AG-UI protocol using an adapter pattern.
+ *
+ * @description
+ * The AI Chatbot component provides a full-featured chat interface with support for streaming responses,
+ * client-side tool execution, file attachments, markdown rendering, and programmatic control.
+ * It uses an adapter pattern to abstract communication, allowing for AG-UI or custom protocol implementations.
+ *
+ * @slot header - Slot for custom header content
+ * @slot empty-state - Slot for custom empty state content (overrides default suggestions)
+ *
+ * @property {string} titleText - The title text to display in the header (default: 'AI Assistant')
+ * @property {HeadingLevel} headingLevel - Controls the heading level for the title content (default: 2)
+ *
+ * @event {CustomEvent<void>} forge-ai-chatbot-connected - Fired when adapter connects
+ * @event {CustomEvent<void>} forge-ai-chatbot-disconnected - Fired when adapter disconnects
+ * @event {CustomEvent<ForgeAiChatbotMessageEventData>} forge-ai-chatbot-message-sent - Fired when user sends a message
+ * @event {CustomEvent<ForgeAiChatbotMessageEventData>} forge-ai-chatbot-message-received - Fired when assistant message is complete
+ * @event {CustomEvent<ForgeAiChatbotToolCallEventData>} forge-ai-chatbot-tool-call - Fired when a tool needs to be executed
+ * @event {CustomEvent<ForgeAiChatbotErrorEventData>} forge-ai-chatbot-error - Fired when an error occurs
+ * @event {CustomEvent<void>} forge-ai-chatbot-expand - Fired when header expand button is clicked
+ * @event {CustomEvent<void>} forge-ai-chatbot-minimize - Fired when header minimize button is clicked
+ * @event {CustomEvent<void>} forge-ai-chatbot-clear - Fired when header clear option is selected (cancelable, prevents clearMessages() if default prevented)
+ * @event {CustomEvent<void>} forge-ai-chatbot-info - Fired when header info option is selected
+ */
+export declare class AiChatbotComponent extends LitElement {
+    #private;
+    static styles: import('lit').CSSResult;
+    adapter?: AgentAdapter;
+    fileUpload: FeatureToggle;
+    voiceInput: FeatureToggle;
+    placeholder: string;
+    suggestions?: Suggestion[];
+    showExpandButton: boolean;
+    showMinimizeButton: boolean;
+    expanded: boolean;
+    minimizeIcon: 'default' | 'panel';
+    enableReactions: boolean;
+    agentInfo?: AgentInfo;
+    titleText: string;
+    headingLevel: HeadingLevel;
+    debugMode: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    willUpdate(changedProperties: PropertyValues<this>): void;
+    /**
+     * Clears all messages from the chat history.
+     */
+    clearMessages(): void;
+    /**
+     * Gets the current message history.
+     * @returns Array of chat messages
+     */
+    getMessages(): ChatMessage[];
+    /**
+     * Sets the message history. Useful for restoring conversation state.
+     * @param messages - Array of chat messages to set
+     */
+    setMessages(messages: ChatMessage[]): void;
+    /**
+     * Programmatically sends a message as the user.
+     * @param content - The message content to send
+     * @param files - Optional file objects to attach
+     */
+    sendMessage(content: string, files?: File[]): Promise<void>;
+    /**
+     * Aborts the current streaming response.
+     */
+    abort(): void;
+    /**
+     * Scrolls the chat interface to the bottom.
+     */
+    scrollToBottom({ behavior }?: {
+        behavior?: ScrollBehavior;
+    }): Promise<void>;
+    /**
+     * Gets the complete serializable thread state including threadId and messages.
+     * @returns ThreadState object containing threadId, messages, and timestamp
+     */
+    getThreadState(): ThreadState;
+    /**
+     * Restores thread state from a serialized ThreadState object.
+     * @param state - ThreadState object to restore
+     */
+    setThreadState(state: ThreadState): void;
+    render(): TemplateResult;
+}