educast-classroom-sdk 2.4.3 → 2.4.5

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

@@ -1,6 +0,0 @@
-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

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

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

@@ -1,6 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,70 +0,0 @@
-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

@@ -1,67 +0,0 @@
-/**
- * 此类事件从教室发出，在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"
-}

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

@@ -1,24 +0,0 @@
-import { AgoraWidgetController } from 'agora-edu-core';
-import { Logger } from 'agora-rte-sdk';
-import { CabinetItem } from '../stores/common/toolbar/type';
-import { FcrBoardH5WindowConfig, FcrBoardMaterialWindowConfig, FcrBoardMediaWindowConfig, OrientationStates, StreamMediaPlayerOpenParams, WebviewOpenParams } from './type';
-import { MobileCallState } from '../stores/lecture-mobile/layout';
-export declare class Extension {
-    logger: Logger;
-    private _controller?;
-    private _registeredCabinetItems;
-    get cabinetItems(): CabinetItem[];
-    install(controller: AgoraWidgetController): void;
-    uninstall(): void;
-    private _handleRegisterCabinetTool;
-    private _handleUnregisterCabinetTool;
-    openWebview(params: WebviewOpenParams): void;
-    openMediaStreamPlayer(params: StreamMediaPlayerOpenParams): void;
-    openMaterialResourceWindow(resource: FcrBoardMaterialWindowConfig): void;
-    openMediaResourceWindow(resource: FcrBoardMediaWindowConfig): void;
-    openH5ResourceWindow(resource: FcrBoardH5WindowConfig): void;
-    updateOrientationStates(param: OrientationStates): void;
-    updateMobileLandscapeToolBarVisible(visible: boolean): void;
-    updateMobileCallState(callState: MobileCallState): void;
-    private _broadcastMessage;
-}

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

@@ -1,70 +0,0 @@
-import { OrientationEnum } from '../stores/common/type';
-export declare enum BoardConnectionState {
-    Disconnected = 0,
-    Connecting = 1,
-    Connected = 2,
-    Reconnecting = 3,
-    Disconnecting = 4
-}
-export declare enum BoardMountState {
-    NotMounted = 0,
-    Mounted = 1
-}
-/** Board types */
-export declare enum FcrBoardTool {
-    Selector = 1,
-    LaserPointer = 2,
-    Eraser = 3,
-    Clicker = 4,
-    Hand = 5,
-    Text = 6
-}
-export declare enum FcrBoardShape {
-    Curve = 1,
-    Straight = 2,
-    Arrow = 3,
-    Rectangle = 4,
-    Triangle = 5,
-    Rhombus = 6,
-    Pentagram = 7,
-    Ellipse = 8
-}
-export declare type WebviewOpenParams = {
-    resourceUuid: string;
-    url: string;
-    title: string;
-};
-export declare type StreamMediaPlayerOpenParams = {
-    resourceUuid: string;
-    url: string;
-    title: string;
-};
-export declare type Color = {
-    r: number;
-    g: number;
-    b: number;
-    a?: number;
-};
-export declare type FcrBoardMaterialWindowConfig<T = unknown> = {
-    resourceUuid: string;
-    urlPrefix: string;
-    title: string;
-    pageList: T[];
-    taskUuid: string;
-    resourceHasAnimation: boolean;
-};
-export declare type FcrBoardMediaWindowConfig = {
-    resourceUuid: string;
-    resourceUrl: string;
-    title: string;
-    mimeType: string;
-};
-export declare type FcrBoardH5WindowConfig = {
-    resourceUuid: string;
-    resourceUrl: string;
-    title: string;
-};
-export declare type OrientationStates = {
-    orientation: OrientationEnum;
-    forceLandscape: boolean;
-};

package/lib/infra/stores/common/base.d.ts

