@n8n/ai-workflow-builder 0.32.0 → 0.33.0-exp.0

package/dist/tools/utils/markdown-workflow.utils.d.ts

@@ -0,0 +1,14 @@
+import type { NodeConfigurationsMap, WorkflowMetadata } from '../../types';
+export interface MermaidOptions {
+    includeNodeType?: boolean;
+    includeNodeParameters?: boolean;
+    includeNodeName?: boolean;
+    collectNodeConfigurations?: boolean;
+}
+export interface MermaidResult {
+    mermaid: string;
+    nodeConfigurations: NodeConfigurationsMap;
+}
+export declare function mermaidStringify(workflow: WorkflowMetadata, options?: MermaidOptions): string;
+export declare function processWorkflowExamples(workflows: WorkflowMetadata[], options?: Omit<MermaidOptions, 'collectNodeConfigurations'>): MermaidResult[];
+export declare function stickyNotesStringify(workflow: WorkflowMetadata): string;

package/dist/tools/utils/markdown-workflow.utils.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mermaidStringify = mermaidStringify;
+exports.processWorkflowExamples = processWorkflowExamples;
+exports.stickyNotesStringify = stickyNotesStringify;
+const constants_1 = require("../../constants");
+const DEFAULT_MERMAID_OPTIONS = {
+    includeNodeType: true,
+    includeNodeParameters: true,
+    includeNodeName: true,
+    collectNodeConfigurations: false,
+};
+function createNodeIdMap(nodes) {
+    const nodeIdMap = new Map();
+    nodes.forEach((node, idx) => {
+        nodeIdMap.set(node.name, `n${idx + 1}`);
+    });
+    return nodeIdMap;
+}
+function findNodesWithIncomingConnections(connections) {
+    const nodesWithIncoming = new Set();
+    Object.values(connections)
+        .filter((conn) => conn.main)
+        .forEach((sourceConnections) => {
+        for (const connArray of sourceConnections.main) {
+            if (!connArray) {
+                continue;
+            }
+            for (const conn of connArray) {
+                nodesWithIncoming.add(conn.node);
+            }
+        }
+    });
+    return nodesWithIncoming;
+}
+function formatConnectionLine(sourceId, targetId, connType) {
+    return connType === 'main'
+        ? `    ${sourceId} --> ${targetId}`
+        : `    ${sourceId} -.${connType}.-> ${targetId}`;
+}
+function extractNodeConnectionLines(nodeConns, sourceId, nodeIdMap) {
+    return Object.entries(nodeConns).flatMap(([connType, connList]) => connList
+        .filter((connArray) => connArray !== null)
+        .flatMap((connArray) => connArray
+        .map((conn) => {
+        const targetId = nodeIdMap.get(conn.node);
+        return targetId ? formatConnectionLine(sourceId, targetId, connType) : null;
+    })
+        .filter((line) => line !== null)));
+}
+function getMainConnectionTargets(nodeConns) {
+    if (!nodeConns.main)
+        return [];
+    return nodeConns.main
+        .filter((connArray) => connArray !== null)
+        .flatMap((connArray) => connArray.map((conn) => conn.node));
+}
+function buildConnectionLines(connections, nodeIdMap, startNodes) {
+    const visited = new Set();
+    const outputConnections = [];
+    function traverse(nodeName) {
+        if (visited.has(nodeName))
+            return;
+        visited.add(nodeName);
+        const nodeConns = connections[nodeName];
+        if (!nodeConns)
+            return;
+        const sourceId = nodeIdMap.get(nodeName);
+        if (!sourceId)
+            return;
+        outputConnections.push(...extractNodeConnectionLines(nodeConns, sourceId, nodeIdMap));
+        getMainConnectionTargets(nodeConns).forEach((target) => traverse(target));
+    }
+    startNodes.forEach((node) => traverse(node.name));
+    return outputConnections;
+}
+function maybeCollectNodeConfiguration(node, nodeConfigurations) {
+    const hasParams = Object.keys(node.parameters).length > 0;
+    if (!hasParams)
+        return;
+    const parametersStr = JSON.stringify(node.parameters);
+    if (parametersStr.length <= constants_1.MAX_NODE_EXAMPLE_CHARS) {
+        if (!nodeConfigurations[node.type]) {
+            nodeConfigurations[node.type] = [];
+        }
+        nodeConfigurations[node.type].push({
+            version: node.typeVersion,
+            parameters: node.parameters,
+        });
+    }
+}
+function buildNodeDefinitionLines(nodes, nodeIdMap, options, nodeConfigurations) {
+    const lines = [];
+    for (const node of nodes) {
+        const id = nodeIdMap.get(node.name);
+        if (!id)
+            continue;
+        const hasParams = Object.keys(node.parameters).length > 0;
+        if (options.collectNodeConfigurations) {
+            maybeCollectNodeConfiguration(node, nodeConfigurations);
+        }
+        if (options.includeNodeType || options.includeNodeParameters) {
+            const typePart = options.includeNodeType ? node.type : '';
+            const paramsPart = options.includeNodeParameters && hasParams ? ` | ${JSON.stringify(node.parameters)}` : '';
+            if (typePart || paramsPart) {
+                lines.push(`    %% ${typePart}${paramsPart}`);
+            }
+        }
+        if (options.includeNodeName) {
+            lines.push(`    ${id}["${node.name.replace(/"/g, "'")}"]`);
+        }
+        else {
+            lines.push(`    ${id}`);
+        }
+    }
+    return lines;
+}
+function buildMermaidLines(nodes, connections, options = DEFAULT_MERMAID_OPTIONS, existingConfigurations) {
+    const regularNodes = nodes.filter((n) => n.type !== 'n8n-nodes-base.stickyNote');
+    const nodeConfigurations = existingConfigurations ?? {};
+    const nodeIdMap = createNodeIdMap(regularNodes);
+    const nodesWithIncoming = findNodesWithIncomingConnections(connections);
+    const startNodes = regularNodes.filter((n) => !nodesWithIncoming.has(n.name));
+    const connectionLines = buildConnectionLines(connections, nodeIdMap, startNodes);
+    const nodeDefinitionLines = buildNodeDefinitionLines(regularNodes, nodeIdMap, options, nodeConfigurations);
+    const lines = ['```mermaid', 'flowchart TD', ...nodeDefinitionLines, ...connectionLines, '```'];
+    return { lines, nodeConfigurations };
+}
+function mermaidStringify(workflow, options) {
+    const { workflow: wf } = workflow;
+    const mergedOptions = {
+        ...DEFAULT_MERMAID_OPTIONS,
+        ...options,
+    };
+    const result = buildMermaidLines(wf.nodes, wf.connections, mergedOptions);
+    return result.lines.join('\n');
+}
+function processWorkflowExamples(workflows, options) {
+    const mergedOptions = {
+        ...DEFAULT_MERMAID_OPTIONS,
+        ...options,
+        collectNodeConfigurations: true,
+    };
+    const allConfigurations = {};
+    const results = workflows.map((workflow) => {
+        const { workflow: wf } = workflow;
+        const result = buildMermaidLines(wf.nodes, wf.connections, mergedOptions, allConfigurations);
+        return {
+            mermaid: result.lines.join('\n'),
+            nodeConfigurations: result.nodeConfigurations,
+        };
+    });
+    return results;
+}
+function stickyNotesStringify(workflow) {
+    const { workflow: wf } = workflow;
+    const stickyNotes = wf.nodes.filter((node) => node.type === 'n8n-nodes-base.stickyNote');
+    if (stickyNotes.length === 0) {
+        return '';
+    }
+    const lines = [];
+    for (const note of stickyNotes) {
+        const content = note.parameters.content;
+        if (typeof content === 'string' && content) {
+            const contentLines = content.trim().split('\n');
+            const indentedContent = contentLines
+                .map((line, idx) => (idx === 0 ? `- ${line}` : `  ${line}`))
+                .join('\n');
+            lines.push(indentedContent);
+        }
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=markdown-workflow.utils.js.map

package/dist/tools/utils/markdown-workflow.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-workflow.utils.js","sourceRoot":"","sources":["../../../src/tools/utils/markdown-workflow.utils.ts"],"names":[],"mappings":";;AA+OA,4CAQC;AAMD,0DAuBC;AAKD,oDAsBC;AA/SD,2CAAqD;AAyBrD,MAAM,uBAAuB,GAA6B;IACzD,eAAe,EAAE,IAAI;IACrB,qBAAqB,EAAE,IAAI;IAC3B,eAAe,EAAE,IAAI;IACrB,yBAAyB,EAAE,KAAK;CAChC,CAAC;AAgBF,SAAS,eAAe,CAAC,KAAqB;IAC7C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAC3B,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AAClB,CAAC;AAKD,SAAS,gCAAgC,CAAC,WAAgC;IACzE,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;SACxB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;SAC3B,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;QAC9B,KAAK,MAAM,SAAS,IAAI,iBAAiB,CAAC,IAAI,EAAE,CAAC;YAChD,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,SAAS;YACV,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC9B,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IACJ,OAAO,iBAAiB,CAAC;AAC1B,CAAC;AAKD,SAAS,oBAAoB,CAAC,QAAgB,EAAE,QAAgB,EAAE,QAAgB;IACjF,OAAO,QAAQ,KAAK,MAAM;QACzB,CAAC,CAAC,OAAO,QAAQ,QAAQ,QAAQ,EAAE;QACnC,CAAC,CAAC,OAAO,QAAQ,MAAM,QAAQ,OAAO,QAAQ,EAAE,CAAC;AACnD,CAAC;AAKD,SAAS,0BAA0B,CAClC,SAAsC,EACtC,QAAgB,EAChB,SAA8B;IAE9B,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,CACjE,QAAQ;SACN,MAAM,CAAC,CAAC,SAAS,EAA8C,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC;SACrF,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CACtB,SAAS;SACP,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7E,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CACjD,CACF,CAAC;AACH,CAAC;AAKD,SAAS,wBAAwB,CAAC,SAAsC;IACvE,IAAI,CAAC,SAAS,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IAC/B,OAAO,SAAS,CAAC,IAAI;SACnB,MAAM,CAAC,CAAC,SAAS,EAA8C,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC;SACrF,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC;AAKD,SAAS,oBAAoB,CAC5B,WAAgC,EAChC,SAA8B,EAC9B,UAA0B;IAE1B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,iBAAiB,GAAa,EAAE,CAAC;IAEvC,SAAS,QAAQ,CAAC,QAAgB;QACjC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,OAAO;QAClC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEtB,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ;YAAE,OAAO;QAEtB,iBAAiB,CAAC,IAAI,CAAC,GAAG,0BAA0B,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;QACtF,wBAAwB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,OAAO,iBAAiB,CAAC;AAC1B,CAAC;AAKD,SAAS,6BAA6B,CACrC,IAAkB,EAClB,kBAAyC;IAEzC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1D,IAAI,CAAC,SAAS;QAAE,OAAO;IAEvB,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtD,IAAI,aAAa,CAAC,MAAM,IAAI,kCAAsB,EAAE,CAAC;QACpD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,CAAC;QACD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;YAClC,OAAO,EAAE,IAAI,CAAC,WAAW;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC3B,CAAC,CAAC;IACJ,CAAC;AACF,CAAC;AAKD,SAAS,wBAAwB,CAChC,KAAqB,EACrB,SAA8B,EAC9B,OAAiC,EACjC,kBAAyC;IAEzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,EAAE;YAAE,SAAS;QAElB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1D,IAAI,OAAO,CAAC,yBAAyB,EAAE,CAAC;YACvC,6BAA6B,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1D,MAAM,UAAU,GACf,OAAO,CAAC,qBAAqB,IAAI,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAE3F,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;gBAC5B,KAAK,CAAC,IAAI,CAAC,UAAU,QAAQ,GAAG,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC;QACF,CAAC;QAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAKD,SAAS,iBAAiB,CACzB,KAA4C,EAC5C,WAAgC,EAChC,UAAoC,uBAAuB,EAC3D,sBAA8C;IAE9C,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,2BAA2B,CAAC,CAAC;IACjF,MAAM,kBAAkB,GAA0B,sBAAsB,IAAI,EAAE,CAAC;IAE/E,MAAM,SAAS,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;IAChD,MAAM,iBAAiB,GAAG,gCAAgC,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,MAAM,eAAe,GAAG,oBAAoB,CAAC,WAAW,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IACjF,MAAM,mBAAmB,GAAG,wBAAwB,CACnD,YAAY,EACZ,SAAS,EACT,OAAO,EACP,kBAAkB,CAClB,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,YAAY,EAAE,cAAc,EAAE,GAAG,mBAAmB,EAAE,GAAG,eAAe,EAAE,KAAK,CAAC,CAAC;IAEhG,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AACtC,CAAC;AAKD,SAAgB,gBAAgB,CAAC,QAA0B,EAAE,OAAwB;IACpF,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;IAClC,MAAM,aAAa,GAA6B;QAC/C,GAAG,uBAAuB;QAC1B,GAAG,OAAO;KACV,CAAC;IACF,MAAM,MAAM,GAAG,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAMD,SAAgB,uBAAuB,CACtC,SAA6B,EAC7B,OAA2D;IAE3D,MAAM,aAAa,GAA6B;QAC/C,GAAG,uBAAuB;QAC1B,GAAG,OAAO;QACV,yBAAyB,EAAE,IAAI;KAC/B,CAAC;IAGF,MAAM,iBAAiB,GAA0B,EAAE,CAAC;IAEpD,MAAM,OAAO,GAAoB,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3D,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;QAClC,MAAM,MAAM,GAAG,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;QAC7F,OAAO;YACN,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;YAChC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;SAC7C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AAChB,CAAC;AAKD,SAAgB,oBAAoB,CAAC,QAA0B;IAC9D,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;IAClC,MAAM,WAAW,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,2BAA2B,CAAC,CAAC;IAEzF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC;IACX,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;QACxC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,EAAE,CAAC;YAE5C,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChD,MAAM,eAAe,GAAG,YAAY;iBAClC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;iBAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/tools/utils/test/workflows/ai-assistant.workflow.d.ts

@@ -0,0 +1,2 @@
+import type { WorkflowMetadata } from '../../../../types';
+export declare const aiAssistantWorkflow: WorkflowMetadata;