@erdoai/types 0.1.4 → 0.1.6

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, externalUserId)
+- **`TokenResponse`** - Token creation response (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.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);

package/dist/index.d.cts

@@ -0,0 +1,235 @@
+/**
+ * Erdo TypeScript SDK Types
+ *
+ * TODO: Auto-generate from Go types via `erdo gen-ts-client`
+ * These types mirror erdo-python-sdk/erdo/_generated/types.py
+ */
+interface Message {
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+}
+interface InvokeParams {
+    /** Messages to send to the agent */
+    messages?: Message[];
+    /** Parameters to pass to the agent */
+    parameters?: Record<string, unknown>;
+    /** Dataset slugs to include (e.g. ["my-dataset"] or ["org.my-dataset"]) */
+    datasets?: string[];
+    /** Invocation mode */
+    mode?: InvocationMode;
+    /** Manual mock responses for mode="manual" */
+    manualMocks?: Record<string, unknown>;
+}
+type InvocationMode = 'live' | 'replay' | 'manual' | {
+    mode: 'replay';
+    refresh?: boolean;
+};
+interface Result {
+    status?: string;
+    parameters?: Record<string, unknown>;
+    output?: ResultOutput;
+    message?: string;
+    error?: string;
+}
+interface ResultOutput {
+    content?: ContentItem[];
+    [key: string]: unknown;
+}
+interface ContentItem {
+    id?: string;
+    content_type: ContentType | string;
+    ui_content_type?: UIContentType | {
+        Valid: boolean;
+        String: string;
+    };
+    content: unknown;
+    data?: unknown;
+    chartConfig?: unknown;
+    chartData?: unknown[];
+    tableColumns?: Array<{
+        column_name: string;
+        key: string;
+        format?: string;
+        value_type?: 'number' | 'category' | 'date';
+    }>;
+    tableData?: unknown[];
+    [key: string]: unknown;
+}
+type ContentType = 'text' | 'json' | 'code' | 'table' | 'image' | 'error';
+type UIContentType = 'chart' | 'bar_chart' | 'line_chart' | 'pie_chart' | 'scatter_chart' | 'heatmap' | 'table' | 'markdown' | string;
+interface InvokeResult {
+    /** Whether the invocation succeeded */
+    success: boolean;
+    /** Bot key used for invocation */
+    botKey?: string;
+    /** Unique invocation ID */
+    invocationId?: string;
+    /** The actual bot result */
+    result?: Result;
+    /** Messages from the invocation */
+    messages: MessageContent[];
+    /** All raw SSE events (for debugging/analysis) */
+    events: SSEEvent[];
+    /** Step execution info */
+    steps: StepInfo[];
+    /** Error message if failed */
+    error?: string;
+}
+interface MessageContent {
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+}
+interface StepInfo {
+    key: string;
+    action: string;
+    status: 'pending' | 'running' | 'completed' | 'failed';
+}
+interface SSEEvent {
+    type?: string;
+    payload?: unknown;
+    metadata?: SSEEventMetadata;
+    [key: string]: unknown;
+}
+interface SSEEventMetadata {
+    user_visibility?: 'visible' | 'hidden';
+    bot_visibility?: 'visible' | 'hidden';
+    content_type?: ContentType;
+    ui_content_type?: UIContentType;
+    message_content_id?: string;
+    [key: string]: unknown;
+}
+interface ChartConfig {
+    type: ChartType;
+    title?: string;
+    xAxis?: AxisConfig;
+    yAxis?: AxisConfig;
+    series?: SeriesConfig[];
+    chartConfig?: Record<string, ChartSeriesConfig>;
+}
+type ChartType = 'bar' | 'line' | 'pie' | 'scatter' | 'area' | 'heatmap';
+interface AxisConfig {
+    label?: string;
+    dataKey?: string;
+    type?: 'category' | 'number' | 'time';
+}
+interface SeriesConfig {
+    dataKey: string;
+    name?: string;
+    color?: string;
+}
+interface ChartSeriesConfig {
+    label: string;
+    color?: string;
+}
+interface ChartContent extends ContentItem {
+    ui_content_type: 'chart' | 'bar_chart' | 'line_chart' | 'pie_chart' | 'scatter_chart';
+    data: unknown[];
+    config?: ChartConfig;
+}
+interface ErdoClientConfig {
+    /** API endpoint URL */
+    endpoint?: string;
+    /** 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 */
+    botKeys?: string[];
+    /** Dataset IDs to grant access to */
+    datasetIds?: 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 {
+    /** The scoped token (only returned once) */
+    token: string;
+    /** When the token expires */
+    expiresAt: string;
+}
+interface ToolInvocation {
+    invocation_id: string;
+    action: string;
+    params: Record<string, unknown>;
+}
+interface ToolResult {
+    invocation_id: string;
+    result: unknown;
+}
+interface ToolGroup {
+    invocation: ToolInvocation;
+    result?: ToolResult;
+}
+type LogLevel = 'info' | 'error' | 'requires_info';
+interface LogEntry {
+    level: LogLevel;
+    message: string;
+    timestamp?: string;
+}
+interface WebSearchResult {
+    title: string;
+    description: string;
+    url: string;
+}
+interface WebSearchOutput {
+    results: WebSearchResult[];
+}
+interface WebParseOutput {
+    title: string;
+    description: string;
+    content: string;
+    url: string;
+}
+interface CodeExecOutputItem {
+    index: number;
+    level: 'output' | 'error' | 'warning';
+    message: string;
+    timestamp?: string;
+}
+type InvocationStatus = 'pending' | 'running' | 'success' | 'error' | 'requires info' | 'go to step' | 'skipped' | 'break' | 'cancelled';
+interface BotInvocationInfo {
+    id: string;
+    bot_id: string;
+    bot_key: string;
+    bot_name?: string;
+    status: InvocationStatus;
+    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, 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,37 @@ 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 */
+    botKeys?: string[];
+    /** Dataset IDs to grant access to */
+    datasetIds?: 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 {
+    /** The scoped token (only returned once) */
+    token: string;
+    /** When the token expires */
+    expiresAt: string;
 }
 interface ToolInvocation {
     invocation_id: string;
@@ -186,5 +210,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.4",
+  "version": "0.1.6",
   "description": "Erdo SDK shared types",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,7 +9,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "files": [
@@ -34,4 +35,4 @@
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   }
-}
+}