@salesforce/core 4.0.0 → 4.0.1

package/lib/config/envVars.js

@@ -11,9 +11,8 @@ const path_1 = require("path");
 const change_case_1 = require("change-case");
 const kit_1 = require("@salesforce/kit");
 const messages_1 = require("../messages");
-const global_1 = require("../global");
-messages_1.Messages.importMessagesDirectory((0, path_1.join)(__dirname));
-const messages = messages_1.Messages.loadMessages('@salesforce/core', 'envVars');
+const lifecycleEvents_1 = require("../lifecycleEvents");
+const messages = new messages_1.Messages('@salesforce/core', 'envVars', new Map([["forceOpenUrl", "Web page that opens in your browser when you connect to an org. For example, to open Lightning Experience, set to \"lightning\"."], ["forceShowSpinner", "Set to true to show a spinner animation on the command line when running asynchronous CLI commands. Default is false."], ["forceSpinnerDelay", "Speed of the spinner in milliseconds. Default is 60."], ["httpProxy", "HTTP URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy."], ["httpsProxy", "HTTPS URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy."], ["nodeExtraCaCerts", "Fully qualified path to your self-signed certificate. Will be installed after you run \"sfdx update\"."], ["nodeTlsRejectUnauthorized", "Set to 0 to allow Node.js to use the self-signed certificate in the certificate chain."], ["sfdxAccessToken", "Specifies an access token when using the auth:accesstoken:store command."], ["sfdxApiVersion", "The API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion config value."], ["sfdxAudienceUrl", "URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you\u2019re logging into."], ["sfdxCodeCoverageRequirement", "Code coverage percentages that are displayed in green when you run force:apex:test:\\* with the --codecoverage parameter."], ["sfdxContentType", "Set to JSON so that all CLI commands output results in JSON format."], ["sfdxDefaultdevhubusername", "Username or alias of your default Dev Hub org. Overrides the defaultdevhubusername configuration value."], ["sfdxDefaultusername", "Username or alias of your default org. Overrides the defaultusername configuration value."], ["sfdxDisableAutoupdate", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfdxAutoupdateDisable", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfdxDisableSourceMemberPolling", "Set to true to disable polling of your org\u2019s SourceMember object when you run the force:source:push|pull commands. Default value is false."], ["sfdxDisableTelemetry", "Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable."], ["sfdxDnsTimeout", "Number of seconds that the force:org:\\* commands wait for a response when checking whether an org is connected. Default value is 3."], ["sfdxDomainRetry", "Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240."], ["sfdxImprovedCodeCoverage", "Set to true to scope Apex test results to the classes entered during a test run when running force:apex:test:\\*."], ["sfdxInstanceUrl", "URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration value."], ["sfdxJsonToStdout", "Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr."], ["sfdxDisableLogFile", "Set to true to disable log file writing"], ["sfdxLogLevel", "Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn."], ["sfdxLogRotationCount", "The default rotation period for logs. Example '1d' will rotate logs daily (at midnight)."], ["sfdxLogRotationPeriod", "The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files."], ["sfdxMaxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration value."], ["sfdxMdapiTempDir", "Directory that contains files (in metadata format) when running certain Salesforce CLI commands, such as force:source:\\*."], ["sfdxNpmRegistry", "URL to a private npm server, where all packages that you publish are private."], ["sfdxPrecompileEnable", "Set to true to enable Apex pre-compile before the tests are run with the force:apex:test:run command. Default is false."], ["sfdxProjectAutoupdateDisableForPackageCreate", "Set to true to disable automatic updates to sfdx-project.json when running force:package:create."], ["sfdxProjectAutoupdateDisableForPackageVersionCreate", "Set to true to disable automatic updates to sfdx-project.json when running force:package:version:create."], ["sfdxRestDeploy", "Set to true to make Salesforce CLI use the Metadata REST API for deployments. By default, the CLI uses SOAP."], ["sfdxSourceMemberPollingTimeout", "Number of seconds you want the force:source:push command to keep polling the SourceMember object before the command times out."], ["sfdxUseGenericUnixKeychain", "(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain."], ["sfdxUseProgressBar", "Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy, or force:source:push."], ["sfdxLazyLoadModules", "Set to true to enable lazy loading of sfdx modules"], ["sfdxS3Host", "URL to S3 host"], ["sfdxUpdateInstructions", "Text that describes how to update sfdx"], ["sfdxInstaller", "Boolean indicating that the installer is running"], ["sfdxEnv", "Describes if sfdx is in \"demo\" mode"], ["sfTargetOrg", "Username or alias of your default org. Overrides the target-org configuration variable."], ["sfTargetDevHub", "Username or alias of your default Dev Hub org. Overrides the target-dev-hub configuration variable."], ["sfAccessToken", "Specifies an access token when using a login command that uses access tokens."], ["sfOrgApiVersion", "API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion configuration variable."], ["sfAudienceUrl", "URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you\u2019re logging into."], ["sfCodeCoverageRequirement", "Code coverage percentages that are displayed in green when you run the Apex test CLIcommands with the --code-coverage flag."], ["sfContentType", "Set to JSON so that all CLI commands output results in JSON format."], ["sfDisableAutoupdate", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfAutoupdateDisable", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfDisableSourceMemberPolling", "Set to true to disable polling of your org\u2019s SourceMember object when you run the commands to push and pull source. Default value is false."], ["sfDisableTelemetry", "Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable."], ["sfDnsTimeout", "Number of seconds that the env commands wait for a response when checking whether an org is connected. Default value is 3."], ["sfDomainRetry", "Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240."], ["sfImprovedCodeCoverage", "Set to true to scope Apex test results to the classes entered during a test run when running the Apex test commands."], ["sfOrgInstanceUrl", "URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration variable."], ["sfJsonToStdout", "Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr."], ["sfDisableLogFile", "Set to true to disable log file writing"], ["sfLogLevel", "Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn."], ["sfLogRotationCount", "The default rotation period for logs. Example '1d' will rotate logs daily (at midnight)."], ["sfLogRotationPeriod", "The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files."], ["sfOrgMaxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable."], ["sfMdapiTempDir", "Directory that contains files (in metadata format) when running certain Salesforce CLI commands."], ["sfNpmRegistry", "URL to a private npm server, where all packages that you publish are private."], ["sfPrecompileEnable", "Set to true to enable Apex pre-compile before the tests are run with the Apex test run command. Default is false."], ["sfProjectAutoupdateDisableForPackageCreate", "Set to true to disable automatic updates to sfdx-project.json when running the package create command."], ["sfProjectAutoupdateDisableForPackageVersionCreate", "Set to true to disable automatic updates to sfdx-project.json when running the package version create command."], ["sfSourceMemberPollingTimeout", "Number of seconds you want the source push command to keep polling the SourceMember object before the command times out."], ["sfUseGenericUnixKeychain", "(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain."], ["sfUseProgressBar", "Set to false to disable the progress bar when running the metadata deploy command."], ["sfLazyLoadModules", "Set to true to enable lazy loading of sf modules"], ["sfS3Host", "URL to S3 host"], ["sfUpdateInstructions", "Text that describes how to update sf"], ["sfInstaller", "Boolean indicating that the installer is running"], ["sfEnv", "Describes if sf is in \"demo\" mode"], ["deprecatedEnv", "Deprecated environment variable: %s. Please use %s instead."], ["deprecatedEnvDisagreement", "Deprecated environment variable: %s. Please use %s instead.\n\nYour environment has both variables populated, and with different values. The value from %s will be used."]]));
 var EnvironmentVariable;
 (function (EnvironmentVariable) {
     EnvironmentVariable["FORCE_OPEN_URL"] = "FORCE_OPEN_URL";
@@ -39,7 +38,10 @@ var EnvironmentVariable;
     EnvironmentVariable["SFDX_IMPROVED_CODE_COVERAGE"] = "SFDX_IMPROVED_CODE_COVERAGE";
     EnvironmentVariable["SFDX_INSTANCE_URL"] = "SFDX_INSTANCE_URL";
     EnvironmentVariable["SFDX_JSON_TO_STDOUT"] = "SFDX_JSON_TO_STDOUT";
+    EnvironmentVariable["SFDX_DISABLE_LOG_FILE"] = "SFDX_DISABLE_LOG_FILE";
     EnvironmentVariable["SFDX_LOG_LEVEL"] = "SFDX_LOG_LEVEL";
+    EnvironmentVariable["SFDX_LOG_ROTATION_COUNT"] = "SFDX_LOG_ROTATION_COUNT";
+    EnvironmentVariable["SFDX_LOG_ROTATION_PERIOD"] = "SFDX_LOG_ROTATION_PERIOD";
     EnvironmentVariable["SFDX_MAX_QUERY_LIMIT"] = "SFDX_MAX_QUERY_LIMIT";
     EnvironmentVariable["SFDX_MDAPI_TEMP_DIR"] = "SFDX_MDAPI_TEMP_DIR";
     EnvironmentVariable["SFDX_NPM_REGISTRY"] = "SFDX_NPM_REGISTRY";
@@ -58,7 +60,7 @@ var EnvironmentVariable;
     EnvironmentVariable["SF_TARGET_ORG"] = "SF_TARGET_ORG";
     EnvironmentVariable["SF_TARGET_DEV_HUB"] = "SF_TARGET_DEV_HUB";
     EnvironmentVariable["SF_ACCESS_TOKEN"] = "SF_ACCESS_TOKEN";
-    EnvironmentVariable["SF_API_VERSION"] = "SF_API_VERSION";
+    EnvironmentVariable["SF_ORG_API_VERSION"] = "SF_ORG_API_VERSION";
     EnvironmentVariable["SF_AUDIENCE_URL"] = "SF_AUDIENCE_URL";
     EnvironmentVariable["SF_CODE_COVERAGE_REQUIREMENT"] = "SF_CODE_COVERAGE_REQUIREMENT";
     EnvironmentVariable["SF_CONTENT_TYPE"] = "SF_CONTENT_TYPE";
@@ -69,10 +71,13 @@ var EnvironmentVariable;
     EnvironmentVariable["SF_DNS_TIMEOUT"] = "SF_DNS_TIMEOUT";
     EnvironmentVariable["SF_DOMAIN_RETRY"] = "SF_DOMAIN_RETRY";
     EnvironmentVariable["SF_IMPROVED_CODE_COVERAGE"] = "SF_IMPROVED_CODE_COVERAGE";
-    EnvironmentVariable["SF_INSTANCE_URL"] = "SF_INSTANCE_URL";
+    EnvironmentVariable["SF_ORG_INSTANCE_URL"] = "SF_ORG_INSTANCE_URL";
     EnvironmentVariable["SF_JSON_TO_STDOUT"] = "SF_JSON_TO_STDOUT";
+    EnvironmentVariable["SF_DISABLE_LOG_FILE"] = "SF_DISABLE_LOG_FILE";
     EnvironmentVariable["SF_LOG_LEVEL"] = "SF_LOG_LEVEL";
-    EnvironmentVariable["SF_MAX_QUERY_LIMIT"] = "SF_MAX_QUERY_LIMIT";
+    EnvironmentVariable["SF_LOG_ROTATION_COUNT"] = "SF_LOG_ROTATION_COUNT";
+    EnvironmentVariable["SF_LOG_ROTATION_PERIOD"] = "SF_LOG_ROTATION_PERIOD";
+    EnvironmentVariable["SF_ORG_MAX_QUERY_LIMIT"] = "SF_ORG_MAX_QUERY_LIMIT";
     EnvironmentVariable["SF_MDAPI_TEMP_DIR"] = "SF_MDAPI_TEMP_DIR";
     EnvironmentVariable["SF_NPM_REGISTRY"] = "SF_NPM_REGISTRY";
     EnvironmentVariable["SF_PRECOMPILE_ENABLE"] = "SF_PRECOMPILE_ENABLE";
@@ -124,7 +129,7 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SFDX_API_VERSION]: {
         description: getMessage(EnvironmentVariable.SFDX_API_VERSION),
-        synonymOf: EnvironmentVariable.SF_API_VERSION,
+        synonymOf: EnvironmentVariable.SF_ORG_API_VERSION,
     },
     [EnvironmentVariable.SFDX_AUDIENCE_URL]: {
         description: getMessage(EnvironmentVariable.SFDX_AUDIENCE_URL),
@@ -176,19 +181,31 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SFDX_INSTANCE_URL]: {
         description: getMessage(EnvironmentVariable.SFDX_INSTANCE_URL),
-        synonymOf: EnvironmentVariable.SF_INSTANCE_URL,
+        synonymOf: EnvironmentVariable.SF_ORG_INSTANCE_URL,
     },
     [EnvironmentVariable.SFDX_JSON_TO_STDOUT]: {
         description: getMessage(EnvironmentVariable.SFDX_JSON_TO_STDOUT),
         synonymOf: EnvironmentVariable.SF_JSON_TO_STDOUT,
     },
+    [EnvironmentVariable.SFDX_DISABLE_LOG_FILE]: {
+        description: getMessage(EnvironmentVariable.SFDX_DISABLE_LOG_FILE),
+        synonymOf: EnvironmentVariable.SF_DISABLE_LOG_FILE,
+    },
     [EnvironmentVariable.SFDX_LOG_LEVEL]: {
         description: getMessage(EnvironmentVariable.SFDX_LOG_LEVEL),
         synonymOf: EnvironmentVariable.SF_LOG_LEVEL,
     },
+    [EnvironmentVariable.SFDX_LOG_ROTATION_COUNT]: {
+        description: getMessage(EnvironmentVariable.SFDX_LOG_ROTATION_COUNT),
+        synonymOf: EnvironmentVariable.SF_LOG_ROTATION_COUNT,
+    },
+    [EnvironmentVariable.SFDX_LOG_ROTATION_PERIOD]: {
+        description: getMessage(EnvironmentVariable.SFDX_LOG_ROTATION_PERIOD),
+        synonymOf: EnvironmentVariable.SF_LOG_ROTATION_PERIOD,
+    },
     [EnvironmentVariable.SFDX_MAX_QUERY_LIMIT]: {
         description: getMessage(EnvironmentVariable.SFDX_MAX_QUERY_LIMIT),
-        synonymOf: EnvironmentVariable.SF_MAX_QUERY_LIMIT,
+        synonymOf: EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT,
     },
     [EnvironmentVariable.SFDX_MDAPI_TEMP_DIR]: {
         description: getMessage(EnvironmentVariable.SFDX_MDAPI_TEMP_DIR),
@@ -212,7 +229,8 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SFDX_REST_DEPLOY]: {
         description: getMessage(EnvironmentVariable.SFDX_REST_DEPLOY),
-        synonymOf: null,
+        // this is not an "official" env var, but it supports the env=>config naming convention for the config that lives in plugin-deploy-retrieve
+        synonymOf: 'SF_ORG_METADATA_REST_DEPLOY',
     },
     [EnvironmentVariable.SFDX_SOURCE_MEMBER_POLLING_TIMEOUT]: {
         description: getMessage(EnvironmentVariable.SFDX_SOURCE_MEMBER_POLLING_TIMEOUT),
@@ -259,8 +277,8 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SF_ACCESS_TOKEN),
         synonymOf: null,
     },
