@karinjs/adapter-qqbot 1.0.1

package/lib/types/event.d.ts

@@ -0,0 +1,232 @@
+import { Attachment } from './media.js';
+/**
+ * opcode
+ * 客户端操作含义如下：
+ * Receive 客户端接收到服务端 push 的消息
+ * Send 客户端发送消息
+ * Reply 客户端接收到服务端发送的消息之后的回包（HTTP 回调模式）
+ */
+export declare const enum Opcode {
+    /** Dispatch [Receive] 服务端进行消息推送 */
+    Dispatch = 0,
+    /** Heartbeat [Send/Receive] 客户端或服务端发送心跳 */
+    Heartbeat = 1,
+    /** Identify [Send] 客户端发送鉴权 */
+    Identify = 2,
+    /** Resume [Send] 客户端恢复连接 */
+    Resume = 6,
+    /** Reconnect [Receive] 服务端通知客户端重新连接 */
+    Reconnect = 7,
+    /** Invalid Session [Receive] 当identify或resume的时候，如果参数有错，服务端会返回该消息 */
+    InvalidSession = 9,
+    /** Hello [Receive] 当客户端与网关建立ws连接之后，网关下发的第一条消息 */
+    Hello = 10,
+    /** Heartbeat ACK [Receive/Reply] 当发送心跳成功之后，就会收到该消息 */
+    HeartbeatACK = 11,
+    /** HTTP Callback ACK [Reply] 仅用于 http 回调模式的回包，代表机器人收到了平台推送的数据 */
+    HTTPCallbackACK = 12
+}
+/**
+ * 心跳生命周期事件
+ */
+export interface HeartbeatEvent {
+    /** opcode */
+    op: Opcode.Hello;
+    /** 事件内容 */
+    d: {
+        /** 心跳声明周期 */
+        heartbeat_interval: number;
+    };
+}
+/**
+ * 心跳回包事件
+ */
+export interface HeartbeatACKEvent {
+    /** opcode */
+    op: Opcode.HeartbeatACK;
+}
+/**
+ * 子事件类型
+ */
+export declare const enum EventType {
+    /** 在鉴权成功后下发 代表建立连接成功 */
+    READY = "READY",
+    /** 恢复登录状态后 不发遗漏事件完毕下发 */
+    RESUMED = "RESUMED",
+    /** 当机器人加入新的guild时 */
+    GUILD_CREATE = "GUILD_CREATE",
+    /** 当guild资料发生变更时 */
+    GUILD_UPDATE = "GUILD_UPDATE",
+    /** 当机器人退出guild时 */
+    GUILD_DELETE = "GUILD_DELETE",
+    /** 当channel被创建时 */
+    CHANNEL_CREATE = "CHANNEL_CREATE",
+    /** 当channel被更新时 */
+    CHANNEL_UPDATE = "CHANNEL_UPDATE",
+    /** 当channel被删除时 */
+    CHANNEL_DELETE = "CHANNEL_DELETE",
+    /** 当成员加入时 */
+    GUILD_MEMBER_ADD = "GUILD_MEMBER_ADD",
+    /** 当成员资料变更时 */
+    GUILD_MEMBER_UPDATE = "GUILD_MEMBER_UPDATE",
+    /** 当成员被移除时 */
+    GUILD_MEMBER_REMOVE = "GUILD_MEMBER_REMOVE",
+    /** 发送消息事件，代表频道内的全部消息，而不只是 at 机器人的消息。内容与 AT_MESSAGE_CREATE 相同 */
+    MESSAGE_CREATE = "MESSAGE_CREATE",
+    /** 删除（撤回）消息事件 */
+    MESSAGE_DELETE = "MESSAGE_DELETE",
+    /** 为消息添加表情表态 */
+    MESSAGE_REACTION_ADD = "MESSAGE_REACTION_ADD",
+    /** 为消息删除表情表态 */
+    MESSAGE_REACTION_REMOVE = "MESSAGE_REACTION_REMOVE",
+    /** 当收到用户发给机器人的私信消息时 */
+    DIRECT_MESSAGE_CREATE = "DIRECT_MESSAGE_CREATE",
+    /** 删除（撤回）消息事件 */
+    DIRECT_MESSAGE_DELETE = "DIRECT_MESSAGE_DELETE",
+    /** 用户单聊发消息给机器人时候 */
+    C2C_MESSAGE_CREATE = "C2C_MESSAGE_CREATE",
+    /** 用户添加使用机器人 */
+    FRIEND_ADD = "FRIEND_ADD",
+    /** 用户删除机器人 */
+    FRIEND_DEL = "FRIEND_DEL",
+    /** 用户在机器人资料卡手动关闭"主动消息"推送 */
+    C2C_MSG_REJECT = "C2C_MSG_REJECT",
+    /** 用户在机器人资料卡手动开启"主动消息"推送开关 */
+    C2C_MSG_RECEIVE = "C2C_MSG_RECEIVE",
+    /** 用户在群里@机器人时收到的消息 */
+    GROUP_AT_MESSAGE_CREATE = "GROUP_AT_MESSAGE_CREATE",
+    /** 机器人被添加到群聊 */
+    GROUP_ADD_ROBOT = "GROUP_ADD_ROBOT",
+    /** 机器人被移出群聊 */
+    GROUP_DEL_ROBOT = "GROUP_DEL_ROBOT",
+    /** 群管理员主动在机器人资料页操作关闭通知 */
+    GROUP_MSG_REJECT = "GROUP_MSG_REJECT",
+    /** 群管理员主动在机器人资料页操作开启通知 */
+    GROUP_MSG_RECEIVE = "GROUP_MSG_RECEIVE",
+    /** 互动事件创建时 */
+    INTERACTION_CREATE = "INTERACTION_CREATE",
+    /** 消息审核通过 */
+    MESSAGE_AUDIT_PASS = "MESSAGE_AUDIT_PASS",
+    /** 消息审核不通过 */
+    MESSAGE_AUDIT_REJECT = "MESSAGE_AUDIT_REJECT",
+    /** 当用户创建主题时 */
+    FORUM_THREAD_CREATE = "FORUM_THREAD_CREATE",
+    /** 当用户更新主题时 */
+    FORUM_THREAD_UPDATE = "FORUM_THREAD_UPDATE",
+    /** 当用户删除主题时 */
+    FORUM_THREAD_DELETE = "FORUM_THREAD_DELETE",
+    /** 当用户创建帖子时 */
+    FORUM_POST_CREATE = "FORUM_POST_CREATE",
+    /** 当用户删除帖子时 */
+    FORUM_POST_DELETE = "FORUM_POST_DELETE",
+    /** 当用户回复评论时 */
+    FORUM_REPLY_CREATE = "FORUM_REPLY_CREATE",
+    /** 当用户回复评论时 */
+    FORUM_REPLY_DELETE = "FORUM_REPLY_DELETE",
+    /** 当用户发表审核通过时 */
+    FORUM_PUBLISH_AUDIT_RESULT = "FORUM_PUBLISH_AUDIT_RESULT",
+    /** 音频开始播放时 */
+    AUDIO_START = "AUDIO_START",
+    /** 音频播放结束时 */
+    AUDIO_FINISH = "AUDIO_FINISH",
+    /** 上麦时 */
+    AUDIO_ON_MIC = "AUDIO_ON_MIC",
+    /** 下麦时 */
+    AUDIO_OFF_MIC = "AUDIO_OFF_MIC",
+    /** 当收到@机器人的消息时 */
+    AT_MESSAGE_CREATE = "AT_MESSAGE_CREATE",
+    /** 当频道的消息被删除时 */
+    PUBLIC_MESSAGE_DELETE = "PUBLIC_MESSAGE_DELETE"
+}
+/**
+ * 子事件基类
+ */
+export interface Event {
+    /** opcode */
+    op: Opcode.Dispatch;
+    /** 序列号 */
+    s: number;
+    /** 事件类型 */
+    t: EventType;
+}
+/**
+ * READY子事件
+ */
+export interface ReadyEvent extends Event {
+    /** 事件类型 */
+    t: EventType.READY;
+    /** 事件内容 */
+    d: {
+        version: number;
+        session_id: string;
+        user: {
+            /** 机器人的user_id */
+            id: string;
+            /** 机器人的nickname */
+            username: string;
+            bot: boolean;
+            status: number;
+        };
+        shard: Number[];
+    };
+}
+/**
+ * C2C_MESSAGE_CREATE子事件
+ */
+export interface C2CMessageCreateEvent extends Event {
+    /** 事件类型 */
+    t: EventType.C2C_MESSAGE_CREATE;
+    /** 平台方消息ID 格式: C2C_MESSAGE_CREATE:abc... */
+    id: string;
+    d: {
+        /** 富媒体消息 */
+        attachments?: Array<Attachment>;
+        /** 发送者信息 */
+        author: {
+            /** 发送者的id 目前版本和user_openid一致 */
+            id: string;
+            /** 发送者的user_openid */
+            user_openid: string;
+        };
+        /** 消息内容 */
+        content: string;
+        /** 消息ID message_id */
+        id: string;
+        /** 消息发送时间 */
+        timestamp: string;
+    };
+}
+/**
+ * GROUP_AT_MESSAGE_CREATE子事件
+ */
+export interface GroupAtMessageCreateEvent extends Event {
+    /** 事件类型 */
+    t: EventType.GROUP_AT_MESSAGE_CREATE;
+    /** 平台方消息ID 格式: GROUP_AT_MESSAGE_CREATE:abc... */
+    id: string;
+    d: {
+        /** 富媒体消息 */
+        attachments?: Array<Attachment>;
+        /** 发送者信息 */
+        author: {
+            /** 发送者的id 目前版本和user_openid一致 */
+            id: string;
+            /** 发送者的user_openid */
+            member_openid: string;
+        };
+        /** 消息内容 */
+        content: string;
+        /** 群ID group_id 目前版本和group_openid一致 */
+        group_id: string;
+        /** 消息ID group_openid */
+        group_openid: string;
+        /** 消息ID message_id */
+        id: string;
+        /** 消息发送时间 */
+        timestamp: string;
+    };
+}
+/**
+ * 所有子事件
+ */
+export type SubEvent = ReadyEvent | C2CMessageCreateEvent | GroupAtMessageCreateEvent;

