@salesforce/core 3.7.5 → 3.7.8

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -0,0 +1,56 @@
+import { JsonMap } from '@salesforce/ts-types';
+import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { Org } from './org';
+export declare enum RequestStatus {
+    Pending = "Pending",
+    InProgress = "InProgress",
+    Succeeded = "Succeeded",
+    SucceededPartial = "SucceededPartial",
+    Failed = "Failed",
+    Canceling = "Canceling",
+    Canceled = "Canceled"
+}
+export interface ObjectSetting extends JsonMap {
+    sharingModel?: string;
+    defaultRecordType?: string;
+}
+export interface BusinessProcessFileContent extends JsonMap {
+    fullName: string;
+    isActive: boolean;
+    values: [
+        {
+            fullName: string;
+            default?: boolean;
+        }
+    ];
+}
+/**
+ * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
+ * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
+ */
+export default class SettingsGenerator {
+    private settingData?;
+    private objectSettingsData?;
+    private logger;
+    private writer;
+    private shapeDirName;
+    constructor();
+    /** extract the settings from the scratch def file, if they are present. */
+    extract(scratchDef: ScratchOrgInfo): Promise<void>;
+    /** True if we are currently tracking setting or object setting data. */
+    hasSettings(): boolean;
+    /** Create temporary deploy directory used to upload the scratch org shape.
+     * This will create the dir, all of the .setting files and minimal object files needed for objectSettings
+     */
+    createDeploy(): Promise<void>;
+    /**
+     * Deploys the settings to the org.
+     */
+    deploySettingsViaFolder(scratchOrg: Org, apiVersion: string): Promise<void>;
+    private writeObjectSettingsIfNeeded;
+    private writeSettingsIfNeeded;
+    private createPackageXml;
+    private createObjectFileContent;
+    private createRecordTypeFileContent;
+    private createBusinessProcessFileContent;
+}

package/lib/org/scratchOrgSettingsGenerator.js