-    [EnvironmentVariable.SF_API_VERSION]: {
-        description: getMessage(EnvironmentVariable.SF_API_VERSION),
+    [EnvironmentVariable.SF_ORG_API_VERSION]: {
+        description: getMessage(EnvironmentVariable.SF_ORG_API_VERSION),
         synonymOf: null,
     },
     [EnvironmentVariable.SF_AUDIENCE_URL]: {
@@ -303,20 +321,32 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SF_IMPROVED_CODE_COVERAGE),
         synonymOf: null,
     },
-    [EnvironmentVariable.SF_INSTANCE_URL]: {
-        description: getMessage(EnvironmentVariable.SF_INSTANCE_URL),
+    [EnvironmentVariable.SF_ORG_INSTANCE_URL]: {
+        description: getMessage(EnvironmentVariable.SF_ORG_INSTANCE_URL),
         synonymOf: null,
     },
     [EnvironmentVariable.SF_JSON_TO_STDOUT]: {
         description: getMessage(EnvironmentVariable.SF_JSON_TO_STDOUT),
         synonymOf: null,
     },
+    [EnvironmentVariable.SF_DISABLE_LOG_FILE]: {
+        description: getMessage(EnvironmentVariable.SF_DISABLE_LOG_FILE),
+        synonymOf: null,
+    },
     [EnvironmentVariable.SF_LOG_LEVEL]: {
         description: getMessage(EnvironmentVariable.SF_LOG_LEVEL),
         synonymOf: null,
     },
-    [EnvironmentVariable.SF_MAX_QUERY_LIMIT]: {
-        description: getMessage(EnvironmentVariable.SF_MAX_QUERY_LIMIT),
+    [EnvironmentVariable.SF_LOG_ROTATION_COUNT]: {
+        description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_COUNT),
+        synonymOf: null,
+    },
+    [EnvironmentVariable.SF_LOG_ROTATION_PERIOD]: {
+        description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_PERIOD),
+        synonymOf: null,
+    },
+    [EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT]: {
+        description: getMessage(EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT),
         synonymOf: null,
     },
     [EnvironmentVariable.SF_MDAPI_TEMP_DIR]: {
@@ -377,55 +407,49 @@ class EnvVars extends kit_1.Env {
         super(env);
         this.resolve();
     }
-    static defaultPrefix() {
-        if (process.argv[0].startsWith('sfdx'))
-            return 'SFDX_';
-        if (process.argv[0].startsWith('sf'))
-            return 'SF_';
-        return 'SFDX_';
-    }
-    propertyToEnvName(property, prefix = EnvVars.defaultPrefix()) {
+    static 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);
-        }
+    static defaultPrefix() {
+        return 'SF_';
     }
     getPropertyFromEnv(property, prefix = EnvVars.defaultPrefix()) {
-        const envName = this.propertyToEnvName(property, prefix);
+        const envName = EnvVars.propertyToEnvName(property, prefix);
         return this.get(envName);
     }
     asDictionary() {
-        return this.entries().reduce((accumulator, [key, value]) => {
-            accumulator[key] = value;
-            return accumulator;
-        }, {});
+        return Object.fromEntries(this.entries());
     }
     asMap() {
-        return this.entries().reduce((accumulator, [key, value]) => {
-            accumulator.set(key, value);
-            return accumulator;
-        }, new Map());
+        return new Map(this.entries());
     }
     resolve() {
+        // iterate everything in the real environment
+        const corrections = new Map();
         this.entries().forEach(([key, value]) => {
-            if (exports.SUPPORTED_ENV_VARS[key]) {
-                // cross populate value to synonym if synonym exists
-                if (exports.SUPPORTED_ENV_VARS[key].synonymOf) {
-                    const synonym = exports.SUPPORTED_ENV_VARS[key].synonymOf;
-                    // set synonym only if it is in the map and running in interoperability mode
-                    if (synonym && global_1.Global.SFDX_INTEROPERABILITY) {
-                        this.setString(synonym, value);
+            if (exports.SUPPORTED_ENV_VARS[key]?.synonymOf) {
+                // we are looking at an "old" key that has a new name
+                // if the new key has a value set, use that for the old key, too
+                const newEnvName = exports.SUPPORTED_ENV_VARS[key].synonymOf;
+                if (newEnvName) {
+                    const valueOfNewName = this.getString(newEnvName);
+                    if (!valueOfNewName) {
+                        void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('deprecatedEnv', [key, newEnvName]));
+                        corrections.set(newEnvName, value);
+                    }
+                    else if (valueOfNewName !== value) {
+                        void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('deprecatedEnvDisagreement', [key, newEnvName, newEnvName]));
+                        corrections.set(key, valueOfNewName ?? value);
                     }
                 }
             }
         });
+        corrections.forEach((v, k) => {
+            this.setString(k, v);
+        });
     }
     get(envName) {
-        return this.asDictionary()[envName];
+        return this.asMap().get(envName);
     }
 }
 exports.EnvVars = EnvVars;

