@nocobase/flow-engine 2.0.0-alpha.7 → 2.0.0-alpha.71

package/lib/models/CollectionFieldModel.js

@@ -45,13 +45,17 @@ __export(CollectionFieldModel_exports, {
 });
 module.exports = __toCommonJS(CollectionFieldModel_exports);
 var import_antd = require("antd");
+var import_icons = require("@ant-design/icons");
+var import_lodash = __toESM(require("lodash"));
 var import_react = __toESM(require("react"));
 var import_react_i18next = require("react-i18next");
 var import_hooks = require("../hooks");
 var import_utils = require("../utils");
 var import_flowModel = require("./flowModel");
-function FieldPlaceholder() {
-  return /* @__PURE__ */ import_react.default.createElement(import_antd.Form.Item, null, /* @__PURE__ */ import_react.default.createElement(
+var import_FormItem = require("../components/FormItem");
+function FieldPlaceholder({ title }) {
+  const { t } = (0, import_react_i18next.useTranslation)();
+  return /* @__PURE__ */ import_react.default.createElement(import_FormItem.FormItem, { label: title, showLabel: true }, /* @__PURE__ */ import_react.default.createElement(
     import_antd.Card,
     {
       size: "small",
@@ -61,19 +65,22 @@ function FieldPlaceholder() {
         }
       }
     },
-    "\u8BE5\u5B57\u6BB5\u5DF2\u88AB\u9690\u85CF\uFF0C\u4F60\u65E0\u6CD5\u67E5\u770B\uFF08\u8BE5\u5185\u5BB9\u4EC5\u5728\u6FC0\u6D3B UI Editor \u65F6\u663E\u793A\uFF09\u3002"
+    t(
+      "This field has been hidden and you cannot view it (this content is only visible when the UI Editor is activated)."
+    )
   ));
 }
 __name(FieldPlaceholder, "FieldPlaceholder");
 function FieldDeletePlaceholder() {
+  var _a;
   const { t } = (0, import_react_i18next.useTranslation)();
   const model = (0, import_hooks.useFlowModel)();
   const blockModel = model.context.blockModel;
-  const dataSource = blockModel.collection.dataSource;
+  const dataSource = (_a = blockModel.collection) == null ? void 0 : _a.dataSource;
   const collection = blockModel.collection;
   const name = model.fieldPath;
   const nameValue = (0, import_react.useMemo)(() => {
-    const dataSourcePrefix = `${t(dataSource.displayName || dataSource.key)} > `;
+    const dataSourcePrefix = dataSource ? `${t(dataSource.displayName || dataSource.key)} > ` : "";
     const collectionPrefix = collection ? `${t(collection.title) || collection.name || collection.tableName} > ` : "";
     return `${dataSourcePrefix}${collectionPrefix}${name}`;
   }, []);
@@ -92,14 +99,39 @@ function FieldDeletePlaceholder() {
   ));
 }
 __name(FieldDeletePlaceholder, "FieldDeletePlaceholder");
+function FieldWithoutPermissionPlaceholder() {
+  var _a, _b;
+  const { t } = (0, import_react_i18next.useTranslation)();
+  const model = (0, import_hooks.useFlowModel)();
+  const blockModel = model.context.blockModel;
+  const collection = ((_a = model.context.collectionField) == null ? void 0 : _a.collection) || blockModel.collection;
+  const dataSource = collection.dataSource;
+  const name = ((_b = model.context.collectionField) == null ? void 0 : _b.name) || model.fieldPath;
+  const nameValue = (0, import_react.useMemo)(() => {
+    const dataSourcePrefix = `${t(dataSource.displayName || dataSource.key)} > `;
+    const collectionPrefix = collection ? `${t(collection.title) || collection.name || collection.tableName} > ` : "";
+    return `${dataSourcePrefix}${collectionPrefix}${name}`;
+  }, []);
+  const { actionName } = model.forbidden;
+  const messageValue = (0, import_react.useMemo)(() => {
+    return t(
+      `The current user only has the UI configuration permission, but don't have "{{actionName}}" permission for field "{{name}}"`,
+      {
+        name: nameValue,
+        actionName: t(import_lodash.default.capitalize(actionName))
+      }
+    ).replaceAll(">", ">");
+  }, [nameValue, t]);
+  return /* @__PURE__ */ import_react.default.createElement(import_antd.Tooltip, { title: messageValue }, /* @__PURE__ */ import_react.default.createElement(import_FormItem.FormItem, { showLabel: true, label: model.context.collectionField.title || name, style: { opacity: "0.4" } }, /* @__PURE__ */ import_react.default.createElement(import_icons.LockOutlined, null)));
+}
+__name(FieldWithoutPermissionPlaceholder, "FieldWithoutPermissionPlaceholder");
 const defaultWhen = /* @__PURE__ */ __name(() => true, "defaultWhen");
 const _CollectionFieldModel = class _CollectionFieldModel extends import_flowModel.FlowModel {
-  fieldDeleted = false;
   renderHiddenInConfig() {
-    if (this.fieldDeleted) {
-      return /* @__PURE__ */ import_react.default.createElement(FieldDeletePlaceholder, null);
+    if (this.forbidden) {
+      return /* @__PURE__ */ import_react.default.createElement(FieldWithoutPermissionPlaceholder, null);
     }
-    return /* @__PURE__ */ import_react.default.createElement(FieldPlaceholder, null);
+    return /* @__PURE__ */ import_react.default.createElement(import_antd.Tooltip, { title: this.context.t("The field is hidden and only visible when the UI Editor is active") }, /* @__PURE__ */ import_react.default.createElement("div", { style: { opacity: 0.3 } }, this.renderOriginal.call(this)));
   }
   get title() {
     return void 0;
@@ -120,11 +152,13 @@ const _CollectionFieldModel = class _CollectionFieldModel extends import_flowMod
         return this.fieldPath;
       }, "get")
     });
