@polyv/chat-ui 2.0.0-rc-20250925.1

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@polyv/chat-ui",
+  "version": "2.0.0-rc-20250925.1",
+  "main": "./index.es.js",
+  "dependencies": {},
+  "types": "./index.d.ts"
+}

package/special.d.ts

@@ -0,0 +1,590 @@
+import { ChatMsgSource } from '@polyv/chat-sdk';
+import { ChatMsgType } from '@polyv/chat-sdk';
+import { ComponentCustomProperties } from 'vue';
+import { ComponentOptions } from 'vue';
+import { ComponentOptionsBase } from 'vue';
+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 { ShallowUnwrapRef } from 'vue';
+import { ValidatorFunction } from 'vue-types/dist/types';
+import { Vue3Instance } from 'vue/types/v3-component-public-instance';
+import { VueTypeValidableDef } from '../../../../../../node_modules/vue-types';
+
+declare const __VLS_component: DefineComponent<    {
+showMore: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+showMore: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}>>, {
+showMore: boolean;
+}>;
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'more-panel'?(_: {}): any;
+        'bottom-suffix'?(_: {}): any;
+    };
+    refs: {
+        msgInputBaseRef: (Vue3Instance<    {}, Readonly<ExtractPropTypes<    {
+        showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
+        default: string;
+        };
+        disabledInput: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        disabledSubmitBtn: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        maxInputTextLength: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
+        }>>, Readonly<ExtractPropTypes<    {
+        showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
+        default: string;
+        };
+        disabledInput: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        disabledSubmitBtn: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        maxInputTextLength: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
+        }>>, {
+        submit: (arg: {
+        contentList: InputContent[];
+        }) => void;
+        resize: (arg?: void | undefined) => void;
+        "send-image": (arg?: void | undefined) => void;
+        "system-msg": (arg: {
+        content: string;
+        }) => void;
+        }, {
+        disabledInput: boolean;
+        placeholder: string;
+        disabledSubmitBtn: boolean;
+        maxInputTextLength: number;
+        showBottom: boolean;
+        }, true, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>> & Readonly<Readonly<ExtractPropTypes<    {
+        showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
+        default: string;
+        };
+        disabledInput: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        disabledSubmitBtn: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        maxInputTextLength: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
+        }>>> & ShallowUnwrapRef<    {
+        focusInput: () => void;
+        }> & ExtractComputedReturns<    {}> & ComponentCustomProperties & Readonly<ExtractPropTypes<    {
+        showBottom: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
+        default: string;
+        };
+        disabledInput: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        disabledSubmitBtn: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        maxInputTextLength: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+        default: number;
+        } & {
+        default: number;
+        };
+        }>> & {
+            $scopedSlots: {
+                'panel-suffix'?(_: {}): any;
+                'icon-left'?(_: {}): any;
+                'icon-left-suffix'?(_: {}): any;
+                'icon-right-suffix'?(_: {}): any;
+                input?(_: {}): any;
+                'bottom-suffix'?(_: {}): any;
+            };
+        }) | null;
+    };
+    rootEl: HTMLDivElement;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $scopedSlots: S;
+    };
+};
+
+export declare const BanList: DefineComponent<    {}, {
+openBanList: () => void;
+closeBanList: () => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare interface ChatGlobalInject {
+    /**
+     * 获取聊天室实例对象
+     */
+    getChatTarget: () => PolyvChat;
+    /**
+     * 获取消息配置
+     */
+    getMessageConfig?: () => MessageConfig;
+    /**
+     * 获取输入框配置
+     */
+    getInputConfig?: () => InputConfig;
+    /**
+     * 获取管理配置
+     */
+    getManageConfig?: () => ManageConfig | boolean;
+    /**
+     * 获取历史记录配置
+     */
+    getHistoryConfig?: () => HistoryConfig;
+    /**
+     * 在线列表配置
+     */
+    getOnlineConfig?: () => OnlineConfig;
+    /**
+     * 获取直播状态
+     */
+    getLiveStatus?: () => string;
+}
+
+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<    {}>>, {}>;
+
+declare function closeInputPopup(): void;
+
+/**
+ * 文字类型，normal-普通文字，nickname-用户昵称，productName-商品名称
+ */
+export declare type EffectTextType = 'normal' | 'nickname' | 'productName' | 'donateName';
+
+export declare const GlobalVariable = "PolyvChatUISpecial";
+
+declare interface HistoryConfig {
+    /**
+     * 是否获取企微我的客户的消息
+     * @default false
+     */
+    workWechatMyCustomerHistory?: boolean;
+}
+
+export declare interface InputConfig {
+    /**
+     * 聊天室输入框占位符
+     * @default ''
+     */
+    inputPlaceholder?: string;
+    /**
+     * 黄脸表情开关
+     * @default true
+     */
+    faceEmotionEnabled?: boolean;
+    /**
+     * 图片表情开关
+     * @default true
+     */
+    imageEmotionEnabled?: boolean;
+    /**
+     * 是否禁用输入框
+     * @default false
+     */
+    disabledInput?: boolean;
+    /**
+     * 发送图片开关
+     * @defualt true
+     */
+    sendImageEnabled?: boolean;
+    /**
+     * 输入框遮罩文案
+     * @default ''
+     */
+    inputMaskPlaceholder?: string;
+}
+
+export declare type InputContent = InputContentText | InputContentImage;
+
+export declare interface InputContentImage {
+    type: 'img';
+    file: File;
+}
+
+export declare interface InputContentText {
+    type: 'text';
+    content: string;
+}
+
+export declare const KickList: DefineComponent<    {}, {
+openKickList: () => void;
+closeKickList: () => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+/**
+ * 管理配置
+ */
+export declare interface ManageConfig {
+    /**
+     * 删除消息开关
+     * @default false
+     */
+    deleteMsgEnabled?: boolean;
+    /**
+     * 清空消息开关
+     * @default false
+     */
+    clearMsgEnabled?: boolean;
+    /**
+     * 禁言用户开关
+     * @default false
+     */
+    banUserEnabled?: boolean;
+    /**
+     * 禁言 ip 开关
+     * @default false
+     */
+    banIpEnabled?: boolean;
+    /**
+     * 踢出用户开关
+     * @default false
+     */
+    kickUserEnabled?: boolean;
+    /**
+     * 课堂激励开关
+     * @default false
+     */
+    motivationLikeEnabled?: boolean;
+    /**
+     * 置顶消息开关
+     * @default false
+     */
+    topMsgEnabled?: boolean;
+    /**
+     * 私聊用户开关
+     * @default false
+     */
+    askUserEnabled?: boolean;
+    /**
+     * 私聊用户回调
+     */
+    askUserCallback?: boolean | ((chatMsg: ChatMsgType) => void);
+    /**
+     * 聊天室全体禁言开关
+     * @default false
+     */
+    chatSwitchEnabled?: boolean;
+    /**
+     * 推送观众发言消息到问答开关
+     * @default false
+     */
+    pushSpeakMsgToQaEnabled?: boolean;
+}
+
+export declare const ManagerInputControl: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare interface MessageConfig {
+    /**
+     * 聊天区通知文本
+     * @default ''
+     */
+    introductionText?: string;
+    /**
+     * 需要隐藏的消息来源
+     * @default []
+     */
+    hideSources?: ChatMsgSource[];
+    /**
+     * 隐藏消息处理
+     * @default {}
+     */
+    hideMessage?: {
+        [msgSource in ChatMsgSource]?: (chatMsg: PickChatMsgType<msgSource>) => boolean;
+    };
+    /**
+     * 是否显示消息时间
+     * @default true
+     */
+    showMessageTime?: boolean;
+    /**
+     * 消息布局
+     * @default compact
+     */
+    messageLayout?: MessageLayout;
+    /**
+     * 是否显示消息的用户头像
+     * @default true
+     */
+    showUserAvatar?: boolean;
+    /**
+     * 是否显示普通观众的头衔
+     * @default false
+     */
+    showOrdinaryActor?: boolean;
+    /**
+     * 翻译开关
+     * @default false
+     */
+    translateEnabled?: boolean;
+    /**
+     * 复制文本消息开关
+     * @default false
+     */
+    copySpeakEnabled?: boolean;
+    /**
+     * 引用回复开关
+     * @default false
+     */
+    quoteEnabled?: boolean;
+    /**
+     * 回复是否响应聊天室关闭
+     * @default false
+     */
+    quoteResponseChatRoomClosed?: boolean;
+    /**
+     * 消息水平间距
+     * @default { left: 16, right: 16 }
+     */
+    messageHorizontalSpacing?: {
+        left: number;
+        right: number;
+    };
+    /**
+     * 鼠标悬停高亮
+     * @default false
+     */
+    hoverHighlight?: boolean;
+    /**
+     * 消息操作交互类型
+     * @default 'context-menu'
+     */
+    messageControlInteraction?: MsgControlInteraction;
+    /**
+     * 是否显示图片预览图标
+     * @default false
+     */
+    imagePreviewIcon?: boolean;
+    /**
+     * 自己发言消息对齐方式，仅 loose 宽松模式下生效
+     * @default 'left'
+     */
+    selfMsgAlign?: 'left' | 'right';
+    /**
+     * 点击消息回调
+     * @default {}
+     */
+    clickMsgCallback?: {
+        [msgSource in ChatMsgSource]?: (chatMsg: PickChatMsgType<msgSource>) => void;
+    };
+    /**
+     * 自定义消息渲染内容
+     * @default {}
+     */
+    customMessageRender?: {
+        [ChatMsgSource.Redpaper]?: ComponentOptions<any>;
+    };
+    /**
+     * 消息大小开关
+     * @default false
+     */
+    messageSizeEnabled?: boolean;
+    /**
+     * 是否显示虚拟人的头衔
+     * @default false
+     */
+    showDummyActor?: boolean;
+    /**
+     * 只看主持人开关
+     * @default false
+     */
+    onlySpecialMsgEnabled?: boolean;
+    /**
+     * 消息自动翻译开关
+     * @default false
+     */
+    autoTranslateEnabled?: boolean;
+}
+
+/**
+ * 消息特效数据
+ */
+export declare interface MessageEffectData {
+    id: string;
+    /**
+     * 特效类型
+     */
+    effectType: MessageEffectType;
+    /**
+     * 昵称列表
+     */
+    nicknames: string[];
+    /**
+     * 昵称数量
+     */
+    nicknameCount: number;
+    /**
+     * 目标 id
+     */
+    targetId: string | number;
+    /**
+     * 目标名称
+     */
+    targetName: string;
+    /**
+     * 目标数量
+     */
+    targetCount?: number;
+    /**
+     * 目标图片
+     */
+    targetImage?: string;
+    /**
+     * 商品类消息的商品类型
+     */
+    productType?: string;
+    /**
+     * 字符串模板
+     */
+    strTemplate: string;
+}
+
+/**
+ * 消息特效文字节点
+ */
+export declare interface MessageEffectTextItem {
+    /**
+     * 文字类型
+     */
+    textType: EffectTextType;
+    /**
+     * 文字内容
+     */
+    text: string;
+    /**
+     * 数量
+     */
+    count?: number;
+    /**
+     * 图片
+     */
+    image?: string;
+}
+
+/**
+ * 消息特效类型
+ */
+export declare enum MessageEffectType {
+    /**
+     * 用户访问
+     */
+    JoinVisit = "JoinVisit",
+    /**
+     * 商品点击
+     */
+    ProductClick = "ProductClick",
+    /**
+     * 商品下单
+     */
+    ProductBuy = "ProductBuy",
+    /**
+     * 用户签到
+     */
+    CheckIn = "CheckIn",
+    /**
+     * 打赏
+     */
+    Donate = "Donate"
+}
+
+/**
+ * 消息布局，紧凑布局和宽松布局
+ */
+export declare type MessageLayout = 'compact' | 'loose';
+
+/**
+ * 消息操作交互类型
+ */
+declare type MsgControlInteraction = 'context-menu' | 'hover' | 'bubble' | 'action-sheet';
+
+declare interface OnlineConfig {
+    /**
+     * 请求获取的在线列表数量
+     * @default 200
+     */
+    requestCount?: number;
+}
+
+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 { }