acp-ts 1.0.0 → 1.0.2

package/README.md

@@ -1,14 +1,24 @@
-# ACP-WS 使用指南
+# acp-ts
+
+基于 WebSocket 的智能体通信库，提供智能体身份管理和实时通信功能。
+
+## 安装
+
+```bash
+npm install acp-ts
+```
 
 ## 简介
 
-ACP-WS 是一个基于 WebSocket 的智能体通信库，提供了智能体身份管理（AgentCP）和 WebSocket 通信（AgentWS）功能。通过 AgentManager 统一管理这些功能，使用更加便捷。
+acp-ts 是一个基于 WebSocket 的智能体通信库，提供了智能体身份管理（AgentCP）和 WebSocket 通信（AgentWS）功能。通过 AgentManager 统一管理这些功能，使用更加便捷。
 
 ## 快速开始
 
 ### 1. 初始化 AgentManager
 
 ```typescript
+import { AgentManager } from 'acp-ts';
+
 // 获取 AgentManager 单例
 const manager = AgentManager.getInstance();
 
@@ -67,7 +77,7 @@ const aws = await manager.initAWS(aid, config);
 await aws.startWebSocket();
 
 // 快速连接到指定智能体（推荐方式）
-aws.connectTo("target-aid", 
+aws.connectTo("target-aid",
     (sessionInfo) => {
         console.log("会话创建成功:", sessionInfo.sessionId);
         console.log("邀请码:", sessionInfo.identifyingCode);
@@ -114,11 +124,11 @@ aws.disconnect();
 aws.createSession((sessionRes) => {
     console.log("会话ID:", sessionRes.sessionId);
     console.log("邀请码:", sessionRes.identifyingCode);
-    
+
     // 手动邀请智能体
     aws.invite(
-        "target-agent-id", 
-        sessionRes.sessionId, 
+        "target-agent-id",
+        sessionRes.sessionId,
         sessionRes.identifyingCode,
         (inviteStatus) => {
             if (inviteStatus === 'success') {
@@ -135,7 +145,7 @@ aws.createSession((sessionRes) => {
 
 ```typescript
 import React, { useEffect, useState } from 'react';
-import { AgentManager } from './agent-manager';
+import { AgentManager } from 'acp-ts';
 
 const ChatComponent: React.FC = () => {
     const [aws, setAws] = useState<any>(null);
@@ -147,30 +157,30 @@ const ChatComponent: React.FC = () => {
             try {
                 const manager = AgentManager.getInstance();
                 const acp = await manager.initACP("https://api.example.com");
-                
+
                 // 加载或创建身份
                 let aid = await acp.loadCurrentAid();
                 if (!aid) {
                     aid = await acp.loadGuestAid();
                 }
-                
+
                 // 获取连接配置并初始化WebSocket
                 const config = await acp.online();
                 const agentWS = await manager.initAWS(aid, config);
-                
+
                 // 注册事件监听器
                 agentWS.onStatusChange((status) => {
                     setConnectionStatus(status);
                 });
-                
+
                 agentWS.onMessage((message) => {
                     setMessages(prev => [...prev, message.content]);
                 });
-                
+
                 // 启动连接
                 await agentWS.startWebSocket();
                 setAws(agentWS);
-                
+
             } catch (error) {
                 console.error("初始化失败:", error);
             }
@@ -206,7 +216,6 @@ const ChatComponent: React.FC = () => {
                     <div key={index}>{msg}</div>
                 ))}
             </div>
-            {/* 发送消息和连接的UI组件 */}
         </div>
     );
 };
