@webda/workflow 0.0.0-stage → 4.0.0-beta.13

package/lib/interpreter.js

@@ -0,0 +1,330 @@
+import { evaluate } from "./expression.js";
+/**
+ * Maximum number of iterations of a `while`
+ */
+export const MAX_LOOP_ITERATIONS = 10000;
+/**
+ * An error thrown inside the flow, catchable by a `try`
+ */
+class FlowThrow {
+    error;
+    /**
+     * @param error - the flow error
+     */
+    constructor(error) {
+        this.error = error;
+    }
+}
+const NORMAL = { type: "normal" };
+/**
+ * Task key of a statement at an iteration path
+ * @param id - the statement id
+ * @param path - indexes of the enclosing loops and branches
+ * @returns the key
+ */
+export function taskKey(id, path) {
+    return `${id}@${path.join(".")}`;
+}
+/**
+ * Statement id of a task key
+ * @param key - the task key
+ * @returns the statement id
+ */
+export function statementIdOf(key) {
+    return key.substring(0, key.lastIndexOf("@"));
+}
+/**
+ * Replay of one flow against its journal
+ */
+class Replay {
+    def;
+    journal;
+    /**
+     * @param def - the flow
+     * @param journal - finished task outcomes
+     */
+    constructor(def, journal) {
+        this.def = def;
+        this.journal = journal;
+    }
+    /**
+     * Throw a flow error
+     * @param code - error code
+     * @param message - error message
+     * @returns never
+     */
+    fail(code, message) {
+        throw new FlowThrow({ code, message, operation: this.def.id });
+    }
+    /**
+     * Evaluate an expression, an invalid one throws in the flow
+     * @param expr - the expression
+     * @param scope - the variables
+     * @returns the value
+     */
+    value(expr, scope) {
+        try {
+            return evaluate(expr, scope);
+        }
+        catch (err) {
+            return this.fail("ExpressionError", err.message);
+        }
+    }
+    /**
+     * Run a block of statements in order, stopping at the first one that does not complete normally
+     * @param stmts - the statements
+     * @param scope - the variables
+     * @param path - the iteration path
+     * @returns the completion
+     */
+    block(stmts, scope, path) {
+        for (const stmt of stmts ?? []) {
+            const res = this.stmt(stmt, scope, path);
+            if (res.type !== "normal") {
+                return res;
+            }
+        }
+        return NORMAL;
+    }
+    /**
+     * Run one statement
+     * @param stmt - the statement
+     * @param scope - the variables
+     * @param path - the iteration path
+     * @returns the completion
+     */
+    stmt(stmt, scope, path) {
+        switch (stmt.kind) {
+            case "task":
+                return this.task(stmt, scope, path);
+            case "assign":
+                scope[stmt.name] = this.value(stmt.value, scope);
+                return NORMAL;
+            case "if":
+                return this.block(this.value(stmt.cond, scope) ? stmt.then : stmt.else, scope, path);
+            case "forOf": {
+                const items = this.value(stmt.items, scope);
+                if (!Array.isArray(items)) {
+                    this.fail("TypeError", `${stmt.id}: items is not an array`);
+                }
+                for (let i = 0; i < items.length; i++) {
+                    scope[stmt.item] = items[i];
+                    const res = this.block(stmt.body, scope, [...path, i]);
+                    if (res.type !== "normal") {
+                        return res;
+                    }
+                }
+                return NORMAL;
+            }
+            case "while":
+                for (let i = 0; this.value(stmt.cond, scope); i++) {
+                    if (i >= MAX_LOOP_ITERATIONS) {
+                        this.fail("LoopLimit", `${stmt.id}: more than ${MAX_LOOP_ITERATIONS} iterations`);
+                    }
+                    const res = this.block(stmt.body, scope, [...path, i]);
+                    if (res.type !== "normal") {
+                        return res;
+                    }
+                }
+                return NORMAL;
+            case "try":
+                return this.try(stmt, scope, path);
+            case "parallel":
+                return this.concurrent(stmt.branches.map((branch, i) => ({ body: branch, scope: structuredClone(scope), path: [...path, i] })), Infinity, scope, stmt.assign);
+            case "map": {
+                const items = this.value(stmt.items, scope);
+                if (!Array.isArray(items)) {
+                    this.fail("TypeError", `${stmt.id}: items is not an array`);
+                }
+                return this.concurrent(items.map((item, i) => ({
+                    body: stmt.body,
+                    scope: { ...structuredClone(scope), [stmt.item]: structuredClone(item) },
+                    path: [...path, i]
+                })), stmt.concurrency && stmt.concurrency > 0 ? stmt.concurrency : Infinity, scope, stmt.assign);
+            }
+            case "return":
+                return { type: "return", value: stmt.value === undefined ? undefined : this.value(stmt.value, scope) };
+            case "throw": {
+                const value = this.value(stmt.value, scope);
+                if (value && typeof value.code === "string" && typeof value.message === "string") {
+                    // A caught FlowError rethrown
+                    throw new FlowThrow({ code: value.code, message: value.message, operation: String(value.operation ?? "") });
+                }
+                return this.fail("FlowError", typeof value === "string" ? value : JSON.stringify(value));
+            }
+        }
+        return this.fail("InvalidStatement", `Unknown statement kind ${stmt?.kind}`);
+    }
+    /**
+     * A task: its outcome from the journal, or schedule it
+     * @param stmt - the task statement
+     * @param scope - the variables
+     * @param path - the iteration path
+     * @returns the completion
+     */
+    task(stmt, scope, path) {
+        const key = taskKey(stmt.id, path);
+        const outcome = this.journal[key];
+        if (outcome === undefined) {
+            return {
+                type: "pending",
+                schedule: [
+                    {
+                        key,
+                        operation: stmt.operation,
+                        input: this.value(stmt.input, scope),
+                        options: { ...this.def.options, ...stmt.options }
+                    }
+                ]
+            };
+        }
+        if ("error" in outcome) {
+            throw new FlowThrow(outcome.error);
+        }
+        if (stmt.assign) {
+            scope[stmt.assign] = structuredClone(outcome.result);
+        }
+        return NORMAL;
+    }
+    /**
+     * try/catch/finally: finally runs after the body or the catch, then their completion goes on
+     * @param stmt - the try statement
+     * @param scope - the variables
+     * @param path - the iteration path
+     * @returns the completion
+     */
+    try(stmt, scope, path) {
+        let res = NORMAL;
+        let thrown;
+        try {
+            res = this.block(stmt.body, scope, path);
+        }
+        catch (err) {
+            if (!(err instanceof FlowThrow))
+                throw err;
+            if (stmt.catch) {
+                if (stmt.catchVar) {
+                    scope[stmt.catchVar] = structuredClone(err.error);
+                }
+                try {
+                    res = this.block(stmt.catch, scope, path);
+                }
+                catch (err2) {
+                    if (!(err2 instanceof FlowThrow))
+                        throw err2;
+                    thrown = err2;
+                }
+            }
+            else {
+                thrown = err;
+            }
+        }
+        if (res?.type === "pending") {
+            return res;
+        }
+        const fin = this.block(stmt.finally, scope, path);
+        if (fin.type !== "normal") {
+            return fin;
+        }
+        if (thrown) {
+            throw thrown;
+        }
+        return res;
+    }
+    /**
+     * Run branches concurrently: each one on its own copy of the variables, at most `concurrency` unfinished
+     * @param branches - the bodies with their scope and path
+     * @param concurrency - maximum number of unfinished branches
+     * @param scope - the parent variables
+     * @param assign - variable receiving the return values
+     * @returns the completion
+     */
+    concurrent(branches, concurrency, scope, assign) {
+        const values = [];
+        const schedule = [];
+        let running = 0;
+        let error;
+        for (const branch of branches) {
+            if (running >= concurrency) {
+                // A later branch cannot start before one of the running ones finishes
+                break;
+            }
+            try {
+                const res = this.block(branch.body, branch.scope, branch.path);
+                if (res.type === "pending") {
+                    running++;
+                    schedule.push(...res.schedule);
+                }
+                else {
+                    values.push(res.type === "return" ? res.value : undefined);
+                }
+            }
+            catch (err) {
+                if (!(err instanceof FlowThrow))
+                    throw err;
+                // The first branch to fail (in order) fails the whole statement
+                error ??= err;
+            }
+        }
+        if (error) {
+            throw error;
+        }
+        if (schedule.length) {
+            return { type: "pending", schedule };
+        }
+        if (assign) {
+            scope[assign] = values;
+        }
+        return NORMAL;
+    }
+}
+/**
+ * Replay a flow against its journal
+ *
+ * Pure: no I/O, the same arguments always give the same result.
+ * @param def - the flow definition
+ * @param input - the flow input, by parameter name
+ * @param journal - outcomes of the finished tasks
+ * @returns done with the output, error with the uncaught error, or pending with the tasks to run
+ */
+export function run(def, input, journal) {
+    const replay = new Replay(def, journal);
+    try {
+        const res = replay.block(def.body, structuredClone(input ?? {}), []);
+        if (res.type === "pending") {
+            return { status: "pending", schedule: res.schedule };
+        }
+        return { status: "done", output: res.type === "return" ? res.value : undefined };
+    }
+    catch (err) {
+        if (err instanceof FlowThrow) {
+            return { status: "error", error: err.error };
+        }
+        throw err;
+    }
+}
+/**
+ * Statement ids of a definition, nested ones included
+ * @param def - the flow definition
+ * @returns the ids
+ */
+export function keysOf(def) {
+    const ids = new Set();
+    const walk = (stmts) => {
+        for (const stmt of stmts ?? []) {
+            if (!stmt || typeof stmt !== "object")
+                continue;
+            ids.add(stmt.id);
+            walk(stmt.then);
+            walk(stmt.else);
+            walk(stmt.body);
+            walk(stmt.catch);
+            walk(stmt.finally);
+            for (const branch of stmt.branches ?? [])
+                walk(branch);
+        }
+    };
+    walk(def.body);
+    return ids;
+}
+//# sourceMappingURL=interpreter.js.map