package/lib/config/orgUsersConfig.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrgUsersConfig = void 0;
+const global_1 = require("../global");
 const configFile_1 = require("./configFile");
 /**
  * A config file that stores usernames for an org.
@@ -33,6 +34,7 @@ class OrgUsersConfig extends configFile_1.ConfigFile {
             isState: true,
             filename: `${orgId}.json`,
             orgId,
+            stateFolder: global_1.Global.SFDX_STATE_FOLDER,
         };
     }
 }

package/lib/config/sandboxOrgConfig.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SandboxOrgConfig = void 0;
+const global_1 = require("../global");
 const configFile_1 = require("./configFile");
 /**
  * A config file that stores usernames for an org.
@@ -33,6 +34,7 @@ class SandboxOrgConfig extends configFile_1.ConfigFile {
             isState: true,
             filename: `${orgId}.sandbox.json`,
             orgId,
+            stateFolder: global_1.Global.SFDX_STATE_FOLDER,
         };
     }
 }

package/lib/config/sandboxProcessCache.d.ts

@@ -0,0 +1,16 @@
+import { SandboxProcessObject, SandboxRequest } from '../org';
+import { TTLConfig } from './ttlConfig';
+export type SandboxRequestCacheEntry = {
+    alias?: string;
+    setDefault: boolean;
+    prodOrgUsername: string;
+    sandboxProcessObject: Partial<SandboxProcessObject>;
+    sandboxRequest: Partial<SandboxRequest>;
+    tracksSource?: boolean;
+};
+export declare class SandboxRequestCache extends TTLConfig<TTLConfig.Options, SandboxRequestCacheEntry> {
+    static getDefaultOptions(): TTLConfig.Options;
+    static unset(key: string): Promise<void>;
+    static set(key: string, sandboxProcessObject: SandboxRequestCacheEntry): Promise<void>;
+    static getFileName(): string;
+}

package/lib/config/sandboxProcessCache.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SandboxRequestCache = void 0;
+/*
+ * 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
+ */
+const kit_1 = require("@salesforce/kit");
+const global_1 = require("../global");
+const ttlConfig_1 = require("./ttlConfig");
+class SandboxRequestCache extends ttlConfig_1.TTLConfig {
+    static getDefaultOptions() {
+        return {
+            isGlobal: true,
+            isState: true,
+            filename: SandboxRequestCache.getFileName(),
+            stateFolder: global_1.Global.SF_STATE_FOLDER,
+            ttl: kit_1.Duration.days(14),
+        };
+    }
+    static async unset(key) {
+        const cache = await SandboxRequestCache.create();
+        cache.unset(key);
+        await cache.write();
+    }
+    static async set(key, sandboxProcessObject) {
+        const cache = await SandboxRequestCache.create();
+        cache.set(key, sandboxProcessObject);
+        await cache.write();
+    }
+    static getFileName() {
+        return 'sandbox-create-cache.json';
+    }
+}
+exports.SandboxRequestCache = SandboxRequestCache;
+//# sourceMappingURL=sandboxProcessCache.js.map

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,29 @@
+"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
+ */
+/* eslint-disable class-methods-use-this */
+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/i, /password/i, /secret/i];
+//# sourceMappingURL=tokensConfig.js.map

