openclaw-agent-dashboard 1.0.21 → 1.0.23

package/package.json

@@ -1,25 +1,33 @@
 {
   "name": "openclaw-agent-dashboard",
-  "version": "1.0.21",
-  "description": "多 Agent 可视化看板 - 开发仓库（发布请使用 npm run publish:npm）",
-  "scripts": {
-    "pack": "node scripts/build-plugin.js",
-    "install-plugin": "node scripts/install.js",
-    "deploy": "npm run pack && npm run install-plugin",
-    "upgrade": "git pull && npm run deploy",
-    "bundle": "bash scripts/bundle.sh",
-    "start": "node scripts/start.js",
-    "publish:npm": "npm run pack && cd plugin && npm publish --access public"
+  "version": "1.0.23",
+  "description": "多 Agent 可视化看板 - OpenClaw 插件",
+  "main": "index.js",
+  "openclaw": {
+    "extensions": [
+      "./index.js"
+    ]
   },
   "keywords": [
     "openclaw",
-    "agent",
     "dashboard",
-    "visualization"
+    "agent",
+    "monitoring"
   ],
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/Umarchen/openclaw-agent-dashboard.git"
+  },
+  "files": [
+    "openclaw.plugin.json",
+    "index.js",
+    "dashboard",
+    "frontend-dist",
+    "scripts"
+  ],
+  "scripts": {
+    "pack": "node ../scripts/build-plugin.js",
+    "prepublishOnly": "npm run pack"
   }
-}
+}

package/.github/workflows/release.yml

@@ -1,56 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*'
-  workflow_dispatch:
-
-jobs:
-  build-and-release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-
-      - name: Install dependencies
-        run: cd frontend && npm ci
-
-      - name: Build and pack plugin
-        run: npm run pack
-
-      - name: Generate release tgz
-        run: bash scripts/release-pack.sh
-
-      - name: Get version
-        id: version
-        run: |
-          VERSION=$(jq -r '.version' plugin/openclaw.plugin.json)
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "tag=v$VERSION" >> $GITHUB_OUTPUT
-
-      - name: Upload artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: plugin-tgz
-          path: openclaw-agent-dashboard-v*.tgz
-          retention-days: 30
-
-      - name: Create Release
-        if: github.event_name == 'push'
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: ${{ steps.version.outputs.tag }}
-          name: Release ${{ steps.version.outputs.tag }}
-          generate_release_notes: true
-          make_latest: true
-          files: |
-            openclaw-agent-dashboard-v*.tgz

package/VERSION_DISPLAY_delivery.md

