educast-classroom-sdk 1.0.0

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

@@ -0,0 +1,17 @@
+import { FC } from 'react';
+import { BaseProps } from '../util/type';
+import './index.css';
+export interface VolumeProps extends BaseProps {
+    backgroundColor?: string;
+    activeColor?: string;
+    width?: number;
+    height?: number;
+    currentVolume?: number;
+    maxLength: number;
+}
+export declare const Volume: FC<VolumeProps>;
+export interface AudioVolumeProps extends BaseProps {
+    isMicMuted?: boolean;
+    currentVolume?: number;
+}
+export declare const AudioVolume: FC<AudioVolumeProps>;

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

@@ -0,0 +1,2 @@
+export * from './components';
+export * from './utilities';

package/lib/ui-kit/utilities/hooks.d.ts

@@ -0,0 +1,22 @@
+export declare const useUnMount: (cb: CallableFunction) => void;
+export declare const useMounted: () => boolean;
+export declare const useTimeout: (fn: CallableFunction, delay: number) => void;
+export declare const useDebounce: <T>(value: T, delay?: number | undefined) => T;
+/**
+ * figure out a position that the target can make use to be centered in the container which has the `bounds` class.
+ * @param
+ *  draggableHeight: target's height
+ *  draggableWidth: target's width
+ *  bounds: class of the container which the target will be centered in
+ * @returns
+ */
+export declare const useDraggableDefaultCenterPosition: ({ draggableHeight, draggableWidth, bounds, }: {
+    draggableWidth: number;
+    draggableHeight: number;
+    bounds?: string | undefined;
+}) => {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};

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

@@ -0,0 +1,31 @@
+export declare type I18nLanguage = 'zh' | 'en';
+export declare const getOS: () => {
+    isTablet: boolean;
+    isPhone: boolean;
+    isPc: boolean;
+};
+export declare const Z_INDEX_CONST: {
+    zIndexBadge: "auto";
+    zIndexTableFixed: number;
+    zIndexAffix: number;
+    zIndexBackTop: number;
+    zIndexPickerPanel: number;
+    zIndexPopupClose: number;
+    zIndexModal: number;
+    zIndexModalMask: number;
+    zIndexMessage: number;
+    zIndexNotification: number;
+    zIndexPopover: number;
+    zIndexDropdown: number;
+    zIndexPicker: number;
+    zIndexPopoconfirm: number;
+    zIndexTooltip: number;
+    zIndexImage: number;
+    zIndexExtApp: number;
+    zIndexRtcVideo: number;
+    zIndexCameraPlaceholderLoading: number;
+    zIndexCameraPlaceholderBroken: number;
+    zIndexCameraPlaceholderMuted: number;
+    zIndexCameraPlaceholderDisabled: number;
+    zIndexCameraPlaceholderNone: number;
+};

package/lib/ui-kit/utilities/state-color.d.ts

@@ -0,0 +1,17 @@
+export declare const NetworkStateColors: {
+    normal: string;
+    bad: string;
+    down: string;
+    unknown: string;
+};
+export declare const InteractionStateColors: {
+    allow: string;
+    disallow: string;
+    half: string;
+    disabled: string;
+    normal: string;
+};
+export declare const PlaceholderStateColors: {
+    normal: string;
+    disabled: string;
+};

package/lib/ui-kit/utilities/style-config.d.ts

