educast-classroom-sdk 1.0.0

package/lib/infra/utils/async-queue.d.ts

@@ -0,0 +1,16 @@
+import { Logger } from 'agora-rte-sdk';
+export declare enum WorkPriority {
+    high = 0,
+    normal = 1,
+    low = 2
+}
+declare class AsyncQueue {
+    logger: Logger;
+    private _handle?;
+    private _queue;
+    runNextTick(run: () => Promise<void>, fail: (e: Error) => void, priority?: WorkPriority): void;
+    sortWorks(): void;
+    private _execute;
+}
+declare const _default: AsyncQueue;
+export default _default;

package/lib/infra/utils/board-utils.d.ts

@@ -0,0 +1,22 @@
+export declare type FetchImageResult = {
+    width: number;
+    height: number;
+    file: File;
+    uuid: string;
+    url: string;
+};
+export declare type BaseImageSize = {
+    width: number;
+    height: number;
+};
+export declare const getImageSize: (imageInnerSize: BaseImageSize) => BaseImageSize;
+export declare const fetchNetlessImageByUrl: (url: string) => Promise<FetchImageResult>;
+export declare const rgbToHexColor: (r: number, g: number, b: number) => string;
+/**
+ * Mimetypes
+ *
+ * @see http://hul.harvard.edu/ois/////systems/wax/wax-public-help/mimetypes.htm
+ * @typedef Mimetypes~Kind
+ * @enum
+ */
+export declare const MimeTypesKind: Record<string, string>;

package/lib/infra/utils/colors.d.ts

@@ -0,0 +1,13 @@
+export declare const brandColor = "#0056FD";
+export declare const blue1: string;
+export declare const blue2: string;
+export declare const blue3: string;
+export declare const blue4: string;
+export declare const blue5: string;
+export declare const blue6 = "#0056FD";
+export declare const blue7: string;
+export declare const blue8: string;
+export declare const blue9: string;
+export declare const blue10: string;
+export declare const primaryRadius = "24px";
+export declare const halfRadius = "12px";

package/lib/infra/utils/config-loader.d.ts

@@ -0,0 +1,9 @@
+import { EduRoomTypeEnum } from 'agora-edu-core';
+import { FcrMultiThemes, FcrTheme, FcrUIConfig } from 'agora-common-libs';
+export declare const themes: Record<string, FcrMultiThemes>;
+export declare const uiConfigs: Record<string, FcrUIConfig>;
+export declare const supportedRoomTypes: EduRoomTypeEnum[];
+export declare const loadTheme: (key: string, theme: FcrMultiThemes) => void;
+export declare const loadUIConfig: (roomType: EduRoomTypeEnum, config: FcrUIConfig) => void;
+export declare const applyTheme: (theme: FcrTheme) => void;
+export declare const loadGeneratedFiles: () => void;

package/lib/infra/utils/error.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 返回错误提示信息
+ * @param error
+ * @returns
+ */
+export declare const getEduErrorMessage: (error: Error) => string | null;
+/**
+ * 如果Error中包含有服务端错误码，则返回服务端错误码
+ * @param error
+ * @returns
+ */
+export declare const getErrorServCode: (error: Error) => any;

package/lib/infra/utils/event-center.d.ts

@@ -0,0 +1,20 @@
+import { AGEventEmitter } from 'agora-rte-sdk';
+export declare const AgoraEduClassRoomUIType = "classroom-ui-events";
+export declare enum AgoraEduClassroomUIEvent {
+    offStreamWindow = "off-stream-window",
+    toggleTeacherStreamWindow = "toggle-teacher-stream-window",
+    toggleWhiteboard = "toggle-whiteboard",
+    dragFileOverBoard = "drag-file-over-board",
+    dropFileOnBoard = "drop-file-on-board"
+}
+declare type EventCallback = (type: AgoraEduClassroomUIEvent, ...args: any[]) => void;
+export declare class EduEventUICenter extends AGEventEmitter {
+    static shared: EduEventUICenter;
+    private _callbacks;
+    constructor();
+    emitClassroomUIEvents(type: AgoraEduClassroomUIEvent, ...args: any[]): void;
+    onClassroomUIEvents(cb: EventCallback): void;
+    offClassroomUIEvents(cb: EventCallback): void;
+    cleanup(): void;
+}
+export {};

