@karinjs/adapter-qqbot 1.3.1 → 2.1.0

package/dist/apps/cleanup.d.ts

@@ -0,0 +1,5 @@
+//#region src/apps/cleanup.d.ts
+/** 每 10 分钟清理一次过期的 getMsg/getHistoryMsg 本地缓存。 */
+declare const clearMessageCache: import("node-karin").Task | undefined;
+//#endregion
+export { clearMessageCache };

package/dist/apps/cleanup.js

@@ -0,0 +1,22 @@
+import { n as config } from "../config-DKa7596f.js";
+import { t as getMessageStore } from "../message-O73AeL_P.js";
+import karin from "node-karin";
+
+//#region src/apps/cleanup.ts
+/**
+* 判断是否有任意 QQBot 配置开启消息缓存。
+*
+* @returns true 表示需要注册消息缓存清理任务。
+*/
+const enabledMessageCache = () => {
+	return config().some((item) => item.messageCache.enable);
+};
+/** 每 10 分钟清理一次过期的 getMsg/getHistoryMsg 本地缓存。 */
+const clearMessageCache = enabledMessageCache() ? karin.task("qqbot 适配器消息缓存清理", "*/10 * * * *", async () => await getMessageStore().cleanupExpired(), {
+	name: "qqbot 适配器消息缓存清理任务",
+	log: false,
+	type: "skip"
+}) : void 0;
+
+//#endregion
+export { clearMessageCache };

package/dist/apps/login.d.ts

@@ -0,0 +1,18 @@
+//#region src/apps/login.d.ts
+/**
+ * #QQ登录 指令
+ *
+ * 仅主人可用。匹配 `#QQ登录` 或 `#qqlogin`（大小写均可）。
+ * 必须带 `#` 前缀。
+ *
+ * 流程：
+ * 1. 立即回复"开始扫码"
+ * 2. 触发扫码授权流程
+ * 3. 每次生成新二维码 → 把 PNG 图片回复给触发者
+ * 4. 授权成功 → 回复结果，watch 回调自动初始化 bot
+ *
+ * ⚠ 注意：扫码授权会刷新该 appId 的 secret，旧 secret 立即失效
+ */
+declare const qqLogin: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;
+//#endregion
+export { qqLogin };

package/dist/apps/login.js

@@ -0,0 +1,106 @@
+import { c as log } from "../config-DKa7596f.js";
+import { n as runQrOnboard } from "../onboard-DPWgX39H.js";
+import karin, { segment } from "node-karin";
+
+//#region src/apps/login.ts
+/**
+* #QQ登录 指令
+*
+* 仅主人可用。匹配 `#QQ登录` 或 `#qqlogin`（大小写均可）。
+* 必须带 `#` 前缀。
+*
+* 流程：
+* 1. 立即回复"开始扫码"
+* 2. 触发扫码授权流程
+* 3. 每次生成新二维码 → 把 PNG 图片回复给触发者
+* 4. 授权成功 → 回复结果，watch 回调自动初始化 bot
+*
+* ⚠ 注意：扫码授权会刷新该 appId 的 secret，旧 secret 立即失效
+*/
+/** 互斥锁：避免并发扫码 */
+let busy = false;
+/**
+* 判断触发 #QQ登录 的上游是否为 Karin 控制台适配器。
+* Console 适配器无法直接在聊天窗口展示二维码图片，因此需要额外打印终端二维码。
+*/
+const isConsoleAdapter = (bot) => {
+	const selfId = String(bot.selfId || "").toLowerCase();
+	const name = String(bot.adapter.name || "").toLowerCase();
+	const protocol = String(bot.adapter.protocol || "").toLowerCase();
+	return selfId === "console" || name === "console" || name.endsWith("/console") || protocol === "console";
+};
+/**
+* 记录一次回复返回的消息 ID，便于扫码流程结束后清理二维码、链接等临时信息。
+* @param result 回复返回值。
+* @param messageIds 已登记的消息 ID 集合。
+*/
+const trackReply = (result, messageIds) => {
+	const messageId = result?.messageId;
+	if (messageId && !messageIds.includes(messageId)) messageIds.push(messageId);
+};
+/**
+* 撤回扫码流程中发出的临时消息。
+* @param bot 触发登录的机器人实例。
+* @param contact 回复所在会话。
+* @param messageIds 需要撤回的消息 ID。
+*/
+const recallTrackedReplies = async (bot, contact, messageIds) => {
+	for (const messageId of messageIds) try {
+		await bot.recallMsg(contact, messageId);
+	} catch (err) {
+		log("warn", `[扫码登录] 撤回临时消息失败: ${messageId}`, err);
+	}
+	messageIds.length = 0;
+};
+const qqLogin = karin.command(/^#(?:qq登录|qqlogin)$/i, async (e) => {
+	if (busy) {
+		await e.reply("已有扫码授权在进行中，请稍候再试");
+		return;
+	}
+	busy = true;
+	const messageIds = [];
+	/**
+	* 发送并登记扫码流程的临时回复。
+	* @param elements 回复内容。
+	*/
+	const replyAndTrack = async (elements) => {
+		const result = await e.reply(elements);
+		trackReply(result, messageIds);
+		return result;
+	};
+	try {
+		await replyAndTrack([segment.text("已开始 QQ 扫码登录授权\n⚠ 扫码完成会刷新该机器人的 secret，旧 secret 立即失效")]);
+		log("info", `[扫码登录] 由用户 ${e.userId} 触发`);
+		const ok = await runQrOnboard({
+			printTerminal: isConsoleAdapter(e.bot),
+			onQr: async ({ base64, url, refresh }) => {
+				const head = refresh === 0 ? "请使用手机 QQ 扫描二维码完成授权（二维码 60s 内有效，过期会自动刷新最多 3 次）：" : `上一张二维码已过期，已自动刷新（第 ${refresh}/3 次，仍为 60s 有效期）：`;
+				try {
+					await replyAndTrack([
+						segment.text(head),
+						segment.image(base64),
+						segment.text(`或在手机 QQ 打开链接：\n${url}`)
+					]);
+				} catch (err) {
+					log("warn", "[扫码登录] 推送二维码失败:", err);
+				}
+			}
+		});
+		await recallTrackedReplies(e.bot, e.contact, messageIds);
+		if (ok) await e.reply("扫码授权成功，配置已保存，QQBot 实例正在初始化…");
+		else await e.reply("扫码授权失败或超时，请重试 #QQ登录");
+	} catch (err) {
+		log("error", "[扫码登录] 异常:", err);
+		await recallTrackedReplies(e.bot, e.contact, messageIds);
+		await e.reply("扫码授权过程中发生异常，详情见服务端日志");
+	} finally {
+		busy = false;
+	}
+}, {
+	name: "qqbot:login",
+	permission: "master",
+	authFailMsg: "#QQ登录 仅限主人使用"
+});
+
+//#endregion
+export { qqLogin };