package/lib/config/ttlConfig.d.ts

@@ -0,0 +1,34 @@
+import { Duration } from '@salesforce/kit';
+import { JsonMap, Nullable } from '@salesforce/ts-types';
+import { ConfigFile } from './configFile';
+/**
+ * A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.
+ *
+ * @example
+ * ```
+ * import { Duration } from '@salesforce/kit';
+ * const config = await TTLConfig.create({
+ *   isGlobal: false,
+ *   ttl: Duration.days(1)
+ * });
+ * ```
+ */
+export declare class TTLConfig<T extends TTLConfig.Options, P extends JsonMap> extends ConfigFile<T, TTLConfig.Contents<P>> {
+    set(key: string, value: Partial<TTLConfig.Entry<P>>): void;
+    getLatestEntry(): Nullable<[string, TTLConfig.Entry<P>]>;
+    getLatestKey(): Nullable<string>;
+    isExpired(dateTime: number, value: P & {
+        timestamp: string;
+    }): boolean;
+    protected init(): Promise<void>;
+    private timestamp;
+}
+export declare namespace TTLConfig {
+    type Options = ConfigFile.Options & {
+        ttl: Duration;
+    };
+    type Entry<T extends JsonMap> = T & {
+        timestamp: string;
+    };
+    type Contents<T extends JsonMap> = Record<string, Entry<T>>;
+}

