sfdx-hardis 5.24.3-alpha202504040902.0 → 5.25.0

package/lib/common/docBuilder/docBuilderPackageXml.js

@@ -0,0 +1,136 @@
+import c from 'chalk';
+import * as path from 'path';
+import fs from 'fs-extra';
+import { SfError } from '@salesforce/core';
+import { uxLog } from '../utils/index.js';
+import { countPackageXmlItems, parsePackageXmlFile } from '../utils/xmlUtils.js';
+import { SalesforceSetupUrlBuilder } from './docUtils.js';
+import { CONSTANTS } from '../../config/index.js';
+export class DocBuilderPackageXML {
+    static async buildIndexTable(outputPackageXmlMarkdownFiles) {
+        const packageLines = [];
+        const packagesForMenu = { "All manifests": "manifests.md" };
+        packageLines.push(...[
+            "## Package XML files",
+            "",
+            "| Package name | Description |",
+            "| :----------- | :---------- |"
+        ]);
+        for (const outputPackageXmlDef of outputPackageXmlMarkdownFiles) {
+            const metadataNb = await countPackageXmlItems(outputPackageXmlDef.path);
+            const packageMdFile = path.basename(outputPackageXmlDef.path) + ".md";
+            const label = outputPackageXmlDef.name ? `Package folder: ${outputPackageXmlDef.name}` : path.basename(outputPackageXmlDef.path);
+            const packageTableLine = `| [${label}](${packageMdFile}) (${metadataNb}) | ${outputPackageXmlDef.description} |`;
+            packageLines.push(packageTableLine);
+            packagesForMenu[label] = packageMdFile;
+        }
+        packageLines.push("");
+        packageLines.push("___");
+        packageLines.push("");
+        return { packageLines, packagesForMenu };
+    }
+    static async generatePackageXmlMarkdown(inputFile, outputFile = null, packageXmlDefinition = null, rootSalesforceUrl = "") {
+        // Find packageXml to parse if not defined
+        if (inputFile == null) {
+            inputFile = path.join(process.cwd(), "manifest", "package.xml");
+            if (!fs.existsSync(inputFile)) {
+                throw new SfError("No package.xml found. You need to send the path to a package.xml file in --inputfile option");
+            }
+        }
+        // Build output file if not defined
+        if (outputFile == null) {
+            const packageXmlFileName = path.basename(inputFile);
+            outputFile = path.join(process.cwd(), "docs", `${packageXmlFileName}.md`);
+        }
+        await fs.ensureDir(path.dirname(outputFile));
+        uxLog(this, `Generating markdown doc from ${inputFile} to ${outputFile}...`);
+        // Read content
+        const packageXmlContent = await parsePackageXmlFile(inputFile);
+        const metadataTypes = Object.keys(packageXmlContent);
+        metadataTypes.sort();
+        const nbItems = await countPackageXmlItems(inputFile);
+        const mdLines = [];
+        if (packageXmlDefinition && packageXmlDefinition.description) {
+            // Header
+            mdLines.push(...[
+                `## Content of ${path.basename(inputFile)}`,
+                '',
+                packageXmlDefinition.description,
+                '',
+                `Metadatas: ${nbItems}`,
+                ''
+            ]);
+        }
+        else {
+            // Header
+            mdLines.push(...[
+                `## Content of ${path.basename(inputFile)}`,
+                '',
+                `Metadatas: ${nbItems}`,
+                ''
+            ]);
+        }
+        // Generate package.xml markdown
+        for (const metadataType of metadataTypes) {
+            const members = packageXmlContent[metadataType];
+            members.sort();
+            const memberLengthLabel = members.length === 1 && members[0] === "*" ? "*" : members.length;
+            mdLines.push(`<details><summary>${metadataType} (${memberLengthLabel})</summary>\n\n`);
+            for (const member of members) {
+                const memberLabel = member === "*" ? "ALL (wildcard *)" : member;
+                const setupUrl = SalesforceSetupUrlBuilder.getSetupUrl(metadataType, member);
+                if (setupUrl && rootSalesforceUrl) {
+                    mdLines.push(`  • <a href="${rootSalesforceUrl}${setupUrl}" target="_blank">${memberLabel}</a><br/>`);
+                }
+                else {
+                    mdLines.push(`  • ${memberLabel}<br/>`);
+                }
+            }
+            mdLines.push("");
+            mdLines.push("</details>");
+            mdLines.push("");
+        }
+        mdLines.push("");
+        // Footer
+        mdLines.push(`_Documentation generated with [sfdx-hardis](${CONSTANTS.DOC_URL_ROOT})_`);
+        // Write output file
+        await fs.writeFile(outputFile, mdLines.join("\n") + "\n");
+        uxLog(this, c.green(`Successfully generated ${path.basename(inputFile)} documentation into ${outputFile}`));
+        return outputFile;
+    }
+    static listPackageXmlCandidates() {
+        return [
+            // CI/CD package files
+            {
+                path: "manifest/package.xml",
+                description: "Contains all deployable metadatas of the SFDX project"
+            },
+            {
+                path: "manifest/packageDeployOnce.xml",
+                description: "Contains all metadatas that will never be overwritten during deployment if they are already existing in the target org"
+            },
+            {
+                path: "manifest/package-no-overwrite.xml",
+                description: "Contains all metadatas that will never be overwritten during deployment if they are already existing in the target org"
+            },
+            {
+                path: "manifest/destructiveChanges.xml",
+                description: "Contains all metadatas that will be deleted during deployment, in case they are existing in the target org"
+            },
+            // Monitoring package files
+            {
+                path: "manifest/package-all-org-items.xml",
+                description: "Contains the entire list of metadatas that are present in the monitored org (not all of them are in the git backup)"
+            },
+            {
+                path: "manifest/package-backup-items.xml",
+                description: "Contains the list of metadatas that are in the git backup"
+            },
+            {
+                path: "manifest/package-skip-items.xml",
+                description: "Contains the list of metadatas that are excluded from the backup.<br/>Other metadata types might be skipped using environment variable MONITORING_BACKUP_SKIP_METADATA_TYPES"
+            },
+        ];
+    }
+}
+//# sourceMappingURL=docBuilderPackageXml.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docBuilderPackageXml.js","sourceRoot":"","sources":["../../../src/common/docBuilder/docBuilderPackageXml.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,OAAO,CAAC;AACtB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,OAAO,oBAAoB;IAExB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,6BAAoC;QACtE,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAQ,EAAE,eAAe,EAAE,cAAc,EAAE,CAAA;QAChE,YAAY,CAAC,IAAI,CAAC,GAAG;YACnB,sBAAsB;YACtB,EAAE;YACF,gCAAgC;YAChC,gCAAgC;SACjC,CAAC,CAAC;QAEH,KAAK,MAAM,mBAAmB,IAAI,6BAA6B,EAAE,CAAC;YAChE,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACxE,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACtE,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,mBAAmB,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACjI,MAAM,gBAAgB,GAAG,MAAM,KAAK,KAAK,aAAa,MAAM,UAAU,OAAO,mBAAmB,CAAC,WAAW,IAAI,CAAC;YACjH,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACpC,eAAe,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC;QACzC,CAAC;QACD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtB,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtB,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,SAAwB,EAAE,aAA4B,IAAI,EAAE,uBAA4B,IAAI,EAAE,oBAA4B,EAAE;QACzK,0CAA0C;QAC1C,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;YAChE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,OAAO,CAAC,6FAA6F,CAAC,CAAC;YACnH,CAAC;QACH,CAAC;QACD,mCAAmC;QACnC,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpD,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,kBAAkB,KAAK,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAE7C,KAAK,CAAC,IAAI,EAAE,gCAAgC,SAAS,OAAO,UAAU,KAAK,CAAC,CAAC;QAE7E,eAAe;QACf,MAAM,iBAAiB,GAAG,MAAM,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC/D,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACrD,aAAa,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAa,EAAE,CAAA;QAE5B,IAAI,oBAAoB,IAAI,oBAAoB,CAAC,WAAW,EAAE,CAAC;YAC7D,SAAS;YACT,OAAO,CAAC,IAAI,CAAC,GAAG;gBACd,iBAAiB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBAC3C,EAAE;gBACF,oBAAoB,CAAC,WAAW;gBAChC,EAAE;gBACF,cAAc,OAAO,EAAE;gBACvB,EAAE;aACH,CAAC,CAAC;QACL,CAAC;aACI,CAAC;YACJ,SAAS;YACT,OAAO,CAAC,IAAI,CAAC,GAAG;gBACd,iBAAiB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBAC3C,EAAE;gBACF,cAAc,OAAO,EAAE;gBACvB,EAAE;aACH,CAAC,CAAC;QACL,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChD,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5F,OAAO,CAAC,IAAI,CAAC,qBAAqB,YAAY,KAAK,iBAAiB,iBAAiB,CAAC,CAAC;YACvF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,WAAW,GAAG,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC;gBACjE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBAC7E,IAAI,QAAQ,IAAI,iBAAiB,EAAE,CAAC;oBAClC,OAAO,CAAC,IAAI,CAAC,gBAAgB,iBAAiB,GAAG,QAAQ,qBAAqB,WAAW,WAAW,CAAC,CAAC;gBACxG,CAAC;qBACI,CAAC;oBACJ,OAAO,CAAC,IAAI,CAAC,OAAO,WAAW,OAAO,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEjB,SAAS;QACT,OAAO,CAAC,IAAI,CAAC,+CAA+C,SAAS,CAAC,YAAY,IAAI,CAAC,CAAC;QAExF,oBAAoB;QACpB,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAE1D,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC,CAAC;QAE5G,OAAO,UAAU,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,wBAAwB;QACpC,OAAO;YACL,sBAAsB;YACtB;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,uDAAuD;aACrE;YACD;gBACE,IAAI,EAAE,gCAAgC;gBACtC,WAAW,EAAE,wHAAwH;aACtI;YACD;gBACE,IAAI,EAAE,mCAAmC;gBACzC,WAAW,EAAE,wHAAwH;aACtI;YACD;gBACE,IAAI,EAAE,iCAAiC;gBACvC,WAAW,EAAE,4GAA4G;aAC1H;YACD,2BAA2B;YAC3B;gBACE,IAAI,EAAE,oCAAoC;gBAC1C,WAAW,EAAE,qHAAqH;aACnI;YACD;gBACE,IAAI,EAAE,mCAAmC;gBACzC,WAAW,EAAE,2DAA2D;aACzE;YACD;gBACE,IAAI,EAAE,iCAAiC;gBACvC,WAAW,EAAE,8KAA8K;aAC5L;SACF,CAAC;IACJ,CAAC;CAEF"}

