@salesforce/core 3.10.1 → 3.12.0

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.12.0](https://github.com/forcedotcom/sfdx-core/compare/v3.11.1...v3.12.0) (2022-04-04)
+
+### Features
+
+- move common authinfo utils to core ([01b8cf3](https://github.com/forcedotcom/sfdx-core/commit/01b8cf3fa38162380da5ce15f6dee1d2a5d2d72d))
+
+### [3.11.1](https://github.com/forcedotcom/sfdx-core/compare/v3.11.0...v3.11.1) (2022-04-01)
+
+## [3.11.0](https://github.com/forcedotcom/sfdx-core/compare/v3.10.1...v3.11.0) (2022-03-30)
+
+### Features
+
+- normalize config vars for sf ([#543](https://github.com/forcedotcom/sfdx-core/issues/543)) ([93f3cbe](https://github.com/forcedotcom/sfdx-core/commit/93f3cbe90103fa159f21f532ffc173931037651c))
+
 ### [3.10.1](https://github.com/forcedotcom/sfdx-core/compare/v3.10.0...v3.10.1) (2022-03-24)
 
 ### Bug Fixes

package/lib/config/config.d.ts

@@ -51,6 +51,20 @@ export interface ConfigPropertyMetaInput {
      */
     failedMessage: string | ((value: ConfigValue) => string);
 }
+export declare enum SfConfigProperties {
+    /**
+     * Disables telemetry reporting
+     */
+    DISABLE_TELEMETRY = "disable-telemetry"
+}
+export declare const SF_ALLOWED_PROPERTIES: {
+    key: SfConfigProperties;
+    description: string;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+}[];
 export declare enum SfdxPropertyKeys {
     /**
      * Username associated with the default dev hub org.
@@ -68,74 +82,112 @@ export declare enum SfdxPropertyKeys {
     DEFAULT_USERNAME = "defaultusername",
     /**
      * The sid for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_SID in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     ISV_DEBUGGER_SID = "isvDebuggerSid",
     /**
      * The url for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     ISV_DEBUGGER_URL = "isvDebuggerUrl",
     /**
      * The api version
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_API_VERSION in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     API_VERSION = "apiVersion",
     /**
      * Disables telemetry reporting
+     *
+     * @deprecated Replaced by SfPropertyKeys.DISABLE_TELEMETRY in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     DISABLE_TELEMETRY = "disableTelemetry",
     /**
      * Custom templates repo or local location.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     CUSTOM_ORG_METADATA_TEMPLATES = "customOrgMetadataTemplates",
     /**
      * allows users to override the 10,000 result query limit
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_MAX_QUERY_LIMIT in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     MAX_QUERY_LIMIT = "maxQueryLimit",
-    /** */
+    /**
+     * @deprecated
+     */
     REST_DEPLOY = "restDeploy",
-    /** */
+    /**
+     * @deprecated Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     */
     INSTANCE_URL = "instanceUrl"
 }
 export declare const SFDX_ALLOWED_PROPERTIES: ({
     key: SfdxPropertyKeys;
     description: string;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
     input: {
         validator: (value: ConfigValue) => boolean;
         failedMessage: string;
     };
+    encrypted?: undefined;
     hidden?: undefined;
-    newKey?: undefined;
-    deprecated?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
+    description: string;
+    input?: undefined;
     encrypted?: undefined;
+    hidden?: undefined;
 } | {
     key: SfdxPropertyKeys;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
     description: string;
-    hidden: boolean;
+    encrypted: boolean;
     input: {
         validator: (value: ConfigValue) => boolean;
         failedMessage: string;
     };
-    newKey?: undefined;
-    deprecated?: undefined;
-    encrypted?: undefined;
+    hidden?: undefined;
 } | {
     key: SfdxPropertyKeys;
-    newKey: OrgConfigProperties;
+    newKey: SfConfigProperties;
     deprecated: boolean;
     description: string;
-    input?: undefined;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
     hidden?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    description: string;
+    hidden: boolean;
+    newKey: string;
+    deprecated: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
     encrypted?: undefined;
 } | {
     key: SfdxPropertyKeys;
     description: string;
-    encrypted: boolean;
+    hidden: boolean;
+    newKey: OrgConfigProperties;
     input: {
         validator: (value: ConfigValue) => boolean;
         failedMessage: string;
     };
-    hidden?: undefined;
-    newKey?: undefined;
     deprecated?: undefined;
+    encrypted?: undefined;
 })[];
 export declare const SfProperty: {
     [index: string]: ConfigPropertyMeta;

package/lib/config/config.js

@@ -6,7 +6,7 @@
  * 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.Config = exports.SfProperty = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = void 0;
+exports.Config = exports.SfProperty = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.SF_ALLOWED_PROPERTIES = exports.SfConfigProperties = void 0;
 const path_1 = require("path");
 const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
@@ -40,10 +40,28 @@ const messages = messages_1.Messages.load('@salesforce/core', 'config', [
     'maxQueryLimit',
     'restDeploy',
     'instanceUrl',
+    'disable-telemetry',
 ]);
 const log = logger_1.Logger.childFromRoot('core:config');
 const SFDX_CONFIG_FILE_NAME = 'sfdx-config.json';
 const CONFIG_FILE_NAME = 'config.json';
+var SfConfigProperties;
+(function (SfConfigProperties) {
+    /**
+     * Disables telemetry reporting
+     */
+    SfConfigProperties["DISABLE_TELEMETRY"] = "disable-telemetry";
+})(SfConfigProperties = exports.SfConfigProperties || (exports.SfConfigProperties = {}));
+exports.SF_ALLOWED_PROPERTIES = [
+    {
+        key: SfConfigProperties.DISABLE_TELEMETRY,
+        description: messages.getMessage(SfConfigProperties.DISABLE_TELEMETRY),
+        input: {
+            validator: (value) => value == null || ['true', 'false'].includes(value.toString()),
+            failedMessage: messages.getMessage('invalidBooleanConfigValue'),
+        },
+    },
+];
 var SfdxPropertyKeys;
 (function (SfdxPropertyKeys) {
     /**
@@ -62,37 +80,55 @@ var SfdxPropertyKeys;
     SfdxPropertyKeys["DEFAULT_USERNAME"] = "defaultusername";
     /**
      * The sid for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_SID in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["ISV_DEBUGGER_SID"] = "isvDebuggerSid";
     /**
      * The url for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["ISV_DEBUGGER_URL"] = "isvDebuggerUrl";
     /**
      * The api version
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_API_VERSION in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["API_VERSION"] = "apiVersion";
     /**
      * Disables telemetry reporting
+     *
+     * @deprecated Replaced by SfPropertyKeys.DISABLE_TELEMETRY in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["DISABLE_TELEMETRY"] = "disableTelemetry";
     /**
      * Custom templates repo or local location.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["CUSTOM_ORG_METADATA_TEMPLATES"] = "customOrgMetadataTemplates";
     /**
      * allows users to override the 10,000 result query limit
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_MAX_QUERY_LIMIT in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     SfdxPropertyKeys["MAX_QUERY_LIMIT"] = "maxQueryLimit";
-    /** */
+    /**
+     * @deprecated
+     */
     SfdxPropertyKeys["REST_DEPLOY"] = "restDeploy";
-    /** */
+    /**
+     * @deprecated Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     */
     SfdxPropertyKeys["INSTANCE_URL"] = "instanceUrl";
 })(SfdxPropertyKeys = exports.SfdxPropertyKeys || (exports.SfdxPropertyKeys = {}));
 exports.SFDX_ALLOWED_PROPERTIES = [
     {
         key: SfdxPropertyKeys.INSTANCE_URL,
         description: messages.getMessage(SfdxPropertyKeys.INSTANCE_URL),
+        newKey: orgConfigProperties_1.OrgConfigProperties.ORG_INSTANCE_URL,
+        deprecated: true,
         input: {
             // If a value is provided validate it otherwise no value is unset.
             validator: (value) => {
@@ -109,6 +145,8 @@ exports.SFDX_ALLOWED_PROPERTIES = [
     },
     {
         key: SfdxPropertyKeys.API_VERSION,
+        newKey: orgConfigProperties_1.OrgConfigProperties.ORG_API_VERSION,
+        deprecated: true,
         description: messages.getMessage(SfdxPropertyKeys.API_VERSION),
         hidden: true,
         input: {
@@ -133,6 +171,8 @@ exports.SFDX_ALLOWED_PROPERTIES = [
     },
     {
         key: SfdxPropertyKeys.ISV_DEBUGGER_SID,
+        newKey: orgConfigProperties_1.OrgConfigProperties.ORG_ISV_DEBUGGER_SID,
+        deprecated: true,
         description: messages.getMessage(SfdxPropertyKeys.ISV_DEBUGGER_SID),
         encrypted: true,
         input: {
@@ -143,6 +183,8 @@ exports.SFDX_ALLOWED_PROPERTIES = [
     },
     {
         key: SfdxPropertyKeys.ISV_DEBUGGER_URL,
+        newKey: orgConfigProperties_1.OrgConfigProperties.ORG_ISV_DEBUGGER_URL,
+        deprecated: true,
         description: messages.getMessage(SfdxPropertyKeys.ISV_DEBUGGER_URL),
         input: {
             // If a value is provided validate it otherwise no value is unset.
@@ -152,17 +194,20 @@ exports.SFDX_ALLOWED_PROPERTIES = [
     },
     {
         key: SfdxPropertyKeys.DISABLE_TELEMETRY,
+        newKey: SfConfigProperties.DISABLE_TELEMETRY,
+        deprecated: true,
         description: messages.getMessage(SfdxPropertyKeys.DISABLE_TELEMETRY),
         input: {
             validator: (value) => value == null || ['true', 'false'].includes(value.toString()),
             failedMessage: messages.getMessage('invalidBooleanConfigValue'),
         },
     },
-    // This should be brought in by a plugin, but there isn't a way to do that right now.
     {
         key: SfdxPropertyKeys.REST_DEPLOY,
         description: messages.getMessage(SfdxPropertyKeys.REST_DEPLOY),
         hidden: true,
+        newKey: 'org-metadata-rest-deploy',
+        deprecated: true,
         input: {
             validator: (value) => value != null && ['true', 'false'].includes(value.toString()),
             failedMessage: messages.getMessage('invalidBooleanConfigValue'),
@@ -171,6 +216,8 @@ exports.SFDX_ALLOWED_PROPERTIES = [
     {
         key: SfdxPropertyKeys.MAX_QUERY_LIMIT,
         description: messages.getMessage(SfdxPropertyKeys.MAX_QUERY_LIMIT),
+        hidden: true,
+        newKey: orgConfigProperties_1.OrgConfigProperties.ORG_MAX_QUERY_LIMIT,
         input: {
             // the bit shift will remove the negative bit, and any decimal numbers
             // then the parseFloat will handle converting it to a number from a string
@@ -420,6 +467,7 @@ class Config extends configFile_1.ConfigFile {
 exports.Config = Config;
 Config.allowedProperties = [
     ...exports.SFDX_ALLOWED_PROPERTIES,
+    ...exports.SF_ALLOWED_PROPERTIES,
     ...orgConfigProperties_1.ORG_CONFIG_ALLOWED_PROPERTIES,
 ];
 class SfdxConfig {

package/lib/config/envVars.d.ts

@@ -46,7 +46,7 @@ export declare enum EnvironmentVariable {
     'SF_TARGET_ORG' = "SF_TARGET_ORG",
     'SF_TARGET_DEV_HUB' = "SF_TARGET_DEV_HUB",
     'SF_ACCESS_TOKEN' = "SF_ACCESS_TOKEN",
-    'SF_API_VERSION' = "SF_API_VERSION",
+    'SF_ORG_API_VERSION' = "SF_ORG_API_VERSION",
     'SF_AUDIENCE_URL' = "SF_AUDIENCE_URL",
     'SF_CODE_COVERAGE_REQUIREMENT' = "SF_CODE_COVERAGE_REQUIREMENT",
     'SF_CONTENT_TYPE' = "SF_CONTENT_TYPE",
@@ -57,12 +57,12 @@ export declare enum EnvironmentVariable {
     'SF_DNS_TIMEOUT' = "SF_DNS_TIMEOUT",
     'SF_DOMAIN_RETRY' = "SF_DOMAIN_RETRY",
     'SF_IMPROVED_CODE_COVERAGE' = "SF_IMPROVED_CODE_COVERAGE",
-    'SF_INSTANCE_URL' = "SF_INSTANCE_URL",
+    'SF_ORG_INSTANCE_URL' = "SF_ORG_INSTANCE_URL",
     'SF_JSON_TO_STDOUT' = "SF_JSON_TO_STDOUT",
     'SF_LOG_LEVEL' = "SF_LOG_LEVEL",
     'SF_LOG_ROTATION_COUNT' = "SF_LOG_ROTATION_COUNT",
     'SF_LOG_ROTATION_PERIOD' = "SF_LOG_ROTATION_PERIOD",
-    'SF_MAX_QUERY_LIMIT' = "SF_MAX_QUERY_LIMIT",
+    'SF_ORG_MAX_QUERY_LIMIT' = "SF_ORG_MAX_QUERY_LIMIT",
     'SF_MDAPI_TEMP_DIR' = "SF_MDAPI_TEMP_DIR",
     'SF_NPM_REGISTRY' = "SF_NPM_REGISTRY",
     'SF_PRECOMPILE_ENABLE' = "SF_PRECOMPILE_ENABLE",

package/lib/config/envVars.js

@@ -60,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";
@@ -71,12 +71,12 @@ 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_LOG_LEVEL"] = "SF_LOG_LEVEL";
     EnvironmentVariable["SF_LOG_ROTATION_COUNT"] = "SF_LOG_ROTATION_COUNT";
     EnvironmentVariable["SF_LOG_ROTATION_PERIOD"] = "SF_LOG_ROTATION_PERIOD";
-    EnvironmentVariable["SF_MAX_QUERY_LIMIT"] = "SF_MAX_QUERY_LIMIT";
+    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";
@@ -128,7 +128,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),
@@ -180,7 +180,7 @@ 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),
@@ -200,7 +200,7 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [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),
@@ -271,8 +271,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]: {
@@ -315,8 +315,8 @@ 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]: {
@@ -335,8 +335,8 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_PERIOD),
         synonymOf: null,
     },
-    [EnvironmentVariable.SF_MAX_QUERY_LIMIT]: {
-        description: getMessage(EnvironmentVariable.SF_MAX_QUERY_LIMIT),
+    [EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT]: {
+        description: getMessage(EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT),
         synonymOf: null,
     },
     [EnvironmentVariable.SF_MDAPI_TEMP_DIR]: {

package/lib/exported.d.ts

@@ -6,7 +6,7 @@ export { BaseConfigStore, ConfigContents, ConfigEntry, ConfigStore, ConfigValue
 export { GlobalInfo, SfEntry, SfInfo, SfInfoKeys, SfOrg, SfOrgs, SfToken, SfTokens } from './globalInfo';
 export { DeviceOauthService, DeviceCodeResponse, DeviceCodePollingResponse } from './deviceOauthService';
 export { OrgUsersConfig } from './config/orgUsersConfig';
-export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SFDX_ALLOWED_PROPERTIES, } from './config/config';
+export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SfConfigProperties, SFDX_ALLOWED_PROPERTIES, SF_ALLOWED_PROPERTIES, } from './config/config';
 export { ConfigInfo, ConfigAggregator } from './config/configAggregator';
 export { AuthFields, AuthInfo, AuthSideEffects, OrgAuthorization } from './org/authInfo';
 export { AuthRemover } from './org/authRemover';

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.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = 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.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = 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.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
+exports.User = exports.REQUIRED_FIELDS = 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.ConfigAggregator = 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.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.scratchOrgCreate = exports.PermissionSetAssignment = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -41,7 +41,9 @@ Object.defineProperty(exports, "OrgUsersConfig", { enumerable: true, get: functi
 var config_1 = require("./config/config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
 Object.defineProperty(exports, "SfdxPropertyKeys", { enumerable: true, get: function () { return config_1.SfdxPropertyKeys; } });
+Object.defineProperty(exports, "SfConfigProperties", { enumerable: true, get: function () { return config_1.SfConfigProperties; } });
 Object.defineProperty(exports, "SFDX_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return config_1.SFDX_ALLOWED_PROPERTIES; } });
+Object.defineProperty(exports, "SF_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return config_1.SF_ALLOWED_PROPERTIES; } });
 var configAggregator_1 = require("./config/configAggregator");
 Object.defineProperty(exports, "ConfigAggregator", { enumerable: true, get: function () { return configAggregator_1.ConfigAggregator; } });
 var authInfo_1 = require("./org/authInfo");

package/lib/org/authInfo.d.ts

@@ -171,6 +171,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.
      */

package/lib/org/authInfo.js

@@ -26,6 +26,7 @@ const messages_1 = require("../messages");
 const sfdcUrl_1 = require("../util/sfdcUrl");
 const connection_1 = require("./connection");
 const orgConfigProperties_1 = require("./orgConfigProperties");
+const org_1 = require("./org");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'core', [
     'authInfoCreationError',
@@ -246,6 +247,61 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
             loginUrl: `https://${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 async identifyPossibleScratchOrgs(fields, orgAuthInfo) {
+        // fields property is passed in because the consumers of this method have performed the decrypt.
+        // This is so we don't have to call authInfo.getFields(true) and decrypt again OR accidentally save an
+        // authInfo before it is necessary.
+        const logger = await logger_1.Logger.child('Common', { tag: 'identifyPossibleScratchOrgs' });
+        // return if we already know the hub org we know it is a devhub or prod-like or no orgId present
+        if (fields.isDevHub || fields.devHubUsername || !fields.orgId)
+            return;
+        logger.debug('getting devHubs');
+        // TODO: return if url is not sandbox-like to avoid constantly asking about production orgs
+        // TODO: someday we make this easier by asking the org if it is a scratch org
+        const hubAuthInfos = await AuthInfo.getDevHubAuthInfos();
+        logger.debug(`found ${hubAuthInfos.length} DevHubs`);
+        if (hubAuthInfos.length === 0)
+            return;
+        // ask all those orgs if they know this orgId
+        await Promise.all(hubAuthInfos.map(async (hubAuthInfo) => {
+            try {
+                const data = await AuthInfo.queryScratchOrg(hubAuthInfo.username, fields.orgId);
+                if (data.totalSize > 0) {
+                    // if any return a result
+                    logger.debug(`found orgId ${fields.orgId} in devhub ${hubAuthInfo.username}`);
+                    try {
+                        await orgAuthInfo.save({ ...fields, devHubUsername: hubAuthInfo.username });
+                        logger.debug(`set ${hubAuthInfo.username} as devhub for scratch org ${orgAuthInfo.getUsername()}`);
+                    }
+                    catch (error) {
+                        logger.debug(`error updating auth file for ${orgAuthInfo.getUsername()}`, error);
+                    }
+                }
+            }
+            catch (error) {
+                logger.error(`Error connecting to devhub ${hubAuthInfo.username}`, error);
+            }
+        }));
+    }
+    /**
+     * Find all dev hubs available in the local environment.
+     */
+    static async getDevHubAuthInfos() {
+        return (await AuthInfo.listAllAuthorizations()).filter((possibleHub) => possibleHub === null || possibleHub === void 0 ? void 0 : possibleHub.isDevHub);
+    }
+    static async queryScratchOrg(devHubUsername, scratchOrgId) {
+        const devHubOrg = await org_1.Org.create({ aliasOrUsername: devHubUsername });
+        const conn = devHubOrg.getConnection();
+        const data = await conn.query(`select Id from ScratchOrgInfo where ScratchOrg = '${sfdc_1.sfdc.trimTo15(scratchOrgId)}'`);
+        return data;
+    }
     /**
      * Get the username.
      */

package/lib/org/orgConfigProperties.d.ts

@@ -1,8 +1,69 @@
+import { ConfigValue } from '../config/configStore';
 export declare enum OrgConfigProperties {
+    /**
+     * Username associate with the default org.
+     */
     TARGET_ORG = "target-org",
-    TARGET_DEV_HUB = "target-dev-hub"
+    /**
+     * Username associated with the default dev hub org.
+     */
+    TARGET_DEV_HUB = "target-dev-hub",
+    /**
+     * The api version
+     */
+    ORG_API_VERSION = "org-api-version",
+    /**
+     * Custom templates repo or local location.
+     */
+    ORG_CUSTOM_METADATA_TEMPLATES = "org-custom-metadata-templates",
+    /**
+     * Allows users to override the 10,000 result query limit.
+     */
+    ORG_MAX_QUERY_LIMIT = "org-max-query-limit",
+    /**
+     * The instance url of the org.
+     */
+    ORG_INSTANCE_URL = "org-instance-url",
+    /**
+     * The sid for the debugger configuration.
+     */
+    ORG_ISV_DEBUGGER_SID = "org-isv-debugger-sid",
+    /**
+     * The url for the debugger configuration.
+     */
+    ORG_ISV_DEBUGGER_URL = "org-isv-debugger-url"
 }
-export declare const ORG_CONFIG_ALLOWED_PROPERTIES: {
+export declare const ORG_CONFIG_ALLOWED_PROPERTIES: ({
     key: OrgConfigProperties;
     description: string;
-}[];
+    input?: undefined;
+    hidden?: undefined;
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    hidden?: undefined;
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    hidden: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    encrypted: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    hidden?: undefined;
+})[];

package/lib/org/orgConfigProperties.js

@@ -8,22 +8,125 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = void 0;
 const path_1 = require("path");
+const ts_types_1 = require("@salesforce/ts-types");
 const messages_1 = require("../messages");
+const sfdcUrl_1 = require("../util/sfdcUrl");
+const sfdc_1 = require("../util/sfdc");
 messages_1.Messages.importMessagesDirectory((0, path_1.join)(__dirname));
-const messages = messages_1.Messages.load('@salesforce/core', 'config', ['targetOrg', 'targetDevHub']);
+const messages = messages_1.Messages.load('@salesforce/core', 'config', [
+    'invalidApiVersion',
+    'invalidBooleanConfigValue',
+    'invalidInstanceUrl',
+    'invalidIsvDebuggerSid',
+    'invalidIsvDebuggerUrl',
+    'invalidNumberConfigValue',
+    'org-api-version',
+    'org-instance-url',
+    'org-isv-debugger-sid',
+    'org-isv-debugger-url',
+    'org-max-query-limit',
+    'target-dev-hub',
+    'target-org',
+]);
 var OrgConfigProperties;
 (function (OrgConfigProperties) {
+    /**
+     * Username associate with the default org.
+     */
     OrgConfigProperties["TARGET_ORG"] = "target-org";
+    /**
+     * Username associated with the default dev hub org.
+     */
     OrgConfigProperties["TARGET_DEV_HUB"] = "target-dev-hub";
+    /**
+     * The api version
+     */
+    OrgConfigProperties["ORG_API_VERSION"] = "org-api-version";
+    /**
+     * Custom templates repo or local location.
+     */
+    OrgConfigProperties["ORG_CUSTOM_METADATA_TEMPLATES"] = "org-custom-metadata-templates";
+    /**
+     * Allows users to override the 10,000 result query limit.
+     */
+    OrgConfigProperties["ORG_MAX_QUERY_LIMIT"] = "org-max-query-limit";
+    /**
+     * The instance url of the org.
+     */
+    OrgConfigProperties["ORG_INSTANCE_URL"] = "org-instance-url";
+    /**
+     * The sid for the debugger configuration.
+     */
+    OrgConfigProperties["ORG_ISV_DEBUGGER_SID"] = "org-isv-debugger-sid";
+    /**
+     * The url for the debugger configuration.
+     */
+    OrgConfigProperties["ORG_ISV_DEBUGGER_URL"] = "org-isv-debugger-url";
 })(OrgConfigProperties = exports.OrgConfigProperties || (exports.OrgConfigProperties = {}));
 exports.ORG_CONFIG_ALLOWED_PROPERTIES = [
     {
         key: OrgConfigProperties.TARGET_ORG,
-        description: messages.getMessage('targetOrg'),
+        description: messages.getMessage(OrgConfigProperties.TARGET_ORG),
     },
     {
         key: OrgConfigProperties.TARGET_DEV_HUB,
-        description: messages.getMessage('targetDevHub'),
+        description: messages.getMessage(OrgConfigProperties.TARGET_DEV_HUB),
+    },
+    {
+        key: OrgConfigProperties.ORG_INSTANCE_URL,
+        description: messages.getMessage(OrgConfigProperties.ORG_INSTANCE_URL),
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => {
+                if (value == null)
+                    return true;
+                // validate if the value is a string and is a valid url and is either a salesforce domain
+                // or an internal url.
+                return ((0, ts_types_1.isString)(value) &&
+                    sfdcUrl_1.SfdcUrl.isValidUrl(value) &&
+                    (new sfdcUrl_1.SfdcUrl(value).isSalesforceDomain() || new sfdcUrl_1.SfdcUrl(value).isInternalUrl()));
+            },
+            failedMessage: messages.getMessage('invalidInstanceUrl'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_API_VERSION,
+        description: messages.getMessage(OrgConfigProperties.ORG_API_VERSION),
+        hidden: true,
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || ((0, ts_types_1.isString)(value) && sfdc_1.sfdc.validateApiVersion(value)),
+            failedMessage: messages.getMessage('invalidApiVersion'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_ISV_DEBUGGER_SID,
+        description: messages.getMessage(OrgConfigProperties.ORG_ISV_DEBUGGER_SID),
+        encrypted: true,
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || (0, ts_types_1.isString)(value),
+            failedMessage: messages.getMessage('invalidIsvDebuggerSid'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_ISV_DEBUGGER_URL,
+        description: messages.getMessage(OrgConfigProperties.ORG_ISV_DEBUGGER_URL),
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || (0, ts_types_1.isString)(value),
+            failedMessage: messages.getMessage('invalidIsvDebuggerUrl'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_MAX_QUERY_LIMIT,
+        description: messages.getMessage(OrgConfigProperties.ORG_MAX_QUERY_LIMIT),
+        input: {
+            // the bit shift will remove the negative bit, and any decimal numbers
+            // then the parseFloat will handle converting it to a number from a string
+            validator: (value) => value >>> 0 === parseFloat(value) && value > 0,
+            failedMessage: messages.getMessage('invalidNumberConfigValue'),
+        },
     },
 ];
 //# sourceMappingURL=orgConfigProperties.js.map

package/lib/testSetup.js

@@ -480,8 +480,8 @@ class MockTestOrgData {
         this.userId = `user_id_${this.testId}`;
         this.orgId = `${this.testId}`;
         this.username = (options === null || options === void 0 ? void 0 : options.username) || `admin_${this.testId}@gb.org`;
-        this.loginUrl = `http://login.${this.testId}.salesforce.com`;
-        this.instanceUrl = `http://instance.${this.testId}.salesforce.com`;
+        this.loginUrl = `https://login.${this.testId}.salesforce.com`;
+        this.instanceUrl = `https://instance.${this.testId}.salesforce.com`;
         this.clientId = `${this.testId}/client_id`;
         this.clientSecret = `${this.testId}/client_secret`;
         this.authcode = `${this.testId}/authcode`;

package/messages/config.md

@@ -75,11 +75,11 @@ In sfdx-project.json, indicate only one package directory (path) as the default.
 
 The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `"default": false` key and try again.
 
-# targetOrg
+# target-org
 
 Username or alias of the org that all commands run against by default. (sf only)
 
-# targetDevHub
+# target-dev-hub
 
 Username or alias of your default Dev Hub org. (sf only)
 
@@ -93,28 +93,52 @@ Username or alias of your default Dev Hub org. (sfdx only)
 
 # isvDebuggerSid
 
-ISV debugger SID
+ISV debugger SID (sfdx only)
 
 # isvDebuggerUrl
 
-ISV debugger URL
+ISV debugger URL (sfdx only)
+
+# org-isv-debugger-sid
+
+ISV debugger SID.
+
+# org-isv-debugger-url
+
+ISV debugger URL.
 
 # apiVersion
 
+API version of your project. Default: API version of your Dev Hub org. (sfdx only)
+
+# org-api-version
+
 API version of your project. Default: API version of your Dev Hub org.
 
 # disableTelemetry
 
-Disables the collection of usage and user environment information, etc. Default: true.
+Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)
+
+# disable-telemetry
+
+Disables the collection of usage and user environment information, etc. Default: false.
 
 # maxQueryLimit
 
+Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)
+
+# org-max-query-limit
+
 Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
 
 # restDeploy
 
-Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).
+Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)
 
 # instanceUrl
 
+URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)
+
+# org-instance-url
+
 URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.

package/messages/envVars.md

@@ -174,7 +174,7 @@ Username or alias of your default Dev Hub org. Overrides the target-dev-hub conf
 
 Specifies an access token when using a login command that uses access tokens.
 
-# sfApiVersion
+# 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.
 
@@ -218,7 +218,7 @@ Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom
 
 Set to true to scope Apex test results to the classes entered during a test run when running the Apex test commands.
 
-# sfInstanceUrl
+# sfOrgInstanceUrl
 
 URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration variable.
 
@@ -238,7 +238,7 @@ The default rotation period for logs. Example '1d' will rotate logs daily (at mi
 
 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.
 
-# sfMaxQueryLimit
+# sfOrgMaxQueryLimit
 
 Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.10.1",
+  "version": "3.12.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -34,7 +34,6 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@oclif/core": "^1.5.1",
     "@salesforce/bunyan": "^2.0.0",
     "@salesforce/kit": "^1.5.34",
     "@salesforce/schemas": "^1.1.0",