feat: display HasVpi in package version list and report commands

Author: tjporcaro

messages/package_version_list.md

@@ -157,3 +157,7 @@ Language
 # endToEndBuildDurationInSeconds
 
 End To End Build Duration In Seconds
+
+# hasVpi
+
+Has Version Settings

schemas/package-version-list.json

@@ -111,6 +111,9 @@
         },
         "Language": {
           "type": "string"
+        },
+        "HasVpi": {
+          "type": ["string", "boolean"]
         }
       },
       "required": [

schemas/package-version-report.json

@@ -17,10 +17,7 @@
           ]
         },
         "HasPassedCodeCoverageCheck": {
-          "type": [
-            "boolean",
-            "string"
-          ]
+          "type": ["boolean", "string"]
         },
         "Package2": {
           "type": "object",
@@ -96,10 +93,7 @@
           ]
         },
         "HasMetadataRemoved": {
-          "type": [
-            "boolean",
-            "string"
-          ]
+          "type": ["boolean", "string"]
         },
         "Id": {
           "type": "string"
@@ -201,32 +195,23 @@
               "$ref": "#/definitions/PackagingSObjects.SubscriberPackageDependencies"
             }
           },
-          "required": [
-            "Dependencies"
-          ],
+          "required": ["Dependencies"],
           "additionalProperties": false
         },
         "Version": {
           "type": "string"
         },
         "AncestorVersion": {
-          "type": [
-            "string",
-            "null"
-          ]
+          "type": ["string", "null"]
         },
         "AncestorId": {
-          "type": [
-            "string",
-            "null"
-          ]
+          "type": ["string", "null"]
+        },
+        "HasVpi": {
+          "type": ["boolean", "string"]
         }
       },
-      "required": [
-        "HasMetadataRemoved",
-        "Package2",
-        "Version"
-      ]
+      "required": ["HasMetadataRemoved", "Package2", "Version"]
     },
     "CodeCoverage": {
       "anyOf": [
@@ -240,19 +225,14 @@
               "type": "number"
             }
           },
-          "required": [
-            "apexCodeCoveragePercentage"
-          ],
+          "required": ["apexCodeCoveragePercentage"],
           "additionalProperties": false
         }
       ]
     },
     "PackageType": {
       "type": "string",
-      "enum": [
-        "Managed",
-        "Unlocked"
-      ]
+      "enum": ["Managed", "Unlocked"]
     },
     "CodeCoveragePercentages": {
       "anyOf": [
@@ -274,19 +254,14 @@
                     "type": "number"
                   }
                 },
-                "required": [
-                  "className",
-                  "codeCoveragePercentage"
-                ],
+                "required": ["className", "codeCoveragePercentage"],
                 "additionalProperties": false
               },
               "minItems": 1,
               "maxItems": 1
             }
           },
-          "required": [
-            "codeCovPercentages"
-          ],
+          "required": ["codeCovPercentages"],
           "additionalProperties": false
         }
       ]
@@ -303,17 +278,13 @@
                 "type": "string"
               }
             },
-            "required": [
-              "subscriberPackageVersionId"
-            ],
+            "required": ["subscriberPackageVersionId"],
             "additionalProperties": false
           }
         }
       },
-      "required": [
-        "ids"
-      ],
+      "required": ["ids"],
       "additionalProperties": false
     }
   }
-}
+}

src/commands/package/version/list.ts

@@ -41,6 +41,7 @@ export type PackageVersionListDetails = Omit<
   | 'BuildDurationInSeconds'
   | 'CodeCoverage'
   | 'Package2'
+  | 'HasVpi'
 > & {
   HasMetadataRemoved: string;
   IsPasswordProtected: string | boolean;
@@ -57,6 +58,7 @@ export type PackageVersionListDetails = Omit<
   IsOrgDependent: 'N/A' | 'Yes' | 'No';
   CreatedBy: string;
   ValidatedAsync?: boolean;
+  HasVpi?: string | boolean;
 };
 
 export type PackageVersionListCommandResult = PackageVersionListDetails[];
@@ -187,6 +189,13 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
         const hasMetadataRemoved =
           containerOptionsMap.get(record.Package2Id) !== 'Managed' ? 'N/A' : record.HasMetadataRemoved ? 'Yes' : 'No';
 
