@logicflow/engine 0.0.1

package/es/index.js

@@ -0,0 +1,156 @@
+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';
+var Engine = /** @class */ (function () {
+    function Engine() {
+        this.nodeModelMap = new Map();
+        this.recorder = new Recorder();
+        // register node
+        this.register({
+            type: StartNode.nodeTypeName,
+            model: StartNode,
+        });
+        this.register({
+            type: TaskNode.nodeTypeName,
+            model: TaskNode,
+        });
+    }
+    /**
+     * 注册节点
+     * @param nodeConfig { type: 'custom-node', model: Class }
+     */
+    Engine.prototype.register = function (nodeConfig) {
+        this.nodeModelMap.set(nodeConfig.type, nodeConfig.model);
+    };
+    /**
+     * 自定义执行记录的存储，默认浏览器使用 sessionStorage，nodejs 使用内存存储。
+     * 注意：由于执行记录不会主动删除，所以需要自行清理。
+     * nodejs环境建议自定义为持久化存储。
+     * engine.setCustomRecorder({
+     *   async addTask(task) {}
+     *   async getTask(taskId) {}
+     *   async getExecutionTasks(executionId) {}
+     *   clear() {}
+     * });
+     */
+    Engine.prototype.setCustomRecorder = function (recorder) {
+        this.recorder = recorder;
+    };
+    /**
+     * 加载流程图数据
+     */
+    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, _d = _a.context, context = _d === void 0 ? {} : _d;
+        this.flowModel = new FlowModel({
+            nodeModelMap: this.nodeModelMap,
+            recorder: this.recorder,
+            context: context,
+            globalData: globalData,
+            startNodeType: startNodeType,
+        });
+        this.flowModel.load(graphData);
+        return this.flowModel;
+    };
+    /**
+     * 执行流程，允许多次调用。
+     */
+    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);
+                            } }));
+                    })];
+            });
+        });
+    };
+    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);
+                            } }));
+                    })];
+            });
+        });
+    };
+    Engine.prototype.getExecutionRecord = function (executionId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var tasks, records, i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.recorder.getExecutionTasks(executionId)];
+                    case 1:
+                        tasks = _a.sent();
+                        records = [];
+                        for (i = 0; i < tasks.length; i++) {
+                            records.push(this.recorder.getTask(tasks[i]));
+                        }
+                        return [2 /*return*/, Promise.all(records)];
+                }
+            });
+        });
+    };
+    return Engine;
+}());
+export default Engine;
+export { Engine, TaskNode, StartNode, };

package/es/nodes/BaseNode.d.ts

@@ -0,0 +1,109 @@
+import type { ActionResult, NodeExecResult, ExecResumeParams, ExecParams } from '../types.d';
+export interface BaseNodeInterface {
+    outgoing: Record<string, any>[];
+    incoming: Record<string, any>[];
+    nodeId: string;
+    type: string;
+    readonly baseType: string;
+    execute(taskParam: any): Promise<NodeExecResult>;
+}
+export declare type NodeConstructor = {
+    new (config: {
+        nodeConfig: NodeConfig;
+        context: Record<string, any>;
+        globalData: Record<string, any>;
+    }): BaseNode;
+};
+export declare type IncomingConfig = {
+    id: string;
+    properties?: Record<string, any>;
+    source: string;
+};
+export declare type OutgoingConfig = {
+    id: string;
+    target: string;
+    properties?: Record<string, any>;
+};
+export declare type NodeConfig = {
+    id: string;
+    type: string;
+    properties?: Record<string, any>;
+    incoming: IncomingConfig[];
+    outgoing: OutgoingConfig[];
+};
+export declare type NextTaskParam = {
+    executionId: string;
+    nodeId: string;
+    taskId: string;
+    nodeType: string;
+    outgoing: OutgoingConfig[];
+    properties?: Record<string, any>;
+};
+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;
+    });
+    /**
+     * 节点的每一次执行都会生成一个唯一的taskId
+     */
+    execute(params: ExecParams): Promise<NodeExecResult>;
+    /**
+     * 节点在执行中断后，可以通过resume方法恢复执行。
+     * 自定义节点时不建议重写此方法
+     */
+    resume(params: ExecResumeParams): Promise<undefined>;
+    private getOutgoing;
+    private isPass;
+    /**
+     * 节点的执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.taskId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     */
+    action(params: {
+        executionId: string;
+        taskId: string;
+        nodeId: string;
+    }): Promise<ActionResult>;
+    /**
+     * 节点的重新恢复执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.taskId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     */
+    onResume(params: {
+        executionId: string;
+        taskId: string;
+        nodeId: string;
+        data?: Record<string, any>;
+    }): Promise<void>;
+}

package/es/nodes/BaseNode.js

