onebots 0.4.22 → 0.4.25

package/lib/adapters/qq/elements.d.ts

@@ -0,0 +1,125 @@
+/// <reference types="node" />
+import { Dict } from './types';
+export declare enum MusicPlatform {
+    qq = "qq",
+    netease = "163"
+}
+export interface Quotable {
+    event_id?: string;
+    message_id?: string;
+}
+export interface MessageElemMap {
+    text: {
+        text: string;
+    };
+    at: {
+        /** 在频道消息中该值为0 */
+        qq: number | "all";
+        /** 频道中的`tiny_id` */
+        id?: string | "all";
+        /** AT后跟的字符串，接收消息时有效 */
+        text?: string;
+        /** 假AT */
+        dummy?: boolean;
+    };
+    face: {
+        /** face为0~348，sface不明 */
+        id: number;
+        /** 表情说明，接收消息时有效 */
+        text?: string;
+        /** 大表情 */
+        qlottie?: string;
+    };
+    image: {
+        /**
+         * @type {string} 本地图片文件路径，例如`"/tmp/1.jpg"`
+         * @type {Buffer} 图片`Buffer`
+         */
+        file: string | Buffer;
+        /** 网络图片是否使用缓存 */
+        cache?: boolean;
+        /** 流的超时时间，默认60(秒) */
+        timeout?: number;
+        headers?: import("http").OutgoingHttpHeaders;
+        /** 图片url地址，接收时有效 */
+        url?: string;
+        /** 是否作为表情发送 */
+        asface?: boolean;
+        /** 是否显示下载原图按钮 */
+        origin?: boolean;
+    };
+    video: {
+        /**
+         * 需要`ffmpeg`和`ffprobe`
+         * @type {string} 本地视频文件路径，例如`"/tmp/1.mp4"`
+         */
+        file: string;
+        /** 视频名，接收时有效 */
+        name?: string;
+        /** 作为文件的文件id，接收时有效 */
+        fid?: string;
+        md5?: string;
+        /** 文件大小，接收时有效 */
+        size?: number;
+        /** 视频时长（秒），接收时有效 */
+        seconds?: number;
+    };
+    audio: {
+        /**
+         * 支持`raw silk`和`amr`文件
+         * @type {string} 本地语音文件路径，例如`"/tmp/1.slk"`
+         * @type {Buffer} ptt buffer (silk or amr)
+         */
+        file: string | Buffer;
+        /** 语言url地址，接收时有效 */
+        url?: string;
+        md5?: string;
+        /** 文件大小，接收时有效 */
+        size?: number;
+        /** 语音时长（秒），接收时有效 */
+        seconds?: number;
+    };
+    xml: {
+        id?: number;
+        data: string;
+    };
+    json: {
+        res_id?: string;
+        data: string | Record<string, any>;
+    };
+    markdown: {
+        content: string;
+    };
+    music: {
+        id: number;
+        platform: MusicPlatform;
+    };
+    reply: Quotable;
+    link: {
+        channel_id: string;
+    };
+    button: {
+        data: Dict;
+    };
+}
+export type MessageElemType = keyof MessageElemMap;
+export type MessageElem<T extends MessageElemType = MessageElemType> = {
+    type: T;
+} & MessageElemMap[T];
+export type TextElem = MessageElem<"text">;
+export type AtElem = MessageElem<"at">;
+export type FaceElem = MessageElem<"face">;
+export type ImageElem = MessageElem<"image">;
+export type VideoElem = MessageElem<"video">;
+export type AudioElem = MessageElem<"audio">;
+export type LinkElem = MessageElem<'link'>;
+export type XmlElem = MessageElem<"xml">;
+export type JsonElem = MessageElem<"json">;
+export type MDElem = MessageElem<'markdown'>;
+export type MusicElem = MessageElem<"music">;
+export type ButtonElem = MessageElem<'button'>;
+export type ReplyElem = MessageElem<"reply">;
+type RepeatableCombineElem = TextElem | FaceElem | ImageElem | AtElem | ButtonElem;
+type WithReply<T extends MessageElem> = T | [T] | [ReplyElem, T] | [ReplyElem, ...RepeatableCombineElem[]];
+export type Sendable = string | RepeatableCombineElem | (RepeatableCombineElem | string)[] | WithReply<MDElem | LinkElem | VideoElem | AudioElem | XmlElem | MusicElem | JsonElem>;
+export {};

