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

package/index.es.d.ts

@@ -10,10 +10,29 @@ import { SM2Key } from '@polyv/request-plugin-sm2';
 
 export { AuthorizeAppSignRequestOptions }
 
+declare interface ChannelInfo {
+    /**
+     * 频道号
+     */
+    channelId: string;
+    /**
+     * 场次号
+     */
+    sessionId?: string;
+    /**
+     * 是否指定场次
+     */
+    inTargetSession: boolean;
+    /**
+     * 保利威账号 id
+     */
+    accountId?: string;
+}
+
 /**
  * 频道信息
  */
-export declare interface ChannelInfo {
+export declare interface ChannelInfoOptions {
     /**
      * 频道号
      */
@@ -22,12 +41,48 @@ export declare interface ChannelInfo {
      * 场次号
      */
     sessionId?: string;
+    /**
+     * 是否指定场次
+     * @default false
+     */
+    inTargetSession?: boolean;
     /**
      * 保利威账号 id
      */
     accountId?: string;
 }
 
+declare class ChannelModule extends SocketModuleBase {
+    /**
+     * 频道号
+     */
+    private __channelId;
+    /**
+     * 场次号
+     */
+    private __sessionId?;
+    /**
+     * 保利威账号 id
+     */
+    private __accountId?;
+    /**
+     * 是否指定场次
+     */
+    private __inTargetSession;
+    /**
+     * 讲师信息
+     */
+    private __teacherInfo?;
+    constructor(plvSocket: PolyvSocket);
+    private __onTeacherInfo;
+    getTeacherInfo(): TeacherInfo | undefined;
+    getChannelInfo(): Promise<ChannelInfo>;
+    /**
+     * 更新场次信息
+     */
+    updateSession(options: UpdateSessionOptions): void;
+}
+
 /**
  * 频道令牌数据
  */
@@ -91,6 +146,77 @@ export declare enum ConnectFailReason {
     SocketConnectTimeout = "SocketConnectTimeout"
 }
 
+declare class ConnectModule extends SocketModuleBase {
+    customSocket?: SocketInstance;
+    /**
+     * 事件存储
+     */
+    private __eventStore;
+    /**
+     * Socket 连接实例
+     */
+    private __socket?;
+    constructor(plvSocket: PolyvSocket);
+    setup(options: SocketSetupOptions): Promise<void>;
+    /**
+     * 获取连接令牌
+     */
+    getToken(): Promise<string | undefined>;
+    getSocket(check?: true): SocketInstance;
+    getSocket(check: false): SocketInstance | undefined;
+    /**
+     * 初始化 Socket
+     */
+    private __initSocket;
+    /**
+     * 连接 Socket
+     */
+    private __connectSocket;
+    /**
+     * 登录聊天室 socket
+     */
+    private __loginSocket;
+    /**
+     * 监听 socket 连接事件
+     */
+    private __bindConnectEvent;
+    /**
+     * 发送 socket 数据
+     * @param socketData socket 数据
+     * @param socketType socket 类型，默认：message
+     */
+    emitSocket<D = unknown>(socketData: unknown, socketType?: SocketEventType, options?: EmitSocketOptions): Promise<D>;
+    /**
+     * 添加 socket 事件监听
+     * @param appName 应用名称
+     * @param handlers 消息事件处理对象
+     * @param socketType socket 事件类型
+     */
+    addSocketHandles(appName: EventAppName, handlers: SocketEventStoreHandlers | EventHandler, socketType?: SocketEventType): void;
+    /**
+     * 清除 socket 事件监听
+     * @param appName 应用名称
+     */
+    clearSocketHandles(appName: EventAppName): void;
+    /**
+     * 断开 Socket 连接
+     */
+    disconnect(): Promise<void>;
+}
+
+export declare interface EmitSocketOptions {
+    /**
+     * 是否直接回调参数
+     * @default false
+     */
+    directCallback?: boolean;
+    /**
+     * 是否检查 code 返回
+     * @default true
+     */
+    checkCode?: boolean;
+}
+
 /** 应用名 */
 export declare type EventAppName = string;
 
@@ -100,6 +226,8 @@ export declare type EventHandler = (msg: any) => unknown;
 /** 事件 key */
 export declare type EventKey = string;
 
+export declare const GlobalVariable = "PolyvSocket";
+
 export declare type MaybePromiseFn<R> = () => Promise<R> | R;
 
 declare class PolyvApiRequest extends PolyvRequest<PolyvApiRequestOptions> {
@@ -114,10 +242,12 @@ declare class PolyvApiRequest extends PolyvRequest<PolyvApiRequestOptions> {
 declare interface PolyvApiRequestOptions extends RequestOptions {
 }
 
-export declare class PolyvSocket extends PolyvSocketBase {
+export declare class PolyvSocket {
     ConnectFailReason: typeof ConnectFailReason;
     SocketUserType: typeof SocketUserType;
     PolyvSocketEvent: typeof PolyvSocketEvent;
+    eventEmitter: EventEmitter<PolyvSocketEventRelations, PolyvSocketEvent>;
+    config: PolyvSocketConfig;
     /**
      * 聊天室 api 请求器
      */
@@ -126,88 +256,29 @@ export declare class PolyvSocket extends PolyvSocketBase {
      * 保利威 api 请求器
      */
     polyvApi: PolyvApiRequest;
-    constructor(config: PolyvSocketConfig);
-    /**
-     * 设置 Socket 连接
-     */
-    setup(): Promise<void>;
-    protected _afterConnect(): void;
-    /**
-     * 登录聊天室 socket
-     */
-    loginSocket(): Promise<void>;
-    /**
-     * 判断是否为特殊的用户身份
-     *
-     * 用户模块提供 Api 用于判断用户身份是否为内置的特殊用户身份，如讲师、管理员、助教等。
-     * @param userType 用户身份
-     * @param actor 用户头衔
-     * @returns 是否特殊身份
-     */
-    isSpecialUserType(userType: SocketUserType | unknown, actor?: string): boolean;
     /**
-     * 判断是否为当前用户
-     * @param userId 用户 id
+     * 连接模块
      */
-    isCurrentUser(userId: string): boolean;
-}
-
-/**
- * Polyv Socket 基类
- */
-declare class PolyvSocketBase {
-    config: PolyvSocketConfig;
-    eventEmitter: EventEmitter<PolyvSocketEventRelations, PolyvSocketEvent>;
+    connect: ConnectModule;
     /**
-     * 事件存储
+     * 频道模块
      */
-    private __eventStore;
+    channel: ChannelModule;
     /**
-     * Socket 连接实例
+     * 埋点
      */
-    private __socket?;
+    rtas: RtasModule;
     constructor(config: PolyvSocketConfig);
     /**
-     * @hook 连接成功后
-     */
-    protected _afterConnect(): void;
-    /**
-     * 获取连接令牌
-     */
-    getToken(): Promise<string | undefined>;
-    /**
-     * 获取频道信息
-     */
-    getChannelInfo(): Promise<ChannelInfo>;
-    /**
-     * 获取用户信息
-     */
-    getUserInfo(): UserInfo;
-    getSocket(check?: true): SocketInstance;
-    getSocket(check: false): SocketInstance | undefined;
-    /**
-     * 初始化 Socket
-     */
-    protected _initSocket(): Promise<void>;
-    /**
-     * 连接 Socket
-     */
-    protected _connectSocket(): Promise<void>;
-    /**
-     * 监听 socket 连接事件
+     * 创建并连接 socket
      */
-    private __bindConnectEvent;
+    setup(options?: SocketSetupOptions): Promise<void>;
     /**
      * 发送 socket 数据
      * @param socketData socket 数据
      * @param socketType socket 类型，默认：message
      */
-    emitSocket<D = unknown>(socketData: unknown, socketType?: SocketEventType, options?: {
-        /** 是否直接回调参数，默认：false */
-        directCallback?: boolean;
-        /** 是否检查 code 返回，默认：true */
-        checkCode?: boolean;
-    }): Promise<D>;
+    emitSocket<D = unknown>(socketData: unknown, socketType?: SocketEventType, options?: EmitSocketOptions): Promise<D>;
     /**
      * 添加 socket 事件监听
      * @param appName 应用名称
@@ -216,9 +287,30 @@ declare class PolyvSocketBase {
      */
     addSocketHandles(appName: EventAppName, handlers: SocketEventStoreHandlers | EventHandler, socketType?: SocketEventType): void;
     /**
-     * 断开 Socket 连接
+     * 清除 socket 事件监听
+     * @param appName 应用名称
      */
-    disconnect(): Promise<void>;
+    clearSocketHandles(appName: EventAppName): void;
+    /**
+     * 获取用户信息
+     */
+    getUserInfo(): UserInfo;
+    /**
+     * 判断是否为特殊的用户身份
+     *
+     * 用户模块提供 Api 用于判断用户身份是否为内置的特殊用户身份，如讲师、管理员、助教等。
+     * @param userType 用户身份
+     * @param actor 用户头衔
+     * @returns 是否特殊身份
+     */
+    isSpecialUserType(userType: SocketUserType | unknown, actor?: string): boolean;
+    currentIsSpecialUser(): boolean;
+    /**
+     * 判断是否为当前用户
+     * @param userId 用户 id
+     */
+    isCurrentUser(userId: string): boolean;
+    destroy(): Promise<void>;
 }
 
 /**
@@ -232,11 +324,15 @@ export declare interface PolyvSocketConfig {
     /**
      * 频道信息
      */
-    channelInfo: ChannelInfo;
+    channelInfo: ChannelInfoOptions;
     /**
      * 用户信息
      */
     userInfo: UserInfo | (() => UserInfo);
+    /**
+     * 讲师信息
+     */
+    teacherInfo?: TeacherInfo;
     /**
      * 域名信息
      */
@@ -268,6 +364,10 @@ export declare interface PolyvSocketConfig {
      * 获取频道令牌信息
      */
     getChannelToken?: MaybePromiseFn<ChannelTokenData>;
+    /**
+     * 埋点上报总开关
+     */
+    watchEventTrackEnabled?: boolean;
     /**
      * 授权方式
      * @default RequestAuthorizeMethod.Token
@@ -325,7 +425,11 @@ export declare enum PolyvSocketEvent {
     /**
      * 登录失败
      */
-    LoginFailed = "LoginFailed"
+    LoginFailed = "LoginFailed",
+    /**
+     * 场次信息更新
+     */
+    SessionUpdate = "SessionUpdate"
 }
 
 export declare type PolyvSocketEventRelations = {
@@ -359,6 +463,17 @@ export declare enum RequestAuthorizeMethod {
     Sign = "sign"
 }
 
+declare class RtasModule extends SocketModuleBase {
+    private __rtasSender?;
+    constructor(plvSocket: PolyvSocket);
+    setup(_setupOptions: SocketSetupOptions): Promise<void>;
+    private __init;
+    /**
+     * 发送事件日志
+     */
+    trackEvent(data: TrackEventData): Promise<void>;
+}
+
 /**
  * 安全模式
  */
@@ -385,7 +500,7 @@ export declare type SocketEventStoreHandlers = {
  */
 export declare type SocketEventType = typeof socketEventTypes[number];
 
-export declare const socketEventTypes: readonly ["message", "product", "lottery", "questionnaire", "coupon", "activityLottery", "testQuestion", "emotion", "speak", "customMessage", "motivation"];
+export declare const socketEventTypes: readonly ["message", "product", "lottery", "questionnaire", "coupon", "activityLottery", "testQuestion", "emotion", "speak", "customMessage", "motivation", "fakeLikes"];
 
 export declare interface SocketInstance {
     /** 是否已断开连接 */
@@ -404,6 +519,19 @@ export declare interface SocketInstance {
     once: (event: string, callback: (...args: any[]) => void) => void;
 }
 
+declare class SocketModuleBase {
+    protected _plvSocket: PolyvSocket;
+    constructor(_plvSocket: PolyvSocket);
+    setup(_setupOptions: SocketSetupOptions): Promise<void>;
+}
+
+export declare interface SocketSetupOptions {
+    /**
+     * 自定义 socket 连接实例，如果提供了该实例，则不会自动创建 socket 连接和连接 socket
+     */
+    customSocket?: SocketInstance;
+}
+
 /**
  * 用户身份类型枚举
  */
@@ -472,6 +600,48 @@ export declare interface StatisticsParams {
     param5?: string;
 }
 
+/**
+ * 讲师信息
+ */
+export declare interface TeacherInfo {
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 用户昵称
+     */
+    nick: string;
+    /**
+     * 用户头像
+     */
+    pic: string;
+    /**
+     * 头衔
+     */
+    actor?: string;
+}
+
+declare interface TrackEventData {
+    /** 事件名 */
+    event_id: string;
+    /** 事件类型 */
+    event_type: string;
+    /** 事件属性，不能为空对象 */
+    spec_attrs: Record<string, unknown>;
+}
+
+declare interface UpdateSessionOptions {
+    /**
+     * 场次号
+     */
+    sessionId?: string;
+    /**
+     * 是否指定场次
+     */
+    inTargetSession?: boolean;
+}
+
 /**
  * 用户信息
  */
@@ -500,6 +670,14 @@ export declare interface UserInfo {
      * 头衔
      */
     actor?: string;
+    /**
+     * 用户登录方式
+     */
+    authType?: string;
+    /**
+     * 分组 id
+     */
+    groupId?: string;
     /**
      * 微信 unionId
      */