@salesforce/packaging 0.0.28 → 0.0.29

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.29](https://github.com/forcedotcom/packaging/compare/v0.0.28...v0.0.29) (2022-08-26)
+
+### Bug Fixes
+
+- add PackageVersion.update, NUTs ([af8a816](https://github.com/forcedotcom/packaging/commit/af8a8167d5fbcf7056f7b72db49e4e9f6ed0363f))
+
 ### [0.0.28](https://github.com/forcedotcom/packaging/compare/v0.0.27...v0.0.28) (2022-08-26)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -156,6 +156,13 @@ export declare type PackageVersionListOptions = {
     concise: boolean;
     isReleased: boolean;
 };
+export declare type PackageVersionUpdateOptions = {
+    InstallKey?: string;
+    VersionName?: string;
+    VersionDescription?: string;
+    Branch?: string;
+    Tag?: string;
+};
 export declare type ListPackageVersionOptions = PackageVersionListOptions & {
     connection: Connection;
 };

package/lib/package/packageVersion.d.ts

@@ -1,5 +1,5 @@
 import { Duration } from '@salesforce/kit';
-import { PackageSaveResult, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageVersionListOptions, PackageVersionListResult, PackageVersionOptions, PackageVersionReportResult } from '../interfaces';
+import { PackageSaveResult, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageVersionListOptions, PackageVersionListResult, PackageVersionOptions, PackageVersionReportResult, PackageVersionUpdateOptions } from '../interfaces';
 export declare class PackageVersion {
     private options;
     private readonly project;
@@ -59,7 +59,7 @@ export declare class PackageVersion {
     list(options: PackageVersionListOptions): Promise<PackageVersionListResult[]>;
     uninstall(): Promise<void>;
     promote(id: string): Promise<PackageSaveResult>;
-    update(): Promise<void>;
+    update(id: string, options: PackageVersionUpdateOptions): Promise<PackageSaveResult>;
     private updateDeprecation;
     private updateProjectWithPackageVersion;
 }

package/lib/package/packageVersion.js

@@ -167,8 +167,28 @@ class PackageVersion {
         }
         return await this.options.connection.tooling.update('Package2Version', { IsReleased: true, Id: id });
     }
-    update() {
-        return Promise.resolve(undefined);
+    async update(id, options) {
+        // ID can be an 04t or 05i
+        (0, utils_1.validateId)([utils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, utils_1.BY_LABEL.PACKAGE_VERSION_ID], id);
+        // lookup the 05i ID, if needed
+        id = await (0, utils_1.getPackageVersionId)(id, this.connection);
+        const request = {
+            Id: id,
+            InstallKey: options.InstallKey,
+            Name: options.VersionName,
+            Description: options.VersionDescription,
+            Branch: options.Branch,
+            Tag: options.Tag,
+        };
+        // filter out any undefined values and their keys
+        Object.keys(request).forEach((key) => request[key] === undefined && delete request[key]);
+        const result = await this.connection.tooling.update('Package2Version', request);
+        if (!result.success) {
+            throw new Error(result.errors.join(', '));
+        }
+        // Use the 04t ID for the success message
+        result.id = await (0, utils_1.getSubscriberPackageVersionId)(id, this.connection);
+        return result;
     }
     async updateDeprecation(idOrAlias, IsDeprecated) {
         const packageVersionId = (0, utils_1.getPackageIdFromAlias)(idOrAlias, this.project);

package/package.json

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