package/lib/adapters/qq/elements.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MusicPlatform = void 0;
+var MusicPlatform;
+(function (MusicPlatform) {
+    MusicPlatform["qq"] = "qq";
+    MusicPlatform["netease"] = "163";
+})(MusicPlatform || (exports.MusicPlatform = MusicPlatform = {}));

package/lib/adapters/qq/entries/channel.d.ts

@@ -0,0 +1,17 @@
+import { ChannelSubType, ChannelType, PrivateType, SpeakPermission } from "../constans";
+export declare namespace Channel {
+    interface Info {
+        id: string;
+        guild_id: string;
+        name: string;
+        type: ChannelType;
+        sub_type: ChannelSubType;
+        position: number;
+        parent_id?: string;
+        owner_id: string;
+        private_type: PrivateType;
+        speak_permission: SpeakPermission;
+        application_id?: string;
+        permissions?: string;
+    }
+}

package/lib/adapters/qq/entries/channel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/friend.d.ts

@@ -0,0 +1,8 @@
+import { User } from "./user";
+export declare namespace Friend {
+    interface Info {
+        id: string;
+        user: User.Info;
+        name: string;
+    }
+}

package/lib/adapters/qq/entries/friend.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/group.d.ts

@@ -0,0 +1,6 @@
+export declare namespace Group {
+    interface Info {
+        id: string;
+        name: string;
+    }
+}

package/lib/adapters/qq/entries/group.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/groupMember.d.ts

@@ -0,0 +1,7 @@
+import { User } from "./user";
+export declare namespace GroupMember {
+    interface Info {
+        user: User.Info;
+        group_id: string;
+    }
+}

package/lib/adapters/qq/entries/groupMember.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/guild.d.ts

@@ -0,0 +1,21 @@
+export declare namespace Guild {
+    interface Info {
+        id: string;
+        name: string;
+        icon: string;
+        owner_id: string;
+        owner: boolean;
+        join_time: number;
+        member_count: number;
+        max_members: number;
+        description: string;
+    }
+    interface Role {
+        id: string;
+        name: string;
+        color: string;
+        hoist: boolean;
+        number: number;
+        member_limit: number;
+    }
+}

package/lib/adapters/qq/entries/guild.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/guildMember.d.ts

@@ -0,0 +1,9 @@
+import { User } from "./user";
+export declare namespace GuildMember {
+    interface Info {
+        user: User.Info;
+        nick: string;
+        roles: string[];
+        join_time: number;
+    }
+}

package/lib/adapters/qq/entries/guildMember.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/entries/user.d.ts

@@ -0,0 +1,9 @@
+export declare namespace User {
+    interface Info {
+        id: string;
+        username: string;
+        avatar: string;
+        bot: boolean;
+        public_flag: number;
+    }
+}

package/lib/adapters/qq/entries/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/adapters/qq/event.d.ts

@@ -0,0 +1,28 @@
+import { DirectMessageEvent, GroupMessageEvent, GuildMessageEvent, PrivateMessageEvent } from "./message";
+export declare enum QQEvent {
+    DIRECT_MESSAGE_CREATE = "message.direct",
+    AT_MESSAGE_CREATE = "message.guild",
+    MESSAGE_CREATE = "message.guild",
+    GUILD_CREATE = "notice.guild.increase",
+    GUILD_UPDATE = "notice.guild.update",
+    GUILD_DELETE = "notice.guild.decrease",
+    CHANNEL_CREATE = "notice.channel.increase",
+    CHANNEL_UPDATE = "notice.channel.update",
+    CHANNEL_DELETE = "notice.channel.decrease",
+    GUILD_MEMBER_ADD = "notice.guild.member.increase",
+    GUILD_MEMBER_UPDATE = "notice.guild.member.update",
+    GUILD_MEMBER_REMOVE = "notice.guild.member.decrease",
+    GROUP_ADD_ROBOT = "notice.group.increase",
+    GROUP_DEL_ROBOT = "notice.group.decrease",
+    FRIEND_ADD = "notice.friend.add",
+    FRIEND_DEL = "notice.friend.del",
+    C2C_MESSAGE_CREATE = "message.private",
+    GROUP_AT_MESSAGE_CREATE = "message.group"
+}
+export interface EventMap {
+    'message'(e: PrivateMessageEvent | GroupMessageEvent | GuildMessageEvent | DirectMessageEvent): void;
+    'message.direct'(e: DirectMessageEvent): void;
+    'message.group'(e: GroupMessageEvent): void;
+    'message.private'(e: PrivateMessageEvent): void;
+    'message.guild'(e: GuildMessageEvent): void;
+}

