@salesforce/core 4.0.0 → 4.1.0

package/lib/config/configAggregator.js

@@ -9,20 +9,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigAggregator = void 0;
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
-const change_case_1 = require("change-case");
 const messages_1 = require("../messages");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 const envVars_1 = require("./envVars");
 const config_1 = require("./config");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'config', ['unknownConfigKey', 'deprecatedConfigKey']);
-const propertyToEnvName = (property, prefix = 'SFDX_') => `${prefix || ''}${(0, change_case_1.snakeCase)(property).toUpperCase()}`;
+const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([["unknownConfigKey", "Unknown config name: %s."], ["deprecatedConfigKey", "Deprecated config name: %s. Please use %s instead."], ["invalidWrite", "The writeSync method is not allowed on SfdxConfig. Use the async write method instead."], ["invalidConfigValue", "Invalid config value: %s."], ["invalidInstanceUrl", "Specify a valid Salesforce instance URL."], ["invalidApiVersion", "Specify a valid Salesforce API version, for example, 42.0."], ["invalidCustomOrgMetadataTemplates", "Specify a valid repository URL or directory for the custom org metadata templates."], ["invalidIsvDebuggerSid", "Specify a valid Debugger SID."], ["invalidIsvDebuggerUrl", "Specify a valid Debugger URL."], ["invalidNumberConfigValue", "Specify a valid positive integer, for example, 150000."], ["invalidBooleanConfigValue", "The config value can only be set to true or false."], ["invalidProjectWorkspace", "This directory does not contain a valid Salesforce DX project."], ["schemaValidationError", "The config file \"%s\" is not schema valid.\nDue to: %s"], ["schemaValidationError.actions", ["Fix the invalid entries at %s."]], ["missingDefaultPath", "In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: `[{ \"path\": \"packageDirectory1\", \"default\": true }, { \"path\": \"packageDirectory2\" }]`"], ["missingPackageDirectory", "The path \"%s\", specified in sfdx-project.json, does not exist. Be sure this directory is included in your project root."], ["invalidPackageDirectory", "The path \"%s\", specified in sfdx-project.json, must be indicated as a relative path to the project root."], ["multipleDefaultPaths", "In sfdx-project.json, indicate only one package directory (path) as the default."], ["singleNonDefaultPackage", "The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `\"default\": false` key and try again."], ["target-org", "Username or alias of the org that all commands run against by default. (sf only)"], ["target-dev-hub", "Username or alias of your default Dev Hub org. (sf only)"], ["defaultUsername", "Username or alias of the org that all commands run against by default. (sfdx only)"], ["defaultDevHubUsername", "Username or alias of your default Dev Hub org. (sfdx only)"], ["isvDebuggerSid", "ISV debugger SID (sfdx only)"], ["isvDebuggerUrl", "ISV debugger URL (sfdx only)"], ["org-isv-debugger-sid", "ISV debugger SID."], ["org-isv-debugger-url", "ISV debugger URL."], ["apiVersion", "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"], ["org-api-version", "API version of your project. Default: API version of your Dev Hub org."], ["disableTelemetry", "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"], ["disable-telemetry", "Disables the collection of usage and user environment information, etc. Default: false."], ["maxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"], ["org-max-query-limit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."], ["restDeploy", "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"], ["instanceUrl", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"], ["org-instance-url", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."], ["customOrgMetadataTemplates", "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."]]));
 /**
  * Aggregate global and local project config files, as well as environment variables for
- * `sfdx-config.json`. The resolution happens in the following bottom-up order:
+ * `config.json`. The resolution happens in the following bottom-up order:
  *
- * 1. Environment variables  (`SFDX_LOG_LEVEL`)
- * 1. Workspace settings  (`<workspace-root>/.sfdx/sfdx-config.json`)
- * 1. Global settings  (`$HOME/.sfdx/sfdx-config.json`)
+ * 1. Environment variables  (`SF_LOG_LEVEL`)
+ * 1. Workspace settings  (`<workspace-root>/.sf/config.json`)
+ * 1. Global settings  (`$HOME/.sf/config.json`)
  *
  * Use {@link ConfigAggregator.create} to instantiate the aggregator.
  *
@@ -38,7 +36,8 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * @ignore
      */
     constructor(options) {
-        super(options || {});
+        super(options ?? {});
+        this.envVars = {};
         // Don't throw an project error with the aggregator, since it should resolve to global if
         // there is no project.
         try {
@@ -53,21 +52,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         this.setAllowedProperties(config_1.Config.getAllowedProperties());
     }
     get config() {
-        return this.resolveProperties(this.globalConfig.getContents(), this.localConfig && this.localConfig.getContents());
-    }
-    /**
-     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
-     * the **encrypted** config values. Encrypted config values need to be resolved
-     * asynchronously by calling {@link ConfigAggregator.reload}
-     */
-    // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
-    // We really don't want ConfigAggregator extended but typescript doesn't support a final.
-    static getInstance() {
-        if (!ConfigAggregator.instance) {
-            ConfigAggregator.instance = new this();
-            ConfigAggregator.instance.loadPropertiesSync();
-        }
-        return ConfigAggregator.instance;
+        return this.resolveProperties(this.globalConfig.getContents(), this.localConfig?.getContents());
     }
     // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
     // We really don't want ConfigAggregator extended but typescript doesn't support a final.
@@ -80,6 +65,9 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         if (ConfigAggregator.encrypted) {
             await config.loadProperties();
         }
+        if (options?.customConfigMeta) {
+            config_1.Config.addAllowedProperties(options.customConfigMeta);
+        }
         return ConfigAggregator.instance;
     }
     /**
@@ -91,6 +79,20 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     static getValue(key) {
         return this.getInstance().getInfo(key);
     }
+    /**
+     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
+     * the **encrypted** config values. Encrypted config values need to be resolved
+     * asynchronously by calling {@link ConfigAggregator.reload}
+     */
+    // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
+    // We really don't want ConfigAggregator extended but typescript doesn't support a final.
+    static getInstance() {
+        if (!ConfigAggregator.instance) {
+            ConfigAggregator.instance = new this();
+            ConfigAggregator.instance.loadPropertiesSync();
+        }
+        return ConfigAggregator.instance;
+    }
     /**
      * Initialize this instances async dependencies.
      */