package/lib/infra/utils/extract.d.ts

@@ -0,0 +1,6 @@
+import { EduStream, EduUserStruct } from 'agora-edu-core';
+import { AgoraRteVideoSourceType } from 'agora-rte-sdk';
+/**
+ * 提取流列表
+ */
+export declare const extractUserStreams: (users: Map<string, EduUserStruct>, streamByUserUuid: Map<string, Set<string>>, streamByStreamUuid: Map<string, EduStream>, sourceTypes: AgoraRteVideoSourceType[]) => Set<EduStream>;

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

@@ -0,0 +1,16 @@
+export declare const isProduction: boolean;
+export declare const number2Percent: (v: number, fixed?: number) => string;
+export declare function audioBufferToWav(buffer: any, opt?: any): ArrayBuffer;
+export declare const appendBuffer: (buffer1: Float32Array, buffer2: Float32Array) => Float32Array;
+export declare const mapToObject: (map: Map<any, any>) => any;
+export declare function isSupportedImageType(file: File): boolean;
+export declare const dataURIToFile: (dataURI: string, filename: string) => File;
+export declare const jumpToLine: (str: string) => string;
+export declare const getAssetURL: (relativeURL: string) => any;
+export declare const clickAnywhere: (el: HTMLElement, cb: () => void) => () => void;
+export declare const isIOS: () => boolean;
+export declare const getIOSVersion: () => number;
+export declare const isWeChatBrowser: () => boolean;
+export declare const setUrlParameters: (url: string, params: {
+    [key: string]: string | number | boolean;
+}) => string;

package/lib/infra/utils/interaction.d.ts

@@ -0,0 +1,6 @@
+declare type Delegate = (message: string) => void;
+export declare const interactionThrottleHandler: <T>(func: T, limitFunc: Delegate, options?: {
+    limitMs?: number | undefined;
+    message?: string | undefined;
+} | undefined) => T;
+export {};

package/lib/infra/utils/ipc-channels.d.ts

@@ -0,0 +1,39 @@
+/**
+ * IPC消息通道
+ */
+export declare enum ChannelType {
+    OpenBrowserWindow = "open-browser-window",
+    CloseBrowserWindow = "close-browser-window",
+    ShowBrowserWindow = "show-browser-window",
+    HideBrowserWindow = "hide-browser-window",
+    Message = "browser-window-message",
+    UpdateBrowserWindow = "update-browser-window",
+    MoveWindowToTargetScreen = "move-window-to-target-screen",
+    MoveWindowAlignToWindow = "move-window-align-to-window",
+    ShortCutCapture = "short-cut-capture",
+    RTCRawDataTransmit = "rtc-raw-data-transmit"
+}
+/**
+ * IPC消息类型
+ */
+export declare enum IPCMessageType {
+    /** App事件 */
+    BrowserWindowClose = "BrowserWindowClose",
+    BrowserWindowClosed = "BrowserWindowClosed",
+    /** 远程控制 */
+    ControlStateChanged = "ControlStateChanged",
+    HideControlBar = "HideControlBar",
+    CloseControlBar = "CloseControlBar",
+    StudentListUpdated = "StudentListUpdated",
+    FetchStudentList = "FetchStudentList",
+    StopScreenShareAndRemoteControl = "StopScreenShareAndRemoteControl",
+    SwitchScreenShareDevice = "SwitchScreenShareDevice",
+    /** 白板 */
+    ShortCutCaptureDone = "ShortCutCaptureDone",
+    ShortCutCaptureDenied = "ShortCutCaptureDenied",
+    /** 扩展屏 */
+    FetchVideoGalleryState = "FetchVideoGalleryState",
+    VideoGalleryStateUpdated = "VideoGalleryStateUpdated",
+    UpdateVideoGalleryState = "UpdateVideoGalleryState",
+    InviteStage = "InviteStage"
+}

