@distri/react 0.3.2 → 0.3.4

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Agent as Agent$1, DistriChatMessage, DistriBaseTool, ToolExecutionOptions, DistriMessage, DistriPart, AgentDefinition, DistriThread, ThreadListParams, AgentUsageInfo, DistriFnTool, ToolCall, ToolResult, PlanStep, DistriConfiguration, DistriClient, DistriClientConfig, SpeechToTextConfig, StreamingTranscriptionOptions, ConfigurationMeta, ConfigurationResponse, DistriEvent, ImagePart } from '@distri/core';
+import { Agent as Agent$1, DistriChatMessage, DistriBaseTool, ToolExecutionOptions, DistriMessage, DistriPart, AgentDefinition, DistriThread, ThreadListParams, AgentUsageInfo, DistriFnTool, ToolCall, ToolResult, PlanStep, TodoItem, DistriConfiguration, DistriClient, DistriClientConfig, SpeechToTextConfig, StreamingTranscriptionOptions, ConfigurationMeta, ConfigurationResponse, MessageReadStatus, MessageVoteSummary, MessageVote, DistriEvent, ImagePart } from '@distri/core';
 import * as React$1 from 'react';
 import React__default, { ReactNode } from 'react';
 import * as zustand from 'zustand';
@@ -83,15 +83,22 @@ interface UseThreadsOptions {
 }
 declare function useThreads(options?: UseThreadsOptions): UseThreadsResult;
 /**
- * Hook to get agents sorted by usage (thread count)
+ * Hook to get agents sorted by usage (thread count).
+ * Includes all registered agents, even those with 0 threads.
  */
 interface UseAgentsByUsageResult {
     agents: AgentUsageInfo[];
     loading: boolean;
     error: Error | null;
     refetch: () => Promise<void>;
+    search: string;
+    setSearch: (search: string) => void;
 }
-declare function useAgentsByUsage(): UseAgentsByUsageResult;
+interface UseAgentsByUsageOptions {
+    /** Initial search query */
+    search?: string;
+}
+declare function useAgentsByUsage(options?: UseAgentsByUsageOptions): UseAgentsByUsageResult;
 interface UseThreadMessagesOptions {
     threadId: string | null;
 }