@@ -1,46 +0,0 @@
-import { EduClassroomStore } from 'agora-edu-core';
-import { EduShareUIStore } from './share';
-import { Board } from '@classroom/infra/protocol/board';
-import { Extension } from '@classroom/infra/protocol';
-import { Getters } from './getters';
-import { Logger } from 'agora-rte-sdk';
-export declare abstract class EduUIStoreBase {
-    private static _boardApi;
-    private static _extensionApi;
-    protected readonly logger: Logger;
-    /**
-     * 参数覆盖
-     */
-    protected get uiOverrides(): {};
-    protected readonly getters: Getters;
-    /**
-     * 当前 EduClassroomStore 实例
-     */
-    readonly classroomStore: EduClassroomStore;
-    /**
-     * EduShareUIStore 实例
-     */
-    readonly shareUIStore: EduShareUIStore;
-    /**
-     * 构造函数
-     * @param store
-     * @param shareUIStore
-     */
-    constructor(store: EduClassroomStore, shareUIStore: EduShareUIStore, getters: Getters);
-    /**
-     * 初始化
-     */
-    abstract onInstall(): void;
-    /**
-     * 销毁
-     */
-    abstract onDestroy(): void;
-    /**
-     * 白板API服务
-     */
-    get boardApi(): Board;
-    /**
-     * 扩展API
-     */
-    get extensionApi(): Extension;
-}

package/lib/infra/stores/common/board/index.d.ts

@@ -1,41 +0,0 @@
-/// <reference types="react" />
-import { IReactionDisposer, Lambda } from 'mobx';
-import { EduUIStoreBase } from '../base';
-export declare class BoardUIStore extends EduUIStoreBase {
-    protected _disposers: (IReactionDisposer | Lambda)[];
-    protected get uiOverrides(): {
-        heightRatio: number;
-    };
-    /**
-     * 白板容器高度
-     * @returns
-     */
-    get boardAreaHeight(): number;
-    isCopying: boolean;
-    get isTeacherOrAssistant(): boolean;
-    get grantedUsers(): Set<string>;
-    get isGrantedBoard(): boolean;
-    get undoSteps(): number;
-    get redoSteps(): number;
-    get currentSceneIndex(): number;
-    get scenesCount(): number;
-    get mounted(): boolean;
-    onInstall(): void;
-    private _handleUIEvents;
-    addMainViewScene(): void;
-    toPreMainViewScene(): void;
-    toNextMainViewScene(): void;
-    setDelay(delay: number): void;
-    /**
-     * for teacher and assistent only
-     *
-     * @param event
-     */
-    handleDragOver(event: React.DragEvent<HTMLDivElement>): void;
-    /**
-     * for teacher and assistent only
-     * @param event
-     */
-    hanldeDrop(event: React.DragEvent<HTMLDivElement>): Promise<void>;
-    onDestroy(): void;
-}

package/lib/infra/stores/common/cloud-drive/helper.d.ts

@@ -1,14 +0,0 @@
-import { CourseWareItem } from '@classroom/infra/api';
-import { CloudDriveResource, ConversionOption } from 'agora-edu-core';
-export declare const h5Type = "ah5";
-export declare const linkType = "alf";
-export declare const imageTypes: string[];
-export declare const mediaVideoTypes: string[];
-export declare const mediaAudioTypes: string[];
-export declare const convertableTypes: string[];
-export declare const convertableDynamicTypes: string[];
-export declare const supportedTypes: string[];
-export declare const createCloudResource: (data: CourseWareItem) => CloudDriveResource | never;
-export declare const conversionOption: (ext: string, scale?: number | undefined) => ConversionOption | undefined;
-export declare const extractFileExt: (name: string) => string | undefined;
-export declare const fileExt2ContentType: (fileExt: string) => string;

package/lib/infra/stores/common/cloud-drive/index.d.ts

