educast-classroom-sdk 2.4.1 → 2.4.3

package/lib/infra/capabilities/containers/widget/slots.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+export declare const Chat: () => JSX.Element;
+export declare const Whiteboard: () => JSX.Element;
+export declare const CountDownMobile: () => JSX.Element;
+export declare const PollMobile: () => JSX.Element;
+export declare const WhiteboardMobile: () => JSX.Element;
+export declare const ChatMobile: () => JSX.Element;
+export declare const Watermark: () => JSX.Element;

package/lib/infra/capabilities/containers/widget/track.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+import { Dimensions, Point, Track, TrackOptions } from 'agora-edu-core';
+declare type TrackSyncingProps = {
+    draggable: boolean;
+    resizable: boolean;
+    controlled: boolean;
+    handle?: string;
+    cancel?: string;
+    syncOn?: 'drag' | 'drop';
+    minWidth?: number;
+    minHeight?: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    boundaryName?: string;
+    children?: React.ReactNode;
+    zIndex?: number;
+    track: Track;
+    onChange: (end: boolean, pos: Point, dimensions?: Dimensions, options?: TrackOptions) => void;
+    onZIndexChange: () => void;
+};
+export declare const TrackCore: React.FC<TrackSyncingProps>;
+export {};

package/lib/infra/capabilities/scenarios/1v1/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const OneToOneScenario: () => JSX.Element;

package/lib/infra/capabilities/scenarios/big-class/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const BigClassScenario: () => JSX.Element;

package/lib/infra/capabilities/scenarios/big-class-mobile/index.mobile.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import './index.mobile.css';
+export declare const BigClassScenarioMobile: () => JSX.Element;
+export declare const DialogContainerMobile: React.FC<unknown>;
+interface GenericErrorDialogMobileProps {
+    onOK: () => void;
+    okBtnText: string;
+    title: string;
+    content: string;
+}
+export declare const GenericErrorDialogMobile: ({ onOK, title, content, okBtnText, }: GenericErrorDialogMobileProps) => JSX.Element;
+export {};

package/lib/infra/capabilities/scenarios/big-class-mobile/zbj-layout.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import './zbj-mobile.css';
+export declare const ZbjMobileLayout: () => JSX.Element;

package/lib/infra/capabilities/scenarios/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { EduRoomTypeEnum } from 'agora-edu-core';
+import '@classroom/ui-kit/styles/global.css';
+import '@classroom/ui-kit/styles/scenario.css';
+export declare type ScenariosProps = {
+    pretest: boolean;
+    roomType: EduRoomTypeEnum;
+};
+export declare const renderRoomSceneWith: (roomType: EduRoomTypeEnum) => JSX.Element | null;
+export declare const Scenarios: React.FC<ScenariosProps>;

package/lib/infra/capabilities/scenarios/mid-class/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const MidClassScenario: () => JSX.Element;

package/lib/infra/capabilities/scenarios/room/index.d.ts

@@ -0,0 +1,6 @@
+import React, { FC } from 'react';
+declare type Props = {
+    children?: React.ReactNode;
+};
+declare const Room: FC<Props>;
+export default Room;

package/lib/infra/configs/base-theme.d.ts

