fcr-ui-scene 1.0.40 → 3.1.0

package/lib/modules/chat/mock.js

@@ -0,0 +1,283 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.messages = void 0;
+require("core-js/modules/es.date.now.js");
+var messages = exports.messages = [{
+  id: '1',
+  nickName: 'AliceAliceAlice',
+  uid: '111',
+  role: 'union-host',
+  time: '2023-12-29 12:20 AM',
+  msg: '测试 time 省略',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '2',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: '2023-12-29 12:21 AM',
+  msg: 'Hello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '3',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: '03-12 12:20 PM  ',
+  msg: '测试别人发送的私聊消息',
+  color: 'var(--fcr_ui_scene_icontext1)',
+  isPrivate: true
+},
+// TODO: 当可视区域最后一条消息的时间距离现在，差 ? 时，需要插入一条时间消息
+{
+  id: '4',
+  nickName: '',
+  uid: '',
+  color: '',
+  role: 'system',
+  time: '14:20 AM',
+  msg: '',
+  systemMsg: true,
+  chatLevel: 'everyone'
+}, {
+  id: '5',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: '14:20 PM',
+  msg: 'Hello, how can I help you?Hello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '6',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?Hello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)',
+  isPrivate: true
+}, {
+  id: '7',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: '测试私聊消息换行',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '8',
+  nickName: 'Alice_AliceAliceAlice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: '测试名称 ... 截断',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '9',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '10',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '11',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '12',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '13',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '14',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '15',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '16',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '17',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?Hello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help youHello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '18',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '19',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '20',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '21',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '22',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '23',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '24',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '25',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '26',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '27',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '28',
+  nickName: 'Alice',
+  uid: '111',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '29',
+  nickName: 'Bob',
+  uid: '222',
+  role: 'participant',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '30',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '31',
+  nickName: 'Cherry',
+  uid: '333',
+  role: 'host',
+  time: Date.now(),
+  msg: 'Hello, how can I help you?',
+  color: 'var(--fcr_ui_scene_icontext1)'
+}, {
+  id: '32',
+  nickName: 'Alice',
+  uid: '111',
+  color: '',
+  role: 'host',
+  time: Date.now(),
+  msg: '',
+  systemMsg: true,
+  chatLevel: 'no_one'
+}, {
+  id: '33',
+  nickName: 'Cherry',
+  uid: '333',
+  color: '',
+  role: 'host',
+  time: Date.now(),
+  msg: '',
+  systemMsg: true,
+  chatLevel: 'everyone'
+}];

package/lib/modules/chat/store.d.ts

