@nocobase/flow-engine 2.0.22 → 2.1.0-alpha.10

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/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/models/flowModel.js

@@ -56,13 +56,11 @@ var import_reactive = require("@formily/reactive");
 var import_lodash = __toESM(require("lodash"));
 var import_react = __toESM(require("react"));
 var import_secure = require("uid/secure");
-var import_StepRequiredSettingsDialog = require("../components/settings/wrappers/contextual/StepRequiredSettingsDialog");
-var import_StepSettingsDialog = require("../components/settings/wrappers/contextual/StepSettingsDialog");
 var import_emitter = require("../emitter");
 var import_InstanceFlowRegistry = require("../flow-registry/InstanceFlowRegistry");
 var import_flowContext = require("../flowContext");
 var import_utils = require("../utils");
-var import_lib = require("antd/lib");
+var import_antd = require("antd");
 var import_ModelActionRegistry = require("../action-registry/ModelActionRegistry");
 var import_utils2 = require("../components/subModel/utils");
 var import_ModelEventRegistry = require("../event-registry/ModelEventRegistry");
@@ -75,6 +73,16 @@ const classEventRegistries = /* @__PURE__ */ new WeakMap();
 const modelMetas = /* @__PURE__ */ new WeakMap();
 const modelGlobalRegistries = /* @__PURE__ */ new WeakMap();
 const classMenuExtensions = /* @__PURE__ */ new WeakMap();