@@ -0,0 +1,210 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestStatus = void 0;
+const path = require("path");
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+const js2xmlparser = require("js2xmlparser");
+const logger_1 = require("../logger");
+const sfError_1 = require("../sfError");
+const jsonXmlTools_1 = require("../util/jsonXmlTools");
+const zipWriter_1 = require("../util/zipWriter");
+const pollingClient_1 = require("../status/pollingClient");
+var RequestStatus;
+(function (RequestStatus) {
+    RequestStatus["Pending"] = "Pending";
+    RequestStatus["InProgress"] = "InProgress";
+    RequestStatus["Succeeded"] = "Succeeded";
+    RequestStatus["SucceededPartial"] = "SucceededPartial";
+    RequestStatus["Failed"] = "Failed";
+    RequestStatus["Canceling"] = "Canceling";
+    RequestStatus["Canceled"] = "Canceled";
+})(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
+const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
+/**
+ * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
+ * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
+ */
+class SettingsGenerator {
+    constructor() {
+        this.shapeDirName = `shape_${Date.now()}`;
+        this.logger = logger_1.Logger.childFromRoot('SettingsGenerator');
+        // If SFDX_MDAPI_TEMP_DIR is set, copy settings to that dir for people to inspect.
+        const mdapiTmpDir = kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
+        this.writer = new zipWriter_1.ZipWriter(mdapiTmpDir);
+    }
+    /** extract the settings from the scratch def file, if they are present. */
+    async extract(scratchDef) {
+        this.logger.debug('extracting settings from scratch definition file');
+        this.settingData = scratchDef.settings;
+        this.objectSettingsData = scratchDef.objectSettings;
+        this.logger.debug('settings are', this.settingData);
+    }
+    /** True if we are currently tracking setting or object setting data. */
+    hasSettings() {
+        return !(0, kit_1.isEmpty)(this.settingData) || !(0, kit_1.isEmpty)(this.objectSettingsData);
+    }
+    /** Create temporary deploy directory used to upload the scratch org shape.
+     * This will create the dir, all of the .setting files and minimal object files needed for objectSettings
+     */
+    async createDeploy() {
+        const settingsDir = path.join(this.shapeDirName, 'settings');
+        const objectsDir = path.join(this.shapeDirName, 'objects');
+        await Promise.all([this.writeSettingsIfNeeded(settingsDir), this.writeObjectSettingsIfNeeded(objectsDir)]);
+    }
+    /**
+     * Deploys the settings to the org.
+     */
+    async deploySettingsViaFolder(scratchOrg, apiVersion) {
+        const username = scratchOrg.getUsername();
+        const logger = await logger_1.Logger.child('deploySettingsViaFolder');
+        this.createPackageXml(apiVersion);
+        await this.writer.finalize();
+        const connection = scratchOrg.getConnection();
+        logger.debug(`deploying to apiVersion: ${apiVersion}`);
+        connection.setApiVersion(apiVersion);
+        const { id } = await connection.deploy(this.writer.buffer, {});
+        logger.debug(`deploying settings id ${id}`);
+        let result = await connection.metadata.checkDeployStatus(id);
+        const pollingOptions = {
+            async poll() {
+                try {
+                    result = await connection.metadata.checkDeployStatus(id, true);
+                    logger.debug(`Deploy id: ${id} status: ${result.status}`);
+                    if (breakPolling.includes(result.status)) {
+                        return {
+                            completed: true,
+                            payload: result.status,
+                        };
+                    }
+                    return {
+                        completed: false,
+                    };
+                }
+                catch (error) {
+                    logger.debug(`An error occurred trying to check deploy id: ${id}`);
+                    logger.debug(`Error: ${error.message}`);
+                    logger.debug('Re-trying deploy check again....');
+                    return {
+                        completed: false,
+                    };
+                }
+            },
+            timeout: kit_1.Duration.minutes(10),
+            frequency: kit_1.Duration.seconds(1),
+            timeoutErrorName: 'DeployingSettingsTimeoutError',
+        };
+        const client = await pollingClient_1.PollingClient.create(pollingOptions);
+        const status = await client.subscribe();
+        if (status !== RequestStatus.Succeeded) {
+            const componentFailures = (0, ts_types_1.ensureObject)(result.details).componentFailures;
+            const failures = (Array.isArray(componentFailures) ? componentFailures : [componentFailures])
+                .map((failure) => failure.problem)
+                .join('\n');
+            const error = new sfError_1.SfError(`A scratch org was created with username ${username}, but the settings failed to deploy due to: \n${failures}`, 'ProblemDeployingSettings');
+            error.setData(result);
+            throw error;
+        }
+    }
+    async writeObjectSettingsIfNeeded(objectsDir) {
+        if (!this.objectSettingsData || !Object.keys(this.objectSettingsData).length) {
+            return;
+        }
+        for (const objectName of Object.keys(this.objectSettingsData)) {
+            const value = this.objectSettingsData[objectName];
+            // writes the object file in source format
+            const objectDir = path.join(objectsDir, (0, kit_1.upperFirst)(objectName));
+            const customObjectDir = path.join(objectDir, `${(0, kit_1.upperFirst)(objectName)}.object`);
+            const customObjectXml = (0, jsonXmlTools_1.JsonAsXml)({
+                json: this.createObjectFileContent(value),
+                type: 'RecordType',
+            });
+            this.writer.addToZip(customObjectXml, customObjectDir);
+            if (value.defaultRecordType) {
+                const recordTypesDir = path.join(objectDir, 'recordTypes', `${(0, kit_1.upperFirst)(value.defaultRecordType)}.recordType`);
+                const recordTypesFileContent = this.createRecordTypeFileContent(objectName, value);
+                const recordTypesXml = (0, jsonXmlTools_1.JsonAsXml)({
+                    json: recordTypesFileContent,
+                    type: 'RecordType',
+                });
+                this.writer.addToZip(recordTypesXml, recordTypesDir);
+                // for things that required a businessProcess
+                if (recordTypesFileContent.businessProcess) {
+                    const businessProcessesDir = path.join(objectDir, 'businessProcesses', `${recordTypesFileContent.businessProcess}.businessProcess`);
+                    const businessProcessesXml = (0, jsonXmlTools_1.JsonAsXml)({
+                        json: this.createBusinessProcessFileContent(objectName, recordTypesFileContent.businessProcess),
+                        type: 'BusinessProcess',
+                    });
+                    this.writer.addToZip(businessProcessesXml, businessProcessesDir);
+                }
+            }
+        }
+    }
+    async writeSettingsIfNeeded(settingsDir) {
+        if (this.settingData) {
+            for (const item of Object.keys(this.settingData)) {
+                const value = (0, ts_types_1.getObject)(this.settingData, item);
+                const typeName = (0, kit_1.upperFirst)(item);
+                const fname = typeName.replace('Settings', '');
+                const fileContent = js2xmlparser.parse(typeName, value);
+                this.writer.addToZip(fileContent, path.join(settingsDir, fname + '.settings'));
+            }
+        }
+    }
+    createPackageXml(apiVersion) {
+        const pkg = `<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>*</members>
+        <name>Settings</name>
+    </types>
+    <types>
+        <members>*</members>
+        <name>CustomObject</name>
+    </types>
+    <version>${apiVersion}</version>
+</Package>`;
+        this.writer.addToZip(pkg, path.join(this.shapeDirName, 'package.xml'));
+    }
+    createObjectFileContent(json) {
+        const output = {};
+        if (json.sharingModel) {
+            output.sharingModel = (0, kit_1.upperFirst)(json.sharingModel);
+        }
+        return output;
+    }
+    createRecordTypeFileContent(objectName, setting) {
+        const defaultRecordType = (0, kit_1.upperFirst)(setting.defaultRecordType);
+        const output = {
+            fullName: defaultRecordType,
+            label: defaultRecordType,
+            active: true,
+        };
+        // all the edge cases
+        if (['Case', 'Lead', 'Opportunity', 'Solution'].includes((0, kit_1.upperFirst)(objectName))) {
+            return { ...output, businessProcess: `${defaultRecordType}Process` };
+        }
+        return output;
+    }
+    createBusinessProcessFileContent(objectName, businessProcessName) {
+        const objectToBusinessProcessPicklist = {
+            Opportunity: { fullName: 'Prospecting' },
+            Case: { fullName: 'New', default: true },
+            Lead: { fullName: 'New - Not Contacted', default: true },
+            Solution: { fullName: 'Draft', default: true },
+        };
+        return {
+            fullName: businessProcessName,
+            isActive: true,
+            values: [objectToBusinessProcessPicklist[(0, kit_1.upperFirst)(objectName)]],
+        };
+    }
+}
+exports.default = SettingsGenerator;
+//# sourceMappingURL=scratchOrgSettingsGenerator.js.map

package/lib/org/user.js

@@ -11,12 +11,12 @@ const os_1 = require("os");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const http_api_1 = require("jsforce/lib/http-api");
-const connection_1 = require("../org/connection");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const secureBuffer_1 = require("../crypto/secureBuffer");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const sfdc_1 = require("../util/sfdc");
+const connection_1 = require("./connection");
 const permissionSetAssignment_1 = require("./permissionSetAssignment");
 const authInfo_1 = require("./authInfo");
 const rand = (len) => Math.floor(Math.random() * len.length);
@@ -185,11 +185,11 @@ class User extends kit_1.AsyncCreatable {
     static generatePasswordUtf8(passwordCondition = { length: 13, complexity: 5 }) {
         if (!PASSWORD_COMPLEXITY[passwordCondition.complexity]) {
             const msg = messages.getMessage('complexityOutOfBound');
-            throw new sfdxError_1.SfdxError(msg, 'complexityOutOfBound');
+            throw new sfError_1.SfError(msg, 'complexityOutOfBound');
         }
         if (passwordCondition.length < 8 || passwordCondition.length > 1000) {
             const msg = messages.getMessage('lengthOutOfBound');
-            throw new sfdxError_1.SfdxError(msg, 'lengthOutOfBound');
+            throw new sfError_1.SfError(msg, 'lengthOutOfBound');
         }
         let password = [];
         ['SYMBOLS', 'NUMBERS', 'UPPER', 'LOWER'].forEach((charSet) => {
@@ -228,7 +228,6 @@ class User extends kit_1.AsyncCreatable {
             // eslint-disable-next-line @typescript-eslint/no-misused-promises
             password.value(async (buffer) => {
                 try {
-                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                     // @ts-ignore TODO: expose `soap` on Connection however appropriate
                     const soap = userConnection.soap;
                     await soap.setPassword((0, ts_types_1.ensureString)(info.getFields().userId), buffer.toString('utf8'));
@@ -294,6 +293,7 @@ class User extends kit_1.AsyncCreatable {
      * ```
      */
     async createUser(fields) {
+        var _a;
         // Create a user and get a refresh token
         const refreshTokenSecret = await this.createUserInternal(fields);
         // Create the initial auth info
@@ -301,7 +301,8 @@ class User extends kit_1.AsyncCreatable {
         const adminUserAuthFields = authInfo.getFields(true);
         // Setup oauth options for the new user
         const oauthOptions = {
-            loginUrl: adminUserAuthFields.loginUrl,
+            // Communities users require the instance for auth
+            loginUrl: (_a = adminUserAuthFields.instanceUrl) !== null && _a !== void 0 ? _a : adminUserAuthFields.loginUrl,
             refreshToken: refreshTokenSecret.buffer.value((buffer) => buffer.toString('utf8')),
             clientId: adminUserAuthFields.clientId,
             clientSecret: adminUserAuthFields.clientSecret,
@@ -406,7 +407,7 @@ class User extends kit_1.AsyncCreatable {
                 }
             }
             this.logger.debug(message);
-            throw new sfdxError_1.SfdxError(message, 'UserCreateHttpError');
+            throw new sfError_1.SfError(message, 'UserCreateHttpError');
         }
         fields.id = (0, ts_types_1.ensureString)(responseBody.id);
         await this.updateRequiredUserFields(fields);

package/lib/schema/printer.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaPrinter = exports.SchemaPropertyRenderer = void 0;
 const ts_types_1 = require("@salesforce/ts-types");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 /**
  * Renders schema properties.  By default, this is simply an identity transform.  Subclasses may provide more
  * interesting decorations of each values, such as ANSI coloring.
@@ -78,7 +78,7 @@ class SchemaPrinter {
             // No need to add to messages, since this should never happen. In fact,
             // this will cause a test failure if there is a command that uses a schema
             // with no properties defined.
-            throw new sfdxError_1.SfdxError('There is no purpose to print a schema with no properties or items');
+            throw new sfError_1.SfError('There is no purpose to print a schema with no properties or items');
         }
         const startLevel = 0;
         const add = this.addFn(startLevel);

package/lib/schema/validator.d.ts

@@ -27,8 +27,8 @@ export declare class SchemaValidator {
      * Performs validation of JSON data against the schema located at the `schemaPath` value provided
      * at instantiation.
      *
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.
@@ -38,8 +38,8 @@ export declare class SchemaValidator {
      * Performs validation of JSON data against the schema located at the `schemaPath` value provided
      * at instantiation.
      *
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.

package/lib/schema/validator.js

@@ -8,11 +8,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaValidator = void 0;
 const path = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const validator = require("jsen");
-const sfdxError_1 = require("../sfdxError");
-const fs_1 = require("../util/fs");
+const sfError_1 = require("../sfError");
 /**
  * Loads a JSON schema and performs validations against JSON objects.
  */
@@ -33,7 +33,7 @@ class SchemaValidator {
      */
     async load() {
         if (!this.schema) {
-            this.schema = await fs_1.fs.readJsonMap(this.schemaPath);
+            this.schema = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -43,7 +43,7 @@ class SchemaValidator {
      */
     loadSync() {
         if (!this.schema) {
-            this.schema = fs_1.fs.readJsonMapSync(this.schemaPath);
+            this.schema = (0, kit_1.parseJsonMap)(fs.readFileSync(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -52,8 +52,8 @@ class SchemaValidator {
      * Performs validation of JSON data against the schema located at the `schemaPath` value provided
      * at instantiation.
      *
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.
@@ -66,8 +66,8 @@ class SchemaValidator {
      * Performs validation of JSON data against the schema located at the `schemaPath` value provided
      * at instantiation.
      *
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
-     * **Throws** *{@link SfdxError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaFieldError' }* If there are known validations errors.
+     * **Throws** *{@link SfError}{ name: 'ValidationSchemaUnknownError' }* If there are unknown validations errors.
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.
@@ -85,10 +85,10 @@ class SchemaValidator {
         if (!validate(json)) {
             if (validate.errors) {
                 const errors = this.getErrorsText(validate.errors, schema);
-                throw new sfdxError_1.SfdxError(`Validation errors:\n${errors}`, 'ValidationSchemaFieldError');
+                throw new sfError_1.SfError(`Validation errors:\n${errors}`, 'ValidationSchemaFieldError');
             }
             else {
-                throw new sfdxError_1.SfdxError('Unknown schema validation error', 'ValidationSchemaUnknownError');
+                throw new sfError_1.SfError('Unknown schema validation error', 'ValidationSchemaUnknownError');
             }
         }
         return validate.build(json);
@@ -112,7 +112,7 @@ class SchemaValidator {
                 externalSchemas[externalSchema.id] = externalSchema;
             }
             else {
-                throw new sfdxError_1.SfdxError(`Unexpected external schema id type: ${typeof externalSchema.id}`, 'ValidationSchemaTypeError');
+                throw new sfError_1.SfError(`Unexpected external schema id type: ${typeof externalSchema.id}`, 'ValidationSchemaTypeError');
             }
         });
         return externalSchemas;
@@ -125,11 +125,11 @@ class SchemaValidator {
     loadExternalSchema(uri) {
         const schemaPath = path.join(this.schemasDir, `${uri}.json`);
         try {
-            return fs_1.fs.readJsonMapSync(schemaPath);
+            return (0, kit_1.parseJsonMap)(fs.readFileSync(schemaPath, 'utf8'));
         }
         catch (err) {
             if (err.code === 'ENOENT') {
-                throw new sfdxError_1.SfdxError(`Schema not found: ${schemaPath}`, 'ValidationSchemaNotFound');
+                throw new sfError_1.SfError(`Schema not found: ${schemaPath}`, 'ValidationSchemaNotFound');
             }
             throw err;
         }

package/lib/{sfdxError.d.ts → sfError.d.ts}

@@ -13,10 +13,10 @@ import { JsonMap } from '@salesforce/ts-types';
  * const messages = Messages.load('myPackageName', 'myBundleName');
  *
  * // To throw a non-bundle based error:
- * throw new SfdxError(message.getMessage('myError'), 'MyErrorName');
+ * throw new SfError(message.getMessage('myError'), 'MyErrorName');
  * ```
  */
-export declare class SfdxError extends NamedError {
+export declare class SfError extends NamedError {
     /**
      * Action messages. Hints to the users regarding what can be done to fix related issues.
      */
@@ -35,21 +35,21 @@ export declare class SfdxError extends NamedError {
      */
     private _code?;
     /**
-     * Create an SfdxError.
+     * Create an SfError.
      *
      * @param message The error message.
-     * @param name The error name. Defaults to 'SfdxError'.
+     * @param name The error name. Defaults to 'SfError'.
      * @param actions The action message(s).
      * @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.
      */
     constructor(message: string, name?: string, actions?: string[], exitCodeOrCause?: number | Error, cause?: Error);
     /**
-     * Convert an Error to an SfdxError.
+     * Convert an Error to an SfError.
      *
      * @param err The error to convert.
      */
-    static wrap(err: Error | string): SfdxError;
+    static wrap(err: Error | string): SfError;
     get code(): string | undefined | any;
     set code(code: string);
     /**
@@ -57,20 +57,20 @@ export declare class SfdxError extends NamedError {
      *
      * @param context The command name.
      */
-    setContext(context: string): SfdxError;
+    setContext(context: string): SfError;
     /**
      * An additional payload for the error. For convenience `this` object is returned.
      *
      * @param data The payload data.
      */
-    setData(data: unknown): SfdxError;
+    setData(data: unknown): SfError;
     /**
-     * Convert an {@link SfdxError} state to an object. Returns a plain object representing the state of this error.
+     * Convert an {@link SfError} state to an object. Returns a plain object representing the state of this error.
      */
     toObject(): JsonMap;
-    /**
-     * @deprecated Does nothing. Do not use. This is kept around to support older versions of SfdxCommand.
-     * @param commandName
-     */
-    setCommandName(): void;
+}
+/**
+ * @deprecated use SfError instead
+ */
+export declare class SfdxError extends SfError {
 }

package/lib/{sfdxError.js → sfError.js}

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SfdxError = void 0;
+exports.SfdxError = exports.SfError = void 0;
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 /**
@@ -22,22 +22,22 @@ const ts_types_1 = require("@salesforce/ts-types");
  * const messages = Messages.load('myPackageName', 'myBundleName');
  *
  * // To throw a non-bundle based error:
- * throw new SfdxError(message.getMessage('myError'), 'MyErrorName');
+ * throw new SfError(message.getMessage('myError'), 'MyErrorName');
  * ```
  */
-class SfdxError extends kit_1.NamedError {
+class SfError extends kit_1.NamedError {
     /**
-     * Create an SfdxError.
+     * Create an SfError.
      *
      * @param message The error message.
-     * @param name The error name. Defaults to 'SfdxError'.
+     * @param name The error name. Defaults to 'SfError'.
      * @param actions The action message(s).
      * @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.
      */
     constructor(message, name, actions, exitCodeOrCause, cause) {
         cause = exitCodeOrCause instanceof Error ? exitCodeOrCause : cause;
-        super(name || 'SfdxError', message || name, cause);
+        super(name || 'SfError', message || name, cause);
         this.actions = actions;
         if (typeof exitCodeOrCause === 'number') {
             this.exitCode = exitCodeOrCause;
@@ -47,23 +47,23 @@ class SfdxError extends kit_1.NamedError {
         }
     }
     /**
-     * Convert an Error to an SfdxError.
+     * Convert an Error to an SfError.
      *
      * @param err The error to convert.
      */
     static wrap(err) {
         if ((0, ts_types_1.isString)(err)) {
-            return new SfdxError(err);
+            return new SfError(err);
         }
-        if (err instanceof SfdxError) {
+        if (err instanceof SfError) {
             return err;
         }
-        const sfdxError = new SfdxError(err.message, err.name, undefined, err);
+        const sfError = new SfError(err.message, err.name, undefined, err);
         // If the original error has a code, use that instead of name.
         if ((0, ts_types_1.hasString)(err, 'code')) {
-            sfdxError.code = err.code;
+            sfError.code = err.code;
         }
-        return sfdxError;
+        return sfError;
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     get code() {
@@ -91,7 +91,7 @@ class SfdxError extends kit_1.NamedError {
         return this;
     }
     /**
-     * Convert an {@link SfdxError} state to an object. Returns a plain object representing the state of this error.
+     * Convert an {@link SfError} state to an object. Returns a plain object representing the state of this error.
      */
     toObject() {
         const obj = {
@@ -109,13 +109,12 @@ class SfdxError extends kit_1.NamedError {
         }
         return obj;
     }
-    /**
-     * @deprecated Does nothing. Do not use. This is kept around to support older versions of SfdxCommand.
-     * @param commandName
-     */
-    setCommandName() {
-        /** Do nothing. */
-    }
+}
+exports.SfError = SfError;
+/**
+ * @deprecated use SfError instead
+ */
+class SfdxError extends SfError {
 }
 exports.SfdxError = SfdxError;
-//# sourceMappingURL=sfdxError.js.map
+//# sourceMappingURL=sfError.js.map