@zhin.js/adapter-wecom 0.0.1 → 1.1.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 (66) hide show
  1. package/CHANGELOG.md +624 -0
  2. package/README.md +80 -216
  3. package/adapters/wecom.js +34 -0
  4. package/adapters/wecom.ts +39 -0
  5. package/{skills/wecom → agent}/PERMITS.md +1 -1
  6. package/agent/tools/get_dept_users.ts +16 -0
  7. package/agent/tools/get_user.ts +15 -0
  8. package/agent/tools/list_departments.ts +16 -0
  9. package/agent/tools/send_text.ts +17 -0
  10. package/commands/endpoint/add/[id].js +3 -0
  11. package/commands/endpoint/add/[id].ts +3 -0
  12. package/commands/endpoint/list.js +3 -0
  13. package/commands/endpoint/list.ts +3 -0
  14. package/commands/endpoint/remove/[id].js +3 -0
  15. package/commands/endpoint/remove/[id].ts +3 -0
  16. package/lib/client.d.ts +12 -0
  17. package/lib/client.js +2 -0
  18. package/lib/endpoint.d.ts +55 -37
  19. package/lib/endpoint.js +247 -516
  20. package/lib/index.d.ts +6 -15
  21. package/lib/index.js +6 -115
  22. package/lib/media-upload.d.ts +23 -0
  23. package/lib/media-upload.js +58 -0
  24. package/lib/platform-permit.d.ts +2 -4
  25. package/lib/platform-permit.js +5 -11
  26. package/lib/protocol.d.ts +102 -0
  27. package/lib/protocol.js +268 -0
  28. package/lib/side-event-dispatch.d.ts +4 -0
  29. package/lib/side-event-dispatch.js +63 -0
  30. package/lib/webhook.d.ts +14 -0
  31. package/lib/webhook.js +86 -0
  32. package/lib/wecom-endpoint-commands.d.ts +1 -0
  33. package/lib/wecom-endpoint-commands.js +19 -0
  34. package/lib/wecom-runtime-state.d.ts +1 -0
  35. package/lib/wecom-runtime-state.js +6 -0
  36. package/package.json +64 -16
  37. package/plugin.js +19 -0
  38. package/schema.json +96 -0
  39. package/src/client.ts +16 -0
  40. package/src/endpoint.ts +311 -559
  41. package/src/index.ts +52 -131
  42. package/src/media-upload.ts +79 -0
  43. package/src/platform-permit.ts +6 -11
  44. package/src/protocol.ts +379 -0
  45. package/src/side-event-dispatch.ts +70 -0
  46. package/src/webhook.ts +130 -0
  47. package/src/wecom-endpoint-commands.ts +20 -0
  48. package/src/wecom-runtime-state.ts +7 -0
  49. package/lib/adapter.d.ts +0 -15
  50. package/lib/adapter.d.ts.map +0 -1
  51. package/lib/adapter.js +0 -20
  52. package/lib/adapter.js.map +0 -1
  53. package/lib/endpoint.d.ts.map +0 -1
  54. package/lib/endpoint.js.map +0 -1
  55. package/lib/index.d.ts.map +0 -1
  56. package/lib/index.js.map +0 -1
  57. package/lib/platform-permit.d.ts.map +0 -1
  58. package/lib/platform-permit.js.map +0 -1
  59. package/lib/types.d.ts +0 -48
  60. package/lib/types.d.ts.map +0 -1
  61. package/lib/types.js +0 -5
  62. package/lib/types.js.map +0 -1
  63. package/plugin.yml +0 -3
  64. package/src/adapter.ts +0 -26
  65. package/src/types.ts +0 -51
  66. /package/{skills/wecom/SKILL.md → agent/skills/wecom.md} +0 -0
package/README.md CHANGED
@@ -1,6 +1,13 @@
1
1
  # @zhin.js/adapter-wecom
2
2
 
3
- Zhin.js 企业微信(WeCom)适配器,支持企业内部应用机器人开发。
3
+ Zhin.js 企业微信(WeCom)适配器(Plugin Runtime),通过 Runtime Host HTTP Webhook 收发消息。
4
+
5
+ ## 功能
6
+
7
+ - Webhook 事件接收(`httpHostToken` GET 验签解密 + POST 消息)
8
+ - AES-256-CBC 消息加解密与 SHA1 签名验证
9
+ - Access Token 自动刷新
10
+ - 约定式 `defineAdapter` / `definePlugin`(无需 `usePlugin`)
4
11
 