@@ -1,242 +0,0 @@
-# 版本号显示功能 - 交付清单
-
-> **任务标识**: 开发任务 - 界面显示版本号  
-> **交付日期**: 2026-03-19  
-> **交付人员**: DevOps Agent (Subagent: Coder-version-display)  
-> **任务状态**: ✅ 完成
-
----
-
-## 📋 任务概述
-
-根据设计文档和 PRD，实现"界面显示版本号"功能，使用户能够在 Dashboard 界面直观地查看当前插件的版本信息。
-
----
-
-## ✅ 交付成果
-
-### 1. 后端实现（P0）
-
-#### 1.1 新增文件
-
-| 文件 | 路径 | 大小 | 描述 |
-|-----|------|------|------|
-| 版本信息读取器 | `src/backend/data/version_info_reader.py` | 3.5 KB | 从 package.json 读取版本信息，支持缓存和降级 |
-| 版本信息 API | `src/backend/api/version.py` | 990 B | 提供 GET /api/version 端点 |
-
-#### 1.2 修改文件
-
-| 文件 | 修改内容 |
-|-----|---------|
-| `src/backend/main.py` | 导入 version 模块，注册 `app.include_router(version.router)` |
-
-#### 1.3 API 端点
-
-| 方法 | 路径 | 描述 |
-|-----|------|------|
-| GET | /api/version | 返回插件版本信息 |
-
-**响应示例**:
-```json
-{
-  "version": "1.0.10",
-  "name": "openclaw-agent-dashboard",
-  "description": "多 Agent 可视化看板 - 状态、任务、API、工作流、协作流程",
-  "build_date": "2026-03-19T12:34:56Z",
-  "git_commit": "abc123def456"
-}
-```
-
----
-
-### 2. 前端实现（P0）
-
-#### 2.1 新增文件
-
-| 文件 | 路径 | 大小 | 描述 |
-|-----|------|------|------|
-| 版本显示组件 | `frontend/src/components/common/VersionDisplay.vue` | 3.9 KB | Vue 3 组件，在界面右下角显示版本号 |
-
-#### 2.2 修改文件
-
-| 文件 | 修改内容 |
-|-----|---------|
-| `frontend/src/App.vue` | 导入 VersionDisplay 组件，在模板中添加 `<VersionDisplay />` 标签 |
-
-#### 2.3 组件特性
-
-- **位置**: 界面右下角固定显示
-- **样式**: 12px 灰色文字，hover 变深
-- **交互**: hover 时显示完整版本信息（tooltip）
-- **状态**: 支持加载中、错误、正常三种状态
-- **响应式**: 移动端自动调整大小
-
----
-
-### 3. 文档交付
-
-| 文档 | 路径 | 大小 | 描述 |
-|-----|------|------|------|
-| 追溯清单 | `.staging/traceability_manifest.json` | 8.6 KB | 需求到实现的映射关系 |
-| 实施摘要 | `.staging/VERSION_DISPLAY_implementation_summary.md` | 5.9 KB | 详细实施过程和验证结果 |
-| 交付清单 | `.staging/VERSION_DISPLAY_delivery.md` | - | 本文档 |
-
----
-
-## 📦 文件统计
-
-| 类型 | 数量 | 文件列表 |
-|-----|------|---------|
-| 新增文件 | 5 | version_info_reader.py, version.py, VersionDisplay.vue, traceability_manifest.json, implementation_summary.md |
-| 修改文件 | 2 | main.py, App.vue |
-| 测试脚本 | 1 | test_version_display.sh |
-| **总计** | **8** | - |
-
----
-
-## ✅ 验收测试
-
-### 自动化测试
-
-```bash
-# 运行快速测试脚本
-./scripts/test_version_display.sh
-```
-
-**测试结果**: ✅ 所有测试通过
-
-### 手动测试步骤
-
-1. **启动服务**:
-   ```bash
-   cd /home/ubuntu/vrt-projects/projects/openclaw-agent-dashboard
-   npm start
-   ```
-
-2. **测试 API**:
-   ```bash
-   curl http://localhost:8000/api/version
-   # 预期: 返回包含 version, name, description 的 JSON
-   ```
-
-3. **测试前端**:
-   - 访问 `http://localhost:8000`
-   - 检查右下角是否显示版本号
-   - 鼠标悬停在版本号上，查看 tooltip
-
----
-
-## 📊 需求追溯
-
-| 需求 ID | 描述 | 优先级 | 状态 |
-|---------|------|--------|------|
-| REQ_VERSION_DISPLAY_001 | 后端版本信息 API | P0 | ✅ 完成 |
-| REQ_VERSION_DISPLAY_002 | 前端版本信息组件 | P0 | ✅ 完成 |
-| REQ_VERSION_DISPLAY_003 | 实时数据管理器集成 | P1 | ⏸️ 延后 |
-| REQ_VERSION_DISPLAY_004 | 版本信息配置 | P2 | ✅ 部分（环境变量支持） |
-
----
-
-## 🔧 技术亮点
-
-### 1. 最小侵入原则
-- 优先新增文件（5 个新增，2 个修改）
-- 修改内容极简（仅新增导入和注册/标签）
-
-### 2. 单一数据源
-- 版本号仅从 `package.json` 读取
-- 避免多源数据导致的不一致
-
-### 3. 降级策略
-- 文件读取失败返回 `version="unknown"`
-- API 始终返回 200 状态码
-- 错误日志记录，但不影响核心功能
-
-### 4. 性能优化
-- 使用缓存机制，避免频繁文件读取
-- 响应时间 < 50ms（缓存后）
-
-### 5. 简体中文注释
-- 所有新增代码使用简体中文注释
-- 代码可读性强，易于维护
-
----
-
-## 🌐 环境变量支持
-
-| 环境变量 | 类型 | 默认值 | 说明 |
-|---------|------|--------|------|
-| `DASHBOARD_BUILD_DATE` | String | 未设置 | 构建时间戳（ISO 8601 格式） |
-| `DASHBOARD_GIT_COMMIT` | String | 未设置 | Git 提交哈希（短格式） |
-
-**使用示例**:
-```bash
-export DASHBOARD_BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
-export DASHBOARD_GIT_COMMIT=$(git rev-parse --short HEAD)
-npm start
-```
-
----
-
-## 📝 已知限制与后续优化
-
-### 当前限制
-
-1. **状态管理**: 版本信息由组件独立管理，未集成到全局状态管理器
-2. **重试机制**: 未实现 API 调用失败时的自动重试
-3. **构建集成**: 构建脚本未自动注入构建时间和 Git 提交
-
-### 后续优化建议
-
-#### 优化 1: 集成到状态管理器（P1）
-- 在 `StateManager.ts` 新增 `versionInfo` 字段和访问方法
-- 在 `RealtimeDataManager.ts` 实现 `loadVersionInfo()` 方法
-- 修改 `VersionDisplay.vue` 从状态管理器获取数据
-
-#### 优化 2: 构建脚本增强（P2）
-- 修改 `scripts/build-plugin.js`
-- 在构建时自动读取 Git 提交哈希
-- 自动设置构建时间戳
-
----
-
-## 📚 参考文档
-
-- **设计文档**: `.staging/design/VERSION_DISPLAY_design.md`
-- **设计清单**: `.staging/design_manifest.md`
-- **需求文档**: `docs/specs/VERSION_DISPLAY_spec.md`
-- **追溯清单**: `.staging/traceability_manifest.json`
-- **实施摘要**: `.staging/VERSION_DISPLAY_implementation_summary.md`
-
----
-
-## ✨ 交付确认
-
-- [x] 后端 API 实现（GET /api/version）
-- [x] 前端组件实现（VersionDisplay.vue）
-- [x] 追溯清单创建（traceability_manifest.json）
-- [x] 实施摘要文档（implementation_summary.md）
-- [x] 快速测试脚本（test_version_display.sh）
-- [x] Python 语法检查通过
-- [x] 自动化测试全部通过
-- [x] 最小侵入原则遵循
-- [x] 降级策略实现
-- [x] 简体中文注释
-
----
-
-**交付完成时间**: 2026-03-19 21:36  
-**下一阶段**: 功能测试与部署  
-
----
-
-## 💬 备注
-
-本次实施完成了"界面显示版本号"功能的核心部分（P0 阶段），满足以下目标：
-
-✅ **用户体验提升**: 用户可在界面上直观地看到当前版本号  
-✅ **问题诊断优化**: 用户反馈问题时可快速提供版本信息  
-✅ **升级验证便利**: 升级后可立即确认版本号变化  
-✅ **一致性保证**: 前端显示的版本号与实际安装版本保持一致  
-
-代码质量高，遵循设计原则，可投入测试和部署。

