@polyv/chat-ui 2.0.0-rc-20250925.2 → 2.1.0-rc-20251023.1

package/index.d.ts

@@ -1,5 +1,7 @@
-import { ChatMsgSource } from '@polyv/chat-sdk';
-import { ChatMsgType } from '@polyv/chat-sdk';
+import { ChatMessageUser } from '@polyv/chat';
+import { ChatMsgRewardType } from '@polyv/chat';
+import { ChatMsgSource } from '@polyv/chat';
+import { ChatMsgType } from '@polyv/chat';
 import { ComponentCustomProperties } from 'vue';
 import { ComponentOptions } from 'vue';
 import { ComponentOptionsBase } from 'vue';
@@ -7,37 +9,63 @@ import { ComponentOptionsMixin } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractComputedReturns } from 'vue/types/v3-component-options';
 import { ExtractPropTypes } from 'vue';
-import { PickChatMsgType } from '@polyv/chat-sdk';
-import { PolyvChat } from '@polyv/chat-sdk';
+import { PickChatMsgType } from '@polyv/chat';
+import { PolyvChat } from '@polyv/chat';
+import { SendEmotionImageMsgOptions } from '@polyv/chat';
+import { SendImageMsgOptions } from '@polyv/chat';
+import { SendSpeakMsgOptions } from '@polyv/chat';
 import { ShallowUnwrapRef } from 'vue';
+import { SystemMsgType } from '@polyv/chat';
 import { ValidatorFunction } from 'vue-types/dist/types';
 import { Vue3Instance } from 'vue/types/v3-component-public-instance';
 import { VueTypeValidableDef } from 'vue-types';
 
 declare const __VLS_component: DefineComponent<    {
+defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+/** 是否显示更多 */
 showMore: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
 default: boolean;
 } & {
 default: boolean;
 };
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+/** 是否显示更多 */
 showMore: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
 default: boolean;
 } & {
 default: boolean;
 };
 }>>, {
+defaultHeight: number;
 showMore: boolean;
 }>;
 
+declare const __VLS_component_2: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
         'more-panel'?(_: {}): any;
