@erdoai/ui 0.1.23 → 0.1.24

package/dist/index.d.cts

@@ -7,6 +7,13 @@ import * as RechartsPrimitive from 'recharts';
 import { UseQueryResult } from '@tanstack/react-query';
 import { ClassValue } from 'clsx';
 
+/**
+ * Dataset details returned by getDatasetDetails
+ */
+interface DatasetDetails {
+    id: string;
+    name: string;
+}
 /**
  * Interface for custom data fetching implementations.
  * Use this when you need to override the default REST API behavior,
@@ -17,6 +24,16 @@ import { ClassValue } from 'clsx';
  */
 interface DataFetcher {
     fetchDatasetContents: (slug: string, invocationId: string) => Promise<any[]>;
+    /**
+     * Get dataset details (id and name) by slug.
+     * Used by DatasetDownload component to resolve slug to downloadable dataset.
+     */
+    getDatasetDetails?: (slug: string, threadId: string) => Promise<DatasetDetails | null>;
+    /**
+     * Download a dataset file by ID.
+     * Returns a Blob that can be saved as a file.
+     */
+    downloadDataset?: (datasetId: string) => Promise<Blob>;
 }
 /**
  * Configuration for the ErdoProvider.
@@ -27,6 +44,11 @@ interface ErdoProviderConfig {
      * Used by default REST implementation in hooks.
      */
     baseUrl: string;
+    /**
+     * Optional thread ID for dataset operations.
+     * Used by DatasetDownload to resolve dataset slugs.
+     */
+    threadId?: string;
     /**
      * Optional auth token for API calls.
      * Will be sent as Bearer token in Authorization header.
@@ -1151,6 +1173,29 @@ interface StatusSpinnerProps {
  */
 declare function StatusSpinner({ status, color, size, className }: StatusSpinnerProps): react_jsx_runtime.JSX.Element;
 
