xinc/dist/napcat/Structs.js

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

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Structs = void 0;
exports.Structs = {
    /**
     * 发送文字消息
     * @param text 要发送的文字
     * @returns { type: 'text', data: { text } }
     */
    text: function (text) {
        return { type: 'text', data: { text } };
    },
    /**
     * @某人
     * @param qq at的QQ号
     * @returns { type: 'at', data: { qq } }
     */
    at: function (qq) {
        return { type: 'at', data: { qq: qq.toString() } };
    },
    /**
     * 回复消息
     * @param id 回复的消息id
     * @returns { type: 'reply', data: { id } }
     */
    reply: function (id) {
        return { type: 'reply', data: { id: id.toString() } };
    },
    /**
     * 发送QQ表情
     * @param id QQ 表情 ID
     * @returns { type: 'face', data: { id, resultId, chainCount } }
     */
    face: function (id) {
        return { type: 'face', data: { id: id.toString() } };
    },
    /**
     * 发送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: function (emoji_id, emoji_package_id, key, summary) {
        return {
            type: 'mface',
            data: {
                summary,
                emoji_id: emoji_id.toString(),
                emoji_package_id: emoji_package_id.toString(),
                key,
            },
        };
    },
    /**
     * 发送图片
     * @param file 网络图片地址, 文件路径或者Buffer
     * @param name 图片名
     * @param summary 图片简介
     * @param sub_type 图片类型
     * @returns { type: 'image', data: { file, summary, sub_type } }
     */
    image: function (file, summary, sub_type) {
        return {
            type: 'image',
            data: {
                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
                summary,
                sub_type: sub_type?.toString(),
            },
        };
    },
    /**
     * 发文件
     * @param file 网络文件地址, 文件路径或者Buffer
     * @param name 文件名
     * @returns { type: 'file', data: { file, name } }
     */
    file: function (file, name) {
        return {
            type: 'file',
            data: {
                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
                name,
            },
        };
    },
    /**
     * 发视频
     * @param file 网络视频地址, 文件路径或者Buffer
     * @param name 视频名
     * @param thumb 预览图
     * @returns { type: 'video', data: { file, name, thumb } }
     */
    video: function (file, name, thumb) {
        return {
            type: 'video',
            data: {
                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
                name,
                thumb,
            },
        };
    },
    /**
     * 发语音
     * @param file 网络语音地址, 文件路径或者Buffer
     * @param name 语音备注
     * @returns { type: 'record', data: { file, name } }
     */
    record: function (file) {
        return {
            type: 'record',
            data: {
                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
            },
        };
    },
    /**
     * 发送json消息
     * @param data json信息(序列化后)
     * @returns { type: 'json', data: { data } }
     */
    json: function (data) {
        return { type: 'json', data: { data } };
    },
    /**
     * 发送骰子魔法表情
     * @returns { type: 'dice', data: {} }
     */
    dice: function () {
        return { type: 'dice', data: {} };
    },
    /**
     * 发送猜拳魔法
     * @returns { type: 'rps', data: {} }
     */
    rps: function () {
        return { type: 'rps', data: {} };
    },
    /**
     * 发送markdown
     * @param data markdown内容
     * @returns { type: 'markdown', data: {} }
     */
    markdown: function (content) {
        return { type: 'markdown', data: { content } };
    },
    /**
     * 音乐分享
     * @param type QQ音乐或网易云音乐QQ音乐
     * @param id 音乐id
     * @returns { type: 'music', data: { type, id } }
     */
    music: function (type, id) {
        return { type: 'music', data: { type, id: id.toString() } };
    },
    /**
     * 分享非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: function (type, url, image, audio, title, singer) {
        return { type: 'music', data: { type, url, audio, title, image, singer } };
    },
    /**
     * 转发消息节点
     * @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: function (id, user_id, nickname, source, news, summary, prompt, time) {
        return {
            type: 'node',
            data: {
                id: id.toString(),
                user_id: user_id?.toString(),
                nickname,
                source,
                news,
                summary,
                prompt,
                time: time?.toString(),
            },
        };
    },
    /**
     * 自定义转发消息节点
     * @param content 消息内容
     * @returns { type: 'node', data: { content } }
     */
    customNode: function (content, user_id, nickname, source, news, summary, prompt, time) {
        return {
            type: 'node',
            data: {
                content,
                user_id: user_id?.toString(),
                nickname,
                source,
                news,
                summary,
                prompt,
                time: time?.toString(),
            },
        };
    },
    /**
     * 转发消息
     * @param message_id 消息id
     * @return { type: 'forward', data: { id }}
     */
    forward: function (message_id) {
        return { type: 'forward', data: { id: message_id.toString() } };
    },
    /**
     * 发送名片
     * @param type 名片类型
     * @param id 联系人QQ号
     * @returns { type: 'contact', data: { id } }
     */
    contact: function (type, id) {
        return { type: 'contact', data: { type, id: id.toString() } };
    },
};
//# sourceMappingURL=Structs.js.map