@logicflow/engine 0.0.10 → 0.0.11-beta.0

package/es/index.d.ts

@@ -1,157 +1,60 @@
-import { BaseNode, StartNode, TaskNode } from './nodes';
-import { FlowModel } from './FlowModel';
-import { Recorder } from './recorder';
-export declare class Engine {
-    readonly instanceId: string;
-    graphData?: Engine.GraphConfigData;
-    flowModel?: FlowModel;
+import type { ResumeParams, GraphConfigData, EngineConstructorOptions, NextActionParam } from './types.d';
+import FlowModel, { ActionParams } from './FlowModel';
+import StartNode from './nodes/StartNode';
+import TaskNode from './nodes/TaskNode';
+import Recorder from './recorder';
+import { NodeConstructor } from './nodes/BaseNode';
+export default class Engine {
+    instanceId: string;
+    global: Record<string, any>;
+    graphData: GraphConfigData;
+    nodeModelMap: Map<string, NodeConstructor>;
+    flowModel: FlowModel;
     recorder?: Recorder;
-    context?: Record<string, unknown>;
-    nodeModelMap: Map<string, BaseNode.NodeConstructor>;
-    constructor(options?: Engine.Options);
+    context: Record<string, any>;
+    constructor(options?: EngineConstructorOptions);
     /**
      * 注册节点
      * @param nodeConfig { type: 'custom-node', model: NodeClass }
      */
-    register(nodeConfig: Engine.NodeConfig): void;
+    register(nodeConfig: any): void;
     /**
-     * 自定义执行记录的存储，默认浏览器使用 sessionStorage, nodejs 使用内存存储
-     * 注意：由于执行记录不全会主动删除，所以需要自行清理。
-     * nodejs 环境建议自定义为持久化存储。
-     * engine.setCustomRecorder({{
+     * 自定义执行记录的存储，默认浏览器使用 sessionStorage，nodejs 使用内存存储。
+     * 注意：由于执行记录不会主动删除，所以需要自行清理。
+     * nodejs环境建议自定义为持久化存储。
+     * engine.setCustomRecorder({
      *   async addActionRecord(task) {}
      *   async getTask(actionId) {}
      *   async getExecutionTasks(executionId) {}
      *   clear(instanceId) {}
-     * }}
-     * @param recorder
+     * });
      */
     setCustomRecorder(recorder: Recorder): void;
     /**
      * 加载流程图数据
      */
-    load({ graphData, startNodeType, globalData, }: Engine.LoadGraphParam): FlowModel;
+    load({ graphData, startNodeType, globalData, }: {
+        graphData: any;
+        startNodeType?: string;
+        globalData?: {};
+    }): FlowModel;
     /**
-     * 执行流程，允许多次调用
+     * 执行流程，允许多次调用。
      */
-    execute(param?: Partial<Engine.ActionParam>): Promise<Engine.NextActionParam>;
+    execute(execParam?: ActionParams): Promise<NextActionParam>;
     /**
-     * 中断流程恢复
-     * @param resumeParam
-     * @returns
+     * 恢复执行
+     * 注意此方法只能恢复节点后面的执行，不能恢复流程其他分支的执行。
+     * 同理，中断执行也只能中断节点后面的执行，不会中断其他分支的执行。
+     * 在实际项目中，如果存在中断节点，建议流程所有的节点都是排他网关，这样可以保证执行的过程不存在分支。
      */
-    resume(resumeParam: Engine.ResumeParam): Promise<Engine.NextActionParam | undefined>;
+    resume(resumeParam: ResumeParams): Promise<unknown>;
     getExecutionList(): Promise<any>;
-    /**
-     * 获取执行任务记录
-     * @param executionId
-     * @returns
-     */
-    getExecutionRecord(executionId: Engine.Key): Promise<Recorder.Info[] | null>;
+    getExecutionRecord(executionId: any): Promise<any[]>;
     destroy(): void;
-    getGlobalData(): Record<string, unknown> | undefined;
-    setGlobalData(data: Record<string, unknown>): void;
-    updateGlobalData(data: Record<string, unknown>): void;
-}
-export declare namespace Engine {
-    type Point = {
-        id?: string;
-        x: number;
-        y: number;
-        [key: string]: unknown;
-    };
-    type TextConfig = {
-        value: string;
-    } & Point;
-    type NodeData = {
-        id: string;
-        type: string;
-        x?: number;
-        y?: number;
-        text?: TextConfig | string;
-        zIndex?: number;
-        properties?: Record<string, unknown>;
-    };
-    type EdgeData = {
-        id: string;
-        /**
-         * 边的类型，不传默认为lf.setDefaultEdgeType(type)传入的类型。
-         * LogicFlow内部默认为polyline
-         */
-        type?: string;
-        sourceNodeId: string;
-        sourceAnchorId?: string;
-        targetNodeId: string;
-        targetAnchorId?: string;
-        startPoint?: {
-            x: number;
-            y: number;
-        };
-        endPoint?: {
-            x: number;
-            y: number;
-        };
-        text?: {
-            x: number;
-            y: number;
-            value: string;
-        } | string;
-        pointsList?: Point[];
-        zIndex?: number;
-        properties?: Record<string, unknown>;
-    };
-    type GraphConfigData = {
-        nodes: NodeData[];
-        edges: EdgeData[];
-    };
-    type LoadGraphParam = {
-        graphData: GraphConfigData;
-        startNodeType?: string;
-        globalData?: Record<string, unknown>;
-    };
-    type Options = {
-        context?: Record<string, unknown>;
-        debug?: boolean;
-    };
-    type Key = string | number;
-    type NodeConfig = {
-        type: string;
-        model: any;
-    };
-    type NodeParam = {
-        executionId: Key;
-        nodeId: Key;
-    };
-    type CommonActionInfo = {
-        actionId: Key;
-    } & NodeParam;
-    type ActionParam = CommonActionInfo;
-    type ResumeParam = {
-        data?: Record<string, unknown>;
-    } & CommonActionInfo;
-    type ExecParam = {
-        next: (data: NextActionParam) => void;
-    } & ActionParam;
-    type ExecResumeParam = {
-        next: (data: NextActionParam) => void;
-    } & ResumeParam;
-    type ActionStatus = 'success' | 'error' | 'interrupted' | '';
-    type NextActionParam = {
-        executionId: Key;
-        nodeId: Key;
-        actionId: Key;
-        nodeType: string;
-        outgoing: BaseNode.OutgoingConfig[];
-        properties?: Record<string, unknown>;
-        detail?: Record<string, unknown>;
-        status?: ActionStatus;
-    };
-    type ActionResult = NextActionParam;
-    type NodeExecResult = {
-        nodeType: string;
-        properties?: Record<string, unknown>;
-    } & CommonActionInfo & ActionResult;
+    getGlobalData(): Record<string, any>;
+    setGlobalData(data: any): void;
+    updateGlobalData(data: any): void;
 }
-export * from './constant';
-export { BaseNode, StartNode, TaskNode, Recorder };
-export default Engine;
+export { Engine, TaskNode, StartNode, Recorder, };
+export type { ActionParams, };

package/es/index.js

@@ -1,11 +1,57 @@
-import { __awaiter } from "tslib";
-// import { LogicFlow } from '@logicflow/core';
-import { BaseNode, StartNode, TaskNode } from './nodes';
-import { FlowModel } from './FlowModel';
-import { Recorder } from './recorder';
-import { createEngineId } from './utils';
-export class Engine {
-    constructor(options) {
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import FlowModel from './FlowModel';
+import StartNode from './nodes/StartNode';
+import TaskNode from './nodes/TaskNode';
+import Recorder from './recorder';
+import { createEngineId } from './util/ID';
+var Engine = /** @class */ (function () {
+    function Engine(options) {
         this.nodeModelMap = new Map();
         this.instanceId = createEngineId();
         if (options === null || options === void 0 ? void 0 : options.debug) {
@@ -13,7 +59,6 @@ export class Engine {
                 instanceId: this.instanceId,
             });
         }
-        // 默认注册节点 register default nodes
         this.register({
             type: StartNode.nodeTypeName,
             model: StartNode,
@@ -28,125 +73,132 @@ export class Engine {
      * 注册节点
      * @param nodeConfig { type: 'custom-node', model: NodeClass }
      */
-    register(nodeConfig) {
+    Engine.prototype.register = function (nodeConfig) {
         this.nodeModelMap.set(nodeConfig.type, nodeConfig.model);
-    }
+    };
     /**
-     * 自定义执行记录的存储，默认浏览器使用 sessionStorage, nodejs 使用内存存储
-     * 注意：由于执行记录不全会主动删除，所以需要自行清理。
-     * nodejs 环境建议自定义为持久化存储。
-     * engine.setCustomRecorder({{
+     * 自定义执行记录的存储，默认浏览器使用 sessionStorage，nodejs 使用内存存储。
+     * 注意：由于执行记录不会主动删除，所以需要自行清理。
+     * nodejs环境建议自定义为持久化存储。
+     * engine.setCustomRecorder({
      *   async addActionRecord(task) {}
      *   async getTask(actionId) {}
      *   async getExecutionTasks(executionId) {}
      *   clear(instanceId) {}
-     * }}
-     * @param recorder
+     * });
      */
-    setCustomRecorder(recorder) {
+    Engine.prototype.setCustomRecorder = function (recorder) {
         this.recorder = recorder;
-    }
+    };
     /**
      * 加载流程图数据
      */
-    load({ graphData, startNodeType = 'StartNode', globalData = {}, }) {
-        this.graphData = graphData;
-        const flowModel = new FlowModel({
+    Engine.prototype.load = function (_a) {
+        var graphData = _a.graphData, _b = _a.startNodeType, startNodeType = _b === void 0 ? 'StartNode' : _b, _c = _a.globalData, globalData = _c === void 0 ? {} : _c;
+        this.flowModel = new FlowModel({
             nodeModelMap: this.nodeModelMap,
             recorder: this.recorder,
             context: this.context,
-            globalData,
-            startNodeType,
+            globalData: globalData,
+            startNodeType: startNodeType,
         });
-        flowModel.load(graphData);
-        this.flowModel = flowModel;
-        return flowModel;
-    }
+        this.flowModel.load(graphData);
+        return this.flowModel;
+    };
     /**
-     * 执行流程，允许多次调用
+     * 执行流程，允许多次调用。
      */
-    execute(param) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                var _a;
-                let execParam = param;
-                if (!param) {
-                    execParam = {};
-                }
-                (_a = this.flowModel) === null || _a === void 0 ? void 0 : _a.execute(Object.assign(Object.assign({}, execParam), { callback: (result) => {
-                        resolve(result);
-                    }, onError: (error) => {
-                        reject(error);
-                    } }));
+    Engine.prototype.execute = function (execParam) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        if (!execParam) {
+                            execParam = {};
+                        }
+                        _this.flowModel.execute(__assign(__assign({}, execParam), { callback: function (result) {
+                                resolve(result);
+                            }, onError: function (error) {
+                                reject(error);
+                            } }));
+                    })];
             });
         });
-    }
+    };
     /**
-     * 中断流程恢复
-     * @param resumeParam
-     * @returns
+     * 恢复执行
+     * 注意此方法只能恢复节点后面的执行，不能恢复流程其他分支的执行。
+     * 同理，中断执行也只能中断节点后面的执行，不会中断其他分支的执行。
+     * 在实际项目中，如果存在中断节点，建议流程所有的节点都是排他网关，这样可以保证执行的过程不存在分支。
      */
-    resume(resumeParam) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                var _a;
-                (_a = this.flowModel) === null || _a === void 0 ? void 0 : _a.resume(Object.assign(Object.assign({}, resumeParam), { callback: (result) => {
-                        resolve(result);
-                    }, onError: (error) => {
-                        reject(error);
-                    } }));
+    Engine.prototype.resume = function (resumeParam) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        _this.flowModel.resume(__assign(__assign({}, resumeParam), { callback: function (result) {
+                                resolve(result);
+                            }, onError: function (error) {
+                                reject(error);
+                            } }));
+                    })];
             });
         });
