@salesforce/packaging 4.16.0 → 4.17.1

package/lib/package/package.d.ts

@@ -129,11 +129,16 @@ export declare class Package {
      *
      * @param options
      */
-    update(options: PackageUpdateOptions): Promise<PackageSaveResult>;
+    update(options: PackageUpdateOptions, skipAncestorCheck?: boolean): Promise<PackageSaveResult>;
     /**
      * Returns the package data for the package.
      *
      * @param force force a refresh of the package data
      */
     getPackageData(force?: boolean): Promise<PackagingSObjects.Package2 | undefined>;
+    /**
+     *
+     * @param options
+     */
+    private checkRecommendedVersionAncestors;
 }

package/lib/package/package.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Package = exports.Package2Fields = void 0;
 const core_1 = require("@salesforce/core");
+const graphology_1 = require("graphology");
 const packageUtils_1 = require("../utils/packageUtils");
 const packageCreate_1 = require("./packageCreate");
 const packageConvert_1 = require("./packageConvert");
@@ -18,6 +19,8 @@ const packagePrefixes = {
 };
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package');
+const packageVersionQuery = 'SELECT SubscriberPackageVersionId, AncestorId FROM Package2Version';
+const package2Query = 'SELECT RecommendedVersionId FROM Package2';
 exports.Package2Fields = [
     'Id',
     'IsDeleted',
@@ -234,7 +237,7 @@ class Package {
      *
      * @param options
      */
-    async update(options) {
+    async update(options, skipAncestorCheck) {
         try {
             // filter out any undefined values and their keys
             const opts = Object.fromEntries(Object.entries(options).filter(([, value]) => value !== undefined));
@@ -244,6 +247,18 @@ class Package {
             if (opts.RecommendedVersionId !== undefined && this.options.connection.getApiVersion() < '66.0') {
                 throw messages.createError('recommendedVersionIdApiPriorTo66Error');
             }
+            if (opts.RecommendedVersionId !== undefined) {
+                const trimmedId = opts.RecommendedVersionId.trim();
+                if (trimmedId === '' || !trimmedId.startsWith('04t') || (trimmedId.length !== 15 && trimmedId.length !== 18)) {
+                    throw messages.createError('invalidRecommendedVersionError');
+                }
+            }
+            if (skipAncestorCheck === true && opts.RecommendedVersionId === undefined) {
+                throw messages.createError('skipAncestorCheckRequiresRecommendedVersionIdError');
+            }
+            if (skipAncestorCheck !== true && opts.RecommendedVersionId !== undefined) {
+                await this.checkRecommendedVersionAncestors(opts);
+            }
             const result = await this.options.connection.tooling.update('Package2', opts);
             if (!result.success) {
                 throw new core_1.SfError(result.errors.join(', '));
@@ -273,6 +288,67 @@ class Package {
         }
         return this.packageData;
     }
+    /**
+     *
+     * @param options
+     */
+    async checkRecommendedVersionAncestors(opts) {
+        if (opts.RecommendedVersionId === undefined) {
+            return;
+        }
+        const queryP2 = `${package2Query} WHERE Id = '${this.packageId}'`;
+        const priorRecommendedVersionId = (await this.options.connection.tooling.query(queryP2))
+            .records[0].RecommendedVersionId;
+        if (priorRecommendedVersionId === undefined || opts.RecommendedVersionId === priorRecommendedVersionId) {
+            return;
+        }
+        const queryP2V = `${packageVersionQuery} WHERE Package2Id = '${this.packageId}'`;
+        const result = await this.options.connection.tooling.query(queryP2V);
+        if (result.totalSize === 0) {
+            throw messages.createError('noPackageVersionsForGivenPackage2FoundError');
+        }
+        else if (result.totalSize === 1) {
+            return;
+        }
+        const graph = new graphology_1.DirectedGraph();
+        const truncatedRecommendedVersionId = opts.RecommendedVersionId.substring(0, 15);
+        const stack = [truncatedRecommendedVersionId];
+        const visited = new Set([truncatedRecommendedVersionId]);
+        result.records.forEach((record) => {
+            const truncatedSubscriberId = record.SubscriberPackageVersionId.substring(0, 15);
+            graph.addNode(truncatedSubscriberId);
+            if (record.AncestorId) {
+                const truncatedAncestorId = record.AncestorId.substring(0, 15);
+                if (!graph.hasNode(truncatedAncestorId)) {
+                    graph.addNode(truncatedAncestorId);
+                }
+                graph.addEdge(truncatedSubscriberId, truncatedAncestorId);
+            }
+        });
+        if (!graph.hasNode(truncatedRecommendedVersionId)) {
+            throw messages.createError('unassociatedRecommendedVersionError');
+        }
+        const truncatedPriorRecommendedVersionId = priorRecommendedVersionId?.substring(0, 15);
+        if (graph.outDegree(truncatedRecommendedVersionId) > 0 &&
+            result.records.some((record) => record.SubscriberPackageVersionId.substring(0, 15) === truncatedPriorRecommendedVersionId)) {
+            while (stack.length > 0) {
+                const node = stack.pop();
+                for (const neighbor of graph.neighbors(node)) {
+                    if (neighbor === truncatedPriorRecommendedVersionId) {
+                        return;
+                    }
+                    if (!visited.has(neighbor)) {
+                        visited.add(neighbor);
+                        stack.push(neighbor);
+                    }
+                }
+            }
+        }
+        else if (graph.outDegree(truncatedRecommendedVersionId) === 0 && result.records.length === 1) {
+            return;
+        }
+        throw messages.createError('recommendedVersionNotAncestorOfPriorVersionError');
+    }
 }
 exports.Package = Package;
 //# sourceMappingURL=package.js.map

package/messages/package.md

@@ -49,3 +49,23 @@ Can't retrieve package metadata. The org you specified doesn't have the required
 # recommendedVersionIdApiPriorTo66Error
 
 To enable Recommended Version, use API version 66.0 or higher.
+
+# skipAncestorCheckRequiresRecommendedVersionIdError
+
+The skip ancestor check requires a recommended version ID.
+
+# noPackageVersionsForGivenPackage2FoundError
+
+No package versions were found for the given Package 2 ID (0Ho). At least one released package version must exist.
+
+# recommendedVersionNotAncestorOfPriorVersionError
+
+The new recommended version is not a descendant of the previous recommended version. To bypass this check, use the --skip-ancestor-check CLI flag.
+
+# invalidRecommendedVersionError
+
+Provide a valid subscriber package version (04t) for the recommended version.
+
+# unassociatedRecommendedVersionError
+
+The provided recommended version isn't associated with this package.

package/messages/package_version_create.md

@@ -92,11 +92,11 @@ Provide a valid positive number for %s. %d
 
 # errorAncestorNoneNotAllowed
 
-Can’t create package version because you didn’t specify a package ancestor. Set the ancestor version to %s, and try creating the package version. You can also specify --skipancestorcheck to override the ancestry requirement.
+Can’t create package version because you didn’t specify a package ancestor. Set the ancestor version to %s and try creating the package version again. You can also specify --skip-ancestor-check to override the ancestry requirement.
 
 # errorAncestorNotHighest
 
-Can’t create package version. The ancestor version [%s] you specified isn’t the highest released package version. Set the ancestor version to %s, and try creating the package version again. You can also specify --skipancestorcheck to override the ancestry requirement.
+Can’t create package version. The ancestor version [%s] you specified isn’t the highest released package version. Set the ancestor version to %s and try creating the package version again. You can also specify --skip-ancestor-check to override the ancestry requirement.
 
 # errorInvalidBuildNumberForKeywords
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.16.0",
+  "version": "4.17.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,11 +42,11 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@jsforce/jsforce-node": "^3.10.4",
-    "@salesforce/core": "^8.23.0",
+    "@jsforce/jsforce-node": "^3.10.8",
+    "@salesforce/core": "^8.23.2",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/schemas": "^1.10.3",
-    "@salesforce/source-deploy-retrieve": "^12.16.9",
+    "@salesforce/source-deploy-retrieve": "^12.24.0",
     "@salesforce/ts-types": "^2.0.11",
     "@salesforce/types": "^1.2.0",
     "fast-xml-parser": "^4.5.0",