@flow-scanner/lightning-flow-scanner-core 6.10.6 → 6.11.1

package/README.md

@@ -1,25 +1,22 @@
 <p align="center">
-  <a href="https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/LICENSE.md">
-    <img src="https://img.shields.io/github/license/Flow-Scanner/lightning-flow-scanner?style=flat-square" alt="License">
-  </a>
-  <a href="https://github.com/Flow-Scanner/lightning-flow-scanner/graphs/contributors">
-    <img src="https://img.shields.io/github/contributors/Flow-Scanner/lightning-flow-scanner.svg?style=flat-square" alt="Contributors">
+  <a href="https://github.com/Flow-Scanner/lightning-flow-scanner/stargazers">
+    <img src="https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner?label=Stargazers&style=flat-square" alt="GitHub stars">
   </a>
-  <a href="https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core">
-    <img src="https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=core&style=flat-square" alt="Core version">
+   <a href="https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core">
+    <img src="https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=Core&style=flat-square" alt="Core version">
   </a>
   <a href="https://www.npmjs.com/package/lightning-flow-scanner">
-    <img src="https://img.shields.io/npm/v/lightning-flow-scanner?label=cli&style=flat-square" alt="CLI version">
+    <img src="https://img.shields.io/npm/v/lightning-flow-scanner?label=CLI&style=flat-square" alt="CLI version">
   </a>
   <a href="https://open-vsx.org/extension/ForceConfigControl/lightning-flow-scanner-vsx">
-    <img src="https://img.shields.io/open-vsx/v/ForceConfigControl/lightning-flow-scanner-vsx?label=Open%20VSX&style=flat-square" alt="Open VSX">
-  </a>
-  <a href="https://github.com/Flow-Scanner/lightning-flow-scanner/stargazers">
-    <img src="https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner?style=flat-square" alt="GitHub stars">
+    <img src="https://img.shields.io/open-vsx/v/ForceConfigControl/lightning-flow-scanner-vsx?label=VS%20Code&style=flat-square" alt="VS Code version">
   </a>
   <a href="https://www.npmjs.com/package/lightning-flow-scanner-core">
-    <img src="https://img.shields.io/badge/downloads-510k%2B-success?style=flat-square" alt="Total Downloads">
-  </a>
+  <img src="https://img.shields.io/npm/dt/lightning-flow-scanner-core?label=Downloads%3Cv6&style=flat-square" alt="Downloads <v6">
+</a>
+<a href="https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core">
+  <img src="https://img.shields.io/npm/dt/@flow-scanner/lightning-flow-scanner-core?label=Downloads%3Ev6&style=flat-square" alt="Downloads >v6">
+</a>
 </p>
 
 <p align="center">