@@ -214,11 +223,28 @@ const ChatComponent: React.FC = () => {
 
 ## API 参考
 
-### AgentWS 类
+### AgentManager
+
+- `getInstance(): AgentManager` - 获取单例实例
+- `initACP(apiUrl, seedPassword?): Promise<AgentCP>` - 初始化身份管理
+- `initAWS(aid, config): Promise<AgentWS>` - 初始化 WebSocket 连接
+
+### AgentCP
+
+- `createAid(aid): Promise<string>` - 创建新身份
+- `loadAid(aid): Promise<boolean>` - 加载指定身份
+- `loadCurrentAid(): Promise<string | null>` - 加载当前身份
+- `loadGuestAid(): Promise<string>` - 加载访客身份
+- `loadAidList(): Promise<string[]>` - 获取身份列表
+- `importAid(identity, seedPassword?): Promise<void>` - 导入身份
+- `getCertInfo(aid): Promise<CertInfo>` - 获取证书信息
+- `online(): Promise<Config>` - 上线获取连接配置
+
+### AgentWS
 
 #### 方法
 
-- `startWebSocket(): Promise<void>` - 启动WebSocket连接
+- `startWebSocket(): Promise<void>` - 启动 WebSocket 连接
 - `connectTo(receiver, onSessionCreated?, onInviteStatus?): void` - 快捷连接到指定智能体
 - `createSession(callback): void` - 创建会话
 - `invite(receiver, sessionId, identifyingCode, callback?): void` - 邀请智能体加入会话
@@ -228,16 +254,12 @@ const ChatComponent: React.FC = () => {
 - `onMessage(callback): void` - 注册消息接收监听器
 - `disconnect(): void` - 断开连接
 
-#### 状态类型
+#### 类型定义
 
 ```typescript
 type ConnectionStatus = 'connecting' | 'connected' | 'disconnected' | 'reconnecting' | 'error';
 type InviteStatus = 'success' | 'error';
-```
-
-#### 消息类型
 
-```typescript
 type ACPMessageResponse = {
     type: 'success' | 'error';
     content: string;
@@ -249,11 +271,11 @@ type ACPMessageSessionResponse = {
 }
 ```
 
-### WSClient 类
+### WSClient
 
-底层WebSocket客户端，提供更精细的控制：
+底层 WebSocket 客户端，提供更精细的控制：
 
-- `connectToServer(wsServer, aid, signature): Promise<void>` - 连接到WebSocket服务器
+- `connectToServer(wsServer, aid, signature): Promise<void>` - 连接到 WebSocket 服务器
 - `createSession(callback): void` - 创建会话（自动清理监听器）
 - `invite(receiver, sessionId, identifyingCode, callback?): void` - 发送邀请
 - `onStatusChange(callback): () => void` - 注册状态监听器，返回清理函数
@@ -264,34 +286,18 @@ type ACPMessageSessionResponse = {
 
 ## 错误处理
 
-所有关键操作都有适当的错误处理：
-
-- 身份验证失败
-- 连接超时
-- 消息发送失败
-- WebSocket 连接断开
-- 参数验证错误
-
-建议使用 try-catch 包装关键操作：
-
 ```typescript
 try {
     await aws.startWebSocket();
 } catch (error) {
     console.error(`WebSocket 连接失败: ${error.message}`);
-    // 实现重连逻辑
 }
-```
 
-### 常见错误处理
-
-```typescript
-// 连接错误处理
+// 连接状态监听
 aws.onStatusChange((status) => {
     switch (status) {
         case 'error':
             console.error("连接出错，尝试重连...");
-            // 实现重连逻辑
             break;
         case 'disconnected':
             console.warn("连接断开");
@@ -306,9 +312,7 @@ aws.onStatusChange((status) => {
 aws.onMessage((message) => {
     if (message.type === 'error') {
         console.error("收到错误消息:", message.content);
-        // 处理错误情况
     } else {
-        // 处理正常消息
         console.log("收到消息:", message.content);
     }
 });
@@ -316,59 +320,23 @@ aws.onMessage((message) => {
 
 ## 最佳实践
 
-### 1. 资源管理
-- 始终使用 AgentManager 来管理实例，避免直接创建 AgentCP 或 AgentWS 实例
-- 在应用退出时调用 `disconnect()` 清理资源
-- 在React组件中使用useEffect的清理函数来清理WebSocket连接
-
-### 2. 事件处理
-- 在初始化 WebSocket 连接后再注册事件监听器
-- 使用 WSClient 时记得调用返回的清理函数防止内存泄漏
-- 避免在回调函数中执行耗时操作，以免阻塞消息处理
-
-### 3. 异步操作
-- 使用 async/await 处理异步操作
-- 实现适当的重连机制和错误恢复策略
-- 对关键操作添加超时控制
+1. **资源管理**
+   - 使用 AgentManager 管理实例
+   - 退出时调用 `disconnect()` 清理资源
+   - React 组件中使用 useEffect 清理函数
 
-### 4. 安全性
-- 妥善保管 seedPassword 和私钥信息
-- 验证消息来源和内容的合法性
-- 使用HTTPS/WSS协议进行通信
+2. **事件处理**
+   - 初始化连接后再注册监听器
+   - 使用 WSClient 时调用返回的清理函数防止内存泄漏
 
-### 5. 性能优化
-- 合理使用 `connectTo` 而不是手动管理会话
-- 避免频繁创建和销毁连接
-- 对大量消息的场景考虑消息批处理
+3. **安全性**
+   - 妥善保管 seedPassword 和私钥
+   - 使用 HTTPS/WSS 协议通信
 
-### 6. 调试和监控
-- 启用适当的日志记录
-- 监控连接状态和消息传输
-- 实现健康检查机制
+## 相关项目
 
-## 故障排除
+- [acp-py](https://www.npmjs.com/package/acp-py) - Python 版本的智能体通信库
 
-### 常见问题
-
-1. **连接失败**: 检查网络连接、服务器地址和身份验证信息
-2. **消息发送失败**: 确认WebSocket连接状态和会话状态
-3. **监听器未清理**: 使用WSClient时记得调用返回的清理函数
-4. **重复监听器**: createSession和invite方法已自动处理重复注册问题
-
-### 调试技巧
-
-```typescript
-// 启用详细日志
-aws.onStatusChange((status) => {
-    console.log(`[${new Date().toISOString()}] 状态变更: ${status}`);
-});
-
-// 监控消息传输
-aws.onMessage((message) => {
-    console.log(`[${new Date().toISOString()}] 收到消息:`, message);
-});
+## License
 
-// 检查当前连接状态
-const currentStatus = aws.msgClient.getCurrentStatus();
-console.log("当前连接状态:", currentStatus);
-```
+MIT

package/dist/cli.js

@@ -61,7 +61,7 @@ function update() {
     const npm = getNpmCommand();
     try {
         // 获取最新版本号
-        const result = (0, child_process_1.spawnSync)(npm, ['view', 'agent-acp', 'version'], {
+        const result = (0, child_process_1.spawnSync)(npm, ['view', 'acp-ts', 'version'], {
             encoding: 'utf-8',
             timeout: 30000
         });
@@ -80,7 +80,7 @@ function update() {
         console.log(`发现新版本 v${latestVersion}，当前版本 v${currentVersion}`);
         console.log('正在更新...');
         // 执行全局更新
-        const installResult = (0, child_process_1.spawnSync)(npm, ['install', '-g', 'agent-acp@latest'], {
+        const installResult = (0, child_process_1.spawnSync)(npm, ['install', '-g', 'acp-ts@latest'], {
             stdio: 'inherit',
             shell: true
         });
@@ -91,7 +91,7 @@ function update() {
             // 可能是权限问题
             if (!isWindows) {
                 console.log('\n更新失败，可能需要管理员权限，请尝试运行:');
-                console.log('  sudo npm install -g agent-acp@latest');
+                console.log('  sudo npm install -g acp-ts@latest');
             }
             else {
                 console.log('\n更新失败，请尝试以管理员身份运行命令提示符后重试');
@@ -114,7 +114,7 @@ for (let i = 0; i < args.length; i++) {
         process.exit(0);
     }
     else if (args[i] === '-v' || args[i] === '--version') {
-        console.log(`agent-acp v${getVersion()}`);
+        console.log(`acp-ts v${getVersion()}`);
         process.exit(0);
     }
     else if (args[i] === '-p' || args[i] === '--port') {
@@ -127,11 +127,11 @@ for (let i = 0; i < args.length; i++) {
     }
     else if (args[i] === '-h' || args[i] === '--help') {
         console.log(`
-agent-acp - 智能体通信调试工具 v${getVersion()}
+acp-ts - 智能体通信调试工具 v${getVersion()}
 
 用法:
-  agent-acp [选项]
-  agent-acp update      更新到最新版本
+  acp-ts [选项]
+  acp-ts update      更新到最新版本
 
 选项:
   -v, --version        显示版本号
@@ -140,12 +140,12 @@ agent-acp - 智能体通信调试工具 v${getVersion()}
   -h, --help           显示帮助信息
 
 安装:
-  npm install -g agent-acp
+  npm install -g acp-ts
 
 示例:
-  agent-acp
-  agent-acp -p 8080
-  agent-acp update
+  acp-ts
+  acp-ts -p 8080
+  acp-ts update
 `);
         process.exit(0);
     }

package/dist/server.js

@@ -68,7 +68,7 @@ const indexHtml = `<!DOCTYPE html>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <link rel="icon" href="/favicon.ico" type="image/x-icon">
-    <title>Agent ACP 智能体管理</title>
+    <title>acp-ts 智能体管理</title>
     <style>
         * { box-sizing: border-box; margin: 0; padding: 0; }
         body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #f5f5f5; min-height: 100vh; display: flex; justify-content: center; align-items: center; }
@@ -103,7 +103,7 @@ const indexHtml = `<!DOCTYPE html>
 </head>
 <body>
     <div class="container">
-        <h1>Agent ACP 智能体管理</h1>
+        <h1>acp-ts 智能体管理</h1>
 
         <div class="aid-section" id="aidSection" style="display:none;">
             <div class="aid-label">当前 AID</div>
@@ -232,7 +232,7 @@ const chatHtml = `<!DOCTYPE html>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <link rel="icon" href="/favicon.ico" type="image/x-icon">
-    <title>Agent ACP 聊天</title>
+    <title>acp-ts 聊天</title>
     <style>
         * { box-sizing: border-box; margin: 0; padding: 0; }
         body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #f5f5f5; height: 100vh; display: flex; flex-direction: column; }
@@ -280,7 +280,7 @@ const chatHtml = `<!DOCTYPE html>
 <body>
     <div class="header">
         <div>
-            <h1>Agent ACP 聊天</h1>
+            <h1>acp-ts 聊天</h1>
             <div class="aid" id="myAid">加载中...</div>
         </div>
         <a href="/" class="back">返回</a>
@@ -866,7 +866,7 @@ function startServer(port, apiUrl) {
     process.on('SIGINT', cleanup);
     process.on('SIGTERM', cleanup);
     server.listen(port, () => {
-        console.log(`\n  Agent ACP 调试服务已启动`);
+        console.log(`\n  acp-ts 调试服务已启动`);
         console.log(`  ─────────────────────────`);
         console.log(`  本地地址: http://localhost:${port}`);
         console.log(`  API 服务: ${apiUrl}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "acp-ts",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "基于 WebSocket 的智能体通信库，提供智能体身份管理和实时通信功能",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,7 +33,6 @@
   "dependencies": {
     "@react-native-async-storage/async-storage": "^2.1.2",
     "acp-ws-evol": "^1.0.0",
-    "agent-acp": "^1.0.0",
     "axios": "^1.9.0",
     "jsrsasign": "^11.1.0",
     "mitt": "^3.0.1",