@ensembleapp/client-sdk 0.0.37 → 0.0.39

package/dist/index.d.ts

@@ -158,6 +158,32 @@ type EnrichmentResult<TData = unknown> = {
     data?: TData;
 };
 
+/** Matches POST /api/tools/:toolId/invoke request body */
+interface ToolInvokeRequest {
+    /** Tool arguments (defaults to empty object) */
+    args?: Record<string, unknown>;
+    /** Key/value context data passed to the tool */
+    dataContext?: Record<string, unknown>;
+    /** Tool version: 'latest' (default), 'published', or specific version number */
+    version?: 'latest' | 'published' | number;
+}
+/** Matches POST /api/tools/:toolId/invoke response body */
+interface ToolInvokeResult {
+    success: boolean;
+    /** Tool execution result (when success: true) */
+    data?: unknown;
+    /** Error details (when success: false) */
+    error?: {
+        message: string;
+        details?: string[];
+        code?: string;
+    };
+    debug?: {
+        executionTime: number;
+    };
+}
+type InvokeTool = (toolId: string, request?: ToolInvokeRequest) => Promise<ToolInvokeResult>;
+
 /**
  * Client-specific types for the SDK.
  * Core feedback types (FeedbackRating, FeedbackNote, MessageFeedback, CreateFeedbackRequest)
@@ -194,6 +220,16 @@ interface FeedbackConfig extends FeedbackHandlers {
 interface MessageContext extends FeedbackHandlers {
     messageId: string;
 }
+/**
+ * Options passed to widget render functions.
+ * Provides utilities for message context and tool invocation.
+ */
+interface WidgetRenderOptions {
+    /** Message-level context with feedback handlers */
+    messageContext?: MessageContext;
+    /** Function to invoke tools from within widgets (client-side enrichment) */
+    invokeTool?: InvokeTool;
+}
 
 /** Enriched results keyed by enrichment name */
 type EnrichedResults<T = unknown> = Record<string, EnrichmentResult<T>>;
@@ -210,9 +246,7 @@ interface SDKUIWidgetDefinition<TSchema extends FlexibleSchema = FlexibleSchema,
     widgetType: string;
     schema: TSchema;
     enrich?: WidgetEnrichConfig;
-    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: {
-        messageContext?: MessageContext;
-    }): ReactElement;
+    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: WidgetRenderOptions): ReactElement;
 }
 /** Type guard to check if a widget is an SDK-provided widget */
 declare function isSDKWidget(widget: AnyUIWidgetDefinition): widget is SDKUIWidgetDefinition;
@@ -284,11 +318,9 @@ interface UIWidgetDefinition<TSchema extends FlexibleSchema = FlexibleSchema, TE
      * Render function that receives the payload and enriched results.
      * @param payload - The LLM-generated data matching the schema
      * @param enriched - Enrichment results keyed by name (empty object if no enrich config)
-     * @param options - Render options (messageContext, etc.)
+     * @param options - Render options (messageContext, invokeTool)
      */
-    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: {
-        messageContext?: MessageContext;
-    }): unknown;
+    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: WidgetRenderOptions): unknown;
 }
 /**
  * Helper to create customer widgets.
@@ -318,9 +350,7 @@ declare const createWidget: <TEnriched extends EnrichedResults = EnrichedResults
     schema: any;
     enrich?: WidgetEnrichConfig;
     reactDOM: CustomerReactDOM;
-    render(payload: any, enriched: TEnriched, options: {
-        messageContext?: MessageContext;
-    }): unknown;
+    render(payload: any, enriched: TEnriched, options: WidgetRenderOptions): unknown;
 }) => UIWidgetDefinition<FlexibleSchema, TEnriched>;
 
 type DisplayMode = 'full' | 'brief';
@@ -492,6 +522,8 @@ interface MessageRendererProps {
     className?: string;
     /** Feedback config - if provided, feedback UI will be shown */
     feedback?: FeedbackConfig;
+    /** Function to invoke tools from widgets (client-side enrichment) */
+    invokeTool?: InvokeTool;
 }
 /**
  * MessageRenderer - renders message content with optional feedback UI.
@@ -499,7 +531,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, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
+declare function MessageRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, invokeTool, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
 
 interface DisplayModeProps {
     /** Message sections to render */
@@ -564,8 +596,13 @@ declare global {
 }
 
 declare const defaultChatWidgets: SDKUIWidgetDefinition[];
+/**
+ * Hybrid vendor cards widget:
+ * - Server enriches vendor details (parallel to LLM, immediate render)
+ * - Client fetches distance matrix (progressive, fills in after render)
+ */
 declare const getVendorCardsWidget: (isProd?: boolean) => SDKUIWidgetDefinition[];
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AgentVersion, type AnyUIWidgetDefinition, type ApiConfig, 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, FullDisplayMode, FullDisplayMode as FullRenderer, type MessageContext, type MessageFeedback, MessageRenderer, type MessageRendererProps, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type DisplayModeProps as RendererProps, type SDKUIWidgetDefinition, SDK_WIDGET_MARKER, type SubmitFeedbackParams, TagGroupDisplay, type TagGroupDisplayProps, ToolCallDisplay, type ToolCallDisplayProps, type ToolPart, type UIMessagePart, type UIWidgetDefinition, type UseChatConfig, type UseFeedbackConfig, type WidgetEnrichConfig, cn, createSDKWidget, createWidget, defaultChatWidgets, getVendorCardsWidget, isSDKWidget, registerChatWidgets, transformMessage, useChat, useFeedback };
+export { type AgentVersion, type AnyUIWidgetDefinition, type ApiConfig, 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, FullDisplayMode, FullDisplayMode as FullRenderer, type InvokeTool, type MessageContext, type MessageFeedback, MessageRenderer, type MessageRendererProps, 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, getVendorCardsWidget, isSDKWidget, registerChatWidgets, transformMessage, useChat, useFeedback };