dsh-connect 0.7.2 → 0.9.0

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.
Files changed (153) hide show
  1. package/README.i18n.yaml +2 -2
  2. package/README.md +196 -43
  3. package/README.zh.md +171 -42
  4. package/client/client.js +817 -0
  5. package/client/client.js.map +7 -0
  6. package/client/locale.mjs +227 -0
  7. package/client/panel-state.mjs +54 -0
  8. package/client/settings-client.mjs +389 -0
  9. package/docs/images/settings-advanced-en.png +0 -0
  10. package/docs/images/settings-advanced-zh.png +0 -0
  11. package/docs/images/settings-defaults-en.png +0 -0
  12. package/docs/images/settings-defaults-zh.png +0 -0
  13. package/docs/images/settings-overview-en.png +0 -0
  14. package/docs/images/settings-overview-zh.png +0 -0
  15. package/examples/minimal.config.json +16 -0
  16. package/lib/binding.d.ts.map +1 -1
  17. package/lib/binding.js +2 -2
  18. package/lib/binding.js.map +1 -1
  19. package/lib/channels/dingtalk/adapter.d.ts +59 -0
  20. package/lib/channels/dingtalk/adapter.d.ts.map +1 -0
  21. package/lib/channels/dingtalk/adapter.js +123 -0
  22. package/lib/channels/dingtalk/adapter.js.map +1 -0
  23. package/lib/channels/dingtalk/i18n.d.ts +14 -0
  24. package/lib/channels/dingtalk/i18n.d.ts.map +1 -0
  25. package/lib/channels/dingtalk/i18n.js +16 -0
  26. package/lib/channels/dingtalk/i18n.js.map +1 -0
  27. package/lib/channels/dingtalk/index.d.ts +127 -0
  28. package/lib/channels/dingtalk/index.d.ts.map +1 -0
  29. package/lib/channels/dingtalk/index.js +144 -0
  30. package/lib/channels/dingtalk/index.js.map +1 -0
  31. package/lib/channels/dingtalk/message.d.ts +49 -0
  32. package/lib/channels/dingtalk/message.d.ts.map +1 -0
  33. package/lib/channels/dingtalk/message.js +50 -0
  34. package/lib/channels/dingtalk/message.js.map +1 -0
  35. package/lib/channels/dingtalk/stomp.d.ts +36 -0
  36. package/lib/channels/dingtalk/stomp.d.ts.map +1 -0
  37. package/lib/channels/dingtalk/stomp.js +107 -0
  38. package/lib/channels/dingtalk/stomp.js.map +1 -0
  39. package/lib/channels/dingtalk/stream.d.ts +53 -0
  40. package/lib/channels/dingtalk/stream.d.ts.map +1 -0
  41. package/lib/channels/dingtalk/stream.js +199 -0
  42. package/lib/channels/dingtalk/stream.js.map +1 -0
  43. package/lib/channels/dingtalk/webhook.d.ts +84 -0
  44. package/lib/channels/dingtalk/webhook.d.ts.map +1 -0
  45. package/lib/channels/dingtalk/webhook.js +143 -0
  46. package/lib/channels/dingtalk/webhook.js.map +1 -0
  47. package/lib/channels/feishu/adapter.d.ts +133 -0
  48. package/lib/channels/feishu/adapter.d.ts.map +1 -0
  49. package/lib/channels/feishu/adapter.js +662 -0
  50. package/lib/channels/feishu/adapter.js.map +1 -0
  51. package/lib/channels/feishu/i18n.d.ts +30 -0
  52. package/lib/channels/feishu/i18n.d.ts.map +1 -0
  53. package/lib/channels/feishu/i18n.js +42 -0
  54. package/lib/channels/feishu/i18n.js.map +1 -0
  55. package/lib/channels/feishu/index.d.ts +82 -0
  56. package/lib/channels/feishu/index.d.ts.map +1 -0
  57. package/lib/channels/feishu/index.js +103 -0
  58. package/lib/channels/feishu/index.js.map +1 -0
  59. package/lib/channels/feishu/onboard.d.ts +16 -0
  60. package/lib/channels/feishu/onboard.d.ts.map +1 -0
  61. package/lib/channels/feishu/onboard.js +86 -0
  62. package/lib/channels/feishu/onboard.js.map +1 -0
  63. package/lib/channels/telegram/adapter.d.ts +70 -0
  64. package/lib/channels/telegram/adapter.d.ts.map +1 -0
  65. package/lib/channels/telegram/adapter.js +460 -0
  66. package/lib/channels/telegram/adapter.js.map +1 -0
  67. package/lib/channels/telegram/client.d.ts +115 -0
  68. package/lib/channels/telegram/client.d.ts.map +1 -0
  69. package/lib/channels/telegram/client.js +198 -0
  70. package/lib/channels/telegram/client.js.map +1 -0
  71. package/lib/channels/telegram/i18n.d.ts +14 -0
  72. package/lib/channels/telegram/i18n.d.ts.map +1 -0
  73. package/lib/channels/telegram/i18n.js +18 -0
  74. package/lib/channels/telegram/i18n.js.map +1 -0
  75. package/lib/channels/telegram/index.d.ts +46 -0
  76. package/lib/channels/telegram/index.d.ts.map +1 -0
  77. package/lib/channels/telegram/index.js +54 -0
  78. package/lib/channels/telegram/index.js.map +1 -0
  79. package/lib/channels/web/adapter.d.ts +103 -0
  80. package/lib/channels/web/adapter.d.ts.map +1 -0
  81. package/lib/channels/web/adapter.js +161 -0
  82. package/lib/channels/web/adapter.js.map +1 -0
  83. package/lib/channels/web/index.d.ts +47 -0
  84. package/lib/channels/web/index.d.ts.map +1 -0
  85. package/lib/channels/web/index.js +59 -0
  86. package/lib/channels/web/index.js.map +1 -0
  87. package/lib/chat-key.d.ts +29 -0
  88. package/lib/chat-key.d.ts.map +1 -0
  89. package/lib/chat-key.js +38 -0
  90. package/lib/chat-key.js.map +1 -0
  91. package/lib/index.d.ts +78 -11
  92. package/lib/index.d.ts.map +1 -1
  93. package/lib/index.js +312 -9
  94. package/lib/index.js.map +1 -1
  95. package/lib/runner.d.ts +55 -2
  96. package/lib/runner.d.ts.map +1 -1
  97. package/lib/runner.js +158 -23
  98. package/lib/runner.js.map +1 -1
  99. package/lib/scheduler.d.ts.map +1 -1
  100. package/lib/scheduler.js +2 -2
  101. package/lib/scheduler.js.map +1 -1
  102. package/lib/service.d.ts +17 -1
  103. package/lib/service.d.ts.map +1 -1
  104. package/lib/service.js +47 -3
  105. package/lib/service.js.map +1 -1
  106. package/lib/settings/channel-runtime.d.ts +75 -0
  107. package/lib/settings/channel-runtime.d.ts.map +1 -0
  108. package/lib/settings/channel-runtime.js +165 -0
  109. package/lib/settings/channel-runtime.js.map +1 -0
  110. package/lib/settings/channels.d.ts +62 -0
  111. package/lib/settings/channels.d.ts.map +1 -0
  112. package/lib/settings/channels.js +132 -0
  113. package/lib/settings/channels.js.map +1 -0
  114. package/lib/settings/credential-store.d.ts +85 -0
  115. package/lib/settings/credential-store.d.ts.map +1 -0
  116. package/lib/settings/credential-store.js +142 -0
  117. package/lib/settings/credential-store.js.map +1 -0
  118. package/lib/settings/index.d.ts +14 -0
  119. package/lib/settings/index.d.ts.map +1 -0
  120. package/lib/settings/index.js +14 -0
  121. package/lib/settings/index.js.map +1 -0
  122. package/lib/settings/namespace.d.ts +175 -0
  123. package/lib/settings/namespace.d.ts.map +1 -0
  124. package/lib/settings/namespace.js +200 -0
  125. package/lib/settings/namespace.js.map +1 -0
  126. package/lib/settings/rpc-client.d.ts +36 -0
  127. package/lib/settings/rpc-client.d.ts.map +1 -0
  128. package/lib/settings/rpc-client.js +45 -0
  129. package/lib/settings/rpc-client.js.map +1 -0
  130. package/lib/settings/secret-disclosure.d.ts +50 -0
  131. package/lib/settings/secret-disclosure.d.ts.map +1 -0
  132. package/lib/settings/secret-disclosure.js +132 -0
  133. package/lib/settings/secret-disclosure.js.map +1 -0
  134. package/lib/settings/settings-model.d.ts +124 -0
  135. package/lib/settings/settings-model.d.ts.map +1 -0
  136. package/lib/settings/settings-model.js +118 -0
  137. package/lib/settings/settings-model.js.map +1 -0
  138. package/lib/settings/settings-rpc.d.ts +130 -0
  139. package/lib/settings/settings-rpc.d.ts.map +1 -0
  140. package/lib/settings/settings-rpc.js +233 -0
  141. package/lib/settings/settings-rpc.js.map +1 -0
  142. package/lib/settings/settings-service.d.ts +35 -0
  143. package/lib/settings/settings-service.d.ts.map +1 -0
  144. package/lib/settings/settings-service.js +171 -0
  145. package/lib/settings/settings-service.js.map +1 -0
  146. package/lib/state-dir.d.ts +28 -0
  147. package/lib/state-dir.d.ts.map +1 -0
  148. package/lib/state-dir.js +33 -0
  149. package/lib/state-dir.js.map +1 -0
  150. package/lib/stream.d.ts.map +1 -1
  151. package/lib/stream.js +3 -2
  152. package/lib/stream.js.map +1 -1
  153. package/package.json +56 -12
