@plaso-infi/whiteboard-sdk 0.0.13 → 0.1.0

package/dist/cjs/index.d.ts

@@ -1,6 +1,40 @@
 type DocumentType = 'ppt' | 'pdf' | 'excel' | 'word';
 type FileType = 'image' | 'document' | 'video' | 'audio';
 
+type WebsdkEngineType = {
+    customFoldableTools?: SdkPluginSlotType[];
+};
+/** 在使用画布插件提供给外部的插件 UI 容器，如果需要插件在画布右上方出现功能入口，可以参考本类型声明来书写你的插件代码 */
+type SdkPluginSlotType = {
+    /** 画布 svg 通用使用规范名称 */
+    icon: string;
+    /** 插件名称，会给予 hover tooltip 展示字段名 */
+    name: string;
+    /** 插件 key，需要保证唯一 */
+    key: string;
+    /**
+     * 可以基于画布自带的 popup 面板进行插件内容的承载；在给入这个配置组件后，
+     * 在画布点击插件入口时，会自动弹出 popup 来承载这个配置组件
+     */
+    SubWinContent?: React.FC<{
+        closeSubWin: CB;
+    } & any>;
+};
+interface InfiSdkPluginType {
+    pluginId: string;
+    /** 插件初始化逻辑，可以选择在这里加载 SdkPluginSlotType 来在画布右上角显示你的插件  */
+    init(): void;
+    /** 插件销毁逻辑，该方法在画布销毁时会被自动执行 */
+    destroy(): void;
+}
+interface ISdkPluginConstructor {
+    new (websdkEngine: WebsdkEngineType): InfiSdkPluginType;
+}
+type InfiWebSdkPlugin = {
+    pluginConstructor: ISdkPluginConstructor;
+    beforeInit?: (plugin: InfiSdkPluginType) => void;
+};
+
 type Viewbox = {
     left: number;
     top: number;
@@ -189,11 +223,12 @@ interface GetSdkInstanceConfigs {
     };
     customizeUploaders?: CustomizeUploader;
     /**
-     * 各项功能开关
-     *
+     * 画布内各项功能开关：可以显示/隐藏部分功能的 UI 入口
      * - toolbarConfig:用于配置左侧工具栏中显示的工具，不配置时显示默认工具
      */
     toolbarWidgetsConfigs?: ToolBarWidgetsConfigsT;
+    /** 向画布内注入拆件能力，插件可以在画布内部显示， */
+    plugins?: InfiWebSdkPlugin[];
 }
 type CustomizeUploader = {
     loaders: {
@@ -246,4 +281,4 @@ declare function getDocumentType(ext: string): DocumentType | undefined;
 
 declare const FULL_TOOLBAR_CONFIG: Record<ToolBarType, boolean>;
 
-export { type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, type InfiWebsdkInstanceType, type ToolBarType, InfiWebsdk as default, getDocumentType, getFileType };
+export { type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, type InfiSdkPluginType, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkPluginSlotType, type ToolBarType, 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-3cce7b93.js");exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index-ae933cc5.js");require("react"),require("react-dom"),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;