package/lib/common/docBuilder/docBuilderPage.d.ts

@@ -0,0 +1,10 @@
+import { PromptTemplate } from "../aiProvider/promptTemplates.js";
+import { DocBuilderRoot } from "./docBuilderRoot.js";
+export declare class DocBuilderPage extends DocBuilderRoot {
+    docType: string;
+    promptKey: PromptTemplate;
+    placeholder: string;
+    xmlRootKey: string;
+    static buildIndexTable(prefix: string, pageDescriptions: any, filterObject?: string | null): string[];
+    buildInitialMarkdownLines(): Promise<string[]>;
+}

package/lib/common/docBuilder/docBuilderPage.js

@@ -0,0 +1,40 @@
+import { buildGenericMarkdownTable } from "../utils/flowVisualiser/nodeFormatUtils.js";
+import { DocBuilderRoot } from "./docBuilderRoot.js";
+export class DocBuilderPage extends DocBuilderRoot {
+    docType = "Page";
+    promptKey = "PROMPT_DESCRIBE_PAGE";
+    placeholder = "<!-- Page description -->";
+    xmlRootKey = "FlexiPage";
+    static buildIndexTable(prefix, pageDescriptions, filterObject = null) {
+        const filteredPages = filterObject ? pageDescriptions.filter(page => page.impactedObjects.includes(filterObject)) : pageDescriptions;
+        if (filteredPages.length === 0) {
+            return [];
+        }
+        const lines = [];
+        lines.push(...[
+            filterObject ? "## Related Lightning Pages" : "## Lightning Pages",
+            "",
+            "| Lightning Page | Type |",
+            "| :----      | :--: | "
+        ]);
+        for (const page of filteredPages) {
+            const pageNameCell = `[${page.name}](${prefix}${page.name}.md)`;
+            lines.push(...[
+                `| ${pageNameCell} | ${page.type} |`
+            ]);
+        }
+        lines.push("");
+        return lines;
+    }
+    async buildInitialMarkdownLines() {
+        return [
+            `## ${this.metadataName}`,
+            '',
+            buildGenericMarkdownTable(this.parsedXmlObject, ["sobjectType", "type", "masterLabel", "template"], "## Lightning Page attributes", []),
+            '',
+            '<!-- Page description -->',
+            '',
+        ];
+    }
+}
+//# sourceMappingURL=docBuilderPage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docBuilderPage.js","sourceRoot":"","sources":["../../../src/common/docBuilder/docBuilderPage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,OAAO,cAAe,SAAQ,cAAc;IAEzC,OAAO,GAAG,MAAM,CAAC;IACjB,SAAS,GAAmB,sBAAsB,CAAC;IACnD,WAAW,GAAG,2BAA2B,CAAC;IAC1C,UAAU,GAAG,WAAW,CAAC;IAGzB,MAAM,CAAC,eAAe,CAAC,MAAc,EAAE,gBAAqB,EAAE,eAA8B,IAAI;QACrG,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC;QACrI,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,GAAG;YACZ,YAAY,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,oBAAoB;YAClE,EAAE;YACF,2BAA2B;YAC3B,wBAAwB;SACzB,CAAC,CAAC;QACH,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,GAAG,IAAI,CAAC,IAAI,MAAM,CAAC;YAChE,KAAK,CAAC,IAAI,CAAC,GAAG;gBACZ,KAAK,YAAY,MAAM,IAAI,CAAC,IAAI,IAAI;aACrC,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO;YACL,MAAM,IAAI,CAAC,YAAY,EAAE;YACzB,EAAE;YACF,yBAAyB,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,8BAA8B,EAAE,EAAE,CAAC;YACvI,EAAE;YACF,2BAA2B;YAC3B,EAAE;SACH,CAAC;IACJ,CAAC;CAEF"}