+        'icon-left-suffix'?(_: {}): any;
+        'icon-right-suffix'?(_: {}): any;
         'bottom-suffix'?(_: {}): any;
     };
     refs: {
         msgInputBaseRef: (Vue3Instance<    {}, Readonly<ExtractPropTypes<    {
+        defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
         showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
         default: boolean;
         } & {
@@ -62,6 +90,11 @@ declare function __VLS_template(): {
         default: number;
         };
         }>>, Readonly<ExtractPropTypes<    {
+        defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
         showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
         default: boolean;
         } & {
@@ -90,17 +123,23 @@ declare function __VLS_template(): {
         contentList: InputContent[];
         }) => void;
         resize: (arg?: void | undefined) => void;
-        "send-image": (arg?: void | undefined) => void;
         "system-msg": (arg: {
         content: string;
         }) => void;
+        "click-send-image": (arg?: void | undefined) => void;
         }, {
         disabledInput: boolean;
         placeholder: string;
         disabledSubmitBtn: boolean;
         maxInputTextLength: number;
+        defaultHeight: number;
         showBottom: boolean;
         }, true, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>> & Readonly<Readonly<ExtractPropTypes<    {
+        defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
         showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
         default: boolean;
         } & {
@@ -127,6 +166,11 @@ declare function __VLS_template(): {
         }>>> & ShallowUnwrapRef<    {
         focusInput: () => void;
         }> & ExtractComputedReturns<    {}> & ComponentCustomProperties & Readonly<ExtractPropTypes<    {
+        defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
         showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
         default: boolean;
         } & {
@@ -164,14 +208,37 @@ declare function __VLS_template(): {
     rootEl: HTMLDivElement;
 };
 
+declare function __VLS_template_2(): {
+    attrs: Partial<{}>;
+    slots: {
+        'body-suffix'?(_: {}): any;
+        suffix?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+
 declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 
+declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $scopedSlots: S;
     };
 };
 
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $scopedSlots: S;
+    };
+};
+
+/**
+ * 动画来源
+ */
+declare type AnimationSource = 'donate-svga-animation' | 'donate-animation';
+
 export declare const BanList: DefineComponent<    {}, {
 openBanList: () => void;
 closeBanList: () => void;
@@ -202,23 +269,65 @@ export declare interface ChatGlobalInject {
      * 在线列表配置
      */
     getOnlineConfig?: () => OnlineConfig;
+    /**
+     * 获取打赏配置
+     */
+    getDonateConfig?: () => DonateConfig;
     /**
      * 获取直播状态
      */
     getLiveStatus?: () => string;
+    /**
+     * 获取是否显示动画
+     */
+    getAnimationVisible?: (animationSource: AnimationSource) => boolean;
+    /**
+     * 拦截处理，返回 true 表示终止后续的业务逻辑执行
+     */
+    interceptClick?: (triggerSource: InterceptTriggerSource) => boolean | Promise<boolean>;
 }
 
-export declare const ChatMessageInputManager: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
-
 export declare const ChatMessageInputPopup: DefineComponent<    {}, {
 showInputPopup: typeof showInputPopup;
 closeInputPopup: typeof closeInputPopup;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
-export declare const ChatMessageList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+export declare const ChatMessageInputSection: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare const ChatMessageList: DefineComponent<    {}, {
+setIsOnlySpecialMsg: (value: boolean) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 declare function closeInputPopup(): void;
 
+export declare const DonateAnimation: DefineComponent<    {
+trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+}>>, {
+trackCount: number;
+}>;
+
+/**
+ * 打赏配置
+ */
+declare interface DonateConfig {
+    /**
+     * 获取打赏 svga 地址
+     */
+    getSvgaUrl?: (chatMsg: ChatMsgRewardType) => Promise<string | undefined> | string | undefined;
+}
+
+export declare const DonateSvgaAnimation: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
 /**
  * 文字类型，normal-普通文字，nickname-用户昵称，productName-商品名称
  */
@@ -226,7 +335,7 @@ export declare type EffectTextType = 'normal' | 'nickname' | 'productName' | 'do
 
 export declare const GlobalVariable = "PolyvChatUI";
 
-declare interface HistoryConfig {
+export declare interface HistoryConfig {
     /**
      * 是否获取企微我的客户的消息
      * @default false
@@ -257,7 +366,7 @@ export declare interface InputConfig {
     disabledInput?: boolean;
     /**
      * 发送图片开关
-     * @defualt true
+     * @default true
      */
     sendImageEnabled?: boolean;
     /**
@@ -279,6 +388,19 @@ export declare interface InputContentText {
     content: string;
 }
 
+/**
+ * 拦截来源
+ *
+ * send-image: 发送图片
+ * emotion-picker: 表情选择
+ * chat-quote: 引用回复
+ * more-panel: 更多面板
+ * click-message-input: 消息输入框
+ * focus-message-input: 聚焦输入框
+ * click-submit: 点击提交按钮
+ */
+export declare type InterceptTriggerSource = 'send-image' | 'emotion-picker' | 'chat-quote' | 'more-panel' | 'click-message-input' | 'focus-message-input' | 'click-submit';
+
 export declare const KickList: DefineComponent<    {}, {
 openKickList: () => void;
 closeKickList: () => void;
@@ -331,7 +453,7 @@ export declare interface ManageConfig {
     /**
      * 私聊用户回调
      */
-    askUserCallback?: boolean | ((chatMsg: ChatMsgType) => void);
+    askUserCallback?: boolean | ((user: ChatMessageUser) => void);
     /**
      * 聊天室全体禁言开关
      * @default false
@@ -342,10 +464,24 @@ export declare interface ManageConfig {
      * @default false
      */
     pushSpeakMsgToQaEnabled?: boolean;
+    /**
+     * 到勤名单开关
+     */
+    attendanceEnabled?: boolean;
+    /**
+     * 白名单开关
+     */
+    whiteListEnabled?: boolean;
+    /**
+     * 下载在线列表开关
+     */
+    downloadOnlineListEnabled?: boolean;
 }
 
 export declare const ManagerInputControl: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
+export declare const MemberList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
 export declare interface MessageConfig {
     /**
      * 聊天区通知文本
@@ -404,11 +540,6 @@ export declare interface MessageConfig {
      * @default false
      */
     quoteEnabled?: boolean;
-    /**
-     * 回复是否响应聊天室关闭
-     * @default false
-     */
-    quoteResponseChatRoomClosed?: boolean;
     /**
      * 消息水平间距
      * @default { left: 16, right: 16 }
@@ -417,6 +548,14 @@ export declare interface MessageConfig {
         left: number;
         right: number;
     };
+    /**
+     * 消息容器边界间距
+     * @default { top: 0, bottom: 0 }
+     */
+    messageContainerBoundaryPadding?: {
+        top: number;
+        bottom: number;
+    };
     /**
      * 鼠标悬停高亮
      * @default false
@@ -565,7 +704,7 @@ export declare enum MessageEffectType {
 }
 
 /**
- * 消息布局，紧凑布局和宽松布局
+ * 消息布局，compact-紧凑布局，loose-宽松布局
  */
 export declare type MessageLayout = 'compact' | 'loose';
 
@@ -574,22 +713,34 @@ export declare type MessageLayout = 'compact' | 'loose';
  */
 declare type MsgControlInteraction = 'context-menu' | 'hover' | 'bubble' | 'action-sheet';
 
-declare interface OnlineConfig {
+export declare interface OnlineConfig {
     /**
      * 请求获取的在线列表数量
      * @default 200
      */
     requestCount?: number;
+    /**
+     * 在线人数更新回调
+     * @param count 在线人数
+     */
+    onlineCountCallback?: (count: number) => void;
 }
 
-export declare const OnlineList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-"total-change": (arg: number) => void;
-}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
 declare function showInputPopup(): void;
 
 export declare const TopingMsgList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 export declare const useChatGlobalProvide: (injectData: ChatGlobalInject) => void;
 
+export declare const useSendMsg: () => {
+    sendSpeakMsg: (options: SendSpeakMsgOptions) => Promise<void>;
+    sendImageMsg: (options: SendImageMsgOptions) => Promise<void>;
+    sendEmotionImageMsg: (options: SendEmotionImageMsgOptions) => Promise<void>;
+    sendSystemMsg: (content: string, type?: SystemMsgType) => void;
+    choiceImageFileSend: () => Promise<void>;
+    sendContentList: (contentList: InputContent[], quoteMsg?: ChatMsgType) => Promise<void>;
+};
+
+export declare const ViewerInputControl: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
 export { }