@ensembleapp/client-sdk 0.0.34 → 0.0.36

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import React$1, { ReactElement } from 'react';
+import React, { ReactElement, ReactNode } from 'react';
 import * as ai from 'ai';
 import { UIMessage } from 'ai';
 import { FlexibleSchema, InferSchema } from '@ai-sdk/provider-utils';
@@ -39,7 +39,7 @@ type DeprecatedChatConfig = {
     agentExecutionId?: string;
 };
 interface ApiConfig {
-    /** The base URL where /chat and /chat/messages are hosted */
+    /** The base URL where /api/chat and /api/chat/messages are hosted */
     baseUrl: string;
     /** JWT token generated from Secret */
     token: string;
@@ -232,10 +232,10 @@ interface UIWidgetDefinition<TSchema extends FlexibleSchema = FlexibleSchema, TE
     render(payload: InferSchema<TSchema>, enriched: TEnriched): unknown;
 }
 /**
- * Helper to create customer widgets with type inference.
+ * Helper to create customer widgets.
  *
- * Provides autocomplete and type checking for widget definitions.
- * The render function receives typed payload based on your schema.
+ * Note: Uses loose typing for schema to avoid "Type instantiation is excessively deep"
+ * errors with complex Zod schemas. Schema is validated at runtime, not compile time.
  *
  * @example
  * ```typescript
@@ -254,7 +254,13 @@ interface UIWidgetDefinition<TSchema extends FlexibleSchema = FlexibleSchema, TE
  * });
  * ```
  */
-declare const createWidget: <TSchema extends FlexibleSchema, TEnriched extends EnrichedResults = EnrichedResults>({ widgetType, schema, enrich, reactDOM, render, }: UIWidgetDefinition<TSchema, TEnriched>) => UIWidgetDefinition<TSchema, TEnriched>;
+declare const createWidget: <TEnriched extends EnrichedResults = EnrichedResults>(widget: {
+    widgetType: string;
+    schema: any;
+    enrich?: WidgetEnrichConfig;
+    reactDOM: CustomerReactDOM;
+    render(payload: any, enriched: TEnriched): unknown;
+}) => UIWidgetDefinition<FlexibleSchema, TEnriched>;
 
 type DisplayMode = 'full' | 'brief';
 
@@ -321,7 +327,7 @@ interface ChatWidgetConfig extends UseChatConfig {
     /** Feedback options for assistant messages. Enabled by default. */
     feedback?: ChatWidgetFeedbackOptions;
 }
-declare const ChatWidget: React$1.ForwardRefExoticComponent<ChatWidgetConfig & React$1.RefAttributes<ChatWidgetHandle>>;
+declare const ChatWidget: React.ForwardRefExoticComponent<ChatWidgetConfig & React.RefAttributes<ChatWidgetHandle>>;
 
 interface PopupAnchorConfig {
     enabled?: boolean;
@@ -331,13 +337,13 @@ interface PopupAnchorConfig {
     render?: (options: {
         isOpen: boolean;
         toggle: () => void;
-    }) => React$1.ReactNode;
+    }) => React.ReactNode;
     closeButton?: PopupCloseConfig;
 }
 interface PopupCloseConfig {
     render?: (options: {
         toggle: () => void;
-    }) => React$1.ReactNode;
+    }) => React.ReactNode;
     position?: 'top-end' | 'top-start';
     show?: boolean;
 }
