@karinjs/adapter-qqbot 1.2.10 → 2.0.0

package/dist/onboard-BX8g8Wik.js

@@ -0,0 +1,249 @@
+import { d as sleep, f as log, i as getDefaultConfig, n as config, o as writeConfig } from "./config-H7LrvlNU.js";
+import qrcode from "qrcode";
+import axios from "node-karin/axios";
+import crypto from "node:crypto";
+
+//#region src/core/onboard/crypto.ts
+/**
+* 生成 256-bit 随机 AES 密钥（base64）
+*/
+const generateBindKey = () => crypto.randomBytes(32).toString("base64");
+/**
+* 解密 bot_encrypt_secret（AES-256-GCM）
+*
+* 密文布局：IV (12 bytes) || ciphertext (N bytes) || AuthTag (16 bytes)
+*/
+const decryptSecret = (encryptedBase64, keyBase64) => {
+	const key = Buffer.from(keyBase64, "base64");
+	if (key.length !== 32) throw new Error(`AES key length must be 32 bytes, got ${key.length}`);
+	const raw = Buffer.from(encryptedBase64, "base64");
+	const iv = raw.subarray(0, 12);
+	const ciphertext = raw.subarray(12, raw.length - 16);
+	const authTag = raw.subarray(raw.length - 16);
+	const decipher = crypto.createDecipheriv("aes-256-gcm", key, iv);
+	decipher.setAuthTag(authTag);
+	let plaintext = decipher.update(ciphertext, void 0, "utf8");
+	plaintext += decipher.final("utf8");
+	return plaintext;
+};
+
+//#endregion
+//#region src/core/onboard/portal.ts
+/** QQ 开放平台扫码绑定服务域名 */
+const PORTAL_HOST = "q.qq.com";
+const CREATE_PATH = "/lite/create_bind_task";
+const POLL_PATH = "/lite/poll_bind_result";
+/** 扫码页面模板 */
+const CONNECT_URL = "https://q.qq.com/qqbot/openclaw/connect.html?task_id={task_id}&_wv=2&source=karin";
+const headers = {
+	"Content-Type": "application/json",
+	Accept: "application/json"
+};
+/** 绑定状态 */
+const BindStatus = {
+	NONE: 0,
+	PENDING: 1,
+	COMPLETED: 2,
+	EXPIRED: 3
+};
+/**
+* 创建绑定任务
+* @returns task_id 与本地生成的 AES key
+*/
+const createBindTask = async () => {
+	const key = generateBindKey();
+	const { data } = await axios.post(`https://${PORTAL_HOST}${CREATE_PATH}`, { key }, { headers });
+	if (data.retcode !== 0) throw new Error(`create_bind_task: ${data.msg || "unknown error"}`);
+	const taskId = data.data?.task_id;
+	if (!taskId) throw new Error("create_bind_task: missing task_id");
+	return {
+		taskId,
+		aesKey: key
+	};
+};
+/**
+* 轮询绑定结果
+*/
+const pollBindResult = async (taskId) => {
+	const { data } = await axios.post(`https://${PORTAL_HOST}${POLL_PATH}`, { task_id: taskId }, { headers });
+	if (data.retcode !== 0) throw new Error(`poll_bind_result: ${data.msg || "unknown error"}`);
+	const d = data.data ?? {};
+	return {
+		status: d.status ?? BindStatus.NONE,
+		appId: String(d.bot_appid ?? ""),
+		encryptedSecret: d.bot_encrypt_secret ?? "",
+		userOpenid: d.user_openid ?? ""
+	};
+};
+/**
+* 构造扫码 URL
+*/
+const buildConnectUrl = (taskId) => CONNECT_URL.replace("{task_id}", encodeURIComponent(taskId));
+/**
+* 通过 appId + secret 直接调一次 @me，拿到 bot 昵称
+* 用于扫码完成后的展示与写入配置
+*/
+const fetchBotName = async (appId, secret) => {
+	try {
+		const accessToken = (await axios.post("https://bots.qq.com/app/getAppAccessToken", {
+			appId,
+			clientSecret: secret
+		})).data?.access_token;
+		if (!accessToken) return "";
+		return (await axios.get("https://api.sgroup.qq.com/users/@me", { headers: { Authorization: `QQBot ${accessToken}` } })).data?.username || "";
+	} catch {
+		return "";
+	}
+};
+
+//#endregion
+//#region src/core/onboard/qr.ts
+/** 默认轮询间隔（毫秒） */
+const POLL_INTERVAL = 2e3;
+/** 默认总超时（秒） */
+const DEFAULT_TIMEOUT_S = 600;
+/** 单张二维码硬编码有效期：60s，到时主动判定过期触发刷新 */
+const QR_TTL_MS = 6e4;
+/** 二维码过期最大刷新次数 */
+const MAX_REFRESHES = 3;
+/**
+* 生成二维码（同时拿到 ascii / base64）
+*/
+const renderQr = async (url) => {
+	return {
+		ascii: await qrcode.toString(url, {
+			type: "terminal",
+			small: true
+		}).catch(() => ""),
+		base64: `base64://${(await qrcode.toDataURL(url, {
+			width: 320,
+			margin: 2
+		})).split(",")[1]}`
+	};
+};
+/**
+* 扫码登录主流程：
+* 1. 创建绑定任务，调用 onQr 暴露二维码
+* 2. 轮询直到 COMPLETED / 二维码过期刷新 / 超时
+* 3. 解密返回 secret
+*/
+const qrRegister = async (opts = {}) => {
+	const { timeoutSeconds = DEFAULT_TIMEOUT_S, onQr } = opts;
+	const deadline = Date.now() + timeoutSeconds * 1e3;
+	for (let refresh = 0; refresh <= MAX_REFRESHES; refresh++) {
+		let task;
+		try {
+			task = await createBindTask();
+		} catch (err) {
+			log("error", "[扫码登录] 创建绑定任务失败:", err);
+			return null;
+		}
+		const url = buildConnectUrl(task.taskId);
+		const { ascii, base64 } = await renderQr(url);
+		const qrDeadline = Date.now() + QR_TTL_MS;
+		if (ascii) {
+			console.log();
+			console.log(ascii);
+		}
+		console.log(`  请使用 QQ 扫码（60s 内有效），或在手机 QQ 打开：\n  ${url}\n`);
+		if (onQr) try {
+			await onQr({
+				url,
+				ascii,
+				base64,
+				refresh
+			});
+		} catch (err) {
+			log("warn", "[扫码登录] onQr 回调异常:", err);
+		}
+		let expired = false;
+		while (Date.now() < deadline) {
+			if (Date.now() >= qrDeadline) {
+				expired = true;
+				break;
+			}
+			let result;
+			try {
+				result = await pollBindResult(task.taskId);
+			} catch {
+				await sleep(POLL_INTERVAL);
+				continue;
+			}
+			if (result.status === BindStatus.COMPLETED) {
+				if (!result.encryptedSecret) {
+					log("error", "[扫码登录] 绑定结果缺少加密密钥");
+					return null;
+				}
+				let secret;
+				try {
+					secret = decryptSecret(result.encryptedSecret, task.aesKey);
+				} catch (err) {
+					log("error", "[扫码登录] 解密 secret 失败:", err);
+					return null;
+				}
+				log("info", `[扫码登录] 授权成功，App ID: ${result.appId}`);
+				return {
+					appId: result.appId,
+					secret,
+					userOpenid: result.userOpenid
+				};
+			}
+			if (result.status === BindStatus.EXPIRED) {
+				expired = true;
+				break;
+			}
+			await sleep(POLL_INTERVAL);
+		}
+		if (expired) {
+			if (refresh >= MAX_REFRESHES) {
+				log("error", `[扫码登录] 二维码已过期 ${MAX_REFRESHES + 1} 次，终止流程`);
+				return null;
+			}
+			log("info", `[扫码登录] 二维码 60s 内未完成扫码，正在刷新 (${refresh + 1}/${MAX_REFRESHES})`);
+			continue;
+		}
+		log("error", `[扫码登录] 等待扫码总超时（${timeoutSeconds}s）`);
+		return null;
+	}
+	return null;
+};
+
+//#endregion
+//#region src/core/onboard/index.ts
+/** 是否需要触发扫码引导：完全没有 bot 配置时为 true */
+const needQrOnboard = () => config().length === 0;
+/**
+* 执行扫码登录并把结果写入 config.json
+*
+* - 同 appId 已存在 → 覆盖 secret / name
+* - 不存在 → 追加新配置
+*
+* 支持 `opts.onQr` 把新二维码透出给调用方（如 #QQ登录 指令把图片回给用户）
+*/
+const runQrOnboard = async (opts = {}) => {
+	const result = await qrRegister(opts);
+	if (!result) return false;
+	const name = await fetchBotName(result.appId, result.secret);
+	if (name) log("info", `[扫码登录] Bot 名称: ${name}`);
+	const list = config();
+	const idx = list.findIndex((item) => item.appId === result.appId);
+	if (idx >= 0) {
+		list[idx].secret = result.secret;
+		if (name) list[idx].name = name;
+		log("info", `[扫码登录] 已更新已有配置: ${result.appId}`);
+	} else {
+		const defaults = getDefaultConfig()[0];
+		list.push({
+			...defaults,
+			name: name || "",
+			appId: result.appId,
+			secret: result.secret
+		});
+		log("info", `[扫码登录] 已添加新配置: ${result.appId}`);
+	}
+	writeConfig(list);
+	return true;
+};
+
+//#endregion
+export { runQrOnboard as n, needQrOnboard as t };

