@salesforce/core 3.7.6 → 3.7.7

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.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

@@ -202,7 +202,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 +210,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 +220,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 +228,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

@@ -308,7 +308,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 +319,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 +355,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 +372,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.
      */

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

@@ -13,7 +13,7 @@ const path_1 = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
 const global_1 = require("../global");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const fs_2 = require("../util/fs");
 const internal_1 = require("../util/internal");
 const configStore_1 = require("./configStore");
@@ -65,7 +65,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.
@@ -135,7 +135,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.
@@ -170,7 +170,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.
@@ -270,7 +270,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if (exists) {
             return await fs_2.fs.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.
@@ -283,7 +283,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if (exists) {
             return fs_2.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 +295,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/crypto/keyChainImpl.js

@@ -58,9 +58,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.

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

@@ -19,10 +19,10 @@ export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptio
 export { Messages } 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';

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");

package/lib/globalInfo/accessors/aliasAccessor.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AliasAccessor = void 0;
-const sfdxError_1 = require("../../sfdxError");
+const sfError_1 = require("../../sfError");
 const types_1 = require("../types");
 class AliasAccessor {
     constructor(globalInfo) {
@@ -121,7 +121,7 @@ class AliasAccessor {
             return entity;
         const aliaseeName = (_a = entity.username) !== null && _a !== void 0 ? _a : entity.user;
         if (!aliaseeName) {
-            throw new sfdxError_1.SfdxError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
+            throw new sfError_1.SfError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
         }
         return aliaseeName;
     }

package/lib/logger.d.ts

@@ -174,7 +174,7 @@ export declare class Logger {
      *
      * @param optionsOrName A set of `LoggerOptions` or name to use with the default options.
      *
-     * **Throws** *{@link SfdxError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
+     * **Throws** *{@link SfError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
      * `Logger`.
      */
     constructor(optionsOrName: LoggerOptions | string);
@@ -211,7 +211,7 @@ export declare class Logger {
      *
      * @param {string} levelName The level name to convert to a `LoggerLevel` enum value.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
      * @see {@Link LoggerLevel}
      */
     static getLevelByName(levelName: string): LoggerLevelValue;
@@ -249,7 +249,7 @@ export declare class Logger {
      *
      * @param {LoggerLevelValue} [level] The logger level.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
      * was invalid.
      *
      * ```

package/lib/logger.js

@@ -17,7 +17,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const Debug = require("debug");
 const global_1 = require("./global");
-const sfdxError_1 = require("./sfdxError");
+const sfError_1 = require("./sfError");
 const fs_1 = require("./util/fs");
 /**
  * Standard `Logger` levels.
@@ -68,7 +68,7 @@ class Logger {
      *
      * @param optionsOrName A set of `LoggerOptions` or name to use with the default options.
      *
-     * **Throws** *{@link SfdxError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
+     * **Throws** *{@link SfError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
      * `Logger`.
      */
     constructor(optionsOrName) {
@@ -102,7 +102,7 @@ class Logger {
             options = optionsOrName;
         }
         if (Logger.rootLogger && options.name === Logger.ROOT_NAME) {
-            throw new sfdxError_1.SfdxError('Can not create another root logger.', 'RedundantRootLoggerError');
+            throw new sfError_1.SfError('Can not create another root logger.', 'RedundantRootLoggerError');
         }
         // Inspect format to know what logging format to use then delete from options to
         // ensure it doesn't conflict with Bunyan.
@@ -198,13 +198,13 @@ class Logger {
      *
      * @param {string} levelName The level name to convert to a `LoggerLevel` enum value.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
      * @see {@Link LoggerLevel}
      */
     static getLevelByName(levelName) {
         levelName = levelName.toUpperCase();
         if (!(0, ts_types_1.isKeyOf)(LoggerLevel, levelName)) {
-            throw new sfdxError_1.SfdxError(`Invalid log level "${levelName}".`, 'UnrecognizedLoggerLevelNameError');
+            throw new sfError_1.SfError(`Invalid log level "${levelName}".`, 'UnrecognizedLoggerLevelNameError');
         }
         return LoggerLevel[levelName];
     }
@@ -243,7 +243,7 @@ class Logger {
                 await fs_1.fs.writeFile(logFile, '', { mode: fs_1.fs.DEFAULT_USER_FILE_MODE });
             }
             catch (err3) {
-                throw sfdxError_1.SfdxError.wrap(err3);
+                throw sfError_1.SfError.wrap(err3);
             }
         }
         // avoid multiple streams to same log file
@@ -283,7 +283,7 @@ class Logger {
                 fs_1.fs.writeFileSync(logFile, '', { mode: fs_1.fs.DEFAULT_USER_FILE_MODE });
             }
             catch (err3) {
-                throw sfdxError_1.SfdxError.wrap(err3);
+                throw sfError_1.SfError.wrap(err3);
             }
         }
         // avoid multiple streams to same log file
@@ -319,7 +319,7 @@ class Logger {
      *
      * @param {LoggerLevelValue} [level] The logger level.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
      * was invalid.
      *
      * ```
@@ -452,7 +452,7 @@ class Logger {
      */
     child(name, fields = {}) {
         if (!name) {
-            throw new sfdxError_1.SfdxError('LoggerNameRequired');
+            throw new sfError_1.SfError('LoggerNameRequired');
         }
         fields.log = name;
         const child = new Logger(name);

package/lib/messages.d.ts

@@ -1,5 +1,5 @@
 import { AnyJson } from '@salesforce/ts-types';
-import { SfdxError } from './sfdxError';
+import { SfError } from './sfError';
 export declare type Tokens = Array<string | boolean | number | null | undefined>;
 /**
  * A loader function to return messages.
@@ -247,6 +247,6 @@ export declare class Messages<T extends string> {
      * @param exitCodeOrCause The exit code which will be used by SfdxCommand or he underlying error that caused this error to be raised.
      * @param cause The underlying error that caused this error to be raised.
      */
-    createError(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfdxError;
+    createError(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfError;
     private getMessageWithMap;
 }

package/lib/messages.js

@@ -13,7 +13,7 @@ const path = require("path");
 const util = require("util");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
-const sfdxError_1 = require("./sfdxError");
+const sfError_1 = require("./sfError");
 class Key {
     constructor(packageName, bundleName) {
         this.packageName = packageName;
@@ -57,7 +57,7 @@ const markdownLoader = (filePath, fileContents) => {
             }
         }
         else {
-            // use error instead of SfdxError because messages.js should have no internal dependencies.
+            // use error instead of SfError because messages.js should have no internal dependencies.
             throw new Error(`Invalid markdown message file: ${filePath}\nThe line "# <key>" must be immediately followed by the message on a new line.`);
         }
     }
@@ -217,7 +217,7 @@ class Messages {
             if (!fileContents || fileContents.trim().length === 0) {
                 // messages.js should have no internal dependencies.
                 const error = new Error(`Invalid message file: ${filePath}. No content.`);
-                error.name = 'SfdxError';
+                error.name = 'SfError';
                 throw error;
             }
             const map = parser(filePath, fileContents);
@@ -456,7 +456,7 @@ class Messages {
         catch (e) {
             /* just ignore if actions aren't found */
         }
-        return new sfdxError_1.SfdxError(errMessage, errName, errActions, exitCodeOrCause, cause);
+        return new sfError_1.SfError(errMessage, errName, errActions, exitCodeOrCause, cause);
     }
     getMessageWithMap(key, tokens = [], map) {
         // Allow nested keys for better grouping

package/lib/org/authInfo.d.ts

@@ -253,7 +253,7 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      *
      * @param options Options to be used for creating an OAuth2 instance.
      *
-     * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* Org information does not exist.
+     * **Throws** *{@link SfError}{ name: 'NamedOrgNotFoundError' }* Org information does not exist.
      * @returns {Promise<AuthInfo>}
      */
     private initAuthOptions;

package/lib/org/authInfo.js

@@ -18,7 +18,7 @@ const jwt = require("jsonwebtoken");
 const config_1 = require("../config/config");
 const configAggregator_1 = require("../config/configAggregator");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const fs_1 = require("../util/fs");
 const sfdc_1 = require("../util/sfdc");
 const globalInfo_1 = require("../globalInfo");
@@ -236,7 +236,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     static parseSfdxAuthUrl(sfdxAuthUrl) {
         const match = sfdxAuthUrl.match(/^force:\/\/([a-zA-Z0-9._-]+):([a-zA-Z0-9._-]*):([a-zA-Z0-9._-]+={0,2})@([a-zA-Z0-9._-]+)/);
         if (!match) {
-            throw new sfdxError_1.SfdxError('Invalid SFDX auth URL. Must be in the format "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".  Note that the SFDX auth URL uses the "force" protocol, and not "http" or "https".  Also note that the "instanceUrl" inside the SFDX auth URL doesn\'t include the protocol ("https://").', 'INVALID_SFDX_AUTH_URL');
+            throw new sfError_1.SfError('Invalid SFDX auth URL. Must be in the format "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".  Note that the SFDX auth URL uses the "force" protocol, and not "http" or "https".  Also note that the "instanceUrl" inside the SFDX auth URL doesn\'t include the protocol ("https://").', 'INVALID_SFDX_AUTH_URL');
         }
         const [, clientId, clientSecret, refreshToken, loginUrl] = match;
         return {
@@ -489,7 +489,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      *
      * @param options Options to be used for creating an OAuth2 instance.
      *
-     * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* Org information does not exist.
+     * **Throws** *{@link SfError}{ name: 'NamedOrgNotFoundError' }* Org information does not exist.
      * @returns {Promise<AuthInfo>}
      */
     async initAuthOptions(options) {
@@ -768,7 +768,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         catch (err) {
             errorMsg = `${bodyAsString}`;
         }
-        throw new sfdxError_1.SfdxError(errorMsg);
+        throw new sfError_1.SfError(errorMsg);
     }
 }
 exports.AuthInfo = AuthInfo;

package/lib/org/authRemover.d.ts

@@ -39,8 +39,8 @@ export declare class AuthRemover extends AsyncOptionalCreatable {
     removeAllAuths(): Promise<void>;
     /**
      * Finds authorization files for username/alias in the global .sfdx folder
-     * **Throws** *{@link SfdxError}{ name: 'TargetOrgNotSetError' }* if no target-org
-     * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
+     * **Throws** *{@link SfError}{ name: 'TargetOrgNotSetError' }* if no target-org
+     * **Throws** *{@link SfError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
      *
      * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured target-org
      * @returns {Promise<SfOrg>}

package/lib/org/authRemover.js

@@ -66,8 +66,8 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Finds authorization files for username/alias in the global .sfdx folder
-     * **Throws** *{@link SfdxError}{ name: 'TargetOrgNotSetError' }* if no target-org
-     * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
+     * **Throws** *{@link SfError}{ name: 'TargetOrgNotSetError' }* if no target-org
+     * **Throws** *{@link SfError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
      *
      * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured target-org
      * @returns {Promise<SfOrg>}

package/lib/org/connection.d.ts

@@ -123,7 +123,7 @@ export declare class Connection<S extends Schema = Schema> extends JSForceConnec
     /**
      * Set the API version for all connection requests.
      *
-     * **Throws** *{@link SfdxError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
+     * **Throws** *{@link SfError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
      *
      * @param version The API version.
      */