xinc/dist/napcat/Structs.d.ts

基于napcat,node-napcat-ts的bot框架

export interface UnSafeStruct {
    type: string;
    data: {
        [k: string]: any;
    };
}
export interface Receive {
    text: {
        type: 'text';
        data: {
            text: string;
        };
    };
    at: {
        type: 'at';
        data: {
            qq: string | 'all';
        };
    };
    image: {
        type: 'image';
        data: {
            summary: string;
            file: string;
            sub_type: number;
            url: string;
            file_size: string;
        } | {
            summary: string;
            file: string;
            sub_type: string;
            url: string;
            key: string;
            emoji_id: string;
            emoji_package_id: number;
        };
    };
    file: {
        type: 'file';
        data: {
            file: string;
            file_id: string;
            file_size: string;
        };
    };
    poke: {
        type: 'poke';
        data: {
            type: string;
            id: string;
        };
    };
    dice: {
        type: 'dice';
        data: {
            result: string;
        };
    };
    rps: {
        type: 'rps';
        data: {
            result: string;
        };
    };
    face: {
        type: 'face';
        data: {
            id: string;
            raw: {
                faceIndex: number;
                faceText: string;
                faceType: number;
                packId: string;
                stickerId: string;
                sourceType: number;
                stickerType: number;
                resultId: string;
                surpriseId: string;
                randomType: number;
                imageType: null;
                pokeType: null;
                spokeSummary: null;
                doubleHit: null;
                vaspokeId: null;
                vaspokeName: null;
                vaspokeMinver: null;
                pokeStrength: null;
                msgType: null;
                faceBubbleCount: null;
                oldVersionStr: null;
                pokeFlag: null;
                chainCount: number;
            };
            resultId: string | null;
            chainCount: number | null;
        };
    };
    reply: {
        type: 'reply';
        data: {
            id: string;
        };
    };
    video: {
        type: 'video';
        data: {
            file: string;
            url: string;
            file_size: string;
        };
    };
    record: {
        type: 'record';
        data: {
            file: string;
            file_size: string;
        };
    };
    forward: {
        type: 'forward';
        data: {
            id: string;
            content?: Receive[keyof Receive][];
        };
    };
    json: {
        type: 'json';
        data: {
            data: string;
        };
    };
    markdown: {
        type: 'markdown';
        data: {
            content: string;
        };
    };
}
export interface Send {
    text: {
        type: 'text';
        data: {
            text: string;
        };
    };
    at: {
        type: 'at';
        data: {
            qq: string | 'all';
        };
    };
    reply: {
        type: 'reply';
        data: {
            id: string;
        };
    };
    face: {
        type: 'face';
        data: {
            id: string;
        };
    };
    mface: {
        type: 'mface';
        data: {
            emoji_id: string;
            emoji_package_id: string;
            key: string;
            summary?: string;
        };
    };
    image: {
        type: 'image';
        data: {
            file: string;
            summary?: string;
            sub_type?: string;
        };
    };
    file: {
        type: 'file';
        data: {
            file: string;
            name?: string;
        };
    };
    video: {
        type: 'video';
        data: {
            file: string;
            name?: string;
            thumb?: string;
        };
    };
    record: {
        type: 'record';
        data: {
            file: string;
        };
    };
    json: {
        type: 'json';
        data: {
            data: string;
        };
    };
    dice: {
        type: 'dice';
        data: {};
    };
    rps: {
        type: 'rps';
        data: {};
    };
    markdown: {
        type: 'markdown';
        data: {
            content: string;
        };
    };
    music: {
        type: 'music';
        data: {
            type: 'qq' | '163' | 'kugou' | 'kuwo' | 'migu';
            id: string;
        } | {
            type: 'qq' | '163' | 'kugou' | 'kuwo' | 'migu' | 'custom';
            url: string;
            image: string;
            audio?: string;
            title?: string;
            singer?: string;
        };
    };
    node: {
        type: 'node';
        data: ({
            content: Send[keyof Send][];
        } | {
            id: string;
        }) & {
            user_id?: string;
            nickname?: string;
            source?: string;
            news?: {
                text: string;
            }[];
            summary?: string;
            prompt?: string;
            time?: string;
        };
    };
    forward: {
        type: 'forward';
        data: {
            id: string;
        };
    };
    contact: {
        type: 'contact';
        data: {
            type: 'qq' | 'group';
            id: string;
        };
    };
}
export declare const Structs: {
    /**
     * 发送文字消息
     * @param text 要发送的文字
     * @returns { type: 'text', data: { text } }
     */
    text: (text: string) => Send["text"];
    /**
     * @某人
     * @param qq at的QQ号
     * @returns { type: 'at', data: { qq } }
     */
    at: (qq: string | "all" | number) => Send["at"];
    /**
     * 回复消息
     * @param id 回复的消息id
     * @returns { type: 'reply', data: { id } }
     */
    reply: (id: string | number) => Send["reply"];
    /**
     * 发送QQ表情
     * @param id QQ 表情 ID
     * @returns { type: 'face', data: { id, resultId, chainCount } }
     */
    face: (id: string | number) => Send["face"];
    /**
     * 发送QQ表情包
     * @param emoji_id 表情id
     * @param emoji_package_id 表情包id
     * @param key 未知(必要)
     * @param summary 表情简介,可选
     * @returns { type: 'mface', data: { summary, emoji_id, emoji_package_id, key } }
     */
    mface: (emoji_id: string | number, emoji_package_id: string | number, key: string, summary?: string) => Send["mface"];
    /**
     * 发送图片
     * @param file 网络图片地址, 文件路径或者Buffer
     * @param name 图片名
     * @param summary 图片简介
     * @param sub_type 图片类型
     * @returns { type: 'image', data: { file, summary, sub_type } }
     */
    image: (file: string | Buffer, summary?: string, sub_type?: string | number) => Send["image"];
    /**
     * 发文件
     * @param file 网络文件地址, 文件路径或者Buffer
     * @param name 文件名
     * @returns { type: 'file', data: { file, name } }
     */
    file: (file: string | Buffer, name?: string) => Send["file"];
    /**
     * 发视频
     * @param file 网络视频地址, 文件路径或者Buffer
     * @param name 视频名
     * @param thumb 预览图
     * @returns { type: 'video', data: { file, name, thumb } }
     */
    video: (file: string | Buffer, name?: string, thumb?: string) => Send["video"];
    /**
     * 发语音
     * @param file 网络语音地址, 文件路径或者Buffer
     * @param name 语音备注
     * @returns { type: 'record', data: { file, name } }
     */
    record: (file: string | Buffer) => Send["record"];
    /**
     * 发送json消息
     * @param data json信息(序列化后)
     * @returns { type: 'json', data: { data } }
     */
    json: (data: string) => Send["json"];
    /**
     * 发送骰子魔法表情
     * @returns { type: 'dice', data: {} }
     */
    dice: () => Send["dice"];
    /**
     * 发送猜拳魔法
     * @returns { type: 'rps', data: {} }
     */
    rps: () => Send["rps"];
    /**
     * 发送markdown
     * @param data markdown内容
     * @returns { type: 'markdown', data: {} }
     */
    markdown: (content: string) => Send["markdown"];
    /**
     * 音乐分享
     * @param type QQ音乐或网易云音乐QQ音乐
     * @param id 音乐id
     * @returns { type: 'music', data: { type, id } }
     */
    music: (type: "qq" | "163" | "kugou" | "migu" | "kuwo", id: string | number) => Send["music"];
    /**
     * 分享非qq、网易云音乐 需要配置签名服务器
     * @param url 点击后跳转目标 URL
     * @param audio 音乐 URL
     * @param title 标题
     * @param image 发送时可选，内容描述
     * @param singer 发送时可选，图片 URL
     * @returns { type: 'music', data: { type: 'custom', url, audio, title, image, singer } }
     */
    customMusic: (type: "qq" | "163" | "kugou" | "migu" | "kuwo" | "custom", url: string, image: string, audio?: string, title?: string, singer?: string) => Send["music"];
    /**
     * 转发消息节点
     * @param id 消息id
     * @param user_id 消息id
     * @param nickname 消息id
     * @param source 消息id
     * @param id 消息id
     * @param id 消息id
     * @returns { type: 'node', data: { id } }
     */
    node: (id: string | number, user_id?: number | string, nickname?: string, source?: string, news?: {
        text: string;
    }[], summary?: string, prompt?: string, time?: string | number) => Send["node"];
    /**
     * 自定义转发消息节点
     * @param content 消息内容
     * @returns { type: 'node', data: { content } }
     */
    customNode: (content: Send[keyof Send][], user_id?: number | string, nickname?: string, source?: string, news?: {
        text: string;
    }[], summary?: string, prompt?: string, time?: string | number) => Send["node"];
    /**
     * 转发消息
     * @param message_id 消息id
     * @return { type: 'forward', data: { id }}
     */
    forward: (message_id: number) => Send["forward"];
    /**
     * 发送名片
     * @param type 名片类型
     * @param id 联系人QQ号
     * @returns { type: 'contact', data: { id } }
     */
    contact: (type: "qq" | "group", id: number | string) => Send["contact"];
};