@meetsmore-oss/use-ai-client 1.13.1 → 1.14.0

package/dist/index.d.ts

@@ -359,6 +359,7 @@ declare class UseAIClient {
     private _tools;
     private _messages;
     private _state;
+    private _currentRunId;
     private _availableAgents;
     private _defaultAgent;
     private _selectedAgent;
@@ -419,6 +420,53 @@ declare class UseAIClient {
      * @param state - Optional updated state to send back to the AI
      */
     sendToolResponse(toolCallId: string, result: unknown, state?: unknown): void;
+    /**
+     * Aborts the in-flight run, if any.
+     * Sends an `abort_run` message to the server which cancels the AI stream
+     * and rejects any pending tool/approval waits. The server then emits
+     * `RUN_ERROR` with `ErrorCode.ABORTED`, which the client handles by
+     * persisting the partial response.
+     *
+     * No-op when no run is in flight.
+     */
+    abortRun(): void;
+    /**
+     * Flushes the final in-progress step into `_messages` when a run terminates.
+     *
+     * Only two terminations reach here. Truncation (maxOutputTokens / finish
+     * reason 'length') and tool-execution errors never do — the server absorbs
+     * them: truncation continues via a fallback step and ends as a normal
+     * RUN_FINISHED, and tool errors come back as tool_results that keep the run
+     * going. So the dispatch is binary:
+     *  - `aborted: false` (RUN_FINISHED): every tool-call step was already flushed
+     *    at STEP_FINISHED, so the in-progress step is always text-only.
+     *  - `aborted: true` (RUN_ERROR / ABORTED): the run may have been cut
+     *    mid-tool-call or mid-reasoning, so extra repair is needed.
+     *
+     * After this returns, `currentMessageContent` and `currentReasoningBlocks`
+     * remain readable for the persistence helper. The next RUN_STARTED clears them.
+     */
+    finalizeRun(opts: {
+        aborted: boolean;
+    }): void;
+    /**
+     * Normal completion (RUN_FINISHED). The in-progress step is text-only —
+     * tool-call steps were already flushed at STEP_FINISHED — so just push the
+     * trailing assistant text with its reasoning.
+     */
+    private finalizeCompletedRun;
+    /**
+     * User-initiated abort (RUN_ERROR / ABORTED).
+     *
+     * Drops the in-progress step's reasoning blocks. A block gets its encrypted
+     * signature on REASONING_ENCRYPTED_VALUE, which arrives after
+     * REASONING_MESSAGE_END — so a mid-stream abort can leave signature-less
+     * blocks. Persisting those would corrupt the next turn. Reasoning from
+     * already-completed prior steps lives on STEP_FINISHED-flushed assistant
+     * messages and is untouched. Aborted-step messages therefore never carry
+     * reasoningParts.
+     */
+    private finalizeAbortedRun;
     /**
      * Sends a tool approval response back to the server.
      *
@@ -467,6 +515,10 @@ declare class UseAIClient {
      * Gets the current accumulated message content (useful during streaming).
      */
     get currentMessageContent(): string;
+    /**
+     * Gets the runId of the in-flight run, or null when no run is active.
+     */
+    get currentRunId(): string | null;
     /**
      * Gets the current reasoning blocks collected during the current run.
      */
@@ -720,7 +772,7 @@ type ChatMetadata = Record<string, unknown>;
  * Display mode for chat messages.
  * Determines the visual styling of the message bubble.
  */
-type MessageDisplayMode = 'default' | 'error';
+type MessageDisplayMode = 'default' | 'error' | 'info';
 /**
  * Text content part for persisted messages.
  */
@@ -1175,6 +1227,10 @@ declare const defaultStrings: {
         /** Error for unknown/unexpected errors */
         UNKNOWN_ERROR: string;
     };
+    notices: {
+        /** Shown as a separate bubble after the user aborts generation */
+        aborted: string;
+    };
     thinking: {
         /** Label shown while thinking is in progress */
         inProgress: string;
@@ -1243,6 +1299,8 @@ declare const defaultTheme: {
     activeBackground: string;
     /** Disabled button background */
     buttonDisabledBackground: string;
+    /** Stop (abort) button background — neutral so it doesn't read as a primary action */
+    stopButtonBackground: string;
     /** Primary text color */
     textColor: string;
     /** Secondary/muted text color */
@@ -1397,6 +1455,11 @@ interface UseAIContextValue {
     agents: AgentContextValue;
     /** Command management */
     commands: CommandContextValue;
+    /**
+     * Aborts the in-flight run, if any. Persists the partial response and
+     * leaves the conversation in a state where the user can send a follow-up.
+     */
+    abortRun: () => void;
 }
 /**
  * Props for custom floating button component.
@@ -1421,6 +1484,11 @@ interface ChatPanelProps {
     onClose: () => void;
     /** Callback when a message is sent */
     onSendMessage: (message: string) => void;
+    /**
+     * Aborts the in-flight run. No-op when no run is active.
+     * Use this to wire a "stop" button while `loading` is true.
+     */
+    onAbort: () => void;
     /** Array of messages in the conversation */
     messages: PersistedMessage[];
     /** Whether the AI is currently processing */
@@ -1645,6 +1713,13 @@ type Message = PersistedMessage;
  */
 interface UseAIChatPanelProps {
     onSendMessage: (message: string, attachments?: FileAttachment[]) => void;
+    /**
+     * Aborts the in-flight run. When provided and `loading` is true (and no
+     * tool is currently executing), the send button switches to a "stop"
+     * button that calls this. Without `onAbort` the button stays disabled
+     * during loading.
+     */
+    onAbort?: () => void;
     messages: Message[];
     loading: boolean;
     connected: boolean;
@@ -1711,7 +1786,7 @@ interface UseAIChatPanelProps {
  * Chat panel content - fills its container.
  * Use directly for embedded mode, or wrap with UseAIFloatingChatWrapper for floating mode.
  */
-declare function UseAIChatPanel({ onSendMessage, messages, loading, connected, streamingText, streamingReasoning, currentChatId, onNewChat, onLoadChat, onDeleteChat, onListChats, onGetChat, suggestions, availableAgents, defaultAgent, selectedAgent, onAgentChange, fileUploadConfig, fileProcessing, commands, onSaveCommand, onRenameCommand, onDeleteCommand, closeButton, executingTool, feedbackEnabled, onFeedback, pendingApprovals, onApproveToolCall, onRejectToolCall, submitMode, }: UseAIChatPanelProps): react_jsx_runtime.JSX.Element;
+declare function UseAIChatPanel({ onSendMessage, onAbort, messages, loading, connected, streamingText, streamingReasoning, currentChatId, onNewChat, onLoadChat, onDeleteChat, onListChats, onGetChat, suggestions, availableAgents, defaultAgent, selectedAgent, onAgentChange, fileUploadConfig, fileProcessing, commands, onSaveCommand, onRenameCommand, onDeleteCommand, closeButton, executingTool, feedbackEnabled, onFeedback, pendingApprovals, onApproveToolCall, onRejectToolCall, submitMode, }: UseAIChatPanelProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Props for the floating chat wrapper.
@@ -2206,7 +2281,7 @@ interface UseChatManagementReturn {
      * the turn are persisted before the final assistant message, preserving the
      * complete tool call context for conversation history.
      */
-    saveAIResponse: (content: string, displayMode?: 'default' | 'error', traceId?: string, turnMessages?: PersistedMessage[], reasoningParts?: ReasoningPart[]) => Promise<void>;
+    saveAIResponse: (content: string, displayMode?: MessageDisplayMode, traceId?: string, turnMessages?: PersistedMessage[], reasoningParts?: ReasoningPart[]) => Promise<void>;
     /** Reloads messages from storage for the given chat ID */
     reloadMessages: (chatId: string) => Promise<void>;
     /** Get the current chat object. Metadata is frozen to prevent accidental mutation. */
@@ -2368,7 +2443,7 @@ interface UseServerEventsOptions {
     /** Tool system for executing tools and looking up tool metadata */
     toolSystem: UseToolSystemReturn;
     /** Saves an AI response to chat storage */
-    saveAIResponse: (content: string, displayMode?: 'default' | 'error', traceId?: string, turnMessages?: PersistedMessage[], reasoningParts?: ReasoningPart[]) => Promise<void>;
+    saveAIResponse: (content: string, displayMode?: MessageDisplayMode, traceId?: string, turnMessages?: PersistedMessage[], reasoningParts?: ReasoningPart[]) => Promise<void>;
     /** UI strings for error messages and tool execution fallbacks */
     strings: UseAIStrings;
 }