@salesforce/packaging 4.14.1 → 4.15.1

package/lib/interfaces/bundleSObjects.d.ts

@@ -96,14 +96,17 @@ export declare namespace BundleSObjects {
         CreatedDate: string;
         CreatedById: string;
         Error?: string[];
+        ValidationError?: string;
     };
     enum PkgBundleVersionCreateReqStatus {
         queued = "Queued",
+        inProgress = "InProgress",
         success = "Success",
         error = "Error"
     }
     enum PkgBundleVersionInstallReqStatus {
         queued = "Queued",
+        inProgress = "InProgress",
         success = "Success",
         error = "Error"
     }
@@ -120,6 +123,7 @@ export declare namespace BundleSObjects {
         CreatedDate: string;
         CreatedById: string;
         Error?: string[];
+        ValidationError?: string;
     } & Schema;
     type PkgBundleVersionInstallReq = {
         PackageBundleVersionID: string;

package/lib/interfaces/bundleSObjects.js

@@ -6,12 +6,14 @@ var BundleSObjects;
     let PkgBundleVersionCreateReqStatus;
     (function (PkgBundleVersionCreateReqStatus) {
         PkgBundleVersionCreateReqStatus["queued"] = "Queued";
+        PkgBundleVersionCreateReqStatus["inProgress"] = "InProgress";
         PkgBundleVersionCreateReqStatus["success"] = "Success";
         PkgBundleVersionCreateReqStatus["error"] = "Error";
     })(PkgBundleVersionCreateReqStatus = BundleSObjects.PkgBundleVersionCreateReqStatus || (BundleSObjects.PkgBundleVersionCreateReqStatus = {}));
     let PkgBundleVersionInstallReqStatus;
     (function (PkgBundleVersionInstallReqStatus) {
         PkgBundleVersionInstallReqStatus["queued"] = "Queued";
+        PkgBundleVersionInstallReqStatus["inProgress"] = "InProgress";
         PkgBundleVersionInstallReqStatus["success"] = "Success";
         PkgBundleVersionInstallReqStatus["error"] = "Error";
     })(PkgBundleVersionInstallReqStatus = BundleSObjects.PkgBundleVersionInstallReqStatus || (BundleSObjects.PkgBundleVersionInstallReqStatus = {}));

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -36,6 +36,7 @@ export type PackageUpdateOptions = {
     Description?: string;
     PackageErrorUsername?: string;
     AppAnalyticsEnabled?: boolean;
+    RecommendedVersionId?: string;
 };
 export type PackageIdType = 'PackageId' | 'SubscriberPackageVersionId' | 'PackageInstallRequestId' | 'PackageUninstallRequestId';
 export type PackageVersionOptions1GP = Record<string, unknown>;

package/lib/interfaces/packagingSObjects.d.ts

@@ -19,6 +19,7 @@ export declare namespace PackagingSObjects {
         ConvertedFromPackageId: string;
         PackageErrorUsername: string;
         AppAnalyticsEnabled?: boolean;
+        RecommendedVersionId?: string;
     };
     type Package2Version = {
         Id: string;

package/lib/package/package.js

@@ -36,6 +36,7 @@ exports.Package2Fields = [
     'ConvertedFromPackageId',
     'PackageErrorUsername',
     'AppAnalyticsEnabled',
+    'RecommendedVersionId',
 ];
 /**
  * Provides the ability to list, create, update, delete, convert, and get version
@@ -179,7 +180,7 @@ class Package {
     }
     static getPackage2Fields(connection) {
         const apiVersion = connection.getApiVersion();
-        return exports.Package2Fields.filter((field) => (apiVersion >= '59.0' ? true : field !== 'AppAnalyticsEnabled'));
+        return exports.Package2Fields.filter((field) => (apiVersion >= '59.0' ? true : field !== 'AppAnalyticsEnabled')).filter((field) => (apiVersion >= '66.0' ? true : field !== 'RecommendedVersionId'));
     }
     /**
      * Returns the package ID of the package.
@@ -240,6 +241,9 @@ class Package {
             if (opts.AppAnalyticsEnabled !== undefined && this.options.connection.getApiVersion() < '59.0') {
                 throw messages.createError('appAnalyticsEnabledApiPriorTo59Error');
             }
+            if (opts.RecommendedVersionId !== undefined && this.options.connection.getApiVersion() < '66.0') {
+                throw messages.createError('recommendedVersionIdApiPriorTo66Error');
+            }
             const result = await this.options.connection.tooling.update('Package2', opts);
             if (!result.success) {
                 throw new core_1.SfError(result.errors.join(', '));

package/lib/package/packageBundle.js

@@ -55,7 +55,7 @@ class PackageBundle {
         frequency: kit_1.Duration.seconds(0),
         timeout: kit_1.Duration.seconds(0),
     }) {
-        return packageBundleVersion_1.PackageBundleVersion.create(options, polling);
+        return packageBundleVersion_1.PackageBundleVersion.create({ ...options, polling });
     }
     static async delete(connection, project, idOrAlias) {
         // Check if it's already an ID (1Fl followed by 15 characters)

package/lib/package/packageBundleInstall.js

@@ -17,6 +17,7 @@ exports.PackageBundleInstall = void 0;
  * limitations under the License.
  */
 const core_1 = require("@salesforce/core");
+const kit_1 = require("@salesforce/kit");
 const interfaces_1 = require("../interfaces");
 const bundleUtils_1 = require("../utils/bundleUtils");
 core_1.Messages.importMessagesDirectory(__dirname);
@@ -24,8 +25,26 @@ const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'bundle_i
 class PackageBundleInstall {
     static async getInstallStatus(installRequestId, connection) {
         try {
-            const result = await connection.tooling.sobject('PkgBundleVersionInstallReq').retrieve(installRequestId);
-            return result;
+            const query = 'SELECT Id, InstallStatus, PackageBundleVersionID, DevelopmentOrganization, ValidationError, ' +
+                'CreatedDate, CreatedById ' +
+                `FROM PkgBundleVersionInstallReq WHERE Id = '${installRequestId}'`;
+            const queryResult = await connection.autoFetchQuery(query, {
+                tooling: true,
+            });
+            if (!queryResult.records || queryResult.records.length === 0) {
+                throw new Error(messages.getMessage('failedToGetPackageBundleInstallStatus'));
+            }
+            const record = queryResult.records[0];
+            return {
+                Id: record.Id,
+                InstallStatus: record.InstallStatus,
+                PackageBundleVersionID: record.PackageBundleVersionID ?? '',
+                DevelopmentOrganization: record.DevelopmentOrganization ?? '',
+                ValidationError: record.ValidationError ?? '',
+                CreatedDate: record.CreatedDate ?? '',
+                CreatedById: record.CreatedById ?? '',
+                Error: record.Error,
+            };
         }
         catch (err) {
             const error = err instanceof Error ? err : new Error(messages.getMessage('failedToGetPackageBundleInstallStatus'));
@@ -56,6 +75,7 @@ class PackageBundleInstall {
             ValidationError: record.ValidationError ?? '',
             CreatedDate: record.CreatedDate ?? '',
             CreatedById: record.CreatedById ?? '',
+            Error: record.Error,
         }));
     }
     static async installBundle(connection, project, options) {
@@ -80,15 +100,8 @@ class PackageBundleInstall {
         if (options.polling) {
             return PackageBundleInstall.pollInstallStatus(installResult.id, connection, options.polling);
         }
-        return {
-            Id: installResult.id,
-            PackageBundleVersionID: packageBundleVersionId,
-            DevelopmentOrganization: options.DevelopmentOrganization,
-            InstallStatus: interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.queued,
-            ValidationError: '',
-            CreatedDate: new Date().toISOString(),
-            CreatedById: connection.getUsername() ?? 'unknown',
-        };
+        // When not polling, query the actual status from the server to get accurate information
+        return PackageBundleInstall.getInstallStatus(installResult.id, connection);
     }
     static parsePackageBundleVersionId(packageBundleVersion, project) {
         // Check if it's already an ID (starts with appropriate prefix)
@@ -106,13 +119,33 @@ class PackageBundleInstall {
         if (polling.timeout?.milliseconds <= 0) {
             return PackageBundleInstall.getInstallStatus(installRequestId, connection);
         }
+        let remainingWaitTime = polling.timeout;
         const pollingClient = await core_1.PollingClient.create({
             poll: async () => {
-                const status = await PackageBundleInstall.getInstallStatus(installRequestId, connection);
-                if (status.InstallStatus === interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.success) {
-                    return { completed: true, payload: status };
+                const report = await PackageBundleInstall.getInstallStatus(installRequestId, connection);
+                switch (report.InstallStatus) {
+                    case interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.queued:
+                    case interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.inProgress:
+                        // Emit progress event for UI updates
+                        await core_1.Lifecycle.getInstance().emit('bundle-install-progress', { ...report, remainingWaitTime });
+                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
+                        return {
+                            completed: false,
+                            payload: report,
+                        };
+                    case interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.success:
+                        return { completed: true, payload: report };
+                    case interfaces_1.BundleSObjects.PkgBundleVersionInstallReqStatus.error:
+                        return { completed: true, payload: report };
+                    default:
+                        // Handle any unexpected status by continuing to poll
+                        await core_1.Lifecycle.getInstance().emit('bundle-install-progress', { ...report, remainingWaitTime });
+                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
+                        return {
+                            completed: false,
+                            payload: report,
+                        };
                 }
-                return { completed: false, payload: status };
             },
             frequency: polling.frequency,
             timeout: polling.timeout,
@@ -121,8 +154,11 @@ class PackageBundleInstall {
             return await pollingClient.subscribe();
         }
         catch (err) {
+            const report = await PackageBundleInstall.getInstallStatus(installRequestId, connection);
             if (err instanceof Error) {
-                throw new Error('Install request timed out');
+                const timeoutError = new core_1.SfError(`Install request timed out. Run 'sf package bundle install report -i ${installRequestId} -o <target-org>' to check the status.`);
+                timeoutError.setData({ InstallRequestId: installRequestId, ...report });
+                throw timeoutError;
             }
             throw err;
         }

package/lib/package/packageBundleVersion.d.ts

@@ -3,10 +3,7 @@ import { SfProject } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { BundleVersionCreateOptions, BundleSObjects, PackagingSObjects } from '../interfaces';
 export declare class PackageBundleVersion {
-    static create(options: BundleVersionCreateOptions, polling?: {
-        frequency: Duration;
-        timeout: Duration;
-    }): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult>;
+    static create(options: BundleVersionCreateOptions): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult>;
     static pollCreateStatus(createPackageVersionRequestId: string, connection: Connection, project: SfProject, polling: {
         frequency: Duration;
         timeout: Duration;

package/lib/package/packageBundleVersion.js

@@ -19,16 +19,16 @@ exports.PackageBundleVersion = void 0;
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const interfaces_1 = require("../interfaces");
-const bundleUtils_1 = require("../utils/bundleUtils");
 const packageUtils_1 = require("../utils/packageUtils");
+const bundleUtils_1 = require("../utils/bundleUtils");
 const packageBundleVersionCreate_1 = require("./packageBundleVersionCreate");
 core_1.Messages.importMessagesDirectory(__dirname);
 const bundleVersionMessages = core_1.Messages.loadMessages('@salesforce/packaging', 'bundle_version');
 class PackageBundleVersion {
-    static async create(options, polling) {
+    static async create(options) {
         const createResult = await packageBundleVersionCreate_1.PackageBundleVersionCreate.createBundleVersion(options.connection, options.project, options);
-        if (polling) {
-            return PackageBundleVersion.pollCreateStatus(createResult.Id, options.connection, options.project, polling).catch((error) => {
+        if (options.polling) {
+            return PackageBundleVersion.pollCreateStatus(createResult.Id, options.connection, options.project, options.polling).catch((error) => {
                 if (error.name === 'PollingClientTimeout') {
                     const modifiedError = new core_1.SfError(error.message);
                     modifiedError.setData({ VersionCreateRequestId: createResult.Id });
@@ -50,7 +50,8 @@ class PackageBundleVersion {
                 const report = await packageBundleVersionCreate_1.PackageBundleVersionCreate.getCreateStatus(createPackageVersionRequestId, connection);
                 switch (report.RequestStatus) {
                     case interfaces_1.BundleSObjects.PkgBundleVersionCreateReqStatus.queued:
-                        await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.enqueued, { ...report, remainingWaitTime });
+                    case interfaces_1.BundleSObjects.PkgBundleVersionCreateReqStatus.inProgress:
+                        await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.progress, { ...report, remainingWaitTime });
                         remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
                         return {
                             completed: false,
@@ -63,6 +64,14 @@ class PackageBundleVersion {
                     case interfaces_1.BundleSObjects.PkgBundleVersionCreateReqStatus.error:
                         await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.error, report);
                         return { completed: true, payload: report };
+                    default:
+                        // Handle any unexpected status by continuing to poll
+                        await core_1.Lifecycle.getInstance().emit(interfaces_1.PackageVersionEvents.create.progress, { ...report, remainingWaitTime });
+                        remainingWaitTime = kit_1.Duration.seconds(remainingWaitTime.seconds - polling.frequency.seconds);
+                        return {
+                            completed: false,
+                            payload: report,
+                        };
                 }
             },
             frequency: polling.frequency,

package/lib/package/packageBundleVersionCreate.d.ts

@@ -5,7 +5,7 @@ export declare class PackageBundleVersionCreate {
     static getCreateStatuses(connection: Connection, status?: BundleSObjects.PkgBundleVersionCreateReqStatus, createdLastDays?: number): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult[]>;
     static createBundleVersion(connection: Connection, project: SfProject, options: BundleVersionCreateOptions): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult>;
     private static readBundleVersionComponents;
-    private static getVersionName;
+    private static getVersionNameFromBundle;
     private static parsePackageBundleId;
     private static getPackageVersion;
 }

package/lib/package/packageBundleVersionCreate.js

@@ -51,28 +51,46 @@ exports.PackageBundleVersionCreate = void 0;
  */
 const fs = __importStar(require("node:fs"));
 const core_1 = require("@salesforce/core");
-const interfaces_1 = require("../interfaces");
 const bundleUtils_1 = require("../utils/bundleUtils");
-const packageBundleVersion_1 = require("./packageBundleVersion");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'bundle_version_create');
 class PackageBundleVersionCreate {
     static async getCreateStatus(createPackageVersionRequestId, connection) {
         try {
-            const result = await connection.tooling
-                .sobject('PkgBundleVersionCreateReq')
-                .retrieve(createPackageVersionRequestId);
-            return result;
+            const query = 'SELECT Id, RequestStatus, PackageBundle.Id, PackageBundle.BundleName, PackageBundleVersion.Id, ' +
+                'VersionName, MajorVersion, MinorVersion, Ancestor.Id, BundleVersionComponents, ' +
+                'CreatedDate, CreatedById, ValidationError ' +
+                `FROM PkgBundleVersionCreateReq WHERE Id = '${createPackageVersionRequestId}'`;
+            const queryResult = await connection.autoFetchQuery(query, {
+                tooling: true,
+            });
+            if (!queryResult.records || queryResult.records.length === 0) {
+                throw new Error(messages.getMessage('failedToGetPackageBundleVersionCreateStatus'));
+            }
+            const record = queryResult.records[0];
+            return {
+                Id: record.Id,
+                RequestStatus: record.RequestStatus,
+                PackageBundleId: record.PackageBundle?.Id ?? '',
+                PackageBundleVersionId: record.PackageBundleVersion?.Id ?? '',
+                VersionName: record.VersionName ?? '',
+                MajorVersion: record.MajorVersion ?? '',
+                MinorVersion: record.MinorVersion ?? '',
+                Ancestor: record.Ancestor?.Id ?? '',
+                BundleVersionComponents: record.BundleVersionComponents ?? '',
+                CreatedDate: record.CreatedDate ?? '',
+                CreatedById: record.CreatedById ?? '',
+                ValidationError: record.ValidationError ?? '',
+            };
         }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error(messages.getMessage('failedToGetPackageBundleVersionCreateStatus'));
-            throw core_1.SfError.wrap((0, bundleUtils_1.massageErrorMessage)(error));
+        catch (error) {
+            throw (0, bundleUtils_1.massageErrorMessage)(error);
         }
     }
     static async getCreateStatuses(connection, status, createdLastDays) {
         let query = 'SELECT Id, RequestStatus, PackageBundle.Id, PackageBundle.BundleName, PackageBundleVersion.Id, ' +
             'VersionName, MajorVersion, MinorVersion, Ancestor.Id, BundleVersionComponents, ' +
-            'CreatedDate, CreatedById ' +
+            'CreatedDate, CreatedById, ValidationError ' +
             'FROM PkgBundleVersionCreateReq';
         if (status && createdLastDays) {
             query += ` WHERE RequestStatus = '${status}' AND CreatedDate = LAST_N_DAYS: ${createdLastDays}`;
@@ -98,6 +116,7 @@ class PackageBundleVersionCreate {
             BundleVersionComponents: record.BundleVersionComponents ?? '',
             CreatedDate: record.CreatedDate ?? '',
             CreatedById: record.CreatedById ?? '',
+            ValidationError: record.ValidationError ?? '',
         }));
     }
     static async createBundleVersion(connection, project, options) {
@@ -107,9 +126,11 @@ class PackageBundleVersionCreate {
         const version = options.MajorVersion && options.MinorVersion
             ? { MajorVersion: options.MajorVersion, MinorVersion: options.MinorVersion }
             : await PackageBundleVersionCreate.getPackageVersion(options, project, connection);
+        // Get the versionName from the bundle configuration
+        const versionName = await PackageBundleVersionCreate.getVersionNameFromBundle(options.PackageBundle, project, connection);
         const request = {
             PackageBundleId: packageBundleId,
-            VersionName: PackageBundleVersionCreate.getVersionName(options.PackageBundle, version.MajorVersion, version.MinorVersion),
+            VersionName: versionName,
             MajorVersion: version.MajorVersion,
             MinorVersion: version.MinorVersion,
             BundleVersionComponents: JSON.stringify(bundleVersionComponents),
@@ -126,23 +147,18 @@ class PackageBundleVersionCreate {
             throw core_1.SfError.wrap((0, bundleUtils_1.massageErrorMessage)(error));
         }
         if (!createResult?.success) {
-            throw core_1.SfError.wrap((0, bundleUtils_1.massageErrorMessage)(new Error(messages.getMessage('failedToCreatePackageBundleVersion'))));
-        }
-        if (options.polling) {
-            return packageBundleVersion_1.PackageBundleVersion.pollCreateStatus(createResult.id, connection, project, options.polling);
+            let errorMessage = messages.getMessage('failedToCreatePackageBundleVersion');
+            if (createResult.errors?.length) {
+                errorMessage = createResult.errors.join(', ');
+            }
+            else if (createResult.errors && createResult.errors.length === 0) {
+                errorMessage = 'No specific error details available from Salesforce API';
+            }
+            throw core_1.SfError.wrap((0, bundleUtils_1.massageErrorMessage)(new Error(errorMessage)));
         }
-        return {
-            Id: createResult.id,
-            PackageBundleVersionId: createResult.id,
-            PackageBundleId: packageBundleId,
-            VersionName: PackageBundleVersionCreate.getVersionName(options.PackageBundle, version.MajorVersion, version.MinorVersion),
-            MajorVersion: version.MajorVersion,
-            MinorVersion: version.MinorVersion,
-            BundleVersionComponents: JSON.stringify(bundleVersionComponents),
-            RequestStatus: interfaces_1.BundleSObjects.PkgBundleVersionCreateReqStatus.success,
-            CreatedDate: new Date().toISOString(),
-            CreatedById: connection.getUsername() ?? 'unknown',
-        };
+        // Return the request result with the ID - polling will be handled by the caller if needed
+        // Query the actual status from the server to get accurate information including the request ID
+        return PackageBundleVersionCreate.getCreateStatus(createResult.id, connection);
     }
     static readBundleVersionComponents(filePath, project) {
         try {
@@ -177,8 +193,23 @@ class PackageBundleVersionCreate {
             throw core_1.SfError.wrap((0, bundleUtils_1.massageErrorMessage)(error));
         }
     }
-    static getVersionName(packageBundle, majorVersion, minorVersion) {
-        return `${packageBundle}@${majorVersion}.${minorVersion}`;
+    static async getVersionNameFromBundle(packageBundle, project, connection) {
+        const packageBundleId = PackageBundleVersionCreate.parsePackageBundleId(packageBundle, project);
+        const query = `SELECT BundleName FROM PackageBundle WHERE Id = '${packageBundleId}'`;
+        const result = await connection.tooling.query(query);
+        if (!result.records || result.records.length === 0) {
+            throw new core_1.SfError(messages.getMessage('noBundleFoundWithId', [packageBundleId]));
+        }
+        const bundleName = result.records[0].BundleName;
+        const bundles = project.getSfProjectJson().getPackageBundles();
+        const bundle = bundles.find((b) => b.name === bundleName);
+        if (!bundle) {
+            throw new core_1.SfError(messages.getMessage('noBundleFoundWithName', [bundleName]));
+        }
+        if (!bundle.versionName) {
+            throw new core_1.SfError(`Bundle '${bundleName}' is missing versionName in sfdx-project.json. Please add a versionName field to the bundle configuration.`);
+        }
+        return bundle.versionName;
     }
     static parsePackageBundleId(packageBundle, project) {
         if (/^1Fl.{15}$/.test(packageBundle)) {

package/messages/package.md

@@ -45,3 +45,7 @@ Can't retrieve package metadata. We're unable to retrieve metadata for the packa
 # packagingNotEnabledOnOrg
 
 Can't retrieve package metadata. The org you specified doesn't have the required second-generation packaging permission enabled. Enable this permission on your Dev Hub org, and try again.
+
+# recommendedVersionIdApiPriorTo66Error
+
+To enable Recommended Version, use API version 66.0 or higher.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.14.1",
+  "version": "4.15.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",