@salesforce/core 3.32.14 → 3.33.0

package/lib/messages.d.ts

@@ -253,6 +253,20 @@ export declare class Messages<T extends string> {
      * @param cause The underlying error that caused this error to be raised.
      */
     createError(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfError;
+    /**
+     * SfError wants error names to end with the suffix Error.  Use this to create errors while preserving their existing name (for compatibility reasons).
+     *
+     * @deprecated Use `createError` instead unless you need to preserver the error name to avoid breaking changes.
+     * `error.name` will be the upper-cased key, remove prefixed `error.`.
+     * `error.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the error message.
+     * @param tokens The error message tokens.
+     * @param actionTokens The action messages tokens.
+     * @param exitCodeOrCause The exit code which will be used by SfdxCommand or the underlying error that caused this error to be raised.
+     * @param cause The underlying error that caused this error to be raised.
+     */
+    createErrorButPreserveName(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfError;
     /**
      * Convenience method to create warning using message labels.
      *
@@ -285,6 +299,7 @@ export declare class Messages<T extends string> {
      * @param key The key of the warning message.
      * @param tokens The warning message tokens.
      * @param actionTokens The action messages tokens.
+     * @param preserveName Do not require that the name end in the type ('error' | 'warning' | 'info').
      */
     private formatMessageContents;
     private getMessageWithMap;

package/lib/messages.js

@@ -442,8 +442,36 @@ class Messages {
      * @param cause The underlying error that caused this error to be raised.
      */
     createError(key, tokens = [], actionTokens = [], exitCodeOrCause, cause) {
-        const structuredMessage = this.formatMessageContents('error', key, tokens, actionTokens);
-        return new sfError_1.SfError(structuredMessage.message, structuredMessage.name, structuredMessage.actions, exitCodeOrCause, cause);
+        const { message, name, actions } = this.formatMessageContents({
+            type: 'error',
+            key,
+            tokens,
+            actionTokens,
+        });
+        return new sfError_1.SfError(message, name, actions, exitCodeOrCause, cause);
+    }
+    /**
+     * SfError wants error names to end with the suffix Error.  Use this to create errors while preserving their existing name (for compatibility reasons).
+     *
+     * @deprecated Use `createError` instead unless you need to preserver the error name to avoid breaking changes.
+     * `error.name` will be the upper-cased key, remove prefixed `error.`.
+     * `error.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the error message.
+     * @param tokens The error message tokens.
+     * @param actionTokens The action messages tokens.
+     * @param exitCodeOrCause The exit code which will be used by SfdxCommand or the underlying error that caused this error to be raised.
+     * @param cause The underlying error that caused this error to be raised.
+     */
+    createErrorButPreserveName(key, tokens = [], actionTokens = [], exitCodeOrCause, cause) {
+        const { message, name, actions } = this.formatMessageContents({
+            type: 'error',
+            key,
+            tokens,
+            actionTokens,
+            preserveName: true,
+        });
+        return new sfError_1.SfError(message, name, actions, exitCodeOrCause, cause);
     }
     /**
      * Convenience method to create warning using message labels.
@@ -456,7 +484,7 @@ class Messages {
      * @param actionTokens The action messages tokens.
      */
     createWarning(key, tokens = [], actionTokens = []) {
-        return this.formatMessageContents('warning', key, tokens, actionTokens);
+        return this.formatMessageContents({ type: 'warning', key, tokens, actionTokens });
     }
     /**
      * Convenience method to create info using message labels.
@@ -469,7 +497,7 @@ class Messages {
      * @param actionTokens The action messages tokens.
      */
     createInfo(key, tokens = [], actionTokens = []) {
-        return this.formatMessageContents('info', key, tokens, actionTokens);
+        return this.formatMessageContents({ type: 'info', key, tokens, actionTokens });
     }
     /**
      * Formats message contents given a message type, key, tokens and actions tokens
@@ -481,8 +509,9 @@ class Messages {
      * @param key The key of the warning message.
      * @param tokens The warning message tokens.
      * @param actionTokens The action messages tokens.
+     * @param preserveName Do not require that the name end in the type ('error' | 'warning' | 'info').
      */
-    formatMessageContents(type, key, tokens = [], actionTokens = []) {
+    formatMessageContents({ type, key, tokens = [], actionTokens = [], preserveName = false, }) {
         const label = (0, kit_1.upperFirst)(type);
         const labelRegExp = new RegExp(`${label}$`);
         const searchValue = type === 'error' ? /^error.*\./ : new RegExp(`^${type}.`);
@@ -490,7 +519,7 @@ class Messages {
         //     'myMessage' -> `MyMessageWarning`
         //     'myMessageError' -> `MyMessageError`
         //     'warning.myMessage' -> `MyMessageWarning`
-        const name = `${(0, kit_1.upperFirst)(key.replace(searchValue, ''))}${labelRegExp.exec(key) ? '' : label}`;
+        const name = `${(0, kit_1.upperFirst)(key.replace(searchValue, ''))}${labelRegExp.exec(key) || preserveName ? '' : label}`;
         const message = this.getMessage(key, tokens);
         let actions;
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.32.14",
+  "version": "3.33.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",