@salesforce/packaging 2.3.10 → 2.4.1

package/lib/interfaces/packagingSObjects.d.ts

@@ -299,4 +299,10 @@ export declare namespace PackagingSObjects {
         IsDeprecated: boolean;
         MetadataZip?: string;
     };
+    type MetadataPackage = {
+        Id: string;
+        Name: string;
+        NamespacePrefix: string;
+        PackageCategory: 'Application' | 'Module' | 'Package' | 'Package2';
+    };
 }

package/lib/package/package.d.ts

@@ -1,5 +1,5 @@
 import { Connection, SfProject } from '@salesforce/core';
-import { ConvertPackageOptions, PackageCreateOptions, PackageOptions, PackageSaveResult, PackageType, PackageUpdateOptions, PackageVersionCreateRequestResult, PackageVersionListOptions, PackageVersionListResult, PackagingSObjects, PackageVersionMetadataDownloadOptions, PackageVersionMetadataDownloadResult } from '../interfaces';
+import { ConvertPackageOptions, PackageCreateOptions, PackageOptions, PackageSaveResult, PackageType, PackageUpdateOptions, PackageVersionCreateRequestResult, PackageVersionListOptions, PackageVersionListResult, PackageVersionMetadataDownloadOptions, PackageVersionMetadataDownloadResult, PackagingSObjects } from '../interfaces';
 import { PackageAncestry } from './packageAncestry';
 export declare const Package2Fields: string[];
 /**

package/lib/package/package.js

@@ -7,13 +7,11 @@ exports.Package = exports.Package2Fields = void 0;
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-const path = require("path");
-const fs = require("fs");
 const core_1 = require("@salesforce/core");
-const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const packageUtils_1 = require("../utils/packageUtils");
 const packageCreate_1 = require("./packageCreate");
 const packageConvert_1 = require("./packageConvert");
+const packageVersionRetrieve_1 = require("./packageVersionRetrieve");
 const packageVersionList_1 = require("./packageVersionList");
 const packageDelete_1 = require("./packageDelete");
 const packageAncestry_1 = require("./packageAncestry");
@@ -162,46 +160,7 @@ class Package {
      * @returns
      */
     static async downloadPackageVersionMetadata(project, options, connection) {
-        // Validate the destination path is suitable to extract package version metadata (must be new or empty)
-        const destinationFolder = options.destinationFolder ?? 'force-app';
-        if (path.isAbsolute(destinationFolder)) {
-            throw messages.createError('sourcesDownloadDirectoryMustBeRelative');
-        }
-        const destinationPath = path.join(project.getPath(), destinationFolder);
-        if (!fs.existsSync(destinationPath)) {
-            fs.mkdirSync(destinationPath, { recursive: true });
-        }
-        if (!(0, packageUtils_1.isPackageDirectoryEffectivelyEmpty)(destinationPath)) {
-            throw messages.createError('sourcesDownloadDirectoryNotEmpty');
-        }
-        // Get the MetadataZip URL from the MetadataPackageVersion record
-        const subscriberPackageVersionId = project.getPackageIdFromAlias(options.subscriberPackageVersionId) ?? options.subscriberPackageVersionId;
-        const versionInfo = (await connection.tooling
-            .sobject('MetadataPackageVersion')
-            .retrieve(subscriberPackageVersionId));
-        if (!versionInfo.MetadataZip) {
-            throw messages.createError('unableToAccessMetadataZip');
-        }
-        const responseBase64 = await connection.tooling.request(versionInfo.MetadataZip, {
-            encoding: 'base64',
-        });
-        const buffer = Buffer.from(responseBase64, 'base64');
-        // 2GP packages have the package.zip wrapped in an outer zip.
-        let tree = await source_deploy_retrieve_1.ZipTreeContainer.create(buffer);
-        if (tree.exists('package.zip')) {
-            tree = await source_deploy_retrieve_1.ZipTreeContainer.create(await tree.readFile('package.zip'));
-        }
-        const zipComponents = source_deploy_retrieve_1.ComponentSet.fromSource({
-            fsPaths: ['.'],
-            tree,
-        })
-            .getSourceComponents()
-            .toArray();
-        return new source_deploy_retrieve_1.MetadataConverter().convert(zipComponents, 'source', {
-            type: 'directory',
-            outputDirectory: destinationPath,
-            genUniqueDir: false,
-        });
+        return (0, packageVersionRetrieve_1.retrievePackageVersionMetadata)(project, options, connection);
     }
     static getPackage2Fields(connection) {
         const apiVersion = connection.getApiVersion();

package/lib/package/packageConvert.d.ts

@@ -1,6 +1,6 @@
 import { Connection, SfProject } from '@salesforce/core';
 import { ConvertPackageOptions, PackageVersionCreateRequestResult, PackagingSObjects } from '../interfaces';
-export declare function findOrCreatePackage2(seedPackage: string, connection: Connection): Promise<string>;
+export declare function findOrCreatePackage2(seedPackage: string, connection: Connection, project?: SfProject): Promise<string>;
 export declare function convertPackage(pkg: string, connection: Connection, options: ConvertPackageOptions, project?: SfProject): Promise<PackageVersionCreateRequestResult>;
 /**
  * Convert the list of command line options to a JSON object that can be used to create an Package2VersionCreateRequest entity.

package/lib/package/packageConvert.js

@@ -29,8 +29,8 @@ const getLogger = () => {
     }
     return logger;
 };
-async function findOrCreatePackage2(seedPackage, connection) {
-    const query = `SELECT Id FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
+async function findOrCreatePackage2(seedPackage, connection, project) {
+    const query = `SELECT Id, Name FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
     const queryResult = (await connection.tooling.query(query)).records;
     if (queryResult?.length > 1) {
         const ids = queryResult.map((r) => r.Id);
@@ -38,6 +38,9 @@ async function findOrCreatePackage2(seedPackage, connection) {
     }
     if (queryResult?.length === 1) {
         // return the package2 object
+        if (project) {
+            await addPackageAlias(project, queryResult[0].Name, queryResult[0].Id);
+        }
         return queryResult[0].Id;
     }
     // Need to create a new Package2
@@ -62,6 +65,9 @@ async function findOrCreatePackage2(seedPackage, connection) {
     if (!createResult.success) {
         throw pkgUtils.combineSaveErrors('Package2', 'create', createResult.errors);
     }
+    if (project) {
+        await addPackageAlias(project, subscriberResult.Name, createResult.id);
+    }
     return createResult.id;
 }
 exports.findOrCreatePackage2 = findOrCreatePackage2;
@@ -71,7 +77,7 @@ async function convertPackage(pkg, connection, options, project) {
     if (options.wait) {
         maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.minutes;
     }
-    const packageId = await findOrCreatePackage2(pkg, connection);
+    const packageId = await findOrCreatePackage2(pkg, connection, project);
     const apiVersion = project?.getSfProjectJson()?.get('sourceApiVersion');
     const request = await createPackageVersionCreateRequest({
         installationkey: options.installationKey,
@@ -179,7 +185,7 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, project
                 if (isStatusEqualTo(results, [Package2VersionStatus.success])) {
                     // update sfdx-project.json
                     let projectUpdated = false;
-                    if (project && !process.env.SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
+                    if (project && !kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE')) {
                         projectUpdated = true;
                         const query = `SELECT MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE Id = '${results[0].Package2VersionId}'`;
                         const packageVersionVersionString = await connection.tooling
@@ -238,6 +244,12 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, project
     });
     return pollingClient.subscribe();
 }
+async function addPackageAlias(project, packageName, packageId) {
+    if (!kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE')) {
+        project.getSfProjectJson().addPackageAlias(packageName, packageId);
+        await project.getSfProjectJson().write();
+    }
+}
 /**
  * Return true if the queryResult.records[0].Status is equal to one of the values in statuses.
  *

package/lib/package/packageCreate.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPackage = exports.createPackageDirEntry = exports.createPackageRequestFromContext = void 0;
 const core_1 = require("@salesforce/core");
+const kit_1 = require("@salesforce/kit");
 const pkgUtils = require("../utils/packageUtils");
 const packageUtils_1 = require("../utils/packageUtils");
 function createPackageRequestFromContext(project, options) {
@@ -39,7 +40,7 @@ function createPackageDirEntry(project, options) {
     if (!packageDir) {
         // no match - create a new one
         isNew = true;
-        packageDir = pkgUtils.DEFAULT_PACKAGE_DIR;
+        packageDir = { ...pkgUtils.DEFAULT_PACKAGE_DIR };
         packageDir.path = (0, packageUtils_1.replaceIfEmpty)(packageDir.path, options.path);
     }
     if (packageDirs.length === 0) {
@@ -69,7 +70,7 @@ async function createPackage(connection, project, options) {
     if (!createResult.success) {
         throw pkgUtils.combineSaveErrors('Package2', 'create', createResult.errors);
     }
-    if (!process.env.SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE) {
+    if (!kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE')) {
         const packageDirectory = createPackageDirEntry(project, options);
         project.getSfProjectJson().addPackageDirectory(packageDirectory);
         project.getSfProjectJson().addPackageAlias(options.name, createResult.id);

package/lib/package/packageVersion.js

@@ -498,7 +498,7 @@ class PackageVersion {
         return updateResult;
     }
     async updateProjectWithPackageVersion(results) {
-        if (!process.env.SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
+        if (!kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE')) {
             // get the newly created package version from the server
             const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${results.SubscriberPackageVersionId}'`)).records[0];
             const aliases = this.project.getAliasesFromPackageId(results.Package2Id);

package/lib/package/packageVersionCreate.js

@@ -221,7 +221,7 @@ class PackageVersionCreate {
      * @private
      */
     async createPackageVersionCreateRequestFromOptions() {
-        const preserveFiles = !!(this.options.preserve ?? process.env.SFDX_PACKAGE2_VERSION_CREATE_PRESERVE);
+        const preserveFiles = !!(this.options.preserve ?? kit_1.env.getBoolean('SFDX_PACKAGE2_VERSION_CREATE_PRESERVE'));
         const uniqueHash = (0, packageUtils_1.uniqid)({ template: `${this.packageId}-%s` });
         const packageVersTmpRoot = path.join(os.tmpdir(), `${uniqueHash}`);
         const packageVersMetadataFolder = path.join(packageVersTmpRoot, 'md-files');
@@ -858,6 +858,7 @@ const packageXmlStringToPackageXmlJson = (rawXml) => {
         // make sure types and members is always an array
         isArray: (name) => ['types', 'members'].includes(name),
     });
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     return parser.parse(rawXml).Package;
 };
 exports.packageXmlStringToPackageXmlJson = packageXmlStringToPackageXmlJson;

