@flow-scanner/lightning-flow-scanner-core 6.1.2 → 6.1.6

package/README.md

@@ -18,7 +18,7 @@
   - [Include Beta Rules](#include-beta-rules)
 - **[Usage](#Usage)**
   - [Examples](#examples)
-  - [Functions](#core-functions)
+  - [Functions](#functions)
 - **[Installation](#installation)**
 - **[Development](#development)**
 
@@ -277,17 +277,21 @@ _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._
 
 ---
 
 ## Installation
 
-`lightning-flow-scanner-core` is published to **npm** only.
+`lightning-flow-scanner-core` is published to **npm** and **scanned with Snyk during release**.
 
-[![npm version](https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=npm)](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core)
+[![npm version](https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=npm)](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core) [![Known Vulnerabilities](https://snyk.io/test/github/Flow-Scanner/lightning-flow-scanner-core/badge.svg)](https://snyk.io/test/github/Flow-Scanner/lightning-flow-scanner-core)
 
 **To install with npm:**
 
@@ -349,9 +353,7 @@ npm install @flow-scanner/lightning-flow-scanner-core
 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 UMD module will be created at`dist/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.2",
+  "version": "6.1.6",
   "main": "index.js",
   "types": "index.d.ts",
   "engines": {