package/lib/interpreter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interpreter.js","sources":["../src/interpreter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAG3C;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC;AA0BzC;;GAEG;AACH,MAAM,SAAS;IAIM,KAAK;IAHxB;;OAEG;IACH,YAAmB,KAAgB;qBAAhB,KAAK;IAAc,CAAC;CACxC;AAOD,MAAM,MAAM,GAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,EAAU,EAAE,IAAc;IAChD,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AAChD,CAAC;AAED;;GAEG;AACH,MAAM,MAAM;IAME,GAAG;IACH,OAAO;IANnB;;;OAGG;IACH,YACY,GAAmB,EACnB,OAAgB;mBADhB,GAAG;uBACH,OAAO;IAChB,CAAC;IAEJ;;;;;OAKG;IACH,IAAI,CAAC,IAAY,EAAE,OAAe;QAChC,MAAM,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAU,EAAE,KAA0B;QAC1C,IAAI,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAyB,EAAE,KAA0B,EAAE,IAAc;QACzE,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACzC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1B,OAAO,GAAG,CAAC;YACb,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,IAAU,EAAE,KAA0B,EAAE,IAAc;QACzD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACtC,KAAK,QAAQ;gBACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACjD,OAAO,MAAM,CAAC;YAChB,KAAK,IAAI;gBACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACvF,KAAK,OAAO,EAAE,CAAC;gBACb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,EAAE,yBAAyB,CAAC,CAAC;gBAC9D,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACvD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC1B,OAAO,GAAG,CAAC;oBACb,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,KAAK,OAAO;gBACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBAClD,IAAI,CAAC,IAAI,mBAAmB,EAAE,CAAC;wBAC7B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,EAAE,eAAe,mBAAmB,aAAa,CAAC,CAAC;oBACpF,CAAC;oBACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACvD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC1B,OAAO,GAAG,CAAC;oBACb,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACrC,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,UAAU,CACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EACvG,QAAQ,EACR,KAAK,EACL,IAAI,CAAC,MAAM,CACZ,CAAC;YACJ,KAAK,KAAK,EAAE,CAAC;gBACX,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,EAAE,yBAAyB,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,IAAI,CAAC,UAAU,CACpB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,KAAK,EAAE,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,EAAE;oBACxE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;iBACnB,CAAC,CAAC,EACH,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,EACtE,KAAK,EACL,IAAI,CAAC,MAAM,CACZ,CAAC;YACJ,CAAC;YACD,KAAK,QAAQ;gBACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YACzG,KAAK,OAAO,EAAE,CAAC;gBACb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC5C,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;oBACjF,8BAA8B;oBAC9B,MAAM,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC9G,CAAC;gBACD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,0BAA2B,IAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,IAAqC,EAAE,KAA0B,EAAE,IAAc;QACpF,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;wBACpC,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;qBAClD;iBACF;aACF,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,IAAoC,EAAE,KAA0B,EAAE,IAAc;QAClF,IAAI,GAAG,GAAe,MAAM,CAAC;QAC7B,IAAI,MAA6B,CAAC;QAClC,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,SAAS,CAAC;gBAAE,MAAM,GAAG,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACpD,CAAC;gBACD,IAAI,CAAC;oBACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC5C,CAAC;gBAAC,OAAO,IAAI,EAAE,CAAC;oBACd,IAAI,CAAC,CAAC,IAAI,YAAY,SAAS,CAAC;wBAAE,MAAM,IAAI,CAAC;oBAC7C,MAAM,GAAG,IAAI,CAAC;gBAChB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,CAAC;YACf,CAAC;QACH,CAAC;QACD,IAAI,GAAG,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAClD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,CAAC;QACf,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,QAAwE,EACxE,WAAmB,EACnB,KAA0B,EAC1B,MAAe;QAEf,MAAM,MAAM,GAAU,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,KAA4B,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC9B,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;gBAC3B,sEAAsE;gBACtE,MAAM;YACR,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/D,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC3B,OAAO,EAAE,CAAC;oBACV,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBAC7D,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,CAAC,GAAG,YAAY,SAAS,CAAC;oBAAE,MAAM,GAAG,CAAC;gBAC3C,gEAAgE;gBAChE,KAAK,KAAK,GAAG,CAAC;YAChB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,KAAK,CAAC;QACd,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACvC,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CAAC,GAAmB,EAAE,KAA0B,EAAE,OAAgB;IACnF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACxC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACrE,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;QACvD,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IACnF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,SAAS,EAAE,CAAC;YAC7B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC;QAC/C,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAiC;IACtD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,MAAM,IAAI,GAAG,CAAC,KAAwB,EAAE,EAAE;QACxC,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,SAAS;YAChD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE;gBAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACf,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/models/workflow.model.d.ts