-    }
-    getExecutionList() {
+    };
+    Engine.prototype.getExecutionList = function () {
         var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield ((_a = this.recorder) === null || _a === void 0 ? void 0 : _a.getExecutionList());
+        return __awaiter(this, void 0, void 0, function () {
+            var executionIds;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, ((_a = this.recorder) === null || _a === void 0 ? void 0 : _a.getExecutionList())];
+                    case 1:
+                        executionIds = _b.sent();
+                        return [2 /*return*/, executionIds];
+                }
+            });
         });
-    }
-    /**
-     * 获取执行任务记录
-     * @param executionId
-     * @returns
-     */
-    getExecutionRecord(executionId) {
+    };
+    Engine.prototype.getExecutionRecord = function (executionId) {
         var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const actions = yield ((_a = this.recorder) === null || _a === void 0 ? void 0 : _a.getExecutionActions(executionId));
-            if (!actions) {
-                return null;
-            }
-            // DONE: 确认 records 的类型
-            const records = [];
-            for (let i = 0; i < (actions === null || actions === void 0 ? void 0 : actions.length); i++) {
-                const action = actions[i];
-                if (this.recorder) {
-                    records.push((_b = this.recorder) === null || _b === void 0 ? void 0 : _b.getActionRecord(action));
+        return __awaiter(this, void 0, void 0, function () {
+            var tasks, records, i;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, ((_a = this.recorder) === null || _a === void 0 ? void 0 : _a.getExecutionActions(executionId))];
+                    case 1:
+                        tasks = _c.sent();
+                        if (!tasks) {
+                            return [2 /*return*/, null];
+                        }
+                        records = [];
+                        for (i = 0; i < tasks.length; i++) {
+                            records.push((_b = this.recorder) === null || _b === void 0 ? void 0 : _b.getActionRecord(tasks[i]));
+                        }
+                        return [2 /*return*/, Promise.all(records)];
                 }
-            }
-            return Promise.all(records);
+            });
         });