package/lib/infra/utils/ipc.d.ts

@@ -0,0 +1,48 @@
+import { WindowID } from '../api';
+import type { IpcRendererEvent } from 'electron';
+import { ChannelType } from './ipc-channels';
+declare type ChannelMessage = {
+    type: string;
+    payload?: unknown;
+};
+declare type ChannelMessageCallback = (event: IpcRendererEvent, message: ChannelMessage, ...args: any) => void;
+declare type ChannelMessageListenerOptions = {
+    once?: boolean;
+};
+declare type RTCRawDataCallback = (event: IpcRendererEvent, payload: unknown) => void;
+export declare const withTimeout: <T>(p: Promise<T>, detail: unknown, timeout?: number) => Promise<T>;
+/**
+ * 打开窗口
+ * @param channel
+ * @param args
+ * @returns
+ */
+export declare const sendToMainProcess: (channel: ChannelType, ...args: unknown[]) => Promise<unknown>;
+/**
+ * 发送消息到指定窗口
+ * @param windowID
+ * @param args
+ * @returns
+ */
+export declare const sendToRendererProcess: (windowID: WindowID, channel: ChannelType, message: ChannelMessage) => Promise<unknown>;
+/**
+ * 监听主进程消息
+ * @param channel
+ * @param callback
+ * @param options
+ * @returns
+ */
+export declare const listenChannelMessage: (channel: ChannelType, callback: ChannelMessageCallback, options?: ChannelMessageListenerOptions | undefined) => () => void;
+/**
+ * RTC裸数据传输
+ * @param windowID
+ * @param payload
+ */
+export declare const transmitRTCRawData: (windowID: WindowID, payload: unknown) => void;
+/**
+ * 接收RTC裸数据
+ * @param callback
+ * @returns
+ */
+export declare const receiveRTCRawData: (callback: RTCRawDataCallback) => () => void;
+export {};

package/lib/ui-kit/components/button/abutton.d.ts

@@ -0,0 +1,6 @@
+import { ButtonProps } from 'antd/lib/button';
+import { FC, PropsWithChildren } from 'react';
+import './abutton.css';
+declare type AButtonProps = Pick<ButtonProps, 'className' | 'onClick' | 'icon' | 'type' | 'style'>;
+export declare const AButton: FC<PropsWithChildren<AButtonProps>>;
+export {};

package/lib/ui-kit/components/button/index.d.ts

@@ -0,0 +1,18 @@
+import { EventHandler, FC, SyntheticEvent } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+declare type ButtonType = 'primary' | 'secondary' | 'ghost' | 'danger';
+export interface ButtonProps extends BaseProps {
+    type?: ButtonType;
+    size?: 'xs' | 'sm' | 'lg';
+    disabled?: boolean;
+    action?: string;
+    animate?: boolean;
+    onClick?: EventHandler<SyntheticEvent<HTMLButtonElement>>;
+    onMouseOver?: EventHandler<SyntheticEvent<HTMLButtonElement>>;
+    onMouseLeave?: EventHandler<SyntheticEvent<HTMLButtonElement>>;
+    icon?: React.ReactElement;
+    children?: React.ReactNode;
+}
+export declare const Button: FC<ButtonProps>;
+export { AButton } from './abutton';

package/lib/ui-kit/components/card/index.d.ts

@@ -0,0 +1,14 @@
+import React, { FC, EventHandler } from 'react';
+import { BaseProps } from '../../components/util/type';
+import './index.css';
+export interface CardProps extends BaseProps {
+    width?: number;
+    height?: number;
+    borderRadius?: number | string;
+    children?: React.ReactNode;
+    onMouseDown?: EventHandler<any>;
+    onMouseUp?: EventHandler<any>;
+    onMouseLeave?: EventHandler<any>;
+    onScroll?: EventHandler<any>;
+}
+export declare const Card: FC<CardProps>;