package/lib/adapters/qq/event.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QQEvent = void 0;
+var QQEvent;
+(function (QQEvent) {
+    QQEvent["DIRECT_MESSAGE_CREATE"] = "message.direct";
+    QQEvent["AT_MESSAGE_CREATE"] = "message.guild";
+    QQEvent["MESSAGE_CREATE"] = "message.guild";
+    QQEvent["GUILD_CREATE"] = "notice.guild.increase";
+    QQEvent["GUILD_UPDATE"] = "notice.guild.update";
+    QQEvent["GUILD_DELETE"] = "notice.guild.decrease";
+    QQEvent["CHANNEL_CREATE"] = "notice.channel.increase";
+    QQEvent["CHANNEL_UPDATE"] = "notice.channel.update";
+    QQEvent["CHANNEL_DELETE"] = "notice.channel.decrease";
+    QQEvent["GUILD_MEMBER_ADD"] = "notice.guild.member.increase";
+    QQEvent["GUILD_MEMBER_UPDATE"] = "notice.guild.member.update";
+    QQEvent["GUILD_MEMBER_REMOVE"] = "notice.guild.member.decrease";
+    QQEvent["GROUP_ADD_ROBOT"] = "notice.group.increase";
+    QQEvent["GROUP_DEL_ROBOT"] = "notice.group.decrease";
+    QQEvent["FRIEND_ADD"] = "notice.friend.add";
+    QQEvent["FRIEND_DEL"] = "notice.friend.del";
+    QQEvent["C2C_MESSAGE_CREATE"] = "message.private";
+    QQEvent["GROUP_AT_MESSAGE_CREATE"] = "message.group";
+})(QQEvent || (exports.QQEvent = QQEvent = {}));

package/lib/adapters/qq/index.d.ts

@@ -0,0 +1,35 @@
+import { Adapter } from "../../adapter";
+import { App } from "../../server/app";
+import { OneBot } from "../../onebot";
+export default class QQAdapter extends Adapter<'qq'> {
+    #private;
+    constructor(app: App, config: QQAdapter.Config);
+    startOneBot(oneBot: OneBot): Promise<() => void>;
+    call(uin: string, version: string, method: string, args?: any[]): Promise<any>;
+    fromSegment<V extends OneBot.Version>(version: V, segment: OneBot.Segment<V> | OneBot.Segment<V>[]): OneBot.MessageElement<V>[];
+    toSegment<V extends OneBot.Version>(version: V, message: OneBot.MessageElement<V>[]): OneBot.Segment<V>[];
+    fromCqcode<V extends OneBot.Version>(version: V, message: string): OneBot.MessageElement<V>[];
+    toCqcode<V extends OneBot.Version>(version: V, messageArr: OneBot.MessageElement<V>[]): string;
+    formatEventPayload<V extends OneBot.Version>(version: V, event: string, data: any): OneBot.Payload<V>;
+    start(uin: string): Promise<void>;
+    stop(uin?: string): Promise<void>;
+    getSelfInfo<V extends OneBot.Version>(uin: string, version: V): OneBot.SelfInfo<V>;
+}
+declare module '../../adapter' {
+    namespace Adapter {
+        interface Configs {
+            qq: QQAdapter.Config;
+        }
+    }
+}
+export declare namespace QQAdapter {
+    interface Config extends Adapter.Config<'qq'> {
+        protocol: {
+            secret: string;
+            token: string;
+            sandbox?: boolean;
+            maxRetry?: number;
+            intents?: string[];
+        };
+    }
+}

