dsh-tokenlens 1.3.6 → 1.3.7

package/CHANGELOG.md

@@ -4,9 +4,9 @@
 
 **版本记录约定**：同一发布日只保留一个章节，标题取当日**最后一个**已发布版本号；当日多次发布的改动合并到该章节，并在标题下注明当日实际发布过的版本号（npm 上仍可安装这些独立版本）。若当日已有发布，后续小改动不再单独增加版本号，而是并入下一篇日志。这样日志按天规整、不出现同日多个小版本。
 
-## 1.3.6 — 2026-11-02
+## 1.3.7 — 2026-11-02
 
-（当日已发布版本：v1.3.5 / v1.3.6）
+（当日已发布版本：v1.3.5 / v1.3.6 / v1.3.7）
 
 - feat(ui): 供应商管理页可为 **Open Design** 填写「工作区 ID」并持久化到插件配置——此前 workspaceId 只能在 profile patch 或 `OPENDESIGN_WORKSPACE_ID` 里设置，用推理 Key 配好供应商后额度卡片仍报错却无处可改
 - feat(ui): Open Design 额度失败时的引导——详情弹窗的错误条说明「额度查询需要工作区 ID 与 Control Key（不是推理 Key）」，并提供「去配置」按钮直接跳到供应商管理页
@@ -14,6 +14,7 @@
 - feat(wire): `providers[]` 仅对声明了 workspace 的适配器（Open Design）下发 `workspaceId` 字段；其余供应商不下发，客户端据此决定是否渲染输入框（旧 Host 无此字段 ⇒ 不渲染，自然降级）
 - feat(ui): Open Design 缺配置时 chip 不再按 `missing-key` 静默隐藏，而是显示「待配置」并可点进详情看引导——否则用户既看不到提示也没有入口
 - fix(tool): Agent 工具 `tokenlens_usage` 的 `updateCheck` 动作此前虽在枚举里却会落到用量读取分支，返回当前供应商的用量或错误；现在正确执行更新检查并返回 `UpdateInfo`
+- docs: 中英 README 补充 **workspace ID 与 Control Key 到底在哪里取**——workspace ID 在控制台 URL 的 `?workspaceId=`（或成员邀请页的「工作空间 ID」），Control Key 是桌面端 / `vela login` 写入 `~/.amr/config.json` 的 `profiles.prod.controlKey`；并说明用推理 Key 冒充会得到 401
 - 测试：280 → 286（workspace ID 校验/持久化/清空、管理页字段渲染与保存、缺 workspaceId 的 Host 报错与引导按钮、待配置 chip、工具 updateCheck 分发）
 
 ## 1.3.4 — 2026-11-01

package/PROTOCOL.md

@@ -112,6 +112,15 @@ A `windows` snapshot may also carry a non-null `balance` (Open Design reports
 allowance windows and a wallet independently); the Client renders it as one extra
 row at the end of the capacity card and appends the amount to the chip tooltip.
 
