@erdoai/types 0.1.5 → 0.1.7

package/README.md

@@ -19,6 +19,14 @@ import type {
   InvokeResult,
   InvokeParams,
   UIContentType,
+  // Token types
+  CreateTokenParams,
+  TokenResponse,
+  // Thread types
+  Thread,
+  CreateThreadParams,
+  ListThreadsResponse,
+  SendMessageParams,
 } from '@erdoai/types';
 ```
 
@@ -31,6 +39,18 @@ import type {
 - **`InvokeResult`** - Processed result with `messages`, `steps`, `events`, `result`
 - **`InvokeParams`** - Parameters for invoking an Erdo agent
 
+### Token Types
+
+- **`CreateTokenParams`** - Parameters for creating a scoped token (botKeys, datasetIds, threadIds, externalUserId)
+- **`TokenResponse`** - Token creation response (tokenId, token, expiresAt)
+
+### Thread Types
+
+- **`Thread`** - Thread object (id, name, createdAt, updatedAt)
+- **`CreateThreadParams`** - Parameters for creating a thread (name, datasetIds)
+- **`ListThreadsResponse`** - Response from listThreads (threads array)
+- **`SendMessageParams`** - Parameters for sending a message (content, botKey)
+
 ### UI Types
 
 - **`UIContentType`** - Content type hints for UI rendering (charts, tables, etc.)

package/dist/index.d.cts

@@ -60,8 +60,8 @@ type UIContentType = 'chart' | 'bar_chart' | 'line_chart' | 'pie_chart' | 'scatt
 interface InvokeResult {
     /** Whether the invocation succeeded */
     success: boolean;
-    /** Bot identifier */
-    botId?: string;
+    /** Bot key used for invocation */
+    botKey?: string;
     /** Unique invocation ID */
     invocationId?: string;
     /** The actual bot result */
@@ -129,13 +129,41 @@ interface ChartContent extends ContentItem {
 interface ErdoClientConfig {
     /** API endpoint URL */
     endpoint?: string;
-    /** Authentication token (API key) */
+    /** Authentication token (API key) - use for server-side requests */
     authToken?: string;
+    /** Scoped token - use for client-side requests (created via createToken) */
+    token?: string;
 }
 /** Interface for ErdoClient - implemented by @erdoai/server */
 interface ErdoClient {
     invoke(botKey: string, params?: InvokeParams): Promise<InvokeResult>;
     invokeStream(botKey: string, params?: InvokeParams): AsyncGenerator<SSEEvent, void, unknown>;
+    createToken?(params: CreateTokenParams): Promise<TokenResponse>;
+    createThread?(params?: CreateThreadParams): Promise<Thread>;
+    listThreads?(): Promise<ListThreadsResponse>;
+    getThread?(threadId: string): Promise<Thread>;
+    sendMessage?(threadId: string, params: SendMessageParams): AsyncGenerator<SSEEvent, void, unknown>;
+    sendMessageAndWait?(threadId: string, params: SendMessageParams): Promise<SSEEvent[]>;
+}
+interface CreateTokenParams {
+    /** Bot keys to grant access to (e.g., ["my-org.data-analyst"]) */
+    botKeys?: string[];
+    /** Dataset IDs to grant access to */
+    datasetIds?: string[];
+    /** Thread IDs to grant access to */
+    threadIds?: string[];
+    /** Optional identifier for the external user */
+    externalUserId?: string;
+    /** Token expiry in seconds (default: 3600 = 1 hour, max: 86400 = 24 hours) */
+    expiresInSeconds?: number;
+}
+interface TokenResponse {
+    /** Token ID (needed for revocation) */
+    tokenId: string;
+    /** The scoped token (only returned once) */
+    token: string;
+    /** When the token expires */
+    expiresAt: string;
 }
 interface ToolInvocation {
     invocation_id: string;
@@ -186,5 +214,26 @@ interface BotInvocationInfo {
     started_at?: string;
     completed_at?: string;
 }
+interface CreateThreadParams {
+    /** Optional thread name */
+    name?: string;
+    /** Dataset IDs to attach to the thread */
+    datasetIds?: string[];
+}
+interface Thread {
+    id: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListThreadsResponse {
+    threads: Thread[];
+}
+interface SendMessageParams {
+    /** Message content */
+    content: string;
+    /** Optional bot key to use (must be in token scope) */
+    botKey?: string;
+}
 
-export type { AxisConfig, BotInvocationInfo, ChartConfig, ChartContent, ChartSeriesConfig, ChartType, CodeExecOutputItem, ContentItem, ContentType, ErdoClient, ErdoClientConfig, InvocationMode, InvocationStatus, InvokeParams, InvokeResult, LogEntry, LogLevel, Message, MessageContent, Result, ResultOutput, SSEEvent, SSEEventMetadata, SeriesConfig, StepInfo, ToolGroup, ToolInvocation, ToolResult, UIContentType, WebParseOutput, WebSearchOutput, WebSearchResult };
+export type { AxisConfig, BotInvocationInfo, ChartConfig, ChartContent, ChartSeriesConfig, ChartType, CodeExecOutputItem, ContentItem, ContentType, CreateThreadParams, CreateTokenParams, ErdoClient, ErdoClientConfig, InvocationMode, InvocationStatus, InvokeParams, InvokeResult, ListThreadsResponse, LogEntry, LogLevel, Message, MessageContent, Result, ResultOutput, SSEEvent, SSEEventMetadata, SendMessageParams, SeriesConfig, StepInfo, Thread, TokenResponse, ToolGroup, ToolInvocation, ToolResult, UIContentType, WebParseOutput, WebSearchOutput, WebSearchResult };

package/dist/index.d.ts

@@ -60,8 +60,8 @@ type UIContentType = 'chart' | 'bar_chart' | 'line_chart' | 'pie_chart' | 'scatt
 interface InvokeResult {
     /** Whether the invocation succeeded */
     success: boolean;
-    /** Bot identifier */
-    botId?: string;
+    /** Bot key used for invocation */
+    botKey?: string;
     /** Unique invocation ID */
     invocationId?: string;
     /** The actual bot result */
@@ -129,13 +129,41 @@ interface ChartContent extends ContentItem {
 interface ErdoClientConfig {
     /** API endpoint URL */
     endpoint?: string;
-    /** Authentication token (API key) */
+    /** Authentication token (API key) - use for server-side requests */
     authToken?: string;
+    /** Scoped token - use for client-side requests (created via createToken) */
+    token?: string;
 }
 /** Interface for ErdoClient - implemented by @erdoai/server */
 interface ErdoClient {
     invoke(botKey: string, params?: InvokeParams): Promise<InvokeResult>;
     invokeStream(botKey: string, params?: InvokeParams): AsyncGenerator<SSEEvent, void, unknown>;
+    createToken?(params: CreateTokenParams): Promise<TokenResponse>;
+    createThread?(params?: CreateThreadParams): Promise<Thread>;
+    listThreads?(): Promise<ListThreadsResponse>;
+    getThread?(threadId: string): Promise<Thread>;
+    sendMessage?(threadId: string, params: SendMessageParams): AsyncGenerator<SSEEvent, void, unknown>;
+    sendMessageAndWait?(threadId: string, params: SendMessageParams): Promise<SSEEvent[]>;
+}
+interface CreateTokenParams {
+    /** Bot keys to grant access to (e.g., ["my-org.data-analyst"]) */
+    botKeys?: string[];
+    /** Dataset IDs to grant access to */
+    datasetIds?: string[];
+    /** Thread IDs to grant access to */
+    threadIds?: string[];
+    /** Optional identifier for the external user */
+    externalUserId?: string;
+    /** Token expiry in seconds (default: 3600 = 1 hour, max: 86400 = 24 hours) */
+    expiresInSeconds?: number;
+}
+interface TokenResponse {
+    /** Token ID (needed for revocation) */
+    tokenId: string;
+    /** The scoped token (only returned once) */
+    token: string;
+    /** When the token expires */
+    expiresAt: string;
 }
 interface ToolInvocation {
     invocation_id: string;
@@ -186,5 +214,26 @@ interface BotInvocationInfo {
     started_at?: string;
     completed_at?: string;
 }
+interface CreateThreadParams {
+    /** Optional thread name */
+    name?: string;
+    /** Dataset IDs to attach to the thread */
+    datasetIds?: string[];
+}
+interface Thread {
+    id: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListThreadsResponse {
+    threads: Thread[];
+}
+interface SendMessageParams {
+    /** Message content */
+    content: string;
+    /** Optional bot key to use (must be in token scope) */
+    botKey?: string;
+}
 
-export type { AxisConfig, BotInvocationInfo, ChartConfig, ChartContent, ChartSeriesConfig, ChartType, CodeExecOutputItem, ContentItem, ContentType, ErdoClient, ErdoClientConfig, InvocationMode, InvocationStatus, InvokeParams, InvokeResult, LogEntry, LogLevel, Message, MessageContent, Result, ResultOutput, SSEEvent, SSEEventMetadata, SeriesConfig, StepInfo, ToolGroup, ToolInvocation, ToolResult, UIContentType, WebParseOutput, WebSearchOutput, WebSearchResult };
+export type { AxisConfig, BotInvocationInfo, ChartConfig, ChartContent, ChartSeriesConfig, ChartType, CodeExecOutputItem, ContentItem, ContentType, CreateThreadParams, CreateTokenParams, ErdoClient, ErdoClientConfig, InvocationMode, InvocationStatus, InvokeParams, InvokeResult, ListThreadsResponse, LogEntry, LogLevel, Message, MessageContent, Result, ResultOutput, SSEEvent, SSEEventMetadata, SendMessageParams, SeriesConfig, StepInfo, Thread, TokenResponse, ToolGroup, ToolInvocation, ToolResult, UIContentType, WebParseOutput, WebSearchOutput, WebSearchResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erdoai/types",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Erdo SDK shared types",
   "type": "module",
   "main": "./dist/index.js",
@@ -35,4 +35,4 @@
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   }
-}
+}