@karinjs/adapter-qqbot 1.2.8 → 1.2.10

package/config/comment/config.json

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

package/config/config/config.yaml

@@ -0,0 +1,53 @@
+# 全局默认配置 以下所有配置均可在账号配置中单独配置
+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

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

package/lib/cli/pr.js

@@ -0,0 +1,73 @@
+#!/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();
+}

package/lib/core/adapter/adapter.d.ts

@@ -0,0 +1,91 @@
+import FormData from 'form-data';
+import { QQBotApi } from '@/core/api';
+import { AdapterBase } from 'node-karin';
+import type { SendGuildMsg, SendGuildResponse, SendQQMsg, SendQQMsgResponse } from '@/core/api/types';
+import type { LoggerLevel, ButtonElement, KeyboardElement, MarkdownElement, MarkdownTplElement, SendMsgResults, Contact } from 'node-karin';
+/** 发送函数所需参数 */
+export type Options<T extends 'qq' | 'guild'> = T extends 'qq' ? SendQQMsg : SendGuildMsg | FormData;
+/** QQ发送消息函数类型 */
+export type QQSend = (peer: string, item: SendQQMsg) => Promise<SendQQMsgResponse>;
+/** 频道发送消息函数类型 */
+export type GuildSend = (peer: string, subPeer: string, item: SendGuildMsg | FormData) => Promise<SendGuildResponse>;
+export type Pasmsg<T extends 'qq' | 'guild'> = {
+    type: 'msg' | 'event';
+    msg_id: string;
+    msg_seq: T extends 'qq' ? number : never;
+};
+export interface Grouping<T extends 'qq' | 'guild'> {
+    /** 文本 */
+    content: string[];
+    /** 图片 QQ专属 */
+    image: string[];
+    /** 单行按钮 */
+    button: ButtonElement[];
+    /** 多行按钮 */
+    keyboard: KeyboardElement[];
+    /** markdown */
+    markdown: MarkdownElement[];
+    /** markdown模板 */
+    markdownTpl: MarkdownTplElement[];
+    /** 频道专属 图片url */
+    imageUrls: string[];
+    /** 频道专属 图片file */
+    imageFiles: string[];
+    /** 引用回复 频道专属 */
+    reply: {
+        message_id: string;
+    };
+    /** pasmsg */
+    pasmsg: Pasmsg<T>;
+    /** 代发送列表 */
+    list: Array<Options<T>>;
+    /**
+     * 处理按钮、markdown
+     * 统一格式后推入待发送消息列表
+     * @param type 构建类型
+     * @param list 分类列表
+     * @returns
+     */
+    markdownToButton: (type: T, list: Grouping<T>) => void;
+}
+export declare abstract class AdapterQQBot extends AdapterBase {
+    super: QQBotApi;
+    constructor(QQBot: QQBotApi);
+    logger(level: LoggerLevel, ...args: any[]): void;
+    /**
+     * 被动消息结构
+     * @param type 消息类型
+     */
+    pasmsg<T extends 'qq' | 'guild'>(type: T): Pasmsg<T>;
+    /**
+     * 撤回消息
+     * @param contact 联系人
+     * @param messageId 消息id
+     * @returns 撤回结果
+     */
+    recallMsg(contact: Contact, messageId: string): Promise<boolean>;
+    /**
+     * 初始化消息分类对象
+     */
+    initList<T extends 'qq' | 'guild'>(type: T): Grouping<T>;
+    /**
+     * 初始化发送消息返回值
+     */
+    initSendMsgResults(): SendMsgResults;
+    /**
+     * 处理返回值
+     * @param data 返回值
+     */
+    handleResponse(data: SendMsgResults): SendMsgResults;
+    /**
+     * - 处理按钮、markdown
+     * - 统一格式后推入待发送消息列表
+     * @param type 消息类型
+     * @param button 按钮
+     * @param keyboard 键盘
+     * @param markdown markdown
+     * @param markdownTpl markdown模板
+     * @returns 消息列表
+     */
+    markdownToButton<T extends 'qq' | 'guild'>(type: T, list: Grouping<T>): void;
+}

package/lib/core/adapter/adapter.js

