@nocobase/flow-engine 2.0.0-alpha.4 → 2.0.0-alpha.41

package/lib/data-source/index.d.ts

@@ -49,7 +49,9 @@ export declare class DataSource {
     addCollection(collection: Collection | CollectionOptions): void;
     updateCollection(newOptions: CollectionOptions): void;
     upsertCollection(options: CollectionOptions): Collection;
-    upsertCollections(collections: CollectionOptions[]): void;
+    upsertCollections(collections: CollectionOptions[], options?: {
+        clearFields?: boolean;
+    }): void;
     removeCollection(name: string): void;
     clearCollections(): void;
     setOptions(newOptions?: any): void;
@@ -68,14 +70,19 @@ export declare class CollectionManager {
     get flowEngine(): FlowEngine;
     addCollection(collection: Collection | CollectionOptions): void;
     removeCollection(name: string): void;
-    updateCollection(newOptions: CollectionOptions): void;
+    updateCollection(newOptions: CollectionOptions, options?: {
+        clearFields?: boolean;
+    }): void;
     upsertCollection(options: CollectionOptions): Collection;
-    upsertCollections(collections: CollectionOptions[]): void;
+    upsertCollections(collections: CollectionOptions[], options?: {
+        clearFields?: boolean;
+    }): void;
     sortCollectionsByInherits(collections: CollectionOptions[]): CollectionOptions[];
     getCollection(name: string): Collection | undefined;
     getCollections(): Collection[];
     clearCollections(): void;
     getAssociation(associationName: string): CollectionField | undefined;
+    getChildrenCollections(name: any): any[];
 }
 export declare class Collection {
     fields: Map<string, CollectionField>;
@@ -84,6 +91,7 @@ export declare class Collection {
     dataSource: DataSource;
     constructor(options?: Record<string, any>);
     getFilterByTK(record: any): any;
+    get titleableFields(): CollectionField[];
     get hidden(): any;
     get flowEngine(): FlowEngine;
     get collectionManager(): CollectionManager;
@@ -97,7 +105,9 @@ export declare class Collection {
     get titleCollectionField(): CollectionField;
     initInherits(): void;
     setDataSource(dataSource: DataSource): void;
-    setOptions(newOptions?: any): void;
+    setOptions(newOptions?: any, options?: {
+        clearFields?: boolean;
+    }): void;
     getFields(): CollectionField[];
     getToOneAssociationFields(): CollectionField[];
     getAssociationFields(types?: any[]): CollectionField[];
@@ -140,6 +150,7 @@ export declare class CollectionField {
     get resourceName(): string;
     get collectionName(): any;
     get readonly(): any;
+    get titleable(): boolean;
     get fullpath(): string;
     get name(): any;
     get type(): any;

package/lib/data-source/index.js

@@ -49,6 +49,7 @@ module.exports = __toCommonJS(data_source_exports);
 var import_reactive = require("@formily/reactive");
 var import_lodash = __toESM(require("lodash"));
 var import_jioToJoiSchema = require("./jioToJoiSchema");
+var import_sortCollectionsByInherits = require("./sortCollectionsByInherits");
 const _DataSourceManager = class _DataSourceManager {
   dataSources;
   flowEngine;
@@ -152,8 +153,8 @@ const _DataSource = class _DataSource {
   upsertCollection(options) {
     return this.collectionManager.upsertCollection(options);
   }
-  upsertCollections(collections) {
-    return this.collectionManager.upsertCollections(collections);
+  upsertCollections(collections, options = {}) {
+    return this.collectionManager.upsertCollections(collections, options);
   }
   removeCollection(name) {
     return this.collectionManager.removeCollection(name);
@@ -204,12 +205,12 @@ const _CollectionManager = class _CollectionManager {
   removeCollection(name) {
     this.collections.delete(name);
   }
-  updateCollection(newOptions) {
+  updateCollection(newOptions, options = {}) {
     const collection = this.getCollection(newOptions.name);
     if (!collection) {
       throw new Error(`Collection ${newOptions.name} not found`);
     }
-    collection.setOptions(newOptions);
+    collection.setOptions(newOptions, options);
   }
   upsertCollection(options) {
     if (this.collections.has(options.name)) {
@@ -219,10 +220,10 @@ const _CollectionManager = class _CollectionManager {
     }
     return this.getCollection(options.name);
   }
-  upsertCollections(collections) {
-    for (const collection of this.sortCollectionsByInherits(collections)) {
+  upsertCollections(collections, options = {}) {
+    for (const collection of (0, import_sortCollectionsByInherits.sortCollectionsByInherits)(collections)) {
       if (this.collections.has(collection.name)) {
-        this.updateCollection(collection);
+        this.updateCollection(collection, options);
       } else {
         this.addCollection(collection);
       }
@@ -299,6 +300,23 @@ const _CollectionManager = class _CollectionManager {
     }
     return collection.getField(fieldName);
   }
+  getChildrenCollections(name) {
+    const childrens = [];
+    const collections = Array.from(this.collections.values());
+    const getChildrens = /* @__PURE__ */ __name((name2) => {
+      const inheritCollections = collections.filter((v) => {
+        var _a;
+        return (_a = v.options.inherits) == null ? void 0 : _a.includes(name2);
+      });
+      inheritCollections.forEach((v) => {
+        const collectionKey = v.name;
+        childrens.push(v);
+        return getChildrens(collectionKey);
+      });
+      return childrens;
+    }, "getChildrens");
+    return getChildrens(name);
+  }
 };
 __name(_CollectionManager, "CollectionManager");
 let CollectionManager = _CollectionManager;
@@ -328,6 +346,9 @@ const _Collection = class _Collection {
     }
     return import_lodash.default.pick(record, this.filterTargetKey);
   }
+  get titleableFields() {
+    return this.getFields().filter((field) => field.titleable);
+  }
   get hidden() {
     return this.options.hidden || false;
   }
@@ -368,7 +389,8 @@ const _Collection = class _Collection {
     for (const inherit of this.options.inherits || []) {
       const collection = this.collectionManager.getCollection(inherit);
       if (!collection) {
-        throw new Error(`Collection ${inherit} not found`);
+        console.warn(`Warning: Collection ${inherit} not found for collection ${this.name}`);
+        continue;
       }
       this.inherits.set(inherit, collection);
     }
@@ -376,10 +398,13 @@ const _Collection = class _Collection {
   setDataSource(dataSource) {
     this.dataSource = dataSource;
   }
-  setOptions(newOptions = {}) {
+  setOptions(newOptions = {}, options = {}) {
     Object.keys(this.options).forEach((key) => delete this.options[key]);
     Object.assign(this.options, newOptions);
     this.initInherits();
+    if (options.clearFields) {
+      this.clearFields();
+    }
     this.upsertFields(this.options.fields || []);
   }
   getFields() {
@@ -438,7 +463,7 @@ const _Collection = class _Collection {
     if (otherKeys.length === 0) {
       return field;
     }
-    if (!field.targetCollection) {
+    if (!(field == null ? void 0 : field.targetCollection)) {
       return null;
     }
     return field.targetCollection.getFieldByPath(otherKeys.join("."));
@@ -558,6 +583,9 @@ const _CollectionField = class _CollectionField {
     var _a;
     return this.options.readonly || ((_a = this.options.uiSchema) == null ? void 0 : _a["x-read-pretty"]) || false;
   }
+  get titleable() {
+    return !!(this.options.titleable ?? this.options.titleUsable);
+  }
   get fullpath() {
     return this.collection.dataSource.key + "." + this.collection.name + "." + this.name;
   }
@@ -584,7 +612,7 @@ const _CollectionField = class _CollectionField {
   }
   get title() {
     var _a, _b, _c;
-    const titleValue = ((_a = this.options) == null ? void 0 : _a.title) || ((_c = (_b = this.options) == null ? void 0 : _b.uiSchema) == null ? void 0 : _c.title) || this.options.name;
+    const titleValue = ((_b = (_a = this.options) == null ? void 0 : _a.uiSchema) == null ? void 0 : _b.title) || ((_c = this.options) == null ? void 0 : _c.title) || this.options.name;
     return this.flowEngine.translate(titleValue);
   }
   set title(value) {
@@ -618,7 +646,7 @@ const _CollectionField = class _CollectionField {
     return this.options.validation;
   }
   getComponentProps() {
-    var _a;
+    var _a, _b;
     const { type, target } = this.options;
     const componentProps = import_lodash.default.omitBy(
       {
@@ -627,7 +655,8 @@ const _CollectionField = class _CollectionField {
         mode: this.type === "array" ? "multiple" : void 0,
         multiple: target ? ["belongsToMany", "hasMany", "belongsToArray"].includes(type) : void 0,
         maxCount: target && !["belongsToMany", "hasMany", "belongsToArray"].includes(type) ? 1 : void 0,
-        target
+        target,
+        template: (_b = this.targetCollection) == null ? void 0 : _b.template
       },
       import_lodash.default.isUndefined
     );

package/lib/data-source/sortCollectionsByInherits.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { CollectionOptions } from '.';
+export declare function sortCollectionsByInherits(collections: CollectionOptions[]): CollectionOptions[];

package/lib/data-source/sortCollectionsByInherits.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 __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sortCollectionsByInherits_exports = {};
+__export(sortCollectionsByInherits_exports, {
+  sortCollectionsByInherits: () => sortCollectionsByInherits
+});
+module.exports = __toCommonJS(sortCollectionsByInherits_exports);
+function sortCollectionsByInherits(collections) {
+  const sorted = [];
+  const visited = /* @__PURE__ */ new Set();
+  const visiting = /* @__PURE__ */ new Set();
+  const map = /* @__PURE__ */ new Map();
+  collections.forEach((col) => {
+    map.set(col.name, col);
+  });
+  const addToSorted = /* @__PURE__ */ __name((col) => {
+    if (visiting.has(col.name)) {
+      throw new Error(`Circular dependency detected: ${col.name} inherits from itself through a chain`);
+    }
+    if (visited.has(col.name)) {
+      return;
+    }
+    visiting.add(col.name);
+    const inherits = col.inherits || [];
+    for (const inheritName of inherits) {
+      const inheritCol = map.get(inheritName);
+      if (!inheritCol) {
+        console.warn(`Warning: Collection ${inheritName}, inherited by ${col.name}, not found.`);
+        continue;
+      }
+      addToSorted(inheritCol);
+    }
+    visiting.delete(col.name);
+    visited.add(col.name);
+    sorted.push(col);
+  }, "addToSorted");
+  for (const col of collections) {
+    addToSorted(col);
+  }
+  return sorted;
+}
+__name(sortCollectionsByInherits, "sortCollectionsByInherits");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  sortCollectionsByInherits
+});

package/lib/emitter.d.ts

@@ -13,4 +13,10 @@ export declare class Emitter {
     on(event: string, callback: (...args: any[]) => void): void;
     off(event: string, callback: (...args: any[]) => void): void;
     emit(event: string, ...args: any[]): void;
+    /**
+     * 异步触发事件：按监听器注册顺序依次（串行）等待执行完成。
+     * - 若某个监听器抛错/Promise reject，将中断后续执行并将异常向上传递（便于调用方统一处理）。
+     * - 当前不提供并行触发能力；如需并发处理，请在监听器内部自行管理（例如在回调内使用 Promise.all）。
+     */
+    emitAsync(event: string, ...args: any[]): Promise<void>;
 }

package/lib/emitter.js

@@ -49,6 +49,18 @@ const _Emitter = class _Emitter {
     }
     (this.events[event] || []).forEach((fn) => fn(...args));
   }
+  /**
+   * 异步触发事件：按监听器注册顺序依次（串行）等待执行完成。
+   * - 若某个监听器抛错/Promise reject，将中断后续执行并将异常向上传递（便于调用方统一处理）。
+   * - 当前不提供并行触发能力；如需并发处理，请在监听器内部自行管理（例如在回调内使用 Promise.all）。
+   */
+  async emitAsync(event, ...args) {
+    if (this.paused) return;
+    const listeners = (this.events[event] || []).slice();
+    for (const fn of listeners) {
+      await fn(...args);
+    }
+  }
 };
 __name(_Emitter, "Emitter");
 let Emitter = _Emitter;

package/lib/executor/FlowExecutor.d.ts

@@ -8,19 +8,18 @@
  */
 import { FlowEngine } from '../flowEngine';
 import type { FlowModel } from '../models';
+import type { DispatchEventOptions } from '../types';
 export declare class FlowExecutor {
     private readonly engine;
     constructor(engine: FlowEngine);
+    /** Cache wrapper for applyFlow cache lifecycle */
+    private withApplyFlowCache;
     /**
      * Execute a single flow on model.
      */
     runFlow(model: FlowModel, flowKey: string, inputArgs?: Record<string, any>, runId?: string): Promise<any>;
-    /**
-     * Execute all auto-apply flows for model.
-     */
-    runAutoFlows(model: FlowModel, inputArgs?: Record<string, any>, useCache?: boolean): Promise<any[]>;
     /**
      * Dispatch an event to flows bound via flow.on and execute them.
      */
-    dispatchEvent(model: FlowModel, eventName: string, inputArgs?: Record<string, any>): Promise<void>;
+    dispatchEvent(model: FlowModel, eventName: string, inputArgs?: Record<string, any>, options?: DispatchEventOptions): Promise<any>;
 }