@@ -0,0 +1,391 @@
+import { FcrMultiThemes } from 'agora-common-libs';
+declare class FcrMultiThemesImpl implements FcrMultiThemes {
+    get light(): {
+        /**
+         * 背景色
+         */
+        readonly background: string;
+        /**
+         * 前景色
+         */
+        readonly foreground: string;
+        /**
+         * 组件背景色
+         */
+        readonly brand: string;
+        /**
+         * 分割线颜色
+         */
+        readonly divider: string;
+        /**
+         * 错误提示颜色
+         */
+        readonly error: string;
+        /**
+         * 警告提示色
+         */
+        readonly warning: string;
+        /**
+         * 一般提示色
+         */
+        readonly safe: string;
+        /**
+         * Icon 主色
+         */
+        readonly iconPrimary: string;
+        /**
+         * Icon 副色
+         */
+        readonly iconSecondary: string;
+        /**
+         * 图标被选背景色
+         */
+        readonly iconSelected: string;
+        /**
+         * 组件背景色
+         */
+        readonly component: string;
+        readonly toastNormal: string;
+        readonly textPrimaryButton: string;
+        readonly textLevel1: string;
+        readonly textLevel2: string;
+        readonly textLevel3: string;
+        readonly textDisable: string;
+        readonly textLink: string;
+        /**
+         * 块颜色 1
+         */
+        /** @en
+         * Block color 1
+         */
+        readonly v2Block1: string;
+        /**
+         * 块颜色 2
+         */
+        /** @en
+         * Block color 2
+         */
+        readonly v2Block2: string;
+        /**
+         * 块颜色 3
+         */
+        /** @en
+         * Block color 3
+         */
+        readonly v2Block3: string;
+        /**
+         * 块颜色 4
+         */
+        /** @en
+         * Block color 4
+         */
+        readonly v2Block4: string;
+        /**
+         * 块颜色 5
+         */
+        /** @en
+         * Block color 5
+         */
+        readonly v2Block5: string;
+        /**
+         * 块颜色 6
+         */
+        /** @en
+         * Block color 6
+         */
+        readonly v2Block6: string;
+        /**
+         * 块颜色 7
+         */
+        /** @en
+         * Block color 7
+         */
+        readonly v2Block7: string;
+        /**
+         * 块颜色 8
+         */
+        /** @en
+         * Block color 8
+         */
+        readonly v2Block8: string;
+        /**
+         * 边框和线条颜色 1
+         */
+        /** @en
+         * Border and line color 1
+         */
+        readonly v2Line1: string;
+        /**
+         * 字体颜色 1
+         */
+        /** @en
+         * Font color 1
+         */
+        readonly v2Text1: string;
+        /**
+         * 字体颜色 2
+         */
+        /** @en
+         * Font color 2
+         */
+        readonly v2Text2: string;
+        /**
+         * 字体颜色 3
+         */
+        /** @en
+         * Font color 3
+         */
+        readonly v2Text3: string;
+        /**
+         * 图标颜色 1
+         */
+        /** @en
+         * Icon color 1
+         */
+        readonly v2Icon1: string;
+        /**
+         * 图标颜色 2
+         */
+        /** @en
+         * Icon color 2
+         */
+        readonly v2Icon2: string;
+        /**
+         * 悬浮颜色
+         */
+        /** @en
+         * Hover color
+         */
+        readonly v2Hover: string;
+        /**
+         * 阴影颜色 1
+         */
+        /** @en
+         * Shadow color 1
+         */
+        readonly v2Shadow1: string;
+        /**
+         * 阴影颜色 2
+         */
+        /** @en
+         * Shadow color 2
+         */
+        readonly v2Shadow2: string;
+        /**
+         * 阴影颜色 3
+         */
+        /** @en
+         * Shadow color 3
+         */
+        readonly v2Shadow3: string;
+        /**
+         * 基色
+         */
+        /** @en
+         * essential color
+         */
+        readonly v2Essential: string;
+        /**
+         * 基色反色
+         */
+        /** @en
+         *  essential color inverse
+         */
+        readonly v2EssentialInverse: string;
+    };
+    get dark(): {
+        /**
+         * 背景色
+         */
+        readonly background: string;
+        /**
+         * 前景色
+         */
+        readonly foreground: string;
+        /**
+         * 组件背景色
+         */
+        readonly brand: string;
+        /**
+         * 分割线颜色
+         */
+        readonly divider: string;
+        /**
+         * 错误提示颜色
+         */
+        readonly error: string;
+        /**
+         * 警告提示色
+         */
+        readonly warning: string;
+        /**
+         * 一般提示色
+         */
+        readonly safe: string;
+        /**
+         * Icon 主色
+         */
+        readonly iconPrimary: string;
+        /**
+         * Icon 副色
+         */
+        readonly iconSecondary: string;
+        /**
+         * 图标被选背景色
+         */
+        readonly iconSelected: string;
+        /**
+         * 组件背景色
+         */
+        readonly component: string;
+        readonly toastNormal: string;
+        readonly textPrimaryButton: string;
+        readonly textLevel1: string;
+        readonly textLevel2: string;
+        readonly textLevel3: string;
+        readonly textDisable: string;
+        readonly textLink: string;
+        /**
+         * 块颜色 1
+         */
+        /** @en
+         * Block color 1
+         */
+        readonly v2Block1: string;
+        /**
+         * 块颜色 2
+         */
+        /** @en
+         * Block color 2
+         */
+        readonly v2Block2: string;
+        /**
+         * 块颜色 3
+         */
+        /** @en
+         * Block color 3
+         */
+        readonly v2Block3: string;
+        /**
+         * 块颜色 4
+         */
+        /** @en
+         * Block color 4
+         */
+        readonly v2Block4: string;
+        /**
+         * 块颜色 5
+         */
+        /** @en
+         * Block color 5
+         */
+        readonly v2Block5: string;
+        /**
+         * 块颜色 6
+         */
+        /** @en
+         * Block color 6
+         */
+        readonly v2Block6: string;
+        /**
+         * 块颜色 7
+         */
+        /** @en
+         * Block color 7
+         */
+        readonly v2Block7: string;
+        /**
+         * 块颜色 8
+         */
+        /** @en
+         * Block color 8
+         */
+        readonly v2Block8: string;
+        /**
+         * 边框和线条颜色 1
+         */
+        /** @en
+         * Border and line color 1
+         */
+        readonly v2Line1: string;
+        /**
+         * 字体颜色 1
+         */
+        /** @en
+         * Font color 1
+         */
+        readonly v2Text1: string;
+        /**
+         * 字体颜色 2
+         */
+        /** @en
+         * Font color 2
+         */
+        readonly v2Text2: string;
+        /**
+         * 字体颜色 3
+         */
+        /** @en
+         * Font color 3
+         */
+        readonly v2Text3: string;
+        /**
+         * 图标颜色 1
+         */
+        /** @en
+         * Icon color 1
+         */
+        readonly v2Icon1: string;
+        /**
+         * 图标颜色 2
+         */
+        /** @en
+         * Icon color 2
+         */
+        readonly v2Icon2: string;
+        /**
+         * 悬浮颜色
+         */
+        /** @en
+         * Hover color
+         */
+        readonly v2Hover: string;
+        /**
+         * 阴影颜色 1
+         */
+        /** @en
+         * Shadow color 1
+         */
+        readonly v2Shadow1: string;
+        /**
+         * 阴影颜色 2
+         */
+        /** @en
+         * Shadow color 2
+         */
+        readonly v2Shadow2: string;
+        /**
+         * 阴影颜色 3
+         */
+        /** @en
+         * Shadow color 3
+         */
+        readonly v2Shadow3: string;
+        /**
+         * 基色
+         */
+        /** @en
+         * essential color
+         */
+        readonly v2Essential: string;
+        /**
+         * 基色反色
+         */
+        /** @en
+         *  essential color inverse
+         */
+        readonly v2EssentialInverse: string;
+    };
+}
+export declare const baseTheme: FcrMultiThemesImpl;
+export {};

