@polyv/chat 2.1.0-rc-20251023.2 → 2.3.0-rc-20251204.1

package/index.es.d.ts

@@ -4,6 +4,42 @@ import { EventEmitter } from '@polyv/utils/es/event';
 import { PolyvSocket } from '@polyv/socket';
 import { SocketUserType } from '@polyv/socket';
 
+declare class AskModule extends ChatModuleBase {
+    private __apiFilter;
+    constructor(plvChat: PolyvChat);
+    private __handleAskSocket;
+    /**
+     * 获取提问用户列表
+     */
+    getAskUserList(): Promise<AskUser[]>;
+    /**
+     * 获取提问历史消息
+     */
+    getAskHistory(options: GetAskHistoryOptions): Promise<AskMsgType[]>;
+    private __buildSocketData;
+    sendSpeakMsg(options: SendAskSpeakMsgOptions): Promise<void>;
+    sendImageMsg(options: SendAskImageMsgOptions): Promise<void>;
+    sendSystemMsg(options: SendAskSystemMsgOptions): Promise<void>;
+}
+
+/**
+ * 提问消息类型
+ */
+export declare type AskMsgType = ChatMsgSpeakType | ChatMsgImageType | ChatMsgSystemType;
+
+export declare interface AskUser {
+    /** 用户 id */
+    userId: string;
+    /** 昵称 */
+    nick: string;
+    /** 头像 */
+    pic: string;
+    /** 头衔 */
+    actor: string;
+    /** 最新消息的时间戳 */
+    lastMessageTime: number;
+}
+
 export declare interface AttendanceData extends ChatMessageUser {
     /**
      * 排序号
@@ -140,7 +176,7 @@ export declare interface ChatMessageUser<T extends SocketUserType = SocketUserTy
      */
     label?: {
         /** 提问区标签 */
-        question: string[];
+        question?: string[];
     };
 }
 
@@ -346,6 +382,10 @@ export declare interface ChatMsgRewardType extends ChatMsgCommonType<ChatMsgSour
      * 打赏礼物图片
      */
     gimg: string;
+    /**
+     * 特效文件
+     */
+    dynamicFile?: string;
     /**
      * 打赏数量
      */
