@karinjs/adapter-qqbot 1.2.9 → 1.3.1

package/lib/types/message.d.ts

@@ -1,85 +0,0 @@
-import { ArkType, KeyboardType, MarkdownType } from 'node-karin';
-import { MediaType } from './media.js';
-/**
- * 请求路径类型
- */
-export declare const enum PathType {
-    Groups = "groups",
-    Friends = "users"
-}
-/**
- * 消息类型
- */
-export declare const enum MessageType {
-    /**
-     * 文本消息
-     */
-    Text = 0,
-    /**
-     * markdown消息
-     */
-    Markdown = 2,
-    /**
-     * ark消息
-     */
-    Ark = 3,
-    /**
-     * embed消息
-     */
-    Embed = 4,
-    /**
-     * 富媒体消息
-     */
-    Media = 7
-}
-/**
- * v2接口枚举
- */
-export declare const enum V2ApiType {
-    /**
-     * 发送消息
-     */
-    Message = "messages",
-    /**
-     * 上传富媒体文件
-     */
-    Files = "files"
-}
-/**
- * 被动消息ID类型
- */
-export declare const enum IdType {
-    MsgID = "msg_id",
-    EventID = "event_id"
-}
-/**
- * 被动消息Seq
- */
-export declare const enum SeqType {
-    MsgSeq = "msg_seq"
-}
-/**
- * 发送消息请求参数
- */
-export interface SendMessageOptions {
-    /** 文本内容 没有传空格 */
-    content: string;
-    /** 消息类型 */
-    msg_type: MessageType;
-    /** markdown消息 */
-    markdown?: MarkdownType<boolean>;
-    /** keyboard按钮消息 */
-    keyboard?: KeyboardType<boolean>;
-    /** ark消息 */
-    ark?: ArkType;
-    /** 富媒体消息 */
-    media?: MediaType;
-    /** 【暂未支持】消息引用 */
-    message_reference?: object;
-    /** 平台方事件ID，可以用于被动消息发送 */
-    [IdType.EventID]?: string;
-    /** 平台方消息ID，可以用于被动消息发送 */
-    [IdType.MsgID]?: string;
-    /** 回复消息的序号 相同的 msg_id + msg_seq 重复发送会失败 */
-    [SeqType.MsgSeq]?: number;
-}

package/lib/types/message.js

@@ -1 +0,0 @@
-export {};

package/lib/utils/common.d.ts

@@ -1,66 +0,0 @@
-import { ButtonElement } from 'node-karin';
-/**
- * 二维码返回参数
- */
-export interface QRRes {
-    /** 二维码base64 */
-    base64: string;
-    /** 宽度 */
-    width: number;
-    /** 高度 */
-    height: number;
-}
-declare class Common {
-    /** ffmpeg */
-    ffmpeg: string;
-    constructor();
-    random(min: number, max: number): number;
-    /**
-       * 语音转silk
-       * @param voice - 语音文件
-       * @returns silk buffer
-       */
-    voiceToSilk(voice: string): Promise<string>;
-    /**
-       * 初始化ffmpeg
-       */
-    initFfmpeg(): Promise<void>;
-    /**
-       * 处理URL
-       * @param url - URL
-       * @param exclude - 排除的URL
-       */
-    getUrls(url: string, exclude?: never[]): string[];
-    /**
-       * 传入URL数组，转为二维码base64
-       * @param urls - URL数组
-       */
-    getQrCode(urls: string[]): Promise<QRRes>;
-    /**
-       * 传入文本 返回处理后的文本、图片
-       * @param text - 文本
-       */
-    getQQBotText(text: string): Promise<{
-        /** 处理后的文本 */
-        text: string;
-        /** 二维码数据 */
-        data?: QRRes;
-    }>;
-    /**
-     * 传入文本 处理文本 返回的按钮为多行按钮
-     * @param text - 文本
-     */
-    getQQBotButton(text: string): {
-        text: string;
-        data: ButtonElement[];
-    };
-    /**
-     * 传入文本 将文本一些特殊字符转义去除 用于处理markdown
-     * @param text - 文本
-     * @param isC2C - 是否是C2C
-     * @returns 处理后的文本
-     */
-    formatText(text: string, isC2C?: boolean): string;
-}
-export declare const common: Common;
-export {};