@@ -0,0 +1,60 @@
+/**
+ * antd zIndex rules
+ * @zindex-badge: auto;
+ * @zindex-table-fixed: 2;
+ * @zindex-affix: 10;
+ * @zindex-back-top: 10;
+ * @zindex-picker-panel: 10;
+ * @zindex-popup-close: 10;
+ * @zindex-modal: 1000;
+ * @zindex-modal-mask: 1000;
+ * @zindex-message: 1010;
+ * @zindex-notification: 1010;
+ * @zindex-popover: 1030;
+ * @zindex-dropdown: 1050;
+ * @zindex-picker: 1050;
+ * @zindex-popoconfirm: 1060;
+ * @zindex-tooltip: 1070;
+ * @zindex-image: 1080;
+ *
+ * agora zIndex rule
+ * @zindex-ext-app: 998
+ * @zindex-rtc-video: 0
+ * @zindex-camera-placeholder-loading: 0
+ * @zindex-camera-placeholder-broken: 0
+ * @zindex-camera-placeholder-muted: 0
+ * @zindex-camera-placeholder-disabled: 0
+ * @zindex-camera-placeholder-none: -1
+ */
+export declare const Z_INDEX_RULES: {
+    zIndexBadge: 'auto';
+    zIndexTableFixed: number;
+    zIndexAffix: number;
+    zIndexBackTop: number;
+    zIndexPickerPanel: number;
+    zIndexPopupClose: number;
+    zIndexModal: number;
+    zIndexModalMask: number;
+    zIndexMessage: number;
+    zIndexNotification: number;
+    zIndexPopover: number;
+    zIndexDropdown: number;
+    zIndexPicker: number;
+    zIndexPopoconfirm: number;
+    zIndexTooltip: number;
+    zIndexImage: number;
+    zIndexExtApp: number;
+    zIndexRtcVideo: number;
+    zIndexCameraPlaceholderLoading: number;
+    zIndexCameraPlaceholderBroken: number;
+    zIndexCameraPlaceholderMuted: number;
+    zIndexCameraPlaceholderDisabled: number;
+    zIndexCameraPlaceholderNone: number;
+};
+/**
+ * 一些颜色的定义
+ */
+export declare const COLOR_RULES: {
+    activeColor: string;
+    deactiveColor: string;
+};

package/lib/ui-kit/utilities/types.d.ts

@@ -0,0 +1,8 @@
+export declare type OnChangeEvents<Type> = {
+    [Property in keyof Type as `onChange${Capitalize<string & Property>}`]: (newValue: Type[Property]) => void;
+};
+export declare type HomeModule<CustomizeVanillaType> = OnChangeEvents<CustomizeVanillaType> & CustomizeVanillaType;
+export declare type IncludeUIKitSetter<Type> = {
+    [Property in keyof Type as `set${Capitalize<string & Property>}`]: (newValue: Type[Property]) => void;
+};
+export declare type UIKitModule<EntityType> = IncludeUIKitSetter<EntityType> & EntityType;

package/lib/worker-entry.bundle.worker.js.LICENSE.txt

@@ -0,0 +1,3 @@
+/*! https://mths.be/punycode v1.4.1 by @mathias */
+
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/package.json