package/dist/common-by1GpV0b.js

@@ -0,0 +1,49 @@
+import { common, logger } from "node-karin";
+import qrcode from "qrcode";
+import size from "image-size";
+import lodash from "node-karin/lodash";
+import GetUrls from "@karinjs/geturls";
+
+//#region src/utils/common.ts
+/** 睡眠 */
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+/** 随机数 */
+const random = (min, max) => lodash.random(min, max);
+/**
+* 伪事件日志（红字）
+*/
+const fakeEvent = (log) => {
+	logger.fatal(`${logger.red("[QQ Official Bot][虚假事件]")} ${log.replace(/\n/g, "\\n")}`);
+};
+/**
+* 提取文本中的 URL 列表
+* 中文不符合 URL 规范，先替换为 `|` 再扫描
+*/
+const handleUrl = (text, exclude = []) => {
+	const cleaned = text.replace(/[一-龥]/g, "|");
+	return GetUrls.getUrls(cleaned, {
+		exclude,
+		stripWWW: false,
+		normalizeProtocol: false,
+		removeQueryParameters: false,
+		removeSingleSlash: false,
+		sortQueryParameters: false,
+		stripAuthentication: false,
+		stripTextFragment: false,
+		removeTrailingSlash: false,
+		normalize: false
+	});
+};
+/**
+* 读取图片宽高
+*/
+const getImageSize = async (url) => {
+	const { width = 100, height = 100 } = size(await common.buffer(url));
+	return {
+		width,
+		height
+	};
+};
+
+//#endregion
+export { sleep as a, random as i, getImageSize as n, handleUrl as r, fakeEvent as t };

package/dist/config-DKa7596f.js