+interface DatasetDownloadProps {
+    /** Dataset slug to download */
+    slug: string;
+    /** Invocation ID (used for context, may be needed by some backends) */
+    invocationId?: string;
+    /** Optional thread ID override (falls back to provider's threadId) */
+    threadId?: string;
+    /** Optional class name for styling */
+    className?: string;
+}
+/**
+ * A download button component for datasets.
+ *
+ * Uses the DataFetcher from ErdoProvider if available, otherwise falls back
+ * to REST API calls using baseUrl and auth tokens.
+ *
+ * @example
+ * ```tsx
+ * <DatasetDownload slug="my-dataset" invocationId="abc123" />
+ * ```
+ */
+declare function DatasetDownload({ slug, invocationId: _invocationId, threadId: threadIdProp, className, }: DatasetDownloadProps): react_jsx_runtime.JSX.Element | null;
+
 interface ZoomState {
     refAreaLeft: number | null;
     refAreaRight: number | null;
@@ -1268,11 +1313,30 @@ interface UseThreadReturn {
  * For server-side processing where you don't need React rendering,
  * use `ErdoClient.invoke()` or `ErdoClient.invokeStream()` directly.
  *
- * ## Loading message history
+ * ## Persisting message history
+ *
+ * This hook focuses on streaming new messages. For chat history, we recommend
+ * storing messages in your own database as they complete:
+ *
+ * ```tsx
+ * const { streamingContents, sendMessage } = useThread({
+ *   botKey: 'org.my-bot',
+ *   onFinish: () => {
+ *     // Save to your database when message completes
+ *     await saveMessageToDb(threadId, streamingContents);
+ *   },
+ * });
+ *
+ * // Load history from your database
+ * const { data: history } = useQuery({
+ *   queryKey: ['messages', threadId],
+ *   queryFn: () => fetchMessagesFromDb(threadId),
+ * });
+ * ```
+ *
+ * This gives you full control over your data and avoids extra API calls.
  *
- * This hook focuses on streaming new messages. To load existing thread messages
- * (chat history), use `client.getThreadMessages(threadId)` with React Query or
- * your preferred data fetching solution:
+ * Alternatively, you can fetch history from Erdo using `client.getThreadMessages()`:
  *
  * ```tsx
  * const { data: history } = useQuery({
@@ -1404,4 +1468,4 @@ declare function handleIncrementalMixedJsonParsing(outputContent: MessageContent
  */
 declare function handleSSEEvent(eventType: string, event: SSEEventData, path: string[], threadID: string, activeMessagesByID: Record<string, MessageWithContents>, currentEntity?: Entity | null, parents?: Entity[], entityIds?: Record<string, string>): Entity | null;
 
-export { BarChart, type BaseChartProps, type BotInvocation, BotInvocationContent, type BotInvocationContentData, type BotInvocationContentProps, type BotInvocationData, type BotInvocationEventInfo, type BotInvocationStatusInfo, Chart, type ChartConfig, ChartContainer, ChartContent, type ChartContentProps, ChartLegend, ChartLegendContent, ChartStyle, ChartTooltip, ChartTooltipContent, CodeexecContent, type CodeexecContentProps, CodegenContent, type CodegenContentProps, CollapsibleCodeBlock, type CollapsibleCodeBlockProps, Content, type ContentChartConfig, type ContentChunk, type ContentComponentProps, type ContentProps, type ContentType, type DataFetcher, DatasetChart, type DatasetChartProps, DatasetTable, type DatasetTableProps, type Entity, type EntityType, ErdoProvider, type ErdoProviderConfig, type ErdoProviderProps, ErdoUI, type ErdoUIProps, ErrorBoundary, ExecutionStatus, ExpandableOutputContent, type ExpandableOutputContentProps, HeatmapChart, InvocationEvent, type InvocationEventProps, InvocationEvents, type InvocationEventsProps, InvocationStatus, JSONStreamParser, type JSONValue, JsonContent, type JsonContentProps, LineChart, Log, LogContent, type LogContentProps, type LogProps, MarkdownContent, type MarkdownContentProps, type Message, type MessageContent, type MessageStreamingState, type MessageWithContents, Output, type OutputContent, type OutputProps, type OutputWithContents, PieChart, type ResolvedBotInvocation, type ResultHandler, type SSEEventData, ScatterChart, type SpinnerStatus, SqlContent, type SqlContentProps, type Status, type StatusEvent, StatusSpinner, type StatusSpinnerProps, StderrText, StdoutText, StdwarnText, type Step, StepInvocation, type StepInvocationProps, StepInvocationStatus, type StepInvocationStatusProps, StreamingLoader, TableContent, type TableContentProps, TextContent, type TextContentProps, ThinkingContent, type ThinkingContentProps, ToolGroupContent, type ToolGroupContentProps, type UseThreadOptions, type UseThreadReturn, WebParseContent, type WebParseContentProps, WebSearchContent, type WebSearchContentProps, type WrapperType, WritingLoader, cn, extractContentItems, formatValue, handleIncrementalMixedJsonParsing, handleSSEEvent, isJsonLike, isParsingComplete, isParsingInProgress, isWhitespaceChar, parseCompleteJson, parseMixedJson, parseToDate, resolveKeyFromData, toSnakeCase, useChartZoom, useDatasetContents, useErdoConfig, useErdoConfigOptional, useMultipleDatasetContents, useThread };
+export { BarChart, type BaseChartProps, type BotInvocation, BotInvocationContent, type BotInvocationContentData, type BotInvocationContentProps, type BotInvocationData, type BotInvocationEventInfo, type BotInvocationStatusInfo, Chart, type ChartConfig, ChartContainer, ChartContent, type ChartContentProps, ChartLegend, ChartLegendContent, ChartStyle, ChartTooltip, ChartTooltipContent, CodeexecContent, type CodeexecContentProps, CodegenContent, type CodegenContentProps, CollapsibleCodeBlock, type CollapsibleCodeBlockProps, Content, type ContentChartConfig, type ContentChunk, type ContentComponentProps, type ContentProps, type ContentType, type DataFetcher, DatasetChart, type DatasetChartProps, type DatasetDetails, DatasetDownload, type DatasetDownloadProps, DatasetTable, type DatasetTableProps, type Entity, type EntityType, ErdoProvider, type ErdoProviderConfig, type ErdoProviderProps, ErdoUI, type ErdoUIProps, ErrorBoundary, ExecutionStatus, ExpandableOutputContent, type ExpandableOutputContentProps, HeatmapChart, InvocationEvent, type InvocationEventProps, InvocationEvents, type InvocationEventsProps, InvocationStatus, JSONStreamParser, type JSONValue, JsonContent, type JsonContentProps, LineChart, Log, LogContent, type LogContentProps, type LogProps, MarkdownContent, type MarkdownContentProps, type Message, type MessageContent, type MessageStreamingState, type MessageWithContents, Output, type OutputContent, type OutputProps, type OutputWithContents, PieChart, type ResolvedBotInvocation, type ResultHandler, type SSEEventData, ScatterChart, type SpinnerStatus, SqlContent, type SqlContentProps, type Status, type StatusEvent, StatusSpinner, type StatusSpinnerProps, StderrText, StdoutText, StdwarnText, type Step, StepInvocation, type StepInvocationProps, StepInvocationStatus, type StepInvocationStatusProps, StreamingLoader, TableContent, type TableContentProps, TextContent, type TextContentProps, ThinkingContent, type ThinkingContentProps, ToolGroupContent, type ToolGroupContentProps, type UseThreadOptions, type UseThreadReturn, WebParseContent, type WebParseContentProps, WebSearchContent, type WebSearchContentProps, type WrapperType, WritingLoader, cn, extractContentItems, formatValue, handleIncrementalMixedJsonParsing, handleSSEEvent, isJsonLike, isParsingComplete, isParsingInProgress, isWhitespaceChar, parseCompleteJson, parseMixedJson, parseToDate, resolveKeyFromData, toSnakeCase, useChartZoom, useDatasetContents, useErdoConfig, useErdoConfigOptional, useMultipleDatasetContents, useThread };

package/dist/index.d.ts

@@ -7,6 +7,13 @@ import * as RechartsPrimitive from 'recharts';
 import { UseQueryResult } from '@tanstack/react-query';
 import { ClassValue } from 'clsx';
 
+/**
+ * Dataset details returned by getDatasetDetails
+ */
+interface DatasetDetails {
+    id: string;
+    name: string;
+}
 /**
  * Interface for custom data fetching implementations.
  * Use this when you need to override the default REST API behavior,
@@ -17,6 +24,16 @@ import { ClassValue } from 'clsx';
  */
 interface DataFetcher {
     fetchDatasetContents: (slug: string, invocationId: string) => Promise<any[]>;
+    /**
+     * Get dataset details (id and name) by slug.
+     * Used by DatasetDownload component to resolve slug to downloadable dataset.
+     */
+    getDatasetDetails?: (slug: string, threadId: string) => Promise<DatasetDetails | null>;
+    /**
+     * Download a dataset file by ID.
+     * Returns a Blob that can be saved as a file.
+     */
+    downloadDataset?: (datasetId: string) => Promise<Blob>;
 }
 /**
  * Configuration for the ErdoProvider.
@@ -27,6 +44,11 @@ interface ErdoProviderConfig {
      * Used by default REST implementation in hooks.
      */
     baseUrl: string;
+    /**
+     * Optional thread ID for dataset operations.
+     * Used by DatasetDownload to resolve dataset slugs.
+     */
+    threadId?: string;
     /**
      * Optional auth token for API calls.
      * Will be sent as Bearer token in Authorization header.
@@ -1151,6 +1173,29 @@ interface StatusSpinnerProps {
  */
 declare function StatusSpinner({ status, color, size, className }: StatusSpinnerProps): react_jsx_runtime.JSX.Element;
 
+interface DatasetDownloadProps {
+    /** Dataset slug to download */
+    slug: string;
+    /** Invocation ID (used for context, may be needed by some backends) */
+    invocationId?: string;
+    /** Optional thread ID override (falls back to provider's threadId) */
+    threadId?: string;
+    /** Optional class name for styling */
+    className?: string;
+}
+/**
+ * A download button component for datasets.
+ *
+ * Uses the DataFetcher from ErdoProvider if available, otherwise falls back
+ * to REST API calls using baseUrl and auth tokens.
+ *
+ * @example
+ * ```tsx
+ * <DatasetDownload slug="my-dataset" invocationId="abc123" />
+ * ```
+ */
+declare function DatasetDownload({ slug, invocationId: _invocationId, threadId: threadIdProp, className, }: DatasetDownloadProps): react_jsx_runtime.JSX.Element | null;
+
 interface ZoomState {
     refAreaLeft: number | null;
     refAreaRight: number | null;
@@ -1268,11 +1313,30 @@ interface UseThreadReturn {
  * For server-side processing where you don't need React rendering,
  * use `ErdoClient.invoke()` or `ErdoClient.invokeStream()` directly.
  *
- * ## Loading message history
+ * ## Persisting message history
+ *
+ * This hook focuses on streaming new messages. For chat history, we recommend
+ * storing messages in your own database as they complete:
+ *
+ * ```tsx
+ * const { streamingContents, sendMessage } = useThread({
+ *   botKey: 'org.my-bot',
+ *   onFinish: () => {
+ *     // Save to your database when message completes
+ *     await saveMessageToDb(threadId, streamingContents);
+ *   },
+ * });
+ *
+ * // Load history from your database
+ * const { data: history } = useQuery({
+ *   queryKey: ['messages', threadId],
+ *   queryFn: () => fetchMessagesFromDb(threadId),
+ * });
+ * ```
+ *
+ * This gives you full control over your data and avoids extra API calls.
  *
- * This hook focuses on streaming new messages. To load existing thread messages
- * (chat history), use `client.getThreadMessages(threadId)` with React Query or
- * your preferred data fetching solution:
+ * Alternatively, you can fetch history from Erdo using `client.getThreadMessages()`:
  *
  * ```tsx
  * const { data: history } = useQuery({
@@ -1404,4 +1468,4 @@ declare function handleIncrementalMixedJsonParsing(outputContent: MessageContent
  */
 declare function handleSSEEvent(eventType: string, event: SSEEventData, path: string[], threadID: string, activeMessagesByID: Record<string, MessageWithContents>, currentEntity?: Entity | null, parents?: Entity[], entityIds?: Record<string, string>): Entity | null;
 
-export { BarChart, type BaseChartProps, type BotInvocation, BotInvocationContent, type BotInvocationContentData, type BotInvocationContentProps, type BotInvocationData, type BotInvocationEventInfo, type BotInvocationStatusInfo, Chart, type ChartConfig, ChartContainer, ChartContent, type ChartContentProps, ChartLegend, ChartLegendContent, ChartStyle, ChartTooltip, ChartTooltipContent, CodeexecContent, type CodeexecContentProps, CodegenContent, type CodegenContentProps, CollapsibleCodeBlock, type CollapsibleCodeBlockProps, Content, type ContentChartConfig, type ContentChunk, type ContentComponentProps, type ContentProps, type ContentType, type DataFetcher, DatasetChart, type DatasetChartProps, DatasetTable, type DatasetTableProps, type Entity, type EntityType, ErdoProvider, type ErdoProviderConfig, type ErdoProviderProps, ErdoUI, type ErdoUIProps, ErrorBoundary, ExecutionStatus, ExpandableOutputContent, type ExpandableOutputContentProps, HeatmapChart, InvocationEvent, type InvocationEventProps, InvocationEvents, type InvocationEventsProps, InvocationStatus, JSONStreamParser, type JSONValue, JsonContent, type JsonContentProps, LineChart, Log, LogContent, type LogContentProps, type LogProps, MarkdownContent, type MarkdownContentProps, type Message, type MessageContent, type MessageStreamingState, type MessageWithContents, Output, type OutputContent, type OutputProps, type OutputWithContents, PieChart, type ResolvedBotInvocation, type ResultHandler, type SSEEventData, ScatterChart, type SpinnerStatus, SqlContent, type SqlContentProps, type Status, type StatusEvent, StatusSpinner, type StatusSpinnerProps, StderrText, StdoutText, StdwarnText, type Step, StepInvocation, type StepInvocationProps, StepInvocationStatus, type StepInvocationStatusProps, StreamingLoader, TableContent, type TableContentProps, TextContent, type TextContentProps, ThinkingContent, type ThinkingContentProps, ToolGroupContent, type ToolGroupContentProps, type UseThreadOptions, type UseThreadReturn, WebParseContent, type WebParseContentProps, WebSearchContent, type WebSearchContentProps, type WrapperType, WritingLoader, cn, extractContentItems, formatValue, handleIncrementalMixedJsonParsing, handleSSEEvent, isJsonLike, isParsingComplete, isParsingInProgress, isWhitespaceChar, parseCompleteJson, parseMixedJson, parseToDate, resolveKeyFromData, toSnakeCase, useChartZoom, useDatasetContents, useErdoConfig, useErdoConfigOptional, useMultipleDatasetContents, useThread };
+export { BarChart, type BaseChartProps, type BotInvocation, BotInvocationContent, type BotInvocationContentData, type BotInvocationContentProps, type BotInvocationData, type BotInvocationEventInfo, type BotInvocationStatusInfo, Chart, type ChartConfig, ChartContainer, ChartContent, type ChartContentProps, ChartLegend, ChartLegendContent, ChartStyle, ChartTooltip, ChartTooltipContent, CodeexecContent, type CodeexecContentProps, CodegenContent, type CodegenContentProps, CollapsibleCodeBlock, type CollapsibleCodeBlockProps, Content, type ContentChartConfig, type ContentChunk, type ContentComponentProps, type ContentProps, type ContentType, type DataFetcher, DatasetChart, type DatasetChartProps, type DatasetDetails, DatasetDownload, type DatasetDownloadProps, DatasetTable, type DatasetTableProps, type Entity, type EntityType, ErdoProvider, type ErdoProviderConfig, type ErdoProviderProps, ErdoUI, type ErdoUIProps, ErrorBoundary, ExecutionStatus, ExpandableOutputContent, type ExpandableOutputContentProps, HeatmapChart, InvocationEvent, type InvocationEventProps, InvocationEvents, type InvocationEventsProps, InvocationStatus, JSONStreamParser, type JSONValue, JsonContent, type JsonContentProps, LineChart, Log, LogContent, type LogContentProps, type LogProps, MarkdownContent, type MarkdownContentProps, type Message, type MessageContent, type MessageStreamingState, type MessageWithContents, Output, type OutputContent, type OutputProps, type OutputWithContents, PieChart, type ResolvedBotInvocation, type ResultHandler, type SSEEventData, ScatterChart, type SpinnerStatus, SqlContent, type SqlContentProps, type Status, type StatusEvent, StatusSpinner, type StatusSpinnerProps, StderrText, StdoutText, StdwarnText, type Step, StepInvocation, type StepInvocationProps, StepInvocationStatus, type StepInvocationStatusProps, StreamingLoader, TableContent, type TableContentProps, TextContent, type TextContentProps, ThinkingContent, type ThinkingContentProps, ToolGroupContent, type ToolGroupContentProps, type UseThreadOptions, type UseThreadReturn, WebParseContent, type WebParseContentProps, WebSearchContent, type WebSearchContentProps, type WrapperType, WritingLoader, cn, extractContentItems, formatValue, handleIncrementalMixedJsonParsing, handleSSEEvent, isJsonLike, isParsingComplete, isParsingInProgress, isWhitespaceChar, parseCompleteJson, parseMixedJson, parseToDate, resolveKeyFromData, toSnakeCase, useChartZoom, useDatasetContents, useErdoConfig, useErdoConfigOptional, useMultipleDatasetContents, useThread };