@salesforce/packaging 0.0.33 → 0.0.34

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.34](https://github.com/forcedotcom/packaging/compare/v0.0.33...v0.0.34) (2022-09-08)
+
+### Bug Fixes
+
+- default ut timeout to 20 seconds ([e8dc2c1](https://github.com/forcedotcom/packaging/commit/e8dc2c10650ad2fd3d33fba212bf4ff5908e775e))
+- only required refactoring - waiting on packaging to enable na40 to convert ([5e6365c](https://github.com/forcedotcom/packaging/commit/5e6365ccbc2086a40652ddf518c369bd0584f926))
+
 ### [0.0.33](https://github.com/forcedotcom/packaging/compare/v0.0.32...v0.0.33) (2022-09-08)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -10,7 +10,7 @@ import PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
 import MetadataPackageVersion = PackagingSObjects.MetadataPackageVersion;
 export interface IPackage {
     create(): Promise<void>;
-    convert(): Promise<void>;
+    convert(pkgId: string, options: ConvertPackageOptions, project?: SfProject): Promise<PackageVersionCreateRequestResult>;
     delete(): Promise<void>;
     install(pkgInstallCreateRequest: PackageInstallCreateRequest, options?: PackageInstallOptions): Promise<PackageInstallRequest>;
     getInstallStatus(installRequestId: string): Promise<PackageInstallRequest>;
@@ -208,6 +208,12 @@ export declare type PackageVersionOptions = {
     connection: Connection;
     project: SfProject;
 };
+export declare type ConvertPackageOptions = {
+    installationKey: string;
+    installationKeyBypass: boolean;
+    wait: Duration;
+    buildInstance: string;
+};
 export declare type PackageVersionCreateOptions = Partial<PackageVersionOptions & {
     branch: string;
     buildinstance: string;

package/lib/package/package.d.ts

@@ -1,7 +1,8 @@
+import { SfProject } from '@salesforce/core';
 import { AsyncCreatable, Duration } from '@salesforce/kit';
 import { QueryResult } from 'jsforce';
 import { Optional } from '@salesforce/ts-types';
-import { IPackage, PackageOptions, PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest, PackageIdType, PackageSaveResult, PackageUpdateOptions } from '../interfaces';
+import { IPackage, PackageOptions, PackagingSObjects, PackageInstallOptions, PackageInstallCreateRequest, PackageIdType, ConvertPackageOptions, PackageVersionCreateRequestResult, PackageSaveResult, PackageUpdateOptions } from '../interfaces';
 declare type PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
 /**
  * Package class.
@@ -25,7 +26,7 @@ export declare class Package extends AsyncCreatable<PackageOptions> implements I
      * @param type The type of package ID
      */
     static validateId(id: string, type: PackageIdType): void;
-    convert(): Promise<void>;
+    convert(pkgId: string, options: ConvertPackageOptions, project?: SfProject): Promise<PackageVersionCreateRequestResult>;
     create(): Promise<void>;
     delete(): Promise<void>;
     install(pkgInstallCreateRequest: PackageInstallCreateRequest, options?: PackageInstallOptions): Promise<PackageInstallRequest>;

package/lib/package/package.js

@@ -11,6 +11,7 @@ const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const packageList_1 = require("./packageList");
 const packageInstall_1 = require("./packageInstall");
+const packageConvert_1 = require("./packageConvert");
 const packagePrefixes = {
     PackageId: '0Ho',
     SubscriberPackageVersionId: '04t',
@@ -51,8 +52,8 @@ class Package extends kit_1.AsyncCreatable {
             throw messages.createError('invalidIdLength', [type, id]);
         }
     }
-    convert() {
-        return Promise.resolve(undefined);
+    async convert(pkgId, options, project) {
+        return await (0, packageConvert_1.convertPackage)(pkgId, this.options.connection, options, project);
     }
     create() {
         return Promise.resolve(undefined);

package/lib/package/packageConvert.d.ts

@@ -1,11 +1,15 @@
-import { Connection, Org, SfProject } from '@salesforce/core';
-import { Duration } from '@salesforce/kit';
-import { PackageVersionCreateRequestResult } from '../interfaces';
-declare type ConvertPackageOptions = {
-    installationKey: string;
-    installationKeyBypass: boolean;
-    wait: Duration;
-    buildInstance: string;
-};
-export declare function convertPackage(pkg: string, org: Org, connection: Connection, project: SfProject, options: ConvertPackageOptions): Promise<PackageVersionCreateRequestResult>;
-export {};
+import { Connection, SfProject } from '@salesforce/core';
+import { PackagingSObjects, PackageVersionCreateRequestResult, ConvertPackageOptions } from '../interfaces';
+export declare function convertPackage(pkg: string, connection: Connection, options: ConvertPackageOptions, project?: SfProject): Promise<PackageVersionCreateRequestResult>;
+/**
+ * Convert the list of command line options to a JSON object that can be used to create an Package2VersionCreateRequest entity.
+ *
+ * @param context: command context
+ * @param packageId: package2 id to create a package version for
+ * @returns {{Package2Id: string, Package2VersionMetadata: *, Tag: *, Branch: number}}
+ * @private
+ */
+export declare function createPackageVersionCreateRequest(context: {
+    installationkey?: string;
+    buildinstance?: string;
+}, packageId: string): Promise<PackagingSObjects.Package2VersionCreateRequest>;

package/lib/package/packageConvert.js

@@ -6,9 +6,8 @@
  * 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.convertPackage = void 0;
+exports.createPackageVersionCreateRequest = exports.convertPackage = void 0;
 const path = require("path");
-const util = require("util");
 const os = require("os");
 const fs = require("fs");
 const core_1 = require("@salesforce/core");
@@ -19,15 +18,16 @@ const constants_1 = require("../constants");
 const srcDevUtil = require("../utils/srcDevUtils");
 const packageVersionCreateRequest_1 = require("./packageVersionCreateRequest");
 core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
-async function convertPackage(pkg, org, connection, project, options) {
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'packageVersionCreate');
+async function convertPackage(pkg, connection, options, project) {
     let maxRetries = 0;
     const branch = 'main';
     if (options.wait) {
-        maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.seconds;
+        maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.minutes;
     }
-    const packageId = await pkgUtils.findOrCreatePackage(pkg, connection);
-    const request = await createPackageVersionCreateRequest(context, packageId);
+    const packageId = await pkgUtils.findOrCreatePackage2(pkg, connection);
+    const request = await createPackageVersionCreateRequest({ installationkey: options.installationKey, buildinstance: options.buildInstance }, packageId);
+    // TODO: a lot of this is duplicated from PC, PVC, and PVCR.
     const createResult = await connection.tooling.create('Package2VersionCreateRequest', request);
     if (!createResult.success) {
         const errStr = createResult.errors && createResult.errors.length ? createResult.errors.join(', ') : createResult.errors;
@@ -43,7 +43,7 @@ async function convertPackage(pkg, org, connection, project, options) {
     else {
         results = await (0, packageVersionCreateRequest_1.byId)(packageId, connection);
     }
-    return util.isArray(results) ? results[0] : results;
+    return Array.isArray(results) ? results[0] : results;
 }
 exports.convertPackage = convertPackage;
 /**
@@ -69,6 +69,7 @@ async function createPackageVersionCreateRequest(context, packageId) {
     await srcDevUtil.zipDir(packageVersBlobDirectory, packageVersBlobZipFile);
     return createRequestObject(packageId, context, packageVersTmpRoot, packageVersBlobZipFile);
 }
+exports.createPackageVersionCreateRequest = createPackageVersionCreateRequest;
 async function createRequestObject(packageId, options, packageVersTmpRoot, packageVersBlobZipFile) {
     const zipFileBase64 = (await fs.promises.readFile(packageVersBlobZipFile)).toString('base64');
     const requestObject = {
@@ -78,7 +79,7 @@ async function createRequestObject(packageId, options, packageVersTmpRoot, packa
         Instance: options.buildinstance,
         IsConversionRequest: true,
     };
-    await fs.promises.unlink(packageVersTmpRoot);
+    await fs.promises.rm(packageVersTmpRoot, { recursive: true });
     return requestObject;
 }
 //# sourceMappingURL=packageConvert.js.map

package/lib/package/packageVersionCreateRequest.js

@@ -50,7 +50,7 @@ async function _query(query, connection) {
 }
 async function _queryErrors(packageVersionCreateRequestId, connection) {
     const errorResults = [];
-    const queryResult = connection.tooling.query(util.format(ERROR_QUERY, packageVersionCreateRequestId));
+    const queryResult = await connection.tooling.query(util.format(ERROR_QUERY, packageVersionCreateRequestId));
     if (queryResult.records) {
         queryResult.records.forEach((record) => {
             errorResults.push(record.Message);

package/lib/utils/packageUtils.d.ts

@@ -135,7 +135,7 @@ export declare function convertCamelCaseStringToSentence(stringIn: string): stri
  * @returns an array of alias for the given id.
  */
 export declare function getPackageAliasesFromId(packageId: string, project: SfProject): string[];
-export declare function findOrCreatePackage(seedPackage: string, connection: Connection): Promise<string>;
+export declare function findOrCreatePackage2(seedPackage: string, connection: Connection): Promise<string>;
 export declare function pollForStatusWithInterval(id: string, retries: number, packageId: string, branch: string, withProject: SfProject, connection: Connection, interval: Duration): Promise<PackageVersionCreateRequestResult>;
 /**
  * Generate package alias json entry for this package version that can be written to sfdx-project.json

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.getAncestorId = exports.validateAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
+exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.pollForStatusWithInterval = exports.findOrCreatePackage2 = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.getAncestorId = exports.validateAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -612,30 +612,27 @@ function getPackageAliasesFromId(packageId, project) {
         .map((alias) => alias[0]);
 }
 exports.getPackageAliasesFromId = getPackageAliasesFromId;
-// probably used by convert.
-async function findOrCreatePackage(seedPackage, connection) {
+async function findOrCreatePackage2(seedPackage, connection) {
     const query = `SELECT Id FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
-    const queryResult = await connection.tooling.query(query);
-    const records = queryResult.records;
-    if (records && records.length > 1) {
-        const ids = records.map((r) => r.Id);
+    const queryResult = (await connection.tooling.query(query)).records;
+    if (queryResult?.length > 1) {
+        const ids = queryResult.map((r) => r.Id);
         throw messages.createError('errorMoreThanOnePackage2WithSeed', [ids.join(', ')]);
     }
-    if (records && records.length === 1) {
+    if (queryResult?.length === 1) {
         // return the package2 object
-        return records[0].Id;
+        return queryResult[0].Id;
     }
     // Need to create a new Package2
     const subQuery = `SELECT Name, Description, NamespacePrefix FROM SubscriberPackage WHERE Id = '${seedPackage}'`;
-    const subscriberResult = await connection.tooling.query(subQuery);
-    const subscriberRecords = subscriberResult.records;
-    if (!subscriberRecords || subscriberRecords.length <= 0) {
+    const subscriberResult = (await connection.tooling.query(subQuery)).records;
+    if (!subscriberResult || subscriberResult?.length <= 0) {
         throw messages.createError('errorNoSubscriberPackageRecord', [seedPackage]);
     }
     const request = {
-        Name: subscriberRecords[0].Name,
-        Description: subscriberRecords[0].Description,
-        NamespacePrefix: subscriberRecords[0].NamespacePrefix,
+        Name: subscriberResult[0].Name,
+        Description: subscriberResult[0].Description,
+        NamespacePrefix: subscriberResult[0].NamespacePrefix,
         ContainerOptions: 'Managed',
         ConvertedFromPackageId: seedPackage,
     };
@@ -645,7 +642,7 @@ async function findOrCreatePackage(seedPackage, connection) {
     }
     return createResult.id;
 }
-exports.findOrCreatePackage = findOrCreatePackage;
+exports.findOrCreatePackage2 = findOrCreatePackage2;
 async function pollForStatusWithInterval(id, retries, packageId, branch, withProject, connection, interval) {
     let remainingRetries = retries;
     const pollingClient = await core_1.PollingClient.create({
@@ -695,20 +692,20 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                 }
             }
             else {
-                const remainingTime = kit_1.Duration.milliseconds(interval.milliseconds * remainingRetries);
+                const remainingTime = kit_1.Duration.seconds(interval.seconds * remainingRetries);
                 await core_1.Lifecycle.getInstance().emit(Package2VersionStatus.inProgress, {
                     id,
                     packageVersionCreateRequestResult: results[0],
                     message: '',
-                    remainingTime,
+                    timeRemaining: remainingTime,
                 });
                 logger.info(`Request in progress. Sleeping ${interval.seconds} 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] };
             }
         },
-        frequency: kit_1.Duration.milliseconds(interval.milliseconds * 1000),
-        timeout: kit_1.Duration.milliseconds(interval.milliseconds * retries * 1000),
+        frequency: kit_1.Duration.seconds(interval.seconds),
+        timeout: kit_1.Duration.seconds(interval.seconds * retries),
     });
     return pollingClient.subscribe();
 }

package/package.json

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