@flowlab/all
Version:
A cool library focusing on handling various flows
179 lines (178 loc) • 9.78 kB
JavaScript
"use strict";
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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FlowLabEngine = void 0;
var nodeRegistry_1 = require("./nodeRegistry");
var definition_1 = require("./definition");
var executor_1 = require("./executor");
var errors_1 = require("../errors");
var FlowLabEngine = /** @class */ (function () {
function FlowLabEngine(options) {
if (options === void 0) { options = {}; }
// Allow storing definitions in memory or loading from persistence
this.workflowDefinitions = new Map();
this.options = __assign({ maxLoopIterations: 1000 }, options);
this.nodeRegistry = new nodeRegistry_1.NodeRegistry();
this.persistence = options.persistence;
this.scheduler = options.scheduler;
this.eventManager = options.eventManager;
// this.logger.info('FlowLabEngine initialized.');
if (this.persistence)
this.logger.info("Persistence enabled: ".concat(this.persistence.constructor.name));
if (this.scheduler)
this.logger.info("Scheduler enabled: ".concat(this.scheduler.constructor.name));
if (this.eventManager)
this.logger.info("EventManager enabled: ".concat(this.eventManager.constructor.name));
}
FlowLabEngine.prototype.registerNode = function (idOrNode, func, description) {
this.nodeRegistry.register(idOrNode, func, description);
};
// --- Workflow Definition ---
FlowLabEngine.prototype.defineWorkflow = function (id, name, description) {
var definition = new definition_1.WorkflowDefinition(id, name, description);
// Store definition in memory for execution by ID
// TODO: Decide if registration should be explicit via `registerDefinition`
this.workflowDefinitions.set(id, definition);
return definition;
};
// Explicitly register a definition (e.g., after building or loading)
FlowLabEngine.prototype.registerDefinition = function (definition) {
var _this = this;
var _a;
var def = definition instanceof definition_1.WorkflowDefinition ? definition : this._hydrateDefinition(definition);
if (this.workflowDefinitions.has(def.id)) {
this.logger.warn("Overwriting existing definition for workflow ID '".concat(def.id, "'."));
}
this.workflowDefinitions.set(def.id, def);
// Optionally save to persistence if configured
if ((_a = this.persistence) === null || _a === void 0 ? void 0 : _a.saveDefinition) {
this.persistence.saveDefinition(def.getData())
.catch(function (err) { return _this.logger.error("Failed to save definition '".concat(def.id, "' to persistence"), err); });
}
this.logger.info("Workflow definition '".concat(def.id, "' registered."));
};
FlowLabEngine.prototype.getDefinition = function (id) {
return __awaiter(this, void 0, void 0, function () {
var definition, data;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
definition = this.workflowDefinitions.get(id);
if (!(!definition && ((_a = this.persistence) === null || _a === void 0 ? void 0 : _a.loadDefinition))) return [3 /*break*/, 2];
this.logger.debug("Definition '".concat(id, "' not in memory, attempting to load from persistence..."));
return [4 /*yield*/, this.persistence.loadDefinition(id)];
case 1:
data = _b.sent();
if (data) {
definition = this._hydrateDefinition(data);
this.workflowDefinitions.set(id, definition); // Cache in memory
this.logger.info("Definition '".concat(id, "' loaded from persistence."));
}
else {
this.logger.warn("Definition '".concat(id, "' not found in persistence."));
}
_b.label = 2;
case 2: return [2 /*return*/, definition];
}
});
});
};
// Re-create WorkflowDefinition instance from data (e.g., loaded from DB)
FlowLabEngine.prototype._hydrateDefinition = function (data) {
var definition = new definition_1.WorkflowDefinition(data.id, data.name, data.description);
// Re-add steps from data
for (var stepId in data.steps) {
// This assumes _addStepInternal exists and accepts StepConfig
definition._addStepInternal(data.steps[stepId]);
}
if (data.startStepId) {
definition.setStartStep(data.startStepId);
}
// TODO: Handle versioning?
return definition;
};
// --- Workflow Execution ---
FlowLabEngine.prototype.createExecutor = function () {
// Pass engine dependencies to the executor
return new executor_1.WorkflowExecutor({
nodeRegistry: this.nodeRegistry,
logger: this.logger,
persistence: this.persistence,
scheduler: this.scheduler,
eventManager: this.eventManager,
getWorkflowDefinition: this.getDefinition.bind(this), // Provide lookup function
maxLoopIterations: this.options.maxLoopIterations,
});
};
/**
* Convenience method to define AND run a simple workflow immediately.
* Combines definition and execution for simple cases (closer to Core API).
* Warning: Definition is ephemeral unless explicitly registered/saved.
*/
FlowLabEngine.prototype.runWorkflow = function (definitionBuilder_1, input_1) {
return __awaiter(this, arguments, void 0, function (definitionBuilder, input, contextExtras // Allow passing tenantId, userId etc.
) {
var tempId, builder, executor;
if (contextExtras === void 0) { contextExtras = {}; }
return __generator(this, function (_a) {
tempId = "temp-".concat(Date.now(), "-").concat(Math.random().toString(16).slice(2));
builder = new definition_1.WorkflowDefinition(tempId);
definitionBuilder(builder); // Allow user to define steps via callback
if (!builder.validate()) {
throw new errors_1.ConfigurationError("Temporary workflow definition validation failed.");
}
executor = this.createExecutor();
return [2 /*return*/, executor.run(builder, input, contextExtras)]; // Execute directly
});
});
};
return FlowLabEngine;
}());
exports.FlowLabEngine = FlowLabEngine;