@@ -0,0 +1,152 @@
+{
+  "name": "educast-classroom-sdk",
+  "version": "1.0.0",
+  "keywords": [
+    "agora",
+    "WebRTC",
+    "latest",
+    "AgoraFlexibleClassroom",
+    "Education"
+  ],
+  "license": "MIT",
+  "main": "lib/edu_sdk.bundle.js",
+  "types": "lib/infra/api/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "exports": {
+    ".": "./lib/edu_sdk.bundle.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ggc-educast-team/agora-classroom-sdk.git"
+  },
+  "scripts": {
+    "build:types": "tsc -p tsconfig.json",
+    "build:docs": "typedoc",
+    "pack:npm": "run-s bundle:npm build:types",
+    "bundle:npm": "cross-env NODE_ENV=production NODE_OPTIONS=--max_old_space_size=4096 webpack --config ./webpack.config.js",
+    "storybook": "start-storybook -p 6006 --no-manager-cache",
+    "ci:build": "run-s bundle:npm build:types",
+    "prepare": "npm run ci:build"
+  },
+  "browserslist": {
+    "production": [
+      ">0.3%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      ">0.3%",
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@types/js-md5": "0.7.0",
+    "@types/react-copy-to-clipboard": "5.0.4",
+    "@types/axios": "0.14.0",
+    "@types/classnames": "2.2.11",
+    "@types/lodash": "4.14.145",
+    "@types/react": "17.0.44",
+    "@types/react-dom": "16.9.2",
+    "@types/react-helmet": "6.1.5",
+    "@types/react-router-dom": "5.3.3",
+    "@types/react-transition-group": "4.4.1",
+    "@types/uuid": "3.4.6",
+    "@types/tinycolor2": "1.4.3",
+    "@types/react-select": "4.0.15",
+    "cross-env": "6.0.3",
+    "cpx": "1.5.0",
+    "concurrently": "5.0.0",
+    "@storybook/addon-postcss": "2.0.0",
+    "@storybook/addon-essentials": "6.5.13",
+    "@storybook/addon-links": "6.5.13",
+    "@storybook/react": "6.5.13",
+    "@types/react-virtualized": "^9.21.14",
+    "babel-loader": "8.2.2",
+    "mini-css-extract-plugin": "2.4.5",
+    "storybook": "6.5.13",
+    "svg-sprite-loader": "6.0.7",
+    "svgaplayerweb": "2.3.2",
+    "crypto-browserify": "3.12.0",
+    "stream-browserify": "3.0.0",
+    "npm-run-all": "4.1.5",
+    "null-loader": "4.0.1",
+    "@nicolo-ribaudo/semver-v6": "6.3.3",
+    "webpack": "5.54.0",
+    "webpack-cli": "4.10.0",
+    "webpackbar": "5.0.0-3",
+    "thread-loader": "3.0.1",
+    "url-loader": "4.1.1",
+    "@babel/cli": "7.17.6",
+    "@babel/core": "7.13.15",
+    "@babel/plugin-proposal-class-properties": "7.13.0",
+    "@babel/plugin-proposal-decorators": "7.15.8",
+    "@babel/plugin-proposal-object-rest-spread": "7.13.8",
+    "@babel/plugin-proposal-private-property-in-object": "7.16.7",
+    "@babel/plugin-syntax-decorators": "7.12.13",
+    "@babel/plugin-syntax-dynamic-import": "7.8.3",
+    "@babel/plugin-transform-runtime": "7.13.15",
+    "@babel/plugin-transform-typescript": "7.16.1",
+    "@babel/preset-env": "7.13.15",
+    "@babel/preset-react": "7.13.13",
+    "@babel/preset-typescript": "7.13.0",
+    "@babel/runtime-corejs3": "7.13.10",
+    "postcss": "8.4.4",
+    "postcss-import": "14.0.1",
+    "postcss-loader": "4.0.3"
+  },
+  "dependencies": {
+    "tinycolor2": "1.4.2",
+    "@use-gesture/react": "10.2.11",
+    "agora-edu-core": "~2.9.0",
+    "agora-rte-sdk": "~2.9.0",
+    "agora-common-libs": "~2.9.0",
+    "animate.css": "4.1.1",
+    "autoprefixer": "10.2.5",
+    "axios": "0.19.2",
+    "buffer": "6.0.3",
+    "classnames": "2.2.6",
+    "clipboard": "^2.0.11",
+    "dayjs": "1.10.4",
+    "electron-screenshots": "0.0.13",
+    "js-md5": "0.7.3",
+    "lodash": "4.17.21",
+    "matchmedia-polyfill": "0.3.2",
+    "mobx": "5.15.4",
+    "mobx-react": "6.3.1",
+    "promise-polyfill": "8.2.0",
+    "react": "17.0.0",
+    "react-copy-to-clipboard": "^5.1.0",
+    "react-dom": "17.0.0",
+    "react-draggable": "4.4.3",
+    "react-helmet": "6.1.0",
+    "react-rnd": "10.3.4",
+    "react-router": "5.2.0",
+    "react-router-dom": "5.2.0",
+    "react-spring": "9.4.4",
+    "react-transition-group": "4.4.1",
+    "react-use-measure": "2.1.1",
+    "tailwindcss": "2.0.3",
+    "typescript": "4.4.4",
+    "uuid": "3.3.3",
+    "agora-extension-virtual-background": "1.1.1",
+    "agora-extension-beauty-effect": "1.0.1-beta",
+    "agora-extension-ai-denoiser": "1.0.0",
+    "antd": "4.23.0",
+    "patch-package": "6.4.7",
+    "react-virtualized": "9.22.3",
+    "rc-notification": "4.4.0",
+    "rc-pagination": "3.1.6",
+    "rc-tooltip": "5.1.1",
+    "rc-trigger": "5.2.3",
+    "rc-util": "5.21.0",
+    "react-select": "4.3.0"
+  }
+}