@polyv/chat 2.1.0-rc-20251023.1

package/index.es.d.ts

@@ -0,0 +1,1934 @@
+import { DataExportRecordData } from '@polyv/vue-components';
+import { EmotionParser } from '@polyv/emotion-sdk';
+import { EventEmitter } from '@polyv/utils/es/event';
+import { PolyvSocket } from '@polyv/socket';
+import { SocketUserType } from '@polyv/socket';
+
+export declare interface AttendanceData extends ChatMessageUser {
+    /**
+     * 排序号
+     */
+    score: number;
+}
+
+export declare interface AttendanceListResult {
+    /**
+     * 列表
+     */
+    list: AttendanceData[];
+    /**
+     * 总数
+     */
+    total: number;
+}
+
+export declare interface BanIpOptions {
+    /** ip */
+    ip: string;
+}
+
+/** 被封禁的 ip 数据 */
+export declare interface BannedIpData {
+    /** ip 地址 */
+    clientIp: string;
+}
+
+export declare interface BannedUserData {
+    /** 用户 id */
+    userId: string;
+    /** 昵称 */
+    nick: string;
+    /** ip 地址 */
+    clientIp: string;
+    /** 是否被平台封禁 */
+    platformProhibited: boolean;
+}
+
+export declare interface BannedUserListOptions {
+    /** 关键词 */
+    keyword?: string;
+    /** 页数 */
+    pageNumber?: number;
+    /** 每页数量 */
+    pageSize?: number;
+}
+
+export declare interface BanUserOptions {
+    /** 用户 id */
+    userId: string;
+}
+
+export declare interface CancelTopMsgOptions {
+    /** 置顶 id */
+    id: number;
+}
+
+/** 支持回复的消息来源 */
+export declare const canQuoteMsgSource: readonly [ChatMsgSource.Speak, ChatMsgSource.Image, ChatMsgSource.File, ChatMsgSource.Redpaper, ChatMsgSource.CustomServer, ChatMsgSource.Emotion];
+
+/** 支持置顶的消息来源 */
+export declare const canTopMsgSource: readonly [ChatMsgSource.Speak];
+
+/**
+ * 频道消息特效设置
+ */
+export declare interface ChannelEffectSetting {
+    /** 访问特效开关 */
+    visitEffectEnabled: boolean;
+    /** 用户访问直播间 */
+    joinVisitEffectTip: string;
+    /** 购买转化特效开关 */
+    productEffectEnabled: boolean;
+    /** 用户点击商品-普通商品 */
+    clickOrdinaryProductEffectTip: string;
+    /** 用户点击商品-金融商品 */
+    clickFinancialProductEffectTip: string;
+    /** 用户点击商品-职位商品 */
+    clickJobProductEffectTip: string;
+    /** 用户下单商品-普通商品 */
+    orderProductEffectTip: string;
+    /** 参与互动特效开关 */
+    interactionEffectEnabled: boolean;
+    /** 用户签到成功 */
+    checkinInteractionEffectTip: string;
+    /** 用户打赏成功特效 */
+    donateInteractionEffectTip: string;
+}
+
+export declare interface ChatDefaultResource {
+    /**
+     * 观众默认头像
+     */
+    defaultViewerAvatar: string;
+}
+
+/**
+ * 聊天室消息中的用户信息
+ */
+export declare interface ChatMessageUser<T extends SocketUserType = SocketUserType> {
+    /**
+     * 用户 id
+     * @description 系统消息或自定义消息中的 userId 固定为 system
+     */
+    userId: string;
+    /**
+     * 昵称
+     */
+    nick: string;
+    /**
+     * 头像
+     */
+    pic?: string;
+    /**
+     * 身份
+     */
+    userType: T;
+    /**
+     * 头衔
+     */
+    actor?: string;
+    /**
+     * 是否被禁言
+     */
+    banned?: boolean;
+    /**
+     * 用户 ip
+     */
+    clientIp?: string;
+    /**
+     * 标签
+     */
+    label?: {
+        /** 提问区标签 */
+        question: string[];
+    };
+}
+
+declare class ChatModuleBase {
+    protected _plvChat: PolyvChat;
+    constructor(_plvChat: PolyvChat);
+    protected get _plvSocket(): PolyvSocket;
+}
+
+/**
+ * 聊天室消息公用基础类型
+ */
+export declare interface ChatMsgCommonBasicType<S extends ChatMsgSource> {
+    /** 消息唯一标识 */
+    id: string;
+    /** 消息来源 */
+    msgSource: S;
+    /** 消息时间 */
+    time: number;
+}
+
+/**
+ * 聊天室消息公用类型
+ */
+export declare interface ChatMsgCommonType<S extends ChatMsgSource> extends ChatMsgCommonBasicType<S> {
+    /** 用户信息 */
+    user: ChatMessageUser;
+}
+
+/**
+ * 聊天室消息类型 - 自定义消息(客户端)
+ * @source {@link ChatMsgSource.CustomClient}
+ */
+export declare interface ChatMsgCustomClientType<D extends object = object> extends ChatMsgCommonType<ChatMsgSource.CustomClient>, CustomClientMsgData<D> {
+}
+
+/**
+ * 聊天室消息类型 - 自定义消息(服务端)
+ * @source {@link ChatMsgSource.CustomServer}
+ */
+export declare interface ChatMsgCustomServerType extends ChatMsgCommonType<ChatMsgSource.CustomServer> {
+    /**
+     * 消息内容
+     */
+    content: string;
+}
+
+/**
+ * 聊天室消息类型 - 特效消息
+ * @source {@link ChatMsgSource.Effect}
+ */
+export declare interface ChatMsgEffectType extends ChatMsgCommonBasicType<ChatMsgSource.Effect> {
+    data: unknown;
+}
+
+/**
+ * 聊天室消息类型 - 表情
+ * @source {@link ChatMsgSource.Emotion}
+ */
+export declare interface ChatMsgEmotionType extends ChatMsgCommonType<ChatMsgSource.Emotion>, ChatMsgSendStatus {
+    /**
+     * 表情 id
+     */
+    emotionId: string;
+    /**
+     * 表情图片地址
+     */
+    emotionUrl: string;
+}
+
+/**
+ * 聊天室消息类型 - 文件分享
+ * @source {@link ChatMsgSource.File}
+ */
+export declare interface ChatMsgFileType extends ChatMsgCommonType<ChatMsgSource.File> {
+    /**
+     * 文件下载地址
+     */
+    fileUrl: string;
+    /**
+     * 文件名称
+     */
+    fileName: string;
+}
+
+/**
+ * 聊天室消息类型 - 图片
+ * @source {@link ChatMsgSource.Image}
+ */
+export declare interface ChatMsgImageType extends ChatMsgCommonType<ChatMsgSource.Image>, ChatMsgSendStatus {
+    /**
+     * 图片 id
+     */
+    imageId: string;
+    /**
+     * 图片地址
+     */
+    imageUrl: string;
+    /**
+     * 图片尺寸
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * 本地发送消息的图片地址
+     */
+    localImageUrl?: string;
+    /**
+     * 是否违规
+     */
+    isIllegal?: boolean;
+}
+
+/**
+ * 课堂激励点赞数据
+ */
+export declare interface ChatMsgMotivationLikeData {
+    /**
+     * 激励者Id
+     */
+    motivatorId: string;
+    /**
+     * 激励者昵称
+     */
+    motivatorNick: string;
+    /**
+     * 被激励者Id
+     */
+    motivatedId: string;
+    /**
+     * 被激励者昵称
+     */
+    motivatedNick: string;
+    /**
+     * 激励点赞类型来源
+     */
+    type: MotivationLikeType;
+}
+
+/**
+ * 聊天室消息类型 - 课堂激励点赞消息
+ * @source {@link ChatMsgSource.MotivationLike}
+ */
+export declare interface ChatMsgMotivationLikeType extends ChatMsgMotivationLikeData, ChatMsgCommonBasicType<ChatMsgSource.MotivationLike> {
+}
+
+/**
+ * 聊天室红包数据类型
+ */
+export declare interface ChatMsgRedpaperData {
+    /** 红包数量 */
+    number: number;
+    /** 祝福语 */
+    content: string;
+    /** 红包类型 */
+    type: RedpackType;
+    /** 红包缓存 id */
+    redCacheId: string;
+    /** 红包 id */
+    redpackId: string;
+    /** 红包总金额 */
+    totalAmount?: number;
+}
+
+/**
+ * 聊天室消息类型 - 红包领取
+ * @source {@link ChatMsgSource.RedpaperReceive}
+ */
+export declare interface ChatMsgRedpaperReceiveType extends ChatMsgCommonBasicType<ChatMsgSource.RedpaperReceive> {
+    /**
+     * 领取用户的昵称
+     */
+    nick: string;
+    /**
+     * 红包类型
+     */
+    type: RedpackType;
+    /**
+     * 是否已领取完毕
+     */
+    isOver: boolean;
+}
+
+/**
+ * 聊天室消息类型 - 红包
+ * @source {@link ChatMsgSource.Redpaper}
+ */
+export declare interface ChatMsgRedpaperType extends ChatMsgCommonType<ChatMsgSource.Redpaper>, ChatMsgRedpaperData {
+    /**
+     * 红包的用户标签 id
+     */
+    userLabels?: number[];
+}
+
+/**
+ * 聊天室消息类型 - 打赏
+ * @source {@link ChatMsgSource.Reward}
+ */
+export declare interface ChatMsgRewardType extends ChatMsgCommonType<ChatMsgSource.Reward> {
+    /**
+     * 打赏礼物图片
+     */
+    gimg: string;
+    /**
+     * 打赏数量
+     */
+    goodNum: number;
+    /**
+     * 打赏类型
+     */
+    donateType: DonateType;
+    /**
+     * 打赏道具名称或现金打赏金额
+     */
+    rewardContent: string;
+    /**
+     * 是否自己的打赏
+     */
+    isSelf: boolean;
+}
+
+/**
+ * 聊天室消息发送状态类型
+ */
+export declare interface ChatMsgSendStatus {
+    /**
+     * 是否本地发送的消息
+     */
+    isLocal?: boolean;
+    /**
+     * 是否已经发送完成
+     * */
+    isSended?: boolean;
+    /**
+     * 是否发送失败
+     */
+    isSendFailed?: boolean;
+}
+
+/**
+ * 聊天消息来源
+ *
+ * 通过聊天室消息事件 `ChatEvents.ChatMessage`、聊天历史记录 Api `getChatHistory` 等获取的聊天消息类型均为 ChatMsgSource 类型
+ * 所有消息数据都有对应的消息来源 `msgSource` 字段，该字段为 `ChatMsgSource` 枚举，开发者可根据该字段显示相应的消息样式。
+ */
+export declare enum ChatMsgSource {
+    /**
+     * 发言消息
+     * @service ✓
+     */
+    Speak = "speak",
+    /**
+     * 图片消息
+     * @service ✓
+     */
+    Image = "image",
+    /**
+     * 表情图片消息
+     * @service ✓
+     */
+    Emotion = "emotion",
+    /**
+     * 打赏消息
+     * @service ✓
+     */
+    Reward = "reward",
+    /**
+     * 文件分享消息
+     * @service ✓
+     */
+    File = "file",
+    /**
+     * 红包消息
+     * @service ✓
+     */
+    Redpaper = "redpaper",
+    /**
+     * 红包领取消息
+     * @service ×
+     */
+    RedpaperReceive = "redpaperReceive",
+    /**
+     * 自定义消息(服务端)
+     * @service ✓
+     */
+    CustomServer = "customServer",
+    /**
+     * 自定义消息(客户端)
+     * @service ✓
+     */
+    CustomClient = "customClient",
+    /**
+     * 系统消息
+     * @service ×
+     */
+    System = "system",
+    /**
+     * 课堂激励点赞消息
+     * @service ×
+     */
+    MotivationLike = "motivationLike",
+    /**
+     * 消息特效
+     * @service ×
+     */
+    Effect = "effect"
+}
+
+/** 支持回复的消息来源 */
+export declare type ChatMsgSourceByQuote = typeof canQuoteMsgSource[number];
+
+/** 支持置顶的消息来源 */
+export declare type ChatMsgSourceByTop = typeof canTopMsgSource[number];
+
+/**
+ * 聊天室消息类型 - 发言
+ * @source {@link ChatMsgSource.Speak}
+ */
+export declare interface ChatMsgSpeakType extends ChatMsgCommonType<ChatMsgSource.Speak>, ChatMsgSendStatus {
+    /**
+     * 发言内容
+     */
+    content: string;
+    /**
+     * 回复内容
+     */
+    quote?: ChatMsgTypeByQuote;
+    /**
+     * 是否超长文本
+     * */
+    isOverLength?: boolean;
+    /**
+     * 当前翻译的语言
+     */
+    translateLanguage?: TranslateLanguage;
+    /**
+     * 各种语言翻译后的内容
+     */
+    translateResult?: TranslatedContents;
+}
+
+/**
+ * 聊天室消息类型 - 系统消息
+ * @source {@link ChatMsgSource.System}
+ */
+export declare interface ChatMsgSystemType extends ChatMsgCommonBasicType<ChatMsgSource.System> {
+    /**
+     * 消息内容
+     */
+    content: string;
+    /**
+     * 系统消息类型
+     */
+    type?: SystemMsgType;
+}
+
+/** 聊天室消息类型 */
+export declare type ChatMsgType = ChatMsgTypeMap[keyof ChatMsgTypeMap];
+
+/** 支持回复的消息类型 */
+export declare type ChatMsgTypeByQuote = ChatMsgTypeMap[ChatMsgSourceByQuote];
+
+/** 支持置顶的消息类型 */
+export declare type ChatMsgTypeByTop = ChatMsgTypeMap[ChatMsgSourceByTop];
+
+/**
+ * 聊天消息绑定关系
+ */
+export declare type ChatMsgTypeMap = {
+    [ChatMsgSource.Speak]: ChatMsgSpeakType;
+    [ChatMsgSource.File]: ChatMsgFileType;
+    [ChatMsgSource.Image]: ChatMsgImageType;
+    [ChatMsgSource.Emotion]: ChatMsgEmotionType;
+    [ChatMsgSource.Reward]: ChatMsgRewardType;
+    [ChatMsgSource.Redpaper]: ChatMsgRedpaperType;
+    [ChatMsgSource.RedpaperReceive]: ChatMsgRedpaperReceiveType;
+    [ChatMsgSource.CustomServer]: ChatMsgCustomServerType;
+    [ChatMsgSource.CustomClient]: ChatMsgCustomClientType;
+    [ChatMsgSource.System]: ChatMsgSystemType;
+    [ChatMsgSource.MotivationLike]: ChatMsgMotivationLikeType;
+    [ChatMsgSource.Effect]: ChatMsgEffectType;
+};
+
+/**
+ * 可用于发送的聊天消息类型
+ */
+export declare type ChatMsgTypeWithSendStatus = ChatMsgSpeakType | ChatMsgEmotionType | ChatMsgImageType;
+
+/**
+ * 聊天请求历史数据模式
+ */
+export declare enum ChatRequestHistoryMode {
+    /** 加载旧数据 */
+    Prev = "prev",
+    /** 加载新数据 */
+    Next = "next"
+}
+
+declare class ChatSocketFilter extends FilterBase {
+    constructor(plvChat: PolyvChat);
+    private __emitChatMessage;
+    /** 过滤回复 */
+    private __filterQuote;
+    /** 过滤发言消息 */
+    private __filterSpeakMsg;
+    /** 过滤发言（文件）sdk 消息 */
+    private __filterFileMsg;
+    /** 过滤图片消息 */
+    private __filterChatImgMsg;
+    /** 过滤表情消息 */
+    private __filterEmotionMsg;
+    /** 过滤打赏消息 */
+    private __filterRewardMsg;
+    /** 过滤红包消息 */
+    private __filterRedpaperMsg;
+    /** 过滤红包领取消息 */
+    private __filterRedpaperReceiveMsg;
+    /** 过滤自定义消息(服务端) */
+    private __filterCustomServerMsg;
+    /** 过滤自定义消息(客户端) */
+    private __filterCustomClientMsg;
+    /** 过滤课堂激励点赞消息 */
+    private __filterMotivationLikeMsg;
+    /** 过滤置顶消息 */
+    __filterSpeakTopMsg(speakTop: InternalSpeakTopData): TopingMsgData[];
+}
+
+/**
+ * 聊天室状态信息
+ */
+export declare interface ChatStatusInfo {
+    /**
+     * 聊天室是否已关闭
+     */
+    chatRoomIsClosed: boolean;
+    /**
+     * 自动翻译的语言语种
+     */
+    autoTranslateLanguage?: TranslateLanguage;
+}
+
+export declare interface ChoiceImageFileSendOptions {
+    /**
+     * 选择图片文件后回调
+     */
+    choiceCallback?: () => void;
+}
+
+/**
+ * 结果类型
+ */
+export declare type CommonResult<FailReason extends string = string, SuccessData extends object = object> = ResultSuccess<SuccessData> | ResultFail<FailReason>;
+
+export declare interface CustomClientMsgData<D extends object = object> {
+    /**
+     * 自定义事件
+     */
+    EVENT: string;
+    /**
+     * 版本
+     */
+    version: number;
+    /**
+     * 自定义数据
+     */
+    data: D;
+    /**
+     * 提示
+     */
+    tips: string;
+    /**
+     * 是否加入历史数据
+     */
+    joinHistoryList: boolean;
+}
+
+export declare interface DeleteMsgOptions {
+    /** 消息唯一标识 */
+    id: string;
+}
+
+/**
+ * 打赏类型
+ */
+export declare enum DonateType {
+    /**
+     * 现金打赏
+     */
+    Cash = "cash",
+    /**
+     * 礼物打赏（包含现金礼物和积分礼物）
+     */
+    Good = "good"
+}
+
+declare class DownloadModule extends ChatModuleBase {
+    private __refId;
+    /**
+     * 设置关联ID
+     * @param refId 关联ID
+     */
+    setRefId(refId: string): void;
+    /**
+     * 获取关联ID
+     */
+    getRefId(): string;
+    /**
+     * 导出到勤/缺勤名单
+     */
+    exportAttendanceList(): Promise<void>;
+    /**
+     * 获取到勤/缺勤导出记录
+     */
+    getAttendanceDownloadRecord(options?: GetAttendanceDownloadRecordOptions): Promise<PageContent<DataExportRecordData>>;
+    /**
+     * 导出在线列表
+     */
+    exportOnlineList(): Promise<void>;
+    /**
+     * 导出白名单观看情况
+     */
+    exportWhiteList(): Promise<void>;
+}
+
+/**
+ * 表情图片数据
+ */
+export declare interface EmotionImageData {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * 名称
+     */
+    title: string;
+    /**
+     * 在线图片地址
+     */
+    url: string;
+}
+
+declare class EmotionModule extends ChatModuleBase {
+    private __emotionParser?;
+    /**
+     * 加载表情解析器
+     */
+    setupEmotionParser(): Promise<void>;
+    /**
+     * 获取黄脸表情节点
+     *
+     * 开发者可通过 `getEmotionFaceDomList` 方法获取节点并插入到页面容器中。
+     *
+     * 监听容器的点击事件并调用 {@link getEmotionFaceClickTarget} 方法可获取观众点击时的黄脸表情。
+     * @returns 黄脸表情 dom 节点
+     * @example
+     * ```js
+     * const containerElem = document.querySelector('容器选择器');
+     * // 插入表情节点
+     * const elems = watchCore.chat.getEmotionFaceDomList();
+     * containerElem.appendChild(elems);
+     * // 监听容器节点的点击事件
+     * containerElem.addEventListener('click', function(event) {
+     *   const title = watchCore.emotion.getEmotionFaceClickTarget(event);
+     *   console.log('点击的表情', title);
+     * });
+     * ```
+     */
+    getEmotionFaceDomList(isZhCN?: boolean): HTMLElement;
+    /**
+     * 获取点击事件中的黄脸表情
+     *
+     * 用于获取观众点击黄脸表情容器时的表情对象，获取后插入到观众正在输入的聊天消息文本中。
+     * @param event 点击事件
+     * @returns 黄脸表情字符
+     * @example
+     * ```js
+     * // 观众正在输入的聊天消息
+     * const inputMsg = '今天天气真好';
+     *
+     * // 监听容器节点的点击事件
+     * containerElem.addEventListener('click', function(event) {
+     *   const title = watchCore.emotion.getEmotionFaceClickTarget(event);
+     *   if (title) {
+     *     console.log('点击的表情', title); // 如：[呲牙]、[害羞]
+     *     inputMsg = inputMsg + title;
+     *   }
+     * });
+     * ```
+     */
+    getEmotionFaceClickTarget(event: Event): string | undefined;
+    /**
+     * 把表情名称转成中文
+     * @param content 发言内容
+     * @returns 转换后的内容
+     * @example
+     * ```js
+     * // 聊天发言内容
+     * let content = '[微笑]';
+     * // 返回转换后的内容
+     * let translatedContent = await chatTarget.emotion.translateEmotions(content);
+     * ```
+     */
+    translateEmotions(content: string, isZhCN?: boolean): string;
+    /**
+     * 获取表情解析器
+     */
+    getEmotionParser(): EmotionParser | undefined;
+    private __getEmotionImagePromise?;
+    /**
+     * 获取表情图片列表
+     */
+    getEmotionImages(): Promise<EmotionImageData[]>;
+}
+
+declare class FilterBase {
+    protected _plvChat: PolyvChat;
+    constructor(_plvChat: PolyvChat);
+    /** 过滤用户昵称 */
+    protected _filterNick(nick: string): string;
+    /** 过滤用户信息 */
+    _filterUser(user: ChatMessageUser): ChatMessageUser;
+}
+
+export declare interface GetAttendanceDownloadRecordOptions {
+    pageNumber?: number;
+    pageSize?: number;
+}
+
+export declare interface GetAttendanceListOptions {
+    /**
+     * 搜索关键词
+     */
+    keyword?: string;
+    /**
+     * 获取数量，传入 `keyword` 时，该选项会失效
+     * @default 10
+     */
+    count?: number;
+    /**
+     * 搜索类型, attendance: 出勤, absence: 缺勤
+     * @default attendance
+     */
+    searchType?: 'attendance' | 'absence';
+    /**
+     * 排序号
+     */
+    score?: number;
+}
+
+export declare interface GetChatHistoryByTimeOptions {
+    /**
+     * 时间戳
+     */
+    timestamp?: number;
+    /**
+     * 时间戳相对应的数量
+     * @default 1
+     */
+    count?: number;
+    /**
+     * 获取的数量
+     * @default 10
+     */
+    size?: number;
+    /**
+     * 排除的消息类型
+     * @description 目前仅支持 {@link ChatMsgSource.CustomServer}、{@link ChatMsgSource.Reward}、{@link ChatMsgSource.Redpaper}
+     */
+    exclude?: ChatMsgSource[];
+    /**
+     * 聊天请求历史数据模式
+     * @default ChatRequestHistoryMode.Prev
+     */
+    mode?: ChatRequestHistoryMode;
+    /**
+     * 是否获取禁言状态
+     * @default false
+     */
+    getBanStatus?: boolean;
+    /**
+     * 是否只获取特殊身份消息
+     * @default false
+     */
+    onlySpecialMsg?: boolean;
+}
+
+export declare interface GetChatHistoryByWorkWechatTagIdOptions {
+    /**
+     * 时间戳
+     */
+    timestamp?: number;
+    /**
+     * 获取的数量
+     * @default 10
+     */
+    size?: number;
+    /**
+     * 聊天请求历史数据模式
+     * @default ChatRequestHistoryMode.Prev
+     */
+    mode?: ChatRequestHistoryMode;
+}
+
+export declare interface GetOnlineListOptions {
+    /**
+     * 搜索关键词
+     */
+    keyword?: string;
+    /**
+     * 获取数量
+     * @default 10
+     */
+    count?: number;
+    /**
+     * 是否获取禁言状态
+     * @default false
+     */
+    getBanStatus?: boolean;
+}
+
+export declare interface GetSpeakOriginalContentOptions {
+    /**
+     * 发言消息
+     */
+    chatMsg: ChatMsgSpeakType;
+}
+
+/**
+ * 历史消息模块
+ */
+declare class HistoryModule extends ChatModuleBase {
+    /**
+     * 聊天历史消息是否加密
+     */
+    private __chatHistoryEncrypt;
+    private __apiFilter;
+    constructor(plvChat: PolyvChat);
+    /**
+     * 设置聊天历史消息是否加密
+     * @param chatHistoryEncrypt 聊天历史消息是否加密
+     */
+    setChatHistoryEncrypt(chatHistoryEncrypt: boolean): void;
+    /**
+     * 根据时间戳获取聊天历史消息
+     * @param options 获取选项
+     */
+    getChatHistoryByTime(options?: GetChatHistoryByTimeOptions): Promise<ChatMsgType[]>;
+    /**
+     * 获取传入到后端接口的 exclude
+     * @param exclude 排除类型数组
+     */
+    private __getHistoryExclude;
+    getChatHistoryByWorkWechatTagId(options?: GetChatHistoryByWorkWechatTagIdOptions): Promise<ChatMsgType[]>;
+}
+
+declare interface InternalSpeakTopData {
+    /** 置顶 id */
+    id: number;
+    /** 置顶操作者头衔 */
+    topActor: string;
+    /** 头衔 */
+    actor: string;
+    /** 发言内容 */
+    content: string;
+    /** 昵称 */
+    nick: string;
+    /** 头像 */
+    pic: string;
+    /** 消息 id */
+    speakId: string;
+    /** 用户 id */
+    userId: string;
+    /** 用户类型 */
+    userType: SocketUserType;
+    /** 另外置顶的消息 */
+    others?: InternalSpeakTopData[];
+}
+
+/** 是否为服务端消息 */
+export declare const isServiceMsgMap: Record<ChatMsgSource, boolean>;
+
+/** 被踢出聊天室的用户数据 */
+export declare interface KickedUserData {
+    /** 用户 id */
+    userId: string;
+    /** 昵称 */
+    nick: string;
+    /** ip 地址 */
+    clientIp: string;
+    /** 是否被平台封禁 */
+    platformProhibited: boolean;
+}
+
+export declare interface KickUserOptions {
+    /** 用户 id */
+    userId: string;
+}
+
+export declare enum ManageFailReason {
+    /** 未知错误 */
+    UnknownError = "UnknownError",
+    /** 已被平台封禁 */
+    PlatformProhibited = "PlatformProhibited"
+}
+
+/**
+ * 管理模块
+ */
+declare class ManageModule extends ChatModuleBase {
+    private __isListened;
+    /**
+     * 监听管理相关事件
+     *
+     * sdk sdk 内部不会自动监听管理事件，如使用管理功能，需要手动触发监听
+     */
+    listenManageEvent(): void;
+    /**
+     * 删除消息
+     * @param options 删除选项
+     */
+    deleteMsg(options: DeleteMsgOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 清空聊天室
+     */
+    clearMsg(): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 禁言用户
+     * @param options 禁言选项
+     */
+    banUser(options: BanUserOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 取消禁言用户
+     * @param options 取消禁言选项
+     */
+    cancelBanUser(options: BanUserOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 获取被禁言的用户列表
+     * @param options 获取被禁言的用户列表选项
+     */
+    getBannedUserList(options?: BannedUserListOptions): Promise<PageContent<BannedUserData>>;
+    /**
+     * 禁言 ip
+     * @param options 禁言选项
+     */
+    banIp(options: BanIpOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 取消禁言 ip
+     * @param options 取消禁言选项
+     */
+    cancelBanIp(options: BanIpOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 获取已被禁言的 ip 列表
+     */
+    getBannedIpList(): Promise<{
+        contents: BannedIpData[];
+    }>;
+    /**
+     * 踢出用户
+     * @param options 踢出选项
+     */
+    kickUser(options: KickUserOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 取消踢出用户
+     * @param options 取消踢出选项
+     */
+    cancelKickUser(options: KickUserOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 获取被踢出聊天室的用户列表
+     */
+    getKickedUserList(): Promise<{
+        contents: KickedUserData[];
+    }>;
+    /**
+     * 激励点赞
+     * @param options 激励点赞选项
+     */
+    motivateLike(options: MotivateLikeOptions): Promise<void>;
+    /**
+     * 置顶消息
+     * @param options 置顶选项
+     */
+    topMsg(options: TopMsgOptions): Promise<void>;
+    /**
+     * 取消置顶消息
+     * @param options 取消置顶选项
+     */
+    cancelTopMsg(options: CancelTopMsgOptions): Promise<void>;
+    /**
+     * 设置聊天室全体禁言
+     * @param options 设置选项
+     */
+    setChatSwitch(options: SetChatSwitchOptions): Promise<CommonResult<ManageFailReason>>;
+    /**
+     * 推送发言消息到问答
+     * @param options 推送选项
+     */
+    pushMsgToQa(options: PushMsgToQaOptions): Promise<CommonResult<ManageFailReason>>;
+}
+
+/**
+ * 消息模块
+ */
+declare class MessageModule extends ChatModuleBase {
+    /** 置顶中的消息 */
+    topingMsgs: TopingMsgData[];
+    constructor(plvChat: PolyvChat);
+    /**
+     * 是否为服务端消息
+     * @param chatMsg 聊天消息
+     * @returns 是否为服务端消息
+     */
+    isServiceMsg(chatMsg: ChatMsgType): boolean;
+    /**
+     * 是否可被引用回复
+     * @param chatMsg 聊天消息
+     * @returns 是否可被引用回复
+     */
+    canQuoteMsg(chatMsg: ChatMsgType): chatMsg is ChatMsgTypeByQuote;
+    /**
+     * 是否可被置顶
+     * @param chatMsg 聊天消息
+     * @returns 是否可被置顶
+     */
+    canTopMsg(chatMsg: ChatMsgType): chatMsg is ChatMsgTypeByTop;
+    /**
+     * 转换发言内容
+     *
+     * 通过 `parseSpeakContent` 将观众发言中的表情、链接转换成 html 元素。
+     *
+     * 转换顺序：parseLink > removeEmotion > parseEmotion > parseLineBreak
+     * @param content 发言内容
+     * @param options 转换选项
+     * @returns 转换后的 html 字符
+     * @example
+     * ```js
+     * // 转换链接
+     * plvChat.message.parseSpeakContent('这是我们的官网地址：https://www.polyv.net/', { parseLink: true });
+     * // 转换后的字符串：这是我们的官网地址：<a target="_blank" rel="noopener" href="https://www.polyv.net/">https://www.polyv.net/</a>
+     *
+     * // 移除表情
+     * plvChat.message.parseSpeakContent('今天天气真好[呲牙]', { removeEmotion: true });
+     * // 转换后的字符串：今天天气真好
+     *
+     * // 转换表情
+     * plvChat.message.parseSpeakContent('今天天气真好[呲牙]', { parseEmotion: true });
+     * // 转换后的字符串：今天天气真好<img src="黄脸表情图片地址" alt="呲牙" class="plv-emotion-img" />
+     *
+     * // 将换行符转成 <br />
+     * plvChat.message.parseSpeakContent('这是一段文字\n这是另一段文字', { parseLineBreak: true });
+     * // 转换后的字符串：这是一段文字<br />这是另一段文字
+     * ```
+     */
+    parseSpeakContent(content: string, options?: ParseOptions): string;
+    /**
+     * 完整的消息文本记录对象
+     */
+    private __fullMessageRecord;
+    /**
+     * 获取超长消息的完整文本
+     *
+     * 讲师可发送超过 2000 字的文本消息，该消息为超长文本消息（通过 `chatMsg.isOverLength === true` 判断），`chat` 提供消息文本只会返回前 1000 字的消息字符串，如需展示完整的消息文本，可调用该方法获取。
+     * @param id 聊天消息 id
+     * @param chatMsg 聊天消息，在未超过服务端聊天文本长度或者请求异常时会使用聊天消息内容返回 [v0.11.0 新增]
+     * @example
+     * ```ts
+     * import { ChatMsgSpeakType } from '@polyv/live-watch-sdk';
+     *
+     * async function getFullMessageText(chatMsg: ChatMsgSpeakType): Promise<string> {
+     *   if (!chatMsg.isOverLength) {
+     *     throw new Error('该消息非超长文本');
+     *   }
+     *
+     *   const result = await plvChat.message.getFullMessage(chatMsg.id, chatMsg);
+     *   console.log('完整的文本', result);
+     *   return result;
+     * }
+     * ```
+     */
+    getFullMessage(chatMsg: ChatMsgSpeakType): Promise<string>;
+    /**
+     * 翻译发言消息
+     * @param options 翻译选项
+     */
+    translateSpeak(options: TranslateSpeakOptions): Promise<TranslateSpeakResult>;
+    /**
+     * 获取发言消息的原始内容
+     * @param options 选项
+     */
+    getSpeakOriginalContent(options: GetSpeakOriginalContentOptions): Promise<string | undefined>;
+}
+
+export declare interface MotivateLikeOptions {
+    /**
+     * 激励类型
+     */
+    type?: MotivationLikeType;
+    /**
+     * 被激励者Id
+     */
+    motivatedId: string;
+    /**
+     * 消息 id
+     */
+    chatMsgId?: string;
+}
+
+/** 激励类型来源 */
+export declare enum MotivationLikeType {
+    /** 消息发言 */
+    Speak = "speak",
+    /** 连麦 */
+    Mic = "mic"
+}
+
+export declare interface OnlineListResult {
+    /** 在线总人数 */
+    total: number;
+    /** 在线列表 */
+    onlineList: ChatMessageUser[];
+}
+
+declare class OnlineModule extends ChatModuleBase {
+    /**
+     * 获取在线列表
+     * @param options 获取选项
+     */
+    getOnlineList(options?: GetOnlineListOptions): Promise<OnlineListResult>;
+    private __getOnlineListByKeyword;
+    /**
+     * 获取在线列表（普通）
+     */
+    private __getOnlineListByNormal;
+    /**
+     * 获取到勤/缺勤列表
+     * @param options 获取选项
+     */
+    getAttendanceList(options: GetAttendanceListOptions): Promise<AttendanceListResult>;
+}
+
+/**
+ * 分页数据
+ */
+export declare interface PageContent<I = unknown> {
+    /** 当前页数 */
+    pageNumber: number;
+    /** 每页数量 */
+    pageSize: number;
+    /** 总记录数 */
+    totalItems: number;
+    /** 总页数 */
+    totalPages: number;
+    /** 内容列表 */
+    contents: I[];
+}
+
+/**
+ * 转换选项
+ */
+export declare interface ParseOptions {
+    /**
+     * 是否转换链接
+     * @default false
+     */
+    parseLink?: boolean;
+    /**
+     * 移除表情内容
+     * @default false
+     */
+    removeEmotion?: boolean;
+    /**
+     * 是否转换表情
+     * @default false
+     */
+    parseEmotion?: boolean;
+    /**
+     * 是否转换换行符
+     * @default false
+     */
+    parseLineBreak?: boolean;
+}
+
+/** 根据来源获取聊天消息类型 */
+export declare type PickChatMsgType<S extends ChatMsgSource> = ChatMsgTypeMap[S];
+
+export declare class PolyvChat {
+    plvSocket: PolyvSocket;
+    config: PolyvChatConfig;
+    PolyvChatEvent: typeof PolyvChatEvent;
+    ChatMsgSource: typeof ChatMsgSource;
+    DonateType: typeof DonateType;
+    RedpackType: typeof RedpackType;
+    SystemMsgType: typeof SystemMsgType;
+    ChatRequestHistoryMode: typeof ChatRequestHistoryMode;
+    ManageFailReason: typeof ManageFailReason;
+    TranslateLanguage: typeof TranslateLanguage;
+    eventEmitter: EventEmitter<PolyvChatEventRelations, PolyvChatEvent>;
+    __socketFilter: ChatSocketFilter;
+    private __socketHandler;
+    /** 表情模块 */
+    emotion: EmotionModule;
+    /** 历史消息模块 */
+    history: HistoryModule;
+    /** 消息模块 */
+    message: MessageModule;
+    /** 状态模块 */
+    status: StatusModule;
+    /** 工具模块 */
+    utils: UtilsModule;
+    /** 发送模块 */
+    sender: SenderModule;
+    /** 管理模块 */
+    manage: ManageModule;
+    /** 在线列表模块 */
+    online: OnlineModule;
+    /** 下载导出模块 */
+    download: DownloadModule;
+    constructor(plvSocket: PolyvSocket, config?: PolyvChatConfig);
+    /** 是否设置完成 */
+    setuped: boolean;
+    /**
+     * 设置聊天室
+     */
+    setup(): Promise<void>;
+}
+
+export declare interface PolyvChatConfig {
+    /**
+     * 频道消息特效设置
+     */
+    effectSetting?: ChannelEffectSetting;
+    /**
+     * 聊天历史消息是否加密
+     * @default false
+     */
+    chatHistoryEncrypt?: boolean;
+}
+
+export declare enum PolyvChatEvent {
+    /**
+     * 聊天室初始完成
+     */
+    ChatInitialized = "ChatInitialized",
+    /**
+     * 状态信息更新事件
+     */
+    StatusInfoUpdate = "StatusInfoUpdate",
+    /**
+     * 聊天消息事件
+     */
+    ChatMessage = "ChatMessage",
+    /**
+     * 删除某条聊天消息
+     */
+    RemoveChatMsg = "RemoveChatMsg",
+    /**
+     * 清空聊天室
+     */
+    ClearMsgHistory = "ClearMsgHistory",
+    /**
+     * 关闭聊天室
+     */
+    CloseChatRoom = "CloseChatRoom",
+    /**
+     * 打开聊天室
+     */
+    OpenChatRoom = "OpenChatRoom",
+    /**
+     * 替换聊天消息事件
+     */
+    ReplaceChatMessage = "ReplaceChatMessage",
+    /**
+     * 当前观众发送消息
+     */
+    SelfSendMessage = "SelfSendMessage",
+    /**
+     * 用户被禁言
+     */
+    UserBanned = "UserBanned",
+    /**
+     * 用户被取消禁言
+     */
+    UserCancelBanned = "UserCancelBanned",
+    /**
+     * ip 被禁言
+     */
+    IpBanned = "IpBanned",
+    /**
+     * ip 被取消禁言
+     */
+    IpCancelBanned = "IpCancelBanned",
+    /**
+     * 用户被踢出聊天室
+     */
+    UserKicked = "UserKicked",
+    /**
+     * 用户被取消踢出聊天室
+     */
+    UserCancelKicked = "UserCancelKicked",
+    /**
+     * 置顶消息事件
+     */
+    TopMsg = "TopMsg",
+    /**
+     * 设置自动翻译语言
+     */
+    SetAutoTranslateLanguage = "SetAutoTranslateLanguage",
+    /**
+     * 商品点击事件
+     */
+    ProductClick = "ProductClick",
+    /**
+     * 商品下单数量事件
+     */
+    ProductBuyTimes = "ProductBuyTimes"
+}
+
+export declare type PolyvChatEventRelations = {
+    [PolyvChatEvent.StatusInfoUpdate]: {
+        /**
+         * 状态信息
+         */
+        statusInfo: ChatStatusInfo;
+    };
+    [PolyvChatEvent.ChatMessage]: {
+        /**
+         * 聊天消息对象
+         */
+        chatMsg: ChatMsgType;
+    };
+    [PolyvChatEvent.RemoveChatMsg]: {
+        /**
+         * 删除的消息 id
+         */
+        id: string;
+    };
+    [PolyvChatEvent.ReplaceChatMessage]: {
+        /**
+         * 替换的消息 id
+         */
+        id: string;
+        /**
+         * 新的消息对象
+         */
+        chatMsg: ChatMsgType;
+    };
+    [PolyvChatEvent.SelfSendMessage]: {
+        /**
+         * 发送的消息对象
+         */
+        chatMsg: ChatMsgTypeWithSendStatus;
+    };
+    [PolyvChatEvent.UserBanned]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+    };
+    [PolyvChatEvent.UserCancelBanned]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+    };
+    [PolyvChatEvent.IpBanned]: {
+        /**
+         * ip
+         */
+        ip: string;
+    };
+    [PolyvChatEvent.IpCancelBanned]: {
+        /**
+         * ip
+         */
+        ip: string;
+    };
+    [PolyvChatEvent.UserKicked]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+    };
+    [PolyvChatEvent.UserCancelKicked]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+    };
+    [PolyvChatEvent.TopMsg]: {
+        /**
+         * 置顶消息
+         */
+        topingMsgs: TopingMsgData[];
+    };
+    [PolyvChatEvent.SetAutoTranslateLanguage]: {
+        /**
+         * 自动翻译语言
+         */
+        language: TranslateLanguage | undefined;
+    };
+    [PolyvChatEvent.ProductClick]: {
+        /**
+         * 用户昵称
+         */
+        nickname: string;
+        /**
+         * 商品 id
+         */
+        productId: string;
+        /**
+         * 商品名称
+         */
+        name: string;
+        /**
+         * 商品类型
+         */
+        type: string;
+    };
+    [PolyvChatEvent.ProductBuyTimes]: {
+        /**
+         * 首个下单观众昵称
+         */
+        nickname: string;
+        /**
+         * 次数
+         */
+        count: number;
+        /**
+         * 商品 id
+         */
+        productId: string;
+        /**
+         * 商品名称
+         */
+        productName: string;
+        /**
+         * 商品类型
+         */
+        productType: string;
+    };
+};
+
+export declare interface PushMsgToQaOptions {
+    /** 发言消息 */
+    chatMsg: ChatMsgSpeakType;
+}
+
+/**
+ * 红包类型
+ */
+export declare enum RedpackType {
+    /**
+     * 用户 - 普通红包
+     */
+    Normal = "normal",
+    /**
+     * 开播端 - 普通红包
+     */
+    OfficialNormal = "official_normal",
+    /**
+     * 开播端 - 口令红包
+     */
+    Password = "password",
+    /**
+     * 开播端 - 红包雨
+     */
+    Rain = "rain",
+    /**
+     * 开播端 - 积分普通红包
+     */
+    ScoreOfficialNormal = "score_official_normal",
+    /**
+     * 开播端 - 积分口令红包
+     */
+    ScorePassword = "score_password",
+    /**
+     * 开播端 - 积分红包雨
+     */
+    ScoreRain = "score_rain",
+    /**
+     * 开播端 - 积分答题红包
+     */
+    ScoreQuestion = "score_question",
+    /**
+     * 开播端 - 答题红包
+     */
+    Question = "question",
+    /**
+     * 开播端 - 支付宝口令普通红包
+     */
+    AlipayPasswordOfficialNormal = "alipay_password_official_normal",
+    /**
+     * 任务奖励
+     */
+    TaskWard = "TASK_REWARD"
+}
+
+/**
+ * 失败结果
+ */
+export declare interface ResultFail<FailReason extends string> {
+    success: false;
+    /** 失败原因 */
+    failReason: FailReason;
+    /** 失败消息 */
+    failMessage?: string;
+}
+
+export declare type ResultSuccess<SuccessData extends object = object> = ResultSuccessBasic & SuccessData;
+
+/**
+ * 成功的结果
+ */
+export declare interface ResultSuccessBasic {
+    success: true;
+}
+
+export declare interface SendCustomServerMsgOptions {
+    /**
+     * 自定义消息内容
+     */
+    content: string;
+    /**
+     * 是否加入聊天历史
+     * @default true
+     */
+    joinHistoryList?: boolean;
+}
+
+/**
+ * 发送图片表情参数
+ */
+export declare interface SendEmotionImageMsgOptions extends SendMsgCommonOptions<ChatMsgEmotionType> {
+    /**
+     * 表情 id
+     */
+    emotionId: string;
+    /**
+     * 表情图片地址
+     */
+    emotionUrl: string;
+}
+
+declare class SenderModule extends ChatModuleBase {
+    /**
+     * 获取当前观众的聊天室用户信息
+     */
+    private __getCurrentChatMsgUserData;
+    private __afterSendSocket;
+    /**
+     * 生成本地消息
+     * @param source 消息来源
+     * @param options 选项参数
+     * @returns
+     */
+    generateLocalMsg<S extends SendMsgSourceType>(source: S, options: SendMsgRealtions[S]): Promise<PickChatMsgType<S>>;
+    /**
+     * 发送文本消息
+     *
+     * 用于观众进行聊天发言，调用过程中会触发 {@link ChatEvents.ChatMessage} 聊天消息事件。
+     * @category 发送聊天消息
+     * @param options 发言参数
+     * @returns 发送到服务器后的消息对象
+     * @example
+     * ```ts
+     * import { ChatMsgSpeakType } from '@polyv/chat';
+     * // 发送的文本
+     * const content = '今天天气真好[呲牙][酷]';
+     * // 被回复的消息
+     * const currentQuoteMsg: ChatMsgSpeakType | undefined = undefined;
+     * // 发送消息
+     * chatTarget.sender.sendSpeakMsg({
+     *   content,
+     *   quoteMsg: currentQuoteMsg,
+     * });
+     * ```
+     */
+    sendSpeakMsg(options: SendSpeakMsgOptions): Promise<ChatMsgSpeakType>;
+    /**
+     * 发送图片消息
+     *
+     * 用于观众发送图片消息，调用过程中会触发 {@link PolyvChatEvents.ChatMessage} 聊天消息事件。
+     * @category 发送聊天消息
+     * @param options 发送图片参数
+     * @returns 发送到服务器后的图片消息对象
+     * @example
+     * ```js
+     * import { uuidV4 } from '@utils-ts/string';
+     * // 图片 id
+     * const imageId = uuidV4();
+     * // 图片地址
+     * const imageUrl = '发送到图片地址，需要带有协议';
+     * // 图片地址
+     * const size = { width: 200, height: 100 };
+     * // 发送图片消息
+     * chatTarget.sender.sendImageMsg({ imageId, imageUrl, size });
+     * ```
+     */
+    sendImageMsg(options: SendImageMsgOptions): Promise<ChatMsgImageType>;
+    /**
+     * 选择图片文件并发送图片消息
+     */
+    choiceImageFileSend(options?: ChoiceImageFileSendOptions): Promise<ChatMsgImageType[]>;
+    /**
+     * 发送表情图片消息
+     *
+     * 通过 `getEmotionImages` 方法获取表情图片列表后，通过列表项的 `id`、`url` 发送表情图片消息，调用过程中会触发 {@link PolyvChatEvents.ChatMessage} 聊天消息事件。
+     *
+     * 开发者可通过 {@link getEmotionImages} 获取表情图片列表。
+     * @category 发送聊天消息
+     * @param options 发送表情图片参数
+     * @returns 发送到服务器后的消息对象
+     * @example
+     * ```js
+     * // 获取表情图片列表
+     * const emotionImages = await chatTarget.emotion.getEmotionImages();
+     * // 发送表情图片
+     * const item = emotionImages[2];
+     * chatTarget.sender.sendEmotionImageMsg({ emotionId: item.id, emotionUrl: item.url });
+     * ```
+     */
+    sendEmotionImageMsg(options: SendEmotionImageMsgOptions): Promise<ChatMsgEmotionType>;
+    /**
+     * 发送系统消息
+     *
+     * 用于发送系统消息到聊天区，注意该消息并不会发送到服务端，调用过程中会触发 {@link PolyvChatEvent.ChatMessage} 聊天消息事件。
+     * @param content 消息内容
+     * @param type 系统消息类型
+     * @example
+     * ```js
+     * chatTarget.sender.sendSystemMsg('聊天室已关闭');
+     * ```
+     */
+    sendSystemMsg(content: string, type?: SystemMsgType): void;
+    /**
+     * 发送自定义消息(服务端)
+     * @param options
+     */
+    sendCustomServerMsg(options: SendCustomServerMsgOptions): Promise<void>;
+}
+
+/**
+ * 发送图片参数
+ */
+export declare interface SendImageMsgOptions extends SendMsgCommonOptions<ChatMsgImageType> {
+    /**
+     * 图片 id，建议使用 uuid(v4) 生成
+     */
+    imageId: string;
+    /**
+     * 图片地址
+     */
+    imageUrl: string;
+    /**
+     * 图片尺寸
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+}
+
+export declare interface SendMsgCommonOptions<L extends ChatMsgType = ChatMsgType> {
+    /**
+     * 本地 id
+     */
+    localId?: string;
+    /**
+     * 本地消息
+     */
+    localMsg?: L;
+    /**
+     * 广播本地消息
+     * @default true
+     */
+    emitLocalMsg?: boolean;
+}
+
+export declare type SendMsgRealtions = {
+    [ChatMsgSource.Speak]: SendSpeakMsgOptions;
+    [ChatMsgSource.Image]: SendImageMsgOptions;
+    [ChatMsgSource.Emotion]: SendEmotionImageMsgOptions;
+};
+
+export declare type SendMsgRealtionsGenerateObj = {
+    [key in SendMsgSourceType]: (_options: SendMsgRealtions[key]) => Promise<PickChatMsgType<key>>;
+};
+
+export declare type SendMsgSourceType = keyof SendMsgRealtions;
+
+/**
+ * 发言参数
+ */
+export declare interface SendSpeakMsgOptions extends SendMsgCommonOptions<ChatMsgSpeakType> {
+    /**
+     * 发言内容
+     */
+    content: string;
+    /**
+     * 引用的消息
+     */
+    quoteMsg?: ChatMsgType;
+}
+
+export declare interface SetAutoTranslateOptions {
+    /**
+     * 翻译的语言, undefined 表示关闭自动翻译
+     */
+    language: TranslateLanguage | undefined;
+}
+
+export declare interface SetChatSwitchOptions {
+    /** 是否开启 */
+    enabled: boolean;
+}
+
+/**
+ * 状态模块
+ */
+declare class StatusModule extends ChatModuleBase {
+    private __statusInfo;
+    generateStatusInfo(): ChatStatusInfo;
+    constructor(plvChat: PolyvChat);
+    /**
+     * 获取状态信息
+     */
+    getStatusInfo(): ChatStatusInfo;
+    private __updateStatusInfo;
+    /**
+     * 设置自动翻译
+     * @param options 设置选项
+     */
+    setAutoTranslate(options: SetAutoTranslateOptions): Promise<void>;
+}
+
+/**
+ * 系统消息类型
+ */
+export declare enum SystemMsgType {
+    /**
+     * 聊天区通知
+     */
+    ChatRoomIntroduction = "chat-room-introduction"
+}
+
+export declare interface TopingMsgData {
+    /** 置顶 id */
+    id: number;
+    /** 置顶操作者头衔 */
+    topActor: string;
+    /** 被置顶的消息 */
+    chatMsg: ChatMsgTypeByTop;
+}
+
+export declare interface TopMsgOptions {
+    /** 消息 id */
+    msgId: string;
+}
+
+export declare type TranslatedContents = {
+    [lang in TranslateLanguage]?: string;
+};
+
+/**
+ * 翻译的语言
+ */
+export declare enum TranslateLanguage {
+    /** 中文 */
+    Chinese = "Chinese",
+    /** 英文 */
+    English = "English",
+    /** 日文 */
+    Japanese = "Japanese",
+    /** 韩文 */
+    Korean = "Korean",
+    /** 俄文 */
+    Russian = "Russian"
+}
+
+export declare interface TranslateSpeakOptions {
+    /**
+     * 发言消息
+     */
+    chatMsg: ChatMsgSpeakType;
+    /**
+     * 目标语言
+     */
+    language: TranslateLanguage;
+}
+
+export declare interface TranslateSpeakResult {
+    /**
+     * 翻译后的语言
+     */
+    language: TranslateLanguage;
+    /**
+     * 翻译后的内容
+     */
+    content: string;
+}
+
+export declare interface UploadImageResult {
+    /** 图片 id */
+    imageId: string;
+    /** 图片地址 */
+    imageUrl: string;
+    /** 图片尺寸 */
+    size: {
+        width: number;
+        height: number;
+    };
+}
+
+/**
+ * 多图片上传失败结果
+ */
+export declare interface UploadMultiImageFailResult {
+    /** 图片id */
+    imageId: string;
+    /** 图片预览url */
+    previewSrc: string;
+}
+
+export declare interface UploadMultiImageOptions {
+    /** 上传限制，默认为 9 张 */
+    maxLimit?: number;
+    /** 上传准备完成回调 */
+    ready?: (result: UploadMultiImageReadyResult) => void;
+    /** 上传完成回调，每上传完一张图片就会回调一次 */
+    success?: (result: UploadMultiImageSuccessResult) => void;
+    /** 上传失败回调，不影响后续图片上传 */
+    fail?: (err: Error, result: UploadMultiImageFailResult) => void;
+}
+
+/**
+ * 多图片上传准备结果（已完成图片选择）
+ */
+export declare interface UploadMultiImageReadyResult {
+    /** 图片id */
+    imageId: string;
+    /** 图片预览url */
+    previewSrc: string;
+}
+
+export declare interface UploadMultiImageResult {
+    /** 上传成功的图片集合 */
+    successUploadImages: UploadMultiImageSuccessResult[];
+    /** 上传失败的图片集合 */
+    failUploadImages: UploadMultiImageFailResult[];
+}
+
+/**
+ * 多图片上传完成结果
+ */
+export declare type UploadMultiImageSuccessResult = UploadImageResult;
+
+declare class UtilsModule extends ChatModuleBase {
+    private __uploadImgCtrl;
+    constructor(plvChat: PolyvChat);
+    private __setUploadImgChannelId;
+    /**
+     * 选择图片文件并上传多张图片
+     */
+    uploadMultiImage(params?: UploadMultiImageOptions): Promise<UploadMultiImageResult>;
+    /**
+     * 根据文件直接上传图片
+     */
+    directUploadImage(file: File | null): Promise<UploadImageResult>;
+    /**
+     * 翻译文本
+     * @param text 需要翻译的文本
+     */
+    translateText(text: string): Promise<string>;
+    private __genResourceUrl;
+    /**
+     * 获取默认资源
+     * @returns 默认资源
+     */
+    getDefaultResource(): ChatDefaultResource;
+    private __svgaMap;
+    /**
+     * 获取默认打赏 svga 地址
+     * @param chatMsg 打赏消息
+     * @returns 默认打赏 svga 地址
+     */
+    getDefaultDonateSvgaUrl(chatMsg: ChatMsgRewardType): Promise<string | undefined>;
+}
+
+export { }