flowlint 0.3.1 → 0.3.3

package/dist/packages/review/rules/index.js

@@ -0,0 +1,313 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAllRules = runAllRules;
+const rule_utils_1 = require("./rule-utils");
+const utils_1 = require("../utils");
+// --- Rule Definitions using Helpers ---
+const r1Retry = (0, rule_utils_1.createNodeRule)('R1', 'rate_limit_retry', (node, graph, ctx) => {
+    if (!(0, utils_1.isApiNode)(node.type))
+        return null;
+    const params = (node.params ?? {});
+    const options = (params.options ?? {});
+    const retryCandidates = [
+        options.retryOnFail,
+        params.retryOnFail,
+        node.flags?.retryOnFail,
+    ];
+    const retryOnFail = retryCandidates.find((value) => value !== undefined && value !== null);
+    if (retryOnFail === true) {
+        return null;
+    }
+    if (typeof retryOnFail === 'string') {
+        const normalized = retryOnFail.trim().toLowerCase();
+        if (retryOnFail.includes('{{') || normalized === 'true') {
+            return null;
+        }
+    }
+    return {
+        rule: 'R1',
+        severity: 'must',
+        path: ctx.path,
+        message: `Node ${node.name || node.id} is missing retry/backoff configuration`,
+        raw_details: `In the node properties, enable "Retry on Fail" under Options.`,
+        nodeId: node.id,
+        line: ctx.nodeLines?.[node.id],
+    };
+});
+const r2ErrorHandling = (0, rule_utils_1.createNodeRule)('R2', 'error_handling', (node, graph, ctx) => {
+    if (ctx.cfg.rules.error_handling.forbid_continue_on_fail && node.flags?.continueOnFail) {
+        return {
+            rule: 'R2',
+            severity: 'must',
+            path: ctx.path,
+            message: `Node ${node.name || node.id} has continueOnFail enabled (disable it and route errors explicitly)`,
+            nodeId: node.id,
+            line: ctx.nodeLines?.[node.id],
+            raw_details: 'Open the node in n8n and disable "Continue On Fail" (Options > Continue On Fail). Route failures down an explicit error branch instead.',
+        };
+    }
+    return null;
+});
+const r4Secrets = (0, rule_utils_1.createHardcodedStringRule)({
+    ruleId: 'R4',
+    severity: 'must',
+    configKey: 'secrets',
+    messageFn: (node) => `Node ${node.name || node.id} contains a hardcoded secret (move it to credentials/env vars)`,
+    details: 'Move API keys/tokens into Credentials or environment variables; the workflow should only reference {{$credentials.*}} expressions.',
+});
+const r9ConfigLiterals = (0, rule_utils_1.createHardcodedStringRule)({
+    ruleId: 'R9',
+    severity: 'should',
+    configKey: 'config_literals',
+    messageFn: (node, value) => `Node ${node.name || node.id} contains env-specific literal "${value.substring(0, 40)}" (move to expression/credential)`,
+    details: 'Move environment-specific URLs/IDs into expressions or credentials (e.g., {{$env.API_BASE_URL}}) so the workflow is portable.',
+});
+const r10NamingConvention = (0, rule_utils_1.createNodeRule)('R10', 'naming_convention', (node, graph, ctx) => {
+    const genericNames = new Set(ctx.cfg.rules.naming_convention.generic_names ?? []);
+    if (!node.name || genericNames.has(node.name.toLowerCase())) {
+        return {
+            rule: 'R10',
+            severity: 'nit',
+            path: ctx.path,
+            message: `Node ${node.id} uses a generic name "${node.name ?? ''}" (rename it to describe the action)`,
+            nodeId: node.id,
+            line: ctx.nodeLines?.[node.id],
+            raw_details: 'Rename the node to describe its purpose (e.g., "Check subscription status" instead of "IF") for easier reviews and debugging.',
+        };
+    }
+    return null;
+});
+const DEPRECATED_NODES = {
+    'n8n-nodes-base.splitInBatches': 'Use Loop over items instead',
+    'n8n-nodes-base.executeWorkflow': 'Use Execute Workflow (Sub-Workflow) instead',
+};
+const r11DeprecatedNodes = (0, rule_utils_1.createNodeRule)('R11', 'deprecated_nodes', (node, graph, ctx) => {
+    if (DEPRECATED_NODES[node.type]) {
+        return {
+            rule: 'R11',
+            severity: 'should',
+            path: ctx.path,
+            message: `Node ${node.name || node.id} uses deprecated type ${node.type} (replace with ${DEPRECATED_NODES[node.type]})`,
+            nodeId: node.id,
+            line: ctx.nodeLines?.[node.id],
+            raw_details: `Replace this node with ${DEPRECATED_NODES[node.type]} so future n8n upgrades don’t break the workflow.`,
+        };
+    }
+    return null;
+});
+const r12UnhandledErrorPath = (0, rule_utils_1.createNodeRule)('R12', 'unhandled_error_path', (node, graph, ctx) => {
+    if (!(0, utils_1.isErrorProneNode)(node.type))
+        return null;
+    const hasErrorPath = graph.edges.some((edge) => {
+        if (edge.from !== node.id)
+            return false;
+        if (edge.on === 'error')
+            return true;
+        const targetNode = graph.nodes.find((candidate) => candidate.id === edge.to);
+        return targetNode ? (0, utils_1.isErrorHandlerNode)(targetNode.type, targetNode.name) : false;
+    });
+    if (!hasErrorPath) {
+        return {
+            rule: 'R12',
+            severity: 'must',
+            path: ctx.path,
+            message: `Node ${node.name || node.id} has no error branch (add a red connector to handler)`,
+            nodeId: node.id,
+            line: ctx.nodeLines?.[node.id],
+            raw_details: 'Add an error (red) branch to a Stop and Error or logging/alert node so failures do not disappear silently.',
+        };
+    }
+    return null;
+});
+// --- Rules with custom logic (not fitting the simple node-by-node pattern) ---
+function r3Idempotency(graph, ctx) {
+    const cfg = ctx.cfg.rules.idempotency;
+    if (!cfg?.enabled)
+        return [];
+    const hasIngress = graph.nodes.some((node) => /webhook|trigger|start/i.test(node.type));
+    if (!hasIngress)
+        return [];
+    const mutationNodes = graph.nodes.filter((node) => (0, utils_1.isMutationNode)(node.type));
+    if (!mutationNodes.length)
+        return [];
+    const findings = [];
+    for (const mutationNode of mutationNodes) {
+        const upstreamNodeIds = (0, utils_1.findAllUpstreamNodes)(graph, mutationNode.id);
+        const upstreamNodes = graph.nodes.filter((n) => upstreamNodeIds.has(n.id));
+        const hasGuard = upstreamNodes.some((p) => (0, utils_1.containsCandidate)(p.params, cfg.key_field_candidates));
+        if (!hasGuard) {
+            findings.push({
+                rule: 'R3',
+                severity: 'must',
+                path: ctx.path,
+                message: `The mutation path ending at "${mutationNode.name || mutationNode.id}" appears to be missing an idempotency guard.`,
+                raw_details: `Ensure one of the upstream nodes or the mutation node itself uses an idempotency key, such as one of: ${cfg.key_field_candidates.join(', ')}`,
+                nodeId: mutationNode.id,
+                line: ctx.nodeLines?.[mutationNode.id],
+            });
+        }
+    }
+    return findings;
+}
+function r5DeadEnds(graph, ctx) {
+    const cfg = ctx.cfg.rules.dead_ends;
+    if (!cfg?.enabled)
+        return [];
+    if (graph.nodes.length <= 1)
+        return [];
+    const outgoing = new Map();
+    for (const node of graph.nodes)
+        outgoing.set(node.id, 0);
+    for (const edge of graph.edges)
+        outgoing.set(edge.from, (outgoing.get(edge.from) || 0) + 1);
+    const findings = [];
+    for (const node of graph.nodes) {
+        if ((outgoing.get(node.id) || 0) === 0 && !(0, utils_1.isTerminalNode)(node.type, node.name)) {
+            findings.push({
+                rule: 'R5',
+                severity: 'nit',
+                path: ctx.path,
+                message: `Node ${node.name || node.id} has no outgoing connections (either wire it up or remove it)`,
+                nodeId: node.id,
+                line: ctx.nodeLines?.[node.id],
+                raw_details: 'Either remove this node as dead code or connect it to the next/safe step so the workflow can continue.',
+            });
+        }
+    }
+    return findings;
+}
+function r6LongRunning(graph, ctx) {
+    const cfg = ctx.cfg.rules.long_running;
+    if (!cfg?.enabled)
+        return [];
+    const findings = [];
+    const loopNodes = graph.nodes.filter((node) => /loop|batch|while|repeat/i.test(node.type));
+    for (const node of loopNodes) {
+        const iterations = (0, utils_1.readNumber)(node.params, [
+            'maxIterations',
+            'maxIteration',
+            'limit',
+            'options.maxIterations',
+        ]);
+        if (!iterations || (cfg.max_iterations && iterations > cfg.max_iterations)) {
+            findings.push({
+                rule: 'R6',
+                severity: 'should',
+                path: ctx.path,
+                message: `Node ${node.name || node.id} allows ${iterations ?? 'unbounded'} iterations (limit ${cfg.max_iterations}; set a lower cap)`,
+                nodeId: node.id,
+                line: ctx.nodeLines?.[node.id],
+                raw_details: `Set Options > Max iterations to ≤ ${cfg.max_iterations} or split the processing into smaller batches.`,
+            });
+        }
+        if (cfg.timeout_ms) {
+            const timeout = (0, utils_1.readNumber)(node.params, ['timeout', 'timeoutMs', 'options.timeout']);
+            if (timeout && timeout > cfg.timeout_ms) {
+                findings.push({
+                    rule: 'R6',
+                    severity: 'should',
+                    path: ctx.path,
+                    message: `Node ${node.name || node.id} uses timeout ${timeout}ms (limit ${cfg.timeout_ms}ms; shorten the timeout or break work apart)`,
+                    nodeId: node.id,
+                    line: ctx.nodeLines?.[node.id],
+                    raw_details: `Lower the timeout to ≤ ${cfg.timeout_ms}ms or split the workflow so no single step blocks for too long.`,
+                });
+            }
+        }
+    }
+    return findings;
+}
+function r7AlertLogEnforcement(graph, ctx) {
+    const cfg = ctx.cfg.rules.alert_log_enforcement;
+    if (!cfg?.enabled)
+        return [];
+    const findings = [];
+    const errorEdges = graph.edges.filter((edge) => edge.on === 'error');
+    for (const edge of errorEdges) {
+        const fromNode = graph.nodes.find((n) => n.id === edge.from);
+        let isHandled = false;
+        const queue = [edge.to];
+        const visited = new Set([edge.to]);
+        let head = 0;
+        while (head < queue.length) {
+            const currentId = queue[head++];
+            const currentNode = graph.nodes.find((n) => n.id === currentId);
+            if ((0, utils_1.isNotificationNode)(currentNode.type)) {
+                isHandled = true;
+                break; // Found a handler, stop searching this path
+            }
+            if ((0, utils_1.isRejoinNode)(graph, currentId)) {
+                continue; // It's a rejoin point, but not a handler, so stop traversing this path
+            }
+            // Add successors to queue
+            const outgoing = graph.edges.filter((e) => e.from === currentId);
+            for (const outEdge of outgoing) {
+                if (!visited.has(outEdge.to)) {
+                    visited.add(outEdge.to);
+                    queue.push(outEdge.to);
+                }
+            }
+        }
+        if (!isHandled) {
+            findings.push({
+                rule: 'R7',
+                severity: 'should',
+                path: ctx.path,
+                message: `Error path from node ${fromNode.name || fromNode.id} has no log/alert before rejoining (add notification node)`,
+                nodeId: fromNode.id,
+                line: ctx.nodeLines?.[fromNode.id],
+                raw_details: 'Add a Slack/Email/Log node on the error branch before it rejoins the main flow so failures leave an audit trail.',
+            });
+        }
+    }
+    return findings;
+}
+function r8UnusedData(graph, ctx) {
+    const cfg = ctx.cfg.rules.unused_data;
+    if (!cfg?.enabled)
+        return [];
+    const findings = [];
+    for (const node of graph.nodes) {
+        // If a node has no successors, R5 handles it. If it's a terminal node, its "use" is to end the flow.
+        if ((0, utils_1.isTerminalNode)(node.type, node.name) || !graph.edges.some((e) => e.from === node.id)) {
+            continue;
+        }
+        const downstreamNodes = (0, utils_1.findAllDownstreamNodes)(graph, node.id);
+        downstreamNodes.delete(node.id);
+        const leadsToConsumer = [...downstreamNodes].some((id) => {
+            const downstreamNode = graph.nodes.find((n) => n.id === id);
+            return (0, utils_1.isMeaningfulConsumer)(downstreamNode);
+        });
+        if (!leadsToConsumer) {
+            findings.push({
+                rule: 'R8',
+                severity: 'nit',
+                path: ctx.path,
+                message: `Node "${node.name || node.id}" produces data that never reaches any consumer`,
+                nodeId: node.id,
+                line: ctx.nodeLines?.[node.id],
+                raw_details: 'Wire this branch into a consumer (DB/API/response) or remove it—otherwise the data produced here is never used.',
+            });
+        }
+    }
+    return findings;
+}
+// --- Rule Registration ---
+const rules = [
+    r1Retry,
+    r2ErrorHandling,
+    r3Idempotency,
+    r4Secrets,
+    r5DeadEnds,
+    r6LongRunning,
+    r7AlertLogEnforcement,
+    r8UnusedData,
+    r9ConfigLiterals,
+    r10NamingConvention,
+    r11DeprecatedNodes,
+    r12UnhandledErrorPath,
+];
+function runAllRules(graph, ctx) {
+    return rules.flatMap((rule) => rule(graph, ctx));
+}
+//# sourceMappingURL=index.js.map

