@salesforce/core 8.22.0 → 8.23.0

package/lib/sfProject.d.ts

@@ -1,5 +1,5 @@
 import { Dictionary, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
-import { PackageDir, ProjectJson as ProjectJsonSchema, PackagePackageDir } from '@salesforce/schemas';
+import { PackageDir, ProjectJson as ProjectJsonSchema, PackagePackageDir, BundleEntry } from '@salesforce/schemas';
 import { ConfigFile } from './config/configFile';
 import { ConfigContents } from './config/configStackTypes';
 type NameAndFullPath = {
@@ -14,6 +14,7 @@ type NameAndFullPath = {
 };
 export type NamedPackagingDir = PackagePackageDir & NameAndFullPath;
 export type NamedPackageDir = PackageDir & NameAndFullPath;
+export type { BundleEntry };
 export type ProjectJson = ConfigContents & ProjectJsonSchema;
 /**
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
@@ -104,6 +105,10 @@ export declare class SfProjectJson extends ConfigFile<ConfigFile.Options, Projec
      * Has multiple package directories (MPD) defined in the project.
      */
     hasMultiplePackages(): boolean;
+    /**
+     * Has multiple package bundles defined in the project.
+     */
+    hasMultiplePackageBundles(): boolean;
     /**
      * Has at least one package alias defined in the project.
      */
@@ -128,6 +133,34 @@ export declare class SfProjectJson extends ConfigFile<ConfigFile.Options, Projec
      * @param packageDir
      */
     addPackageDirectory(packageDir: PackageDir): void;
+    /**
+     * Get package bundles defined in the project.
+     */
+    getPackageBundles(): BundleEntry[];
+    /**
+     * Add a bundle entry to the project.
+     * If the bundle entry already exists, the new entry
+     * properties will be merged with the existing properties.
+     *
+     * @param bundleEntry
+     */
+    addPackageBundle(bundleEntry: BundleEntry): void;
+    /**
+     * Has at least one package bundle alias defined in the project.
+     */
+    hasPackageBundleAliases(): boolean;
+    /**
+     * Get package bundle aliases defined in the project.
+     */
+    getPackageBundleAliases(): Nullable<Dictionary<string>>;
+    /**
+     * Add a bundle alias to the project.
+     * If the bundle alias already exists, it will be overwritten.
+     *
+     * @param alias The alias name
+     * @param id The bundle ID
+     */
+    addPackageBundleAlias(alias: string, id: string): void;
     private doesPackageExist;
     private validateKeys;
 }
@@ -150,6 +183,7 @@ export declare class SfProject {
     private packageDirectories?;
     private activePackage;
     private packageAliases;
+    private packageBundleAliases;
     /**
      * Do not directly construct instances of this class -- use {@link SfProject.resolve} instead.
      *
@@ -292,6 +326,10 @@ export declare class SfProject {
      * Has multiple package directories (MPD) defined in the project.
      */
     hasMultiplePackages(): boolean;
+    /**
+     * Has multiple package bundles defined in the project.
+     */
+    hasMultiplePackageBundles(): boolean;
     /**
      * Get the currently activated package on the project. This has no implication on sfdx-project.json
      * but is useful for keeping track of package and source specific options in a process.
@@ -330,6 +368,9 @@ export declare class SfProject {
     getPackageAliases(): Nullable<Dictionary<string>>;
     getPackageIdFromAlias(alias: string): Optional<string>;
     getAliasesFromPackageId(id: string): string[];
+    getPackageBundleAliases(): Nullable<Dictionary<string>>;
+    getPackageBundleIdFromAlias(alias: string): Optional<string>;
+    getAliasesFromPackageBundleId(id: string): string[];
     /**
      * retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName
      *
@@ -359,4 +400,3 @@ export declare class SfProject {
 export declare const isPackagingDirectory: (packageDir: PackageDir) => packageDir is PackagePackageDir;
 /** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */
 export declare const isNamedPackagingDirectory: (packageDir: NamedPackageDir) => packageDir is NamedPackagingDir;
-export {};

package/lib/sfProject.js

@@ -47,7 +47,7 @@ const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([
  */
 class SfProjectJson extends configFile_1.ConfigFile {
     /** json properties that are uppercase, or allow uppercase keys inside them */
-    static BLOCKLIST = ['packageAliases', 'plugins'];
+    static BLOCKLIST = ['packageAliases', 'plugins', 'packageBundleAliases'];
     static getFileName() {
         return internal_1.SFDX_PROJECT_JSON;
     }
@@ -235,10 +235,16 @@ class SfProjectJson extends configFile_1.ConfigFile {
     hasMultiplePackages() {
         return this.getContents()?.packageDirectories?.length > 1;
     }
+    /**
+     * Has multiple package bundles defined in the project.
+     */
+    hasMultiplePackageBundles() {
+        return (this.getContents()?.packageBundles?.length ?? 0) > 1;
+    }
     /**
      * Has at least one package alias defined in the project.
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/require-await
+    // eslint-disable-next-line @typescript-eslint/require-await
     async hasPackageAliases() {
         return Object.keys(this.getContents().packageAliases ?? {}).length > 0;
     }
@@ -281,6 +287,54 @@ class SfProjectJson extends configFile_1.ConfigFile {
                 [...(this.getContents()?.packageDirectories ?? []), packageDirEntry];
         this.set('packageDirectories', modifiedPackagesDirs);
     }
+    /**
+     * Get package bundles defined in the project.
+     */
+    getPackageBundles() {
+        return this.get('packageBundles') ?? [];
+    }
+    /**
+     * Add a bundle entry to the project.
+     * If the bundle entry already exists, the new entry
+     * properties will be merged with the existing properties.
+     *
+     * @param bundleEntry
+     */
+    addPackageBundle(bundleEntry) {
+        const bundles = this.getPackageBundles();
+        const bundleIndex = bundles.findIndex((b) => b.name === bundleEntry.name);
+        const bundleEntryJson = {
+            ...(bundleIndex > -1 ? bundles[bundleIndex] : bundleEntry),
+            ...bundleEntry,
+        };
+        const modifiedBundles = bundleIndex > -1
+            ? bundles.map((b) => (b.name === bundleEntry.name ? bundleEntryJson : b))
+            : [...bundles, bundleEntryJson];
+        this.set('packageBundles', modifiedBundles);
+    }
+    /**
+     * Has at least one package bundle alias defined in the project.
+     */
+    hasPackageBundleAliases() {
+        return Object.keys(this.getContents().packageBundleAliases ?? {}).length > 0;
+    }
+    /**
+     * Get package bundle aliases defined in the project.
+     */
+    getPackageBundleAliases() {
+        return this.get('packageBundleAliases');
+    }
+    /**
+     * Add a bundle alias to the project.
+     * If the bundle alias already exists, it will be overwritten.
+     *
+     * @param alias The alias name
+     * @param id The bundle ID
+     */
+    addPackageBundleAlias(alias, id) {
+        const newAliases = { ...(this.get('packageBundleAliases') ?? {}), [alias]: id };
+        this.set('packageBundleAliases', newAliases);
+    }
     // keep it because testSetup stubs it!
     // eslint-disable-next-line class-methods-use-this
     doesPackageExist(packagePath) {
@@ -313,6 +367,7 @@ class SfProject {
     packageDirectories;
     activePackage;
     packageAliases;
+    packageBundleAliases;
     /**
      * Do not directly construct instances of this class -- use {@link SfProject.resolve} instead.
      *
@@ -548,6 +603,12 @@ class SfProject {
     hasMultiplePackages() {
         return this.getSfProjectJson().hasMultiplePackages();
     }
+    /**
+     * Has multiple package bundles defined in the project.
+     */
+    hasMultiplePackageBundles() {
+        return this.getSfProjectJson().hasMultiplePackageBundles();
+    }
     /**
      * Get the currently activated package on the project. This has no implication on sfdx-project.json
      * but is useful for keeping track of package and source specific options in a process.
@@ -651,6 +712,24 @@ class SfProject {
             .filter(([, value]) => value?.startsWith(id))
             .map(([key]) => key);
     }
+    getPackageBundleAliases() {
+        if (!this.packageBundleAliases) {
+            this.packageBundleAliases = this.getSfProjectJson().getPackageBundleAliases();
+        }
+        return this.packageBundleAliases;
+    }
+    getPackageBundleIdFromAlias(alias) {
+        const packageBundleAliases = this.getPackageBundleAliases();
+        return packageBundleAliases ? packageBundleAliases[alias] : undefined;
+    }
+    getAliasesFromPackageBundleId(id) {
+        if (!/^.{15,18}$/.test(id)) {
+            throw messages.createError('invalidId', [id]);
+        }
+        return Object.entries(this.getPackageBundleAliases() ?? {})
+            .filter(([, value]) => value?.startsWith(id))
+            .map(([key]) => key);
+    }
     /**
      * retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.22.0",
+  "version": "8.23.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -57,7 +57,7 @@
   "dependencies": {
     "@jsforce/jsforce-node": "^3.10.4",
     "@salesforce/kit": "^3.2.2",
-    "@salesforce/schemas": "^1.9.1",
+    "@salesforce/schemas": "^1.10.0",
     "@salesforce/ts-types": "^2.0.11",
     "ajv": "^8.17.1",
     "change-case": "^4.1.2",
@@ -77,7 +77,7 @@
   },
   "devDependencies": {
     "@salesforce/dev-scripts": "^10.1.1",
-    "@salesforce/ts-sinon": "^1.4.30",
+    "@salesforce/ts-sinon": "^1.4.31",
     "@types/benchmark": "^2.1.5",
     "@types/fast-levenshtein": "^0.0.4",
     "@types/jsonwebtoken": "9.0.9",