@salesforce/packaging 0.0.8 → 0.0.9

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.9](https://github.com/forcedotcom/packaging/compare/v0.0.8...v0.0.9) (2022-07-19)
+
+### Features
+
+- add package1Display method for use with package1:version:display command ([ef3df30](https://github.com/forcedotcom/packaging/commit/ef3df309147bafb16367c957981a04470c6ad7df))
+
 ### [0.0.8](https://github.com/forcedotcom/packaging/compare/v0.0.7...v0.0.8) (2022-07-18)
 
 ### Features

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -92,6 +92,14 @@ export declare type PackageVersionListResult = {
     BuildDurationInSeconds?: number;
     HasMetadataRemoved?: boolean;
 };
+export declare type Package1Display = {
+    MetadataPackageVersionId: string;
+    MetadataPackageId: string;
+    Name: string;
+    Version: string;
+    ReleaseState: string;
+    BuildNumber: number;
+};
 export declare type PackageType = 'Managed' | 'Unlocked';
 export declare type PackageCreateOptions = {
     name: string;

package/lib/interfaces/packagingSObjects.d.ts

@@ -223,4 +223,15 @@ export declare namespace PackagingSObjects {
         SubscriberPackageVersionId: string;
         MinPackageVersionId: string;
     };
+    type MetadataPackageVersion = {
+        Id: string;
+        MetadataPackageId: string;
+        Name: string;
+        ReleaseState: 'Beta' | 'Released';
+        MajorVersion: number;
+        MinorVersion: number;
+        PatchVersion: number;
+        BuildNumber: number;
+        IsDeprecated: boolean;
+    };
 }

package/lib/package/packageCreate.js

@@ -32,7 +32,6 @@ exports._createPackageRequestFromContext = _createPackageRequestFromContext;
  * @private
  */
 function _generatePackageDirEntry(project, options) {
-    var _a, _b;
     let packageDirs = project.getPackageDirectories();
     if (!packageDirs) {
         packageDirs = [];
@@ -47,8 +46,8 @@ function _generatePackageDirEntry(project, options) {
     if (packageDir) {
         // update existing entry
         packageDir.package = options.name;
-        (_a = packageDir.versionName) !== null && _a !== void 0 ? _a : (packageDir.versionName = pkgUtils.DEFAULT_PACKAGE_DIR.versionName);
-        (_b = packageDir.versionNumber) !== null && _b !== void 0 ? _b : (packageDir.versionNumber = pkgUtils.DEFAULT_PACKAGE_DIR.versionNumber);
+        packageDir.versionName ?? (packageDir.versionName = pkgUtils.DEFAULT_PACKAGE_DIR.versionName);
+        packageDir.versionNumber ?? (packageDir.versionNumber = pkgUtils.DEFAULT_PACKAGE_DIR.versionNumber);
         // set as default if this is the only entry or no other entry is the default
         if (!Reflect.getOwnPropertyDescriptor(packageDir, 'default')) {
             packageDir.default = !pkgUtils.getConfigPackageDirectory(packageDirs, 'default', true);
@@ -97,7 +96,7 @@ async function createPackage(connection, project, options) {
     }
     packageId = createResult.id;
     const queryResult = await connection.tooling.query(`SELECT Id FROM Package2 WHERE Id='${packageId}'`);
-    if (!(queryResult === null || queryResult === void 0 ? void 0 : queryResult.records[0])) {
+    if (!queryResult?.records[0]) {
         throw messages.createError('unableToFindPackageWithId', [packageId]);
     }
     const record = queryResult.records[0];

package/lib/package/packageVersionCreate.js

@@ -48,8 +48,7 @@ class PackageVersionCreate {
     }
     // convert source to mdapi format and copy to tmp dir packaging up
     async generateMDFolderForArtifact(options) {
-        var _a;
-        const sourcepath = (_a = options.sourcePaths) !== null && _a !== void 0 ? _a : [options.sourceDir];
+        const sourcepath = options.sourcePaths ?? [options.sourceDir];
         const componentSet = await source_deploy_retrieve_1.ComponentSetBuilder.build({
             sourceapiversion: this.project.getSfProjectJson().get('sourceApiVersion'),
             sourcepath,
@@ -558,10 +557,9 @@ class PackageVersionCreate {
         return value;
     }
     async packageVersionCreate(options) {
-        var _a, _b;
         let pollInterval = kit_1.Duration.seconds(pkgUtils.POLL_INTERVAL_SECONDS);
         let maxRetries = 0;
-        if (((_a = options.wait) === null || _a === void 0 ? void 0 : _a.milliseconds) > 0) {
+        if (options.wait?.milliseconds > 0) {
             if (options.skipvalidation === true) {
                 pollInterval = kit_1.Duration.seconds(POLL_INTERVAL_WITHOUT_VALIDATION_SECONDS);
             }
@@ -573,7 +571,7 @@ class PackageVersionCreate {
             await this.project.getSfProjectJson().schemaValidate();
         }
         // Check for empty packageDirectories
-        if (((_b = this.project.getPackageDirectories()) === null || _b === void 0 ? void 0 : _b.length) === 0) {
+        if (this.project.getPackageDirectories()?.length === 0) {
             throw messages.createError('errorEmptyPackageDirs');
         }
         const canonicalPackageProperty = this.resolveCanonicalPackageProperty(options);
@@ -602,7 +600,7 @@ class PackageVersionCreate {
         }
         let result;
         if (options.wait && options.wait.milliseconds > 0) {
-            pollInterval = pollInterval !== null && pollInterval !== void 0 ? pollInterval : kit_1.Duration.seconds(options.wait.seconds / maxRetries);
+            pollInterval = pollInterval ?? kit_1.Duration.seconds(options.wait.seconds / maxRetries);
             if (pollInterval) {
                 result = await pkgUtils.pollForStatusWithInterval(createResult.id, maxRetries, resolvedPackageId, options.branch, this.project, this.connection, pollInterval);
             }

package/lib/package/packageVersionList.js

@@ -51,7 +51,7 @@ exports._assembleQueryParts = _assembleQueryParts;
 function _constructWhere(idsOrAliases, createdLastDays, lastModLastDays, project) {
     const where = [];
     // filter on given package ids
-    if ((idsOrAliases === null || idsOrAliases === void 0 ? void 0 : idsOrAliases.length) > 0) {
+    if (idsOrAliases?.length > 0) {
         // remove dups
         const aliasesOrIds = [...new Set(idsOrAliases)];
         // resolve any aliases

package/lib/package1/index.d.ts

@@ -1,2 +1,3 @@
 export * from './packageVersion1GP';
+export * from './packageDisplay';
 export * from './package1VersionCreateGet';

package/lib/package1/index.js

@@ -21,5 +21,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 __exportStar(require("./packageVersion1GP"), exports);
+__exportStar(require("./packageDisplay"), exports);
 __exportStar(require("./package1VersionCreateGet"), exports);
 //# sourceMappingURL=index.js.map

package/lib/package1/packageDisplay.d.ts

@@ -0,0 +1,9 @@
+import { Connection } from '@salesforce/core';
+import { Package1Display } from '../interfaces';
+/**
+ * Executes server-side logic for the package1:display command
+ *
+ * @param connection
+ * @param id: id of the MetadataPackageVersion sObject
+ */
+export declare function package1Display(connection: Connection, id: string): Promise<Package1Display[]>;

package/lib/package1/packageDisplay.js

@@ -0,0 +1,29 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.package1Display = void 0;
+/**
+ * Executes server-side logic for the package1:display command
+ *
+ * @param connection
+ * @param id: id of the MetadataPackageVersion sObject
+ */
+async function package1Display(connection, id) {
+    const query = `SELECT Id,MetadataPackageId,Name,ReleaseState,MajorVersion,MinorVersion,PatchVersion,BuildNumber FROM MetadataPackageVersion WHERE id = '${id}'`;
+    const results = (await connection.tooling.query(query)).records;
+    return results.map((result) => ({
+        MetadataPackageVersionId: result.Id,
+        MetadataPackageId: result.MetadataPackageId,
+        Name: result.Name,
+        ReleaseState: result.ReleaseState,
+        Version: `${result.MajorVersion}.${result.MinorVersion}.${result.PatchVersion}`,
+        BuildNumber: result.BuildNumber,
+    }));
+}
+exports.package1Display = package1Display;
+//# sourceMappingURL=packageDisplay.js.map

package/lib/utils/packageUtils.js

@@ -195,7 +195,7 @@ exports.applyErrorAction = applyErrorAction;
  */
 async function getPackageVersionId(versionId, connection) {
     // if it's already a 05i return it, otherwise query for it
-    if (versionId === null || versionId === void 0 ? void 0 : versionId.startsWith(exports.BY_LABEL.PACKAGE_VERSION_ID.prefix)) {
+    if (versionId?.startsWith(exports.BY_LABEL.PACKAGE_VERSION_ID.prefix)) {
         return versionId;
     }
     const query = `SELECT Id FROM Package2Version WHERE SubscriberPackageVersionId = '${versionId}'`;
@@ -410,9 +410,8 @@ exports.getInClauseItemsCount = getInClauseItemsCount;
 async function getAncestorId(packageDescriptorJson, connection, project, versionNumberString, skipAncestorCheck) {
     // eslint-disable-next-line complexity
     return Promise.resolve().then(async () => {
-        var _a;
         // If an id property is present, use it.  Otherwise, look up the package id from the package property.
-        const packageId = (_a = packageDescriptorJson['id']) !== null && _a !== void 0 ? _a : getPackageIdFromAlias(packageDescriptorJson.package, project);
+        const packageId = packageDescriptorJson['id'] ?? getPackageIdFromAlias(packageDescriptorJson.package, project);
         // No need to proceed if Unlocked
         const packageType = await getPackageType(packageId, connection);
         if (packageType === 'Unlocked') {
@@ -540,7 +539,7 @@ async function getAncestorIdHighestRelease(connection, packageId, versionNumberS
             'ORDER BY MajorVersion Desc, MinorVersion Desc, PatchVersion Desc, BuildNumber Desc LIMIT 1';
         const majorMinorVersionResult = await connection.tooling.query(query);
         const majorMinorVersionRecords = majorMinorVersionResult.records;
-        if (majorMinorVersionRecords && (majorMinorVersionRecords === null || majorMinorVersionRecords === void 0 ? void 0 : majorMinorVersionRecords.length) === 1 && majorMinorVersionRecords[0]) {
+        if (majorMinorVersionRecords && majorMinorVersionRecords?.length === 1 && majorMinorVersionRecords[0]) {
             result.finalAncestorId = majorMinorVersionRecords[0].Id;
         }
         else {
@@ -587,7 +586,7 @@ function getConfigPackageDirectories(project) {
 }
 exports.getConfigPackageDirectories = getConfigPackageDirectories;
 function getConfigPackageDirectory(packageDirs, lookupProperty, lookupValue) {
-    return packageDirs === null || packageDirs === void 0 ? void 0 : packageDirs.find((pkgDir) => pkgDir[lookupProperty] === lookupValue);
+    return packageDirs?.find((pkgDir) => pkgDir[lookupProperty] === lookupValue);
 }
 exports.getConfigPackageDirectory = getConfigPackageDirectory;
 /**
@@ -619,7 +618,7 @@ exports.convertCamelCaseStringToSentence = convertCamelCaseStringToSentence;
  * @returns an array of alias for the given id.
  */
 function getPackageAliasesFromId(packageId, project) {
-    const packageAliases = (project === null || project === void 0 ? void 0 : project.getSfProjectJson().getContents().packageAliases) || {};
+    const packageAliases = project?.getSfProjectJson().getContents().packageAliases || {};
     // check for a matching alias
     return Object.entries(packageAliases)
         .filter((alias) => alias[1] === packageId)
@@ -664,7 +663,6 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
     let remainingRetries = retries;
     const pollingClient = await core_1.PollingClient.create({
         poll: async () => {
-            var _a;
             const results = await pvcr.byId(id, connection);
             if (_isStatusEqualTo(results, [Package2VersionStatus.success, Package2VersionStatus.error])) {
                 // complete
@@ -693,7 +691,7 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                 }
                 else {
                     let status = 'Unknown Error';
-                    if ((results === null || results === void 0 ? void 0 : results.length) > 0 && results[0].Error.length > 0) {
+                    if (results?.length > 0 && results[0].Error.length > 0) {
                         const errors = [];
                         // for multiple errors, display one per line prefixed with (x)
                         if (results[0].Error.length > 1) {
@@ -716,7 +714,7 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                     message: '',
                     remainingTime,
                 });
-                logger.info(`Request in progress. Sleeping ${interval} seconds. Will wait a total of ${remainingTime.seconds} more seconds before timing out. Current Status='${convertCamelCaseStringToSentence((_a = results[0]) === null || _a === void 0 ? void 0 : _a.Status)}'`);
+                logger.info(`Request in progress. Sleeping ${interval} seconds. Will wait a total of ${remainingTime.seconds} more seconds before timing out. Current Status='${convertCamelCaseStringToSentence(results[0]?.Status)}'`);
                 remainingRetries--;
                 return { completed: false, payload: results[0] };
             }
@@ -747,7 +745,7 @@ async function _generatePackageAliasEntry(connection, project, packageVersionId,
         const query = `SELECT Name FROM Package2 WHERE Id = '${packageId}'`;
         packageName = await connection.tooling
             .query(query)
-            .then((pkgQueryResult) => { var _a; return (_a = pkgQueryResult.records[0]) === null || _a === void 0 ? void 0 : _a.Name; });
+            .then((pkgQueryResult) => pkgQueryResult.records[0]?.Name);
     }
     else {
         packageName = aliasForPackageId[0];
@@ -766,7 +764,7 @@ async function _generatePackageAliasEntry(connection, project, packageVersionId,
  * @returns {boolean} if one of the values in status is found.
  */
 function _isStatusEqualTo(results, statuses) {
-    return (results === null || results === void 0 ? void 0 : results.length) <= 0 ? false : statuses === null || statuses === void 0 ? void 0 : statuses.some((status) => results[0].Status === status);
+    return results?.length <= 0 ? false : statuses?.some((status) => results[0].Status === status);
 }
 // added for unit testing
 function getSoqlWhereClauseMaxLength() {
@@ -782,8 +780,7 @@ function formatDate(date) {
 exports.formatDate = formatDate;
 function combineSaveErrors(sObject, crudOperation, errors) {
     const errorMessages = errors.map((error) => {
-        var _a;
-        const fieldsString = ((_a = error.fields) === null || _a === void 0 ? void 0 : _a.length) > 0 ? `Fields: [${error.fields.join(', ')}]` : '';
+        const fieldsString = error.fields?.length > 0 ? `Fields: [${error.fields.join(', ')}]` : '';
         return `Error: ${error.errorCode} Message: ${error.message} ${fieldsString}`;
     });
     const sfError = messages.createError('errorDuringSObjectCRUDOperation', [

package/lib/utils/versionNumber.js

@@ -30,7 +30,7 @@ class VersionNumber {
             throw messages.createError('errorMissingVersionNumber');
         }
         const version = versionString.split('.');
-        if ((version === null || version === void 0 ? void 0 : version.length) === 4) {
+        if (version?.length === 4) {
             const [major, minor, patch, build] = version;
             const asNumbers = [major, minor, patch, build].map((v) => parseInt(v, 10));
             if (asNumbers.slice(0, 3).some((v) => isNaN(v))) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -43,13 +43,15 @@
     "debug": "^4.3.4",
     "globby": "^11",
     "js2xmlparser": "^4.0.2",
-    "jsforce": "2.0.0-beta.14",
+    "jsforce": "beta",
+    "mkdirp": "1.0.4",
+    "ts-retry-promise": "^0.6.1",
     "jszip": "^3.10.0",
     "xml2js": "^0.4.23",
     "xmldom-sfdx-encoding": "^0.1.30"
   },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^2.3.0",
+    "@salesforce/cli-plugins-testkit": "^2.3.4",
     "@salesforce/dev-config": "^3.0.1",
     "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/prettier-config": "^0.0.2",