package/dist/utils-DO4gEkVN.js

@@ -0,0 +1,3 @@
+import "./config-H7LrvlNU.js";
+
+export {  };

package/dist/web.config.d.ts

@@ -0,0 +1,22 @@
+import * as _$node_karin0 from "node-karin";
+
+//#region src/web.config.d.ts
+declare const _default: _$node_karin0.DefineConfig<{
+  qqbot: Array<{
+    name: string;
+    appId: string;
+    secret: string;
+    prodApi: string;
+    sandboxApi: string;
+    tokenApi: string;
+    sandbox: boolean;
+    qqEnable: boolean;
+    guildEnable: boolean;
+    guildMode: boolean;
+    regex: string[];
+    "keyboard:enable": boolean;
+    "event:type": string;
+  }>;
+}>;
+//#endregion
+export { _default as default };

package/dist/web.config.js

@@ -0,0 +1,173 @@
+import { a as pkg, n as config, o as writeConfig } from "./config-H7LrvlNU.js";
+import "./utils-DO4gEkVN.js";
+import { components, defineConfig } from "node-karin";
+
+//#region src/web.config.ts
+var web_config_default = defineConfig({
+	info: {
+		id: pkg().name,
+		name: "QQBot 适配器",
+		version: pkg().version,
+		description: "为 karin 提供 QQ 官方 Bot 连接能力（2.0）",
+		author: [{
+			name: "shijin",
+			avatar: "https://github.com/sj817.png"
+		}]
+	},
+	components: () => {
+		const data = [];
+		config().forEach((item) => {
+			data.push({
+				title: item.name || item.appId,
+				subtitle: item.appId,
+				name: item.name,
+				appId: item.appId,
+				secret: item.secret,
+				prodApi: item.prodApi,
+				sandboxApi: item.sandboxApi,
+				tokenApi: item.tokenApi,
+				sandbox: item.sandbox,
+				qqEnable: item.qqEnable,
+				guildEnable: item.guildEnable,
+				guildMode: item.guildMode === 1,
+				regex: item.regex.map((r) => `${r.reg} ${r.rep}`),
+				"keyboard:enable": item.keyboard?.enable !== false,
+				"event:type": String(item.event?.type ?? 2)
+			});
+		});
+		return [components.accordionPro.create("qqbot", data, {
+			label: "QQBot",
+			description: "QQBot 配置",
+			children: {
+				key: "qqbotConfig",
+				children: [
+					components.input.create("name", {
+						label: "机器人名称",
+						description: "机器人名称，扫码登录会自动获取"
+					}),
+					components.input.create("appId", {
+						label: "AppID",
+						description: "机器人 AppID",
+						isRequired: true
+					}),
+					components.input.create("secret", {
+						label: "Secret",
+						description: "机器人 Secret",
+						isRequired: true
+					}),
+					components.input.create("prodApi", {
+						label: "正式环境 API",
+						defaultValue: "https://api.sgroup.qq.com",
+						isRequired: true
+					}),
+					components.input.create("sandboxApi", {
+						label: "沙盒环境 API",
+						defaultValue: "https://sandbox.api.sgroup.qq.com",
+						isRequired: true
+					}),
+					components.input.create("tokenApi", {
+						label: "AccessToken 接口",
+						defaultValue: "https://bots.qq.com/app/getAppAccessToken",
+						isRequired: true
+					}),
+					components.switch.create("sandbox", {
+						label: "沙盒环境",
+						description: "启用后调用沙盒 API",
+						defaultSelected: false
+					}),
+					components.switch.create("qqEnable", {
+						label: "QQ 场景",
+						description: "是否处理私聊和群聊消息",
+						defaultSelected: true
+					}),
+					components.switch.create("guildEnable", {
+						label: "频道场景",
+						description: "是否处理频道消息",
+						defaultSelected: true
+					}),
+					components.switch.create("guildMode", {
+						label: "频道私域模式",
+						description: "开启 = 私域机器人；关闭 = 公域机器人",
+						defaultSelected: false
+					}),
+					components.input.group("regex", {
+						data: [],
+						label: "消息正则替换",
+						description: "每行格式：正则表达式 替换内容。如：^/ #",
+						template: components.input.create("regex", {
+							label: "正则规则",
+							placeholder: "^/ #"
+						})
+					}),
+					components.switch.create("keyboard:enable", {
+						label: "URL 自动按钮",
+						description: "将文本中的链接自动转为 keyboard 按钮",
+						defaultSelected: true
+					}),
+					components.radio.group("event:type", {
+						label: "事件接收方式",
+						description: "选择 QQ 官方推送事件的方式",
+						defaultValue: "2",
+						radio: [
+							components.radio.create("0", {
+								label: "关闭",
+								value: "0",
+								description: "不接收任何事件"
+							}),
+							components.radio.create("1", {
+								label: "Webhook",
+								value: "1",
+								description: "QQ 官方主动推送事件到本机"
+							}),
+							components.radio.create("2", {
+								label: "WebSocket",
+								value: "2",
+								description: "主动连接 QQ 官方 WebSocket 网关接收事件（推荐）"
+							})
+						]
+					})
+				]
+			}
+		})];
+	},
+	save: (input) => {
+		if (!Array.isArray(input.qqbot)) return {
+			success: false,
+			message: "保存失败：配置格式错误"
+		};
+		const data = input.qqbot.map((item) => {
+			const guildMode = item.guildMode === true ? 1 : 0;
+			const eventType = Number(item["event:type"] ?? 0);
+			const regex = (item.regex || []).map((str) => {
+				const parts = str.split(" ");
+				return {
+					reg: parts[0]?.replace(/^<|>$/g, "") || "",
+					rep: parts[1]?.replace(/^<|>$/g, "") || ""
+				};
+			});
+			return {
+				name: item.name || "",
+				appId: item.appId || "",
+				secret: item.secret || "",
+				prodApi: item.prodApi || "https://api.sgroup.qq.com",
+				sandboxApi: item.sandboxApi || "https://sandbox.api.sgroup.qq.com",
+				tokenApi: item.tokenApi || "https://bots.qq.com/app/getAppAccessToken",
+				sandbox: !!item.sandbox,
+				qqEnable: !!item.qqEnable,
+				guildEnable: !!item.guildEnable,
+				guildMode,
+				regex,
+				keyboard: { enable: item["keyboard:enable"] !== false },
+				event: { type: eventType }
+			};
+		});
+		writeConfig(data);
+		return {
+			success: true,
+			message: "保存成功"
+		};
+	}
+});
+
+//#endregion
+export { web_config_default as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@karinjs/adapter-qqbot",
-  "version": "1.2.10",
-  "description": "karin plugin adapter for qqbot",
+  "version": "2.0.0",
+  "description": "karin adapter for QQ Official Bot (2.0)",
   "homepage": "https://github.com/KarinJS/karin-plugin-adapter-qqbot",
   "bugs": {
     "url": "https://github.com/KarinJS/karin-plugin-adapter-qqbot/issues"
@@ -12,41 +12,52 @@
   },
   "author": "shijin",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "/lib/**/*.js",
-    "/lib/**/*.d.ts",
-    "config",
-    "resources",
-    "LICENSE",
-    "package.json",
-    "README.md"
+    "dist"
   ],
   "scripts": {
-    "build": "tsc && tsup",
-    "pr": "node lib/cli/pr.js",
+    "build": "tsc && tsdown",
+    "dev": "tsx watch --include \"src/**/*.ts\" src/app.ts",
+    "karin": "karin",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
     "pub": "npm publish --access public",
-    "pub-beta": "npm publish --tag beta",
-    "sort": "npx sort-package-json",
-    "dev": "tsx src/index.ts",
-    "karin": "karin"
+    "sort": "npx sort-package-json"
   },
   "dependencies": {
     "@karinjs/geturls": "^1.0.2",
-    "form-data": "^4.0.2",
-    "image-size": "^1.2.0",
+    "form-data": "^4.0.5",
+    "image-size": "^2.0.2",
     "qrcode": "^1.5.4",
-    "silk-wasm": "^3.6.3",
+    "silk-wasm": "^3.7.1",
     "tweetnacl": "^1.0.3"
   },