package/lib/infra/configs/base-ui.d.ts

@@ -0,0 +1,14 @@
+import { FcrEngagement, FcrExtension, FcrFooter, FcrHeader, FcrStage, FcrUIConfig } from 'agora-common-libs';
+declare class FcrUIConfigImpl implements FcrUIConfig {
+    get version(): string;
+    get name(): string;
+    get header(): FcrHeader;
+    get stage(): FcrStage;
+    get engagement(): FcrEngagement;
+    get footer(): FcrFooter;
+    get extension(): FcrExtension;
+}
+export declare const room1V1Class: FcrUIConfigImpl;
+export declare const roomMidClass: FcrUIConfigImpl;
+export declare const roomBigClass: FcrUIConfigImpl;
+export {};

package/lib/infra/contexts/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export declare class EduContext {
+    private static _shareContext?;
+    static get shared(): React.Context<any>;
+    static reset(): void;
+    static create(): React.Context<{
+        oneToOne: import("agora-edu-core").EduClassroomStore;
+        interactive: import("agora-edu-core").EduClassroomStore;
+        lecture: import("agora-edu-core").EduClassroomStore;
+        oneToOneUI: import("../stores/common").EduClassroomUIStore;
+        interactiveUI: import("../stores/common").EduClassroomUIStore;
+        lectureUI: import("../stores/common").EduClassroomUIStore;
+        lectureH5UI: import("../stores/common").EduClassroomUIStore;
+    }>;
+}