@@ -0,0 +1,170 @@
+import { common, karinPathBase, logger, requireFileSync, watch } from "node-karin";
+import path from "path";
+import { fileURLToPath } from "url";
+import fs from "node:fs";
+
+//#region src/root.ts
+/** 当前文件的绝对路径 */
+const filePath = fileURLToPath(import.meta.url);
+/** 插件包绝对路径 */
+const dirPath = path.resolve(filePath, "../..");
+/** 插件包的名称 */
+const basename = path.basename(dirPath);
+
+//#endregion
+//#region src/utils/logger.ts
+const PREFIX = "[QQ Official Bot]";
+const m = {
+	trace: (...a) => logger.trace(PREFIX, ...a),
+	debug: (...a) => logger.debug(PREFIX, ...a),
+	info: (...a) => logger.info(PREFIX, ...a),
+	warn: (...a) => logger.warn(PREFIX, ...a),
+	error: (...a) => logger.error(PREFIX, ...a),
+	fatal: (...a) => logger.fatal(PREFIX, ...a),
+	mark: (...a) => logger.mark(PREFIX, ...a)
+};
+/**
+* QQBot 日志函数
+* - log('info', '消息')
+* - log.info('消息')
+*
+* 日志级别由 karin 框架的 log.level 控制
+*/
+function log(level, ...args) {
+	m[level](...args);
+}
+Object.assign(log, m);
+
+//#endregion
+//#region src/utils/plugin.ts
+/**
+* 读取当前插件的 package.json。
+*
+* @returns package.json 内容。
+*/
+const pkg = () => requireFileSync(`${dirPath}/package.json`);
+/** 当前插件 npm 包名，如 @karinjs/adapter-qqbot。 */
+const pluginName = pkg().name;
+/** 文件系统目录名：把 npm 包名里的 `/` 规范化为 `-`，与 Karin 框架对齐。 */
+const pluginDirName = pluginName.replace(/\//g, "-");
+
+//#endregion
+//#region src/utils/config.ts
+let cache;
+const cacheMap = {};
+/** 延迟注入，避免与 core/index.ts 循环依赖 */
+let _createBot;
+let _destroyBot;
+const bindHandlers = (createBot, destroyBot) => {
+	_createBot = createBot;
+	_destroyBot = destroyBot;
+};
+/** 配置目录：${karinPathBase}/@karinjs-adapter-qqbot/config */
+const dirConfig = `${karinPathBase}/${pluginDirName}/config`;
+/**
+* 读取配置
+*/
+const config = () => {
+	const cfgPath = `${dirConfig}/config.json`;
+	if (!fs.existsSync(cfgPath)) {
+		fs.mkdirSync(dirConfig, { recursive: true });
+		fs.writeFileSync(cfgPath, JSON.stringify([], null, 2));
+	}
+	if (cache) return cache;
+	const result = formatConfig(requireFileSync(cfgPath));
+	cache = result;
+	result.forEach((v) => {
+		cacheMap[v.appId] = v;
+	});
+	return result;
+};
+/**
+* 获取单 bot 配置
+*/
+const getConfig = (appid) => cacheMap[appid];
+/**
+* 写入配置
+*/
+const writeConfig = (data) => {
+	fs.mkdirSync(dirConfig, { recursive: true });
+	fs.writeFileSync(`${dirConfig}/config.json`, JSON.stringify(data, null, 2));
+};
+/**
+* 用默认值补齐用户配置
+*/
+const formatConfig = (user) => {
+	const def = getDefaultConfig()[0];
+	return user.map((item) => ({
+		...def,
+		...item,
+		keyboard: {
+			...def.keyboard,
+			...item.keyboard
+		},
+		messageCache: {
+			...def.messageCache,
+			...item.messageCache
+		},
+		event: {
+			...def.event,
+			...item.event
+		}
+	}));
+};
+/**
+* 默认配置
+*/
+const getDefaultConfig = () => [{
+	name: "",
+	appId: "",
+	secret: "",
+	prodApi: "https://api.sgroup.qq.com",
+	sandboxApi: "https://sandbox.api.sgroup.qq.com",
+	tokenApi: "https://bots.qq.com/app/getAppAccessToken",
+	sandbox: false,
+	qqEnable: true,
+	guildEnable: true,
+	guildMode: 0,
+	regex: [{
+		reg: "^/",
+		rep: "#"
+	}],
+	keyboard: { enable: true },
+	messageCache: {
+		enable: false,
+		self: false
+	},
+	event: { type: 2 }
+}];
+/**
+* 监听配置文件，比较前后差异决定重建 / 销毁 bot
+*/
+setTimeout(() => {
+	watch(`${dirConfig}/config.json`, (old, now) => {
+		cache = formatConfig(now);
+		cache.forEach((v) => {
+			cacheMap[v.appId] = v;
+		});
+		const diff = common.diffArray(old, now);
+		diff.removed.forEach((v) => _destroyBot?.(v.appId));
+		if (diff.added.length > 0) {
+			const ids = new Set(diff.added.map((v) => v.appId));
+			cache.forEach((v) => {
+				if (!ids.has(v.appId)) return;
+				if (v.event.type === 0) return;
+				_createBot?.(v);
+			});
+		}
+		diff.common.forEach((curr) => {
+			const prev = old.find((c) => c.appId === curr.appId);
+			if (!prev) return;
+			if (JSON.stringify(prev) === JSON.stringify(curr)) return;
+			logger.info(`[QQ Official Bot][配置监听] 配置已变更: ${curr.appId}，重新初始化`);
+			_destroyBot?.(prev.appId);
+			if (curr.event.type !== 0) _createBot?.(curr);
+		});
+	});
+}, 2e3);
+
+//#endregion
+export { writeConfig as a, log as c, getDefaultConfig as i, basename as l, config as n, pkg as o, getConfig as r, pluginDirName as s, bindHandlers as t };