package/lib/utils/common.js

@@ -1,210 +0,0 @@
-import fs from 'fs';
-import Jimp from 'jimp';
-import qrcode from 'qrcode';
-import { basename } from './dir.js';
-import { encode, isSilk } from 'silk-wasm';
-import lodash from 'node-karin/lodash';
-import GetUrls from '@karinjs/geturls';
-import { config, execs, logger, common as karinCommon, segment } from 'node-karin';
-import path from 'path';
-class Common {
-    /** ffmpeg */
-    ffmpeg;
-    constructor() {
-        this.ffmpeg = '';
-        this.initFfmpeg();
-    }
-    random(min, max) {
-        return lodash.random(min, max);
-    }
-    /**
-       * 语音转silk
-       * @param voice - 语音文件
-       * @returns silk buffer
-       */
-    async voiceToSilk(voice) {
-        if (!this.ffmpeg)
-            throw TypeError('ffmpeg未安装，请安装 ffmpeg 或者 配置ffmpeg_path');
-        const time = Date.now();
-        const dir = `${process.cwd()}/temp/${basename}/${Date.now()}`;
-        let voicePath = dir;
-        /** 传入的是路径 则直接使用 */
-        if (fs.existsSync(voice)) {
-            const buffer = fs.readFileSync(voice);
-            if (isSilk(buffer))
-                return `base64://${Buffer.from(buffer).toString('base64')}`;
-            voicePath = path.resolve(voice);
-        }
-        else {
-            /** 保存到本地 */
-            const buffer = await karinCommon.buffer(voice);
-            if (isSilk(buffer))
-                return `base64://${Buffer.from(buffer).toString('base64')}`;
-            fs.writeFileSync(dir, buffer);
-        }
-        const pcmPath = `${dir}.pcm`;
-        const silkPath = `${dir}.silk`;
-        const command = `${this.ffmpeg} -i ${voicePath} -f s16le -ar 48000 -ac 1 ${pcmPath}`;
-        await execs(command);
-        logger.info('pcm文件转换成功 开始转码为silk文件');
-        const buffer = await fs.promises.readFile(pcmPath);
-        const silk = await encode(buffer, 48000);
-        logger.info(`silk文件转码成功 音频时长: ${logger.yellow(silk.duration + 'ms')} 转码耗时: ${logger.yellow(Date.now() - time + 'ms')}`);
-        /** dev模式下生成silk文件并保留 */
-        if (process.env.karin_app_mode === 'dev') {
-            await fs.promises.writeFile(silkPath, Buffer.from(silk.data));
-            logger.info(`silk文件已生成: ${logger.yellow(silkPath)}`);
-        }
-        else {
-            /** 非dev删除文件 */
-            fs.promises.unlink(voicePath);
-            fs.promises.unlink(pcmPath);
-        }
-        return `base64://${Buffer.from(silk.data).toString('base64')}`;
-    }
-    /**
-       * 初始化ffmpeg
-       */
-    async initFfmpeg() {
-        try {
-            /** 环境变量 */
-            await execs('ffmpeg -version');
-            this.ffmpeg = 'ffmpeg';
-        }
-        catch {
-            /** 环境变量没有读配置 */
-            const ffmpeg_path = config.Config.ffmpeg_path;
-            if (!ffmpeg_path)
-                return logger.error(logger.red('ffmpeg未安装，请安装 ffmpeg 或者 配置ffmpeg_path'));
-            /** 检查文件是否存在 */
-            if (!fs.existsSync(ffmpeg_path))
-                return logger.error(logger.red('ffmpeg_path配置错误，请检查文件是否存在'));
-            this.ffmpeg = `"${ffmpeg_path}"`;
-        }
-    }
-    /**
-       * 处理URL
-       * @param url - URL
-       * @param exclude - 排除的URL
-       */
-    getUrls(url, exclude = []) {
-        /** 中文不符合url规范 */
-        url = url.replace(/[\u4e00-\u9fa5]/g, '|');
-        const urls = GetUrls.getUrls(url, {
-            exclude,
-            /** 去除 WWW */
-            stripWWW: false,
-            /** 规范化协议 */
-            normalizeProtocol: false,
-            /** 移除查询参数 */
-            removeQueryParameters: false,
-            /** 移除唯一斜杠 */
-            removeSingleSlash: false,
-            /** 查询参数排序 */
-            sortQueryParameters: false,
-            /** 去除认证信息 */
-            stripAuthentication: false,
-            /** 去除文本片段 */
-            stripTextFragment: false,
-            /** 移除末尾斜杠 */
-            removeTrailingSlash: false,
-            /** 不进行标准处理url */
-            normalize: false,
-        });
-        return urls;
-    }
-    /**
-       * 传入URL数组，转为二维码base64
-       * @param urls - URL数组
-       */
-    async getQrCode(urls) {
-        const list = await Promise.all(urls.map(url => qrcode.toDataURL(url)));
-        /** 转为jimp图像对象 */
-        const Jimps = await Promise.all(list.map(url => {
-            return Jimp.read(Buffer.from(url.split(',')[1], 'base64'));
-        }));
-        /** 获取最长的宽高 */
-        const QRwidth = lodash.max(Jimps.map(j => j.bitmap.width)) || Jimps[0].bitmap.width;
-        const Qrheight = lodash.sum(Jimps.map(j => j.bitmap.height));
-        /** 空白区域高度 */
-        const padding = 0;
-        /** 二维码图像加上文字 */
-        const qrImagesWithText = await Promise.all(Jimps.map(async (qrImage) => {
-            /** 增加空白区域 */
-            const newImage = new Jimp(QRwidth, Qrheight + padding, 0xffffffff);
-            /** 将二维码图像放在空白区域下方 */
-            newImage.composite(qrImage, 0, padding);
-            return newImage;
-        }));
-        /** 动态计算每行二维码的数量 */
-        const qrPerRow = Math.ceil(Math.sqrt(urls.length));
-        /** 计算总行数和合并后图像的总宽度和总高度 */
-        const totalRows = Math.ceil(qrImagesWithText.length / qrPerRow);
-        const combinedWidth = QRwidth * qrPerRow;
-        const combinedHeight = (Qrheight + padding) * totalRows;
-        /** 创建合并后的图像对象 */
-        const combinedQRImage = new Jimp(combinedWidth, combinedHeight, 0xffffffff);
-        /** 将二维码图像合并到合并后的图像对象中 */
-        qrImagesWithText.forEach((qrImage, index) => {
-            const x = (index % qrPerRow) * QRwidth;
-            const y = Math.floor(index / qrPerRow) * (Qrheight + padding);
-            combinedQRImage.composite(qrImage, x, y);
-        });
-        /** 转为base64 */
-        const base64 = await combinedQRImage.getBase64Async(Jimp.MIME_PNG);
-        /** 宽高 */
-        const width = combinedQRImage.bitmap.width;
-        const height = combinedQRImage.bitmap.height;
-        return {
-            base64,
-            width,
-            height,
-        };
-    }
-    /**
-       * 传入文本 返回处理后的文本、图片
-       * @param text - 文本
-       */
-    async getQQBotText(text) {
-        const urls = this.getUrls(text);
-        const data = urls.length ? (await this.getQrCode(urls)) : undefined;
-        /** 使用for循环来替换字符串 保证一致性 */
-        for (const url of urls) {
-            text = text.replace(url, '[请扫码查看]');
-        }
-        return {
-            text,
-            data,
-        };
-    }
-    /**
-     * 传入文本 处理文本 返回的按钮为多行按钮
-     * @param text - 文本
-     */
-    getQQBotButton(text) {
-        const urls = this.getUrls(text);
-        const data = [];
-        /** 使用for循环来替换字符串 保证一致性 */
-        for (const url of urls) {
-            text = text.replace(url, '[请点击按钮查看]');
-            data.push(segment.button({ text: url, link: url }));
-        }
-        return {
-            text,
-            data,
-        };
-    }
-    /**
-     * 传入文本 将文本一些特殊字符转义去除 用于处理markdown
-     * @param text - 文本
-     * @param isC2C - 是否是C2C
-     * @returns 处理后的文本
-     */
-    formatText(text, isC2C = false) {
-        text = text.replace(/everyone/g, '').replace(/\n/g, '\r');
-        if (isC2C)
-            text = text.replace(/<qqbot-at-user id=".+" \/>/gm, '').replace(/<@.+>/gm, '');
-        return text;
-    }
-}
-export const common = new Common();

