@salesforce/packaging 0.0.27 → 0.0.30

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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
+
+- 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
+
+- finish pvl, implement a few missing things ([9bb825c](https://github.com/forcedotcom/packaging/commit/9bb825c97b6cb8c8b9522ddcb5e5fb32e5653995))
+
 ### [0.0.27](https://github.com/forcedotcom/packaging/compare/v0.0.26...v0.0.27) (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 = {
@@ -147,17 +153,25 @@ export declare type PackageVersionCreateRequest = {
     CalculateCodeCoverage: boolean;
     SkipValidation: boolean;
 };
-export declare type PackageVersionQueryOptions = {
-    project: SfProject;
+export declare type PackageVersionListOptions = {
     orderBy: string;
     modifiedLastDays: number;
     createdLastDays: number;
     packages: string[];
-    connection: Connection;
     verbose: boolean;
     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;
+};
 export declare type PackageSaveResult = SaveResult;
 export declare type PackageVersionCreateRequestOptions = {
     path: string;

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/lib/package/packageVersion.d.ts

@@ -1,5 +1,5 @@
 import { Duration } from '@salesforce/kit';
-import { PackageSaveResult, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageVersionOptions, PackageVersionReportResult } from '../interfaces';
+import { PackageSaveResult, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageVersionListOptions, PackageVersionListResult, PackageVersionOptions, PackageVersionReportResult, PackageVersionUpdateOptions } from '../interfaces';
 export declare class PackageVersion {
     private options;
     private readonly project;
@@ -56,10 +56,10 @@ export declare class PackageVersion {
     }): Promise<PackageVersionCreateRequestResult>;
     convert(): Promise<void>;
     install(): Promise<void>;
-    list(): Promise<void>;
+    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

@@ -13,6 +13,7 @@ const utils_1 = require("../utils");
 const packageVersionCreate_1 = require("./packageVersionCreate");
 const packageVersionReport_1 = require("./packageVersionReport");
 const packageVersionCreateRequestReport_1 = require("./packageVersionCreateRequestReport");
+const packageVersionList_1 = require("./packageVersionList");
 core_1.Messages.importMessagesDirectory(__dirname);
 class PackageVersion {
     constructor(options) {
@@ -153,8 +154,8 @@ class PackageVersion {
     install() {
         return Promise.resolve(undefined);
     }
-    list() {
-        return Promise.resolve(undefined);
+    async list(options) {
+        return (await (0, packageVersionList_1.listPackageVersions)({ ...options, ...{ connection: this.connection } })).records;
     }
     uninstall() {
         return Promise.resolve(undefined);
@@ -166,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/lib/package/packageVersionList.d.ts

@@ -1,9 +1,7 @@
-import { SfProject } from '@salesforce/core';
 import { QueryResult } from 'jsforce';
-import { PackageVersionListResult, PackageVersionQueryOptions } from '../interfaces';
+import { PackageVersionListResult, ListPackageVersionOptions } from '../interfaces';
 export declare const DEFAULT_ORDER_BY_FIELDS = "Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber";
-export declare function listPackageVersions(options: PackageVersionQueryOptions): Promise<QueryResult<PackageVersionListResult>>;
-export declare function _constructQuery(options: PackageVersionQueryOptions): string;
-export declare function _assembleQueryParts(select: string, where: string[], orderBy?: string): string;
-export declare function _constructWhere(idsOrAliases: string[], createdLastDays: number, lastModLastDays: number, project: SfProject): string[];
-export declare function _getLastDays(paramName: string, lastDays: number): number;
+export declare function listPackageVersions(options: ListPackageVersionOptions): Promise<QueryResult<PackageVersionListResult>>;
+export declare function assembleQueryParts(select: string, where: string[], orderBy?: string): string;
+export declare function constructWhere(packageIds: string[], createdLastDays: number, lastModLastDays: number, isReleased: boolean): string[];
+export declare function validateDays(paramName: string, lastDays: number): number;

package/lib/package/packageVersionList.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._getLastDays = exports._constructWhere = exports._assembleQueryParts = exports._constructQuery = exports.listPackageVersions = exports.DEFAULT_ORDER_BY_FIELDS = void 0;
+exports.validateDays = exports.constructWhere = exports.assembleQueryParts = exports.listPackageVersions = exports.DEFAULT_ORDER_BY_FIELDS = void 0;
 const core_1 = require("@salesforce/core");
 const ts_types_1 = require("@salesforce/ts-types");
 const utils_1 = require("../utils");
@@ -25,67 +25,60 @@ const VERBOSE_SELECT = 'SELECT Id, Package2Id, SubscriberPackageVersionId, Name,
 exports.DEFAULT_ORDER_BY_FIELDS = 'Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber';
 const logger = core_1.Logger.childFromRoot('packageVersionList');
 async function listPackageVersions(options) {
-    return options.connection.tooling.query(_constructQuery(options));
+    return options.connection.tooling.query(constructQuery(options));
 }
 exports.listPackageVersions = listPackageVersions;
-function _constructQuery(options) {
+function constructQuery(options) {
     // construct custom WHERE clause, if applicable
-    const where = _constructWhere(options.packages, options.createdLastDays, options.modifiedLastDays, options.project);
-    if (options.isReleased) {
-        where.push('IsReleased = true');
-    }
-    return _assembleQueryParts(options.verbose === true ? VERBOSE_SELECT : DEFAULT_SELECT, where, options.orderBy);
+    const where = constructWhere(options.packages, options.createdLastDays, options.modifiedLastDays, options.isReleased);
+    return assembleQueryParts(options.verbose === true ? VERBOSE_SELECT : DEFAULT_SELECT, where, options.orderBy);
 }
-exports._constructQuery = _constructQuery;
-function _assembleQueryParts(select, where, orderBy = exports.DEFAULT_ORDER_BY_FIELDS) {
+function assembleQueryParts(select, where, orderBy) {
     // construct ORDER BY clause
-    // TODO: validate given fields
     const orderByPart = `ORDER BY ${orderBy ? orderBy : exports.DEFAULT_ORDER_BY_FIELDS}`;
     const wherePart = where.length > 0 ? `WHERE ${where.join(' AND ')}` : '';
     const query = `${select} ${wherePart} ${orderByPart}`;
     logger.debug(query);
     return query;
 }
-exports._assembleQueryParts = _assembleQueryParts;
+exports.assembleQueryParts = assembleQueryParts;
 // construct custom WHERE clause parts
-function _constructWhere(idsOrAliases, createdLastDays, lastModLastDays, project) {
+function constructWhere(packageIds, createdLastDays, lastModLastDays, isReleased) {
     const where = [];
     // filter on given package ids
-    if (idsOrAliases?.length > 0) {
+    if (packageIds?.length > 0) {
         // remove dups
-        const aliasesOrIds = [...new Set(idsOrAliases)];
-        // resolve any aliases
-        const packageIds = aliasesOrIds.map((idOrAlias) => (0, utils_1.getPackageIdFromAlias)(idOrAlias, project));
+        const uniquePackageIds = [...new Set(packageIds)];
         // validate ids
-        packageIds.forEach((packageId) => {
+        uniquePackageIds.forEach((packageId) => {
             (0, utils_1.validateId)(utils_1.BY_LABEL.PACKAGE_ID, packageId);
         });
         // stash where part
-        where.push(`Package2Id IN ('${packageIds.join("','")}')`);
+        where.push(`Package2Id IN ('${uniquePackageIds.join("','")}')`);
     }
     // filter on created date, days ago: 0 for today, etc
     if ((0, ts_types_1.isNumber)(createdLastDays)) {
-        createdLastDays = _getLastDays('createdlastdays', createdLastDays);
+        createdLastDays = validateDays('createdlastdays', createdLastDays);
         where.push(`CreatedDate = LAST_N_DAYS:${createdLastDays}`);
     }
     // filter on last mod date, days ago: 0 for today, etc
     if ((0, ts_types_1.isNumber)(lastModLastDays)) {
-        lastModLastDays = _getLastDays('modifiedlastdays', lastModLastDays);
+        lastModLastDays = validateDays('modifiedlastdays', lastModLastDays);
         where.push(`LastModifiedDate = LAST_N_DAYS:${lastModLastDays}`);
     }
+    if (isReleased) {
+        where.push('IsReleased = true');
+    }
     // exclude deleted
     where.push('IsDeprecated = false');
     return where;
 }
-exports._constructWhere = _constructWhere;
-function _getLastDays(paramName, lastDays) {
-    if (isNaN(lastDays)) {
-        return 0;
-    }
+exports.constructWhere = constructWhere;
+function validateDays(paramName, lastDays) {
     if (lastDays < 0) {
         throw messages.createError('invalidDaysNumber', [paramName, `${lastDays}`]);
     }
     return lastDays;
 }
-exports._getLastDays = _getLastDays;
+exports.validateDays = validateDays;
 //# sourceMappingURL=packageVersionList.js.map

package/lib/utils/packageUtils.js

@@ -324,7 +324,9 @@ async function getPackageVersionStrings(subscriberPackageVersionIds, connection)
     }
     // remove any duplicate Ids
     const ids = [...new Set(subscriberPackageVersionIds)];
-    const query = 'SELECT SubscriberPackageVersionId, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId IN (%IDS%)';
+    const query = `SELECT SubscriberPackageVersionId, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId IN (${ids
+        .map((id) => `'${id}'`)
+        .join(',')})`;
     const records = await queryWithInConditionChunking(query, ids, '%IDS%', connection);
     if (records && records.length > 0) {
         results = new Map(records.map((record) => {

package/package.json

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