@@ -0,0 +1,241 @@
+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 };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+import { TaskStatus } from '../constant/constant';
+import { getExpressionResult } from '../expression';
+var BaseNode = /** @class */ (function () {
+    function BaseNode(_a) {
+        var nodeConfig = _a.nodeConfig, context = _a.context, globalData = _a.globalData;
+        this.outgoing = nodeConfig.outgoing;
+        this.incoming = nodeConfig.incoming;
+        this.nodeId = nodeConfig.id;
+        this.type = nodeConfig.type;
+        this.properties = nodeConfig.properties;
+        this.context = context;
+        this.globalData = globalData;
+        this.baseType = 'base';
+    }
+    /**
+     * 节点的每一次执行都会生成一个唯一的taskId
+     */
+    BaseNode.prototype.execute = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var r, outgoing;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.action({
+                            executionId: params.executionId,
+                            taskId: params.taskId,
+                            nodeId: this.nodeId,
+                        })];
+                    case 1:
+                        r = _a.sent();
+                        if (!(!r || r.status === TaskStatus.SUCCESS)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.getOutgoing()];
+                    case 2:
+                        outgoing = _a.sent();
+                        params.next({
+                            executionId: params.executionId,
+                            taskId: params.taskId,
+                            nodeId: this.nodeId,
+                            nodeType: this.type,
+                            properties: this.properties,
+                            outgoing: outgoing,
+                        });
+                        _a.label = 3;
+                    case 3: return [2 /*return*/, {
+                            status: r && r.status,
+                            detail: r && r.detail,
+                            executionId: params.executionId,
+                            taskId: params.taskId,
+                            nodeId: this.nodeId,
+                            nodeType: this.type,
+                            properties: this.properties,
+                        }];
+                }
+            });
+        });
+    };
+    /**
+     * 节点在执行中断后，可以通过resume方法恢复执行。
+     * 自定义节点时不建议重写此方法
+     */
+    BaseNode.prototype.resume = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var outgoing;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getOutgoing()];
+                    case 1:
+                        outgoing = _a.sent();
+                        return [4 /*yield*/, this.onResume({
+                                executionId: params.executionId,
+                                nodeId: params.nodeId,
+                                taskId: params.taskId,
+                                data: params.data,
+                            })];
+                    case 2:
+                        _a.sent();
+                        params.next({
+                            executionId: params.executionId,
+                            taskId: params.taskId,
+                            nodeId: this.nodeId,
+                            nodeType: this.type,
+                            properties: this.properties,
+                            outgoing: outgoing,
+                        });
+                        return [2 /*return*/, undefined];
+                }
+            });
+        });
+    };
+    BaseNode.prototype.getOutgoing = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var outgoing, expressions, _a, _b, item, properties, result;
+            var e_1, _c;
+            var _this = this;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        outgoing = [];
+                        expressions = [];
+                        try {
+                            for (_a = __values(this.outgoing), _b = _a.next(); !_b.done; _b = _a.next()) {
+                                item = _b.value;
+                                properties = item.properties;
+                                expressions.push(this.isPass(properties));
+                            }
+                        }
+                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        finally {
+                            try {
+                                if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                        }
+                        return [4 /*yield*/, Promise.all(expressions)];
+                    case 1:
+                        result = _d.sent();
+                        result.forEach(function (item, index) {
+                            if (item) {
+                                outgoing.push(_this.outgoing[index]);
+                            }
+                        });
+                        return [2 /*return*/, outgoing];
+                }
+            });
+        });
+    };
+    BaseNode.prototype.isPass = function (properties) {
+        return __awaiter(this, void 0, void 0, function () {
+            var conditionExpression, result, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!properties)
+                            return [2 /*return*/, true];
+                        conditionExpression = properties.conditionExpression;
+                        if (!conditionExpression)
+                            return [2 /*return*/, true];
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, getExpressionResult("result" + this.nodeId + " = (" + conditionExpression + ")", __assign({}, this.globalData))];
+                    case 2:
+                        result = _a.sent();
+                        return [2 /*return*/, result["result" + this.nodeId]];
+                    case 3:
+                        e_2 = _a.sent();
+                        return [2 /*return*/, false];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 节点的执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.taskId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     */
+    BaseNode.prototype.action = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, undefined];
+            });
+        });
+    };
+    /**
+     * 节点的重新恢复执行逻辑
+     * @overridable 可以自定义节点重写此方法。
+     * @param params.executionId 流程执行记录ID
+     * @param params.taskId 此节点执行记录ID
+     * @param params.nodeId 节点ID
+     */
+    BaseNode.prototype.onResume = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, undefined];
+            });
+        });
+    };
+    BaseNode.nodeTypeName = 'BaseNode';
+    return BaseNode;
+}());
+export default BaseNode;

package/es/nodes/StartNode.d.ts

@@ -0,0 +1,5 @@
+import BaseNode from './BaseNode';
+export default class StartNode extends BaseNode {
+    static nodeTypeName: string;
+    readonly baseType = "start";
+}

package/es/nodes/StartNode.js

@@ -0,0 +1,25 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+import BaseNode from './BaseNode';
+var StartNode = /** @class */ (function (_super) {
+    __extends(StartNode, _super);
+    function StartNode() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.baseType = 'start';
+        return _this;
+    }
+    StartNode.nodeTypeName = 'StartNode';
+    return StartNode;
+}(BaseNode));
+export default StartNode;

package/es/nodes/TaskNode.d.ts

@@ -0,0 +1,5 @@
+import BaseNode from './BaseNode';
+export default class TaskNode extends BaseNode {
+    static nodeTypeName: string;
+    readonly baseType = "task";
+}

package/es/nodes/TaskNode.js

@@ -0,0 +1,25 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+import BaseNode from './BaseNode';
+var TaskNode = /** @class */ (function (_super) {
+    __extends(TaskNode, _super);
+    function TaskNode() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.baseType = 'task';
+        return _this;
+    }
+    TaskNode.nodeTypeName = 'TaskNode';
+    return TaskNode;
+}(BaseNode));
+export default TaskNode;

package/es/recorder/index.d.ts

@@ -0,0 +1,9 @@
+import type { RecorderData, RecorderInterface } from '../types.d';
+export default class Recorder implements RecorderInterface {
+    addTask(task: RecorderData): Promise<void>;
+    getTask(taskId: string): Promise<RecorderData>;
+    getExecutionTasks(executionId: any): Promise<any>;
+    clear(): void;
+    private pushExecution;
+    private pushTaskToExecution;
+}