-    this.context.blockModel.addAppends(this.fieldPath);
-    this.context.blockModel.addAppends(this.associationPathName);
+    if (this.context.blockModel) {
+      this.context.blockModel.addAppends(this.fieldPath);
+      this.context.blockModel.addAppends(this.associationPathName);
+    }
   }
   getFieldSettingsInitParams() {
-    return this.getStepParams("fieldSettings", "init");
+    return this.getStepParams("fieldSettings", "init") || {};
   }
   get fieldPath() {
     return this.getFieldSettingsInitParams().fieldPath;
@@ -148,7 +182,7 @@ const _CollectionFieldModel = class _CollectionFieldModel extends import_flowMod
     if (!this.bindings.has(interfaceName)) {
       return [];
     }
-    const bindings = this.bindings.get(interfaceName);
+    const bindings = this.bindings.get(interfaceName).sort((a, b) => a.order - b.order);
     return bindings.filter(
       (binding) => ctx.engine.getModelClass(binding.modelName) && binding.when(ctx, collectionField)
     );
@@ -157,8 +191,11 @@ const _CollectionFieldModel = class _CollectionFieldModel extends import_flowMod
     if (options.fallbackToTargetTitleField) {
       const binding = this.getDefaultBindingByField(ctx, collectionField, { useStrict: true });
       if (!binding) {
-        if (collectionField.isAssociationField() && collectionField.targetCollectionTitleField) {
-          return this.getDefaultBindingByField(ctx, collectionField.targetCollectionTitleField);
+        if (collectionField.isAssociationField() && (options == null ? void 0 : options.targetCollectionTitleField) || collectionField.targetCollectionTitleField) {
+          return this.getDefaultBindingByField(
+            ctx,
+            (options == null ? void 0 : options.targetCollectionTitleField) || collectionField.targetCollectionTitleField
+          );
         }
       }
       return binding;
@@ -208,7 +245,8 @@ const _CollectionFieldModel = class _CollectionFieldModel extends import_flowMod
       modelName,
       isDefault: options.isDefault || false,
       defaultProps: options.defaultProps || null,
-      when: options.when || defaultWhen
+      when: options.when || defaultWhen,
+      order: options.order
     });
     this.currentBindings.set(interfaceName, bindings);
   }
@@ -248,6 +286,15 @@ const _CollectionFieldModel = class _CollectionFieldModel extends import_flowMod
     }
     return allBindings;
   }
