@salesforce/core 3.19.0 → 3.19.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.19.3](https://github.com/forcedotcom/sfdx-core/compare/v3.19.2...v3.19.3) (2022-06-06)
+
+### [3.19.2](https://github.com/forcedotcom/sfdx-core/compare/v3.19.1...v3.19.2) (2022-06-02)
+
+### Bug Fixes
+
+- loosen audience url determination ([#588](https://github.com/forcedotcom/sfdx-core/issues/588)) ([a58ab89](https://github.com/forcedotcom/sfdx-core/commit/a58ab89e2ada34fbdb6d8c72d88966a5281db60b))
+
+### [3.19.1](https://github.com/forcedotcom/sfdx-core/compare/v3.19.0...v3.19.1) (2022-05-27)
+
+### Bug Fixes
+
+- env var resolution in ConfigAggregator ([#590](https://github.com/forcedotcom/sfdx-core/issues/590)) ([a65cfbd](https://github.com/forcedotcom/sfdx-core/commit/a65cfbdd0e2a6c3806aa4da3270b237f68b37133))
+
 ## [3.19.0](https://github.com/forcedotcom/sfdx-core/compare/v3.18.3...v3.19.0) (2022-05-20)
 
 ### Features

package/README.md

@@ -36,14 +36,8 @@ const $$ = testSetup();
 describe('Mocking Auth data', () => {
   it('example', async () => {
     const testData = new MockTestOrgData();
-    $$.setConfigStubContents('GlobalInfo', {
-      contents: {
-        orgs: {
-          [testData.username]: await testData.getConfig(),
-        },
-      },
-    });
-    const auth: AuthInfo = await AuthInfo.create({ username: testData.username });
+    await $$.stubAuths(testData)
+    const auth = await AuthInfo.create({ username: testData.username });
     strictEqual(auth.getUsername(), testData.username);
   });
 });
@@ -65,25 +59,19 @@ describe('Mocking a force server call', () => {
   it('example', async () => {
     const records: AnyJson = { records: ['123456', '234567'] };
     const testData = new MockTestOrgData();
-    $$.setConfigStubContents('GlobalInfo', {
-      contents: {
-        orgs: {
-          [testData.username]: await testData.getConfig(),
-        },
-      },
-    });
+    await $$.stubAuths(testData);
     $$.fakeConnectionRequest = (request: AnyJson): Promise<AnyJson> => {
-      const _request: JsonMap = ensureJsonMap(request);
+      const _request = ensureJsonMap(request);
       if (request && ensureString(_request.url).includes('Account')) {
         return Promise.resolve(records);
       } else {
         return Promise.reject(new SfError(`Unexpected request: ${_request.url}`));
       }
     };
-    const connection: Connection = await Connection.create({
+    const connection = await Connection.create({
       authInfo: await AuthInfo.create({ username: testData.username }),
     });
-    const result: QueryResult<{}> = await connection.query('select Id From Account');
+    const result = await connection.query('select Id From Account');
     deepStrictEqual(result, records);
   });
 });

package/lib/config/aliasesConfig.d.ts

@@ -0,0 +1,12 @@
+import { ConfigGroup } from './configGroup';
+import { ConfigContents, ConfigValue } from './configStore';
+/**
+ * Different groups of aliases. Currently only support orgs.
+ */
+export declare enum AliasGroup {
+    ORGS = "orgs"
+}
+export declare class AliasesConfig extends ConfigGroup<ConfigGroup.Options> {
+    static getDefaultOptions(): ConfigGroup.Options;
+    protected setMethod(contents: ConfigContents, key: string, value?: ConfigValue): void;
+}

package/lib/config/aliasesConfig.js

@@ -0,0 +1,27 @@
+"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.AliasesConfig = exports.AliasGroup = void 0;
+const configGroup_1 = require("./configGroup");
+/**
+ * Different groups of aliases. Currently only support orgs.
+ */
+var AliasGroup;
+(function (AliasGroup) {
+    AliasGroup["ORGS"] = "orgs";
+})(AliasGroup = exports.AliasGroup || (exports.AliasGroup = {}));
+class AliasesConfig extends configGroup_1.ConfigGroup {
+    static getDefaultOptions() {
+        return { ...configGroup_1.ConfigGroup.getOptions(AliasGroup.ORGS, 'alias.json'), isGlobal: true, isState: true };
+    }
+    setMethod(contents, key, value) {
+        contents[key] = value;
+    }
+}
+exports.AliasesConfig = AliasesConfig;
+//# sourceMappingURL=aliasesConfig.js.map

package/lib/config/authInfoConfig.d.ts

@@ -0,0 +1,19 @@
+import { AuthFields } from '../org';
+import { ConfigFile } from './configFile';
+/**
+ * An auth config file that stores information such as access tokens, usernames, etc.,
+ * in the global sfdx directory (~/.sfdx).
+ *
+ * ```
+ * const authInfo = await AuthInfoConfig.create(AuthInfoConfig.getOptions(username));
+ * ```
+ */
+export declare class AuthInfoConfig extends ConfigFile<ConfigFile.Options, AuthFields> {
+    protected static encryptedKeys: RegExp[];
+    /**
+     * Gets the config options for a given org ID.
+     *
+     * @param username The username for the org.
+     */
+    static getOptions(username: string): ConfigFile.Options;
+}

package/lib/config/authInfoConfig.js

@@ -0,0 +1,35 @@
+"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.AuthInfoConfig = void 0;
+const configFile_1 = require("./configFile");
+/**
+ * An auth config file that stores information such as access tokens, usernames, etc.,
+ * in the global sfdx directory (~/.sfdx).
+ *
+ * ```
+ * const authInfo = await AuthInfoConfig.create(AuthInfoConfig.getOptions(username));
+ * ```
+ */
+class AuthInfoConfig extends configFile_1.ConfigFile {
+    /**
+     * Gets the config options for a given org ID.
+     *
+     * @param username The username for the org.
+     */
+    static getOptions(username) {
+        return {
+            isGlobal: true,
+            isState: true,
+            filename: `${username}.json`,
+        };
+    }
+}
+exports.AuthInfoConfig = AuthInfoConfig;
+AuthInfoConfig.encryptedKeys = [/token/gi, /password/gi, /secret/gi];
+//# sourceMappingURL=authInfoConfig.js.map

package/lib/config/configAggregator.d.ts

@@ -1,5 +1,5 @@
 import { AsyncOptionalCreatable } from '@salesforce/kit';
-import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
+import { AnyJson, Dictionary, JsonMap, Optional } from '@salesforce/ts-types';
 import { Config, ConfigPropertyMeta } from './config';
 /**
  * Information about a config property.
@@ -54,8 +54,8 @@ export interface ConfigInfo {
  * ```
  */
 export declare class ConfigAggregator extends AsyncOptionalCreatable<ConfigAggregator.Options> {
-    private static instance;
-    private static encrypted;
+    protected static instance: AsyncOptionalCreatable;
+    protected static encrypted: boolean;
     private allowedProperties;
     private localConfig?;
     private globalConfig;
@@ -161,7 +161,7 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<ConfigAggre
     /**
      * Get the config properties that are environment variables.
      */
-    getEnvVars(): Map<string, string>;
+    getEnvVars(): Dictionary<string>;
     /**
      * Re-read all property configurations from disk.
      */
@@ -183,7 +183,7 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<ConfigAggre
     /**
      * Loads all the properties and aggregates them according to location.
      */
-    private loadProperties;
+    protected loadProperties(): Promise<void>;
     /**
      * Loads all the properties and aggregates them according to location.
      */
@@ -219,6 +219,8 @@ export declare namespace ConfigAggregator {
  * @deprecated
  */
 export declare class SfdxConfigAggregator extends ConfigAggregator {
+    protected static instance: AsyncOptionalCreatable;
+    protected static encrypted: boolean;
     static create<P, T extends AsyncOptionalCreatable<P>>(this: new (options?: ConfigAggregator.Options) => T, options?: ConfigAggregator.Options): Promise<T>;
     getPropertyMeta(key: string): ConfigPropertyMeta;
     getPropertyValue<T extends AnyJson>(key: string): Optional<T>;

package/lib/config/configAggregator.js

@@ -37,6 +37,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      */
     constructor(options) {
         super(options || {});
+        this.envVars = {};
         // Don't throw an project error with the aggregator, since it should resolve to global if
         // there is no project.
         try {
@@ -107,7 +108,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      */
     getPropertyValue(key) {
         if (this.getAllowedProperties().some((element) => key === element.key)) {
-            return this.getConfig()[key] || this.getEnvVars().get(key);
+            return this.getConfig()[key];
         }
         else {
             throw messages.createError('unknownConfigKey', [key]);
@@ -164,7 +165,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * @param key The key of the property.
      */
     getLocation(key) {
-        if (this.getEnvVars().get(key) != null) {
+        if (this.envVars[key] != null) {
             return "Environment" /* ENVIRONMENT */;
         }
         if (this.localConfig && this.localConfig.get(key)) {
@@ -189,8 +190,8 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * @param key The key of the property.
      */
     getPath(key) {
-        if (this.envVars.getString(key) != null) {
-            return `$${this.envVars.propertyToEnvName(key)}`;
+        if (this.envVars[key] != null) {
+            return `$${envVars_1.EnvVars.propertyToEnvName(key)}`;
         }
         if (this.localConfig && this.localConfig.getContents()[key] != null) {
             return this.localConfig.getPath();
@@ -239,7 +240,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * Get the config properties that are environment variables.
      */
     getEnvVars() {
-        return this.envVars.asMap();
+        return this.envVars;
     }
     /**
      * Re-read all property configurations from disk.
@@ -287,9 +288,12 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         this.resolveProperties(this.globalConfig.readSync(), this.localConfig && this.localConfig.readSync());
     }
     resolveProperties(globalConfig, localConfig) {
-        this.envVars = new envVars_1.EnvVars();
+        const envVars = new envVars_1.EnvVars();
         for (const property of this.getAllowedProperties()) {
-            this.envVars.setPropertyFromEnv(property.key);
+            const key = property.newKey ? property.newKey : property.key;
+            const value = envVars.getPropertyFromEnv(property.key);
+            if (value)
+                this.envVars[key] = value;
         }
         // Global config must be read first so it is on the left hand of the
         // object assign and is overwritten by the local config.
@@ -298,7 +302,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         if (localConfig) {
             configs.push(localConfig);
         }
-        configs.push(this.envVars.asDictionary());
+        configs.push(this.envVars);
         const json = {};
         const reduced = configs.filter(ts_types_1.isJsonMap).reduce((acc, el) => (0, kit_1.merge)(acc, el), json);
         return reduced;
@@ -320,7 +324,18 @@ class SfdxConfigAggregator extends ConfigAggregator {
         const restDeploy = config_1.SFDX_ALLOWED_PROPERTIES.find((p) => p.key === config_1.SfdxPropertyKeys.REST_DEPLOY);
         const orgRestDeploy = Object.assign({}, restDeploy, { key: 'org-metadata-rest-deploy', deprecated: false });
         options.customConfigMeta = [...customConfigMeta, orgRestDeploy];
-        return super.create(options);
+        let config = SfdxConfigAggregator.instance;
+        if (!config) {
+            config = SfdxConfigAggregator.instance = new this(options);
+            await config.init();
+        }
+        if (SfdxConfigAggregator.encrypted) {
+            await config.loadProperties();
+        }
+        if (options === null || options === void 0 ? void 0 : options.customConfigMeta) {
+            config_1.Config.addAllowedProperties(options.customConfigMeta);
+        }
+        return SfdxConfigAggregator.instance;
     }
     getPropertyMeta(key) {
         const match = this.getAllowedProperties().find((element) => key === element.key);
@@ -363,4 +378,5 @@ class SfdxConfigAggregator extends ConfigAggregator {
     }
 }
 exports.SfdxConfigAggregator = SfdxConfigAggregator;
+SfdxConfigAggregator.encrypted = true;
 //# sourceMappingURL=configAggregator.js.map

package/lib/config/configFile.js

@@ -80,7 +80,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             isGlobal,
             isState: true,
             filename: filename || this.getFileName(),
-            stateFolder: global_1.Global.SF_STATE_FOLDER,
+            stateFolder: global_1.Global.SFDX_STATE_FOLDER,
         };
     }
     /**
@@ -306,7 +306,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
                 ? this.options.rootFolder
                 : ConfigFile.resolveRootFolderSync(!!this.options.isGlobal);
             if (_isGlobal || _isState) {
-                configRootFolder = (0, path_1.join)(configRootFolder, this.options.stateFolder || global_1.Global.SF_STATE_FOLDER);
+                configRootFolder = (0, path_1.join)(configRootFolder, this.options.stateFolder || global_1.Global.SFDX_STATE_FOLDER);
             }
             this.path = (0, path_1.join)(configRootFolder, this.options.filePath ? this.options.filePath : '', this.options.filename);
         }

package/lib/config/configGroup.d.ts

@@ -0,0 +1,141 @@
+import { Dictionary, JsonMap, Optional } from '@salesforce/ts-types';
+import { ConfigFile } from './configFile';
+import { ConfigContents, ConfigEntry, ConfigValue } from './configStore';
+/**
+ * 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();
+ * ```
+ */
+export declare class ConfigGroup<T extends ConfigGroup.Options> extends ConfigFile<T> {
+    protected defaultGroup: string;
+    /**
+     * 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: string, filename?: string): ConfigGroup.Options;
+    /**
+     * 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: string): void;
+    /**
+     * 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.
+     */
+    updateValues(newEntries: Dictionary<ConfigValue>, group?: string): Promise<Dictionary<ConfigValue>>;
+    /**
+     * 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.
+     */
+    updateValue(key: string, value: ConfigValue, group?: string): Promise<void>;
+    /**
+     * Gets an array of key value pairs.
+     */
+    entries(): ConfigEntry[];
+    /**
+     * Returns a specified element from ConfigGroup. Returns the associated value.
+     *
+     * @param key The key.
+     */
+    get(key: string): Optional<ConfigValue>;
+    /**
+     * Returns a boolean if an element with the specified key exists in the default group.
+     *
+     * @param {string} key The key.
+     */
+    has(key: string): boolean;
+    /**
+     * Returns an array of the keys from the default group.
+     */
+    keys(): string[];
+    /**
+     * Returns an array of the values from the default group.
+     */
+    values(): ConfigValue[];
+    /**
+     * Add or updates an element with the specified key in the default group.
+     *
+     * @param key The key.
+     * @param value The value.
+     */
+    set(key: string, value: ConfigValue): ConfigContents;
+    /**
+     * Removes an element with the specified key from the default group. Returns `true` if the item was deleted.
+     *
+     * @param key The key.
+     */
+    unset(key: string): boolean;
+    /**
+     * Remove all key value pairs from the default group.
+     */
+    clear(): void;
+    /**
+     * Get all config contents for a group.
+     *
+     * @param {string} [group = 'default'] The group.
+     */
+    getGroup(group?: string): Optional<ConfigContents>;
+    /**
+     * 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: string, group?: string): Optional<ConfigValue>;
+    /**
+     * Convert the config object to a json object.
+     */
+    toObject(): JsonMap;
+    /**
+     * Convert an object to a {@link ConfigContents} and set it as the config contents.
+     *
+     * @param {object} obj The object.
+     */
+    setContentsFromObject<U extends object>(obj: U): void;
+    /**
+     * 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: string, value?: ConfigValue, group?: string): ConfigContents;
+    /**
+     * Initialize the asynchronous dependencies.
+     */
+    init(): Promise<void>;
+}
+export declare namespace ConfigGroup {
+    /**
+     * Options when creating the config file.
+     */
+    interface Options extends ConfigFile.Options {
+        /**
+         * The default group for properties to go into.
+         */
+        defaultGroup?: string;
+    }
+}