@salesforce/packaging 0.0.18 → 0.0.19

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.19](https://github.com/forcedotcom/packaging/compare/v0.0.18...v0.0.19) (2022-08-18)
+
+### Bug Fixes
+
+- package version. now stored in packdir in sfdx project ([a7a725d](https://github.com/forcedotcom/packaging/commit/a7a725dde13b8c73fbac7527141d006a7ed28fa8))
+
 ### [0.0.18](https://github.com/forcedotcom/packaging/compare/v0.0.17...v0.0.18) (2022-08-17)
 
 ### Bug Fixes

package/lib/package/package.d.ts

@@ -34,6 +34,7 @@ export declare class Package extends AsyncCreatable<PackageOptions> implements I
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
     uninstall(): Promise<void>;
     update(): Promise<void>;
+    getPackage(packageId: string): Promise<PackagingSObjects.Package2>;
     getExternalSites(subscriberPackageVersionId: string, installationKey?: string): Promise<Optional<string[]>>;
     waitForPublish(subscriberPackageVersionId: string, timeout: number | Duration, installationKey?: string): Promise<void>;
     protected init(): Promise<void>;

package/lib/package/package.js

@@ -75,6 +75,10 @@ class Package extends kit_1.AsyncCreatable {
     update() {
         return Promise.resolve(undefined);
     }
+    async getPackage(packageId) {
+        const package2 = await this.options.connection.tooling.sobject('Package2').retrieve(packageId);
+        return package2;
+    }
     async getExternalSites(subscriberPackageVersionId, installationKey) {
         return (0, packageInstall_1.getExternalSites)(this.options.connection, subscriberPackageVersionId, installationKey);
     }

package/lib/package/packageVersion.d.ts

@@ -46,11 +46,22 @@ export declare class PackageVersion {
      * @param wait - how long to wait for the package version to be created
      * @param interval - frequency of checking for the package version to be created
      */
-    waitForCreateVersion(createPackageVersionRequestId: string, wait?: Duration, interval?: Duration): Promise<PackageVersionCreateRequestResult>;
+    waitForCreateVersion(packageId: string, createPackageVersionRequestId: string, wait?: Duration, interval?: Duration): Promise<PackageVersionCreateRequestResult>;
     convert(): Promise<void>;
     install(): Promise<void>;
     list(): Promise<void>;
     uninstall(): Promise<void>;
     update(): Promise<void>;
     private updateDeprecation;
+    /**
+     * Increase the wait time for a package version that is org dependent.
+     *
+     * @param resolvedPackageId
+     * @param pollInterval
+     * @param wait
+     * @private
+     */
+    private resolveOrgDependentPollingTime;
+    private updateProjectWithPackageVersion;
+    private generatePackageDirectory;
 }

package/lib/package/packageVersion.js

@@ -11,9 +11,11 @@ const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const pkgUtils = require("../utils/packageUtils");
 const utils_1 = require("../utils");
+const packageUtils_1 = require("../utils/packageUtils");
 const packageVersionCreate_1 = require("./packageVersionCreate");
 const packageVersionReport_1 = require("./packageVersionReport");
 const packageVersionCreateRequestReport_1 = require("./packageVersionCreateRequestReport");
+const package_1 = require("./package");
 core_1.Messages.importMessagesDirectory(__dirname);
 // const messages = Messages.loadMessages('@salesforce/packaging', 'messages');
 // const logger = Logger.childFromRoot('packageVersionCreate');
@@ -31,7 +33,7 @@ class PackageVersion {
     async create(options) {
         const pvc = new packageVersionCreate_1.PackageVersionCreate({ ...options, ...this.options });
         const createResult = await pvc.createPackageVersion();
-        const waitResult = await this.waitForCreateVersion(createResult.Id, options.wait ?? kit_1.Duration.milliseconds(0), options.pollInterval ? options.pollInterval : kit_1.Duration.seconds(30)).catch((err) => {
+        const waitResult = await this.waitForCreateVersion(createResult.Package2Id, createResult.Id, options.wait ?? kit_1.Duration.milliseconds(0), options.pollInterval ? options.pollInterval : kit_1.Duration.seconds(30)).catch((err) => {
             // TODO
             // until package2 is GA, wrap perm-based errors w/ 'contact sfdc' action (REMOVE once package2 is GA'd)
             throw pkgUtils.applyErrorAction(err);
@@ -98,11 +100,12 @@ class PackageVersion {
      * @param wait - how long to wait for the package version to be created
      * @param interval - frequency of checking for the package version to be created
      */
-    async waitForCreateVersion(createPackageVersionRequestId, wait = kit_1.Duration.milliseconds(0), interval = kit_1.Duration.milliseconds(0)) {
+    async waitForCreateVersion(packageId, createPackageVersionRequestId, wait = kit_1.Duration.milliseconds(0), interval = kit_1.Duration.milliseconds(0)) {
         if (wait?.milliseconds <= 0) {
             const result = await this.getCreateVersionReport(createPackageVersionRequestId);
             return result;
         }
+        const resolvedWait = await this.resolveOrgDependentPollingTime(packageId, wait, interval);
         let remainingWaitTime = wait;
         let report;
         const pollingClient = await core_1.PollingClient.create({
@@ -129,6 +132,7 @@ class PackageVersion {
                             payload: report,
                         };
                     case 'Success':
+                        await this.updateProjectWithPackageVersion(this.project, report);
                         await core_1.Lifecycle.getInstance().emit('success', report);
                         return { completed: true, payload: report };
                     case 'Error':
@@ -137,7 +141,7 @@ class PackageVersion {
                 }
             },
             frequency: interval,
-            timeout: wait,
+            timeout: resolvedWait,
         });
         try {
             return pollingClient.subscribe();
@@ -180,6 +184,53 @@ class PackageVersion {
         updateResult.id = await pkgUtils.getSubscriberPackageVersionId(packageVersionId, this.connection);
         return updateResult;
     }
+    /**
+     * Increase the wait time for a package version that is org dependent.
+     *
+     * @param resolvedPackageId
+     * @param pollInterval
+     * @param wait
+     * @private
+     */
+    async resolveOrgDependentPollingTime(resolvedPackageId, wait, pollInterval) {
+        // If we are polling check to see if the package is Org-Dependent, if so, update the poll time
+        if (wait.milliseconds > 0) {
+            const query = `SELECT IsOrgDependent FROM Package2 WHERE Id = '${resolvedPackageId}'`;
+            try {
+                const pkgQueryResult = await this.connection.singleRecordQuery(query, {
+                    tooling: true,
+                });
+                if (pkgQueryResult.IsOrgDependent) {
+                    return kit_1.Duration.seconds((60 / pollInterval.seconds) * wait.seconds);
+                }
+            }
+            catch {
+                // do nothing
+            }
+        }
+        return wait;
+    }
+    async updateProjectWithPackageVersion(withProject, results) {
+        if (withProject && !process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
+            const query = `SELECT Name, Package2Id, MajorVersion, MinorVersion, PatchVersion, BuildNumber, Description, Branch FROM Package2Version WHERE Id = '${results.Package2VersionId}'`;
+            const packageVersion = await this.connection.singleRecordQuery(query, {
+                tooling: true,
+            });
+            const packageVersionVersionString = `${packageVersion.MajorVersion}.${packageVersion.MinorVersion}.${packageVersion.PatchVersion}.${packageVersion.BuildNumber}`;
+            await this.generatePackageDirectory(packageVersion, withProject, packageVersionVersionString);
+            const newConfig = await (0, packageUtils_1.generatePackageAliasEntry)(this.connection, withProject, packageVersion.SubscriberPackageVersionId, packageVersionVersionString, packageVersion.Branch, packageVersion.Package2Id);
+            withProject.getSfProjectJson().set('packageAliases', newConfig);
+            await withProject.getSfProjectJson().write();
+        }
+    }
+    async generatePackageDirectory(packageVersion, withProject, packageVersionVersionString) {
+        const pkg = await (await package_1.Package.create({ connection: this.connection })).getPackage(packageVersion.Package2Id);
+        const pkgDir = (0, packageUtils_1.getConfigPackageDirectory)(withProject.getPackageDirectories(), 'id', pkg.Id) ?? {};
+        pkgDir.versionNumber = packageVersionVersionString;
+        pkgDir.versionDescription = packageVersion.Description;
+        const packageDirs = withProject.getPackageDirectories().map((pd) => (pkgDir['id'] === pd['id'] ? pkgDir : pd));
+        withProject.getSfProjectJson().set('packageDirectories', packageDirs);
+    }
 }
 exports.PackageVersion = PackageVersion;
 //# sourceMappingURL=packageVersion.js.map

package/lib/package/packageVersionCreate.d.ts

@@ -55,7 +55,6 @@ export declare class PackageVersionCreate {
     private resolveCanonicalPackageProperty;
     private validateVersionNumber;
     private resolveUserLicenses;
-    private resolveOrgDependentPollingTime;
     private validateFlagsForPackageType;
     /**
      * Cleans invalid attribute(s) from the packageDescriptorJSON

package/lib/package/packageVersionCreate.js

@@ -15,7 +15,6 @@ const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const testSetup_1 = require("@salesforce/core/lib/testSetup");
 const scratchOrgSettingsGenerator_1 = require("@salesforce/core/lib/org/scratchOrgSettingsGenerator");
 const xml2js = require("xml2js");
-const kit_1 = require("@salesforce/kit");
 const pkgUtils = require("../utils/packageUtils");
 const constants_1 = require("../constants");
 const utils_1 = require("../utils");
@@ -26,7 +25,6 @@ core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
 const logger = core_1.Logger.childFromRoot('packageVersionCreate');
 const DESCRIPTOR_FILE = 'package2-descriptor.json';
-const POLL_INTERVAL_WITHOUT_VALIDATION_SECONDS = 5;
 class PackageVersionCreate {
     constructor(options) {
         this.options = options;
@@ -589,15 +587,6 @@ class PackageVersionCreate {
                 errStr.toString(),
             ]);
         }
-        let pollInterval = kit_1.Duration.seconds(pkgUtils.POLL_INTERVAL_SECONDS);
-        let maxRetries = 0;
-        if (options.wait?.milliseconds > 0) {
-            if (options.skipvalidation === true) {
-                pollInterval = kit_1.Duration.seconds(POLL_INTERVAL_WITHOUT_VALIDATION_SECONDS);
-            }
-            maxRetries = (60 / pollInterval.seconds) * options.wait.seconds;
-        }
-        [pollInterval, maxRetries] = await this.resolveOrgDependentPollingTime(resolvedPackageId, options, pollInterval, maxRetries);
         return (await this.listRequestById(createResult.id, this.connection))[0];
     }
     resolveCanonicalPackageProperty(options) {
@@ -651,27 +640,6 @@ class PackageVersionCreate {
             generateProfileInformation: shouldGenerateProfileInformation,
         });
     }
-    async resolveOrgDependentPollingTime(resolvedPackageId, options, pollInterval, maxRetries) {
-        let pi = pollInterval;
-        let mr = maxRetries;
-        // If we are polling check to see if the package is Org-Dependent, if so, update the poll time
-        if (options.wait) {
-            const query = `SELECT IsOrgDependent FROM Package2 WHERE Id = '${resolvedPackageId}'`;
-            try {
-                const pkgQueryResult = await this.connection.singleRecordQuery(query, {
-                    tooling: true,
-                });
-                if (pkgQueryResult.IsOrgDependent) {
-                    pi = kit_1.Duration.seconds(POLL_INTERVAL_WITHOUT_VALIDATION_SECONDS);
-                    mr = (60 / pollInterval.seconds) * options.wait.seconds;
-                }
-            }
-            catch {
-                // do nothing
-            }
-        }
-        return [pi, mr];
-    }
     async validateFlagsForPackageType(packageId, options) {
         const packageType = await pkgUtils.getPackageType(packageId, this.connection);
         if (packageType === 'Unlocked') {

package/lib/utils/packageUtils.d.ts

@@ -148,6 +148,22 @@ export declare function convertCamelCaseStringToSentence(stringIn: string): stri
 export declare function getPackageAliasesFromId(packageId: string, project: SfProject): string[];
 export declare function findOrCreatePackage(seedPackage: string, connection: Connection): Promise<string>;
 export declare function pollForStatusWithInterval(id: string, retries: number, packageId: string, branch: string, withProject: SfProject, connection: Connection, interval: Duration): Promise<PackageVersionCreateRequestResult>;
+/**
+ * Generate package alias json entry for this package version that can be written to sfdx-project.json
+ *
+ * @param connection
+ * @param project SfProject instance for the project
+ * @param packageVersionId 04t id of the package to create the alias entry for
+ * @param packageVersionNumber that will be appended to the package name to form the alias
+ * @param branch
+ * @param packageId the 0Ho id
+ * @private
+ */
+export declare function generatePackageAliasEntry(connection: Connection, project: SfProject, packageVersionId: string, packageVersionNumber: string, branch: string, packageId: string): Promise<{
+    packageAliases: {
+        [p: string]: string;
+    };
+}>;
 export declare function getSoqlWhereClauseMaxLength(): number;
 export declare function formatDate(date: Date): string;
 export declare function combineSaveErrors(sObject: string, crudOperation: string, errors: SaveError[]): SfError;

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveCanonicalPackageProperty = exports.combineSaveErrors = exports.formatDate = exports.getSoqlWhereClauseMaxLength = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.validateAncestorId = exports.getAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validUrl = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
+exports.resolveCanonicalPackageProperty = exports.combineSaveErrors = exports.formatDate = exports.getSoqlWhereClauseMaxLength = exports.generatePackageAliasEntry = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.validateAncestorId = exports.getAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validUrl = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -682,11 +682,11 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                             const record = pkgQueryResult.records[0];
                             return `${record.MajorVersion}.${record.MinorVersion}.${record.PatchVersion}-${record.BuildNumber}`;
                         });
-                        const newConfig = await _generatePackageAliasEntry(connection, withProject, results[0].SubscriberPackageVersionId, packageVersionVersionString, branch, packageId);
+                        const newConfig = await generatePackageAliasEntry(connection, withProject, results[0].SubscriberPackageVersionId, packageVersionVersionString, branch, packageId);
                         withProject.getSfProjectJson().set('packageAliases', newConfig);
                         await withProject.getSfProjectJson().write();
                     }
-                    core_1.Lifecycle.getInstance().emit(Package2VersionStatus.success, {
+                    await core_1.Lifecycle.getInstance().emit(Package2VersionStatus.success, {
                         id,
                         packageVersionCreateRequestResult: results[0],
                         projectUpdated,
@@ -706,13 +706,13 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                         }
                         status = errors.length !== 0 ? errors.join('\n') : results[0].Error.join('\n');
                     }
-                    core_1.Lifecycle.getInstance().emit(Package2VersionStatus.error, { id, status });
+                    await core_1.Lifecycle.getInstance().emit(Package2VersionStatus.error, { id, status });
                     throw new core_1.SfError(status);
                 }
             }
             else {
                 const remainingTime = kit_1.Duration.milliseconds(interval.milliseconds * remainingRetries);
-                core_1.Lifecycle.getInstance().emit(Package2VersionStatus.inProgress, {
+                await core_1.Lifecycle.getInstance().emit(Package2VersionStatus.inProgress, {
                     id,
                     packageVersionCreateRequestResult: results[0],
                     message: '',
@@ -740,16 +740,15 @@ exports.pollForStatusWithInterval = pollForStatusWithInterval;
  * @param packageId the 0Ho id
  * @private
  */
-async function _generatePackageAliasEntry(connection, project, packageVersionId, packageVersionNumber, branch, packageId) {
+async function generatePackageAliasEntry(connection, project, packageVersionId, packageVersionNumber, branch, packageId) {
     const configContent = project.getSfProjectJson().getContents();
     const packageAliases = configContent.packageAliases || {};
     const aliasForPackageId = getPackageAliasesFromId(packageId, project);
     let packageName;
     if (!aliasForPackageId || aliasForPackageId.length === 0) {
         const query = `SELECT Name FROM Package2 WHERE Id = '${packageId}'`;
-        packageName = await connection.tooling
-            .query(query)
-            .then((pkgQueryResult) => pkgQueryResult.records[0]?.Name);
+        const package2 = await connection.singleRecordQuery(query, { tooling: true });
+        packageName = package2.Name;
     }
     else {
         packageName = aliasForPackageId[0];
@@ -760,6 +759,7 @@ async function _generatePackageAliasEntry(connection, project, packageVersionId,
     packageAliases[packageAlias] = packageVersionId;
     return { packageAliases };
 }
+exports.generatePackageAliasEntry = generatePackageAliasEntry;
 /**
  * Return true if the queryResult.records[0].Status is equal to one of the values in statuses.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",