+        const hasVpi =
+          record.HasVpi === undefined
+            ? undefined
+            : containerOptionsMap.get(record.Package2Id) !== 'Managed'
+            ? 'N/A'
+            : String(record.HasVpi); // displays 'true'/'false'
+
         results.push({
           Package2Id: record.Package2Id,
           Branch: record.Branch,
@@ -222,6 +231,7 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
           HasMetadataRemoved: hasMetadataRemoved,
           CreatedBy: record.CreatedById,
           Language: record.Language,
+          HasVpi: hasVpi,
         });
       });
       this.table({
@@ -287,6 +297,7 @@ const getColumnData = (
       { key: 'Description', name: messages.getMessage('description') },
       { key: 'CodeCoverage', name: messages.getMessage('codeCoverage') },
       { key: 'HasPassedCodeCoverageCheck', name: messages.getMessage('hasPassedCodeCoverageCheck') },
+      { key: 'HasVpi', name: messages.getMessage('hasVpi') },
       { key: 'ConvertedFromVersionId', name: messages.getMessage('convertedFromVersionId') },
       { key: 'IsOrgDependent', name: messages.getMessage('isOrgDependent') },
       { key: 'ReleaseVersion', name: messages.getMessage('releaseVersion') },

src/commands/package/version/report.ts

@@ -39,6 +39,7 @@ const omissions = [
   'Package2',
   'HasMetadataRemoved',
   'DeveloperUsePkgZip',
+  'HasVpi',
 ] as const;
 type Omission = (typeof omissions)[number];
 
@@ -48,6 +49,7 @@ export type PackageVersionReportResultModified = Omit<PackageVersionReportResult
   Package2: Partial<Omit<PackagingSObjects.Package2, 'IsOrgDependent'> & { IsOrgDependent: string }>;
   PackageType?: PackageType;
   HasMetadataRemoved: boolean | string;
+  HasVpi?: boolean | string;
 };
 
 export class PackageVersionReportCommand extends SfCommand<PackageVersionReportResultModified> {
@@ -85,6 +87,7 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
     return massagedResults;
   }
 
+  // eslint-disable-next-line complexity
   private display(record: PackageVersionReportResultModified, verbose: boolean, connection: Connection): void {
     if (this.jsonEnabled()) {
       return;
@@ -197,6 +200,12 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
             : '') as unknown as string,
         }
       );
+      if (Number(connection.version) >= 67) {
+        displayRecords.push({
+          key: pvlMessages.getMessage('hasVpi'),
+          value: record.HasVpi,
+        });
+      }
     }
     const maximumNumClasses = 15; // Number of least code covered classes displayed on the cli output for better UX.
     let codeCovStr = ''; // String to display when code coverage data is empty or null
@@ -298,6 +307,10 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
     // set HasMetadataRemoved to N/A for Unlocked, and No when value is false or absent (pre-230)
     record.HasMetadataRemoved = results.PackageType !== 'Managed' ? 'N/A' : results.HasMetadataRemoved ? 'Yes' : 'No';
 
+    if (results.HasVpi !== undefined) {
+      record.HasVpi = results.PackageType !== 'Managed' ? 'N/A' : results.HasVpi ? 'Yes' : 'No';
+    }
+
     record.ConvertedFromVersionId ??= ' ';
 
     return record;

test/commands/package/packageVersion.nut.ts

@@ -418,6 +418,10 @@ describe('package:version:*', () => {
         'HasMetadataRemoved',
         'CreatedBy',
       ];
+      // HasVpi is only present at API v67+ (app version 262)
+      if (Number((session.hubOrg as { apiVersion?: string }).apiVersion) >= 67) {
+        keys.push('HasVpi');
+      }
 
       expect(output).to.have.length.greaterThan(0);
       expect(output[0]).to.have.keys(keys);

test/commands/package/versionReport.test.ts

@@ -46,6 +46,7 @@ const pkgVersionReportResultModified: PackageVersionReportResultModified = {
   Description: '',
   HasMetadataRemoved: 'N/A',
   HasPassedCodeCoverageCheck: false,
+  HasVpi: 'N/A',
   Id: '05i3i000000Gmj6XXX',
   InstallKey: '',
   IsDeleted: false,
@@ -93,6 +94,7 @@ const pkgVersionReportResult: PackageVersionReportResult = {
   Description: '',
   HasMetadataRemoved: false,
   HasPassedCodeCoverageCheck: false,
+  HasVpi: false,
   Id: '05i3i000000Gmj6XXX',
   InstallKey: '',
   IsDeleted: false,
@@ -189,6 +191,7 @@ describe('package:version:report - tests', () => {
       pvrr.PackageType = 'Managed';
       pvrr.CodeCoverage = { apexCodeCoveragePercentage: 33 };
       pvrr.HasMetadataRemoved = true;
+      pvrr.HasVpi = true;
       pvrr.Description = 'test description';
       const pvrrm = Object.assign({} as PackageVersionReportResultModified, pvrr) as PackageVersionReportResultModified;
       pvrrm.Version = '0.0.6.0';
@@ -197,6 +200,7 @@ describe('package:version:report - tests', () => {
       pvrrm.Package2.IsOrgDependent = 'N/A';
       pvrrm.CodeCoverage = { apexCodeCoveragePercentage: 33 };
       pvrrm.HasMetadataRemoved = 'Yes';
+      pvrrm.HasVpi = 'Yes';
       pvrrm.HasPassedCodeCoverageCheck = 'N/A';
 
       const result = cmd['massageResultsForDisplay'](pvrr);
@@ -208,6 +212,7 @@ describe('package:version:report - tests', () => {
       pvrr.PackageType = undefined;
       pvrr.CodeCoverage = { apexCodeCoveragePercentage: 33 };
       pvrr.HasMetadataRemoved = true;
+      pvrr.HasVpi = false;
       pvrr.Package2.IsOrgDependent = true;
       pvrr.ValidationSkipped = true;
       const pvrrm = Object.assign({} as PackageVersionReportResultModified, pvrr) as PackageVersionReportResultModified;
@@ -217,10 +222,18 @@ describe('package:version:report - tests', () => {
       pvrrm.Package2.IsOrgDependent = 'No';
       pvrrm.CodeCoverage = 'N/A';
       pvrrm.HasMetadataRemoved = 'N/A';
+      pvrrm.HasVpi = 'N/A';
       pvrrm.HasPassedCodeCoverageCheck = 'N/A';
 
       const result = cmd['massageResultsForDisplay'](pvrr);
       expect(result).to.deep.equal(pvrrm);
     });
+    it('should not transform HasVpi when undefined (api < 67)', () => {
+      const pvrr = Object.assign({}, pkgVersionReportResult);
+      delete (pvrr as Partial<PackageVersionReportResult>).HasVpi;
+
+      const result = cmd['massageResultsForDisplay'](pvrr);
+      expect(result.HasVpi).to.be.undefined;
+    });
   });
 });