@polyv/socket 2.0.0-rc-20250925.1

package/index.es.d.ts

@@ -0,0 +1,511 @@
+import { AppSignSecretKey } from '@polyv/request-plugin-authorize-app-sign';
+import { EventEmitter } from '@polyv/utils/es/event';
+import { GetAppSignFn } from '@polyv/request-plugin-authorize-app-sign';
+import { PickDomainInfo } from '@polyv/request-plugin-polyv-business';
+import { PolyvRequest } from '@polyv/request-core';
+import { RequestOptions } from '@polyv/request-core';
+import { SignatureMethod } from '@polyv/request-plugin-authorize-app-sign';
+import { SM2Key } from '@polyv/request-plugin-sm2';
+
+/**
+ * 频道信息
+ */
+export declare interface ChannelInfo {
+    /**
+     * 频道号
+     */
+    channelId: string;
+    /**
+     * 场次号
+     */
+    sessionId?: string;
+    /**
+     * 保利威账号 id
+     */
+    accountId?: string;
+}
+
+/**
+ * 频道令牌数据
+ */
+export declare interface ChannelTokenData {
+    channelToken: string;
+}
+
+declare class ChatApiRequest extends PolyvRequest<ChatApiRequestOptions> {
+    private _plvSocket;
+    constructor(_plvSocket: PolyvSocket);
+    /**
+     * 获取聊天室签名
+     */
+    getChatSign(): Promise<string | undefined>;
+}
+
+declare interface ChatApiRequestOptions extends RequestOptions {
+    /**
+     * 插入频道号
+     * @default true
+     */
+    appendChannelId?: boolean;
+    /**
+     * 插入保利威账号 id
+     * @default false
+     */
+    appendAccountId?: boolean;
+    /**
+     * 插入用户 userId
+     * @default true
+     */
+    appendUserId?: boolean;
+    /**
+     * 插入频道号签名
+     * @default false
+     */
+    appendSign?: boolean;
+}
+
+/**
+ * socket 连接失败原因
+ */
+export declare enum ConnectFailReason {
+    /**
+     * 令牌过期
+     */
+    TokenExpired = "TokenExpired",
+    /**
+     * socket 连接失败
+     */
+    SocketConnectError = "SocketConnectError",
+    /**
+     * socket 连接超时
+     */
+    SocketConnectTimeout = "SocketConnectTimeout"
+}
+
+/** 应用名 */
+export declare type EventAppName = string;
+
+/** 事件处理 */
+export declare type EventHandler = (msg: any) => unknown;
+
+/** 事件 key */
+export declare type EventKey = string;
+
+export declare type MaybePromise<R> = () => Promise<R> | R;
+
+declare class PolyvApiRequest extends PolyvRequest<PolyvApiRequestOptions> {
+    constructor(_plvSocket: PolyvSocket);
+}
+
+declare interface PolyvApiRequestOptions extends RequestOptions {
+}
+
+export declare class PolyvSocket extends PolyvSocketBase {
+    ConnectFailReason: typeof ConnectFailReason;
+    SocketUserType: typeof SocketUserType;
+    /**
+     * 聊天室 api 请求器
+     */
+    chatApi: ChatApiRequest;
+    /**
+     * 保利威 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>;
+    /**
+     * 事件存储
+     */
+    private __eventStore;
+    /**
+     * Socket 连接实例
+     */
+    private __socket?;
+    constructor(config: PolyvSocketConfig);
+    /**
+     * @hook 连接成功后
+     */
+    protected _afterConnect(): void;
+    /**
+     * 获取连接令牌
+     */
+    getToken(): Promise<string>;
+    /**
+     * 获取频道信息
+     */
+    getChannelInfo(): Promise<ChannelInfo>;
+    /**
+     * 获取用户信息
+     */
+    getUserInfo(): Promise<UserInfo>;
+    getSocket(check?: true): SocketInstance;
+    getSocket(check: false): SocketInstance | undefined;
+    /**
+     * 初始化 Socket
+     */
+    protected _initSocket(): Promise<void>;
+    /**
+     * 连接 Socket
+     */
+    protected _connectSocket(): Promise<void>;
+    /**
+     * 监听 socket 连接事件
+     */
+    private __bindConnectEvent;
+    /**
+     * 发送 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>;
+    /**
+     * 添加 socket 事件监听
+     * @param appName 应用名称
+     * @param handlers 消息事件处理对象
+     * @param socketType socket 事件类型
+     */
+    addSocketHandles(appName: EventAppName, handlers: SocketEventStoreHandlers | EventHandler, socketType?: SocketEventType): void;
+    /**
+     * 断开 Socket 连接
+     */
+    disconnect(): Promise<void>;
+}
+
+/**
+ * 保利威 socket 配置
+ */
+export declare interface PolyvSocketConfig {
+    /**
+     * 连接令牌
+     */
+    token: string;
+    /**
+     * 频道信息
+     */
+    channelInfo: ChannelInfo;
+    /**
+     * 用户信息
+     */
+    userInfo: UserInfo;
+    /**
+     * 域名信息
+     */
+    domainInfo?: PickDomainInfo<'polyvApiDomain' | 'chatApiDomain' | 'chatWsDomain'>;
+    /**
+     * socket 连接版本号
+     *
+     * @default 3.0
+     */
+    socketVersion?: string;
+    /**
+     * 自定义 socket 连接实例，如果提供了该实例，则不会自动创建 socket 连接和连接 socket
+     */
+    customSocket?: SocketInstance;
+    /**
+     * 自动登录聊天室 socket
+     * @default true
+     */
+    autoLogin?: boolean;
+    /**
+     * 统计参数
+     */
+    statisticsParams?: StatisticsParams;
+    /**
+     * 获取用户令牌信息
+     */
+    getViewerToken?: MaybePromise<ViewerTokenData>;
+    /**
+     * 获取频道令牌信息
+     */
+    getChannelToken?: MaybePromise<ChannelTokenData>;
+    /**
+     * 授权方式
+     * @default RequestAuthorizeMethod.Token
+     */
+    authorizeMethod?: RequestAuthorizeMethod;
+    /**
+     * 获取 app 签名
+     */
+    getAppSign?: GetAppSignFn;
+    /**
+     * 应用签名密钥
+     */
+    appSignSecretKey?: AppSignSecretKey;
+    /**
+     * 是否使用放重放，仅 `RequestAuthorizeMethod.Sign` 时有效
+     * @default false
+     */
+    signatureNonce?: boolean;
+    /**
+     * 签名方式，仅 `RequestAuthorizeMethod.Sign` 时有效
+     * @default SignatureMethod.MD5
+     */
+    signatureMethod?: SignatureMethod;
+    /**
+     * 安全模式
+     */
+    securityMode?: SecurityMode;
+    /**
+     * SM2 密钥，仅 `SecurityMode.SM2` 时有效
+     */
+    sm2Key?: SM2Key;
+}
+
+export declare enum PolyvSocketEvent {
+    /**
+     * 连接成功
+     */
+    ConnectSuccess = "ConnectSuccess",
+    /**
+     * 重连成功
+     */
+    ReconnectSuccess = "ReconnectSuccess",
+    /**
+     * 连接失败
+     */
+    ConnectFailed = "ConnectFailed",
+    /**
+     * 断开连接
+     */
+    Disconnect = "Disconnect",
+    /**
+     * 登录成功
+     */
+    LoginSuccess = "LoginSuccess",
+    /**
+     * 登录失败
+     */
+    LoginFailed = "LoginFailed"
+}
+
+export declare type PolyvSocketEventRelations = {
+    [PolyvSocketEvent.ConnectFailed]: {
+        /**
+         * 连接失败原因
+         */
+        reason: ConnectFailReason;
+    };
+    [PolyvSocketEvent.LoginSuccess]: {
+        /**
+         * 登录状态码
+         */
+        code: number;
+    };
+    [PolyvSocketEvent.LoginFailed]: {
+        /**
+         * 登录状态码
+         */
+        code: number;
+    };
+};
+
+/**
+ * 请求授权方式
+ */
+export declare enum RequestAuthorizeMethod {
+    /** 通过令牌授权 */
+    Token = "token",
+    /** 通过签名授权 */
+    Sign = "sign"
+}
+
+/**
+ * 安全模式
+ */
+export declare enum SecurityMode {
+    /** 不使用 */
+    None = "none",
+    /** AES 加密解密 */
+    AES = "aes",
+    /** SM2 加密解密 */
+    SM2 = "sm2"
+}
+
+/**
+ * socket 的事件处理集合
+ */
+export declare type SocketEventStoreHandlers = {
+    [eventKey: EventKey]: EventHandler;
+};
+
+/**
+ * socket 类型
+ */
+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 interface SocketInstance {
+    /** 是否已断开连接 */
+    disconnected: boolean;
+    /** 是否已连接 */
+    connected: boolean;
+    /** 连接 */
+    connect: () => void;
+    /** 断开连接 */
+    disconnect: () => void;
+    /** 发送消息 */
+    emit: (event: string, ...args: any[]) => void;
+    /** 监听事件 */
+    on: (event: string, callback: (...args: any[]) => void) => void;
+    /** 监听一次事件 */
+    once: (event: string, callback: (...args: any[]) => void) => void;
+}
+
+/**
+ * 用户身份类型枚举
+ */
+export declare enum SocketUserType {
+    /**
+     * 普通频道观众身份
+     */
+    Student = "student",
+    /**
+     * 云课堂频道观众身份
+     */
+    Slice = "slice",
+    /**
+     * 观众
+     */
+    Viewer = "viewer",
+    /**
+     * 讲师
+     */
+    Teacher = "teacher",
+    /**
+     * 助教
+     */
+    Assistant = "assistant",
+    /**
+     * 管理员
+     */
+    Manager = "manager",
+    /**
+     * 嘉宾
+     */
+    Guest = "guest",
+    /**
+     * 标签管理员
+     */
+    UserTagsMonitor = "userTagsMonitor",
+    /**
+     * 研讨会参与者
+     */
+    Attendee = "attendee",
+    /**
+     * 研讨会观众身份
+     */
+    Listener = "listener",
+    /**
+     * 研讨会主持人
+     */
+    Host = "host",
+    /**
+     * 虚拟人
+     */
+    Dummy = "dummy"
+}
+
+/**
+ * 统计参数
+ */
+export declare interface StatisticsParams {
+    /**
+     * 自定义统计参数 p4
+     */
+    param4?: string;
+    /**
+     * 自定义统计参数 p5
+     */
+    param5?: string;
+}
+
+/**
+ * 用户信息
+ */
+export declare interface UserInfo {
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 用户系统唯一 id
+     */
+    unionId?: string;
+    /**
+     * 用户昵称
+     */
+    nick: string;
+    /**
+     * 用户头像
+     */
+    pic: string;
+    /**
+     * 用户类型
+     */
+    userType: SocketUserType;
+    /**
+     * 头衔
+     */
+    actor?: string;
+    /**
+     * 微信 unionId
+     */
+    wxUnionId?: string;
+    /**
+     * 微信 openId
+     */
+    wxOpenId?: string;
+    /**
+     * 用户系统的标签 id
+     */
+    labelIds?: number[];
+    /**
+     * 企微用户标签id
+     */
+    workWechatTagId?: string;
+}
+
+/**
+ * 用户令牌数据
+ */
+export declare interface ViewerTokenData {
+    viewerToken: string;
+}
+
+export { }