package/lib/types/event.js

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

package/lib/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './message.js';
+export * from './media.js';
+export * from './event.js';

package/lib/types/index.js

@@ -0,0 +1,3 @@
+export * from './message.js';
+export * from './media.js';
+export * from './event.js';

package/lib/types/media.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 需要注意 目前只有私聊可以收到file类型的消息
+ */
+export type Content_type = 'image/gif' | 'image/jpeg' | 'image/png' | 'file';
+/**
+ * 富媒体文件类型
+ */
+export declare const enum FileType {
+    /**
+     * 图片
+     */
+    Image = 1,
+    /**
+     * 视频
+     */
+    Video = 2,
+    /**
+     * 语音
+     */
+    Record = 3,
+    /**
+     * 文件
+     */
+    File = 4
+}
+/**
+ * 富媒体基类
+ */
+export interface Attachment {
+    /**
+     * 类型
+     */
+    content_type: Content_type;
+    /** 未知作用 */
+    content?: string;
+    /**
+     * 文件名
+     */
+    filename: string;
+    /**
+     * 图片高度
+     */
+    height?: number;
+    /**
+     * 图片宽度
+     */
+    width?: number;
+    /**
+     * 文件大小
+     */
+    size: number;
+    /**
+     * 文件url
+     */
+    url: string;
+}
+/**
+ * 富媒体消息结构
+ */
+export interface MediaType {
+    /** 文件信息 */
+    file_info: string;
+}
+/**
+ * 上传富媒体文件请求参数
+ */
+export interface UploadMediaOptions {
+    /**
+     * 媒体的文件类型
+     * - 1. 图片 png/jpg
+     * - 2. 视频 mp4
+     * - 3. 语音 silk
+     * - 4. 文件
+     */
+    file_type: FileType;
+    /**
+     * 媒体资源的URL
+     */
+    url?: string;
+    /** 不带前缀的base64 */
+    file_data?: string;
+    /**
+     * 是否直接发送消息到目标端
+     * 如果设置为 true，将会消耗主动消息频次
+     */
+    srv_send_msg: boolean;
+}
+/**
+ * 上传富媒体文件返回数据
+ */
+export interface UploadMediaResponse {
+    /** 文件 ID */
+    file_uuid: string;
+    /** 文件信息，用于发消息接口的 media 字段使用 */
+    file_info: string;
+    /** 有效期，表示剩余多少秒到期，到期后 file_info 失效，当等于 0 时，表示可长期使用 */
+    ttl: number;
+    /** 发送消息的唯一ID，当srv_send_msg设置为true时返回 */
+    id?: string;
+}

package/lib/types/media.js

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

package/lib/types/message.d.ts

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

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

package/lib/utils/common.d.ts

@@ -0,0 +1,58 @@
+import { ButtonElement } from 'node-karin';
+/**
+ * 二维码返回参数
+ */
+export interface QRRes {
+    /** 二维码base64 */
+    base64: string;
+    /** 宽度 */
+    width: number;
+    /** 高度 */
+    height: number;
+}
+declare class Common {
+    /** ffmpeg */
+    ffmpeg: string;
+    constructor();
+    /**
+       * 语音转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[];
+    };
+}
+export declare const common: Common;
+export {};

package/lib/utils/common.js

@@ -0,0 +1,195 @@
+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();
+    }
+    /**
+       * 语音转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 = await this.getQrCode(urls);
+        /** 使用for循环来替换字符串 保证一致性 */
+        for (const url of urls) {
+            text = text.replace(url, '[请扫码查看]');
+        }
+        return {
+            text,
+            data: urls.length ? data : undefined,
+        };
+    }
+    /**
+     * 传入文本 处理文本 返回的按钮为多行按钮
+     * @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,
+        };
+    }
+}
+export const common = new Common();