@ensembleapp/client-sdk 0.0.5 → 0.0.6

package/dist/index.d.ts

@@ -1,13 +1,15 @@
 import * as ai from 'ai';
 import { UIMessage } from 'ai';
-import { U as UIWidget, a as UIWidgetDefinition } from './schemas-n2u83F_H.js';
-export { W as WidgetDefinition, c as createWidget } from './schemas-n2u83F_H.js';
+import { UIWidget } from '@repo/agent-sdk/schemas';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React from 'react';
+import React$1, { ReactNode } from 'react';
+import z, { AnyZodObject } from 'zod';
 import { ClassValue } from 'clsx';
-import 'json-schema';
-import 'zod';
 
+type DeprecatedChatConfig = {
+    /** @deprecated use agentId instead */
+    agentExecutionId?: string;
+};
 interface ApiConfig {
     /** The base URL where /chat and /chat/messages are hosted */
     baseUrl: string;
@@ -15,15 +17,13 @@ interface ApiConfig {
     token: string;
     headers?: Record<string, string>;
 }
-interface UseChatConfig {
+type UseChatConfig = DeprecatedChatConfig & {
     /** The server API configuration */
     api: ApiConfig;
     /** Thread ID for keeping conversation history */
     threadId: string;
-    /** The Agent ID that this chat connects to. Either agentId or agentExecutionId must be provided */
+    /** Ensemble agent ID to connect to */
     agentId?: string;
-    /** The Agent Orchestration ID that this chat connects to. Either agentId or agentExecutionId must be provided */
-    agentExecutionId?: string;
     /** additional context (anything) that needs to be passed to the LLM */
     dataContext?: unknown;
     onError?: (error: Error) => void;
@@ -32,11 +32,35 @@ interface UseChatConfig {
     onFinish?: (message: any) => void;
     onData?: (data: any) => void;
     onMessage?: (message: UIMessage) => void;
+};
+interface ToolCallContent {
+    type: 'tool-call';
+    toolName: string;
+    input?: Record<string, unknown>;
+    state: 'pending' | 'output-available' | 'error';
+    output?: unknown;
+}
+type ChatContentItem = string | UIWidget | ToolCallContent;
+/** A grouped section of sub-agent output, wrapped by data-tag-start/end markers */
+interface TagGroup {
+    tagId: string;
+    content: ChatContentItem[];
+    /** Index into content[] where the last step begins (for promoting only final output) */
+    lastStepStartIndex?: number;
 }
+/** A single section in the message, rendered in chronological order */
+type MessageSection = {
+    type: 'content';
+    item: ChatContentItem;
+} | {
+    type: 'tag-group';
+    group: TagGroup;
+};
 interface ChatMessage {
     id: string;
     role: 'user' | 'assistant';
-    content: (string | UIWidget)[];
+    /** Ordered sections: content items and tag groups interleaved chronologically */
+    sections: MessageSection[];
     thoughts?: (string | UIWidget)[];
     createdAt?: Date;
 }
@@ -67,6 +91,44 @@ declare function useChat({ api, threadId, agentId, agentExecutionId, dataContext
     setMessages: (messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[] | ((messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[]) => UIMessage<unknown, ai.UIDataTypes, ai.UITools>[])) => void;
 };
 
+type FeedbackRating = 'positive' | 'negative';
+interface MessageFeedback {
+    id: string;
+    messageId: string;
+    rating: FeedbackRating;
+    improvementText?: string;
+    createdAt: Date;
+}
+interface FeedbackState {
+    rating: FeedbackRating;
+    comment?: string;
+}
+interface UseFeedbackConfig {
+    api: ApiConfig;
+    threadId: string;
+    agentId?: string;
+    agentExecutionId?: string;
+}
+interface SubmitFeedbackParams {
+    messageId: string;
+    rating: FeedbackRating;
+    improvementText?: string;
+}
+declare function useFeedback({ api, threadId, agentId, agentExecutionId, }: UseFeedbackConfig): {
+    submitFeedback: ({ messageId, rating, improvementText }: SubmitFeedbackParams) => Promise<MessageFeedback | null>;
+    getFeedbackForMessage: (messageId: string) => FeedbackState | undefined;
+    hasFeedback: (messageId: string) => boolean;
+    isSubmitting: string | null;
+    error: Error | null;
+};
+
+interface UIWidgetDefinition<TSchema extends AnyZodObject = AnyZodObject> {
+    widgetType: string;
+    schema: TSchema;
+    render(widget: z.infer<TSchema>): ReactNode;
+}
+declare const createWidget: <TSchema extends AnyZodObject>({ widgetType, schema, render, }: UIWidgetDefinition<TSchema>) => UIWidgetDefinition<TSchema>;
+
 interface ChatWidgetStyles {
     primaryColor?: string;
     primaryTextColor?: string;
@@ -98,6 +160,12 @@ interface ChatWidgetSpeechToTextOptions {
     onError?: (message: string) => void;
     finalDelay?: number;
 }
+interface ChatWidgetFeedbackOptions {
+    /** Enable feedback buttons on assistant messages. Default: true */
+    enabled?: boolean;
+    /** Require comment when giving negative feedback. Default: false */
+    requireCommentForNegative?: boolean;
+}
 interface ChatWidgetConfig extends UseChatConfig {
     /** Title for the Chat window */
     title?: string;
@@ -110,8 +178,10 @@ interface ChatWidgetConfig extends UseChatConfig {
     voice?: ChatWidgetVoiceOptions;
     speechToText?: ChatWidgetSpeechToTextOptions;
     widgets?: UIWidgetDefinition[];
+    /** Feedback options for assistant messages. Enabled by default. */
+    feedback?: ChatWidgetFeedbackOptions;
 }
-declare function ChatWidget({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onMessage, title, introMessage, inputPlaceholder, className, styles: styleProps, voice, speechToText, widgets, }: ChatWidgetConfig): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onMessage, title, introMessage, inputPlaceholder, className, styles: styleProps, voice, speechToText, widgets, feedback, }: ChatWidgetConfig): react_jsx_runtime.JSX.Element;
 
 interface PopupAnchorConfig {
     enabled?: boolean;
@@ -121,13 +191,13 @@ interface PopupAnchorConfig {
     render?: (options: {
         isOpen: boolean;
         toggle: () => void;
-    }) => React.ReactNode;
+    }) => React$1.ReactNode;
     closeButton?: PopupCloseConfig;
 }
 interface PopupCloseConfig {
     render?: (options: {
         toggle: () => void;
-    }) => React.ReactNode;
+    }) => React$1.ReactNode;
     position?: 'top-end' | 'top-start';
     show?: boolean;
 }
@@ -147,12 +217,19 @@ interface PopupChatWidgetProps extends ChatWidgetConfig {
 }
 declare function PopupChatWidget({ anchor, ...props }: PopupChatWidgetProps): react_jsx_runtime.JSX.Element;
 
-interface ChatWidgetInstance {
-    updateProps: (props: Partial<ChatWidgetConfig>) => void;
-    updateTheme: (styles: ChatWidgetStyles) => void;
-    unmount: () => void;
+interface ToolCallDisplayProps {
+    toolCall: ToolCallContent;
+    className?: string;
 }
-declare const createChatWidget: (target: HTMLElement, props: ChatWidgetConfig) => ChatWidgetInstance;
+declare function ToolCallDisplay({ toolCall, className }: ToolCallDisplayProps): react_jsx_runtime.JSX.Element;
+
+interface TagGroupDisplayProps {
+    tagId: string;
+    isExpanded: boolean;
+    onToggle: () => void;
+    children: React.ReactNode;
+}
+declare function TagGroupDisplay({ tagId, isExpanded, onToggle, children, }: TagGroupDisplayProps): react_jsx_runtime.JSX.Element;
 
 type RegisterChatWidgetsParams = {
     api: ApiConfig;
@@ -164,6 +241,13 @@ type RegisterChatWidgetsParams = {
  */
 declare function registerChatWidgets({ api, threadId, widgets, }: RegisterChatWidgetsParams): Promise<void>;
 
+interface ChatWidgetInstance {
+    updateProps: (props: Partial<ChatWidgetConfig>) => void;
+    updateTheme: (styles: ChatWidgetStyles) => void;
+    unmount: () => void;
+}
+declare const createChatWidget: (target: HTMLElement, props: ChatWidgetConfig) => ChatWidgetInstance;
+
 /**
  * Embeddable Chat Widget
  *
@@ -190,4 +274,4 @@ declare const defaultChatWidgets: UIWidgetDefinition[];
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type ApiConfig, type ChatMessage, ChatWidget, type ChatWidgetInstance, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type EmbeddableChatWidgetConfig, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, UIWidget, UIWidgetDefinition, type UseChatConfig, cn, createChatWidget, defaultChatWidgets, registerChatWidgets, useChat };
+export { type ApiConfig, type ChatContentItem, type ChatMessage, ChatWidget, type ChatWidgetFeedbackOptions, type ChatWidgetInstance, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type EmbeddableChatWidgetConfig, type FeedbackRating, type FeedbackState, type MessageFeedback, type MessageSection, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type SubmitFeedbackParams, type TagGroup, TagGroupDisplay, type TagGroupDisplayProps, type ToolCallContent, ToolCallDisplay, type ToolCallDisplayProps, type UIWidgetDefinition, type UseChatConfig, type UseFeedbackConfig, cn, createChatWidget, createWidget, defaultChatWidgets, registerChatWidgets, useChat, useFeedback };