@karinjs/adapter-qqbot 2.1.0 → 2.2.1

package/README.md

@@ -26,7 +26,15 @@ pnpm add @karinjs/adapter-qqbot
     "qqEnable": true,
     "guildEnable": true,
     "guildMode": 0,
+    "proxy": {
+      "prodApi": "https://api.sgroup.qq.com",
+      "sandboxApi": "https://sandbox.api.sgroup.qq.com",
+      "tokenApi": "https://bots.qq.com/app/getAppAccessToken",
+      "prodWs": "wss://api.sgroup.qq.com/websocket/",
+      "sandboxWs": "wss://sandbox.api.sgroup.qq.com/websocket/"
+    },
     "keyboard": { "enable": true },
+    "markdown": { "enable": true },
     "event": { "type": 2 }
   }
 ]
@@ -34,6 +42,8 @@ pnpm add @karinjs/adapter-qqbot
 
 - `event.type`: `0` 关闭、`1` Webhook、`2` WebSocket（默认）。
 - `guildMode`: `0` 公域，只收 @ 消息；`1` 私域，接收全部频道消息。
+- `proxy`: 自定义连接代理地址。`prodApi` / `sandboxApi` 作为 OpenAPI 根地址使用，后端拼接路径时会兼容末尾 `/`；`tokenApi` 是完整接口地址；`prodWs` / `sandboxWs` 是完整 WebSocket 网关地址，支持 `ws://` 和 `wss://`，路径和查询参数会按配置原样连接。
+- `markdown.enable`: 是否让普通文本和图片自动合并为 Markdown 消息，默认开启。关闭后普通图片会改为单独上传发送；插件显式传入的 `segment.markdown` 不受此开关影响。
 
 ## 按钮
 

package/dist/apps/cleanup.js

@@ -1,5 +1,5 @@
-import { n as config } from "../config-DKa7596f.js";
-import { t as getMessageStore } from "../message-O73AeL_P.js";
+import { n as config } from "../config-B_Gc9JKZ.js";
+import { t as getMessageStore } from "../message-Dt4QkDYn.js";
 import karin from "node-karin";
 
 //#region src/apps/cleanup.ts

package/dist/apps/login.js

@@ -1,5 +1,5 @@
-import { c as log } from "../config-DKa7596f.js";
-import { n as runQrOnboard } from "../onboard-DPWgX39H.js";
+import { m as log } from "../config-B_Gc9JKZ.js";
+import { n as runQrOnboard } from "../onboard-BXQ1cG8h.js";
 import karin, { segment } from "node-karin";
 
 //#region src/apps/login.ts

package/dist/config-B_Gc9JKZ.js