5
12
  ## 安装
6
13
 
@@ -8,255 +15,112 @@ Zhin.js 企业微信(WeCom)适配器,支持企业内部应用机器人开
8
15
  pnpm add @zhin.js/adapter-wecom
9
16
  ```
10
17
 
11
- ## 前置条件
18
+ ## Plugin Runtime
12
19
 
13
- ### 企业微信管理后台配置
20
+ - `@zhin.js/adapter` — 约定式 `adapters/wecom.ts`(`defineAdapter`)
21
+ - `@zhin.js/core` — `Endpoint.emit(...)` 入站、`outboundMessageToken` 出站
22
+ - `@zhin.js/host-http` — `httpHostToken` 注册 Webhook 路由(**非** legacy host-router/Koa)
23
+ - `zhin.js` — `plugin.ts`(`definePlugin`)
24
+ - 配置经插件 `schema.json` 落到 `plugins.<instanceKey>`
14
25
 
15
- 1. **登录企业微信管理后台**
16
- - 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame)
17
- - 使用管理员账号登录
26
+ 入站:`gateway.receive({ conversation, message: { conversation, id: MsgId }, content: text, sender, metadata })`(`conversation` 为 `ConversationRef`,`@chatroom` → kind `group`,其余 → kind `private`)
27
+ 出站:`send({ conversation, payload })` → 企业微信 `message/send` API
18
28
 
19
- 2. **创建应用**
20
- - 进入「应用管理」→「自建」
21
- - 点击「创建应用」
22
- - 填写应用名称、上传 Logo、选择可见范围
29
+ 入站 `metadata.mentioned`:**未接线**。企业微信应用消息回调的 XML 事件不含 mentions/@ 字段,回调里的 `ToUserName` 是 CorpID(企业 ID)而非可比较的 bot 用户 id,配置中也没有 bot id/name 可作可靠判据,故无法可靠识别 @ 机器人。
23
30
 
24
- 3. **获取应用凭证**
25
- - 在应用详情页面获取:
26
- - **CorpId**(企业 ID):在「我的企业」→「企业信息」中查看
27
- - **AgentId**(应用 AgentId):在应用详情页面
28
- - **Secret**(应用 Secret):在应用详情页面
31
+ ## 前置条件
29
32
 
30
- 4. **配置接收消息**
31
- - 在应用详情页面,进入「接收消息」设置
32
- - 设置 **URL**:`https://yourdomain.com/wecom/callback`
33
- - 设置 **Token**:自定义字符串(用于签名验证)
34
- - 设置 **EncodingAESKey**:点击「随机获取」(用于消息加解密)
35
- - 点击「保存」,企业微信会发送验证请求
33
+ ### 企业微信管理后台配置
36
34
 
37
- 5. **配置权限**
38
- - 在「API 权限」中申请所需权限:
39
- - `通讯录只读权限` - 读取组织架构和用户信息
40
- - `应用消息发送权限` - 向用户发送消息
41
- - 其他业务需要的权限
35
+ 1. 登录 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame)
36
+ 2. 「应用管理」→「自建」→ 创建应用,获取 **CorpId**、**AgentId**、**Secret**
37
+ 3. 「接收消息」设置:
38
+ - **URL**:`https://yourdomain.com/wecom/callback`
39
+ - **Token** / **EncodingAESKey** 与配置一致
40
+ 4. Runtime Host(`http`)须已 listen,Webhook 才可达
42
41
 
43
- ## 配置
42
+ 必填字段(`endpoints[i]`):`name`、`corpId`、`agentSecret`、`token`、`encodingAESKey`。
44
43
 
45
- ### 基础配置(zhin.config.yml)
44
+ ## 最小配置
46
45
 
