@salesforce/core 3.30.1 → 3.30.3

package/lib/config/envVars.d.ts

@@ -25,6 +25,7 @@ export declare enum EnvironmentVariable {
     'SFDX_IMPROVED_CODE_COVERAGE' = "SFDX_IMPROVED_CODE_COVERAGE",
     'SFDX_INSTANCE_URL' = "SFDX_INSTANCE_URL",
     'SFDX_JSON_TO_STDOUT' = "SFDX_JSON_TO_STDOUT",
+    'SFDX_DISABLE_LOG_FILE' = "SFDX_DISABLE_LOG_FILE",
     'SFDX_LOG_LEVEL' = "SFDX_LOG_LEVEL",
     'SFDX_LOG_ROTATION_COUNT' = "SFDX_LOG_ROTATION_COUNT",
     'SFDX_LOG_ROTATION_PERIOD' = "SFDX_LOG_ROTATION_PERIOD",
@@ -59,6 +60,7 @@ export declare enum EnvironmentVariable {
     'SF_IMPROVED_CODE_COVERAGE' = "SF_IMPROVED_CODE_COVERAGE",
     'SF_ORG_INSTANCE_URL' = "SF_ORG_INSTANCE_URL",
     'SF_JSON_TO_STDOUT' = "SF_JSON_TO_STDOUT",
+    'SF_DISABLE_LOG_FILE' = "SF_DISABLE_LOG_FILE",
     'SF_LOG_LEVEL' = "SF_LOG_LEVEL",
     'SF_LOG_ROTATION_COUNT' = "SF_LOG_ROTATION_COUNT",
     'SF_LOG_ROTATION_PERIOD' = "SF_LOG_ROTATION_PERIOD",

package/lib/config/envVars.js

@@ -39,6 +39,7 @@ var EnvironmentVariable;
     EnvironmentVariable["SFDX_IMPROVED_CODE_COVERAGE"] = "SFDX_IMPROVED_CODE_COVERAGE";
     EnvironmentVariable["SFDX_INSTANCE_URL"] = "SFDX_INSTANCE_URL";
     EnvironmentVariable["SFDX_JSON_TO_STDOUT"] = "SFDX_JSON_TO_STDOUT";
+    EnvironmentVariable["SFDX_DISABLE_LOG_FILE"] = "SFDX_DISABLE_LOG_FILE";
     EnvironmentVariable["SFDX_LOG_LEVEL"] = "SFDX_LOG_LEVEL";
     EnvironmentVariable["SFDX_LOG_ROTATION_COUNT"] = "SFDX_LOG_ROTATION_COUNT";
     EnvironmentVariable["SFDX_LOG_ROTATION_PERIOD"] = "SFDX_LOG_ROTATION_PERIOD";
@@ -73,6 +74,7 @@ var EnvironmentVariable;
     EnvironmentVariable["SF_IMPROVED_CODE_COVERAGE"] = "SF_IMPROVED_CODE_COVERAGE";
     EnvironmentVariable["SF_ORG_INSTANCE_URL"] = "SF_ORG_INSTANCE_URL";
     EnvironmentVariable["SF_JSON_TO_STDOUT"] = "SF_JSON_TO_STDOUT";
+    EnvironmentVariable["SF_DISABLE_LOG_FILE"] = "SF_DISABLE_LOG_FILE";
     EnvironmentVariable["SF_LOG_LEVEL"] = "SF_LOG_LEVEL";
     EnvironmentVariable["SF_LOG_ROTATION_COUNT"] = "SF_LOG_ROTATION_COUNT";
     EnvironmentVariable["SF_LOG_ROTATION_PERIOD"] = "SF_LOG_ROTATION_PERIOD";
@@ -186,6 +188,10 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SFDX_JSON_TO_STDOUT),
         synonymOf: EnvironmentVariable.SF_JSON_TO_STDOUT,
     },
+    [EnvironmentVariable.SFDX_DISABLE_LOG_FILE]: {
+        description: getMessage(EnvironmentVariable.SFDX_DISABLE_LOG_FILE),
+        synonymOf: EnvironmentVariable.SF_DISABLE_LOG_FILE,
+    },
     [EnvironmentVariable.SFDX_LOG_LEVEL]: {
         description: getMessage(EnvironmentVariable.SFDX_LOG_LEVEL),
         synonymOf: EnvironmentVariable.SF_LOG_LEVEL,
@@ -323,6 +329,10 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SF_JSON_TO_STDOUT),
         synonymOf: null,
     },
+    [EnvironmentVariable.SF_DISABLE_LOG_FILE]: {
+        description: getMessage(EnvironmentVariable.SF_DISABLE_LOG_FILE),
+        synonymOf: EnvironmentVariable.SFDX_DISABLE_LOG_FILE,
+    },
     [EnvironmentVariable.SF_LOG_LEVEL]: {
         description: getMessage(EnvironmentVariable.SF_LOG_LEVEL),
         synonymOf: null,

package/lib/logger.js

@@ -155,7 +155,8 @@ class Logger {
         }
         const rootLogger = (this.rootLogger = new Logger(Logger.ROOT_NAME).setLevel());
         // disable log file writing, if applicable
-        if (process.env.SFDX_DISABLE_LOG_FILE !== 'true' && global_1.Global.getEnvironmentMode() !== global_1.Mode.TEST) {
+        const disableLogFile = new kit_1.Env().getString('SF_DISABLE_LOG_FILE');
+        if (disableLogFile !== 'true' && global_1.Global.getEnvironmentMode() !== global_1.Mode.TEST) {
             await rootLogger.addLogFileStream(global_1.Global.LOG_FILE_PATH);
         }
         rootLogger.enableDEBUG();
@@ -353,7 +354,8 @@ class Logger {
      */
     setLevel(level) {
         if (level == null) {
-            level = process.env.SFDX_LOG_LEVEL ? Logger.getLevelByName(process.env.SFDX_LOG_LEVEL) : Logger.DEFAULT_LEVEL;
+            const logLevelFromEnvVar = new kit_1.Env().getString('SF_LOG_LEVEL');
+            level = logLevelFromEnvVar ? Logger.getLevelByName(logLevelFromEnvVar) : Logger.DEFAULT_LEVEL;
         }
         this.bunyan.level(level);
         return this;

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/messages/envVars.md

@@ -90,6 +90,10 @@ URL of the Salesforce instance that is hosting your org. Default value is https:
 
 Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr.
 
+# sfdxDisableLogFile
+
+Set to true to disable log file writing
+
 # sfdxLogLevel
 
 Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
@@ -226,6 +230,10 @@ URL of the Salesforce instance that is hosting your org. Default value is https:
 
 Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr.
 
+# sfDisableLogFile
+
+Set to true to disable log file writing
+
 # sfLogLevel
 
 Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.30.1",
+  "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"
   }
-}
+}