package/VERSION_DISPLAY_implementation_summary.md

@@ -1,315 +0,0 @@
-# 版本号显示功能 - 实施摘要
-
-> **特性标识**: VERSION_DISPLAY  
-> **实施日期**: 2026-03-19  
-> **实施人员**: DevOps Agent  
-> **实施状态**: ✅ 完成（P0 阶段）  
-> **版本**: 1.0.0
-
----
-
-## 1. 实施概述
-
-本次实施完成了"界面显示版本号"功能的核心部分（P0 阶段），包括后端 API 和前端组件的完整实现。功能使用户能够在 Dashboard 界面右下角直观地查看当前插件的版本信息。
-
-### 1.1 已完成的工作
-
-✅ **阶段 1: 后端 API 实现（P0）**
-- 创建版本信息读取器：`src/backend/data/version_info_reader.py`
-- 创建版本信息 API 路由：`src/backend/api/version.py`
-- 修改主入口注册路由：`src/backend/main.py`
-
-✅ **阶段 2: 前端组件实现（P0）**
-- 创建版本显示组件：`frontend/src/components/common/VersionDisplay.vue`
-- 修改主应用集成组件：`frontend/src/App.vue`
-
-✅ **阶段 3: 追溯清单**
-- 创建需求追溯清单：`.staging/traceability_manifest.json`
-
-### 1.2 待优化的工作（P1/P2）
-
-⏸️ **实时数据管理器集成（P1）**
-- 将版本信息集成到 `StateManager.ts` 和 `RealtimeDataManager.ts`
-- 实现重试机制和全局访问接口
-- 当前由组件独立管理，已满足基本需求
-
-⏸️ **构建脚本优化（P2）**
-- 在构建时自动注入构建时间和 Git 提交哈希
-- 当前支持通过环境变量设置，构建脚本暂未修改
-
----
-
-## 2. 文件变更清单
-
-### 2.1 新增文件（3 个）
-
-| 文件路径 | 类型 | 大小 | 描述 |
-|---------|------|------|------|
-| `src/backend/data/version_info_reader.py` | Python | 3.5 KB | 版本信息读取器，支持缓存和降级 |
-| `src/backend/api/version.py` | Python | 990 B | 版本信息 API 路由，提供 GET /api/version |
-| `frontend/src/components/common/VersionDisplay.vue` | Vue | 3.9 KB | 版本显示组件，支持 hover 提示 |
-
-### 2.2 修改文件（2 个）
-
-| 文件路径 | 修改类型 | 修改内容 |
-|---------|---------|---------|
-| `src/backend/main.py` | 新增导入 + 注册路由 | 导入 `version` 模块，注册 `app.include_router(version.router)` |
-| `frontend/src/App.vue` | 新增导入 + 模板标签 | 导入 `VersionDisplay` 组件，在模板中添加 `<VersionDisplay />` |
-
-### 2.3 新增文档（1 个）
-
-| 文件路径 | 大小 | 描述 |
-|---------|------|------|
-| `.staging/traceability_manifest.json` | 8.6 KB | 需求追溯清单，记录需求到实现的映射关系 |
-
----
-
-## 3. 技术实现详情
-
-### 3.1 后端 API 实现
-
-#### 3.1.1 版本信息读取器
-
-**文件**: `src/backend/data/version_info_reader.py`
-
-**核心功能**:
-- 从 `package.json` 读取版本号、名称、描述
-- 支持应用启动时缓存，避免重复文件读取
-- 支持通过环境变量注入构建时间和 Git 提交哈希
-- 降级策略：读取失败时返回 `version="unknown"`
-
-**关键方法**:
-- `read_version_info()`: 读取版本信息（带缓存）
-- `_read_build_date()`: 读取构建时间（从环境变量 `DASHBOARD_BUILD_DATE`）
-- `_read_git_commit()`: 读取 Git 提交哈希（从环境变量 `DASHBOARD_GIT_COMMIT`）
-
-**性能指标**:
-- 首次请求: < 100ms（文件读取 + JSON 解析）
-- 后续请求: < 50ms（内存读取）
-
-#### 3.1.2 版本信息 API 路由
-
-**文件**: `src/backend/api/version.py`
-
-**API 端点**: `GET /api/version`
-
-**响应示例**:
-```json
-{
-  "version": "1.0.10",
-  "name": "openclaw-agent-dashboard",
-  "description": "多 Agent 可视化看板 - 状态、任务、API、工作流、协作流程",
-  "build_date": "2026-03-19T12:34:56Z",
-  "git_commit": "abc123def456"
-}
-```
-
-**降级响应**（读取失败时）:
-```json
-{
-  "version": "unknown",
-  "name": "openclaw-agent-dashboard",
-  "description": ""
-}
-```
-
-### 3.2 前端组件实现
-
-#### 3.2.1 版本显示组件
-
-**文件**: `frontend/src/components/common/VersionDisplay.vue`
-
-**核心功能**:
-- 组件挂载时自动调用 `/api/version` 获取版本信息
-- 在界面右下角固定显示版本号（12px，灰色文字）
-- hover 时显示完整版本信息（名称、版本、描述、构建时间、Git 提交）
-- 支持加载中、错误状态显示
-- 响应式布局，移动端自动调整大小
-
-**显示文本**:
-- 默认: `openclaw-agent-dashboard v1.0.10`
-- 降级: `v?` 或 `openclaw-agent-dashboard vunknown`
-
-**样式特性**:
-- 定位: `position: fixed; bottom: 16px; right: 16px`
-- 颜色: `#999`（hover 时变为 `#666`）
-- Tooltip: 白色背景，阴影效果，最小宽度 200px
-
----
-
-## 4. 验收测试
-
-### 4.1 功能验收
-
-| 编号 | 验收项 | 状态 | 验证方法 |
-|-----|--------|------|---------|
-| FAT-001 | 后端 API 正常返回版本信息 | ✅ 已实现 | 使用 curl 访问 `/api/version` |
-| FAT-002 | 前端组件正常显示版本号 | ✅ 已实现 | 在浏览器中打开 Dashboard |
-| FAT-003 | 版本号与 package.json 一致 | ✅ 已实现 | 对比三者版本号 |
-| FAT-004 | API 失败时降级显示 | ✅ 已实现 | 模拟 API 失败场景 |
-| FAT-005 | 加载状态正确显示 | ✅ 已实现 | 清除缓存，刷新页面 |
-
-### 4.2 手动测试步骤
-
-1. **启动后端服务**:
-   ```bash
-   cd /home/ubuntu/vrt-projects/projects/openclaw-agent-dashboard
-   npm start
-   ```
-
-2. **测试 API**:
-   ```bash
-   curl http://localhost:8000/api/version
-   # 预期返回包含 version, name, description 的 JSON
-   ```
-
-3. **打开浏览器**:
-   - 访问 `http://localhost:8000`
-   - 检查右下角是否显示版本号
-   - 鼠标悬停在版本号上，查看 tooltip
-
-4. **测试降级**:
-   ```bash
-   # 删除 package.json，重启服务
-   cd src/backend
-   mv ../../package.json ../../package.json.bak
-   # 重启服务后访问 /api/version
-   # 预期返回 version: "unknown"
-   ```
-
----
-
-## 5. 设计原则遵循
-
-✅ **最小侵入原则**:
-- 优先新增文件（3 个新增，2 个修改）
-- 修改内容极简（仅新增导入和注册/标签）
-
-✅ **单一数据源原则**:
-- 版本号仅从 `package.json` 读取
-- 避免多源数据导致的不一致
-
-✅ **降级优先原则**:
-- 文件读取失败返回 `version="unknown"`
-- API 始终返回 200 状态码
-- 错误日志记录，但不影响核心功能
-
-✅ **性能优先原则**:
-- 使用缓存机制，避免频繁文件读取
-- 响应时间 < 50ms（缓存后）
-
-✅ **简体中文注释**:
-- 所有新增代码使用简体中文注释
-
----
-
-## 6. 环境变量支持
-
-| 环境变量 | 类型 | 默认值 | 说明 |
-|---------|------|--------|------|
-| `DASHBOARD_BUILD_DATE` | String | 未设置 | 构建时间戳（ISO 8601 格式） |
-| `DASHBOARD_GIT_COMMIT` | String | 未设置 | Git 提交哈希（短格式） |
-
-**使用示例**:
-```bash
-export DASHBOARD_BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
-export DASHBOARD_GIT_COMMIT=$(git rev-parse --short HEAD)
-npm start
-```
-
----
-
-## 7. 兼容性分析
-
-✅ **向后兼容**:
-- 新增功能不影响现有功能
-- 不破坏现有 API 和组件
-
-✅ **依赖变更**:
-- 无新增 npm 包
-- 无新增 Python 依赖（使用标准库和现有依赖）
-
-✅ **浏览器兼容**:
-- 使用标准 Vue 3 和 TypeScript 特性
-- 支持主流浏览器（Chrome、Firefox、Safari）
-
----
-
-## 8. 已知限制与后续优化
-
-### 8.1 当前限制
-
-1. **状态管理**:
-   - 版本信息由组件独立管理，未集成到全局状态管理器
-   - 影响：其他组件无法直接访问版本信息
-
-2. **重试机制**:
-   - 未实现 API 调用失败时的自动重试
-   - 影响：网络不稳定时可能显示错误
-
-3. **构建集成**:
-   - 构建脚本未自动注入构建时间和 Git 提交
-   - 影响：需要手动设置环境变量
-
-### 8.2 后续优化建议
-
-#### 优化 1: 集成到状态管理器（P1）
-
-**目标**: 将版本信息集成到 `StateManager.ts` 和 `RealtimeDataManager.ts`
-
-**收益**:
-- 全局访问版本信息
-- 支持重试机制
-- 统一的状态管理
-
-**实现要点**:
-- 在 `StateManager.ts` 新增 `versionInfo` 字段和访问方法
-- 在 `RealtimeDataManager.ts` 实现 `loadVersionInfo()` 方法
-- 修改 `VersionDisplay.vue` 从状态管理器获取数据
-
-#### 优化 2: 构建脚本增强（P2）
-
-**目标**: 在构建时自动注入构建时间和 Git 提交哈希
-
-**收益**:
-- 自动化版本信息注入
-- 避免手动设置环境变量
-- 更精确的版本追踪
-
-**实现要点**:
-- 修改 `scripts/build-plugin.js`
-- 在构建时读取 Git 提交哈希
-- 设置环境变量或写入到配置文件
-
----
-
-## 9. 文档参考
-
-- **设计文档**: `.staging/design/VERSION_DISPLAY_design.md`
-- **设计清单**: `.staging/design_manifest.md`
-- **需求文档**: `docs/specs/VERSION_DISPLAY_spec.md`
-- **追溯清单**: `.staging/traceability_manifest.json`
-
----
-
-## 10. 总结
-
-本次实施成功完成了"界面显示版本号"功能的核心部分（P0 阶段），满足以下目标：
-
-✅ **用户体验提升**: 用户可在界面上直观地看到当前版本号  
-✅ **问题诊断优化**: 用户反馈问题时可快速提供版本信息  
-✅ **升级验证便利**: 升级后可立即确认版本号变化  
-✅ **一致性保证**: 前端显示的版本号与实际安装版本保持一致  
-
-代码质量：
-- 遵循最小侵入原则
-- 实现降级策略
-- 使用缓存机制优化性能
-- 简体中文注释清晰
-
-后续可根据实际需求，逐步实现 P1/P2 阶段的优化功能。
-
----
-
-**实施完成时间**: 2026-03-19  
-**下一阶段**: 功能测试与部署