dsh-dock 0.1.0 → 0.4.1

package/LICENSE

@@ -2,20 +2,17 @@ MIT License
 
 Copyright (c) 2026 wycto
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
+associated documentation files (the "Software"), to deal in the Software without restriction, including 
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the 
+following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial 
+portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 
+USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,107 +1,98 @@
-# dsh-dock
+# dsh-dock · 功能坞
 
 [![npm version](https://img.shields.io/npm/v/dsh-dock)](https://www.npmjs.com/package/dsh-dock)
 [![license](https://img.shields.io/npm/l/dsh-dock)](LICENSE)
 
-**DeepSeek Harness 功能中枢插件**：用一张管理面板，统一注册、开关所有小功能。
+**DeepSeek Harness 功能坞插件**：用一张管理面板，统一注册、开关所有小功能。
 
-模型余额、Token 用量记录、任务动画……这些散落的小功能，全部收进一个面板：
-每个功能是独立模块，有注册表、有开关、有错误隔离。新功能按注册表模式追加，老功能互不牵连。
+模型余额、用量记录、模型设置、图片理解代理……这些散落的小功能，全部收进一个「功能坞」：
+每个功能是独立模块，有注册表、有开关、有错误隔离。新功能按模块追加，老功能互不牵连。
 
-> 前身：本地原型 `feature-hub`（已安装验证），本包为其正式发布的 npm 版本。
-> 相关功能包：`@wycto/dsh-balance-panel`、`@wycto/dsh-token-usage`、`@wycto/dsh-task-pulse`
-> （后续按路线图吸收为中枢内的功能模块，或保持独立包并注册进中枢）。
+![功能坞首页总揽](screenshots/dock-home.png)
 
 ---
 
-## 当前状态（v0.1.0 · 基础框架）
+## 功能一览
 
-- ✅ 设置页新增一整页「功能中枢」面板（侧栏底部 → 设置 → 功能中枢）
-- ✅ 功能注册表：`FEATURES` 一处登记，面板自动渲染
-- ✅ 每功能独立开关 + 错误隔离：单个功能出错只降级自己
-- ✅ 示例功能：心跳监视、主题信息（纯 Client，开箱可用）
-- 🚧 示例功能的开关为浏览器内存态，刷新重置（持久化在 0.5.0）
-- 🚧 三个真实功能已登记为**规划占位**，面板可见但显示"规划中"
+| 功能 | 说明 |
+|---|---|
+| **用量记录** | 记录全部 LLM API 调用：秒级时间筛选、Token/费用统计（峰谷计价 + 官网价目自动同步）、分组汇总、明细检索与 CSV 导出 |
+| **模型设置** | 编辑各 Provider 模型目录：输入类型（文本/图片 + 标注）与思考强度档位；写回官方配置热生效 |
+| **模型余额** | 展示所有模型 Provider 账户余额（5 分钟自动刷新） |
+| **图片理解代理** | 图片识别等（visionproxy） |
+| **心跳监视 / 主题信息** | 示例功能（纯 Client） |
 
-## 面板入口
+**会话区随身小控件**：启用后，在会话输入区工具行（模型选择器左侧）显示——
 
-```
-设置（侧栏底部）→ 功能中枢
-```
+- **模型余额**：当前选中 Provider 的账户余额（跟随模型切换实时更新），点击打开功能坞并定位到该 Provider 的余额详情；
+- **用量记录**：当前会话的总 Token 与估算花费（10 秒静默刷新），点击打开功能坞并跳转到该会话的用量记录。
 
-## 目录结构
+![会话区余额/用量小控件](screenshots/dock-chips.png)
 
-```
-dsh-dock/
-├── index.js          # Host 半部：功能注册表 + 每功能生命周期（setup/dispose）+ 错误隔离
-├── client.js         # Client 半部：中枢面板（settings.section），浏览器 bundle，无需构建器
-├── cordis.patch.yml  # 组合层：insert 一行 dsh-dock
-├── package.json      # 双面程序包清单（dsh.bundle.patch + dsh.client）
-└── scripts/publish.sh # 一键发布（登录检查 + 预览 + publish）
-```
+勾选「启用」即显示，点芯片跳转；每个功能可在面板页脚或设置页单独设置「会话页显示/隐藏」。
 
-## 路线图（后面要干嘛）
+## 界面
 
-| 版本 | 内容 | 动哪里 |
-| --- | --- | --- |
-| **0.2.0** | 接入**模型余额**：拉取所有模型 Provider 账户余额并展示 | `index.js` 的 `hostSetups.balance` 实现拉取；打通 Client↔Host 联通（typert）；`client.js` 的 balance 占位改为真实视图 |
-| **0.3.0** | 接入 **Token 用量记录**：记录全部 LLM API 调用，支持时间范围/维度筛选与统计 | `hostSetups.tokenlog` 监听事件记账；面板加统计视图 |
-| **0.4.0** | 接入**任务动画**：任务进度动画、完成/卡住通知 | 纯 Client 功能模块；如需挂对话区，在模块内注册对应 slot（如 `conversation.composer.dock`） |
-| **0.5.0** | 开关状态**持久化**、Host↔Client 双侧注册表打通 | 状态写入持久化服务；可选依赖注册（面板不在，功能照跑） |
+点击侧栏底部「功能坞」按钮，弹出功能面板：左侧导航 = 首页总揽 + 各功能模块，右侧内容区。
 
-后续新增功能遵循同一模式：**注册表加一条 + 视图加一个**，即插即用。
+![用量记录页](screenshots/dock-tokenlog.png)
 
-## 新增一个功能（三步）
+面板支持最大化 / 最小化 / 还原、标题栏拖动、右下角缩放。
 
-1. `client.js` 的 `FEATURES` 加一条 `{ id, name, description, defaultEnabled }`；
-2. `featureViews` 加同名组件（`react.createElement` 写法，可用 `ctx.get(...)` 取 Client 服务）；
-3. 需要 Host 侧逻辑的，在 `index.js` 的 `hostSetups` 加一个返回 disposer 的函数。
+---
 
 ## 安装
 
-开发期（link 模式）：
+dsh-dock 是 DeepSeek Harness（dsh）的插件，通过 dsh 的插件市场安装：
 
-```sh
-dsh plugin --profile web add dsh-dock   # npm 版安装
-# 或本地路径：dsh plugin --profile web add /path/to/dsh-dock
+```bash
+# 在 dsh 配置中启用插件（或通过 dsh 插件命令）
+npx @deepseek-ai/dsh plugin add dsh-dock
 ```
 
-查看/卸载：
+或手动在 dsh 的 `cordis.patch.yml` 中声明后重启。
 
-```sh
-dsh web --dump-config                    # 查看合成层（含 dsh-dock）
-dsh plugin --profile web remove dsh-dock # 卸载
-```
-
-### 从 feature-hub 迁移
+要求：DeepSeek Harness 环境（dsh），Node.js 18+。
 
-本包是 feature-hub 原型的正式发布版，面板与功能几乎一致：
+## 使用方法
 
-```sh
-dsh plugin --profile web remove dsh-feature-hub
-dsh plugin --profile web add dsh-dock
-```
+1. 启动 dsh：`npx @deepseek-ai/dsh web`
+2. 打开左侧边栏底部的 **功能坞** 按钮
+3. 在 **设置 → 功能坞** 面板中启用/停用各功能模块
+4. 每个功能页内可进行具体操作（余额查询、用量统计、模型目录编辑等）
 
-（两个插件共存亦可，只是面板重复；建议迁移后移除旧版。）
+> 功能开关为浏览器内存态，刷新页面后重置（持久化在规划中）。
 
-## 开发与发布
+## 开发：新增一个功能模块
 
-- **开发提交**：Gitea 仓库（`wycto/dsh-dock`）
-- **发版**：GitHub 仓库（`github.com/wycto/dsh-dock`）打 tag 发 Release
-- **npm 发布**（无作用域名先到先得，已占用后归本账号所有）：
+每个功能是一个 `features/<id>/` 目录，由两部分组成：
 
-```sh
-cd dsh-dock
-npm login          # 首次：登录你的 npm 账号（wycto）
-scripts/publish.sh # 预览 → 登录检查 → 发布
+```
+features/<id>/
+  host.js        # 宿主半部：注册 RPC 路由 / 定时任务（纯 ESM，零构建）
+  view.js(x)     # 客户端视图：渲染面板内容（自带样式，CSS 类名带前缀隔离）
 ```
 
-> 若发布时报 `EPERM`（npm 缓存目录里有 root 属主文件的历史 bug）：
-> 修复一次 `sudo chown -R 501:20 ~/.npm`，或临时绕过
-> `CACHE_DIR=/tmp/dsh-dock-npm-cache ./scripts/publish.sh`。
+在视图模块导出功能描述符：
+
+```js
+export const feature = {
+  id: "my-feature",
+  name: "我的功能",
+  order: 160,              // 菜单排序（首页固定第一，数值越大越靠后）
+  accent: "#22c55e",       // 品牌色
+  description: "…",
+  css: "…",
+  View: MyView,            // 面板内容组件，收到 { ctx, feature, params }
+  HomeStat: MyStat,        // 可选：首页总揽卡片统计
+  Chip: MyChip,            // 可选：会话输入区小控件
+};
+```
 
-> 注：`package.json` 中仓库链接请在 Gitea/GitHub 建仓后按实际地址更新。
+外壳只做组装：宿主半部在 `index.js` 注册，客户端在外壳 `src/client.jsx` 装配。
+每个模块可整体拎出单独打包发布（`scripts/extract-feature.mjs` 生成独立包骨架，
+独立包装回后经 **dockBridge** 注册回功能坞菜单）。
 
-## License
+## 许可
 
-MIT
+[MIT](LICENSE)