47
46
  ```yaml
48
- endpoints:
49
- - name: wecom-bot
50
- context: wecom
51
- corpId: "ww1234567890abcdef"
52
- agentSecret: "your-agent-secret"
53
- token: "your-verify-token"
54
- encodingAESKey: "your-43-char-encoding-aes-key"
55
- webhookPath: "/wecom/callback"
56
-
47
+ # zhin.config.yml(Plugin Runtime)
57
48
  plugins:
58
- - "@zhin.js/host-router"
59
- - "@zhin.js/adapter-wecom"
60
- ```
61
-
62
- ### 完整配置
63
-
64
- ```yaml
65
- endpoints:
66
- - name: wecom-bot
67
- context: wecom
68
- corpId: "ww1234567890abcdef"
69
- agentSecret: "your-agent-secret"
70
- token: "your-verify-token"
71
- encodingAESKey: "your-43-char-encoding-aes-key"
72
- webhookPath: "/wecom/callback"
73
- apiBaseUrl: "https://qyapi.weixin.qq.com" # 可选,默认值
49
+ wecom:
50
+ webhookPath: /wecom/callback # 可选,默认 /wecom/callback
51
+ apiBaseUrl: https://qyapi.weixin.qq.com # 可选
52
+ endpoints:
53
+ - name: wecom-bot
54
+ corpId: ${WECOM_CORP_ID}
55
+ agentSecret: ${WECOM_AGENT_SECRET}
56
+ token: ${WECOM_TOKEN}
57
+ encodingAESKey: ${WECOM_AES_KEY}
74
58
  ```
75
59
 
76
- ### 配置参数说明
77
-
78
- | 参数 | 必需 | 说明 |
79
- |------|------|------|
80
- | `corpId` | 是 | 企业 ID,在管理后台「我的企业」查看 |
81
- | `agentSecret` | 是 | 应用 Secret,在应用详情页获取 |
82
- | `token` | 是 | 用于签名验证,需与管理后台「接收消息」设置中的 Token 一致 |
83
- | `encodingAESKey` | 是 | 用于消息加解密,需与管理后台一致(43 字符) |
84
- | `webhookPath` | 否 | Webhook 回调路径,默认 `/wecom/callback` |
85
- | `apiBaseUrl` | 否 | 企业微信 API 地址,默认 `https://qyapi.weixin.qq.com` |
60
+ 根插件 `zhin.plugins`(或项目图)需引用 `@zhin.js/adapter-wecom`(`instanceKey: wecom`)。
86
61
 
87
- ### 环境变量推荐
88
-
89
- ```yaml
90
- endpoints:
91
- - name: wecom-bot
92
- context: wecom
93
- corpId: "${WECOM_CORP_ID}"
94
- agentSecret: "${WECOM_AGENT_SECRET}"
95
- token: "${WECOM_TOKEN}"
96
- encodingAESKey: "${WECOM_AES_KEY}"
97
- ```
98
-
99
- ## 使用示例
100
-
101
- ### 接收和发送消息
102
-
103
- ```typescript
104
- import { usePlugin, MessageCommand } from 'zhin.js'
105
-
106
- const { addCommand, logger } = usePlugin()
107
-
108
- // 定义命令
109
- addCommand(new MessageCommand('hello <name:text>')
110
- .action(async (message, result) => {
111
- logger.info(`收到问候: ${result.params.name}`)
112
- return `你好,${result.params.name}!欢迎使用企业微信机器人。`
113
- })
114
- )
115
-
116
- // 监听所有消息
117
- import { onMessage } from 'zhin.js'
118
-
119
- onMessage(async (message) => {
120
- logger.info(`收到消息:${JSON.stringify(message.$content)}`)
121
- logger.info(`发送者:${message.$sender.name}`)
122
- logger.info(`会话类型:${message.$channel.type}`)
123
- })
124
- ```
62
+ ## 环境变量
125
63
 
