@salesforce/packaging 3.5.16 → 3.5.17

package/lib/package/packageVersionCreate.d.ts

@@ -1,5 +1,5 @@
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
-import { MDFolderForArtifactOptions, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageXml, PackagingSObjects } from '../interfaces';
+import { MDFolderForArtifactOptions, PackageDescriptorJson, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageXml, PackagingSObjects } from '../interfaces';
 export declare class PackageVersionCreate {
     private options;
     private apiVersionFromPackageXml;
@@ -12,16 +12,17 @@ export declare class PackageVersionCreate {
     private metadataResolver;
     constructor(options: PackageVersionCreateOptions);
     createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
-    private validateDependencyValues;
     /**
-     * A dependency in the workspace config file may be specified using either a subscriber package version id (04t)
+     * A dependency in the project config file may be specified using either a subscriber package version id (04t)
      * or a package Id (0Ho) + a version number.  Additionally, a build number may be the actual build number, or a
      * keyword: LATEST or RELEASED (meaning the latest or released build number for a given major.minor.patch).
      *
      * This method resolves a package Id + version number to a subscriber package version id (04t)
      * and adds it as a SubscriberPackageVersionId parameter in the dependency object.
      */
-    private retrieveSubscriberPackageVersionId;
+    retrieveSubscriberPackageVersionId(dependency: PackageDescriptorJson): Promise<string>;
+    private resolveSubscriberPackageVersionId;
+    private validateDependencyValues;
     private resolveBuildNumber;
     private createRequestObject;
     /**

package/lib/package/packageVersionCreate.js

@@ -70,42 +70,8 @@ class PackageVersionCreate {
             throw err;
         }
     }
-    async validateDependencyValues(dependency) {
-        // If valid 04t package, just return it to be used straight away.
-        if (dependency.subscriberPackageVersionId) {
-            pkgUtils.validateId(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, dependency.subscriberPackageVersionId);
-            return;
-        }
-        if (dependency.packageId && dependency.package) {
-            throw messages.createError('errorPackageAndPackageIdCollision', []);
-        }
-        const idOrPackage = dependency.packageId ?? dependency.package;
-        if (!idOrPackage) {
-            throw messages.createError('errorPackageOrPackageIdMissing', []);
-        }
-        const packageIdFromAlias = this.project.getPackageIdFromAlias(idOrPackage) ?? idOrPackage;
-        // If valid 04t package, just return it to be used straight away.
-        if (pkgUtils.validateIdNoThrow(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, packageIdFromAlias)) {
-            dependency.subscriberPackageVersionId = packageIdFromAlias;
-            return;
-        }
-        if (!packageIdFromAlias || !dependency.versionNumber) {
-            throw messages.createError('errorDependencyPair', [JSON.stringify(dependency)]);
-        }
-        // Just override dependency.packageId value to the resolved alias.
-        dependency.packageId = packageIdFromAlias;
-        pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, dependency.packageId);
-        (0, exports.validateVersionNumber)(dependency.versionNumber, versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN, versionNumber_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN);
-        await this.validatePatchVersion(dependency.versionNumber, dependency.packageId);
-        // Validate that the Package2 id exists on the server
-        const query = `SELECT Id FROM Package2 WHERE Id = '${dependency.packageId}'`;
-        const result = await this.connection.tooling.query(query);
-        if (!result.records || result.records.length !== 1) {
-            throw messages.createError('errorNoIdInHub', [dependency.packageId]);
-        }
-    }
     /**
-     * A dependency in the workspace config file may be specified using either a subscriber package version id (04t)
+     * A dependency in the project config file may be specified using either a subscriber package version id (04t)
      * or a package Id (0Ho) + a version number.  Additionally, a build number may be the actual build number, or a
      * keyword: LATEST or RELEASED (meaning the latest or released build number for a given major.minor.patch).
      *
@@ -113,12 +79,6 @@ class PackageVersionCreate {
      * and adds it as a SubscriberPackageVersionId parameter in the dependency object.
      */
     async retrieveSubscriberPackageVersionId(dependency) {
-        await this.validateDependencyValues(dependency);
-        if (dependency.subscriberPackageVersionId) {
-            delete dependency.package;
-            // if a 04t id is specified just use it.
-            return dependency;
-        }
         if (!dependency.versionNumber) {
             throw messages.createError('errorDependencyPair', [JSON.stringify(dependency)]);
         }
@@ -129,7 +89,7 @@ class PackageVersionCreate {
         const buildNumber = versionNumber.build;
         // use the dependency.branch if present otherwise use the branch of the version being created
         const branch = dependency.branch ?? this.options.branch;
-        const branchString = !branch || branch === '' ? 'null' : `'${branch}'`;
+        const branchString = !branch ? 'null' : `'${branch}'`;
         // resolve a build number keyword to an actual number, if needed
         const resolvedBuildNumber = await this.resolveBuildNumber(versionNumber, dependency.packageId, branch);
         // now that we have a full build number, query for the associated 04t.
@@ -149,9 +109,8 @@ class PackageVersionCreate {
                 resolvedBuildNumber,
             ]);
         }
-        dependency.subscriberPackageVersionId = pkgVerQueryResult.records[0].SubscriberPackageVersionId;
         // warn user of the resolved build number when LATEST and RELEASED keywords are used
-        if (versionNumber.isbuildKeyword()) {
+        if (versionNumber.isBuildKeyword()) {
             versionNumber.build = resolvedBuildNumber;
             if (buildNumber === versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN) {
                 this.logger.info(messages.getMessage('buildNumberResolvedForLatest', [
@@ -169,14 +128,58 @@ class PackageVersionCreate {
                 ]));
             }
         }
+        return pkgVerQueryResult.records[0].SubscriberPackageVersionId;
+    }
+    async resolveSubscriberPackageVersionId(dependency) {
+        await this.validateDependencyValues(dependency);
+        if (dependency.subscriberPackageVersionId) {
+            delete dependency.package;
+            // if a 04t id is specified just use it.
+            return dependency;
+        }
+        dependency.subscriberPackageVersionId = await this.retrieveSubscriberPackageVersionId(dependency);
         delete dependency.packageId;
         delete dependency.package;
         delete dependency.versionNumber;
         delete dependency.branch;
         return dependency;
     }
+    async validateDependencyValues(dependency) {
+        // If valid 04t package, just return it to be used straight away.
+        if (dependency.subscriberPackageVersionId) {
+            pkgUtils.validateId(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, dependency.subscriberPackageVersionId);
+            return;
+        }
+        if (dependency.packageId && dependency.package) {
+            throw messages.createError('errorPackageAndPackageIdCollision', []);
+        }
+        const idOrPackage = dependency.packageId ?? dependency.package;
+        if (!idOrPackage) {
+            throw messages.createError('errorPackageOrPackageIdMissing', []);
+        }
+        const packageIdFromAlias = this.project.getPackageIdFromAlias(idOrPackage) ?? idOrPackage;
+        // If valid 04t package, just return it to be used straight away.
+        if (pkgUtils.validateIdNoThrow(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, packageIdFromAlias)) {
+            dependency.subscriberPackageVersionId = packageIdFromAlias;
+            return;
+        }
+        if (!packageIdFromAlias || !dependency.versionNumber) {
+            throw messages.createError('errorDependencyPair', [JSON.stringify(dependency)]);
+        }
+        // Just override dependency.packageId value to the resolved alias.
+        dependency.packageId = packageIdFromAlias;
+        pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, dependency.packageId);
+        (0, exports.validateVersionNumber)(dependency.versionNumber, versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN, versionNumber_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN);
+        await this.validatePatchVersion(dependency.versionNumber, dependency.packageId);
+        // Validate that the Package2 id exists on the server
+        const query = `SELECT Id FROM Package2 WHERE Id = '${dependency.packageId}'`;
+        const result = await this.connection.tooling.query(query);
+        if (!result.records || result.records.length !== 1) {
+            throw messages.createError('errorNoIdInHub', [dependency.packageId]);
+        }
+    }
     async resolveBuildNumber(versionNumber, packageId, branch) {
-        if (!versionNumber.isbuildKeyword()) {
+        if (!versionNumber.isBuildKeyword()) {
             // The build number is already specified so just return it using the tooling query result obj structure
             return `${versionNumber.build}`;
         }
@@ -304,12 +307,12 @@ class PackageVersionCreate {
         }
         this.resolveBuildUserPermissions(packageDescriptorJson);
         // All dependencies for the packaging dir should be resolved to an 04t id to be passed to the server.
-        // (see _retrieveSubscriberPackageVersionId for details)
+        // (see resolveSubscriberPackageVersionId() for details)
         const dependencies = packageDescriptorJson.dependencies;
         // branch and APV language can be set via options or packageDirectory; option takes precedence
         this.options.branch = this.options.branch ?? packageDescriptorJson.branch;
         this.options.language = this.options.language ?? apvLanguage;
-        const resultValues = await Promise.all(!dependencies ? [] : dependencies.map((dependency) => this.retrieveSubscriberPackageVersionId(dependency)));
+        const resultValues = await Promise.all(!dependencies ? [] : dependencies.map((dependency) => this.resolveSubscriberPackageVersionId(dependency)));
         const versionNumber = this.options.versionnumber ?? packageDescriptorJson.versionNumber;
         if (!versionNumber) {
             throw messages.createError('versionNumberRequired');

package/lib/package/subscriberPackageVersion.d.ts

@@ -1,7 +1,7 @@
 import { Connection } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { Nullable, Optional } from '@salesforce/ts-types';
-import { InstalledPackages, PackageInstallCreateRequest, PackageInstallOptions, PackageType, PackagingSObjects, SubscriberPackageVersionOptions } from '../interfaces';
+import { InstalledPackages, PackageDescriptorJson, PackageInstallCreateRequest, PackageInstallOptions, PackageType, PackagingSObjects, SubscriberPackageVersionOptions } from '../interfaces';
 import { VersionNumber } from './versionNumber';
 export declare const SubscriberPackageVersionFields: string[];
 /**
@@ -56,6 +56,18 @@ export declare class SubscriberPackageVersion {
      * @param connection
      */
     static getInstallRequest(installRequestId: string, connection: Connection): Promise<PackagingSObjects.PackageInstallRequest>;
+    /**
+     * Resolve fields from a packageDirectories entry to a SubscriberPackageVersionId (04t).
+     * Specifically uses the `versionNumber` and `packageId` fields, as well as an optional
+     * `branch` field.
+     *
+     * @param connection A connection object to the org
+     * @param pkgDescriptor Fields from a packageDirectories entry in sfdx-project.json.
+     * The `versionNumber` and `packageId` fields are required. Optionally, the `branch` and
+     * `package` fields can be passed.
+     * @returns the SubscriberPackageVersionId (04t)
+     */
+    static resolveId(connection: Connection, pkgDescriptor: Partial<PackageDescriptorJson>): Promise<string>;
     /**
      * Get the package version ID for this SubscriberPackageVersion.
      *
@@ -65,7 +77,7 @@ export declare class SubscriberPackageVersion {
     /**
      * Get the package type for this SubscriberPackageVersion.
      *
-     * @returns {PackageType} The package type.
+     * @returns {PackageType} The package type ("Managed" or "Unlocked") for this SubscriberPackageVersion.
      */
     getPackageType(): Promise<PackageType>;
     /**
@@ -77,7 +89,7 @@ export declare class SubscriberPackageVersion {
     /**
      * Get the subscriber package Id (033) for this SubscriberPackageVersion.
      *
-     * @returns {string} The subscriber package Id.
+     * @returns {string} The subscriber package Id (033).
      */
     getSubscriberPackageId(): Promise<string>;
     /**

package/lib/package/subscriberPackageVersion.js

@@ -12,6 +12,7 @@ const kit_1 = require("@salesforce/kit");
 const packageUtils_1 = require("../utils/packageUtils");
 const packageInstall_1 = require("./packageInstall");
 const packageUninstall_1 = require("./packageUninstall");
+const packageVersionCreate_1 = require("./packageVersionCreate");
 const versionNumber_1 = require("./versionNumber");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'subscriber_package_version');
@@ -186,6 +187,21 @@ class SubscriberPackageVersion {
         }
         return installRequest;
     }
+    /**
+     * Resolve fields from a packageDirectories entry to a SubscriberPackageVersionId (04t).
+     * Specifically uses the `versionNumber` and `packageId` fields, as well as an optional
+     * `branch` field.
+     *
+     * @param connection A connection object to the org
+     * @param pkgDescriptor Fields from a packageDirectories entry in sfdx-project.json.
+     * The `versionNumber` and `packageId` fields are required. Optionally, the `branch` and
+     * `package` fields can be passed.
+     * @returns the SubscriberPackageVersionId (04t)
+     */
+    static async resolveId(connection, pkgDescriptor) {
+        const pvc = new packageVersionCreate_1.PackageVersionCreate({ connection, project: core_1.SfProject.getInstance() });
+        return pvc.retrieveSubscriberPackageVersionId(pkgDescriptor);
+    }
     /**
      * Get the package version ID for this SubscriberPackageVersion.
      *
@@ -197,7 +213,7 @@ class SubscriberPackageVersion {
     /**
      * Get the package type for this SubscriberPackageVersion.
      *
-     * @returns {PackageType} The package type.
+     * @returns {PackageType} The package type ("Managed" or "Unlocked") for this SubscriberPackageVersion.
      */
     async getPackageType() {
         return this.getField('Package2ContainerOptions');
@@ -213,7 +229,7 @@ class SubscriberPackageVersion {
     /**
      * Get the subscriber package Id (033) for this SubscriberPackageVersion.
      *
-     * @returns {string} The subscriber package Id.
+     * @returns {string} The subscriber package Id (033).
      */
     async getSubscriberPackageId() {
         return this.getField('SubscriberPackageId');

package/lib/package/versionNumber.d.ts

@@ -23,10 +23,6 @@ export declare class VersionNumber {
     static from(versionString: string | undefined): VersionNumber;
     static isABuildKeyword(token: string | number): boolean;
     toString(): string;
-    /**
-     * @deprecated use isBuildKeyword instead
-     */
-    isbuildKeyword(): boolean;
     isBuildKeyword(): boolean;
     compareTo(other: VersionNumber): number;
 }

package/lib/package/versionNumber.js

@@ -77,12 +77,6 @@ class VersionNumber {
             return `${this.major || '0'}.${this.minor || '0'}.${this.patch || '0'}.${this.build ? `${this.build}` : '0'}`;
         }
     }
-    /**
-     * @deprecated use isBuildKeyword instead
-     */
-    isbuildKeyword() {
-        return this.isBuildKeyword();
-    }
     isBuildKeyword() {
         return VersionNumber.isABuildKeyword(this.build);
     }

package/lib/utils/packageUtils.d.ts

@@ -100,10 +100,8 @@ export declare function numberToDuration(duration: number | Duration | undefined
 /**
  * Zips directory to given zipfile.
  *
- * https://github.com/archiverjs/node-archiver
- *
- * @param dir to zip
- * @param zipfile
+ * @param dir directory to zip
+ * @param zipfile path to the zip file to create
  */
 export declare function zipDir(dir: string, zipfile: string): Promise<void>;
 export declare function copyDir(src: string, dest: string): void;

package/lib/utils/packageUtils.js

@@ -380,10 +380,8 @@ const pipeline = (0, node_util_1.promisify)(node_stream_1.pipeline);
 /**
  * Zips directory to given zipfile.
  *
- * https://github.com/archiverjs/node-archiver
- *
- * @param dir to zip
- * @param zipfile
+ * @param dir directory to zip
+ * @param zipfile path to the zip file to create
  */
 async function zipDir(dir, zipfile) {
     const logger = core_1.Logger.childFromRoot('srcDevUtils#zipDir');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "3.5.16",
+  "version": "3.5.17",
   "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.6",
+    "@salesforce/core": "^7.3.8",
     "@salesforce/kit": "^3.1.1",
     "@salesforce/schemas": "^1.7.0",
     "@salesforce/source-deploy-retrieve": "^11.4.3",