package/lib/ui-kit/components/checkbox/index.d.ts

@@ -0,0 +1,14 @@
+import { ChangeEvent, FC } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+declare type CheckboxProps = BaseProps & {
+    text?: string;
+    value?: any;
+    checked?: boolean;
+    disabled?: boolean;
+    indeterminate?: boolean;
+    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
+    gap?: number;
+};
+export declare const CheckBox: FC<CheckboxProps>;
+export {};

package/lib/ui-kit/components/float/index.d.ts

@@ -0,0 +1,13 @@
+import { FC, PropsWithChildren } from 'react';
+import { BaseProps } from '../util/type';
+export interface FloatProps extends BaseProps {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+    direction?: 'row' | 'col';
+    align?: 'flex-start' | 'flex-end';
+    justify?: 'start' | 'end';
+    gap: number;
+}
+export declare const Float: FC<PropsWithChildren<FloatProps>>;

package/lib/ui-kit/components/index.d.ts

@@ -0,0 +1,27 @@
+export * from './button';
+export * from './card';
+export * from './checkbox';
+export * from './float';
+export * from './input';
+export * from './input-number';
+export * from './layout';
+export * from './loading';
+export * from './modal';
+export * from './overlay-wrap';
+export * from './pagination';
+export * from './placeholder';
+export * from './popover';
+export * from './progress';
+export * from './radio';
+export * from './root-box';
+export * from './roster';
+export * from './sound-player';
+export * from './svg-img';
+export * from './svga-player';
+export * from './table';
+export * from './tabs';
+export * from './toast';
+export * from './toolbar';
+export * from './tooltip';
+export * from './tree';
+export * from './volume';

package/lib/ui-kit/components/input/ainput.d.ts

@@ -0,0 +1,6 @@
+import { InputProps } from 'antd/lib/input';
+import { FC } from 'react';
+import './ainput.css';
+declare type AInputProps = Pick<InputProps, 'value' | 'className' | 'onChange' | 'placeholder' | 'allowClear' | 'maxLength' | 'showCount' | 'suffix' | 'prefix' | 'disabled'>;
+export declare const AInput: FC<AInputProps>;
+export {};

package/lib/ui-kit/components/input/index.d.ts

@@ -0,0 +1,31 @@
+import React, { FC } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+export interface InputProps extends BaseProps {
+    type?: string;
+    placeholder?: string;
+    prefix?: React.ReactNode;
+    suffix?: React.ReactNode;
+    disabled?: boolean;
+    value?: any;
+    inputPrefixWidth?: number;
+    rule?: RegExp;
+    errorMsg?: string;
+    errorMsgPositionLeft?: number;
+    min?: number;
+    max?: number;
+    width?: number;
+    maxLength?: string | number;
+    maxNumber?: number;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    onFocus?: React.FocusEventHandler<HTMLInputElement>;
+    onBlur?: React.FocusEventHandler<HTMLInputElement>;
+}
+export declare const Input: FC<InputProps>;
+export interface SearchProps extends InputProps {
+    onSearch: (value: string) => void | Promise<void>;
+    suffix?: any;
+    prefix?: any;
+}
+export declare const Search: FC<SearchProps>;
+export { AInput } from './ainput';

package/lib/ui-kit/components/input-number/index.d.ts

@@ -0,0 +1,10 @@
+import { FC } from 'react';
+import './index.css';
+declare type InputNumberProps = {
+    min: number;
+    max: number;
+    value?: number;
+    onChange: (value: number | null) => void;
+};
+export declare const InputNumber: FC<InputNumberProps>;
+export {};

package/lib/ui-kit/components/layout/index.d.ts

