@salesforce/core 3.19.0 → 3.19.3

package/lib/config/configGroup.js

@@ -0,0 +1,224 @@
+"use strict";
+/*
+ * Copyright (c) 2020, 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.ConfigGroup = void 0;
+const ts_types_1 = require("@salesforce/ts-types");
+const sfError_1 = require("../sfError");
+const configFile_1 = require("./configFile");
+/**
+ * A config file that stores config values in groups. e.g. to store different config
+ * values for different commands, without having manually manipulate the config.
+ *
+ * **Note:** All config methods are overwritten to use the {@link ConfigGroup.setDefaultGroup}.
+ *
+ * ```
+ * class MyPluginConfig extends ConfigGroup<ConfigGroup.Options> {
+ *   public static getFileName(): string {
+ *     return 'myPluginConfigFilename.json';
+ *   }
+ * }
+ * const myConfig = await MyPluginConfig.create(ConfigGroup.getOptions('all'));
+ * myConfig.setDefaultGroup('myCommand'); // Can be set in your command's init.
+ * myConfig.set('mykey', 'myvalue'); // Sets 'myKey' for the 'myCommand' group.
+ * myConfig.setInGroup('myKey', 'myvalue', 'all'); // Manually set in another group.
+ * await myConfig.write();
+ * ```
+ */
+class ConfigGroup extends configFile_1.ConfigFile {
+    constructor() {
+        super(...arguments);
+        this.defaultGroup = 'default';
+    }
+    /**
+     * Get ConfigGroup specific options, such as the default group.
+     *
+     * @param defaultGroup The default group to use when creating the config.
+     * @param filename The filename of the config file. Uses the static {@link getFileName} by default.
+     */
+    static getOptions(defaultGroup, filename) {
+        const options = configFile_1.ConfigFile.getDefaultOptions(true, filename);
+        const configGroupOptions = { defaultGroup };
+        Object.assign(configGroupOptions, options);
+        return configGroupOptions;
+    }
+    /**
+     * Sets the default group for all {@link BaseConfigStore} methods to use.
+     * **Throws** *{@link SfError}{ name: 'MissingGroupName' }* The group parameter is null or undefined.
+     *
+     * @param group The group.
+     */
+    setDefaultGroup(group) {
+        if (!group) {
+            throw new sfError_1.SfError('null or undefined group', 'MissingGroupName');
+        }
+        this.defaultGroup = group;
+    }
+    /**
+     * Set a group of entries in a bulk save. Returns The new properties that were saved.
+     *
+     * @param newEntries An object representing the aliases to set.
+     * @param group The group the property belongs to.
+     */
+    async updateValues(newEntries, group) {
+        // Make sure the contents are loaded
+        await this.read();
+        Object.entries(newEntries).forEach(([key, val]) => this.setInGroup(key, val, group || this.defaultGroup));
+        await this.write();
+        return newEntries;
+    }
+    /**
+     * Set a value on a group. Returns the promise resolved when the value is set.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @param group The group.
+     */
+    async updateValue(key, value, group) {
+        // Make sure the content is loaded
+        await this.read();
+        this.setInGroup(key, value, group || this.defaultGroup);
+        // Then save it
+        await this.write();
+    }
+    /**
+     * Gets an array of key value pairs.
+     */
+    entries() {
+        const group = this.getGroup();
+        if (group) {
+            return (0, ts_types_1.definiteEntriesOf)(group);
+        }
+        return [];
+    }
+    /**
+     * Returns a specified element from ConfigGroup. Returns the associated value.
+     *
+     * @param key The key.
+     */
+    get(key) {
+        return this.getInGroup(key);
+    }
+    /**
+     * Returns a boolean if an element with the specified key exists in the default group.
+     *
+     * @param {string} key The key.
+     */
+    has(key) {
+        const group = this.getGroup();
+        return !!group && super.has(this.defaultGroup) && !!group[key];
+    }
+    /**
+     * Returns an array of the keys from the default group.
+     */
+    keys() {
+        return Object.keys(this.getGroup(this.defaultGroup) || {});
+    }
+    /**
+     * Returns an array of the values from the default group.
+     */
+    values() {
+        return (0, ts_types_1.definiteValuesOf)(this.getGroup(this.defaultGroup) || {});
+    }
+    /**
+     * Add or updates an element with the specified key in the default group.
+     *
+     * @param key The key.
+     * @param value The value.
+     */
+    set(key, value) {
+        return this.setInGroup(key, value, this.defaultGroup);
+    }
+    /**
+     * Removes an element with the specified key from the default group. Returns `true` if the item was deleted.
+     *
+     * @param key The key.
+     */
+    unset(key) {
+        const groupContents = this.getGroup(this.defaultGroup);
+        if (groupContents) {
+            delete groupContents[key];
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Remove all key value pairs from the default group.
+     */
+    clear() {
+        delete this.getContents()[this.defaultGroup];
+    }
+    /**
+     * Get all config contents for a group.
+     *
+     * @param {string} [group = 'default'] The group.
+     */
+    getGroup(group = this.defaultGroup) {
+        return (0, ts_types_1.getJsonMap)(this.getContents(), group) || undefined;
+    }
+    /**
+     * Returns the value associated to the key and group, or undefined if there is none.
+     *
+     * @param key The key.
+     * @param group The group. Defaults to the default group.
+     */
+    getInGroup(key, group) {
+        const groupContents = this.getGroup(group);
+        if (groupContents) {
+            return groupContents[key];
+        }
+    }
+    /**
+     * Convert the config object to a json object.
+     */
+    toObject() {
+        return this.getContents();
+    }
+    /**
+     * Convert an object to a {@link ConfigContents} and set it as the config contents.
+     *
+     * @param {object} obj The object.
+     */
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    setContentsFromObject(obj) {
+        const contents = new Map(Object.entries(obj));
+        Array.from(contents.entries()).forEach(([groupKey, groupContents]) => {
+            if (groupContents) {
+                Object.entries(groupContents).forEach(([contentKey, contentValue]) => {
+                    this.setInGroup(contentKey, contentValue, groupKey);
+                });
+            }
+        });
+    }
+    /**
+     * Sets the value for the key and group in the config object.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @param group The group. Uses the default group if not specified.
+     */
+    setInGroup(key, value, group) {
+        group = group || this.defaultGroup;
+        if (!super.has(group)) {
+            super.set(group, {});
+        }
+        const content = this.getGroup(group) || {};
+        this.setMethod(content, key, value);
+        return content;
+    }
+    /**
+     * Initialize the asynchronous dependencies.
+     */
+    async init() {
+        await super.init();
+        if (this.options.defaultGroup) {
+            this.setDefaultGroup(this.options.defaultGroup);
+        }
+    }
+}
+exports.ConfigGroup = ConfigGroup;
+//# sourceMappingURL=configGroup.js.map

package/lib/config/configStore.d.ts

@@ -12,7 +12,7 @@ export declare type ConfigEntry = [string, ConfigValue];
 /**
  * The type of content a config stores.
  */
-export declare type ConfigContents = Dictionary<ConfigValue>;
+export declare type ConfigContents<T = ConfigValue> = Dictionary<T>;
 export declare type Key<P extends ConfigContents> = Extract<keyof P, string>;
 /**
  * An interface for a config object with a persistent store.
@@ -166,7 +166,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      *
      * @param obj The object.
      */
-    setContentsFromObject<U extends object>(obj: U): void;
+    setContentsFromObject<U extends JsonMap>(obj: U): void;
     protected getEncryptedKeys(): Array<string | RegExp>;
     /**
      * This config file has encrypted keys and it should attempt to encrypt them.

package/lib/config/configStore.js

@@ -198,9 +198,8 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
      *
      * @param obj The object.
      */
-    // eslint-disable-next-line @typescript-eslint/ban-types
     setContentsFromObject(obj) {
-        this.contents = {};
+        this.contents = (this.hasEncryption() ? this.recursiveEncrypt(obj) : {});
         Object.entries(obj).forEach(([key, value]) => {
             this.setMethod(this.contents, key, value);
         });

package/lib/config/envVars.d.ts

@@ -87,10 +87,9 @@ declare type EnvType = {
 export declare const SUPPORTED_ENV_VARS: EnvType;
 export declare class EnvVars extends Env {
     constructor(env?: NodeJS.ProcessEnv);
+    static propertyToEnvName(property: string, prefix?: string): string;
     private static defaultPrefix;
-    propertyToEnvName(property: string, prefix?: string | undefined): string;
-    setPropertyFromEnv(property: string, prefix?: string | undefined): void;
-    getPropertyFromEnv<T>(property: string, prefix?: string | undefined): T | undefined;
+    getPropertyFromEnv<T>(property: string, prefix?: string): Nullable<T>;
     asDictionary(): Dictionary<unknown>;
     asMap(): Map<string, string>;
     private resolve;

package/lib/config/envVars.js

@@ -337,7 +337,7 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT]: {
         description: getMessage(EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT),
-        synonymOf: null,
+        synonymOf: EnvironmentVariable.SFDX_MAX_QUERY_LIMIT,
     },
     [EnvironmentVariable.SF_MDAPI_TEMP_DIR]: {
         description: getMessage(EnvironmentVariable.SF_MDAPI_TEMP_DIR),
@@ -397,6 +397,9 @@ class EnvVars extends kit_1.Env {
         super(env);
         this.resolve();
     }
+    static propertyToEnvName(property, prefix = EnvVars.defaultPrefix()) {
+        return `${prefix || ''}${(0, change_case_1.snakeCase)(property).toUpperCase()}`;
+    }
     static defaultPrefix() {
         if (process.argv[0].startsWith('sfdx'))
             return 'SFDX_';
@@ -404,19 +407,11 @@ class EnvVars extends kit_1.Env {
             return 'SF_';
         return 'SFDX_';
     }
-    propertyToEnvName(property, prefix = EnvVars.defaultPrefix()) {
-        return `${prefix || ''}${(0, change_case_1.snakeCase)(property).toUpperCase()}`;
-    }
-    setPropertyFromEnv(property, prefix = EnvVars.defaultPrefix()) {
-        const envName = this.propertyToEnvName(property, prefix);
-        const value = this.getString(envName);
-        if (value) {
-            this.setString(property, value);
-        }
-    }
     getPropertyFromEnv(property, prefix = EnvVars.defaultPrefix()) {
-        const envName = this.propertyToEnvName(property, prefix);
-        return this.get(envName);
+        var _a;
+        const envName = EnvVars.propertyToEnvName(property, prefix);
+        const synonym = (_a = exports.SUPPORTED_ENV_VARS[envName]) === null || _a === void 0 ? void 0 : _a.synonymOf;
+        return this.get(envName) || this.get(synonym);
     }
     asDictionary() {
         return this.entries().reduce((accumulator, [key, value]) => {

package/lib/config/tokensConfig.d.ts

@@ -0,0 +1,10 @@
+import { Optional } from '@salesforce/ts-types';
+import { SfTokens } from '../stateAggregator';
+import { ConfigFile } from './configFile';
+import { ConfigContents, ConfigValue } from './configStore';
+export declare class TokensConfig extends ConfigFile<ConfigFile.Options, SfTokens> {
+    protected static encryptedKeys: RegExp[];
+    static getDefaultOptions(): ConfigFile.Options;
+    protected getMethod(contents: ConfigContents, key: string): Optional<ConfigValue>;
+    protected setMethod(contents: ConfigContents, key: string, value?: ConfigValue): void;
+}

package/lib/config/tokensConfig.js

@@ -0,0 +1,28 @@
+"use strict";
+/*
+ * Copyright (c) 2022, 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.TokensConfig = void 0;
+const configFile_1 = require("./configFile");
+class TokensConfig extends configFile_1.ConfigFile {
+    static getDefaultOptions() {
+        return {
+            isGlobal: true,
+            isState: true,
+            filename: 'tokens.json',
+        };
+    }
+    getMethod(contents, key) {
+        return contents[key];
+    }
+    setMethod(contents, key, value) {
+        contents[key] = value;
+    }
+}
+exports.TokensConfig = TokensConfig;
+TokensConfig.encryptedKeys = [/token/gi, /password/gi, /secret/gi];
+//# sourceMappingURL=tokensConfig.js.map

package/lib/crypto/keyChainImpl.js

@@ -317,7 +317,7 @@ const _darwinImpl = {
         }
     },
 };
-const getSecretFile = () => path.join(global_1.Global.SFDX_DIR, 'key.json');
+const getSecretFile = () => path.join(global_1.Global.DIR, 'key.json');
 var SecretField;
 (function (SecretField) {
     SecretField["SERVICE"] = "service";

package/lib/exported.d.ts

@@ -3,7 +3,7 @@ export { ConfigFile } from './config/configFile';
 export { TTLConfig } from './config/ttlConfig';
 export { envVars, EnvironmentVariable, SUPPORTED_ENV_VARS, EnvVars } from './config/envVars';
 export { BaseConfigStore, ConfigContents, ConfigEntry, ConfigStore, ConfigValue } from './config/configStore';
-export { GlobalInfo, SfEntry, SfInfo, SfInfoKeys, SfOrg, SfOrgs, SfToken, SfTokens } from './globalInfo';
+export { GlobalInfo, SfEntry, SfInfo, SfInfoKeys, SfOrg, SfOrgs, SfToken, SfTokens, StateAggregator, } from './stateAggregator';
 export { DeviceOauthService, DeviceCodeResponse, DeviceCodePollingResponse } from './deviceOauthService';
 export { OrgUsersConfig } from './config/orgUsersConfig';
 export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SfConfigProperties, SFDX_ALLOWED_PROPERTIES, SF_ALLOWED_PROPERTIES, } from './config/config';

package/lib/exported.js

@@ -16,8 +16,8 @@ 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.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.SfdxConfigAggregator = exports.ConfigAggregator = exports.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = 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.TTLConfig = exports.ConfigFile = void 0;
-exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.scratchOrgResume = exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = void 0;
+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.SfdxConfigAggregator = exports.ConfigAggregator = exports.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.StateAggregator = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
+exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.scratchOrgResume = exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -31,9 +31,10 @@ Object.defineProperty(exports, "SUPPORTED_ENV_VARS", { enumerable: true, get: fu
 Object.defineProperty(exports, "EnvVars", { enumerable: true, get: function () { return envVars_1.EnvVars; } });
 var configStore_1 = require("./config/configStore");
 Object.defineProperty(exports, "BaseConfigStore", { enumerable: true, get: function () { return configStore_1.BaseConfigStore; } });
-var globalInfo_1 = require("./globalInfo");
-Object.defineProperty(exports, "GlobalInfo", { enumerable: true, get: function () { return globalInfo_1.GlobalInfo; } });
-Object.defineProperty(exports, "SfInfoKeys", { enumerable: true, get: function () { return globalInfo_1.SfInfoKeys; } });
+var stateAggregator_1 = require("./stateAggregator");
+Object.defineProperty(exports, "GlobalInfo", { enumerable: true, get: function () { return stateAggregator_1.GlobalInfo; } });
+Object.defineProperty(exports, "SfInfoKeys", { enumerable: true, get: function () { return stateAggregator_1.SfInfoKeys; } });
+Object.defineProperty(exports, "StateAggregator", { enumerable: true, get: function () { return stateAggregator_1.StateAggregator; } });
 var deviceOauthService_1 = require("./deviceOauthService");
 Object.defineProperty(exports, "DeviceOauthService", { enumerable: true, get: function () { return deviceOauthService_1.DeviceOauthService; } });
 var orgUsersConfig_1 = require("./config/orgUsersConfig");

package/lib/global.d.ts

@@ -28,6 +28,10 @@ export declare class Global {
      * The global folder in which sf state is stored.
      */
     static readonly SF_STATE_FOLDER = ".sf";
+    /**
+     * The peferred global folder in which state is stored.
+     */
+    static readonly STATE_FOLDER = ".sfdx";
     /**
      * The full system path to the global sfdx state folder.
      *
@@ -40,6 +44,10 @@ export declare class Global {
      * **See** {@link Global.SF_STATE_FOLDER}
      */
     static get SF_DIR(): string;
+    /**
+     * The full system path to the peferred global state folder
+     */
+    static get DIR(): string;
     /**
      * The full system path to the global log file.
      */

package/lib/global.js

@@ -44,6 +44,12 @@ class Global {
     static get SF_DIR() {
         return path.join(os.homedir(), Global.SF_STATE_FOLDER);
     }
+    /**
+     * The full system path to the peferred global state folder
+     */
+    static get DIR() {
+        return path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
+    }
     /**
      * Gets the current mode environment variable as a {@link Mode} instance.
      *
@@ -80,6 +86,10 @@ Global.SFDX_STATE_FOLDER = '.sfdx';
  * The global folder in which sf state is stored.
  */
 Global.SF_STATE_FOLDER = '.sf';
+/**
+ * The peferred global folder in which state is stored.
+ */
+Global.STATE_FOLDER = Global.SFDX_STATE_FOLDER;
 /**
  * The full system path to the global log file.
  */

package/lib/org/authInfo.d.ts

@@ -126,7 +126,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;
     /**
@@ -289,7 +289,8 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     private loadDecryptedAuthFromConfig;
     private isTokenOptions;
     private refreshFn;
-    private buildJwtConfig;
+    private authJwt;
+    private tryJwtAuth;
     private buildRefreshTokenConfig;
     /**
      * Performs an authCode exchange but the Oauth2 feature of jsforce is extended to include a code_challenge