@ensembleapp/client-sdk 0.0.46 → 0.0.48

package/dist/index.d.ts

@@ -178,6 +178,7 @@ interface ApiConfig {
 }
 /** Agent version selector: 'latest' (default), 'published', or a specific version number */
 type AgentVersion = 'latest' | 'published' | number;
+type StructuredMessagePayload = Record<string, unknown>;
 type UseChatConfig = DeprecatedChatConfig & {
     /** The server API configuration */
     api: ApiConfig;
@@ -200,6 +201,7 @@ declare function useChat({ api, threadId, agentId, agentVersion, agentExecutionI
     messages: ChatMessage[];
     status: ai.ChatStatus;
     isLoadingInitial: boolean;
+    canSendMessage: boolean;
     sendMessage: (message?: (Omit<UIMessage<unknown, ai.UIDataTypes, ai.UITools>, "id" | "role"> & {
         id?: string | undefined;
         role?: "user" | "assistant" | "system" | undefined;
@@ -219,6 +221,7 @@ declare function useChat({ api, threadId, agentId, agentVersion, agentExecutionI
         parts?: never;
         messageId?: string;
     } | undefined, options?: ai.ChatRequestOptions) => Promise<void>;
+    sendStructuredMessage: (text: string, payload: StructuredMessagePayload) => Promise<void>;
     stop: () => Promise<void>;
     setMessages: (messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[] | ((messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[]) => UIMessage<unknown, ai.UIDataTypes, ai.UITools>[])) => void;
     addToolOutput: <TOOL extends string>({ state, tool, toolCallId, output, errorText, }: {
@@ -310,6 +313,12 @@ interface WidgetRenderOptions {
     messageContext?: MessageContext;
     /** Function to invoke tools from within widgets (client-side enrichment) */
     invokeTool?: InvokeTool;
+    /** Whether the chat is ready for widget-triggered messages */
+    canSendMessage?: boolean;
+    /** Send a visible text message from within widgets */
+    sendMessage?: (text: string) => void | Promise<void>;
+    /** Send visible text plus structured JSON data from within widgets */
+    sendStructuredMessage?: (text: string, payload: Record<string, unknown>) => void | Promise<void>;
 }
 
 /** Enriched results keyed by enrichment name */
@@ -501,6 +510,8 @@ interface ChatWidgetFeedbackOptions {
 interface ChatWidgetHandle {
     /** Send a message programmatically */
     sendMessage: (message: string) => void;
+    /** Send visible text plus structured JSON data for the agent */
+    sendStructuredMessage: (message: string, payload: Record<string, unknown>) => void;
 }
 interface ChatWidgetConfig extends UseChatConfig {
     /** Title for the Chat window */
@@ -658,6 +669,12 @@ interface MessageRendererProps {
     feedback?: FeedbackConfig;
     /** Function to invoke tools from widgets (client-side enrichment) */
     invokeTool?: InvokeTool;
+    /** Whether the chat is ready for widget-triggered messages */
+    canSendMessage?: boolean;
+    /** Function to send a visible text message from widgets */
+    sendMessage?: (text: string) => void | Promise<void>;
+    /** Function to send visible text plus structured JSON data from widgets */
+    sendStructuredMessage?: (text: string, payload: Record<string, unknown>) => void | Promise<void>;
 }
 /**
  * MessageRenderer - renders message content with optional feedback UI.
@@ -665,7 +682,7 @@ interface MessageRendererProps {
  * Renders the content of a ChatMessage (text, tools, widgets, groups) and optionally
  * displays feedback buttons for assistant messages.
  */
-declare function MessageRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, invokeTool, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
+declare function MessageRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, invokeTool, canSendMessage, sendMessage, sendStructuredMessage, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
 
 interface DisplayModeProps {
     /** Message sections to render */
@@ -739,4 +756,4 @@ declare const getVendorCardsWidget: (isProd?: boolean) => SDKUIWidgetDefinition[
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AgentVersion, type AnyUIWidgetDefinition, type ApiConfig, type ApprovalUIConfig, BriefDisplayMode, BriefDisplayMode as BriefRenderer, type ChatMessage, type ChatMessageSection, ChatWidget, type ChatWidgetFeedbackOptions, type ChatWidgetHandle, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type CustomerReactDOM, type DisplayMode, type DisplayModeProps, type EmbeddableChatWidgetConfig, type EnrichedResults, type FeedbackConfig, type FeedbackHandlers, type FeedbackNote, type FeedbackRating, type FetchApprovalConfigOptions, FullDisplayMode, FullDisplayMode as FullRenderer, type InvokeTool, type MessageContext, type MessageFeedback, MessageRenderer, type MessageRendererProps, type PendingToolApproval, type PendingToolOutput, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type DisplayModeProps as RendererProps, type SDKUIWidgetDefinition, SDK_WIDGET_MARKER, type SubmitFeedbackParams, TagGroupDisplay, type TagGroupDisplayProps, ToolCallDisplay, type ToolCallDisplayProps, type ToolInvokeRequest, type ToolInvokeResult, type ToolPart, type UIMessagePart, type UIWidgetDefinition, type UseChatConfig, type UseFeedbackConfig, type WidgetEnrichConfig, type WidgetRenderOptions, cn, createSDKWidget, createWidget, defaultChatWidgets, fetchApprovalConfig, getVendorCardsWidget, isSDKWidget, registerChatWidgets, transformMessage, useChat, useFeedback };
+export { type AgentVersion, type AnyUIWidgetDefinition, type ApiConfig, type ApprovalUIConfig, BriefDisplayMode, BriefDisplayMode as BriefRenderer, type ChatMessage, type ChatMessageSection, ChatWidget, type ChatWidgetFeedbackOptions, type ChatWidgetHandle, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type CustomerReactDOM, type DisplayMode, type DisplayModeProps, type EmbeddableChatWidgetConfig, type EnrichedResults, type FeedbackConfig, type FeedbackHandlers, type FeedbackNote, type FeedbackRating, type FetchApprovalConfigOptions, FullDisplayMode, FullDisplayMode as FullRenderer, type InvokeTool, type MessageContext, type MessageFeedback, MessageRenderer, type MessageRendererProps, type PendingToolApproval, type PendingToolOutput, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type DisplayModeProps as RendererProps, type SDKUIWidgetDefinition, SDK_WIDGET_MARKER, type StructuredMessagePayload, type SubmitFeedbackParams, TagGroupDisplay, type TagGroupDisplayProps, ToolCallDisplay, type ToolCallDisplayProps, type ToolInvokeRequest, type ToolInvokeResult, type ToolPart, type UIMessagePart, type UIWidgetDefinition, type UseChatConfig, type UseFeedbackConfig, type WidgetEnrichConfig, type WidgetRenderOptions, cn, createSDKWidget, createWidget, defaultChatWidgets, fetchApprovalConfig, getVendorCardsWidget, isSDKWidget, registerChatWidgets, transformMessage, useChat, useFeedback };