@salesforce/packaging 2.2.9-profiles.0 → 2.2.9-profiles.1

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -370,6 +370,4 @@ export declare const Package1VersionEvents: {
         progress: string;
     };
 };
-export type PackageXml = {
-    Package: Pick<Package, 'types' | 'version'>;
-};
+export type PackageXml = Pick<Package, 'types' | 'version'>;

package/lib/package/packageProfileApi.d.ts

@@ -10,16 +10,18 @@ export declare class PackageProfileApi extends AsyncCreatable<ProfileApiOptions>
      * For any profile present in the workspace, this function generates a subset of data that only contains references
      * to items in the manifest.
      *
+     * return a list of profile file locations that need to be removed from the package because they are empty
+     *
      * @param destPath location of new profiles
      * @param manifestTypes: array of objects { name: string, members: string[] } that represent package xml types
      * @param excludedDirectories Directories to not include profiles from
      */
-    generateProfiles(destPath: string, manifestTypes: PackageXml['Package']['types'], excludedDirectories?: string[]): string[];
+    generateProfiles(destPath: string, manifestTypes: PackageXml['types'], excludedDirectories?: string[]): string[];
     /**
      * Filter out all profiles in the manifest and if any profiles exists in the workspace, add them to the manifest.
      *
      * @param typesArr array of objects { name[], members[] } that represent package types JSON.
      * @param excludedDirectories Direcotires not to generate profiles for
      */
-    filterAndGenerateProfilesForManifest(typesArr: PackageXml['Package']['types'], excludedDirectories?: string[]): PackageXml['Package']['types'];
+    filterAndGenerateProfilesForManifest(typesArr: PackageXml['types'], excludedDirectories?: string[]): PackageXml['types'];
 }

package/lib/package/packageProfileApi.js