package/lib/config/ttlConfig.js

@@ -0,0 +1,50 @@
+"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.TTLConfig = void 0;
+const configFile_1 = require("./configFile");
+/**
+ * A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.
+ *
+ * @example
+ * ```
+ * import { Duration } from '@salesforce/kit';
+ * const config = await TTLConfig.create({
+ *   isGlobal: false,
+ *   ttl: Duration.days(1)
+ * });
+ * ```
+ */
+class TTLConfig extends configFile_1.ConfigFile {
+    set(key, value) {
+        super.set(key, this.timestamp(value));
+    }
+    getLatestEntry() {
+        const entries = this.entries();
+        const sorted = entries.sort(([, valueA], [, valueB]) => new Date(valueB.timestamp).getTime() - new Date(valueA.timestamp).getTime());
+        return sorted.length > 0 ? sorted[0] : null;
+    }
+    getLatestKey() {
+        const [key] = this.getLatestEntry() ?? [null];
+        return key;
+    }
+    isExpired(dateTime, value) {
+        return dateTime - new Date(value.timestamp).getTime() > this.options.ttl.milliseconds;
+    }
+    async init() {
+        const contents = await this.read(this.options.throwOnNotFound);
+        const date = new Date().getTime();
+        this.setContents(Object.fromEntries(Object.entries(contents).filter(([, value]) => !this.isExpired(date, value))));
+    }
+    // eslint-disable-next-line class-methods-use-this
+    timestamp(value) {
+        return { ...value, timestamp: new Date().toISOString() };
+    }
+}
+exports.TTLConfig = TTLConfig;
+//# sourceMappingURL=ttlConfig.js.map