+`open-design` needs two credentials that the API-keys page does not provide: a
+**workspace id** (the console URL's `?workspaceId=` value) and a **Control Key**
+(the `profiles.prod.controlKey` the desktop app / `vela login` writes to
+`~/.amr/config.json`). The inference key from the Cloud API Keys page answers
+HTTP 401 on the billing endpoints. Missing either value is a `missing-key` error;
+the workspace id may be set from the management page (persisted in
+`providers.json`, v1.3.5) and the Control Key comes from `OPENDESIGN_CONTROL_KEY`,
+`VELA_CONTROL_KEY`, the credential store, or that page's key field.
+
 Rules:
 
 - `percent` is clamped to `0..100`; an unknown percentage is `null` (render "—"), never a fake 0.

package/README.en.md

@@ -109,6 +109,11 @@ Credentials come from DSH itself: providers configured in DSH inherit their `api
 
 Open Design (OpenDesign) is the exception: its read-only billing API needs a **workspace ID** plus a **Control Key** (`OPENDESIGN_CONTROL_KEY` or `VELA_CONTROL_KEY`), which is *not* the inference API key from the Cloud API Keys page. Set the workspace ID right on the provider management page's Open Design card (v1.3.5, stored in the plugin's own config and kept across restarts), under `providers.open-design.workspaceId`, or via `OPENDESIGN_WORKSPACE_ID`; provide the Control Key through the environment, DSH credentials, or the management page's key field. When either is missing the detail dialog names the missing piece and offers a 「去配置 / Configure」 button instead of a generic missing-key error.
 
+**Where the two values come from.** Neither is on the Cloud API Keys page.
+
+- *Workspace ID* — the console keeps it in the URL: open 套餐与余额 (or 成员) and read `open-design.ai/cloud/dashboard?workspaceId=<the id>`; the member-invite confirmation page also prints it as 「工作空间 ID」.
+- *Control Key* — a session credential that the Open Design desktop app / `vela` CLI writes to `~/.amr/config.json` when you sign in (`profiles.prod.controlKey`). Sign in once with the desktop app, or run `vela login` and approve the browser prompt, then copy that value (or point the plugin at it). Pasting the inference key instead makes the quota call answer HTTP 401.
+
 See the [Chinese README](README.md) for the full configuration reference, preview and provider tables.
 
 ## Supported providers and harnesses

package/README.md

@@ -195,6 +195,47 @@ dsh plugin --profile <profile> remove dsh-tokenlens
 - **Open Design（OpenDesign）** 的额度查询需要 OpenDesign Cloud 的 **workspace ID + Control Key**（`OPENDESIGN_CONTROL_KEY` 或 `VELA_CONTROL_KEY`），**不是** Cloud API Keys 页的推理 Key（推理 Key 只能调用模型）。workspace ID 可直接在[供应商管理页](#供应商管理)的 Open Design 卡片里填写（v1.3.5，保存在插件自己的配置里，重启后仍在），或写在 provider 配置里，或用 `OPENDESIGN_WORKSPACE_ID` 环境变量；Control Key 通过环境变量 / DSH 凭据 / 管理页的 Key 输入框提供。
 - 配置不全时，详情弹窗会说明缺哪一项并提供「去配置」按钮，而不是只显示一个笼统的「没有找到该供应商的 API Key」。
 
+### 拿到 Open Design 的 workspace ID 与 Control Key
+
+这两样都**不在** Cloud 控制台的 API Keys 页面（那里只有推理 Key）。具体步骤：
+
+**1. workspace ID**
+
+控制台的页面路由里带着它，任选一种：
+
+- 在 Cloud 控制台里随便点进「套餐与余额」或「成员」，看地址栏：`open-design.ai/cloud/dashboard?workspaceId=<这一串>`；把 `workspaceId=` 后面的值复制出来即可。
+- 或者打开「成员」页 → 邀请成员，邀请确认页会以「工作空间 ID」为标签直接显示这个值。
+- 或者装了桌面端时，本机 `~/.amr/config.json` 的 `profiles.prod` 里也记录了当前会话对应的 workspace（键名 `controlKey` 同级的配置块）。
+
+**2. Control Key**
+
+Control Key 是 **Open Design 桌面端/CLI 登录时写入本机的会话凭据**，不是控制台上可以生成的一串字。它由桌面客户端或 `vela` CLI 在登录后写进 `~/.amr/config.json`：
+
+```jsonc
+// ~/.amr/config.json（Windows: C:\Users\<你>\.amr\config.json）
+{
+  "profiles": {
+    "prod": {
+      "controlKey": "……",   // ← 这就是额度查询要的 Control Key
+      "runtimeKey": "……"
+    }
+  }
+}
+```
+
+取得它的方式（任选一种）：
+
+- **桌面端登录一次**：安装并启动 Open Design 桌面端 → 登录 Cloud 账号。客户端完成登录后会在本机写入 `~/.amr/config.json`（同时 CLI 也已就位）。
+- **CLI 登录**：在装有 `vela` 命令的机器上执行 `vela login`，按终端提示打开激活链接、在浏览器里确认（"Approve CLI login"），完成后同样写入 `~/.amr/config.json`。
+- 已有 `~/.amr/config.json` 的话直接打开取 `profiles.prod.controlKey` 即可。
+
+拿到后两种放法：
+
+- 写进 `$DSH_HOME/.credentials.yaml` 的 `refs:` 下：`OPENDESIGN_CONTROL_KEY: <control key>`（或环境变量 `OPENDESIGN_CONTROL_KEY` / `VELA_CONTROL_KEY`）；
+- workspace ID 在插件的[供应商管理页](#供应商管理) Open Design 卡片里填写，或用 `OPENDESIGN_WORKSPACE_ID` 环境变量。
+
+> 这也解释了最容易踩的坑：**用推理 Key 填 Control Key** 会让额度查询返回 401。插件已经区分这两种凭据，缺哪一项都会指名道姓地提示。
+
 解析顺序（先命中先用）：DSH 凭据服务 → 环境变量 → `$DSH_HOME/.credentials.yaml` → OpenCode CLI 的 `auth.json`（仅默认的 `OPENCODE_GO_API_KEY` 引用）。
 
 凭据只在 Host 进程内解析，**不会**下发到浏览器、**不会**写入日志或诊断输出（诊断只显示来源与引用名，不显示明文）。

package/index.js

@@ -76,7 +76,7 @@ export const inject = []
 export const PLUGIN_NAME = 'dsh-tokenlens'
 
 /** Plugin version; mirrors package.json (kept here so diagnostics need no fs read). */
-export const PLUGIN_VERSION = '1.3.6'
+export const PLUGIN_VERSION = '1.3.7'
 
 /** Documented defaults; every field of the raw row config is optional. */
 const DEFAULTS = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-tokenlens",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "type": "module",
   "description": "dsh-TokenLens (词元透镜) — provider-aware plan capacity plus local token statistics (today/7d/30d/all-time, by harness/provider/model/workspace) for DSH.",
   "license": "MIT",