package/dist/packages/review/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/review/rules/index.ts"],"names":[],"mappings":";;AAyXA,kCAEC;AAzXD,6CAAyE;AACzE,oCAakB;AAMlB,yCAAyC;AAEzC,MAAM,OAAO,GAAG,IAAA,2BAAc,EAAC,IAAI,EAAE,kBAAkB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IAC5E,IAAI,CAAC,IAAA,iBAAS,EAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAEvC,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAA4B,CAAC;IAC9D,MAAM,OAAO,GAAG,CAAE,MAAc,CAAC,OAAO,IAAI,EAAE,CAA4B,CAAC;IAE3E,MAAM,eAAe,GAAc;QACjC,OAAO,CAAC,WAAW;QAClB,MAAc,CAAC,WAAW;QAC3B,IAAI,CAAC,KAAK,EAAE,WAAW;KACxB,CAAC;IAEF,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC;IAE3F,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpD,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,yCAAyC;QAC9E,WAAW,EAAE,+DAA+D;QAC5E,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;KAC/B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,IAAA,2BAAc,EAAC,IAAI,EAAE,gBAAgB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IAClF,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,uBAAuB,IAAI,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;QACvF,OAAO;YACL,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,sEAAsE;YAC3G,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,WAAW,EACT,yIAAyI;SAC5I,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,IAAA,sCAAyB,EAAC;IAC1C,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,gEAAgE;IACjH,OAAO,EAAE,oIAAoI;CAC9I,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,IAAA,sCAAyB,EAAC;IACjD,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,iBAAiB;IAC5B,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,mCAAmC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC;IACpJ,OAAO,EAAE,+HAA+H;CACzI,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,IAAA,2BAAc,EAAC,KAAK,EAAE,mBAAmB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IAC1F,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;IAClF,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC5D,OAAO;YACL,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,QAAQ,IAAI,CAAC,EAAE,yBAAyB,IAAI,CAAC,IAAI,IAAI,EAAE,sCAAsC;YACtG,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,WAAW,EAAE,+HAA+H;SAC7I,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAA2B;IAC/C,+BAA+B,EAAE,6BAA6B;IAC9D,gCAAgC,EAAE,6CAA6C;CAChF,CAAC;AAEF,MAAM,kBAAkB,GAAG,IAAA,2BAAc,EAAC,KAAK,EAAE,kBAAkB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IACxF,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,yBAAyB,IAAI,CAAC,IAAI,kBAAkB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YACvH,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,WAAW,EAAE,0BAA0B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mDAAmD;SACtH,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,IAAA,2BAAc,EAAC,KAAK,EAAE,sBAAsB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IAC/F,IAAI,CAAC,IAAA,wBAAgB,EAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9C,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7C,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QAErC,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7E,OAAO,UAAU,CAAC,CAAC,CAAC,IAAA,0BAAkB,EAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO;YACL,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,uDAAuD;YAC5F,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,WAAW,EACT,4GAA4G;SAC/G,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAGH,gFAAgF;AAEhF,SAAS,aAAa,CAAC,KAAY,EAAE,GAAgB;IACnD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC;IACtC,IAAI,CAAC,GAAG,EAAE,OAAO;QAAE,OAAO,EAAE,CAAC;IAE7B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxF,IAAI,CAAC,UAAU;QAAE,OAAO,EAAE,CAAC;IAE3B,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,IAAI,CAAC,aAAa,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAErC,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,MAAM,eAAe,GAAG,IAAA,4BAAoB,EAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;QACrE,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACxC,IAAA,yBAAiB,EAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,oBAAoB,CAAC,CACtD,CAAC;QAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,gCACP,YAAY,CAAC,IAAI,IAAI,YAAY,CAAC,EACpC,+CAA+C;gBAC/C,WAAW,EAAE,yGAAyG,GAAG,CAAC,oBAAoB,CAAC,IAAI,CACjJ,IAAI,CACL,EAAE;gBACH,MAAM,EAAE,YAAY,CAAC,EAAE;gBACvB,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,KAAY,EAAE,GAAgB;IAChD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC;IACpC,IAAI,CAAC,GAAG,EAAE,OAAO;QAAE,OAAO,EAAE,CAAC;IAC7B,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAEvC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK;QAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK;QAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAE5F,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChF,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,KAAK;gBACf,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,+DAA+D;gBACpG,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,WAAW,EAAE,wGAAwG;aACtH,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,KAAY,EAAE,GAAgB;IACnD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC;IACvC,IAAI,CAAC,GAAG,EAAE,OAAO;QAAE,OAAO,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3F,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,MAAM,EAAE;YACzC,eAAe;YACf,cAAc;YACd,OAAO;YACP,uBAAuB;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,cAAc,IAAI,UAAU,GAAG,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;YAC3E,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,QAAQ;gBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,WACnC,UAAU,IAAI,WAChB,sBAAsB,GAAG,CAAC,cAAc,oBAAoB;gBAC5D,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,WAAW,EAAE,qCAAqC,GAAG,CAAC,cAAc,gDAAgD;aACrH,CAAC,CAAC;QACL,CAAC;QAED,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC;YACrF,IAAI,OAAO,IAAI,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;gBACtC,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,IAAI;oBACV,QAAQ,EAAE,QAAQ;oBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,OAAO,EAAE,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,iBAAiB,OAAO,aAC3D,GAAG,CAAC,UACN,8CAA8C;oBAChD,MAAM,EAAE,IAAI,CAAC,EAAE;oBACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,WAAW,EAAE,0BAA0B,GAAG,CAAC,UAAU,iEAAiE;iBACvH,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAY,EAAE,GAAgB;IAC3D,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,OAAO;QAAE,OAAO,EAAE,CAAC;IAE7B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;IAErE,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAE,CAAC;QAC9D,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,MAAM,KAAK,GAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAE3C,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,OAAO,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,EAAE,CAAE,CAAC;YACjC,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAE,CAAC;YAEjE,IAAI,IAAA,0BAAkB,EAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,SAAS,GAAG,IAAI,CAAC;gBACjB,MAAM,CAAC,4CAA4C;YACrD,CAAC;YAED,IAAI,IAAA,oBAAY,EAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;gBACnC,SAAS,CAAC,uEAAuE;YACnF,CAAC;YAED,0BAA0B;YAC1B,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YACjE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC7B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACxB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,QAAQ;gBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,wBACP,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,EAC5B,4DAA4D;gBAC5D,MAAM,EAAE,QAAQ,CAAC,EAAE;gBACnB,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,WAAW,EAAE,kHAAkH;aAChI,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,YAAY,CAAC,KAAY,EAAE,GAAgB;IAClD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC;IACtC,IAAI,CAAC,GAAG,EAAE,OAAO;QAAE,OAAO,EAAE,CAAC;IAE7B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,qGAAqG;QACrG,IAAI,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACzF,SAAS;QACX,CAAC;QAED,MAAM,eAAe,GAAG,IAAA,8BAAsB,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEhC,MAAM,eAAe,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;YACvD,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAE,CAAC;YAC7D,OAAO,IAAA,4BAAoB,EAAC,cAAc,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,KAAK;gBACf,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,SAAS,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,iDAAiD;gBACvF,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,WAAW,EAAE,iHAAiH;aAC/H,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,4BAA4B;AAE5B,MAAM,KAAK,GAAiB;IAC1B,OAAO;IACP,eAAe;IACf,aAAa;IACb,SAAS;IACT,UAAU;IACV,aAAa;IACb,qBAAqB;IACrB,YAAY;IACZ,gBAAgB;IAChB,mBAAmB;IACnB,kBAAkB;IAClB,qBAAqB;CACtB,CAAC;AAEF,SAAgB,WAAW,CAAC,KAAY,EAAE,GAAgB;IACxD,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AACnD,CAAC"}