@@ -0,0 +1,12 @@
+import React, { FC, PropsWithChildren } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+export interface LayoutProps extends BaseProps {
+    direction?: 'row' | 'col' | 'col-reverse';
+    children?: React.ReactNode;
+    onClick?: () => void;
+}
+export declare const Layout: FC<LayoutProps>;
+export declare const Header: FC<PropsWithChildren<BaseProps>>;
+export declare const Aside: FC<PropsWithChildren<BaseProps>>;
+export declare const Content: FC<PropsWithChildren<BaseProps>>;

package/lib/ui-kit/components/loading/index.d.ts

@@ -0,0 +1,37 @@
+import React, { FC } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+declare enum CloudDriveResourceUploadStatus {
+    Pending = "pending",
+    Success = "success",
+    Failed = "failed",
+    Canceled = "canceled"
+}
+export interface UploadItem {
+    resourceUuid: string;
+    iconType?: string;
+    fileName?: string;
+    fileSize?: string;
+    currentProgress?: number;
+    status: CloudDriveResourceUploadStatus;
+}
+export interface LoadingProps extends BaseProps {
+    hasLoadingGif?: boolean;
+    loadingText?: string;
+    hasProgress?: boolean;
+    currentProgress?: number;
+    footer?: React.ReactNode[];
+    uploadItemList?: UploadItem[];
+    onClick?: (id: string, type: 'delete' | 'click') => void;
+    noCloseBtn?: boolean;
+    showUploadOpeBtn?: boolean;
+    onRetry?: (resourceUuid: string) => void;
+    onCancel?: (resourceUuid: string) => void;
+}
+export interface CircleLoadingProps extends BaseProps {
+    width?: string;
+    height?: string;
+}
+export declare const Loading: FC<LoadingProps>;
+export declare const CircleLoading: FC<CircleLoadingProps>;
+export {};

package/lib/ui-kit/components/modal/index.d.ts

@@ -0,0 +1,32 @@
+import React, { FC } from 'react';
+import './index.css';
+export interface ModalProps {
+    /** 标题 */
+    title?: string | React.ReactNode;
+    /** 遮罩效果 */
+    showMask?: boolean;
+    /** 是否显示右上角的关闭按钮 */
+    closable?: boolean;
+    /** 底部内容 */
+    footer?: React.ReactNode[];
+    style?: any;
+    /** 点击确定回调 */
+    onOk?: (e: React.MouseEvent<HTMLElement>) => void | Promise<void>;
+    /** 点击模态框右上角叉、取消按钮、Props.maskClosable 值为 true 时的遮罩层或键盘按下 Esc 时的回调 */
+    onCancel?: (e: React.MouseEvent<HTMLElement>) => void | Promise<void>;
+    component?: React.ReactNode;
+    /**
+     * 是否有蒙层
+     */
+    hasMask?: boolean;
+    maskClosable?: boolean;
+    contentClassName?: string;
+    modalType?: 'normal' | 'back' | 'minimize';
+    children?: React.ReactNode;
+    btnId?: string;
+    topLevel?: boolean;
+    animate?: boolean;
+    className?: string;
+    id?: string;
+}
+export declare const Modal: FC<ModalProps>;

package/lib/ui-kit/components/overlay-wrap/index.d.ts

@@ -0,0 +1,15 @@
+import { FC, PropsWithChildren } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+interface OverlayWrapProps extends BaseProps {
+    opened?: boolean;
+    centered?: boolean;
+    onExited?: (() => void) | undefined;
+}
+/**
+ *
+ * @param param0
+ * @returns
+ */
+export declare const OverlayWrap: FC<PropsWithChildren<OverlayWrapProps>>;
+export {};

package/lib/ui-kit/components/pagination/index.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { PaginationProps } from 'rc-pagination';
+import 'rc-pagination/assets/index.css';
+import './index.css';
+export declare const Pagination: FC<PaginationProps>;

package/lib/ui-kit/components/placeholder/index.d.ts

