@salesforce/packaging 4.12.0 → 4.13.1

package/lib/exported.d.ts

@@ -2,3 +2,6 @@ export * from './interfaces';
 export * from './package';
 export * from './package1';
 export * from './utils';
+export * from './package/packageBundle';
+export * from './package/packageBundleVersionCreate';
+export * from './package/packageBundleInstall';

package/lib/exported.js

@@ -15,13 +15,25 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (c) 2022, 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
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./package"), exports);
 __exportStar(require("./package1"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./package/packageBundle"), exports);
+__exportStar(require("./package/packageBundleVersionCreate"), exports);
+__exportStar(require("./package/packageBundleInstall"), exports);
 //# sourceMappingURL=exported.js.map

package/lib/interfaces/bundleInterfacesAndType.d.ts

@@ -0,0 +1,33 @@
+import { Nullable } from '@salesforce/ts-types';
+import { Connection, SfProject } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import { SaveResult } from '@jsforce/jsforce-node';
+export type BundleCreateOptions = {
+    BundleName: string;
+    Description: string;
+};
+export type BundleVersionCreateOptions = {
+    connection: Connection;
+    project: SfProject;
+    PackageBundle: string;
+    MajorVersion: string;
+    MinorVersion: string;
+    Ancestor: Nullable<string>;
+    BundleVersionComponentsPath: string;
+    Description?: string;
+    polling?: {
+        timeout: Duration;
+        frequency: Duration;
+    };
+};
+export type BundleInstallOptions = {
+    connection: Connection;
+    project: SfProject;
+    PackageBundleVersion: string;
+    DevelopmentOrganization: string;
+    polling?: {
+        timeout: Duration;
+        frequency: Duration;
+    };
+};
+export type BundleSaveResult = SaveResult;

package/lib/interfaces/bundleInterfacesAndType.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=bundleInterfacesAndType.js.map

package/lib/interfaces/bundleSObjects.d.ts

@@ -0,0 +1,146 @@
+import { Nullable } from '@salesforce/ts-types';
+import { BundleEntry } from '@salesforce/schemas';
+import type { Schema } from '@jsforce/jsforce-node';
+export { BundleEntry };
+export type QueryRecord = Schema & {
+    Id: string;
+    PackageBundle?: {
+        Id: string;
+        BundleName: string;
+        Description?: string;
+        IsDeleted: boolean;
+        CreatedDate: string;
+        CreatedById: string;
+        LastModifiedDate: string;
+        LastModifiedById: string;
+        SystemModstamp: string;
+    };
+    VersionName: string;
+    MajorVersion: string;
+    MinorVersion: string;
+    IsReleased: boolean;
+    Ancestor?: {
+        Id: string;
+        PackageBundle?: {
+            Id: string;
+            BundleName: string;
+            Description?: string;
+            IsDeleted: boolean;
+            CreatedDate: string;
+            CreatedById: string;
+            LastModifiedDate: string;
+            LastModifiedById: string;
+            SystemModstamp: string;
+        };
+        VersionName: string;
+        MajorVersion: string;
+        MinorVersion: string;
+        IsReleased: boolean;
+    };
+};
+export type AncestorRecord = {
+    Id: string;
+    PackageBundle?: {
+        Id: string;
+        BundleName: string;
+        Description?: string;
+        IsDeleted: boolean;
+        CreatedDate: string;
+        CreatedById: string;
+        LastModifiedDate: string;
+        LastModifiedById: string;
+        SystemModstamp: string;
+    };
+    VersionName: string;
+    MajorVersion: string;
+    MinorVersion: string;
+    IsReleased: boolean;
+};
+export declare namespace BundleSObjects {
+    type Bundle = {
+        BundleName: string;
+        Description?: string;
+        Id: string;
+        IsDeleted: boolean;
+        CreatedDate: string;
+        CreatedById: string;
+        LastModifiedDate: string;
+        LastModifiedById: string;
+        SystemModstamp: string;
+    };
+    type BundleVersion = {
+        Id: string;
+        PackageBundle: Bundle;
+        VersionName: string;
+        MajorVersion: string;
+        MinorVersion: string;
+        Ancestor: Nullable<BundleVersion>;
+        IsReleased: boolean;
+        CreatedDate: string;
+        CreatedById: string;
+        LastModifiedDate: string;
+        LastModifiedById: string;
+    };
+    type PkgBundleVersionCreateReq = {
+        PackageBundleId: string;
+        VersionName: string;
+        MajorVersion: string;
+        MinorVersion: string;
+        BundleVersionComponents: string;
+        Ancestor?: string | null;
+    };
+    type PackageBundleVersionCreateRequestResult = PkgBundleVersionCreateReq & {
+        Id: string;
+        PackageBundleVersionId: string;
+        RequestStatus: PkgBundleVersionCreateReqStatus;
+        CreatedDate: string;
+        CreatedById: string;
+        Error?: string[];
+    };
+    enum PkgBundleVersionCreateReqStatus {
+        queued = "Queued",
+        success = "Success",
+        error = "Error"
+    }
+    enum PkgBundleVersionInstallReqStatus {
+        queued = "Queued",
+        success = "Success",
+        error = "Error"
+    }
+    type PkgBundleVersionQueryRecord = {
+        Id: string;
+        RequestStatus: BundleSObjects.PkgBundleVersionCreateReqStatus;
+        PackageBundle: Bundle;
+        PackageBundleVersion: BundleVersion;
+        VersionName: string;
+        MajorVersion: string;
+        MinorVersion: string;
+        Ancestor: BundleVersion;
+        BundleVersionComponents: string;
+        CreatedDate: string;
+        CreatedById: string;
+        Error?: string[];
+    } & Schema;
+    type PkgBundleVersionInstallReq = {
+        PackageBundleVersionID: string;
+        DevelopmentOrganization: string;
+    };
+    type PkgBundleVersionInstallReqResult = PkgBundleVersionInstallReq & {
+        Id: string;
+        InstallStatus: PkgBundleVersionInstallReqStatus;
+        ValidationError: string;
+        CreatedDate: string;
+        CreatedById: string;
+        Error?: string[];
+    };
+    type PkgBundleVersionInstallQueryRecord = {
+        Id: string;
+        InstallStatus: BundleSObjects.PkgBundleVersionInstallReqStatus;
+        PackageBundleVersionID: string;
+        DevelopmentOrganization: string;
+        ValidationError: string;
+        CreatedDate: string;
+        CreatedById: string;
+        Error?: string[];
+    } & Schema;
+}

package/lib/interfaces/bundleSObjects.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BundleSObjects = void 0;
+var BundleSObjects;
+(function (BundleSObjects) {
+    let PkgBundleVersionCreateReqStatus;
+    (function (PkgBundleVersionCreateReqStatus) {
+        PkgBundleVersionCreateReqStatus["queued"] = "Queued";
+        PkgBundleVersionCreateReqStatus["success"] = "Success";
+        PkgBundleVersionCreateReqStatus["error"] = "Error";
+    })(PkgBundleVersionCreateReqStatus = BundleSObjects.PkgBundleVersionCreateReqStatus || (BundleSObjects.PkgBundleVersionCreateReqStatus = {}));
+    let PkgBundleVersionInstallReqStatus;
+    (function (PkgBundleVersionInstallReqStatus) {
+        PkgBundleVersionInstallReqStatus["queued"] = "Queued";
+        PkgBundleVersionInstallReqStatus["success"] = "Success";
+        PkgBundleVersionInstallReqStatus["error"] = "Error";
+    })(PkgBundleVersionInstallReqStatus = BundleSObjects.PkgBundleVersionInstallReqStatus || (BundleSObjects.PkgBundleVersionInstallReqStatus = {}));
+})(BundleSObjects || (exports.BundleSObjects = BundleSObjects = {}));
+//# sourceMappingURL=bundleSObjects.js.map

package/lib/interfaces/index.d.ts

@@ -1,2 +1,4 @@
 export * from './packagingInterfacesAndType';
 export * from './packagingSObjects';
+export * from './bundleInterfacesAndType';
+export * from './bundleSObjects';

package/lib/interfaces/index.js

@@ -15,11 +15,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (c) 2022, 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
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 __exportStar(require("./packagingInterfacesAndType"), exports);
 __exportStar(require("./packagingSObjects"), exports);
+__exportStar(require("./bundleInterfacesAndType"), exports);
+__exportStar(require("./bundleSObjects"), exports);
 //# sourceMappingURL=index.js.map

package/lib/interfaces/packagingInterfacesAndType.js

@@ -1,9 +1,18 @@
 "use strict";
 /*
- * Copyright (c) 2022, 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
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Package1VersionEvents = exports.PackageVersionEvents = exports.PackageEvents = exports.PackageVersionCreateRequestResultInProgressStatuses = void 0;

package/lib/package/index.d.ts

@@ -3,3 +3,6 @@ export * from './packageVersion';
 export * from './subscriberPackageVersion';
 export * from './packagePushUpgrade';
 export { VersionNumber } from './versionNumber';
+export * from './packageBundle';
+export * from './packageBundleVersion';
+export * from './packageBundleInstall';

package/lib/package/index.js

@@ -16,10 +16,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VersionNumber = void 0;
 /*
- * Copyright (c) 2022, 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
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 __exportStar(require("./package"), exports);
 __exportStar(require("./packageVersion"), exports);
@@ -27,4 +36,7 @@ __exportStar(require("./subscriberPackageVersion"), exports);
 __exportStar(require("./packagePushUpgrade"), exports);
 var versionNumber_1 = require("./versionNumber");
 Object.defineProperty(exports, "VersionNumber", { enumerable: true, get: function () { return versionNumber_1.VersionNumber; } });
+__exportStar(require("./packageBundle"), exports);
+__exportStar(require("./packageBundleVersion"), exports);
+__exportStar(require("./packageBundleInstall"), exports);
 //# sourceMappingURL=index.js.map

package/lib/package/packageAncestry.js

@@ -38,10 +38,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PackageAncestryNode = exports.AncestryDotProducer = exports.AncestryJsonProducer = exports.AncestryTreeProducer = exports.PackageAncestry = void 0;
 /*
- * Copyright (c) 2022, 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
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 const node_os_1 = require("node:os");
 const core_1 = require("@salesforce/core");

package/lib/package/packageBundle.d.ts

@@ -0,0 +1,37 @@
+import { Connection, SfProject } from '@salesforce/core';
+import { SaveResult } from '@jsforce/jsforce-node';
+import { Duration } from '@salesforce/kit';
+import { BundleCreateOptions, BundleSObjects, BundleVersionCreateOptions } from '../interfaces';
+export declare class PackageBundle {
+    /**
+     * Create a new package bundle.
+     *
+     * @param connection - instance of Connection
+     * @param project - instance of SfProject
+     * @param options - options for creating a bundle - see BundleCreateOptions
+     * @returns PackageBundle
+     */
+    static create(connection: Connection, project: SfProject, options: BundleCreateOptions): Promise<{
+        Id: string;
+    }>;
+    /**
+     * Create a new package bundle version.
+     *
+     * @param connection - instance of Connection
+     * @param project - instance of SfProject
+     * @param options - options for creating a bundle version - see BundleVersionCreateOptions
+     * @returns PackageBundle
+     */
+    static createVersion(options: BundleVersionCreateOptions, polling?: {
+        frequency: Duration;
+        timeout: Duration;
+    }): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult>;
+    static delete(connection: Connection, project: SfProject, idOrAlias: string): Promise<SaveResult>;
+    /**
+     * Returns all the package bundles that are available in the org, up to 10,000. If more records are
+     * needed use the `SF_ORG_MAX_QUERY_LIMIT` env var.
+     *
+     * @param connection
+     */
+    static list(connection: Connection): Promise<BundleSObjects.Bundle[]>;
+}

package/lib/package/packageBundle.js

@@ -0,0 +1,85 @@
+"use strict";
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageBundle = void 0;
+const core_1 = require("@salesforce/core");
+const kit_1 = require("@salesforce/kit");
+const packageBundleCreate_1 = require("./packageBundleCreate");
+const packageBundleVersion_1 = require("./packageBundleVersion");
+const BundleFields = [
+    'BundleName',
+    'Description',
+    'Id',
+    'IsDeleted',
+    'CreatedDate',
+    'CreatedById',
+    'LastModifiedDate',
+    'LastModifiedById',
+    'SystemModstamp',
+];
+class PackageBundle {
+    /**
+     * Create a new package bundle.
+     *
+     * @param connection - instance of Connection
+     * @param project - instance of SfProject
+     * @param options - options for creating a bundle - see BundleCreateOptions
+     * @returns PackageBundle
+     */
+    static async create(connection, project, options) {
+        return (0, packageBundleCreate_1.createBundle)(connection, project, options);
+    }
+    /**
+     * Create a new package bundle version.
+     *
+     * @param connection - instance of Connection
+     * @param project - instance of SfProject
+     * @param options - options for creating a bundle version - see BundleVersionCreateOptions
+     * @returns PackageBundle
+     */
+    static async createVersion(options, polling = {
+        frequency: kit_1.Duration.seconds(0),
+        timeout: kit_1.Duration.seconds(0),
+    }) {
+        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)
+        if (/^1Fl.{15}$/.test(idOrAlias)) {
+            return connection.tooling.sobject('PackageBundle').delete(idOrAlias);
+        }
+        // Validate that project is provided when using aliases
+        if (!project) {
+            throw new core_1.SfError('Project instance is required when deleting package bundle by alias');
+        }
+        // eslint-disable-next-line no-param-reassign
+        idOrAlias = project.getPackageBundleIdFromAlias(idOrAlias) ?? idOrAlias;
+        return connection.tooling.sobject('PackageBundle').delete(idOrAlias);
+    }
+    /**
+     * Returns all the package bundles that are available in the org, up to 10,000. If more records are
+     * needed use the `SF_ORG_MAX_QUERY_LIMIT` env var.
+     *
+     * @param connection
+     */
+    static async list(connection) {
+        const query = `select ${BundleFields.join(', ')} from PackageBundle ORDER BY BundleName`;
+        return (await connection.autoFetchQuery(query, { tooling: true }))?.records;
+    }
+}
+exports.PackageBundle = PackageBundle;
+//# sourceMappingURL=packageBundle.js.map

