@zhin.js/adapter-sandbox 1.0.30 → 1.0.32

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @zhin.js/adapter-process
 
+## 1.0.32
+
+### Patch Changes
+
+- Updated dependencies [b27e633]
+  - @zhin.js/http@1.0.18
+  - @zhin.js/core@1.0.27
+  - zhin.js@1.0.27
+  - @zhin.js/console@1.0.23
+
+## 1.0.31
+
+### Patch Changes
+
+- 106d357: fix: ai
+- Updated dependencies [106d357]
+  - @zhin.js/console@1.0.22
+  - @zhin.js/http@1.0.17
+  - @zhin.js/client@1.0.9
+  - @zhin.js/core@1.0.26
+  - zhin.js@1.0.26
+
 ## 1.0.30
 
 ### Patch Changes

package/README.md

@@ -1,84 +1,90 @@
-# @zhin.js/adapter-process
+# @zhin.js/adapter-sandbox
 
-基于进程标准输入输出的 Zhin 机器人适配器，用于命令行环境下的测试和开发。
+Zhin.js Sandbox 适配器，基于 WebSocket 的本地测试适配器，配合 Web 控制台提供浏览器端聊天窗口进行调试。
 
 ## 功能特性
 
-- 🖥️ 命令行交互界面
-- ⌨️ 标准输入输出处理
-- 🧪 测试和开发友好
-- 📝 简单的消息格式
-- 🔄 实时消息处理
+- 基于 WebSocket 实时通信
+- 浏览器端 React 聊天 UI
+- 支持多客户端同时连接
+- 无需第三方平台账号，即开即用
+- 适合本地开发和插件调试
 
 ## 安装
 
 ```bash
-npm install @zhin.js/adapter-process
+pnpm add @zhin.js/adapter-sandbox
 ```
 
+## 依赖
+
+Sandbox 适配器需要以下服务插件：
+
+- `@zhin.js/http` — HTTP 服务（提供 Router 和 WebSocket）
+- `@zhin.js/console` — Web 控制台（提供前端 UI）
+- `@zhin.js/client` — 控制台客户端框架
+
 ## 配置
 
-```javascript
-// zhin.config.ts
-export default {
+```yaml
+# zhin.config.yml
+bots:
+  - context: sandbox
+    name: sandbox-bot
+
+plugins:
+  - adapter-sandbox
+  - http
+  - console
+```
+
+或使用 TypeScript 配置：
+
+```typescript
+import { defineConfig } from 'zhin.js'
+
+export default defineConfig({
   bots: [
     {
-      context: 'process',
-      name: 'console-bot', // 机器人名称
+      context: 'sandbox',
+      name: 'sandbox-bot',
     }
+  ],
+  plugins: [
+    'adapter-sandbox',
+    'http',
+    'console',
   ]
-}
+})
 ```
 
 ## 使用方式
 
-启动后，直接在命令行中输入消息即可：
-
-```bash
-$ npm run dev
-> 你好
-[Bot] 收到消息：你好
-[Bot] 回复：Hello World!
-```
-
-## 消息处理
+1. 启动机器人：`pnpm dev`
+2. 打开浏览器访问 Web 控制台（默认 `http://localhost:8086`）
+3. 在控制台的 Sandbox 聊天窗口中发送消息进行测试
 
-- 监听 `process.stdin` 输入
-- 将输入内容转换为标准消息格式
-- 消息发送只会在日志中显示，不会输出到终端
+每个浏览器客户端通过 WebSocket 连接后会自动创建一个 Sandbox Bot 实例，消息通过 JSON 格式在 WebSocket 上传输。
 
 ## 消息格式
 
-消息对象包含：
-- `id`: 基于时间戳的消息ID
-- `sender.id`: 当前进程PID
-- `sender.name`: 进程标题
-- `channel.id`: 进程PID
-- `channel.type`: 固定为 'private'
-- `content`: 文本消息内容
-- `timestamp`: 消息时间戳
-
-## 适用场景
-
-- 🧪 插件开发测试
-- 🔍 功能调试
-- 📚 学习和演示
-- 🛠️ 开发环境验证
-
-## 依赖项
+Sandbox 使用 JSON 消息格式：
 
-- `zhin.js` - Zhin核心框架
-- Node.js 内置模块
+```json
+{
+  "type": "message",
+  "id": "msg-001",
+  "content": "你好",
+  "timestamp": 1700000000000
+}
+```
 
-## 开发
+## 适用场景
 
-```bash
-npm run build  # 构建
-npm run clean  # 清理构建文件
-```
+- 本地开发调试插件逻辑
+- 测试命令和 AI 工具调用
+- 不依赖外部平台的功能验证
 
-## 注意事项
+## 许可证
 
-- 此适配器仅用于开发和测试
-- 不支持图片、文件等复杂消息类型
-- 消息发送仅在日志中显示
+MIT License