@tencent-connect/openclaw-qqbot 1.7.2 → 2.0.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 (291) hide show
  1. package/README.md +25 -8
  2. package/README.zh.md +24 -8
  3. package/bin/qqbot-cli.js +5 -2
  4. package/dist/index.cjs +15549 -0
  5. package/dist/index.cjs.map +1 -0
  6. package/dist/index.d.cts +890 -0
  7. package/index.ts +56 -19
  8. package/openclaw.plugin.json +19 -3
  9. package/package.json +14 -23
  10. package/preload.cjs +17 -14
  11. package/scripts/link-sdk-core.cjs +133 -50
  12. package/scripts/upgrade-via-npm.sh +42 -11
  13. package/scripts/upgrade-via-source.sh +4 -4
  14. package/skills/qqbot-channel/SKILL.md +34 -12
  15. package/src/adapter/contract.ts +69 -0
  16. package/src/adapter/gateway.ts +61 -0
  17. package/src/adapter/index.ts +15 -0
  18. package/src/adapter/lint.ts +144 -0
  19. package/src/adapter/media.ts +112 -0
  20. package/src/adapter/pairing.ts +99 -0
  21. package/src/adapter/resolve.ts +333 -0
  22. package/src/adapter/setup.ts +55 -0
  23. package/src/adapter/webhook.ts +248 -0
  24. package/src/adapter/workspace.ts +29 -0
  25. package/src/bot-instance.ts +60 -0
  26. package/src/channel.ts +202 -413
  27. package/src/commands/bot-approve.ts +143 -0
  28. package/src/commands/bot-clear-storage.ts +114 -0
  29. package/src/commands/bot-group-always.ts +62 -0
  30. package/src/commands/bot-help.ts +40 -0
  31. package/src/commands/bot-logs.ts +248 -0
  32. package/src/commands/bot-me.ts +18 -0
  33. package/src/commands/bot-pairing.ts +57 -0
  34. package/src/commands/bot-ping.ts +33 -0
  35. package/src/commands/bot-streaming.ts +55 -0
  36. package/src/commands/bot-upgrade.ts +56 -0
  37. package/src/commands/bot-version.ts +41 -0
  38. package/src/commands/config-util.ts +96 -0
  39. package/src/commands/index.ts +49 -0
  40. package/src/config.ts +46 -19
  41. package/src/dispatch/body-assembler.ts +356 -0
  42. package/src/dispatch/ctx-builder.ts +110 -0
  43. package/src/dispatch/dispatch.ts +352 -0
  44. package/src/dispatch/envelope-builder.ts +112 -0
  45. package/src/dispatch/index.ts +2 -0
  46. package/src/{approval-handler.ts → features/approval-handler.ts} +40 -94
  47. package/src/features/approval-utils.ts +41 -0
  48. package/src/features/credential-backup.ts +82 -0
  49. package/src/features/history-store.ts +19 -0
  50. package/src/features/msgid-cache.ts +55 -0
  51. package/src/features/onboarding.ts +38 -0
  52. package/src/{proactive.ts → features/proactive.ts} +68 -49
  53. package/src/features/ref-index-store.ts +282 -0
  54. package/src/{update-checker.ts → features/update-checker.ts} +15 -35
  55. package/src/gateway/event-handlers.ts +241 -0
  56. package/src/gateway/index.ts +3 -0
  57. package/src/gateway/lifecycle.ts +221 -0
  58. package/src/gateway/middleware-setup.ts +139 -0
  59. package/src/gateway/qqbot-gateway.ts +342 -0
  60. package/src/middleware/access-control.ts +130 -0
  61. package/src/middleware/attachment.ts +314 -0
  62. package/src/middleware/policy-injector.ts +66 -0
  63. package/src/openclaw-plugin-sdk.d.ts +81 -10
  64. package/src/outbound/cron-scheduler.ts +130 -0
  65. package/src/outbound/debounce.ts +102 -0
  66. package/src/outbound/deliver-pipeline.ts +235 -0
  67. package/src/outbound/image-size.ts +123 -0
  68. package/src/outbound/index.ts +3 -0
  69. package/src/outbound/local-file-router.ts +145 -0
  70. package/src/outbound/media-send.ts +377 -0
  71. package/src/outbound/outbound-service.ts +222 -0
  72. package/src/outbound/reply-limiter.ts +128 -0
  73. package/src/outbound/sanitize.ts +32 -0
  74. package/src/outbound/streaming-controller.ts +228 -0
  75. package/src/outbound/target.ts +63 -0
  76. package/src/outbound/tts-provider.ts +84 -0
  77. package/src/request-context.ts +9 -8
  78. package/src/runtime.ts +31 -6
  79. package/src/setup/account-key.ts +41 -0
  80. package/src/setup/finalize.ts +110 -0
  81. package/src/setup/login.ts +197 -0
  82. package/src/setup/surface.ts +40 -0
  83. package/src/tools/platform.ts +149 -0
  84. package/src/tools/remind.ts +2 -0
  85. package/src/types-augment.d.ts +54 -0
  86. package/src/types.ts +51 -9
  87. package/src/utils/mention.ts +52 -0
  88. package/src/utils/pkg-version.ts +84 -47
  89. package/src/utils/platform.ts +31 -7
  90. package/src/utils/plugin-logger.ts +104 -0
  91. package/src/utils/ssrf-guard.ts +32 -2
  92. package/src/utils/stt.ts +137 -0
  93. package/src/utils/voice-text.ts +61 -0
  94. package/tsconfig.json +2 -1
  95. package/tsup.config.ts +57 -0
  96. package/dist/index.d.ts +0 -18
  97. package/dist/index.js +0 -27
  98. package/dist/src/admin-resolver.d.ts +0 -33
  99. package/dist/src/admin-resolver.js +0 -157
  100. package/dist/src/api.d.ts +0 -309
  101. package/dist/src/api.js +0 -923
  102. package/dist/src/approval-handler.d.ts +0 -47
  103. package/dist/src/approval-handler.js +0 -372
  104. package/dist/src/channel.d.ts +0 -29
  105. package/dist/src/channel.js +0 -528
  106. package/dist/src/config.d.ts +0 -60
  107. package/dist/src/config.js +0 -288
  108. package/dist/src/credential-backup.d.ts +0 -31
  109. package/dist/src/credential-backup.js +0 -66
  110. package/dist/src/deliver-debounce.d.ts +0 -74
  111. package/dist/src/deliver-debounce.js +0 -174
  112. package/dist/src/gateway.d.ts +0 -18
  113. package/dist/src/gateway.js +0 -2025
  114. package/dist/src/group-history.d.ts +0 -136
  115. package/dist/src/group-history.js +0 -226
  116. package/dist/src/image-server.d.ts +0 -87
  117. package/dist/src/image-server.js +0 -570
  118. package/dist/src/inbound-attachments.d.ts +0 -60
  119. package/dist/src/inbound-attachments.js +0 -248
  120. package/dist/src/known-users.d.ts +0 -100
  121. package/dist/src/known-users.js +0 -263
  122. package/dist/src/message-gating.d.ts +0 -53
  123. package/dist/src/message-gating.js +0 -107
  124. package/dist/src/message-queue.d.ts +0 -91
  125. package/dist/src/message-queue.js +0 -257
  126. package/dist/src/onboarding.d.ts +0 -10
  127. package/dist/src/onboarding.js +0 -203
  128. package/dist/src/outbound-deliver.d.ts +0 -48
  129. package/dist/src/outbound-deliver.js +0 -392
  130. package/dist/src/outbound.d.ts +0 -220
  131. package/dist/src/outbound.js +0 -975
  132. package/dist/src/proactive.d.ts +0 -170
  133. package/dist/src/proactive.js +0 -399
  134. package/dist/src/ref-index-store.d.ts +0 -101
  135. package/dist/src/ref-index-store.js +0 -298
  136. package/dist/src/reply-dispatcher.d.ts +0 -35
  137. package/dist/src/reply-dispatcher.js +0 -311
  138. package/dist/src/request-context.d.ts +0 -25
  139. package/dist/src/request-context.js +0 -37
  140. package/dist/src/runtime.d.ts +0 -3
  141. package/dist/src/runtime.js +0 -13
  142. package/dist/src/session-store.d.ts +0 -52
  143. package/dist/src/session-store.js +0 -254
  144. package/dist/src/slash-commands.d.ts +0 -82
  145. package/dist/src/slash-commands.js +0 -2233
  146. package/dist/src/startup-greeting.d.ts +0 -30
  147. package/dist/src/startup-greeting.js +0 -97
  148. package/dist/src/streaming.d.ts +0 -247
  149. package/dist/src/streaming.js +0 -899
  150. package/dist/src/stt.d.ts +0 -21
  151. package/dist/src/stt.js +0 -70
  152. package/dist/src/tools/channel.d.ts +0 -16
  153. package/dist/src/tools/channel.js +0 -231
  154. package/dist/src/tools/remind.d.ts +0 -2
  155. package/dist/src/tools/remind.js +0 -255
  156. package/dist/src/transport/index.d.ts +0 -10
  157. package/dist/src/transport/index.js +0 -9
  158. package/dist/src/transport/webhook-transport.d.ts +0 -67
  159. package/dist/src/transport/webhook-transport.js +0 -245
  160. package/dist/src/transport/webhook-verify.d.ts +0 -48
  161. package/dist/src/transport/webhook-verify.js +0 -98
  162. package/dist/src/types.d.ts +0 -462
  163. package/dist/src/types.js +0 -22
  164. package/dist/src/typing-keepalive.d.ts +0 -27
  165. package/dist/src/typing-keepalive.js +0 -64
  166. package/dist/src/update-checker.d.ts +0 -36
  167. package/dist/src/update-checker.js +0 -171
  168. package/dist/src/utils/audio-convert.d.ts +0 -98
  169. package/dist/src/utils/audio-convert.js +0 -783
  170. package/dist/src/utils/chunked-upload.d.ts +0 -68
  171. package/dist/src/utils/chunked-upload.js +0 -341
  172. package/dist/src/utils/file-utils.d.ts +0 -61
  173. package/dist/src/utils/file-utils.js +0 -172
  174. package/dist/src/utils/image-size.d.ts +0 -51
  175. package/dist/src/utils/image-size.js +0 -234
  176. package/dist/src/utils/media-send.d.ts +0 -158
  177. package/dist/src/utils/media-send.js +0 -502
  178. package/dist/src/utils/media-tags.d.ts +0 -14
  179. package/dist/src/utils/media-tags.js +0 -165
  180. package/dist/src/utils/payload.d.ts +0 -112
  181. package/dist/src/utils/payload.js +0 -186
  182. package/dist/src/utils/pkg-version.d.ts +0 -5
  183. package/dist/src/utils/pkg-version.js +0 -61
  184. package/dist/src/utils/platform.d.ts +0 -137
  185. package/dist/src/utils/platform.js +0 -390
  186. package/dist/src/utils/ssrf-guard.d.ts +0 -25
  187. package/dist/src/utils/ssrf-guard.js +0 -91
  188. package/dist/src/utils/text-parsing.d.ts +0 -31
  189. package/dist/src/utils/text-parsing.js +0 -74
  190. package/dist/src/utils/upload-cache.d.ts +0 -34
  191. package/dist/src/utils/upload-cache.js +0 -93
  192. package/node_modules/@eshaz/web-worker/LICENSE +0 -201
  193. package/node_modules/@eshaz/web-worker/README.md +0 -134
  194. package/node_modules/@eshaz/web-worker/browser.js +0 -17
  195. package/node_modules/@eshaz/web-worker/cjs/browser.js +0 -16
  196. package/node_modules/@eshaz/web-worker/cjs/node.js +0 -219
  197. package/node_modules/@eshaz/web-worker/index.d.ts +0 -4
  198. package/node_modules/@eshaz/web-worker/node.js +0 -223
  199. package/node_modules/@eshaz/web-worker/package.json +0 -54
  200. package/node_modules/@wasm-audio-decoders/common/index.js +0 -5
  201. package/node_modules/@wasm-audio-decoders/common/package.json +0 -36
  202. package/node_modules/@wasm-audio-decoders/common/src/WASMAudioDecoderCommon.js +0 -231
  203. package/node_modules/@wasm-audio-decoders/common/src/WASMAudioDecoderWorker.js +0 -129
  204. package/node_modules/@wasm-audio-decoders/common/src/puff/README +0 -67
  205. package/node_modules/@wasm-audio-decoders/common/src/puff/build_puff.js +0 -31
  206. package/node_modules/@wasm-audio-decoders/common/src/puff/puff.c +0 -863
  207. package/node_modules/@wasm-audio-decoders/common/src/puff/puff.h +0 -35
  208. package/node_modules/@wasm-audio-decoders/common/src/utilities.js +0 -3
  209. package/node_modules/@wasm-audio-decoders/common/types.d.ts +0 -7
  210. package/node_modules/mpg123-decoder/README.md +0 -265
  211. package/node_modules/mpg123-decoder/dist/mpg123-decoder.min.js +0 -185
  212. package/node_modules/mpg123-decoder/dist/mpg123-decoder.min.js.map +0 -1
  213. package/node_modules/mpg123-decoder/index.js +0 -8
  214. package/node_modules/mpg123-decoder/package.json +0 -58
  215. package/node_modules/mpg123-decoder/src/EmscriptenWasm.js +0 -464
  216. package/node_modules/mpg123-decoder/src/MPEGDecoder.js +0 -200
  217. package/node_modules/mpg123-decoder/src/MPEGDecoderWebWorker.js +0 -21
  218. package/node_modules/mpg123-decoder/types.d.ts +0 -30
  219. package/node_modules/silk-wasm/LICENSE +0 -21
  220. package/node_modules/silk-wasm/README.md +0 -85
  221. package/node_modules/silk-wasm/lib/index.cjs +0 -16
  222. package/node_modules/silk-wasm/lib/index.d.ts +0 -70
  223. package/node_modules/silk-wasm/lib/index.mjs +0 -16
  224. package/node_modules/silk-wasm/lib/silk.wasm +0 -0
  225. package/node_modules/silk-wasm/lib/utils.d.ts +0 -4
  226. package/node_modules/silk-wasm/package.json +0 -39
  227. package/node_modules/simple-yenc/.github/FUNDING.yml +0 -1
  228. package/node_modules/simple-yenc/.prettierignore +0 -1
  229. package/node_modules/simple-yenc/LICENSE +0 -7
  230. package/node_modules/simple-yenc/README.md +0 -163
  231. package/node_modules/simple-yenc/dist/esm.js +0 -1
  232. package/node_modules/simple-yenc/dist/index.js +0 -1
  233. package/node_modules/simple-yenc/package.json +0 -50
  234. package/node_modules/simple-yenc/rollup.config.js +0 -27
  235. package/node_modules/simple-yenc/src/simple-yenc.js +0 -302
  236. package/node_modules/ws/LICENSE +0 -20
  237. package/node_modules/ws/README.md +0 -548
  238. package/node_modules/ws/browser.js +0 -8
  239. package/node_modules/ws/index.js +0 -13
  240. package/node_modules/ws/lib/buffer-util.js +0 -131
  241. package/node_modules/ws/lib/constants.js +0 -19
  242. package/node_modules/ws/lib/event-target.js +0 -292
  243. package/node_modules/ws/lib/extension.js +0 -203
  244. package/node_modules/ws/lib/limiter.js +0 -55
  245. package/node_modules/ws/lib/permessage-deflate.js +0 -528
  246. package/node_modules/ws/lib/receiver.js +0 -706
  247. package/node_modules/ws/lib/sender.js +0 -602
  248. package/node_modules/ws/lib/stream.js +0 -161
  249. package/node_modules/ws/lib/subprotocol.js +0 -62
  250. package/node_modules/ws/lib/validation.js +0 -152
  251. package/node_modules/ws/lib/websocket-server.js +0 -554
  252. package/node_modules/ws/lib/websocket.js +0 -1393
  253. package/node_modules/ws/package.json +0 -69
  254. package/node_modules/ws/wrapper.mjs +0 -8
  255. package/scripts/postinstall-link-sdk.js +0 -170
  256. package/skills/qqbot-media/SKILL.md +0 -60
  257. package/src/admin-resolver.ts +0 -181
  258. package/src/api.ts +0 -1333
  259. package/src/credential-backup.ts +0 -72
  260. package/src/deliver-debounce.ts +0 -229
  261. package/src/gateway.ts +0 -2272
  262. package/src/group-history.ts +0 -328
  263. package/src/image-server.ts +0 -675
  264. package/src/inbound-attachments.ts +0 -321
  265. package/src/known-users.ts +0 -353
  266. package/src/message-gating.ts +0 -190
  267. package/src/message-queue.ts +0 -354
  268. package/src/onboarding.ts +0 -282
  269. package/src/outbound-deliver.ts +0 -486
  270. package/src/outbound.ts +0 -1179
  271. package/src/ref-index-store.ts +0 -412
  272. package/src/reply-dispatcher.ts +0 -334
  273. package/src/session-store.ts +0 -303
  274. package/src/slash-commands.ts +0 -2431
  275. package/src/startup-greeting.ts +0 -120
  276. package/src/streaming.ts +0 -1077
  277. package/src/stt.ts +0 -86
  278. package/src/tools/channel.ts +0 -275
  279. package/src/transport/index.ts +0 -11
  280. package/src/transport/webhook-transport.ts +0 -332
  281. package/src/transport/webhook-verify.ts +0 -119
  282. package/src/typing-keepalive.ts +0 -59
  283. package/src/utils/audio-convert.ts +0 -887
  284. package/src/utils/chunked-upload.ts +0 -483
  285. package/src/utils/file-utils.ts +0 -193
  286. package/src/utils/image-size.ts +0 -266
  287. package/src/utils/media-send.ts +0 -636
  288. package/src/utils/media-tags.ts +0 -183
  289. package/src/utils/payload.ts +0 -265
  290. package/src/utils/text-parsing.ts +0 -85
  291. package/src/utils/upload-cache.ts +0 -128
