@salesforce/core 3.30.2 → 3.30.3

package/lib/sfProject.d.ts

@@ -1,4 +1,4 @@
-import { JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import { Dictionary, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
 import { ConfigFile } from './config/configFile';
 import { ConfigContents } from './config/configStore';
 export declare type PackageDirDependency = {
@@ -127,6 +127,30 @@ export declare class SfProjectJson extends ConfigFile {
      * Has multiple package directories (MPD) defined in the project.
      */
     hasMultiplePackages(): boolean;
+    /**
+     * Has at least one package alias defined in the project.
+     */
+    hasPackageAliases(): Promise<boolean>;
+    /**
+     * Get package aliases defined in the project.
+     */
+    getPackageAliases(): Nullable<Dictionary<string>>;
+    /**
+     * Add a package alias to the project.
+     * If the alias already exists, it will be overwritten.
+     *
+     * @param alias
+     * @param id
+     */
+    addPackageAlias(alias: string, id: string): void;
+    /**
+     * Add a package directory to the project.
+     * If the package directory already exists, the new directory
+     * properties will be merged with the existing properties.
+     *
+     * @param packageDir
+     */
+    addPackageDirectory(packageDir: PackageDir): void;
     private doesPackageExist;
     private validateKeys;
 }
@@ -148,6 +172,7 @@ export declare class SfProject {
     private sfProjectJsonGlobal;
     private packageDirectories?;
     private activePackage;
+    private packageAliases;
     /**
      * Do not directly construct instances of this class -- use {@link SfProject.resolve} instead.
      *
@@ -284,7 +309,7 @@ export declare class SfProject {
      * Set 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.
      *
-     * @param pkgName The package name to activate. E.g. 'force-app'
+     * @param packageName The package name to activate. E.g. 'force-app'
      */
     setActivePackage(packageName: Nullable<string>): void;
     /**
@@ -304,6 +329,15 @@ export declare class SfProject {
      * properties, including some 3rd party custom properties.
      */
     resolveProjectConfig(): Promise<JsonMap>;
+    hasPackageAliases(): Promise<boolean>;
+    /**
+     * Returns a read-only list of `packageDirectories` within sfdx-project.json, first reading
+     * and validating the file if necessary. i.e. modifying this array will not affect the
+     * sfdx-project.json file.
+     */
+    getPackageAliases(): Nullable<Dictionary<string>>;
+    getPackageIdFromAlias(alias: string): Optional<string>;
+    getAliasesFromPackageId(id: string): string[];
 }
 /**
  * @deprecated use SfProject instead

package/lib/sfProject.js

@@ -27,6 +27,7 @@ const messages = messages_1.Messages.load('@salesforce/core', 'config', [
     'multipleDefaultPaths',
     'invalidPackageDirectory',
     'missingPackageDirectory',
+    'invalidId',
 ]);
 const coreMessages = messages_1.Messages.load('@salesforce/core', 'core', ['invalidJsonCasing']);
 /**
@@ -241,13 +242,63 @@ class SfProjectJson extends configFile_1.ConfigFile {
      * Has package directories defined in the project.
      */
     hasPackages() {
-        return this.getContents().packageDirectories && this.getContents().packageDirectories.length > 0;
+        return this.getContents()?.packageDirectories?.length > 0;
     }
     /**
      * Has multiple package directories (MPD) defined in the project.
      */
     hasMultiplePackages() {
-        return this.getContents().packageDirectories && this.getContents().packageDirectories.length > 1;
+        return this.getContents()?.packageDirectories?.length > 1;
+    }
+    /**
+     * Has at least one package alias defined in the project.
+     */
+    async hasPackageAliases() {
+        return Object.keys(this.getContents().packageAliases || {}).length > 0;
+    }
+    /**
+     * Get package aliases defined in the project.
+     */
+    getPackageAliases() {
+        return this.getContents().packageAliases;
+    }
+    /**
+     * Add a package alias to the project.
+     * If the alias already exists, it will be overwritten.
+     *
+     * @param alias
+     * @param id
+     */
+    addPackageAlias(alias, id) {
+        // TODO: validate id (e.g. 04t, 0Ho)
+        if (!/^.{15,18}$/.test(id)) {
+            throw messages.createError('invalidId', [id]);
+        }
+        const contents = this.getContents();
+        if (!contents.packageAliases) {
+            contents.packageAliases = {};
+        }
+        contents.packageAliases[alias] = id;
+        this.setContents(contents);
+    }
+    /**
+     * Add a package directory to the project.
+     * If the package directory already exists, the new directory
+     * properties will be merged with the existing properties.
+     *
+     * @param packageDir
+     */
+    addPackageDirectory(packageDir) {
+        const dirIndex = this.getContents().packageDirectories.findIndex((pkgDir) => {
+            return pkgDir.package === packageDir.package;
+        });
+        const packageDirEntry = Object.assign({}, dirIndex > -1 ? this.getContents().packageDirectories[dirIndex] : packageDir, packageDir);
+        if (dirIndex > -1) {
+            this.getContents().packageDirectories[dirIndex] = packageDirEntry;
+        }
+        else {
+            this.getContents().packageDirectories.push(packageDirEntry);
+        }
     }
     doesPackageExist(packagePath) {
         return fs.existsSync(packagePath);
@@ -492,7 +543,7 @@ class SfProject {
      * Set 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.
      *
-     * @param pkgName The package name to activate. E.g. 'force-app'
+     * @param packageName The package name to activate. E.g. 'force-app'
      */
     setActivePackage(packageName) {
         if (packageName == null) {
@@ -551,6 +602,32 @@ class SfProject {
         }
         return this.projectConfig;
     }
+    async hasPackageAliases() {
+        return this.getSfProjectJson().hasPackageAliases();
+    }
+    /**
+     * Returns a read-only list of `packageDirectories` within sfdx-project.json, first reading
+     * and validating the file if necessary. i.e. modifying this array will not affect the
+     * sfdx-project.json file.
+     */
+    getPackageAliases() {
+        if (!this.packageAliases) {
+            this.packageAliases = this.getSfProjectJson().getPackageAliases();
+        }
+        return this.packageAliases;
+    }
+    getPackageIdFromAlias(alias) {
+        const packageAliases = this.getPackageAliases();
+        return packageAliases ? packageAliases[alias] : undefined;
+    }
+    getAliasesFromPackageId(id) {
+        if (!/^.{15,18}$/.test(id)) {
+            throw messages.createError('invalidId', [id]);
+        }
+        return Object.entries(this.getPackageAliases() ?? {})
+            .filter(([, value]) => value?.startsWith(id))
+            .map(([key]) => key);
+    }
 }
 exports.SfProject = SfProject;
 // Cache of SfProject instances per path.

package/messages/config.md

@@ -150,3 +150,7 @@ A valid repository URL or directory for the custom org metadata templates.
 # org-custom-metadata-templates
 
 A valid repository URL or directory for the custom org metadata templates.
+
+# invalidId
+
+The given id %s is not a valid 15 or 18 character Salesforce ID.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.30.2",
+  "version": "3.30.3",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -96,4 +96,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}