+  "devDependencies": {
+    "@types/express": "5.0.6",
+    "@types/node": "^24.12.4",
+    "@types/qrcode": "^1.5.6",
+    "eslint": "^9.39.4",
+    "neostandard": "^0.13.0",
+    "node-karin": "^1.15.5",
+    "tsdown": "^0.22.0",
+    "tsx": "^4.22.0",
+    "typescript": "^6.0.3"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "pnpm": {
+    "overrides": {
+      "yaml@>=2.0.0 <2.8.3": "^2.8.3"
+    }
+  },
   "karin": {
     "main": "src/index.ts",
     "apps": [
-      "lib/apps"
+      "dist/apps"
     ],
     "ts-apps": [
       "src/apps"
@@ -58,6 +69,8 @@
       "config",
       "data",
       "resources"
-    ]
+    ],
+    "ts-web": "src/web.config.ts",
+    "web": "dist/web.config.js"
   }
 }

package/config/comment/config.json

@@ -1,3 +0,0 @@
-{
-  "screenshotUrl": "网页截图测试地址"
-}

package/config/config/config.yaml

@@ -1,53 +0,0 @@
-# 全局默认配置 以下所有配置均可在账号配置中单独配置
-default:
-  # 机器人ID
-  appId: string
-  # 机器人密钥
-  secret: string
-  # 正式环境api
-  prodApi: https://api.sgroup.qq.com
-  # 沙盒api
-  sandboxApi: https://sandbox.api.sgroup.qq.com
-  # 调用凭证的Api
-  tokenApi: https://bots.qq.com/app/getAppAccessToken
-  # 是否开启沙盒环境
-  sandbox: false
-  # 开启QQ场景能力
-  qqEnable: true
-  # 开启频道场景能力
-  guildEnable: true
-  # 频道场景模式 0-公域 1-私域
-  guildMode: 0
-  # 文本中的url转二维码白名单 配置后将不转换这些url为二维码
-  exclude: []
-  # 接受到消息后对文本进行表达式处理
-  regex: [
-      {
-        # 表达式
-        reg: "^#",
-        # 替换为
-        rep: "",
-      },
-    ]
-  # markdown配置
-  markdown:
-    # 发送模式 0-关闭MD 1-原生MD 3-旧图文模板MD 4-纯文模板MD 5-自定义处理
-    mode: 0
-    # 模板ID
-    id: ""
-    kv:
-      - text_start
-      - img_dec
-      - img_url
-      - text_end
-
-  # 事件接收配置
-  event:
-    # 接收方式 0-关闭 1-webhook 2-http 3-ws
-    type: 0
-    # ws服务器地址
-    wsUrl: ws://example.com/webhook
-    # ws服务器token
-    wsToken: your_token
-    # http鉴权token
-    httpToken: your_token

