@salesforce/packaging 0.0.29 → 0.0.30

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.30](https://github.com/forcedotcom/packaging/compare/v0.0.29...v0.0.30) (2022-08-29)
+
+### Bug Fixes
+
+- add Package.update method, NUT ([dd77095](https://github.com/forcedotcom/packaging/commit/dd77095f77d2224c347d146810f8d0f883bbd9a3))
+
 ### [0.0.29](https://github.com/forcedotcom/packaging/compare/v0.0.28...v0.0.29) (2022-08-26)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -14,7 +14,7 @@ export interface IPackage {
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
     uninstall(): Promise<void>;
-    update(): Promise<void>;
+    update(options: PackageUpdateOptions): Promise<PackageSaveResult>;
     waitForPublish(subscriberPackageVersionKey: string, timeout: number | Duration, installationKey?: string): any;
     getExternalSites(subscriberPackageVersionKey: string, installationKey?: string): any;
 }
@@ -39,6 +39,12 @@ export interface IPackageVersion2GP {
 export declare type PackageOptions = {
     connection: Connection;
 };
+export declare type PackageUpdateOptions = {
+    Id: string;
+    Name?: string;
+    Description?: string;
+    PackageErrorUsername?: string;
+};
 export declare type PackageIdType = 'PackageId' | 'SubscriberPackageVersionId' | 'PackageInstallRequestId' | 'PackageUninstallRequestId';
 export declare type PackageVersionOptions1GP = Record<string, unknown>;
 export declare type PackageVersionCreateRequestResult = {

package/lib/package/package.d.ts

@@ -1,7 +1,7 @@
 import { AsyncCreatable, Duration } from '@salesforce/kit';
 import { QueryResult } from 'jsforce';
 import { Optional } from '@salesforce/ts-types';
-import { IPackage, PackageOptions, PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest, PackageIdType } from '../interfaces';
+import { IPackage, PackageOptions, PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest, PackageIdType, PackageSaveResult, PackageUpdateOptions } from '../interfaces';
 declare type PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
 /**
  * Package class.
@@ -32,7 +32,7 @@ export declare class Package extends AsyncCreatable<PackageOptions> implements I
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
     list(): Promise<QueryResult<PackagingSObjects.Package2>>;
     uninstall(): Promise<void>;
-    update(): Promise<void>;
+    update(options: PackageUpdateOptions): Promise<PackageSaveResult>;
     getPackage(packageId: string): Promise<PackagingSObjects.Package2>;
     getExternalSites(subscriberPackageVersionId: string, installationKey?: string): Promise<Optional<string[]>>;
     waitForPublish(subscriberPackageVersionId: string, timeout: number | Duration, installationKey?: string): Promise<void>;

package/lib/package/package.js

@@ -72,8 +72,14 @@ class Package extends kit_1.AsyncCreatable {
     uninstall() {
         return Promise.resolve(undefined);
     }
-    update() {
-        return Promise.resolve(undefined);
+    async update(options) {
+        // filter out any undefined values and their keys
+        Object.keys(options).forEach((key) => options[key] === undefined && delete options[key]);
+        const result = await this.options.connection.tooling.update('Package2', options);
+        if (!result.success) {
+            throw new core_1.SfError(result.errors.join(', '));
+        }
+        return result;
     }
     async getPackage(packageId) {
         const package2 = await this.options.connection.tooling.sobject('Package2').retrieve(packageId);

package/package.json

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