@salesforce/packaging 0.0.20 → 0.0.21

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.21](https://github.com/forcedotcom/packaging/compare/v0.0.20...v0.0.21) (2022-08-19)
+
+### Bug Fixes
+
+- inital refactor for PVC - a lot left to do, but a lot has been done ([c629291](https://github.com/forcedotcom/packaging/commit/c629291ae375c7db627b47f4ddb2f6bdd874c394))
+
 ### [0.0.20](https://github.com/forcedotcom/packaging/compare/v0.0.19...v0.0.20) (2022-08-19)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -1,5 +1,5 @@
 import { Duration } from '@salesforce/kit';
-import { Connection, SfProject } from '@salesforce/core';
+import { Connection, NamedPackageDir, SfProject } from '@salesforce/core';
 import { QueryResult, SaveResult } from 'jsforce';
 import { PackageProfileApi } from '../package/packageProfileApi';
 import { PackagingSObjects } from './packagingSObjects';
@@ -119,6 +119,34 @@ export declare type PackageCreateOptions = {
     errorNotificationUsername: string;
     path: string;
 };
+export declare type PackageDescriptorJson = Partial<NamedPackageDir> & Partial<{
+    id: string;
+    features: string[];
+    orgPreferences: string[];
+    snapshot: string;
+    unpackagedMetadata: NamedPackageDir;
+    apexTestAccess: {
+        permissionSets: string[] | string;
+        permissionSetLicenses: string[] | string;
+    };
+    permissionSetNames: string[];
+    permissionSetLicenseDeveloperNames: string[];
+    branch: string;
+    subscriberPackageVersionId: string;
+    packageId: string;
+    versionName: string;
+}>;
+export declare type PackageVersionCreateRequest = {
+    Package2Id: string;
+    VersionInfo: string;
+    Tag: string;
+    Branch: string;
+    InstallKey: string;
+    Instance: string;
+    SourceOrg: string;
+    CalculateCodeCoverage: boolean;
+    SkipValidation: boolean;
+};
 export declare type PackageVersionQueryOptions = {
     project: SfProject;
     orderBy: string;
@@ -171,8 +199,7 @@ export declare type PackageVersionCreateOptions = Partial<PackageVersionOptions
     definitionfile: string;
     installationkey: string;
     installationkeybypass: boolean;
-    package: string;
-    path: string;
+    packageId: string;
     postinstallscript: string;
     postinstallurl: string;
     preserve: boolean;
@@ -186,8 +213,6 @@ export declare type PackageVersionCreateOptions = Partial<PackageVersionOptions
     versiondescription: string;
     versionname: string;
     versionnumber: string;
-    wait: Duration;
-    pollInterval: Duration;
     profileApi: PackageProfileApi;
 }>;
 export declare type PackageVersionCreateRequestQueryOptions = {

package/lib/package/index.d.ts

@@ -8,3 +8,4 @@ export { createPackage } from './packageCreate';
 export { deletePackage } from './packageDelete';
 export { uninstallPackage } from './packageUninstall';
 export * from './packageInstalledList';
+export * from './packageVersionCreateRequestReport';

package/lib/package/index.js

@@ -35,4 +35,5 @@ Object.defineProperty(exports, "deletePackage", { enumerable: true, get: functio
 var packageUninstall_1 = require("./packageUninstall");
 Object.defineProperty(exports, "uninstallPackage", { enumerable: true, get: function () { return packageUninstall_1.uninstallPackage; } });
 __exportStar(require("./packageInstalledList"), exports);
+__exportStar(require("./packageVersionCreateRequestReport"), exports);
 //# sourceMappingURL=index.js.map

package/lib/package/packageProfileApi.d.ts

@@ -30,17 +30,24 @@ export declare class PackageProfileApi extends AsyncCreatable<ProfileApiOptions>
      * @param excludedDirectories Directories to not include profiles from
      */
     generateProfiles(destPath: string, manifest: {
-        Package: {
-            types: string[];
-        };
-    }, excludedDirectories?: string[]): any[];
+        Package: Array<{
+            name: string[];
+            members: string[];
+        }>;
+    }, excludedDirectories?: string[]): string[];
     /**
      * Filter out all profiles in the manifest and if any profiles exists in the workspace, add them to the manifest.
      *
      * @param typesArr array of objects { name[], members[] } that represent package types JSON.
      * @param excludedDirectories Direcotires not to generate profiles for
      */
-    filterAndGenerateProfilesForManifest(typesArr: any, excludedDirectories?: string[]): any;
+    filterAndGenerateProfilesForManifest(typesArr: Array<{
+        name: string[];
+        members: string[];
+    }>, excludedDirectories?: string[]): Array<{
+        name: string[];
+        members: string[];
+    }>;
     getProfileInformation(): ProfileInformation[];
     private copyNodes;
     private findAllProfiles;

package/lib/package/packageProfileApi.js

@@ -115,9 +115,9 @@ class PackageProfileApi extends kit_1.AsyncCreatable {
             let hasNodes = false;
             // We need to keep track of all the members for when we package up the "OtherProfileSettings"
             let allMembers = [];
-            manifest.Package.types.forEach((element) => {
-                const name = element['name'];
-                const members = element['members'];
+            manifest.Package.forEach((element) => {
+                const name = element.name;
+                const members = element.members;
                 allMembers = allMembers.concat(members);
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 const idx = this.nodeEntities.name.indexOf(name[0]);

package/lib/package/packageVersion.d.ts

@@ -1,5 +1,5 @@
 import { Duration } from '@salesforce/kit';
-import { PackageVersionCreateRequestResult, PackageSaveResult, PackageVersionCreateOptions, PackageVersionOptions, PackageVersionReportResult } from '../interfaces';
+import { PackageSaveResult, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageVersionOptions, PackageVersionReportResult } from '../interfaces';
 export declare class PackageVersion {
     private options;
     private readonly project;
@@ -9,8 +9,12 @@ export declare class PackageVersion {
      * Creates a new package version.
      *
      * @param options
+     * @param polling frequency and timeout Durations to be used in polling
      */
-    create(options: PackageVersionCreateOptions): Promise<Partial<PackageVersionCreateRequestResult>>;
+    create(options: PackageVersionCreateOptions, polling?: {
+        frequency: Duration;
+        timeout: Duration;
+    }): Promise<Partial<PackageVersionCreateRequestResult>>;
     /**
      * Deletes a package version.
      *
@@ -43,25 +47,18 @@ export declare class PackageVersion {
      * progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.
      *
      * @param createPackageVersionRequestId
-     * @param wait - how long to wait for the package version to be created
-     * @param interval - frequency of checking for the package version to be created
-     */
-    waitForCreateVersion(packageId: string, createPackageVersionRequestId: string, wait?: Duration, interval?: Duration): Promise<PackageVersionCreateRequestResult>;
+     * @param polling frequency and timeout Durations to be used in polling
+     * */
+    waitForCreateVersion(createPackageVersionRequestId: string, polling: {
+        frequency: Duration;
+        timeout: Duration;
+    }): Promise<PackageVersionCreateRequestResult>;
     convert(): Promise<void>;
     install(): Promise<void>;
     list(): Promise<void>;
     uninstall(): Promise<void>;
     update(): Promise<void>;
     private updateDeprecation;
-    /**
-     * Increase the wait time for a package version that is org dependent.
-     *
-     * @param resolvedPackageId
-     * @param pollInterval
-     * @param wait
-     * @private
-     */
-    private resolveOrgDependentPollingTime;
     private updateProjectWithPackageVersion;
     private generatePackageDirectory;
 }

package/lib/package/packageVersion.js

@@ -10,15 +10,12 @@ exports.PackageVersion = void 0;
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const pkgUtils = require("../utils/packageUtils");
-const utils_1 = require("../utils");
 const packageUtils_1 = require("../utils/packageUtils");
 const packageVersionCreate_1 = require("./packageVersionCreate");
 const packageVersionReport_1 = require("./packageVersionReport");
 const packageVersionCreateRequestReport_1 = require("./packageVersionCreateRequestReport");
 const package_1 = require("./package");
 core_1.Messages.importMessagesDirectory(__dirname);
-// const messages = Messages.loadMessages('@salesforce/packaging', 'messages');
-// const logger = Logger.childFromRoot('packageVersionCreate');
 class PackageVersion {
     constructor(options) {
         this.options = options;
@@ -29,16 +26,19 @@ class PackageVersion {
      * Creates a new package version.
      *
      * @param options
+     * @param polling frequency and timeout Durations to be used in polling
      */
-    async create(options) {
+    async create(options, polling = {
+        frequency: kit_1.Duration.seconds(0),
+        timeout: kit_1.Duration.seconds(0),
+    }) {
         const pvc = new packageVersionCreate_1.PackageVersionCreate({ ...options, ...this.options });
         const createResult = await pvc.createPackageVersion();
-        const waitResult = await this.waitForCreateVersion(createResult.Package2Id, createResult.Id, options.wait ?? kit_1.Duration.milliseconds(0), options.pollInterval ? options.pollInterval : kit_1.Duration.seconds(30)).catch((err) => {
+        return await this.waitForCreateVersion(createResult.Id, polling).catch((err) => {
             // TODO
             // until package2 is GA, wrap perm-based errors w/ 'contact sfdc' action (REMOVE once package2 is GA'd)
             throw pkgUtils.applyErrorAction(err);
         });
-        return waitResult;
     }
     /**
      * Deletes a package version.
@@ -97,16 +97,13 @@ class PackageVersion {
      * progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.
      *
      * @param createPackageVersionRequestId
-     * @param wait - how long to wait for the package version to be created
-     * @param interval - frequency of checking for the package version to be created
-     */
-    async waitForCreateVersion(packageId, createPackageVersionRequestId, wait = kit_1.Duration.milliseconds(0), interval = kit_1.Duration.milliseconds(0)) {
-        if (wait?.milliseconds <= 0) {
-            const result = await this.getCreateVersionReport(createPackageVersionRequestId);
-            return result;
+     * @param polling frequency and timeout Durations to be used in polling
+     * */
+    async waitForCreateVersion(createPackageVersionRequestId, polling) {
+        if (polling.timeout?.milliseconds <= 0) {
+            return await this.getCreateVersionReport(createPackageVersionRequestId);
         }
-        const resolvedWait = await this.resolveOrgDependentPollingTime(packageId, wait, interval);
-        let remainingWaitTime = wait;
+        let remainingWaitTime = polling.timeout;
         let report;
         const pollingClient = await core_1.PollingClient.create({
             poll: async () => {
@@ -114,7 +111,7 @@ class PackageVersion {
                 switch (report.Status) {
                     case 'Queued':
                         await core_1.Lifecycle.getInstance().emit('enqueued', { ...report, remainingWaitTime });
-                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - interval.seconds);
+                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
                         return {
                             completed: false,
                             payload: report,
@@ -126,7 +123,7 @@ class PackageVersion {
                     case 'VerifyingMetadata':
                     case 'FinalizingPackageVersion':
                         await core_1.Lifecycle.getInstance().emit('in-progress', { ...report, remainingWaitTime });
-                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - interval.seconds);
+                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
                         return {
                             completed: false,
                             payload: report,
@@ -134,14 +131,25 @@ class PackageVersion {
                     case 'Success':
                         await this.updateProjectWithPackageVersion(this.project, report);
                         await core_1.Lifecycle.getInstance().emit('success', report);
+                        if (!process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE) {
+                            // get the newly created package version from the server
+                            const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${report.SubscriberPackageVersionId}'`)).records[0];
+                            const version = `${(0, packageUtils_1.getPackageAliasesFromId)(report.Package2Id, this.project).join()}@${versionResult.MajorVersion ?? 0}.${versionResult.MinorVersion ?? 0}.${versionResult.PatchVersion ?? 0}`;
+                            const build = versionResult.BuildNumber ? `-${versionResult.BuildNumber}` : '';
+                            const branch = versionResult.Branch ? `-${versionResult.Branch}` : '';
+                            // set packageAliases entry '<package>@<major>.<minor>.<patch>-<build>-<branch>: <result.subscriberPackageVersionId>'
+                            this.project.getSfProjectJson().getContents().packageAliases[`${version}${build}${branch}`] =
+                                report.SubscriberPackageVersionId;
+                            await this.project.getSfProjectJson().write();
+                        }
                         return { completed: true, payload: report };
                     case 'Error':
                         await core_1.Lifecycle.getInstance().emit('error', report);
                         return { completed: true, payload: report };
                 }
             },
-            frequency: interval,
-            timeout: resolvedWait,
+            frequency: polling.frequency,
+            timeout: polling.timeout,
         });
         try {
             return pollingClient.subscribe();
@@ -179,37 +187,11 @@ class PackageVersion {
         };
         const updateResult = await this.connection.tooling.update('Package2Version', request);
         if (!updateResult.success) {
-            throw (0, utils_1.combineSaveErrors)('Package2', 'update', updateResult.errors);
+            throw (0, packageUtils_1.combineSaveErrors)('Package2', 'update', updateResult.errors);
         }
         updateResult.id = await pkgUtils.getSubscriberPackageVersionId(packageVersionId, this.connection);
         return updateResult;
     }
-    /**
-     * Increase the wait time for a package version that is org dependent.
-     *
-     * @param resolvedPackageId
-     * @param pollInterval
-     * @param wait
-     * @private
-     */
-    async resolveOrgDependentPollingTime(resolvedPackageId, wait, pollInterval) {
-        // If we are polling check to see if the package is Org-Dependent, if so, update the poll time
-        if (wait.milliseconds > 0) {
-            const query = `SELECT IsOrgDependent FROM Package2 WHERE Id = '${resolvedPackageId}'`;
-            try {
-                const pkgQueryResult = await this.connection.singleRecordQuery(query, {
-                    tooling: true,
-                });
-                if (pkgQueryResult.IsOrgDependent) {
-                    return kit_1.Duration.seconds((60 / pollInterval.seconds) * wait.seconds);
-                }
-            }
-            catch {
-                // do nothing
-            }
-        }
-        return wait;
-    }
     async updateProjectWithPackageVersion(withProject, results) {
         if (withProject && !process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
             const query = `SELECT Name, Package2Id, MajorVersion, MinorVersion, PatchVersion, BuildNumber, Description, Branch FROM Package2Version WHERE Id = '${results.Package2VersionId}'`;

package/lib/package/packageVersionCreate.d.ts

@@ -1,61 +1,41 @@
-import { Connection } from '@salesforce/core';
-import { PackageVersionCreateRequestResult, PackageVersionCreateOptions } from '../interfaces';
+import { PackageVersionCreateOptions, PackageVersionCreateRequestResult } from '../interfaces';
 export declare class PackageVersionCreate {
     private options;
     private apiVersionFromPackageXml;
     private readonly project;
     private readonly connection;
+    private packageObject;
+    private packageType;
+    private packageId;
+    private packageAlias;
     constructor(options: PackageVersionCreateOptions);
     createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
-    listRequest(createdlastdays?: number, status?: string): Promise<PackageVersionCreateRequestResult[]>;
-    listRequestById(id: string, connection: Connection): Promise<PackageVersionCreateRequestResult[]>;
     private generateMDFolderForArtifact;
     private validateDependencyValues;
     /**
-     *  A dependency in the workspace config file may be specified using either a subscriber package version id (04t)
-     *  or a package Id (0Ho) + a version number.  Additionally, a build number may be the actual build number, or a
-     *  keyword: LATEST or RELEASED (meaning the latest or released build number for a given major.minor.patch).
+     * A dependency in the workspace config file may be specified using either a subscriber package version id (04t)
+     * or a package Id (0Ho) + a version number.  Additionally, a build number may be the actual build number, or a
+     * keyword: LATEST or RELEASED (meaning the latest or released build number for a given major.minor.patch).
      *
-     *  This method resolves a package Id + version number to a subscriber package version id (04t)
-     *  and adds it as a SubscriberPackageVersionId parameter in the dependency object.
+     * This method resolves a package Id + version number to a subscriber package version id (04t)
+     * and adds it as a SubscriberPackageVersionId parameter in the dependency object.
      */
     private retrieveSubscriberPackageVersionId;
     private resolveBuildNumber;
     private createRequestObject;
-    private getPackageDescriptorJsonFromPackageId;
     /**
      * Convert the list of command line options to a JSON object that can be used to create an Package2VersionCreateRequest entity.
      *
-     * @param options
-     * @param packageId
-     * @param versionNumberString
      * @returns {{Package2Id: (*|p|boolean), Package2VersionMetadata: *, Tag: *, Branch: number}}
      * @private
      */
     private createPackageVersionCreateRequestFromOptions;
+    private cleanGeneratedPackage;
     private resolveApexTestPermissions;
     private resolveUnpackagedMetadata;
-    private getPackagePropertyFromPackage;
-    private getPackageValuePropertyFromDirectory;
-    /**
-     * Returns the property value that corresponds to the propertyToLookup.  This value found for a particular
-     * package directory element that matches the knownProperty and knownValue.  In other words, we locate a package
-     * directory element whose knownProperty matches the knownValue, then we grab the value for the propertyToLookup
-     * and return it.
-     *
-     * @param packageDirs The list of all the package directories from the sfdx-project.json
-     * @param propertyToLookup The property ID whose value we want to find
-     * @param knownProperty The JSON property in the packageDirectories that is already known
-     * @param knownValue The value that corresponds to the knownProperty in the packageDirectories JSON
-     * @param knownFlag The flag details e.g. short/long name, etc. Only used for the error message
-     * @param options
-     */
-    private getConfigPackageDirectoriesValue;
     private packageVersionCreate;
-    private resolveCanonicalPackageProperty;
-    private validateVersionNumber;
     private resolveUserLicenses;
-    private validateFlagsForPackageType;
+    private validateOptionsForPackageType;
     /**
      * Cleans invalid attribute(s) from the packageDescriptorJSON
      */