package/lib/adapters/qq/index.js

@@ -0,0 +1,170 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _QQAdapter_disposes;
+Object.defineProperty(exports, "__esModule", { value: true });
+const adapter_1 = require("../../adapter");
+const onebot_1 = require("../../onebot");
+const bot_1 = require("../../adapters/qq/bot");
+var UnsupportedMethodError = onebot_1.OneBot.UnsupportedMethodError;
+class QQAdapter extends adapter_1.Adapter {
+    constructor(app, config) {
+        super(app, 'qq', config);
+        _QQAdapter_disposes.set(this, new Map());
+    }
+    async startOneBot(oneBot) {
+        const config = this.app.config[`qq.${oneBot.uin}`].protocol;
+        const qqBot = oneBot.internal = new bot_1.Bot(oneBot, oneBot.uin, config);
+        await qqBot.init();
+        const disposeArr = [];
+        const clean = () => {
+            while (disposeArr.length > 0) {
+                disposeArr.pop()();
+            }
+            qqBot.stop();
+        };
+        const _this = this;
+        const messageHandler = (event) => {
+            this.emit('message.receive', oneBot.uin, event);
+        };
+        qqBot.on('message', messageHandler);
+        disposeArr.push(() => {
+            qqBot.off('message', messageHandler);
+        });
+        return clean;
+    }
+    call(uin, version, method, args) {
+        const oneBot = this.oneBots.get(uin);
+        if (!oneBot) {
+            throw new Error(`未找到账号${uin}`);
+        }
+        if (typeof this[method] === 'function')
+            return this[method](uin, version, args);
+        if (typeof oneBot.internal[method] !== 'function')
+            throw UnsupportedMethodError;
+        try {
+            return oneBot.internal[method](...(args || []));
+        }
+        catch (e) {
+            throw new Error(`call internal method error:${e.message}`);
+        }
+    }
+    fromSegment(version, segment) {
+        return [].concat(segment).map(item => {
+            if (typeof item === "string")
+                return {
+                    type: 'text',
+                    data: {
+                        text: item
+                    }
+                };
+            return item;
+        });
+    }
+    toSegment(version, message) {
+        return [].concat(message).map(item => {
+            if (!item || typeof item !== "object")
+                return {
+                    type: 'text',
+                    data: {
+                        text: item
+                    }
+                };
+            const { type, ...data } = item;
+            return {
+                type,
+                data
+            };
+        });
+    }
+    fromCqcode(version, message) {
+        const regExpMatchArray = message.match(/\[CQ:([a-z]+),(!])+]/g);
+        if (!regExpMatchArray)
+            return [
+                {
+                    type: 'text',
+                    data: {
+                        text: message
+                    }
+                }
+            ];
+        const result = [];
+        for (const match of regExpMatchArray) {
+            const [type, ...valueArr] = match.substring(1, match.length - 1).split(',');
+            result.push({
+                type: type,
+                data: Object.fromEntries(valueArr.map(item => {
+                    const [key, value] = item.split('=');
+                    return [key, value];
+                }))
+            });
+        }
+        return result;
+    }
+    toCqcode(version, messageArr) {
+        return [].concat(messageArr).map(item => {
+            const dataStr = Object.entries(item.data).map(([key, value]) => {
+                // is Buffer
+                if (value instanceof Buffer)
+                    return `${key}=${value.toString('base64')}`;
+                // is Object
+                if (value instanceof Object)
+                    return `${key}=${JSON.stringify(value)}`;
+                // is Array
+                if (value instanceof Array)
+                    return `${key}=${value.map(v => JSON.stringify(v)).join(',')}`;
+                // is String
+                return `${key}=${item.data[key]}`;
+            });
+            return `[CQ:${item.type},${dataStr.join(',')}]`;
+        }).join('');
+    }
+    formatEventPayload(version, event, data) {
+        return {
+            id: data.id,
+            type: event,
+            version: version,
+            self: {
+                platform: 'qq',
+                user_id: data.self_id
+            },
+            detail_type: data.message_type || data.notice_type || data.request_type,
+            platform: 'qq',
+            ...data,
+        };
+    }
+    async start(uin) {
+        const startOneBots = [...this.oneBots.values()].filter(oneBot => {
+            return uin ? oneBot.uin === uin : true;
+        });
+        for (const oneBot of startOneBots) {
+            __classPrivateFieldGet(this, _QQAdapter_disposes, "f").set(oneBot.uin, await this.startOneBot(oneBot));
+        }
+        const { protocol } = this.config;
+        await super.start();
+    }
+    async stop(uin) {
+        const stopOneBots = [...this.oneBots.values()].filter(oneBot => {
+            return uin ? oneBot.uin === uin : true;
+        });
+        for (const oneBot of stopOneBots) {
+            const dispose = __classPrivateFieldGet(this, _QQAdapter_disposes, "f").get(oneBot.uin);
+            if (dispose) {
+                dispose();
+            }
+        }
+        await super.stop();
+    }
+    getSelfInfo(uin, version) {
+        const oneBot = this.oneBots.get(uin);
+        return {
+            nickname: oneBot?.internal?.nickname,
+            status: onebot_1.OneBotStatus.Online,
+        };
+    }
+}
+_QQAdapter_disposes = new WeakMap();
+exports.default = QQAdapter;