+async function loadOpenStepSettingsDialog() {
+  const mod = await import("../components/settings/wrappers/contextual/StepSettingsDialog");
+  return mod.openStepSettingsDialog;
+}
+__name(loadOpenStepSettingsDialog, "loadOpenStepSettingsDialog");
+async function loadOpenRequiredParamsStepFormDialog() {
+  const mod = await import("../components/settings/wrappers/contextual/StepRequiredSettingsDialog");
+  return mod.openRequiredParamsStepFormDialog;
+}
+__name(loadOpenRequiredParamsStepFormDialog, "loadOpenRequiredParamsStepFormDialog");
 var ModelRenderMode = /* @__PURE__ */ ((ModelRenderMode2) => {
   ModelRenderMode2["ReactElement"] = "reactElement";
   ModelRenderMode2["RenderFunction"] = "renderFunction";
@@ -1058,7 +1066,7 @@ const _FlowModel = class _FlowModel {
    * @param {string} stepKey 步骤的唯一标识符
    * @returns {void}
    */
-  openStepSettingsDialog(flowKey, stepKey) {
+  async openStepSettingsDialog(flowKey, stepKey) {
     var _a;
     const flow = this.getFlow(flowKey);
     const step = (_a = flow == null ? void 0 : flow.steps) == null ? void 0 : _a[stepKey];
@@ -1069,7 +1077,8 @@ const _FlowModel = class _FlowModel {
     const ctx = new import_flowContext.FlowRuntimeContext(this, flowKey, "settings");
     (0, import_utils.setupRuntimeContextSteps)(ctx, flow.steps, this, flowKey);
     ctx.defineProperty("currentStep", { value: step });
-    return (0, import_StepSettingsDialog.openStepSettingsDialog)({
+    const openStepSettingsDialog = await loadOpenStepSettingsDialog();
+    return openStepSettingsDialog({
       model: this,
       flowKey,
       stepKey,
@@ -1084,7 +1093,8 @@ const _FlowModel = class _FlowModel {
    * @returns {Promise<any>} 返回表单提交的值
    */
   async configureRequiredSteps(dialogWidth, dialogTitle) {
-    return (0, import_StepRequiredSettingsDialog.openRequiredParamsStepFormDialog)({
+    const openRequiredParamsStepFormDialog = await loadOpenRequiredParamsStepFormDialog();
+    return openRequiredParamsStepFormDialog({
       model: this,
       dialogWidth,
       dialogTitle
@@ -1303,7 +1313,7 @@ const _ErrorFlowModel = class _ErrorFlowModel extends FlowModel {
     this.errorMessage = msg;
   }
   render() {
-    return /* @__PURE__ */ import_react.default.createElement(import_lib.Typography.Text, { type: "danger" }, this.errorMessage);
+    return /* @__PURE__ */ import_react.default.createElement(import_antd.Typography.Text, { type: "danger" }, this.errorMessage);
   }
 };
 __name(_ErrorFlowModel, "ErrorFlowModel");

package/lib/types.d.ts

@@ -303,6 +303,41 @@ export interface CreateModelOptions {
     delegateToParent?: boolean;
     [key: string]: any;
 }
+/**
+ * FlowModel loader result.
+ * Supports returning the model constructor directly, a default export, or a module object containing the named export.
+ */
+export type FlowModelLoaderResult = ModelConstructor | {
+    default?: ModelConstructor;
+    [key: string]: unknown;
+} | Record<string, unknown>;
+/**
+ * FlowModel loader function.
+ */
+export type FlowModelLoader = () => Promise<FlowModelLoaderResult>;
+/**
+ * FlowModel loader entry.
+ * Future contribution-style fields are intentionally kept as commented placeholders in phase A
+ * and are not consumed by current runtime logic.
+ */
+export interface FlowModelLoaderEntry {
+    loader: FlowModelLoader;
+}
+/**
+ * FlowModel loader entry map.
+ */
+export type FlowModelLoaderMap = Record<string, FlowModelLoaderEntry>;
+/**
+ * Batch ensure result.
+ */
+export interface EnsureBatchResult {
+    requested: string[];
+    loaded: string[];
+    failed: Array<{
+        name: string;
+        error?: unknown;
+    }>;
+}
 export interface IFlowModelRepository<T extends FlowModel = FlowModel> {
     findOne(query: Record<string, any>): Promise<Record<string, any> | null>;
     save(model: T, options?: {

package/lib/utils/runjsTemplateCompat.js

@@ -527,8 +527,8 @@ function extractUsedCtxLibKeys(code) {
 }
 __name(extractUsedCtxLibKeys, "extractUsedCtxLibKeys");
 function injectEnsureLibsPreamble(code) {
-  if (!CTX_LIBS_MARKER_RE.test(code)) return code;
   if (ENSURE_LIBS_MARKER_RE.test(code)) return code;
+  if (!CTX_LIBS_MARKER_RE.test(code)) return code;
   const keys = extractUsedCtxLibKeys(code);
   if (!keys.length) return code;
   return `/* __runjs_ensure_libs */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/flow-engine",
-  "version": "2.0.22",
+  "version": "2.1.0-alpha.10",
   "private": false,
   "description": "A standalone flow engine for NocoBase, managing workflows, models, and actions.",
   "main": "lib/index.js",
@@ -8,8 +8,8 @@
   "dependencies": {
     "@formily/antd-v5": "1.x",
     "@formily/reactive": "2.x",
-    "@nocobase/sdk": "2.0.22",
-    "@nocobase/shared": "2.0.22",
+    "@nocobase/sdk": "2.1.0-alpha.10",
+    "@nocobase/shared": "2.1.0-alpha.10",
     "ahooks": "^3.7.2",
     "dayjs": "^1.11.9",
     "dompurify": "^3.0.2",
@@ -36,5 +36,5 @@
   ],
   "author": "NocoBase Team",
   "license": "Apache-2.0",
-  "gitHead": "7b703580c4bb60f1e5e44c8fd685141bb8b3a47c"
+  "gitHead": "ce790d46c0a5768ca9618c7d0d77ab8300de75c8"
 }

package/src/__tests__/flowEngine.modelLoaders.test.ts

@@ -0,0 +1,245 @@
+/**
+ * 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.
+ */
+
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { FlowEngine } from '../flowEngine';
+import { ErrorFlowModel, FlowModel } from '../models';
+import type { IFlowModelRepository } from '../types';
+
+class MockFlowModelRepository implements IFlowModelRepository {
+  findOneResult: any = null;
+  save = vi.fn(async (model: FlowModel) => ({ success: true, uid: model.uid }));
+
+  async findOne() {
+    return this.findOneResult ? JSON.parse(JSON.stringify(this.findOneResult)) : null;
+  }
+
+  async destroy() {
+    return true;
+  }
+
+  async move() {}
+
+  async duplicate() {
+    return null;
+  }
+}
+
+describe('FlowEngine model loaders', () => {
+  let engine: FlowEngine;
+  let repo: MockFlowModelRepository;
+
+  beforeEach(() => {
+    engine = new FlowEngine();
+    repo = new MockFlowModelRepository();
+    engine.setModelRepository(repo);
+  });
+
+  it('resolves explicit and meta-default model trees before synchronous creation', async () => {
+    class ParentModel extends FlowModel {}
+    class ChildModel extends FlowModel {}
+    class DefaultChildModel extends FlowModel {}
+
+    ParentModel.define({
+      createModelOptions: {
+        subModels: {
+          defaultChild: {
+            use: 'DefaultChildModel',
+          },
+        },
+      },
+    });
+
+    const parentLoader = vi.fn(async () => ({ ParentModel }));
+    const childLoader = vi.fn(async () => ({ ChildModel }));
+    const defaultChildLoader = vi.fn(async () => ({ DefaultChildModel }));
+
+    engine.registerModelLoaders({
+      ParentModel: { loader: parentLoader },
+      ChildModel: { loader: childLoader },
+      DefaultChildModel: { loader: defaultChildLoader },
+    });
+
+    const model = await engine.loadOrCreateModel({
+      uid: 'parent-model',
+      use: 'ParentModel',
+      subModels: {
+        child: {
+          use: 'ChildModel',
+        },
+      },
+    });
+
+    expect(model).toBeInstanceOf(ParentModel);
+    expect(model?.subModels.child).toBeInstanceOf(ChildModel);
+    expect(model?.subModels.defaultChild).toBeInstanceOf(DefaultChildModel);
+    expect(parentLoader).toHaveBeenCalledTimes(1);
+    expect(childLoader).toHaveBeenCalledTimes(1);
+    expect(defaultChildLoader).toHaveBeenCalledTimes(1);
+  });
+
+  it('resolves repository-loaded model trees before loadModel creates instances', async () => {
+    class RepoRootModel extends FlowModel {}
+    class RepoChildModel extends FlowModel {}
+
+    const rootLoader = vi.fn(async () => ({ RepoRootModel }));
+    const childLoader = vi.fn(async () => ({ RepoChildModel }));
+
+    engine.registerModelLoaders({
+      RepoRootModel: { loader: rootLoader },
+      RepoChildModel: { loader: childLoader },
+    });
+
+    repo.findOneResult = {
+      uid: 'repo-root',
+      use: 'RepoRootModel',
+      subModels: {
+        child: {
+          use: 'RepoChildModel',
+        },
+      },
+    };
+
+    const model = await engine.loadModel({ uid: 'repo-root' });
+
+    expect(model).toBeInstanceOf(RepoRootModel);
+    expect(model?.subModels.child).toBeInstanceOf(RepoChildModel);
+    expect(rootLoader).toHaveBeenCalledTimes(1);
+    expect(childLoader).toHaveBeenCalledTimes(1);
+  });
+
+  it('supports async model creation and async getters', async () => {
+    class AsyncRootModel extends FlowModel {}
+    class AsyncChildModel extends FlowModel {}
+
+    const rootLoader = vi.fn(async () => ({ AsyncRootModel }));
+    const childLoader = vi.fn(async () => ({ AsyncChildModel }));
+
+    engine.registerModelLoaders({
+      AsyncRootModel: { loader: rootLoader },
+      AsyncChildModel: { loader: childLoader },
+    });
+
+    const rootClass = await engine.getModelClassAsync('AsyncRootModel');
+    const classes = await engine.getModelClassesAsync();
+    const model = await engine.createModelAsync({
+      uid: 'async-root',
+      use: 'AsyncRootModel',
+      subModels: {
+        child: {
+          use: 'AsyncChildModel',
+        },
+      },
+    });
+
+    expect(rootClass).toBe(AsyncRootModel);
+    expect(classes.get('AsyncRootModel')).toBe(AsyncRootModel);
+    expect(classes.get('AsyncChildModel')).toBe(AsyncChildModel);
+    expect(model).toBeInstanceOf(AsyncRootModel);
+    expect(model.subModels.child).toBeInstanceOf(AsyncChildModel);
+    expect(rootLoader).toHaveBeenCalledTimes(1);
+    expect(childLoader).toHaveBeenCalledTimes(1);
+  });
+
+  it('createModelAsync degrades unresolved loader failures to ErrorFlowModel', async () => {
+    const invalidLoader = vi.fn(async () => ({ notAModel: {} }));
+
+    engine.registerModelLoaders({
+      BrokenRootModel: { loader: invalidLoader as any },
+    });
+
+    const model = await engine.createModelAsync({
+      uid: 'broken-root',
+      use: 'BrokenRootModel',
+    });
+
+    expect(model).toBeInstanceOf(ErrorFlowModel);
+    expect(invalidLoader).toHaveBeenCalledTimes(1);
+  });
+
+  it('keeps loader resolution idempotent across resolveModelTree and flow settings preload', async () => {
+    class RuntimeResolvedModel extends FlowModel {}
+    class DesignResolvedModel extends FlowModel {}
+
+    const runtimeLoader = vi.fn(async () => ({ RuntimeResolvedModel }));
+    const designLoader = vi.fn(async () => ({ DesignResolvedModel }));
+
+    engine.registerModelLoaders({
+      RuntimeResolvedModel: { loader: runtimeLoader },
+      DesignResolvedModel: { loader: designLoader },
+    });
+
+    await engine.resolveModelTree({
+      use: 'RuntimeResolvedModel',
+    });
+
+    const firstPreload = await engine.preloadModelLoaders();
+    const secondPreload = await engine.preloadModelLoaders();
+
+    expect(runtimeLoader).toHaveBeenCalledTimes(1);
+    expect(designLoader).toHaveBeenCalledTimes(1);
+    expect(firstPreload.loaded).toContain('DesignResolvedModel');
+    expect(firstPreload.loaded).not.toContain('RuntimeResolvedModel');
+    expect(secondPreload.loaded).toHaveLength(0);
+    expect(secondPreload.failed).toHaveLength(0);
+  });
+
+  it('picks up newly registered loaders after preload has already completed', async () => {
+    class FirstModel extends FlowModel {}
+    class SecondModel extends FlowModel {}
+
+    const firstLoader = vi.fn(async () => ({ FirstModel }));
+    const secondLoader = vi.fn(async () => ({ SecondModel }));
+
+    engine.registerModelLoaders({
+      FirstModel: { loader: firstLoader },
+    });
+
+    await engine.preloadModelLoaders();
+    expect(firstLoader).toHaveBeenCalledTimes(1);
+    expect(engine.getModelClass('FirstModel')).toBe(FirstModel);
+
+    engine.registerModelLoaders({
+      SecondModel: { loader: secondLoader },
+    });
+
+    const result = await engine.preloadModelLoaders();
+
+    expect(secondLoader).toHaveBeenCalledTimes(1);
+    expect(result.loaded).toContain('SecondModel');
+    expect(engine.getModelClass('SecondModel')).toBe(SecondModel);
+  });
+
+  it('degrades unresolved loader failures to ErrorFlowModel instead of crashing runtime creation', async () => {
+    class ParentModel extends FlowModel {}
+
+    const parentLoader = vi.fn(async () => ({ ParentModel }));
+    const invalidChildLoader = vi.fn(async () => ({ notAModel: {} }));
+
+    engine.registerModelLoaders({
+      ParentModel: { loader: parentLoader },
+      BrokenChildModel: { loader: invalidChildLoader as any },
+    });
+
+    const model = await engine.loadOrCreateModel({
+      uid: 'parent-with-broken-child',
+      use: 'ParentModel',
+      subModels: {
+        child: {
+          use: 'BrokenChildModel',
+        },
+      },
+    });
+
+    expect(model).toBeInstanceOf(ParentModel);
+    expect(model?.subModels.child).toBeInstanceOf(ErrorFlowModel);
+    expect(parentLoader).toHaveBeenCalledTimes(1);
+    expect(invalidChildLoader).toHaveBeenCalledTimes(1);
+  });
+});