@@ -0,0 +1,71 @@
+import { CoreModel, type IOperationContext } from "@webda/core";
+import type { TaskOptions } from "../graph.js";
+/**
+ * A cron launching a stored workflow
+ */
+export interface StoredWorkflowCron {
+    /**
+     * Cron expression
+     */
+    cron: string;
+    /**
+     * Description
+     */
+    description?: string;
+    /**
+     * Flow input, by parameter name
+     */
+    input?: Record<string, any>;
+}
+/**
+ * A workflow defined at runtime: the same graph as a `.flow.ts` flow, stored as data
+ *
+ * Saving validates the graph (expressions, statement kinds, operations, `useSystem`); the WorkflowService registers
+ * it as the operation `name` and its crons, which run as the user who saved it last.
+ *
+ * @WebdaModel
+ * @WebdaPlural Workflows
+ */
+export default class Workflow extends CoreModel {
+    /**
+     * Flow id: the operation launching it
+     */
+    name: string;
+    /**
+     * Names of the flow parameters, in order
+     */
+    params: string[];
+    /**
+     * JSON schema of the input
+     */
+    input: object;
+    /**
+     * The statements ({@link Stmt}[])
+     */
+    body: any[];
+    /**
+     * Default options of every task
+     */
+    options?: TaskOptions;
+    /**
+     * Crons launching the flow
+     */
+    crons?: StoredWorkflowCron[];
+    /**
+     * {@link flowVersion} of the graph, computed on save
+     */
+    version: string;
+    /**
+     * User id of the last save: the identity of its crons
+     */
+    updatedBy?: string;
+    /**
+     * The system always; any authenticated user reads; writes need the stored workflow role
+     * @param context - the caller
+     * @param action - the action
+     * @returns true when allowed, the reason otherwise
+     */
+    canAct(context: IOperationContext, action: string): Promise<string | boolean>;
+}
+export { Workflow };
+//# sourceMappingURL=workflow.model.d.ts.map

