Merge pull request #1131 from hardisgroupcom/flows/transform-elements

Flow documentation: Take in account new **Transform Element**

Author: nvuillam

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image `hardisgroupcom/sfdx-hardis@beta`
 
+## [5.24.0] 2025-03-21
+
+- Flow documentation: Take in account new **Transform Element**
+
 ## [5.23.0] 2025-03-19
 
 - Lazy loading in hooks to improve performances when other CLI plugins commands are called

src/common/utils/flowVisualiser/flowParser.ts

@@ -15,29 +15,6 @@ interface FlowMap {
     [propName: string]: any;
 }
 
-/*
-// TODO FILL OUT
-interface FlowObj {
-    "description"?: string;
-    "label"?: string;
-    "processType"?: string; // TODO
-    "start"?: {
-        "connector": string;
-        "scheduledPaths": any;
-    };
-    "status"?: "Active" | "Draft";
-    "subflows"?: any | any[];
-    "actionCalls"?: any | any[];
-    "assignments"?: any | any[];
-    "decisions"?: any | any[];
-}
-    */
-
-
-/*===================================================================
- * E X P O R T E D
- *=================================================================*/
-
 const FLOW_NODE_TYPES = [
     'actionCalls',
     'assignments',
@@ -50,7 +27,8 @@ const FLOW_NODE_TYPES = [
     'recordLookups',
     'recordUpdates',
     'screens',
-    'subflows'
+    'subflows',
+    'transforms'
 ];
 
 export async function parseFlow(xml: string, renderAs: "mermaid" | "plantuml" = "mermaid", options: any = {}): Promise<{ flowMap: FlowMap, uml: string }> {
@@ -242,6 +220,7 @@ async function getMermaidBody(flowMap: FlowMap): Promise<string> {
             case 'recordLookups':
             case 'recordUpdates':
             case 'screens':
+            case 'transforms':
                 bodyStr += node.name + " --> " + nextNode + "\n";
                 manageAddEndNode(nextNode, endNodeIds);
                 if (node.faultPath) {

src/common/utils/flowVisualiser/nodeFormatUtils.ts

@@ -105,6 +105,14 @@ export function flowNodeToMarkdown(flowNodeIn: any, allProperties: string[]): st
       additionalTables.push(...[ruleTable, mdEndSection(ruleConditionsTable)])
     }
   }
+  // Special case of transforms
+  else if (flowNode.type === "transforms") {
+    const transformValues = flowNode.transformValues || {};
+    const transformValueActions = getElementAsArray(transformValues, "transformValueActions");
+    delete flowNode.transformValues;
+    const transformsTable = buildCustomMarkdownTable(transformValueActions, ["transformType", "value", "outputFieldApiName"], "#### Transform actions", allProperties);
+    additionalTables.push(transformsTable);
+  }
   else if (flowNode.type === "screens") {
     handleFields(flowNode, allProperties, "", additionalTables);
   }

src/common/utils/flowVisualiser/renderConfig.ts

@@ -124,5 +124,13 @@ export const NODE_CONFIG = {
 	"endClass": {
 		background: "#F9BABA", // Slightly shinier pale re
 		color: "black"
-	}
+	},
+	'transforms': {
+		background: "#FDEAF6", // Light pink
+		color: "black",
+		label: "",
+		mermaidIcon: "♻️",
+		mermaidClose: "}}",
+		mermaidOpen: "{{"
+	},
 };

src/common/utils/mermaidUtils.ts

@@ -170,7 +170,8 @@ export function getMermaidExtraClasses() {
     'recordUpdatesAdded',
     'screensAdded',
     'subflowsAdded',
-    'startClassAdded'
+    'startClassAdded',
+    'transformsAdded'
   ];
 
   const removedClasses = [
@@ -186,7 +187,8 @@ export function getMermaidExtraClasses() {
     'recordUpdatesRemoved',
     'screensRemoved',
     'subflowsRemoved',
-    'startClassRemoved'
+    'startClassRemoved',
+    'transformsRemoved'
   ];
 
   const changedClasses = [
@@ -202,7 +204,8 @@ export function getMermaidExtraClasses() {
     'recordUpdatesChanged',
     'screensChanged',
     'subflowsChanged',
-    'startClassChanged'
+    'startClassChanged',
+    'transformsChanged'
   ];
 
   const formatClasses = (classList, style) =>

src/common/utils/projectUtils.ts

@@ -70,6 +70,7 @@ export async function isManagedFlow(flowFile: string) {
     'recordDeletes',
     'recordLookups',
     'recordUpdates',
+    'transforms',
     'screens',
     'subflows',
     'variables',