@nocobase/flow-engine 2.1.0-beta.9 → 2.2.0-alpha.1

package/lib/flowSettings.d.ts

@@ -79,12 +79,19 @@ export interface FlowSettingsOpenOptions {
     /** 配置保存成功后触发的回调 */
     onSaved?: () => void | Promise<void>;
 }
+export type FlowSettingsComponent = React.ComponentType<any>;
+export type FlowSettingsComponentModule = {
+    default?: FlowSettingsComponent;
+} | Record<string, FlowSettingsComponent>;
+export type FlowSettingsComponentLoader = () => Promise<FlowSettingsComponentModule | FlowSettingsComponent>;
+export type FlowSettingsComponentLoaderMap = Record<string, FlowSettingsComponentLoader>;
 export declare class FlowSettings {
     #private;
     components: Record<string, any>;
     scopes: Record<string, any>;
     private antdComponentsLoaded;
     enabled: boolean;
+    private engine;
     toolbarItems: ToolbarItemConfig[];
     constructor(engine: FlowEngine);
     on(event: 'beforeOpen', callback: (...args: any[]) => void): void;
@@ -110,6 +117,7 @@ export declare class FlowSettings {
      * flowSettings.registerComponents({ MyComponent, AnotherComponent });
      */
     registerComponents(components: Record<string, any>): void;
+    registerComponentLoaders(loaders: FlowSettingsComponentLoaderMap): void;
     /**
      * 添加作用域到 FlowSettings 的作用域注册表中。
      * 这些作用域可以在 flow step 的 uiSchema 中使用。
@@ -122,17 +130,17 @@ export declare class FlowSettings {
     /**
      * 启用流程设置组件的显示
      * @example
-     * flowSettings.enable();
+     * await flowSettings.enable();
      */
-    enable(): void;
-    forceEnable(): void;
+    enable(): Promise<void>;
+    forceEnable(): Promise<void>;
     /**
      * 禁用流程设置组件的显示
      * @example
-     * flowSettings.disable();
+     * await flowSettings.disable();
      */
-    disable(): void;
-    forceDisable(): void;
+    disable(): Promise<void>;
+    forceDisable(): Promise<void>;
     /**
      * 添加扩展工具栏项目
      * @param {ToolbarItemConfig} config 项目配置

package/lib/flowSettings.js

@@ -65,6 +65,7 @@ var import_utils = require("./utils");
 var import_exceptions = require("./utils/exceptions");
 var import_useFlowStep = require("./hooks/useFlowStep");
 var import_views = require("./views");
+var import_lazy_helper = require("./lazy-helper");
 var _forceEnabled, _emitter;
 const Panel = import_antd.Collapse.Panel;
 const _FlowSettings = class _FlowSettings {
@@ -73,10 +74,12 @@ const _FlowSettings = class _FlowSettings {
     __publicField(this, "scopes", {});
     __publicField(this, "antdComponentsLoaded", false);
     __publicField(this, "enabled");
+    __publicField(this, "engine");
     __privateAdd(this, _forceEnabled, false);
     // 强制启用状态，主要用于设计模式下的强制启用
     __publicField(this, "toolbarItems", []);
     __privateAdd(this, _emitter, new import_emitter.Emitter());
+    this.engine = engine;
     this.enabled = false;
     engine.context.defineProperty("flowSettingsEnabled", {
       get: /* @__PURE__ */ __name(() => this.enabled, "get"),
@@ -215,6 +218,29 @@ const _FlowSettings = class _FlowSettings {
       this.components[name] = components[name];
     });
   }
+  registerComponentLoaders(loaders) {
+    Object.entries(loaders).forEach(([name, loader]) => {
+      if (this.components[name]) {
+        console.warn(`FlowSettings: Component with name '${name}' is already registered and will be overwritten.`);
+      }
+      this.components[name] = (0, import_lazy_helper.lazy)(async () => {
+        const loaded = await loader();
+        if (typeof loaded === "function") {
+          return { default: loaded };
+        }
+        if ((loaded == null ? void 0 : loaded.default) && typeof loaded.default === "function") {
+          return { default: loaded.default };
+        }
+        const namedComponent = loaded == null ? void 0 : loaded[name];
+        if (typeof namedComponent === "function") {
+          return { default: namedComponent };
+        }
+        throw new Error(
+          `FlowSettings: component loader for '${name}' must resolve to a React component or a module exporting it.`
+        );
+      });
+    });
+  }
   /**
    * 添加作用域到 FlowSettings 的作用域注册表中。
    * 这些作用域可以在 flow step 的 uiSchema 中使用。
@@ -234,27 +260,29 @@ const _FlowSettings = class _FlowSettings {
   /**
    * 启用流程设置组件的显示
    * @example
-   * flowSettings.enable();
+   * await flowSettings.enable();
    */
