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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polyv/chat-ui",
-  "version": "2.1.0-rc-20251023.2",
+  "version": "2.3.0-rc-20251204.1",
   "main": "./index.es.js",
   "dependencies": {},
   "types": "./index.d.ts"

package/special.d.ts

@@ -1,4 +1,4 @@
-import { ChatMessageUser } from '@polyv/chat';
+import { AskMsgType } from '@polyv/chat';
 import { ChatMsgRewardType } from '@polyv/chat';
 import { ChatMsgSource } from '@polyv/chat';
 import { ChatMsgType } from '@polyv/chat';
@@ -6,11 +6,14 @@ import { ComponentCustomProperties } from 'vue';
 import { ComponentOptions } from 'vue';
 import { ComponentOptionsBase } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
+import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractComputedReturns } from 'vue/types/v3-component-options';
 import { ExtractPropTypes } from 'vue';
+import { GlobalStoreDefinition } from '@polyv/vue-components';
 import { PickChatMsgType } from '@polyv/chat';
 import { PolyvChat } from '@polyv/chat';
+import { Ref } from 'vue';
 import { SendEmotionImageMsgOptions } from '@polyv/chat';
 import { SendImageMsgOptions } from '@polyv/chat';
 import { SendSpeakMsgOptions } from '@polyv/chat';
@@ -18,9 +21,35 @@ 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 '../../../../../../node_modules/vue-types';
+import { VueTypeValidableDef } from '../../../../../../../node_modules/vue-types';
+import { VueTypeValidableDef as VueTypeValidableDef_2 } from '../../../../../../node_modules/vue-types';
+import { VueTypeValidableDef as VueTypeValidableDef_3 } from '../../../../../node_modules/vue-types';
 
 declare const __VLS_component: DefineComponent<    {
+/**
+* 是否显示发送图片图标
+* @default false
+*/
+showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+/**
+* 是否显示发送图片图标
+* @default false
+*/
+showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}>>, {
+showSendImage: boolean;
+}>;
+
+declare const __VLS_component_2: DefineComponent<    {
 defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
 default: number;
 } & {
@@ -49,9 +78,17 @@ defaultHeight: number;
 showMore: boolean;
 }>;
 
-declare const __VLS_component_2: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
 declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'body-suffix'?(_: {}): any;