package/lib/package/packageBundleCreate.d.ts

@@ -0,0 +1,7 @@
+import { Connection, SfProject } from '@salesforce/core';
+import { BundleEntry } from '@salesforce/schemas';
+import { BundleCreateOptions } from '../interfaces';
+export declare function createPackageDirEntry(project: SfProject, options: BundleCreateOptions): BundleEntry;
+export declare function createBundle(connection: Connection, project: SfProject, options: BundleCreateOptions): Promise<{
+    Id: string;
+}>;

package/lib/package/packageBundleCreate.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPackageDirEntry = createPackageDirEntry;
+exports.createBundle = createBundle;
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const core_1 = require("@salesforce/core");
+const bundleUtils_1 = require("../utils/bundleUtils");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'bundle_create');
+function createPackageDirEntry(project, options) {
+    return {
+        versionName: 'ver 0.1',
+        versionNumber: '0.1',
+        name: options.BundleName,
+        versionDescription: options.Description,
+    };
+}
+async function createBundle(connection, project, options) {
+    const request = { BundleName: options.BundleName, Description: options.Description };
+    let createResult;
+    try {
+        createResult = await connection.tooling.sobject('PackageBundle').create(request);
+    }
+    catch (err) {
+        const error = err instanceof Error
+            ? err
+            : new Error(typeof err === 'string' ? err : messages.getMessage('failedToCreatePackageBundle'));
+        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('failedToCreatePackageBundle'))));
+    }
+    const bundleEntry = createPackageDirEntry(project, options);
+    project.getSfProjectJson().addPackageBundle(bundleEntry);
+    project.getSfProjectJson().addPackageBundleAlias(bundleEntry.name, createResult.id);
+    await project.getSfProjectJson().write();
+    return { Id: createResult.id };
+}
+//# sourceMappingURL=packageBundleCreate.js.map

package/lib/package/packageBundleInstall.d.ts

@@ -0,0 +1,9 @@
+import { Connection, SfProject } from '@salesforce/core';
+import { BundleSObjects, BundleInstallOptions } from '../interfaces';
+export declare class PackageBundleInstall {
+    static getInstallStatus(installRequestId: string, connection: Connection): Promise<BundleSObjects.PkgBundleVersionInstallReqResult>;
+    static getInstallStatuses(connection: Connection, status?: BundleSObjects.PkgBundleVersionInstallReqStatus, createdLastDays?: number): Promise<BundleSObjects.PkgBundleVersionInstallReqResult[]>;
+    static installBundle(connection: Connection, project: SfProject, options: BundleInstallOptions): Promise<BundleSObjects.PkgBundleVersionInstallReqResult>;
+    private static parsePackageBundleVersionId;
+    private static pollInstallStatus;
+}