+  renderItem() {
+    return null;
+  }
+  render() {
+    if (!this.collectionField) {
+      return /* @__PURE__ */ import_react.default.createElement(FieldDeletePlaceholder, null);
+    }
+    return this.renderItem();
+  }
 };
 __name(_CollectionFieldModel, "CollectionFieldModel");
 __publicField(_CollectionFieldModel, "_bindings", /* @__PURE__ */ new Map());

package/lib/models/flowModel.d.ts

@@ -11,15 +11,37 @@ import { Emitter } from '../emitter';
 import { InstanceFlowRegistry } from '../flow-registry/InstanceFlowRegistry';
 import { FlowContext, FlowModelContext, FlowRuntimeContext } from '../flowContext';
 import { FlowEngine } from '../flowEngine';
-import type { ActionDefinition, ArrayElementType, CreateModelOptions, CreateSubModelOptions, DefaultStructure, FlowDefinitionOptions, FlowModelMeta, FlowModelOptions, ModelConstructor, ParamObject, ParentFlowModel, PersistOptions, StepParams } from '../types';
+import type { ActionDefinition, ArrayElementType, CreateModelOptions, CreateSubModelOptions, DefaultStructure, FlowDefinitionOptions, FlowModelMeta, FlowModelOptions, ModelConstructor, ParamObject, ParentFlowModel, PersistOptions, ResolveUseResult, StepParams } from '../types';
 import { IModelComponentProps, ReadonlyModelProps } from '../types';
 import { ModelActionRegistry } from '../action-registry/ModelActionRegistry';
 import { ModelEventRegistry } from '../event-registry/ModelEventRegistry';
 import { GlobalFlowRegistry } from '../flow-registry/GlobalFlowRegistry';
 import { FlowDefinition } from '../FlowDefinition';
 import { FlowSettingsOpenOptions } from '../flowSettings';
