@plaso-infi/whiteboard-sdk 0.3.6 → 0.3.7

package/dist/cjs/index.d.ts

@@ -1,4 +1,5 @@
-import React$1, { FC, CSSProperties } from 'react';
+import * as React$1 from 'react';
+import React__default, { FC, CSSProperties } from 'react';
 
 type PositionLike = {
     x: number;
@@ -19,6 +20,13 @@ type ViewRect = {
 };
 type BorderBox = Omit<Viewbox, 'scale'>;
 
+type eventHandler<E> = (evt: E) => void;
+interface EventManagerT<ET = any> {
+    subscribe<T extends keyof ET>(topic: T, cb: eventHandler<ET[T]>): CB;
+    once<T extends keyof ET>(topic: T, cb: eventHandler<ET[T]>): CB;
+    publish<T extends keyof ET>(topic: T, evt: ET[T]): void;
+}
+
 type DocumentType = 'ppt' | 'pdf' | 'excel' | 'word';
 type FileType = 'image' | 'document' | 'video' | 'audio';
 
@@ -121,6 +129,17 @@ type RouteConfigT = {
     boardCompositeKey?: string[];
 };
 type ToolBarWidgetsConfigsT = Partial<FullToolBarWidgetsConfigs>;
+type CanUploadInfo = {
+    canUpload: boolean;
+    reason?: string;
+};
+declare enum UploadFailedCode {
+    EXCEEDS_STORAGE_LIMIT = 1
+}
+type UploadRejectInfo = {
+    code: UploadFailedCode;
+    message?: string;
+};
 /** 获取白板 websdk 实例的配置参数  */
 interface GetSdkInstanceConfigs {
     /** 当前白板的用户信息 */
@@ -136,7 +155,7 @@ interface GetSdkInstanceConfigs {
          * 画布左上角的标题栏插槽，React 组件 maxHeight 为 48px; 与画布自带的搜索、下载等 UI 毗邻
          * 通常可以用于展示 logo 或呈现 “返回” 按键等。
          */
-        titleSlot?: React.ReactNode;
+        titleSlot?: (w?: number, cb?: (w: number) => void) => React.ReactNode;
         /**
          * 画布右上角的 UI 插槽，React 组件 maxHeight 为 48px; 与画布自身的在线成员展示等 UI 毗邻
          */
@@ -152,6 +171,30 @@ interface GetSdkInstanceConfigs {
         laserMode?: boolean;
         /** 默认的画布网格设置，会被用户自己的使用习惯数据覆盖 */
         defaultGrid?: GridType;
+        /**
+         * 画布内默认画笔偏好，包括颜色、粗细、不透明度等
+         * @param lineColor 画布颜色，Hex 数值，e.g. 0xff0000
+         * @param lineWidth 画笔粗细 [0, 30] 之间
+         * @param lineOpacity 马克笔不透明度 [0.1, 1]
+         * 注：
+         * - 请确保设置的颜色是画布默认颜色，包括：0xffffff, 0xfef445, 0xfac710, 0xf24726, 0xe6e6e6, 0xcee741, 0x8fd14f, 0xda0063,
+         *   0x808080, 0x12cdd4, 0x0ca789, 0x9510ac, 0x1a1a1a, 0x2d9bf0, 0x414bb2, 0x652cb3
+         * - pen 及 mark 的默认配置数组长度应 <= 3。
+         * - 手机或大屏模式下，仅第一个配置有效。
+         *
+         * **TODO: 后续会增加配置项以控制：默认画笔样式是否会被 websdk 用户自己的画笔使用行为记录覆盖**
+         **/
+        defaultDrawStyles?: {
+            pen?: {
+                lineColor?: number;
+                lineWidth?: number;
+            }[];
+            mark?: {
+                lineColor?: number;
+                lineWidth?: number;
+                lineOpacity?: number;
+            }[];
+        };
     };
     /** 进入画布时，如果给入该值，则会向 x:0, y:0 处插入模板内容，并尝试移动视野至该位置 */
     initTemplate?: string | {
@@ -194,6 +237,7 @@ interface GetSdkInstanceConfigs {
      * - normal: 常规模式，PC、Laptop、PAD 上推荐使用本模式
      */
     displayMode?: 'bigScreen' | 'normal' | 'phone';
+    meetingConfigs: MeetingConfigs;
     getElementLink?: (encodeId: string, id: string) => string;
     /** 链接跳转，返回值为string表示跳转元素id */
     gotoLink?: (link: string) => string | undefined;
@@ -209,6 +253,8 @@ interface GetSdkInstanceConfigs {
     getShadowBoardQuery?: () => Promise<string>;
     /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
     getUsersInfo: (loginNames: string[]) => Promise<InfiUserInfoT[]>;
+    /** 上传文件出错时的回调 */
+    onUploadFailed?: (info: UploadRejectInfo) => void;
 }
 type CustomizeUploader = {
     loaders: {
@@ -276,6 +322,18 @@ declare enum GridType {
     LINE = 1,
     DOT = 2
 }
+type PreferencesType = Partial<{
+    gridType: GridType;
+    palette: number[];
+    toolBar: string[];
+    toolBox: string[];
+    view: {
+        x: number;
+        y: number;
+        height: number;
+        width: number;
+    };
+}>;
 type ElementMetaData = {
     id: string;
     elementType: number;
@@ -444,10 +502,28 @@ interface InfiWebsdkInstanceType {
     useElementsInfo(info: any[], position: PositionLike): Promise<void>;
     /** 销毁白板 sdk 实例 */
     destroy: () => Promise<void>;
+    /** 开启快捷键 */
+    enableShortCut: () => void;
+    /** 关闭快捷键 */
+    disableShortCut: () => void;
 }
 type ShadowViewDataT = {
     viewData?: [number, number, number, number];
 };
+interface InternalWebSdkInsT extends InfiWebsdkInstanceType {
+    init: () => Promise<void>;
+    routeConfig: RouteConfigT;
+    configs: GetSdkInstanceConfigs;
+    update: () => void;
+    anchorElement?: string;
+    evtBus: EventManagerT<InnerWebsdkEventTypeMap>;
+    getQueryString: () => Promise<string>;
+    preCreditCheck: () => Promise<AiCheckInfo>;
+    userPreference: PreferencesType;
+    setUserPreferences(userPreference: PreferencesType, needRefresh?: boolean): Promise<void>;
+    /** 上传文件前回调函数 */
+    beforeUpload?: () => Promise<boolean>;
+}
 type WebsdkEventTypeMap = {
     /** 白板未完成初始化 */
     not_initialized: void;
@@ -471,6 +547,10 @@ type WebsdkEventTypeMap = {
         connectId: string;
     };
 };
+type InnerWebsdkEventTypeMap = {
+    /** sdk dom状态更新 */
+    update_state: undefined;
+} & WebsdkEventTypeMap;
 /** Infi 白板 websdk 全局对象，引入 min.js 后即会挂载至 window 对象上 */
 interface InfiWebSdkType {
     /**
@@ -481,10 +561,72 @@ interface InfiWebSdkType {
      */
     getSdkInstance: (configs: GetSdkInstanceConfigs) => GetSdkInstanceReturnType;
     readonly version: string;
-}
+}
+type MeetingId = string;
+type MeetingJoinerId = string;
+declare enum MeetingStatus {
+    /** 待开始 */
+    PENDING = 0,
+    /** 已开始 */
+    ON_GOING = 1,
+    /** 已结束 */
+    ENDED = 2,
+    /** 已取消 */
+    CANCELED = 3
+}
+declare enum DefaultForceFollow {
+    No = 0,
+    Yes = 1
+}
+declare enum DefaultPerm {
+    SameWithSdk = 0,
+    Edit = 1,
+    Comment = 2,
+    View = 3
+}
+/** 静态会议 interface */
+interface StaticMeetingData {
+    id: MeetingId;
+    title: string;
+    host: string;
+    planJoiners: MeetingJoinerId[];
+    planStart: number;
+    planEnd: number;
+    status?: MeetingStatus;
+    joined?: boolean;
+    coHosts: string[];
+    openAhead: number;
+    defaultForceFollow: DefaultForceFollow;
+    defaultPerm: DefaultPerm;
+}
+type EditMeetingCmpProp = {
+    data: StaticMeetingData | null;
+    onSubmit: (data: StaticMeetingData) => Promise<void>;
+    onFormChanged: (dirty: boolean) => void;
+    getCurServerTime: () => number;
+};
+type AddMemberCmpProp = {
+    curJoiners: string[];
+    onSubmit: (joiners: string[]) => void;
+    onCancel: () => void;
+    listAll: boolean;
+    getMeetingLink(): void;
+};
+type MeetingConfigs = {
+    /** 是否能在会议中查看成员列表，及是否可以直接添加参会人员 */
+    couldCheckMemberList?: boolean;
+    /** 是否可以发起会议 */
+    couldCreateMeeting?: boolean;
+    EditMeetingCmp?: FC<EditMeetingCmpProp>;
+    AddMemberCmp?: FC<AddMemberCmpProp>;
+};
 
 declare const InfiWebsdk: InfiWebSdkType;
 
+declare const SDKContext: React$1.Context<{
+    websdkIns: InternalWebSdkInsT;
+}>;
+
 /**
  * 根据文件后缀获取文件类型
  * @param ext
@@ -500,19 +642,19 @@ declare function getDocumentType(ext: string): DocumentType | undefined;
 
 declare const FULL_TOOLBAR_CONFIG: Record<ToolBarType, boolean>;
 
-declare const Setting: React$1.FC<{
+declare const Setting: React__default.FC<{
     showHistory?: boolean;
 }>;
 
 type PropT = {
     className?: string;
-    style?: React$1.CSSProperties;
+    style?: React__default.CSSProperties;
     title?: string;
     icon: string;
     onClick?: any;
     [key: string]: any;
 };
-declare const SvgIcon: React$1.FC<PropT>;
+declare const SvgIcon: React__default.FC<PropT>;
 
 type HoverTipPropsT = {
     content: string;
@@ -524,13 +666,13 @@ type HoverTipPropsT = {
     allowShow?: boolean;
     customStyle?: CSSProperties;
     tipContainerStyle?: CSSProperties;
-    children: React$1.ReactNode;
+    children: React__default.ReactNode;
 };
 type HoverTipRefT = {
     rootRef: HTMLDivElement | null;
 };
 /** 注意：仅在pc端使用 */
-declare const HoverTip: React$1.ForwardRefExoticComponent<HoverTipPropsT & React$1.RefAttributes<HoverTipRefT>>;
+declare const HoverTip: React__default.ForwardRefExoticComponent<HoverTipPropsT & React__default.RefAttributes<HoverTipRefT>>;
 
 interface Icon {
     [key: string]: string;
@@ -574,4 +716,4 @@ declare class SvgManager {
 /** 官方提供分组讨论插件，基于 websdk plugin 配置项引入后，会使得画布开启分组讨论功能 */
 declare const GroupTalkPlugin: ISdkPluginConstructor;
 
-export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, GridType, GroupTalkPlugin, HoverTip, type InfiSdkPluginType, type InfiUserInfoT, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkBottomRightPluginSlotType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };
+export { type AddMemberCmpProp, type CanUploadInfo, type ComponentProps, type CustomizeUploader, DefaultPerm, type EditMeetingCmpProp, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, GridType, GroupTalkPlugin, HoverTip, type InfiSdkPluginType, type InfiUserInfoT, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type MeetingConfigs, SDKContext, type SdkBottomRightPluginSlotType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type UploadRejectInfo, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };

package/dist/cjs/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index-beeb77d9.js");require("react"),require("react-dom"),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,Object.defineProperty(exports,"GridType",{enumerable:!0,get:function(){return e.GridType}}),exports.GroupTalkPlugin=e.GroupTalkPlugin,exports.HoverTip=e.HoverTip,exports.Setting=e.Setting,exports.SvgIcon=e.SvgIcon,exports.SvgManager=e.SvgManager,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index-00a77edf.js");require("react"),require("react-dom"),require("agora-rtc-sdk-ng"),Object.defineProperty(exports,"DefaultPerm",{enumerable:!0,get:function(){return e.DefaultPerm}}),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,Object.defineProperty(exports,"GridType",{enumerable:!0,get:function(){return e.GridType}}),exports.GroupTalkPlugin=e.GroupTalkPlugin,exports.HoverTip=e.HoverTip,exports.SDKContext=e.SDKContext,exports.Setting=e.Setting,exports.SvgIcon=e.SvgIcon,exports.SvgManager=e.SvgManager,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;