@serverlessworkflow/sdk 1.0.3-alpha1 → 1.0.3-alpha3

package/index.cjs

@@ -30,6 +30,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
+let semver_functions_satisfies_js = require("semver/functions/satisfies.js");
+semver_functions_satisfies_js = __toESM(semver_functions_satisfies_js);
 let ajv_dist_2020_js = require("ajv/dist/2020.js");
 ajv_dist_2020_js = __toESM(ajv_dist_2020_js);
 let ajv_formats = require("ajv-formats");
@@ -141,11 +143,12 @@ var ArrayHydrator = class extends Array {
 };
 //#endregion
 //#region package.json
-var schemaVersion = "1.0.3";
+var supportedDslVersions = ">=1.0.0 <=1.0.3";
 //#endregion
 //#region src/lib/hooks/workflow-hooks.ts
 const WorkflowHooks = { preValidation(instance) {
-	if (instance?.document?.dsl !== schemaVersion) throw new Error(`'Workflow' is invalid - The DSL version of the workflow '${instance?.document?.dsl}' doesn't match the supported version of the SDK '${schemaVersion}'.`);
+	const dsl = instance?.document?.dsl;
+	if (!(typeof dsl === "string" && (0, semver_functions_satisfies_js.default)(dsl, supportedDslVersions, { includePrerelease: true }))) throw new Error(`'Workflow' is invalid - The DSL version of the workflow '${dsl}' does not satisfy the DSL version range supported by this SDK '${supportedDslVersions}'.`);
 } };
 //#endregion
 //#region src/lib/lifecycle-hooks.ts
@@ -6664,7 +6667,7 @@ const _ExternalScript = class ExternalScript extends ObjectHydrator {
 		return getLifecycleHooks("ExternalScript")?.normalize?.(copy) || copy;
 	}
 };
-const _FlowDirective = class FlowDirective$1 extends ObjectHydrator {
+const _FlowDirective = class FlowDirective extends ObjectHydrator {
 	/**
 	* Instanciates a new instance of the FlowDirective class.
 	* Initializes properties based on the provided model if it is an object.
@@ -6680,7 +6683,7 @@ const _FlowDirective = class FlowDirective$1 extends ObjectHydrator {
 	* Throws if invalid.
 	*/
 	validate(workflow) {
-		validate("FlowDirective", new FlowDirective$1(this), workflow);
+		validate("FlowDirective", new FlowDirective(this), workflow);
 	}
 	/**
 	* Normalizes the current instance of the FlowDirective.
@@ -6689,7 +6692,7 @@ const _FlowDirective = class FlowDirective$1 extends ObjectHydrator {
 	* @returns A normalized version of the FlowDirective instance.
 	*/
 	normalize() {
-		const copy = new FlowDirective$1(this);
+		const copy = new FlowDirective(this);
 		return getLifecycleHooks("FlowDirective")?.normalize?.(copy) || copy;
 	}
 };
@@ -8453,7 +8456,6 @@ const entrySuffix = "-entry-node";
 const exitSuffix = "-exit-node";
 const rootId = "root";
 const doReference = "/do";
-const forReference = "/for";
 const catchReference = "/catch";
 const branchReference = "/fork/branches";
 const tryReference = "/try";
@@ -8483,15 +8485,6 @@ let GraphNodeType = /* @__PURE__ */ function(GraphNodeType) {
 	return GraphNodeType;
 }({});
 /**
-* Enumeration of possible workflow flow directives.
-*/
-var FlowDirective = /* @__PURE__ */ function(FlowDirective) {
-	FlowDirective["Exit"] = "exit";
-	FlowDirective["End"] = "end";
-	FlowDirective["Continue"] = "continue";
-	return FlowDirective;
-}(FlowDirective || {});
-/**
 * Converts an array of TaskItem objects into a Map for easy lookup.
 *
 * @param tasksList An array of TaskItem objects.
@@ -8525,12 +8518,12 @@ function initGraph(type, id = rootId, task = void 0, label = void 0, parent = vo
 		edges: []
 	};
 	const entryNode = {
-		type: id === rootId ? GraphNodeType.Start : GraphNodeType.Entry,
+		type: id === rootId ? "start" : "entry",
 		id: `${id}${entrySuffix}`,
 		parent: graph
 	};
 	const exitNode = {
-		type: id === rootId ? GraphNodeType.End : GraphNodeType.Exit,
+		type: id === rootId ? "end" : "exit",
 		id: `${id}${exitSuffix}`,
 		parent: graph
 	};
@@ -8549,23 +8542,23 @@ function initGraph(type, id = rootId, task = void 0, label = void 0, parent = vo
 */
 function getNextTask(tasksList, taskName = void 0, transition = void 0) {
 	if (!tasksList?.size) return {
-		name: FlowDirective.Exit,
+		name: "exit",
 		index: -1
 	};
 	const currentTask = tasksList.get(taskName || "");
 	transition = transition || currentTask?.then || "";
-	if (transition == FlowDirective.End || transition == FlowDirective.Exit) return {
+	if (transition == "end" || transition == "exit") return {
 		name: transition,
 		index: -1
 	};
 	let index = 0;
-	if (transition && transition != FlowDirective.Continue) {
+	if (transition && transition != "continue") {
 		index = Array.from(tasksList.keys()).indexOf(transition);
 		if (index === -1) throw new Error(`Unable to find task to transition to '${transition}' from '${taskName}'`);
 	} else if (currentTask) {
 		index = Array.from(tasksList.values()).indexOf(currentTask) + 1;
 		if (index >= tasksList.size) return {
-			name: FlowDirective.Exit,
+			name: "exit",
 			index: -1
 		};
 	}
@@ -8605,10 +8598,10 @@ function buildTransition(sourceNode, transition, context) {
 			taskName: transition.name
 		});
 		buildEdge(context.graph, context.knownEdges, exitAnchor, targetNode.entryNode || targetNode, transition.label);
-	} else if (transition.name === FlowDirective.Exit) {
+	} else if (transition.name === "exit") {
 		if (!context.graph.exitNode) throw new Error(`Missing exit node on graph id '${context.graph.id}'`);
 		buildEdge(context.graph, context.knownEdges, exitAnchor, context.graph.exitNode, transition.label);
-	} else if (transition.name === FlowDirective.End) buildEdge(context.graph, context.knownEdges, exitAnchor, getEndNode(context.graph), transition.label);
+	} else if (transition.name === "end") buildEdge(context.graph, context.knownEdges, exitAnchor, getEndNode(context.graph), transition.label);
 	else throw new Error("Invalid transition");
 }
 /**
@@ -8622,7 +8615,7 @@ function buildTransitions(sourceNode, context) {
 	transitions.push(nextTransition);
 	while (nextTransition?.task?.if) {
 		nextTransition.label = nextTransition?.task?.if;
-		nextTransition = getNextTask(context.taskList, nextTransition.name, FlowDirective.Continue);
+		nextTransition = getNextTask(context.taskList, nextTransition.name, "continue");
 		transitions.push(nextTransition);
 	}
 	transitions.filter((transition, index) => transitions.findIndex((t) => t.index === transition.index && t.name === transition.name && t.task === transition.task) === index).forEach((transition) => buildTransition(sourceNode, transition, context));
@@ -8676,7 +8669,7 @@ function buildGenericTaskNode(task, type, context) {
 * @returns A graph node for the provided task
 */
 function buildCallTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Call, context);