package/src/stt.ts DELETED
@@ -1,86 +0,0 @@
1
- /**
2
- * 通用 OpenAI 兼容 STT(语音转文字)
3
- *
4
- * 为什么在插件侧做 STT 而不走框架管道?
5
- * 框架的 applyMediaUnderstanding 同时执行 runCapability("audio") 和 extractFileBlocks。
6
- * 后者会把 WAV 文件的 PCM 二进制当文本注入 Body(looksLikeUtf8Text 误判),导致 context 爆炸。
7
- * 在插件侧完成 STT 后不把 WAV 放入 MediaPaths,即可规避此框架 bug。
8
- *
9
- * 配置解析策略(与 TTS 统一的两级回退):
10
- * 1. 优先 channels.qqbot.stt(插件专属配置)
11
- * 2. 回退 tools.media.audio.models[0](框架级配置)
12
- * 3. 再从 models.providers.[provider] 继承 apiKey/baseUrl
13
- * 4. 支持任何 OpenAI 兼容的 STT 服务
14
- */
15
-
16
- import * as fs from "node:fs";
17
- import path from "node:path";
18
- import { sanitizeFileName } from "./utils/platform.js";
19
-
20
- export interface STTConfig {
21
- baseUrl: string;
22
- apiKey: string;
23
- model: string;
24
- }
25
-
26
- export function resolveSTTConfig(cfg: Record<string, unknown>): STTConfig | null {
27
- const c = cfg as any;
28
-
29
- // 优先使用 channels.qqbot.stt(插件专属配置)
30
- const channelStt = c?.channels?.qqbot?.stt;
31
- if (channelStt && channelStt.enabled !== false) {
32
- const providerId: string = channelStt?.provider || "openai";
33
- const providerCfg = c?.models?.providers?.[providerId];
34
- const baseUrl: string | undefined = channelStt?.baseUrl || providerCfg?.baseUrl;
35
- const apiKey: string | undefined = channelStt?.apiKey || providerCfg?.apiKey;
36
- const model: string = channelStt?.model || "whisper-1";
37
- if (baseUrl && apiKey) {
38
- return { baseUrl: baseUrl.replace(/\/+$/, ""), apiKey, model };
39
- }
40
- }
41
-
42
- // 回退到 tools.media.audio.models[0](框架级配置)
43
- const audioModelEntry = c?.tools?.media?.audio?.models?.[0];
44
- if (audioModelEntry) {
45
- const providerId: string = audioModelEntry?.provider || "openai";
46
- const providerCfg = c?.models?.providers?.[providerId];
47
- const baseUrl: string | undefined = audioModelEntry?.baseUrl || providerCfg?.baseUrl;
48
- const apiKey: string | undefined = audioModelEntry?.apiKey || providerCfg?.apiKey;
49
- const model: string = audioModelEntry?.model || "whisper-1";
50
- if (baseUrl && apiKey) {
51
- return { baseUrl: baseUrl.replace(/\/+$/, ""), apiKey, model };
52
- }
53
- }
54
-
55
- return null;
56
- }
57
-
58
- export async function transcribeAudio(audioPath: string, cfg: Record<string, unknown>): Promise<string | null> {
59
- const sttCfg = resolveSTTConfig(cfg);
60
- if (!sttCfg) return null;
61
-
62
- const fileBuffer = fs.readFileSync(audioPath);
63
- const fileName = sanitizeFileName(path.basename(audioPath));
64
- const mime = fileName.endsWith(".wav") ? "audio/wav"
65
- : fileName.endsWith(".mp3") ? "audio/mpeg"
66
- : fileName.endsWith(".ogg") ? "audio/ogg"
67
- : "application/octet-stream";
68
-
69
- const form = new FormData();
70
- form.append("file", new Blob([fileBuffer], { type: mime }), fileName);
71
- form.append("model", sttCfg.model);
72
-
73
- const resp = await fetch(`${sttCfg.baseUrl}/audio/transcriptions`, {
74
- method: "POST",
75
- headers: { "Authorization": `Bearer ${sttCfg.apiKey}` },
76
- body: form,
77
- });
78
-
79
- if (!resp.ok) {
80
- const detail = await resp.text().catch(() => "");
81
- throw new Error(`STT failed (HTTP ${resp.status}): ${detail.slice(0, 300)}`);
82
- }
83
-
84
- const result = await resp.json() as { text?: string };
85
- return result.text?.trim() || null;
86
- }
@@ -1,275 +0,0 @@
1
- import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
2
- import { resolveQQBotAccount } from "../config.js";
3
- import { listQQBotAccountIds } from "../config.js";
4
- import { getAccessToken, API_BASE } from "../api.js";
5
-
6
- const DEFAULT_TIMEOUT_MS = 30000;
7
-
8
- // ========== 类型定义 ==========
9
-
10
- interface ChannelApiParams {
11
- method: string;
12
- path: string;
13
- body?: Record<string, unknown>;
14
- query?: Record<string, string>;
15
- }
16
-
17
- // ========== JSON Schema ==========
18
-
19
- const ChannelApiSchema = {
20
- type: "object",
21
- properties: {
22
- method: {
23
- type: "string",
24
- description:
25
- "HTTP 请求方法。可选值:GET, POST, PUT, PATCH, DELETE",
26
- enum: ["GET", "POST", "PUT", "PATCH", "DELETE"],
27
- },
28
- path: {
29
- type: "string",
30
- description:
31
- "API 路径(不含域名),占位符需替换为实际值。" +
32
- "示例:/users/@me/guilds, /guilds/{guild_id}/channels, /channels/{channel_id}",
33
- },
34
- body: {
35
- type: "object",
36
- description:
37
- "请求体(JSON),用于 POST/PUT/PATCH 请求。" +
38
- "GET/DELETE 请求不需要此参数。",
39
- },
40
- query: {
41
- type: "object",
42
- description:
43
- "URL 查询参数(键值对),会拼接到路径后面。" +
44
- "如 { \"limit\": \"100\", \"after\": \"0\" } 会拼接为 ?limit=100&after=0",
45
- additionalProperties: { type: "string" },
46
- },
47
- },
48
- required: ["method", "path"],
49
- } as const;
50
-
51
- // ========== 工具函数 ==========
52
-
53
- function json(data: unknown) {
54
- return {
55
- content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }],
56
- details: data,
57
- };
58
- }
59
-
60
- /**
61
- * 构建完整的请求 URL
62
- */
63
- function buildUrl(path: string, query?: Record<string, string>): string {
64
- let url = `${API_BASE}${path}`;
65
- if (query && Object.keys(query).length > 0) {
66
- const params = new URLSearchParams();
67
- for (const [key, value] of Object.entries(query)) {
68
- if (value !== undefined && value !== null && value !== "") {
69
- params.set(key, value);
70
- }
71
- }
72
- const qs = params.toString();
73
- if (qs) {
74
- url += `?${qs}`;
75
- }
76
- }
77
- return url;
78
- }
79
-
80
- /**
81
- * 校验 path 防止 SSRF
82
- */
83
- function validatePath(path: string): string | null {
84
- if (!path.startsWith("/")) {
85
- return "path 必须以 / 开头";
86
- }
87
- if (path.includes("..") || path.includes("//")) {
88
- return "path 不允许包含 .. 或 //";
89
- }
90
- // 只允许合法的 URL path 字符
91
- if (!/^\/[a-zA-Z0-9\-._~:@!$&'()*+,;=/%]+$/.test(path) && path !== "/") {
92
- return "path 包含非法字符";
93
- }
94
- return null;
95
- }
96
-
97
- // ========== 注册入口 ==========
98
-
99
- /**
100
- * 注册 QQ 频道 API 代理工具。
101
- *
102
- * 该工具作为 QQ 开放平台频道 API 的 HTTP 代理,自动处理 Token 鉴权。
103
- * AI 通过 skill 文档了解各接口的路径、方法和参数,构造请求后由此工具代理发送。
104
- *
105
- * 支持的能力:
106
- * - 频道管理(Guild)
107
- * - 子频道管理(Channel)
108
- * - 成员管理(Member)
109
- * - 公告管理(Announces)
110
- * - 论坛管理(Forum Thread)
111
- * - 日程管理(Schedule)
112
- */
113
- export function registerChannelTool(api: OpenClawPluginApi): void {
114
- const cfg = api.config;
115
- if (!cfg) {
116
- console.log("[qqbot-channel-api] No config available, skipping");
117
- return;
118
- }
119
-
120
- const accountIds = listQQBotAccountIds(cfg);
121
- if (accountIds.length === 0) {
122
- console.log("[qqbot-channel-api] No QQBot accounts configured, skipping");
123
- return;
124
- }
125
-
126
- const firstAccountId = accountIds[0];
127
- const account = resolveQQBotAccount(cfg, firstAccountId);
128
-
129
- if (!account.appId || !account.clientSecret) {
130
- console.log("[qqbot-channel-api] Account not fully configured, skipping");
131
- return;
132
- }
133
-
134
- api.registerTool(
135
- {
136
- name: "qqbot_channel_api",
137
- label: "QQBot Channel API",
138
- description:
139
- "QQ 开放平台频道 API HTTP 代理,自动填充鉴权 Token。" +
140
- "常用接口速查:" +
141
- "频道列表 GET /users/@me/guilds | " +
142
- "子频道列表 GET /guilds/{guild_id}/channels | " +
143
- "子频道详情 GET /channels/{channel_id} | " +
144
- "创建子频道 POST /guilds/{guild_id}/channels | " +
145
- "成员列表 GET /guilds/{guild_id}/members?after=0&limit=100 | " +
146
- "成员详情 GET /guilds/{guild_id}/members/{user_id} | " +
147
- "帖子列表 GET /channels/{channel_id}/threads | " +
148
- "发帖 PUT /channels/{channel_id}/threads | " +
149
- "创建公告 POST /guilds/{guild_id}/announces | " +
150
- "创建日程 POST /channels/{channel_id}/schedules。" +
151
- "更多接口和参数详情请阅读 qqbot-channel skill。",
152
- parameters: ChannelApiSchema,
153
- async execute(_toolCallId, params) {
154
- const p = params as ChannelApiParams;
155
-
156
- // 参数校验
157
- if (!p.method) {
158
- return json({ error: "method 为必填参数" });
159
- }
160
- if (!p.path) {
161
- return json({ error: "path 为必填参数" });
162
- }
163
-
164
- const method = p.method.toUpperCase();
165
- if (!["GET", "POST", "PUT", "PATCH", "DELETE"].includes(method)) {
166
- return json({ error: `不支持的 HTTP 方法: ${method},可选值:GET, POST, PUT, PATCH, DELETE` });
167
- }
168
-
169
- // 路径安全校验
170
- const pathError = validatePath(p.path);
171
- if (pathError) {
172
- return json({ error: pathError });
173
- }
174
-
175
- // GET/DELETE 不应有 body
176
- if ((method === "GET" || method === "DELETE") && p.body && Object.keys(p.body).length > 0) {
177
- console.log(`[qqbot-channel-api] ${method} request with body, body will be ignored`);
178
- }
179
-
180
- try {
181
- // 获取鉴权 Token
182
- const accessToken = await getAccessToken(account.appId, account.clientSecret);
183
-
184
- // 构建请求
185
- const url = buildUrl(p.path, p.query);
186
- const headers: Record<string, string> = {
187
- Authorization: `QQBot ${accessToken}`,
188
- "Content-Type": "application/json",
189
- };
190
-
191
- const controller = new AbortController();
192
- const timeoutId = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT_MS);
193
-
194
- const fetchOptions: RequestInit = {
195
- method,
196
- headers,
197
- signal: controller.signal,
198
- };
199
-
200
- // POST/PUT/PATCH 才发送 body
201
- if (p.body && ["POST", "PUT", "PATCH"].includes(method)) {
202
- fetchOptions.body = JSON.stringify(p.body);
203
- }
204
-
205
- console.log(`[qqbot-channel-api] >>> ${method} ${url} (timeout: ${DEFAULT_TIMEOUT_MS}ms)`);
206
-
207
- let res: Response;
208
- try {
209
- res = await fetch(url, fetchOptions);
210
- } catch (err) {
211
- clearTimeout(timeoutId);
212
- if (err instanceof Error && err.name === "AbortError") {
213
- console.error(`[qqbot-channel-api] <<< Request timeout after ${DEFAULT_TIMEOUT_MS}ms`);
214
- return json({ error: `请求超时(${DEFAULT_TIMEOUT_MS}ms)`, path: p.path });
215
- }
216
- console.error(`[qqbot-channel-api] <<< Network error:`, err);
217
- return json({
218
- error: `网络错误: ${err instanceof Error ? err.message : String(err)}`,
219
- path: p.path,
220
- });
221
- } finally {
222
- clearTimeout(timeoutId);
223
- }
224
-
225
- console.log(`[qqbot-channel-api] <<< Status: ${res.status} ${res.statusText}`);
226
-
227
- // 解析响应
228
- const rawBody = await res.text();
229
-
230
- // 空响应(如 DELETE 204)
231
- if (!rawBody || rawBody.trim() === "") {
232
- if (res.ok) {
233
- return json({ success: true, status: res.status, path: p.path });
234
- }
235
- return json({
236
- error: `API 返回 ${res.status} ${res.statusText}`,
237
- status: res.status,
238
- path: p.path,
239
- });
240
- }
241
-
242
- let data: unknown;
243
- try {
244
- data = JSON.parse(rawBody);
245
- } catch {
246
- return json({
247
- error: "响应解析失败",
248
- status: res.status,
249
- raw: rawBody.slice(0, 500),
250
- path: p.path,
251
- });
252
- }
253
-
254
- if (!res.ok) {
255
- const errData = data as { message?: string; code?: number };
256
- return json({
257
- error: errData.message ?? `API 错误 (HTTP ${res.status})`,
258
- code: errData.code,
259
- status: res.status,
260
- path: p.path,
261
- detail: data,
262
- });
263
- }
264
-
265
- return json(data);
266
- } catch (err) {
267
- const errMsg = err instanceof Error ? err.message : String(err);
268
- console.error(`[qqbot-channel-api] Error [${method} ${p.path}]: ${errMsg}`);
269
- return json({ error: errMsg, path: p.path });
270
- }
271
- },
272
- },
273
- { name: "qqbot_channel_api" },
274
- );
275
- }
@@ -1,11 +0,0 @@
1
- /**
2
- * Transport module — QQ Bot event receiving mechanisms.
3
- *
4
- * Supports two transport modes:
5
- * - **WebSocket** (default): long-lived WS connection with heartbeat, RESUME, etc.
6
- * - **Webhook** (HTTP callback): QQ platform POSTs events to registered path.
7
- */
8
-
9
- export type { WebhookInboundEvent, WebhookTransportOptions, QQBotWebhookTarget } from "./webhook-transport.js";
10
- export { startWebhookTransport, resolveWebhookPath } from "./webhook-transport.js";
11
- export { verifyWebhookSignature, signValidationResponse, ed25519Sign } from "./webhook-verify.js";
@@ -1,332 +0,0 @@
1
- /**
2
- * Webhook Transport — receive QQ Bot events via HTTP POST callbacks.
3
- *
4
- * Uses OpenClaw plugin-sdk's `registerWebhookTargetWithPluginRoute` (模式 C)
5
- * to register webhook HTTP routes through the framework's gateway HTTP server,
6
- * sharing the same port and benefiting from built-in rate limiting & in-flight guards.
7
- *
8
- * Architecture:
9
- * 1. On gateway startAccount, register a webhook target via plugin-sdk
10
- * 2. Framework routes POST requests to our handler
11
- * 3. Handler verifies Ed25519 signatures and dispatches events
12
- * 4. Returns op:12 ACK immediately, processes events asynchronously
13
- * 5. On account stop (abortSignal), unregister the target
14
- *
15
- * Configuration (openclaw.yaml):
16
- * ```yaml
17
- * channels:
18
- * qqbot:
19
- * appId: "xxx"
20
- * clientSecret: "xxx"
21
- * transport: webhook
22
- * webhook:
23
- * path: /qqbot/webhook
24
- * ```
25
- */
26
-
27
- import type { IncomingMessage, ServerResponse } from "node:http";
28
- import {
29
- registerWebhookTargetWithPluginRoute,
30
- withResolvedWebhookRequestPipeline,
31
- resolveWebhookTargetWithAuthOrRejectSync,
32
- createWebhookInFlightLimiter,
33
- createFixedWindowRateLimiter,
34
- readWebhookBodyOrReject,
35
- type WebhookInFlightLimiter,
36
- type FixedWindowRateLimiter,
37
- } from "openclaw/plugin-sdk/webhook-ingress";
38
-
39
- import type { ResolvedQQBotAccount } from "../types.js";
40
- import { verifyWebhookSignature, signValidationResponse } from "./webhook-verify.js";
41
-
42
- // ============ Constants ============
43
-
44
- const OP_DISPATCH = 0;
45
- const OP_HTTP_CALLBACK_ACK = 12;
46
- const OP_VALIDATION = 13;
47
-
48
- const PLUGIN_ID = "openclaw-qqbot";
49
- const DEFAULT_WEBHOOK_PATH = "/qqbot/webhook";
50
-
51
- // ============ Types ============
52
-
53
- /** Webhook target registered per account */
54
- export interface QQBotWebhookTarget {
55
- path: string;
56
- accountId: string;
57
- appId: string;
58
- clientSecret: string;
59
- }
60
-
61
- /** Webhook event dispatched to the consumer */
62
- export interface WebhookInboundEvent {
63
- eventType: string;
64
- data: unknown;
65
- seq?: number;
66
- }
67
-
68
- /** Options for starting webhook transport */
69
- export interface WebhookTransportOptions {
70
- account: ResolvedQQBotAccount;
71
- abortSignal: AbortSignal;
72
- onEvent: (event: WebhookInboundEvent) => void | Promise<void>;
73
- onReady?: () => void;
74
- onError?: (error: Error) => void;
75
- log?: {
76
- info: (msg: string) => void;
77
- warn?: (msg: string) => void;
78
- error: (msg: string) => void;
79
- debug?: (msg: string) => void;
80
- };
81
- }
82
-
83
- // ============ Module state ============
84
-
85
- /** Per-path target registry (shared across all accounts) */
86
- const webhookTargets = new Map<string, QQBotWebhookTarget[]>();
87
-
88
- /** Per-account event handler map */
89
- const eventHandlers = new Map<string, (event: WebhookInboundEvent) => void | Promise<void>>();
90
-
91
- /** Module-level logger (set by the last startWebhookTransport call) */
92
- let log: WebhookTransportOptions["log"] | undefined;
93
-
94
- /** Shared rate limiter (fixed window, per source IP) */
95
- let rateLimiter: FixedWindowRateLimiter | null = null;
96
-
97
- /** Shared in-flight limiter */
98
- let inFlightLimiter: WebhookInFlightLimiter | null = null;
99
-
100
- function ensureGuards(): { rateLimiter: FixedWindowRateLimiter; inFlightLimiter: WebhookInFlightLimiter } {
101
- if (!rateLimiter) {
102
- rateLimiter = createFixedWindowRateLimiter({
103
- windowMs: 60_000,
104
- maxRequests: 600,
105
- maxTrackedKeys: 4096,
106
- });
107
- }
108
- if (!inFlightLimiter) {
109
- inFlightLimiter = createWebhookInFlightLimiter({
110
- maxInFlightPerKey: 8,
111
- maxTrackedKeys: 4096,
112
- });
113
- }
114
- return { rateLimiter, inFlightLimiter };
115
- }
116
-
117
- // ============ Main handler ============
118
-
119
- /**
120
- * Shared HTTP handler for all QQBot webhook routes.
121
- * Registered once per unique path, dispatches to the correct account target.
122
- */
123
- async function handleQQBotWebhookRequest(req: IncomingMessage, res: ServerResponse): Promise<boolean | void> {
124
- const guards = ensureGuards();
125
-
126
- const handled = await withResolvedWebhookRequestPipeline({
127
- req,
128
- res,
129
- targetsByPath: webhookTargets,
130
- rateLimiter: guards.rateLimiter,
131
- inFlightLimiter: guards.inFlightLimiter,
132
- requireJsonContentType: true,
133
- handle: async ({ targets }) => {
134
- // Read raw body (up to 1MB, 30s timeout)
135
- const bodyResult = await readWebhookBodyOrReject({
136
- req,
137
- res,
138
- maxBytes: 1024 * 1024,
139
- timeoutMs: 30_000,
140
- });
141
- if (!bodyResult.ok) return;
142
-
143
- const rawBodyStr = bodyResult.value;
144
- const rawBody = Buffer.from(rawBodyStr, "utf-8");
145
- let payload: { op: number; d?: unknown; t?: string; s?: number };
146
- try {
147
- payload = JSON.parse(rawBodyStr);
148
- } catch (err) {
149
- log?.error(`[qqbot:webhook] Failed to parse request body as JSON: ${err instanceof Error ? err.message : String(err)}, body preview: ${rawBodyStr.slice(0, 200)}`);
150
- res.statusCode = 400;
151
- res.end(JSON.stringify({ error: "invalid json" }));
152
- return;
153
- }
154
-
155
- // ── op:13 — Callback URL validation (before signature check) ──
156
- if (payload.op === OP_VALIDATION) {
157
- handleValidation(payload, targets, res);
158
- return;
159
- }
160
-
161
- // ── Signature verification → resolve target ──
162
- const timestamp = getHeader(req, "x-signature-timestamp") ?? "";
163
- const signature = getHeader(req, "x-signature-ed25519") ?? "";
164
-
165
- if (!timestamp || !signature) {
166
- log?.warn?.(`[qqbot:webhook] Missing signature headers — timestamp: "${timestamp}", signature: "${signature}", url: ${req.url}`);
167
- res.statusCode = 401;
168
- res.end(JSON.stringify({ error: "missing signature headers" }));
169
- return;
170
- }
171
-
172
- const matchedTarget = resolveWebhookTargetWithAuthOrRejectSync({
173
- targets,
174
- res,
175
- isMatch: (target) =>
176
- verifyWebhookSignature({
177
- body: rawBody,
178
- timestamp,
179
- signature,
180
- botSecret: target.clientSecret,
181
- }),
182
- unauthorizedStatusCode: 401,
183
- unauthorizedMessage: JSON.stringify({ error: "invalid signature" }),
184
- });
185
-
186
- if (!matchedTarget) {
187
- log?.warn?.(`[qqbot:webhook] Signature verification failed for path: ${req.url}, timestamp: ${timestamp}`);
188
- return; // response already sent by resolver
189
- }
190
-
191
- // ── ACK immediately ──
192
- res.statusCode = 200;
193
- res.setHeader("Content-Type", "application/json");
194
- res.end(JSON.stringify({ op: OP_HTTP_CALLBACK_ACK, d: 0 }));
195
-
196
- // ── Async dispatch (fire-and-forget) ──
197
- if (payload.op === OP_DISPATCH) {
198
- const handler = eventHandlers.get(matchedTarget.accountId);
199
- if (handler) {
200
- Promise.resolve(
201
- handler({
202
- eventType: payload.t ?? "",
203
- data: payload.d,
204
- seq: payload.s,
205
- }),
206
- ).catch((err) => {
207
- log?.error(`[qqbot:${matchedTarget.accountId}] Event handler error for "${payload.t}": ${err instanceof Error ? err.message : String(err)}`);
208
- });
209
- } else {
210
- log?.warn?.(`[qqbot:webhook] No event handler registered for account: ${matchedTarget.accountId}, event: ${payload.t}`);
211
- }
212
- }
213
- },
214
- });
215
-
216
- return handled;
217
- }
218
-
219
- // ============ Validation handler (op:13) ============
220
-
221
- function handleValidation(
222
- payload: { d?: unknown },
223
- targets: QQBotWebhookTarget[],
224
- res: ServerResponse,
225
- ): void {
226
- const d = payload.d as { plain_token?: string; event_ts?: string } | undefined;
227
-
228
- if (!d?.plain_token || !d?.event_ts) {
229
- log?.warn?.(`[qqbot:webhook] Invalid validation payload (op:13): missing plain_token or event_ts, got: ${JSON.stringify(d)}`);
230
- res.statusCode = 400;
231
- res.end(JSON.stringify({ error: "invalid validation payload" }));
232
- return;
233
- }
234
-
235
- // Use the first target's secret for validation
236
- // (op:13 is sent during URL registration, only one bot should be using the path at that time)
237
- const target = targets[0];
238
- if (!target) {
239
- log?.error(`[qqbot:webhook] No target registered for validation (op:13), cannot sign response`);
240
- res.statusCode = 500;
241
- res.end(JSON.stringify({ error: "no target registered" }));
242
- return;
243
- }
244
-
245
- const response = signValidationResponse({
246
- plainToken: d.plain_token,
247
- eventTs: d.event_ts,
248
- botSecret: target.clientSecret,
249
- });
250
-
251
- res.statusCode = 200;
252
- res.setHeader("Content-Type", "application/json");
253
- res.end(JSON.stringify(response));
254
- }
255
-
256
- // ============ Public API ============
257
-
258
- /**
259
- * Start the webhook transport for a given account.
260
- *
261
- * Registers a webhook target on the framework's plugin HTTP route system.
262
- * The handler verifies Ed25519 signatures, ACKs immediately, and dispatches
263
- * events asynchronously via the provided `onEvent` callback.
264
- *
265
- * Returns when the abortSignal is triggered (account stopped).
266
- */
267
- export async function startWebhookTransport(opts: WebhookTransportOptions): Promise<void> {
268
- const { account, abortSignal, onEvent, onReady, onError, log: optLog } = opts;
269
- log = optLog;
270
- const webhookPath = account.config.webhook?.path ?? DEFAULT_WEBHOOK_PATH;
271
-
272
- log?.info(`[qqbot:${account.accountId}] Starting webhook transport on path: ${webhookPath}`);
273
-
274
- // Register event handler for this account
275
- eventHandlers.set(account.accountId, onEvent);
276
-
277
- // Register webhook target + plugin HTTP route
278
- const { unregister } = registerWebhookTargetWithPluginRoute({
279
- targetsByPath: webhookTargets,
280
- target: {
281
- path: webhookPath,
282
- accountId: account.accountId,
283
- appId: account.appId,
284
- clientSecret: account.clientSecret,
285
- },
286
- route: {
287
- auth: "plugin",
288
- match: "exact" as const,
289
- pluginId: PLUGIN_ID,
290
- source: "qqbot-webhook",
291
- accountId: account.accountId,
292
- replaceExisting: true,
293
- log: (msg: string) => log?.info(msg),
294
- handler: handleQQBotWebhookRequest,
295
- },
296
- onLastPathTargetRemoved: () => {
297
- log?.info(`[qqbot] Last webhook target removed from path: ${webhookPath}`);
298
- },
299
- });
300
-
301
- log?.info(`[qqbot:${account.accountId}] Webhook transport registered on path: ${webhookPath}`);
302
- onReady?.();
303
-
304
- // Wait until abort signal fires
305
- await new Promise<void>((resolve) => {
306
- if (abortSignal.aborted) {
307
- resolve();
308
- return;
309
- }
310
- abortSignal.addEventListener("abort", () => resolve(), { once: true });
311
- });
312
-
313
- // Cleanup
314
- unregister();
315
- eventHandlers.delete(account.accountId);
316
- log?.info(`[qqbot:${account.accountId}] Webhook transport stopped`);
317
- }
318
-
319
- /**
320
- * Resolve the webhook path for a given account (for external configuration / setWebhook calls).
321
- */
322
- export function resolveWebhookPath(account: ResolvedQQBotAccount): string {
323
- return account.config.webhook?.path ?? DEFAULT_WEBHOOK_PATH;
324
- }
325
-
326
- // ============ Helpers ============
327
-
328
- function getHeader(req: IncomingMessage, key: string): string | undefined {
329
- const val = req.headers[key];
330
- if (Array.isArray(val)) return val[0];
331
- return val;
332
- }