126
- ### 发送富文本消息
127
-
128
- ```typescript
129
- addCommand(new MessageCommand('info')
130
- .action(async (message) => {
131
- return [
132
- {
133
- type: 'markdown',
134
- data: {
135
- content: `# 系统信息\n\n- 服务器: 运行正常\n- 版本: v1.0.0\n- 状态: 在线`
136
- }
137
- }
138
- ]
139
- })
140
- )
141
- ```
64
+ | 变量 | 说明 |
65
+ |------|------|
66
+ | `WECOM_CORP_ID` | 企业 ID |
67
+ | `WECOM_AGENT_SECRET` | 应用 Secret |
68
+ | `WECOM_TOKEN` | 回调签名 Token |
69
+ | `WECOM_AES_KEY` | EncodingAESKey(43 字符) |
142
70
 
143
71
  ## 消息类型支持
144
72
 
145
- ### 接收消息类型
146
-
147
- | 类型 | 状态 | 说明 |
148
- |------|------|------|
149
- | 文本消息 (`text`) | 支持 | 普通文本 |
150
- | 图片消息 (`image`) | 支持 | 图片文件 |
151
- | 语音消息 (`voice`) | 支持 | 含语音识别结果 |
152
- | 视频消息 (`video`) | 支持 | 视频文件 |
153
- | 位置消息 (`location`) | 支持 | 地理位置 |
154
- | 链接消息 (`link`) | 支持 | 链接卡片 |
155
- | 事件消息 (`event`) | 支持 | 关注/取消关注等 |
156
-
157
- ### 发送消息类型
158
-
159
- | 类型 | 状态 | 说明 |
160
- |------|------|------|
161
- | 文本消息 | 支持 | 支持 @ 提醒 |
162
- | 图片消息 | 支持 | 需要 media_id |
163
- | Markdown 消息 | 支持 | 企业微信原生 Markdown |
164
- | 图文消息 | 支持 | news 类型 |
165
- | 撤回消息 | 不支持 | 企业微信机器人不支持撤回 |
73
+ | 入站类型 | content 摘要 |
74
+ |----------|--------------|
75
+ | text | 原文 |
76
+ | image | `[image: url]` |
77
+ | voice | 识别结果或 `[voice]` |
78
+ | video / shortvideo | `[video]` |
79
+ | location | `[位置] …` |
80
+ | link | `[link: …]` |
81
+ | event | `[事件] …` |
82
+
83
+ | 出站 wire | 说明 |
84
+ |-----------|------|
85
+ | text | 支持 `<@userid>` |
86
+ | image | 需 `media_id` |
87
+ | markdown | 企业微信原生 Markdown |
88
+ | news | link 段映射 |
166
89
 
167
90
  ## 安全说明
168
91
 
169
- ### 消息加解密
170
-
171
- 企业微信使用 AES-256-CBC 加密算法对回调消息进行加密:
172
-
173
- - **签名验证**:SHA1 排序拼接 `[token, timestamp, nonce, encrypt]`
174
- - **解密流程**:
175
- 1. Base64 解码加密消息
176
- 2. AES-256-CBC 解密(Key: `encodingAESKey` + `=` 的 Base64 解码,IV: Key 的前 16 字节)
177
- 3. PKCS7 去填充
178
- 4. 提取:16 字节随机数 + 4 字节消息长度 + 消息体 + CorpId
92
+ 企业微信回调始终加密:
179
93
 
180
- 适配器自动处理所有加解密,无需手动处理。
181
-
182
- ### Token 管理
183
-
184
- 适配器会自动管理 access_token:
185
- - 首次连接时获取 token
186
- - Token 过期前 5 分钟自动刷新
187
- - 所有 API 请求自动携带有效 token
188
-
189
- ## API 方法
190
-
191
- ### 获取用户信息
192
-
193
- ```typescript
194
- const endpoint = app.adapters.get('wecom')?.endpoints.get('wecom-bot')
195
- if (endpoint) {
196
- const userInfo = await endpoint.getUserInfo('user-id')
197
- console.log(userInfo)
198
- }
199
- ```
94
+ - **签名**:SHA1 排序拼接 `[token, timestamp, nonce, encrypt]`
95
+ - **解密**:AES-256-CBC(Key = `encodingAESKey` + `=` 的 Base64,IV = Key 前 16 字节)
200
96
 
201
- ### 获取部门用户列表
202
-
203
- ```typescript
204
- const users = await endpoint.getDepartmentUsers(1) // 部门 ID
205
- console.log(users)
206
- ```
207
-
208
- ### 获取部门列表
209
-
210
- ```typescript
211
- const departments = await endpoint.getDepartmentList(1) // 父部门 ID
212
- console.log(departments)
213
- ```
214
-
215
- ### 发送文本消息
216
-
217
- ```typescript
218
- const success = await endpoint.sendTextMessage('user-id', '这是一条测试消息')
219
- ```
97
+ Access Token 在过期前 5 分钟自动刷新。
220
98
 
221
99
  ## 故障排查
222
100
 
223
- ### Q: Webhook 验证失败?
224
-
225
- A: 检查以下几点:
226
- 1. `token` 是否与企业微信管理后台设置的 Token 一致
227
- 2. `encodingAESKey` 是否与管理后台一致(43 字符)
228
- 3. 服务器是否可从公网访问
229
- 4. 服务器是否返回了正确的验证响应(解密后的 echostr)
230
-
231
- ### Q: 收不到消息回调?
232
-
233
- A: 可能的原因:
234
- 1. 应用未启用「接收消息」功能
235
- 2. Webhook URL 配置错误或不可达
236
- 3. 应用可见范围未包含发送消息的用户
237
- 4. 服务器日志中是否有签名验证失败的警告
101
+ | 现象 | 排查 |
102
+ |------|------|
103
+ | URL 验证失败 | `token` / `encodingAESKey` / `corpId` 与管理后台一致;Host 已 listen 且公网可达 |
104
+ | 收不到消息 | 应用已启用接收消息;可见范围包含发送者;endpoint 已 `open()` |
105
+ | 发送失败 | `corpId` + `agentSecret` 可换取 token;接收者在可见范围 |
238
106
 
239
- ### Q: 发送消息失败?
107
+ ## AI 工具
240
108
 
241
- A: 可能的原因:
242
- 1. `agentSecret`(应用 Secret)配置错误
243
- 2. access_token 获取失败(检查 CorpId 和 Secret)
244
- 3. 接收者不在应用可见范围内
245
- 4. 应用未开通消息发送权限
109
+ | 类别 | 路径 |
110
+ |------|------|
111
+ | Permit 词汇 | `agent/PERMITS.md` |
112
+ | 平台工具(4 个) | `agent/tools/` |
113
+ | 技能说明 | `agent/skills/wecom.md` |
246
114
 
247
- ### Q: Token 刷新失败?
115
+ ## 平台权限(platform permit)
248
116
 
249
- A: 检查:
250
- 1. CorpId 是否正确
251
- 2. agentSecret 是否是应用 Secret(不是应用的 AgentId 数字)
252
- 3. 企业微信 API 是否可访问
117
+ `plugin.ts` 在 generation setup 注册 `src/platform-permit.ts` checker,并在 dispose 注销;CapabilityIngress 与 ToolSystem 统一经 Core `canAccessTool()` 消费工具权限。
253
118
 
254
119
  ## 相关链接
255
120
 
256
121
  - [企业微信开发文档](https://developer.work.weixin.qq.com/document/)
257
- - [企业微信接收消息](https://developer.work.weixin.qq.com/document/path/90930)
258
- - [企业微信发送应用消息](https://developer.work.weixin.qq.com/document/path/90236)
259
- - [Zhin.js 官方文档](https://github.com/zhinjs/zhin)
122
+ - [接收消息](https://developer.work.weixin.qq.com/document/path/90930)
123
+ - [发送应用消息](https://developer.work.weixin.qq.com/document/path/90236)
260
124
 
261
125
  ## 许可证
262
126
 
@@ -0,0 +1,34 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ /**
3
+ * Convention entry: discover `adapters/wecom.ts` → defineAdapter.
4
+ * Implementation lives under `src/` (endpoint / webhook / protocol).
5
+ */
6
+ import { defineAdapter } from 'zhin.js/adapter';
7
+ import { httpHostToken } from '@zhin.js/host-http';
8
+ import { WecomEndpoint } from "../lib/endpoint.js";
9
+ import { resolveWecomConfig, } from "../lib/protocol.js";
10
+ import { wecomRuntimeStateToken } from "../lib/wecom-runtime-state.js";
11
+ export { WecomEndpoint } from "../lib/endpoint.js";
12
+ export default defineAdapter({
13
+ capabilities: ['inbound', 'outbound'],
14
+ operations: ['recall'],
15
+ // image 段全部经 /cgi-bin/media/upload 物化为 media_id(url 下载后上传、
16
+ // base64/path 直接上传、file 引用直用 media_id);无卡片交互面,交互段降级纯文本。
17
+ segments: {
18
+ outboundMedia: ['upload'],
19
+ interactive: 'text',
20
+ },
21
+ create(context) {
22
+ const config = resolveWecomConfig(context.config);
23
+ // 注册到插件运行时状态(wecom.endpoint list 的"运行中"数据源)
24
+ context.use(wecomRuntimeStateToken).endpoints.set(config.id, {
25
+ id: config.id,
26
+ mode: 'webhook',
27
+ });
28
+ return new WecomEndpoint({
29
+ id: context.id,
30
+ http: context.use(httpHostToken),
31
+ config,
32
+ });
33
+ },
34
+ });
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Convention entry: discover `adapters/wecom.ts` → defineAdapter.
3
+ * Implementation lives under `src/` (endpoint / webhook / protocol).
4
+ */
5
+ import { defineAdapter } from 'zhin.js/adapter';
6
+ import { httpHostToken } from '@zhin.js/host-http';
7
+ import { WecomEndpoint } from '../src/endpoint.js';
8
+ import {
9
+ resolveWecomConfig,
10
+ type WecomAdapterConfig,
11
+ } from '../src/protocol.js';
12
+ import { wecomRuntimeStateToken } from '../src/wecom-runtime-state.js';
13
+
14
+ export { WecomEndpoint } from '../src/endpoint.js';
15
+ export type { WecomEndpointOptions, WecomFetch } from '../src/endpoint.js';
16
+
17
+ export default defineAdapter<WecomAdapterConfig>({
18
+ capabilities: ['inbound', 'outbound'],
19
+ operations: ['recall'],
20
+ // image 段全部经 /cgi-bin/media/upload 物化为 media_id(url 下载后上传、
21
+ // base64/path 直接上传、file 引用直用 media_id);无卡片交互面,交互段降级纯文本。
22
+ segments: {
23
+ outboundMedia: ['upload'],
24
+ interactive: 'text',
25
+ },
26
+ create(context) {
27
+ const config = resolveWecomConfig(context.config);
28
+ // 注册到插件运行时状态(wecom.endpoint list 的"运行中"数据源)
29
+ context.use(wecomRuntimeStateToken).endpoints.set(config.id, {
30
+ id: config.id,
31
+ mode: 'webhook',
32
+ });
33
+ return new WecomEndpoint({
34
+ id: context.id,
35
+ http: context.use(httpHostToken),
36
+ config,
37
+ });
38
+ },
39
+ });
@@ -16,4 +16,4 @@
16
16
 
17
17
  ## 工厂映射
18
18
 
19
- `group_admin` → `chat_admin` · `group_owner` → `chat_owner`
19
+ `scene_admin` → `chat_admin` · `scene_owner` → `chat_owner`
@@ -0,0 +1,16 @@
1
+ import { defineAgentTool } from '@zhin.js/agent/tools';
2
+ import { z } from 'zod';
3
+ export default defineAgentTool<{ dept_id: string }>({
4
+ description: '获取企业微信部门用户列表',
5
+ inputSchema: z.object({
6
+ dept_id: z.string().describe('部门 ID'),
7
+ }),
8
+ adapter: 'wecom',
9
+ tags: ['wecom'],
10
+ async execute({ dept_id }: { dept_id: string }, context) {
11
+ const endpoint = context.$client;
12
+ const users = await endpoint.getDepartmentUsers(Number(dept_id));
13
+ return { users, count: users.length };
14
+ },
15
+ });
16
+
@@ -0,0 +1,15 @@
1
+ import { defineAgentTool } from '@zhin.js/agent/tools';
2
+ import { z } from 'zod';
3
+ export default defineAgentTool<{ user_id: string }>({
4
+ description: '获取企业微信用户信息',
5
+ inputSchema: z.object({
6
+ user_id: z.string().describe('用户 ID'),
7
+ }),
8
+ adapter: 'wecom',
9
+ tags: ['wecom'],
10
+ async execute({ user_id }: { user_id: string }, context) {
11
+ const endpoint = context.$client;
12
+ return await endpoint.getUserInfo(user_id);
13
+ },
14
+ });
15
+
@@ -0,0 +1,16 @@
1
+ import { defineAgentTool } from '@zhin.js/agent/tools';
2
+ import { z } from 'zod';
3
+ export default defineAgentTool<{ dept_id?: string }>({
4
+ description: '获取企业微信部门列表',
5
+ inputSchema: z.object({
6
+ dept_id: z.string().optional().describe('父部门 ID,默认 1(根部门)'),
7
+ }),
8
+ adapter: 'wecom',
9
+ tags: ['wecom'],
10
+ async execute({ dept_id }: { dept_id?: string }, context) {
11
+ const endpoint = context.$client;
12
+ const departments = await endpoint.getDepartmentList(Number(dept_id) || 1);
13
+ return { departments, count: departments.length };
14
+ },
15
+ });
16
+
@@ -0,0 +1,17 @@
1
+ import { defineAgentTool } from '@zhin.js/agent/tools';
2
+ import { z } from 'zod';
3
+ export default defineAgentTool<{ user_id: string; content: string }>({
4
+ description: '向指定企业微信用户发送文本消息',
5
+ inputSchema: z.object({
6
+ user_id: z.string().describe('用户 ID'),
7
+ content: z.string().describe('消息内容'),
8
+ }),
9
+ adapter: 'wecom',
10
+ tags: ['wecom'],
11
+ async execute({ user_id, content }: { user_id: string; content: string }, context) {
12
+ const endpoint = context.$client;
13
+ const success = await endpoint.sendTextMessage(user_id, content);
14
+ return { success, message: success ? '消息已发送' : '发送失败' };
15
+ },
16
+ });
17
+
@@ -0,0 +1,3 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ import { wecomEndpointCommands } from "../../../lib/wecom-endpoint-commands.js";
3
+ export default wecomEndpointCommands.add;
@@ -0,0 +1,3 @@
1
+ import { wecomEndpointCommands } from '../../../src/wecom-endpoint-commands.js';
2
+
3
+ export default wecomEndpointCommands.add;
@@ -0,0 +1,3 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ import { wecomEndpointCommands } from "../../lib/wecom-endpoint-commands.js";
3
+ export default wecomEndpointCommands.list;
@@ -0,0 +1,3 @@
1
+ import { wecomEndpointCommands } from '../../src/wecom-endpoint-commands.js';
2
+
3
+ export default wecomEndpointCommands.list;
@@ -0,0 +1,3 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ import { wecomEndpointCommands } from "../../../lib/wecom-endpoint-commands.js";
3
+ export default wecomEndpointCommands.remove;
@@ -0,0 +1,3 @@
1
+ import { wecomEndpointCommands } from '../../../src/wecom-endpoint-commands.js';
2
+
3
+ export default wecomEndpointCommands.remove;
@@ -0,0 +1,12 @@
1
+ import type { WecomClient } from './endpoint.js';
2
+ import type { WecomMessage } from './protocol.js';
3
+ export type WecomClientEventMap = Record<string, WecomMessage>;
4
+ declare module '@zhin.js/feature-kit' {
5
+ interface AdapterClientRegistry {
6
+ readonly wecom: {
7
+ readonly client: WecomClient;
8
+ readonly events: WecomClientEventMap;
9
+ };
10
+ }
11
+ }
12
+ export declare const wecomClient: import("@zhin.js/adapter").EndpointClientToken<WecomClient, WecomClientEventMap>;
package/lib/client.js ADDED
@@ -0,0 +1,2 @@
1
+ import { defineEndpointClient } from 'zhin.js/adapter';
2
+ export const wecomClient = defineEndpointClient('wecom');
package/lib/endpoint.d.ts CHANGED
@@ -1,43 +1,61 @@
1
+ import { Endpoint } from 'zhin.js/adapter';
1
2
  /**
2
- * 企业微信 Endpoint 实现
3
+ * WecomEndpoint — lifecycle, outbound send, inbound admit, OpenAPI helpers for agent tools.
3
4
  */
4
- import { Endpoint, Message, type SendOptions } from 'zhin.js';
5
- import { type Router } from '@zhin.js/host-router/router';
6
- import type { WecomEndpointConfig, WecomMessage, WecomApiResponse } from './types.js';
7
- import type { WecomAdapter } from './adapter.js';
8
- export declare class WecomEndpoint implements Endpoint<WecomEndpointConfig, WecomMessage> {
9
- #private;
10
- adapter: WecomAdapter;
11
- $config: WecomEndpointConfig;
12
- $connected: boolean;
13
- private router;
14
- private accessToken;
15
- private baseURL;
16
- private aesKey;
17
- private corpId;
18
- get $id(): string;
19
- get logger(): import("zhin.js").Logger;
20
- constructor(adapter: WecomAdapter, router: Router, $config: WecomEndpointConfig);
21
- private request;
22
- private setupWebhookRoute;
23
- private handleVerification;
24
- private handleWebhook;
25
- private verifySignature;
26
- private decryptMessage;
27
- private parseXmlMessage;
28
- private handleMessage;
29
- private ensureAccessToken;
30
- private refreshAccessToken;
31
- $formatMessage(msg: WecomMessage): Message<WecomMessage>;
32
- private parseMessageContent;
33
- $sendMessage(options: SendOptions): Promise<string>;
34
- $recallMessage(_id: string): Promise<void>;
35
- private formatSendContent;
36
- $connect(): Promise<void>;
37
- $disconnect(): Promise<void>;
38
- getUserInfo(userId: string): Promise<WecomApiResponse | null>;
5
+ import { type EndpointControl, type EndpointSendRequest } from 'zhin.js/adapter';
6
+ import type { HttpHost } from '@zhin.js/host-http';
7
+ import type { CapabilityId } from 'zhin.js';
8
+ import { type ResolvedWecomConfig, type WecomMessage } from './protocol.js';
9
+ export type WecomFetch = (url: string, init?: {
10
+ readonly method?: string;
11
+ readonly headers?: Record<string, string>;
12
+ readonly body?: string | FormData;
13
+ }) => Promise<{
14
+ readonly ok: boolean;
15
+ readonly status: number;
16
+ text(): Promise<string>;
17
+ json(): Promise<unknown>;
18
+ }>;
19
+ export interface WecomEndpointOptions {
20
+ readonly id: CapabilityId;
21
+ readonly http: HttpHost;
22
+ readonly config: ResolvedWecomConfig;
23
+ readonly fetch?: WecomFetch;
24
+ }
25
+ export interface WecomClientApi {
26
+ getUserInfo(userId: string): Promise<unknown>;
39
27
  getDepartmentUsers(deptId: number): Promise<unknown[]>;
40
28
  getDepartmentList(deptId?: number): Promise<unknown[]>;
41
29
  sendTextMessage(userId: string, content: string): Promise<boolean>;
42
30
  }
43
- //# sourceMappingURL=endpoint.d.ts.map
31
+ /** WeCom API surface exposed to plugin events without Endpoint lifecycle methods. */
32
+ export declare class WecomClient implements WecomClientApi {
33
+ readonly api: WecomClientApi;
34
+ constructor(api: WecomClientApi);
35
+ getUserInfo: (userId: string) => Promise<unknown>;
36
+ getDepartmentUsers: (deptId: number) => Promise<unknown[]>;
37
+ getDepartmentList: (deptId?: number) => Promise<unknown[]>;
38
+ sendTextMessage: (userId: string, content: string) => Promise<boolean>;
39
+ }
40
+ /**
41
+ * 企业微信服务端 API 无 bot 群列表/群成员列表接口(客户群接口属「客户联系」
42
+ * 独立授权域,非 bot 社交面),好友/频道概念亦不存在;
43
+ * 因此本 endpoint 不暴露 EndpointManagement(Console 社交面 RPC 对该平台保持未接线)。
44
+ */
45
+ export declare class WecomEndpoint extends Endpoint<WecomClient> {
46
+ #private;
47
+ readonly client: WecomClient;
48
+ readonly control: EndpointControl;
49
+ constructor(options: WecomEndpointOptions);
50
+ /** Used by webhook handler. */
51
+ get isOpen(): boolean;
52
+ get config(): ResolvedWecomConfig;
53
+ start(): Promise<void>;
54
+ open(): void;
55
+ close(): void;
56
+ stop(): Promise<void>;
57
+ send({ conversation, payload }: EndpointSendRequest): Promise<string>;
58
+ recallMessage(messageId: string): Promise<void>;
59
+ /** Test / internal: admit a parsed message when open (non-webhook path). */
60
+ admit(msg: WecomMessage): void;
61
+ }