@@ -235,6 +242,7 @@ interface ChatState {
     browserSessionId?: string;
     browserViewerUrl?: string;
     browserStreamUrl?: string;
+    todos: TodoItem[];
 }
 type ChatStateTool = DistriAnyTool & {
     executionType: 'backend' | 'external';
@@ -248,6 +256,7 @@ interface ChatStateStore extends ChatState {
     setCurrentThought: (thought: string | undefined) => void;
     setBrowserSession: (sessionId: string, viewerUrl?: string, streamUrl?: string) => void;
     clearBrowserSession: () => void;
+    setTodos: (todos: TodoItem[]) => void;
     addMessage: (message: DistriChatMessage) => void;
     processMessage: (message: DistriChatMessage, isFromStream?: boolean) => void;
     clearAllStates: () => void;
@@ -263,6 +272,7 @@ interface ChatStateStore extends ChatState {
     completeTool: (toolCall: ToolCall, result: ToolResult) => Promise<void>;
     executeTool: (toolCall: ToolCall, distriTool: DistriAnyTool) => void;
     hasPendingToolCalls: () => boolean;
+    failAllPendingToolCalls: (errorMessage: string) => void;
     clearToolResults: () => void;
     getExternalToolResponses: () => ToolResult[];
     getCurrentTask: () => TaskState | null;
@@ -391,6 +401,16 @@ interface ChatProps {
     className?: string;
     agentId?: string;
     enableHistory?: boolean;
+    /**
+     * Enable debug mode to show developer messages in the chat.
+     * Developer messages are hidden by default.
+     */
+    debug?: boolean;
+    /**
+     * Enable message feedback (voting) UI on assistant messages.
+     * Shows thumbs up/down buttons for rating responses.
+     */
+    enableFeedback?: boolean;
 }
 declare const ChatInner: React__default.ForwardRefExoticComponent<ChatProps & React__default.RefAttributes<ChatInstance>>;
 interface ChatContainerProps extends ChatProps {
@@ -439,7 +459,6 @@ interface ChatInputProps {
     onSend: (content: string | DistriPart[]) => void;
     onStop?: () => void;
     browserEnabled?: boolean;
-    /** Whether browser has an active session (used for highlighting) */
     browserHasSession?: boolean;
     onToggleBrowser?: (enabled: boolean) => void;
     placeholder?: string;
@@ -514,11 +533,42 @@ interface AuthLoadingProps {
 }
 declare const AuthLoading: React__default.FC<AuthLoadingProps>;
 
+/**
+ * AskFollowUp - Interactive stepper component for agent follow-up questions
+ *
+ * This tool allows agents to ask a series of questions to the user.
+ * Questions are rendered as a stepper, one at a time.
+ * User answers are collected and sent back to the agent.
+ */
+
+interface FollowUpQuestion {
+    id: string;
+    question: string;
+    type: 'text' | 'select' | 'multiselect' | 'boolean';
+    options?: string[];
+    placeholder?: string;
+    required?: boolean;
+    default?: string | string[] | boolean;
+}
+interface AskFollowUpInput {
+    title?: string;
+    description?: string;
+    questions: FollowUpQuestion[];
+}
+interface AskFollowUpOutput {
+    answers: Record<string, string | string[] | boolean>;
+    completed: boolean;
+}
+declare const ASK_FOLLOW_UP_TOOL_NAME = "ask_follow_up";
+declare function createAskFollowUpTool(): DistriUiTool;
+
 interface DistriContextValue {
     client: DistriClient | null;
     error: Error | null;
     isLoading: boolean;
     token?: string | null;
+    workspaceId?: string | null;
+    setWorkspaceId?: (workspaceId: string | null) => void;
 }
 declare const DistriContext: React$1.Context<DistriContextValue>;
 interface DistriProviderProps {
@@ -555,6 +605,11 @@ declare function useDistriToken(): {
     token: string | null | undefined;
     isLoading: boolean;
 };
+declare function useWorkspace(): {
+    workspaceId: string | null | undefined;
+    setWorkspaceId: ((workspaceId: string | null) => void) | undefined;
+    isLoading: boolean;
+};
 
 type AuthStatus = 'idle' | 'loading' | 'authenticated' | 'error';
 interface DistriAuthContextValue {
@@ -658,6 +713,106 @@ type UseConfigurationResult = {
 };
 declare function useConfiguration(): UseConfigurationResult;
 
+interface UseMessageReadStatusOptions {
+    threadId: string;
+    messageId: string;
+    /**
+     * Whether to fetch the read status automatically on mount.
+     * Default: false
+     */
+    autoFetch?: boolean;
+}
+interface UseMessageReadStatusResult {
+    readStatus: MessageReadStatus | null;
+    loading: boolean;
+    error: Error | null;
+    markAsRead: () => Promise<MessageReadStatus | null>;
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to manage read status for a specific message
+ */
+declare function useMessageReadStatus(options: UseMessageReadStatusOptions): UseMessageReadStatusResult;
+interface UseThreadReadStatusOptions {
+    threadId: string;
+    /**
+     * Whether to fetch the read status automatically on mount.
+     * Default: true
+     */
+    enabled?: boolean;
+}
+interface UseThreadReadStatusResult {
+    readStatuses: MessageReadStatus[];
+    loading: boolean;
+    error: Error | null;
+    /**
+     * Check if a specific message has been read
+     */
+    isRead: (messageId: string) => boolean;
+    /**
+     * Mark a specific message as read
+     */
+    markAsRead: (messageId: string) => Promise<MessageReadStatus | null>;
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to manage read status for all messages in a thread
+ */
+declare function useThreadReadStatus(options: UseThreadReadStatusOptions): UseThreadReadStatusResult;
+interface UseMessageVoteOptions {
+    threadId: string;
+    messageId: string;
+    /**
+     * Whether to fetch the vote summary automatically on mount.
+     * Default: false
+     */
+    autoFetch?: boolean;
+}
+interface UseMessageVoteResult {
+    summary: MessageVoteSummary | null;
+    loading: boolean;
+    error: Error | null;
+    /**
+     * Upvote the message
+     */
+    upvote: () => Promise<MessageVote | null>;
+    /**
+     * Downvote the message with a required comment
+     */
+    downvote: (comment: string) => Promise<MessageVote | null>;
+    /**
+     * Remove the current user's vote
+     */
+    removeVote: () => Promise<void>;
+    /**
+     * Refetch the vote summary
+     */
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to manage voting on a specific message
+ */
+declare function useMessageVote(options: UseMessageVoteOptions): UseMessageVoteResult;
+interface UseMessageVotesOptions {
+    threadId: string;
+    messageId: string;
+    /**
+     * Whether to fetch the votes automatically on mount.
+     * Default: false
+     */
+    enabled?: boolean;
+}
+interface UseMessageVotesResult {
+    votes: MessageVote[];
+    loading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to get all votes for a message (useful for admin/analytics)
+ */
+declare function useMessageVotes(options: UseMessageVotesOptions): UseMessageVotesResult;
+
 /**
  * Wraps a DistriFnTool as a DistriUiTool with DefaultToolActions component
  */
@@ -861,17 +1016,87 @@ interface ImageRendererProps {
 }
 declare const ImageRenderer: React__default.FC<ImageRendererProps>;
 
+interface MessageFeedbackProps {
+    threadId: string;
+    messageId: string;
+    /** Show the component in compact mode (icons only) */
+    compact?: boolean;
+    /** CSS class name */
+    className?: string;
+    /** Called when a vote is submitted */
+    onVote?: (voteType: 'upvote' | 'downvote', comment?: string) => void;
+}
+/**
+ * Message feedback component with thumbs up/down voting.
+ * Downvotes require a comment explaining the issue.
+ */
+declare const MessageFeedback: React__default.FC<MessageFeedbackProps>;
+
+interface MessageReadContextValue {
+    /** Check if a message has been read */
+    isRead: (messageId: string) => boolean;
+    /** Mark a message as read (will skip if already read) */
+    markAsRead: (messageId: string) => Promise<void>;
+    /** Set of message IDs that have been read */
+    readMessageIds: Set<string>;
+    /** Whether the initial fetch is loading */
+    isLoading: boolean;
+}
+interface MessageReadProviderProps {
+    threadId: string;
+    /** Whether to enable read tracking */
+    enabled?: boolean;
+    children: React__default.ReactNode;
+}
+/**
+ * Provider that manages read status for all messages in a thread.
+ * Fetches existing read statuses on mount and provides methods to check/mark messages as read.
+ */
+declare const MessageReadProvider: React__default.FC<MessageReadProviderProps>;
+/**
+ * Hook to access message read context
+ */
+declare const useMessageReadContext: () => MessageReadContextValue | null;
+
+interface MessageReadTrackerProps {
+    messageId: string;
+    /** Only track read status for this message if enabled */
+    enabled?: boolean;
+    /** Threshold for intersection (0-1). Default 0.5 means 50% visible */
+    threshold?: number;
+    /** Delay in ms before marking as read (prevents marking during fast scroll) */
+    delay?: number;
+    children: React__default.ReactNode;
+}
+/**
+ * Wrapper component that tracks when a message comes into view
+ * and automatically marks it as read using the MessageReadContext.
+ *
+ * Must be used inside a MessageReadProvider.
+ */
+declare const MessageReadTracker: React__default.FC<MessageReadTrackerProps>;
+
 interface MessageRendererProps {
     message: DistriChatMessage;
     index: number;
     isExpanded?: boolean;
     onToggle?: () => void;
     toolRenderers?: ToolRendererMap;
+    /** Enable debug mode to show developer messages */
+    debug?: boolean;
+    /** Thread ID for feedback functionality */
+    threadId?: string;
+    /** Enable message feedback (voting) UI */
+    enableFeedback?: boolean;
 }
-declare function MessageRenderer({ message, index, toolRenderers, }: MessageRendererProps): React__default.ReactNode;
+declare function MessageRenderer({ message, index, toolRenderers, debug, threadId, enableFeedback, }: MessageRendererProps): React__default.ReactNode;
 
 interface StepBasedRendererProps {
     message: DistriMessage;
+    /** Thread ID for feedback functionality */
+    threadId?: string;
+    /** Enable message feedback (voting) UI */
+    enableFeedback?: boolean;
 }
 declare const StepBasedRenderer: React__default.FC<StepBasedRendererProps>;
 
@@ -893,6 +1118,13 @@ interface ExtractedContent {
 }
 declare function extractContent(message: DistriMessage | DistriEvent): ExtractedContent;
 
+interface TodosDisplayProps {
+    todos: TodoItem[];
+    className?: string;
+    title?: string;
+}
+declare const TodosDisplay: React__default.FC<TodosDisplayProps>;
+
 declare const TypingIndicator: React__default.FC;
 
 interface UserMessageRendererProps {
@@ -902,4 +1134,4 @@ interface UserMessageRendererProps {
 }
 declare const UserMessageRenderer: React__default.FC<UserMessageRendererProps>;
 
-export { AgentSelect, AppSidebar, AssistantMessageRenderer, type AssistantMessageRendererProps, type AttachedImage, AuthLoading, type AuthStatus, Badge, BrowserPreviewPanel, BrowserViewport, type BrowserViewportProps, Button, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Chat, type ChatContainerProps, type ChatCustomRenderers, type ChatEmptyStateCategory, type ChatEmptyStateController, type ChatEmptyStateOptions, type ChatEmptyStateStarter, ChatInner, ChatInput, type ChatInputProps, type ChatInstance, type ChatProps, type ChatState, type ChatStateStore, ConfigurationPanel, DialogRoot as Dialog, DialogContent, DialogHeader, DialogTitle, DialogTrigger, type DistriAnyTool, DistriAuthProvider, DistriContext, DistriProvider, type DistriUiTool, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, type ExtractedContent, ImageRenderer, type ImageRendererProps, Input, LoadingAnimation, type LoadingAnimationConfig, type LoadingAnimationPreset, type LoadingAnimationProps, LoadingShimmer, MessageRenderer, type MessageRendererProps, type ModelOption, type PlanState, Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Separator, Sheet, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupAction, SidebarGroupContent, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarMenu, SidebarMenuAction, SidebarMenuBadge, SidebarMenuButton, SidebarMenuItem, SidebarMenuSkeleton, SidebarMenuSub, SidebarMenuSubButton, SidebarMenuSubItem, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, Skeleton, StepBasedRenderer, type StepBasedRendererProps, type StepState, type StreamingIndicator, StreamingTextRenderer, type StreamingTtsOptions, type TaskState, Textarea, ThemeProvider, ThemeToggle, ThinkingRenderer, type ThinkingRendererProps, type ToolCallState, type ToolCallStatus, type ToolRendererMap, type ToolRendererProps, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger, type TtsConfig, type TtsRequest, TypingIndicator, type UiToolProps, type UseAgentOptions, type UseAgentResult, type UseAgentsByUsageResult, type UseAgentsResult, type UseChatMessagesOptions, type UseChatMessagesReturn, type UseChatOptions, type UseChatReturn, type UseConfigurationResult, type UseThreadMessagesOptions, type UseThreadsOptions, type UseThreadsResult, UserMessageRenderer, type UserMessageRendererProps, VoiceInput, type VoiceInputProps, extractContent, useAgent, useAgentDefinitions, useAgentsByUsage, useChat, useChatMessages, useChatStateStore, useConfiguration, useDistri, useDistriAuth, useDistriToken, useSidebar, useSpeechToText, useTheme, useThreads, useTts, wrapFnToolAsUiTool, wrapTools };
+export { ASK_FOLLOW_UP_TOOL_NAME, AgentSelect, AppSidebar, type AskFollowUpInput, type AskFollowUpOutput, AssistantMessageRenderer, type AssistantMessageRendererProps, type AttachedImage, AuthLoading, type AuthStatus, Badge, BrowserPreviewPanel, BrowserViewport, type BrowserViewportProps, Button, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Chat, type ChatContainerProps, type ChatCustomRenderers, type ChatEmptyStateCategory, type ChatEmptyStateController, type ChatEmptyStateOptions, type ChatEmptyStateStarter, ChatInner, ChatInput, type ChatInputProps, type ChatInstance, type ChatProps, type ChatState, type ChatStateStore, ConfigurationPanel, DialogRoot as Dialog, DialogContent, DialogHeader, DialogTitle, DialogTrigger, type DistriAnyTool, DistriAuthProvider, DistriContext, DistriProvider, type DistriUiTool, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, type ExtractedContent, type FollowUpQuestion, ImageRenderer, type ImageRendererProps, Input, LoadingAnimation, type LoadingAnimationConfig, type LoadingAnimationPreset, type LoadingAnimationProps, LoadingShimmer, MessageFeedback, type MessageFeedbackProps, MessageReadProvider, type MessageReadProviderProps, MessageReadTracker, type MessageReadTrackerProps, MessageRenderer, type MessageRendererProps, type ModelOption, type PlanState, Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Separator, Sheet, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupAction, SidebarGroupContent, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarMenu, SidebarMenuAction, SidebarMenuBadge, SidebarMenuButton, SidebarMenuItem, SidebarMenuSkeleton, SidebarMenuSub, SidebarMenuSubButton, SidebarMenuSubItem, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, Skeleton, StepBasedRenderer, type StepBasedRendererProps, type StepState, type StreamingIndicator, StreamingTextRenderer, type StreamingTtsOptions, type TaskState, Textarea, ThemeProvider, ThemeToggle, ThinkingRenderer, type ThinkingRendererProps, TodosDisplay, type TodosDisplayProps, type ToolCallState, type ToolCallStatus, type ToolRendererMap, type ToolRendererProps, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger, type TtsConfig, type TtsRequest, TypingIndicator, type UiToolProps, type UseAgentOptions, type UseAgentResult, type UseAgentsByUsageOptions, type UseAgentsByUsageResult, type UseAgentsResult, type UseChatMessagesOptions, type UseChatMessagesReturn, type UseChatOptions, type UseChatReturn, type UseConfigurationResult, type UseMessageReadStatusOptions, type UseMessageReadStatusResult, type UseMessageVoteOptions, type UseMessageVoteResult, type UseMessageVotesOptions, type UseMessageVotesResult, type UseThreadMessagesOptions, type UseThreadReadStatusOptions, type UseThreadReadStatusResult, type UseThreadsOptions, type UseThreadsResult, UserMessageRenderer, type UserMessageRendererProps, VoiceInput, type VoiceInputProps, createAskFollowUpTool, extractContent, useAgent, useAgentDefinitions, useAgentsByUsage, useChat, useChatMessages, useChatStateStore, useConfiguration, useDistri, useDistriAuth, useDistriToken, useMessageReadContext, useMessageReadStatus, useMessageVote, useMessageVotes, useSidebar, useSpeechToText, useTheme, useThreadReadStatus, useThreads, useTts, useWorkspace, wrapFnToolAsUiTool, wrapTools };