dsh-key-usage 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -12
- package/client/client.js +905 -260
- package/client/client.js.map +1 -1
- package/lib/index.js +4 -1
- package/lib/live-quota.js +96 -30
- package/lib/quota-snapshots.js +68 -0
- package/lib/routes.js +70 -11
- package/lib/session-meta.js +101 -0
- package/lib/session-usage.js +33 -1
- package/lib/sessions.js +58 -4
- package/package.json +9 -3
package/README.md
CHANGED
|
@@ -59,7 +59,7 @@ dsh plugin --profile web remove dsh-key-usage
|
|
|
59
59
|
curl -s http://127.0.0.1:19387/dsh-key-usage/channels # 返回 { channels: [...] } 即已挂载
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
8 个端点全部只读 GET，且只接受 `127.0.0.1` / `::1` 回环请求，非回环一律 403。
|
|
63
63
|
|
|
64
64
|
## 功能
|
|
65
65
|
|
|
@@ -80,10 +80,18 @@ curl -s http://127.0.0.1:19387/dsh-key-usage/channels # 返回 { channels: [..
|
|
|
80
80
|
|
|
81
81
|
- 按工作目录聚合的调用数、Tokens、占比、成本与最近活跃时间，支持搜索、按通道筛选、按列排序。
|
|
82
82
|
|
|
83
|
+
**按模型**
|
|
84
|
+
|
|
85
|
+
- 按 `通道 + 模型` 聚合的调用数、Tokens、占比、缓存命中率、成本与会话数，支持搜索、按通道筛选、按列排序。
|
|
86
|
+
|
|
83
87
|
**会话用量**
|
|
84
88
|
|
|
85
89
|
- 按会话列出时间、时长、Tokens、命中率与成本，按日期分组，同样支持搜索 / 筛选 / 排序。
|
|
86
90
|
|
|
91
|
+
**导出**
|
|
92
|
+
|
|
93
|
+
- 使用明细 / 按模型 / 项目用量 / 会话用量四处都能把**当前筛选后的数据**导出成 CSV 或 JSON；CSV 带 UTF-8 BOM，Excel 打开中文不乱码。
|
|
94
|
+
|
|
87
95
|
**余额与配额**
|
|
88
96
|
|
|
89
97
|
- 每个通道一张卡片：官方余额（DeepSeek 的总余额 / 赠送 / 充值）或订阅窗口占用（opencode-go 的 5 小时 / 本周 / 本月窗口 + 重置时间）；
|
|
@@ -115,6 +123,12 @@ curl -s http://127.0.0.1:19387/dsh-key-usage/channels # 返回 { channels: [..
|
|
|
115
123
|
| 宿主 `sessionPersistence` 服务 | 项目 / 会话 / 按小时 | 只开只读句柄（`open("read") → read(0) → close`），不自行解压会话文件 |
|
|
116
124
|
| 宿主 `credentials` 服务 / 进程环境变量 | 查余额时的 API Key | 只用于拼 `Authorization` 请求头 |
|
|
117
125
|
|
|
126
|
+
**唯一写入的对象**：
|
|
127
|
+
|
|
128
|
+
| 写入对象 | 用途 | 说明 |
|
|
129
|
+
| --- | --- | --- |
|
|
130
|
+
| `$DSH_HOME/dsh-key-usage/quota-snapshots.json` | 余额 / 订阅窗口**快照** | 每次实时查询成功即落盘（原子写：临时文件 + 改名，只保留每个通道最新一份）；失败回落时与宿主那份**取更新的**。不含任何密钥，内容就是 `/quota` 返回的余额与窗口 |
|
|
131
|
+
|
|
118
132
|
**会联网的唯一路径**：打开「余额与配额」时按通道请求官方接口，结果缓存 60 秒（点「刷新」强制重查）：
|
|
119
133
|
|
|
120
134
|
| 通道 | 接口 |
|
|
@@ -126,7 +140,7 @@ curl -s http://127.0.0.1:19387/dsh-key-usage/channels # 返回 { channels: [..
|
|
|
126
140
|
请求 6 秒超时、响应上限 64 KiB、只发 `Authorization` 与 `Accept` 两个头；任何失败都回落本机快照并在卡片上说明原因。
|
|
127
141
|
|
|
128
142
|
- **不读凭据文件**：从不打开 `.credentials.yaml`；密钥不落盘、不进日志、不返回给前端；界面只显示 `apiKeyEnv` 这类**变量名**。
|
|
129
|
-
-
|
|
143
|
+
- **只写一个自己的文件**：`$DSH_HOME/dsh-key-usage/quota-snapshots.json` —— **每次余额/窗口实时查询成功**后落一份快照，下次查询失败时回落到「最近一次成功」而不是宿主那份可能很旧的快照（本机实测宿主那份已 13 天未更新）。不改宿主配置，不碰宿主的 `provider-snapshots.json`、不写其它任何数据文件。
|
|
130
144
|
- **仅回环**：所有端点只监听本机回环，非回环 403。
|
|
131
145
|
|
|
132
146
|
## 兼容与运行要求
|
|
@@ -174,35 +188,43 @@ curl -s http://127.0.0.1:19387/dsh-key-usage/channels # 返回 { channels: [..
|
|
|
174
188
|
## 开发
|
|
175
189
|
|
|
176
190
|
```bash
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
191
|
+
pnpm install # 依赖（CI 用 pnpm，见 .github/workflows/ci.yml）
|
|
192
|
+
pnpm run build # 服务端 → lib/，客户端 → client/client.js（含产物头校验）
|
|
193
|
+
pnpm run typecheck # 客户端 + 服务端类型检查
|
|
194
|
+
pnpm run test # 9 个离线测试
|
|
195
|
+
pnpm run check # lib/*.js 语法检查
|
|
196
|
+
pnpm run verify # 上面全套（CI 跑的就是这条）
|
|
197
|
+
pnpm run pack:dry # 发布清单自检
|
|
181
198
|
```
|
|
182
199
|
|
|
200
|
+
> 本目录的 `node_modules` 目前是 pnpm 10.32.1 装的；用**不同大版本**的 pnpm 执行 `pnpm run` 会触发「清空 modules 目录」而中止。此时改用 `npm run <script>`（等价），或先按 `packageManager` 字段对齐 pnpm 版本再重装依赖。
|
|
201
|
+
|
|
183
202
|
**改动生效条件**（最容易踩的坑）：
|
|
184
203
|
|
|
185
204
|
| 改动 | 生效方式 |
|
|
186
205
|
| --- | --- |
|
|
187
|
-
| `src/client/**` |
|
|
188
|
-
| `src/server/**` |
|
|
206
|
+
| `src/client/**` | `pnpm run build` → **刷新页面** |
|
|
207
|
+
| `src/server/**` | `pnpm run build` → **退出重开 DSH**（模块在宿主启动时进入 ESM 缓存，重装插件也不会重新导入） |
|
|
189
208
|
|
|
190
209
|
另外两个坑：`tsc --noEmit` **不会**更新 `lib/`，而测试读的是 `lib/*.js`；`cordis.yml` 是应用重写的组合产物，插件集变化期间会短暂变成空模板，因此通道提取会回退到 `cordis.patch.yml`。
|
|
191
210
|
|
|
211
|
+
**CI**：[`.github/workflows/ci.yml`](./.github/workflows/ci.yml) 在 push / PR 上跑 `pnpm run verify`，另加两道闸：**构建产物必须与源码同步**（`lib/`、`client/` 是要提交的）与**发布包必须含三件套**（`lib/index.js`、`client/client.js`、`cordis.patch.yml`）。发布仍是人工动作。
|
|
212
|
+
|
|
192
213
|
**目录结构**
|
|
193
214
|
|
|
194
215
|
```
|
|
195
216
|
src/client/ index.tsx（slot 注册）· UsagePage / UsageIcon · KeyUsageSection（Tab 外壳）
|
|
196
|
-
tabs/（
|
|
197
|
-
src/server/ index.ts（cordis apply）· routes.ts（
|
|
217
|
+
tabs/（6 个页面）· components/ · export.ts · styles/（CSS Module，basename 全局唯一）
|
|
218
|
+
src/server/ index.ts（cordis apply）· routes.ts（8 个只读端点）
|
|
198
219
|
ledger.ts（台账）· collect.ts（通道判定）· merge.ts（台账 × 会话按天合并）
|
|
199
|
-
live-quota.ts（官方余额实时查询 + 缓存）·
|
|
220
|
+
live-quota.ts（官方余额实时查询 + 缓存）· quota-snapshots.ts（成功即落盘，失败回落）
|
|
221
|
+
sessions.ts / session-usage.ts / session-meta.ts（会话折叠 / 标题 / 归档）
|
|
200
222
|
lib/ client/ 构建产物（发布必须带，git 与 npm 都提交）
|
|
201
223
|
```
|
|
202
224
|
|
|
203
225
|
客户端注册的是 `sidebar.panellist`（导航项）+ `main`（主区域整页），与官方 `dsh-context`「上下文洞察」同一套写法。
|
|
204
226
|
|
|
205
|
-
**延伸文档**：[架构与数据契约](./docs/01-架构与数据契约.md) · [原型差异清单](./docs/02-原型差异与优化清单.md) · [按 Tab 重构方案](./docs/03-按Tab拆分重构方案.md) · [会话归档的影响](./docs/04-归档会话的影响与对策.md) · [AGENTS.md](./AGENTS.md)
|
|
227
|
+
**延伸文档**：[架构与数据契约](./docs/01-架构与数据契约.md) · [原型差异清单](./docs/02-原型差异与优化清单.md) · [按 Tab 重构方案](./docs/03-按Tab拆分重构方案.md) · [会话归档的影响](./docs/04-归档会话的影响与对策.md) · [后续版本计划](./docs/05-后续版本计划.md) · [AGENTS.md](./AGENTS.md)
|
|
206
228
|
|
|
207
229
|
## 许可证
|
|
208
230
|
|