package/lib/common/docBuilder/docBuilderProfile.d.ts

@@ -0,0 +1,11 @@
+import { PromptTemplate } from "../aiProvider/promptTemplates.js";
+import { DocBuilderRoot } from "./docBuilderRoot.js";
+export declare class DocBuilderProfile extends DocBuilderRoot {
+    docType: string;
+    promptKey: PromptTemplate;
+    placeholder: string;
+    xmlRootKey: string;
+    static buildIndexTable(prefix: string, profileDescriptions: any[], filterObject?: string | null): string[];
+    buildInitialMarkdownLines(): Promise<string[]>;
+    stripXmlForAi(): Promise<string>;
+}

package/lib/common/docBuilder/docBuilderProfile.js

@@ -0,0 +1,86 @@
+import { XMLBuilder, XMLParser } from "fast-xml-parser";
+import { buildGenericMarkdownTable } from "../utils/flowVisualiser/nodeFormatUtils.js";
+import { DocBuilderRoot } from "./docBuilderRoot.js";
+export class DocBuilderProfile extends DocBuilderRoot {
+    docType = "Profile";
+    promptKey = "PROMPT_DESCRIBE_PROFILE";
+    placeholder = "<!-- Profile description -->";
+    xmlRootKey = "Profile";
+    static buildIndexTable(prefix, profileDescriptions, filterObject = null) {
+        const filteredProfiles = filterObject ? profileDescriptions.filter(profile => profile.impactedObjects.includes(filterObject)) : profileDescriptions;
+        if (filteredProfiles.length === 0) {
+            return [];
+        }
+        const lines = [];
+        lines.push(...[
+            filterObject ? "## Related Profiles" : "## Profiles",
+            "",
+            "| Profile | User License |",
+            "| :----      | :--: | "
+        ]);
+        for (const profile of filteredProfiles) {
+            const profileNameCell = `[${profile.name}](${prefix}${encodeURIComponent(profile.name)}.md)`;
+            lines.push(...[
+                `| ${profileNameCell} | ${profile.userLicense} |`
+            ]);
+        }
+        lines.push("");
+        return lines;
+    }
+    async buildInitialMarkdownLines() {
+        return [
+            `## ${this.metadataName}`,
+            '',
+            '<!-- Profile description -->',
+            '',
+            buildGenericMarkdownTable(this.parsedXmlObject, ["allFields"], "## Profile attributes", []),
+        ];
+    }
+    stripXmlForAi() {
+        const xmlObj = new XMLParser().parse(this.metadataXml);
+        // Remove class access: not relevant for prompt
+        if (xmlObj?.Profile?.classAccesses) {
+            delete xmlObj.Profile.classAccesses;
+        }
+        // Remove fieldPermissions: not relevant for prompt
+        if (xmlObj?.Profile?.fieldPermissions) {
+            delete xmlObj.Profile.fieldPermissions;
+        }
+        // Remove flowAccesses: not relevant for prompt
+        if (xmlObj?.Profile?.flowAccesses) {
+            delete xmlObj.Profile.flowAccesses;
+        }
+        // Remove layoutAssignments: not relevant for prompt
+        if (xmlObj?.Profile?.layoutAssignments) {
+            delete xmlObj.Profile.layoutAssignments;
+        }
+        // Remove pageAccesses: not relevant for prompt
+        if (xmlObj?.Profile?.pageAccesses) {
+            delete xmlObj.Profile.pageAccesses;
+        }
+        // Keep only visible applications
+        if (xmlObj?.Profile?.applicationVisibilities) {
+            if (!Array.isArray(xmlObj.Profile.applicationVisibilities)) {
+                xmlObj.Profile.applicationVisibilities = [xmlObj.Profile.applicationVisibilities];
+            }
+            xmlObj.Profile.applicationVisibilities = xmlObj.Profile.applicationVisibilities.filter(applicationVisibility => applicationVisibility.visible === true);
+        }
+        // Keep only visible recordTypes
+        if (xmlObj?.Profile?.recordTypeVisibilities) {
+            if (!Array.isArray(xmlObj.Profile.recordTypeVisibilities)) {
+                xmlObj.Profile.recordTypeVisibilities = [xmlObj.Profile.recordTypeVisibilities];
+            }
+            xmlObj.Profile.recordTypeVisibilities = xmlObj.Profile.recordTypeVisibilities.filter(rt => rt.visible === true);
+        }
+        // Keep only visible tabs
+        if (xmlObj?.Profile?.tabVisibilities) {
+            if (!Array.isArray(xmlObj.Profile.tabVisibilities)) {
+                xmlObj.Profile.tabVisibilities = [xmlObj.Profile.tabVisibilities];
+            }
+            xmlObj.Profile.tabVisibilities = xmlObj.Profile.tabVisibilities.filter(tab => tab.visibility === 'Hidden');
+        }
+        const xmlStripped = new XMLBuilder().build(xmlObj);
+        return xmlStripped;
+    }
+}
+//# sourceMappingURL=docBuilderProfile.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docBuilderProfile.js","sourceRoot":"","sources":["../../../src/common/docBuilder/docBuilderProfile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IAE5C,OAAO,GAAG,SAAS,CAAC;IACpB,SAAS,GAAmB,yBAAyB,CAAC;IACtD,WAAW,GAAG,8BAA8B,CAAC;IAC7C,UAAU,GAAG,SAAS,CAAC;IAEvB,MAAM,CAAC,eAAe,CAAC,MAAc,EAAE,mBAA0B,EAAE,eAA8B,IAAI;QAC1G,MAAM,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACpJ,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,GAAG;YACZ,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,aAAa;YACpD,EAAE;YACF,4BAA4B;YAC5B,wBAAwB;SACzB,CAAC,CAAC;QACH,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;YACvC,MAAM,eAAe,GAAG,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;YAC7F,KAAK,CAAC,IAAI,CAAC,GAAG;gBACZ,KAAK,eAAe,MAAM,OAAO,CAAC,WAAW,IAAI;aAClD,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO;YACL,MAAM,IAAI,CAAC,YAAY,EAAE;YACzB,EAAE;YACF,8BAA8B;YAC9B,EAAE;YACF,yBAAyB,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,WAAW,CAAC,EAAE,uBAAuB,EAAE,EAAE,CAAC;SAC5F,CAAC;IACJ,CAAC;IAEM,aAAa;QAClB,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,+CAA+C;QAC/C,IAAI,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;QACtC,CAAC;QACD,mDAAmD;QACnD,IAAI,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;YACtC,OAAO,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC;QACzC,CAAC;QACD,+CAA+C;QAC/C,IAAI,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QACrC,CAAC;QACD,oDAAoD;QACpD,IAAI,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;QAC1C,CAAC;QACD,+CAA+C;QAC/C,IAAI,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QACrC,CAAC;QACD,iCAAiC;QACjC,IAAI,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC;gBAC3D,MAAM,CAAC,OAAO,CAAC,uBAAuB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YACpF,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,uBAAuB,GAAG,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC,qBAAqB,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QAC1J,CAAC;QACD,gCAAgC;QAChC,IAAI,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;YAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,OAAO,CAAC,sBAAsB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAClF,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,sBAAsB,GAAG,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QAClH,CAAC;QACD,yBAAyB;QACzB,IAAI,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;gBACnD,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpE,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC;QAC7G,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnD,OAAO,WAAW,CAAA;IACpB,CAAC;CAEF"}