@@ -1,178 +0,0 @@
-import { IUploadOnlineCoursewareData } from '@classroom/infra/capabilities/containers/cloud-driver/person-resource';
-import { CloudDrivePagingOption, CloudDriveResource, CloudDriveResourceUploadStatus } from 'agora-edu-core';
-import { SvgIconEnum } from '@classroom/ui-kit';
-import { EduUIStoreBase } from '../base';
-export declare enum FileTypeSvgColor {
-    ppt = "#F6B081",
-    word = "#96CBE1",
-    excel = "#A6DDBF",
-    pdf = "#A3C3DE",
-    video = "#A8ABE9",
-    audio = "#6C82D1",
-    txt = "#8597FF",
-    image = "#95E2E7"
-}
-export interface UploadItem {
-    resourceUuid: string;
-    iconType?: string;
-    fileName?: string;
-    fileSize?: string;
-    currentProgress?: number;
-    status: CloudDriveResourceUploadStatus;
-}
-export declare class CloudUIStore extends EduUIStoreBase {
-    readonly pageSize: number;
-    personalResourceUuidByPage: Map<number, string[]>;
-    personalResourcesTotalNum: number;
-    private _disposers;
-    private _isUploading;
-    onInstall(): void;
-    /**
-     * 根据类型返回扩展名
-     * @param name
-     * @returns
-     */
-    fileNameToType(name: string): SvgIconEnum.ALF | SvgIconEnum.AUDIO | SvgIconEnum.EXCEL | SvgIconEnum.H5 | SvgIconEnum.IMAGE | SvgIconEnum.PDF | SvgIconEnum.PPT | SvgIconEnum.UNKNOWN | SvgIconEnum.VIDEO | SvgIconEnum.WORD;
-    /**
-     * 文件大小信息格式化
-     * @param fileByteSize
-     * @param decimalPoint
-     * @returns
-     */
-    formatFileSize(fileByteSize: number, decimalPoint?: number): string;
-    /**
-     * 刷新资源列表
-     */
-    reloadPersonalResources(): Promise<void>;
-    /**
-     * 查询个人资源列表
-     * @param options
-     * @returns
-     */
-    fetchPersonalResources(options: CloudDrivePagingOption): Promise<{
-        list: never[];
-        total: number;
-    } | undefined>;
-    /**
-     *
-     * @param files
-     */
-    validateFiles(files: File[]): boolean;
-    /**
-     * 上传文件至个人资源
-     * @param file
-     * @returns
-     */
-    uploadPersonalResource(files: File[]): Promise<void>;
-    addOnlineCourseware({ resourceName, url }: IUploadOnlineCoursewareData): Promise<void>;
-    /**
-     * 打开课件
-     */
-    private _tryOpenCourseware;
-    /**
-     * 打开课件
-     * @param resource
-     */
-    openResource(resource: CloudDriveResource): Promise<void>;
-    /**
-     * 公共资源
-     * @returns
-     */
-    get publicResources(): Map<string, CloudDriveResource>;
-    showUploadModal: boolean;
-    showUploadToast: boolean;
-    /**
-     * 上传状态
-     */
-    uploadState: 'uploading' | 'success' | 'error' | 'idle';
-    /**
-     * 云盘上传modal最小化显示
-     */
-    showUploadMinimize: boolean;
-    /**
-     * 检索公共资源课件字符串
-     */
-    searchPublicResourcesKeyword: string;
-    /**
-     * 检索个人资源课件字符串
-     */
-    searchPersonalResourcesKeyword: string;
-    /**
-     * 个人资源左侧选项框状态
-     */
-    personalResourcesCheckSet: Set<string>;
-    /**
-     * 个人资源页码
-     */
-    currentPersonalResPage: number;
-    /**
-     * 个人资源全选
-     */
-    isPersonalResSelectedAll: boolean;
-    /**
-     * 云盘资源列表
-     */
-    get personalResources(): Map<string, CloudDriveResource>;
-    /**
-     * 云盘资源列表（左侧选择框使用）
-     * @returns
-     */
-    get personalResourcesList(): {
-        resource: CloudDriveResource;
-        checked: boolean;
-    }[];
-    /**
-     * 是否有选中资源文件
-     * @returns
-     */
-    get hasSelectedPersonalRes(): boolean;
-    /**
-     * 资源上传进度
-     * @returns
-     */
-    get uploadingProgresses(): UploadItem[];
-    /**
-     * 勾选资源文件
-     * @param resourceUuid
-     * @param val
-     */
-    setPersonalResourceSelected: (resourceUuid: string, val: boolean) => void;
-    /**
-     * 资源列表全选
-     * @param val
-     */
-    setAllPersonalResourceSelected: (val: boolean) => void;
-    /**
-     * 设置资源列表页码
-     * @param num
-     */
-    setPersonalResCurrentPage: (num: number) => void;
-    /**
-     * 设置上传状态
-     * @param uploadState
-     */
-    setUploadState: (uploadState: 'uploading' | 'success' | 'error') => void;
-    setShowUploadModal: (v: boolean) => void;
-    setShowUploadToast: (v: boolean) => void;
-    /**
-     * 设置云盘上传modal最小化
-     * @param v
-     */
-    setShowUploadMinimize: (v: boolean) => void;
-    /**
-     * 删除个人资源
-     * @returns
-     */
-    removePersonalResources: (singleFileUuid?: string | undefined) => Promise<void>;
-    /**
-     * 设置检索公共资源字符串
-     * @param keyword
-     */
-    setSearchPublicResourcesKeyword(keyword: string): void;
-    /**
-     * 设置检索个人资源字符串
-     * @param keyword
-     */
-    setSearchPersonalResourcesKeyword(keyword: string): void;
-    onDestroy(): void;
-}

