Merge pull request #764 from forcedotcom/t/managed-packaging/W-17561980/display-dependency-graph-3

W-17561980 Verified GPG Signing Outputs DOT Code for DisplayDependencies Command

Author: MimiRaiSalesforce

messages/package_version_dependency.md

@@ -0,0 +1,11 @@
+# invalidPackageVersionIdError
+
+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.

package.json

@@ -43,7 +43,7 @@
   ],
   "dependencies": {
     "@jsforce/jsforce-node": "^3.6.5",
-    "@salesforce/core": "^8.15.0",
+    "@salesforce/core": "^8.18.5",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/schemas": "^1.9.1",
     "@salesforce/source-deploy-retrieve": "^12.16.9",

src/interfaces/packagingInterfacesAndType.ts

@@ -15,6 +15,7 @@ import { ConvertResult } from '@salesforce/source-deploy-retrieve';
 import type { Package } from '@salesforce/types/metadata';
 import { PackageProfileApi } from '../package/packageProfileApi';
 import { PackageAncestryNode } from '../package/packageAncestry';
+import { VersionNumber } from '../package/versionNumber';
 import { PackagingSObjects } from './packagingSObjects';
 import Package2VersionStatus = PackagingSObjects.Package2VersionStatus;
 import PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
@@ -500,6 +501,31 @@ export type AncestryRepresentationProducer = {
   produce(): PackageAncestryNodeData | string | void;
 };
 
+export type PackageVersionDependencyOptions = {
+  packageVersionId: string;
+  project?: SfProject;
+  connection: Connection;
+  verbose?: boolean;
+  edgeDirection?: 'root-first' | 'root-last';
+};
+
+export type DependencyGraphData = {
+  creator: string;
+  nodes: DependencyGraphNode[];
+  edges: DependencyGraphEdge[];
+};
+
+export type DependencyGraphNode = {
+  subscriberPackageVersionId: string;
+  packageName: string;
+  version: VersionNumber;
+};
+
+export type DependencyGraphEdge = {
+  source: string;
+  target: string;
+};
+
 export const PackageEvents = {
   convert: {
     success: 'Package/convert-success',

src/package/package.ts

@@ -27,6 +27,7 @@ import { retrievePackageVersionMetadata } from './packageVersionRetrieve';
 import { listPackageVersions } from './packageVersionList';
 import { deletePackage } from './packageDelete';
 import { PackageAncestry } from './packageAncestry';
+import { PackageVersionDependency } from './packageVersionDependency';
 
 const packagePrefixes = {
   PackageId: '0Ho',
@@ -177,6 +178,29 @@ export class Package {
     });
   }
 
+  /**
+   * create a PackageVersionDependency instance
+   *
+   * @param packageVersionId to get version information for
+   * @param project SfProject instance
+   * @param connection Hub Org Connection
+   * @param options flags for the command line
+   */
+  public static async getDependencyGraph(
+    packageVersionId: string,
+    project: SfProject | undefined,
+    connection: Connection,
+    options?: { verbose?: boolean; edgeDirection?: 'root-first' | 'root-last' }
+  ): Promise<PackageVersionDependency> {
+    return PackageVersionDependency.create({
+      packageVersionId,
+      project,
+      connection,
+      verbose: options?.verbose ?? false,
+      edgeDirection: options?.edgeDirection ?? 'root-first',
+    });
+  }
+
   /**
    * Convert a 1st generation package to a 2nd generation package.
    * See {@link ConvertPackageOptions} for conversion options.