@salesforce/core 4.0.0 → 4.0.1

package/lib/messages.js

@@ -13,16 +13,8 @@ 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");
-class Key {
-    constructor(packageName, bundleName) {
-        this.packageName = packageName;
-        this.bundleName = bundleName;
-    }
-    toString() {
-        return `${this.packageName}:${this.bundleName}`;
-    }
-}
+const sfError_1 = require("./sfError");
+const getKey = (packageName, bundleName) => `${packageName}:${bundleName}`;
 const REGEXP_NO_CONTENT = /^\s*$/g;
 const REGEXP_NO_CONTENT_SECTION = /^#\s*/gm;
 const REGEXP_MD_IS_LIST_ROW = /^[*-]\s+|^ {2}/;
@@ -57,7 +49,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.`);
         }
     }
@@ -148,7 +140,7 @@ const jsAndJsonLoader = (filePath, fileContents) => {
  *
  * // Now you can use the messages from anywhere in your code or file.
  * // If using importMessageDirectory, the bundle name is the file name.
- * const messages: Messages = Messages.load(packageName, bundleName);
+ * const messages: Messages = Messages.loadMessages(packageName, bundleName);
  *
  * // Messages now contains all the message in the bundleName file.
  * messages.getMessage('authInfoCreationError');
@@ -158,7 +150,7 @@ class Messages {
     /**
      * Create a new messages bundle.
      *
-     * **Note:** Use {Messages.load} unless you are writing your own loader function.
+     * **Note:** Use {Messages.loadMessages} unless you are writing your own loader function.
      *
      * @param bundleName The bundle name.
      * @param locale The locale.
@@ -177,14 +169,14 @@ class Messages {
         return 'en_US';
     }
     /**
-     * Set a custom loader function for a package and bundle that will be called on {@link Messages.load}.
+     * Set a custom loader function for a package and bundle that will be called on {@link Messages.loadMessages}.
      *
      * @param packageName The npm package name.
      * @param bundle The name of the bundle.
      * @param loader The loader function.
      */
     static setLoaderFunction(packageName, bundle, loader) {
-        this.loaders.set(new Key(packageName, bundle).toString(), loader);
+        this.loaders.set(getKey(packageName, bundle), loader);
     }
     /**
      * Generate a file loading function. Use {@link Messages.importMessageFile} unless
@@ -217,7 +209,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);
@@ -239,7 +231,7 @@ class Messages {
     }
     /**
      * Import all json and js files in a messages directory. Use the file name as the bundle key when
-     * {@link Messages.load} is called. By default, we're assuming the moduleDirectoryPart is a
+     * {@link Messages.loadMessages} is called. By default, we're assuming the moduleDirectoryPart is a
      * typescript project and will truncate to root path (where the package.json file is). If your messages
      * directory is in another spot or you are not using typescript, pass in false for truncateToProjectPath.
      *
@@ -304,83 +296,33 @@ class Messages {
      * Load messages for a given package and bundle. If the bundle is not already cached, use the loader function
      * created from {@link Messages.setLoaderFunction} or {@link Messages.importMessagesDirectory}.
      *
-     * **NOTE: Use {@link Messages.load} instead for safe message validation and usage.**
-     *
      * ```typescript
      * Messages.importMessagesDirectory(__dirname);
