feat(utils): add workspace utils

liujuping · JackLian · commit ad044f49ed90 · 2023-11-23T16:22:09.000+08:00
diff --git a/packages/designer/src/plugin/plugin-types.ts b/packages/designer/src/plugin/plugin-types.ts
@@ -60,6 +60,7 @@ export interface ILowCodePluginContextPrivate {
   set workspace(workspace: IPublicApiWorkspace);
   set editorWindow(window: IPublicModelWindow);
   set registerLevel(level: IPublicEnumPluginRegisterLevel);
+  set isPluginRegisteredInWorkspace(flag: boolean);
 }
 export interface ILowCodePluginContextApiAssembler {
   assembleApis(
diff --git a/packages/engine/src/engine-core.ts b/packages/engine/src/engine-core.ts
@@ -139,6 +139,7 @@ const pluginContextApiAssembler: ILowCodePluginContextApiAssembler = {
     context.logger = new Logger({ level: 'warn', bizName: `plugin:${pluginName}` });
     context.workspace = workspace;
     context.registerLevel = IPublicEnumPluginRegisterLevel.Default;
+    context.isPluginRegisteredInWorkspace = false;
   },
 };
 
diff --git a/packages/types/src/shell/model/plugin-context.ts b/packages/types/src/shell/model/plugin-context.ts
@@ -108,6 +108,8 @@ export interface IPublicModelPluginContext {
    */
   get registerLevel(): IPublicEnumPluginRegisterLevel;
 
+  get isPluginRegisteredInWorkspace(): boolean;
+
   get editorWindow(): IPublicModelWindow;
 }
 
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -30,3 +30,4 @@ export * from './is-plugin-event-name';
 export * as css from './css-helper';
 export { transactionManager } from './transaction-manager';
 export * from './check-types';
+export * from './workspace';
diff --git a/packages/utils/src/workspace.tsx b/packages/utils/src/workspace.tsx
@@ -0,0 +1,54 @@
+import React, { useEffect, useState, useCallback } from 'react';
+import { IPublicModelPluginContext, IPublicEnumPluginRegisterLevel, IPublicModelWindow, IPublicModelEditorView } from '@alilc/lowcode-types';
+
+/**
+ * 高阶组件（HOC）：为组件提供 view 插件上下文。
+ *
+ * @param {React.ComponentType} Component - 需要被封装的组件。
+ * @param {string|string[]} viewName - 视图名称或视图名称数组，用于过滤特定的视图插件上下文。
+ * @returns {React.ComponentType} 返回封装后的组件。
+ *
+ * @example
+ * // 用法示例（函数组件）:
+ * const EnhancedComponent = ProvideViewPluginContext(MyComponent, "viewName");
+ */
+export const ProvideViewPluginContext = (Component: any, viewName?: string | string[]) => {
+  // 创建一个新的函数组件，以便在其中使用 Hooks
+  return function WithPluginContext(props: {
+    [key: string]: any;
+
+    pluginContext?: IPublicModelPluginContext;
+  }) {
+    const getPluginContextFun = useCallback((editorWindow?: IPublicModelWindow | null) => {
+      if (!editorWindow?.currentEditorView) {
+        return null;
+      }
+      if (viewName) {
+        const items = editorWindow?.editorViews.filter(d => (d as any).viewName === viewName || (Array.isArray(viewName) && viewName.includes((d as any).viewName)));
+        return items[0];
+      } else {
+        return editorWindow.currentEditorView;
+      }
+    }, []);
+
+    const { workspace } = props.pluginContext || {};
+    const [pluginContext, setPluginContext] = useState<IPublicModelEditorView | null>(getPluginContextFun(workspace?.window));
+
+    useEffect(() => {
+      if (workspace?.window) {
+        const ctx = getPluginContextFun(workspace.window);
+        ctx && setPluginContext(ctx);
+      }
+      return workspace?.onChangeActiveEditorView(() => {
+        const ctx = getPluginContextFun(workspace.window);
+        ctx && setPluginContext(ctx);
+      });
+    }, [workspace, getPluginContextFun]);
+
+    if (props.pluginContext?.registerLevel !== IPublicEnumPluginRegisterLevel.Workspace || !props.pluginContext) {
+      return <Component {...props} />;
+    }
+
+    return <Component {...props} pluginContext={pluginContext} />;
+  };
+};
diff --git a/packages/workspace/src/context/base-context.ts b/packages/workspace/src/context/base-context.ts
@@ -170,6 +170,7 @@ export class BasicContext implements IBasicContext {
           context.editorWindow = new Window(editorWindow);
         }
         context.registerLevel = registerLevel;
+        context.isPluginRegisteredInWorkspace = registerLevel === IPublicEnumPluginRegisterLevel.Workspace;
       },
     };
 

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ export interface ILowCodePluginContextPrivate {`
`60`	`60`	`set workspace(workspace: IPublicApiWorkspace);`
`61`	`61`	`set editorWindow(window: IPublicModelWindow);`
`62`	`62`	`set registerLevel(level: IPublicEnumPluginRegisterLevel);`
	`63`	`+ set isPluginRegisteredInWorkspace(flag: boolean);`
`63`	`64`	`}`
`64`	`65`	`export interface ILowCodePluginContextApiAssembler {`
`65`	`66`	`assembleApis(`
Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,8 @@ export interface IPublicModelPluginContext {`
`108`	`108`	`*/`
`109`	`109`	`get registerLevel(): IPublicEnumPluginRegisterLevel;`
`110`	`110`
	`111`	`+ get isPluginRegisteredInWorkspace(): boolean;`
	`112`	`+`
`111`	`113`	`get editorWindow(): IPublicModelWindow;`
`112`	`114`	`}`
`113`	`115`
Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,7 @@ export class BasicContext implements IBasicContext {`
`170`	`170`	`context.editorWindow = new Window(editorWindow);`
`171`	`171`	`}`
`172`	`172`	`context.registerLevel = registerLevel;`
	`173`	`+ context.isPluginRegisteredInWorkspace = registerLevel === IPublicEnumPluginRegisterLevel.Workspace;`
`173`	`174`	`},`
`174`	`175`	`};`
`175`	`176`