package/lib/utils/config.d.ts

@@ -1,134 +0,0 @@
-/** 机器人发送模式
- * - 0: 直接发送
- * - 1: 原生 Markdown
- * - 3: 旧图文模板 Markdown
- * - 4: 纯文模板 Markdown
- * - 5: 自定义处理
- */
-export type SendMode = 0 | 1 | 3 | 4 | 5;
-/**
- * 全局配置类型定义
- */
-export interface GlobalCfgType {
-    /** 获取调用凭证的 API 地址 */
-    accessTokenApi: string;
-    /** 沙盒环境 API 地址 */
-    sandBoxApi: string;
-    /** 正式环境 API 地址 */
-    qqBotApi: string;
-    /** 是否开启沙盒环境 */
-    sandBox: boolean;
-    /** 机器人发送模式
-     * - 0: 直接发送
-     * - 1: 原生 Markdown
-     * - 3: 旧图文模板 Markdown
-     * - 4: 纯文模板 Markdown
-     * - 5: 自定义处理
-     */
-    sendMode: SendMode;
-    /** 是否开启频道消息 */
-    guild: boolean;
-    /** 频道机器人模式 0-公域机器人 1-私域机器人 */
-    guildMode: 0 | 1;
-    /** 机器人 Markdown 模板 ID，仅在 sendMode 为 3 或 4 时有效 */
-    templateId: string;
-    /** 机器人旧图文模板 Markdown 配置 */
-    oldTemplate: {
-        /** 开头文字的键 */
-        textStartKey: string;
-        /** 图片描述的键 */
-        imgDescKey: string;
-        /** 图片地址的键 */
-        imgUrlKey: string;
-        /** 结尾文字的键 */
-        textEndKey: string;
-    };
-    /** 机器人纯文模板 Markdown 配置，10个文本键 */
-    textTemplate: string[];
-    /** 文本中的 URL 转二维码白名单，配置后将不转换这些 URL 为二维码 */
-    exclude: string[];
-    /** 接受到消息后对文本进行表达式处理，优先级高于全局配置 */
-    regex: Array<{
-        /** 匹配的正则表达式 */
-        reg: RegExp;
-        /** 替换为的内容 */
-        rep: string;
-    }>;
-}
-/**
- * 账号配置类型定义
- */
-export interface AccountCfgType extends GlobalCfgType {
-    /** 机器人 AppID */
-    appId: string;
-    /** 机器人 AppSecret */
-    secret: string;
-}
-/**
- * 配置类型定义
- */
-export interface ConfigType {
-    /**
-     * 全局默认配置
-     */
-    default: GlobalCfgType;
-    /** 账号配置列表 */
-    accounts: Record<string, AccountCfgType>;
-}
-declare class Cfg {
-    /** 配置文件跟路径 */
-    dir: string;
-    /** 默认配置文件根路径 */
-    defdir: string;
-    /** 缓存 不经常用的不建议缓存 */
-    change: Map<string, any>;
-    /** 监听文件 */
-    watcher: Map<string, any>;
-    constructor();
-    /** 初始化配置 */
-    initCfg(): Promise<void>;
-    /**
-   * 更新yaml文件
-   * @param filePath - 文件路径
-   * @param settings - 设置项
-   */
-    updateYaml(filePath: string, settings: {
-        /** 键路径 */
-        key: string;
-        /** 要写入的 */
-        val: any;
-        /** 需要写入的注释 */
-        comment: string;
-        /** 是否添加到顶部 否则添加到同一行 */
-        type: boolean;
-    }[]): void;
-    /**
-     * 基本配置
-     */
-    get Config(): ConfigType;
-    /**
-     * 获取指定Bot配置
-     * @param {string} appID - Bot的AppID
-     */
-    getBotConfig(appID: string): AccountCfgType | null;
-    /**
-     * package
-     */
-    get package(): any;
-    /**
-     * 获取配置yaml
-     */
-    getYaml(type: 'defSet' | 'config', name: string, isWatch?: boolean): any;
-    /**
-     * 监听配置文件
-     * @param {'defSet'|'config'} type 类型
-     * @param {string} name 文件名称 不带后缀
-     * @param {string} file 文件路径
-     */
-    watch(type: 'defSet' | 'config', name: string, file: string): Promise<true | undefined>;
-}
-/**
- * 配置文件
- */
-export declare const config: Cfg;
-export {};