-  enable() {
+  async enable() {
+    await this.engine.preloadModelLoaders();
     this.enabled = true;
   }
-  forceEnable() {
+  async forceEnable() {
+    await this.engine.preloadModelLoaders();
     __privateSet(this, _forceEnabled, true);
     this.enabled = true;
   }
   /**
    * 禁用流程设置组件的显示
    * @example
-   * flowSettings.disable();
+   * await flowSettings.disable();
    */
-  disable() {
+  async disable() {
     if (__privateGet(this, _forceEnabled)) {
       return;
     }
     this.enabled = false;
   }
-  forceDisable() {
+  async forceDisable() {
     __privateSet(this, _forceEnabled, false);
     this.enabled = false;
   }

package/lib/index.d.ts

@@ -34,5 +34,7 @@ export { getSnippetBody, listSnippetsForContext, registerRunJSSnippet } from './
 export * from './views';
 export { DATA_SOURCE_DIRTY_EVENT, ENGINE_SCOPE_KEY, getEmitterViewActivatedVersion, VIEW_ACTIVATED_EVENT, VIEW_ACTIVATED_VERSION, VIEW_ENGINE_SCOPE, } from './views/viewEvents';
 export * from './FlowDefinition';
+export { DetachedFlowRegistry, replaceFlowRegistry, serializeFlowRegistry } from './flow-registry';
+export type { FlowRegistryData } from './flow-registry';
 export { createViewScopedEngine } from './ViewScopedFlowEngine';
 export { createBlockScopedEngine } from './BlockScopedFlowEngine';

package/lib/index.js

@@ -28,6 +28,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   DATA_SOURCE_DIRTY_EVENT: () => import_viewEvents.DATA_SOURCE_DIRTY_EVENT,
+  DetachedFlowRegistry: () => import_flow_registry.DetachedFlowRegistry,
   ENGINE_SCOPE_KEY: () => import_viewEvents.ENGINE_SCOPE_KEY,
   RunJSContextRegistry: () => import_registry.RunJSContextRegistry,
   VIEW_ACTIVATED_EVENT: () => import_viewEvents.VIEW_ACTIVATED_EVENT,
@@ -47,6 +48,8 @@ __export(src_exports, {
   registerRunJSContextContribution: () => import_contributions.registerRunJSContextContribution,
   registerRunJSLib: () => import_runjsLibs.registerRunJSLib,
   registerRunJSSnippet: () => import_snippets.registerRunJSSnippet,
+  replaceFlowRegistry: () => import_flow_registry.replaceFlowRegistry,
+  serializeFlowRegistry: () => import_flow_registry.serializeFlowRegistry,
   setupRunJSContexts: () => import_setup.setupRunJSContexts
 });
 module.exports = __toCommonJS(src_exports);
@@ -75,11 +78,13 @@ var import_snippets = require("./runjs-context/snippets");
 __reExport(src_exports, require("./views"), module.exports);
 var import_viewEvents = require("./views/viewEvents");
 __reExport(src_exports, require("./FlowDefinition"), module.exports);
+var import_flow_registry = require("./flow-registry");
 var import_ViewScopedFlowEngine = require("./ViewScopedFlowEngine");
 var import_BlockScopedFlowEngine = require("./BlockScopedFlowEngine");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DATA_SOURCE_DIRTY_EVENT,
+  DetachedFlowRegistry,
   ENGINE_SCOPE_KEY,
   RunJSContextRegistry,
   VIEW_ACTIVATED_EVENT,
@@ -99,6 +104,8 @@ var import_BlockScopedFlowEngine = require("./BlockScopedFlowEngine");
   registerRunJSContextContribution,
   registerRunJSLib,
   registerRunJSSnippet,
+  replaceFlowRegistry,
+  serializeFlowRegistry,
   setupRunJSContexts,
   ...require("./types"),
   ...require("./utils"),

package/lib/lazy-helper.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+type LazyComponentType<M extends Record<string, any>, K extends keyof M> = {
+    [P in K]: M[P];
+};
+export declare function lazy<M extends Record<'default', any>>(factory: () => Promise<M>): M['default'];
+export declare function lazy<M extends Record<string, any>, K extends keyof M = keyof M>(factory: () => Promise<M>, ...componentNames: K[]): LazyComponentType<M, K>;
+export {};

package/lib/lazy-helper.js

@@ -0,0 +1,71 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var lazy_helper_exports = {};
+__export(lazy_helper_exports, {
+  lazy: () => lazy
+});
+module.exports = __toCommonJS(lazy_helper_exports);
+var import_react = __toESM(require("react"));
+function lazy(factory, ...componentNames) {
+  if (componentNames.length === 0) {
+    const LazyComponent = (0, import_react.lazy)(
+      () => factory().then((module2) => ({
+        default: module2.default
+      }))
+    );
+    const Component = /* @__PURE__ */ __name((props) => /* @__PURE__ */ import_react.default.createElement(import_react.default.Suspense, { fallback: null }, /* @__PURE__ */ import_react.default.createElement(LazyComponent, { ...props })), "Component");
+    return Component;
+  }
+  return componentNames.reduce(
+    (acc, name) => {
+      const LazyComponent = (0, import_react.lazy)(
+        () => factory().then((module2) => ({
+          default: module2[name]
+        }))
+      );
+      acc[name] = (props) => /* @__PURE__ */ import_react.default.createElement(import_react.default.Suspense, { fallback: null }, /* @__PURE__ */ import_react.default.createElement(LazyComponent, { ...props }));
+      return acc;
+    },
+    {}
+  );
+}
+__name(lazy, "lazy");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  lazy
+});

package/lib/locale/en-US.json

@@ -34,6 +34,7 @@
   "Failed to destroy model after creation error": "Failed to destroy model after creation error",
   "Failed to get action {{action}}": "Failed to get action {{action}}",
   "Failed to get configurable flows for model {{model}}": "Failed to get configurable flows for model {{model}}",
+  "Attributes are unavailable before selecting a record": "Attributes are unavailable before selecting a record",
   "Failed to import FormDialog": "Failed to import FormDialog",
   "Failed to import FormDialog or FormStep": "Failed to import FormDialog or FormStep",
   "Failed to import Formily components": "Failed to import Formily components",

package/lib/locale/index.d.ts

@@ -43,6 +43,7 @@ export declare const locales: {
         "Failed to destroy model after creation error": string;
         "Failed to get action {{action}}": string;
         "Failed to get configurable flows for model {{model}}": string;
+        "Attributes are unavailable before selecting a record": string;
         "Failed to import FormDialog": string;
         "Failed to import FormDialog or FormStep": string;
         "Failed to import Formily components": string;
@@ -120,6 +121,7 @@ export declare const locales: {
         "Failed to destroy model after creation error": string;
         "Failed to get action {{action}}": string;
         "Failed to get configurable flows for model {{model}}": string;
+        "Attributes are unavailable before selecting a record": string;
         "Failed to import FormDialog": string;
         "Failed to import FormDialog or FormStep": string;
         "Failed to import Formily components": string;

package/lib/locale/zh-CN.json

@@ -31,6 +31,7 @@
   "Failed to destroy model after creation error": "创建错误后销毁模型失败",
   "Failed to get action {{action}}": "获取 action '{{action}}' 失败",
   "Failed to get configurable flows for model {{model}}": "获取模型 '{{model}}' 的可配置 flows 失败",
+  "Attributes are unavailable before selecting a record": "选择记录之前，当前项属性不可用",
   "Failed to import FormDialog": "导入 FormDialog 失败",
   "Failed to import FormDialog or FormStep": "导入 FormDialog 或 FormStep 失败",
   "Failed to import Formily components": "导入 Formily 组件失败",

package/lib/models/DisplayItemModel.d.ts

@@ -6,7 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { DefaultStructure } from '@nocobase/flow-engine';
+import type { DefaultStructure } from '../types';
 import { CollectionFieldModel } from './CollectionFieldModel';
 export declare class DisplayItemModel<T extends DefaultStructure = DefaultStructure> extends CollectionFieldModel<T> {
 }

package/lib/models/EditableItemModel.d.ts

@@ -6,7 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { DefaultStructure } from '@nocobase/flow-engine';
+import type { DefaultStructure } from '../types';
 import { CollectionFieldModel } from './CollectionFieldModel';
 export declare class EditableItemModel<T extends DefaultStructure = DefaultStructure> extends CollectionFieldModel<T> {
 }

package/lib/models/FilterableItemModel.d.ts

@@ -6,7 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { DefaultStructure } from '@nocobase/flow-engine';
+import type { DefaultStructure } from '../types';
 import { CollectionFieldModel } from './CollectionFieldModel';
 export declare class FilterableItemModel<T extends DefaultStructure = DefaultStructure> extends CollectionFieldModel<T> {
 }

package/lib/models/flowModel.d.ts

@@ -13,6 +13,7 @@ import { FlowContext, FlowModelContext, FlowRuntimeContext } from '../flowContex
 import { FlowEngine } from '../flowEngine';
 import type { ActionDefinition, ArrayElementType, CreateModelOptions, CreateSubModelOptions, DefaultStructure, FlowDefinitionOptions, FlowModelMeta, FlowModelOptions, ModelConstructor, ParamObject, ParentFlowModel, PersistOptions, ResolveUseResult, StepParams } from '../types';
 import { IModelComponentProps, ReadonlyModelProps } from '../types';
+import type { MenuProps } from 'antd';
 import { ModelActionRegistry } from '../action-registry/ModelActionRegistry';
 import { ModelEventRegistry } from '../event-registry/ModelEventRegistry';
 import { GlobalFlowRegistry } from '../flow-registry/GlobalFlowRegistry';
@@ -21,19 +22,20 @@ import { FlowSettingsOpenOptions } from '../flowSettings';
 import type { ScheduleOptions } from '../scheduler/ModelOperationScheduler';
 import type { DispatchEventOptions, EventDefinition } from '../types';
 import { ForkFlowModel } from './forkFlowModel';
-import type { MenuProps } from 'antd';
 type BaseMenuItem = NonNullable<MenuProps['items']>[number];
-type MenuLeafItem = Exclude<BaseMenuItem, {
-    children: MenuProps['items'];
-}>;
-export type FlowModelExtraMenuItem = Omit<MenuLeafItem, 'key'> & {
+type MenuBaseItem = Omit<Exclude<BaseMenuItem, null>, 'key' | 'children'>;
+export type FlowModelExtraMenuItem = MenuBaseItem & {
     key: React.Key;
     group?: string;
     sort?: number;
+    label?: React.ReactNode;
+    disabled?: boolean;
     onClick?: () => void;
+    children?: FlowModelExtraMenuItem[];
 };
-type FlowModelExtraMenuItemInput = Omit<FlowModelExtraMenuItem, 'key'> & {
+type FlowModelExtraMenuItemInput = Omit<FlowModelExtraMenuItem, 'key' | 'children'> & {
     key?: React.Key;
+    children?: FlowModelExtraMenuItemInput[];
 };
 type ExtraMenuItemEntry = {
     group?: string;
@@ -239,6 +241,7 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
      * 使用 lodash debounce 避免频繁调用
      */
     private _rerunLastAutoRun;
+    private resetAutoRunState;
     /**
      * 通用事件分发钩子：开始
      * 子类可覆盖；beforeRender 事件可通过抛出 FlowExitException 提前终止。
@@ -297,10 +300,10 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     removeParentDelegate(): void;
     addSubModel<T extends FlowModel>(subKey: string, options: CreateModelOptions | T): T;
     setSubModel(subKey: string, options: CreateModelOptions | FlowModel): FlowModel<DefaultStructure>;
-    filterSubModels<K extends keyof Structure['subModels'], R>(subKey: K, callback: (model: ArrayElementType<Structure['subModels'][K]>, index: number) => boolean): ArrayElementType<Structure['subModels'][K]>[];
-    mapSubModels<K extends keyof Structure['subModels'], R>(subKey: K, callback: (model: ArrayElementType<Structure['subModels'][K]>, index: number) => R): R[];
-    hasSubModel<K extends keyof Structure['subModels']>(subKey: K): boolean;
-    findSubModel<K extends keyof Structure['subModels'], R>(subKey: K, callback: (model: ArrayElementType<Structure['subModels'][K]>) => R): ArrayElementType<Structure['subModels'][K]> | null;
+    filterSubModels<K extends keyof NonNullable<Structure['subModels']>, R>(subKey: K, callback: (model: ArrayElementType<NonNullable<Structure['subModels']>[K]>, index: number) => boolean): ArrayElementType<NonNullable<Structure['subModels']>[K]>[];
+    mapSubModels<K extends keyof NonNullable<Structure['subModels']>, R>(subKey: K, callback: (model: ArrayElementType<NonNullable<Structure['subModels']>[K]>, index: number) => R): R[];
+    hasSubModel<K extends keyof NonNullable<Structure['subModels']>>(subKey: K): boolean;
+    findSubModel<K extends keyof NonNullable<Structure['subModels']>, R>(subKey: K, callback: (model: ArrayElementType<NonNullable<Structure['subModels']>[K]>) => R): ArrayElementType<NonNullable<Structure['subModels']>[K]> | null;
     createRootModel(options: any): FlowModel<DefaultStructure>;
     /**
      * 对指定子模型派发 beforeRender 事件（顺序执行并使用缓存）。