@salesforce/packaging 4.26.5 → 4.27.1

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -411,6 +411,7 @@ export type PackageVersionDependencyOptions = {
     connection: Connection;
     verbose?: boolean;
     edgeDirection?: 'root-first' | 'root-last';
+    installationKey?: string;
 };
 export type DependencyGraphData = {
     creator: string;

package/lib/package/package.d.ts

@@ -72,6 +72,7 @@ export declare class Package {
     static getDependencyGraph(packageVersionId: string, project: SfProject | undefined, connection: Connection, options?: {
         verbose?: boolean;
         edgeDirection?: 'root-first' | 'root-last';
+        installationKey?: string;
     }): Promise<PackageVersionDependency>;
     /**
      * Convert a 1st generation package to a 2nd generation package.

package/lib/package/package.js

@@ -156,6 +156,7 @@ class Package {
             connection,
             verbose: options?.verbose ?? false,
             edgeDirection: options?.edgeDirection ?? 'root-first',
+            installationKey: options?.installationKey,
         });
     }
     /**

package/lib/package/packageVersionDependency.d.ts

@@ -10,6 +10,7 @@ export declare class PackageVersionDependency extends AsyncCreatable<PackageVers
     private userPackageVersionId;
     private verbose;
     private edgeDirection;
+    private installationKey?;
     private resolvedPackageVersionCreateRequestId;
     private allPackageVersionId;
     constructor(options: PackageVersionDependencyOptions);
@@ -38,9 +39,10 @@ export declare class DependencyDotProducer {
     private resolvedPackageVersionId;
     private subscriberPackageVersionId;
     private connection;
+    private installationKey?;
     private dependencyGraphData;
     private selectedNodeIds;
-    constructor(connection: Connection, dependencyGraphString: string, verbose: boolean, edgeDirection: 'root-first' | 'root-last', resolvedPackageVersionId: string);
+    constructor(connection: Connection, dependencyGraphString: string, verbose: boolean, edgeDirection: 'root-first' | 'root-last', resolvedPackageVersionId: string, installationKey?: string);
     private static throwErrorOnInvalidRecord;
     init(): Promise<void>;
     produce(): string;

package/lib/package/packageVersionDependency.js

@@ -19,6 +19,7 @@ exports.PackageDependencyNode = exports.DependencyDotProducer = exports.PackageV
 const node_os_1 = require("node:os");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
+const packageUtils_1 = require("../utils/packageUtils");
 const versionNumber_1 = require("./versionNumber");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_version_dependency');
@@ -31,6 +32,7 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
     userPackageVersionId;
     verbose;
     edgeDirection;
+    installationKey;
     resolvedPackageVersionCreateRequestId;
     allPackageVersionId;
     constructor(options) {
@@ -41,6 +43,7 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         this.userPackageVersionId = options.packageVersionId;
         this.verbose = options.verbose ?? false;
         this.edgeDirection = options.edgeDirection ?? 'root-first';
+        this.installationKey = options.installationKey;
         this.resolvedPackageVersionCreateRequestId = '';
         this.allPackageVersionId = '';
     }
@@ -61,7 +64,7 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         else {
             dependencyGraphJson = await this.createFlatDependencyGraph();
         }
-        const producer = new DependencyDotProducer(this.connection, dependencyGraphJson, this.verbose, this.edgeDirection, this.resolvedPackageVersionCreateRequestId);
+        const producer = new DependencyDotProducer(this.connection, dependencyGraphJson, this.verbose, this.edgeDirection, this.resolvedPackageVersionCreateRequestId, this.installationKey);
         await producer.init();
         return producer;
     }
@@ -77,7 +80,10 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         if (!this.allPackageVersionId) {
             throw messages.createError('noDependencyGraphJsonMustProvideVersion');
         }
-        const query = `SELECT Dependencies FROM SubscriberPackageVersion WHERE Id = '${this.allPackageVersionId}'`;
+        let query = `SELECT Dependencies FROM SubscriberPackageVersion WHERE Id = '${this.allPackageVersionId}'`;
+        if (this.installationKey) {
+            query += ` AND InstallationKey = '${(0, packageUtils_1.escapeInstallationKey)(this.installationKey)}'`;
+        }
         const result = await this.connection.tooling.query(query);
         if (result?.records?.length !== 1) {
             throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
@@ -174,14 +180,16 @@ class DependencyDotProducer {
     resolvedPackageVersionId;
     subscriberPackageVersionId;
     connection;
+    installationKey;
     dependencyGraphData;
     selectedNodeIds = [];
-    constructor(connection, dependencyGraphString, verbose, edgeDirection, resolvedPackageVersionId) {
+    constructor(connection, dependencyGraphString, verbose, edgeDirection, resolvedPackageVersionId, installationKey) {
         this.verbose = verbose;
         this.edgeDirection = edgeDirection;
         this.resolvedPackageVersionId = resolvedPackageVersionId;
         this.connection = connection;
         this.dependencyGraphString = dependencyGraphString;
+        this.installationKey = installationKey;
         this.subscriberPackageVersionId = exports.VERSION_BEING_BUILT;
     }
     static throwErrorOnInvalidRecord(record) {
@@ -215,7 +223,10 @@ class DependencyDotProducer {
         }
         else if (this.subscriberPackageVersionId.startsWith('04t')) {
             selectedNodes.push(this.subscriberPackageVersionId);
-            const query = `SELECT Dependencies FROM SubscriberPackageVersion WHERE Id = '${this.subscriberPackageVersionId}'`;
+            let query = `SELECT Dependencies FROM SubscriberPackageVersion WHERE Id = '${this.subscriberPackageVersionId}'`;
+            if (this.installationKey) {
+                query += ` AND InstallationKey = '${(0, packageUtils_1.escapeInstallationKey)(this.installationKey)}'`;
+            }
             try {
                 const result = await this.connection.tooling.query(query);
                 if (result.records?.length !== 1) {

package/lib/package/packageVersionRetrieve.js

@@ -51,30 +51,12 @@ async function retrievePackageVersionMetadata(project, options, connection) {
     if (!(0, packageUtils_1.isPackageDirectoryEffectivelyEmpty)(destinationPath)) {
         throw messages.createError('sourcesDownloadDirectoryNotEmpty');
     }
-    // Get the DeveloperUsePkgZip URL from the Package2Version record
+    // Resolve an alias to the underlying 04t if one was passed.
     const subscriberPackageVersionId = project.getPackageIdFromAlias(options.subscriberPackageVersionId) ?? options.subscriberPackageVersionId;
-    // 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.DeveloperUsePkgZip, {
+    const versionInfo = await resolvePackage2Version(connection, subscriberPackageVersionId);
+    // The package version exists in this Dev Hub, so now we fetch the download URL.
+    const developerUsePkgZipUrl = await fetchDeveloperUsePkgZipUrl(connection, subscriberPackageVersionId);
+    const responseBase64 = await connection.tooling.request(developerUsePkgZipUrl, {
         encoding: 'base64',
     });
     const buffer = Buffer.from(responseBase64, 'base64');
@@ -180,4 +162,84 @@ async function attemptToUpdateProjectJson(project, connection, packageId, subscr
         logger.error(`Encountered error trying to update sfdx-project.json after retrieving package version metadata: ${msg}`);
     }
 }
+/**
+ * Query the Package2Version record for the given 04t, mapping a missing row to the right error: no
+ * packaging support on the org, not found anywhere, or found but not in this Dev Hub. Selects only
+ * columns any authenticated user can read, so the query always succeeds; selecting DeveloperUsePkgZip
+ * here (which requires the DownloadPackageVersionZips permission) would throw "No such column" for a
+ * user without that permission and mask those cases as a permission problem.
+ *
+ * Rejects a syntactically invalid 04t up front so it maps to packageVersionNotFound rather than
+ * leaking a raw "invalid ID field" SOQL error from the interpolated where clause.
+ */
+async function resolvePackage2Version(connection, subscriberPackageVersionId) {
+    if (!(0, packageUtils_1.validateIdNoThrow)(packageUtils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, subscriberPackageVersionId)) {
+        throw messages.createError('packageVersionNotFound', [subscriberPackageVersionId]);
+    }
+    const queryOptions = {
+        whereClause: `WHERE SubscriberPackageVersionId = '${subscriberPackageVersionId}'`,
+        fields: ['Package2Id', 'ConvertedFromVersionId'],
+    };
+    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("sObject type 'Package2Version' is not supported.")) {
+            throw messages.createError('packagingNotEnabledOnOrg');
+        }
+        throw e;
+    }
+    // No Package2Version row in this Dev Hub. Use SubscriberPackageVersion, a global view any
+    // authenticated user can query, to tell "doesn't exist anywhere" from "exists but not here".
+    if (!versionInfo) {
+        const exists = await subscriberPackageVersionExists(connection, subscriberPackageVersionId);
+        throw messages.createError(exists ? 'packageVersionNotInDevHub' : 'packageVersionNotFound', [
+            subscriberPackageVersionId,
+        ]);
+    }
+    return versionInfo;
+}
+/**
+ * Fetch the DeveloperUsePkgZip download URL for a Package2Version row already confirmed to exist in
+ * this Dev Hub. Reading this column requires the DownloadPackageVersionZips permission, so once the
+ * row is known to exist, both a "No such column" error and a null value reliably mean the user lacks
+ * that permission.
+ */
+async function fetchDeveloperUsePkgZipUrl(connection, subscriberPackageVersionId) {
+    const queryOptions = {
+        whereClause: `WHERE SubscriberPackageVersionId = '${subscriberPackageVersionId}'`,
+        fields: ['DeveloperUsePkgZip'],
+    };
+    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');
+        }
+        throw e;
+    }
+    if (!versionInfo?.DeveloperUsePkgZip) {
+        throw messages.createError('developerUsePkgZipFieldUnavailable');
+    }
+    return versionInfo.DeveloperUsePkgZip;
+}
+/**
+ * True if a SubscriberPackageVersion with this 04t ID exists anywhere. That global view is
+ * queryable by any authenticated user, so it tells "not found" apart from "not in this Dev Hub".
+ */
+async function subscriberPackageVersionExists(connection, subscriberPackageVersionId) {
+    try {
+        const result = await connection.tooling.query(`SELECT Id FROM SubscriberPackageVersion WHERE Id = '${subscriberPackageVersionId}' LIMIT 1`);
+        return (result.records?.length ?? 0) > 0;
+    }
+    catch {
+        // If even the existence probe fails (malformed ID, etc.), fall back to "not found".
+        return false;
+    }
+}
 //# sourceMappingURL=packageVersionRetrieve.js.map

