@flow-scanner/lightning-flow-scanner-core 6.1.1 → 6.1.5

package/README.md

@@ -4,7 +4,7 @@
   </a>
 </p>
 
-<p align="center"><i>UMD-compatible Flow metadata engine for Node.js & browsers—20+ rules to catch common issues.</i></p>
+<p align="center"><i>UMD-compatible Flow metadata engine for Node.js & browsers—20+ rules to catch issues.</i></p>
 
 ---
 
@@ -18,7 +18,7 @@
   - [Include Beta Rules](#include-beta-rules)
 - **[Usage](#Usage)**
   - [Examples](#examples)
-  - [Functions](#core-functions)
+  - [Functions](#functions)
 - **[Installation](#installation)**
 - **[Development](#development)**
 
@@ -143,7 +143,7 @@ It is recommended to set up configuration and define:
 }
 ```
 
-Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. To include rules currently that are currently in beta, set `betarules` to true. Below is a breakdown of the available attributes of rule configuration:
+Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. Below is a breakdown of the available attributes of rule configuration:
 
 ```json
 {
@@ -182,11 +182,11 @@ Some rules have additional attributes to configure, such as the expression, that
   "rules": {
     "APIVersion": {
       "severity": "error",
-      "expression": "===58"
+      "expression": "===58" // comparison operator
     },
     "FlowName": {
       "severity": "note",
-      "expression": "[A-Za-z0-9]"
+      "expression": "[A-Za-z0-9]" // regular expression
     }
   }
 }
@@ -231,7 +231,7 @@ New rules are introduced in Beta mode before being added to the default ruleset.
 
 ## Usage
 
-The Lightning Flow Scanner Core can be used as a dependency in Node.js and browser environments, or used as a standalone UMD module.
+`lightning-flow-scanner-core` can be used as a dependency in Node.js and browser environments, or as a standalone UMD module.
 
 ### Examples
 
@@ -240,16 +240,13 @@ The Lightning Flow Scanner Core can be used as a dependency in Node.js and brows
 import { parse, scan } from "@flow-scanner/lightning-flow-scanner-core";
 parse("flows/*.xml").then(scan);
 
-// Apply fixes automatically
+// Apply available patches
 import { parse, scan, fix } from "@flow-scanner/lightning-flow-scanner-core";
 parse("flows/*.xml").then(scan).then(fix);
 
 // Get SARIF output
 import { parse, scan, exportSarif } from "@flow-scanner/lightning-flow-scanner-core";
-parse("flows/*.xml")
-  .then(scan)
-  .then(exportSarif)
-  .then((sarif) => save("results.sarif", sarif));
+parse("flows/*.xml").then(scan).then(exportSarif); //.then((sarif) => save("results.sarif", sarif));
 
 // Browser Usage (Tooling API)
 const { Flow, scan } = window.lightningflowscanner;
@@ -258,8 +255,7 @@ const results = scan(
   metadataRes.records.map((r) => ({
     uri: `/services/data/v60.0/tooling/sobjects/Flow/${r.Id}`,
     flow: new Flow(r.FullName, r.Metadata),
-  })),
-  optionsForScan
+  })) //, optionsForScan
 );
 ```
 
@@ -281,9 +277,13 @@ _Runs all enabled rules and returns detailed violations._
 
 _Automatically applies available fixes(removing variables and unconnected elements)._
 
-#### [`exportSarif(results: ScanResult[]): string`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ExportSarif.ts)
+#### [`exportDetails(results: ScanResult[]): FlatViolation[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/exportDetails.ts)
 
-_Generates SARIF output with paths and exact line numbers._
+_Get flattened output of violations only._
+
+#### [`exportSarif(results: ScanResult[]): string`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/exportSarif.ts)
+
+_Get SARIF output including exact line numbers of violations._
 
 ---
 
@@ -336,26 +336,24 @@ npm install @flow-scanner/lightning-flow-scanner-core
    ```
 
 5. Test as local dependency(Optional):
-   To test changes to the core module in the VS Code extension or SF CLI plugin locally, run:
+   To test changes to the core module locally, run:
 
    ```bash
    npm run link
    ```
 
-   b) Go to the dependent project (VSX or SF CLI) and use:
+   b) Go to the dependent project (e.g. VSX or CLI) and use:
 
    ```bash
    npm link @flow-scanner/lightning-flow-scanner-core
    ```
 
-   Your local core module will now replace the installed dependency and update automatically on rebuild.
+   Your local module will now replace any installed version and update on rebuild.
 
 6. Create a standalone UMD Module(Optional):
 
 ```bash
-npm run vite:dist
+  npm run vite:dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
 ```
 
-The resulting file will be available in the `dist` directory as `lightning-flow-scanner-core.umd.js`.
-
 ###### Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).

package/index.d.ts

@@ -1,7 +1,8 @@
 import type { IRuleDefinition } from "./main/interfaces/IRuleDefinition";
 import type { IRulesConfig } from "./main/interfaces/IRulesConfig";
 import { Compiler } from "./main/libs/Compiler";
-import { exportSarif } from "./main/libs/ExportSarif";
+import { exportDetails } from "./main/libs/exportAsDetails";
+import { exportSarif } from "./main/libs/exportAsSarif";
 import { fix } from "./main/libs/FixFlows";
 import { getBetaRules, getRules } from "./main/libs/GetRuleDefinitions";
 import { parse } from "./main/libs/ParseFlows";
@@ -18,5 +19,5 @@ import { ParsedFlow } from "./main/models/ParsedFlow";
 import { ResultDetails } from "./main/models/ResultDetails";
 import { RuleResult } from "./main/models/RuleResult";
 import { ScanResult } from "./main/models/ScanResult";
-export { AdvancedRule, Compiler, exportSarif, fix, Flow, FlowAttribute, FlowElement, FlowNode, FlowResource, FlowType, FlowVariable, getBetaRules, getRules, parse, ParsedFlow, ResultDetails, RuleResult, scan, ScanResult, };
+export { AdvancedRule, Compiler, exportDetails, exportSarif, fix, Flow, FlowAttribute, FlowElement, FlowNode, FlowResource, FlowType, FlowVariable, getBetaRules, getRules, parse, ParsedFlow, ResultDetails, RuleResult, scan, ScanResult, };
 export type { IRuleDefinition, IRulesConfig };

package/index.js

@@ -48,8 +48,11 @@ _export(exports, {
     get ScanResult () {
         return _ScanResult.ScanResult;
     },
+    get exportDetails () {
+        return _exportAsDetails.exportDetails;
+    },
     get exportSarif () {
-        return _ExportSarif.exportSarif;
+        return _exportAsSarif.exportSarif;
     },
     get fix () {
         return _FixFlows.fix;
@@ -68,7 +71,8 @@ _export(exports, {
     }
 });
 const _Compiler = require("./main/libs/Compiler");
-const _ExportSarif = require("./main/libs/ExportSarif");
+const _exportAsDetails = require("./main/libs/exportAsDetails");
+const _exportAsSarif = require("./main/libs/exportAsSarif");
 const _FixFlows = require("./main/libs/FixFlows");
 const _GetRuleDefinitions = require("./main/libs/GetRuleDefinitions");
 const _ParseFlows = require("./main/libs/ParseFlows");

package/main/libs/exportAsDetails.d.ts

@@ -0,0 +1,16 @@
+import { ScanResult } from "../models/ScanResult";
+export interface FlatViolation {
+    connectsTo?: string;
+    dataType?: string;
+    expression?: string;
+    flowFile: string;
+    flowName: string;
+    locationX?: string;
+    locationY?: string;
+    metaType: string;
+    name: string;
+    ruleName: string;
+    severity: string;
+    type: string;
+}
+export declare function exportDetails(results: ScanResult[]): FlatViolation[];

package/main/libs/exportAsDetails.js

@@ -0,0 +1,43 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "exportDetails", {
+    enumerable: true,
+    get: function() {
+        return exportDetails;
+    }
+});
+function exportDetails(results) {
+    const violations = [];
+    for (const result of results){
+        const flow = result.flow;
+        const flowName = flow.label || flow.name;
+        const flowFile = flow.fsPath ? flow.fsPath.replace(/\\/g, "/") : `${flow.name}.flow-meta.xml`;
+        for (const rule of result.ruleResults){
+            var _rule_details;
+            if (!rule.occurs || !((_rule_details = rule.details) === null || _rule_details === void 0 ? void 0 : _rule_details.length)) continue;
+            const ruleName = rule.ruleDefinition.label || rule.ruleName;
+            var _rule_severity;
+            const severity = (_rule_severity = rule.severity) !== null && _rule_severity !== void 0 ? _rule_severity : "error";
+            for (const detail of rule.details){
+                const d = detail.details || {};
+                violations.push({
+                    connectsTo: Array.isArray(d.connectsTo) ? d.connectsTo.join("; ") : d.connectsTo,
+                    dataType: d.dataType,
+                    expression: d.expression,
+                    flowFile,
+                    flowName,
+                    locationX: d.locationX,
+                    locationY: d.locationY,
+                    metaType: detail.metaType,
+                    name: detail.name,
+                    ruleName,
+                    severity,
+                    type: detail.type
+                });
+            }
+        }
+    }
+    return violations;
+}

package/main/libs/{ExportSarif.js → exportAsSarif.js}

@@ -1,4 +1,3 @@
-// src/main/libs/exportSarif.ts
 "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flow-scanner/lightning-flow-scanner-core",
   "description": "A lightweight, purpose-built engine for parsing and analyzing Salesforce Flow metadata in Node.js or browser environments. Scan, validate, and optimize Flow automations for security risks, best practices, governor limits, and performance bottlenecks.",
-  "version": "6.1.1",
+  "version": "6.1.5",
   "main": "index.js",
   "types": "index.d.ts",
   "engines": {