@salesforce/core 3.7.6 → 3.7.9

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.7.9](https://github.com/forcedotcom/sfdx-core/compare/v3.7.8...v3.7.9) (2022-03-04)
+
+### Bug Fixes
+
+- error literal to match the error thrown ([#533](https://github.com/forcedotcom/sfdx-core/issues/533)) ([b91ce5c](https://github.com/forcedotcom/sfdx-core/commit/b91ce5c329c9b2b88fb4b0ad028aee5f6d5b6e77))
+
+### [3.7.8](https://github.com/forcedotcom/sfdx-core/compare/v3.7.7...v3.7.8) (2022-03-03)
+
+### Bug Fixes
+
+- add create warning and info convenience functions ([#526](https://github.com/forcedotcom/sfdx-core/issues/526)) ([e3428b3](https://github.com/forcedotcom/sfdx-core/commit/e3428b35e00b9cee3c90153ed6ce08b352535ff7))
+
+### [3.7.7](https://github.com/forcedotcom/sfdx-core/compare/v3.7.6...v3.7.7) (2022-03-01)
+
 ### [3.7.6](https://github.com/forcedotcom/sfdx-core/compare/v4.0.0...v3.7.6) (2022-02-28)
 
 ## [4.0.0](https://github.com/forcedotcom/sfdx-core/compare/v2.35.2...v4.0.0) (2022-02-28)

package/README.md

@@ -52,7 +52,7 @@ describe('Mocking Auth data', () => {
 After having a valid AuthInfo object you can then create fake connections to a Salesforce.com scratch org. This allows for writing tests that can validate result responses for SOQL queries and REST endpoints.
 
 ```typescript
-import { AuthInfo, Connection, SfdxError } from '@salesforce/core';
+import { AuthInfo, Connection, SfError } from '@salesforce/core';
 import { MockTestOrgData, testSetup } from '@salesforce/core/lib/testSetup';
 import { AnyJson, ensureJsonMap, JsonMap } from '@salesforce/ts-types';
 import { ensureString } from '@salesforce/ts-types';
@@ -77,7 +77,7 @@ describe('Mocking a force server call', () => {
       if (request && ensureString(_request.url).includes('Account')) {
         return Promise.resolve(records);
       } else {
-        return Promise.reject(new SfdxError(`Unexpected request: ${_request.url}`));
+        return Promise.reject(new SfError(`Unexpected request: ${_request.url}`));
       }
     };
     const connection: Connection = await Connection.create({
@@ -117,13 +117,13 @@ describe('Using the built in Sinon sandbox.', () => {
 It's important to have negative tests that ensure proper error handling. With `shouldThrow` it's easy to test for expected async rejections.
 
 ```typescript
-import { SfdxError } from '@salesforce/core';
+import { SfError } from '@salesforce/core';
 import { shouldThrow } from '@salesforce/core/lib/testSetup';
 import { strictEqual } from 'assert';
 
 class TestObject {
   public static async method() {
-    throw new SfdxError('Error', 'ExpectedError');
+    throw new SfError('Error', 'ExpectedError');
   }
 }
 

package/lib/config/config.d.ts

@@ -56,12 +56,14 @@ export declare enum SfdxPropertyKeys {
      * Username associated with the default dev hub org.
      *
      * @deprecated Replaced by OrgConfigProperties.TARGET_DEV_HUB in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
     DEFAULT_DEV_HUB_USERNAME = "defaultdevhubusername",
     /**
      * Username associate with the default org.
      *
      * @deprecated Replaced by OrgConfigProperties.TARGET_ORG in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
     DEFAULT_USERNAME = "defaultusername",
     /**
@@ -202,7 +204,7 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      * DO NOT CALL - The config file needs to encrypt values which can only be done asynchronously.
      * Call {@link SfdxConfig.write} instead.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidWriteError' }* Always.
+     * **Throws** *{@link SfError}{ name: 'InvalidWriteError' }* Always.
      *
      * @param newContents Contents to write
      */
@@ -210,8 +212,8 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
     /**
      * Sets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
-     * **Throws** *{@link SfdxError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
      *
      * @param key The property to set.
      * @param value The value of the property.
@@ -220,7 +222,7 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
     /**
      * Unsets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
      *
      * @param key The property to unset.
      */
@@ -228,7 +230,7 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
     /**
      * Get an individual property config.
      *
-     * **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 propertyName The name of the property.
      */

package/lib/config/config.js

@@ -8,13 +8,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Config = exports.SfProperty = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = void 0;
 const path_1 = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
+const mkdirp = require("mkdirp");
 const global_1 = require("../global");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const sfdc_1 = require("../util/sfdc");
-const fs_1 = require("../util/fs");
 const sfdcUrl_1 = require("../util/sfdcUrl");
 const orgConfigProperties_1 = require("../org/orgConfigProperties");
 const configFile_1 = require("./configFile");
@@ -49,12 +50,14 @@ var SfdxPropertyKeys;
      * Username associated with the default dev hub org.
      *
      * @deprecated Replaced by OrgConfigProperties.TARGET_DEV_HUB in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
     SfdxPropertyKeys["DEFAULT_DEV_HUB_USERNAME"] = "defaultdevhubusername";
     /**
      * Username associate with the default org.
      *
      * @deprecated Replaced by OrgConfigProperties.TARGET_ORG in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
     SfdxPropertyKeys["DEFAULT_USERNAME"] = "defaultusername";
     /**
@@ -115,12 +118,14 @@ exports.SFDX_ALLOWED_PROPERTIES = [
         },
     },
     {
+        // will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
         key: SfdxPropertyKeys.DEFAULT_DEV_HUB_USERNAME,
         newKey: orgConfigProperties_1.OrgConfigProperties.TARGET_DEV_HUB,
         deprecated: true,
         description: messages.getMessage('defaultDevHubUsername'),
     },
     {
+        // will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
         key: SfdxPropertyKeys.DEFAULT_USERNAME,
         newKey: orgConfigProperties_1.OrgConfigProperties.TARGET_ORG,
         deprecated: true,
@@ -308,7 +313,7 @@ class Config extends configFile_1.ConfigFile {
      * DO NOT CALL - The config file needs to encrypt values which can only be done asynchronously.
      * Call {@link SfdxConfig.write} instead.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidWriteError' }* Always.
+     * **Throws** *{@link SfError}{ name: 'InvalidWriteError' }* Always.
      *
      * @param newContents Contents to write
      */
@@ -319,8 +324,8 @@ class Config extends configFile_1.ConfigFile {
     /**
      * Sets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
-     * **Throws** *{@link SfdxError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
      *
      * @param key The property to set.
      * @param value The value of the property.
@@ -355,7 +360,7 @@ class Config extends configFile_1.ConfigFile {
     /**
      * Unsets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
      *
      * @param key The property to unset.
      */
@@ -372,7 +377,7 @@ class Config extends configFile_1.ConfigFile {
     /**
      * Get an individual property config.
      *
-     * **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 propertyName The name of the property.
      */
@@ -446,7 +451,7 @@ class SfdxConfig {
     }
     readSync() {
         try {
-            const contents = fs_1.fs.readJsonMapSync(this.getSfdxPath());
+            const contents = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getSfdxPath(), 'utf8'));
             return this.normalize(contents, 'toNew');
         }
         catch (error) {
@@ -457,9 +462,9 @@ class SfdxConfig {
     async writeSync(config = this.config.toObject()) {
         try {
             const sfdxPath = this.getSfdxPath();
-            await fs_1.fs.mkdirp((0, path_1.dirname)(sfdxPath));
+            await mkdirp((0, path_1.dirname)(sfdxPath));
             const mapped = this.normalize(config, 'toOld');
-            await fs_1.fs.writeJson(sfdxPath, mapped);
+            await fs.promises.writeFile(sfdxPath, JSON.stringify(mapped, null, 2));
         }
         catch (error) {
             /* Do nothing */

package/lib/config/configAggregator.d.ts

@@ -88,7 +88,7 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
     /**
      * Get a resolved config property.
      *
-     * **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.
      */
@@ -96,7 +96,7 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
     /**
      * Get a resolved config property meta.
      *
-     * **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.
      */

package/lib/config/configAggregator.js

@@ -100,7 +100,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     /**
      * Get a resolved config property.
      *
-     * **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.
      */
@@ -115,7 +115,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     /**
      * Get a resolved config property meta.
      *
-     * **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.
      */

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,16 @@
  */
 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 mkdirp = require("mkdirp");
 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 +67,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.
@@ -107,7 +109,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 +126,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 +137,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 +148,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 +172,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 +183,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 +213,9 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if (newContents) {
             this.setContents(newContents);
         }
-        await fs_2.fs.mkdirp((0, path_1.dirname)(this.getPath()));
+        await mkdirp((0, path_1.dirname)(this.getPath()));
         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,9 +228,9 @@ 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()));
+        mkdirp.sync((0, path_1.dirname)(this.getPath()));
         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();
     }
     /**
@@ -249,7 +251,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 +259,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 +270,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 await 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 +283,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,7 +297,7 @@ 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;

package/lib/config/configStore.js

@@ -11,7 +11,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const ts_types_2 = require("@salesforce/ts-types");
 const crypto_1 = require("../crypto/crypto");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 /**
  * An abstract class that implements all the config management functions but
  * none of the storage functions.
@@ -287,18 +287,18 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         if (!value)
             return;
         if (!this.crypto)
-            throw new sfdxError_1.SfdxError('crypto is not initialized', 'CryptoNotInitializedError');
+            throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfdxError_1.SfdxError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? value : this.crypto.encrypt(value);
     }
     decrypt(value) {
         if (!value)
             return;
         if (!this.crypto)
-            throw new sfdxError_1.SfdxError('crypto is not initialized', 'CryptoNotInitializedError');
+            throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfdxError_1.SfdxError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? this.crypto.decrypt(value) : value;
     }
     /**

package/lib/config/keychainConfig.js

@@ -8,7 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeychainConfig = void 0;
 const path_1 = require("path");
-const fs_1 = require("../util/fs");
+const fs = require("fs");
+const mkdirp = require("mkdirp");
 const configFile_1 = require("./configFile");
 /**
  * Represent a key chain config backed by a json file.
@@ -34,8 +35,8 @@ class KeychainConfig extends configFile_1.ConfigFile {
         if (newContents != null) {
             this.setContents(newContents);
         }
-        await fs_1.fs.mkdirp((0, path_1.dirname)(this.getPath()));
-        await fs_1.fs.writeFile(this.getPath(), JSON.stringify(this.getContents(), null, 4), { mode: '600' });
+        await mkdirp((0, path_1.dirname)(this.getPath()));
+        await fs.promises.writeFile(this.getPath(), JSON.stringify(this.getContents(), null, 4), { mode: '600' });
         return this.getContents();
     }
 }

package/lib/crypto/keyChainImpl.js

@@ -9,12 +9,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.keyChainImpl = exports.GenericWindowsKeychainAccess = exports.GenericUnixKeychainAccess = exports.GenericKeychainAccess = exports.KeychainAccess = void 0;
 const childProcess = require("child_process");
 const nodeFs = require("fs");
+const fs = require("fs");
 const os = require("os");
-const path = require("path");
 const os_1 = require("os");
+const path = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
+const kit_1 = require("@salesforce/kit");
+const mkdirp = require("mkdirp");
 const global_1 = require("../global");
-const fs_1 = require("../util/fs");
 const messages_1 = require("../messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'encryption', [
@@ -58,9 +60,9 @@ const _isExe = (mode, gid, uid) => {
 /**
  * Private helper to validate that a program exists on the file system and is executable.
  *
- * **Throws** *{@link SfdxError}{ name: 'MissingCredentialProgramError' }* When the OS credential program isn't found.
+ * **Throws** *{@link SfError}{ name: 'MissingCredentialProgramError' }* When the OS credential program isn't found.
  *
- * **Throws** *{@link SfdxError}{ name: 'CredentialProgramAccessError' }* When the OS credential program isn't accessible.
+ * **Throws** *{@link SfError}{ name: 'CredentialProgramAccessError' }* When the OS credential program isn't accessible.
  *
  * @param programPath The absolute path of the program.
  * @param fsIfc The file system interface.
@@ -329,8 +331,8 @@ async function _writeFile(opts, fn) {
             [SecretField.KEY]: opts.password,
             [SecretField.SERVICE]: opts.service,
         };
-        await fs_1.fs.mkdirp(path.dirname(secretFile));
-        await fs_1.fs.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
+        await mkdirp(path.dirname(secretFile));
+        await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
         fn(null, contents);
     }
     catch (err) {
@@ -339,7 +341,7 @@ async function _writeFile(opts, fn) {
 }
 async function _readFile() {
     // The file and access is validated before this method is called
-    const fileContents = await fs_1.fs.readJsonMap(secretFile);
+    const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(secretFile, 'utf8'));
     return {
         account: (0, ts_types_1.ensureString)(fileContents[SecretField.ACCOUNT]),
         password: (0, ts_types_1.asString)(fileContents[SecretField.KEY]),
@@ -406,7 +408,7 @@ class GenericKeychainAccess {
     async isValidFileAccess(cb) {
         try {
             const root = (0, os_1.homedir)();
-            await fs_1.fs.access(path.join(root, global_1.Global.SFDX_STATE_FOLDER), fs_1.fs.constants.R_OK | fs_1.fs.constants.X_OK | fs_1.fs.constants.W_OK);
+            await fs.promises.access(path.join(root, global_1.Global.SFDX_STATE_FOLDER), fs.constants.R_OK | fs.constants.X_OK | fs.constants.W_OK);
             await cb(null);
         }
         catch (err) {
@@ -426,7 +428,7 @@ class GenericUnixKeychainAccess extends GenericKeychainAccess {
                 await cb(err);
             }
             else {
-                const stats = await fs_1.fs.stat(secretFile);
+                const stats = await fs.promises.stat(secretFile);
                 const octalModeStr = (stats.mode & 0o777).toString(8);
                 const EXPECTED_OCTAL_PERM_VALUE = '600';
                 if (octalModeStr === EXPECTED_OCTAL_PERM_VALUE) {
@@ -451,7 +453,7 @@ class GenericWindowsKeychainAccess extends GenericKeychainAccess {
             }
             else {
                 try {
-                    await fs_1.fs.access(secretFile, fs_1.fs.constants.R_OK | fs_1.fs.constants.W_OK);
+                    await fs.promises.access(secretFile, fs.constants.R_OK | fs.constants.W_OK);
                     await cb(null);
                 }
                 catch (e) {

package/lib/deviceOauthService.js

@@ -15,7 +15,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const logger_1 = require("./logger");
 const authInfo_1 = require("./org/authInfo");
-const sfdxError_1 = require("./sfdxError");
+const sfError_1 = require("./sfError");
 const connection_1 = require("./org/connection");
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
@@ -29,7 +29,7 @@ async function makeRequest(options) {
     const rawResponse = await new transport_1.default().httpRequest(options);
     const response = (0, kit_1.parseJsonMap)(rawResponse.body);
     if (response.error) {
-        const err = new sfdxError_1.SfdxError('Request Failed.');
+        const err = new sfError_1.SfError('Request Failed.');
         err.data = Object.assign(response, { status: rawResponse.statusCode });
         throw err;
     }

package/lib/exported.d.ts

@@ -16,13 +16,13 @@ export { WebOAuthServer } from './webOAuthServer';
 export { SfdcUrl } from './util/sfdcUrl';
 export { getJwtAudienceUrl } from './util/getJwtAudienceUrl';
 export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptions, LoggerStream, Logger, } from './logger';
-export { Messages } from './messages';
+export { Messages, StructuredMessage } from './messages';
 export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
 export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
-export { PackageDir, NamedPackageDir, PackageDirDependency, SfdxProject, SfdxProjectJson } from './sfdxProject';
+export { PackageDir, NamedPackageDir, PackageDirDependency, SfProject, SfProjectJson, SfdxProject, SfdxProjectJson, } from './sfProject';
 export { SchemaPrinter } from './schema/printer';
 export { SchemaValidator } from './schema/validator';
-export { SfdxError } from './sfdxError';
+export { SfError, SfdxError } from './sfError';
 export { PollingClient } from './status/pollingClient';
 export { CometClient, CometSubscription, StreamingClient, StatusResult } from './status/streamingClient';
 export { MyDomainResolver } from './status/myDomainResolver';
@@ -30,6 +30,5 @@ export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
 export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
 export { ScratchOrgInfo } from './org/scratchOrgInfoApi';
-export * from './util/fs';
 export * from './util/sfdc';
 export * from './util/sfdcUrl';

package/lib/exported.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.ConfigFile = void 0;
+exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SfError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.ConfigFile = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -71,15 +71,18 @@ Object.defineProperty(exports, "OrgTypes", { enumerable: true, get: function ()
 var orgConfigProperties_1 = require("./org/orgConfigProperties");
 Object.defineProperty(exports, "OrgConfigProperties", { enumerable: true, get: function () { return orgConfigProperties_1.OrgConfigProperties; } });
 Object.defineProperty(exports, "ORG_CONFIG_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return orgConfigProperties_1.ORG_CONFIG_ALLOWED_PROPERTIES; } });
-var sfdxProject_1 = require("./sfdxProject");
-Object.defineProperty(exports, "SfdxProject", { enumerable: true, get: function () { return sfdxProject_1.SfdxProject; } });
-Object.defineProperty(exports, "SfdxProjectJson", { enumerable: true, get: function () { return sfdxProject_1.SfdxProjectJson; } });
+var sfProject_1 = require("./sfProject");
+Object.defineProperty(exports, "SfProject", { enumerable: true, get: function () { return sfProject_1.SfProject; } });
+Object.defineProperty(exports, "SfProjectJson", { enumerable: true, get: function () { return sfProject_1.SfProjectJson; } });
+Object.defineProperty(exports, "SfdxProject", { enumerable: true, get: function () { return sfProject_1.SfdxProject; } });
+Object.defineProperty(exports, "SfdxProjectJson", { enumerable: true, get: function () { return sfProject_1.SfdxProjectJson; } });
 var printer_1 = require("./schema/printer");
 Object.defineProperty(exports, "SchemaPrinter", { enumerable: true, get: function () { return printer_1.SchemaPrinter; } });
 var validator_1 = require("./schema/validator");
 Object.defineProperty(exports, "SchemaValidator", { enumerable: true, get: function () { return validator_1.SchemaValidator; } });
-var sfdxError_1 = require("./sfdxError");
-Object.defineProperty(exports, "SfdxError", { enumerable: true, get: function () { return sfdxError_1.SfdxError; } });
+var sfError_1 = require("./sfError");
+Object.defineProperty(exports, "SfError", { enumerable: true, get: function () { return sfError_1.SfError; } });
+Object.defineProperty(exports, "SfdxError", { enumerable: true, get: function () { return sfError_1.SfdxError; } });
 var pollingClient_1 = require("./status/pollingClient");
 Object.defineProperty(exports, "PollingClient", { enumerable: true, get: function () { return pollingClient_1.PollingClient; } });
 var streamingClient_1 = require("./status/streamingClient");
@@ -96,7 +99,6 @@ Object.defineProperty(exports, "PermissionSetAssignment", { enumerable: true, ge
 var scratchOrgCreate_1 = require("./org/scratchOrgCreate");
 Object.defineProperty(exports, "scratchOrgCreate", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgCreate; } });
 // Utility sub-modules
-__exportStar(require("./util/fs"), exports);
 __exportStar(require("./util/sfdc"), exports);
 __exportStar(require("./util/sfdcUrl"), exports);
 //# sourceMappingURL=exported.js.map