qq-official-bot/lib/segment.js

qq机器人开发SDK

"use strict";
/**
 * 消息段工厂函数集合
 * 提供便捷的消息段创建方法
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.segment = void 0;
/**
 * 消息段工厂函数
 */
exports.segment = {
    /**
     * 创建文本消息段
     * @param text 文本内容
     */
    text(text) {
        return {
            type: 'text',
            text
        };
    },
    /**
     * 创建@消息段
     * @param userId 用户ID，传入 'all' 表示@全体成员
     */
    at(userId) {
        return {
            type: 'at',
            user_id: userId
        };
    },
    /**
     * 创建表情消息段
     * @param id 表情ID（0~348）
     * @param text 表情说明文字（可选，接收消息时有效）
     */
    face(id, text) {
        const elem = {
            type: 'face',
            id
        };
        if (text !== undefined) {
            elem.text = text;
        }
        return elem;
    },
    /**
     * 创建图片消息段
     * @param file 图片文件路径、Buffer数据、base64数据或网络地址
     * @param options 可选参数
     */
    image(file, options) {
        const elem = {
            type: 'image',
            file
        };
        if (options?.url) {
            elem.url = options.url;
        }
        if (options?.name) {
            elem.name = options.name;
        }
        return elem;
    },
    /**
     * 创建视频消息段
     * @param file 视频文件路径或网络地址
     * @param options 可选参数
     */
    video(file, options) {
        const elem = {
            type: 'video',
            file
        };
        if (options?.url) {
            elem.url = options.url;
        }
        if (options?.name) {
            elem.name = options.name;
        }
        return elem;
    },
    /**
     * 创建音频消息段
     * @param file 音频文件路径或网络地址
     * @param options 可选参数
     */
    audio(file, options) {
        const elem = {
            type: 'audio',
            file
        };
        if (options?.url) {
            elem.url = options.url;
        }
        if (options?.name) {
            elem.name = options.name;
        }
        return elem;
    },
    /**
     * 创建Markdown消息段
     * @param content Markdown内容或自定义模板ID
     * @param params 模板参数（当第一个参数是模板ID时使用）
     */
    markdown(contentOrTemplateId, params) {
        if (params) {
            // 使用自定义模板
            return {
                type: 'markdown',
                content: null,
                custom_template_id: contentOrTemplateId,
                params
            };
        }
        else {
            // 使用直接内容
            return {
                type: 'markdown',
                content: contentOrTemplateId,
                custom_template_id: null,
                params: null
            };
        }
    },
    /**
     * 创建ARK消息段
     * @param templateId 模板ID
     * @param kv 键值对数据
     */
    ark(templateId, kv) {
        return {
            type: 'ark',
            template_id: templateId,
            kv
        };
    },
    /**
     * 创建Embed消息段
     * @param title 标题
     * @param prompt 描述
     * @param thumbnail 缩略图
     * @param fields 字段列表
     */
    embed(title, prompt, thumbnail, fields) {
        return {
            type: 'embed',
            title,
            prompt,
            htumbnail: thumbnail,
            fields
        };
    },
    /**
     * 创建按钮消息段
     * @param data 按钮数据
     */
    button(data) {
        return {
            type: 'button',
            data
        };
    },
    /**
     * 创建链接消息段
     * @param channelId 频道ID
     */
    link(channelId) {
        return {
            type: 'link',
            channel_id: channelId
        };
    },
    /**
     * 创建回复消息段
     * @param idOrQuotable 消息ID、事件ID或Quotable对象
     */
    reply(idOrQuotable) {
        if (typeof idOrQuotable === 'string') {
            return {
                type: 'reply',
                id: idOrQuotable
            };
        }
        else {
            return {
                type: 'reply',
                ...idOrQuotable
            };
        }
    },
    /**
     * 创建键盘按钮组消息段
     * @param id 按钮组ID
     */
    keyboard(id) {
        return {
            type: 'keyboard',
            id
        };
    }
};
// 为了兼容性，也导出一个默认的segment对象
exports.default = exports.segment;