@@ -0,0 +1,132 @@
+import { FcrUserControl } from 'agora-edu-core';
+import { RoleType } from 'agora-ui-foundation/lib/components/message-bubble';
+import { FcrChatRoomControl } from 'agora-edu-core/lib/room-control/chatroom-control';
+import { FcrChatRoomMessageType, FcrUserRole, FcrUserInfo, FcrChatRoomFile, FcrChatRoomConnectionState } from 'agora-edu-core/lib/type';
+import { FcrUIEventStore } from '../../common/event-store';
+import { FcrSecurityStore } from '../../common/security-store';
+import { CellMeasurerCache, List } from 'react-virtualized';
+import { AllowChatLevelType } from 'agora-ui-foundation/lib/components/chat-manager';
+import { ToastConfig } from 'agora-ui-foundation/lib/components/toast';
+export interface MsgListType {
+    id: string;
+    nickName: string;
+    uid: string;
+    role: RoleType;
+    time: number | string;
+    msg?: string;
+    img?: FcrChatRoomFile;
+    color: string;
+    systemMsg?: boolean;
+    chatLevel?: AllowChatLevelType;
+    isPrivate?: boolean;
+    target?: string;
+}
+export declare const USER_ALL = "All";
+export declare const USER_NONE = "NONE";
+export declare const allToUser: FcrUserInfo;
+export declare const noUser: FcrUserInfo;
+export default class ChatStore {
+    needCbBottomCount: number;
+    list: List | undefined;
+    mostRecentHeight: number;
+    mostRecentWidth: number;
+    cache: CellMeasurerCache;
+    scrollHeight: number;
+    scrollTop: number;
+    clientHeight: number;
+    firstMsgId: string;
+    lastReadInfo: {
+        index: number;
+        msgId: string;
+    };
+    lastScrollTop: undefined | number;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _uiEventStore;
+    private _userControl;
+    private _chatRoomControl;
+    private _securityStore;
+    private _maxMsgCount;
+    private _originalMessages;
+    private _disposers;
+    private accessor _userInfo;
+    accessor messageList: MsgListType[];
+    accessor readMsgIndex: {
+        index: number;
+        msgId: string;
+    };
+    accessor readIdx: number;
+    accessor viewIdx: number;
+    accessor historyUnreadCount: number;
+    accessor hasHistoryMsg: boolean;
+    accessor newMsgsUnReadCnt: number;
+    accessor privateTargetUser: FcrUserInfo;
+    accessor chatLevel: AllowChatLevelType;
+    accessor currentUserMap: Map<string, FcrUserInfo>;
+    accessor textMsg: string;
+    accessor privateTargetList: FcrUserInfo[];
+    accessor chatRoomState: FcrChatRoomConnectionState;
+    private _chatRoomObserver;
+    private _userObserver;
+    constructor({ chatRoomControl, userControl, uiEventStore, securityStore, }: {
+        chatRoomControl: FcrChatRoomControl;
+        userControl: FcrUserControl;
+        uiEventStore: FcrUIEventStore;
+        securityStore: FcrSecurityStore;
+    });
+    release(): void;
+    setLastScrollTop(value: number | undefined): void;
+    setMessageList(messages: MsgListType[]): void;
+    sendMessage(msg: string | FcrChatRoomFile, type: FcrChatRoomMessageType): Promise<void>;
+    private messageReceived;
+    private _handleTextMessageReceived;
+    private _onRemoteUserUpdate;
+    private _onUserPropertiesUpdated;
+    private _onUserInfoUpdated;
+    private _refreshUserList;
+    handleNewMsg(msg: MsgListType): void;
+    updateReadMsgIndex(info?: {
+        index: number;
+        msgId: string;
+    }): void;
+    get allowChat(): boolean;
+    get allowedAllChat(): boolean | undefined;
+    get allowedPublicChatAndDisallowedPrivateChat(): boolean | undefined;
+    get disallowedPublicChatAndDisallowedPrivateChatToParticipant(): boolean | undefined;
+    get disallowedAllChat(): boolean | undefined;
+    get hasChatPermission(): boolean;
+    get isHost(): boolean;
+    get isCohost(): boolean;
+    get localIsManager(): boolean;
+    private _addReactions;
+    initReadInfo(): void;
+    updateHistoryUnreadCnt(historyUnreadCount: number): void;
+    updateHasHistoryMsg(hasHistoryMsg: boolean): void;
+    updateScrollInfo(listScrollHeight: number, listScrollTop: number, listClientHeight: number): void;
+    updateViewIdx(viewIdx: number): void;
+    updateReadIdx(readIdx: number): void;
+    updateFirstMsgId(firstMsgId: string): void;
+    updateHistoryUnReadCount(historyUnReadCount: number): void;
+    updateList(list: List): void;
+    updateMostRecentHeight(mostRecentHeight: number): void;
+    updateMostRecentWidth(mostRecentWidth: number): void;
+    patchHandleMsg(): void;
+    forceNotifyMsgs(): void;
+    resetComponentCache(): void;
+    resetTargetUser(): void;
+    initChatLevel(): void;
+    setTargetUser(user: FcrUserInfo): void;
+    get targetUserIsOnline(): boolean;
+    get remoteUsers(): FcrUserInfo[];
+    handleChatPermissionUpdate(chatLevel: AllowChatLevelType): void;
+    updateChatLevel(chatLevel: AllowChatLevelType): void;
+    get privilegeOperator(): FcrUserInfo | undefined;
+    updateChatTextMsg(txt: string): void;
+    permitPrivateChat(userId: string): void;
+    handleToast(params: ToastConfig): void;
+    get isHostOrCoHost(): boolean;
+    setAllowChat(allowChat: boolean): void;
+    setAllowChatWithPayload(type: 'public' | 'private_to_manager'): void;
+    private _handleConnectionUpdated;
+}
+export declare function isManager(role: FcrUserRole): boolean;
+export declare function sortUsers(users: FcrUserInfo[]): FcrUserInfo[];