@salesforce/packaging 0.0.15 → 0.0.16

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.16](https://github.com/forcedotcom/packaging/compare/v0.0.15...v0.0.16) (2022-08-08)
+
+### Bug Fixes
+
+- add method to uninstall package ([243f4e8](https://github.com/forcedotcom/packaging/commit/243f4e867d5b71a4a24afc70a8551f071dcbbc34))
+
 ### [0.0.15](https://github.com/forcedotcom/packaging/compare/v0.0.14...v0.0.15) (2022-08-08)
 
 ### Bug Fixes

package/lib/package/index.d.ts

@@ -6,3 +6,4 @@ export * from './packageVersionCreateRequest';
 export { listPackageVersions } from './packageVersionList';
 export { createPackage } from './packageCreate';
 export { deletePackage } from './packageDelete';
+export { uninstallPackage } from './packageUninstall';

package/lib/package/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deletePackage = exports.createPackage = exports.listPackageVersions = void 0;
+exports.uninstallPackage = exports.deletePackage = exports.createPackage = exports.listPackageVersions = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -32,4 +32,6 @@ var packageCreate_1 = require("./packageCreate");
 Object.defineProperty(exports, "createPackage", { enumerable: true, get: function () { return packageCreate_1.createPackage; } });
 var packageDelete_1 = require("./packageDelete");
 Object.defineProperty(exports, "deletePackage", { enumerable: true, get: function () { return packageDelete_1.deletePackage; } });
+var packageUninstall_1 = require("./packageUninstall");
+Object.defineProperty(exports, "uninstallPackage", { enumerable: true, get: function () { return packageUninstall_1.uninstallPackage; } });
 //# sourceMappingURL=index.js.map

package/lib/package/packageUninstall.d.ts

@@ -0,0 +1,6 @@
+import { Connection } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import { PackagingSObjects } from '../interfaces';
+declare type UninstallResult = PackagingSObjects.SubscriberPackageVersionUninstallRequest;
+export declare function uninstallPackage(id: string, conn: Connection, wait?: Duration): Promise<UninstallResult>;
+export {};

package/lib/package/packageUninstall.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uninstallPackage = void 0;
+/*
+ * Copyright (c) 2020, 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 os = require("os");
+const core_1 = require("@salesforce/core");
+const kit_1 = require("@salesforce/kit");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
+async function poll(id, conn) {
+    const uninstallRequest = await conn.tooling.sobject('SubscriberPackageVersionUninstallRequest').retrieve(id);
+    switch (uninstallRequest.Status) {
+        case 'Success': {
+            return { completed: true, payload: uninstallRequest };
+        }
+        case 'InProgress':
+        case 'Queued': {
+            core_1.Lifecycle.getInstance().emit('packageUninstall', {
+                ...uninstallRequest,
+            });
+            return { completed: false, payload: uninstallRequest };
+        }
+        default: {
+            const err = messages.getMessage('defaultErrorMessage', [id, uninstallRequest.Id]);
+            const errorQueryResult = await conn.tooling.query(`"SELECT Message FROM PackageVersionUninstallRequestError WHERE ParentRequest.Id = '${id}' ORDER BY Message"`);
+            const errors = [];
+            if (errorQueryResult.records.length) {
+                errors.push('\n=== Errors\n');
+                errorQueryResult.records.forEach((record) => {
+                    errors.push(`(${errors.length}) ${record.Message}${os.EOL}`);
+                });
+            }
+            throw new core_1.SfError(`${err}${errors.join(os.EOL)}`, 'UNINSTALL_ERROR', [
+                messages.getMessage('uninstallErrorAction'),
+            ]);
+        }
+    }
+}
+async function uninstallPackage(id, conn, wait = kit_1.Duration.seconds(0)) {
+    const uninstallRequest = await conn.tooling.sobject('SubscriberPackageVersionUninstallRequest').create({
+        SubscriberPackageVersionId: id,
+    });
+    if (wait.seconds === 0) {
+        return (await conn.tooling
+            .sobject('SubscriberPackageVersionUninstallRequest')
+            .retrieve(uninstallRequest.id));
+    }
+    else {
+        const pollingClient = await core_1.PollingClient.create({
+            poll: () => poll(uninstallRequest.id, conn),
+            frequency: kit_1.Duration.seconds(5),
+            timeout: wait,
+        });
+        return pollingClient.subscribe();
+    }
+}
+exports.uninstallPackage = uninstallPackage;
+//# sourceMappingURL=packageUninstall.js.map

package/messages/messages.md

@@ -247,3 +247,11 @@ Package version creation failed with unknown error
 
 Package upload failed.
 %s
+
+# defaultErrorMessage
+
+Can't uninstall the package %s during uninstall request %s.
+
+# uninstallErrorAction
+
+Verify installed package ID and resolve errors, then try again.

package/package.json

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