@ensembleapp/client-sdk 0.0.14 → 0.0.15

package/dist/index.d.ts

@@ -5,42 +5,43 @@ import React$1, { ReactNode } from 'react';
 import z, { AnyZodObject } from 'zod';
 import { ClassValue } from 'clsx';
 
-/**
- * Version selector for tools. This should mirror VersionSelector on server-side
- * - 'latest': prefer draft (v0), fallback to last published
- * - 'published': prefer last published, fallback to draft
- * - number: specific version (1+)
- */
+/** @minimum 1 */
 type VersionSelector = 'latest' | 'published' | number;
 /**
- * Configuration for enriching widget data server-side by calling a tool.
- * Uses JEXL expressions to build tool inputs from the widget payload.
+ * fetch data via tool call.
  */
-type WidgetEnrichConfig = {
-    /** Tool ID to call for enrichment */
+type ToolCallConfig = {
     toolId: string;
     /**
-     * Tool version selector. Defaults to 'latest'.
-     * - 'latest': prefer draft, fallback to published
-     * - 'published': prefer published, fallback to draft
-     * - number: specific version (1+)
+     * Select the tool version (default to 'latest' if not provided).
+     * - 'latest': pick draft if exists, fallback to latest published version
+     * - 'published': pick latest published version, fallback to draft version
+     * - number: specific tool version (1+)
      */
     version?: VersionSelector;
     /**
-     * Maps tool input names to JEXL expressions.
-     * Expressions are evaluated with $ as the payload root (auto-normalized).
-     * Use ${...} syntax for JEXL expressions, or literal values.
-     *
-     * Examples:
-     * - "${vendors|map('id')|join(',')}" → "v1,v2,v3"
-     * - "${limit}" → 10
-     * - "static value" → "static value"
-     *
-     * If omitted, the entire payload is passed as tool input.
+     * Tool input can be literal or templated string with expressions
      */
     inputs?: Record<string, unknown>;
 };
-/** Enrichment result containing the full tool response. TThis should mirror ToolResult on server-side. */
+/**
+ * Widget enrichment configuration.
+ * Keys are used to access the enrichment results in the render function.
+ *
+ * Example:
+ * ```typescript
+ * enrich: {
+ *   vendorDetails: { toolId: 'vendor-tool', inputs: { ids: "${vendors}" } },
+ *   pricing: { toolId: 'pricing-tool', inputs: { ids: "${vendors}" } },
+ * },
+ * render: (payload, enriched) => {
+ *   const vendors = enriched?.vendorDetails?.data;
+ *   const pricing = enriched?.pricing?.data;
+ * }
+ * ```
+ */
+type WidgetEnrichConfig = Record<string, ToolCallConfig>;
+/** Enrichment result containing the full tool response. This should mirror ToolResult on server-side. */
 type EnrichmentResult$1 = {
     success: boolean;
     error?: {
@@ -55,8 +56,8 @@ type UIWidget = {
     widgetType: string;
     /** LLM-generated data based on the widget schema specified by the client */
     payload: unknown;
-    /** Server-injected enrichment result from tool call. This mirror ToolResult on server-side. */
-    enrichedResult?: EnrichmentResult$1;
+    /** Server-injected enrichment results from tool calls, keyed by enrichment name */
+    enriched?: Record<string, EnrichmentResult$1>;
 };
 
 type DeprecatedChatConfig = {
@@ -175,8 +176,7 @@ declare function useFeedback({ api, threadId, agentId, agentExecutionId, }: UseF
     error: Error | null;
 };
 
-/** Enrichment result containing the full tool response - this should mirror ToolResult
- * OR maybe we should declare ToolResult here? */
+/** Enrichment result containing the full tool response - this should mirror ToolResult */
 interface EnrichmentResult<TData = unknown> {
     success: boolean;
     error?: {
@@ -186,27 +186,32 @@ interface EnrichmentResult<TData = unknown> {
     data?: TData;
     metadata?: Record<string, unknown>;
 }
-/**
- * Props passed to widget render functions.
- * Contains both the validated payload and optional enriched result.
- */
-interface WidgetRenderProps<TPayload, TEnrichedData = unknown> {
-    /** The validated widget payload matching the schema */
-    payload: TPayload;
-    /** Server-injected enrichment result (only present if widget has enrich config) */
-    enrichedResult?: EnrichmentResult<TEnrichedData>;
-}
-interface UIWidgetDefinition<TSchema extends AnyZodObject = AnyZodObject, TEnrichedData = unknown> {
+/** Enriched results keyed by enrichment name */
+type EnrichedResults<T = unknown> = Record<string, EnrichmentResult<T>>;
+interface UIWidgetDefinition<TSchema extends AnyZodObject = AnyZodObject, TEnriched extends EnrichedResults = EnrichedResults> {
     widgetType: string;
     schema: TSchema;
     /**
-     * Optional enrichment config - if provided, server will call a tool to enrich the data.
-     * The enriched data is passed to the render function as `enrichedResult.data`.
+     * Optional enrichment config - if provided, server will call the tools to enrich the data.
+     * Keys are used to access results in the render function.
+     *
+     * Example:
+     * ```typescript
+     * enrich: {
+     *   vendorDetails: { toolId: 'vendor-tool', inputs: { ids: "${vendors}" } },
+     *   pricing: { toolId: 'pricing-tool', inputs: { ids: "${vendors}" } },
+     * }
+     * ```
      */
     enrich?: WidgetEnrichConfig;
-    render(props: WidgetRenderProps<z.infer<TSchema>, TEnrichedData>): ReactNode;
+    /**
+     * 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)
+     */
+    render(payload: z.infer<TSchema>, enriched: TEnriched): ReactNode;
 }
-declare const createWidget: <TSchema extends AnyZodObject, TEnrichedData = unknown>({ widgetType, schema, enrich, render, }: UIWidgetDefinition<TSchema, TEnrichedData>) => UIWidgetDefinition<TSchema, TEnrichedData>;
+declare const createWidget: <TSchema extends AnyZodObject, TEnriched extends EnrichedResults = EnrichedResults>({ widgetType, schema, enrich, render, }: UIWidgetDefinition<TSchema, TEnriched>) => UIWidgetDefinition<TSchema, TEnriched>;
 
 interface ChatWidgetStyles {
     primaryColor?: string;
@@ -353,4 +358,4 @@ declare const defaultChatWidgets: UIWidgetDefinition[];
 
 declare function cn(...inputs: ClassValue[]): string;
 
-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 EnrichmentResult, 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, type WidgetEnrichConfig, type WidgetRenderProps, cn, createChatWidget, createWidget, defaultChatWidgets, registerChatWidgets, useChat, useFeedback };
+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 EnrichedResults, type EnrichmentResult, 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, type WidgetEnrichConfig, cn, createChatWidget, createWidget, defaultChatWidgets, registerChatWidgets, useChat, useFeedback };

package/dist/index.js

@@ -23670,12 +23670,12 @@ async function registerChatWidgets({
   widgets
 }) {
   const widgetSchemas = widgets.map(({ widgetType, schema, enrich }) => {
-    schema = schema.extend({
+    const extendedSchema = schema.extend({
       widgetType: zod_default.literal(widgetType)
     });
     return {
       widgetType,
-      schema: toJsonSchema(schema),
+      schema: toJsonSchema(extendedSchema),
       enrich
     };
   });
@@ -24273,7 +24273,7 @@ function MessageItemComponent({
         ] }, key);
       }
       const widget = item;
-      return /* @__PURE__ */ jsx5("div", { className: "chat-widget__widget", children: widgetDef.render({ payload: widget.payload, enrichedResult: widget.enrichedResult }) }, key);
+      return /* @__PURE__ */ jsx5("div", { className: "chat-widget__widget", children: widgetDef.render(widget.payload, widget.enriched ?? {}) }, key);
     }
     return null;
   };
@@ -24875,7 +24875,7 @@ var createWidget = ({
   widgetType,
   schema,
   enrich,
-  render: (props) => render(props)
+  render
 });
 
 // lib/widgets/default-widgets.tsx
@@ -24888,7 +24888,7 @@ var defaultChatWidgets = [
       profileUri: zod_default.string().optional(),
       details: zod_default.record(zod_default.any()).optional()
     }).describe("showing a person card with name, photo and additional details"),
-    render: ({ payload }) => /* @__PURE__ */ jsx8(
+    render: (payload) => /* @__PURE__ */ jsx8(
       "div",
       {
         style: {
@@ -24937,7 +24937,7 @@ var defaultChatWidgets = [
       uri: zod_default.string().url(),
       text: zod_default.string().optional()
     }).describe("rendering a clickable link"),
-    render: ({ payload }) => /* @__PURE__ */ jsx8(
+    render: (payload) => /* @__PURE__ */ jsx8(
       "a",
       {
         href: payload.uri,
@@ -24980,14 +24980,16 @@ var defaultChatWidgets = [
       }))
     }).describe("displaying a list of vendor cards with rankings and reasons. Only use this widget when calling Care Network vendor search tools."),
     enrich: {
-      toolId: "CPgsswom7FkUYvplmy6H",
-      inputs: {
-        vendorIds: "${vendors|map('vendor_id')|join(',')}"
+      vendorDetails: {
+        toolId: "CPgsswom7FkUYvplmy6H",
+        inputs: {
+          vendorIds: "${vendors|map('vendor_id')|join(',')}"
+        }
       }
     },
-    render: ({ payload, enrichedResult }) => {
+    render: (payload, { vendorDetails }) => {
       const typedPayload = payload;
-      const vendorData = enrichedResult?.data ?? {};
+      const vendorData = vendorDetails?.data ?? {};
       const formatLanguage = (code3) => {
         const langMap = { en: "English", es: "Spanish", zh: "Chinese", fr: "French" };
         return langMap[code3.trim()] || code3.trim();