@plaso-infi/whiteboard-sdk 0.2.0 → 0.2.1

package/dist/esm/index.d.ts

@@ -66,6 +66,8 @@ declare enum GridType {
 type PreDownloadInfo = any;
 type DownloadConfigT = {
     enable: boolean;
+    fileEnable?: boolean;
+    imageEnable?: boolean;
     preCheck?: (event: string) => Promise<PreDownloadInfo>;
 };
 type Viewbox = {
@@ -148,6 +150,8 @@ interface InfiWebsdkInstanceType {
     toggleHistoryPanel: () => void;
     /** 修改画板背景 */
     changeGridType: (gridType: GridType) => void;
+    /** 设置跳转元素 */
+    setAnchorElement: (anchorElement?: string) => void;
     /**
      * 于白板内显示 toast 消息
      * @param message 消息
@@ -180,6 +184,13 @@ interface InfiWebsdkInstanceType {
 type ShadowViewDataT = {
     viewData?: [number, number, number, number];
 };
+type HistoryType = 'browser' | 'hash';
+type RouteConfigT = {
+    /** 设置路由history的类型（默认为browser）*/
+    historyType: HistoryType;
+    /** 路由中指定标识画布唯一性的字段，用于判断是否是跳转至本画布内的其他元素*/
+    boardCompositeKey?: string[];
+};
 type WebsdkEventTypeMap = {
     /** 白板未完成初始化 */
     not_initialized: void;
@@ -199,7 +210,7 @@ type WebsdkEventTypeMap = {
     presentation_change: boolean;
 };
 /** 当前白板的用户信息 */
-interface UserInfoT {
+interface InfiUserInfoT {
     loginName: string;
     userName: string;
     avatarUrl?: string;
@@ -240,11 +251,11 @@ interface GetSdkInstanceConfigs {
      */
     getShadowBoardQuery?: () => Promise<string>;
     /** 当前白板的用户信息 */
-    userInfo: UserInfoT;
+    userInfo: InfiUserInfoT;
     /** 用以挂载白板 DOM 的 HTML DOM 元素, 白板相关元素会自动 appendChild 至这个元素之内 */
     containerDom: HTMLDivElement;
     /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
-    getUsersInfo: (loginNames: string[]) => Promise<UserInfoT[]>;
+    getUsersInfo: (loginNames: string[]) => Promise<InfiUserInfoT[]>;
     /** 是否应用上一次用户偏好（背景设置、工具栏顺序、视野、颜料色板） */
     preferenceConfigs?: object;
     /** 画布天然提供若干 UI 插槽，分别位于画布页面的左上角与右上角，目前仅支持基于 React 实现 */
@@ -291,6 +302,13 @@ interface GetSdkInstanceConfigs {
      * 尚提供可以切换不同的画布侧环境的配置项入口。后期会移除该配置项，websdk 仅能使用线上环境
      */
     env?: 'prod' | 'dev' | 'test';
+    getElementLink?: (id: string) => string;
+    /** 链接跳转，返回值为string表示跳转元素id */
+    gotoLink?: (link: string) => string | undefined;
+    /**
+     * 路由配置，包括设置路由history的类型（默认为browser）、标识画布唯一性的search字段（默认为所有search字段）等
+     */
+    routeConfig?: RouteConfigT;
 }
 type CustomizeUploader = {
     loaders: {
@@ -450,4 +468,4 @@ declare class SvgManager {
     private static _isSymbol;
 }
 
-export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, HoverTip, type InfiSdkPluginType, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkBottomRightPluginSlotType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };
+export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, 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 };

package/dist/esm/index.js

@@ -1 +1 @@
-export{F as FULL_TOOLBAR_CONFIG,H as HoverTip,b as Setting,c as SvgIcon,d as SvgManager,I as default,a as getDocumentType,g as getFileType}from"./index-ae9c8b77.js";import"react";import"react-dom";import"agora-rtc-sdk-ng";
+export{F as FULL_TOOLBAR_CONFIG,H as HoverTip,b as Setting,c as SvgIcon,d as SvgManager,I as default,a as getDocumentType,g as getFileType}from"./index-78d849ca.js";import"react";import"react-dom";import"agora-rtc-sdk-ng";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaso-infi/whiteboard-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",