n8n-workflow 1.98.0 → 1.99.0

package/dist/cjs/graph/graph-utils.js

@@ -0,0 +1,195 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.getInputEdges = getInputEdges;
+    exports.getOutputEdges = getOutputEdges;
+    exports.getRootNodes = getRootNodes;
+    exports.getLeafNodes = getLeafNodes;
+    exports.hasPath = hasPath;
+    exports.buildAdjacencyList = buildAdjacencyList;
+    exports.parseExtractableSubgraphSelection = parseExtractableSubgraphSelection;
+    /**
+     * Find all edges leading into the graph described in `graphIds`.
+     */
+    function getInputEdges(graphIds, adjacencyList) {
+        const result = [];
+        for (const [from, tos] of adjacencyList.entries()) {
+            if (graphIds.has(from))
+                continue;
+            for (const to of tos) {
+                if (graphIds.has(to.node)) {
+                    result.push([from, to]);
+                }
+            }
+        }
+        return result;
+    }
+    /**
+     * Find all edges leading out of the graph described in `graphIds`.
+     */
+    function getOutputEdges(graphIds, adjacencyList) {
+        const result = [];
+        for (const [from, tos] of adjacencyList.entries()) {
+            if (!graphIds.has(from))
+                continue;
+            for (const to of tos) {
+                if (!graphIds.has(to.node)) {
+                    result.push([from, to]);
+                }
+            }
+        }
+        return result;
+    }
+    function intersection(a, b) {
+        const result = new Set();
+        for (const x of a) {
+            if (b.has(x))
+                result.add(x);
+        }
+        return result;
+    }
+    function union(a, b) {
+        const result = new Set();
+        for (const x of a)
+            result.add(x);
+        for (const x of b)
+            result.add(x);
+        return result;
+    }
+    function difference(minuend, subtrahend) {
+        const result = new Set(minuend.values());
+        for (const x of subtrahend) {
+            result.delete(x);
+        }
+        return result;
+    }
+    function getRootNodes(graphIds, adjacencyList) {
+        // Inner nodes are all nodes with an incoming edge from another node in the graph
+        let innerNodes = new Set();
+        for (const nodeId of graphIds) {
+            innerNodes = union(innerNodes, new Set([...(adjacencyList.get(nodeId) ?? [])]
+                .filter((x) => x.type === 'main' && x.node !== nodeId)
+                .map((x) => x.node)));
+        }
+        return difference(graphIds, innerNodes);
+    }
+    function getLeafNodes(graphIds, adjacencyList) {
+        const result = new Set();
+        for (const nodeId of graphIds) {
+            if (intersection(new Set([...(adjacencyList.get(nodeId) ?? [])]
+                .filter((x) => x.type === 'main' && x.node !== nodeId)
+                .map((x) => x.node)), graphIds).size === 0) {
+                result.add(nodeId);
+            }
+        }
+        return result;
+    }
+    function hasPath(start, end, adjacencyList) {
+        const seen = new Set();
+        const paths = [start];
+        while (true) {
+            const next = paths.pop();
+            if (next === end)
+                return true;
+            if (next === undefined)
+                return false;
+            seen.add(next);
+            paths.push(...difference(new Set([...(adjacencyList.get(next) ?? [])].filter((x) => x.type === 'main').map((x) => x.node)), seen));
+        }
+    }
+    function buildAdjacencyList(connectionsBySourceNode) {
+        const result = new Map();
+        const addOrCreate = (k, v) => result.set(k, union(result.get(k) ?? new Set(), new Set([v])));
+        for (const sourceNode of Object.keys(connectionsBySourceNode)) {
+            for (const type of Object.keys(connectionsBySourceNode[sourceNode])) {
+                for (const sourceIndex of Object.keys(connectionsBySourceNode[sourceNode][type])) {
+                    for (const connectionIndex of Object.keys(connectionsBySourceNode[sourceNode][type][parseInt(sourceIndex, 10)] ?? [])) {
+                        const connection = connectionsBySourceNode[sourceNode][type][parseInt(sourceIndex, 10)]?.[parseInt(connectionIndex, 10)];
+                        if (connection)
+                            addOrCreate(sourceNode, connection);
+                    }
+                }
+            }
+        }
+        return result;
+    }
+    /**
+     * A subgraph is considered extractable if the following properties hold:
+     * - 0-1 input nodes from outside the subgraph, to a root node
+     * - 0-1 output nodes to outside the subgraph, from a leaf node
+     * - continuous path between input and output nodes if they exist
+     *
+     * This also covers the requirement that all "inner" nodes between the root node
+     * and the output node are selected, since this would otherwise create extra
+     * input or output nodes.
+     *
+     * @returns An object containing optional start and end nodeIds
+     *            indicating which nodes have outside connections, OR
+     *          An array of errors if the selection is not valid.
+     */
+    function parseExtractableSubgraphSelection(graphIds, adjacencyList) {
+        const errors = [];
+        // 0-1 Input nodes
+        const inputEdges = getInputEdges(graphIds, adjacencyList);
+        // This filters out e.g. sub-nodes, which are technically parents
+        const inputNodes = new Set(inputEdges.filter((x) => x[1].type === 'main').map((x) => x[1].node));
+        let rootNodes = getRootNodes(graphIds, adjacencyList);
+        // this enables supporting cases where we have one input and a loop back to it from within the selection
+        if (rootNodes.size === 0 && inputNodes.size === 1)
+            rootNodes = inputNodes;
+        for (const inputNode of difference(inputNodes, rootNodes).values()) {
+            errors.push({
+                errorCode: 'Input Edge To Non-Root Node',
+                node: inputNode,
+            });
+        }
+        const rootInputNodes = intersection(rootNodes, inputNodes);
+        if (rootInputNodes.size > 1) {
+            errors.push({
+                errorCode: 'Multiple Input Nodes',
+                nodes: rootInputNodes,
+            });
+        }
+        // 0-1 Output nodes
+        const outputEdges = getOutputEdges(graphIds, adjacencyList);
+        const outputNodes = new Set(outputEdges.filter((x) => x[1].type === 'main').map((x) => x[0]));
+        let leafNodes = getLeafNodes(graphIds, adjacencyList);
+        // If we have no leaf nodes, and only one output node, we can tolerate this output node
+        // and connect to it.
+        // Note that this is fairly theoretical, as return semantics in this case are not well-defined.
+        if (leafNodes.size === 0 && outputNodes.size === 1)
+            leafNodes = outputNodes;
+        for (const outputNode of difference(outputNodes, leafNodes).values()) {
+            errors.push({
+                errorCode: 'Output Edge From Non-Leaf Node',
+                node: outputNode,
+            });
+        }
+        const leafOutputNodes = intersection(leafNodes, outputNodes);
+        if (leafOutputNodes.size > 1) {
+            errors.push({
+                errorCode: 'Multiple Output Nodes',
+                nodes: leafOutputNodes,
+            });
+        }
+        const start = rootInputNodes.values().next().value;
+        const end = leafOutputNodes.values().next().value;
+        if (start && end && !hasPath(start, end, adjacencyList)) {
+            errors.push({
+                errorCode: 'No Continuous Path From Root To Leaf In Selection',
+                start,
+                end,
+            });
+        }
+        return errors.length > 0 ? errors : { start, end };
+    }
+});
+//# sourceMappingURL=graph-utils.js.map

