@salesforce/packaging 3.5.25 → 3.7.0

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -155,6 +155,7 @@ export type PackageVersionCreateRequest = {
     Language?: string;
     CalculateCodeCoverage: boolean;
     SkipValidation: boolean;
+    AsyncValidation?: boolean;
 };
 export type PackageVersionListOptions = {
     orderBy?: string;
@@ -165,6 +166,7 @@ export type PackageVersionListOptions = {
     concise?: boolean;
     isReleased?: boolean;
     showConversionsOnly?: boolean;
+    branch?: string;
 };
 export type PackageVersionUpdateOptions = {
     InstallKey?: string;
@@ -263,6 +265,7 @@ export type PackageVersionCreateOptions = {
     releasenotesurl: string;
     skipancestorcheck: boolean;
     skipvalidation: boolean;
+    asyncvalidation: boolean;
     sourceorg: string;
     tag: string;
     uninstallscript: string;

package/lib/interfaces/packagingSObjects.d.ts

@@ -34,6 +34,7 @@ export declare namespace PackagingSObjects {
         Branch: string;
         AncestorId: string;
         ValidationSkipped: boolean;
+        ValidatedAsync?: boolean;
         Name: string;
         Description: string;
         MajorVersion: number;
@@ -62,7 +63,8 @@ export declare namespace PackagingSObjects {
         verifyingFeaturesAndSettings = "VerifyingFeaturesAndSettings",
         verifyingDependencies = "VerifyingDependencies",
         verifyingMetadata = "VerifyingMetadata",
-        finalizingPackageVersion = "FinalizingPackageVersion"
+        finalizingPackageVersion = "FinalizingPackageVersion",
+        performingValidations = "PerformingValidations"
     }
     type Package2VersionCreateRequest = {
         Id: string;

package/lib/interfaces/packagingSObjects.js

@@ -14,6 +14,7 @@ var PackagingSObjects;
         Package2VersionStatus["verifyingDependencies"] = "VerifyingDependencies";
         Package2VersionStatus["verifyingMetadata"] = "VerifyingMetadata";
         Package2VersionStatus["finalizingPackageVersion"] = "FinalizingPackageVersion";
+        Package2VersionStatus["performingValidations"] = "PerformingValidations";
     })(Package2VersionStatus = PackagingSObjects.Package2VersionStatus || (PackagingSObjects.Package2VersionStatus = {}));
 })(PackagingSObjects || (exports.PackagingSObjects = PackagingSObjects = {}));
 //# sourceMappingURL=packagingSObjects.js.map

package/lib/package/packageVersion.d.ts

@@ -128,6 +128,7 @@ export declare class PackageVersion {
      * @returns Results from querying the Package2Version SObject.
      */
     static queryPackage2Version(connection: Connection, options?: Package2VersionQueryOptions): Promise<Partial<Package2Version[]>>;
+    private static getPackage2VersionFields;
     /**
      * Get the package version ID for this PackageVersion.
      *

package/lib/package/packageVersion.js

@@ -32,6 +32,7 @@ exports.Package2VersionFields = [
     'Branch',
     'AncestorId',
     'ValidationSkipped',
+    'ValidatedAsync',
     'Name',
     'Description',
     'MajorVersion',
@@ -173,6 +174,7 @@ class PackageVersion {
                             completed: false,
                             payload: report,
                         };
+                    case Package2VersionStatus.performingValidations:
                     case Package2VersionStatus.success: {
                         await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.success, report);
                         const packageVersion = new PackageVersion({
@@ -261,6 +263,7 @@ class PackageVersion {
                             completed: false,
                             payload: report,
                         };
+                    case Package2VersionStatus.performingValidations:
                     case Package2VersionStatus.success:
                         await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.success, report);
                         await new PackageVersion({
@@ -299,7 +302,7 @@ class PackageVersion {
      * @returns Results from querying the Package2Version SObject.
      */
     static async queryPackage2Version(connection, options = {}) {
-        const fields = options.fields ?? exports.Package2VersionFields;
+        const fields = options.fields ?? PackageVersion.getPackage2VersionFields(connection);
         const { whereClause, whereClauseItems } = options;
         const orderBy = options.orderBy ?? 'ORDER BY LastModifiedDate DESC';
         let query = `SELECT ${fields.toString()} FROM Package2Version`;
@@ -318,6 +321,10 @@ class PackageVersion {
         }
         return result.records ?? [];
     }
+    static getPackage2VersionFields(connection) {
+        const apiVersion = connection.getApiVersion();
+        return exports.Package2VersionFields.filter((field) => (apiVersion > '60.0' ? true : field !== 'ValidatedAsync'));
+    }
     /**
      * Get the package version ID for this PackageVersion.
      *
@@ -400,7 +407,7 @@ class PackageVersion {
                     label2: packageUtils_1.BY_LABEL.PACKAGE_VERSION_ID.label,
                 };
             }
-            const allFields = exports.Package2VersionFields.toString();
+            const allFields = PackageVersion.getPackage2VersionFields(this.connection).toString();
             const query = `SELECT ${allFields} FROM Package2Version WHERE ${queryConfig.clause} LIMIT 1`;
             try {
                 this.data = await this.connection.singleRecordQuery(query, { tooling: true });

package/lib/package/packageVersionCreate.js

@@ -219,6 +219,7 @@ class PackageVersionCreate {
             SourceOrg: this.options.sourceorg,
             CalculateCodeCoverage: this.options.codecoverage ?? false,
             SkipValidation: this.options.skipvalidation ?? false,
+            AsyncValidation: this.options.asyncvalidation ?? false,
             // note: the createRequest's Language corresponds to the AllPackageVersion's language
             Language: this.options.language,
         };
@@ -230,6 +231,14 @@ class PackageVersionCreate {
             }
             delete requestObject.Language;
         }
+        // Ensure we only include the async validation property for a connection api version
+        // of v60.0 or higher.
+        if (this.connection.getApiVersion() <= '60.0') {
+            if (requestObject.AsyncValidation) {
+                this.logger.warn(`The async validation option is only valid for API version 60.0 and higher. Ignoring ${requestObject.AsyncValidation}`);
+            }
+            delete requestObject.AsyncValidation;
+        }
         if (preserveFiles) {
             const message = messages.getMessage('tempFileLocation', [packageVersTmpRoot]);
             await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create['preserve-files'], {

package/lib/package/packageVersionCreateRequest.d.ts

@@ -1,4 +1,5 @@
 import { Connection } from '@salesforce/core';
 import { PackageVersionCreateRequestQueryOptions, PackageVersionCreateRequestResult } from '../interfaces';
+export declare function getQuery(connection: Connection): string;
 export declare function list(connection: Connection, options?: PackageVersionCreateRequestQueryOptions): Promise<PackageVersionCreateRequestResult[]>;
 export declare function byId(packageVersionCreateRequestId: string, connection: Connection): Promise<PackageVersionCreateRequestResult[]>;

package/lib/package/packageVersionCreateRequest.js

@@ -9,19 +9,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.byId = exports.list = void 0;
+exports.byId = exports.list = exports.getQuery = void 0;
 const node_util_1 = __importDefault(require("node:util"));
 const core_1 = require("@salesforce/core");
 const interfaces_1 = require("../interfaces");
 const packageUtils_1 = require("../utils/packageUtils");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_version_create');
-const QUERY = 'SELECT Id, Status, Package2Id, Package2.Name, Package2VersionId, Package2Version.SubscriberPackageVersionId, Package2Version.HasPassedCodeCoverageCheck,Package2Version.CodeCoverage, Tag, Branch, ' +
-    'Package2Version.MajorVersion, Package2Version.MinorVersion, Package2Version.PatchVersion, Package2Version.BuildNumber, ' +
-    'CreatedDate, Package2Version.HasMetadataRemoved, CreatedById, IsConversionRequest, Package2Version.ConvertedFromVersionId ' +
-    'FROM Package2VersionCreateRequest ' +
-    '%s' + // WHERE, if applicable
-    'ORDER BY CreatedDate desc';
+function getQuery(connection) {
+    const QUERY = 'SELECT Id, Status, Package2Id, Package2.Name, Package2VersionId, Package2Version.SubscriberPackageVersionId, Package2Version.HasPassedCodeCoverageCheck,Package2Version.CodeCoverage, Tag, Branch, ' +
+        'Package2Version.MajorVersion, Package2Version.MinorVersion, Package2Version.PatchVersion, Package2Version.BuildNumber, ' +
+        'CreatedDate, Package2Version.HasMetadataRemoved, CreatedById, IsConversionRequest, Package2Version.ConvertedFromVersionId ' +
+        (Number(connection.version) > 60.0 ? ', AsyncValidation ' : '') +
+        'FROM Package2VersionCreateRequest ' +
+        '%s' + // WHERE, if applicable
+        'ORDER BY CreatedDate desc';
+    return QUERY;
+}
+exports.getQuery = getQuery;
 function formatDate(date) {
     const pad = (num) => (num < 10 ? `0${num}` : `${num}`);
     return `${date.getFullYear()}-${pad(date.getMonth() + 1)}-${pad(date.getDate())} ${pad(date.getHours())}:${pad(date.getMinutes())}`;
@@ -29,7 +34,7 @@ function formatDate(date) {
 async function list(connection, options) {
     try {
         const whereClause = constructWhere(options);
-        return await query(node_util_1.default.format(QUERY, whereClause), connection);
+        return await query(node_util_1.default.format(getQuery(connection), whereClause), connection);
     }
     catch (err) {
         if (err instanceof Error) {
@@ -40,7 +45,7 @@ async function list(connection, options) {
 }
 exports.list = list;
 async function byId(packageVersionCreateRequestId, connection) {
-    const results = await query(node_util_1.default.format(QUERY, `WHERE Id = '${packageVersionCreateRequestId}' `), connection);
+    const results = await query(node_util_1.default.format(getQuery(connection), `WHERE Id = '${packageVersionCreateRequestId}' `), connection);
     if (results && results.length === 1 && results[0].Status === interfaces_1.PackagingSObjects.Package2VersionStatus.error) {
         results[0].Error = await queryForErrors(packageVersionCreateRequestId, connection);
     }

package/lib/package/packageVersionList.js

@@ -114,6 +114,9 @@ function constructWhere(options) {
     if (options?.showConversionsOnly) {
         where.push('ConvertedFromVersionId != null');
     }
+    if (options?.branch) {
+        where.push(`Branch='${options.branch}'`);
+    }
     // exclude deleted
     where.push('IsDeprecated = false');
     return where;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "3.5.25",
+  "version": "3.7.0",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,7 +42,7 @@
   ],
   "dependencies": {
     "@jsforce/jsforce-node": "^3.2.0",
-    "@salesforce/core": "^7.3.12",
+    "@salesforce/core": "^7.4.0",
     "@salesforce/kit": "^3.1.2",
     "@salesforce/schemas": "^1.9.0",
     "@salesforce/source-deploy-retrieve": "^11.6.5",