@@ -36,11 +33,10 @@
 
 - **[Default Rules](#default-rules)**
 - **[Configuration](#configuration)**
-  - [Defining Severity Levels](#defining-severity-levels)
-  - [Configuring Expressions](#configuring-expressions)
-  - [Specifying Exceptions](#specifying-exceptions)
-  - [Include Beta Rules](#include-beta-rules)
-  - [Rule Mode](#rule-mode)
+  - [Configure Severity Levels](#configure-severity-levels)
+  - [Overwrite Expressions](#overwrite-expressions)
+  - [Define Exceptions](#define-exceptions)
+  - [Scan Modes](#scan-modes)
 - **[Installation](#installation)**
   - [Distributions](#distributions)
   - [CICD Templates](#cicd-templates)
@@ -202,9 +198,9 @@ By default, all default rules are executed. You can customize individual rules a
 }
 ```
 
-### Defining Severity Levels
+### Configure Severity Levels
 
-When the severity is not provided it will be `warning` by default. Other available values for severity are `error` and `note`. Define the severity per rule as shown below:
+When the severity is not provided it will be `warning` by default. Other available values for severity are `error` and `note`. Configure the severity per rule as shown below:
 
 ```json
 {
@@ -219,9 +215,9 @@ When the severity is not provided it will be `warning` by default. Other availab
 }
 ```
 
-### Configuring Expressions
+### Overwrite Expressions
 
-Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
+Some rules have an expression to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
 
 ```json
 {
@@ -236,9 +232,9 @@ Some rules have additional attributes to configure, such as the expression, that
 }
 ```
 
-### Specifying Exceptions
+### Define Exceptions
 
-Specifying exceptions allows you to exclude specific scenarios from rule enforcement. Exceptions can be specified at the flow, rule, or result level to provide fine-grained control. Below is a breakdown of the available attributes of exception configuration:
+Defining exceptions allows you to exclude specific scenarios from rule enforcement. Exceptions can be specified at the flow, rule, or result level to provide fine-grained control. Below is a breakdown of the available attributes of exception configuration:
 
 ```json
 {
@@ -268,7 +264,9 @@ _Example_
 }
 ```
 
-### Include Beta Rules
+### Scan Modes
+
+#### Beta Mode
 
 New rules are introduced in Beta mode before being added to the default ruleset. To include current Beta rules, enable the optional betamode parameter in your configuration:
 
@@ -278,7 +276,7 @@ New rules are introduced in Beta mode before being added to the default ruleset.
 }
 ```
 
-### Rule Mode
+#### Rule Mode
 
 By default, Lightning Flow Scanner runs **all** default rules and merges any custom configurations you provide. This means you can override specific rules without having to list every rule to be executed. If instead, you want to run **only** the rules you explicitly specify, use `"ruleMode": "isolated"`:
 ```json
@@ -287,44 +285,28 @@ By default, Lightning Flow Scanner runs **all** default rules and merges any cus
 }
 ```
 
-
 ## Installation
 
 ### Distributions
 
-| Distribution                                      | Best for                                      | Install / Use                                                                                           |
+| Distribution                                      | Best for                                      | Install                                                                                           |
 |----------------------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------|
-| **[Salesforce CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md)** | Local development, scratch orgs, CI/CD        | `sf plugins install lightning-flow-scanner`                                                             |
-| **[VS Code Extension](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/vsx/README.md)** | Real-time scanning inside VS Code             | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx`                               |
+| **[Salesforce CLI Plugin](https://www.npmjs.com/package/lightning-flow-scanner)** | Local development, scratch orgs, CI/CD        | `sf plugins install lightning-flow-scanner`                                                             |
+| **[VS Code Extension](https://open-vsx.org/extension/ForceConfigControl/lightning-flow-scanner-vsx)** | Real-time scanning inside VS Code             | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx`                               |
 | **[Salesforce App (Managed Package)](https://github.com/Flow-Scanner/lightning-flow-scanner-app)** | Run scans directly inside a Salesforce org  | `sf package install --package 04tgK0000007M73QAE` |
-| **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps   | `npm install -g @flow-scanner/lightning-flow-scanner-core`                                                 |
+| **[GitHub Action](https://github.com/marketplace/actions/lightning-flow-scan)** | Native PR checks        | `uses: Flow-Scanner/lightning-flow-scanner@action-v2.6.0` |
+| **[Core Library](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps   | `npm install -g @flow-scanner/lightning-flow-scanner-core`                                                 |
 
 **Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=security-ov-file).
 
 ### CICD Templates
-Ready-to-use CI/CD templates and a **native GitHub Action**.  
+Ready-to-use CI/CD templates and a **Copado Plugin**.  
 
-| Platform       | Template Type                     | Link |
+| Platform       | Type                     | Link |
 |----------------|-----------------------------------|------|
 | [Azure DevOps](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/azure-templates.md)   | Full Project Scan                 | [`azure-pipelines-flow-FullScan.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/azure-devops/azure-pipelines-flow-FullScan.yml) |
 | [Azure DevOps](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/azure-templates.md)   | Change-Based Scan                 | [`azure-pipelines-flow-changedFiles.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/azure-devops/azure-pipelines-flow-changedFiles.yml) |
-| **[GitHub Action](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/action/README.md)** | Native PR checks                              | [GitHub Marketplace](https://github.com/marketplace/actions/run-flow-scanner)                           |
-| **[Copado Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado)** | Copado CI/CD pipelines                        | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS) |
-
-
-GitHub Action Snippet:
-```yaml
-- name: Lightning Flow Scan
-  id: flowscanner
-  uses: Flow-Scanner/lightning-flow-scanner@main
-
-- name: Upload SARIF to Code Scanning
-  uses: github/codeql-action/upload-sarif@v3
-  with:
-    sarif_file: ${{ steps.flowscanner.outputs.sarifPath }}
-```
-
-To see the full example, see [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/github-action/scan-flows.yml).
+| **[Copado Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado)** | Copado Plugin                       | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS) |
 
 ## Quick Start
 
@@ -333,19 +315,42 @@ To see the full example, see [`scan-flows.yml`](https://github.com/Flow-Scanner/
 Use `lightning-flow-scanner` in the Salesforce CLI:
 
 ```bash
-sf flow:scan # scan flows in current directory
-sf flow:fix -d src/force-app # fix flows in force-app directory
-sf flow:scan --sarif > report.sarif # get results as SARIF file
-sf flow scan --csv > results.csv # get results as CSV file
+sf flow:scan # Scan flows in the current directory
+sf flow:scan --sarif > report.sarif # Export scan results as SARIF
+sf flow scan --csv > results.csv # Export scan results as CSV
+sf flow doc > flow-docs.md # Generate flow documentation (Single markdown file)
+sf flow doc --output flow-docs --separate # Generate one Markdown file per flow
+sf flow:fix -d src/force-app # Fix flows in a specific directory
 ```
 
+For full details, see the [CLI Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md).
+
 ### VS Code Extension
-Use our side bar or the **Command Palette** and type `flowscanner` to see all available commands:
+Use our side bar or the **Command Palette** and type `flow scanner` to see the list of all available commands.
 
-* `Configure Flow Scanner` - Set up rules in `.flow-scanner.yml`
+* `Configure Scanner` - Set up rules in `.flow-scanner.yml`
 * `Scan Flows` - Analyze a directory or selected flow files
 * `Fix Flows` - Automatically apply available fixes
-* `Flow Scanner Documentation` - Open the rules reference guide
+* `Generate Flow Documentation` - Generate flow documentation
+* `Open Scanner Documentation` - Open the rules reference guide
+
+For full details, see the [VSX Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/vsx/README.md).
+
+### GitHub Action
+Add a GitHub workflow file `.github/workflows/scan-flows.yml` to detect issues directly in pull requests:
+
+```yaml
+- name: Lightning Flow Scan
+  id: flowscanner
+  uses: Flow-Scanner/lightning-flow-scanner@action-v2.6.0
+
+- name: Upload SARIF to Code Scanning
+  uses: github/codeql-action/upload-sarif@v3
+  with:
+    sarif_file: ${{ steps.flowscanner.outputs.sarifPath }}
+```
+
+For full details, see the [Action Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/action/README.md).
 
 ### Core Module
 Use `lightning-flow-scanner-core` as a Node.js/browser dependency:
@@ -355,9 +360,15 @@ Use `lightning-flow-scanner-core` as a Node.js/browser dependency:
 import { parse, scan } from "@flow-scanner/lightning-flow-scanner-core";
 parse("flows/*.xml").then(scan);
 
-// Get SARIF output
+// Get SARIF output (e.g. for GitHub Code Scanning)
 import { parse, scan, exportSarif } from "@flow-scanner/lightning-flow-scanner-core";
-parse("flows/*.xml").then(scan).then(exportSarif);
+parse("flows/**/*.flow-meta.xml").then(scan).then(exportSarif) 
+  // .then(sarif => fs.writeFile("results.sarif", sarif))
+
+// Generate Markdown documentation with Mermaid flow diagrams
+import { parse, exportDiagram } from "@flow-scanner/lightning-flow-scanner-core";
+parse("flows/**/*.flow-meta.xml").then(exportDiagram) 
+  // .then(md => fs.writeFile("flow-docs.md", md))
 
 // Browser Usage (Tooling API)
 const { Flow, scan } = window.lightningflowscanner;
@@ -370,6 +381,8 @@ const results = scan(
 );
 ```
 
+For more on Programmatic API, types, and advanced usage of `@flow-scanner/lightning-flow-scanner-core`, see the [Core Library Reference](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/core-reference.md).
+
 ## Development
 
 > This project optionally uses [Volta](https://volta.sh) to guarantee the exact same Node.js and tool versions for every contributor.

package/index.d.ts

@@ -19,5 +19,8 @@ import { ParsedFlow } from "./main/models/ParsedFlow";
 import { RuleResult } from "./main/models/RuleResult";
 import { ScanResult } from "./main/models/ScanResult";
 import { Violation } from "./main/models/Violation";
-export { Compiler, exportDetails, exportSarif, fix, Flow, FlowAttribute, FlowElement, FlowNode, FlowResource, FlowType, FlowVariable, getRules, parse, ParsedFlow, Violation, RuleResult, scan, ScanResult, };
-export type { FlatViolation, IRuleDefinition, IRulesConfig };
+import { DEFAULT_ICONS, ASCII_ICONS, type NodeIconConfig } from "./main/config/NodeIcons";
+import { DEFAULT_VARIABLE_ICONS, ASCII_VARIABLE_ICONS, type VariableIconConfig } from "./main/config/VariableIcons";
+import { exportDiagram, type DiagramOptions } from "./main/libs/ExportDiagram";
+export { Compiler, exportDetails, exportDiagram, exportSarif, fix, Flow, FlowAttribute, FlowElement, FlowNode, FlowResource, FlowType, FlowVariable, getRules, parse, ParsedFlow, Violation, RuleResult, scan, ScanResult, DEFAULT_ICONS, ASCII_ICONS, DEFAULT_VARIABLE_ICONS, ASCII_VARIABLE_ICONS, };
+export type { FlatViolation, IRuleDefinition, IRulesConfig, NodeIconConfig, DiagramOptions, VariableIconConfig };

package/index.js

@@ -1,3 +1,4 @@
+// Updated exports in index.ts
 "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
@@ -9,9 +10,21 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    get ASCII_ICONS () {
+        return _NodeIcons.ASCII_ICONS;
+    },
+    get ASCII_VARIABLE_ICONS () {
+        return _VariableIcons.ASCII_VARIABLE_ICONS;
+    },
     get Compiler () {
         return _Compiler.Compiler;
     },
+    get DEFAULT_ICONS () {
+        return _NodeIcons.DEFAULT_ICONS;
+    },
+    get DEFAULT_VARIABLE_ICONS () {
+        return _VariableIcons.DEFAULT_VARIABLE_ICONS;
+    },
     get Flow () {
         return _Flow.Flow;
     },
@@ -48,6 +61,9 @@ _export(exports, {
     get exportDetails () {
         return _ExportDetails.exportDetails;
     },
+    get exportDiagram () {
+        return _ExportDiagram.exportDiagram;
+    },
     get exportSarif () {
         return _ExportSarif.exportSarif;
     },
@@ -82,3 +98,6 @@ const _ParsedFlow = require("./main/models/ParsedFlow");
 const _RuleResult = require("./main/models/RuleResult");
 const _ScanResult = require("./main/models/ScanResult");
 const _Violation = require("./main/models/Violation");
+const _NodeIcons = require("./main/config/NodeIcons");
+const _VariableIcons = require("./main/config/VariableIcons");
+const _ExportDiagram = require("./main/libs/ExportDiagram");

package/main/config/NodeIcons.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Icon configuration for flow node types.
+ * Emoji are safe in UTF-8 encoded source files and will work in all modern builds.
+ * If you need ASCII fallback, use FlowNode.setIconConfig(ASCII_ICONS)
+ */
+export interface NodeIconConfig {
+    [nodeType: string]: {
+        [subtype: string]: string;
+    } | {
+        default: string;
+    };
+}
+/**
+ * Default icons using emoji (recommended for modern environments)
+ */
+export declare const DEFAULT_ICONS: NodeIconConfig;
+/**
+ * ASCII fallback icons (for environments without emoji support)
+ */
+export declare const ASCII_ICONS: NodeIconConfig;
+/**
+ * Get default icon config (can be overridden at runtime)
+ */
+export declare function getDefaultIconConfig(): NodeIconConfig;

package/main/config/NodeIcons.js

@@ -0,0 +1,122 @@
+/**
+ * Icon configuration for flow node types.
+ * Emoji are safe in UTF-8 encoded source files and will work in all modern builds.
+ * If you need ASCII fallback, use FlowNode.setIconConfig(ASCII_ICONS)
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get ASCII_ICONS () {
+        return ASCII_ICONS;
+    },
+    get DEFAULT_ICONS () {
+        return DEFAULT_ICONS;
+    },
+    get getDefaultIconConfig () {
+        return getDefaultIconConfig;
+    }
+});
+const DEFAULT_ICONS = {
+    actionCalls: {
+        apex: '\u2699\uFE0F',
+        emailAlert: '\uD83D\uDCE7',
+        emailSimple: '\uD83D\uDCE7',
+        submit: '\u26A1',
+        default: '\u26A1' // HIGH VOLTAGE
+    },
+    assignments: {
+        default: '\uD83D\uDFF0' // 🟰 HEAVY EQUALS SIGN
+    },
+    collectionProcessors: {
+        FilterCollectionProcessor: '\uD83D\uDD3D',
+        SortCollectionProcessor: '\uD83D\uDD03',
+        default: '\uD83D\uDCE6' // PACKAGE
+    },
+    customErrors: {
+        default: '\uD83D\uDEAB' // PROHIBITED
+    },
+    decisions: {
+        default: '\uD83D\uDD00' // TWISTED ARROWS
+    },
+    loops: {
+        default: '\uD83D\uDD01' // REPEAT BUTTON
+    },
+    recordCreates: {
+        default: '\u2795' // PLUS
+    },
+    recordDeletes: {
+        default: '\uD83D\uDDD1\uFE0F' // WASTEBASKET
+    },
+    recordLookups: {
+        default: '\uD83D\uDD0D' // MAGNIFYING GLASS
+    },
+    recordUpdates: {
+        default: '\uD83D\uDEE0\uFE0F' // HAMMER AND WRENCH
+    },
+    screens: {
+        default: '\uD83D\uDCBB' // LAPTOP
+    },
+    subflows: {
+        default: '\uD83D\uDD17' // LINK
+    },
+    transforms: {
+        default: '\u267B\uFE0F'
+    }
+};
+const ASCII_ICONS = {
+    actionCalls: {
+        apex: '[A]',
+        emailAlert: '[E]',
+        emailSimple: '[E]',
+        submit: '[!]',
+        default: '[!]'
+    },
+    assignments: {
+        default: '[=]'
+    },
+    collectionProcessors: {
+        FilterCollectionProcessor: '[F]',
+        SortCollectionProcessor: '[S]',
+        default: '[C]'
+    },
+    customErrors: {
+        default: '[X]'
+    },
+    decisions: {
+        default: '[?]'
+    },
+    loops: {
+        default: '[L]'
+    },
+    recordCreates: {
+        default: '[+]'
+    },
+    recordDeletes: {
+        default: '[-]'
+    },
+    recordLookups: {
+        default: '[S]'
+    },
+    recordUpdates: {
+        default: '[U]'
+    },
+    screens: {
+        default: '[#]'
+    },
+    subflows: {
+        default: '[>]'
+    },
+    transforms: {
+        default: '[T]'
+    }
+};
+function getDefaultIconConfig() {
+    return DEFAULT_ICONS;
+}

package/main/config/VariableIcons.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Icon configuration for flow variable types.
+ * Includes icons for variable subtypes and boolean states.
+ */
+export interface VariableIconConfig {
+    subtypes: {
+        [subtype: string]: string;
+    };
+    boolean: {
+        true: string;
+        false: string;
+    };
+}
+/**
+ * Default icons using emoji (recommended for modern environments)
+ */
+export declare const DEFAULT_VARIABLE_ICONS: VariableIconConfig;
+/**
+ * ASCII fallback icons (for environments without emoji support)
+ */
+export declare const ASCII_VARIABLE_ICONS: VariableIconConfig;
+/**
+ * Get default variable icon config
+ */
+export declare function getDefaultVariableIconConfig(): VariableIconConfig;

package/main/config/VariableIcons.js

@@ -0,0 +1,53 @@
+/**
+ * Icon configuration for flow variable types.
+ * Includes icons for variable subtypes and boolean states.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get ASCII_VARIABLE_ICONS () {
+        return ASCII_VARIABLE_ICONS;
+    },
+    get DEFAULT_VARIABLE_ICONS () {
+        return DEFAULT_VARIABLE_ICONS;
+    },
+    get getDefaultVariableIconConfig () {
+        return getDefaultVariableIconConfig;
+    }
+});
+const DEFAULT_VARIABLE_ICONS = {
+    subtypes: {
+        variables: '\uD83D\uDCCA',
+        constants: '\uD83D\uDD12',
+        formulas: '\uD83E\uDDEE',
+        choices: '\uD83D\uDCCB',
+        dynamicChoiceSets: '\uD83D\uDD04'
+    },
+    boolean: {
+        true: '\u2705',
+        false: '\u2B1C'
+    }
+};
+const ASCII_VARIABLE_ICONS = {
+    subtypes: {
+        variables: '[V]',
+        constants: '[C]',
+        formulas: '[F]',
+        choices: '[CH]',
+        dynamicChoiceSets: '[D]'
+    },
+    boolean: {
+        true: '[X]',
+        false: '[ ]'
+    }
+};
+function getDefaultVariableIconConfig() {
+    return DEFAULT_VARIABLE_ICONS;
+}

package/main/libs/Compiler.d.ts

@@ -1,8 +1,7 @@
-import { Flow } from "../models/Flow";
 import { FlowNode } from "../models/FlowNode";
 export declare class Compiler {
     visitedElements: Set<string>;
     constructor();
-    traverseFlow(flow: Flow, startElementName: string, visitCallback: (element: FlowNode) => void, endElementName?: string): void;
+    traverseFlow(startElementName: string, visitCallback: (element: FlowNode) => void, nodeMap: Map<string, FlowNode>, allConnectors: Map<string, Set<string>>, endElementName?: string): void;
     private findNextElements;
 }

package/main/libs/Compiler.js

@@ -22,7 +22,7 @@ function _define_property(obj, key, value) {
     return obj;
 }
 let Compiler = class Compiler {
-    traverseFlow(flow, startElementName, visitCallback, endElementName) {
+    traverseFlow(startElementName, visitCallback, nodeMap, allConnectors, endElementName) {
         // Iterative Deepening Depth-First Search (IDDFS)
         let elementsToVisit = [
             startElementName
@@ -31,12 +31,11 @@ let Compiler = class Compiler {
             const nextElements = [];
             for (const elementName of elementsToVisit){
                 if (!this.visitedElements.has(elementName)) {
-                    var _flow_elements;
-                    const currentElement = (_flow_elements = flow.elements) === null || _flow_elements === void 0 ? void 0 : _flow_elements.find((element)=>element.name === elementName);
+                    const currentElement = nodeMap.get(elementName);
                     if (currentElement) {
                         visitCallback(currentElement);
                         this.visitedElements.add(elementName);
-                        nextElements.push(...this.findNextElements(flow, currentElement, endElementName));
+                        nextElements.push(...this.findNextElements(elementName, allConnectors, nodeMap, endElementName));
                     }
                 }
             }
@@ -46,19 +45,14 @@ let Compiler = class Compiler {
             elementsToVisit = nextElements;
         }
     }
-    findNextElements(flow, currentElement, endElementName) {
+    findNextElements(elementName, allConnectors, nodeMap, endElementName) {
         const nextElements = [];
-        if (!currentElement.connectors || currentElement.connectors.length === 0) {
-            return nextElements;
-        }
-        for (const connector of currentElement.connectors){
-            var _connector_connectorTargetReference, _flow_elements;
-            var _connector_connectorTargetReference_targetReference;
-            const targetReference = (_connector_connectorTargetReference_targetReference = connector === null || connector === void 0 ? void 0 : (_connector_connectorTargetReference = connector.connectorTargetReference) === null || _connector_connectorTargetReference === void 0 ? void 0 : _connector_connectorTargetReference.targetReference) !== null && _connector_connectorTargetReference_targetReference !== void 0 ? _connector_connectorTargetReference_targetReference : connector.reference;
-            // Check if the reference exists in the flow elements
-            const nextElement = (_flow_elements = flow.elements) === null || _flow_elements === void 0 ? void 0 : _flow_elements.find((element)=>element.metaType === "node" && element.name === targetReference);
-            if (nextElement && nextElement.metaType === "node" && nextElement.name !== endElementName) {
-                nextElements.push(nextElement.name);
+        const targets = allConnectors.get(elementName);
+        if (targets) {
+            for (const targetReference of targets){
+                if (targetReference !== endElementName && nodeMap.has(targetReference)) {
+                    nextElements.push(targetReference);
+                }
             }
         }
         return nextElements;

package/main/libs/ExportDiagram.d.ts

@@ -0,0 +1,41 @@
+import { ParsedFlow } from "../models/ParsedFlow";
+export interface DiagramOptions {
+    includeDetails?: boolean;
+    includeMarkdownDocs?: boolean;
+    collapsedDetails?: boolean;
+}
+/**
+ * Generate Markdown documentation for parsed flows, including Mermaid diagrams for valid flows.
+ *
+ * This function can be chained after parse() to generate documentation.
+ * It filters out errored parses and only documents valid flows.
+ *
+ * @param parsedFlows Array of ParsedFlow objects from parse()
+ * @param options Visualization options for Mermaid diagrams
+ *
+ * @returns Markdown string with documentation
+ *
+ * @example
+ * ```typescript
+ * // Node.js usage
+ * import { parse, exportFlowMarkdown } from "@flow-scanner/lightning-flow-scanner-core";
+ * import fs from "fs/promises";
+ *
+ * const parsed = await parse(["flows/*.xml"]);
+ * const md = exportFlowMarkdown(parsed, {
+ *   includeDetails: true,
+ *   includeMarkdownDocs: true,
+ *   collapsedDetails: true
+ * });
+ * await fs.writeFile("flow-doc.md", md);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Chained (async/await)
+ * const md = await parse(["flows/*.xml"]).then(parsed =>
+ *   exportFlowMarkdown(parsed, { includeDetails: true })
+ * );
+ * ```
+ */
+export declare function exportDiagram(parsedFlows: ParsedFlow[], options?: DiagramOptions): string;