package/dist/cjs/graph/graph-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-utils.js","sourceRoot":"","sources":["../../../src/graph/graph-utils.ts"],"names":[],"mappings":";;;;;;;;;;;IAwCA,sCAgBC;IAKD,wCAgBC;IAyBD,oCAkBC;IAED,oCAoBC;IAED,0BAkBC;IAOD,gDAuBC;IAgBD,8EAgEC;IA3OD;;OAEG;IACH,SAAgB,aAAa,CAC5B,QAAqB,EACrB,aAAuC;QAEvC,MAAM,MAAM,GAAiC,EAAE,CAAC;QAChD,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YACnD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YAEjC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;gBACtB,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzB,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACH,SAAgB,cAAc,CAC7B,QAAqB,EACrB,aAAuC;QAEvC,MAAM,MAAM,GAAiC,EAAE,CAAC;QAChD,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YACnD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YAElC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;gBACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzB,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED,SAAS,YAAY,CAAI,CAAS,EAAE,CAAS;QAC5C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAK,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED,SAAS,KAAK,CAAI,CAAS,EAAE,CAAS;QACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAK,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACjC,KAAK,MAAM,CAAC,IAAI,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACjC,OAAO,MAAM,CAAC;IACf,CAAC;IAED,SAAS,UAAU,CAAI,OAAe,EAAE,UAAkB;QACzD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5C,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED,SAAgB,YAAY,CAC3B,QAAqB,EACrB,aAAuC;QAEvC,iFAAiF;QACjF,IAAI,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC/B,UAAU,GAAG,KAAK,CACjB,UAAU,EACV,IAAI,GAAG,CACN,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;iBACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;iBACrD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACpB,CACD,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,SAAgB,YAAY,CAC3B,QAAqB,EACrB,aAAuC;QAEvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC/B,IACC,YAAY,CACX,IAAI,GAAG,CACN,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;iBACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;iBACrD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACpB,EACD,QAAQ,CACR,CAAC,IAAI,KAAK,CAAC,EACX,CAAC;gBACF,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED,SAAgB,OAAO,CAAC,KAAa,EAAE,GAAW,EAAE,aAAuC;QAC1F,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,MAAM,KAAK,GAAa,CAAC,KAAK,CAAC,CAAC;QAChC,OAAO,IAAI,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,IAAI,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YAC9B,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAEf,KAAK,CAAC,IAAI,CACT,GAAG,UAAU,CACZ,IAAI,GAAG,CACN,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACxF,EACD,IAAI,CACJ,CACD,CAAC;QACH,CAAC;IACF,CAAC;IAOD,SAAgB,kBAAkB,CACjC,uBAAqC;QAErC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA4B,CAAC;QACnD,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,CAAc,EAAE,EAAE,CACjD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhE,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC;YAC/D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBACrE,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAClF,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CACxC,uBAAuB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAC1E,EAAE,CAAC;wBACH,MAAM,UAAU,GACf,uBAAuB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,CACrE,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAC7B,CAAC;wBACH,IAAI,UAAU;4BAAE,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;oBACrD,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,iCAAiC,CAChD,QAAqB,EACrB,aAAuC;QAEvC,MAAM,MAAM,GAA6B,EAAE,CAAC;QAE5C,kBAAkB;QAClB,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC1D,iEAAiE;QACjE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACjG,IAAI,SAAS,GAAG,YAAY,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAEtD,wGAAwG;QACxG,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC;YAAE,SAAS,GAAG,UAAU,CAAC;QAC1E,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YACpE,MAAM,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,6BAA6B;gBACxC,IAAI,EAAE,SAAS;aACf,CAAC,CAAC;QACJ,CAAC;QACD,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAC3D,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,sBAAsB;gBACjC,KAAK,EAAE,cAAc;aACrB,CAAC,CAAC;QACJ,CAAC;QAED,mBAAmB;QACnB,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9F,IAAI,SAAS,GAAG,YAAY,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACtD,uFAAuF;QACvF,qBAAqB;QACrB,+FAA+F;QAC/F,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC;YAAE,SAAS,GAAG,WAAW,CAAC;QAE5E,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YACtE,MAAM,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,UAAU;aAChB,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC7D,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,uBAAuB;gBAClC,KAAK,EAAE,eAAe;aACtB,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;QACnD,MAAM,GAAG,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;QAElD,IAAI,KAAK,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,mDAAmD;gBAC9D,KAAK;gBACL,GAAG;aACH,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IACpD,CAAC"}

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -11,6 +11,7 @@ export * from './interfaces';
 export * from './message-event-bus';
 export * from './execution-status';
 export * from './expression';
