@salesforce/packaging 4.13.1 → 4.14.1

package/lib/package/packageVersionDependency.d.ts

@@ -10,13 +10,16 @@ export declare class PackageVersionDependency extends AsyncCreatable<PackageVers
     private userPackageVersionId;
     private verbose;
     private edgeDirection;
-    private resolvedPackageVersionId;
+    private resolvedPackageVersionCreateRequestId;
+    private allPackageVersionId;
     constructor(options: PackageVersionDependencyOptions);
     init(): Promise<void>;
     /**
      * Returns a DependencyDotProducer that can be used to produce a DOT code representation of the package dependency graph.
      */
     getDependencyDotProducer(): Promise<DependencyDotProducer>;
+    private getTransitiveDependencyGraph;
+    private createFlatDependencyGraph;
     /**
      * Resolves id input to a 08c. User can input a 08c or 04t.
      * Currently a 04t is not supported in filtering the Package2VersionCreateRequest. So a user's input of 04t will be resolved to a 05i and then a 08c.
@@ -24,12 +27,9 @@ export declare class PackageVersionDependency extends AsyncCreatable<PackageVers
     private resolvePackageCreateRequestId;
     private query05iFrom04t;
     private query08cFrom05i;
-    /**
-     * Checks that the given Package2VersionCreateRequest ID (08c) contains a valid DependencyGraphJson to generate DOT code
-     */
-    private validatePackageVersion;
+    private isValidPackageVersion;
     private verifyCreateRequesIdExistsOnDevHub;