package/dist/packages/review/rules/rule-utils.d.ts

@@ -0,0 +1,36 @@
+import type { Graph, Finding, NodeRef, FindingSeverity } from '../types';
+import type { FlowLintConfig } from '../../config/flowlint-config';
+type Rule = string;
+type RuleContext = {
+    path: string;
+    cfg: FlowLintConfig;
+    nodeLines?: Record<string, number>;
+};
+type RuleRunner = (graph: Graph, ctx: RuleContext) => Finding[];
+type NodeRuleLogic = (node: NodeRef, graph: Graph, ctx: RuleContext) => Finding | Finding[] | null;
+/**
+ * A higher-order function to create a rule that iterates over each node in the graph.
+ * It abstracts the boilerplate of checking if the rule is enabled and iterating through nodes.
+ *
+ * @param ruleId - The ID of the rule (e.g., 'R1').
+ * @param configKey - The key in the FlowLintConfig rules object.
+ * @param logic - The function containing the core logic to be executed for each node.
+ * @returns A RuleRunner function.
+ */
+export declare function createNodeRule(ruleId: Rule, configKey: keyof FlowLintConfig['rules'], logic: NodeRuleLogic): RuleRunner;
+type HardcodedStringRuleOptions = {
+    ruleId: Rule;
+    severity: FindingSeverity;
+    configKey: 'secrets' | 'config_literals';
+    messageFn: (node: NodeRef, value: string) => string;
+    details: string;
+};
+/**
+ * Creates a rule that checks for hardcoded strings in node parameters based on a denylist of regex patterns.
+ * This is used to create R4 (Secrets) and R9 (Config Literals).
+ *
+ * @param options - The configuration for the hardcoded string rule.
+ * @returns A RuleRunner function.
+ */
+export declare function createHardcodedStringRule({ ruleId, severity, configKey, messageFn, details, }: HardcodedStringRuleOptions): RuleRunner;
+export {};