package/lib/models/workflow.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.model.d.ts","sources":["../../src/models/workflow.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,SAAS;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACG,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,CAalF;CACF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/lib/models/workflow.model.js

@@ -0,0 +1,70 @@
+import { CoreModel } from "@webda/core";
+import { useWorkflowControls } from "../hooks.js";
+/**
+ * A workflow defined at runtime: the same graph as a `.flow.ts` flow, stored as data
+ *
+ * Saving validates the graph (expressions, statement kinds, operations, `useSystem`); the WorkflowService registers
+ * it as the operation `name` and its crons, which run as the user who saved it last.
+ *
+ * @WebdaModel
+ * @WebdaPlural Workflows
+ */
+export default class Workflow extends CoreModel {
+    /**
+     * Flow id: the operation launching it
+     */
+    name;
+    /**
+     * Names of the flow parameters, in order
+     */
+    params;
+    /**
+     * JSON schema of the input
+     */
+    input;
+    /**
+     * The statements ({@link Stmt}[])
+     */
+    body;
+    /**
+     * Default options of every task
+     */
+    options;
+    /**
+     * Crons launching the flow
+     */
+    crons;
+    /**
+     * {@link flowVersion} of the graph, computed on save
+     */
+    version;
+    /**
+     * User id of the last save: the identity of its crons
+     */
+    updatedBy;
+    /**
+     * The system always; any authenticated user reads; writes need the stored workflow role
+     * @param context - the caller
+     * @param action - the action
+     * @returns true when allowed, the reason otherwise
+     */
+    async canAct(context, action) {
+        if (context.isGlobalContext())
+            return true;
+        if (!context.getCurrentUserId())
+            return "Authentication required";
+        if (action === "get" || action === "query")
+            return true;
+        let role = "workflow-admin";
+        try {
+            role = useWorkflowControls().getStoredWorkflowRole();
+        }
+        catch {
+            // No WorkflowService: the default role
+        }
+        const roles = context.getSession()?.roles ?? (await context.getCurrentUser())?.getRoles?.() ?? [];
+        return roles.includes(role) || `Role ${role} required`;
+    }
+}
+export { Workflow };
+//# sourceMappingURL=workflow.model.js.map