+export * from './expressions/expression-helpers';
 export * from './from-ai-parse-utils';
 export * from './node-helpers';
 export * from './node-reference-parser-utils';
@@ -45,3 +46,4 @@ declare module 'http' {
         req?: ClientRequest;
     }
 }
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AAExD,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;AACxE,OAAO,EACN,aAAa,EACb,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,yBAAyB,EACzB,KAAK,EACL,cAAc,EACd,oBAAoB,EACpB,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,GACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,GACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,iCAAiC,EACjC,kBAAkB,EAClB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,IAAI,aAAa,GAC9C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,gBAAgB,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,cAAc,oCAAoC,CAAC;AAEnD,YAAY,EACX,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,SAAS,GACT,MAAM,cAAc,CAAC;AAEtB,OAAO,QAAQ,MAAM,CAAC;IACrB,UAAiB,eAAe;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,cAAc,CAAC;QACzB,kBAAkB,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACzD,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7B,KAAK,EAAE,OAAO,CAAC;QAGf,WAAW,CAAC,EAAE,MAAM,CAAC;QAGrB,GAAG,CAAC,EAAE,aAAa,CAAC;KACpB;CACD"}

package/dist/cjs/index.js

@@ -0,0 +1,114 @@
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./logger-proxy", "./node-helpers", "./observable-object", "./telemetry-helpers", "./errors", "./constants", "./cron", "./deferred-promise", "./global-state", "./interfaces", "./message-event-bus", "./execution-status", "./expression", "./expressions/expression-helpers", "./from-ai-parse-utils", "./node-helpers", "./node-reference-parser-utils", "./metadata-utils", "./workflow", "./workflow-data-proxy", "./workflow-data-proxy-env-provider", "./versioned-node-type", "./type-validation", "./result", "./utils", "./type-guards", "./graph/graph-utils", "./extensions", "./extensions/expression-parser", "./native-methods", "./node-parameters/filter-parameter"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NativeMethods = exports.ExpressionParser = exports.ExpressionExtensions = exports.buildAdjacencyList = exports.parseExtractableSubgraphSelection = exports.isFilterValue = exports.isResourceLocatorValue = exports.isResourceMapperValue = exports.isINodePropertyOptionsList = exports.isINodePropertyCollectionList = exports.isINodePropertiesList = exports.isINodePropertyCollection = exports.isINodePropertyOptions = exports.isINodeProperties = exports.setSafeObjectProperty = exports.isSafeObjectProperty = exports.randomString = exports.randomInt = exports.updateDisplayOptions = exports.removeCircularRefs = exports.assert = exports.fileTypeFromMimeType = exports.sleepWithAbort = exports.sleep = exports.replaceCircularReferences = exports.jsonStringify = exports.base64DecodeUTF8 = exports.jsonParse = exports.deepCopy = exports.isObjectEmpty = exports.TelemetryHelpers = exports.ObservableObject = exports.NodeHelpers = exports.LoggerProxy = void 0;
+    const LoggerProxy = __importStar(require("./logger-proxy"));
+    exports.LoggerProxy = LoggerProxy;
+    const NodeHelpers = __importStar(require("./node-helpers"));
+    exports.NodeHelpers = NodeHelpers;
+    const ObservableObject = __importStar(require("./observable-object"));
+    exports.ObservableObject = ObservableObject;
+    const TelemetryHelpers = __importStar(require("./telemetry-helpers"));
+    exports.TelemetryHelpers = TelemetryHelpers;
+    __exportStar(require("./errors"), exports);
+    __exportStar(require("./constants"), exports);
+    __exportStar(require("./cron"), exports);
+    __exportStar(require("./deferred-promise"), exports);
+    __exportStar(require("./global-state"), exports);
+    __exportStar(require("./interfaces"), exports);
+    __exportStar(require("./message-event-bus"), exports);
+    __exportStar(require("./execution-status"), exports);
+    __exportStar(require("./expression"), exports);
+    __exportStar(require("./expressions/expression-helpers"), exports);
+    __exportStar(require("./from-ai-parse-utils"), exports);
+    __exportStar(require("./node-helpers"), exports);
+    __exportStar(require("./node-reference-parser-utils"), exports);
+    __exportStar(require("./metadata-utils"), exports);
+    __exportStar(require("./workflow"), exports);
+    __exportStar(require("./workflow-data-proxy"), exports);
+    __exportStar(require("./workflow-data-proxy-env-provider"), exports);
+    __exportStar(require("./versioned-node-type"), exports);
+    __exportStar(require("./type-validation"), exports);
+    __exportStar(require("./result"), exports);
+    var utils_1 = require("./utils");
+    Object.defineProperty(exports, "isObjectEmpty", { enumerable: true, get: function () { return utils_1.isObjectEmpty; } });
+    Object.defineProperty(exports, "deepCopy", { enumerable: true, get: function () { return utils_1.deepCopy; } });
+    Object.defineProperty(exports, "jsonParse", { enumerable: true, get: function () { return utils_1.jsonParse; } });
+    Object.defineProperty(exports, "base64DecodeUTF8", { enumerable: true, get: function () { return utils_1.base64DecodeUTF8; } });
+    Object.defineProperty(exports, "jsonStringify", { enumerable: true, get: function () { return utils_1.jsonStringify; } });
+    Object.defineProperty(exports, "replaceCircularReferences", { enumerable: true, get: function () { return utils_1.replaceCircularReferences; } });
+    Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return utils_1.sleep; } });
+    Object.defineProperty(exports, "sleepWithAbort", { enumerable: true, get: function () { return utils_1.sleepWithAbort; } });
+    Object.defineProperty(exports, "fileTypeFromMimeType", { enumerable: true, get: function () { return utils_1.fileTypeFromMimeType; } });
+    Object.defineProperty(exports, "assert", { enumerable: true, get: function () { return utils_1.assert; } });
+    Object.defineProperty(exports, "removeCircularRefs", { enumerable: true, get: function () { return utils_1.removeCircularRefs; } });
+    Object.defineProperty(exports, "updateDisplayOptions", { enumerable: true, get: function () { return utils_1.updateDisplayOptions; } });
+    Object.defineProperty(exports, "randomInt", { enumerable: true, get: function () { return utils_1.randomInt; } });
+    Object.defineProperty(exports, "randomString", { enumerable: true, get: function () { return utils_1.randomString; } });
+    Object.defineProperty(exports, "isSafeObjectProperty", { enumerable: true, get: function () { return utils_1.isSafeObjectProperty; } });
+    Object.defineProperty(exports, "setSafeObjectProperty", { enumerable: true, get: function () { return utils_1.setSafeObjectProperty; } });
+    var type_guards_1 = require("./type-guards");
+    Object.defineProperty(exports, "isINodeProperties", { enumerable: true, get: function () { return type_guards_1.isINodeProperties; } });
+    Object.defineProperty(exports, "isINodePropertyOptions", { enumerable: true, get: function () { return type_guards_1.isINodePropertyOptions; } });
+    Object.defineProperty(exports, "isINodePropertyCollection", { enumerable: true, get: function () { return type_guards_1.isINodePropertyCollection; } });
+    Object.defineProperty(exports, "isINodePropertiesList", { enumerable: true, get: function () { return type_guards_1.isINodePropertiesList; } });
+    Object.defineProperty(exports, "isINodePropertyCollectionList", { enumerable: true, get: function () { return type_guards_1.isINodePropertyCollectionList; } });
+    Object.defineProperty(exports, "isINodePropertyOptionsList", { enumerable: true, get: function () { return type_guards_1.isINodePropertyOptionsList; } });
+    Object.defineProperty(exports, "isResourceMapperValue", { enumerable: true, get: function () { return type_guards_1.isResourceMapperValue; } });
+    Object.defineProperty(exports, "isResourceLocatorValue", { enumerable: true, get: function () { return type_guards_1.isResourceLocatorValue; } });
+    Object.defineProperty(exports, "isFilterValue", { enumerable: true, get: function () { return type_guards_1.isFilterValue; } });
+    var graph_utils_1 = require("./graph/graph-utils");
+    Object.defineProperty(exports, "parseExtractableSubgraphSelection", { enumerable: true, get: function () { return graph_utils_1.parseExtractableSubgraphSelection; } });
+    Object.defineProperty(exports, "buildAdjacencyList", { enumerable: true, get: function () { return graph_utils_1.buildAdjacencyList; } });
+    var extensions_1 = require("./extensions");
+    Object.defineProperty(exports, "ExpressionExtensions", { enumerable: true, get: function () { return extensions_1.ExpressionExtensions; } });
+    exports.ExpressionParser = __importStar(require("./extensions/expression-parser"));
+    var native_methods_1 = require("./native-methods");
+    Object.defineProperty(exports, "NativeMethods", { enumerable: true, get: function () { return native_methods_1.NativeMethods; } });
+    __exportStar(require("./node-parameters/filter-parameter"), exports);
+});
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAAA,4DAA8C;IAyBrC,kCAAW;IAxBpB,4DAA8C;IAwBxB,kCAAW;IAvBjC,sEAAwD;IAuBrB,4CAAgB;IAtBnD,sEAAwD;IAsBH,4CAAgB;IApBrE,2CAAyB;IACzB,8CAA4B;IAC5B,yCAAuB;IACvB,qDAAmC;IACnC,iDAA+B;IAC/B,+CAA6B;IAC7B,sDAAoC;IACpC,qDAAmC;IACnC,+CAA6B;IAC7B,mEAAiD;IACjD,wDAAsC;IACtC,iDAA+B;IAC/B,gEAA8C;IAC9C,mDAAiC;IACjC,6CAA2B;IAC3B,wDAAsC;IACtC,qEAAmD;IACnD,wDAAsC;IACtC,oDAAkC;IAClC,2CAAyB;IAEzB,iCAiBiB;IAhBhB,sGAAA,aAAa,OAAA;IACb,iGAAA,QAAQ,OAAA;IACR,kGAAA,SAAS,OAAA;IACT,yGAAA,gBAAgB,OAAA;IAChB,sGAAA,aAAa,OAAA;IACb,kHAAA,yBAAyB,OAAA;IACzB,8FAAA,KAAK,OAAA;IACL,uGAAA,cAAc,OAAA;IACd,6GAAA,oBAAoB,OAAA;IACpB,+FAAA,MAAM,OAAA;IACN,2GAAA,kBAAkB,OAAA;IAClB,6GAAA,oBAAoB,OAAA;IACpB,kGAAA,SAAS,OAAA;IACT,qGAAA,YAAY,OAAA;IACZ,6GAAA,oBAAoB,OAAA;IACpB,8GAAA,qBAAqB,OAAA;IAEtB,6CAUuB;IATtB,gHAAA,iBAAiB,OAAA;IACjB,qHAAA,sBAAsB,OAAA;IACtB,wHAAA,yBAAyB,OAAA;IACzB,oHAAA,qBAAqB,OAAA;IACrB,4HAAA,6BAA6B,OAAA;IAC7B,yHAAA,0BAA0B,OAAA;IAC1B,oHAAA,qBAAqB,OAAA;IACrB,qHAAA,sBAAsB,OAAA;IACtB,4GAAA,aAAa,OAAA;IAGd,mDAM6B;IAL5B,gIAAA,iCAAiC,OAAA;IACjC,iHAAA,kBAAkB,OAAA;IAKnB,2CAAoD;IAA3C,kHAAA,oBAAoB,OAAA;IAC7B,mFAAmE;IACnE,mDAAiD;IAAxC,+GAAA,aAAa,OAAA;IACtB,qEAAmD"}