package/lib/common/docBuilder/docBuilderRoot.d.ts

@@ -0,0 +1,18 @@
+import { PromptTemplate } from '../aiProvider/promptTemplates.js';
+export declare abstract class DocBuilderRoot {
+    docType: string;
+    promptKey: PromptTemplate;
+    placeholder: string;
+    xmlRootKey: string;
+    metadataName: string;
+    metadataXml: string;
+    outputFile: string;
+    additionalVariables: any;
+    markdownDoc: string;
+    parsedXmlObject: any;
+    constructor(metadataName: string, metadataXml: string, outputFile: string, additionalVariables?: any);
+    buildInitialMarkdownLines(): Promise<string[]>;
+    generateMarkdownFileFromXml(): Promise<string>;
+    completeDocWithAiDescription(): Promise<string>;
+    stripXmlForAi(): Promise<string>;
+}

package/lib/common/docBuilder/docBuilderRoot.js

@@ -0,0 +1,79 @@
+import c from 'chalk';
+import { UtilsAi } from "../aiProvider/utils.js";
+import { uxLog } from "../utils/index.js";
+import { AiProvider } from '../aiProvider/index.js';
+import { XMLParser } from 'fast-xml-parser';
+import fs from 'fs-extra';
+import path from 'path';
+import { getMetaHideLines } from './docUtils.js';
+import { CONSTANTS } from '../../config/index.js';
+export class DocBuilderRoot {
+    docType;
+    promptKey;
+    placeholder;
+    xmlRootKey;
+    metadataName;
+    metadataXml = "";
+    outputFile;
+    additionalVariables;
+    markdownDoc;
+    parsedXmlObject;
+    constructor(metadataName, metadataXml, outputFile, additionalVariables = {}) {
+        this.metadataName = metadataName;
+        this.metadataXml = metadataXml;
+        this.outputFile = outputFile;
+        this.additionalVariables = additionalVariables;
+    }
+    // This method must be overridden
+    async buildInitialMarkdownLines() {
+        return [];
+    }
+    async generateMarkdownFileFromXml() {
+        if (this.xmlRootKey) {
+            this.parsedXmlObject = new XMLParser().parse(this.metadataXml)?.[this.xmlRootKey] || {};
+        }
+        // Main lines generated by overridden method
+        const mdLines = await this.buildInitialMarkdownLines();
+        // Footer
+        mdLines.push("");
+        mdLines.push(`_Documentation generated with [sfdx-hardis](${CONSTANTS.DOC_URL_ROOT})_`);
+        this.markdownDoc = mdLines.join("\n") + "\n";
+        this.markdownDoc = await this.completeDocWithAiDescription();
+        await fs.ensureDir(path.dirname(this.outputFile));
+        await fs.writeFile(this.outputFile, getMetaHideLines() + this.markdownDoc);
+        uxLog(this, c.green(`Successfully generated ${this.metadataName} documentation into ${this.outputFile}`));
+        return this.outputFile;
+    }
+    async completeDocWithAiDescription() {
+        const xmlStripped = await this.stripXmlForAi();
+        const aiCache = await UtilsAi.findAiCache(this.promptKey, [xmlStripped], this.metadataName);
+        if (aiCache.success === true) {
+            uxLog(this, c.grey(`Used AI cache for ${this.docType.toLowerCase()} description (set IGNORE_AI_CACHE=true to force call to AI)`));
+            const replaceText = `## AI-Generated Description\n\n<!-- Cache file: ${aiCache.aiCacheDirFile} -->\n\n${aiCache.cacheText || ""}`;
+            this.markdownDoc = this.markdownDoc.replace(this.placeholder, replaceText);
+            return this.markdownDoc;
+        }
+        if (AiProvider.isAiAvailable()) {
+            const defaultVariables = { [`${this.docType.toUpperCase()}_NAME`]: this.metadataName, [`${this.docType.toUpperCase()}_XML`]: xmlStripped };
+            const variables = { ...defaultVariables, ...this.additionalVariables };
+            const prompt = AiProvider.buildPrompt(this.promptKey, variables);
+            const aiResponse = await AiProvider.promptAi(prompt, this.promptKey);
+            if (aiResponse?.success) {
+                let responseText = aiResponse.promptResponse || "No AI description available";
+                if (responseText.startsWith("##")) {
+                    responseText = responseText.split("\n").slice(1).join("\n");
+                }
+                await UtilsAi.writeAiCache(this.promptKey, [xmlStripped], this.metadataName, responseText);
+                const replaceText = `## AI-Generated Description\n\n<!-- Cache file: ${aiCache.aiCacheDirFile} -->\n\n${responseText}`;
+                this.markdownDoc = this.markdownDoc.replace(this.placeholder, replaceText);
+                return this.markdownDoc;
+            }
+        }
+        return this.markdownDoc;
+    }
+    // Override this method if you need to make a smaller XML to fit in the number of prompt tokens
+    async stripXmlForAi() {
+        return this.metadataXml;
+    }
+}
+//# sourceMappingURL=docBuilderRoot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docBuilderRoot.js","sourceRoot":"","sources":["../../../src/common/docBuilder/docBuilderRoot.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,OAAO,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,OAAgB,cAAc;IAC3B,OAAO,CAAS;IAChB,SAAS,CAAiB;IAC1B,WAAW,CAAS;IACpB,UAAU,CAAS;IAEnB,YAAY,CAAS;IACrB,WAAW,GAAW,EAAE,CAAC;IACzB,UAAU,CAAS;IACnB,mBAAmB,CAAM;IAEzB,WAAW,CAAS;IACpB,eAAe,CAAM;IAE5B,YAAY,YAAoB,EAAE,WAAmB,EAAE,UAAkB,EAAE,sBAA2B,EAAE;QACtG,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACjD,CAAC;IAED,iCAAiC;IAC1B,KAAK,CAAC,yBAAyB;QACpC,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,KAAK,CAAC,2BAA2B;QACtC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,eAAe,GAAG,IAAI,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC1F,CAAC;QACD,4CAA4C;QAC5C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACvD,SAAS;QACT,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,+CAA+C,SAAS,CAAC,YAAY,IAAI,CAAC,CAAC;QAExF,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;QAE7D,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAClD,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3E,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,YAAY,uBAAuB,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC1G,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,4BAA4B;QACvC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5F,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,6DAA6D,CAAC,CAAC,CAAC;YAClI,MAAM,WAAW,GAAG,mDAAmD,OAAO,CAAC,cAAc,WAAW,OAAO,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YAClI,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAED,IAAI,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;YAC/B,MAAM,gBAAgB,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;YAC3I,MAAM,SAAS,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvE,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAEjE,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrE,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;gBACxB,IAAI,YAAY,GAAG,UAAU,CAAC,cAAc,IAAI,6BAA6B,CAAC;gBAC9E,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9D,CAAC;gBACD,MAAM,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;gBAC3F,MAAM,WAAW,GAAG,mDAAmD,OAAO,CAAC,cAAc,WAAW,YAAY,EAAE,CAAC;gBACvH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;gBAC3E,OAAO,IAAI,CAAC,WAAW,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,+FAA+F;IACxF,KAAK,CAAC,aAAa;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CAEF"}