package/lib/crypto/crypto.js

@@ -16,6 +16,7 @@ const kit_1 = require("@salesforce/kit");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const cache_1 = require("../util/cache");
+const global_1 = require("../global");
 const keyChain_1 = require("./keyChain");
 const secureBuffer_1 = require("./secureBuffer");
 const TAG_DELIMITER = ':';
@@ -25,13 +26,7 @@ const AUTH_TAG_LENGTH = 32;
 const ENCRYPTED_CHARS = /[a-f0-9]/;
 const KEY_NAME = 'sfdx';
 const ACCOUNT = 'local';
-messages_1.Messages.importMessagesDirectory((0, path_1.join)(__dirname));
-const messages = messages_1.Messages.load('@salesforce/core', 'encryption', [
-    'keychainPasswordCreationError',
-    'invalidEncryptedFormatError',
-    'authDecryptError',
-    'macKeychainOutOfSync',
-]);
+const messages = new messages_1.Messages('@salesforce/core', 'encryption', new Map([["invalidEncryptedFormatError", "The encrypted data is not properly formatted."], ["invalidEncryptedFormatError.actions", ["If attempting to create a scratch org then re-authorize. Otherwise create a new scratch org."]], ["authDecryptError", "Failed to decipher auth data. reason: %s."], ["unsupportedOperatingSystemError", "Unsupported Operating System: %s"], ["missingCredentialProgramError", "Unable to find required security software: %s"], ["credentialProgramAccessError", "Unable to execute security software: %s"], ["passwordRetryError", "Failed to get the password after %i retries."], ["passwordRequiredError", "A password is required."], ["keyChainServiceRequiredError", "Unable to get or set a keychain value without a service name."], ["keyChainAccountRequiredError", "Unable to get or set a keychain value without an account name."], ["keyChainUserCanceledError", "User canceled authentication."], ["keychainPasswordCreationError", "Failed to create a password in the keychain."], ["genericKeychainServiceError", "The service and account specified in %s do not match the version of the toolbelt."], ["genericKeychainServiceError.actions", ["Check your toolbelt version and re-auth."]], ["genericKeychainInvalidPermsError", "Invalid file permissions for secret file"], ["genericKeychainInvalidPermsError.actions", ["Ensure the file %s has the file permission octal value of %s."]], ["passwordNotFoundError", "Could not find password.\n%s"], ["passwordNotFoundError.actions", ["Ensure a valid password is returned with the following command: [%s]"]], ["setCredentialError", "Command failed with response:\n%s"], ["setCredentialError.actions", ["Determine why this command failed to set an encryption key for user %s: [%s]."]], ["macKeychainOutOfSync", "We\u2019ve encountered an error with the Mac keychain being out of sync with your `sfdx` credentials. To fix the problem, sync your credentials by authenticating into your org again using the auth commands."]]));
 const makeSecureBuffer = (password) => {
     const newSb = new secureBuffer_1.SecureBuffer();
     newSb.consume(Buffer.from((0, ts_types_1.ensure)(password), 'utf8'));
@@ -49,23 +44,20 @@ const keychainPromises = {
      * @param account The keychain account name.
      */
     getPassword(_keychain, service, account) {
-        const sb = cache_1.Cache.get(`${service}:${account}`);
+        const cacheKey = `${global_1.Global.DIR}:${service}:${account}`;
+        const sb = cache_1.Cache.get(cacheKey);
         if (!sb) {
-            return new Promise((resolve, reject) => {
-                return _keychain.getPassword({ service, account }, (err, password) => {
-                    if (err)
-                        return reject(err);
-                    cache_1.Cache.set(`${service}:${account}`, makeSecureBuffer(password));
-                    return resolve({ username: account, password: (0, ts_types_1.ensure)(password) });
-                });
-            });
+            return new Promise((resolve, reject) => _keychain.getPassword({ service, account }, (err, password) => {
+                if (err)
+                    return reject(err);
+                cache_1.Cache.set(cacheKey, makeSecureBuffer(password));
+                return resolve({ username: account, password: (0, ts_types_1.ensure)(password) });
+            }));
         }
         else {
             const pw = sb.value((buffer) => buffer.toString('utf8'));
-            cache_1.Cache.set(`${service}:${account}`, makeSecureBuffer(pw));
-            return new Promise((resolve) => {
-                return resolve({ username: account, password: (0, ts_types_1.ensure)(pw) });
-            });
+            cache_1.Cache.set(cacheKey, makeSecureBuffer(pw));
+            return new Promise((resolve) => resolve({ username: account, password: (0, ts_types_1.ensure)(pw) }));
         }
     },
     /**
@@ -98,7 +90,7 @@ class Crypto extends kit_1.AsyncOptionalCreatable {
     constructor(options) {
         super(options);
         this.key = new secureBuffer_1.SecureBuffer();
-        this.options = options || {};
+        this.options = options ?? {};
     }
     encrypt(text) {
         if (text == null) {
@@ -137,7 +129,7 @@ class Crypto extends kit_1.AsyncOptionalCreatable {
             }
             catch (err) {
                 const error = messages.createError('authDecryptError', [err.message], [], err);
-                const useGenericUnixKeychain = kit_1.env.getBoolean('SFDX_USE_GENERIC_UNIX_KEYCHAIN') || kit_1.env.getBoolean('USE_GENERIC_UNIX_KEYCHAIN');
+                const useGenericUnixKeychain = kit_1.env.getBoolean('SF_USE_GENERIC_UNIX_KEYCHAIN') || kit_1.env.getBoolean('USE_GENERIC_UNIX_KEYCHAIN');
                 if (os.platform() === 'darwin' && !useGenericUnixKeychain) {
                     error.actions = [messages.getMessage('macKeychainOutOfSync')];
                 }
@@ -153,6 +145,7 @@ class Crypto extends kit_1.AsyncOptionalCreatable {
      * @param text The text
      * @returns true if the text is encrypted, false otherwise.
      */
+    // eslint-disable-next-line class-methods-use-this
     isEncrypted(text) {
         if (text == null) {
             return false;

package/lib/crypto/keyChain.js

@@ -11,8 +11,7 @@ const kit_1 = require("@salesforce/kit");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const keyChainImpl_1 = require("./keyChainImpl");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'encryption', ['unsupportedOperatingSystemError']);
+const messages = new messages_1.Messages('@salesforce/core', 'encryption', new Map([["invalidEncryptedFormatError", "The encrypted data is not properly formatted."], ["invalidEncryptedFormatError.actions", ["If attempting to create a scratch org then re-authorize. Otherwise create a new scratch org."]], ["authDecryptError", "Failed to decipher auth data. reason: %s."], ["unsupportedOperatingSystemError", "Unsupported Operating System: %s"], ["missingCredentialProgramError", "Unable to find required security software: %s"], ["credentialProgramAccessError", "Unable to execute security software: %s"], ["passwordRetryError", "Failed to get the password after %i retries."], ["passwordRequiredError", "A password is required."], ["keyChainServiceRequiredError", "Unable to get or set a keychain value without a service name."], ["keyChainAccountRequiredError", "Unable to get or set a keychain value without an account name."], ["keyChainUserCanceledError", "User canceled authentication."], ["keychainPasswordCreationError", "Failed to create a password in the keychain."], ["genericKeychainServiceError", "The service and account specified in %s do not match the version of the toolbelt."], ["genericKeychainServiceError.actions", ["Check your toolbelt version and re-auth."]], ["genericKeychainInvalidPermsError", "Invalid file permissions for secret file"], ["genericKeychainInvalidPermsError.actions", ["Ensure the file %s has the file permission octal value of %s."]], ["passwordNotFoundError", "Could not find password.\n%s"], ["passwordNotFoundError.actions", ["Ensure a valid password is returned with the following command: [%s]"]], ["setCredentialError", "Command failed with response:\n%s"], ["setCredentialError.actions", ["Determine why this command failed to set an encryption key for user %s: [%s]."]], ["macKeychainOutOfSync", "We\u2019ve encountered an error with the Mac keychain being out of sync with your `sfdx` credentials. To fix the problem, sync your credentials by authenticating into your org again using the auth commands."]]));
 /**
  * Gets the os level keychain impl.
  *
@@ -22,7 +21,7 @@ const messages = messages_1.Messages.load('@salesforce/core', 'encryption', ['un
 const retrieveKeychain = async (platform) => {
     const logger = await logger_1.Logger.child('keyChain');
     logger.debug(`platform: ${platform}`);
-    const useGenericUnixKeychainVar = kit_1.env.getBoolean('SFDX_USE_GENERIC_UNIX_KEYCHAIN');
+    const useGenericUnixKeychainVar = kit_1.env.getBoolean('SF_USE_GENERIC_UNIX_KEYCHAIN');
     const shouldUseGenericUnixKeychain = useGenericUnixKeychainVar && useGenericUnixKeychainVar;
     if (platform.startsWith('win')) {
         return keyChainImpl_1.keyChainImpl.generic_windows;

package/lib/crypto/keyChainImpl.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import * as childProcess from 'child_process';
 import * as nodeFs from 'fs';
 import { Nullable } from '@salesforce/ts-types';
-export declare type FsIfc = Pick<typeof nodeFs, 'statSync'>;
+export type FsIfc = Pick<typeof nodeFs, 'statSync'>;
 /**
  * Basic keychain interface.
  */
@@ -75,7 +77,7 @@ declare enum SecretField {
     ACCOUNT = "account",
     KEY = "key"
 }
-declare type SecretContents = {
+type SecretContents = {
     [SecretField.ACCOUNT]: string;
     [SecretField.KEY]?: string;
     [SecretField.SERVICE]: string;
@@ -110,5 +112,5 @@ export declare const keyChainImpl: {
     linux: KeychainAccess;
     validateProgram: (programPath: string, fsIfc: FsIfc, isExeIfc: (mode: number, gid: number, uid: number) => boolean) => Promise<void>;
 };
-export declare type KeyChain = GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess;
+export type KeyChain = GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess;
 export {};