-     * const messages = Messages.load('packageName', 'bundleName');
+     * const messages = Messages.loadMessages('packageName', 'bundleName');
      * ```
      *
      * @param packageName The name of the npm package.
      * @param bundleName The name of the bundle to load.
      */
     static loadMessages(packageName, bundleName) {
-        const key = new Key(packageName, bundleName);
-        let messages;
-        if (this.isCached(packageName, bundleName)) {
-            messages = this.bundles.get(key.toString());
-        }
-        else if (this.loaders.has(key.toString())) {
-            const loader = this.loaders.get(key.toString());
-            if (loader) {
-                messages = loader(Messages.getLocale());
-                this.bundles.set(key.toString(), messages);
-                messages = this.bundles.get(key.toString());
-            }
-        }
-        if (messages) {
-            return messages;
-        }
-        // Don't use messages inside messages
-        throw new kit_1.NamedError('MissingBundleError', `Missing bundle ${key.toString()} for locale ${Messages.getLocale()}.`);
-    }
-    /**
-     * Load messages for a given package and bundle. If the bundle is not already cached, use the loader function
-     * created from {@link Messages.setLoaderFunction} or {@link Messages.importMessagesDirectory}.
-     *
-     * The message keys that will be used must be passed in for validation. This prevents runtime errors if messages are used but not defined.
-     *
-     * **NOTE: This should be defined at the top of the file so validation is done at load time rather than runtime.**
-     *
-     * ```typescript
-     * Messages.importMessagesDirectory(__dirname);
-     * const messages = Messages.load('packageName', 'bundleName', [
-     *   'messageKey1',
-     *   'messageKey2',
-     * ]);
-     * ```
-     *
-     * @param packageName The name of the npm package.
-     * @param bundleName The name of the bundle to load.
-     * @param keys The message keys that will be used.
-     */
-    static load(packageName, bundleName, keys) {
-        const key = new Key(packageName, bundleName);
+        const key = getKey(packageName, bundleName);
         let messages;
         if (this.isCached(packageName, bundleName)) {
-            messages = this.bundles.get(key.toString());
+            messages = this.bundles.get(key);
         }
-        else if (this.loaders.has(key.toString())) {
-            const loader = this.loaders.get(key.toString());
+        else if (this.loaders.has(key)) {
+            const loader = this.loaders.get(key);
             if (loader) {
                 messages = loader(Messages.getLocale());
-                this.bundles.set(key.toString(), messages);
-                messages = this.bundles.get(key.toString());
+                this.bundles.set(key, messages);
+                messages = this.bundles.get(key);
             }
         }
         if (messages) {
-            // Type guard on key length, but do a runtime check.
-            if (!keys || keys.length === 0) {
-                throw new kit_1.NamedError('MissingKeysError', 'Can not load messages without providing the message keys that will be used.');
-            }
-            // Get all messages to validate they are actually present
-            for (const messageKey of keys) {
-                messages.getMessage(messageKey);
-            }
             return messages;
         }
         // Don't use messages inside messages
-        throw new kit_1.NamedError('MissingBundleError', `Missing bundle ${key.toString()} for locale ${Messages.getLocale()}.`);
+        throw new kit_1.NamedError('MissingBundleError', `Missing bundle ${key} for locale ${Messages.getLocale()}.`);
     }
     /**
      * Check if a bundle already been loaded.
@@ -389,7 +331,7 @@ class Messages {
      * @param bundleName The bundle name.
      */
     static isCached(packageName, bundleName) {
-        return this.bundles.has(new Key(packageName, bundleName).toString());
+        return this.bundles.has(getKey(packageName, bundleName));
     }
     /**
      * Get a message using a message key and use the tokens as values for tokenization.
@@ -438,25 +380,74 @@ class Messages {
      * @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 he underlying error that caused this error to be raised.
+     * @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.
      */
     createError(key, tokens = [], actionTokens = [], exitCodeOrCause, cause) {
+        const { message, name, actions } = this.formatMessageContents({
+            type: 'error',
+            key,
+            tokens,
+            actionTokens,
+        });
+        return new sfError_1.SfError(message, name, actions, exitCodeOrCause, cause);
+    }
+    /**
+     * Convenience method to create warning using message labels.
+     *
+     * `warning.name` will be the upper-cased key, remove prefixed `warning.` and will always end in Warning.
+     * `warning.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the warning message.
+     * @param tokens The warning message tokens.
+     * @param actionTokens The action messages tokens.
+     */
+    createWarning(key, tokens = [], actionTokens = []) {
+        return this.formatMessageContents({ type: 'warning', key, tokens, actionTokens });
+    }
+    /**
+     * Convenience method to create info using message labels.
+     *
+     * `info.name` will be the upper-cased key, remove prefixed `info.` and will always end in Info.
+     * `info.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the warning message.
+     * @param tokens The warning message tokens.
+     * @param actionTokens The action messages tokens.
+     */
+    createInfo(key, tokens = [], actionTokens = []) {
+        return this.formatMessageContents({ type: 'info', key, tokens, actionTokens });
+    }
+    /**
+     * Formats message contents given a message type, key, tokens and actions tokens
+     *
+     * `<type>.name` will be the upper-cased key, remove prefixed `<type>.` and will always end in 'Error | Warning | Info.
+     * `<type>.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param type The type of the message set must 'error' | 'warning' | 'info'.
+     * @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 = [], preserveName = false, }) {
+        const label = (0, kit_1.upperFirst)(type);
+        const labelRegExp = new RegExp(`${label}$`);
+        const searchValue = type === 'error' ? /^error.*\./ : new RegExp(`^${type}.`);
         // Convert key to name:
-        //     'myMessage' -> `MyMessageError`
+        //     'myMessage' -> `MyMessageWarning`
         //     'myMessageError' -> `MyMessageError`
-        //     'error.myMessage' -> `MyMessageError`
-        //     'errors.myMessage' -> `MyMessageError`
-        const errName = `${(0, kit_1.upperFirst)(key.replace(/^errors*\./, ''))}${/Error$/.exec(key) ? '' : 'Error'}`;
-        const errMessage = this.getMessage(key, tokens);
-        let errActions;
+        //     'warning.myMessage' -> `MyMessageWarning`
+        const name = `${(0, kit_1.upperFirst)(key.replace(searchValue, ''))}${labelRegExp.exec(key) || preserveName ? '' : label}`;
+        const message = this.getMessage(key, tokens);
+        let actions;
         try {
-            errActions = this.getMessageWithMap(`${key}.actions`, actionTokens, this.messages);
+            actions = this.getMessageWithMap(`${key}.actions`, actionTokens, this.messages);
         }
         catch (e) {
             /* just ignore if actions aren't found */
         }