package/lib/utils/config.js

@@ -1,176 +0,0 @@
-import fs from 'fs';
-import Yaml from 'yaml';
-import chokidar from 'node-karin/chokidar';
-import { dirPath, basename } from '../utils/index.js';
-import { logger, YamlEditor } from 'node-karin';
-class Cfg {
-    /** 配置文件跟路径 */
-    dir;
-    /** 默认配置文件根路径 */
-    defdir;
-    /** 缓存 不经常用的不建议缓存 */
-    change;
-    /** 监听文件 */
-    watcher;
-    constructor() {
-        this.dir = `./config/plugin/${basename}`;
-        this.defdir = `${dirPath}/config`;
-        this.change = new Map();
-        this.watcher = new Map();
-        this.initCfg();
-    }
-    /** 初始化配置 */
-    async initCfg() {
-        /** 读取默认配置的所有yaml */
-        const files = fs.readdirSync(this.defdir).filter(file => file.endsWith('.yaml'));
-        for (const file of files) {
-            const dirPath = `${this.dir}/${file}`;
-            const defPath = `${this.defdir}/${file}`;
-            if (!fs.existsSync(dirPath))
-                fs.copyFileSync(defPath, dirPath);
-        }
-        // this.updateYaml(`${this.dir}/config.yaml`, [
-        //   { key: 'a', val: 'value', comment: '实例配置1', type: true },
-        //   { key: 'b.c', val: 'Value', comment: '实例配置2', type: true },
-        // ])
-    }
-    /**
-   * 更新yaml文件
-   * @param filePath - 文件路径
-   * @param settings - 设置项
-   */
-    updateYaml(filePath, settings) {
-        let yaml = new YamlEditor(filePath);
-        /** 先添加内容 */
-        settings.forEach(({ key, val }) => {
-            try {
-                if (!yaml.has(key))
-                    yaml.set(key, val);
-            }
-            catch (error) {
-                logger.error(`[common] 更新yaml文件时出错：${error.stack || error.message || error}`);
-            }
-        });
-        /** 先保存 */
-        yaml.save();
-        /** 重新解析 再次写入注释 直接写入注释会报错 写入的不是node节点模式 */
-        yaml = new YamlEditor(filePath);
-        settings.forEach(({ key, comment, type }) => {
-            try {
-                yaml.comment(key, comment, type);
-            }
-            catch (error) {
-                logger.error(`[common] 更新yaml文件时出错：${error.stack || error.message || error}`);
-            }
-        });
-        yaml.save();
-    }
-    /**
-     * 基本配置
-     */
-    get Config() {
-        const key = 'change.config';
-        const res = this.change.get(key);
-        /** 取缓存 */
-        if (res)
-            return res;
-        /** 取配置 */
-        const config = this.getYaml('config', 'config', true);
-        const defSet = this.getYaml('defSet', 'config', false);
-        const data = {
-            ...defSet,
-            ...config,
-            default: { ...defSet?.default, ...config?.default },
-        };
-        /** 缓存 */
-        this.change.set(key, data);
-        return data;
-    }
-    /**
-     * 获取指定Bot配置
-     * @param {string} appID - Bot的AppID
-     */
-    getBotConfig(appID) {
-        if (!appID)
-            throw new Error('appID不能为空');
-        const key = `change.config.${appID}`;
-        const res = this.change.get(key);
-        /** 取缓存 */
-        if (res)
-            return res;
-        /** 所有配置 */
-        const allCfg = this.Config;
-        /** 取不到 */
-        if (!allCfg?.accounts?.[appID])
-            return null;
-        /** 单个账号配置 */
-        const botCfg = allCfg.accounts[appID];
-        /** 全局默认配置 */
-        const defCfg = allCfg.default;
-        /** 对regex进行处理 */
-        const regex = Array.isArray(botCfg.regex) ? botCfg.regex : defCfg.regex;
-        /** 对表达式进行new RegExp处理 */
-        const regexData = regex.map(({ reg, rep }) => {
-            return {
-                reg: reg instanceof RegExp ? reg : new RegExp(reg),
-                rep,
-            };
-        });
-        const data = {
-            ...defCfg,
-            ...botCfg,
-            sendMode: Number(botCfg.sendMode) || defCfg.sendMode,
-            regex: regexData,
-        };
-        /** 缓存 */
-        this.change.set(key, data);
-        return data;
-    }
-    /**
-     * package
-     */
-    get package() {
-        const data = fs.readFileSync(dirPath + '/package.json', 'utf8');
-        const pkg = JSON.parse(data);
-        return pkg;
-    }
-    /**
-     * 获取配置yaml
-     */
-    getYaml(type, name, isWatch = false) {
-        /** 文件路径 */
-        const file = type === 'defSet' ? `${this.defdir}/${name}.yaml` : `${this.dir}/${name}.yaml`;
-        /** 读取文件 */
-        const data = Yaml.parse(fs.readFileSync(file, 'utf8'));
-        /** 监听文件 */
-        if (isWatch)
-            this.watch(type, name, file);
-        return data;
-    }
-    /**
-     * 监听配置文件
-     * @param {'defSet'|'config'} type 类型
-     * @param {string} name 文件名称 不带后缀
-     * @param {string} file 文件路径
-     */
-    async watch(type, name, file) {
-        const key = `change.${name}`;
-        /** 已经监听过了 */
-        const res = this.change.get(key);
-        if (res)
-            return true;
-        /** 监听文件 */
-        const watcher = chokidar.watch(file);
-        /** 监听文件变化 */
-        watcher.on('change', () => {
-            this.change.delete(key);
-            logger.mark(`[修改配置文件][${type}][${name}]`);
-        });
-        /** 缓存 防止重复监听 */
-        this.watcher.set(key, watcher);
-    }
-}
-/**
- * 配置文件
- */
-export const config = new Cfg();

package/lib/utils/dir.d.ts

@@ -1,5 +0,0 @@
-/** 插件包绝对路径 */
-declare const dirPath: string;
-/** 插件包的名称 */
-declare const basename: any;
-export { dirPath, basename };

package/lib/utils/dir.js

@@ -1,10 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-/** 当前文件的绝对路径 */
-const filePath = fileURLToPath(import.meta.url).replace(/\\/g, '/');
-/** 插件包绝对路径 */
-const dirPath = path.resolve(filePath, '../../../');
-/** 插件包的名称 */
-const basename = JSON.parse(fs.readFileSync(`${dirPath}/package.json`, 'utf-8')).name;
-export { dirPath, basename };

package/lib/utils/index.d.ts

@@ -1,3 +0,0 @@
-export * from './dir.js';
-export * from './common.js';
-export * from './config.js';

package/lib/utils/index.js

@@ -1,3 +0,0 @@
-export * from './dir.js';
-export * from './common.js';
-export * from './config.js';