package/dist/packages/review/rules/rule-utils.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodeRule = createNodeRule;
+exports.createHardcodedStringRule = createHardcodedStringRule;
+const utils_1 = require("../utils");
+/**
+ * A higher-order function to create a rule that iterates over each node in the graph.
+ * It abstracts the boilerplate of checking if the rule is enabled and iterating through nodes.
+ *
+ * @param ruleId - The ID of the rule (e.g., 'R1').
+ * @param configKey - The key in the FlowLintConfig rules object.
+ * @param logic - The function containing the core logic to be executed for each node.
+ * @returns A RuleRunner function.
+ */
+function createNodeRule(ruleId, configKey, logic) {
+    return (graph, ctx) => {
+        const ruleConfig = ctx.cfg.rules[configKey];
+        if (!ruleConfig?.enabled) {
+            return [];
+        }
+        const findings = [];
+        for (const node of graph.nodes) {
+            const result = logic(node, graph, ctx);
+            if (result) {
+                if (Array.isArray(result)) {
+                    findings.push(...result);
+                }
+                else {
+                    findings.push(result);
+                }
+            }
+        }
+        return findings;
+    };
+}
+/**
+ * Creates a rule that checks for hardcoded strings in node parameters based on a denylist of regex patterns.
+ * This is used to create R4 (Secrets) and R9 (Config Literals).
+ *
+ * @param options - The configuration for the hardcoded string rule.
+ * @returns A RuleRunner function.
+ */
+function createHardcodedStringRule({ ruleId, severity, configKey, messageFn, details, }) {
+    const logic = (node, graph, ctx) => {
+        const cfg = ctx.cfg.rules[configKey];
+        if (!cfg.denylist_regex?.length) {
+            return null;
+        }
+        const regexes = cfg.denylist_regex.map((pattern) => (0, utils_1.toRegex)(pattern));
+        const findings = [];
+        const strings = (0, utils_1.collectStrings)(node.params);
+        for (const value of strings) {
+            // Ignore expressions and empty strings
+            if (!value || value.includes('{{')) {
+                continue;
+            }
+            if (regexes.some((regex) => regex.test(value))) {
+                findings.push({
+                    rule: ruleId,
+                    severity,
+                    path: ctx.path,
+                    message: messageFn(node, value),
+                    nodeId: node.id,
+                    line: ctx.nodeLines?.[node.id],
+                    raw_details: details,
+                });
+                // Only report one finding per node to avoid noise
+                break;
+            }
+        }
+        return findings;
+    };
+    return createNodeRule(ruleId, configKey, logic);
+}
+//# sourceMappingURL=rule-utils.js.map