-    private verifyTransitiveDependenciesCalculated;
+    private isTransitiveDependenciesCalculated;
 }
 export declare class DependencyDotProducer {
     private dependencyGraphString;

package/lib/package/packageVersionDependency.js

@@ -31,7 +31,8 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
     userPackageVersionId;
     verbose;
     edgeDirection;
-    resolvedPackageVersionId;
+    resolvedPackageVersionCreateRequestId;
+    allPackageVersionId;
     constructor(options) {
         super(options);
         this.options = options;
@@ -40,7 +41,8 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         this.userPackageVersionId = options.packageVersionId;
         this.verbose = options.verbose ?? false;
         this.edgeDirection = options.edgeDirection ?? 'root-first';
-        this.resolvedPackageVersionId = '';
+        this.resolvedPackageVersionCreateRequestId = '';
+        this.allPackageVersionId = '';
     }
     async init() {
         await this.resolvePackageCreateRequestId();
@@ -49,21 +51,51 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
      * Returns a DependencyDotProducer that can be used to produce a DOT code representation of the package dependency graph.
      */
     async getDependencyDotProducer() {
-        const isValid = await this.validatePackageVersion();
-        if (!isValid) {
+        if (!this.isValidPackageVersion()) {
             throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
         }
-        const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionId}'`;
-        const result = await this.connection.tooling.query(query);
-        const dependencyGraphJson = result.records[0].DependencyGraphJson;
-        // validatePackageVersion() should have already ensured this is not null
-        if (!dependencyGraphJson) {
-            throw messages.createError('invalidDependencyGraphError');
+        let dependencyGraphJson;
+        if (await this.isTransitiveDependenciesCalculated()) {
+            dependencyGraphJson = await this.getTransitiveDependencyGraph();
+        }
+        else {
+            dependencyGraphJson = await this.createFlatDependencyGraph();
         }
-        const producer = new DependencyDotProducer(this.connection, dependencyGraphJson, this.verbose, this.edgeDirection, this.resolvedPackageVersionId);
+        const producer = new DependencyDotProducer(this.connection, dependencyGraphJson, this.verbose, this.edgeDirection, this.resolvedPackageVersionCreateRequestId);
         await producer.init();
         return producer;
     }
+    async getTransitiveDependencyGraph() {
+        const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionCreateRequestId}'`;
+        const result = await this.connection.tooling.query(query);
+        if (result.records[0].DependencyGraphJson == null) {
+            return '';
+        }
+        return result.records[0].DependencyGraphJson;
+    }
+    async createFlatDependencyGraph() {
+        if (!this.allPackageVersionId) {
+            throw messages.createError('noDependencyGraphJsonMustProvideVersion');
+        }
+        const query = `SELECT Dependencies FROM SubscriberPackageVersion WHERE Id = '${this.allPackageVersionId}'`;
+        const result = await this.connection.tooling.query(query);
+        if (result?.records?.length !== 1) {
+            throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
+        }
+        const flatDependencyGraph = {
+            nodes: [],
+            edges: [],
+        };
+        flatDependencyGraph.nodes.push({ id: this.allPackageVersionId });
+        result.records[0].Dependencies?.ids.forEach((dependency) => {
+            flatDependencyGraph.nodes.push({ id: dependency.subscriberPackageVersionId });
+            flatDependencyGraph.edges.push({
+                source: dependency.subscriberPackageVersionId,
+                target: this.allPackageVersionId,
+            });
+        });
+        return JSON.stringify(flatDependencyGraph);
+    }
     /**
      * Resolves id input to a 08c. User can input a 08c or 04t.
      * Currently a 04t is not supported in filtering the Package2VersionCreateRequest. So a user's input of 04t will be resolved to a 05i and then a 08c.
@@ -72,12 +104,14 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         const versionId = this.project?.getPackageIdFromAlias(this.userPackageVersionId) ?? this.userPackageVersionId;
         // User provided a Package2VersionCreateRequest ID (08c) and doesn't need to be resolved
         if (versionId.startsWith('08c')) {
-            this.resolvedPackageVersionId = versionId;
+            this.resolvedPackageVersionCreateRequestId = versionId;
         }
-        // User provided a SubscriberPackageVersionId (04t) and needs to be resolved to a Package2VersionCreateRequest ID (08c)
         else if (versionId.startsWith('04t')) {
+            // User provided a SubscriberPackageVersionId (04t) and needs to be resolved to a Package2VersionCreateRequest ID (08c)
+            this.allPackageVersionId = versionId;
+            // TODO: Make this one query when W-18944974 is fixed.
             const package2VersionId = await this.query05iFrom04t(versionId);
-            this.resolvedPackageVersionId = await this.query08cFrom05i(package2VersionId);
+            this.resolvedPackageVersionCreateRequestId = await this.query08cFrom05i(package2VersionId);
         }
         else {
             throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
@@ -99,29 +133,23 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
         }
         return result08c.records[0].Id;
     }
-    /**
-     * Checks that the given Package2VersionCreateRequest ID (08c) contains a valid DependencyGraphJson to generate DOT code
-     */
-    async validatePackageVersion() {
-        if (!this.resolvedPackageVersionId) {
+    isValidPackageVersion() {
+        if (!this.resolvedPackageVersionCreateRequestId && !this.allPackageVersionId) {
             throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
         }
-        if (await this.verifyTransitiveDependenciesCalculated()) {
-            return true;
-        }
-        return false;
+        return true;
     }
     async verifyCreateRequesIdExistsOnDevHub() {
-        const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionId}'`;
+        const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionCreateRequestId}'`;
         const result = await this.connection.tooling.query(query);
         if (result.records?.length === 0) {
             throw messages.createError('invalidPackageVersionIdError', [this.userPackageVersionId]);
         }
         return true;
     }
-    async verifyTransitiveDependenciesCalculated() {
+    async isTransitiveDependenciesCalculated() {
         if (await this.verifyCreateRequesIdExistsOnDevHub()) {
-            const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionId}'`;
+            const query = `${SELECT_PACKAGE_VERSION_DEPENDENCY} WHERE Id = '${this.resolvedPackageVersionCreateRequestId}'`;
             const result = await this.connection.tooling.query(query);
             if (result.records?.length === 1) {
                 const record = result.records[0];
@@ -133,9 +161,6 @@ class PackageVersionDependency extends kit_1.AsyncCreatable {
                         throw messages.createError('invalidDependencyGraphError');
                     }
                 }
-                else {
-                    throw messages.createError('transitiveDependenciesRequiredError');
-                }
             }
         }
         return false;

package/messages/package_version_dependency.md

@@ -2,10 +2,10 @@
 
 Can't display package dependencies. The package version ID %s you specified is invalid. Review the package version ID and then retry this command.
 
-# transitiveDependenciesRequiredError
-
-Can't display package dependencies. To display package dependencies, you must first add the calculateTransitiveDependencies parameter to the sfdx-project.json file, and set the value to "true". Next, create a new package version and then run this command using the 04t ID for the new package version.
-
 # invalidDependencyGraphError
 
 Can't display package dependencies. There's an issue generating the dependency graph. Before retrying this command, make sure you added the calculateTransitiveDependencies parameter to the sfdx-project.json file and set the value to "true". After setting the attribute and before retrying this command, you must create a new package version.
+
+# noDependencyGraphJsonMustProvideVersion
+
+Can't display package dependencies. This Package2VersionCreateRequest does not have CalcTransitiveDependencies set to true. To display package dependencies, either specify a package version id (starts with 04t or 05i) or create a new package version with the calculateTransitiveDependencies parameter in the sfdx-project.json file to "true".

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.13.1",
+  "version": "4.14.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -63,7 +63,6 @@
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",
     "eslint-plugin-sf-plugin": "^1.20.8",
-    "shelljs": "0.8.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   },