-    }
-    destroy() {
+    };
+    Engine.prototype.destroy = function () {
         var _a;
         (_a = this.recorder) === null || _a === void 0 ? void 0 : _a.clear();
-    }
-    getGlobalData() {
+    };
+    Engine.prototype.getGlobalData = function () {
         var _a;
         return (_a = this.flowModel) === null || _a === void 0 ? void 0 : _a.globalData;
-    }
-    setGlobalData(data) {
+    };
+    Engine.prototype.setGlobalData = function (data) {
         if (this.flowModel) {
             this.flowModel.globalData = data;
         }
-    }
-    updateGlobalData(data) {
+    };
+    Engine.prototype.updateGlobalData = function (data) {
         if (this.flowModel) {
             Object.assign(this.flowModel.globalData, data);
         }
-    }
-}
-export * from './constant';
-export { BaseNode, StartNode, TaskNode, Recorder };
+    };
+    return Engine;
+}());
 export default Engine;
-//# sourceMappingURL=index.js.map
+export { Engine, TaskNode, StartNode, Recorder, };

package/es/nodes/BaseNode.d.ts

@@ -0,0 +1,110 @@
+import type { NextActionParam, ActionResult, ExecResumeParams, ExecParams, OutgoingConfig } from '../types.d';
+export interface BaseNodeInterface {
+    outgoing: Record<string, any>[];
+    incoming: Record<string, any>[];
+    nodeId: string;
+    type: string;
+    readonly baseType: string;
+    execute(actionParam: any): Promise<NextActionParam>;
+}
+export declare type NodeConstructor = {
+    new (config: {
+        nodeConfig: NodeConfig;
+        context: Record<string, any>;
+        globalData: Record<string, any>;
+    }): BaseNode;
+    action(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+    }): Promise<NextActionParam>;
+    onResume(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+        data?: Record<string, any>;
+    }): Promise<void>;
+};
+export declare type IncomingConfig = {
+    id: string;
+    properties?: Record<string, any>;
+    source: string;
+};
+export declare type NodeConfig = {
+    id: string;
+    type: string;
+    properties?: Record<string, any>;
+    incoming: IncomingConfig[];
+    outgoing: OutgoingConfig[];
+};
+export default class BaseNode implements BaseNodeInterface {
+    static nodeTypeName: string;
+    /**
+     * 节点的出边
+     */
+    outgoing: OutgoingConfig[];
+    /**
+     * 节点的入边
+     */
+    incoming: IncomingConfig[];
+    /**
+     * 节点的属性
+     */
+    properties?: Record<string, any>;
+    nodeId: string;
+    type: string;
+    /**
+     * 节点的上下文，是调用流程时传入的上下文
+     */
+    context: Record<string, any>;
+    /**
+     * 节点的全局数据，是调用流程时传入的全局数据。
+     * 在计算表达式时，即基于全局数据进行计算。
+     */
+    globalData: Record<string, any>;
+    readonly baseType: string;
+    constructor({ nodeConfig, context, globalData }: {
+        nodeConfig: any;
+        context: any;
+        globalData: any;
+    });
+    /**
+     * 节点的每一次执行都会生成一个唯一的actionId
+     */
+    execute(params: ExecParams): Promise<NextActionParam>;
+    /**
+     * 节点在执行中断后，可以通过resume方法恢复执行。
+     * 自定义节点时不建议重写此方法
+     */
+    resume(params: ExecResumeParams): Promise<undefined>;
+    private getOutgoing;
+    private isPass;
+    /**
+     * 节点的执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.actionId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     * @returns 返回下一步的执行参数
+     * 当不返回时，表示此节点执行成功，流程会继续执行下一步。
+     * 当返回时，返回格式
+     */
+    action(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+    }): Promise<ActionResult>;
+    /**
+     * 节点的重新恢复执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.actionId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     */
+    onResume(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+        data?: Record<string, any>;
+    }): Promise<void>;
+}