@salesforce/packaging 0.0.21 → 0.0.24

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.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
+
+- add package.promote method ([de5867b](https://github.com/forcedotcom/packaging/commit/de5867bc45850ca2040e4e929a2149a7a146c93f))
+
 ### [0.0.21](https://github.com/forcedotcom/packaging/compare/v0.0.20...v0.0.21) (2022-08-19)
 
 ### Bug Fixes

package/lib/package/package.d.ts

@@ -1,8 +1,7 @@
 import { AsyncCreatable, Duration } from '@salesforce/kit';
 import { QueryResult } from 'jsforce';
 import { Optional } from '@salesforce/ts-types';
-import { IPackage, PackageOptions, PackagingSObjects } from '../interfaces';
-import { PackageInstallOptions, PackageInstallCreateRequest, PackageIdType } from '../interfaces/packagingInterfacesAndType';
+import { IPackage, PackageOptions, PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest, PackageIdType } from '../interfaces';
 declare type PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
 /**
  * Package class.

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

@@ -46,6 +46,7 @@ export declare class PackageVersion {
      * This function emits LifeCycle events, "enqueued", "in-progress", "success", "error" and "timed-out" to
      * progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.
      *
+     * @param packageId - The package id to wait for
      * @param createPackageVersionRequestId
      * @param polling frequency and timeout Durations to be used in polling
      * */
@@ -57,6 +58,7 @@ export declare class PackageVersion {
     install(): Promise<void>;
     list(): Promise<void>;
     uninstall(): Promise<void>;
+    promote(id: string): Promise<PackageSaveResult>;
     update(): Promise<void>;
     private updateDeprecation;
     private updateProjectWithPackageVersion;

package/lib/package/packageVersion.js

@@ -9,8 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PackageVersion = void 0;
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
-const pkgUtils = require("../utils/packageUtils");
-const packageUtils_1 = require("../utils/packageUtils");
+const utils_1 = require("../utils");
 const packageVersionCreate_1 = require("./packageVersionCreate");
 const packageVersionReport_1 = require("./packageVersionReport");
 const packageVersionCreateRequestReport_1 = require("./packageVersionCreateRequestReport");
@@ -37,7 +36,7 @@ class PackageVersion {
         return await this.waitForCreateVersion(createResult.Id, polling).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);
+            throw (0, utils_1.applyErrorAction)(err);
         });
     }
     /**
@@ -71,7 +70,7 @@ class PackageVersion {
         }).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);
+            throw (0, utils_1.applyErrorAction)(err);
         });
         return results[0];
     }
@@ -87,7 +86,7 @@ class PackageVersion {
         }).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);
+            throw (0, utils_1.applyErrorAction)(err);
         });
     }
     /**
@@ -96,6 +95,7 @@ class PackageVersion {
      * This function emits LifeCycle events, "enqueued", "in-progress", "success", "error" and "timed-out" to
      * progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.
      *
+     * @param packageId - The package id to wait for
      * @param createPackageVersionRequestId
      * @param polling frequency and timeout Durations to be used in polling
      * */
@@ -134,7 +134,7 @@ class PackageVersion {
                         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, packageUtils_1.getPackageAliasesFromId)(report.Package2Id, this.project).join()}@${versionResult.MajorVersion ?? 0}.${versionResult.MinorVersion ?? 0}.${versionResult.PatchVersion ?? 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>'
@@ -156,7 +156,7 @@ class PackageVersion {
         }
         catch (err) {
             await core_1.Lifecycle.getInstance().emit('timed-out', report);
-            throw pkgUtils.applyErrorAction(err);
+            throw (0, utils_1.applyErrorAction)(err);
         }
     }
     convert() {
@@ -171,15 +171,22 @@ class PackageVersion {
     uninstall() {
         return Promise.resolve(undefined);
     }
+    async promote(id) {
+        // lookup the 05i ID, if needed
+        if (id.startsWith('04t')) {
+            id = await (0, utils_1.getPackageVersionId)(id, this.connection);
+        }
+        return await this.options.connection.tooling.update('Package2Version', { IsReleased: true, Id: id });
+    }
     update() {
         return Promise.resolve(undefined);
     }
     async updateDeprecation(idOrAlias, IsDeprecated) {
-        const packageVersionId = pkgUtils.getPackageIdFromAlias(idOrAlias, this.project);
+        const packageVersionId = (0, utils_1.getPackageIdFromAlias)(idOrAlias, this.project);
         // ID can be an 04t or 05i
-        pkgUtils.validateId([pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, pkgUtils.BY_LABEL.PACKAGE_VERSION_ID], packageVersionId);
+        (0, utils_1.validateId)([utils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, utils_1.BY_LABEL.PACKAGE_VERSION_ID], packageVersionId);
         // lookup the 05i ID, if needed
-        const packageId = await pkgUtils.getPackageVersionId(packageVersionId, this.connection);
+        const packageId = await (0, utils_1.getPackageVersionId)(packageVersionId, this.connection);
         // setup the request
         const request = {
             Id: packageId,
@@ -187,9 +194,9 @@ class PackageVersion {
         };
         const updateResult = await this.connection.tooling.update('Package2Version', request);
         if (!updateResult.success) {
-            throw (0, packageUtils_1.combineSaveErrors)('Package2', 'update', updateResult.errors);
+            throw (0, utils_1.combineSaveErrors)('Package2', 'update', updateResult.errors);
         }
-        updateResult.id = await pkgUtils.getSubscriberPackageVersionId(packageVersionId, this.connection);
+        updateResult.id = await (0, utils_1.getSubscriberPackageVersionId)(packageVersionId, this.connection);
         return updateResult;
     }
     async updateProjectWithPackageVersion(withProject, results) {
@@ -200,14 +207,14 @@ class PackageVersion {
             });
             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);
+            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();
         }
     }
     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) ?? {};
+        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));

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');

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.21",
+  "version": "0.0.24",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -35,8 +35,8 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^3.26.1",
-    "@salesforce/kit": "^1.5.44",
+    "@salesforce/core": "^3.26.2",
+    "@salesforce/kit": "^1.6.0",
     "@salesforce/schemas": "^1.2.0",
     "@salesforce/source-deploy-retrieve": "^6.2.0",
     "@salesforce/ts-types": "^1.5.20",