package/dist/packages/review/rules/rule-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-utils.js","sourceRoot":"","sources":["../../../../packages/review/rules/rule-utils.ts"],"names":[],"mappings":";;AAkBA,wCAwBC;AAiBD,8DAyCC;AAlGD,oCAAmD;AAOnD;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAC5B,MAAY,EACZ,SAAwC,EACxC,KAAoB;IAEpB,OAAO,CAAC,KAAY,EAAE,GAAgB,EAAa,EAAE;QACnD,MAAM,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAA0B,CAAC;QACrE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC;AAUD;;;;;;GAMG;AACH,SAAgB,yBAAyB,CAAC,EACxC,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO,GACoB;IAC3B,MAAM,KAAK,GAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAChD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,eAAO,EAAC,OAAO,CAAC,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAA,sBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,uCAAuC;YACvC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YAED,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC/C,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,MAAM;oBACZ,QAAQ;oBACR,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,OAAO,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;oBAC/B,MAAM,EAAE,IAAI,CAAC,EAAE;oBACf,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,WAAW,EAAE,OAAO;iBACrB,CAAC,CAAC;gBACH,kDAAkD;gBAClD,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,OAAO,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC"}

package/dist/packages/review/schemas/index.d.ts

@@ -0,0 +1,17 @@
+export declare class ValidationError extends Error {
+    errors: Array<{
+        path: string;
+        message: string;
+        suggestion?: string;
+    }>;
+    constructor(errors: Array<{
+        path: string;
+        message: string;
+        suggestion?: string;
+    }>);
+}
+/**
+ * Validate n8n workflow structure
+ * Throws ValidationError with detailed messages if validation fails
+ */
+export declare function validateN8nWorkflow(data: any): void;