package/lib/models/workflow.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.model.js","sources":["../../src/models/workflow.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAA0B,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAoBlD;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,SAAS;IAC7C;;OAEG;IACH,IAAI,CAAS;IACb;;OAEG;IACH,MAAM,CAAW;IACjB;;OAEG;IACH,KAAK,CAAS;IACd;;OAEG;IACH,IAAI,CAAQ;IACZ;;OAEG;IACH,OAAO,CAAe;IACtB;;OAEG;IACH,KAAK,CAAwB;IAC7B;;OAEG;IACH,OAAO,CAAS;IAChB;;OAEG;IACH,SAAS,CAAU;IAEnB;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,OAA0B,EAAE,MAAc;QACrD,IAAI,OAAO,CAAC,eAAe,EAAE;YAAE,OAAO,IAAI,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YAAE,OAAO,yBAAyB,CAAC;QAClE,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QACxD,IAAI,IAAI,GAAG,gBAAgB,CAAC;QAC5B,IAAI,CAAC;YACH,IAAI,GAAG,mBAAmB,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;QAAC,MAAM,CAAC;YACP,uCAAuC;QACzC,CAAC;QACD,MAAM,KAAK,GACT,OAAO,CAAC,UAAU,EAAE,EAAE,KAAK,IAAK,CAAC,MAAM,OAAO,CAAC,cAAc,EAAE,CAAS,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC;QAC/F,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,IAAI,WAAW,CAAC;IACzD,CAAC;CACF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/lib/models/workflowinstance.model.d.ts