package/lib/infra/contexts/ui-store-factory.d.ts

@@ -0,0 +1,6 @@
+import { EduClassroomStore, EduRoomTypeEnum } from 'agora-edu-core';
+import { EduClassroomUIStore } from '../stores/common';
+export declare class EduUIStoreFactory {
+    static createWithType(roomType: EduRoomTypeEnum, store: EduClassroomStore): EduClassroomUIStore;
+    static createWithTypeH5(roomType: EduRoomTypeEnum, store: EduClassroomStore): EduClassroomUIStore;
+}

package/lib/infra/hooks/cabinet.d.ts

@@ -0,0 +1,4 @@
+export declare const useExtensionCabinets: () => {
+    openExtensionCabinet: (id: string, remote?: any) => void;
+    isInstalled: (id: string) => boolean;
+};

package/lib/infra/hooks/index.d.ts

@@ -0,0 +1,6 @@
+import { DependencyList } from 'react';
+export declare const useInteractionThrottleHandler: <T>(func: T, options: {
+    limitMs?: number;
+    limitFunc?: () => void;
+}, deps: DependencyList) => T;
+export declare const useClickAnywhere: (cb: () => void) => import("react").RefObject<HTMLDivElement>;

package/lib/infra/hooks/ui-store.d.ts

@@ -0,0 +1,10 @@
+import { EduClassroomUIStore } from '../stores/common';
+import { EduInteractiveUIClassStore } from '../stores/interactive';
+import { EduLectureUIStore } from '../stores/lecture';
+import { EduLectureH5UIStore } from '../stores/lecture-mobile';
+import { Edu1v1ClassUIStore } from '../stores/one-on-one';
+export declare const use1v1UIStores: () => Edu1v1ClassUIStore;
+export declare const useInteractiveUIStores: () => EduInteractiveUIClassStore;
+export declare const useLectureUIStores: () => EduLectureUIStore;
+export declare const useLectureH5UIStores: () => EduLectureH5UIStore;
+export declare function useStore(): EduClassroomUIStore;

package/lib/infra/hooks/utilites.d.ts

@@ -0,0 +1,3 @@
+export declare const useInterval: (fun: CallableFunction, delay: number, start: boolean) => void;
+export declare const useTimout: (fun: CallableFunction, delay: number, start: boolean) => void;
+export declare const useEffectOnce: (effect: any) => void;

package/lib/infra/protocol/board.d.ts

@@ -0,0 +1,70 @@
+import { AgoraWidgetController } from 'agora-edu-core';
+import { Logger } from 'agora-rte-sdk';
+import { BoardConnectionState, BoardMountState, FcrBoardShape, FcrBoardTool } from './type';
+export declare class Board {
+    logger: Logger;
+    private _controller?;
+    private _disposers;
+    grantedUsers: Set<string>;
+    connState: BoardConnectionState;
+    mountState: BoardMountState;
+    undoSteps: number;
+    redoSteps: number;
+    pageIndex: number;
+    pageCount: number;
+    strokeColor: {
+        r: number;
+        g: number;
+        b: number;
+    };
+    strokeWidth: number;
+    selectedTool?: FcrBoardTool | undefined;
+    selectedShape?: FcrBoardShape;
+    get connected(): boolean;
+    get mounted(): boolean;
+    get granted(): boolean;
+    enable(): void;
+    disable(): void;
+    addPage(): void;
+    removePage(): void;
+    gotoPage(index: number): void;
+    undo(): void;
+    redo(): void;
+    clean(): void;
+    putImageResource(url: string, pos?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }): void;
+    putImageResourceIntoWindow(src: string): void;
+    selectTool(tool: FcrBoardTool): void;
+    drawShape(shape: FcrBoardShape): void;
+    grantPrivilege(userUuid: string, granted: boolean): void;
+    changeStrokeWidth(strokeWidth: number): void;
+    changeStrokeColor(color: {
+        r: number;
+        g: number;
+        b: number;
+    }): void;
+    loadAttributes(): void;
+    saveAttributes(): void;
+    getSnapshotImageList(): void;
+    setDelay(delay: number): void;
+    hasPrivilege(): boolean;
+    install(controller: AgoraWidgetController): void;
+    uninstall(): void;
+    private _handleRequestGrantedList;
+    private _handleDragOver;
+    private _handleDrop;
+    private _handleRedoStepsChanged;
+    private _handleUndoStepsChanged;
+    private _handlePageInfoChanged;
+    private _handleGrantedUpdate;
+    private _handleSnapshotImageReceived;
+    private _handleConnStateChanged;
+    private _handleMountStateChanged;
+    private _resetTool;
+    private _waitReply;
+    private _sendBoardCommandMessage;
+}