-        return new sfdxError_1.SfdxError(errMessage, errName, errActions, exitCodeOrCause, cause);
+        return { message, name, actions };
     }
     getMessageWithMap(key, tokens = [], map) {
         // Allow nested keys for better grouping
@@ -470,12 +461,12 @@ class Messages {
                 return this.getMessageWithMap(childKey, tokens, childMap);
             }
         }
-        if (!map.has(key)) {
+        const msg = map.get(key);
+        if (!msg) {
             // Don't use messages inside messages
             throw new kit_1.NamedError('MissingMessageError', `Missing message ${this.bundleName}:${key} for locale ${Messages.getLocale()}.`);
         }
-        const msg = map.get(key);
-        const messages = ((0, ts_types_1.isArray)(msg) ? msg : [msg]);
+        const messages = (0, kit_1.ensureArray)(msg);
         return messages.map((message) => {
             (0, ts_types_1.ensureString)(message);
             return util.format(message, ...tokens);
@@ -496,7 +487,6 @@ Messages.bundles = new Map();
  * @param filePath read file target.
  * @ignore
  */
-Messages.readFile = (filePath) => {
-    return require(filePath);
-};
+// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+Messages.readFile = (filePath) => require(filePath);
 //# sourceMappingURL=messages.js.map

package/lib/org/authInfo.d.ts

@@ -1,18 +1,12 @@
 import { AsyncOptionalCreatable } from '@salesforce/kit';
 import { Nullable } from '@salesforce/ts-types';
-import { OAuth2, OAuth2Config as JsforceOAuth2Config } from 'jsforce';
+import { JwtOAuth2Config, OAuth2 } from 'jsforce';
 import { Connection } from './connection';
-export declare type OAuth2Config = JsforceOAuth2Config & {
-    privateKey?: string;
-    privateKeyFile?: string;
-    authCode?: string;
-    refreshToken?: string;
-    loginUrl?: string;
-};
+import { Org } from './org';
 /**
  * Fields for authorization, org, and local information.
  */
-export declare type AuthFields = {
+export type AuthFields = {
     accessToken?: string;
     alias?: string;
     authCode?: string;
@@ -37,8 +31,15 @@ export declare type AuthFields = {
     usernames?: string[];
     userProfileName?: string;
     expirationDate?: string;
+    tracksSource?: boolean;
+    [Org.Fields.NAME]?: string;
+    [Org.Fields.INSTANCE_NAME]?: string;
+    [Org.Fields.NAMESPACE_PREFIX]?: Nullable<string>;
+    [Org.Fields.IS_SANDBOX]?: boolean;
+    [Org.Fields.IS_SCRATCH]?: boolean;
+    [Org.Fields.TRIAL_EXPIRATION_DATE]?: Nullable<string>;
 };
-export declare type OrgAuthorization = {
+export type OrgAuthorization = {
     orgId: string;
     username: string;
     oauthMethod: 'jwt' | 'web' | 'token' | 'unknown';
@@ -46,6 +47,7 @@ export declare type OrgAuthorization = {
     configs: Nullable<string[]>;
     isScratchOrg?: boolean;
     isDevHub?: boolean;
+    isSandbox?: boolean;
     instanceUrl?: string;
     accessToken?: string;
     error?: string;
@@ -59,18 +61,24 @@ export interface AccessTokenOptions {
     loginUrl?: string;
     instanceUrl?: string;
 }
+export type AuthSideEffects = {
+    alias?: string;
+    setDefault: boolean;
+    setDefaultDevHub: boolean;
+    setTracksSource?: boolean;
+};
 /**
  * A function to update a refresh token when the access token is expired.
  */
-export declare type RefreshFn = (conn: Connection, callback: (err: Nullable<Error>, accessToken?: string, res?: Record<string, unknown>) => Promise<void>) => Promise<void>;
+export type RefreshFn = (conn: Connection, callback: (err: Nullable<Error>, accessToken?: string, res?: Record<string, unknown>) => Promise<void>) => Promise<void>;
 /**
  * Options for {@link Connection}.
  */
-export declare type ConnectionOptions = AuthFields & {
+export type ConnectionOptions = AuthFields & {
     /**
      * OAuth options.
      */
-    oauth2?: Partial<OAuth2Config>;
+    oauth2?: Partial<JwtOAuth2Config>;
     /**
      * Refresh token callback.
      */
@@ -78,8 +86,7 @@ export declare type ConnectionOptions = AuthFields & {
 };
 export declare const DEFAULT_CONNECTED_APP_INFO: {
     clientId: string;
-    legacyClientId: string;
-    legacyClientSecret: string;
+    clientSecret: string;
 };
 /**
  * Handles persistence and fetching of user authentication information using
@@ -118,7 +125,7 @@ export declare const DEFAULT_CONNECTED_APP_INFO: {
 export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     private usingAccessToken;
     private logger;
-    private globalInfo;
+    private stateAggregator;
     private username;
     private options;
     /**
@@ -153,7 +160,7 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      *
      * @param options The options to generate the URL.
      */
-    static getAuthorizationUrl(options: OAuth2Config & {
+    static getAuthorizationUrl(options: JwtOAuth2Config & {
         scope?: string;
     }, oauth2?: OAuth2): string;
     /**
@@ -166,6 +173,19 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * @param sfdxAuthUrl
      */
     static parseSfdxAuthUrl(sfdxAuthUrl: string): Pick<AuthFields, 'clientId' | 'clientSecret' | 'refreshToken' | 'loginUrl'>;
+    /**
+     * Given a set of decrypted fields and an authInfo, determine if the org belongs to an available
+     * dev hub.
+     *
+     * @param fields
+     * @param orgAuthInfo
+     */
+    static identifyPossibleScratchOrgs(fields: AuthFields, orgAuthInfo: AuthInfo): Promise<void>;
+    /**
+     * Find all dev hubs available in the local environment.
+     */
+    static getDevHubAuthInfos(): Promise<OrgAuthorization[]>;
+    private static queryScratchOrg;
     /**
      * Get the username.
      */
@@ -225,6 +245,14 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * **See** [SFDX Authorization](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_auth.htm#cli_reference_force_auth)
      */
     getSfdxAuthUrl(): string;
+    /**
+     * Convenience function to handle typical side effects encountered when dealing with an AuthInfo.
+     * Given the values supplied in parameter sideEffects, this function will set auth alias, default auth
+     * and default dev hub.
+     *
+     * @param sideEffects - instance of AuthSideEffects
+     */
+    handleAliasAndDefaultSettings(sideEffects: AuthSideEffects): Promise<void>;
     /**
      * Set the target-env (default) or the target-dev-hub to the alias if
      * it exists otherwise to the username. Method will try to set the local
@@ -253,14 +281,16 @@ 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;
     private loadDecryptedAuthFromConfig;
     private isTokenOptions;
     private refreshFn;
-    private buildJwtConfig;
+    private readJwtKey;
+    private authJwt;
+    private tryJwtAuth;
     private buildRefreshTokenConfig;
     /**
      * Performs an authCode exchange but the Oauth2 feature of jsforce is extended to include a code_challenge
@@ -277,6 +307,12 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * @private
      */
     private throwUserGetException;
+    /**
+     * Returns `true` if the org is a Dev Hub.
+     *
+     * Check access to the ScratchOrgInfo object to determine if the org is a dev hub.
+     */
+    private determineIfDevHub;
 }
 export declare namespace AuthInfo {
     /**
@@ -290,7 +326,7 @@ export declare namespace AuthInfo {
         /**
          * OAuth options.
          */
-        oauth2Options?: OAuth2Config;
+        oauth2Options?: JwtOAuth2Config;
         /**
          * Options for the access token auth.
          */