+        suffix?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+
+declare function __VLS_template_2(): {
     attrs: Partial<{}>;
     slots: {
         'more-panel'?(_: {}): any;
@@ -61,6 +98,7 @@ declare function __VLS_template(): {
     };
     refs: {
         msgInputBaseRef: (Vue3Instance<    {}, Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -71,6 +109,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -89,7 +132,18 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>, Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -100,6 +154,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -118,6 +177,16 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>, {
         submit: (arg: {
         contentList: InputContent[];
@@ -129,12 +198,16 @@ declare function __VLS_template(): {
         "click-send-image": (arg?: void | undefined) => void;
         }, {
         disabledInput: boolean;
+        showSendImage: boolean;
         placeholder: string;
+        showFaceEmotion: boolean;
+        showImageEmotion: boolean;
         disabledSubmitBtn: boolean;
         maxInputTextLength: number;
         defaultHeight: number;
         showBottom: boolean;
         }, true, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>> & Readonly<Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -145,6 +218,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -163,9 +241,20 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>> & ShallowUnwrapRef<    {
         focusInput: () => void;
         }> & ExtractComputedReturns<    {}> & ComponentCustomProperties & Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -176,6 +265,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -194,6 +288,16 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>> & {
             $scopedSlots: {
                 'panel-suffix'?(_: {}): any;
@@ -204,20 +308,11 @@ declare function __VLS_template(): {
                 'bottom-suffix'?(_: {}): any;
             };
         }) | null;
+        morePanelRef: HTMLDivElement;
     };
     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>;
@@ -237,18 +332,50 @@ declare type __VLS_WithTemplateSlots_2<T, S> = T & {
 /**
  * 动画来源
  */
-declare type AnimationSource = 'donate-svga-animation' | 'donate-animation';
+declare type AnimationSource = 'donate-animation' | 'chat-like' | 'special-effect-animation';
+
+/**
+ * 提问配置
+ */
+declare interface AskConfig {
+    /**
+     * 提问欢迎语
+     * @default ''
+     */
+    askWelcomeText?: string;
+    /**
+     * 显示在线状态
+     * @default false
+     */
+    showOnlineStatus?: boolean;
+    /**
+     * 提问新消息回调
+     */
+    onNewAskMessage?: (askMsg: AskMsgType) => void;
+}
 
 export declare const BanList: DefineComponent<    {}, {
 openBanList: () => void;
 closeBanList: () => void;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
+export declare interface BaseConfig {
+    /**
+     * 是否隐藏昵称
+     * @default false
+     */
+    hideNickname?: boolean;
+}
+
 export declare interface ChatGlobalInject {
     /**
      * 获取聊天室实例对象
      */
     getChatTarget: () => PolyvChat;
+    /**
+     * 获取基础配置
+     */
+    getBaseConfig?: () => BaseConfig;
     /**
      * 获取消息配置
      */
@@ -273,6 +400,14 @@ export declare interface ChatGlobalInject {
      * 获取打赏配置
      */
     getDonateConfig?: () => DonateConfig;
+    /**
+     * 获取点赞配置
+     */
+    getLikeConfig?: () => LikeConfig;
+    /**
+     * 获取特效配置
+     */
+    getSpecialEffectConfig?: () => SpecialEffectConfig;
     /**
      * 获取直播状态
      */
@@ -281,18 +416,26 @@ export declare interface ChatGlobalInject {
      * 获取是否显示动画
      */
     getAnimationVisible?: (animationSource: AnimationSource) => boolean;
+    /**
+     * 获取提问配置
+     */
+    getAskConfig?: () => AskConfig;
     /**
      * 拦截处理，返回 true 表示终止后续的业务逻辑执行
      */
     interceptClick?: (triggerSource: InterceptTriggerSource) => boolean | Promise<boolean>;
 }
 
+export declare const ChatMessageInputControl: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
 export declare const ChatMessageInputPopup: DefineComponent<    {}, {
 showInputPopup: typeof showInputPopup;
 closeInputPopup: typeof closeInputPopup;
-}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"visible-change": (arg: boolean) => void;
+}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
-export declare const ChatMessageInputSection: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export declare const ChatMessageInputSection: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
 
 export declare const ChatMessageList: DefineComponent<    {}, {
 setIsOnlySpecialMsg: (value: boolean) => void;
@@ -301,13 +444,13 @@ setIsOnlySpecialMsg: (value: boolean) => void;
 declare function closeInputPopup(): void;
 
 export declare const DonateAnimation: DefineComponent<    {
-trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+trackCount: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
 };
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
-trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+trackCount: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
@@ -326,8 +469,6 @@ declare interface DonateConfig {
     getSvgaUrl?: (chatMsg: ChatMsgRewardType) => Promise<string | undefined> | string | undefined;
 }
 
-export declare const DonateSvgaAnimation: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
 /**
  * 文字类型，normal-普通文字，nickname-用户昵称，productName-商品名称
  */
@@ -341,14 +482,14 @@ export declare interface HistoryConfig {
      * @default false
      */
     workWechatMyCustomerHistory?: boolean;
+    /**
+     * 是否获取聊天历史消息
+     * @default true
+     */
+    getChatHistory?: boolean;
 }
 
 export declare interface InputConfig {
-    /**
-     * 聊天室输入框占位符
-     * @default ''
-     */
-    inputPlaceholder?: string;
     /**
      * 黄脸表情开关
      * @default true
@@ -365,15 +506,29 @@ export declare interface InputConfig {
      */
     disabledInput?: boolean;
     /**
-     * 发送图片开关
+     * 输入框遮罩文案
+     * @default ''
+     */
+    inputMaskPlaceholder?: string;
+    /**
+     * 聊天室输入框占位符
+     * @default ''
+     */
+    chatInputPlaceholder?: string;
+    /**
+     * 聊天区发送图片开关
      * @default true
      */
-    sendImageEnabled?: boolean;
+    sendChatImageEnabled?: boolean;
     /**
-     * 输入框遮罩文案
+     * 提问区输入框占位符
      * @default ''
      */
-    inputMaskPlaceholder?: string;
+    askInputPlaceholder?: string;
+    /**
+     * 提问区发送图片开关
+     */
+    sendAskImageEnabled?: boolean;
 }
 
 export declare type InputContent = InputContentText | InputContentImage;
@@ -398,14 +553,41 @@ export declare interface InputContentText {
  * click-message-input: 消息输入框
  * focus-message-input: 聚焦输入框
  * click-submit: 点击提交按钮
+ * chat-like: 点赞
  */
-export declare type InterceptTriggerSource = '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' | 'chat-like';
 
 export declare const KickList: DefineComponent<    {}, {
 openKickList: () => void;
 closeKickList: () => void;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
+/**
+ * 点赞配置
+ */
+declare interface LikeConfig {
+    /**
+     * 点击开关
+     * @default true
+     */
+    clickEnabled?: boolean;
+    /**
+     * 按住开关
+     * @default true
+     */
+    holdEnabled?: boolean;
+    /**
+     * 数量位置
+     * @default 'bottom'
+     */
+    countPosition?: 'top' | 'bottom';
+    /**
+     * 触发节点大小
+     * @default 40
+     */
+    triggerSize?: number;
+}
+
 /**
  * 管理配置
  */
@@ -450,10 +632,6 @@ export declare interface ManageConfig {
      * @default false
      */
     askUserEnabled?: boolean;
-    /**
-     * 私聊用户回调
-     */
-    askUserCallback?: boolean | ((user: ChatMessageUser) => void);
     /**
      * 聊天室全体禁言开关
      * @default false
@@ -478,9 +656,23 @@ export declare interface ManageConfig {
     downloadOnlineListEnabled?: boolean;
 }
 
-export declare const ManagerInputControl: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
-export declare const MemberList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+export declare const MemberList: DefineComponent<    {
+showTop: VueTypeValidableDef_3<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}, {
+openRulePopup: typeof openRulePopup;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+showTop: VueTypeValidableDef_3<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}>>, {
+showTop: boolean;
+}>;
 
 export declare interface MessageConfig {
     /**
@@ -488,6 +680,11 @@ export declare interface MessageConfig {
      * @default ''
      */
     introductionText?: string;
+    /**
+     * 聊天区系统消息
+     * @default ''
+     */
+    systemText?: string;
     /**
      * 是否显示聊天室空数据提示
      * @default false
@@ -499,7 +696,7 @@ export declare interface MessageConfig {
      */
     hideSources?: ChatMsgSource[];
     /**
-     * 隐藏消息处理
+     * 隐藏消息处理，返回 true 时消息隐藏
      * @default {}
      */
     hideMessage?: {
@@ -556,6 +753,16 @@ export declare interface MessageConfig {
         top: number;
         bottom: number;
     };
+    /**
+     * 消息容器边界阴影配置
+     * @default { topHeight: 0 }
+     */
+    messageContainerBoundaryShadow?: {
+        /**
+         * 顶部阴影高度
+         */
+        topHeight?: number;
+    };
     /**
      * 鼠标悬停高亮
      * @default false
@@ -610,6 +817,12 @@ export declare interface MessageConfig {
      * @default false
      */
     autoTranslateEnabled?: boolean;
+    /**
+     * 是否隐藏滚动条
+     * @description 滚动条消失，但滚动仍然可用
+     * @default false
+     */
+    hideScrollbar?: boolean;
 }
 
 /**
@@ -653,6 +866,10 @@ export declare interface MessageEffectData {
      * 字符串模板
      */
     strTemplate: string;
+    /**
+     * 背景色
+     */
+    bgColor?: string;
 }
 
 /**
@@ -719,6 +936,21 @@ export declare interface OnlineConfig {
      * @default 200
      */
     requestCount?: number;
+    /**
+     * 搜索在线列表开关
+     * @default true
+     */
+    searchEnabled?: boolean;
+    /**
+     * 规则开关
+     * @default false
+     */
+    ruleEnabled?: boolean;
+    /**
+     * 轮训间隔，单位：毫秒
+     * @default 10000
+     */
+    pollingTime?: number;
     /**
      * 在线人数更新回调
      * @param count 在线人数
@@ -726,13 +958,60 @@ export declare interface OnlineConfig {
     onlineCountCallback?: (count: number) => void;
 }
 
+declare function openRulePopup(): void;
+
+export declare const RunwayEffect: DefineComponent<    {
+left: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+left: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
+default: number;
+} & {
+default: number;
+};
+}>>, {
+left: number;
+}>;
+
 declare function showInputPopup(): void;
 
+export declare const SpecialEffectAnimation: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+/**
+ * 特效配置
+ */
+export declare interface SpecialEffectConfig {
+    /**
+     * 屏蔽特效开关
+     * @default false
+     */
+    switchEnabled?: boolean;
+    /**
+     * 默认是否显示
+     * @default true
+     */
+    defaultVisible?: boolean;
+    /**
+     * 特效显示切换回调
+     */
+    visibleChangeCallback?: (visible: boolean) => void;
+}
+
 export declare const TopingMsgList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 export declare const useChatGlobalProvide: (injectData: ChatGlobalInject) => void;
 
-export declare const useSendMsg: () => {
+export declare const useOnlySpecialStore: GlobalStoreDefinition<"only-special", {
+canOnlySpecialMsg: ComputedRef<boolean>;
+isOnlySpecialMsg: Ref<boolean>;
+setIsOnlySpecialMsg: (value: boolean) => void;
+toggleOnlySpecialMsg: () => void;
+}>;
+
+export declare const useSendChatMsg: () => {
     sendSpeakMsg: (options: SendSpeakMsgOptions) => Promise<void>;
     sendImageMsg: (options: SendImageMsgOptions) => Promise<void>;
     sendEmotionImageMsg: (options: SendEmotionImageMsgOptions) => Promise<void>;
@@ -741,6 +1020,15 @@ export declare const useSendMsg: () => {
     sendContentList: (contentList: InputContent[], quoteMsg?: ChatMsgType) => Promise<void>;
 };
 
-export declare const ViewerInputControl: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+export declare const useSpecialEffectStore: GlobalStoreDefinition<"special-effect", {
+/** 特效显隐 */
+specialEffectVisible: Ref<boolean>;
+/** 切换特效显隐 */
+toggleSpecialEffect: () => void;
+/** 显示特效 */
+showSpecialEffect: () => void;
+/** 隐藏特效 */
+hideSpecialEffect: () => void;
+}>;
 
 export { }