@salesforce/core 3.9.0 → 3.11.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.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
+
+- rotating file logs ([ef5df25](https://github.com/forcedotcom/sfdx-core/commit/ef5df25c17a67541d12d5c228c18b75775251d98))
+
+## [3.10.0](https://github.com/forcedotcom/sfdx-core/compare/v3.9.0...v3.10.0) (2022-03-23)
+
+### Features
+
+- lifecycle events for scratch org create ([cba673b](https://github.com/forcedotcom/sfdx-core/commit/cba673b515df311165f3c392b155fcf5fbf9e2c6))
+- scratch org lifecycle events ([541349d](https://github.com/forcedotcom/sfdx-core/commit/541349d84b4784356d8bc504d1e331450487b6ec))
+
+### Bug Fixes
+
+- casing typo for import ([066a2bb](https://github.com/forcedotcom/sfdx-core/commit/066a2bbb37b07f62415f021ef511344976315128))
+- warnings about tracking aren't a throw (org will still auth, default) ([38114a3](https://github.com/forcedotcom/sfdx-core/commit/38114a3526267a615fa8f5d3470b79c9b36a8fa8))
+
 ## [3.9.0](https://github.com/forcedotcom/sfdx-core/compare/v3.8.1...v3.9.0) (2022-03-21)
 
 ### Features

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

@@ -26,6 +26,8 @@ export declare enum EnvironmentVariable {
     'SFDX_INSTANCE_URL' = "SFDX_INSTANCE_URL",
     'SFDX_JSON_TO_STDOUT' = "SFDX_JSON_TO_STDOUT",
     'SFDX_LOG_LEVEL' = "SFDX_LOG_LEVEL",
+    'SFDX_LOG_ROTATION_COUNT' = "SFDX_LOG_ROTATION_COUNT",
+    'SFDX_LOG_ROTATION_PERIOD' = "SFDX_LOG_ROTATION_PERIOD",
     'SFDX_MAX_QUERY_LIMIT' = "SFDX_MAX_QUERY_LIMIT",
     'SFDX_MDAPI_TEMP_DIR' = "SFDX_MDAPI_TEMP_DIR",
     'SFDX_NPM_REGISTRY' = "SFDX_NPM_REGISTRY",
@@ -44,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",
@@ -55,10 +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_MAX_QUERY_LIMIT' = "SF_MAX_QUERY_LIMIT",
+    'SF_LOG_ROTATION_COUNT' = "SF_LOG_ROTATION_COUNT",
+    'SF_LOG_ROTATION_PERIOD' = "SF_LOG_ROTATION_PERIOD",
+    '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

@@ -40,6 +40,8 @@ var EnvironmentVariable;
     EnvironmentVariable["SFDX_INSTANCE_URL"] = "SFDX_INSTANCE_URL";
     EnvironmentVariable["SFDX_JSON_TO_STDOUT"] = "SFDX_JSON_TO_STDOUT";
     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,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_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 +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),
@@ -176,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),
@@ -186,9 +190,17 @@ exports.SUPPORTED_ENV_VARS = {
         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),
@@ -259,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]: {
@@ -303,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]: {
@@ -315,8 +327,16 @@ exports.SUPPORTED_ENV_VARS = {
         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]: {

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';
@@ -30,6 +30,7 @@ export { MyDomainResolver } from './status/myDomainResolver';
 export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user';
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
 export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
-export { ScratchOrgInfo } from './org/scratchOrgInfoApi';
+export { ScratchOrgInfo } from './org/scratchOrgTypes';
+export { ScratchOrgLifecycleEvent, scratchOrgLifecycleEventName, scratchOrgLifecycleStages, } from './org/scratchOrgLifecycleEvents';
 export * from './util/sfdc';
 export * from './util/sfdcUrl';

package/lib/exported.js

@@ -16,7 +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.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");
@@ -40,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");
@@ -100,6 +103,9 @@ var permissionSetAssignment_1 = require("./org/permissionSetAssignment");
 Object.defineProperty(exports, "PermissionSetAssignment", { enumerable: true, get: function () { return permissionSetAssignment_1.PermissionSetAssignment; } });
 var scratchOrgCreate_1 = require("./org/scratchOrgCreate");
 Object.defineProperty(exports, "scratchOrgCreate", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgCreate; } });
+var scratchOrgLifecycleEvents_1 = require("./org/scratchOrgLifecycleEvents");
+Object.defineProperty(exports, "scratchOrgLifecycleEventName", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleEventName; } });
+Object.defineProperty(exports, "scratchOrgLifecycleStages", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleStages; } });
 // Utility sub-modules
 __exportStar(require("./util/sfdc"), exports);
 __exportStar(require("./util/sfdcUrl"), exports);

package/lib/logger.d.ts

@@ -163,6 +163,17 @@ export declare class Logger {
     static readonly LEVEL_NAMES: string[];
     private static readonly lifecycle;
     private static rootLogger?;
+    /**
+     * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+     * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationPeriod: string;
+    /**
+     * 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.
+     * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationCount: number;
     /**
      * Whether debug is enabled for this Logger.
      */

package/lib/logger.js

@@ -74,6 +74,17 @@ class Logger {
      * `Logger`.
      */
     constructor(optionsOrName) {
+        /**
+         * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+         * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationPeriod = new kit_1.Env().getString('SF_LOG_ROTATION_PERIOD') || '1d';
+        /**
+         * 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.
+         * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationCount = new kit_1.Env().getNumber('SF_LOG_ROTATION_COUNT') || 2;
         /**
          * Whether debug is enabled for this Logger.
          */
@@ -252,12 +263,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }
@@ -292,12 +303,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }

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/org/scratchOrgCreate.d.ts

@@ -1,6 +1,6 @@
 import { Duration } from '@salesforce/kit';
 import { Org } from './org';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 import { AuthFields, AuthInfo } from './authInfo';
 export declare const DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
 export interface ScratchOrgCreateResult {

package/lib/org/scratchOrgCreate.js

@@ -13,12 +13,13 @@ const messages_1 = require("../messages");
 const logger_1 = require("../logger");
 const configAggregator_1 = require("../config/configAggregator");
 const sfProject_1 = require("../sfProject");
-const sfError_1 = require("../sfError");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 const org_1 = require("./org");
 const scratchOrgInfoApi_1 = require("./scratchOrgInfoApi");
 const scratchOrgSettingsGenerator_1 = require("./scratchOrgSettingsGenerator");
 const scratchOrgInfoGenerator_1 = require("./scratchOrgInfoGenerator");
 const connection_1 = require("./connection");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate', [
     'SourceStatusResetFailureError',
@@ -58,6 +59,7 @@ const scratchOrgCreate = async (options) => {
     var _a;
     const logger = await logger_1.Logger.child('scratchOrgCreate');
     logger.debug('scratchOrgCreate');
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'prepare request' });
     const { hubOrg, connectedAppConsumerKey, durationDays = 1, nonamespace, noancestors, wait = kit_1.Duration.minutes(exports.DEFAULT_STREAM_TIMEOUT_MINUTES), retry = 0, apiversion, definitionjson, definitionfile, orgConfig, clientSecret = undefined, } = options;
     validateDuration(durationDays);
     validateRetry(retry);
@@ -100,10 +102,12 @@ const scratchOrgCreate = async (options) => {
     const username = scratchOrg.getUsername();
     logger.debug(`scratch org username ${username}`);
     const configAggregator = new configAggregator_1.ConfigAggregator();
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'deploy settings', scratchOrgInfo: scratchOrgInfoResult });
     const authInfo = await (0, scratchOrgInfoApi_1.deploySettingsAndResolveUrl)(scratchOrgAuthInfo, (_a = apiversion !== null && apiversion !== void 0 ? apiversion : configAggregator.getPropertyValue('apiVersion')) !== null && _a !== void 0 ? _a : (await scratchOrg.retrieveMaxApiVersion()), settingsGenerator, scratchOrg);
     logger.trace('Settings deployed to org');
     /** updating the revision num to zero during org:creation if source members are created during org:create.This only happens for some specific scratch org definition file.*/
     await updateRevisionCounterToZero(scratchOrg);
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'done', scratchOrgInfo: scratchOrgInfoResult });
     return {
         username,
         scratchOrgInfo: scratchOrgInfoResult,
@@ -126,17 +130,16 @@ const getSignupTargetLoginUrl = async () => {
 const updateRevisionCounterToZero = async (scratchOrg) => {
     const conn = scratchOrg.getConnection();
     const queryResult = await conn.tooling.sobject('SourceMember').find({ RevisionCounter: { $gt: 0 } }, ['Id']);
+    if (queryResult.length === 0) {
+        return;
+    }
     try {
         await conn.tooling
             .sobject('SourceMember')
             .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
     }
     catch (err) {
-        const message = messages.getMessage('SourceStatusResetFailureError', [
-            scratchOrg.getOrgId(),
-            scratchOrg.getUsername(),
-        ]);
-        throw new sfError_1.SfError(message, 'SourceStatusResetFailure');
+        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [scratchOrg.getOrgId(), scratchOrg.getUsername()]));
     }
 };
 //# sourceMappingURL=scratchOrgCreate.js.map