package/lib/common/docBuilder/docUtils.d.ts

@@ -1,4 +1,3 @@
-export declare function generatePackageXmlMarkdown(inputFile: string | null, outputFile?: string | null, packageXmlDefinition?: any, rootSalesforceUrl?: string): Promise<string>;
 export declare function readMkDocsFile(mkdocsYmlFile: string): any;
 export declare function writeMkDocsFile(mkdocsYmlFile: string, mkdocsYml: any): Promise<void>;
 export declare class SalesforceSetupUrlBuilder {
@@ -15,10 +14,7 @@ export declare class SalesforceSetupUrlBuilder {
      */
     static getSetupUrl(metadataType: string, apiName: string): string | null;
 }
-export declare function generateObjectMarkdown(objectName: string, objectXmlDefinition: string, allObjectsNames: string, objectLinksDetails: string, outputFile: string): Promise<string>;
-export declare function generateLightningPageMarkdown(pageName: string, pageXml: string, outputFile: string): Promise<string>;
 export declare function completeAttributesDescriptionWithAi(attributesMarkdown: string, objectName: string): Promise<string>;
-export declare function completeApexDocWithAiDescription(apexMarkdownDoc: string, className: string, apexCode: string): Promise<string>;
 export declare function replaceInFile(filePath: string, stringToReplace: string, replaceWith: string): Promise<void>;
 export declare function generateMkDocsHTML(): Promise<void>;
 export declare function installMkDocs(): Promise<boolean>;