sfdx-hardis 5.18.1 → 5.19.1

package/lib/common/docBuilder/objectModelBuilder.js

@@ -0,0 +1,161 @@
+// import c from "chalk";
+import { glob } from "glob";
+import fs from "fs-extra";
+// import { uxLog } from "../utils/index.js";
+import * as path from "path";
+import { XMLParser } from "fast-xml-parser";
+import { GLOB_IGNORE_PATTERNS } from "../utils/projectUtils.js";
+let ALL_LINKS_CACHE = [];
+let ALL_OBJECTS_CACHE = [];
+export class ObjectModelBuilder {
+    mainCustomObject;
+    relatedCustomObjects;
+    allLinks = [];
+    allObjects = [];
+    selectedObjectsNames = new Set();
+    selectedObjects = [];
+    selectedLinks = [];
+    constructor(mainCustomObject = "all", relatedCustomObjects = []) {
+        this.mainCustomObject = mainCustomObject;
+        if (this.mainCustomObject !== "all") {
+            this.selectedObjectsNames.add(this.mainCustomObject);
+        }
+        this.relatedCustomObjects = relatedCustomObjects;
+    }
+    async buildObjectsMermaidSchema() {
+        await this.buildAllLinks();
+        await this.buildAllObjects();
+        await this.selectObjects();
+        await this.selectLinks();
+        const mermaidSchema = await this.generateMermaidSchema();
+        return mermaidSchema;
+    }
+    async generateMermaidSchema() {
+        let mermaidSchema = `graph TD\n`;
+        for (const object of this.selectedObjects) {
+            const objectClass = object.name === this.mainCustomObject ? "mainObject" :
+                !object.name.endsWith("__c") ? "object" :
+                    object.name.split("__").length > 2 ? "customObjectManaged" :
+                        "customObject";
+            mermaidSchema += `${object.name}["${object.label}"]:::${objectClass}\n`;
+            if (fs.existsSync(`docs/objects/${object.name}.md`)) {
+                mermaidSchema += `click ${object.name} "/objects/${object.name}/"\n`;
+            }
+        }
+        mermaidSchema += `\n`;
+        let pos = 0;
+        const masterDetailPos = [];
+        const lookupPos = [];
+        for (const link of this.selectedLinks) {
+            if (link.type === "MasterDetail") {
+                mermaidSchema += `${link.from} ==>|${link.field}| ${link.to}\n`;
+                masterDetailPos.push(pos);
+            }
+            else {
+                mermaidSchema += `${link.from} -->|${link.field}| ${link.to}\n`;
+                lookupPos.push(pos);
+            }
+            pos++;
+        }
+        mermaidSchema += `\n`;
+        mermaidSchema += `classDef object fill:#D6E9FF,stroke:#0070D2,stroke-width:3px,rx:12px,ry:12px,shadow:drop,color:#333;
+classDef customObject fill:#FFF4C2,stroke:#CCAA00,stroke-width:3px,rx:12px,ry:12px,shadow:drop,color:#333;
+classDef customObjectManaged fill:#FFD8B2,stroke:#CC5500,stroke-width:3px,rx:12px,ry:12px,shadow:drop,color:#333;
+classDef mainObject fill:#FFB3B3,stroke:#A94442,stroke-width:4px,rx:14px,ry:14px,shadow:drop,color:#333,font-weight:bold;
+`;
+        if (masterDetailPos.length > 0) {
+            mermaidSchema += "linkStyle " + masterDetailPos.join(",") + " stroke:#4C9F70,stroke-width:4px;\n";
+        }
+        if (lookupPos.length > 0) {
+            mermaidSchema += "linkStyle " + lookupPos.join(",") + " stroke:#A6A6A6,stroke-width:2px;\n";
+        }
+        return mermaidSchema;
+    }
+    async buildAllLinks() {
+        if (ALL_LINKS_CACHE.length > 0) {
+            this.allLinks = ALL_LINKS_CACHE;
+            return;
+        }
+        // List all object links in the project
+        const findFieldsPattern = `**/objects/**/fields/**.field-meta.xml`;
+        const matchingFieldFiles = (await glob(findFieldsPattern, { cwd: process.cwd(), ignore: GLOB_IGNORE_PATTERNS })).map(file => file.replace(/\\/g, '/'));
+        for (const fieldFile of matchingFieldFiles) {
+            const objectName = fieldFile.substring(fieldFile.indexOf('objects/')).split("/")[1];
+            if (objectName.endsWith("__dlm") || objectName.endsWith("__dll")) {
+                continue;
+            }
+            const fieldXml = fs.readFileSync(fieldFile, "utf8").toString();
+            const fieldDetail = new XMLParser().parse(fieldXml);
+            if (fieldDetail?.CustomField?.type === "MasterDetail" || fieldDetail?.CustomField?.type === "Lookup") {
+                const fieldName = path.basename(fieldFile, ".field-meta.xml");
+                const link = {
+                    from: objectName,
+                    to: fieldDetail.CustomField.referenceTo,
+                    field: fieldName,
+                    relationshipName: fieldDetail.CustomField.relationshipName,
+                    type: fieldDetail.CustomField.type
+                };
+                this.allLinks.push(link);
+            }
+        }
+        ALL_LINKS_CACHE = [...this.allLinks];
+    }
+    async buildAllObjects() {
+        if (ALL_OBJECTS_CACHE.length > 0) {
+            this.allObjects = ALL_OBJECTS_CACHE;
+            return;
+        }
+        // Get custom objects info
+        const findObjectsPattern = `**/objects/**/*.object-meta.xml`;
+        const matchingObjectFiles = (await glob(findObjectsPattern, { cwd: process.cwd(), ignore: GLOB_IGNORE_PATTERNS })).map(file => file.replace(/\\/g, '/'));
+        for (const objectFile of matchingObjectFiles) {
+            const objectName = path.basename(objectFile, ".object-meta.xml");
+            const objectXml = fs.readFileSync(objectFile, "utf8").toString();
+            const objectDetail = new XMLParser().parse(objectXml);
+            const object = {
+                name: objectName,
+                label: objectDetail?.CustomObject?.label || objectName,
+                description: objectDetail?.CustomObject?.description || '',
+            };
+            this.allObjects.push(object);
+        }
+        ALL_OBJECTS_CACHE = [...this.allObjects];
+    }
+    async selectObjects() {
+        for (const link of this.allLinks) {
+            if (this.relatedCustomObjects.includes(link.from) || this.relatedCustomObjects.includes(link.to)) {
+                this.selectedObjectsNames.add(link.from);
+                this.selectedObjectsNames.add(link.to);
+            }
+            else if (this.mainCustomObject === "all") {
+                this.selectedObjectsNames.add(link.from);
+                this.selectedObjectsNames.add(link.to);
+            }
+            else {
+                if (link.from === this.mainCustomObject || link.to === this.mainCustomObject) {
+                    this.selectedObjectsNames.add(link.from);
+                    this.selectedObjectsNames.add(link.to);
+                }
+            }
+        }
+        for (const object of this.allObjects) {
+            if (this.selectedObjectsNames.has(object.name)) {
+                this.selectedObjects.push(object);
+            }
+        }
+        // Complete with objects with missing .object-meta.xml file
+        for (const object of this.selectedObjectsNames) {
+            if (!this.selectedObjects.some(obj => obj.name === object)) {
+                this.selectedObjects.push({ name: object, label: object, description: '' });
+            }
+        }
+    }
+    async selectLinks() {
+        for (const link of this.allLinks) {
+            if (this.selectedObjectsNames.has(link.from) && this.selectedObjectsNames.has(link.to)) {
+                this.selectedLinks.push(link);
+            }
+        }
+    }
+}
+//# sourceMappingURL=objectModelBuilder.js.map