package/lib/package/packageVersionRetrieve.d.ts

@@ -0,0 +1,11 @@
+import { Connection, SfProject } from '@salesforce/core';
+import { PackageVersionMetadataDownloadOptions, PackageVersionMetadataDownloadResult } from '../interfaces';
+/**
+ * Download the metadata files for a previously published package version, convert them to source format, and put them into a new project folder within the sfdx project.
+ *
+ * @param project
+ * @param options {@link PackageVersionMetadataDownloadOptions}
+ * @param connection
+ * @returns
+ */
+export declare function retrievePackageVersionMetadata(project: SfProject, options: PackageVersionMetadataDownloadOptions, connection: Connection): Promise<PackageVersionMetadataDownloadResult>;

package/lib/package/packageVersionRetrieve.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrievePackageVersionMetadata = void 0;
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const path = require("path");
+const fs = require("fs");
+const core_1 = require("@salesforce/core");
+const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
+const kit_1 = require("@salesforce/kit");
+const packageUtils_1 = require("../utils/packageUtils");
+const packageCreate_1 = require("./packageCreate");
+const package_1 = require("./package");
+const packageVersion_1 = require("./packageVersion");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package');
+let logger;
+const getLogger = () => {
+    if (!logger) {
+        logger = core_1.Logger.childFromRoot('packageVersionRetrieve');
+    }
+    return logger;
+};
+/**
+ * Download the metadata files for a previously published package version, convert them to source format, and put them into a new project folder within the sfdx project.
+ *
+ * @param project
+ * @param options {@link PackageVersionMetadataDownloadOptions}
+ * @param connection
+ * @returns
+ */
+async function retrievePackageVersionMetadata(project, options, connection) {
+    // Validate the destination path is suitable to extract package version metadata (must be new or empty)
+    const destinationFolder = options.destinationFolder ?? 'force-app';
+    if (path.isAbsolute(destinationFolder)) {
+        throw messages.createError('sourcesDownloadDirectoryMustBeRelative');
+    }
+    const destinationPath = path.join(project.getPath(), destinationFolder);
+    if (!fs.existsSync(destinationPath)) {
+        fs.mkdirSync(destinationPath, { recursive: true });
+    }
+    if (!(0, packageUtils_1.isPackageDirectoryEffectivelyEmpty)(destinationPath)) {
+        throw messages.createError('sourcesDownloadDirectoryNotEmpty');
+    }
+    // Get the MetadataZip URL from the MetadataPackageVersion record
+    const subscriberPackageVersionId = project.getPackageIdFromAlias(options.subscriberPackageVersionId) ?? options.subscriberPackageVersionId;
+    const versionInfo = (await connection.tooling
+        .sobject('MetadataPackageVersion')
+        .retrieve(subscriberPackageVersionId));
+    if (!versionInfo.MetadataZip) {
+        throw messages.createError('unableToAccessMetadataZip');
+    }
+    const responseBase64 = await connection.tooling.request(versionInfo.MetadataZip, {
+        encoding: 'base64',
+    });
+    const buffer = Buffer.from(responseBase64, 'base64');
+    let tree = await source_deploy_retrieve_1.ZipTreeContainer.create(buffer);
+    let dependencies = [];
+    // 2GP packages declare their dependencies in dependency-ids.json within the outer zip.
+    if (tree.exists('dependency-ids.json')) {
+        const f = await tree.readFile('dependency-ids.json');
+        const idsObj = JSON.parse(f.toString());
+        if (idsObj?.ids) {
+            dependencies = idsObj.ids;
+        }
+    }
+    // 2GP packages have the package.zip wrapped in an outer zip.
+    if (tree.exists('package.zip')) {
+        tree = await source_deploy_retrieve_1.ZipTreeContainer.create(await tree.readFile('package.zip'));
+    }
+    const zipComponents = source_deploy_retrieve_1.ComponentSet.fromSource({
+        fsPaths: ['.'],
+        tree,
+    })
+        .getSourceComponents()
+        .toArray();
+    const result = await new source_deploy_retrieve_1.MetadataConverter().convert(zipComponents, 'source', {
+        type: 'directory',
+        outputDirectory: destinationPath,
+        genUniqueDir: false,
+    });
+    await attemptToUpdateProjectJson(project, connection, versionInfo.MetadataPackageId, subscriberPackageVersionId, dependencies, destinationFolder);
+    return result;
+}
+exports.retrievePackageVersionMetadata = retrievePackageVersionMetadata;
+/**
+ * Attempt to update the sfdx-project.json file to add information about the retrieved sources. If this fails for some reason we
+ * print out an error message and return so the user will still see a list of retrieved metadata.
+ *
+ */
+async function attemptToUpdateProjectJson(project, connection, packageId, subscriberPackageVersionId, dependencyIds, destinationFolder) {
+    if (kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_RETRIEVE')) {
+        getLogger().info('Skipping sfdx-project.json updates because SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_RETRIEVE is set');
+        return;
+    }
+    try {
+        const packageInfo = (await connection.tooling
+            .sobject('MetadataPackage')
+            .retrieve(packageId));
+        if (packageInfo.PackageCategory !== 'Package2') {
+            getLogger().info(`Skipping sfdx-project.json updates because ${packageId} is not a 2GP package. It has a PackageCategory of '${packageInfo.PackageCategory}'`);
+            return;
+        }
+        const queryOptions = {
+            whereClause: `WHERE SubscriberPackageVersionId = '${subscriberPackageVersionId}'`,
+        };
+        const versions = await packageVersion_1.PackageVersion.queryPackage2Version(connection, queryOptions);
+        if (versions.length && versions[0]) {
+            const version = versions[0];
+            const pkg = new package_1.Package({
+                packageAliasOrId: version.Package2Id,
+                project,
+                connection,
+            });
+            const pkgData = await pkg.getPackageData();
+            if (pkgData) {
+                const dirEntry = (0, packageCreate_1.createPackageDirEntry)(project, {
+                    name: pkgData.Name,
+                    description: pkgData.Description,
+                    path: destinationFolder,
+                    noNamespace: pkgData.NamespacePrefix != null,
+                    orgDependent: pkgData.IsOrgDependent,
+                    packageType: pkgData.ContainerOptions,
+                    errorNotificationUsername: pkgData.PackageErrorUsername,
+                });
+                const dependencies = dependencyIds.map((dep) => ({ package: dep }));
+                const namedDir = {
+                    ...dirEntry,
+                    versionNumber: '<set version number>',
+                    versionName: '<set version name>',
+                    ancestorVersion: '<set ancestor version>',
+                    dependencies,
+                };
+                project.getSfProjectJson().addPackageDirectory(namedDir);
+                const packageVersionVersionString = `${version.MajorVersion}.${version.MinorVersion}.${version.PatchVersion}-${version.BuildNumber}`;
+                const [alias, writtenId] = await (0, packageUtils_1.generatePackageAliasEntry)(connection, project, subscriberPackageVersionId, packageVersionVersionString, 'main', pkg.getId());
+                project.getSfProjectJson().addPackageAlias(alias, writtenId);
+                if (pkgData.ContainerOptions === 'Managed' && !project.getSfProjectJson().getContents().namespace) {
+                    project.getSfProjectJson().getContents().namespace = pkgData.NamespacePrefix;
+                }
+                await project.getSfProjectJson().write();
+            }
+            else {
+                getLogger().warn(`Failed to update sfdx-project.json. Could not find package for ${version.Package2Id}. This should never happen.`);
+            }
+        }
+        else {
+            getLogger().info(`Could not find Package2Version record for ${subscriberPackageVersionId}. No updates to sfdx-project.json will be made.`);
+        }
+    }
+    catch (e) {
+        const msg = e instanceof Error ? e.message : e;
+        getLogger().error(`Encountered error trying to update sfdx-project.json after retrieving package version metadata: ${msg}`);
+    }
+}
+//# sourceMappingURL=packageVersionRetrieve.js.map

