@karinjs/adapter-qqbot 1.0.1

package/lib/core/api.js

@@ -0,0 +1,434 @@
+import got from 'got';
+import WebSocket from 'ws';
+import { Intents } from './intents.js';
+import { common, logger } from 'node-karin';
+export class QQBotApi {
+    /**
+     * 开发者的appId
+     */
+    appId;
+    /**
+     * Bot的昵称
+     */
+    nick;
+    /**
+     * 调用凭证
+     */
+    #access_token;
+    /**
+     * wss地址
+     */
+    wssUrl;
+    /**
+     * 开发者的Secret 仅在内部使用 防止泄露
+     */
+    #Secret;
+    /**
+     * wss连接
+     */
+    wss;
+    seq = 0;
+    /**
+     * 心跳内容
+     */
+    heartbeat;
+    /**
+     * 心跳生命周期 单位：毫秒
+     */
+    heartbeat_interval;
+    /**
+     * 请求头 用于鉴权
+     */
+    headers = {};
+    /**
+     * 基本请求接口
+     */
+    host;
+    #config;
+    constructor(config) {
+        this.#config = config;
+        this.appId = String(this.#config.appId);
+        this.nick = '';
+        this.#Secret = this.#config.secret;
+        this.host = this.#config.sandBox ? this.#config.sandBoxApi : this.#config.qqBotApi;
+        this.#access_token = '';
+        this.wssUrl = '';
+        this.heartbeat = { op: 1, d: null, session_id: '' };
+        this.heartbeat_interval = 0;
+        // 后续处理 重启后重新建立历史会话
+    }
+    logger(level, ...args) {
+        logger.bot(level, this.appId, ...args);
+    }
+    /**
+     * post请求
+     * @param url 请求地址
+     * @param options 请求参数
+     */
+    async post(url, options) {
+        try {
+            return await got.post(url, { json: options, headers: this.headers });
+        }
+        catch (error) {
+            logger.error(`[got] 请求错误: ${JSON.stringify(error.response.body)}`);
+        }
+    }
+    /**
+     * 获取调用凭证
+     * @param clientSecret 开发者的Secret
+     * @param isRefresh 是否是刷新凭证
+     */
+    async getAccessToken(isRefresh = false) {
+        if (isRefresh)
+            this.logger('debug', '凭证即将过期，开始刷新凭证');
+        const url = this.#config.accessTokenApi;
+        const data = await got.post(url, {
+            json: { appId: this.appId, clientSecret: this.#Secret },
+            headers: { 'Content-Type': 'application/json' },
+        }).json();
+        const { expires_in, access_token } = data;
+        this.#access_token = access_token;
+        this.headers = { Authorization: `QQBot ${this.#access_token}`, 'X-Union-Appid': `BOT_${this.appId}` };
+        this.logger('debug', `凭证获取成功: ${JSON.stringify(data)}`);
+        /** 刷新凭证 */
+        const time = Number(expires_in) * 1000 - 50000;
+        setTimeout(async () => {
+            this.getAccessToken(true);
+            /** 重新鉴权 */
+        }, time);
+        return data;
+    }
+    /**
+     * wss鉴权
+     * @param isAuth 是否鉴权
+     */
+    async wssAuth(isAuth) {
+        if (!isAuth) {
+            /** 断连后不需要重新ws鉴权 需要恢复登录态 Session */
+            const data = {
+                op: 6 /* Opcode.Resume */,
+                d: {
+                    token: `QQBot ${this.#access_token}`,
+                    session_id: this.heartbeat.session_id,
+                    seq: this.heartbeat.d || 0,
+                },
+            };
+            this.wss.send(JSON.stringify(data));
+            return;
+        }
+        const intents = Intents(['GROUP_AT_MESSAGE_CREATE']);
+        if (intents === 0)
+            throw new Error('intents 无效，请检查传入的事件名称是否正确');
+        const data = {
+            op: 2 /* Opcode.Identify */,
+            d: {
+                token: `QQBot ${this.#access_token}`,
+                intents,
+                shard: [0, 1],
+                properties: {
+                    $os: 'Linux',
+                    $browser: 'karin-plugin-adapter-qqbot',
+                    $device: 'karin',
+                },
+            },
+        };
+        this.wss.send(JSON.stringify(data));
+    }
+    /**
+     * 获取wss地址
+     */
+    async getWssUrl() {
+        const url = `${this.host}/gateway`;
+        const data = await got.get(url, { headers: this.headers }).json();
+        this.wssUrl = data.url;
+    }
+    /**
+     * 创建wss连接
+     */
+    createWss(isAuth = true) {
+        this.wss = new WebSocket(this.wssUrl);
+        /** 建立连接成功之后 需要鉴权 */
+        this.wss.once('open', () => this.wssAuth(isAuth));
+        /** 监听事件 */
+        this.wss.on('message', (data) => this.payload(data));
+        /** 监听ws关闭 */
+        this.wss.once('close', () => {
+            this.logger('error', 'ws连接关闭，正在重连');
+            /** 回收监听器 */
+            this.wss.removeAllListeners();
+            this.createWss(false);
+        });
+    }
+    payload(payload) {
+        const data = JSON.parse(payload);
+        this.logger('debug', `收到事件推送: ${JSON.stringify(data, null, 2)}`);
+        switch (data.op) {
+            case 0:
+                this.intents(data);
+                this.logger('debug', '事件推送', JSON.stringify(data, null, 2));
+                break;
+            case 1 /* Opcode.Heartbeat */:
+                /** 在指定时间进行回包 */
+                this.wss.send(JSON.stringify({ op: 11, d: null }));
+                this.logger('debug', '心跳', JSON.stringify(data, null, 2));
+                break;
+            case 2 /* Opcode.Identify */:
+                this.logger('info', '鉴权成功', JSON.stringify(data, null, 2));
+                break;
+            case 6 /* Opcode.Resume */:
+                this.logger('info', '客户端恢复连接', JSON.stringify(data, null, 2));
+                break;
+            case 7 /* Opcode.Reconnect */:
+                this.logger('info', '服务端要求重新连接', JSON.stringify(data, null, 2));
+                /** 断开已有ws */
+                this.wss.close();
+                break;
+            case 9 /* Opcode.InvalidSession */:
+                /** 当 identify 或 resume 的时候，如果参数有错，服务端会返回该消息 */
+                this.logger('error', '参数错误', JSON.stringify(data, null, 2));
+                break;
+            case 10 /* Opcode.Hello */:
+                /** 更新生命周期 对声明周期减少3秒 防止过时 */
+                this.heartbeat_interval = data.d.heartbeat_interval - 3000;
+                this.logger('debug', '心跳生命周期更新', JSON.stringify(data, null, 2));
+                break;
+            case 11 /* Opcode.HeartbeatACK */:
+                this.logger('debug', '心跳回包', JSON.stringify(data, null, 2));
+                break;
+            case 12 /* Opcode.HTTPCallbackACK */:
+                /** 仅用于 http 回调模式的回包，代表机器人收到了平台推送的数据 */
+                this.logger('debug', '回包', JSON.stringify(data, null, 2));
+                break;
+        }
+    }
+    /**
+     * 事件处理
+     */
+    async intents(data) {
+        switch (data.t) {
+            case "READY" /* EventType.READY */: {
+                /** 发送第一次心跳 */
+                this.wss.send(JSON.stringify(this.heartbeat));
+                /** 更新心跳唯一值 */
+                this.heartbeat.d = data.s;
+                /** 记录session_id 用于重新连接 */
+                this.heartbeat.session_id = data.d.session_id;
+                /** 心跳 */
+                setInterval(() => this.wss.send(JSON.stringify(this.heartbeat)), this.heartbeat_interval);
+                this.nick = data.d.user.username;
+                this.wss.emit('start');
+                break;
+            }
+            case "GROUP_AT_MESSAGE_CREATE" /* EventType.GROUP_AT_MESSAGE_CREATE */: {
+                this.heartbeat.d = data.s;
+                this.wss.emit("GROUP_AT_MESSAGE_CREATE" /* EventType.GROUP_AT_MESSAGE_CREATE */, data);
+                break;
+            }
+            case "C2C_MESSAGE_CREATE" /* EventType.C2C_MESSAGE_CREATE */: {
+                this.heartbeat.d = data.s;
+                this.wss.emit("C2C_MESSAGE_CREATE" /* EventType.C2C_MESSAGE_CREATE */, data);
+                break;
+            }
+            // case 'GUILD_CREATE':
+            // case 'GUILD_UPDATE':
+            // case 'GUILD_DELETE':
+            // case 'CHANNEL_CREATE':
+            // case 'CHANNEL_UPDATE':
+            // case 'CHANNEL_DELETE':
+            // case 'GUILD_MEMBER_ADD':
+            // case 'GUILD_MEMBER_UPDATE':
+            // case 'GUILD_MEMBER_REMOVE':
+            // case 'MESSAGE_CREATE':
+            // case 'MESSAGE_DELETE':
+            // case 'MESSAGE_REACTION_ADD':
+            // case 'MESSAGE_REACTION_REMOVE':
+            // case 'DIRECT_MESSAGE_CREATE':
+            // case 'DIRECT_MESSAGE_DELETE':
+            // case 'FRIEND_ADD':
+            // case 'FRIEND_DEL':
+            // case 'C2C_MSG_REJECT':
+            // case 'C2C_MSG_RECEIVE':
+            // case 'GROUP_ADD_ROBOT':
+            // case 'GROUP_DEL_ROBOT':
+            // case 'GROUP_MSG_REJECT':
+            // case 'GROUP_MSG_RECEIVE':
+            // case 'INTERACTION_CREATE':
+            // case 'MESSAGE_AUDIT_PASS':
+            // case 'MESSAGE_AUDIT_REJECT':
+            // case 'FORUM_THREAD_CREATE':
+            // case 'FORUM_THREAD_UPDATE':
+            // case 'FORUM_THREAD_DELETE':
+            // case 'FORUM_POST_CREATE':
+            // case 'FORUM_POST_DELETE':
+            // case 'FORUM_REPLY_CREATE':
+            // case 'FORUM_REPLY_DELETE':
+            // case 'FORUM_PUBLISH_AUDIT_RESULT':
+            // case 'AUDIO_START':
+            // case 'AUDIO_FINISH':
+            // case 'AUDIO_ON_MIC':
+            // case 'AUDIO_OFF_MIC':
+            // case 'AT_MESSAGE_CREATE':
+            // case 'PUBLIC_MESSAGE_DELETE':
+            // case 'RESUMED:  {"op":0,"s":53,"t":"RESUMED","d":""} 在客户端恢复连接时收到
+            default:
+                console.log(`Unhandled event: ${JSON.stringify(data)}`);
+        }
+    }
+    /**
+     * 发送消息
+     * @param openid 用户、群openid
+     * @param type 请求路径类型
+     * @param options 请求参数
+     */
+    async sendMessage(openid, type, options) {
+        const url = this.buildUrl(openid, type, "messages" /* V2ApiType.Message */);
+        const result = await this.post(url, options);
+        return JSON.parse(result.body);
+    }
+    /**
+     * 构建发送文本消息请求参数
+     */
+    buildText(content, id, seq) {
+        const options = {
+            content,
+            msg_type: 0 /* MessageType.Text */,
+        };
+        /** id存在 */
+        if (id) {
+            const { key, value } = this.buildId(id);
+            options[key] = value;
+            options["msg_seq" /* SeqType.MsgSeq */] = seq;
+        }
+        return options;
+    }
+    /**
+     * 上传富媒体文件
+     * @param openid 用户、群openid
+     * @param type 请求类型
+     * @param file 文件内容 http、base64、file://
+     * @param file_type 文件类型
+     */
+    async uploadMedia(openid, type, file, file_type) {
+        const options = await this.buildUploadMedia(file, file_type);
+        const url = this.buildUrl(openid, type, "files" /* V2ApiType.Files */);
+        return await got.post(url, options).json();
+    }
+    /**
+     * 构建v2接口请求地址
+     * @param openid 用户、群openid
+     * @param type 请求类型
+     * @param apiType v2接口类型
+     */
+    buildUrl(openid, type, apiType) {
+        return `${this.host}/v2/${type}/${openid}/${apiType}`;
+    }
+    /**
+     * 传入一个msg_id或者event_id 返回其对应的key和value
+     * @param id 消息id或者事件id
+     */
+    buildId(id) {
+        if (id.startsWith(':')) {
+            return { key: "event_id" /* IdType.EventID */, value: id };
+        }
+        else {
+            return { key: "msg_id" /* IdType.MsgID */, value: id };
+        }
+    }
+    /**
+     * 构建发送富媒体请求参数
+     * 富媒体消息只能单独发送 并且必须进行上传
+     * @param file_info 富媒体接口返回的file_info
+     * @param id 消息id或者事件id
+     */
+    buildMedia(file_info, id, seq) {
+        const options = {
+            content: '',
+            msg_type: 7 /* MessageType.Media */,
+            media: {
+                file_info,
+            },
+        };
+        /** id存在 */
+        if (id) {
+            const { key, value } = this.buildId(id);
+            options[key] = value;
+            options["msg_seq" /* SeqType.MsgSeq */] = seq;
+        }
+        return options;
+    }
+    /**
+     * 构建发送Markdown模板请求参数
+     * @param custom_template_id 模板id
+     * @param params 模板参数
+     * @param id 消息id或者事件id
+     * @param seq 消息序号
+     */
+    buildTplMarkdown(custom_template_id, params, keyboard, id, seq) {
+        const options = {
+            msg_type: 2 /* MessageType.Markdown */,
+            content: '',
+            keyboard,
+            markdown: {
+                custom_template_id,
+                params,
+            },
+        };
+        /** id存在 */
+        if (id) {
+            const { key, value } = this.buildId(id);
+            options[key] = value;
+            options["msg_seq" /* SeqType.MsgSeq */] = seq;
+        }
+        return options;
+    }
+    /**
+     * 构建发送原生Markdown请求参数
+     * @param content markdown文本
+     * @param id 消息id或者事件id
+     * @param seq 消息序号
+     */
+    buildRawMarkdown(content, keyboard, id, seq) {
+        const options = {
+            msg_type: 2 /* MessageType.Markdown */,
+            content: '',
+            markdown: { content },
+            keyboard,
+        };
+        /** id存在 */
+        if (id) {
+            const { key, value } = this.buildId(id);
+            options[key] = value;
+            options["msg_seq" /* SeqType.MsgSeq */] = seq;
+        }
+        return options;
+    }
+    /**
+     * 构建上传富媒体请求参数
+     * @param file 文件内容 http、base64、file://
+     * @param file_type 文件类型
+     */
+    async buildUploadMedia(file, file_type) {
+        /** 非http转base64 */
+        if (!file.startsWith('http')) {
+            file = await common.base64(file);
+            return {
+                json: {
+                    /** 发base64，无前缀 */
+                    file_data: file,
+                    file_type,
+                    srv_send_msg: false,
+                },
+                headers: this.headers,
+            };
+        }
+        return {
+            json: {
+                /** http */
+                url: file,
+                file_type,
+                srv_send_msg: false,
+            },
+            headers: this.headers,
+        };
+    }
+}

package/lib/core/index.d.ts

@@ -0,0 +1,92 @@
+import { QQBotApi } from './api.js';
+import { PathType, C2CMessageCreateEvent, GroupAtMessageCreateEvent } from '../types/index.js';
+import { GlobalCfgType, AccountCfgType } from '../utils/index.js';
+import { Contact, LoggerLevel, ReplyReturn, KarinAdapter, KarinElement } from 'node-karin';
+/**
+ * - QQBot适配器
+ */
+export declare class AdapterQQBot implements KarinAdapter {
+    #private;
+    super: QQBotApi;
+    socket: WebSocket;
+    account: KarinAdapter['account'];
+    adapter: KarinAdapter['adapter'];
+    version: KarinAdapter['version'];
+    markdown: GlobalCfgType;
+    constructor(config: AccountCfgType);
+    init(): Promise<void>;
+    _sendNsg(elements: Array<KarinElement>, type: PathType, openid: string, message_id?: string): Promise<ReplyReturn>;
+    get self_id(): string;
+    logger(level: LoggerLevel, ...args: any[]): void;
+    GetVersion(): Promise<{
+        name: string;
+        app_name: string;
+        version: string;
+    }>;
+    /**
+     * QQBot转karin
+     * @return karin格式消息
+     * */
+    AdapterConvertKarin(event: C2CMessageCreateEvent | GroupAtMessageCreateEvent): Array<KarinElement>;
+    /**
+     * karin转qqbot
+     * @param data karin格式消息
+     * */
+    KarinConvertAdapter(data: Array<KarinElement>, type: PathType, openid: string, message_id?: string): Promise<ReplyReturn>;
+    SendMessage(_contact: Contact, elements: Array<KarinElement>): Promise<{
+        message_id: string;
+    }>;
+    getAvatarUrl(): string;
+    getGroupAvatar(): string;
+    GetCurrentAccount(): Promise<{
+        account_uid: string;
+        account_uin: string;
+        account_name: string;
+    }>;
+    GetEssenceMessageList(): Promise<any>;
+    DownloadForwardMessage(): Promise<any>;
+    SetEssenceMessage(): Promise<any>;
+    DeleteEssenceMessage(): Promise<any>;
+    SetFriendApplyResult(): Promise<any>;
+    SetGroupApplyResult(): Promise<any>;
+    SetInvitedJoinGroupResult(): Promise<any>;
+    ReactMessageWithEmoji(): Promise<any>;
+    UploadPrivateFile(): Promise<any>;
+    UploadGroupFile(): Promise<any>;
+    UploadForwardMessage(): Promise<any>;
+    sendForwardMessage(): Promise<any>;
+    SendMessageByResId(): Promise<any>;
+    RecallMessage(): Promise<any>;
+    GetMessage(): Promise<any>;
+    GetHistoryMessage(): Promise<any>;
+    VoteUser(): Promise<any>;
+    KickMember(): Promise<any>;
+    BanMember(): Promise<any>;
+    SetGroupWholeBan(): Promise<any>;
+    SetGroupAdmin(): Promise<any>;
+    ModifyMemberCard(): Promise<any>;
+    ModifyGroupName(): Promise<any>;
+    LeaveGroup(): Promise<any>;
+    SetGroupUniqueTitle(): Promise<any>;
+    GetStrangerProfileCard(): Promise<any>;
+    GetFriendList(): Promise<any>;
+    GetGroupInfo(): Promise<any>;
+    GetGroupList(): Promise<any>;
+    GetGroupMemberInfo(): Promise<any>;
+    GetGroupMemberList(): Promise<any>;
+    GetGroupHonor(): Promise<any>;
+    DownloadFile(): Promise<any>;
+    CreateFolder(): Promise<any>;
+    RenameFolder(): Promise<any>;
+    DeleteFolde(): Promise<any>;
+    DeleteFolder(): Promise<any>;
+    UploadFile(): Promise<any>;
+    DeleteFile(): Promise<any>;
+    GetFileSystemInfo(): Promise<any>;
+    GetFileList(): Promise<any>;
+    ModifyGroupRemark(): Promise<any>;
+    GetRemainCountAtAll(): Promise<any>;
+    GetProhibitedUserList(): Promise<any>;
+    PokeMember(): Promise<any>;
+    SetMessageReaded(): Promise<any>;
+}