package/lib/common/docBuilder/objectModelBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectModelBuilder.js","sourceRoot":"","sources":["../../../src/common/docBuilder/objectModelBuilder.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,6CAA6C;AAC7C,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,IAAI,eAAe,GAAU,EAAE,CAAC;AAChC,IAAI,iBAAiB,GAAU,EAAE,CAAC;AAElC,MAAM,OAAO,kBAAkB;IACnB,gBAAgB,CAAS;IACzB,oBAAoB,CAAW;IAC/B,QAAQ,GAAU,EAAE,CAAC;IACrB,UAAU,GAAU,EAAE,CAAC;IACvB,oBAAoB,GAAgB,IAAI,GAAG,EAAU,CAAC;IACtD,eAAe,GAAU,EAAE,CAAA;IAC3B,aAAa,GAAU,EAAE,CAAA;IAEnC,YAAY,mBAA2B,KAAK,EAAE,uBAAiC,EAAE;QAC/E,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YACpC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,yBAAyB;QAC7B,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACzD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,IAAI,aAAa,GAAG,YAAY,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1C,MAAM,WAAW,GACf,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;gBACpD,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;oBACvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;wBAC1D,cAAc,CAAC;YACvB,aAAa,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,KAAK,QAAQ,WAAW,IAAI,CAAC;YACxE,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACpD,aAAa,IAAI,SAAS,MAAM,CAAC,IAAI,cAAc,MAAM,CAAC,IAAI,MAAM,CAAC;YACvE,CAAC;QACH,CAAC;QACD,aAAa,IAAI,IAAI,CAAC;QACtB,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACjC,aAAa,IAAI,GAAG,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE,IAAI,CAAC;gBAChE,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;iBACI,CAAC;gBACJ,aAAa,IAAI,GAAG,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE,IAAI,CAAC;gBAChE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;YACD,GAAG,EAAE,CAAC;QACR,CAAC;QACD,aAAa,IAAI,IAAI,CAAC;QACtB,aAAa,IAAI;;;;CAIpB,CAAC;QAEE,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,aAAa,IAAI,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,qCAAqC,CAAC;QACpG,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,aAAa,IAAI,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,qCAAqC,CAAC;QAC9F,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC;YAChC,OAAO;QACT,CAAC;QACD,uCAAuC;QACvC,MAAM,iBAAiB,GAAG,wCAAwC,CAAC;QACnE,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QACvJ,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjE,SAAS;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC/D,MAAM,WAAW,GAAG,IAAI,SAAS,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpD,IAAI,WAAW,EAAE,WAAW,EAAE,IAAI,KAAK,cAAc,IAAI,WAAW,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACrG,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;gBAC9D,MAAM,IAAI,GAAG;oBACX,IAAI,EAAE,UAAU;oBAChB,EAAE,EAAE,WAAW,CAAC,WAAW,CAAC,WAAW;oBACvC,KAAK,EAAE,SAAS;oBAChB,gBAAgB,EAAE,WAAW,CAAC,WAAW,CAAC,gBAAgB;oBAC1D,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,IAAI;iBACnC,CAAC;gBACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,eAAe,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC;YACpC,OAAO;QACT,CAAC;QACD,0BAA0B;QAC1B,MAAM,kBAAkB,GAAG,iCAAiC,CAAC;QAC7D,MAAM,mBAAmB,GAAG,CAAC,MAAM,IAAI,CAAC,kBAAkB,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QACzJ,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;YACjE,MAAM,SAAS,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YACjE,MAAM,YAAY,GAAG,IAAI,SAAS,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,IAAI,UAAU;gBACtD,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,IAAI,EAAE;aAC3D,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,iBAAiB,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACjG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACzC,CAAC;iBACI,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;gBACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACzC,CAAC;iBACI,CAAC;gBACJ,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC7E,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,2DAA2D;QAC3D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9E,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW;QACf,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACvF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;CAEF"}