@ensembleapp/client-sdk 0.0.36 → 0.0.38

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import React, { ReactElement, ReactNode } from 'react';
 import * as ai from 'ai';
 import { UIMessage } from 'ai';
 import { FlexibleSchema, InferSchema } from '@ai-sdk/provider-utils';
+import z from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassValue } from 'clsx';
 
@@ -53,7 +54,7 @@ type UseChatConfig = DeprecatedChatConfig & {
     /** Thread ID for keeping conversation history */
     threadId: string;
     /** Ensemble agent ID to connect to */
-    agentId?: string;
+    agentId: string;
     /** Agent version: 'latest' (default), 'published', or a specific version number */
     agentVersion?: AgentVersion;
     /** additional context (anything) that needs to be passed to the LLM */
@@ -92,8 +93,24 @@ declare function useChat({ api, threadId, agentId, agentVersion, agentExecutionI
     setMessages: (messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[] | ((messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[]) => UIMessage<unknown, ai.UIDataTypes, ai.UITools>[])) => void;
 };
 
-/** @minimum 1 */
-type VersionSelector = 'latest' | 'published' | number;
+declare const VersionSelectorSchema: z.ZodUnion<readonly [z.ZodLiteral<"latest">, z.ZodLiteral<"published">, z.ZodNumber]>;
+type VersionSelector = z.infer<typeof VersionSelectorSchema>;
+
+declare const FeedbackRatingSchema: z.ZodEnum<{
+    positive: "positive";
+    negative: "negative";
+}>;
+type FeedbackRating = z.infer<typeof FeedbackRatingSchema>;
+interface FeedbackNote {
+    noteId?: string;
+    [key: string]: unknown;
+}
+interface MessageFeedback {
+    rating?: FeedbackRating;
+    improvementText?: string;
+    notes?: FeedbackNote[];
+}
+
 /**
  * fetch data via tool call.
  */
@@ -141,6 +158,43 @@ type EnrichmentResult<TData = unknown> = {
     data?: TData;
 };
 
+/**
+ * Client-specific types for the SDK.
+ * Core feedback types (FeedbackRating, FeedbackNote, MessageFeedback, CreateFeedbackRequest)
+ * are in @repo/agent-sdk/schemas.
+ */
+
+interface SubmitFeedbackParams {
+    rating?: FeedbackRating | null;
+    improvementText?: string | null;
+    notes?: FeedbackNote[];
+}
+/**
+ * Feedback handlers for a specific message.
+ * messageId is not necessary here and is handled at a higher level.
+ */
+interface FeedbackHandlers {
+    getFeedback: () => MessageFeedback | undefined;
+    submitFeedback: (params: SubmitFeedbackParams) => Promise<MessageFeedback | null>;
+}
+/**
+ * Feedback configuration for MessageRenderer.
+ * Contains handlers and UI options for feedback display.
+ */
+interface FeedbackConfig extends FeedbackHandlers {
+    /** Whether a submission is in progress (disables interaction) */
+    loading?: boolean;
+    /** Whether comment is required for negative feedback */
+    requireCommentForNegative?: boolean;
+}
+/**
+ * Message-level context provided to child.
+ * Contains message-scoped data and feedback utilities.
+ */
+interface MessageContext extends FeedbackHandlers {
+    messageId: string;
+}
+
 /** Enriched results keyed by enrichment name */
 type EnrichedResults<T = unknown> = Record<string, EnrichmentResult<T>>;
 /** Union type for SDK to handle both customer and SDK UI widgets */
@@ -156,7 +210,9 @@ interface SDKUIWidgetDefinition<TSchema extends FlexibleSchema = FlexibleSchema,
     widgetType: string;
     schema: TSchema;
     enrich?: WidgetEnrichConfig;
-    render(payload: InferSchema<TSchema>, enriched: TEnriched): ReactElement;
+    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: {
+        messageContext?: MessageContext;
+    }): ReactElement;
 }
 /** Type guard to check if a widget is an SDK-provided widget */
 declare function isSDKWidget(widget: AnyUIWidgetDefinition): widget is SDKUIWidgetDefinition;
@@ -228,8 +284,11 @@ 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.)
      */