@@ -0,0 +1,253 @@
+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/proxy-url.ts
+/**
+* HTTP / token 地址只清理首尾空白。完整接口地址是否带尾斜杠可能有路由含义，不能替用户改。
+*/
+const normalizeHttpUrl = (raw) => raw.trim();
+/**
+* 拼接 OpenAPI 路径时再处理斜杠，避免配置值本身被改写。
+*/
+const joinHttpPath = (base, path) => {
+	return `${normalizeHttpUrl(base).replace(/\/+$/, "")}/${path.replace(/^\/+/, "")}`;
+};
+/**
+* WebSocket 网关地址：
+* - ws:// / wss:// 原样保留协议
+* - http:// / https:// 映射为 ws:// / wss://
+* - 未写协议时按 wss:// 处理
+*
+* 这里只做最小处理，不改 path / query / hash。自定义网关的尾斜杠和查询参数都可能有路由含义。
+*/
+const normalizeWsGatewayUrl = (raw) => {
+	const value = raw.trim();
+	if (!value) return "";
+	let normalized = value;
+	const scheme = value.match(/^([a-z][a-z\d+.-]*):\/\//i)?.[1]?.toLowerCase();
+	if (scheme === "http" || scheme === "https") normalized = value.replace(/^http/i, "ws");
+	else if (scheme && scheme !== "ws" && scheme !== "wss") throw new Error(`unsupported websocket protocol: ${scheme}:`);
+	else if (!scheme) normalized = `wss://${value}`;
+	const parsed = new URL(normalized);
+	if (parsed.protocol !== "ws:" && parsed.protocol !== "wss:") throw new Error(`unsupported websocket protocol: ${parsed.protocol}`);
+	return normalized;
+};
+/**
+* 只有从 OpenAPI 根地址推导官方 fallback 网关时，才主动拼 `/websocket/`。
+*/
+const buildFallbackWsUrlFromApi = (apiUrl) => {
+	const parsed = new URL(normalizeWsGatewayUrl(apiUrl));
+	parsed.pathname = `${parsed.pathname.replace(/\/+$/, "")}/websocket/`;
+	parsed.search = "";
+	parsed.hash = "";
+	return parsed.toString();
+};
+const normalizeProxyConfig = (proxy) => ({
+	prodApi: normalizeHttpUrl(proxy.prodApi),
+	sandboxApi: normalizeHttpUrl(proxy.sandboxApi),
+	tokenApi: normalizeHttpUrl(proxy.tokenApi),
+	prodWs: normalizeWsGatewayUrl(proxy.prodWs),
+	sandboxWs: normalizeWsGatewayUrl(proxy.sandboxWs)
+});
+
+//#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 configPath = `${dirConfig}/config.json`;
+const syncCache = (data) => {
+	cache = data;
+	Object.keys(cacheMap).forEach((key) => delete cacheMap[key]);
+	data.forEach((v) => {
+		cacheMap[v.appId] = v;
+	});
+};
+/**
+* 读取配置
+*/
+const config = () => {
+	if (!fs.existsSync(configPath)) {
+		fs.mkdirSync(dirConfig, { recursive: true });
+		fs.writeFileSync(configPath, JSON.stringify([], null, 2));
+	}
+	if (cache) return cache;
+	const result = formatConfig(requireFileSync(configPath));
+	syncCache(result);
+	return result;
+};
+/**
+* 直接从磁盘读取配置，不使用内存缓存。
+*/
+const readConfigFile = () => {
+	if (!fs.existsSync(configPath)) return config();
+	return formatConfig(requireFileSync(configPath));
+};
+/**
+* 获取单 bot 配置
+*/
+const getConfig = (appid) => cacheMap[appid];
+/**
+* 写入配置
+*/
+const writeConfig = (data) => {
+	fs.mkdirSync(dirConfig, { recursive: true });
+	const normalized = formatConfig(data);
+	fs.writeFileSync(configPath, JSON.stringify(normalized, null, 2));
+	syncCache(normalized);
+};
+/**
+* 用默认值补齐用户配置
+*/
+const formatConfig = (user) => {
+	const def = getDefaultConfig()[0];
+	return user.map((item) => {
+		const { prodApi, sandboxApi, tokenApi, wsUrl, proxy, keyboard, markdown, messageCache, event, ...rest } = item;
+		return {
+			...def,
+			...rest,
+			proxy: normalizeProxyConfig({
+				...def.proxy,
+				...proxy,
+				prodApi: proxy?.prodApi || prodApi || def.proxy.prodApi,
+				sandboxApi: proxy?.sandboxApi || sandboxApi || def.proxy.sandboxApi,
+				tokenApi: proxy?.tokenApi || tokenApi || def.proxy.tokenApi,
+				prodWs: proxy?.prodWs || proxy?.wsUrl || wsUrl || def.proxy.prodWs,
+				sandboxWs: proxy?.sandboxWs || proxy?.wsUrl || wsUrl || def.proxy.sandboxWs
+			}),
+			keyboard: {
+				...def.keyboard,
+				...keyboard
+			},
+			markdown: {
+				...def.markdown,
+				...markdown
+			},
+			messageCache: {
+				...def.messageCache,
+				...messageCache
+			},
+			event: {
+				...def.event,
+				...event
+			}
+		};
+	});
+};
+/**
+* 默认配置
+*/
+const getDefaultConfig = () => [{
+	name: "",
+	appId: "",
+	secret: "",
+	proxy: {
+		prodApi: "https://api.sgroup.qq.com",
+		sandboxApi: "https://sandbox.api.sgroup.qq.com",
+		tokenApi: "https://bots.qq.com/app/getAppAccessToken",
+		prodWs: "wss://api.sgroup.qq.com/websocket/",
+		sandboxWs: "wss://sandbox.api.sgroup.qq.com/websocket/"
+	},
+	sandbox: false,
+	qqEnable: true,
+	guildEnable: true,
+	guildMode: 0,
+	regex: [{
+		reg: "^/",
+		rep: "#"
+	}],
+	keyboard: { enable: true },
+	markdown: { enable: true },
+	messageCache: {
+		enable: false,
+		self: false
+	},
+	event: { type: 2 }
+}];
+/**
+* 监听配置文件，比较前后差异决定重建 / 销毁 bot
+*/
+setTimeout(() => {
+	watch(`${dirConfig}/config.json`, (old, now) => {
+		const oldConfig = formatConfig(old);
+		const nowConfig = formatConfig(now);
+		syncCache(nowConfig);
+		const diff = common.diffArray(oldConfig, nowConfig);
+		diff.removed.forEach((v) => _destroyBot?.(v.appId));
+		if (diff.added.length > 0) {
+			const ids = new Set(diff.added.map((v) => v.appId));
+			nowConfig.forEach((v) => {
+				if (!ids.has(v.appId)) return;
+				if (v.event.type === 0) return;
+				_createBot?.(v);
+			});
+		}
+		diff.common.forEach((curr) => {
+			const prev = oldConfig.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 { readConfigFile as a, joinHttpPath as c, normalizeWsGatewayUrl as d, pkg as f, basename as h, getDefaultConfig as i, normalizeHttpUrl as l, log as m, config as n, writeConfig as o, pluginDirName as p, getConfig as r, buildFallbackWsUrlFromApi as s, bindHandlers as t, normalizeProxyConfig as u };

package/dist/index.d.ts

@@ -817,6 +817,21 @@ declare class MessageStore {
 }
 //#endregion
 //#region src/types/config.d.ts
+/**
+ * 自定义连接代理配置
+ */
+interface QQBotProxyConfig {
+  /** 正式环境 API */
+  prodApi: string;
+  /** 测试环境 API */
+  sandboxApi: string;
+  /** 调用凭证 API */
+  tokenApi: string;
+  /** 正式环境 WebSocket 网关 */
+  prodWs: string;
+  /** 测试环境 WebSocket 网关 */
+  sandboxWs: string;
+}
 /**
  * 单个 QQBot 配置
  */
@@ -827,12 +842,8 @@ interface QQBotConfig {
   appId: string;
   /** 机器人密钥 */
   secret: string;
-  /** 正式环境 API */
-  prodApi: string;
-  /** 测试环境 API */
-  sandboxApi: string;
-  /** 调用凭证 API */
-  tokenApi: string;
+  /** 自定义连接代理 */
+  proxy: QQBotProxyConfig;
   /** 开启沙盒环境 */
   sandbox: boolean;
   /** 开启 QQ 场景能力（单聊 / 群聊） */
@@ -850,6 +861,10 @@ interface QQBotConfig {
   keyboard: {
     /** 是否将文本中的 URL 自动转换为 keyboard 按钮 */enable: boolean;
   };
+  /** Markdown 通道 */
+  markdown: {
+    /** 是否启用 Markdown 通道发送消息 */enable: boolean;
+  };
   /** 消息缓存配置 */
   messageCache: {
     /** 是否启用数据库消息缓存，用于 bot.getMsg */enable: boolean; /** 是否缓存机器人自己发送的消息 */