@salesforce/packaging 4.7.0 → 4.9.0

package/lib/interfaces/packagingSObjects.d.ts

@@ -56,6 +56,7 @@ export declare namespace PackagingSObjects {
         EndToEndBuildDurationInSeconds?: number;
         TotalNumberOfMetadataFiles: number;
         TotalSizeOfMetadataFiles: number;
+        DeveloperUsePkgZip?: string;
     };
     enum Package2VersionStatus {
         queued = "Queued",
@@ -302,7 +303,6 @@ export declare namespace PackagingSObjects {
         PatchVersion: number;
         BuildNumber: number;
         IsDeprecated: boolean;
-        MetadataZip?: string;
     };
     type MetadataPackage = {
         Id: string;

package/lib/package/packageVersion.js

@@ -51,6 +51,7 @@ exports.Package2VersionFields = [
     'BuildDurationInSeconds',
     'HasMetadataRemoved',
     'EndToEndBuildDurationInSeconds',
+    'DeveloperUsePkgZip',
 ];
 /**
  * Provides the ability to create, update, delete, and promote 2nd
@@ -408,7 +409,10 @@ class PackageVersion {
                     label1: packageUtils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID.label,
                     label2: packageUtils_1.BY_LABEL.PACKAGE_VERSION_ID.label,
                 };
-            const allFields = PackageVersion.getPackage2VersionFields(this.connection).toString();
+            let allFieldsArr = PackageVersion.getPackage2VersionFields(this.connection);
+            // Remove DeveloperUsePkgZip because the user may not have the DownloadPackageVersionZips user permission
+            allFieldsArr = allFieldsArr.filter((field) => field !== 'DeveloperUsePkgZip');
+            const allFields = allFieldsArr.toString();
             const query = `SELECT ${allFields} FROM Package2Version WHERE ${queryConfig.clause} LIMIT 1`;
             try {
                 this.data = await this.connection.singleRecordQuery(query, { tooling: true });

package/lib/package/packageVersionRetrieve.js

@@ -42,19 +42,43 @@ async function retrievePackageVersionMetadata(project, options, connection) {
     if (!(0, packageUtils_1.isPackageDirectoryEffectivelyEmpty)(destinationPath)) {
         throw messages.createError('sourcesDownloadDirectoryNotEmpty');
     }
-    // Get the MetadataZip URL from the MetadataPackageVersion record
+    // Get the DeveloperUsePkgZip URL from the Package2Version 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');
+    // Query Package2Version to get the record by SubscriberPackageVersionId
+    const queryOptions = {
+        whereClause: `WHERE SubscriberPackageVersionId = '${subscriberPackageVersionId}'`,
+    };
+    let versionInfo;
+    try {
+        [versionInfo] = await packageVersion_1.PackageVersion.queryPackage2Version(connection, queryOptions);
+    }
+    catch (e) {
+        const msg = e instanceof Error ? e.message : String(e);
+        if (msg.includes("No such column 'DeveloperUsePkgZip' on entity 'Package2Version'")) {
+            throw messages.createError('developerUsePkgZipFieldUnavailable');
+        }
+        if (msg.includes("sObject type 'Package2Version' is not supported.")) {
+            throw messages.createError('packagingNotEnabledOnOrg');
+        }
+        throw e;
+    }
+    if (!versionInfo?.DeveloperUsePkgZip) {
+        throw messages.createError('developerUsePkgZipFieldUnavailable');
     }
-    const responseBase64 = await connection.tooling.request(versionInfo.MetadataZip, {
+    const responseBase64 = await connection.tooling.request(versionInfo.DeveloperUsePkgZip, {
         encoding: 'base64',
     });
     const buffer = Buffer.from(responseBase64, 'base64');
-    let tree = await source_deploy_retrieve_1.ZipTreeContainer.create(buffer);
+    let tree;
+    try {
+        tree = await source_deploy_retrieve_1.ZipTreeContainer.create(buffer);
+    }
+    catch (e) {
+        if (e instanceof Error && e.message.includes('data length = 0')) {
+            throw messages.createError('downloadDeveloperPackageZipHasNoData');
+        }
+        throw e;
+    }
     let dependencies = [];
     // 2GP packages declare their dependencies in dependency-ids.json within the outer zip.
     if (tree.exists('dependency-ids.json')) {
@@ -79,7 +103,7 @@ async function retrievePackageVersionMetadata(project, options, connection) {
         outputDirectory: destinationPath,
         genUniqueDir: false,
     });
-    await attemptToUpdateProjectJson(project, connection, versionInfo.MetadataPackageId, subscriberPackageVersionId, dependencies, destinationFolder);
+    await attemptToUpdateProjectJson(project, connection, versionInfo.Package2Id, subscriberPackageVersionId, dependencies, destinationFolder);
     return result;
 }
 /**
@@ -94,13 +118,6 @@ async function attemptToUpdateProjectJson(project, connection, packageId, subscr
         return;
     }
     try {
-        const packageInfo = (await connection.tooling
-            .sobject('MetadataPackage')
-            .retrieve(packageId));
-        if (packageInfo.PackageCategory !== 'Package2') {
-            logger.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}'`,
         };

package/messages/package.md

@@ -28,18 +28,20 @@ Enabling App Analytics is only possible with API version 59.0 or higher.
 
 # sourcesDownloadDirectoryNotEmpty
 
-Can’t retrieve package version metadata. The specified directory isn’t empty. Empty the directory, or create a new one and try again.
+Can't retrieve package version metadata. The specified directory isn't empty. Empty the directory, or create a new one and try again.
 
 # sourcesDownloadDirectoryMustBeRelative
 
-Can’t retrieve package version metadata. The specified directory must be relative to your Salesforce DX project directory, and not an absolute path.
+Can't retrieve package version metadata. The specified directory must be relative to your Salesforce DX project directory, and not an absolute path.
 
-# unableToAccessMetadataZip
+# developerUsePkgZipFieldUnavailable
 
-The sf package version retrieve command has been removed. This feature isn’t quite ready for prime time, so we’re removing it for now while we make improvements. We’ll let you know after it’s back up.
+Can't retrieve package metadata. To use this feature, you must first assign yourself the DownloadPackageVersionZips user permission. Then retry retrieving your package metadata.
 
-# errorDownloadingMetadataZip
+# downloadDeveloperPackageZipHasNoData
 
-Can’t retrieve package version metadata.
+Can't retrieve package metadata. We're unable to retrieve metadata for the package version you specified. Retrieving package metadata is available to converted 2GP package versions only. If the package you specified is a converted 2GP package, try creating a new package version, and then retry retrieving the package metadata for the new package version. If your package is a 1GP, start by converting the package to 2GP, and then retry retrieving metadata from the converted 2GP package version.
 
-An error occurred downloading the metadata: %s
+# packagingNotEnabledOnOrg
+
+Can't retrieve package metadata. The org you specified doesn't have the required second-generation packaging permission enabled. Enable this permission on your Dev Hub org, and try again.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.7.0",
+  "version": "4.9.0",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",