package/dist/{interfaces.d.ts → cjs/interfaces.d.ts}

@@ -285,6 +285,7 @@ export interface IExecuteContextData {
     [key: string]: IContextObject;
 }
 export type IHttpRequestMethods = 'DELETE' | 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT';
+/** used in helpers.httpRequest(WithAuthentication) */
 export interface IHttpRequestOptions {
     url: string;
     baseURL?: string;
@@ -316,6 +317,11 @@ export interface IHttpRequestOptions {
     json?: boolean;
     abortSignal?: GenericAbortSignal;
 }
+/**
+ * used in helpers.request(WithAuthentication)
+ * @see IHttpRequestOptions
+ * @deprecated Prefer using IHttpRequestOptions
+ */
 export interface IRequestOptions {
     baseURL?: string;
     uri?: string;
@@ -347,8 +353,11 @@ export interface IRequestOptions {
     simple?: boolean;
     gzip?: boolean;
     resolveWithFullResponse?: boolean;
+    /** Whether to follow GET or HEAD HTTP 3xx redirects @default true */
     followRedirect?: boolean;
+    /** Whether to follow **All** HTTP 3xx redirects @default false */
     followAllRedirects?: boolean;
+    /** Max number of redirects to follow @default 21 */
     maxRedirects?: number;
     agentOptions?: SecureContextOptions;
 }
@@ -449,6 +458,7 @@ export interface FileSystemHelperFunctions {
 export interface BinaryHelperFunctions {
     prepareBinaryData(binaryData: Buffer | Readable, filePath?: string, mimeType?: string): Promise<IBinaryData>;
     setBinaryDataBuffer(data: IBinaryData, binaryData: Buffer): Promise<IBinaryData>;
+    /** @deprecated */
     copyBinaryFile(): Promise<never>;
     binaryToBuffer(body: Buffer | Readable): Promise<Buffer>;
     binaryToString(body: Buffer | Readable, encoding?: BufferEncoding): Promise<string>;
@@ -498,9 +508,25 @@ export interface RequestHelperFunctions {
     httpRequest(requestOptions: IHttpRequestOptions): Promise<any>;
     httpRequestWithAuthentication(this: IAllExecuteFunctions, credentialsType: string, requestOptions: IHttpRequestOptions, additionalCredentialOptions?: IAdditionalCredentialOptions): Promise<any>;
     requestWithAuthenticationPaginated(this: IAllExecuteFunctions, requestOptions: IRequestOptions, itemIndex: number, paginationOptions: PaginationOptions, credentialsType?: string, additionalCredentialOptions?: IAdditionalCredentialOptions): Promise<any[]>;
+    /**
+     * @deprecated Use .httpRequest instead
+     * @see RequestHelperFunctions.httpRequest
+     */
     request(uriOrObject: string | IRequestOptions, options?: IRequestOptions): Promise<any>;
+    /**
+     * @deprecated Use .httpRequestWithAuthentication instead
+     * @see RequestHelperFunctions.requestWithAuthentication
+     */
     requestWithAuthentication(this: IAllExecuteFunctions, credentialsType: string, requestOptions: IRequestOptions, additionalCredentialOptions?: IAdditionalCredentialOptions, itemIndex?: number): Promise<any>;
+    /**
+     * @deprecated Use .httpRequestWithAuthentication instead
+     * @see RequestHelperFunctions.requestWithAuthentication
+     */
     requestOAuth1(this: IAllExecuteFunctions, credentialsType: string, requestOptions: IRequestOptions): Promise<any>;
+    /**
+     * @deprecated Use .httpRequestWithAuthentication instead
+     * @see RequestHelperFunctions.requestWithAuthentication
+     */
     requestOAuth2(this: IAllExecuteFunctions, credentialsType: string, requestOptions: IRequestOptions, oAuth2Options?: IOAuth2Options): Promise<any>;
 }
 export type SSHCredentials = {
@@ -550,6 +576,7 @@ export interface FunctionsBase {
     getKnownNodeTypes(): IDataObject;
     getMode?: () => WorkflowExecuteMode;
     getActivationMode?: () => WorkflowActivateMode;
+    /** @deprecated */
     prepareOutputData(outputData: INodeExecutionData[]): Promise<INodeExecutionData[][]>;
 }
 type FunctionsBaseWithRequiredKeys<Keys extends keyof FunctionsBase> = FunctionsBase & {
@@ -581,6 +608,7 @@ export type IExecuteFunctions = ExecuteFunctions.GetNodeParameterFn & BaseExecut
     sendMessageToUI(message: any): void;
     sendResponse(response: IExecuteResponsePromiseData): void;
     sendChunk(type: ChunkType, content?: IDataObject | string): void;
+    isStreaming(): boolean;
     addInputData(connectionType: NodeConnectionType, data: INodeExecutionData[][] | ExecutionError, runIndex?: number): {
         index: number;
     };
@@ -738,6 +766,10 @@ export interface INodeExecutionData {
     metadata?: {
         subExecution: RelatedExecution;
     };
+    /**
+     * @deprecated This key was added by accident and should not be used as it
+     * will be removed in future. For more information see PR #12469.
+     */
     index?: number;
 }
 export type NodeParameterValue = string | number | boolean | undefined | null;
@@ -1103,12 +1135,23 @@ export interface INodeType {
             [method in WebhookSetupMethodNames]: (this: IHookFunctions) => Promise<boolean>;
         };
     };
+    /**
+     * Defines custom operations for nodes that do not implement an `execute` method, such as declarative nodes.
+     * This function will be invoked instead of `execute` for a specific resource and operation.
+     * Should be either `execute` or `customOperations` defined for a node, but not both.
+     *
+     * @property customOperations - Maps specific resource and operation to a custom function
+     */
     customOperations?: {
         [resource: string]: {
             [operation: string]: (this: IExecuteFunctions) => Promise<NodeOutput>;
         };
     };
 }
+/**
+ * This class serves as the base for all nodes using the new context API
+ * having this as a class enables us to identify these instances at runtime
+ */
 export declare abstract class Node {
     abstract description: INodeTypeDescription;
     execute?(context: IExecuteFunctions): Promise<INodeExecutionData[][]>;
@@ -1181,9 +1224,24 @@ export interface INodeTypeBaseDescription {
     defaultVersion?: number;
     codex?: CodexData;
     parameterPane?: 'wide';
+    /**
+     * Whether the node must be hidden in the node creator panel,
+     * due to deprecation or as a special case (e.g. Start node)
+     */
     hidden?: true;
+    /**
+     * Whether the node will be wrapped for tool-use by AI Agents,
+     * optionally replacing provided parts of the description
+     */
     usableAsTool?: true | UsableAsToolDescription;
 }
+/**
+ * NodeDescription entries that replace the base node entries when
+ * the node is used as a tool
+ *
+ * Note that the new codex is hardcoded and may not behave as expected
+ * without additional changes to the implementation.
+ */
 export type UsableAsToolDescription = {
     replacements?: Partial<Omit<INodeTypeBaseDescription, 'usableAsTool'>>;
 };
@@ -1296,6 +1354,9 @@ export interface INodeOutputConfiguration {
 }
 export type ExpressionString = `={{${string}}}`;
 export type NodeDefaults = Partial<{
+    /**
+     * @deprecated Use {@link INodeTypeBaseDescription.iconColor|iconColor} instead. `iconColor` supports dark mode and uses preset colors from n8n's design system.
+     */
     color: string;
     name: string;
 }>;
@@ -1430,7 +1491,9 @@ export type IWorkflowDataProxyAdditionalKeys = IDataObject & {
     $vars?: IDataObject;
     $secrets?: IDataObject;
     $pageCount?: number;
+    /** @deprecated */
     $executionId?: string;
+    /** @deprecated */
     $resumeWebhookUrl?: string;
 };
 export interface IWorkflowMetadata {
@@ -1476,12 +1539,16 @@ export type ICredentialTypeData = LoadedData<ICredentialType>;
 export type INodeTypeData = LoadedData<INodeType | IVersionedNodeType>;
 export interface IRun {
     data: IRunExecutionData;
+    /**
+     * @deprecated Use status instead
+     */
     finished?: boolean;
     mode: WorkflowExecuteMode;
     waitTill?: Date | null;
     startedAt: Date;
     stoppedAt?: Date;
     status: ExecutionStatus;
+    /** ID of the job this execution belongs to. Only in scaling mode. */
     jobId?: string;
 }
 export interface IRunExecutionData {
@@ -1510,6 +1577,7 @@ export interface IRunExecutionData {
     parentExecution?: RelatedExecution;
     waitTill?: Date;
     pushRef?: string;
+    /** Data needed for a worker to run a manual execution. */
     manualData?: Pick<IWorkflowExecutionDataProcess, 'partialExecutionVersion' | 'dirtyNodeNames' | 'triggerToStartFrom' | 'userId'>;
 }
 export interface IRunData {
@@ -1529,12 +1597,15 @@ export interface ITaskMetadata {
     subExecution?: RelatedExecution;
     subExecutionsCount?: number;
 }
+/** The data that gets returned when a node execution starts */
 export interface ITaskStartedData {
     startTime: number;
+    /** This index tracks the order in which nodes are executed */
     executionIndex: number;
     source: Array<ISourceData | null>;
     hints?: NodeExecutionHint[];
 }
+/** The data that gets returned when a node execution ends */
 export interface ITaskData extends ITaskStartedData {
     executionTime: number;
     executionStatus?: ExecutionStatus;
@@ -1593,6 +1664,10 @@ export interface IWorkflowExecutionDataProcess {
     destinationNode?: string;
     restartExecutionId?: string;
     executionMode: WorkflowExecuteMode;
+    /**
+     * The data that is sent in the body of the webhook that started this
+     * execution.
+     */
     executionData?: IRunExecutionData;
     runData?: IRunData;
     pinData?: IPinData;
@@ -1602,6 +1677,12 @@ export interface IWorkflowExecutionDataProcess {
     workflowData: IWorkflowBase;
     userId?: string;
     projectId?: string;
+    /**
+     * Defines which version of the partial execution flow is used.
+     * Possible values are:
+     *  1 - use the old flow
+     *  2 - use the new flow
+     */
     partialExecutionVersion?: 1 | 2;
     dirtyNodeNames?: string[];
     triggerToStartFrom?: {
@@ -1646,6 +1727,7 @@ export interface IWorkflowExecuteAdditionalData {
     currentNodeExecutionIndex: number;
     httpResponse?: express.Response;
     httpRequest?: express.Request;
+    streamingEnabled?: boolean;
     restApiUrl: string;
     instanceBaseUrl: string;
     setExecutionStatus?: (status: ExecutionStatus) => void;
@@ -1858,6 +1940,9 @@ export interface NodeExecutionWithMetadata extends INodeExecutionData {
 export type AnnotationVote = 'up' | 'down';
 export interface ExecutionSummary {
     id: string;
+    /**
+     * @deprecated Use status instead
+     */
     finished?: boolean;
     mode: WorkflowExecuteMode;
     retryOf?: string | null;
@@ -2002,6 +2087,9 @@ export interface ExecutionOptions {
     limit?: number;
 }
 export interface ExecutionFilters {
+    /**
+     * @deprecated Use status instead
+     */
     finished?: boolean;
     mode?: WorkflowExecuteMode[];
     retryOf?: string;
@@ -2081,3 +2169,4 @@ export interface StructuredChunk {
     };
 }
 export {};
+//# sourceMappingURL=interfaces.d.ts.map