package/lib/cli/pr.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/lib/cli/pr.js

@@ -1,73 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs';
-/**
- * @description 获取package.json路径
- */
-const getPkgPath = () => process.cwd() + '/package.json';
-/**
- * @description 读取package.json
- */
-const readPkg = () => JSON.parse(fs.readFileSync(getPkgPath(), 'utf-8'));
-/**
- * @description 写入package.json
- * @param pkg package.json
- */
-const writePkg = (pkg) => fs.writeFileSync(getPkgPath(), JSON.stringify(pkg, null, 2));
-/**
- * @description 构建pr版本号 <主版本号>.<次版本号>.<修订号>-<预发布标识>.<PR标识>.<PR编号>.<工作流唯一编号>-<时间戳>
-
- * @param pkg package.json
- */
-const updateVersion = (pkg) => {
-    const list = pkg.version.split('.');
-    // 1.0.0 => 1.0.1-beta.pr.pr编号.工作流唯一编号-时间戳 => 1.0.1-beta.pr.184-1631537630
-    const timestamp = Math.floor(Date.now() / 1000);
-    list[2] = `${Number(list[2]) + 1}-beta.pr.${process.env.PR_NUMBER}.${process.env.GITHUB_RUN_ATTEMPT || 1}-${timestamp}`;
-    pkg.version = list.join('.');
-};
-/**
- * @description 设置环境变量
- * @param pkg package.json
- */
-const setEnvVariables = (pkg) => {
-    fs.appendFileSync(process.env.GITHUB_ENV, `PKG_NAME=${pkg.name}\nPKG_VERSION=${pkg.version}\n`);
-};
-/**
- * @description 更新版本号并设置环境变量
- */
-const version = () => {
-    const pkg = readPkg();
-    updateVersion(pkg);
-    writePkg(pkg);
-    setEnvVariables(pkg);
-};
-/**
- * @description 删除devDependencies和peerDependencies
- */
-const clean = () => {
-    const pkg = readPkg();
-    delete pkg.devDependencies;
-    delete pkg.peerDependencies;
-    writePkg(pkg);
-};
-/**
- * @description 执行所有操作
- */
-const all = () => {
-    const pkg = readPkg();
-    updateVersion(pkg);
-    delete pkg.devDependencies;
-    delete pkg.peerDependencies;
-    writePkg(pkg);
-    setEnvVariables(pkg);
-};
-const cmd = process.argv[2];
-if (cmd === 'version') {
-    version();
-}
-else if (cmd === 'clean') {
-    clean();
-}
-else if (cmd === 'all') {
-    all();
-}