package/lib/org/scratchOrgErrorCodes.d.ts

@@ -1,4 +1,4 @@
 import { Optional } from '@salesforce/ts-types';
 import { Logger } from '../logger';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;

package/lib/org/scratchOrgInfoApi.d.ts

@@ -3,45 +3,8 @@ import { Duration } from '@salesforce/kit';
 import { SaveResult } from 'jsforce';
 import { AuthInfo } from './authInfo';
 import { Org } from './org';
-import SettingsGenerator, { ObjectSetting } from './scratchOrgSettingsGenerator';
-export interface ScratchOrgInfo {
-    AdminEmail?: string;
-    readonly CreatedDate?: string;
-    ConnectedAppCallbackUrl?: string;
-    ConnectedAppConsumerKey?: string;
-    Country?: string;
-    Description?: string;
-    DurationDays?: string;
-    Edition?: string;
-    readonly ErrorCode?: string;
-    readonly ExpirationDate?: string;
-    Features?: string;
-    HasSampleData?: boolean;
-    readonly Id?: string;
-    Language?: string;
-    LoginUrl: string;
-    readonly Name?: string;
-    Namespace?: string;
-    OrgName?: string;
-    Release?: 'Current' | 'Previous' | 'Preview';
-    readonly ScratchOrg?: string;
-    SourceOrg?: string;
-    readonly AuthCode: string;
-    Snapshot: string;
-    readonly Status: 'New' | 'Creating' | 'Active' | 'Error' | 'Deleted';
-    readonly SignupEmail: string;
-    readonly SignupUsername: string;
-    readonly SignupInstance: string;
-    Username: string;
-    settings?: Record<string, unknown>;
-    objectSettings?: {
-        [objectName: string]: ObjectSetting;
-    };
-    orgPreferences?: {
-        enabled: string[];
-        disabled: string[];
-    };
-}
+import SettingsGenerator from './scratchOrgSettingsGenerator';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 export interface JsForceError extends Error {
     errorCode: string;
     fields: string[];

package/lib/org/scratchOrgInfoApi.js

@@ -20,6 +20,7 @@ const myDomainResolver_1 = require("../status/myDomainResolver");
 const authInfo_1 = require("./authInfo");
 const org_1 = require("./org");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgInfoApi');
 const errorCodes = messages_1.Messages.load('@salesforce/core', 'scratchOrgErrorCodes', ['C-1007']);
@@ -144,6 +145,7 @@ const getAuthInfo = async (options) => {
 const authorizeScratchOrg = async (options) => {
     var _a;
     const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry: maxRetries } = options;
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'authenticate', scratchOrgInfo: scratchOrgInfoComplete });
     const logger = await logger_1.Logger.child('authorizeScratchOrg');
     logger.debug(`scratchOrgInfoComplete: ${JSON.stringify(scratchOrgInfoComplete, null, 4)}`);
     // if we didn't have it marked as a devhub but just successfully used it as one, this will update the authFile, fix cache, etc