@@ -0,0 +1,18 @@
+import React, { FC } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+declare type PlaceholderType = 'emptyHistory' | 'cameraBroken' | 'cameraClose' | 'noBody' | 'noFile' | 'cameraDisabled' | 'noQuestion';
+export interface PlaceholderProps extends BaseProps {
+    placeholderDesc?: string;
+    placeholderType?: PlaceholderType;
+    backgroundColor?: string;
+}
+export declare const Placeholder: FC<PlaceholderProps>;
+export interface CameraPlaceHolderProps extends BaseProps {
+    state?: 'loading' | 'broken' | 'muted' | 'disabled' | 'none' | 'notpresent' | 'nosetup';
+    text?: string;
+    placeholderSize?: number;
+    children?: React.ReactNode;
+}
+export declare const CameraPlaceHolder: React.FC<CameraPlaceHolderProps>;
+export {};

package/lib/ui-kit/components/popover/index.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { AbstractTooltipProps } from '../tooltip';
+import { RenderFunction } from '../util/getRenderPropValue';
+import './index.css';
+export interface PopoverProps extends AbstractTooltipProps {
+    title?: React.ReactNode | RenderFunction;
+    content?: React.ReactNode | RenderFunction;
+}
+export declare const Popover: React.ForwardRefExoticComponent<PopoverProps & React.RefAttributes<unknown>>;

package/lib/ui-kit/components/progress/index.d.ts

@@ -0,0 +1,19 @@
+import React, { PropsWithChildren } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+export declare type ProgressType = 'download';
+export interface ProgressProps extends BaseProps {
+    progress: number;
+    width: number;
+    type: ProgressType;
+}
+export declare const Progress: React.FC<PropsWithChildren<ProgressProps>>;
+declare type ProgressListItem = Pick<ProgressProps, 'width' | 'progress'> & {
+    key: string;
+    auto?: boolean;
+};
+export declare const DialogProgressApi: {
+    show: (dialog: ProgressListItem) => void;
+    destroy: (key: React.Key) => void;
+};
+export {};

package/lib/ui-kit/components/radio/index.d.ts

@@ -0,0 +1,21 @@
+import { FC } from 'react';
+import { BaseProps } from '../util/type';
+declare type RadioElement = {
+    label: string;
+    value: any;
+    onChange?: () => void;
+    name?: string;
+    checked?: boolean;
+};
+declare type RadioProps = RadioElement & BaseProps;
+declare type RadioGroupProps = {
+    gap?: number;
+    direction?: 'horizontal' | 'vertical';
+    name: string;
+    radios: RadioElement[];
+    value?: any;
+    onChange?: (val: any) => void;
+};
+export declare const Radio: FC<RadioProps>;
+export declare const RadioGroup: FC<RadioGroupProps>;
+export {};

package/lib/ui-kit/components/root-box/index.d.ts

@@ -0,0 +1,5 @@
+import { FC, PropsWithChildren } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+export declare type RootBoxProps = BaseProps;
+export declare const RootBox: FC<PropsWithChildren<RootBoxProps>>;

package/lib/ui-kit/components/roster/carousel-setting.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { CarouselProps } from '..';
+declare type CarouselSettingProps = CarouselProps;
+export declare const CarouselSetting: FC<CarouselSettingProps>;
+export {};

package/lib/ui-kit/components/roster/columns.d.ts

@@ -0,0 +1,7 @@
+import { Column } from './index';
+export declare const defaultColumns: Column[];
+export declare const podiumColumn: Column;
+export declare const grantBoardColumn: Column;
+export declare const starsColumn: Column;
+export declare const kickOutColumn: Column;
+export declare const superviseColumn: Column;

package/lib/ui-kit/components/roster/hooks.d.ts

@@ -0,0 +1,3 @@
+import { Column } from './';
+import { SupportedFunction } from '..';
+export declare const useColumns: (functions: SupportedFunction[]) => Column[];