@salesforce/packaging 0.0.35 → 0.0.37

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.37](https://github.com/forcedotcom/packaging/compare/v0.0.36...v0.0.37) (2022-09-16)
+
+### Bug Fixes
+
+- move util functions with single ref ([e7117d3](https://github.com/forcedotcom/packaging/commit/e7117d3530ac56717796da3535394ca184d53643))
+
+### [0.0.36](https://github.com/forcedotcom/packaging/compare/v0.0.35...v0.0.36) (2022-09-14)
+
+### Bug Fixes
+
+- standardize event names across classes, methods, and events ([d97c231](https://github.com/forcedotcom/packaging/commit/d97c231928582dd092bf0ce225dffa3298cce8eb))
+
 ### [0.0.35](https://github.com/forcedotcom/packaging/compare/v0.0.34...v0.0.35) (2022-09-09)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -15,7 +15,7 @@ export interface IPackage {
     install(pkgInstallCreateRequest: PackageInstallCreateRequest, options?: PackageInstallOptions): Promise<PackageInstallRequest>;
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
-    uninstall(): Promise<void>;
+    uninstall(id: string, wait: Duration): Promise<PackagingSObjects.SubscriberPackageVersionUninstallRequest>;
     update(options: PackageUpdateOptions): Promise<PackageSaveResult>;
     waitForPublish(subscriberPackageVersionKey: string, timeout: number | Duration, installationKey?: string): any;
     getExternalSites(subscriberPackageVersionKey: string, installationKey?: string): any;
@@ -308,3 +308,33 @@ export interface AncestryRepresentationProducer {
     addNode(node: AncestryRepresentationProducer): void;
     produce<T>(): T | string | void;
 }
+export declare const PackageEvents: {
+    convert: {
+        success: string;
+        error: string;
+        progress: string;
+    };
+    install: {
+        warning: string;
+        presend: string;
+        postsend: string;
+        status: string;
+        'subscriber-status': string;
+    };
+    uninstall: string;
+};
+export declare const PackageVersionEvents: {
+    create: {
+        enqueued: string;
+        progress: string;
+        success: string;
+        error: string;
+        'timed-out': string;
+        'preserve-files': string;
+    };
+};
+export declare const Package1VersionEvents: {
+    create: {
+        progress: string;
+    };
+};

package/lib/interfaces/packagingInterfacesAndType.js

@@ -6,8 +6,38 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageVersionCreateRequestResultInProgressStatuses = void 0;
+exports.Package1VersionEvents = exports.PackageVersionEvents = exports.PackageEvents = exports.PackageVersionCreateRequestResultInProgressStatuses = void 0;
 const packagingSObjects_1 = require("./packagingSObjects");
 var Package2VersionStatus = packagingSObjects_1.PackagingSObjects.Package2VersionStatus;
 exports.PackageVersionCreateRequestResultInProgressStatuses = Object.values(Package2VersionStatus).filter((status) => !['Queued', 'Success', 'Error'].includes(status));
+exports.PackageEvents = {
+    convert: {
+        success: 'Package/convert-success',
+        error: 'Package/convert-error',
+        progress: 'Package/convert-in-progress',
+    },
+    install: {
+        warning: 'Package/install-warning',
+        presend: 'Package/install-presend',
+        postsend: 'Package/install-postsend',
+        status: 'Package/install-status',
+        'subscriber-status': 'Package/install-subscriber-status',
+    },
+    uninstall: 'Package/uninstall',
+};
+exports.PackageVersionEvents = {
+    create: {
+        enqueued: 'PackageVersion/create-enqueued',
+        progress: 'PackageVersion/create-in-progress',
+        success: 'PackageVersion/create-success',
+        error: 'PackageVersion/create-error',
+        'timed-out': 'PackageVersion/create-timed-out',
+        'preserve-files': 'PackageVersion/create-preserve-files',
+    },
+};
+exports.Package1VersionEvents = {
+    create: {
+        progress: 'Package1Version/create-progress',
+    },
+};
 //# sourceMappingURL=packagingInterfacesAndType.js.map

package/lib/package/package.d.ts

@@ -32,7 +32,7 @@ export declare class Package extends AsyncCreatable<PackageOptions> implements I
     install(pkgInstallCreateRequest: PackageInstallCreateRequest, options?: PackageInstallOptions): Promise<PackageInstallRequest>;
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
-    uninstall(): Promise<void>;
+    uninstall(id: string, wait: Duration): Promise<PackagingSObjects.SubscriberPackageVersionUninstallRequest>;
     /**
      * Reports on the uninstall progress of a package.
      *

package/lib/package/package.js

@@ -12,6 +12,7 @@ const kit_1 = require("@salesforce/kit");
 const packageList_1 = require("./packageList");
 const packageInstall_1 = require("./packageInstall");
 const packageConvert_1 = require("./packageConvert");
+const packageUninstall_1 = require("./packageUninstall");
 const packagePrefixes = {
     PackageId: '0Ho',
     SubscriberPackageVersionId: '04t',
@@ -70,8 +71,8 @@ class Package extends kit_1.AsyncCreatable {
     list() {
         return (0, packageList_1.listPackages)(this.options.connection);
     }
-    uninstall() {
-        return Promise.resolve(undefined);
+    async uninstall(id, wait) {
+        return await (0, packageUninstall_1.uninstallPackage)(id, this.options.connection, wait);
     }
     /**
      * Reports on the uninstall progress of a package.

package/lib/package/packageAncestry.d.ts

@@ -3,7 +3,7 @@ import { AsyncCreatable } from '@salesforce/kit';
 import { Tree } from '@oclif/core/lib/cli-ux/styled/tree';
 import { Attributes } from 'graphology-types';
 import { AncestryRepresentationProducer, AncestryRepresentationProducerOptions, PackageAncestryNodeOptions, PackageAncestryOptions } from '../interfaces';
-import { VersionNumber } from '../utils/versionNumber';
+import { VersionNumber } from '../utils';
 /**
  * A class that represents the package ancestry graph.
  */

package/lib/package/packageAncestry.js

@@ -26,17 +26,17 @@ const kit_1 = require("@salesforce/kit");
 const tree_1 = require("@oclif/core/lib/cli-ux/styled/tree");
 const graphology_traversal_1 = require("graphology-traversal");
 const pkgUtils = require("../utils/packageUtils");
-const versionNumber_1 = require("../utils/versionNumber");
+const utils_1 = require("../utils");
 core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_ancestry');
 const SELECT_PACKAGE_VERSION = 'SELECT AncestorId, SubscriberPackageVersionId, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version';
 const SELECT_PACKAGE_CONTAINER_OPTIONS = 'SELECT ContainerOptions FROM Package2   ';
 const SELECT_PACKAGE_VERSION_CONTAINER_OPTIONS = 'SELECT Package2ContainerOptions FROM SubscriberPackageVersion';
 // Add this to query calls to only show released package versions in the output
 const releasedOnlyFilter = ' AND IsReleased = true';
 const sortAncestryNodeData = (a, b) => {
-    const aVersion = new versionNumber_1.VersionNumber(a.options.node.MajorVersion, a.options.node.MinorVersion, a.options.node.PatchVersion, a.options.node.BuildNumber);
-    const bVersion = new versionNumber_1.VersionNumber(b.options.node.MajorVersion, b.options.node.MinorVersion, b.options.node.PatchVersion, b.options.node.BuildNumber);
+    const aVersion = new utils_1.VersionNumber(a.options.node.MajorVersion, a.options.node.MinorVersion, a.options.node.PatchVersion, a.options.node.BuildNumber);
+    const bVersion = new utils_1.VersionNumber(b.options.node.MajorVersion, b.options.node.MinorVersion, b.options.node.PatchVersion, b.options.node.BuildNumber);
     return aVersion.compareTo(bVersion);
 };
 /**
@@ -384,7 +384,7 @@ class PackageAncestryNode extends kit_1.AsyncCreatable {
         _PackageAncestryNode_AncestorId.set(this, void 0);
         _PackageAncestryNode_SubscriberPackageVersionId.set(this, void 0);
         _PackageAncestryNode_depthCounter.set(this, void 0);
-        __classPrivateFieldSet(this, _PackageAncestryNode_version, new versionNumber_1.VersionNumber(this.options.MajorVersion, this.options.MinorVersion, this.options.PatchVersion, this.options.BuildNumber), "f");
+        __classPrivateFieldSet(this, _PackageAncestryNode_version, new utils_1.VersionNumber(this.options.MajorVersion, this.options.MinorVersion, this.options.PatchVersion, this.options.BuildNumber), "f");
         __classPrivateFieldSet(this, _PackageAncestryNode_AncestorId, this.options.AncestorId, "f");
         __classPrivateFieldSet(this, _PackageAncestryNode_SubscriberPackageVersionId, this.options.SubscriberPackageVersionId, "f");
         __classPrivateFieldSet(this, _PackageAncestryNode_MajorVersion, typeof this.options.MajorVersion === 'number'

package/lib/package/packageConvert.d.ts

@@ -1,5 +1,6 @@
 import { Connection, SfProject } from '@salesforce/core';
 import { PackagingSObjects, PackageVersionCreateRequestResult, ConvertPackageOptions } from '../interfaces';
+export declare function findOrCreatePackage2(seedPackage: string, connection: Connection): Promise<string>;
 export declare function convertPackage(pkg: string, connection: Connection, options: ConvertPackageOptions, project?: SfProject): Promise<PackageVersionCreateRequestResult>;
 /**
  * Convert the list of command line options to a JSON object that can be used to create an Package2VersionCreateRequest entity.

package/lib/package/packageConvert.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackageVersionCreateRequest = exports.convertPackage = void 0;
+exports.createPackageVersionCreateRequest = exports.convertPackage = exports.findOrCreatePackage2 = void 0;
 const path = require("path");
 const os = require("os");
 const fs = require("fs");
@@ -14,18 +14,58 @@ const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const uniqid_1 = require("../utils/uniqid");
 const pkgUtils = require("../utils/packageUtils");
+const interfaces_1 = require("../interfaces");
 const constants_1 = require("../constants");
 const srcDevUtil = require("../utils/srcDevUtils");
+const utils_1 = require("../utils");
 const packageVersionCreateRequest_1 = require("./packageVersionCreateRequest");
+const pvcr = require("./packageVersionCreateRequest");
+var Package2VersionStatus = interfaces_1.PackagingSObjects.Package2VersionStatus;
 core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'packageVersionCreate');
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_version_create');
+async function findOrCreatePackage2(seedPackage, connection) {
+    const query = `SELECT Id FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
+    const queryResult = (await connection.tooling.query(query)).records;
+    if (queryResult?.length > 1) {
+        const ids = queryResult.map((r) => r.Id);
+        throw messages.createError('errorMoreThanOnePackage2WithSeed', [ids.join(', ')]);
+    }
+    if (queryResult?.length === 1) {
+        // return the package2 object
+        return queryResult[0].Id;
+    }
+    // Need to create a new Package2
+    const subQuery = `SELECT Name, Description, NamespacePrefix FROM SubscriberPackage WHERE Id = '${seedPackage}'`;
+    let subscriberResult;
+    try {
+        subscriberResult = await connection.singleRecordQuery(subQuery, {
+            tooling: true,
+        });
+    }
+    catch (e) {
+        throw messages.createError('errorNoSubscriberPackageRecord', [seedPackage]);
+    }
+    const request = {
+        Name: subscriberResult.Name,
+        Description: subscriberResult.Description,
+        NamespacePrefix: subscriberResult.NamespacePrefix,
+        ContainerOptions: 'Managed',
+        ConvertedFromPackageId: seedPackage,
+    };
+    const createResult = await connection.tooling.create('Package2', request);
+    if (!createResult.success) {
+        throw pkgUtils.combineSaveErrors('Package2', 'create', createResult.errors);
+    }
+    return createResult.id;
+}
+exports.findOrCreatePackage2 = findOrCreatePackage2;
 async function convertPackage(pkg, connection, options, project) {
     let maxRetries = 0;
     const branch = 'main';
     if (options.wait) {
         maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.minutes;
     }
-    const packageId = await pkgUtils.findOrCreatePackage2(pkg, connection);
+    const packageId = await findOrCreatePackage2(pkg, connection);
     const request = await createPackageVersionCreateRequest({ installationkey: options.installationKey, buildinstance: options.buildInstance }, packageId);
     // TODO: a lot of this is duplicated from PC, PVC, and PVCR.
     const createResult = await connection.tooling.create('Package2VersionCreateRequest', request);
@@ -38,7 +78,7 @@ async function convertPackage(pkg, connection, options, project) {
     }
     let results;
     if (options.wait) {
-        results = await pkgUtils.pollForStatusWithInterval(createResult.id, maxRetries, packageId, branch, project, connection, new kit_1.Duration(pkgUtils.POLL_INTERVAL_SECONDS, kit_1.Duration.Unit.SECONDS));
+        results = await pollForStatusWithInterval(createResult.id, maxRetries, packageId, branch, project, connection, new kit_1.Duration(pkgUtils.POLL_INTERVAL_SECONDS, kit_1.Duration.Unit.SECONDS));
     }
     else {
         results = await (0, packageVersionCreateRequest_1.byId)(packageId, connection);
@@ -82,4 +122,82 @@ async function createRequestObject(packageId, options, packageVersTmpRoot, packa
     await fs.promises.rm(packageVersTmpRoot, { recursive: true });
     return requestObject;
 }
+async function pollForStatusWithInterval(id, retries, packageId, branch, withProject, connection, interval) {
+    let remainingRetries = retries;
+    const pollingClient = await core_1.PollingClient.create({
+        poll: async () => {
+            const results = await pvcr.byId(id, connection);
+            if (_isStatusEqualTo(results, [Package2VersionStatus.success, Package2VersionStatus.error])) {
+                // complete
+                if (_isStatusEqualTo(results, [Package2VersionStatus.success])) {
+                    // update sfdx-project.json
+                    let projectUpdated = false;
+                    if (withProject && !process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
+                        projectUpdated = true;
+                        const query = `SELECT MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE Id = '${results[0].Package2VersionId}'`;
+                        const packageVersionVersionString = await connection.tooling
+                            .query(query)
+                            .then((pkgQueryResult) => {
+                            const record = pkgQueryResult.records[0];
+                            return `${record.MajorVersion}.${record.MinorVersion}.${record.PatchVersion}-${record.BuildNumber}`;
+                        });
+                        // TODO SfProjectJson.addPackageAlias
+                        const newConfig = await (0, utils_1.generatePackageAliasEntry)(connection, withProject, results[0].SubscriberPackageVersionId, packageVersionVersionString, branch, packageId);
+                        withProject.getSfProjectJson().set('packageAliases', newConfig);
+                        await withProject.getSfProjectJson().write();
+                    }
+                    await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.convert.success, {
+                        id,
+                        packageVersionCreateRequestResult: results[0],
+                        projectUpdated,
+                    });
+                    return { completed: true, payload: results[0] };
+                }
+                else {
+                    let status = 'Unknown Error';
+                    if (results?.length > 0 && results[0].Error.length > 0) {
+                        const errors = [];
+                        // for multiple errors, display one per line prefixed with (x)
+                        if (results[0].Error.length > 1) {
+                            results[0].Error.forEach((error) => {
+                                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                                errors.push(`(${errors.length + 1}) ${error}`);
+                            });
+                            errors.unshift(messages.getMessage('versionCreateFailedWithMultipleErrors'));
+                        }
+                        status = errors.length !== 0 ? errors.join('\n') : results[0].Error.join('\n');
+                    }
+                    await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.convert.error, { id, status });
+                    throw new core_1.SfError(status);
+                }
+            }
+            else {
+                const remainingTime = kit_1.Duration.seconds(interval.seconds * remainingRetries);
+                await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.convert.progress, {
+                    id,
+                    packageVersionCreateRequestResult: results[0],
+                    message: '',
+                    timeRemaining: remainingTime,
+                });
+                const logger = core_1.Logger.childFromRoot('packageConvert');
+                logger.info(`Request in progress. Sleeping ${interval.seconds} seconds. Will wait a total of ${remainingTime.seconds} more seconds before timing out. Current Status='${(0, kit_1.camelCaseToTitleCase)(results[0]?.Status)}'`);
+                remainingRetries--;
+                return { completed: false, payload: results[0] };
+            }
+        },
+        frequency: kit_1.Duration.seconds(interval.seconds),
+        timeout: kit_1.Duration.seconds(interval.seconds * retries),
+    });
+    return pollingClient.subscribe();
+}
+/**
+ * Return true if the queryResult.records[0].Status is equal to one of the values in statuses.
+ *
+ * @param results to examine
+ * @param statuses array of statuses to look for
+ * @returns {boolean} if one of the values in status is found.
+ */
+function _isStatusEqualTo(results, statuses) {
+    return results?.length <= 0 ? false : statuses?.some((status) => results[0].Status === status);
+}
 //# sourceMappingURL=packageConvert.js.map

package/lib/package/packageCreate.d.ts

@@ -1,7 +1,7 @@
 import { Connection, NamedPackageDir, PackageDir, SfProject } from '@salesforce/core';
 import { PackageCreateOptions, PackagingSObjects } from '../interfaces';
 declare type Package2Request = Pick<PackagingSObjects.Package2, 'Name' | 'Description' | 'NamespacePrefix' | 'ContainerOptions' | 'IsOrgDependent' | 'PackageErrorUsername'>;
-export declare function _createPackageRequestFromContext(project: SfProject, options: PackageCreateOptions): Package2Request;
+export declare function createPackageRequestFromContext(project: SfProject, options: PackageCreateOptions): Package2Request;
 /**
  * Generate packageDirectory json entry for this package that can be written to sfdx-project.json
  *
@@ -9,7 +9,7 @@ export declare function _createPackageRequestFromContext(project: SfProject, opt
  * @param packageId the 0Ho id of the package to create the entry for
  * @private
  */
-export declare function _generatePackageDirEntry(project: SfProject, options: PackageCreateOptions): PackageDir[] | NamedPackageDir[];
+export declare function generatePackageDirEntry(project: SfProject, options: PackageCreateOptions): PackageDir[] | NamedPackageDir[];
 /**
  * Generate package alias json entry for this package that can be written to sfdx-project.json
  *
@@ -17,7 +17,7 @@ export declare function _generatePackageDirEntry(project: SfProject, options: Pa
  * @param packageId the 0Ho id of the package to create the alias entry for
  * @private
  */
-export declare function _generatePackageAliasEntry(project: SfProject, options: PackageCreateOptions, packageId: string): {
+export declare function generatePackageAliasEntry(project: SfProject, options: PackageCreateOptions, packageId: string): {
     [key: string]: string;
 };
 export declare function createPackage(connection: Connection, project: SfProject, options: PackageCreateOptions): Promise<{

package/lib/package/packageCreate.js

@@ -6,13 +6,13 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackage = exports._generatePackageAliasEntry = exports._generatePackageDirEntry = exports._createPackageRequestFromContext = void 0;
+exports.createPackage = exports.generatePackageAliasEntry = exports.generatePackageDirEntry = exports.createPackageRequestFromContext = void 0;
 const core_1 = require("@salesforce/core");
 const ts_types_1 = require("@salesforce/ts-types");
 const pkgUtils = require("../utils/packageUtils");
 core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
-function _createPackageRequestFromContext(project, options) {
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_create');
+function createPackageRequestFromContext(project, options) {
     const namespace = options.noNamespace ? '' : project.getSfProjectJson().getContents().namespace || '';
     return {
         Name: options.name,
@@ -23,7 +23,7 @@ function _createPackageRequestFromContext(project, options) {
         PackageErrorUsername: options.errorNotificationUsername,
     };
 }
-exports._createPackageRequestFromContext = _createPackageRequestFromContext;
+exports.createPackageRequestFromContext = createPackageRequestFromContext;
 /**
  * Generate packageDirectory json entry for this package that can be written to sfdx-project.json
  *
@@ -31,7 +31,8 @@ exports._createPackageRequestFromContext = _createPackageRequestFromContext;
  * @param packageId the 0Ho id of the package to create the entry for
  * @private
  */
-function _generatePackageDirEntry(project, options) {
+function generatePackageDirEntry(project, options) {
+    // TODO: use SfProjectJson#addPackageDirectory for this maintenance
     let packageDirs = project.getPackageDirectories();
     if (!packageDirs) {
         packageDirs = [];
@@ -64,7 +65,7 @@ function _generatePackageDirEntry(project, options) {
     }
     return packageDirs;
 }
-exports._generatePackageDirEntry = _generatePackageDirEntry;
+exports.generatePackageDirEntry = generatePackageDirEntry;
 /**
  * Generate package alias json entry for this package that can be written to sfdx-project.json
  *
@@ -72,17 +73,17 @@ exports._generatePackageDirEntry = _generatePackageDirEntry;
  * @param packageId the 0Ho id of the package to create the alias entry for
  * @private
  */
-function _generatePackageAliasEntry(project, options, packageId) {
+function generatePackageAliasEntry(project, options, packageId) {
     const packageAliases = project.getSfProjectJson().getContents().packageAliases || {};
     const packageName = options.name;
     packageAliases[packageName] = packageId;
     return packageAliases;
 }
-exports._generatePackageAliasEntry = _generatePackageAliasEntry;
+exports.generatePackageAliasEntry = generatePackageAliasEntry;
 async function createPackage(connection, project, options) {
     // strip trailing slash from path param
     options.path = options.path.replace(/\/$/, '');
-    const request = _createPackageRequestFromContext(project, options);
+    const request = createPackageRequestFromContext(project, options);
     let packageId = null;
     const createResult = await connection.tooling
         .sobject('Package2')
@@ -101,8 +102,8 @@ async function createPackage(connection, project, options) {
     }
     const record = queryResult.records[0];
     if (!process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE) {
-        const packageDirectory = _generatePackageDirEntry(project, options);
-        const packageAliases = _generatePackageAliasEntry(project, options, record.Id);
+        const packageDirectory = generatePackageDirEntry(project, options);
+        const packageAliases = generatePackageAliasEntry(project, options, record.Id);
         const projectJson = project.getSfProjectJson();
         projectJson.set('packageDirectories', packageDirectory);
         projectJson.set('packageAliases', packageAliases);

package/lib/package/packageInstall.d.ts

@@ -1,8 +1,7 @@
 import { Connection } from '@salesforce/core';
 import { Optional } from '@salesforce/ts-types';
 import { Duration } from '@salesforce/kit';
-import { PackagingSObjects } from '../interfaces';
-import { PackageInstallOptions, PackageInstallCreateRequest } from '../interfaces/packagingInterfacesAndType';
+import { PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest } from '../interfaces';
 import PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
 export declare function installPackage(connection: Connection, pkgInstallCreateRequest: PackageInstallCreateRequest, options?: PackageInstallOptions): Promise<PackageInstallRequest>;
 /**
@@ -15,4 +14,6 @@ export declare function installPackage(connection: Connection, pkgInstallCreateR
  */
 export declare function getExternalSites(connection: Connection, subscriberPackageVersionId: string, installationKey?: string): Promise<Optional<string[]>>;
 export declare function getStatus(connection: Connection, installRequestId: string): Promise<PackageInstallRequest>;
+export declare function isErrorFromSPVQueryRestriction(err: Error): boolean;
+export declare function isErrorPackageNotAvailable(err: Error): boolean;
 export declare function waitForPublish(connection: Connection, subscriberPackageVersionId: string, timeout: number | Duration, installationKey?: string): Promise<void>;

package/lib/package/packageInstall.js

@@ -6,14 +6,15 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForPublish = exports.getStatus = exports.getExternalSites = exports.installPackage = void 0;
+exports.waitForPublish = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.getStatus = exports.getExternalSites = exports.installPackage = void 0;
 const core_1 = require("@salesforce/core");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
-const packageUtils_1 = require("../utils/packageUtils");
+const utils_1 = require("../utils");
 const constants_1 = require("../constants");
+const interfaces_1 = require("../interfaces");
 core_1.Messages.importMessagesDirectory(__dirname);
-const installMsgs = core_1.Messages.loadMessages('@salesforce/packaging', 'package-install');
+const installMsgs = core_1.Messages.loadMessages('@salesforce/packaging', 'package_install');
 let logger;
 const getLogger = () => {
     if (!logger) {
@@ -21,6 +22,26 @@ const getLogger = () => {
     }
     return logger;
 };
+/**
+ * Given 04t the package type type (Managed, Unlocked, Locked(deprecated?))
+ *
+ * @param packageVersionId the 04t
+ * @param connection For tooling query
+ * @param installKey For tooling query, if an installation key is applicable to the package version it must be passed in the queries
+ * @throws Error with message when package2 cannot be found
+ */
+async function getPackageTypeBy04t(packageVersionId, connection, installKey) {
+    let query = `SELECT Package2ContainerOptions FROM SubscriberPackageVersion WHERE id ='${packageVersionId}'`;
+    if (installKey) {
+        const escapedInstallationKey = installKey.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
+        query += ` AND InstallationKey ='${escapedInstallationKey}'`;
+    }
+    const queryResult = await connection.tooling.query(query);
+    if (!queryResult || queryResult.records === null || queryResult.records.length === 0) {
+        throw installMsgs.createError('errorInvalidPackageId', [packageVersionId]);
+    }
+    return queryResult.records[0].Package2ContainerOptions;
+}
 async function installPackage(connection, pkgInstallCreateRequest, options) {
     const defaults = {
         ApexCompileType: 'all',
@@ -32,25 +53,25 @@ async function installPackage(connection, pkgInstallCreateRequest, options) {
     };
     const request = Object.assign({}, defaults, pkgInstallCreateRequest);
     if (request.Password) {
-        request.Password = (0, packageUtils_1.escapeInstallationKey)(request.Password);
+        request.Password = (0, utils_1.escapeInstallationKey)(request.Password);
     }
-    const pkgType = await (0, packageUtils_1.getPackageTypeBy04t)(request.SubscriberPackageVersionKey, connection, request.Password);
+    const pkgType = await getPackageTypeBy04t(request.SubscriberPackageVersionKey, connection, request.Password);
     // Only unlocked packages can change the UpgradeType and ApexCompile options from the defaults.
     if (pkgType !== 'Unlocked') {
         if (request.UpgradeType !== defaults.UpgradeType) {
             const msg = installMsgs.getMessage('upgradeTypeOnlyForUnlockedWarning');
-            await core_1.Lifecycle.getInstance().emit('PackageInstallRequest:warning', msg);
+            await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install.warning, msg);
             delete request.UpgradeType;
         }
         if (request.ApexCompileType !== defaults.ApexCompileType) {
             const msg = installMsgs.getMessage('apexCompileOnlyForUnlockedWarning');
-            await core_1.Lifecycle.getInstance().emit('PackageInstallRequest:warning', msg);
+            await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install.warning, msg);
             delete request.ApexCompileType;
         }
     }
-    await core_1.Lifecycle.getInstance().emit('PackageInstallRequest:presend', request);
+    await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install.presend, request);
     const result = await connection.tooling.create('PackageInstallRequest', request);
-    await core_1.Lifecycle.getInstance().emit('PackageInstallRequest:postsend', result);
+    await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install.postsend, result);
     const packageInstallRequestId = result.id;
     if (!packageInstallRequestId) {
         throw installMsgs.createError('packageInstallRequestError', [
@@ -78,7 +99,7 @@ async function getExternalSites(connection, subscriberPackageVersionId, installa
     const queryNoKey = `SELECT RemoteSiteSettings, CspTrustedSites FROM SubscriberPackageVersion WHERE Id ='${subscriberPackageVersionId}'`;
     let queryResult;
     try {
-        const escapedInstallationKey = installationKey ? (0, packageUtils_1.escapeInstallationKey)(installationKey) : null;
+        const escapedInstallationKey = installationKey ? (0, utils_1.escapeInstallationKey)(installationKey) : null;
         const queryWithKey = `${queryNoKey} AND InstallationKey ='${escapedInstallationKey}'`;
         getLogger().debug(`Checking package: [${subscriberPackageVersionId}] for external sites`);
         queryResult = await connection.tooling.query(queryWithKey);
@@ -86,7 +107,7 @@ async function getExternalSites(connection, subscriberPackageVersionId, installa
     catch (e) {
         // First check for Implementation Restriction error that is enforced in 214, before it was possible to query
         // against InstallationKey, otherwise surface the error.
-        if (e instanceof Error && (0, packageUtils_1.isErrorFromSPVQueryRestriction)(e)) {
+        if (e instanceof Error && isErrorFromSPVQueryRestriction(e)) {
             queryResult = await connection.tooling.query(queryNoKey);
         }
         else {
@@ -132,7 +153,7 @@ async function pollStatus(connection, installRequestId, options) {
         poll: async () => {
             packageInstallRequest = await getStatus(connection, installRequestId);
             getLogger().debug(installMsgs.getMessage('packageInstallPolling', [packageInstallRequest?.Status]));
-            await core_1.Lifecycle.getInstance().emit('PackageInstallRequest:status', packageInstallRequest);
+            await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install.status, packageInstallRequest);
             if (['SUCCESS', 'ERROR'].includes(packageInstallRequest?.Status)) {
                 return { completed: true, payload: packageInstallRequest };
             }
@@ -158,6 +179,18 @@ async function pollStatus(connection, installRequestId, options) {
         throw error;
     }
 }
+// determines if error is from malformed SubscriberPackageVersion query
+// this is in place to allow cli to run against app version 214, where SPV queries
+// do not require installation key
+function isErrorFromSPVQueryRestriction(err) {
+    return (err.name === 'MALFORMED_QUERY' &&
+        err.message.includes('Implementation restriction: You can only perform queries of the form Id'));
+}
+exports.isErrorFromSPVQueryRestriction = isErrorFromSPVQueryRestriction;
+function isErrorPackageNotAvailable(err) {
+    return err.name === 'UNKNOWN_EXCEPTION' || err.name === 'PACKAGE_UNAVAILABLE';
+}
+exports.isErrorPackageNotAvailable = isErrorPackageNotAvailable;
 async function waitForPublish(connection, subscriberPackageVersionId, timeout, installationKey) {
     let queryResult;
     const pollingOptions = {
@@ -166,18 +199,18 @@ async function waitForPublish(connection, subscriberPackageVersionId, timeout, i
         poll: async () => {
             const QUERY_NO_KEY = `SELECT Id, SubscriberPackageId, InstallValidationStatus FROM SubscriberPackageVersion WHERE Id ='${subscriberPackageVersionId}'`;
             try {
-                const escapedInstallationKey = installationKey ? (0, packageUtils_1.escapeInstallationKey)(installationKey) : null;
+                const escapedInstallationKey = installationKey ? (0, utils_1.escapeInstallationKey)(installationKey) : null;
                 const queryWithKey = `${QUERY_NO_KEY} AND InstallationKey ='${escapedInstallationKey}'`;
                 queryResult = await connection.tooling.query(queryWithKey);
             }
             catch (e) {
                 // Check first for Implementation Restriction error that is enforced in 214, before it was possible to query
                 // against InstallationKey, otherwise surface the error.
-                if (e instanceof Error && (0, packageUtils_1.isErrorFromSPVQueryRestriction)(e)) {
+                if (e instanceof Error && isErrorFromSPVQueryRestriction(e)) {
                     queryResult = await connection.tooling.query(QUERY_NO_KEY);
                 }
                 else {
-                    if (e instanceof Error && !(0, packageUtils_1.isErrorPackageNotAvailable)(e)) {
+                    if (e instanceof Error && !isErrorPackageNotAvailable(e)) {
                         throw e;
                     }
                 }
@@ -188,14 +221,14 @@ async function waitForPublish(connection, subscriberPackageVersionId, timeout, i
             let installValidationStatus;
             if (queryResult?.records?.length) {
                 installValidationStatus = queryResult.records[0].InstallValidationStatus;
-                await core_1.Lifecycle.getInstance().emit('SubscriberPackageVersion:status', installValidationStatus);
+                await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install['subscriber-status'], installValidationStatus);
                 if (!['PACKAGE_UNAVAILABLE', 'UNINSTALL_IN_PROGRESS'].includes(installValidationStatus)) {
                     return { completed: true, payload: queryResult };
                 }
             }
             const tokens = installValidationStatus ? [` Status = ${installValidationStatus}`] : [];
             getLogger().debug(installMsgs.getMessage('publishWaitProgress', tokens));
-            await core_1.Lifecycle.getInstance().emit('SubscriberPackageVersion:status', installValidationStatus);
+            await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageEvents.install['subscriber-status'], installValidationStatus);
             return { completed: false, payload: queryResult };
         },
     };

package/lib/package/packageProfileApi.js

@@ -14,7 +14,7 @@ const xmldom_1 = require("@xmldom/xmldom");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 core_1.Messages.importMessagesDirectory(__dirname);
-const profileApiMessages = core_1.Messages.loadMessages('@salesforce/packaging', 'profile-api');
+const profileApiMessages = core_1.Messages.loadMessages('@salesforce/packaging', 'profile_api');
 /*
  * This class provides functions used to re-write .profiles in the workspace when creating a package2 version.
  * All profiles found in the workspaces are extracted out and then re-written to only include metadata in the profile