-import type { EventDefinition } from '../types';
+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'> & {
+    key: React.Key;
+    group?: string;
+    sort?: number;
+    onClick?: () => void;
+};
+type FlowModelExtraMenuItemInput = Omit<FlowModelExtraMenuItem, 'key'> & {
+    key?: React.Key;
+};
+type ExtraMenuItemEntry = {
+    group?: string;
+    sort?: number;
+    matcher?: (model: FlowModel) => boolean;
+    keyPrefix?: string;
+    items: FlowModelExtraMenuItemInput[] | ((model: FlowModel, t: (k: string, opt?: any) => string) => FlowModelExtraMenuItemInput[] | Promise<FlowModelExtraMenuItemInput[]>);
+};
 export declare enum ModelRenderMode {
     ReactElement = "reactElement",
     RenderFunction = "renderFunction"
@@ -27,7 +49,7 @@ export declare enum ModelRenderMode {
 export declare class FlowModel<Structure extends DefaultStructure = DefaultStructure> {
     #private;
     /**
-     * 当 flowSettings.enabled 且 model.hidden 为 true 时用于渲染设置态组件（实例方法，子类可覆盖）。
+     * 当 flowSettingsEnabled 且 model.hidden 为 true 时用于渲染设置态组件（实例方法，子类可覆盖）。
      * 基类默认仅返回一个透明度降低的占位元素
      */
     protected renderHiddenInConfig(): React.ReactNode | undefined;
@@ -41,7 +63,10 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     subModels: Structure['subModels'];
     private _options;
     protected _title: string;
+    protected _extraTitle: string;
     isNew: boolean;
+    skeleton: any;
+    forbidden: any;
     /**
      * 所有 fork 实例的引用集合。
      * 使用 Set 便于在销毁时主动遍历并调用 dispose，避免悬挂引用。
@@ -53,7 +78,7 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
      */
     private forkCache;
     /**
-     * 上一次 applyAutoFlows 的执行参数
+     * 上一次 beforeRender 的执行参数
      */
     private _lastAutoRunParams;
     protected observerDispose: () => void;
@@ -61,6 +86,7 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
      * 原始 render 方法的引用
      */
     private _originalRender;
+    protected renderOriginal(): React.ReactNode;
     /**
      * 缓存的响应式包装器组件（每个实例一个）
      */
@@ -90,10 +116,16 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     get subType(): "object" | "array";
     get reactView(): import("../ReactView").ReactView;
     get parentId(): string;
+    scheduleModelOperation(toUid: string, fn: (model: FlowModel) => Promise<void> | void, options?: ScheduleOptions): import("../scheduler/ModelOperationScheduler").ScheduledCancel;
     static get meta(): FlowModelMeta;
     static get globalFlowRegistry(): GlobalFlowRegistry;
     protected static get actionRegistry(): ModelActionRegistry;
     protected static get eventRegistry(): ModelEventRegistry;
+    /**
+     * 动态解析实际要实例化的模型类；可在子类中覆盖。
+     * 返回注册名或构造器，支持在 FlowEngine 中继续沿链解析。
+     */
+    static resolveUse?(options: CreateModelOptions, engine: FlowEngine, parent?: FlowModel): ResolveUseResult | void;
     /**
      * 注册仅当前 FlowModel 类及其子类可用的 Action。
      * 该注册是类级别的，不会影响全局（FlowEngine）的 Action 注册。
@@ -112,12 +144,18 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
      * 批量注册仅当前 FlowModel 类及其子类可用的 Events。
      */
     static registerEvents<TModel extends FlowModel = FlowModel>(events: Record<string, EventDefinition<TModel>>): void;
-    static buildChildrenFromModels(ctx: any, Models: Array<any>): import("..").SubModelItem[];
+    static buildChildrenFromModels(ctx: any, Models: Array<any>): Promise<import("..").SubModelItem[]>;
     get title(): any;
+    get extraTitle(): any;
     setTitle(value: string): void;
+    setExtraTitle(value: string): void;
     setHidden(value: boolean): void;
     _createSubModels(subModels: Record<string, CreateSubModelOptions | CreateSubModelOptions[]>): void;
-    invalidateAutoFlowCache(deep?: boolean): void;
+    /**
+     * 失效指定事件的流程缓存；未指定 eventName 时，失效当前模型全部事件缓存。
+     * - 默认 beforeRender 与其它事件共享同一缓存体系：prefix=`event:${scope}`，flowKey=`eventName`，uid=`model.uid`
+     */
+    invalidateFlowCache(eventName?: string, deep?: boolean): void;
     /**
      * 设置FlowEngine实例
      * @param {FlowEngine} flowEngine FlowEngine实例
@@ -187,45 +225,36 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     private _dispatchEvent;
     private _dispatchEventWithDebounce;
     dispatchEvent(eventName: string, inputArgs?: Record<string, any>, options?: {
-        /**
-         * 是否要开启防抖功能
-         */
-        debounce: boolean;
-    }): Promise<void>;
+        /** 是否要开启防抖功能 */
+        debounce?: boolean;
+    } & DispatchEventOptions): Promise<any[]>;
     /**
-     * 获取所有自动应用流程定义（保持 getFlows 的顺序，即按 sort 排序）
-     * @returns {FlowDefinition[]} 自动应用流程定义数组（已按 sort 排序）
+     * 按事件名获取对应的流程集合（保持 getFlows 的顺序，即按 sort 排序）。
+     * - beforeRender 兼容：除显式 on: 'beforeRender' 外，包含未声明 on 且 manual !== true 的流程。
      */
-    getAutoFlows(): FlowDefinition[];
+    getEventFlows(eventName: string): FlowDefinition[];
     /**
-     * 重新执行上一次的 applyAutoFlows，保持参数一致
+     * 重新执行上一次的 beforeRender，保持参数一致
      * 如果之前没有执行过，则直接跳过
      * 使用 lodash debounce 避免频繁调用
      */
     private _rerunLastAutoRun;
     /**
-     * 自动流程执行前钩子。
-     * 子类可覆盖；可抛出 FlowExitException 提前终止。
+     * 通用事件分发钩子：开始
+     * 子类可覆盖；beforeRender 事件可通过抛出 FlowExitException 提前终止。
      */
-    onBeforeAutoFlows(inputArgs?: Record<string, any>): Promise<void>;
+    onDispatchEventStart(eventName: string, options?: DispatchEventOptions, inputArgs?: Record<string, any>): Promise<void>;
     /**
-     * 自动流程执行后钩子。
+     * 通用事件分发钩子：结束
      * 子类可覆盖。
      */
