@seaverse/conversation-sdk 0.2.0 → 0.2.1

package/README.md

@@ -1,18 +1,18 @@
 # @seaverse/conversation-sdk
 
-SeaVerse Conversation SDK - 用于对话（Conversations）和消息（Messages）管理的函数式 SDK。
+SeaVerse Conversation SDK - A functional SDK for managing conversations and messages.
 
-## 安装
+## Installation
 
 ```bash
 npm install @seaverse/conversation-sdk
-# 或
+# or
 pnpm add @seaverse/conversation-sdk
 ```
 
-## 快速开始
+## Quick Start
 
-### 初始化 SDK
+### Initialize SDK
 
 ```typescript
 import { initConversationSdk } from '@seaverse/conversation-sdk';
@@ -23,19 +23,19 @@ const sdk = initConversationSdk({
 });
 ```
 
-### 获取 Apps 及其会话列表
+### Get Apps with Conversations
 
 ```typescript
-// 获取所有 apps,每个 app 返回消息数最多的一个会话
+// Get all apps, each app returns the conversation with the most messages
 const result = await sdk.getAppsWithConversationsList({
   page: 1,
   pageSize: 20
 });
 
 console.log(result.apps);     // AppWithConversations[]
-console.log(result.hasMore);  // boolean - 是否有下一页
+console.log(result.hasMore);  // boolean - whether there's a next page
 
-// 获取指定 app
+// Get a specific app
 const appResult = await sdk.getAppsWithConversationsList({
   appId: 'app-123',
   page: 1,
@@ -43,106 +43,106 @@ const appResult = await sdk.getAppsWithConversationsList({
 });
 ```
 
-### 获取消息列表
+### Get Messages List
 
 ```typescript
-// 获取指定会话的消息列表（倒序,最新的在前）
+// Get message list for a conversation (descending order, newest first)
 const result = await sdk.getMessagesList('conversation-id', {
   page: 1,
   pageSize: 50
 });
 
 console.log(result.messages);  // Message[]
-console.log(result.hasMore);   // boolean - 是否有下一页
+console.log(result.hasMore);   // boolean - whether there's a next page
 ```
 
-## API 参考
+## API Reference
 
 ### initConversationSdk(config)
 
-初始化 Conversation SDK 并返回函数式 API。
+Initialize the Conversation SDK and return functional API.
 
-**参数**:
+**Parameters**:
 ```typescript
 {
-  environment: 'dev' | 'prod';        // 环境配置
-  token: string;                      // 访问令牌
-  getToken?: () => Promise<string>;   // 动态获取令牌（可选）
-  fetch?: typeof fetch;               // 自定义 fetch 实现（可选）
-  timeout?: number;                   // 请求超时时间，默认 30000ms（可选）
+  environment: 'dev' | 'prod';        // Environment configuration
+  token: string;                      // Access token
+  getToken?: () => Promise<string>;   // Dynamic token getter (optional)
+  fetch?: typeof fetch;               // Custom fetch implementation (optional)
+  timeout?: number;                   // Request timeout, default 30000ms (optional)
 }
 ```
 
-**返回**: 包含以下方法的对象
+**Returns**: Object containing the following methods
 
 ### getAppsWithConversationsList(options?)
 
-获取 Apps 列表,每个 app 只返回消息数最多的那一个会话。
+Get list of apps, each app returns only the conversation with the most messages.
 
-**参数**:
+**Parameters**:
 ```typescript
 {
-  appId?: string;      // 可选,按应用 ID 过滤
-  page?: number;       // 页码,默认 1
-  pageSize?: number;   // 每页数量,默认 20
+  appId?: string;      // Optional, filter by app ID
+  page?: number;       // Page number, default 1
+  pageSize?: number;   // Items per page, default 20
 }
 ```
 
-**返回**:
+**Returns**:
 ```typescript
 Promise<{
   apps: AppWithConversations[];
-  hasMore: boolean;  // 是否有下一页
+  hasMore: boolean;  // Whether there's a next page
 }>
 ```
 
 ### getMessagesList(conversationId, options?)
 
-获取指定会话的消息列表（按时间倒序,最新消息在前）。
+Get message list for a conversation (descending order by time, newest first).
 
-**参数**:
-- `conversationId`: `string` - 会话 ID（必需）
-- `options?`: 可选查询选项
+**Parameters**:
+- `conversationId`: `string` - Conversation ID (required)
+- `options?`: Optional query options
   ```typescript
   {
-    page?: number;       // 页码,默认 1
-    pageSize?: number;   // 每页数量,默认 100
+    page?: number;       // Page number, default 1
+    pageSize?: number;   // Items per page, default 100
   }
   ```
 
-**返回**:
+**Returns**:
 ```typescript
 Promise<{
   messages: Message[];
-  hasMore: boolean;  // 是否有下一页
+  hasMore: boolean;  // Whether there's a next page
 }>
 ```
 