+	return buildGenericTaskNode(task, "call", context);
 }
 /**
 * Builds a graph for the provided do task
@@ -8685,7 +8678,7 @@ function buildCallTaskNode(task, context) {
 * @returns A graph for the provided task
 */
 function buildDoTaskNode(task, context) {
-	const subgraph = initGraph(GraphNodeType.Do, context.taskReference, task, context.taskName, context.graph);
+	const subgraph = initGraph("do", context.taskReference, task, context.taskName, context.graph);
 	const doContext = {
 		...context,
 		graph: subgraph,
@@ -8705,7 +8698,7 @@ function buildDoTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildEmitTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Emit, context);
+	return buildGenericTaskNode(task, "emit", context);
 }
 /**
 * Builds a graph for the provided for task
@@ -8714,11 +8707,11 @@ function buildEmitTaskNode(task, context) {
 * @returns A graph for the provided task
 */
 function buildForTaskNode(task, context) {
-	const subgraph = initGraph(GraphNodeType.For, context.taskReference, task, context.taskName, context.graph);
+	const subgraph = initGraph("for", context.taskReference, task, context.taskName, context.graph);
 	const forContext = {
 		...context,
 		graph: subgraph,
-		taskListReference: subgraph.id + forReference + doReference,
+		taskListReference: subgraph.id + "/for/do",
 		taskList: mapTasks(task.do),
 		taskName: void 0
 	};
@@ -8734,7 +8727,7 @@ function buildForTaskNode(task, context) {
 * @returns A graph for the provided task
 */
 function buildForkTaskNode(task, context) {
-	const subgraph = initGraph(GraphNodeType.Fork, context.taskReference, task, context.taskName, context.graph);
+	const subgraph = initGraph("fork", context.taskReference, task, context.taskName, context.graph);
 	for (let i = 0, c = task.fork?.branches.length || 0; i < c; i++) {
 		const branchItem = task.fork?.branches[i];
 		if (!branchItem) continue;
@@ -8762,7 +8755,7 @@ function buildForkTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildListenTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Listen, context);
+	return buildGenericTaskNode(task, "listen", context);
 }
 /**
 * Builds a graph node for the provided rasie task
@@ -8771,7 +8764,7 @@ function buildListenTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildRaiseTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Raise, context);
+	return buildGenericTaskNode(task, "raise", context);
 }
 /**
 * Builds a graph node for the provided run task
@@ -8780,7 +8773,7 @@ function buildRaiseTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildRunTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Run, context);
+	return buildGenericTaskNode(task, "run", context);
 }
 /**
 * Builds a graph node for the provided set task
@@ -8789,7 +8782,7 @@ function buildRunTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildSetTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Set, context);
+	return buildGenericTaskNode(task, "set", context);
 }
 /**
 * Builds a graph node for the provided switch task
@@ -8798,7 +8791,7 @@ function buildSetTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildSwitchTaskNode(task, context) {
-	const node = buildGenericTaskNode(task, GraphNodeType.Switch, context);
+	const node = buildGenericTaskNode(task, "switch", context);
 	let hasDefaultCase = false;
 	task.switch?.forEach((switchItem) => {
 		const [caseName, switchCase] = Object.entries(switchItem)[0];
@@ -8817,8 +8810,8 @@ function buildSwitchTaskNode(task, context) {
 * @returns A graph for the provided task
 */
 function buildTryCatchTaskNode(task, context) {
-	const containerSubgraph = initGraph(GraphNodeType.TryCatch, context.taskReference, task, context.taskName, context.graph);
-	const trySubgraph = initGraph(GraphNodeType.Try, context.taskReference + tryReference, task, context.taskName + " (try)", containerSubgraph);
+	const containerSubgraph = initGraph("try-catch", context.taskReference, task, context.taskName, context.graph);
+	const trySubgraph = initGraph("try", context.taskReference + tryReference, task, context.taskName + " (try)", containerSubgraph);
 	if (!containerSubgraph.entryNode) throw new Error(`Missing 'entryNode' on graph id '${containerSubgraph.id}'`);
 	if (!trySubgraph.entryNode) throw new Error(`Missing 'entryNode' on graph id '${trySubgraph.id}'`);
 	buildEdge(containerSubgraph, context.knownEdges, containerSubgraph.entryNode, trySubgraph.entryNode);
@@ -8834,7 +8827,7 @@ function buildTryCatchTaskNode(task, context) {
 	if (!task.catch?.do?.length) {
 		const catchNode = {
 			task,
-			type: GraphNodeType.Catch,
+			type: "catch",
 			parent: containerSubgraph,
 			id: context.taskReference + catchReference,
 			label: context.taskName + " (catch)"
@@ -8845,7 +8838,7 @@ function buildTryCatchTaskNode(task, context) {
 		buildEdge(containerSubgraph, context.knownEdges, trySubgraph.exitNode, catchNode);
 		buildEdge(containerSubgraph, context.knownEdges, catchNode, containerSubgraph.exitNode);
 	} else {
-		const catchSubgraph = initGraph(GraphNodeType.Catch, context.taskReference + catchReference + doReference, task, context.taskName + " (catch)", containerSubgraph);
+		const catchSubgraph = initGraph("catch", context.taskReference + "/catch/do", task, context.taskName + " (catch)", containerSubgraph);
 		if (!trySubgraph.exitNode) throw new Error(`Missing 'exitNode' on graph id '${trySubgraph.id}'`);
 		if (!catchSubgraph.entryNode) throw new Error(`Missing 'entryNode' on graph id '${catchSubgraph.entryNode}'`);
 		buildEdge(containerSubgraph, context.knownEdges, trySubgraph.exitNode, catchSubgraph.entryNode);
@@ -8871,7 +8864,7 @@ function buildTryCatchTaskNode(task, context) {
 * @returns A graph node for the provided task
 */
 function buildWaitTaskNode(task, context) {
-	return buildGenericTaskNode(task, GraphNodeType.Wait, context);
+	return buildGenericTaskNode(task, "wait", context);
 }
 /**
 * Builds an edge between two elements
@@ -8965,7 +8958,7 @@ function flattenGraph(graph, removePorts = false) {
 	return {
 		...flatGraph,
 		edges: remapEdges(flatGraph.edges),
-		nodes: flatGraph.nodes.filter((node) => node.type !== GraphNodeType.Entry && node.type !== GraphNodeType.Exit)
+		nodes: flatGraph.nodes.filter((node) => node.type !== "entry" && node.type !== "exit")
 	};
 }
 /**
@@ -8975,7 +8968,7 @@ function flattenGraph(graph, removePorts = false) {
 * @returns A graph representation of the workflow.
 */
 function buildGraph(workflow) {
-	const graph = initGraph(GraphNodeType.Root);
+	const graph = initGraph("root");
 	if (!graph.entryNode) throw new Error("The root graph should have an entry node.");
 	buildTransitions(graph.entryNode, {
 		graph,
@@ -9030,14 +9023,14 @@ function convertNodeToCode(root, node) {
 	else {
 		code = node.id;
 		switch (node.type) {
-			case GraphNodeType.Entry:
-			case GraphNodeType.Exit:
+			case "entry":
+			case "exit":
 				code += "[ ]:::hidden";
 				break;
-			case GraphNodeType.Start:
+			case "start":
 				code += "(( ))";
 				break;
-			case GraphNodeType.End:
+			case "end":
 				code += "((( )))";
 				break;
 			default: code += `["${node.label || " "}"]`;
@@ -9069,6 +9062,7 @@ classDef hidden width: 1px, height: 1px;`;
 * This class takes a workflow definition and converts it into a Mermaid.js-compatible diagram.
 */
 var MermaidDiagram = class {
+	workflow;
 	constructor(workflow) {
 		this.workflow = workflow;
 	}