package/dist/packages/review/schemas/index.js

@@ -0,0 +1,139 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+exports.validateN8nWorkflow = validateN8nWorkflow;
+const ajv_1 = __importDefault(require("ajv"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const n8n_workflow_schema_json_1 = __importDefault(require("./n8n-workflow.schema.json"));
+const utils_1 = require("../utils");
+// Custom error class for validation failures
+class ValidationError extends Error {
+    constructor(errors) {
+        super(`Workflow validation failed: ${errors.length} error(s)`);
+        this.errors = errors;
+        this.name = 'ValidationError';
+    }
+}
+exports.ValidationError = ValidationError;
+// Create and configure AJV instance
+const ajv = new ajv_1.default({
+    allErrors: true,
+    strict: false,
+    verbose: true,
+});
+(0, ajv_formats_1.default)(ajv);
+// Compile the schema
+const validate = ajv.compile(n8n_workflow_schema_json_1.default);
+/**
+ * Throws a ValidationError if the provided set contains items.
+ * Centralizes the pattern of checking validation results and throwing errors.
+ *
+ * @param items - Set of items that represent validation failures
+ * @param config - Configuration for building error messages
+ * @throws ValidationError if items set is not empty
+ */
+function throwIfInvalid(items, config) {
+    if (items.size > 0) {
+        const errors = (0, utils_1.buildValidationErrors)(items, config);
+        throw new ValidationError(errors);
+    }
+}
+/**
+ * Check for duplicate node IDs in the workflow
+ */
+function checkDuplicateNodeIds(data) {
+    if (!Array.isArray(data.nodes))
+        return;
+    const seen = new Set();
+    const duplicates = new Set();
+    for (const node of data.nodes) {
+        if (node.id && seen.has(node.id)) {
+            duplicates.add(node.id);
+        }
+        if (node.id) {
+            seen.add(node.id);
+        }
+    }
+    throwIfInvalid(duplicates, {
+        path: 'nodes[].id',
+        messageTemplate: (id) => `Duplicate node ID: "${id}"`,
+        suggestionTemplate: (id) => `Each node must have a unique ID. Remove or rename the duplicate node with ID "${id}".`,
+    });
+}
+/**
+ * Check for orphaned connections (references to non-existent nodes)
+ */
+function checkOrphanedConnections(data) {
+    if (!data.connections || !Array.isArray(data.nodes))
+        return;
+    const nodeIds = new Set();
+    const nodeNames = new Set();
+    // Collect all node IDs and names
+    for (const node of data.nodes) {
+        if (node.id)
+            nodeIds.add(node.id);
+        if (node.name)
+            nodeNames.add(node.name);
+    }
+    const orphanedRefs = new Set();
+    // Check all connection targets
+    Object.entries(data.connections).forEach(([sourceId, channels]) => {
+        // Check if source exists
+        if (!nodeIds.has(sourceId) && !nodeNames.has(sourceId)) {
+            orphanedRefs.add(sourceId);
+        }
+        // Check targets
+        if (typeof channels === 'object' && channels !== null) {
+            Object.values(channels).forEach((connArray) => {
+                const flatConnections = (0, utils_1.flattenConnections)(connArray);
+                flatConnections.forEach((conn) => {
+                    if (conn?.node) {
+                        if (!nodeIds.has(conn.node) && !nodeNames.has(conn.node)) {
+                            orphanedRefs.add(conn.node);
+                        }
+                    }
+                });
+            });
+        }
+    });
+    throwIfInvalid(orphanedRefs, {
+        path: 'connections',
+        messageTemplate: (ref) => `Orphaned connection reference: "${ref}"`,
+        suggestionTemplate: (ref) => `Connection references node "${ref}" which does not exist. Add the missing node or remove the invalid connection.`,
+    });
+}
+/**
+ * Validate n8n workflow structure
+ * Throws ValidationError with detailed messages if validation fails
+ */
+function validateN8nWorkflow(data) {
+    // Basic schema validation
+    if (!validate(data)) {
+        const errors = (validate.errors || []).map((err) => {
+            const path = err.instancePath || err.schemaPath;
+            const message = err.message || 'Validation error';
+            let suggestion = '';
+            // Provide helpful suggestions based on error type
+            if (err.keyword === 'required') {
+                const missing = err.params?.missingProperty;
+                suggestion = `Add the required field "${missing}" to the workflow.`;
+            }
+            else if (err.keyword === 'type') {
+                const expected = err.params?.type;
+                suggestion = `The field should be of type "${expected}".`;
+            }
+            else if (err.keyword === 'minLength') {
+                suggestion = 'This field cannot be empty.';
+            }
+            return { path, message, suggestion };
+        });
+        throw new ValidationError(errors);
+    }
+    // Additional custom validations
+    checkDuplicateNodeIds(data);
+    checkOrphanedConnections(data);
+}
+//# sourceMappingURL=index.js.map

package/dist/packages/review/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/review/schemas/index.ts"],"names":[],"mappings":";;;;;;AA+HA,kDA4BC;AA3JD,8CAAsB;AACtB,8DAAqC;AACrC,0FAAwD;AACxD,oCAAqE;AAErE,6CAA6C;AAC7C,MAAa,eAAgB,SAAQ,KAAK;IACxC,YACS,MAIL;QAEF,KAAK,CAAC,+BAA+B,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC;QANxD,WAAM,GAAN,MAAM,CAIX;QAGF,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAXD,0CAWC;AAED,oCAAoC;AACpC,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC;IAClB,SAAS,EAAE,IAAI;IACf,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,IAAI;CACd,CAAC,CAAC;AACH,IAAA,qBAAU,EAAC,GAAG,CAAC,CAAC;AAEhB,qBAAqB;AACrB,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,kCAAc,CAAC,CAAC;AAE7C;;;;;;;GAOG;AACH,SAAS,cAAc,CACrB,KAAa,EACb,MAIC;IAED,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,IAAS;IACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO;IAEvC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACjC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,cAAc,CAAC,UAAU,EAAE;QACzB,IAAI,EAAE,YAAY;QAClB,eAAe,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,uBAAuB,EAAE,GAAG;QACrD,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,iFAAiF,EAAE,IAAI;KACpH,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,wBAAwB,CAAC,IAAS;IACzC,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO;IAE5D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IAEpC,iCAAiC;IACjC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,IAAI,CAAC,IAAI;YAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IAEvC,+BAA+B;IAC/B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;QAChE,yBAAyB;QACzB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvD,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC;QAED,gBAAgB;QAChB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,SAAc,EAAE,EAAE;gBACjD,MAAM,eAAe,GAAG,IAAA,0BAAkB,EAAC,SAAS,CAAC,CAAC;gBACtD,eAAe,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;oBACpC,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;wBACf,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;4BACzD,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC9B,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,YAAY,EAAE;QAC3B,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAmC,GAAG,GAAG;QACnE,kBAAkB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,+BAA+B,GAAG,gFAAgF;KAChJ,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,IAAS;IAC3C,0BAA0B;IAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACjD,MAAM,IAAI,GAAG,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,UAAU,CAAC;YAChD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,kBAAkB,CAAC;YAClD,IAAI,UAAU,GAAG,EAAE,CAAC;YAEpB,kDAAkD;YAClD,IAAI,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC;gBAC5C,UAAU,GAAG,2BAA2B,OAAO,oBAAoB,CAAC;YACtE,CAAC;iBAAM,IAAI,GAAG,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC;gBAClC,UAAU,GAAG,gCAAgC,QAAQ,IAAI,CAAC;YAC5D,CAAC;iBAAM,IAAI,GAAG,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;gBACvC,UAAU,GAAG,6BAA6B,CAAC;YAC7C,CAAC;YAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,gCAAgC;IAChC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC5B,wBAAwB,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}