dsh-wecom-bot 0.4.2 → 0.5.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.
- package/README.md +130 -49
- package/dist/client.js +139 -123
- package/dist/host/bridge/commands.js +10 -4
- package/dist/host/bridge/commands.js.map +1 -1
- package/dist/host/bridge/index.js +11 -3
- package/dist/host/bridge/index.js.map +1 -1
- package/dist/host/bridge/notices.js +18 -0
- package/dist/host/bridge/notices.js.map +1 -1
- package/dist/host/config.js +31 -32
- package/dist/host/config.js.map +1 -1
- package/dist/host/groups-view.js +89 -3
- package/dist/host/groups-view.js.map +1 -1
- package/dist/host/index.js +11 -28
- package/dist/host/index.js.map +1 -1
- package/dist/host/observation.js +1 -1
- package/dist/host/observation.js.map +1 -1
- package/dist/host/routes.js +18 -13
- package/dist/host/routes.js.map +1 -1
- package/dist/host/routing.js +1 -1
- package/dist/host/routing.js.map +1 -1
- package/dist/host/runtime.js +67 -28
- package/dist/host/runtime.js.map +1 -1
- package/dist/host/session-ops.js +35 -3
- package/dist/host/session-ops.js.map +1 -1
- package/dist/host/session-title.js +47 -0
- package/dist/host/session-title.js.map +1 -0
- package/dist/host/sessions.js +5 -0
- package/dist/host/sessions.js.map +1 -1
- package/dist/host/{routing-store.js → store.js} +68 -9
- package/dist/host/store.js.map +1 -0
- package/dist/shared/protocol.js +18 -8
- package/dist/shared/protocol.js.map +1 -1
- package/package.json +1 -1
- package/dist/host/routing-store.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,29 +1,96 @@
|
|
|
1
1
|
# DSH × 企业微信智能机器人
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
把 **DeepSeek Harness** 接到**企业微信智能机器人**(API 模式 · 长连接):在企微里给机器人发消息,就是在对 DSH 里的会话说话。走 [`@wecom/aibot-node-sdk` 1.0.7](https://cdn.jsdelivr.net/npm/@wecom/aibot-node-sdk@1.0.7/README.md) 的 WebSocket 长连接,**不需要公网回调地址**,一台能出网的机器就够。
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
- **每个企业微信用户/群都有自己的专属 DSH 会话**:用户私聊时一人一个会话,群聊时整个群共享一个会话;
|
|
7
|
-
- DSH 会话**本轮完成**、**需要你回答**时,主动推送回**属于这个会话的那个聊天**;**工具调用审批只通知管理员**,管理员可在单聊里用验证码批准或拒绝;
|
|
8
|
-
- 在企业微信里直接发消息就能继续对话,还能 `/status`、`/compact`、`/delete`、`/answer`、`/cancel`、`/approve`;管理员另有 `/sessions`、`/use`、`/workspaces`、`/new`;
|
|
9
|
-
- **授权就是把人加进分组**:被拒绝的人会带着他发的消息出现在插件主页的「未授权用户」里,选中分组即完成授权(可顺手起个备注名),机器人会给他发一条"管理员已授权,可以开始使用了";
|
|
10
|
-
- 只有管理员能切换会话、选择默认 Workspace;分组、成员、备注、Workspace、模型、effort 与 preset 都能在插件主页上调整,每张卡片各存各的;
|
|
11
|
-
- 每条企微消息的原始请求、回复和元数据写入 DSH home 下的 JSONL 日志。
|
|
5
|
+
DSH 里的会话跑完一轮、需要你回答、或者需要审批工具调用时,机器人会主动推回企微 —— 于是"用 DSH"这件事不再被绑在电脑前。
|
|
12
6
|
|
|
13
|
-
|
|
7
|
+
## 使用场景
|
|
14
8
|
|
|
15
|
-
|
|
9
|
+
它解决的问题只有一个:**让你和你的同事,不坐在 DSH 前面也能用它**。落地下来是两种用法,可以同时存在。
|
|
16
10
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
11
|
+
### 场景一 · 用手机遥控你自己的 DSH
|
|
12
|
+
|
|
13
|
+
把自己的企微账号设成**管理员**(admin),手机上的企业微信就成了 DSH 的遥控器:**任意一个会话**都能查看、切换、推进,而不只是机器人给你开的那个。你在电脑上开的会话,手机上接着聊就行。
|
|
14
|
+
|
|
15
|
+
**怎么搭(十分钟)**
|
|
16
|
+
|
|
17
|
+
1. 装插件、填 Bot ID + Secret —— 见「[快速开始](#快速开始)」;
|
|
18
|
+
2. 先给机器人发一条消息,让它出现在插件主页的「③ 未授权用户」里(那里能看到你的 userid),再到「④ 管理员 → 添加」里选中你自己。管理员由配置直接信任,**不需要加入任何分组**就能用 —— 所以刚装好插件也不会把自己锁在外面;
|
|
19
|
+
3. 可选但推荐:展开「④ 管理员 → 可接收通知的 Workspace」勾选你关心的目录。留空(默认)= **全部 Workspace 的所有会话**都通知你,`/sessions` 也能列出它们;收窄范围会同时收窄这两件事。
|
|
20
|
+
|
|
21
|
+
**日常怎么用**
|
|
22
|
+
|
|
23
|
+
| 你想做的事 | 在企微里 |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| 看有哪些会话 | `/sessions`(按 Workspace 分组列出,带序号、名称、运行状态) |
|
|
26
|
+
| 切到某个会话继续推进 | `/use <序号>`,或直接**引用**那条通知 |
|
|
27
|
+
| 开一个新会话 | `/new`(建在你用 `/workspaces` 选定的默认 Workspace 里) |
|
|
28
|
+
| 看当前会话的状态 | `/status`(模型、effort、preset、上下文占用、第几轮) |
|
|
29
|
+
| 放行 / 拒绝工具调用 | `/approve <验证码>` / `/deny <验证码>`(需在「⑤ 高级设置」打开「远程审批」) |
|
|
30
|
+
| 回答 DSH 的提问 | `/answer <验证码> <选项序号或文字>` |
|
|
31
|
+
| 停止正在跑的回合 | `/cancel` |
|
|
32
|
+
| 腾出上下文 / 清空记忆 | `/compact`、`/delete`(先回一条警告,再 `/delete confirm`) |
|
|
33
|
+
| 回到自己的专属会话 | `/reset` |
|
|
34
|
+
| 直接发文字 | 提交到当前会话 |
|
|
35
|
+
|
|
36
|
+
**为什么够用**:DSH 里一轮跑完,通知会推到你的单聊,末尾带一行 `/use <会话ID片段>` —— **引用那条通知**,之后你发的消息(包括斜杠命令)就直接落在那个会话上。不用记 ID,翻到哪条通知就接着聊哪条。
|
|
37
|
+
|
|
38
|
+
**先说清楚的边界**:计划审阅、带详细内容的提问只能在 DSH 页面处理;完成通知只带该回合**最后一条助手文字**,不外发推理、工具参数或附件;管理员命令只能在单聊里发。
|
|
39
|
+
|
|
40
|
+
### 场景二 · 把 DSH 环境做成分享给同事的机器人
|
|
41
|
+
|
|
42
|
+
把一个「配好的 DSH 环境」变成机器人:给它一个专属 Workspace,接上必要的 **MCP**、放好 **skills**、做一个调过的 **agent preset** —— 同事私聊它,或者在群聊里 @ 它,用的就是这个环境。你把环境调教一次,团队随手就能用。
|
|
43
|
+
|
|
44
|
+
**怎么搭**
|
|
45
|
+
|
|
46
|
+
1. **先在 DSH 里把环境准备好**:选定或新建一个 Workspace,接上要用的 MCP,放好 skills,需要的话做一个专门的 agent preset。这些都归 DSH 自己管,插件不接管 —— 插件只负责"谁、在哪个环境里、跟你说话";
|
|
47
|
+
2. **在插件主页建一个分组**(「② 用户分组 → 添加分组」):指向那个 Workspace,选好模型(含思考强度 effort)与 preset。**分组=一份策略**:一个 Workspace + 一个模型 + 一个 preset;
|
|
48
|
+
3. **把人或群聊放进分组**:让对方先给机器人发一条消息,再到「③ 未授权用户」里选中分组、顺手填个备注名、确认 —— 授权完成,机器人会给他发一条「管理员已授权,可以开始使用了」。群聊同理(把那个群加进分组)。
|
|
49
|
+
|
|
50
|
+
**他们看到什么**
|
|
51
|
+
|
|
52
|
+
- **私聊一人一个会话**,都建在分组指定的 Workspace 里;**群聊整个群共享一个会话**,谁说话都是同一条线(这也是"群聊里不能替大家审批、切换会话"的原因);
|
|
53
|
+
- 会话标题是 `wecom-bot-<userid>`(群聊用 `wecom-bot-<群 chatid>`),在 DSH 侧边栏一眼看出这是谁的;
|
|
54
|
+
- 成员能用自己会话范围内的那一套命令(`/status`、`/compact`、`/delete`、`/cancel`、`/answer`、`/whoami`、`/help`)加直接发消息;**管理员命令与审批永远不属于成员** —— 工具调用审批只发给管理员,群里和成员单聊里都收不到;
|
|
55
|
+
- 群里必须 **@ 机器人**,企业微信才会把消息推给它:没 @ 的消息服务器那一层就不转发,插件连回调帧都收不到。这是平台限制,不是插件的开关。
|
|
56
|
+
|
|
57
|
+
**想给不同团队不同待遇**:再建一个分组就行。研发组指向代码库那个 Workspace,市场组指向另一个,互不影响。注意改某个分组的 Workspace,会让这个组的成员换到新目录**重新开会话** —— DSH 不允许一个会话静默搬家。
|
|
58
|
+
|
|
59
|
+
| | 场景一 · 遥控自己的 DSH | 场景二 · 分享给团队 |
|
|
60
|
+
| --- | --- | --- |
|
|
61
|
+
| 谁在说话 | 你自己(管理员) | 同事、群聊里的所有人 |
|
|
62
|
+
| 会话归属 | 你想操作哪个就 `/use` 哪个 | 一人一个私有会话;群聊共享一个 |
|
|
63
|
+
| 权限 | 全部命令 + 审批 | 自己会话范围内的命令,**不含**审批与管理员命令 |
|
|
64
|
+
| 关键配置 | 管理员名单 + 通知范围 | 分组(Workspace / 模型 / preset)+ 成员授权 |
|
|
65
|
+
| 典型用途 | 手机上查看进度、审批、推进长任务 | 团队随手问,把 MCP / skills 的能力给人用 |
|
|
66
|
+
|
|
67
|
+
## 快速开始
|
|
68
|
+
|
|
69
|
+
### 1. 安装插件
|
|
70
|
+
|
|
71
|
+
已发布到 npm:[`dsh-wecom-bot`](https://www.npmjs.com/package/dsh-wecom-bot)。在 DSH 的「插件」里安装这个包名;本地开发时改成**这个仓库的绝对路径**(bundle 的 patch 会往 profile 里插入一条 `wecom-bot` 条目)。
|
|
72
|
+
|
|
73
|
+
安装完即时生效,不需要重启(bundle 会被直接应用到当前 profile)。但**改完插件代码重新构建之后必须重启 DSH**:桌面版 profile 未开启 Host 源码热重载,禁用/启用插件不会替换已缓存的 Host 模块。
|
|
74
|
+
|
|
75
|
+
### 2. 连接机器人
|
|
76
|
+
|
|
77
|
+
在 **设置 → 插件 → `dsh-wecom-bot`** 的 bundle 主页填「**① 连接机器人**」(仅有的两项必填):
|
|
78
|
+
|
|
79
|
+
- **Bot ID**:写进配置;
|
|
80
|
+
- **Bot Secret**:保存到 DSH 凭据库(引用名 `WECOM_BOT_SECRET`),插件 Config 只记录引用名,保存后不回显。
|
|
81
|
+
|
|
82
|
+
> 企业微信**智能机器人(API 模式 · 长连接)**使用 Bot ID + **Bot Secret**,不是群机器人 webhook key,也不是回调 Token / EncodingAESKey。请勿把 Secret 发进聊天或提交到仓库。
|
|
83
|
+
|
|
84
|
+
### 3. 选一条路走
|
|
21
85
|
|
|
22
|
-
|
|
86
|
+
- **场景一** → 把自己加进「④ 管理员」。提示:先给机器人发一条消息,你的 userid 会出现在「③ 未授权用户」和「④ 添加」的候选列表里。
|
|
87
|
+
- **场景二** → 建一个「② 用户分组」,指向你配好的 Workspace,然后把同事或群聊授权进去。
|
|
23
88
|
|
|
24
|
-
|
|
89
|
+
### 4. 在企微里试一句
|
|
25
90
|
|
|
26
|
-
|
|
91
|
+
私聊机器人(或群里 @ 它)发送 `/help`。如果收到「用户未授权,请联系管理员」,说明你在等一次授权 —— 你会同时出现在插件主页的「③ 未授权用户」里,管理员在那里选中分组即可。
|
|
92
|
+
|
|
93
|
+
## 核心概念:分组、成员、会话
|
|
27
94
|
|
|
28
95
|
插件把"谁能跟机器人说话"和"他的会话建在哪里"合并成了一件事:**分组**。
|
|
29
96
|
|
|
@@ -36,19 +103,22 @@ DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏
|
|
|
36
103
|
| **preset** | DSH 的 agent preset(决定这个会话能用哪些工具、带哪些提示段),只在**新建会话时**生效 |
|
|
37
104
|
|
|
38
105
|
- **授权 = 加入分组**:只有属于某个分组的成员(以及管理员)会得到回复。不在任何分组里的人发消息会收到一条固定回复「**🔒 用户未授权** · 请联系管理员把你加入分组后再试」,同时出现在插件主页的「未授权用户」卡片里,连同他最后一条消息的摘要;在那里选择分组、可选填备注并确认,就完成了授权,机器人随即给他发一条「管理员已授权,可以开始使用了」。
|
|
39
|
-
-
|
|
40
|
-
- **会话创建**:成员的会话为空时,收到下一条消息会在**其分组的 Workspace** 里新建一个 DSH 会话并立即提交消息;会话已归档或已删除时会自动换一个新的。想主动换一个:发 `/delete`(再 `/delete confirm
|
|
106
|
+
- **管理员始终可以发消息**:管理员名单由插件自己的设置直接信任,无需入组,会被隐式放进「默认分组」;这份名单存在 `<DSH home>/wecom-bot/settings.json`,不在 DSH 的插件 Config 里。
|
|
107
|
+
- **会话创建**:成员的会话为空时,收到下一条消息会在**其分组的 Workspace** 里新建一个 DSH 会话并立即提交消息;会话已归档或已删除时会自动换一个新的。想主动换一个:发 `/delete`(再 `/delete confirm`)或在插件主页点成员行尾的「归档会话」。
|
|
41
108
|
- **默认分组的 Workspace**:留空即插件自带目录 `<DSH home>/wecom-bot/workspace`(自动创建并注册到侧边栏,标题「企业微信」);也可以选一个已存在的目录。
|
|
42
109
|
- **模型与 effort 属于分组**:分组选定模型(与思考强度 effort)后,会在创建会话时安装为会话级模型,也适用于该分组已存在的会话;留空表示跟随 DSH 当前默认模型。插件调用 DSH 的 `sessionController.selectModel` 设置会话级模型后会**把 DSH 默认模型恢复原状**,所以配置插件不会改变你在 DSH 界面新建会话时用的默认模型。
|
|
43
|
-
- **preset 属于分组,且是一次性的创建事实**:成员的新会话会按分组的 preset 组装(这个部署没有可选的 preset 时跟随 DSH 默认)。改分组的 preset 只影响**此后新建的会话**——DSH 不允许改写已经开始过一轮的会话,想换 preset
|
|
110
|
+
- **preset 属于分组,且是一次性的创建事实**:成员的新会话会按分组的 preset 组装(这个部署没有可选的 preset 时跟随 DSH 默认)。改分组的 preset 只影响**此后新建的会话**——DSH 不允许改写已经开始过一轮的会话,想换 preset 就归档当前会话。
|
|
44
111
|
- **换 Workspace 会换会话**:分组的 Workspace 一改,该分组成员记录的会话 id 会被清空,下一条消息在新目录里重新建会话(否则"分组的 Workspace"就是一句空话)。
|
|
45
112
|
- **删除分组会取消授权**:删掉一个分组时,组内成员一并被移出(不删 DSH 里的会话),他们会重新出现在「未授权用户」里,需要时再授权一次。这是刻意的:删除分组绝不应该悄悄把成员升级到默认分组的 Workspace。
|
|
46
113
|
- 新会话在**第一次提交消息之前是"空会话"**,DSH 侧边栏会暂时不显示它,提交第一条消息后就正常出现;管理员刚用 `/new` 建出的会话可以直接用,不必等它显示出来。
|
|
114
|
+
- **机器人建的会话会自己命名**:标题是 `wecom-bot-<userid>`(单聊)或 `wecom-bot-<群聊 chatid>`,也就是这个会话属于谁;这是显式设置的标题,DSH 不会再拿第一句话去生成标题(也省掉一次模型调用)。它和会话里的内容无关,改名只影响侧边栏显示。
|
|
47
115
|
|
|
48
116
|
## 在插件主页配置
|
|
49
117
|
|
|
50
118
|
打开 **设置 → 插件 → `dsh-wecom-bot`** 的 bundle 主页。页面只有五张卡片,默认显示的尽量少,需要什么点什么;**每张卡片各存各的**,底部的「保存配置」已经去掉了:
|
|
51
119
|
|
|
120
|
+
> **什么时候会重连机器人**:只有**连接身份**变了才会 —— Bot ID、Bot Secret、WebSocket 地址。这三项之外的一切(管理员、通知范围、等待时间、远程审批、日志开关与保留天数)都写在插件自己的**一个文件**里:`<DSH home>/wecom-bot/settings.json`(`"version": "0.5"`),它同时装着设置块、分组、成员、备注和每位管理员的默认 Workspace。保存后**立即对运行中的机器人生效,不会断开正在进行的对话**;DSH 的插件 Config 里只剩 Bot ID 与 Secret 的引用名。
|
|
121
|
+
|
|
52
122
|

|
|
53
123
|
|
|
54
124
|
每个人的详情(类型、企微 ID、可编辑的备注,以及他的会话、移动分组、移出分组)都在**点小图标弹出的窗口**里;列表本身只负责看:
|
|
@@ -74,30 +144,38 @@ DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏
|
|
|
74
144
|
- 添加成员不再有单独的按钮:给机器人发消息的人在「未授权用户」里授权,就是加成员的唯一入口。
|
|
75
145
|
- **这里的改动立即生效,不需要点保存**。
|
|
76
146
|
3. **③ 未授权用户**:给机器人发过消息、但不在任何分组里的人,按时间倒序,附带最后一条消息的摘要;点「加入分组」选择分组(可填备注)并确认,即完成授权,机器人会给他发一条授权提示。**列表只在内存中**,重启 DSH 后清空(授权本身是持久化的)。这里同样优先显示备注名。
|
|
77
|
-
4. **④ 管理员**:管理员列表用的是同一套人员行——点小图标弹出人员详情(类型、企微 ID
|
|
147
|
+
4. **④ 管理员**:管理员列表用的是同一套人员行——点小图标弹出人员详情(类型、企微 ID、所属分组、备注),**备注即时生效**、与分组成员共用同一个名字;「移除管理员」在详情窗口底部,**加人、移除、改通知范围都不需要再点保存**:选中/移除即写入插件设置,**不会重连机器人**(决定是你当场做的,所以不用再点一次确认)。
|
|
78
148
|
- 列表为空时显示一个「添加管理员」按钮;不为空时卡片右上角有一个「添加」。两者打开同一个**带搜索框的已知用户列表**:候选人是未授权用户和已授权成员,**优先显示备注名**、没有备注才显示企微 ID;找不到时也可以直接按 userid 添加。
|
|
79
|
-
- 「可接收通知的 Workspace」**默认折叠**,展开后是勾选列表。配置留空(默认)时**全部勾选**、表示不收窄范围;取消勾选某个 Workspace
|
|
80
|
-
5. **⑤ 高级设置**(默认折叠):远程审批、等待企微回复的秒数、私有化部署的 `wss://` 地址、JSONL
|
|
149
|
+
- 「可接收通知的 Workspace」**默认折叠**,展开后是勾选列表。配置留空(默认)时**全部勾选**、表示不收窄范围;取消勾选某个 Workspace 后,存的就是剩下勾选的那些路径,全勾回去又回到留空。只有归档会话的 Workspace 也会列出来(除非已被删除)。勾选/取消即生效。
|
|
150
|
+
5. **⑤ 高级设置**(默认折叠):远程审批、等待企微回复的秒数、私有化部署的 `wss://` 地址、JSONL 日志开关与保留天数、日志目录;自带「保存 / 放弃」。这一卡里**只有 WebSocket 地址**属于连接身份,保存它会重连机器人;其余几项保存后立即生效,**日志开关与保留天数也不需要重启 DSH**。
|
|
81
151
|
|
|
82
152
|
> 截图由 `pnpm run preview` 用样例数据离屏渲染生成(`--dark` 深色版 `preview/settings-dark.png`、`--advanced` 展开通知范围的版本 `preview/settings-advanced.png`、`--dialog` 人员详情窗口、`--picker` 添加管理员窗口 `preview/settings-picker.png`、`--archive` 归档确认窗口),改页面后重新跑一次即可更新。
|
|
83
153
|
|
|
84
|
-
|
|
154
|
+
## 授权与权限边界
|
|
85
155
|
|
|
86
156
|
- 只有**分组里的成员**和**管理员**能让机器人干活;其它人发来的消息不会提交给 DSH,只会收到「用户未授权」并在「未授权用户」里留一行。
|
|
87
157
|
- 普通用户**永远只能访问自己名下的那个会话**:`/sessions`、`/use`、`/new`、`/workspaces`、引用通知跳转都会被拒绝,也不会收到别人会话的通知。自己的会话可用 `/compact` 压缩上下文、用 `/delete`(再 `/delete confirm`)归档。
|
|
88
158
|
- **管理员**(`adminUserIds`)可以:`/sessions` 按 Workspace 列出会话、`/use` 切换自己要操作的会话、`/workspaces` 选一个默认 Workspace、`/new` 在那个 Workspace 新建会话并切换过去、`/reset` 回到自己的专属会话、引用任意通知直接跳转到那个会话;并按 `adminWorkspaces` 接收这些 Workspace 中**所有会话**的通知(留空 = 全部 Workspace)。**工具调用审批只发给管理员**,群聊和普通用户的单聊永远收不到审批请求。
|
|
89
|
-
- **管理员命令只能在单聊里发送**:群聊里的会话是所有人共用的,`/new`、`/workspaces`、`/sessions`、`/use`、`/reset`、`/approve`、`/deny` 在群里一律被拒绝(回「管理员命令只能在单聊中使用」,不会被执行);`/compact`、`/delete`
|
|
90
|
-
-
|
|
159
|
+
- **管理员命令只能在单聊里发送**:群聊里的会话是所有人共用的,`/new`、`/workspaces`、`/sessions`、`/use`、`/reset`、`/approve`、`/deny` 在群里一律被拒绝(回「管理员命令只能在单聊中使用」,不会被执行);`/compact`、`/delete` 在群里只有管理员能用,群成员发会收到一条专门的说明:「群聊的会话记录只有管理员可以归档/压缩……如果你想处理的是自己的专属会话,请在与机器人的单聊里发送这条命令」。
|
|
160
|
+
- 管理员名单(`adminUserIds`)与通知范围(`adminWorkspaces`)在插件主页的「④ 管理员」中维护,存在插件自己的 `<DSH home>/wecom-bot/settings.json` 里:改动即时生效、**不会重连机器人**。DSH 的插件 Config 里只有 `botId` 与 Secret 的引用名。
|
|
91
161
|
- 撤销授权有两种方式:在成员详情窗口底部点「移出分组」,或删掉整个分组。两者都不会删除 DSH 里已有的会话,也不会忘记这个人的备注。
|
|
92
|
-
-
|
|
162
|
+
- **备注属于人,而不是属于某次授权**:它和分组、成员、设置一起存在 `settings.json` 的 `labels` 里,但独立于授权——移出分组、删掉分组、甚至从未进过分组的管理员,备注都还在,下次授权同一个人时自动恢复显示。
|
|
163
|
+
|
|
164
|
+
## 通知、提问与审批
|
|
93
165
|
|
|
94
|
-
|
|
166
|
+
- **一轮跑完推给谁**:推给"属于这个会话的人"——成员的会话推给他那个聊天;管理员按 `adminWorkspaces` 范围接收这些 Workspace 里**所有会话**的通知(留空 = 全部)。谁都不该收到时记一条 `wecom.notify.skipped`,不会静默丢消息。
|
|
167
|
+
- **通知内容**:只有该回合最后一条助手文字,不外发推理、工具参数或附件;**子代理会话的回合不推送**;非"正常完成"的回合(取消、出错)只在有企微消息在等它时推送。
|
|
168
|
+
- **提问**:DSH 提问后,等待企微回答(默认 60 秒,见高级设置);这段时间 DSH 页面不显示该提问,超时后回到 DSH 页面。用 `/answer <验证码> <选项序号或文字>` 回答;**计划审阅与带详细内容的提问只能在 DSH 页面处理**。
|
|
169
|
+
- **审批**:`/approve`、`/deny` 需要先在高级设置里打开「远程审批」,且只能在**管理员**的单聊里使用。验证码是 6 位一次性随机码,绑定到具体的那次提问/审批,过期或旧码无法重放。
|
|
170
|
+
|
|
171
|
+
## 内存里保留了什么
|
|
95
172
|
|
|
96
173
|
- 「未授权用户」列表:被拒绝主体的 ID、次数、最近时间,以及**最后一条消息的摘要**(单行、最多 120 字)。这是为了让管理员能认出敲门的人是谁。
|
|
97
174
|
- **被接受的正常消息不保留正文**;只有被拒绝的消息会留下摘要。
|
|
98
|
-
- 所有这些都只驻留内存(最多 200 条、24 小时过期),DSH
|
|
175
|
+
- 所有这些都只驻留内存(最多 200 条、24 小时过期),DSH 重启即清空。
|
|
176
|
+
- **持久化的东西都在一个文件里**:`<DSH home>/wecom-bot/settings.json`(`"version": "0.5"`,权限 `0600`、原子写入)。它装着设置块(管理员、通知范围、WebSocket 地址、等待时间、远程审批、日志开关与保留天数)、分组、成员、备注,以及每位管理员自己的默认 Workspace——不再有第二个状态文件。版本号对不上(或内容读不出来)的文件不会被猜测着读或就地覆盖,而是改名成 `settings.json.v<旧版本>`(读不出来的用 `settings.json.corrupt`)放在旁边,插件从空状态开始;想留用里面的内容,照它的 userid/chatid 在页面上重新加一次即可。
|
|
99
177
|
|
|
100
|
-
|
|
178
|
+
状态与编辑接口注册在 DSH Connection Fetch 通道(`/api/wecom-bot/state` 读取状态、`/api/wecom-bot/store` 应用页面上的一切修改),只有已登录的 DSH 页面可访问。
|
|
101
179
|
|
|
102
180
|
## 企业微信指令
|
|
103
181
|
|
|
@@ -119,13 +197,10 @@ DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏
|
|
|
119
197
|
| 引用(回复)DSH 发来的某条通知 | 把之后的消息(含斜杠命令)直接定位到那条通知所属的会话 | 仅管理员(单聊) |
|
|
120
198
|
| 直接发送文字 | 提交到当前会话(`mode: queue`) | 所有人 |
|
|
121
199
|
|
|
122
|
-
- 没有权限时回复「**🔒 需要管理员权限**」;管理员命令发在群聊里回复「**🔒
|
|
123
|
-
- 完成通知只包含该回合**最后一条助手文字**,不外发推理、工具参数或附件;子代理会话的回合不推送。非"正常完成"的回合(取消、出错)只在有企微消息在等它时推送。
|
|
124
|
-
- 提问在企微等待(默认 60 秒)期间 DSH 页面不显示该提问,超时后回到 DSH 页面;**计划审阅与带详细内容的提问只能在 DSH 页面处理**。
|
|
125
|
-
- 验证码为 6 位一次性随机码,绑定到具体的那次提问/审批,过期或旧码无法重放。
|
|
200
|
+
- 没有权限时回复「**🔒 需要管理员权限**」;管理员命令发在群聊里回复「**🔒 管理员命令只能在单聊中使用**」;群聊里的 `/compact`、`/delete` 会说明「群聊的会话记录只有管理员可以…」并指向单聊。都不会静默失败。
|
|
126
201
|
- **`/delete` 是归档而不是删除文件**:DSH 没有删除会话的 API,归档会让这个会话不再被继续、历史不再进入任何请求,效果就是"记忆清零、下一条消息新开会话";JSONL 会话文件仍留在磁盘上,需要时到 DSH 页面查看。
|
|
127
202
|
- `/new` 建出的会话属于"管理员自己开的会话",不挂任何分组,所以模型与 preset 跟随 DSH 默认;想用某个分组的配置,就让那个分组的成员去用。
|
|
128
|
-
- **`/compact` 用的是 DSH
|
|
203
|
+
- **`/compact` 用的是 DSH 自己的压缩能力**,压缩的是当前会话的历史;这个服务由**会话自己的 agent preset** 提供(DSH 把 `compaction` 隔离在 preset 里,插件从 Agent 的上下文取,而不是从自己那一层),所以换了 preset 就跟着换实现;会话正忙时会拒绝并说明原因。
|
|
129
204
|
- **引用定位的原理**:企业微信的引用回调只回传被引用消息的内容,不回传它的 ID,所以每条通知末尾都带一行 `/use <会话ID片段>` 的提示;插件在收到引用时从这段被回传的文字里把 ID 片段抠出来,按 `/use` 同样的规则解析成会话。无法解析(比如引用了一条无关消息,或该会话不在你的 Workspace 范围内)时什么都不会改变。
|
|
130
205
|
|
|
131
206
|
### 消息排版
|
|
@@ -181,20 +256,25 @@ DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏
|
|
|
181
256
|
| `binding.session.created` / `binding.session.replaced`(`warn`) | 为一个成员创建了新会话(含所属分组);或原会话已归档/不可用而换了新会话 |
|
|
182
257
|
| `binding.session.reset`、`session.created`、`wecom.selection` | `/delete` 或页面归档会话、首次路由、管理员切换会话 |
|
|
183
258
|
| `dsh.session.archive` / `dsh.session.compact` / `dsh.session.create` | 归档会话、上下文压缩(条数与 tokens)、管理员 `/new` 新建会话 |
|
|
259
|
+
| `dsh.session.title` | 给机器人新建的会话写标题(`wecom-bot-<userid/chatid>`);`outcome: unavailable` 表示这个部署没挂标题服务 |
|
|
184
260
|
| `wecom.session.new` / `wecom.session.delete` / `wecom.workspace.select` / `wecom.authorized` | 管理员新建会话、归档自己的会话、选择默认 Workspace、页面授权某人后给她发提示 |
|
|
185
|
-
| `binding.store.error` / `binding.view.error`(`warn`) |
|
|
261
|
+
| `binding.store.error` / `binding.view.error`(`warn`) | 设置文件读写或读取分组视图失败(`stage: version` 表示文件版本不认识、已挪到 `settings.json.v<版本>`;无法解析的文件挪到 `settings.json.corrupt`) |
|
|
186
262
|
| `dsh.question*` / `dsh.approval*` | 提问、审批及其答复 |
|
|
187
|
-
| `connection.phase`、`config.applied`、`wecom.sdk` |
|
|
263
|
+
| `connection.phase`、`config.applied`、`wecom.sdk` | 连接状态变化、生效的设置(不含 Secret;`connection: rebuilt` 表示重建了连接,`kept` 表示就地交给运行中的机器人)、SDK 日志 |
|
|
188
264
|
|
|
189
265
|
Secret 值、`secret`/`token`/`authorization` 等字段、`response_url`、媒体 `url` 与 `aeskey` 一律脱敏。日志包含对话原文,请按敏感数据管理;不需要时可在高级设置中关闭。
|
|
190
266
|
|
|
191
|
-
##
|
|
267
|
+
## 构建、本地安装与升级
|
|
268
|
+
|
|
269
|
+
```sh
|
|
270
|
+
pnpm install # esbuild 的安装脚本不需要运行(见 pnpm-workspace.yaml)
|
|
271
|
+
pnpm run verify # 构建 Host + 浏览器包,类型检查,跑全部测试
|
|
272
|
+
pnpm run preview # 可选:重新生成 README 里的设置页截图(需要 Google Chrome)
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏览器入口 `dist/client.js`。本地开发时在 DSH「插件」中以本目录绝对路径安装 bundle;改完代码重新构建后**重启 DSH**(Host 模块不热重载;只改客户端页面时,插件客户端热重载可用)。接口已在 DSH `0.2.0-rc.2` 与 `0.2.1-rc.2` 上核对。
|
|
192
276
|
|
|
193
|
-
|
|
194
|
-
- **升级后请到「用户分组」里把默认分组的 Workspace / 模型重新设一遍**:旧 Config 的值不会自动迁移(第一版会保留默认分组的插件自带目录)。
|
|
195
|
-
- 需要重新授权:旧的 `allowedUserIds` / `chatIds` 白名单不再生效,所以升级后**所有人都不在分组里**。让他发一条消息,然后到「未授权用户」里把他加进分组;或者先把他加进「管理员」,管理员无需入组即可使用。
|
|
196
|
-
- **绑定文件没有迁移**:`<DSH home>/wecom-bot/bindings.json` 的 `version` 现在是**发布线**而不是递增计数(当前 `"0.4"`,包含分组 + 成员 + 备注 + 管理员各自的默认 Workspace);只有换到新的次版本线并改动布局时它才会变。每位管理员的偏好存成对象(`"adminDefaults": { "<userid>": { "workspace": "<路径>" } }`),以后加字段不用再换文件形状。别的版本号——包括 0.4.1 写下的整数 `5`——不会被猜测着读,而是被改名成 `bindings.json.v<版本>` 放好,插件从空状态开始。想留用旧文件的内容,照里面的 userid/chatid 在页面上重新加一次即可。重启 DSH 后如果「未授权用户」里出现了原来的成员,说明旧文件被放到一边了,重新授权一次即可。
|
|
197
|
-
- 0.3.0 里的 `sessionIds`(更早的会话白名单)早已被忽略,可以手动从 profile 配置里删掉。
|
|
277
|
+
升级到新版本时没有手工迁移步骤:装上新的包,插件继续读同一个 `settings.json`(版本线没变就照原样用);唯一需要动手的情况是文件版本换到了新的次版本线,那时旧文件会被改名放到旁边(见「[内存里保留了什么](#内存里保留了什么)」),照里面的 userid/chatid 在页面上重新加一次即可。
|
|
198
278
|
|
|
199
279
|
## 已知限制
|
|
200
280
|
|
|
@@ -215,16 +295,17 @@ src/
|
|
|
215
295
|
shared/protocol.ts Host 与页面共享的常量、分组/成员/模型/状态接口类型
|
|
216
296
|
host/ DSH Host 插件(Node ESM,tsc → dist/host)
|
|
217
297
|
index.ts 入口:Config、inject、apply(注册两个已认证接口)
|
|
218
|
-
config.ts Config schema
|
|
219
|
-
runtime.ts
|
|
220
|
-
|
|
298
|
+
config.ts Config schema:只有连接身份(Bot ID + 凭据库里的 Secret 引用名)
|
|
299
|
+
runtime.ts 宿主生命周期编排:连接身份变化才重建连接,其余设置就地交给运行中的机器人
|
|
300
|
+
store.ts 插件自己的文档 `settings.json`:设置块 + 分组 + 成员 + 备注 + 每位管理员的默认 Workspace(原子写、私有权限、只认当前版本)
|
|
221
301
|
routing.ts 成员 → 会话路由(分组的 Workspace/模型 + 成员自己的会话)
|
|
222
302
|
sessions.ts 会话供给:创建会话、安装模型、描述会话状态
|
|
223
303
|
session-ops.ts 需要 DSH 服务的三个操作:归档会话、压缩上下文、在指定 Workspace 新建会话
|
|
304
|
+
session-title.ts 给新建的会话写 wecom-bot-<userid/chatid> 标题(DSH sessionTitle 服务)
|
|
224
305
|
workspaces.ts 默认/自定义 Workspace 的解析与注册
|
|
225
306
|
models.ts DSH 模型目录与「安装会话级模型后恢复默认模型」
|
|
226
307
|
presets.ts DSH 的 agent preset 名单(分组表单的选项、写入前的校验)
|
|
227
|
-
groups-view.ts 配置页的分组表格(读取 +
|
|
308
|
+
groups-view.ts 配置页的分组表格(读取 + 校验并应用编辑,含设置项的字段校验)
|
|
228
309
|
bridge/ 一条企微连接:
|
|
229
310
|
index.ts 组装、入站处理、授权、路由、通知/提问/审批
|
|
230
311
|
inbound.ts 回调帧校验与防重放
|
|
@@ -242,11 +323,11 @@ src/
|
|
|
242
323
|
turns.ts 从 Session 日志汇总一个回合
|
|
243
324
|
journal.ts JSONL 日志、DSH home 解析、脱敏
|
|
244
325
|
status.ts 连接状态与计数
|
|
245
|
-
routes.ts
|
|
326
|
+
routes.ts 已认证的两个接口:读取状态、应用页面上的设置/分组/成员修改
|
|
246
327
|
client/ 插件主页(React TSX,esbuild → dist/client.js)
|
|
247
328
|
index.tsx 注册到 plugins.bundle.config
|
|
248
329
|
components/ 状态栏、凭据、用户分组、未授权用户、管理员、高级设置(人员行为 ui.tsx 的 PersonRow/PersonDialog,分卡片保存用 SaveBar)
|
|
249
|
-
hooks.ts / api.ts Config
|
|
330
|
+
hooks.ts / api.ts Config 表单(只有①连接用)、插件设置提交、凭据与状态接口
|
|
250
331
|
model.ts 纯函数:草稿、差异、校验、模型/preset/effort/上下文标签、分组/成员操作
|
|
251
332
|
styles.ts 基于 DSH 主题变量的样式
|
|
252
333
|
scripts/build-client.mjs 打包为 DSH 浏览器模块格式(React 与 DSH UI 组件由宿主提供)
|