package/README.zh.md CHANGED
@@ -2,16 +2,16 @@
2
2
 
3
3
  [English](README.md) | 中文
4
4
 
5
- **与渠道无关的核心**,用于将 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(**DSH**)智能体连接到聊天平台(飞书 / Lark、Telegram、钉钉,更多平台陆续到来):会话绑定、智能体驱动、流式回复桥接、交互式菜单卡片与本地命令。
5
+ **多合一插件**,将 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(**DSH**)智能体连接到聊天平台(飞书 / Lark、Telegram、钉钉,以及 Web 镜像,更多平台陆续到来):会话绑定、智能体驱动、流式回复桥接、交互式菜单卡片、本地命令,以及 Web 设置栈。
6
6
 
7
- > 请与渠道适配器一起安装——例如 [dsh-connect-feishu](https://www.npmjs.com/package/dsh-connect-feishu)、[dsh-connect-telegram](https://www.npmjs.com/package/dsh-connect-telegram) 或仅推送的 [dsh-connect-dingtalk](https://www.npmjs.com/package/dsh-connect-dingtalk)——或可选的 [dsh-connect-web](https://www.npmjs.com/package/dsh-connect-web) 镜像监视器。
7
+ > 一次安装、一份配置:核心 `connect` 服务、全部通道适配器(feishu / telegram / dingtalk / web)以及 Web 设置栈都内置在这个包里。通过 `channels` 选择器启用你要用的通道。此前的拆分包(`dsh-connect-feishu`、`dsh-connect-telegram`、`dsh-connect-dingtalk`、`dsh-connect-web`)与 `dsh-connect-all` 合集已不存在。
8
8
 
9
9
  ## 概述
10
10
 
11
11
  `dsh-connect` 将聊天会话绑定到 DSH 智能体会话并端到端驱动它:
12
12
 
13
13
  - **会话绑定与路由** —— 一个聊天 ⇄ 一个智能体会话,持久化保存在 `bindings.json` 路由存储中;会话可以创建、恢复、切换、清除,并镜像到 DSH Web GUI。
14
- - **流式回复** —— DSH 的 `assistant/chunk` 事件被桥接到渠道的原生流式能力(飞书打字机卡片):思考提示开启推理阶段,推理内容带可读的段落分隔实时流出,工具调用显示为 `🔧` 进度行,心跳保活机制即使在长时间静默时(首个 token 等待过长、密集工具运行)也会让卡片保持更新,绝不会一直卡在「思考中…」。
14
+ - **流式回复** —— 模型的实时增量被桥接到渠道的原生流式能力(飞书打字机卡片):思考提示开启推理阶段,推理内容带可读的段落分隔实时流出,工具调用显示为 `🔧` 进度行,心跳保活机制即使在长时间静默时(首个 token 等待过长、密集工具运行)也会让卡片保持更新,绝不会一直卡在「思考中…」。runner 保持两路订阅,因为 `0.1.5-rc.2` 把原本合二为一的东西拆开了:持久的 `session/event` 流承载回合、工具与结算,瞬时的 `agent/assistant-stream` 帧承载模型增量 —— 过去同时承载两者的 `assistant/chunk` 会话事件已被删除。
15
15
  - **通知级别** —— 按聊天控制过程流式的详细程度:`尽量输出过程`(完整过程)/ `输出重要节点`(关键节点)/ `只输出结果`(仅结果)。可随时通过设置菜单或 `/notify` 切换;选择按聊天持久化并立即生效。
16
16
  - **任务结束统计** —— 每个任务结束后,一张紧凑卡片报告所用模型、输入/输出 token、耗时与上下文窗口占用,并在上下文接近占满时建议 `/compact`。
17
17
  - **交互式菜单** —— 状态、任务、历史、目标、日程、模型/努力度切换、工作区选择、语言等按钮卡片(参见聊天内的 `/` 命令)。
@@ -25,10 +25,12 @@
25
25
 
26
26
  | 方面 | 值 |
27
27
  |---|---|
28
- | DSH 版本 | `^0.1.0-rc.6`(peer `@deepseek-ai/dsh-agent`、`dsh-llm`、`dsh-session`) |
28
+ | DSH 版本 | `^0.1.5-rc.2`(peer `@deepseek-ai/dsh-agent`、`dsh-llm`、`dsh-session`) |
29
29
  | Cordis | `^4.0.1` |
30
30
  | Node.js | ≥ 20(ESM,`NodeNext`) |
31
- | 最后验证 | **2026-08-16**,在 Windows(飞书 WebSocket 传输)上针对 DSH `0.1.0-rc.6` 验证 |
31
+ | 最后验证 | **2026-09-21**,在 Windows 上针对 DSH `0.1.5-rc.2` 验证(宿主加载、飞书 WebSocket 传输、Web 设置面板) |
32
+
33
+ **peer 版本线必须与宿主保持同步。** 上游不提供 changelog 或迁移说明,因此过期的版本范围是插件与静默损坏之间唯一的屏障:DSH `0.1.5-rc.2` 直接删除了 `Session.events` 访问器和 `assistant/chunk` 事件类型,而所有 `dsh-*` 包共用同一条版本线。升级 DSH 时,请把 `dsh-agent`、`dsh-llm`、`dsh-session` 的 `peerDependencies`(以及 `devDependencies`)**一起**上调,重新运行 `tsc`,并重跑测试套件 —— 当版本范围与宿主版本不再有交集时,就是桥接需要再次迁移的信号。
32
34
 
33
35
  插件运行在 DSH **Host 平面**(进程级单例服务)上,而不是在智能体预设内部。
34
36
 
@@ -37,31 +39,28 @@
37
39
  插件管理是 DSH profile 中对 pnpm 的轻量封装:
38
40
 
39
41
  ```sh
40
- # Install (core + Feishu adapter)
41
- dsh plugin --profile web add dsh-connect dsh-connect-feishu
42
-
43
- # Optional: Web mirror monitor
44
- dsh plugin --profile web add dsh-connect-web
42
+ # 安装唯一的多合一插件(核心 + 全部通道适配器 + Web 设置)
43
+ dsh plugin --profile web add dsh-connect
45
44
  ```
46
45
 
47
46
  **升级**
48
47
 
49
48
  ```sh
50
- dsh plugin --profile web update dsh-connect dsh-connect-feishu
49
+ dsh plugin --profile web update dsh-connect
51
50
  ```
52
51
 
53
52
  **禁用** —— 在 profile patch 中将 bundle 注册的条目覆盖为 `disabled: true`(参见 `~/.dsh/profiles/<profile>/cordis.patch.yml`):
54
53
 
55
54
  ```yaml
56
- - id: connect # set disabled: true (and connect-feishu) to disable
55
+ - id: connect
57
56
  name: dsh-connect
58
57
  disabled: true
59
58
  ```
60
59
 
61
- **彻底移除** —— 卸载软件包并删除它们产生的数据:
60
+ **彻底移除** —— 卸载软件包并删除它产生的数据:
62
61
 
63
62
  ```sh
64
- dsh plugin --profile web remove dsh-connect dsh-connect-feishu
63
+ dsh plugin --profile web remove dsh-connect
65
64
  # then remove the plugin data (see "Permissions & data" below):
66
65
  rm -rf .dsh-connect # binding route store (stateDir)
67
66
  rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
@@ -70,36 +69,37 @@ rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
70
69
  ## 快速开始
71
70
 
72
71
  1. **安装插件**(见上文)。
73
- 2. **添加最小配置**到 `~/.dsh/profiles/<profile>/cordis.patch.yml`(另见 [`examples/profile-cordis.patch.yml`](../../examples/profile-cordis.patch.yml))。这些插件会通过各自的 bundle 清单自动注册,因此这里只需要**覆盖(override)**它们的配置——**不要**再用 `insert` 重新插入(重复的 `id` 会让 dsh 启动失败):
72
+ 2. **添加最小配置**到 `~/.dsh/profiles/<profile>/cordis.patch.yml` —— 配置形状见 [`examples/minimal.config.json`](examples/minimal.config.json),带完整注释的版本是仓库里的 [`examples/profile-cordis.patch.yml`](https://github.com/IvanWu2015/dsh-connect/blob/main/examples/profile-cordis.patch.yml)(该路径不在发布产物内,故用绝对链接)。该插件会通过其 bundle 清单自动注册,因此这里只需要**覆盖(override)**它的配置——**不要**再用 `insert` 重新插入(重复的 `id` 会让 dsh 启动失败):
74
73
 
75
74
  ```yaml
76
75
  - id: connect
77
76
  name: dsh-connect
78
77
  # workDir: D:\your\workdir # agent working directory (default: process cwd)
79
- - id: connect-feishu
80
- name: dsh-connect-feishu
81
78
  config:
82
- appId: cli_xxxx
83
- appSecret: cli_secret_xxxx
84
- transport: websocket
85
- requireMention: true
86
- dmMode: open
79
+ channels: [feishu] # 启用哪些通道;省略 = 全部内置
80
+ # channelDefaults: { language: zh } # 应用到未单独设置该键的每个通道
81
+ feishu:
82
+ appId: cli_xxxx
83
+ appSecret: cli_secret_xxxx
84
+ transport: websocket
85
+ requireMention: true
86
+ dmMode: open
87
87
  ```
88
88
 
89
- 3. **启动宿主** —— `dsh web`(或 `dsh run`)。未配置凭据时,`dsh-connect-feishu` 会进入**一键开通**流程:扫描日志中的二维码 / 打开链接以授权机器人。
89
+ 3. **启动宿主** —— `dsh web`(或 `dsh run`)。未配置凭据时,`feishu` 通道会进入**一键开通**流程:扫描日志中的二维码 / 打开链接以授权机器人。
90
90
  4. **在飞书中给机器人发一条消息**。机器人以流式卡片回复;`/help` 列出所有命令;会话也会自动出现在 DSH Web GUI 中(自动镜像)。
91
91
 
92
- 一个完全可复现的示例是 `examples/` 文件夹加上 `docs/feishu-setup.zh.md`(飞书应用创建、事件订阅、发布)。
92
+ 一个完全可复现的示例是 [`examples/`](examples/) 文件夹加上仓库里的[飞书配置手册](https://github.com/IvanWu2015/dsh-connect/blob/main/docs/feishu-setup.zh.md)(飞书应用创建、事件订阅、发布)。
93
93
 
94
94
  ## 配置
95
95
 
96
- 配置位于 DSH profile patch(`cordis.patch.yml`)中每个插件的 `config:` 下。项目根目录(或其父目录)中的 `dsh.shared.config.json` 可以提供工作区/状态默认值,并对这些键具有更高优先级。
96
+ 配置位于 DSH profile patch(`cordis.patch.yml`)中该插件的 `config:` 下。项目根目录(或其父目录)中的 `dsh.shared.config.json` 可以提供工作区/状态默认值,并对这些键具有更高优先级。
97
97
 
98
98
  ### `dsh-connect`(核心)
99
99
 
100
100
  | 键 | 默认值 | 说明 |
101
101
  |---|---|---|
102
- | `agentPreset` | roster default | 组合进每个绑定会话的智能体预设 id |
102
+ | `agentPreset` | roster default | 组合进每个绑定会话的智能体预设 id。解析是尽力而为的:先试配置的 id,再试 `standard`(或 roster 中第一个可挂载项);两者都组合不出来时,智能体不带预设构建,回合照常运行。因此一个过期的 id 只会降级并留下日志,而不会让每条消息都失败。 |
103
103
  | `workDir` | process cwd | 每个绑定智能体的绝对工作目录 |
104
104
  | `workspaces` | `[]` | `/dir` 选择器提供的额外工作区 |
105
105
  | `visionModel` | auto-detected | 当主模型无法查看图片时,用于描述图片的 `{ provider, model }` |
@@ -109,10 +109,18 @@ rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
109
109
  | `stateDir` | `.dsh-connect` | 保存 `bindings.json` 路由存储的目录(环境变量 `DSH_CONNECT_STATE_DIR` 可覆盖) |
110
110
  | `autoMirror` | `true` | 为每个新会话自动创建 Web GUI 镜像 |
111
111
  | `streamHeartbeatMs` | `60000` | 流式卡片的心跳保活间隔(毫秒);`0` 表示禁用 |
112
- | `notifyLevel` | `important` | 默认通知级别:`full`(全部流式输出)/ `important`(关键节点)/ `result`(仅结果);可通过设置菜单或 `/notify` 按聊天覆盖 |
112
+ | `notifyLevel` | `result` | 默认通知级别:`full`(全部流式输出)/ `important`(关键节点)/ `result`(仅结果,默认);可通过设置菜单或 `/notify` 按聊天覆盖 |
113
113
  | `progressTimeoutMs` | `300000` | 主动进度通知间隔(毫秒):当一轮对话在此时间内没有发送独立卡片/文本时,状态卡片会报告最新节点;`0` 表示禁用;可通过设置菜单或 `/progress` 按聊天覆盖 |
114
114
 
115
- ### `dsh-connect-feishu`(适配器)
115
+ ### 公共(所有通道)
116
+
117
+ | 键 | 默认值 | 说明 |
118
+ |---|---|---|
119
+ | `channels` | 全部内置 | 启用哪些通道:`feishu` / `telegram` / `dingtalk` / `web`。省略则启用全部内置通道。 |
120
+ | `channelDefaults` | `{}` | 应用到未单独设置该键的每个通道(如 `{ language: "zh" }`)。 |
121
+ | `settingsStatePath` | `<stateDir>/dsh-connect-settings.json` | Web 设置面板镜像非密钥配置的路径。默认落在 `stateDir` **之内**的 `dsh-connect-settings.json`,与 `bindings.json` 同目录,二者不会各说各话;设置该键可覆盖。自 0.9.0 起,面板的权威数据源是 `$DSH_HOME/settings.yaml` 里的 `dsh-connect` 段(见[用户设置](#用户设置)),本文件只是旧版 `/dsh-connect` RPC 读写的兼容镜像。 |
122
+
123
+ ### `feishu`(飞书 / Lark 通道)
116
124
 
117
125
  | 键 | 默认值 | 说明 |
118
126
  |---|---|---|
@@ -137,11 +145,42 @@ rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
137
145
 
138
146
  **敏感项** —— `appSecret`、`verificationToken`、`encryptKey` 和 `feishu-credentials.json`。优先使用环境变量或一键开通;切勿将它们提交到版本控制。
139
147
 
148
+ ### `telegram`(Telegram 通道)
149
+
150
+ | 键 | 默认值 | 说明 |
151
+ |---|---|---|
152
+ | `botToken` | 环境变量 `TELEGRAM_BOT_TOKEN` | 来自 @BotFather 的机器人 token(**机密**) |
153
+ | `requireMention` | `true` | 群聊仅在 @提及机器人(或回复机器人自己发的消息)时响应 |
154
+ | `pollingTimeoutSeconds` | `50` | `getUpdates` 长轮询超时(秒) |
155
+ | `baseUrl` | — | 可选:Bot API 基地址覆盖(如本地 Bot API 服务器) |
156
+ | `language` | `zh` | 面向用户的消息语言:`zh` / `en` |
157
+
158
+ ### `dingtalk`(钉钉通道)
159
+
160
+ | 键 | 默认值 | 说明 |
161
+ |---|---|---|
162
+ | `webhookUrl` | 环境变量 `DINGTALK_WEBHOOK_URL` | 群自定义机器人 webhook(主动推送) |
163
+ | `secret` | 环境变量 `DINGTALK_WEBHOOK_SECRET` | 仅启用加签时的 `SEC…` 密钥 |
164
+ | `stream.clientId` / `stream.clientSecret` | 环境变量 `DINGTALK_STREAM_CLIENT_ID` / `DINGTALK_STREAM_CLIENT_SECRET` | 双向 stream 模式应用凭据(**机密**,嵌套在 `stream` 下) |
165
+ | `stream.requireMention` | `true` | 群回复需要 @提及(stream 模式) |
166
+ | `defaultAt` | — | 每次推送默认合并的 @列表(`{ mobiles, userIds, all }`) |
167
+ | `language` | `zh` | 面向用户的消息语言:`zh` / `en` |
168
+
169
+ ### `web`(Web 镜像通道)
170
+
171
+ | 键 | 默认值 | 说明 |
172
+ |---|---|---|
173
+ | `pollIntervalMs` | `1000` | 镜像会话轮询间隔(毫秒) |
174
+
175
+ 环境变量(`FEISHU_*`、`TELEGRAM_*`、`DINGTALK_*`、`DSH_CONNECT_STATE_DIR`、`DSH_HOME`)与 DSH 凭据库是提供各通道密钥的推荐方式——Web 设置面板把密钥写入凭据库,加载时由 `injectSecrets` 注入。
176
+
140
177
  ## 权限与数据
141
178
 
142
179
  - **写入的文件**
143
180
  - `<stateDir>/bindings.json`(默认 `.dsh-connect/`)—— 聊天 ⇄ 会话路由存储(聊天键、会话 id、镜像与锁状态)。
144
- - `~/.dsh/.dsh-connect/feishu-credentials.json` —— 一键开通时保存的飞书凭据。
181
+ - `<stateDir>/dsh-connect-settings.json`(默认 `.dsh-connect/`)—— 非密钥配置的兼容镜像,见 `settingsStatePath`。
182
+ - `$DSH_HOME/settings.yaml` 的 `dsh-connect` 段 —— 经由 DSH 第一方设置机制写入,原子、加锁、保留注释。
183
+ - `~/.dsh/.dsh-connect/feishu-credentials.json` —— **旧版、只读**。一键开通过去把飞书凭据存在这里而不是凭据库,导致刚扫码授权完的用户永远看到「未配置凭据」。现在开通流程写入凭据库,已有安装会在启动时从这个文件回填一次;此后不再读写它。
145
184
  - `<workDir>/.dsh-connect-images/` —— 为用户图片/附件暂存,供智能体工具使用。
146
185
  - DSH 自身在 `~/.dsh/` 下的会话日志与设置(sessions、settings 等)。
147
186
  - **网络**
@@ -149,6 +188,90 @@ rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
149
188
  - DSH 为智能体模型调用的 LLM 提供商 API(如 DeepSeek),以及可选的视觉模型。
150
189
  - **用户数据** —— 消息文本与附件经由机器人流向智能体会话;它们与任何 DSH 会话一样保存在 DSH 会话日志中。白名单(`allowUsers` / `allowChats`)限制了可以驱动机器人的人。
151
190
 
191
+ ## 设置面板
192
+
193
+ `dsh-connect` 在 **设置 → dsh-connect** 下有自己的页面。它是一条渠道页签条 + 若干可折叠卡片:
194
+ 每张卡片由一个按钮做标题行,低频字段收在第二级的**高级选项**折叠里,保存/状态固定在滚动区底部。
195
+
196
+ | 渠道与凭据 | 展开高级选项 |
197
+ |---|---|
198
+ | ![dsh-connect 设置面板:渠道页签条、展开的飞书卡片及其凭据字段,以及三张收起后仍显示凭据徽标的渠道卡片](docs/images/settings-overview-zh.png) | ![同一面板展开某渠道的「高级选项」折叠,露出回调端口与回调路径字段](docs/images/settings-advanced-zh.png) |
199
+
200
+ ![面板底部的公共默认卡片与固定保存条](docs/images/settings-defaults-zh.png)
201
+
202
+ 英文截图:[概览](docs/images/settings-overview-en.png) · [高级](docs/images/settings-advanced-en.png) · [公共默认](docs/images/settings-defaults-en.png)。
203
+
204
+ > 截图取自一个凭据全是占位符的一次性 profile。上面没有任何真实密钥 —— 也不可能有:宿主会在
205
+ > 值到达浏览器之前完成打码(见下文[面板回显与脱敏](#面板回显与脱敏))。
206
+
207
+ 卡片默认展开你已启用的渠道(一个都没启用时展开第一个)。点击页签会展开对应卡片并滚进视野,
208
+ **不会**收起其他卡片 —— 多张同时展开是合法状态。收起是**卸载**卡片主体而不是隐藏它,这之所
209
+ 以安全,是因为你刚输入但尚未保存的密钥存在面板自身的 state 里,而不在卡片里。勾选某渠道的
210
+ 启用框同样会展开它。
211
+
212
+ ## 用户设置
213
+
214
+ Web 设置面板(**设置** 下的 `dsh-connect`)编辑的是 `$DSH_HOME/settings.yaml` 里的
215
+ `dsh-connect` 段,走 DSH 自带的(第一方)设置机制。该文档支持热重载、在文件锁下原子写入、
216
+ 并保留你的注释——所以手工编辑它同样有效,改动无需重启即可生效。
217
+
218
+ 取值分三层解析,越靠后越具体:
219
+
220
+ 1. 插件内置的 schema 默认值;
221
+ 2. 插件自己的 `cordis.patch.yml` 条目(你现有的配置**不会**被丢弃,它注册为基础层);
222
+ 3. `settings.yaml` 中的 `dsh-connect` 段。
223
+
224
+ **密钥永远不会写入 `settings.yaml`。** 那是一份普通的、鼓励用户贴进 issue 的文档;凭据
225
+ 一律保存在 DSH 凭据库(`ctx.credentials`)——一键开通流程与 `FEISHU_*` 这类环境变量也
226
+ 正是写在那里。
227
+
228
+ 旧版 `/dsh-connect` HTTP RPC 为面板兼容而保留;它现在读写同一个 namespace,并把非密钥配置
229
+ 镜像到 `settingsStatePath`(见[公共(所有通道)](#公共所有通道)),以兼容旧面板。
230
+
231
+ ### 面板回显与脱敏
232
+
233
+ 每个已保存的密钥字段下方都有一行**只读**的「当前值:…」(没有值时显示「未配置」),这样你
234
+ 不用重新输入就能确认自己填了什么。**打码在宿主侧完成**,只有一张共用的策略表
235
+ (`src/settings/secret-disclosure.ts`)——宿主按它打码,面板按它决定输入框渲染成
236
+ `password` 还是 `text`,两边因此不可能各说各话。
237
+
238
+ | 字段 | 显示方式 |
239
+ |---|---|
240
+ | `appId`、`clientId` | **完整显示**。它们是标识符而不是口令:每次出站 API 调用都会带上,厂家控制台也明文可见,遮住并不能保护什么。 |
241
+ | `appSecret`、`clientSecret`、`botToken`、`secret` | 只留头尾,例如 `a1b2…z9y8`。太短、露头露尾就等于全露的值,改为固定长度的 `••••••`。 |
242
+ | `webhookUrl`(钉钉) | **URL 感知**。保留域名、路径与参数名,只对令牌的中段打码——钉钉把令牌放在查询串里,整串打码(`https…bcde`)等于什么也确认不了。 |
243
+ | 其他 / 未列出的键 | 一律按最保守的方式打码。 |
244
+
245
+ 有两条性质无论如何都成立:
246
+
247
+ - **可用密钥不会跨线。** 值在离开宿主前就已打码,所以浏览器标签页(以及它的截图)永远拿不到
248
+ 一个可用的密钥。
249
+ - **掩码不可能被写回。** 预览是输入框**旁边**的文本,不是输入框的 `value`。输入框始终为空,
250
+ 而「空」的含义是「不动已保存的值」——因此只保存配置时,一个凭据都不会被写入。
251
+
252
+ 面板自身的全部文案(通道名、字段标签、选项文字、状态)都来自 `client/locale.mjs`,其中同时
253
+ 提供 `zh` 与 `en`。有测试断言两种语言的键集合完全一致——宿主在缺键时会静默回退到另一种语言,
254
+ 所以漏译不会报错,只会让页面变成中英混杂。
255
+
256
+ ### 凭据分组
257
+
258
+ 当某通道的**任意一组**凭据被完整满足时,该通道即视为「已配置」;而单组内必须**全部**满足
259
+ ——组内是 all-of,组间是 any-of。没有任何分组的通道(`web`)按定义就是已配置,永远不显示
260
+ 告警徽标。
261
+
262
+ 之所以要分组,是因为一个通道可能有不止一种互斥的认证方式;若要求全部满足,就会把明明能用的
263
+ 机器人误报成未配置:
264
+
265
+ | 通道 | 分组 |
266
+ |---|---|
267
+ | `feishu` | app id + app secret |
268
+ | `telegram` | bot token |
269
+ | `dingtalk` | webhook URL + 签名密钥 —— *或* —— Stream 模式的 client id + client secret |
270
+ | `web` | 无 |
271
+
272
+ 因此,只用 webhook 推送(没有 Stream 凭据)的钉钉机器人会被正确判定为已配置,只用 Stream
273
+ 模式的同样如此。
274
+
152
275
  ## 故障排查
153
276
 
154
277
  日志来自 DSH 宿主日志器(在终端运行 `dsh web`);插件消息带有 `connect:` / `connect-feishu:` 前缀。
@@ -157,44 +280,50 @@ rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
157
280
  |---|---|
158
281
  | `connect-feishu: adapter init failed` / `start failed` | 凭据错误、应用未发布或网络被阻断。检查 `appId`/`appSecret`,重新运行开通流程,确认机器人在飞书开放平台后台处于在线状态。 |
159
282
  | `connect: resume of <id> failed, creating fresh session` | 持久化会话无法恢复(工作目录缺失、持久化问题)。检查 `workDir` 和 `~/.dsh/sessions`。 |
283
+ | 机器人对每条消息都回一行原始的 `agent-presets: preset "…" not found`,内容到不了智能体 | `$DSH_HOME/settings.yaml` 里的 `agent-presets.default` 指向了任何已安装版本都不提供的 id。**0.9.0** 已修复:改为重试 `standard` 并记录决策,而不是让这一轮失败;在更旧的版本上,请把该键改成一个确实存在的 id(`standard`)。 |
160
284
  | 会话锁定提示 | 另一个客户端(飞书或 Web)持有写锁。使用 `/unlock` 或等待锁超时。 |
161
- | Web GUI 中的模型切换似乎被忽略 | 已在当前 main 中修复:插件不再用静态默认模型覆盖 Web GUI 的会话选择。重启 `dsh web` 以加载重建后的插件。 |
285
+ | Web GUI 中的模型切换似乎被忽略 | 已在 **0.9.0** 修复:插件不再用静态默认模型覆盖 Web GUI 的会话选择。升级后重启 `dsh web`。 |
162
286
  | `[用户发送了图片,但下载失败…]` | 应用缺少飞书 `im:resource` 权限;授予该权限并重新授权。 |
163
- | 流式回复是一整块没有分段 | 已在当前 main 中修复:块边界与推理/回答分隔现在会插入空行(推理软换行已针对飞书卡片扩展)。重启 `dsh web`。 |
164
- | 长时间任务中卡片卡在「思考中…」没有进展 | 已在当前 main 中修复:推理现在实时流出,工具调用显示为 `🔧` 进度行,静默期间心跳保活会更新卡片。重启 `dsh web`。 |
287
+ | 流式回复是一整块没有分段 | 已在 **0.9.0** 修复:块边界与推理/回答分隔现在会插入空行(推理软换行已针对飞书卡片扩展)。升级后重启 `dsh web`。 |
288
+ | 长时间任务中卡片卡在「思考中…」没有进展 | 已在 **0.9.0** 修复:推理现在实时流出,工具调用显示为 `🔧` 进度行,静默期间心跳保活会更新卡片。升级后重启 `dsh web`。 |
165
289
  | 菜单卡片不更新 / 过期 | 设计如此:卡片空闲 60 秒后自动关闭;重新打开菜单即可。 |
166
290
 
167
291
  **回滚** —— 重新安装之前的版本(先移除当前版本,再执行 `dsh plugin --profile web add dsh-connect@<version>`),或在源码安装中 `git checkout` 到固定的提交。
168
292
 
169
293
  ## 开发
170
294
 
171
- 这是一个 pnpm workspace;插件是 `packages/` 下相互独立的 npm 包:
295
+ 这是一个 pnpm workspace;`dsh-connect` 是 `packages/` 下的**唯一**包:
172
296
 
173
297
  ```
174
298
  packages/
175
- connect/ # 本包 — 与渠道无关的核心
176
- connect-feishu/ # 飞书 / Lark 适配器
177
- connect-telegram/ # Telegram 适配器(getUpdates 长轮询)
178
- connect-dingtalk/ # 钉钉群机器人 Webhook 推送渠道
179
- connect-web/ # 可选的 Web 镜像监视器
299
+ connect/ # 本包 — 多合一插件
300
+ src/ # 核心:runner、service、binding、commands、menus、chat key …
301
+ src/channels/ # 通道适配器:feishu / telegram / dingtalk / web
302
+ src/settings/ # Web 设置栈:宿主 RPC、凭据库、脱敏策略
303
+ client/ # Web 设置前端插件 + 其纯函数模块(locale、panel-state)
304
+ test/ # node:test 套件(run-all.mjs 导入每个套件)
305
+ docs/images/ # 本 README 引用的截图
306
+ examples/ # minimal.config.json
180
307
  ```
181
308
 
182
309
  ```sh
183
310
  pnpm install
184
311
 
185
- # build & typecheck one package
312
+ # build & typecheck the package
186
313
  pnpm --filter dsh-connect build
187
314
  pnpm --filter dsh-connect typecheck
188
315
 
189
- # unit tests (node:test)
316
+ # unit tests (node:test) — run-all.mjs 进程内导入每个套件
190
317
  pnpm test
191
318
  # or run one suite
192
319
  node packages/connect/test/unit.test.mjs
193
320
  ```
194
321
 
195
- **结构** —— `src/runner.ts` 负责每个聊天的智能体驱动与流式桥接(`applyStreamChunk` 是纯函数、有单元测试的块组装器);`src/service.ts` 负责适配器注册表与路由;`src/i18n.ts` 存放 `zh`/`en` 词典(两种语言的关键字需保持同步);`src/binding.ts` 是路由存储。
322
+ **结构** —— `src/runner.ts` 负责每个聊天的智能体驱动与流式桥接(`applyStreamChunk` 是纯函数、有单元测试的块组装器);`src/service.ts` 负责适配器注册表与路由;`src/channels/` 存放 feishu / telegram / dingtalk / web 通道适配器;`src/settings/` 存放 Web 设置栈(宿主 RPC、凭据库、脱敏策略);`src/binding.ts` 是路由存储。
323
+
324
+ 有两样东西原来是放在 `src/` 的,现在移到了 `client/`,为的是能在不引入 React 的情况下单测:**`client/locale.mjs`** 存放设置面板的全部用户可见文案(`zh` 与 `en`,两边键集合必须一致 —— 宿主在缺键时会静默渲染**另一种**语言,所以漏译表现为中英混杂,而不是报错),**`client/panel-state.mjs`** 存放卡片的展开/高级折叠规则。两者都是零依赖的纯 ESM,分别由 `test/locale.test.mjs` 与 `test/panel-state.test.mjs` 直接断言。
196
325
 
197
- **贡献** —— 欢迎在 [github.com/IvanWu2015/dsh-connect](https://github.com/IvanWu2015/dsh-connect) 提交 PR。对于面向用户的字符串,请在 `src/i18n.ts` 中同时为 `zh` 和 `en` 添加关键字。发布说明在 `CHANGELOG.md` 中;发布流程参见 `docs/PUBLISHING.zh.md`。
326
+ **贡献** —— 欢迎在 [github.com/IvanWu2015/dsh-connect](https://github.com/IvanWu2015/dsh-connect) 提交 PR。对于面向用户的面板文案,请在 `client/locale.mjs` 中同时为 `zh` 和 `en` 添加键,然后重建产物(`node scripts/build-client.mjs`)—— `test/client-bundle.test.mjs` 跑的是**构建产物**,产物过期会直接失败。发布说明在 `CHANGELOG.md` 中;发布流程参见 [`docs/PUBLISHING.zh.md`](https://github.com/IvanWu2015/dsh-connect/blob/main/docs/PUBLISHING.zh.md)。
198
327
 
199
328
  ## 许可与安全
200
329