@@ -389,6 +395,22 @@ declare function useFeedback({ api, threadId, agentId, agentVersion, agentExecut
     error: Error | null;
 };
 
+/**
+ * Transforms a UIMessage into a ChatMessage with sections.
+ *
+ * Groups UIMessage.parts into step and group sections:
+ * - step: content between step-start markers (one LLM turn)
+ * - group: content within data-tag-start/end markers (sub-agent output)
+ *
+ * Parts pass through as-is - no content transformation.
+ * Structural markers (step-start, data-tag-*, data-transfer, data-thoughts)
+ * are consumed during grouping and not included in output.
+ *
+ * @param msg - The UIMessage from AI SDK
+ * @returns ChatMessage with sections
+ */
+declare function transformMessage(msg: UIMessage): ChatMessage;
+
 /** Tool part from UIMessage - either typed tool-* or dynamic-tool */
 type ToolPart = Extract<UIMessagePart, {
     type: `tool-${string}`;
@@ -405,34 +427,84 @@ interface TagGroupDisplayProps {
     tagId: string;
     isExpanded: boolean;
     onToggle: () => void;
-    children: React.ReactNode;
+    children: ReactNode;
 }
 declare function TagGroupDisplay({ tagId, isExpanded, onToggle, children, }: TagGroupDisplayProps): react_jsx_runtime.JSX.Element;
 
-interface RendererProps {
+interface MessageRendererProps {
+    /** The message to render */
+    message: ChatMessage;
+    /** Widget definitions for rendering data-ui parts */
+    widgets?: AnyUIWidgetDefinition[];
+    /** Readonly mode - disables all widget interactions */
+    readonly?: boolean;
+    /** Display mode: 'brief' collapses previous steps, 'full' shows everything */
+    displayMode?: 'brief' | 'full';
+    /** Tag expansion state and handler */
+    tagExpansion?: {
+        state: Map<string, boolean>;
+        onToggle: (tagId: string) => void;
+    };
+    /** Optional className for the container */
+    className?: string;
+}
+/**
+ * MessageRenderer - content-only message renderer.
+ *
+ * Renders the content of a ChatMessage (text, tools, widgets, groups) without
+ * any bubble layout. Use this when you want to provide your own bubble/container styling.
+ *
+ * For a complete solution with bubble layout included, use MessageBubbleRenderer.
+ */
+declare function MessageRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
+
+interface MessageWithFeedbackRendererProps extends MessageRendererProps {
+    /** Feedback configuration (ignored if readonly=true) */
+    feedback?: {
+        enabled: boolean;
+        showButtons?: boolean;
+        existingRating?: FeedbackRating;
+        existingComment?: string;
+        submitting?: boolean;
+        requireCommentForNegative?: boolean;
+        onSubmit?: (rating: FeedbackRating, comment?: string) => void;
+    };
+}
+/**
+ * MessageWithFeedbackRenderer - message renderer with optional feedback UI.
+ *
+ * Wraps MessageRenderer and adds feedback buttons for assistant messages.
+ * Use this when you want content rendering + feedback without bubble styling.
+ *
+ * For a complete solution with ChatWidget bubble layout, use ChatWidget directly.
+ * For content-only rendering, use MessageRenderer.
+ */
+declare function MessageWithFeedbackRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, }: MessageWithFeedbackRendererProps): react_jsx_runtime.JSX.Element;
+
+interface DisplayModeProps {
     /** Message sections to render */
     sections: ChatMessageSection[];
     /** Unique message ID for keying */
     messageId: string;
     /** Render function for individual parts (text, widgets, tool calls) */
-    renderPart: (part: UIMessagePart, key: string) => React$1.ReactNode;
+    renderPart: (part: UIMessagePart, key: string) => ReactNode;
     /** Render function for group sections */
-    renderGroup: (groupName: string, key: string, children: React$1.ReactNode) => React$1.ReactNode;
+    renderGroup: (groupName: string, key: string, children: ReactNode) => ReactNode;
 }
 
 /**
- * Full display mode renderer - shows all content without collapsing.
- * Each section is rendered as-is in chronological order.
- */
-declare function FullRenderer({ sections, messageId, renderPart, renderGroup, }: RendererProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Brief display mode renderer - collapses previous steps.
+ * Brief display mode - collapses previous steps.
  *
  * All steps before the last one are collapsed into a single "Show more" section.
  * Groups collapse their internal content similarly.
  */
-declare function BriefRenderer({ sections, messageId, renderPart, renderGroup, }: RendererProps): react_jsx_runtime.JSX.Element;
+declare function BriefDisplayMode({ sections, messageId, renderPart, renderGroup, }: DisplayModeProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Full display mode - shows all content without collapsing.
+ * Each section is rendered as-is in chronological order.
+ */
+declare function FullDisplayMode({ sections, messageId, renderPart, renderGroup, }: DisplayModeProps): react_jsx_runtime.JSX.Element;
 
 type RegisterChatWidgetsParams = {
     api: ApiConfig;
@@ -476,4 +548,4 @@ declare const getVendorCardsWidget: (isProd?: boolean) => SDKUIWidgetDefinition[
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AgentVersion, type AnyUIWidgetDefinition, type ApiConfig, 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 EmbeddableChatWidgetConfig, type EnrichedResults, type FeedbackRating, type FeedbackState, FullRenderer, type MessageFeedback, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type 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, 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 FeedbackRating, type FeedbackState, FullDisplayMode, FullDisplayMode as FullRenderer, MessageWithFeedbackRenderer as MessageBubbleRenderer, type MessageWithFeedbackRendererProps as MessageBubbleRendererProps, type MessageFeedback, MessageRenderer, type MessageRendererProps, MessageWithFeedbackRenderer, type MessageWithFeedbackRendererProps, 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 };