@@ -657,6 +697,10 @@ declare class DownloadModule extends ChatModuleBase {
      * 获取到勤/缺勤导出记录
      */
     getAttendanceDownloadRecord(options?: GetAttendanceDownloadRecordOptions): Promise<PageContent<DataExportRecordData>>;
+    /**
+     * 获取导出请求参数
+     */
+    private __getExportParams;
     /**
      * 导出在线列表
      */
@@ -687,10 +731,15 @@ export declare interface EmotionImageData {
 
 declare class EmotionModule extends ChatModuleBase {
     private __emotionParser?;
+    private __emotionParserPromise?;
     /**
      * 加载表情解析器
      */
     setupEmotionParser(): Promise<void>;
+    /**
+     * 获取表情解析器
+     */
+    getEmotionParser(): EmotionParser | undefined;
     /**
      * 获取黄脸表情节点
      *
@@ -747,10 +796,6 @@ declare class EmotionModule extends ChatModuleBase {
      * ```
      */
     translateEmotions(content: string, isZhCN?: boolean): string;
-    /**
-     * 获取表情解析器
-     */
-    getEmotionParser(): EmotionParser | undefined;
     private __getEmotionImagePromise?;
     /**
      * 获取表情图片列表
@@ -767,6 +812,13 @@ declare class FilterBase {
     _filterUser(user: ChatMessageUser): ChatMessageUser;
 }
 
+export declare interface GetAskHistoryOptions {
+    /**
+     * 目标用户 id
+     */
+    targetUserId: string;
+}
+
 export declare interface GetAttendanceDownloadRecordOptions {
     pageNumber?: number;
     pageSize?: number;
@@ -864,6 +916,13 @@ export declare interface GetOnlineListOptions {
     getBanStatus?: boolean;
 }
 
+export declare interface GetSessionHistoryCountOptions {
+    /**
+     * 场次号
+     */
+    sessionId: string;
+}
+
 export declare interface GetSpeakOriginalContentOptions {
     /**
      * 发言消息
@@ -871,6 +930,8 @@ export declare interface GetSpeakOriginalContentOptions {
     chatMsg: ChatMsgSpeakType;
 }
 
+export declare const GlobalVariable = "PolyvChat";
+
 /**
  * 历史消息模块
  */
@@ -897,6 +958,10 @@ declare class HistoryModule extends ChatModuleBase {
      */
     private __getHistoryExclude;
     getChatHistoryByWorkWechatTagId(options?: GetChatHistoryByWorkWechatTagIdOptions): Promise<ChatMsgType[]>;
+    /**
+     * 获取场次历史消息数量
+     */
+    getSessionHistoryCount(options: GetSessionHistoryCountOptions): Promise<number>;
 }
 
 declare interface InternalSpeakTopData {
@@ -942,6 +1007,28 @@ export declare interface KickUserOptions {
     userId: string;
 }
 
+declare class LikeModule extends ChatModuleBase {
+    /**
+     * 实时点赞数
+     */
+    private __realtimeLikes;
+    constructor(plvChat: PolyvChat);
+    /**
+     * 获取实时点赞数
+     */
+    getRealtimeLikes(): number;
+    /**
+     * 更新点赞数
+     * @param realtimeLikes 点赞数
+     */
+    setRealtimeLikes(realtimeLikes: number): void;
+    /**
+     * 发送点赞
+     * @param times 点赞次数
+     */
+    sendLike(times: number): Promise<number>;
+}
+
 export declare enum ManageFailReason {
     /** 未知错误 */
     UnknownError = "UnknownError",
@@ -1171,6 +1258,13 @@ declare class OnlineModule extends ChatModuleBase {
      * @param options 获取选项
      */
     getOnlineList(options?: GetOnlineListOptions): Promise<OnlineListResult>;
+    /**
+     * 获取在线列表（观众）
+     */
+    private __getOnlineListByViewer;
+    /**
+     * 获取在线列表（搜索）
+     */
     private __getOnlineListByKeyword;
     /**
      * 获取在线列表（普通）
@@ -1252,7 +1346,7 @@ export declare class PolyvChat {
     status: StatusModule;
     /** 工具模块 */
     utils: UtilsModule;
-    /** 发送模块 */
+    /** 聊天消息发送模块 */
     sender: SenderModule;
     /** 管理模块 */
     manage: ManageModule;
@@ -1260,6 +1354,10 @@ export declare class PolyvChat {
     online: OnlineModule;
     /** 下载导出模块 */
     download: DownloadModule;
+    /** 点赞模块 */
+    like: LikeModule;
+    /** 提问模块 */
+    ask: AskModule;
     constructor(plvSocket: PolyvSocket, config?: PolyvChatConfig);
     /** 是否设置完成 */
     setuped: boolean;
@@ -1267,6 +1365,7 @@ export declare class PolyvChat {
      * 设置聊天室
      */
     setup(): Promise<void>;
+    destroy(): Promise<void>;
 }
 
 export declare interface PolyvChatConfig {
@@ -1279,6 +1378,11 @@ export declare interface PolyvChatConfig {
      * @default false
      */
     chatHistoryEncrypt?: boolean;
+    /**
+     * 默认点赞数
+     * @default 0
+     */
+    defaultLikes?: number;
 }
 
 export declare enum PolyvChatEvent {
@@ -1290,6 +1394,14 @@ export declare enum PolyvChatEvent {
      * 状态信息更新事件
      */
     StatusInfoUpdate = "StatusInfoUpdate",
+    /**
+     * 用户登录事件
+     */
+    UserLogin = "UserLogin",
+    /**
+     * 用户退出事件
+     */
+    UserLogout = "UserLogout",
     /**
      * 聊天消息事件
      */
@@ -1357,7 +1469,27 @@ export declare enum PolyvChatEvent {
     /**
      * 商品下单数量事件
      */
-    ProductBuyTimes = "ProductBuyTimes"
+    ProductBuyTimes = "ProductBuyTimes",
+    /**
+     * 签到次数事件
+     */
+    CheckInTimes = "CheckInTimes",
+    /**
+     * 点赞数更新事件
+     */
+    ChatLikesUpdate = "ChatLikesUpdate",
+    /**
+     * 聊天点赞
+     */
+    ChatLike = "ChatLike",
+    /**
+     * 发送点赞
+     */
+    SendChatLike = "SendChatLike",
+    /**
+     * 提问消息事件
+     */
+    AskMessage = "AskMessage"
 }
 
 export declare type PolyvChatEventRelations = {
@@ -1367,6 +1499,22 @@ export declare type PolyvChatEventRelations = {
          */
         statusInfo: ChatStatusInfo;
     };
+    [PolyvChatEvent.UserLogin]: {
+        /**
+         * 用户信息
+         */
+        user: ChatMessageUser;
+    };
+    [PolyvChatEvent.UserLogout]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+        /**
+         * 用户昵称
+         */
+        nick: string;
+    };
     [PolyvChatEvent.ChatMessage]: {
         /**
          * 聊天消息对象
@@ -1483,6 +1631,60 @@ export declare type PolyvChatEventRelations = {
          */
         productType: string;
     };
+    [PolyvChatEvent.CheckInTimes]: {
+        /**
+         * 用户昵称
+         */
+        nickname: string;
+        /**
+         * 次数
+         */
+        count: number;
+    };
+    [PolyvChatEvent.ChatLikesUpdate]: {
+        /**
+         * 点赞数
+         */
+        realtimeLikes: number;
+    };
+    [PolyvChatEvent.ChatLike]: {
+        /**
+         * 点赞数
+         */
+        count: number;
+        /**
+         * 实时点赞数
+         */
+        realtimeLikes: number;
+        /**
+         * 用户 id
+         */
+        userId: string;
+        /**
+         * 用户昵称
+         */
+        nick: string;
+        /**
+         * 是否自己点赞
+         */
+        isSelf: boolean;
+    };
+    [PolyvChatEvent.SendChatLike]: {
+        /**
+         * 点赞数
+         */
+        count: number;
+    };
+    [PolyvChatEvent.AskMessage]: {
+        /**
+         * 提问消息
+         */
+        askMsg: AskMsgType;
+        /**
+         * 目标用户 id
+         */
+        targetUserId: string;
+    };
 };
 
 export declare interface PushMsgToQaOptions {
@@ -1560,6 +1762,54 @@ export declare interface ResultSuccessBasic {
     success: true;
 }
 
+export declare interface SendAskImageMsgOptions {
+    /**
+     * 图片 id
+     */
+    imageId: string;
+    /**
+     * 图片地址
+     */
+    imageUrl: string;
+    /**
+     * 图片尺寸
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * 目标用户 id
+     */
+    targetUserId?: string;
+}
+
+export declare interface SendAskSpeakMsgOptions {
+    /**
+     * 发言内容
+     */
+    content: string;
+    /**
+     * 目标用户 id
+     */
+    targetUserId?: string;
+}
+
+export declare interface SendAskSystemMsgOptions {
+    /**
+     * 系统消息类型
+     */
+    type?: SystemMsgType;
+    /**
+     * 消息内容
+     */
+    content: string;
+    /**
+     * 目标用户 id
+     */
+    targetUserId: string;
+}
+
 export declare interface SendCustomServerMsgOptions {
     /**
      * 自定义消息内容
@@ -1785,7 +2035,11 @@ export declare enum SystemMsgType {
     /**
      * 聊天区通知
      */
-    ChatRoomIntroduction = "chat-room-introduction"
+    ChatRoomIntroduction = "chat-room-introduction",
+    /**
+     * 违规词
+     */
+    ForbiddenWord = "forbidden-word"
 }
 
 export declare interface TopingMsgData {
@@ -1885,6 +2139,11 @@ export declare interface UploadMultiImageReadyResult {
     imageId: string;
     /** 图片预览url */
     previewSrc: string;
+    /** 图片尺寸 */
+    size: {
+        width: number;
+        height: number;
+    };
 }
 
 export declare interface UploadMultiImageResult {