dsh-wecom-bot 0.0.0-stage → 0.2.1

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 (50) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +151 -2
  3. package/cordis.patch.yml +4 -0
  4. package/dist/client.js +1298 -0
  5. package/dist/host/bridge/commands.js +164 -0
  6. package/dist/host/bridge/commands.js.map +1 -0
  7. package/dist/host/bridge/directory.js +79 -0
  8. package/dist/host/bridge/directory.js.map +1 -0
  9. package/dist/host/bridge/format.js +89 -0
  10. package/dist/host/bridge/format.js.map +1 -0
  11. package/dist/host/bridge/inbound.js +81 -0
  12. package/dist/host/bridge/inbound.js.map +1 -0
  13. package/dist/host/bridge/index.js +408 -0
  14. package/dist/host/bridge/index.js.map +1 -0
  15. package/dist/host/bridge/interactions.js +98 -0
  16. package/dist/host/bridge/interactions.js.map +1 -0
  17. package/dist/host/bridge/notices.js +131 -0
  18. package/dist/host/bridge/notices.js.map +1 -0
  19. package/dist/host/bridge/outbox.js +74 -0
  20. package/dist/host/bridge/outbox.js.map +1 -0
  21. package/dist/host/bridge/policy.js +21 -0
  22. package/dist/host/bridge/policy.js.map +1 -0
  23. package/dist/host/bridge/selection.js +18 -0
  24. package/dist/host/bridge/selection.js.map +1 -0
  25. package/dist/host/catalog.js +128 -0
  26. package/dist/host/catalog.js.map +1 -0
  27. package/dist/host/config.js +72 -0
  28. package/dist/host/config.js.map +1 -0
  29. package/dist/host/dsh.js +10 -0
  30. package/dist/host/dsh.js.map +1 -0
  31. package/dist/host/index.js +50 -0
  32. package/dist/host/index.js.map +1 -0
  33. package/dist/host/journal.js +188 -0
  34. package/dist/host/journal.js.map +1 -0
  35. package/dist/host/observation.js +81 -0
  36. package/dist/host/observation.js.map +1 -0
  37. package/dist/host/rounds.js +112 -0
  38. package/dist/host/rounds.js.map +1 -0
  39. package/dist/host/routes.js +30 -0
  40. package/dist/host/routes.js.map +1 -0
  41. package/dist/host/runtime.js +200 -0
  42. package/dist/host/runtime.js.map +1 -0
  43. package/dist/host/status.js +27 -0
  44. package/dist/host/status.js.map +1 -0
  45. package/dist/host/turns.js +89 -0
  46. package/dist/host/turns.js.map +1 -0
  47. package/dist/shared/protocol.js +16 -0
  48. package/dist/shared/protocol.js.map +1 -0
  49. package/icon.svg +14 -0
  50. package/package.json +79 -4
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 lastorder
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,152 @@
1
- # Temporary Holding Version
1
+ # DSH × 企业微信智能机器人
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ 基于 [`@wecom/aibot-node-sdk` 1.0.7](https://cdn.jsdelivr.net/npm/@wecom/aibot-node-sdk@1.0.7/README.md) WebSocket 长连接的 DeepSeek Harness 本地插件,无需公网回调地址:
4
+
5
+ - DSH 会话**本轮完成**、**需要你回答**或**请求权限**时,主动推送到企业微信;
6
+ - 在企业微信里 `/sessions` 选会话,直接回复就能继续对话,还可 `/answer`、`/cancel`;
7
+ - 每条企微消息的原始请求、回复和元数据写入 DSH home 下的 JSONL 日志。
8
+
9
+ > 企业微信**智能机器人(API 模式 · 长连接)**使用 Bot ID + **Bot Secret**,不是群机器人 webhook key,也不是回调 Token/EncodingAESKey。请勿把 Secret 发进聊天或提交到仓库。
10
+
11
+ ## 构建与安装
12
+
13
+ ```sh
14
+ pnpm install # esbuild 的安装脚本不需要运行(见 pnpm-workspace.yaml)
15
+ pnpm test # 清理 → 构建 Host 与浏览器包 → 运行全部测试
16
+ ```
17
+
18
+ DSH 加载 `dist/` 中的构建产物:Host 入口 `dist/host/index.js`,浏览器入口 `dist/client.js`。已发布到 npm 后可直接安装 [`dsh-wecom-bot`](https://www.npmjs.com/package/dsh-wecom-bot);本地开发时在 DSH「插件」中以本目录绝对路径安装 bundle(bundle patch 会插入 `wecom-bot` 条目)。
19
+
20
+ **修改代码并重新构建后,需要重启 DSH 应用**:桌面版 profile 未开启 Host 源码热重载,禁用/启用插件不会替换已缓存的 Host 模块。接口已在 DSH `0.2.0-rc.2` 上核对。
21
+
22
+ ## 在插件主页配置
23
+
24
+ 打开 **设置 → 插件 → `dsh-wecom-bot`** 的 bundle 主页。页面自上而下:
25
+
26
+ 1. **状态栏**:连接状态(在线 / 连接中 / 认证失败 / 被其他连接替换…)与本次启动以来的消息、拒绝、提交、推送计数。
27
+ 2. **访问范围提示**:任一白名单留空都会醒目提示其含义。
28
+ 3. **① 连接机器人(仅有的两项必填)**
29
+ - **Bot ID**
30
+ - **Bot Secret**:保存到 DSH 凭据库(引用名 `WECOM_BOT_SECRET`),插件 Config 只记录引用名;保存后不回显,留空表示保持不变。
31
+ 4. **② DSH 会话范围**:通过 DSH Session API 读取,与 DSH 侧边栏一致地**按 Workspace 分组**;每行先显示**会话名称**,再显示 Session ID;**已归档、子代理、空白会话不显示**。支持搜索(名称 / ID / 工作区)、按工作区一键全选、仅看已选。已勾选但后来被归档或删除的会话单独列出,可一键移除。
32
+ 5. **③ 企业微信来源**:列出最近 24 小时**真正给机器人发过消息**的 userid 与会话 ID(单聊为对方 userid,群聊为 chatid),**包括被白名单拒绝的**,并标注“上次被拒绝 / 已接受”、最近时间与消息数;勾选即加入白名单,也可手动添加。
33
+ 6. **④ 高级设置**(默认折叠):远程审批、等待企微回复的秒数、私有化部署的 `wss://` 地址、JSONL 日志开关与保留天数、日志目录。
34
+
35
+ 底部操作栏显示是否有未保存更改,提供「放弃更改」「保存配置」。
36
+
37
+ ### 访问控制:留空 = 全部允许
38
+
39
+ | 白名单 | 勾选后 | 留空时 |
40
+ | --- | --- | --- |
41
+ | DSH 会话 | 只能操作勾选的会话 | 可操作所有未归档会话(子代理/空白会话始终不可操作) |
42
+ | 企微会话 | 只接受这些单聊/群聊的消息,通知也只发到这里 | 接受任何会话;通知只发给**曾经通过授权**的会话 |
43
+ | 企微用户 | 只接受这些 userid 的消息 | 任何人 |
44
+
45
+ **三项都留空时,任何能给机器人发消息的人都能读取回复并向你的 DSH 会话下指令(可能触发命令执行与文件修改)。** 建议:只勾选自己的 userid 与自己和机器人的单聊,再只勾选需要远程操作的会话。群聊中的通知对全体群成员可见。
46
+
47
+ 被拒绝的消息**不会收到任何回复**(不暴露机器人存在),但会出现在「企业微信来源」列表供你审核。ID 列表只保存 ID、计数和最近一次判定,不保存消息正文;驻留内存,每类最多 200 条,DSH 重启后清空。状态接口注册在 DSH Connection Fetch 通道(`/api/wecom-bot/state`),只有已登录的 DSH 页面可访问。
48
+
49
+ ## 企业微信指令
50
+
51
+ | 指令 | 作用 |
52
+ | --- | --- |
53
+ | `/help` | 查看命令 |
54
+ | `/sessions` | 按工作区列出可操作的会话,带序号、名称、运行状态和 ID 前缀(最多 30 条) |
55
+ | `/use <序号 \| 会话ID前缀>` | 选择会话;序号来自你最近一次 `/sessions`,ID 前缀至少 6 位且需唯一。白名单只有一个会话时自动选中 |
56
+ | 引用(回复)DSH 发来的某条通知 | 把之后的消息(含斜杠命令)直接定位到那条通知所属的会话,覆盖此前的 `/use` 选择——每条通知末尾都带着可点的提示行 |
57
+ | 直接发送文字 | 提交到选中的会话(`mode: queue`);未选择时会直接回复带序号的会话列表 |
58
+ | `/status` | 当前选择与待处理请求 |
59
+ | `/cancel` | 停止选中会话正在运行的回合 |
60
+ | `/answer <验证码> [题目ID] <选项序号或文字>` | 回答 DSH 的提问;只有一道题时可省略题目 ID;多选用 `1,3` |
61
+ | `/approve <验证码>`、`/deny <验证码>` | 远程审批(需在高级设置中开启,且只能在已授权用户的单聊中使用) |
62
+ | `/whoami` | 查看自己的 userid 与当前会话 ID |
63
+
64
+ - 完成通知只包含该回合**最后一条助手文字**,不外发推理、工具参数或附件;子代理会话的回合不推送。非“正常完成”的回合(取消、出错)只在有企微消息在等它时推送。
65
+ - 提问在企微等待(默认 60 秒)期间 DSH 页面不显示该提问,超时后回到 DSH 页面;**计划审阅与带详细内容的提问只能在 DSH 页面处理**。
66
+ - 验证码为 6 位一次性随机码,绑定到具体的那次提问/审批,过期或旧码无法重放。
67
+ - **引用定位的原理**:企业微信的引用回调只回传被引用消息的内容,不回传它的 ID,所以每条通知末尾都带一行 `/use <会话ID片段>` 的提示;插件在收到引用时从这段被回传的文字里把 ID 片段抠出来,按 `/use` 同样的规则解析成会话。无法解析(比如引用了一条无关消息,或该会话已不再允许操作)时什么都不会改变,继续按你当前的选择处理。
68
+
69
+ ## JSONL 对话日志
70
+
71
+ 位置:`<DSH home>/wecom-bot/logs/YYYY-MM-DD.jsonl`(DSH home 为 `$DSH_HOME`,默认 `~/.dsh`),目录权限 `0700`、文件 `0600`,按保留天数(默认 14 天)自动清理。每行一个 JSON 对象,公共字段 `ts`、`seq`、`level`、`event`。
72
+
73
+ **每条企微消息对应一行 `round.complete`**,汇总一轮对话:
74
+
75
+ ```json
76
+ {"ts":"…","seq":42,"level":"info","event":"round.complete","roundId":"…","outcome":"turn-ended",
77
+ "chatId":"zhangsan","userId":"zhangsan","chatType":"single","msgId":"…",
78
+ "sessionId":"…","sessionTitle":"修复登录 Bug","workspace":"my-app","requestId":"…",
79
+ "request":{"msgtype":"text","text":"帮我修复登录"},
80
+ "response":{"replies":["已提交到《修复登录 Bug》…"],"reason":"completed","assistant":"已修复……","notifiedChats":["zhangsan"]},
81
+ "metadata":{"turn":3,"model":{"provider":"…","model":"…"},"steps":4,"toolCalls":{"bash":2},"turnDurationMs":51234},
82
+ "timing":{"receivedAt":"…","submittedAt":"…","completedAt":"…","totalMs":53012}}
83
+ ```
84
+
85
+ `outcome` 取值:`turn-ended`(DSH 回合结束)、`command`、`rejected`、`unsupported`、`blocked`、`prompt-failed`、`interrupted`、`expired`。
86
+
87
+ 明细行(用 `roundId` / `requestId` / `sessionId` 关联):
88
+
89
+ | event | 内容 |
90
+ | --- | --- |
91
+ | `wecom.message` | 收到的原始回调帧(含被拒绝的消息)与访问判定 |
92
+ | `wecom.quote` | 引用定位的解析结果:抠出的 ID 片段(`hint`)、命中的 `sessionId`,或未解析时的原因(`outcome`) |
93
+ | `wecom.reply` | 被动回复的原始请求(streamId、内容)与服务器回执 |
94
+ | `dsh.prompt` | 提交给 DSH 的原始请求与返回值 / 错误 |
95
+ | `dsh.turn.end` | 回合结束原因、助手文字、模型、步数、工具调用统计 |
96
+ | `wecom.send` | 主动推送的原始请求体与回执 |
97
+ | `wecom.notify.skipped`(`warn`) | 该 Session 本可以推送通知,但目前没有任何已知的合格接收人——多数情况是插件刚重载或 DSH 刚重启,清空了"谁最近发过消息"的名单,而此后还没人发过新消息;`reason` 标注是哪类通知(`turn-complete`/`question`/`approval`) |
98
+ | `dsh.question*` / `dsh.approval*` | 提问、审批及其答复 |
99
+ | `connection.phase`、`config.applied`、`wecom.sdk` | 连接状态变化、生效配置(不含 Secret)、SDK 日志 |
100
+
101
+ Secret 值、`secret`/`token`/`authorization` 等字段、`response_url`、媒体 `url` 与 `aeskey` 一律脱敏。日志包含对话原文,请按敏感数据管理;不需要时可在高级设置中关闭。
102
+
103
+ ## 已知限制
104
+
105
+ - **群聊必须 @ 机器人**:企业微信只会把 @ 了机器人的群消息推给它,没 @ 的消息服务器那一层就不转发——插件连回调帧都收不到,无法处理。这是平台限制,不是插件的开关。
106
+ - **@ 不会被平台摘掉,位置会影响解析**:实测确认企业微信不会把 "@显示名" 从正文里去掉,它停在发送者打字时光标所在的位置。插件会去掉**消息最开头**连续的一个或多个 `@xxx ` 提及(命令解析、提交给 DSH 的内容都基于去掉之后的文本),消息中间的 @ 则原样保留,当作用户确实想说的话。
107
+ - **群聊"话题"(thread)里 @ 机器人,目前收不到消息**:这是用户实测观察到的现象,我们没有查到官方文档确认具体原因(未联网核实),推测大概率是当前 `@wecom/aibot-node-sdk`(进而是企业微信智能机器人 API 本身)还没有把"话题"当作一种消息来源对接——SDK 的消息类型定义(`BaseMessage` 等)里完全没有 `thread_id` / `root_msgid` 这类字段,拿到的回调结构和普通群消息没有任何区别的字段可用来判断"这是不是来自某个话题"。
108
+ - **机器人发的消息不能开成一个新话题**:同样没有找到对应能力。SDK 里所有「主动发送」「被动回复」相关的类型(`SendTextParams`、`SendMarkdownParams`、`StreamReplyBody`、`SendMsgBody` 等)都只接受 `chatid`/`msgid`,没有任何话题相关的参数可以传——即使想做,目前这版 SDK 也没有暴露这个能力。
109
+
110
+ **现在的结论**:这两条先记录下来,不在本插件这一层做任何尝试性的绕过(没有可靠的字段/参数可用,勉强做容易做出"看起来支持、实际不可靠"的功能)。等以后企业微信或 `@wecom/aibot-node-sdk` 真的加上话题相关的字段或参数,可以考虑:
111
+
112
+ - **收消息**:如果回调里出现了类似话题 ID 的字段,可以比照现有的"引用定位"机制,把"同一个话题里的消息"自动路由到同一个 DSH 会话——不需要每次都 `/use` 或引用,天然用话题分组多个并行任务。
113
+ - **发消息**:如果发送 / 回复 API 支持指定话题,完成通知可以发回触发它的那个话题里,而不是群的主干道,长时间跑的任务也不会刷屏主群。
114
+
115
+ ## 代码结构
116
+
117
+ ```text
118
+ src/
119
+ shared/protocol.ts Host 与页面共享的常量和状态接口类型
120
+ host/ DSH Host 插件(Node ESM,tsc → dist/host)
121
+ index.ts 入口:Config、inject、apply
122
+ config.ts Config schema 与规范化
123
+ runtime.ts 宿主生命周期编排:配置/凭据变化时重建连接;唯一的 session/event 监听
124
+ bridge/ 一条企微连接:
125
+ index.ts 组装、入站处理、通知/提问/审批
126
+ inbound.ts 回调帧校验与防重放
127
+ policy.ts 三组白名单
128
+ directory.ts 可操作会话(目录 ∩ 白名单)与 /use 解析
129
+ commands.ts 斜杠命令
130
+ interactions.ts 提问/审批等待与验证码
131
+ notices.ts 消息模板
132
+ outbox.ts 主动推送队列
133
+ selection.ts 每人的会话选择
134
+ format.ts 文本工具
135
+ catalog.ts 按 Workspace 分组的 Session 目录(与侧边栏一致)
136
+ observation.ts 见过的企微用户/会话(含被拒绝)
137
+ rounds.ts 每条消息的一轮记录 → round.complete
138
+ turns.ts 从 Session 日志汇总一个回合
139
+ journal.ts JSONL 日志、DSH home 解析、脱敏
140
+ status.ts 连接状态与计数
141
+ routes.ts 已认证的状态接口
142
+ client/ 插件主页(React TSX,esbuild → dist/client.js)
143
+ index.tsx 注册到 plugins.bundle.config
144
+ components/ 状态栏、风险提示、凭据、会话选择、来源选择、高级设置
145
+ hooks.ts / api.ts Config 表单、凭据、状态接口
146
+ model.ts 纯函数:草稿、差异、校验、筛选
147
+ styles.ts 基于 DSH 主题变量的样式
148
+ scripts/build-client.mjs 打包为 DSH 浏览器模块格式(React 与 DSH UI 组件由宿主提供)
149
+ test/ node:test:Host 单元测试、页面渲染测试(react-test-renderer)
150
+ ```
151
+
152
+ 真实企业微信端到端送达需要本人在插件主页输入 Bot ID/Secret 后,用真实账号收发消息验证;平台限制以真实回执为准。
@@ -0,0 +1,4 @@
1
+ - insert:
2
+ - id: wecom-bot
3
+ name: 'dsh-wecom-bot'
4
+ config: {}