package/lib/adapters/qq/message.d.ts

@@ -0,0 +1,83 @@
+import { MessageElem, Quotable, Sendable } from "./elements";
+import { QQBot } from "./qqBot";
+import { Dict } from "./types";
+import { Bot } from "./bot";
+export declare class Message {
+    bot: Bot;
+    sub_type: Message.SubType;
+    get self_id(): string;
+    guild_id?: string;
+    channel_id?: string;
+    group_id?: string;
+    message_id: string;
+    sender: Message.Sender;
+    user_id: string;
+    constructor(bot: Bot, attrs: Partial<Message>);
+    raw_message: string;
+    message_reference?: {
+        message_id: string;
+    };
+    message: Sendable;
+    get [Symbol.unscopables](): {
+        bot: boolean;
+    };
+    toJSON(): {
+        [k: string]: any;
+    };
+}
+export interface MessageEvent {
+    reply(message: Sendable, quote?: boolean): Promise<any>;
+}
+export declare class PrivateMessageEvent extends Message implements MessageEvent {
+    constructor(bot: Bot, payload: Partial<Message>);
+    reply(message: Sendable): Promise<{
+        message_id: string;
+        timestamp: number;
+    }>;
+}
+export declare class GroupMessageEvent extends Message implements MessageEvent {
+    group_id: string;
+    group_name: string;
+    constructor(bot: Bot, payload: Partial<Message>);
+    reply(message: Sendable): Promise<{
+        message_id: string;
+        timestamp: number;
+    }>;
+}
+export declare class DirectMessageEvent extends Message implements MessageEvent {
+    user_id: string;
+    channel_id: string;
+    constructor(bot: Bot, payload: Partial<Message>);
+    reply(message: Sendable): Promise<{
+        message_id: string;
+        timestamp: number;
+    }>;
+}
+export declare class GuildMessageEvent extends Message implements MessageEvent {
+    guild_id: string;
+    guild_name: string;
+    channel_id: string;
+    channel_name: string;
+    constructor(bot: Bot, payload: Partial<Message>);
+    asAnnounce(): Promise<any>;
+    pin(): Promise<any>;
+    reply(message: Sendable): Promise<{
+        message_id: string;
+        timestamp: number;
+    }>;
+}
+export declare namespace Message {
+    interface Sender {
+        user_id: string;
+        user_name: string;
+    }
+    type SubType = 'private' | 'group' | 'guild' | 'direct';
+    function parse(this: QQBot, payload: Dict): (string | MessageElem[])[];
+    function format(this: QQBot, message: Sendable, source?: Quotable): Promise<{
+        messages: Dict;
+        hasFiles: boolean;
+        hasMessages: boolean;
+        brief: string;
+        files: Dict;
+    }>;
+}