package/lib/infra/protocol/events.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 此类事件从教室发出，在Widget中监听
+ */
+/** @en
+ * Events that come from SDK toward widget
+ */
+export declare enum AgoraExtensionRoomEvent {
+    /** 白板 */
+    BoardSelectTool = "board-select-tool",
+    BoardAddPage = "board-add-page",
+    BoardRemovePage = "board-remove-page",
+    BoardGotoPage = "board-goto-page",
+    BoardUndo = "board-undo",
+    BoardRedo = "board-redo",
+    BoardClean = "board-clean",
+    BoardPutImageResource = "board-put-image-resource",
+    BoardPutImageResourceIntoWindow = "board-put-image-resource-into-window",
+    BoardOpenMaterialResourceWindow = "board-open-material-resource-window",
+    BoardOpenMediaResourceWindow = "board-open-media-resource-window",
+    BoardOpenH5ResourceWindow = "board-open-h5-resource-window",
+    BoardDrawShape = "board-draw-shape",
+    BoardGrantPrivilege = "board-grant-privilege",
+    BoardChangeStrokeWidth = "board-change-stroke-width",
+    BoardChangeStrokeColor = "board-change-stroke-color",
+    BoardSaveAttributes = "board-save-attributes",
+    BoardLoadAttributes = "board-load-attributes",
+    BoardGetSnapshotImageList = "board-get-snapshot-image-list",
+    BoardSetDelay = "board-set-delay",
+    BoardSetAnimationOptions = "board-set-animation-options",
+    ToggleBoard = "toggle-board",
+    OpenWebview = "open-webview",
+    OpenStreamMediaPlayer = "open-stream-media-player",
+    ResponseGrantedList = "response-granted-list",
+    OrientationStatesChanged = "orientation-changed",
+    MobileLandscapeToolBarVisibleChanged = "mobile-landscape-tool-bar-visible-changed",
+    MobileCallStateChanged = "mobile-call-state-changed"
+}
+/**
+ * 此事件从Widget发出，在教室内监听
+ */
+/** @en
+ * Events that come from widget toward SDK
+ */
+export declare enum AgoraExtensionWidgetEvent {
+    /** 白板 */
+    BoardConnStateChanged = "board-connection-state-changed",
+    BoardMountStateChanged = "board-mount-state-changed",
+    BoardMemberStateChanged = "board-member-state-changed",
+    BoardPageInfoChanged = "board-page-info-changed",
+    BoardRedoStepsChanged = "board-redo-steps-changed",
+    BoardUndoStepsChanged = "board-undo-steps-changed",
+    BoardGrantedUsersUpdated = "board-granted-users-updated",
+    BoardSnapshotImageReceived = "board-snapshot-image-received",
+    BoardDragOver = "board-drag-over",
+    BoardDrop = "board-drop",
+    WidgetBecomeActive = "widget-become-active",
+    WidgetBecomeInactive = "widget-become-inactive",
+    RegisterCabinetTool = "register-cabinet-tool",
+    UnregisterCabinetTool = "unregister-cabinet-tool",
+    RequestGrantedList = "request-granted-list",
+    RequestOrientationStates = "request-orientation",
+    QuitForceLandscape = "quit-force-landscape",
+    AddSingletonToast = "add-singleton-toast",
+    PollActiveStateChanged = "poll-active-state-changed",
+    RequestMobileLandscapeToolBarVisible = "request-mobile-landscape-tool-bar-visible",
+    OpenMobileHandsActionSheet = "open-mobile-hands-up-action-sheet"
+}