-    render(payload: InferSchema<TSchema>, enriched: TEnriched): unknown;
+    render(payload: InferSchema<TSchema>, enriched: TEnriched, options: {
+        messageContext?: MessageContext;
+    }): unknown;
 }
 /**
  * Helper to create customer widgets.
@@ -259,7 +318,9 @@ declare const createWidget: <TEnriched extends EnrichedResults = EnrichedResults
     schema: any;
     enrich?: WidgetEnrichConfig;
     reactDOM: CustomerReactDOM;
-    render(payload: any, enriched: TEnriched): unknown;
+    render(payload: any, enriched: TEnriched, options: {
+        messageContext?: MessageContext;
+    }): unknown;
 }) => UIWidgetDefinition<FlexibleSchema, TEnriched>;
 
 type DisplayMode = 'full' | 'brief';
@@ -363,33 +424,15 @@ interface PopupChatWidgetProps extends ChatWidgetConfig {
 }
 declare function PopupChatWidget({ anchor, ...props }: PopupChatWidgetProps): react_jsx_runtime.JSX.Element;
 
-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;
+    agentId: string;
     agentVersion?: AgentVersion;
-    agentExecutionId?: string;
-}
-interface SubmitFeedbackParams {
-    messageId: string;
-    rating: FeedbackRating;
-    improvementText?: string;
 }
-declare function useFeedback({ api, threadId, agentId, agentVersion, agentExecutionId, }: UseFeedbackConfig): {
-    submitFeedback: ({ messageId, rating, improvementText }: SubmitFeedbackParams) => Promise<MessageFeedback | null>;
-    getFeedbackForMessage: (messageId: string) => FeedbackState | undefined;
+declare function useFeedback({ api, threadId, agentId, agentVersion, }: UseFeedbackConfig): {
+    submitFeedback: (messageId: string, { rating, improvementText, notes }: SubmitFeedbackParams) => Promise<MessageFeedback | null>;
+    getFeedbackForMessage: (messageId: string) => MessageFeedback | undefined;
     hasFeedback: (messageId: string) => boolean;
     isSubmitting: string | null;
     error: Error | null;
@@ -411,6 +454,14 @@ declare function useFeedback({ api, threadId, agentId, agentVersion, agentExecut
  */
 declare function transformMessage(msg: UIMessage): ChatMessage;
 
+interface TagGroupDisplayProps {
+    tagId: string;
+    isExpanded: boolean;
+    onToggle: () => void;
+    children: ReactNode;
+}
+declare function TagGroupDisplay({ tagId, isExpanded, onToggle, children, }: TagGroupDisplayProps): react_jsx_runtime.JSX.Element;
+
 /** Tool part from UIMessage - either typed tool-* or dynamic-tool */
 type ToolPart = Extract<UIMessagePart, {
     type: `tool-${string}`;
@@ -423,14 +474,6 @@ interface ToolCallDisplayProps {
 }
 declare function ToolCallDisplay({ toolPart, className }: ToolCallDisplayProps): react_jsx_runtime.JSX.Element;
 
-interface TagGroupDisplayProps {
-    tagId: string;
-    isExpanded: boolean;
-    onToggle: () => void;
-    children: ReactNode;
-}
-declare function TagGroupDisplay({ tagId, isExpanded, onToggle, children, }: TagGroupDisplayProps): react_jsx_runtime.JSX.Element;
-
 interface MessageRendererProps {
     /** The message to render */
     message: ChatMessage;
@@ -447,39 +490,16 @@ interface MessageRendererProps {
     };
     /** Optional className for the container */
     className?: string;
+    /** Feedback config - if provided, feedback UI will be shown */
+    feedback?: FeedbackConfig;
 }
 /**
- * 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.
+ * MessageRenderer - renders message content with optional feedback UI.
  *
- * For a complete solution with ChatWidget bubble layout, use ChatWidget directly.
- * For content-only rendering, use MessageRenderer.
+ * Renders the content of a ChatMessage (text, tools, widgets, groups) and optionally
+ * displays feedback buttons for assistant messages.
  */
-declare function MessageWithFeedbackRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, }: MessageWithFeedbackRendererProps): react_jsx_runtime.JSX.Element;
+declare function MessageRenderer({ message, widgets, readonly, displayMode, tagExpansion, className, feedback, }: MessageRendererProps): react_jsx_runtime.JSX.Element;
 
 interface DisplayModeProps {
     /** Message sections to render */
@@ -548,4 +568,4 @@ 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 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 };
+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 };