package/lib/package/profileRewriter.js

@@ -78,6 +78,7 @@ const profileStringToProfile = (profileString) => {
         numberParseOptions: { leadingZeros: false, hex: false },
         isArray: (name) => rewriteProps.includes(name),
     });
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     return parser.parse(profileString).Profile;
 };
 exports.profileStringToProfile = profileStringToProfile;

package/lib/utils/packageUtils.d.ts

@@ -111,11 +111,11 @@ export declare function copyDescriptorProperties(packageDescriptorJson: PackageD
 export declare function replaceIfEmpty<T>(value: T, replacement: T): T;
 /**
  * Brand new SFDX projects contain a force-app directory tree contiaining empty folders
- * and a few .eslint.json files. We still want to consider such a directory tree
+ * and a few .eslintrc.json files. We still want to consider such a directory tree
  * as 'empty' for the sake of operations like downloading package version metadata.
  *
  * @param directory The absolute path to a directory
  * @returns true if the directory contains nothing except empty directories or
- * directories containing only an .eslint.json file.
+ * directories containing only an .eslintrc.json file.
  */
 export declare function isPackageDirectoryEffectivelyEmpty(directory: string): boolean;

package/lib/utils/packageUtils.js

@@ -410,12 +410,12 @@ function replaceIfEmpty(value, replacement) {
 exports.replaceIfEmpty = replaceIfEmpty;
 /**
  * Brand new SFDX projects contain a force-app directory tree contiaining empty folders
- * and a few .eslint.json files. We still want to consider such a directory tree
+ * and a few .eslintrc.json files. We still want to consider such a directory tree
  * as 'empty' for the sake of operations like downloading package version metadata.
  *
  * @param directory The absolute path to a directory
  * @returns true if the directory contains nothing except empty directories or
- * directories containing only an .eslint.json file.
+ * directories containing only an .eslintrc.json file.
  */
 function isPackageDirectoryEffectivelyEmpty(directory) {
     if (!fs.lstatSync(directory).isDirectory()) {
@@ -424,7 +424,7 @@ function isPackageDirectoryEffectivelyEmpty(directory) {
     const entries = fs.readdirSync(directory, { withFileTypes: true });
     return entries.every((entry) => entry.isDirectory()
         ? isPackageDirectoryEffectivelyEmpty((0, path_1.join)(directory, entry.name))
-        : entry.name === '.eslint.json');
+        : entry.name === '.eslintrc.json');
 }
 exports.isPackageDirectoryEffectivelyEmpty = isPackageDirectoryEffectivelyEmpty;
 //# sourceMappingURL=packageUtils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "2.3.10",
+  "version": "2.4.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -47,7 +47,7 @@
     "@salesforce/schemas": "^1.6.0",
     "@salesforce/source-deploy-retrieve": "^9.7.13",
     "@salesforce/ts-types": "^2.0.6",
-    "fast-xml-parser": "^4.2.5",
+    "fast-xml-parser": "^4.3.0",
     "globby": "^11",
     "graphology": "^0.25.4",
     "graphology-traversal": "^0.3.1",