@karinjs/adapter-qqbot 1.2.10 → 2.0.0

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

@@ -1,91 +0,0 @@
-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

@@ -1,144 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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

@@ -1,140 +0,0 @@
-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

@@ -1,38 +0,0 @@
-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 {};

package/lib/core/adapter/markdown.js

@@ -1,220 +0,0 @@
-import FormData from 'form-data';
-import { handleUrl, qrs, textToButton } from '@/utils/common';
-import { common, fileToUrl, buttonHandle } from 'node-karin';
-import { AdapterQQBot } from '@/core/adapter/adapter';
-/** markdown */
-export class AdapterQQBotMarkdown extends AdapterQQBot {
-    _config;
-    markdown;
-    constructor(QQBot, markdown, config) {
-        super(QQBot);
-        this.markdown = markdown;
-        this._config = config;
-    }
-    async srcReply(e, elements) {
-        const list = await buttonHandle(e.msg, { e });
-        return this.sendMsg(e.contact, [...elements, ...list]);
-    }
-    async sendMsg(contact, elements, retryCount) {
-        if (contact.scene === 'direct' || contact.scene === 'guild') {
-            return this.sendGuildMsg(contact, elements, retryCount);
-        }
-        else if (contact.scene === 'group' || contact.scene === 'friend') {
-            return this.sendQQMsg(contact, elements, retryCount);
-        }
-        throw new Error('不支持的消息类型');
-    }
-    /**
-     * 处理文本 将文本中的链接转为二维码
-     * @param text 文本
-     * @returns 处理后的文本和二维码 二维码为不带`base64://`的字符串
-     */
-    async hendleText(text) {
-        const urls = handleUrl(text);
-        if (!urls.length)
-            return { text, qr: null };
-        urls.forEach((url) => {
-            text = text.replace(new RegExp(url, 'g'), '[请扫码查看]');
-        });
-        const list = await qrs(urls);
-        if (list.length === 1)
-            return { text, qr: list[0] };
-        const result = await common.mergeImage(list, 3);
-        return { text, qr: result.base64 };
-    }
-    /**
-     * 发送QQ私聊、群聊消息
-     * @param contact 联系人
-     * @param elements 消息元素
-     * @param retryCount 重试次数
-     */
-    async sendQQMsg(contact, elements, retryCount) {
-        const list = this.initList('qq');
-        /** 上传富媒体的目标 */
-        const target = contact.scene === 'friend' ? 'user' : 'group';
-        for (const v of elements) {
-            if (v.type === 'text') {
-                const { text, buttons } = textToButton(v.text, contact.scene === 'friend');
-                list.content.push(text);
-                if (buttons)
-                    list.button.push(...buttons);
-                continue;
-            }
-            if (v.type === 'at') {
-                if (contact.scene === 'friend')
-                    continue;
-                list.content.push(v.targetId === 'all' ? '<qqbot-at-everyone />' : `<qqbot-at-user id="${v.targetId}" />`);
-            }
-            if (v.type === 'image') {
-                list.image.push(v.file);
-                continue;
-            }
-            if (v.type === 'pasmsg') {
-                if (v.source === 'event')
-                    list.pasmsg.type = 'event';
-                list.pasmsg.msg_id = v.id;
-                continue;
-            }
-            if (v.type === 'keyboard') {
-                list.keyboard.push(v);
-                continue;
-            }
-            if (v.type === 'button') {
-                list.button.push(v);
-                continue;
-            }
-            if (v.type === 'markdown') {
-                list.markdown.push(v);
-                continue;
-            }
-            if (v.type === 'markdownTpl') {
-                list.markdownTpl.push(v);
-                continue;
-            }
-            if (v.type === 'video' || v.type === 'record') {
-                let url;
-                if (v.file.startsWith('http')) {
-                    url = v.file;
-                }
-                else {
-                    const data = await fileToUrl(v.type, v.file, `${v.type}.${v.type === 'record' ? 'mp3' : 'mp4'}`);
-                    url = data.url;
-                }
-                const res = await this.super.uploadMedia(target, contact.peer, v.type, url, false);
-                list.list.push(this.super.QQdMsgOptions('media', res.file_info));
-                continue;
-            }
-            this.logger('debug', `[QQBot][${v.type}] 不支持发送的消息类型`);
-        }
-        /** 处理被动消息 */
-        const pasmsg = (() => {
-            if (!list.pasmsg.msg_id)
-                return () => '';
-            list.pasmsg.msg_seq++;
-            if (list.pasmsg.type === 'msg') {
-                return (item) => {
-                    item.msg_seq = list.pasmsg.msg_seq;
-                    item.msg_id = list.pasmsg.msg_id;
-                };
-            }
-            return (item) => {
-                item.msg_seq = list.pasmsg.msg_seq;
-                item.event_id = list.pasmsg.msg_id;
-            };
-        })();
-        /** 发送消息 */
-        const send = (() => {
-            if (contact.scene === 'friend') {
-                return (peer, item) => this.super.sendFriendMsg(peer, item);
-            }
-            return (peer, item) => this.super.sendGroupMsg(peer, item);
-        })();
-        return this.markdown('qq', this, list, contact, pasmsg, send);
-    }
-    /**
-     * 发送频道消息
-     * @param contact 联系人
-     * @param elements 消息元素
-     * @param retryCount 重试次数
-     */
-    async sendGuildMsg(contact, elements, retryCount) {
-        const list = this.initList('guild');
-        for (const v of elements) {
-            if (v.type === 'text') {
-                const { text, buttons } = textToButton(v.text, contact.scene === 'direct');
-                list.content.push(text);
-                if (buttons)
-                    list.button.push(...buttons);
-                continue;
-            }
-            if (v.type === 'image') {
-                list.image.push(v.file);
-                continue;
-            }
-            if (v.type === 'at') {
-                if (contact.scene === 'guild') {
-                    list.content.push(v.targetId === 'all' ? '<qqbot-at-everyone />' : `<qqbot-at-user id="${v.targetId}" />`);
-                }
-                continue;
-            }
-            if (v.type === 'pasmsg') {
-                if (v.source === 'event')
-                    list.pasmsg.type = 'event';
-                list.pasmsg.msg_id = v.id;
-                continue;
-            }
-            if (v.type === 'reply') {
-                list.reply.message_id = v.messageId;
-                continue;
-            }
-            if (v.type === 'face') {
-                list.content.push(`<emoji:${v.id}>`);
-                continue;
-            }
-            if (v.type === 'keyboard') {
-                list.keyboard.push(v);
-                continue;
-            }
-            if (v.type === 'button') {
-                list.button.push(v);
-                continue;
-            }
-            if (v.type === 'markdown') {
-                list.markdown.push(v);
-                continue;
-            }
-            if (v.type === 'markdownTpl') {
-                list.markdownTpl.push(v);
-                continue;
-            }
-            this.logger('debug', `[QQBot][${v.type}] 不支持发送的消息类型`);
-        }
-        /** 发送消息 */
-        const send = (() => {
-            if (contact.scene === 'guild') {
-                return (peer, subPeer, item) => this.super.sendChannelMsg(subPeer, item);
-            }
-            return (peer, subPeer, item) => this.super.sendDmsMsg(peer, item);
-        })();
-        /** 处理被动消息 */
-        const pasmsg = (() => {
-            if (!list.pasmsg.msg_id)
-                return () => '';
-            if (list.pasmsg.type === 'msg') {
-                return (item) => {
-                    if (item instanceof FormData) {
-                        return item.append('msg_id', list.pasmsg.msg_id);
-                    }
-                    item.msg_id = list.pasmsg.msg_id;
-                };
-            }
-            return (item) => {
-                if (item instanceof FormData) {
-                    return item.append('event_id', list.pasmsg.msg_id);
-                }
-                item.event_id = list.pasmsg.msg_id;
-            };
-        })();
-        return this.markdown('guild', this, list, contact, pasmsg, send);
-    }
-}