@@ -99,13 +101,22 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Get a resolved config property.
+     * If you use a deprecated property, a warning will be emitted and it will attempt to resolve the new property's value
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
      *
      * @param key The key of the property.
      */
     getPropertyValue(key) {
-        if (this.getAllowedProperties().some((element) => key === element.key)) {
+        const match = this.getAllowedProperties().find((element) => key === element.key);
+        if (match?.deprecated && match.newKey) {
+            void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('deprecatedConfigKey', [key, match.newKey]));
+            const newKeyMatch = this.getAllowedProperties().find((element) => match.newKey === element.key);
+            if (newKeyMatch) {
+                return this.getConfig()[newKeyMatch.key] ?? this.getConfig()[match.key];
+            }
+        }
+        if (this.getAllowedProperties().some((element) => key === element.key || key === element.newKey)) {
             return this.getConfig()[key];
         }
         else {
@@ -114,42 +125,55 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Get a resolved config property meta.
+     * If the property is deprecated, it will return the new key's meta, if it exists, with a deprecation warning
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
      *
      * @param key The key of the property.
      */
     getPropertyMeta(key) {
         const match = this.getAllowedProperties().find((element) => key === element.key);
         if (match) {
+            if (match.deprecated && match.newKey) {
+                void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('deprecatedConfigKey', [key, match.newKey]));
+                const newKeyMatch = this.getAllowedProperties().find((element) => key === element.newKey);
+                if (newKeyMatch) {
+                    return newKeyMatch ?? match;
+                }
+            }
             return match;
         }
-        else {
-            throw messages.createError('unknownConfigKey', [key]);
+        const matchFromNewKey = this.getAllowedProperties().find((element) => key === element.newKey);
+        if (matchFromNewKey) {
+            return matchFromNewKey;
         }
+        throw messages.createError('unknownConfigKey', [key]);
     }
     /**
      * Get a resolved config property.
+     * If a property is deprecated, it will try to use the the new key, if there is a config there.
      *
      * @param key The key of the property.
      * @param throwOnDeprecation True, if you want an error throw when reading a deprecated config
      */
     getInfo(key, throwOnDeprecation = false) {
-        var _a;
         const meta = this.getPropertyMeta(key);
-        if (throwOnDeprecation && meta.deprecated && meta.newKey) {
-            throw messages.createError('deprecatedConfigKey', [key, meta.newKey]);
+        if (meta.deprecated && meta.newKey) {
+            if (throwOnDeprecation) {
+                throw messages.createError('deprecatedConfigKey', [key, meta.newKey]);
+            }
+            // we don't need to emit a deprecatedConfigKey warning here because getPropertyMeta does that
         }
-        const location = this.getLocation(key);
+        const location = meta.newKey ? this.getLocation(meta.newKey) : this.getLocation(key);
         return {
-            key,
+            key: meta.newKey ?? key,
             location,
-            value: this.getPropertyValue(key),
-            path: this.getPath(key),
-            isLocal: () => location === "Local" /* LOCAL */,
-            isGlobal: () => location === "Global" /* GLOBAL */,
-            isEnvVar: () => location === "Environment" /* ENVIRONMENT */,
-            deprecated: (_a = meta.deprecated) !== null && _a !== void 0 ? _a : false,
+            value: this.getPropertyValue(meta.newKey ?? key),
+            path: this.getPath(meta.newKey ?? key),
+            isLocal: () => location === "Local" /* ConfigAggregator.Location.LOCAL */,
+            isGlobal: () => location === "Global" /* ConfigAggregator.Location.GLOBAL */,
+            isEnvVar: () => location === "Environment" /* ConfigAggregator.Location.ENVIRONMENT */,
+            deprecated: meta.deprecated ?? false,
         };
     }
     /**
@@ -163,23 +187,24 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * @param key The key of the property.
      */
     getLocation(key) {
-        if (this.getEnvVars().get(key) != null) {
-            return "Environment" /* ENVIRONMENT */;
+        // envs populate old and new automatically
+        if (this.envVars[key] != null) {
+            return "Environment" /* ConfigAggregator.Location.ENVIRONMENT */;
         }
-        if (this.localConfig && this.localConfig.get(key)) {
-            return "Local" /* LOCAL */;
+        if (this.localConfig?.get(key)) {
+            return "Local" /* ConfigAggregator.Location.LOCAL */;
         }
-        if (this.globalConfig && this.globalConfig.get(key)) {
-            return "Global" /* GLOBAL */;
+        if (this.globalConfig?.get(key)) {
+            return "Global" /* ConfigAggregator.Location.GLOBAL */;
         }
     }
     /**
      * Get a resolved file path or environment variable name of the property.
      *
      * For example, `getPath('logLevel')` will return:
-     * 1. `$SFDX_LOG_LEVEL` if resolved to an environment variable.
-     * 1. `./.sfdx/sfdx-config.json` if resolved to the local config.
-     * 1. `~/.sfdx/sfdx-config.json` if resolved to the global config.
+     * 1. `$SF_LOG_LEVEL` if resolved to an environment variable.
+     * 1. `./.sf/config.json` if resolved to the local config.
+     * 1. `~/.sf/config.json` if resolved to the global config.
      * 1. `undefined`, if not resolved.
      *
      * **Note:** that the path returned may be the absolute path instead of
@@ -188,10 +213,11 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * @param key The key of the property.
      */
     getPath(key) {
-        if (this.envVars.getString(key) != null) {
-            return `$${propertyToEnvName(key)}`;
+        // TODO: make EnvVars always prefer the "new" regardless of CLI
+        if (this.envVars[key] != null) {
+            return `$${envVars_1.EnvVars.propertyToEnvName(key)}`;
         }
-        if (this.localConfig && this.localConfig.getContents()[key] != null) {
+        if (this.localConfig?.getContents()[key] != null) {
             return this.localConfig.getPath();
         }
         if (this.globalConfig.getContents()[key] != null) {
@@ -204,14 +230,14 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * ```
      * > console.log(aggregator.getConfigInfo());
      * [
-     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SFDX_LOG_LEVEL'}
+     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SF_LOG_LEVEL'}
      *     { key: 'target-org', val: '<username>', location: 'Local', path: './.sf/config.json'}
      * ]
      * ```
      */
     getConfigInfo() {
         const infos = Object.keys(this.getConfig())
-            .filter((key) => this.getAllowedProperties().some((element) => key === element.key))
+            .filter((key) => this.getAllowedProperties().some((element) => key === element.key || key === element.newKey))
             .map((key) => this.getInfo(key))
             .filter((info) => !!info);
         return (0, kit_1.sortBy)(infos, 'key');
@@ -238,7 +264,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * Get the config properties that are environment variables.
      */
     getEnvVars() {
-        return this.envVars.asMap();
+        return this.envVars;
     }
     /**
      * Re-read all property configurations from disk.
@@ -258,6 +284,20 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
             this.allowedProperties.push(configMetas);
         }
     }
+    /**
+     * Set the allowed properties.
+     *
+     * @param properties The properties to set.
+     */
+    setAllowedProperties(properties) {
+        this.allowedProperties = properties;
+    }
+    /**
+     * Get the allowed properties.
+     */
+    getAllowedProperties() {
+        return this.allowedProperties;
+    }
     /**
      * Loads all the properties and aggregates them according to location.
      */
@@ -269,12 +309,15 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * Loads all the properties and aggregates them according to location.
      */
     loadPropertiesSync() {
-        this.resolveProperties(this.globalConfig.readSync(), this.localConfig && this.localConfig.readSync());
+        this.resolveProperties(this.globalConfig.readSync(), this.localConfig?.readSync());
     }
     resolveProperties(globalConfig, localConfig) {
-        this.envVars = new envVars_1.EnvVars();
+        const envVars = new envVars_1.EnvVars();
         for (const property of this.getAllowedProperties()) {
-            this.envVars.setPropertyFromEnv(property.key);
+            const key = property.newKey ? property.newKey : property.key;
+            const value = envVars.getPropertyFromEnv(property.key);
+            if (value)
+                this.envVars[key] = value;
         }
         // Global config must be read first so it is on the left hand of the
         // object assign and is overwritten by the local config.
@@ -283,25 +326,11 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         if (localConfig) {
             configs.push(localConfig);
         }
-        configs.push(this.envVars.asDictionary());
+        configs.push(this.envVars);
         const json = {};
         const reduced = configs.filter(ts_types_1.isJsonMap).reduce((acc, el) => (0, kit_1.merge)(acc, el), json);
         return reduced;
     }
-    /**
-     * Get the allowed properties.
-     */
-    getAllowedProperties() {
-        return this.allowedProperties;
-    }
-    /**
-     * Set the allowed properties.
-     *
-     * @param properties The properties to set.
-     */
-    setAllowedProperties(properties) {
-        this.allowedProperties = properties;
-    }
 }
 exports.ConfigAggregator = ConfigAggregator;
 ConfigAggregator.encrypted = true;

package/lib/config/configFile.d.ts

@@ -78,7 +78,7 @@ export declare class ConfigFile<T extends ConfigFile.Options = ConfigFile.Option
      * Read the config file and set the config contents. Returns the config contents of the config file. As an
      * optimization, files are only read once per process and updated in memory and via `write()`. To force
      * a read from the filesystem pass `force=true`.
-     * **Throws** *{@link SfdxError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
+     * **Throws** *{@link SfError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
      *
      * @param [throwOnNotFound = false] Optionally indicate if a throw should occur on file read.
      * @param [force = false] Optionally force the file to be read from disk even when already read within the process.
@@ -88,7 +88,7 @@ export declare class ConfigFile<T extends ConfigFile.Options = ConfigFile.Option
      * Read the config file and set the config contents. Returns the config contents of the config file. As an
      * optimization, files are only read once per process and updated in memory and via `write()`. To force
      * a read from the filesystem pass `force=true`.
-     * **Throws** *{@link SfdxError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
+     * **Throws** *{@link SfError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
      *
      * @param [throwOnNotFound = false] Optionally indicate if a throw should occur on file read.
      * @param [force = false] Optionally force the file to be read from disk even when already read within the process.

package/lib/config/configFile.js

@@ -7,14 +7,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigFile = void 0;
+const fs = require("fs");
 const fs_1 = require("fs");
 const os_1 = require("os");
 const path_1 = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
+const kit_1 = require("@salesforce/kit");
 const global_1 = require("../global");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
-const fs_2 = require("../util/fs");
+const sfError_1 = require("../sfError");
 const internal_1 = require("../util/internal");
 const configStore_1 = require("./configStore");
 /**
@@ -65,7 +66,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      */
     static getFileName() {
         // Can not have abstract static methods, so throw a runtime error.
-        throw new sfdxError_1.SfdxError('Unknown filename for config file.');
+        throw new sfError_1.SfError('Unknown filename for config file.');
     }
     /**
      * Returns the default options for the config file.
@@ -77,8 +78,8 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         return {
             isGlobal,
             isState: true,
-            filename: filename || this.getFileName(),
-            stateFolder: global_1.Global.SF_STATE_FOLDER,
+            filename: filename ?? this.getFileName(),
+            stateFolder: global_1.Global.SFDX_STATE_FOLDER,
         };
     }
     /**
@@ -87,7 +88,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * @param isGlobal True if the config should be global. False for local.
      */
     static async resolveRootFolder(isGlobal) {
-        return isGlobal ? (0, os_1.homedir)() : await (0, internal_1.resolveProjectPath)();
+        return isGlobal ? (0, os_1.homedir)() : (0, internal_1.resolveProjectPath)();
     }
     /**
      * Helper used to determine what the local and global folder point to. Returns the file path of the root folder.
@@ -107,7 +108,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      */
     async access(perm) {
         try {
-            await fs_2.fs.access(this.getPath(), perm);
+            await fs.promises.access(this.getPath(), perm);
             return true;
         }
         catch (err) {
@@ -124,7 +125,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      */
     accessSync(perm) {
         try {
-            fs_2.fs.accessSync(this.getPath(), perm);
+            fs.accessSync(this.getPath(), perm);
             return true;
         }
         catch (err) {
@@ -135,7 +136,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * Read the config file and set the config contents. Returns the config contents of the config file. As an
      * optimization, files are only read once per process and updated in memory and via `write()`. To force
      * a read from the filesystem pass `force=true`.
-     * **Throws** *{@link SfdxError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
+     * **Throws** *{@link SfError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
      *
      * @param [throwOnNotFound = false] Optionally indicate if a throw should occur on file read.
      * @param [force = false] Optionally force the file to be read from disk even when already read within the process.
@@ -146,7 +147,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
                 this.logger.info(`Reading config file: ${this.getPath()}`);
-                const obj = await fs_2.fs.readJsonMap(this.getPath());
+                const obj = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'));
                 this.setContentsFromObject(obj);
             }
             return this.getContents();
@@ -170,7 +171,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * Read the config file and set the config contents. Returns the config contents of the config file. As an
      * optimization, files are only read once per process and updated in memory and via `write()`. To force
      * a read from the filesystem pass `force=true`.
-     * **Throws** *{@link SfdxError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
+     * **Throws** *{@link SfError}{ name: 'UnexpectedJsonFileFormat' }* There was a problem reading or parsing the file.
      *
      * @param [throwOnNotFound = false] Optionally indicate if a throw should occur on file read.
      * @param [force = false] Optionally force the file to be read from disk even when already read within the process.
@@ -181,7 +182,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
                 this.logger.info(`Reading config file: ${this.getPath()}`);
-                const obj = fs_2.fs.readJsonMapSync(this.getPath());
+                const obj = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), 'utf8'));
                 this.setContentsFromObject(obj);
             }
             return this.getContents();
@@ -211,9 +212,14 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if (newContents) {
             this.setContents(newContents);
         }
-        await fs_2.fs.mkdirp((0, path_1.dirname)(this.getPath()));
+        try {
+            await fs.promises.mkdir((0, path_1.dirname)(this.getPath()), { recursive: true });
+        }
+        catch (err) {
+            throw sfError_1.SfError.wrap(err);
+        }
         this.logger.info(`Writing to config file: ${this.getPath()}`);
-        await fs_2.fs.writeJson(this.getPath(), this.toObject());
+        await fs.promises.writeFile(this.getPath(), JSON.stringify(this.toObject(), null, 2));
         return this.getContents();
     }
     /**
@@ -226,16 +232,21 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if ((0, ts_types_1.isPlainObject)(newContents)) {
             this.setContents(newContents);
         }
-        fs_2.fs.mkdirpSync((0, path_1.dirname)(this.getPath()));
+        try {
+            fs.mkdirSync((0, path_1.dirname)(this.getPath()), { recursive: true });
+        }
+        catch (err) {
+            throw sfError_1.SfError.wrap(err);
+        }
         this.logger.info(`Writing to config file: ${this.getPath()}`);
-        fs_2.fs.writeJsonSync(this.getPath(), this.toObject());
+        fs.writeFileSync(this.getPath(), JSON.stringify(this.toObject(), null, 2));
         return this.getContents();
     }
     /**
      * Check to see if the config file exists. Returns `true` if the config file exists and has access, false otherwise.
      */
     async exists() {
-        return await this.access(fs_1.constants.R_OK);
+        return this.access(fs_1.constants.R_OK);
     }
     /**
      * Check to see if the config file exists. Returns `true` if the config file exists and has access, false otherwise.
@@ -249,7 +260,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * {@link fs.stat}
      */
     async stat() {
-        return fs_2.fs.stat(this.getPath());
+        return fs.promises.stat(this.getPath());
     }
     /**
      * Get the stats of the file. Returns the stats of the file.
@@ -257,7 +268,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * {@link fs.stat}
      */
     statSync() {
-        return fs_2.fs.statSync(this.getPath());
+        return fs.statSync(this.getPath());
     }
     /**
      * Delete the config file if it exists.
@@ -268,9 +279,9 @@ class ConfigFile extends configStore_1.BaseConfigStore {
     async unlink() {
         const exists = await this.exists();
         if (exists) {
-            return await fs_2.fs.unlink(this.getPath());
+            return fs.promises.unlink(this.getPath());
         }
-        throw new sfdxError_1.SfdxError(`Target file doesn't exist. path: ${this.getPath()}`, 'TargetFileNotFound');
+        throw new sfError_1.SfError(`Target file doesn't exist. path: ${this.getPath()}`, 'TargetFileNotFound');
     }
     /**
      * Delete the config file if it exists.
@@ -281,9 +292,9 @@ class ConfigFile extends configStore_1.BaseConfigStore {
     unlinkSync() {
         const exists = this.existsSync();
         if (exists) {
-            return fs_2.fs.unlinkSync(this.getPath());
+            return fs.unlinkSync(this.getPath());
         }
-        throw new sfdxError_1.SfdxError(`Target file doesn't exist. path: ${this.getPath()}`, 'TargetFileNotFound');
+        throw new sfError_1.SfError(`Target file doesn't exist. path: ${this.getPath()}`, 'TargetFileNotFound');
     }
     /**
      * Returns the absolute path to the config file.
@@ -295,16 +306,14 @@ class ConfigFile extends configStore_1.BaseConfigStore {
     getPath() {
         if (!this.path) {
             if (!this.options.filename) {
-                throw new sfdxError_1.SfdxError('The ConfigOptions filename parameter is invalid.', 'InvalidParameter');
+                throw new sfError_1.SfError('The ConfigOptions filename parameter is invalid.', 'InvalidParameter');
             }
-            const _isGlobal = (0, ts_types_1.isBoolean)(this.options.isGlobal) && this.options.isGlobal;
-            const _isState = (0, ts_types_1.isBoolean)(this.options.isState) && this.options.isState;
             // Don't let users store config files in homedir without being in the state folder.
             let configRootFolder = this.options.rootFolder
                 ? this.options.rootFolder
-                : ConfigFile.resolveRootFolderSync(!!this.options.isGlobal);
-            if (_isGlobal || _isState) {
-                configRootFolder = (0, path_1.join)(configRootFolder, this.options.stateFolder || global_1.Global.SFDX_STATE_FOLDER);
+                : ConfigFile.resolveRootFolderSync(Boolean(this.options.isGlobal));
+            if (this.options.isGlobal === true || this.options.isState === true) {
+                configRootFolder = (0, path_1.join)(configRootFolder, this.options.stateFolder ?? global_1.Global.SFDX_STATE_FOLDER);
             }
             this.path = (0, path_1.join)(configRootFolder, this.options.filePath ? this.options.filePath : '', this.options.filename);
         }

package/lib/config/configStore.d.ts

@@ -4,16 +4,16 @@ import { Crypto } from '../crypto/crypto';
 /**
  * The allowed types stored in a config store.
  */
-export declare type ConfigValue = AnyJson;
+export type ConfigValue = AnyJson;
 /**
  * The type of entries in a config store defined by the key and value type of {@link ConfigContents}.
  */
-export declare type ConfigEntry = [string, ConfigValue];
+export type ConfigEntry = [string, ConfigValue];
 /**
  * The type of content a config stores.
  */
-export declare type ConfigContents = Dictionary<ConfigValue>;
-export declare type Key<P extends ConfigContents> = Extract<keyof P, string>;
+export type ConfigContents<T = ConfigValue> = Dictionary<T>;
+export type Key<P extends ConfigContents> = Extract<keyof P, string>;
 /**
  * An interface for a config object with a persistent store.
  */
@@ -68,7 +68,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * If the value is an object, a clone will be returned.
      */
     get<K extends Key<P>>(key: K, decrypt?: boolean): P[K];
-    get<T = ConfigValue>(key: string, decrypt?: boolean): T;
+    get<V = ConfigValue>(key: string, decrypt?: boolean): V;
     /**
      * Returns the list of keys that contain a value.
      *
@@ -93,7 +93,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @param value The value.
      */
     set<K extends Key<P>>(key: K, value: P[K]): void;
-    set<T = ConfigValue>(key: string, value: T): void;
+    set<V = ConfigValue>(key: string, value: V): void;
     /**
      * Updates the value for the key in the config object. If the value is an object, it
      * will be merged with the existing object.
@@ -102,7 +102,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @param value The value.
      */
     update<K extends Key<P>>(key: K, value: Partial<P[K]>): void;
-    update<T = ConfigValue>(key: string, value: Partial<T>): void;
+    update<V = ConfigValue>(key: string, value: Partial<V>): void;
     /**
      * Returns `true` if an element in the config object existed and has been removed, or `false` if the element does not
      * exist. {@link BaseConfigStore.has} will return false afterwards.
@@ -166,7 +166,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      *
      * @param obj The object.
      */
-    setContentsFromObject<U extends object>(obj: U): void;
+    setContentsFromObject<U extends JsonMap>(obj: U): void;
     protected getEncryptedKeys(): Array<string | RegExp>;
     /**
      * This config file has encrypted keys and it should attempt to encrypt them.
@@ -204,7 +204,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @param keyPaths: The complete path of the (nested) data
      * @param data: The current (nested) data being worked on.
      */
-    protected recursiveEncrypt<T extends JsonMap>(data: T, parentKey?: string): T;
+    protected recursiveEncrypt<J extends JsonMap>(data: J, parentKey?: string): J;
     /**
      * Decrypt all values in a nested JsonMap.
      *