package/lib/infra/stores/common/cloud-drive/struct.d.ts

@@ -1,109 +0,0 @@
-/**
- * 云盘资源对象。支持两种类型；
- * - `'dynamic'`: 动态资源
- * - `'static'`: 静态资源
- */
-import { CloudDriveResource, ConversionOption } from 'agora-edu-core';
-import { CloudDriveResourceConvertProgress } from './type';
-/** @en
- * The cloud drive resource object. Supports two types of resources:
- * - `'dynamic'`: Dynamic resources.
- * - `'static'`: Static resources.
- */
-export declare class CloudDriveCourseResource extends CloudDriveResource {
-    private _taskProgress;
-    taskUuid: string;
-    conversion: ConversionOption;
-    scenes: {
-        name?: string;
-        previewUrl?: string;
-        contentUrl: string;
-        height: number;
-        width: number;
-    }[];
-    constructor(data: {
-        ext: string;
-        resourceName: string;
-        resourceUuid: string;
-        size: number;
-        updateTime: number;
-        taskProgress: CloudDriveResourceConvertProgress;
-        taskUuid: string;
-        conversion: ConversionOption;
-        initOpen?: boolean;
-    });
-    get hasAnimation(): boolean;
-    get convertedPercentage(): number;
-    get status(): "Waiting" | "Converting" | "Finished" | "Fail";
-    get prefix(): string | undefined;
-}
-/**
- * 多媒体资源文件对象。支持以下类型：
- * - `'video'`: 视频文件
- * - `'audio'`: 音频文件
- */
-/** @en
- * The multi-media resource object. Supports types of multi-media resources:
- * - `'video'`
- * - `'audio'`
- */
-export declare class CloudDriveMediaResource extends CloudDriveResource {
-    url: string;
-    type: 'video' | 'audio';
-    constructor(data: {
-        ext: string;
-        resourceName: string;
-        resourceUuid: string;
-        size: number;
-        updateTime: number;
-        url: string;
-        type: 'video' | 'audio';
-        initOpen?: boolean;
-    });
-}
-/**
- * 图片资源文件对象
- */
-/** @en
- * Cloud Drive Image Resource
- */
-export declare class CloudDriveImageResource extends CloudDriveResource {
-    url: string;
-    constructor(data: {
-        ext: string;
-        resourceName: string;
-        resourceUuid: string;
-        size: number;
-        updateTime: number;
-        url: string;
-        initOpen?: boolean;
-    });
-}
-export declare class CloudDriveH5Resource extends CloudDriveResource {
-    url: string;
-    type: string;
-    constructor(data: {
-        ext: string;
-        resourceName: string;
-        resourceUuid: string;
-        size: number;
-        updateTime: number;
-        url: string;
-        type: string;
-        initOpen?: boolean;
-    });
-}
-export declare class CloudDriveLinkResource extends CloudDriveResource {
-    url: string;
-    type: string;
-    constructor(data: {
-        ext: string;
-        resourceName: string;
-        resourceUuid: string;
-        size: number;
-        updateTime: number;
-        url: string;
-        type: string;
-        initOpen?: boolean;
-    });
-}

package/lib/infra/stores/common/cloud-drive/type.d.ts

@@ -1,23 +0,0 @@
-export interface CloudDriveResourceConvertProgress {
-    prefix?: string;
-    status: 'Waiting' | 'Converting' | 'Finished' | 'Fail';
-    totalPageSize: number;
-    convertedPageSize: number;
-    convertedPercentage: number;
-    convertedFileList: {
-        name?: string;
-        ppt: {
-            preview?: string;
-            src: string;
-            width: number;
-            height: number;
-        };
-    }[];
-    currentStep: string;
-    previews: Record<number, string>;
-    images: Record<number, {
-        width: number;
-        height: number;
-        url: string;
-    }>;
-}