@polyv/socket 2.0.0-rc-20250925.1 → 2.1.0-rc-20251023.1

package/index.es.d.ts

@@ -1,4 +1,5 @@
 import { AppSignSecretKey } from '@polyv/request-plugin-authorize-app-sign';
+import { AuthorizeAppSignRequestOptions } 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';
@@ -7,6 +8,8 @@ import { RequestOptions } from '@polyv/request-core';
 import { SignatureMethod } from '@polyv/request-plugin-authorize-app-sign';
 import { SM2Key } from '@polyv/request-plugin-sm2';
 
+export { AuthorizeAppSignRequestOptions }
+
 /**
  * 频道信息
  */
@@ -36,9 +39,10 @@ declare class ChatApiRequest extends PolyvRequest<ChatApiRequestOptions> {
     private _plvSocket;
     constructor(_plvSocket: PolyvSocket);
     /**
-     * 获取聊天室签名
+     * 获取房间号签名
      */
-    getChatSign(): Promise<string | undefined>;
+    getRoomSign(): Promise<string | undefined>;
+    getChatSign(params: Record<string, unknown>): Promise<string | undefined>;
 }
 
 declare interface ChatApiRequestOptions extends RequestOptions {
@@ -62,6 +66,11 @@ declare interface ChatApiRequestOptions extends RequestOptions {
      * @default false
      */
     appendSign?: boolean;
+    /**
+     * 插入聊天室签名
+     * @default false
+     */
+    appendChatSign?: boolean;
 }
 
 /**
@@ -91,10 +100,15 @@ export declare type EventHandler = (msg: any) => unknown;
 /** 事件 key */
 export declare type EventKey = string;
 
-export declare type MaybePromise<R> = () => Promise<R> | R;
+export declare type MaybePromiseFn<R> = () => Promise<R> | R;
 
 declare class PolyvApiRequest extends PolyvRequest<PolyvApiRequestOptions> {
+    private _plvSocket;
     constructor(_plvSocket: PolyvSocket);
+    /**
+     * 根据用户类型获取 token 字段
+     */
+    getTokenFieldByUserType(): Promise<string>;
 }
 
 declare interface PolyvApiRequestOptions extends RequestOptions {
@@ -103,6 +117,7 @@ declare interface PolyvApiRequestOptions extends RequestOptions {
 export declare class PolyvSocket extends PolyvSocketBase {
     ConnectFailReason: typeof ConnectFailReason;
     SocketUserType: typeof SocketUserType;
+    PolyvSocketEvent: typeof PolyvSocketEvent;
     /**
      * 聊天室 api 请求器
      */
@@ -159,7 +174,7 @@ declare class PolyvSocketBase {
     /**
      * 获取连接令牌
      */
-    getToken(): Promise<string>;
+    getToken(): Promise<string | undefined>;
     /**
      * 获取频道信息
      */
@@ -167,7 +182,7 @@ declare class PolyvSocketBase {
     /**
      * 获取用户信息
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUserInfo(): UserInfo;
     getSocket(check?: true): SocketInstance;
     getSocket(check: false): SocketInstance | undefined;
     /**
@@ -213,7 +228,7 @@ export declare interface PolyvSocketConfig {
     /**
      * 连接令牌
      */
-    token: string;
+    token?: string;
     /**
      * 频道信息
      */
@@ -221,7 +236,7 @@ export declare interface PolyvSocketConfig {
     /**
      * 用户信息
      */
-    userInfo: UserInfo;
+    userInfo: UserInfo | (() => UserInfo);
     /**
      * 域名信息
      */
@@ -248,11 +263,11 @@ export declare interface PolyvSocketConfig {
     /**
      * 获取用户令牌信息
      */
-    getViewerToken?: MaybePromise<ViewerTokenData>;
+    getViewerToken?: MaybePromiseFn<ViewerTokenData>;
     /**
      * 获取频道令牌信息
      */
-    getChannelToken?: MaybePromise<ChannelTokenData>;
+    getChannelToken?: MaybePromiseFn<ChannelTokenData>;
     /**
      * 授权方式
      * @default RequestAuthorizeMethod.Token
@@ -356,6 +371,8 @@ export declare enum SecurityMode {
     SM2 = "sm2"
 }
 
+export { SignatureMethod }
+
 /**
  * socket 的事件处理集合
  */