@@ -225,6 +227,8 @@ const requestScratchOrgCreation = async (hubOrg, scratchOrgRequest, settings) =>
     const scratchOrgInfo = (0, mapKeys_1.default)(scratchOrgRequest, kit_1.upperFirst, true);
     await checkOrgDoesntExist(scratchOrgInfo); // throw if it does exist.
     try {
+        await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'send request' });
+        // return await will cause this catch block to run instead of the caller's catch block
         return await hubOrg.getConnection().sobject('ScratchOrgInfo').create(scratchOrgInfo);
     }
     catch (error) {
@@ -257,11 +261,13 @@ timeout = kit_1.Duration.minutes(15)) => {
                 logger.debug(`polling client result: ${JSON.stringify(resultInProgress, null, 4)}`);
                 // Once it's "done" we can return it
                 if (resultInProgress.Status === 'Active' || resultInProgress.Status === 'Error') {
+                    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'available', scratchOrgInfo: resultInProgress });
                     return {
                         completed: true,
                         payload: resultInProgress,
                     };
                 }
+                await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'wait for org', scratchOrgInfo: resultInProgress });
                 logger.debug(`Scratch org status is ${resultInProgress.Status}`);
                 return {
                     completed: false,

package/lib/org/scratchOrgInfoGenerator.d.ts

@@ -1,6 +1,6 @@
 import { SfProjectJson } from '../sfProject';
 import { Org } from './org';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 declare type PartialScratchOrgInfo = Pick<ScratchOrgInfo, 'ConnectedAppConsumerKey' | 'AuthCode' | 'Snapshot' | 'Status' | 'LoginUrl' | 'SignupEmail' | 'SignupUsername' | 'SignupInstance' | 'Username'>;
 export interface ScratchOrgInfoPayload extends PartialScratchOrgInfo {
     orgName: string;

package/lib/org/scratchOrgLifecycleEvents.d.ts

@@ -0,0 +1,8 @@
+import { ScratchOrgInfo } from './scratchOrgTypes';
+export declare const scratchOrgLifecycleEventName = "scratchOrgLifecycleEvent";
+export declare const scratchOrgLifecycleStages: readonly ["prepare request", "send request", "wait for org", "available", "authenticate", "deploy settings", "done"];
+export interface ScratchOrgLifecycleEvent {
+    stage: typeof scratchOrgLifecycleStages[number];
+    scratchOrgInfo?: ScratchOrgInfo;
+}
+export declare const emit: (event: ScratchOrgLifecycleEvent) => Promise<void>;

package/lib/org/scratchOrgLifecycleEvents.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emit = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = 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 lifecycleEvents_1 = require("../lifecycleEvents");
+const emitter = lifecycleEvents_1.Lifecycle.getInstance();
+exports.scratchOrgLifecycleEventName = 'scratchOrgLifecycleEvent';
+exports.scratchOrgLifecycleStages = [
+    'prepare request',
+    'send request',
+    'wait for org',
+    'available',
+    'authenticate',
+    'deploy settings',
+    'done',
+];
+const emit = async (event) => {
+    emitter.emit(exports.scratchOrgLifecycleEventName, event);
+};
+exports.emit = emit;
+//# sourceMappingURL=scratchOrgLifecycleEvents.js.map

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -1,5 +1,5 @@
 import { JsonMap } from '@salesforce/ts-types';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 import { Org } from './org';
 export declare enum RequestStatus {
     Pending = "Pending",
@@ -10,10 +10,6 @@ export declare enum RequestStatus {
     Canceling = "Canceling",
     Canceled = "Canceled"
 }
-export interface ObjectSetting extends JsonMap {
-    sharingModel?: string;
-    defaultRecordType?: string;
-}
 export interface BusinessProcessFileContent extends JsonMap {
     fullName: string;
     isActive: boolean;

package/lib/org/scratchOrgTypes.d.ts

@@ -0,0 +1,43 @@
+import { JsonMap } from '@salesforce/ts-types';
+export interface ScratchOrgInfo {
+    AdminEmail?: string;
+    readonly CreatedDate?: string;
+    ConnectedAppCallbackUrl?: string;
+    ConnectedAppConsumerKey?: string;
+    Country?: string;
+    Description?: string;
+    DurationDays?: string;
+    Edition?: string;
+    readonly ErrorCode?: string;
+    readonly ExpirationDate?: string;
+    Features?: string;
+    HasSampleData?: boolean;
+    readonly Id?: string;
+    Language?: string;
+    LoginUrl: string;
+    readonly Name?: string;
+    Namespace?: string;
+    OrgName?: string;
+    Release?: 'Current' | 'Previous' | 'Preview';
+    readonly ScratchOrg?: string;
+    SourceOrg?: string;
+    readonly AuthCode: string;
+    Snapshot: string;
+    readonly Status: 'New' | 'Creating' | 'Active' | 'Error' | 'Deleted';
+    readonly SignupEmail: string;
+    readonly SignupUsername: string;
+    readonly SignupInstance: string;
+    Username: string;
+    settings?: Record<string, unknown>;
+    objectSettings?: {
+        [objectName: string]: ObjectSetting;
+    };
+    orgPreferences?: {
+        enabled: string[];
+        disabled: string[];
+    };
+}
+export interface ObjectSetting extends JsonMap {
+    sharingModel?: string;
+    defaultRecordType?: string;
+}

package/lib/org/scratchOrgTypes.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scratchOrgTypes.js.map

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

@@ -94,6 +94,14 @@ Set to true to send messages resulting from failed Salesforce CLI commands to st
 
 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.
@@ -166,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.
 
@@ -210,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.
 
@@ -222,7 +230,15 @@ Set to true to send messages resulting from failed Salesforce CLI commands to st
 
 Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
 
-# sfMaxQueryLimit
+# 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.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.9.0",
+  "version": "3.11.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",