sfdx-hardis/lib/common/docBuilder/docBuilderPermissionSet.js

Swiss-army-knife Toolbox for Salesforce. Allows you to define a complete CD/CD Pipeline. Orchestrate base commands and assist users with interactive wizards

import { XMLBuilder, XMLParser } from "fast-xml-parser";
import { buildGenericMarkdownTable, prettifyFieldName } from "../utils/flowVisualiser/nodeFormatUtils.js";
import { DocBuilderProfile } from "./docBuilderProfile.js";
export class DocBuilderPermissionSet extends DocBuilderProfile {
    docType = "PermissionSet";
    promptKey = "PROMPT_DESCRIBE_PERMISSION_SET";
    placeholder = "<!-- PermissionSet description -->";
    xmlRootKey = "PermissionSet";
    docsSection = "permissionsets";
    static buildIndexTable(prefix, permissionSetDescriptions, filterObject = null) {
        const filteredPsets = filterObject ? permissionSetDescriptions.filter(pSet => pSet.impactedObjects.includes(filterObject)) : permissionSetDescriptions;
        if (filteredPsets.length === 0) {
            return [];
        }
        const lines = [];
        lines.push(...[
            filterObject ? "## Related Permission Sets" : "## Permission Sets",
            "",
            "| Permission Set | User License |",
            "| :----      | :--: | "
        ]);
        for (const pSet of filteredPsets) {
            const pSetNameCell = `[${pSet.name}](${prefix}${encodeURIComponent(pSet.name)}.md)`;
            lines.push(...[
                `| ${pSetNameCell} | ${pSet.license || "None"} |`
            ]);
        }
        lines.push("");
        return lines;
    }
    async buildInitialMarkdownLines() {
        return [
            `## ${this.metadataName}`,
            '',
            '<div id="jstree-container"></div>',
            '',
            buildGenericMarkdownTable(this.parsedXmlObject, ["label", "description", "license", "hasActivationRequired"], "## Permission Set attributes", []),
            '',
            '<!-- Permission Set Groups table -->',
            '',
            '<!-- PermissionSet description -->',
            '',
        ];
    }
    stripXmlForAi() {
        const xmlObj = new XMLParser().parse(this.metadataXml);
        // Remove class access: not relevant for prompt
        if (xmlObj?.PermissionSet?.classAccesses) {
            delete xmlObj.PermissionSet.classAccesses;
        }
        // Remove flowAccesses: not relevant for prompt
        if (xmlObj?.PermissionSet?.flowAccesses) {
            delete xmlObj.PermissionSet.flowAccesses;
        }
        const xmlStripped = new XMLBuilder().build(xmlObj);
        return xmlStripped;
    }
    // Generate json for display with jsTree npm library 
    async generateJsonTree() {
        const xmlObj = new XMLParser().parse(this.metadataXml);
        const treeElements = [];
        for (const psRootAttribute of Object.keys(xmlObj?.PermissionSet || {})) {
            if (["label", "license", "hasActivationRequired", "description"].includes(psRootAttribute)) {
                continue;
            }
            let attributeValue = xmlObj.PermissionSet[psRootAttribute];
            if (!Array.isArray(attributeValue)) {
                attributeValue = [attributeValue];
            }
            const attributeTreeRoot = {
                text: prettifyFieldName(psRootAttribute),
                icon: "fa-solid fa-folder icon-blue",
                a_attr: { href: null },
                children: [],
            };
            if (psRootAttribute === "fieldPermissions") {
                // Sort custom fields by object name
                this.buildObjectFieldsTree(attributeValue, attributeTreeRoot);
            }
            else {
                for (const element of attributeValue) {
                    if (!this.isAccessibleElement(element)) {
                        continue;
                    }
                    const subElement = this.getSubElement(element);
                    attributeTreeRoot.children.push(subElement);
                }
                attributeTreeRoot.text = attributeTreeRoot.text + " (" + attributeTreeRoot.children.length + ")";
            }
            if (attributeTreeRoot.children.length > 0) {
                treeElements.push(attributeTreeRoot);
            }
        }
        return treeElements;
    }
}
//# sourceMappingURL=docBuilderPermissionSet.js.map