@@ -33,39 +33,45 @@ class PackageProfileApi extends kit_1.AsyncCreatable {
      * For any profile present in the workspace, this function generates a subset of data that only contains references
      * to items in the manifest.
      *
+     * return a list of profile file locations that need to be removed from the package because they are empty
+     *
      * @param destPath location of new profiles
      * @param manifestTypes: array of objects { name: string, members: string[] } that represent package xml types
      * @param excludedDirectories Directories to not include profiles from
      */
     generateProfiles(destPath, manifestTypes, excludedDirectories = []) {
         const logger = core_1.Logger.childFromRoot('PackageProfileApi');
-        const profilePathsWithNames = getProfilesWithNamesAndPaths({
+        return (getProfilesWithNamesAndPaths({
             projectPath: this.project.getPath(),
             excludedDirectories,
-        });
-        const results = profilePathsWithNames.map(({ profilePath, name: profileName }) => {
+        })
+            .map(({ profilePath, name: profileName }) => {
             const originalProfile = (0, profileRewriter_1.profileStringToProfile)(fs.readFileSync(profilePath, 'utf-8'));
             const adjustedProfile = (0, profileRewriter_1.profileRewriter)(originalProfile, (0, profileRewriter_1.manifestTypesToMap)(manifestTypes), this.includeUserLicenses);
-            const hasContent = Object.keys(adjustedProfile).length;
-            return { profileName, profilePath, hasContent, adjustedProfile, originalProfile };
-        });
-        results.map(({ profilePath, adjustedProfile, hasContent, profileName, originalProfile }) => {
+            return {
+                profileName,
+                profilePath,
+                hasContent: Object.keys(adjustedProfile).length,
+                adjustedProfile,
+                removedSettings: getRemovedSettings(originalProfile, adjustedProfile),
+                xmlFileLocation: getXmlFileLocation(destPath, profilePath),
+            };
+        })
+            // side effect: modify profiles in place
+            .filter(({ hasContent, profileName, removedSettings, profilePath, xmlFileLocation, adjustedProfile }) => {
             if (!hasContent) {
                 logger.warn(`Profile ${profileName} has no content after filtering. It will still be part of the package but you can remove if it it's not needed.`);
+                return true;
             }
-            logger.info(profileApiMessages.getMessage('addProfileToPackage', [profileName, profilePath]));
-            getRemovedSettings(originalProfile, adjustedProfile).forEach((setting) => {
-                logger.info(profileApiMessages.getMessage('removeProfileSetting', [setting, profileName]));
-            });
-            fs.writeFileSync(getXmlFileLocation(destPath, profilePath), (0, profileRewriter_1.profileObjectToString)(adjustedProfile), 'utf-8');
-        });
-        return results.map((profile) => {
-            const xmlFile = getXmlFileLocation(destPath, profile.profilePath);
-            const replacedProfileName = xmlFile.replace(/(.*)(\.profile)/, '$1');
-            deleteButAllowEnoent(xmlFile);
-            logger.info(profileApiMessages.getMessage('profileNotIncluded', [replacedProfileName]));
-            return replacedProfileName;
-        });
+            else {
+                logger.info(profileApiMessages.getMessage('addProfileToPackage', [profileName, profilePath]));
+                removedSettings.forEach((setting) => {
+                    logger.info(profileApiMessages.getMessage('removeProfileSetting', [setting, profileName]));
+                });
+                fs.writeFileSync(xmlFileLocation, (0, profileRewriter_1.profileObjectToString)(adjustedProfile), 'utf-8');
+            }
+        })
+            .map(({ xmlFileLocation }) => xmlFileLocation.replace(/(.*)(\.profile)/, '$1')));
     }
     /**
      * Filter out all profiles in the manifest and if any profiles exists in the workspace, add them to the manifest.
@@ -94,20 +100,9 @@ const getProfilesWithNamesAndPaths = ({ projectPath, excludedDirectories, }) =>
     .map((profilePath) => ({ profilePath, name: profilePathToName(profilePath) }))
     .filter(isProfilePathWithName);
 const getXmlFileLocation = (destPath, profilePath) => path.join(destPath, path.basename(profilePath).replace(/(.*)(-meta.xml)/, '$1'));
-const deleteButAllowEnoent = (destFilePath) => {
-    try {
-        fs.unlinkSync(destFilePath);
-    }
-    catch (err) {
-        // It is normal for the file to not exist if the profile is in the workspace but not in the directory being packaged.
-        if (err instanceof Error && 'code' in err && err.code !== 'ENOENT') {
-            throw err;
-        }
-    }
-};
 const getRemovedSettings = (originalProfile, adjustedProfile) => {
     const originalProfileSettings = Object.keys(originalProfile);
-    const adjustedProfileSettings = Object.keys(adjustedProfile);
-    return originalProfileSettings.filter((setting) => !adjustedProfileSettings.includes(setting));
+    const adjustedProfileSettings = new Set(Object.keys(adjustedProfile));
+    return originalProfileSettings.filter((setting) => !adjustedProfileSettings.has(setting));
 };
 //# sourceMappingURL=packageProfileApi.js.map

package/lib/package/packageVersionCreate.d.ts

@@ -1,5 +1,5 @@
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
-import { MDFolderForArtifactOptions, PackageVersionCreateOptions, PackageVersionCreateRequestResult } from '../interfaces';
+import { MDFolderForArtifactOptions, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageXml } from '../interfaces';
 export declare class PackageVersionCreate {
     private options;
     private apiVersionFromPackageXml;
@@ -66,3 +66,8 @@ export declare class MetadataResolver {
      */
     private convertMetadata;
 }
+export declare const packageXmlStringToPackageXmlJson: (rawXml: string) => PackageXml;
+/**
+ * Converts PackageXmlJson to a string representing the Xml
+ * */
+export declare const packageXmlJsonToXmlString: (packageXmlJson: PackageXml) => string;

package/lib/package/packageVersionCreate.js

@@ -6,15 +6,15 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetadataResolver = exports.PackageVersionCreate = void 0;
+exports.packageXmlJsonToXmlString = exports.packageXmlStringToPackageXmlJson = exports.MetadataResolver = exports.PackageVersionCreate = void 0;
 const path = require("path");
 const os = require("os");
 const fs = require("fs");
 const core_1 = require("@salesforce/core");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const scratchOrgSettingsGenerator_1 = require("@salesforce/core/lib/org/scratchOrgSettingsGenerator");
-const xml2js = require("xml2js");
 const kit_1 = require("@salesforce/kit");
+const fast_xml_parser_1 = require("fast-xml-parser");
 const pkgUtils = require("../utils/packageUtils");
 const packageUtils_1 = require("../utils/packageUtils");
 const interfaces_1 = require("../interfaces");