package/messages/package.md

@@ -38,6 +38,14 @@ Can't retrieve package version metadata. The specified directory must be relativ
 
 Can't retrieve package metadata. To use this feature, you must first assign yourself the DownloadPackageVersionZips user permission. Then retry retrieving your package metadata.
 
+# packageVersionNotFound
+
+Can't retrieve package metadata. We can't find the package version %s. Verify that the 04t ID is correct and that the package version exists.
+
+# packageVersionNotInDevHub
+
+Can't retrieve package metadata. Package version %s isn't accessible from this Dev Hub org. You can only retrieve package metadata from the Dev Hub that created the package version. Verify that you specified the correct target Dev Hub.
+
 # downloadDeveloperPackageZipHasNoDataNative2GP
 
 Can't retrieve package metadata. The developer package zip for this native 2GP package version is unretrievable. To resolve, create a new package version with the --generate-pkg-zip flag. Then retry retrieving your package metadata.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.26.5",
+  "version": "4.27.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,7 +42,7 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@jsforce/jsforce-node": "^3.10.16",
+    "@jsforce/jsforce-node": "^3.10.18",
     "@salesforce/core": "^8.31.4",
     "@salesforce/kit": "^3.2.6",
     "@salesforce/schemas": "^1.10.3",
@@ -58,7 +58,7 @@
     "object-treeify": "^2"
   },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^5.3.58",
+    "@salesforce/cli-plugins-testkit": "^5.3.62",
     "@salesforce/dev-scripts": "^11.0.4",
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",