@apteva/apteva-kit 0.1.16 → 0.1.18

package/dist/index.d.mts

@@ -138,6 +138,22 @@ interface GalleryWidget extends Widget {
         layout?: 'grid' | 'carousel';
     };
 }
+interface TableColumn {
+    key: string;
+    label: string;
+    align?: 'left' | 'center' | 'right';
+    width?: string;
+}
+interface TableWidget extends Widget {
+    type: 'table';
+    props: {
+        columns: TableColumn[];
+        rows: Array<Record<string, any>>;
+        caption?: string;
+        compact?: boolean;
+        striped?: boolean;
+    };
+}
 
 interface Message {
     id: string;
@@ -162,6 +178,59 @@ interface SendMessageParams {
     metadata?: Record<string, any>;
 }
 
+/**
+ * Widget definitions for context injection
+ * These are sent to the agent so it knows what UI widgets are available
+ */
+declare const WIDGET_DEFINITIONS: {
+    readonly card: {
+        readonly description: "Displays a card with title and optional description, image, footer";
+        readonly schema: "{\"title\": \"string\", \"description?\": \"string\", \"image?\": \"url\", \"footer?\": \"string\"}";
+        readonly example: "@ui:card[{\"title\": \"Summary\", \"description\": \"Key findings from the analysis\"}]";
+    };
+    readonly list: {
+        readonly description: "Displays a list of items with title, subtitle, and optional description";
+        readonly schema: "{\"items\": [{\"id\": \"string\", \"title\": \"string\", \"subtitle?\": \"string\", \"description?\": \"string\", \"image?\": \"url\"}]}";
+        readonly example: "@ui:list[{\"items\": [{\"id\": \"1\", \"title\": \"First item\", \"subtitle\": \"Details\"}]}]";
+    };
+    readonly button_group: {
+        readonly description: "Displays action buttons. User clicks are sent back to you with the button id";
+        readonly schema: "{\"buttons\": [{\"id\": \"string\", \"label\": \"string\", \"variant?\": \"primary|secondary|outline\"}], \"layout?\": \"horizontal|vertical\"}";
+        readonly example: "@ui:button_group[{\"buttons\": [{\"id\": \"confirm\", \"label\": \"Confirm\", \"variant\": \"primary\"}, {\"id\": \"cancel\", \"label\": \"Cancel\"}]}]";
+    };
+    readonly form: {
+        readonly description: "Displays an input form. Submitted data is sent back to you";
+        readonly schema: "{\"title?\": \"string\", \"fields\": [{\"name\": \"string\", \"type\": \"text|number|select|checkbox|textarea|date\", \"label\": \"string\", \"required?\": boolean, \"placeholder?\": \"string\", \"options?\": [{\"label\": \"string\", \"value\": \"string\"}]}]}";
+        readonly example: "@ui:form[{\"title\": \"Contact\", \"fields\": [{\"name\": \"email\", \"type\": \"text\", \"label\": \"Email\", \"required\": true}]}]";
+    };
+    readonly image: {
+        readonly description: "Displays a single image with optional caption";
+        readonly schema: "{\"src\": \"url\", \"alt\": \"string\", \"caption?\": \"string\"}";
+        readonly example: "@ui:image[{\"src\": \"https://example.com/img.png\", \"alt\": \"Description\", \"caption\": \"Figure 1\"}]";
+    };
+    readonly gallery: {
+        readonly description: "Displays multiple images in a grid or carousel layout";
+        readonly schema: "{\"images\": [{\"id\": \"string\", \"src\": \"url\", \"alt\": \"string\", \"caption?\": \"string\"}], \"layout?\": \"grid|carousel\"}";
+        readonly example: "@ui:gallery[{\"images\": [{\"id\": \"1\", \"src\": \"https://example.com/1.png\", \"alt\": \"Image 1\"}], \"layout\": \"grid\"}]";
+    };
+    readonly chart: {
+        readonly description: "Displays a chart visualization (line, bar, pie, doughnut)";
+        readonly schema: "{\"chartType\": \"line|bar|pie|doughnut\", \"title?\": \"string\", \"data\": {\"labels\": [\"string\"], \"datasets\": [{\"label\": \"string\", \"data\": [number], \"backgroundColor?\": \"string|string[]\"}]}}";
+        readonly example: "@ui:chart[{\"chartType\": \"bar\", \"title\": \"Sales\", \"data\": {\"labels\": [\"Q1\", \"Q2\"], \"datasets\": [{\"label\": \"Revenue\", \"data\": [100, 150]}]}}]";
+    };
+    readonly map: {
+        readonly description: "Displays an interactive map with optional markers";
+        readonly schema: "{\"center\": {\"lat\": number, \"lng\": number}, \"zoom?\": number, \"markers?\": [{\"id\": \"string\", \"position\": {\"lat\": number, \"lng\": number}, \"title\": \"string\"}]}";
+        readonly example: "@ui:map[{\"center\": {\"lat\": 40.7128, \"lng\": -74.0060}, \"zoom\": 12, \"markers\": [{\"id\": \"1\", \"position\": {\"lat\": 40.7128, \"lng\": -74.0060}, \"title\": \"NYC\"}]}]";
+    };
+    readonly table: {
+        readonly description: "Displays structured data in rows and columns";
+        readonly schema: "{\"columns\": [{\"key\": \"string\", \"label\": \"string\", \"align?\": \"left|center|right\"}], \"rows\": [{\"id?\": \"string\", ...}], \"caption?\": \"string\", \"compact?\": boolean, \"striped?\": boolean}";
+        readonly example: "@ui:table[{\"columns\": [{\"key\": \"name\", \"label\": \"Name\"}, {\"key\": \"status\", \"label\": \"Status\"}], \"rows\": [{\"name\": \"Item 1\", \"status\": \"Active\"}, {\"name\": \"Item 2\", \"status\": \"Pending\"}]}]";
+    };
+};
+type WidgetType = keyof typeof WIDGET_DEFINITIONS;
+
 interface SuggestedPrompt {
     text: string;
     icon?: React.ReactNode;
@@ -195,12 +264,17 @@ interface ChatProps {
     onFileUpload?: (files: FileList) => void;
     onComplete?: (result: CommandResult) => void;
     onError?: (error: Error) => void;
+    onToolResult?: (toolName: string, result?: any) => void;
     theme?: 'light' | 'dark' | 'auto';
     placeholder?: string;
     showHeader?: boolean;
     headerTitle?: string;
     enableFileUpload?: boolean;
     enableMarkdown?: boolean;
+    enableWidgets?: boolean;
+    availableWidgets?: WidgetType[];
+    compactWidgetContext?: boolean;
+    onWidgetRender?: (widget: Widget) => void;
     className?: string;
 }
 interface CommandProps {
@@ -223,6 +297,7 @@ interface CommandProps {
     onError?: (error: Error) => void;
     onFileUpload?: (files: FileList) => void;
     onAction?: (action: ActionEvent) => void;
+    onToolResult?: (toolName: string, result?: any) => void;
     loadingText?: string;
     showProgress?: boolean;
     enableStreaming?: boolean;
@@ -304,7 +379,7 @@ interface UseAptevaKitReturn {
     error: Error | null;
 }
 
-declare function Chat({ agentId, threadId, initialMessages, context, apiUrl, apiKey, useMock, initialMode, showModeToggle, onModeChange, commandVariant, planMode, onPlanModeChange, enableStreaming, showProgress, loadingText, welcomeTitle, welcomeSubtitle, welcomeIcon, suggestedPrompts, welcomeVariant, onThreadChange, onMessageSent, onAction, onFileUpload, onComplete, onError, placeholder, showHeader, headerTitle, className, }: ChatProps): react_jsx_runtime.JSX.Element;
+declare function Chat({ agentId, threadId, initialMessages, context, apiUrl, apiKey, useMock, initialMode, showModeToggle, onModeChange, commandVariant, planMode, onPlanModeChange, enableStreaming, showProgress, loadingText, welcomeTitle, welcomeSubtitle, welcomeIcon, suggestedPrompts, welcomeVariant, onThreadChange, onMessageSent, onAction, onFileUpload, onComplete, onError, onToolResult, placeholder, showHeader, headerTitle, enableWidgets, availableWidgets, compactWidgetContext, onWidgetRender, className, }: ChatProps): react_jsx_runtime.JSX.Element;
 
 declare function Command({ agentId, command: initialCommand, context, autoExecute, allowInput, placeholder, submitButtonText, variant, useMock, planMode, onPlanModeChange, enableFileUpload, onStart, onProgress, onChunk, onComplete, onError, onFileUpload, onAction, loadingText, showProgress, enableStreaming, resultRenderer, className, }: CommandProps): react_jsx_runtime.JSX.Element;
 
@@ -365,10 +440,11 @@ interface ChatResponse {
     widgets?: any[];
 }
 interface StreamChunk {
-    type: 'start' | 'thread_id' | 'content' | 'token' | 'tool_call' | 'tool_input_delta' | 'tool_use' | 'tool_result' | 'stop' | 'widget' | 'complete' | 'done' | 'error';
+    type: 'start' | 'thread_id' | 'request_id' | 'content' | 'token' | 'tool_call' | 'tool_input_delta' | 'tool_use' | 'tool_result' | 'stop' | 'widget' | 'complete' | 'done' | 'error';
     content?: string;
     widget?: any;
     thread_id?: string;
+    request_id?: string;
     tool_id?: string;
     tool_name?: string;
     error?: string;
@@ -401,6 +477,10 @@ declare class AptevaClient {
      * Get thread messages
      */
     getThreadMessages(threadId: string): Promise<ChatMessage[]>;
+    /**
+     * Cancel an in-progress request
+     */
+    cancelRequest(agentId: string, requestId: string): Promise<void>;
 }
 declare const aptevaClient: AptevaClient;
 
@@ -410,4 +490,4 @@ declare const mockMessages: Message[];
 declare const mockThreads: Thread[];
 declare const mockWidgets: Widget[];
 
-export { type Action, type ActionEvent, AptevaClient, type AptevaClientConfig, type AptevaKitControl, Button, type ButtonGroupWidget, type ButtonWidget, Card, type CardWidget, type ChartWidget, Chat, type ChatMessage, type ChatProps, type ChatRequest, type ChatResponse, Command, type CommandProps, type CommandResult, type FormField, type FormWidget, type GalleryWidget, type ImageWidget, List, type ListItem, type ListWidget, type MapWidget, type Message, Prompt, type PromptProps, type SendMessageParams, Stream, type StreamChunk, type StreamProps, type SuggestedPrompt, type Thread, Threads, type ThreadsProps, type UseAptevaKitReturn, type Widget, Widgets, type WidgetsProps, aptevaClient, cn, getThemeScript, mockMessages, mockThreads, mockWidgets };
+export { type Action, type ActionEvent, AptevaClient, type AptevaClientConfig, type AptevaKitControl, Button, type ButtonGroupWidget, type ButtonWidget, Card, type CardWidget, type ChartWidget, Chat, type ChatMessage, type ChatProps, type ChatRequest, type ChatResponse, Command, type CommandProps, type CommandResult, type FormField, type FormWidget, type GalleryWidget, type ImageWidget, List, type ListItem, type ListWidget, type MapWidget, type Message, Prompt, type PromptProps, type SendMessageParams, Stream, type StreamChunk, type StreamProps, type SuggestedPrompt, type TableColumn, type TableWidget, type Thread, Threads, type ThreadsProps, type UseAptevaKitReturn, type Widget, Widgets, type WidgetsProps, aptevaClient, cn, getThemeScript, mockMessages, mockThreads, mockWidgets };

package/dist/index.d.ts

@@ -138,6 +138,22 @@ interface GalleryWidget extends Widget {
         layout?: 'grid' | 'carousel';
     };
 }
+interface TableColumn {
+    key: string;
+    label: string;
+    align?: 'left' | 'center' | 'right';
+    width?: string;
+}
+interface TableWidget extends Widget {
+    type: 'table';
+    props: {
+        columns: TableColumn[];
+        rows: Array<Record<string, any>>;
+        caption?: string;
+        compact?: boolean;
+        striped?: boolean;
+    };
+}
 
 interface Message {
     id: string;
@@ -162,6 +178,59 @@ interface SendMessageParams {
     metadata?: Record<string, any>;
 }
 
+/**
+ * Widget definitions for context injection
+ * These are sent to the agent so it knows what UI widgets are available
+ */
+declare const WIDGET_DEFINITIONS: {
+    readonly card: {
+        readonly description: "Displays a card with title and optional description, image, footer";
+        readonly schema: "{\"title\": \"string\", \"description?\": \"string\", \"image?\": \"url\", \"footer?\": \"string\"}";
+        readonly example: "@ui:card[{\"title\": \"Summary\", \"description\": \"Key findings from the analysis\"}]";
+    };
+    readonly list: {
+        readonly description: "Displays a list of items with title, subtitle, and optional description";
+        readonly schema: "{\"items\": [{\"id\": \"string\", \"title\": \"string\", \"subtitle?\": \"string\", \"description?\": \"string\", \"image?\": \"url\"}]}";
+        readonly example: "@ui:list[{\"items\": [{\"id\": \"1\", \"title\": \"First item\", \"subtitle\": \"Details\"}]}]";
+    };
+    readonly button_group: {
+        readonly description: "Displays action buttons. User clicks are sent back to you with the button id";
+        readonly schema: "{\"buttons\": [{\"id\": \"string\", \"label\": \"string\", \"variant?\": \"primary|secondary|outline\"}], \"layout?\": \"horizontal|vertical\"}";
+        readonly example: "@ui:button_group[{\"buttons\": [{\"id\": \"confirm\", \"label\": \"Confirm\", \"variant\": \"primary\"}, {\"id\": \"cancel\", \"label\": \"Cancel\"}]}]";
+    };
+    readonly form: {
+        readonly description: "Displays an input form. Submitted data is sent back to you";
+        readonly schema: "{\"title?\": \"string\", \"fields\": [{\"name\": \"string\", \"type\": \"text|number|select|checkbox|textarea|date\", \"label\": \"string\", \"required?\": boolean, \"placeholder?\": \"string\", \"options?\": [{\"label\": \"string\", \"value\": \"string\"}]}]}";
+        readonly example: "@ui:form[{\"title\": \"Contact\", \"fields\": [{\"name\": \"email\", \"type\": \"text\", \"label\": \"Email\", \"required\": true}]}]";
+    };
+    readonly image: {
+        readonly description: "Displays a single image with optional caption";
+        readonly schema: "{\"src\": \"url\", \"alt\": \"string\", \"caption?\": \"string\"}";
+        readonly example: "@ui:image[{\"src\": \"https://example.com/img.png\", \"alt\": \"Description\", \"caption\": \"Figure 1\"}]";
+    };
+    readonly gallery: {
+        readonly description: "Displays multiple images in a grid or carousel layout";
+        readonly schema: "{\"images\": [{\"id\": \"string\", \"src\": \"url\", \"alt\": \"string\", \"caption?\": \"string\"}], \"layout?\": \"grid|carousel\"}";
+        readonly example: "@ui:gallery[{\"images\": [{\"id\": \"1\", \"src\": \"https://example.com/1.png\", \"alt\": \"Image 1\"}], \"layout\": \"grid\"}]";
+    };
+    readonly chart: {
+        readonly description: "Displays a chart visualization (line, bar, pie, doughnut)";
+        readonly schema: "{\"chartType\": \"line|bar|pie|doughnut\", \"title?\": \"string\", \"data\": {\"labels\": [\"string\"], \"datasets\": [{\"label\": \"string\", \"data\": [number], \"backgroundColor?\": \"string|string[]\"}]}}";
+        readonly example: "@ui:chart[{\"chartType\": \"bar\", \"title\": \"Sales\", \"data\": {\"labels\": [\"Q1\", \"Q2\"], \"datasets\": [{\"label\": \"Revenue\", \"data\": [100, 150]}]}}]";
+    };
+    readonly map: {
+        readonly description: "Displays an interactive map with optional markers";
+        readonly schema: "{\"center\": {\"lat\": number, \"lng\": number}, \"zoom?\": number, \"markers?\": [{\"id\": \"string\", \"position\": {\"lat\": number, \"lng\": number}, \"title\": \"string\"}]}";
+        readonly example: "@ui:map[{\"center\": {\"lat\": 40.7128, \"lng\": -74.0060}, \"zoom\": 12, \"markers\": [{\"id\": \"1\", \"position\": {\"lat\": 40.7128, \"lng\": -74.0060}, \"title\": \"NYC\"}]}]";
+    };
+    readonly table: {
+        readonly description: "Displays structured data in rows and columns";
+        readonly schema: "{\"columns\": [{\"key\": \"string\", \"label\": \"string\", \"align?\": \"left|center|right\"}], \"rows\": [{\"id?\": \"string\", ...}], \"caption?\": \"string\", \"compact?\": boolean, \"striped?\": boolean}";
+        readonly example: "@ui:table[{\"columns\": [{\"key\": \"name\", \"label\": \"Name\"}, {\"key\": \"status\", \"label\": \"Status\"}], \"rows\": [{\"name\": \"Item 1\", \"status\": \"Active\"}, {\"name\": \"Item 2\", \"status\": \"Pending\"}]}]";
+    };
+};
+type WidgetType = keyof typeof WIDGET_DEFINITIONS;
+
 interface SuggestedPrompt {
     text: string;
     icon?: React.ReactNode;
@@ -195,12 +264,17 @@ interface ChatProps {
     onFileUpload?: (files: FileList) => void;
     onComplete?: (result: CommandResult) => void;
     onError?: (error: Error) => void;
+    onToolResult?: (toolName: string, result?: any) => void;
     theme?: 'light' | 'dark' | 'auto';
     placeholder?: string;
     showHeader?: boolean;
     headerTitle?: string;
     enableFileUpload?: boolean;
     enableMarkdown?: boolean;
+    enableWidgets?: boolean;
+    availableWidgets?: WidgetType[];
+    compactWidgetContext?: boolean;
+    onWidgetRender?: (widget: Widget) => void;
     className?: string;
 }
 interface CommandProps {
@@ -223,6 +297,7 @@ interface CommandProps {
     onError?: (error: Error) => void;
     onFileUpload?: (files: FileList) => void;
     onAction?: (action: ActionEvent) => void;
+    onToolResult?: (toolName: string, result?: any) => void;
     loadingText?: string;
     showProgress?: boolean;
     enableStreaming?: boolean;
@@ -304,7 +379,7 @@ interface UseAptevaKitReturn {
     error: Error | null;
 }
 
-declare function Chat({ agentId, threadId, initialMessages, context, apiUrl, apiKey, useMock, initialMode, showModeToggle, onModeChange, commandVariant, planMode, onPlanModeChange, enableStreaming, showProgress, loadingText, welcomeTitle, welcomeSubtitle, welcomeIcon, suggestedPrompts, welcomeVariant, onThreadChange, onMessageSent, onAction, onFileUpload, onComplete, onError, placeholder, showHeader, headerTitle, className, }: ChatProps): react_jsx_runtime.JSX.Element;
+declare function Chat({ agentId, threadId, initialMessages, context, apiUrl, apiKey, useMock, initialMode, showModeToggle, onModeChange, commandVariant, planMode, onPlanModeChange, enableStreaming, showProgress, loadingText, welcomeTitle, welcomeSubtitle, welcomeIcon, suggestedPrompts, welcomeVariant, onThreadChange, onMessageSent, onAction, onFileUpload, onComplete, onError, onToolResult, placeholder, showHeader, headerTitle, enableWidgets, availableWidgets, compactWidgetContext, onWidgetRender, className, }: ChatProps): react_jsx_runtime.JSX.Element;
 
 declare function Command({ agentId, command: initialCommand, context, autoExecute, allowInput, placeholder, submitButtonText, variant, useMock, planMode, onPlanModeChange, enableFileUpload, onStart, onProgress, onChunk, onComplete, onError, onFileUpload, onAction, loadingText, showProgress, enableStreaming, resultRenderer, className, }: CommandProps): react_jsx_runtime.JSX.Element;
 
@@ -365,10 +440,11 @@ interface ChatResponse {
     widgets?: any[];
 }
 interface StreamChunk {
-    type: 'start' | 'thread_id' | 'content' | 'token' | 'tool_call' | 'tool_input_delta' | 'tool_use' | 'tool_result' | 'stop' | 'widget' | 'complete' | 'done' | 'error';
+    type: 'start' | 'thread_id' | 'request_id' | 'content' | 'token' | 'tool_call' | 'tool_input_delta' | 'tool_use' | 'tool_result' | 'stop' | 'widget' | 'complete' | 'done' | 'error';
     content?: string;
     widget?: any;
     thread_id?: string;
+    request_id?: string;
     tool_id?: string;
     tool_name?: string;
     error?: string;
@@ -401,6 +477,10 @@ declare class AptevaClient {
      * Get thread messages
      */
     getThreadMessages(threadId: string): Promise<ChatMessage[]>;
+    /**
+     * Cancel an in-progress request
+     */
+    cancelRequest(agentId: string, requestId: string): Promise<void>;
 }
 declare const aptevaClient: AptevaClient;
 
@@ -410,4 +490,4 @@ declare const mockMessages: Message[];
 declare const mockThreads: Thread[];
 declare const mockWidgets: Widget[];
 
-export { type Action, type ActionEvent, AptevaClient, type AptevaClientConfig, type AptevaKitControl, Button, type ButtonGroupWidget, type ButtonWidget, Card, type CardWidget, type ChartWidget, Chat, type ChatMessage, type ChatProps, type ChatRequest, type ChatResponse, Command, type CommandProps, type CommandResult, type FormField, type FormWidget, type GalleryWidget, type ImageWidget, List, type ListItem, type ListWidget, type MapWidget, type Message, Prompt, type PromptProps, type SendMessageParams, Stream, type StreamChunk, type StreamProps, type SuggestedPrompt, type Thread, Threads, type ThreadsProps, type UseAptevaKitReturn, type Widget, Widgets, type WidgetsProps, aptevaClient, cn, getThemeScript, mockMessages, mockThreads, mockWidgets };
+export { type Action, type ActionEvent, AptevaClient, type AptevaClientConfig, type AptevaKitControl, Button, type ButtonGroupWidget, type ButtonWidget, Card, type CardWidget, type ChartWidget, Chat, type ChatMessage, type ChatProps, type ChatRequest, type ChatResponse, Command, type CommandProps, type CommandResult, type FormField, type FormWidget, type GalleryWidget, type ImageWidget, List, type ListItem, type ListWidget, type MapWidget, type Message, Prompt, type PromptProps, type SendMessageParams, Stream, type StreamChunk, type StreamProps, type SuggestedPrompt, type TableColumn, type TableWidget, type Thread, Threads, type ThreadsProps, type UseAptevaKitReturn, type Widget, Widgets, type WidgetsProps, aptevaClient, cn, getThemeScript, mockMessages, mockThreads, mockWidgets };