-## 类型定义
+## Type Definitions
 
 ### Message
 
 ```typescript
 interface Message {
   id: string;
-  role?: 'user' | 'assistant' | 'system';  // tips 消息无 role
-  content?: string;                         // tips 消息不返回此字段
-  timestamp: number;                        // 秒级时间戳
+  role?: 'user' | 'assistant' | 'system';  // tips messages don't have role
+  content?: string;                         // tips messages don't return this field
+  timestamp: number;                        // Unix timestamp in seconds
   type?: 'text' | 'conversation_tips' | string;
-  tips?: string[];                          // conversation_tips 类型专有
-  toolCalls?: ToolCall[];                   // 工具调用信息
+  tips?: string[];                          // Specific to conversation_tips type
+  toolCalls?: ToolCall[];                   // Tool call information
 }
 ```
 
-**Tips 消息格式**:
+**Tips Message Format**:
 ```typescript
 {
   id: string;
-  conversation_id: string;  // 仅 tips 消息有此字段
+  conversation_id: string;  // Only tips messages have this field
   timestamp: number;
   type: "conversation_tips";
   tips: string[];
-  // 注意: tips 消息没有 content 和 role 字段
+  // Note: tips messages don't have content and role fields
 }
 ```
 
@@ -165,10 +165,10 @@ interface Conversation {
   title: string;
   appId: string | null;
   userId: string;
-  createdAt: number;        // 毫秒时间戳
-  updatedAt: number;        // 毫秒时间戳
-  lastActiveAt: number;     // 毫秒时间戳
-  messageCount?: number;    // 消息计数
+  createdAt: number;        // Unix timestamp in milliseconds
+  updatedAt: number;        // Unix timestamp in milliseconds
+  lastActiveAt: number;     // Unix timestamp in milliseconds
+  messageCount?: number;    // Message count
 }
 ```
 
@@ -177,7 +177,7 @@ interface Conversation {
 ```typescript
 interface AppWithConversations {
   app: App;
-  conversations: Conversation[];  // 只有一个元素(消息数最多的会话)
+  conversations: Conversation[];  // Only one element (conversation with most messages)
 }
 ```
 
@@ -197,14 +197,14 @@ interface App {
   positiveCount: number;
   forkCount: number;
   commentCount: number;
-  createdAt: number;        // 毫秒时间戳
-  updatedAt: number;        // 毫秒时间戳
+  createdAt: number;        // Unix timestamp in milliseconds
+  updatedAt: number;        // Unix timestamp in milliseconds
 }
 ```
 
-## 错误处理
+## Error Handling
 
-SDK 提供了几种错误类型：
+The SDK provides several error types:
 
 ```typescript
 import {
@@ -219,38 +219,38 @@ try {
   const result = await sdk.getAppsWithConversationsList();
 } catch (error) {
   if (error instanceof AuthError) {
-    console.error('认证失败:', error.message);
+    console.error('Authentication failed:', error.message);
   } else if (error instanceof NetworkError) {
-    console.error('网络错误:', error.message);
+    console.error('Network error:', error.message);
   } else if (error instanceof TimeoutError) {
-    console.error('请求超时:', error.message);
+    console.error('Request timeout:', error.message);
   } else {
-    console.error('未知错误:', error);
+    console.error('Unknown error:', error);
   }
 }
 ```
 
-## 完整示例
+## Complete Example
 
 ```typescript
 import { initConversationSdk } from '@seaverse/conversation-sdk';
 
-// 初始化 SDK
+// Initialize SDK
 const sdk = initConversationSdk({
   environment: 'prod',
   token: 'your-access-token'
 });
 
-// 1. 获取所有 apps 及其热门会话
+// 1. Get all apps with their top conversations
 const appsResult = await sdk.getAppsWithConversationsList({
   page: 1,
   pageSize: 20
 });
 
 console.log('Apps:', appsResult.apps);
-console.log('有下一页:', appsResult.hasMore);
+console.log('Has more:', appsResult.hasMore);
 
-// 2. 获取某个会话的消息
+// 2. Get messages for a conversation
 const conversationId = appsResult.apps[0]?.conversations[0]?.id;
 if (conversationId) {
   const messagesResult = await sdk.getMessagesList(conversationId, {
@@ -258,27 +258,27 @@ if (conversationId) {
     pageSize: 50
   });
 
-  console.log('消息列表:', messagesResult.messages);
-  console.log('有更多消息:', messagesResult.hasMore);
+  console.log('Messages:', messagesResult.messages);
+  console.log('Has more messages:', messagesResult.hasMore);
 
-  // 处理不同类型的消息
+  // Handle different message types
   messagesResult.messages.forEach(msg => {
     if (msg.type === 'conversation_tips') {
       console.log('Tips:', msg.tips);
     } else {
-      console.log('消息:', msg.content);
+      console.log('Message:', msg.content);
     }
   });
 }
 ```
 
-## 环境配置
+## Environment Configuration
 
-SDK 会根据 `environment` 参数自动选择对应的服务端点：
+The SDK automatically selects the corresponding service endpoint based on the `environment` parameter:
 
-- `'dev'`: 开发环境
-- `'prod'`: 生产环境
+- `'dev'`: Development environment
+- `'prod'`: Production environment
 
-## 许可证
+## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seaverse/conversation-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "SeaVerse Conversation SDK - SDK for conversations and messages management",
   "type": "module",
   "main": "./dist/index.js",