@@ -329,16 +329,16 @@ class PackageVersionCreate {
         // metadata exclusions. If necessary, read the existing package.xml and then re-write it.
         const currentPackageXml = await fs.promises.readFile(path.join(packageVersMetadataFolder, 'package.xml'), 'utf8');
         // convert to json
-        const packageXmlAsJson = (await xml2js.parseStringPromise(currentPackageXml));
-        if (!packageXmlAsJson?.Package) {
+        const packageXmlAsJson = (0, exports.packageXmlStringToPackageXmlJson)(currentPackageXml);
+        if (!packageXmlAsJson) {
             throw messages.createError('packageXmlDoesNotContainPackage');
         }
-        if (!packageXmlAsJson?.Package?.types) {
+        if (!packageXmlAsJson?.types) {
             throw messages.createError('packageXmlDoesNotContainPackageTypes');
         }
         fs.mkdirSync(packageVersMetadataFolder, { recursive: true });
         fs.mkdirSync(packageVersProfileFolder, { recursive: true });
-        this.apiVersionFromPackageXml = packageXmlAsJson.Package.version;
+        this.apiVersionFromPackageXml = packageXmlAsJson.version;
         const sourceApiVersion = this.project?.getSfProjectJson()?.get('sourceApiVersion');
         const hasSeedMetadata = await this.metadataResolver.resolveMetadata(this.packageObject.seedMetadata?.path, seedMetadataFolder, 'seedMDDirectoryDoesNotExist', sourceApiVersion);
         let hasUnpackagedMetadata = false;
@@ -351,19 +351,16 @@ class PackageVersionCreate {
             .getPackageDirectories()
             .map((packageDir) => packageDir.unpackagedMetadata?.path)
             .filter((packageDirPath) => packageDirPath);
-        const typesArr = this.options?.profileApi?.filterAndGenerateProfilesForManifest(packageXmlAsJson.Package.types, profileExcludeDirs) ?? packageXmlAsJson.Package.types;
+        const typesArr = this.options?.profileApi?.filterAndGenerateProfilesForManifest(packageXmlAsJson.types, profileExcludeDirs) ??
+            packageXmlAsJson.types;
         // Next generate profiles and retrieve any profiles that were excluded because they had no matching nodes.
         const excludedProfiles = this.options?.profileApi?.generateProfiles(packageVersProfileFolder, typesArr, profileExcludeDirs);
-        if (excludedProfiles?.length) {
-            const profileIdx = typesArr.findIndex((e) => e.name === 'Profile');
-            typesArr[profileIdx].members = typesArr[profileIdx].members.filter((e) => !excludedProfiles.includes(e));
-        }
-        packageXmlAsJson.Package.types = typesArr;
-        // Re-write the package.xml in case profiles have been added or removed
-        const xmlBuilder = new xml2js.Builder({
-            xmldec: { version: '1.0', encoding: 'UTF-8' },
+        packageXmlAsJson.types = typesArr.map((type) => {
+            if (type.name !== 'Profile')
+                return type;
+            return { ...type, members: type.members.filter((m) => !excludedProfiles?.includes(m)) };
         });
-        const xml = xmlBuilder.buildObject(packageXmlAsJson);
+        const xml = (0, exports.packageXmlJsonToXmlString)(packageXmlAsJson);
         await fs.promises.writeFile(path.join(packageVersMetadataFolder, 'package.xml'), xml, 'utf-8');
         // Zip the packageVersMetadataFolder folder and put the zip in {packageVersBlobDirectory}/package.zip
         await (0, packageUtils_1.zipDir)(packageVersMetadataFolder, metadataZipFile);
@@ -850,4 +847,39 @@ class MetadataResolver {
     }
 }
 exports.MetadataResolver = MetadataResolver;
+const packageXmlStringToPackageXmlJson = (rawXml) => {
+    const parser = new fast_xml_parser_1.XMLParser({
+        ignoreAttributes: true,
+        parseTagValue: false,
+        parseAttributeValue: false,
+        cdataPropName: '__cdata',
+        ignoreDeclaration: true,
+        numberParseOptions: { leadingZeros: false, hex: false },
+        // make sure types and members is always an array
+        isArray: (name) => ['types', 'members'].includes(name),
+    });
+    return parser.parse(rawXml).Package;
+};
+exports.packageXmlStringToPackageXmlJson = packageXmlStringToPackageXmlJson;
+/**
+ * Converts PackageXmlJson to a string representing the Xml
+ * */
+const packageXmlJsonToXmlString = (packageXmlJson) => {
+    const builder = new fast_xml_parser_1.XMLBuilder({
+        format: true,
+        indentBy: '    ',
+        ignoreAttributes: false,
+        cdataPropName: '__cdata',
+        processEntities: false,
+        attributeNamePrefix: '@@@',
+    });
+    return String(builder.build({
+        '?xml': {
+            '@@@version': '1.0',
+            '@@@encoding': 'UTF-8',
+        },
+        Package: { ...packageXmlJson, '@@@xmlns': 'http://soap.sforce.com/2006/04/metadata' },
+    }));
+};
+exports.packageXmlJsonToXmlString = packageXmlJsonToXmlString;
 //# sourceMappingURL=packageVersionCreate.js.map

package/lib/package/profileRewriter.d.ts

@@ -22,10 +22,16 @@ export type CorrectedProfile = Profile & {
  */
 export declare const profileRewriter: (profileJson: CorrectedProfile, packageXml: PackageMap, retainUserLicense?: boolean) => CorrectedProfile;
 export declare const fieldCorrections: (fieldName: string) => string;
+/**
+ * @param profileString: raw xml read from the file
+ * @returns CorrectedProfile (json representation of the profile)
+ */
 export declare const profileStringToProfile: (profileString: string) => CorrectedProfile;
-/** pass in an object that has the Profile props at the top level.  This function will add the outer wrapper `Profile` */
+/** pass in an object that has the Profile props at the top level.
+ * This function will add the outer wrapper `Profile`  and convert the result to xml
+ * */
 export declare const profileObjectToString: (profileObject: Partial<CorrectedProfile>) => string;
 /** it's easier to do lookups by Metadata Type on a Map */
-export declare const manifestTypesToMap: (original: PackageXml['Package']['types']) => PackageMap;
+export declare const manifestTypesToMap: (original: PackageXml['types']) => PackageMap;
 type PackageMap = Map<string, string[]>;
 export {};

package/lib/package/profileRewriter.js

@@ -64,19 +64,26 @@ const allMembers = (packageXml) => Array.from(packageXml.values()).flat();
 // profile.fieldPermissions will display them with the more specific 'Task' or 'Event'
 const fieldCorrections = (fieldName) => fieldName.replace(/^Event\./, 'Activity.').replace(/^Task\./, 'Activity.');
 exports.fieldCorrections = fieldCorrections;
+/**
+ * @param profileString: raw xml read from the file
+ * @returns CorrectedProfile (json representation of the profile)
+ */
 const profileStringToProfile = (profileString) => {
     const parser = new fast_xml_parser_1.XMLParser({
-        ignoreAttributes: false,
+        ignoreAttributes: true,
         parseTagValue: false,
         parseAttributeValue: false,
         cdataPropName: '__cdata',
         ignoreDeclaration: true,
         numberParseOptions: { leadingZeros: false, hex: false },
+        isArray: (name) => rewriteProps.includes(name),
     });
-    return parser.parse(profileString);
+    return parser.parse(profileString).Profile;
 };
 exports.profileStringToProfile = profileStringToProfile;
-/** pass in an object that has the Profile props at the top level.  This function will add the outer wrapper `Profile` */
+/** pass in an object that has the Profile props at the top level.
+ * This function will add the outer wrapper `Profile`  and convert the result to xml
+ * */
 const profileObjectToString = (profileObject) => {
     const builder = new fast_xml_parser_1.XMLBuilder({
         format: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "2.2.9-profiles.0",
+  "version": "2.2.9-profiles.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -53,8 +53,7 @@
     "graphology-traversal": "^0.3.1",
     "graphology-types": "^0.24.7",
     "jsforce": "^2.0.0-beta.27",
-    "jszip": "^3.10.1",
-    "xml2js": "^0.6.0"
+    "jszip": "^3.10.1"
   },
   "devDependencies": {
     "@salesforce/cli-plugins-testkit": "^4.1.1",
@@ -64,7 +63,6 @@
     "@salesforce/ts-sinon": "^1.4.11",
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",
-    "@types/xml2js": "^0.4.11",
     "@typescript-eslint/eslint-plugin": "^5.60.0",
     "@typescript-eslint/parser": "^5.61.0",
     "chai": "^4.3.7",