@@ -0,0 +1,132 @@
+import { CoreModel, type IOperationContext, type MfaState } from "@webda/core";
+import type { FlowDefinitionData, FlowError, Journal } from "../graph.js";
+/**
+ * Status of a workflow instance
+ */
+export type WorkflowInstanceStatus = "RUNNING" | "WAITING" | "SUCCESS" | "ERROR" | "CANCELLED";
+/**
+ * Who launched a workflow: the steps run as this identity
+ */
+export interface WorkflowLauncher {
+    /**
+     * User id of the launcher
+     */
+    userId?: string;
+    /**
+     * Ident used by the launcher to log in
+     */
+    identId?: string;
+    /**
+     * Granted scopes of the launcher session, when restricted
+     */
+    scopes?: string[];
+    /**
+     * OAuth client id of the launcher session, when applicable
+     */
+    clientId?: string;
+    /**
+     * MFA state of the launcher session
+     */
+    mfa?: MfaState;
+    /**
+     * MFA verification timestamp of the launcher session
+     */
+    mfaAt?: number;
+    /**
+     * Launched by the system
+     */
+    system?: boolean;
+}
+/**
+ * Whether a caller may read or control an object launched by `launcherId`
+ * @param context - the caller
+ * @param action - the action
+ * @param launcherId - user id of the launcher
+ * @returns true when allowed, the reason otherwise
+ */
+export declare function canReadWorkflow(context: IOperationContext, action: string, launcherId?: string): string | boolean;
+/**
+ * A running (or finished) flow: its pinned definition, input and journal of task outcomes
+ *
+ * @WebdaModel
+ * @WebdaPlural WorkflowInstances
+ */
+export default class WorkflowInstance extends CoreModel {
+    /**
+     * Flow id: the operation id launching the flow
+     */
+    flowId: string;
+    /**
+     * Version of the pinned definition
+     */
+    version: string;
+    /**
+     * The definition the instance runs, pinned at launch
+     */
+    definition: FlowDefinitionData;
+    /**
+     * Flow input, by parameter name
+     */
+    input: Record<string, any>;
+    /**
+     * Outcomes of the finished tasks, by task key
+     */
+    journal: Journal;
+    /**
+     * Current status
+     */
+    status: WorkflowInstanceStatus;
+    /**
+     * Identity the steps run as
+     */
+    launcher: WorkflowLauncher;
+    /**
+     * Flow output, once SUCCESS
+     */
+    output?: any;
+    /**
+     * Uncaught error, once ERROR
+     */
+    error?: FlowError;
+    /**
+     * Revision of the instance, incremented by every write (compare-and-set)
+     */
+    revision: number;
+    /**
+     * Parent instance and task key of a child flow
+     */
+    parent?: {
+        instance: string;
+        key: string;
+    };
+    /**
+     * Creation time (ms)
+     */
+    createdAt: number;
+    /**
+     * Last update time (ms)
+     */
+    updatedAt: number;
+    /**
+     * Launcher and system may read, writes go through the service only
+     * @param context - the caller
+     * @param action - the action
+     * @returns true when allowed, the reason otherwise
+     */
+    canAct(context: IOperationContext, action: string): string | boolean;
+    /**
+     * Cancel the instance, its live tasks and the children it waits on
+     */
+    cancel(): Promise<void>;
+    /**
+     * Restart a failed instance from its failed task, keeping the outcomes before it
+     */
+    retry(): Promise<void>;
+    /**
+     * Move a running instance to another version of its flow
+     * @param version - the target version, the latest registered when omitted
+     */
+    migrate(version?: string): Promise<void>;
+}
+export { WorkflowInstance };
+//# sourceMappingURL=workflowinstance.model.d.ts.map

package/lib/models/workflowinstance.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowinstance.model.d.ts","sources":["../../src/models/workflowinstance.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,SAAS,EAAE,KAAK,iBAAiB,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvF,OAAO,KAAK,EAAE,kBAAkB,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAOD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAYjH;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,SAAS;IACrD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,kBAAkB,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAEnE;IAED;;OAEG;IAEG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5B;IAED;;OAEG;IAEG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAE3B;IAED;;;OAGG;IAEG,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE7C;CACF;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}