-    onAfterAutoFlows(results: any[], inputArgs?: Record<string, any>): Promise<void>;
+    onDispatchEventEnd(eventName: string, options?: DispatchEventOptions, inputArgs?: Record<string, any>, results?: any[]): Promise<void>;
     /**
-     * 自动流程错误钩子。
+     * 通用事件分发钩子：错误
      * 子类可覆盖。
      */
-    onAutoFlowsError(error: Error, inputArgs?: Record<string, any>): Promise<void>;
+    onDispatchEventError(eventName: string, options?: DispatchEventOptions, inputArgs?: Record<string, any>, error?: Error): Promise<void>;
     useHooksBeforeRender(): void;
-    /**
-     * 执行所有自动应用流程
-     * @param {Record<string, any>} [inputArgs] 可选的运行时参数
-     * @param {boolean} [useCache=true] 是否使用缓存机制，默认为 true
-     * @returns {Promise<any[]>} 所有自动应用流程的执行结果数组
-     */
-    applyAutoFlows(inputArgs?: Record<string, any>, useCache?: boolean): Promise<any[]>;
     /**
      * 智能检测是否应该跳过响应式包装
      * 说明：
@@ -261,9 +290,9 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     render(): any;
     rerender(): Promise<void>;
     /**
-     * 自动流程缓存的作用域标识；fork 实例可覆盖以区分缓存。
+     * 事件缓存的作用域标识；可按事件区分（默认与事件无关的 scope 返回 'default'）。
      */
-    getAutoFlowCacheScope(): string;
+    getFlowCacheScope(eventName: string): string;
     setParent(parent: FlowModel): void;
     removeParentDelegate(): void;
     addSubModel<T extends FlowModel>(subKey: string, options: CreateModelOptions | T): T;
@@ -273,7 +302,10 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     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;
     createRootModel(options: any): FlowModel<DefaultStructure>;
-    applySubModelsAutoFlows<K extends keyof Structure['subModels']>(subKey: K, inputArgs?: Record<string, any>, shared?: Record<string, any>): Promise<void>;
+    /**
+     * 对指定子模型派发 beforeRender 事件（顺序执行并使用缓存）。
+     */
+    applySubModelsBeforeRenderFlows<K extends keyof Structure['subModels']>(subKey: K, inputArgs?: Record<string, any>, shared?: Record<string, any>): Promise<void>;
     /**
      * 创建一个 fork 实例，实现"一份数据（master）多视图（fork）"的能力。
      * @param {IModelComponentProps} [localProps={}] fork 专属的局部 props，优先级高于 master.props
@@ -329,12 +361,23 @@ export declare class FlowModel<Structure extends DefaultStructure = DefaultStruc
     }): Promise<void>;
     get translate(): any;
     serialize(): Record<string, any>;
+    /**
+     * 复制当前模型实例为一个新的实例。
+     * 新实例及其所有子模型都会有新的 uid，且不保留 root model 的 parent 关系。
+     * 内部所有引用旧 uid 的地方（如 parentId, parentUid 等）都会被替换为对应的新 uid。
+     * @returns {FlowModel} 复制后的新模型实例
+     */
+    clone<T extends FlowModel = this>(): T;
     /**
      * Opens the flow settings dialog for this flow model.
      * @param options - Configuration options for opening flow settings, excluding the model property
      * @returns A promise that resolves when the flow settings dialog is opened
      */
     openFlowSettings(options?: Omit<FlowSettingsOpenOptions, 'model'>): Promise<boolean>;
+    /** 注册设置菜单的额外项（静态，按类缓存，可继承合并） */
+    static registerExtraMenuItems(opts: ExtraMenuItemEntry | ((model: FlowModel, t: (k: string, opt?: any) => string) => FlowModelExtraMenuItemInput[] | Promise<FlowModelExtraMenuItemInput[]>)): () => void;
+    static getExtraMenuItems(model: FlowModel, t: (k: string, opt?: any) => string): Promise<FlowModelExtraMenuItem[]>;
+    refresh(): Promise<void>;
 }
 export declare class ErrorFlowModel extends FlowModel {
     errorMessage: string;
@@ -342,3 +385,4 @@ export declare class ErrorFlowModel extends FlowModel {
     render(): React.JSX.Element;
 }
 export declare function defineFlow<TModel extends FlowModel = FlowModel>(definition: FlowDefinitionOptions): FlowDefinitionOptions<TModel>;
+export {};