@salesforce/packaging 0.0.22 → 0.0.25

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.25](https://github.com/forcedotcom/packaging/compare/v0.0.24...v0.0.25) (2022-08-25)
+
+### Bug Fixes
+
+- improve packge property maintenance ([c62acf8](https://github.com/forcedotcom/packaging/commit/c62acf84ad84deec6d77079200290ab09064f6d7))
+
+### [0.0.24](https://github.com/forcedotcom/packaging/compare/v0.0.23...v0.0.24) (2022-08-24)
+
+### Bug Fixes
+
+- correct package alias generation ([c4617bd](https://github.com/forcedotcom/packaging/commit/c4617bd16eac1f2bfe5efadafc1062ea78ee352c))
+
+### [0.0.23](https://github.com/forcedotcom/packaging/compare/v0.0.22...v0.0.23) (2022-08-22)
+
+### Bug Fixes
+
+- increase pvc ut timeout to 10 secs ([08e667f](https://github.com/forcedotcom/packaging/commit/08e667f574abf5a3de0686c5dcfd654d9fa4c0fa))
+- remove ref to dev dep ([a51323a](https://github.com/forcedotcom/packaging/commit/a51323aaf699eb82fc515722681c6f1b56edb5f4))
+
 ### [0.0.22](https://github.com/forcedotcom/packaging/compare/v0.0.21...v0.0.22) (2022-08-22)
 
 ### Bug Fixes

package/lib/package/packageConvert.js

@@ -13,7 +13,7 @@ const os = require("os");
 const fs = require("fs");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
-const testSetup_1 = require("@salesforce/core/lib/testSetup");
+const uniqid_1 = require("../utils/uniqid");
 const pkgUtils = require("../utils/packageUtils");
 const constants_1 = require("../constants");
 const srcDevUtil = require("../utils/srcDevUtils");
@@ -55,7 +55,7 @@ exports.convertPackage = convertPackage;
  * @private
  */
 async function createPackageVersionCreateRequest(context, packageId) {
-    const uniqueId = (0, testSetup_1.uniqid)({ template: `${packageId}-%s` });
+    const uniqueId = (0, uniqid_1.uniqid)({ template: `${packageId}-%s` });
     const packageVersTmpRoot = path.join(os.tmpdir(), uniqueId);
     const packageVersBlobDirectory = path.join(packageVersTmpRoot, 'package-version-info');
     const packageVersBlobZipFile = path.join(packageVersTmpRoot, constants_1.consts.PACKAGE_VERSION_INFO_FILE_ZIP);

package/lib/package/packageVersion.d.ts

@@ -62,5 +62,4 @@ export declare class PackageVersion {
     update(): Promise<void>;
     private updateDeprecation;
     private updateProjectWithPackageVersion;
-    private generatePackageDirectory;
 }

package/lib/package/packageVersion.js

@@ -13,7 +13,6 @@ const utils_1 = require("../utils");
 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);
 class PackageVersion {
     constructor(options) {
@@ -129,19 +128,8 @@ class PackageVersion {
                             payload: report,
                         };
                     case 'Success':
-                        await this.updateProjectWithPackageVersion(this.project, report);
                         await core_1.Lifecycle.getInstance().emit('success', report);
-                        if (!process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE) {
-                            // get the newly created package version from the server
-                            const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${report.SubscriberPackageVersionId}'`)).records[0];
-                            const version = `${(0, utils_1.getPackageAliasesFromId)(report.Package2Id, this.project).join()}@${versionResult.MajorVersion ?? 0}.${versionResult.MinorVersion ?? 0}.${versionResult.PatchVersion ?? 0}`;
-                            const build = versionResult.BuildNumber ? `-${versionResult.BuildNumber}` : '';
-                            const branch = versionResult.Branch ? `-${versionResult.Branch}` : '';
-                            // set packageAliases entry '<package>@<major>.<minor>.<patch>-<build>-<branch>: <result.subscriberPackageVersionId>'
-                            this.project.getSfProjectJson().getContents().packageAliases[`${version}${build}${branch}`] =
-                                report.SubscriberPackageVersionId;
-                            await this.project.getSfProjectJson().write();
-                        }
+                        await this.updateProjectWithPackageVersion(this.project, report);
                         return { completed: true, payload: report };
                     case 'Error':
                         await core_1.Lifecycle.getInstance().emit('error', report);
@@ -201,25 +189,17 @@ class PackageVersion {
     }
     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, utils_1.generatePackageAliasEntry)(this.connection, withProject, packageVersion.SubscriberPackageVersionId, packageVersionVersionString, packageVersion.Branch, packageVersion.Package2Id);
-            withProject.getSfProjectJson().set('packageAliases', newConfig);
-            await withProject.getSfProjectJson().write();
+            // get the newly created package version from the server
+            const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${results.SubscriberPackageVersionId}'`)).records[0];
+            const version = `${(0, utils_1.getPackageAliasesFromId)(results.Package2Id, this.project).join()}@${versionResult.MajorVersion ?? 0}.${versionResult.MinorVersion ?? 0}.${versionResult.PatchVersion ?? 0}`;
+            const build = versionResult.BuildNumber ? `-${versionResult.BuildNumber}` : '';
+            const branch = versionResult.Branch ? `-${versionResult.Branch}` : '';
+            // set packageAliases entry '<package>@<major>.<minor>.<patch>-<build>-<branch>: <result.subscriberPackageVersionId>'
+            this.project.getSfProjectJson().getContents().packageAliases[`${version}${build}${branch}`] =
+                results.SubscriberPackageVersionId;
+            await this.project.getSfProjectJson().write();
         }
     }
-    async generatePackageDirectory(packageVersion, withProject, packageVersionVersionString) {
-        const pkg = await (await package_1.Package.create({ connection: this.connection })).getPackage(packageVersion.Package2Id);
-        const pkgDir = (0, utils_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.js

@@ -12,10 +12,10 @@ const os = require("os");
 const fs = require("fs");
 const core_1 = require("@salesforce/core");
 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 scratchOrgInfoGenerator_1 = require("@salesforce/core/lib/org/scratchOrgInfoGenerator");
+const uniqid_1 = require("../utils/uniqid");
 const pkgUtils = require("../utils/packageUtils");
 const versionNumber_1 = require("../utils/versionNumber");
 const utils_1 = require("../utils");
@@ -221,7 +221,7 @@ class PackageVersionCreate {
      */
     async createPackageVersionCreateRequestFromOptions() {
         const preserveFiles = !!(this.options.preserve || process.env.SFDX_PACKAGE2_VERSION_CREATE_PRESERVE);
-        const uniqueHash = (0, testSetup_1.uniqid)({ template: `${this.packageId}-%s` });
+        const uniqueHash = (0, uniqid_1.uniqid)({ template: `${this.packageId}-%s` });
         const packageVersTmpRoot = path.join(os.tmpdir(), `${uniqueHash}`);
         const packageVersMetadataFolder = path.join(packageVersTmpRoot, 'md-files');
         const unpackagedMetadataFolder = path.join(packageVersTmpRoot, 'unpackaged-md-files');
@@ -415,10 +415,12 @@ class PackageVersionCreate {
         }
         // from the packageDirectories in sfdx-project.json, find the correct package entry either by finding a matching package (name) or path
         this.packageAlias = (0, utils_1.getPackageAliasesFromId)(this.options.packageId, this.options.project).join();
-        // set on the class so we can access them in other methods without redoing this logic
-        this.packageObject = this.project.getPackageDirectories().find((pkg) => pkg.package === this.packageAlias);
+        this.packageId = this.options.packageId;
+        // set on the class, so we can access them in other methods without redoing this logic
+        this.packageObject = this.project
+            .getPackageDirectories()
+            .find((pkg) => pkg.package === this.packageAlias || pkg['id'] === this.options.packageId);
         this.options.profileApi = await this.resolveUserLicenses(this.packageObject.includeProfileUserLicenses);
-        this.packageId = (0, utils_1.getPackageIdFromAlias)(this.packageObject.package, this.project);
         // At this point, the packageIdFromAlias should have been resolved to an Id.  Now, we
         // need to validate that the Id is correct.
         pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, this.packageId);

package/lib/utils/packageUtils.d.ts

@@ -148,9 +148,7 @@ export declare function pollForStatusWithInterval(id: string, retries: number, p
  * @private
  */
 export declare function generatePackageAliasEntry(connection: Connection, project: SfProject, packageVersionId: string, packageVersionNumber: string, branch: string, packageId: string): Promise<{
-    packageAliases: {
-        [p: string]: string;
-    };
+    [p: string]: string;
 }>;
 export declare function formatDate(date: Date): string;
 export declare function combineSaveErrors(sObject: string, crudOperation: string, errors: SaveError[]): SfError;

package/lib/utils/packageUtils.js

@@ -653,7 +653,7 @@ async function generatePackageAliasEntry(connection, project, packageVersionId,
         ? `${packageName}@${packageVersionNumber}-${branch}`
         : `${packageName}@${packageVersionNumber}`;
     packageAliases[packageAlias] = packageVersionId;
-    return { packageAliases };
+    return packageAliases;
 }
 exports.generatePackageAliasEntry = generatePackageAliasEntry;
 /**

package/lib/utils/uniqid.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A function to generate a unique id and return it in the context of a template, if supplied.
+ *
+ * A template is a string that can contain `${%s}` to be replaced with a unique id.
+ * If the template contains the "%s" placeholder, it will be replaced with the unique id otherwise the id will be appended to the template.
+ *
+ * @param options an object with the following properties:
+ * - template: a template string.
+ * - length: the length of the unique id as presented in hexadecimal.
+ */
+export declare function uniqid(options?: {
+    template?: string;
+    length?: number;
+}): string;

package/lib/utils/uniqid.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uniqid = void 0;
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const crypto_1 = require("crypto");
+const util = require("util");
+/**
+ * A function to generate a unique id and return it in the context of a template, if supplied.
+ *
+ * A template is a string that can contain `${%s}` to be replaced with a unique id.
+ * If the template contains the "%s" placeholder, it will be replaced with the unique id otherwise the id will be appended to the template.
+ *
+ * @param options an object with the following properties:
+ * - template: a template string.
+ * - length: the length of the unique id as presented in hexadecimal.
+ */
+function uniqid(options) {
+    const uniqueString = (0, crypto_1.randomBytes)(Math.ceil((options?.length ?? 32) / 2.0))
+        .toString('hex')
+        .slice(0, options?.length ?? 32);
+    if (!options?.template) {
+        return uniqueString;
+    }
+    return options.template.includes('%s')
+        ? util.format(options.template, uniqueString)
+        : `${options.template}${uniqueString}`;
+}
+exports.uniqid = uniqid;
+//# sourceMappingURL=uniqid.js.map

package/package.json

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