@salesforce/packaging 0.0.31 → 0.0.32

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.32](https://github.com/forcedotcom/packaging/compare/v0.0.31...v0.0.32) (2022-09-07)
+
+### Bug Fixes
+
+- add Package.uninstallReport method, NUT ([9269c9b](https://github.com/forcedotcom/packaging/commit/9269c9b999dcac25ac52c4ee64bf261ffebfb0e0))
+
 ### [0.0.31](https://github.com/forcedotcom/packaging/compare/v0.0.30...v0.0.31) (2022-09-07)
 
 ### Bug Fixes

package/lib/interfaces/packagingSObjects.d.ts

@@ -175,7 +175,7 @@ export declare namespace PackagingSObjects {
         LastModifiedById: string;
         SystemModstamp: number;
         SubscriberPackageVersionId: string;
-        Status: string;
+        Status: 'Error' | 'InProgress' | 'Queued' | 'Success';
     };
     type PackageVersionUninstallRequestError = {
         Id: string;

package/lib/package/package.d.ts

@@ -32,6 +32,12 @@ export declare class Package extends AsyncCreatable<PackageOptions> implements I
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
     uninstall(): Promise<void>;
+    /**
+     * Reports on the uninstall progress of a package.
+     *
+     * @param id the 06y package uninstall request id
+     */
+    uninstallReport(id: string): Promise<PackagingSObjects.SubscriberPackageVersionUninstallRequest>;
     update(options: PackageUpdateOptions): Promise<PackageSaveResult>;
     getPackage(packageId: string): Promise<PackagingSObjects.Package2>;
     getExternalSites(subscriberPackageVersionId: string, installationKey?: string): Promise<Optional<string[]>>;

package/lib/package/package.js

@@ -72,6 +72,25 @@ class Package extends kit_1.AsyncCreatable {
     uninstall() {
         return Promise.resolve(undefined);
     }
+    /**
+     * Reports on the uninstall progress of a package.
+     *
+     * @param id the 06y package uninstall request id
+     */
+    async uninstallReport(id) {
+        const result = (await this.options.connection.tooling.retrieve('SubscriberPackageVersionUninstallRequest', id));
+        if (result.Status === 'Error') {
+            const errorDetails = await this.options.connection.tooling.query(`SELECT Message FROM PackageVersionUninstallRequestError WHERE ParentRequest.Id = '${id}' ORDER BY Message`);
+            const errors = [];
+            errorDetails.records.forEach((record) => {
+                errors.push(`(${errors.length + 1}) ${record.Message}`);
+            });
+            const errHeader = errors.length > 0 ? `\n=== Errors\n${errors.join('\n')}` : '';
+            const err = messages.getMessage('defaultErrorMessage', [id, result.Id]);
+            throw new core_1.SfError(`${err}${errHeader}`, 'UNINSTALL_ERROR', [messages.getMessage('action')]);
+        }
+        return result;
+    }
     async update(options) {
         // filter out any undefined values and their keys
         Object.keys(options).forEach((key) => options[key] === undefined && delete options[key]);

package/lib/package/packageInstall.js

@@ -105,8 +105,7 @@ async function getExternalSites(connection, subscriberPackageVersionId, installa
 }
 exports.getExternalSites = getExternalSites;
 async function getStatus(connection, installRequestId) {
-    const result = await connection.tooling.retrieve('PackageInstallRequest', installRequestId);
-    return result;
+    return (await connection.tooling.retrieve('PackageInstallRequest', installRequestId));
 }
 exports.getStatus = getStatus;
 // internal

package/messages/package.md

@@ -5,3 +5,11 @@ The %s: [%s] is invalid. It must start with "%s".
 # invalidIdLength
 
 The %s: [%s] is invalid. It must be either 15 or 18 characters.
+
+# defaultErrorMessage
+
+Can't uninstall the package %s during uninstall request %s.
+
+# action
+
+Verify installed package ID and resolve errors, then try again.

package/package.json

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