@@ -0,0 +1,144 @@
+import { random } from '@/utils/common';
+import { AdapterBase, logger, karinToQQBot } from 'node-karin';
+export class AdapterQQBot extends AdapterBase {
+    super;
+    constructor(QQBot) {
+        super();
+        this.super = QQBot;
+        this.adapter.name = '@karinjs/qqbot';
+        this.adapter.protocol = 'qqbot';
+        this.adapter.platform = 'qq';
+        this.adapter.standard = 'other';
+    }
+    logger(level, ...args) {
+        logger.bot(level, this.selfId, ...args);
+    }
+    /**
+     * 被动消息结构
+     * @param type 消息类型
+     */
+    pasmsg(type) {
+        if (type === 'qq') {
+            return { type: 'msg', msg_id: '', msg_seq: random(1, 9999999) };
+        }
+        return { type: 'msg', msg_id: '' };
+    }
+    /**
+     * 撤回消息
+     * @param contact 联系人
+     * @param messageId 消息id
+     * @returns 撤回结果
+     */
+    async recallMsg(contact, messageId) {
+        try {
+            if (contact.scene === 'friend') {
+                await this.super.recallMsg('user', contact.peer, messageId);
+                return true;
+            }
+            if (contact.scene === 'group') {
+                await this.super.recallMsg('group', contact.peer, messageId);
+                return true;
+            }
+            if (contact.scene === 'direct') {
+                await this.super.recallMsg('dms', contact.peer, messageId);
+                return true;
+            }
+            if (contact.scene === 'guild') {
+                await this.super.recallMsg('channels', contact.peer, messageId);
+                return true;
+            }
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * 初始化消息分类对象
+     */
+    initList(type) {
+        const list = {
+            content: [],
+            image: [],
+            button: [],
+            keyboard: [],
+            markdown: [],
+            markdownTpl: [],
+            imageUrls: [],
+            imageFiles: [],
+            reply: { message_id: '' },
+            pasmsg: this.pasmsg(type),
+            list: [],
+            markdownToButton: (type, list) => this.markdownToButton(type, list)
+        };
+        return list;
+    }
+    /**
+     * 初始化发送消息返回值
+     */
+    initSendMsgResults() {
+        return {
+            messageId: '',
+            message_id: '',
+            time: 0,
+            messageTime: 0,
+            rawData: []
+        };
+    }
+    /**
+     * 处理返回值
+     * @param data 返回值
+     */
+    handleResponse(data) {
+        const { id, timestamp } = data.rawData[0];
+        data.messageId = id;
+        data.message_id = id;
+        data.messageTime = timestamp;
+        data.messageTime = typeof timestamp === 'string' ? new Date(timestamp).getTime() : timestamp;
+        return data;
+    }
+    /**
+     * - 处理按钮、markdown
+     * - 统一格式后推入待发送消息列表
+     * @param type 消息类型
+     * @param button 按钮
+     * @param keyboard 键盘
+     * @param markdown markdown
+     * @param markdownTpl markdown模板
+     * @returns 消息列表
+     */
+    markdownToButton(type, list) {
+        /** 统一按钮 */
+        const rows = [];
+        if (list.button.length) {
+            list.button.forEach((v) => {
+                rows.push(...karinToQQBot(v));
+            });
+        }
+        if (list.keyboard.length) {
+            list.keyboard.forEach((v) => {
+                rows.push(...karinToQQBot(v));
+            });
+        }
+        list.markdown.forEach((v) => {
+            const item = type === 'guild' ? this.super.GuildMsgOptions('markdown', { content: v.markdown }) : this.super.QQdMsgOptions('markdown', { content: v.markdown });
+            if (rows.length)
+                item.keyboard = { content: { rows } };
+            list.list.push(item);
+        });
+        list.markdownTpl.forEach((v) => {
+            const item = type === 'guild'
+                ? this.super.GuildMsgOptions('markdown', {
+                    custom_template_id: v.templateId,
+                    params: v.params
+                })
+                : this.super.QQdMsgOptions('markdown', {
+                    custom_template_id: v.templateId,
+                    params: v.params
+                });
+            if (rows.length)
+                item.keyboard = { content: { rows } };
+            list.list.push(item);
+        });
+    }
+}

package/lib/core/adapter/handler.d.ts

@@ -0,0 +1,49 @@
+import type { Contact, SendMsgResults } from 'node-karin';
+import type { QQSend, Grouping, Options, GuildSend } from '@/core/adapter/adapter';
+import { AdapterQQBotMarkdown } from '@/core/adapter/markdown';
+export interface RawMarkdown {
+    /**
+     * 频道场景原生Markdown
+     * @param type 场景类型
+     * @param ctx 适配器实例
+     * @param list 分类列表
+     * @param contact 发送目标
+     * @param pasmsg 将消息转为被动消息 主动事件无法使用
+     * @param send 发送消息函数
+     */
+    (type: 'guild', ctx: AdapterQQBotMarkdown, list: Grouping<'guild'>, contact: Contact<'guild' | 'direct'>, pasmsg: (item: Options<'guild'>) => void, send: GuildSend): Promise<SendMsgResults>;
+    /**
+     * QQ场景原生Markdown
+     * @param type 场景类型
+     * @param ctx 适配器实例
+     * @param list 分类列表
+     * @param contact 发送目标
+     * @param pasmsg 将消息转为被动消息 主动事件无法使用
+     * @param send 发送消息函数
+     */
+    (type: 'qq', ctx: AdapterQQBotMarkdown, list: Grouping<'qq'>, contact: Contact<'friend' | 'group'>, pasmsg: (item: Options<'qq'>) => void, send: QQSend): Promise<SendMsgResults>;
+}
+/**
+ * 原生Markdown
+ * @param ctx 适配器实例
+ * @param list 分类列表
+ * @param contact 发送目标
+ * @param pasmsg 将消息转为被动消息 主动事件无法使用
+ * @param send 发送函数
+ */
+export declare const rawMarkdown: RawMarkdown;
+/**
+ * 图文模板
+ * @param ctx 适配器实例
+ * @param list 分类列表
+ * @param contact 发送目标
+ * @param pasmsg 将消息转为被动消息 主动事件无法使用
+ * @param send 发送函数
+ */
+export declare const GraphicTemplateMarkdown: RawMarkdown;
+/**
+ * 纯文模板
+ */
+/**
+ * 自定义处理
+ */

package/lib/core/adapter/handler.js

@@ -0,0 +1,140 @@
+import { escapeMarkdown, getImageSize } from '@/utils/common';
+import { common, fileToUrl, segment } from 'node-karin';
+/**
+ * 原生Markdown
+ * @param ctx 适配器实例
+ * @param list 分类列表
+ * @param contact 发送目标
+ * @param pasmsg 将消息转为被动消息 主动事件无法使用
+ * @param send 发送函数
+ */
+export const rawMarkdown = async (type, ctx, list, contact, pasmsg, send) => {
+    await Promise.all(list.image.map(async (file) => {
+        if (file.startsWith('http')) {
+            const { width, height } = await getImageSize(file);
+            list.content.push(`![karin #${width}px #${height}px](${file})`);
+            return;
+        }
+        const { url, width, height } = await fileToUrl('image', file, 'image.jpg');
+        list.content.push(`![karin #${width}px #${height}px](${url})`);
+    }));
+    /** 将文本转为markdown */
+    list.markdown.push(segment.markdown(list.content.join('')));
+    /** 处理Markdown、按钮 */
+    list.markdownToButton(type, list);
+    /** 返回值 */
+    const rawData = ctx.initSendMsgResults();
+    if (type === 'qq') {
+        if (!list.list.length) {
+            const options = ctx.super.QQdMsgOptions('text', '不支持发送的消息类型');
+            list.list.push(options);
+        }
+        for (const item of list.list) {
+            pasmsg(item);
+            const res = await send(contact.peer, item);
+            rawData.rawData.push(res);
+        }
+        return ctx.handleResponse(rawData);
+    }
+    if (!list.list.length) {
+        const options = ctx.super.GuildMsgOptions('text', '不支持发送的消息类型');
+        list.list.push(options);
+    }
+    for (const item of list.list) {
+        pasmsg(item);
+        const res = await send(contact.peer, contact.subPeer, item);
+        rawData.rawData.push(res);
+    }
+    return ctx.handleResponse(rawData);
+};
+/**
+ * 图文模板
+ * @param ctx 适配器实例
+ * @param list 分类列表
+ * @param contact 发送目标
+ * @param pasmsg 将消息转为被动消息 主动事件无法使用
+ * @param send 发送函数
+ */
+export const GraphicTemplateMarkdown = async (type, ctx, list, contact, pasmsg, send) => {
+    /**
+     * 构建模板键值对
+     * @param index 索引
+     * @param value 值
+     */
+    const KV = (index, value) => {
+        return { key: kv[index], values: [value] };
+    };
+    /** 构建模板 */
+    const tpl = (content, desc, url) => {
+        if (desc && url) {
+            return segment.markdownTpl(id, [KV(0, content), KV(1, desc), KV(2, url)]);
+        }
+        if (desc) {
+            return segment.markdownTpl(id, [KV(1, content), KV(2, desc)]);
+        }
+        return segment.markdownTpl(id, [KV(0, content)]);
+    };
+    /**
+     * 图片转换
+     * @param file 图片文件
+     * @returns 图片链接 | 图片宽度 | 图片高度
+     */
+    const imageHandler = async (file) => {
+        if (file.startsWith('http')) {
+            const { width, height } = await getImageSize(file);
+            return { url: file, width, height };
+        }
+        const data = await fileToUrl('image', file, 'image.jpg');
+        return data;
+    };
+    const { kv, id } = ctx._config.markdown;
+    /** 文本内容 */
+    const content = escapeMarkdown(list.content.join(''));
+    /** 处理第一张图片 一段文本可以跟一个图片 */
+    const img = list.image.shift();
+    if (img) {
+        const { url, width, height } = await imageHandler(img);
+        list.markdownTpl.push(tpl(content, `karin #${width}px #${height}px`, url));
+    }
+    else {
+        list.markdownTpl.push(tpl(content));
+    }
+    /** 处理剩下的图片 单独发送 */
+    await Promise.all(list.image.map(async (file, index) => {
+        await common.sleep(index * 100); // 简单的睡眠 防止乱序
+        const { url, width, height } = await imageHandler(file);
+        list.markdownTpl.push(tpl(`karin #${width}px #${height}px`, url));
+    }));
+    /** 处理Markdown、按钮 */
+    list.markdownToButton(type, list);
+    /** 返回值 */
+    const rawData = ctx.initSendMsgResults();
+    if (type === 'qq') {
+        if (!list.list.length) {
+            const options = ctx.super.QQdMsgOptions('text', '不支持发送的消息类型');
+            list.list.push(options);
+        }
+        for (const item of list.list) {
+            pasmsg(item);
+            const res = await send(contact.peer, item);
+            rawData.rawData.push(res);
+        }
+        return ctx.handleResponse(rawData);
+    }
+    if (!list.list.length) {
+        const options = ctx.super.GuildMsgOptions('text', '不支持发送的消息类型');
+        list.list.push(options);
+    }
+    for (const item of list.list) {
+        pasmsg(item);
+        const res = await send(contact.peer, contact.subPeer, item);
+        rawData.rawData.push(res);
+    }
+    return ctx.handleResponse(rawData);
+};
+/**
+ * 纯文模板
+ */
+/**
+ * 自定义处理
+ */

package/lib/core/adapter/markdown.d.ts

@@ -0,0 +1,38 @@
+import { AdapterQQBot } from '@/core/adapter/adapter';
+import type { QQBotApi } from '@/core/api';
+import type { Contact, ElementTypes, Message, SendMsgResults } from 'node-karin';
+import type { RawMarkdown } from '@/core/adapter/handler';
+import type { Config } from '@/types/config';
+type Cfg = Config[string];
+/** markdown */
+export declare class AdapterQQBotMarkdown extends AdapterQQBot {
+    _config: Cfg;
+    markdown: RawMarkdown;
+    constructor(QQBot: QQBotApi, markdown: RawMarkdown, config: Cfg);
+    srcReply(e: Message, elements: ElementTypes[]): Promise<SendMsgResults>;
+    sendMsg(contact: Contact, elements: Array<ElementTypes>, retryCount?: number): Promise<SendMsgResults>;
+    /**
+     * 处理文本 将文本中的链接转为二维码
+     * @param text 文本
+     * @returns 处理后的文本和二维码 二维码为不带`base64://`的字符串
+     */
+    hendleText(text: string): Promise<{
+        text: string;
+        qr: string | null;
+    }>;
+    /**
+     * 发送QQ私聊、群聊消息
+     * @param contact 联系人
+     * @param elements 消息元素
+     * @param retryCount 重试次数
+     */
+    sendQQMsg(contact: Contact<'friend'> | Contact<'group'>, elements: Array<ElementTypes>, retryCount?: number): Promise<SendMsgResults>;
+    /**
+     * 发送频道消息
+     * @param contact 联系人
+     * @param elements 消息元素
+     * @param retryCount 重试次数
+     */
+    sendGuildMsg(contact: Contact<'guild' | 'direct'>, elements: Array<ElementTypes>, retryCount?: number): Promise<SendMsgResults>;
+}
+export {};