@salesforce/core 4.0.0 → 4.1.0

package/lib/org/scratchOrgErrorCodes.js

@@ -6,18 +6,15 @@
  * 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.checkScratchOrgInfoForErrors = void 0;
+exports.checkScratchOrgInfoForErrors = exports.validateScratchOrgInfoForResume = void 0;
 const messages_1 = require("../messages");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
+const logger_1 = require("../logger");
+const scratchOrgCache_1 = require("./scratchOrgCache");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 const WORKSPACE_CONFIG_FILENAME = 'sfdx-project.json';
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgErrorCodes');
-const namedMessages = messages_1.Messages.load('@salesforce/core', 'scratchOrgErrorCodes', [
-    'SignupFailedActionError',
-    'SignupFailedUnknownError',
-    'SignupFailedError',
-    'SignupUnexpectedError',
-]);
+const messages = new messages_1.Messages('@salesforce/core', 'scratchOrgErrorCodes', new Map([["SignupFailedError", "The request to create a scratch org failed with error code: %s."], ["SignupFailedUnknownError", "An unknown server error occurred. Please try again. If you still see this error, contact Salesforce support for assistance. Include the information from 'sfdx force:data:record:get -s ScratchOrgInfo -i %s -u %s'."], ["SignupFailedActionError", "See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_error_codes.htm for information on error code %s."], ["SignupUnexpectedError", "The request to create a scratch org returned an unexpected status"], ["StillInProgressError", "The scratch org is not ready yet (Status = %s)."], ["action.StillInProgress", "Wait for a few minutes, and then try the command again"], ["NoScratchOrgInfoError", "No ScratchOrgInfo object found in the Dev Hub you specified. Check that the ID and the Dev Hub are correct."], ["ScratchOrgDeletedError", "That scratch org has been deleted, so you can't connect to it anymore."], ["INVALID_ID_FIELD", "Provide a valid template ID, in the format 0TTxxxxxxxxxxxx."], ["T-0002", "We couldn\u2019t find a template or snapshot with the ID or name specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["T-0003", "The template specified in the scratch org definition is unapproved. Contact Salesforce Support to request template approval."], ["T-0004", "The Trialforce Source Organization (TSO) for the template doesn\u2019t exist or has expired."], ["S-1006", "Provide a valid email address in your scratch org definition or your %s file."], ["S-2006", "Provide a valid country code in your scratch org definition or your %s file."], ["S-1017", "Specify a namespace that\u2019s used by a release org associated with your Dev Hub org."], ["S-1018", "Provide a valid My Domain value. This value can\u2019t include double hyphens, end in a hyphen, include restricted words, or be more than 40 characters long."], ["S-1019", "The My Domain value you chose is already in use."], ["S-1026", "Provide a valid namespace value. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["S-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance."], ["SH-0001", "Can\u2019t create scratch org. Contact the source org admin to add your Dev Hub org ID to Setup > Org Shape. Then try again."], ["SH-0002", "Can\u2019t create scratch org. No org shape exists for the specified sourceOrg. Create an org shape and try again."], ["SH-0003", "Can\u2019t create scratch org from org shape. The org shape version is outdated. Recreate the org shape and try again."], ["C-1007", "The username provided to the org:create command is already in use. Run 'force:org:list --clean' to remove stale org authentications or create the org with a different username."], ["C-1015", "We encountered a problem while registering your My Domain value with the DNS provider. Please try again."], ["C-1016", "We encountered a problem while attempting to configure and approve the Connected App for your org. Verify the Connected App configuration with your Salesforce admin."], ["C-1017", "Provide a valid namespace prefix. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["C-1020", "We couldn't find a template with the ID specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["C-1027", "The template specified in the Scratch Definition isn\u2019t supported. Specify a generic edition (such as Developer or Enterprise), or specify a template ID."], ["C-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance"]]));
+const namedMessages = new messages_1.Messages('@salesforce/core', 'scratchOrgErrorCodes', new Map([["SignupFailedError", "The request to create a scratch org failed with error code: %s."], ["SignupFailedUnknownError", "An unknown server error occurred. Please try again. If you still see this error, contact Salesforce support for assistance. Include the information from 'sfdx force:data:record:get -s ScratchOrgInfo -i %s -u %s'."], ["SignupFailedActionError", "See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_error_codes.htm for information on error code %s."], ["SignupUnexpectedError", "The request to create a scratch org returned an unexpected status"], ["StillInProgressError", "The scratch org is not ready yet (Status = %s)."], ["action.StillInProgress", "Wait for a few minutes, and then try the command again"], ["NoScratchOrgInfoError", "No ScratchOrgInfo object found in the Dev Hub you specified. Check that the ID and the Dev Hub are correct."], ["ScratchOrgDeletedError", "That scratch org has been deleted, so you can't connect to it anymore."], ["INVALID_ID_FIELD", "Provide a valid template ID, in the format 0TTxxxxxxxxxxxx."], ["T-0002", "We couldn\u2019t find a template or snapshot with the ID or name specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["T-0003", "The template specified in the scratch org definition is unapproved. Contact Salesforce Support to request template approval."], ["T-0004", "The Trialforce Source Organization (TSO) for the template doesn\u2019t exist or has expired."], ["S-1006", "Provide a valid email address in your scratch org definition or your %s file."], ["S-2006", "Provide a valid country code in your scratch org definition or your %s file."], ["S-1017", "Specify a namespace that\u2019s used by a release org associated with your Dev Hub org."], ["S-1018", "Provide a valid My Domain value. This value can\u2019t include double hyphens, end in a hyphen, include restricted words, or be more than 40 characters long."], ["S-1019", "The My Domain value you chose is already in use."], ["S-1026", "Provide a valid namespace value. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["S-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance."], ["SH-0001", "Can\u2019t create scratch org. Contact the source org admin to add your Dev Hub org ID to Setup > Org Shape. Then try again."], ["SH-0002", "Can\u2019t create scratch org. No org shape exists for the specified sourceOrg. Create an org shape and try again."], ["SH-0003", "Can\u2019t create scratch org from org shape. The org shape version is outdated. Recreate the org shape and try again."], ["C-1007", "The username provided to the org:create command is already in use. Run 'force:org:list --clean' to remove stale org authentications or create the org with a different username."], ["C-1015", "We encountered a problem while registering your My Domain value with the DNS provider. Please try again."], ["C-1016", "We encountered a problem while attempting to configure and approve the Connected App for your org. Verify the Connected App configuration with your Salesforce admin."], ["C-1017", "Provide a valid namespace prefix. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["C-1020", "We couldn't find a template with the ID specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["C-1027", "The template specified in the Scratch Definition isn\u2019t supported. Specify a generic edition (such as Developer or Enterprise), or specify a template ID."], ["C-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance"]]));
 // getMessage will throw when the code isn't found
 // and we don't know whether a given code takes arguments or not
 const optionalErrorCodeMessage = (errorCode, args) => {
@@ -34,29 +31,49 @@ const optionalErrorCodeMessage = (errorCode, args) => {
         return undefined;
     }
 };
-const checkScratchOrgInfoForErrors = (orgInfo, hubUsername, logger) => {
-    if (!orgInfo) {
-        throw new sfdxError_1.SfdxError('No scratch org info found.', 'ScratchOrgInfoNotFound');
+const validateScratchOrgInfoForResume = async ({ jobId, scratchOrgInfo, cache, hubUsername, }) => {
+    if (!scratchOrgInfo?.Id || scratchOrgInfo.Status === 'Deleted') {
+        // 1. scratch org info does not exist in that dev hub or has been deleted
+        cache.unset(jobId);
+        await cache.write();
+        throw scratchOrgInfo.Status === 'Deleted'
+            ? namedMessages.createError('ScratchOrgDeletedError')
+            : namedMessages.createError('NoScratchOrgInfoError');
+    }
+    if (['New', 'Creating'].includes(scratchOrgInfo.Status)) {
+        // 2. scratchOrgInfo exists, still isn't finished.  Stays in cache for future attempts
+        throw namedMessages.createError('StillInProgressError', [scratchOrgInfo.Status], ['action.StillInProgress']);
+    }
+    return (0, exports.checkScratchOrgInfoForErrors)(scratchOrgInfo, hubUsername);
+};
+exports.validateScratchOrgInfoForResume = validateScratchOrgInfoForResume;
+const checkScratchOrgInfoForErrors = async (orgInfo, hubUsername) => {
+    if (!orgInfo?.Id) {
+        throw new sfError_1.SfError('No scratch org info found.', 'ScratchOrgInfoNotFound');
     }
     if (orgInfo.Status === 'Active') {
+        await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'available', scratchOrgInfo: orgInfo });
         return orgInfo;
     }
     if (orgInfo.Status === 'Error' && orgInfo.ErrorCode) {
+        await scratchOrgCache_1.ScratchOrgCache.unset(orgInfo.Id);
         const message = optionalErrorCodeMessage(orgInfo.ErrorCode, [WORKSPACE_CONFIG_FILENAME]);
         if (message) {
-            throw new sfdxError_1.SfdxError(message, 'RemoteOrgSignupFailed', [
+            throw new sfError_1.SfError(message, 'RemoteOrgSignupFailed', [
                 namedMessages.getMessage('SignupFailedActionError', [orgInfo.ErrorCode]),
             ]);
         }
-        throw new sfdxError_1.SfdxError(namedMessages.getMessage('SignupFailedError', [orgInfo.ErrorCode]));
+        throw new sfError_1.SfError(namedMessages.getMessage('SignupFailedError', [orgInfo.ErrorCode]));
     }
     if (orgInfo.Status === 'Error') {
+        await scratchOrgCache_1.ScratchOrgCache.unset(orgInfo.Id);
+        const logger = await logger_1.Logger.child('ScratchOrgErrorCodes');
         // Maybe the request object can help the user somehow
         logger.error('No error code on signup error! Logging request.');
         logger.error(orgInfo);
-        throw new sfdxError_1.SfdxError(namedMessages.getMessage('SignupFailedUnknownError', [orgInfo.Id, hubUsername]), 'signupFailedUnknown');
+        throw new sfError_1.SfError(namedMessages.getMessage('SignupFailedUnknownError', [orgInfo.Id, hubUsername]), 'signupFailedUnknown');
     }
-    throw new sfdxError_1.SfdxError(namedMessages.getMessage('SignupUnexpectedError'), 'UnexpectedSignupStatus');
+    throw new sfError_1.SfError(namedMessages.getMessage('SignupUnexpectedError'), 'UnexpectedSignupStatus');
 };
 exports.checkScratchOrgInfoForErrors = checkScratchOrgInfoForErrors;
 //# sourceMappingURL=scratchOrgErrorCodes.js.map

package/lib/org/scratchOrgFeatureDeprecation.js

@@ -14,12 +14,7 @@ exports.ScratchOrgFeatureDeprecation = void 0;
 const ts_types_1 = require("@salesforce/ts-types");
 // Local
 const messages_1 = require("../messages");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgFeatureDeprecation', [
-    'quantifiedFeatureWithoutQuantityWarning',
-    'mappedFeatureWarning',
-    'deprecatedFeatureWarning',
-]);
+const messages = new messages_1.Messages('@salesforce/core', 'scratchOrgFeatureDeprecation', new Map([["quantifiedFeatureWithoutQuantityWarning", "The feature %s will be deprecated in a future release. It's been replaced by %s:<value>, which requires you to specify a quantity."], ["mappedFeatureWarning", "The feature %s has been deprecated. It has been replaced with %s in this scratch org create request."], ["deprecatedFeatureWarning", "The feature %s has been deprecated. It has been removed from the list of requested features."]]));
 const FEATURE_TYPES = {
     // simpleFeatureMapping holds a set of direct replacement values for features.
     simpleFeatureMapping: {

package/lib/org/scratchOrgInfoApi.d.ts

@@ -1,51 +1,20 @@
-import { Optional } from '@salesforce/ts-types';
 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[];
 }
+/**
+ *
+ * @param hubOrg Org
+ * @param id Record ID for the ScratchOrgInfoObject
+ * @returns Promise<ScratchOrgInfo>
+ */
+export declare const queryScratchOrgInfo: (hubOrg: Org, id: string) => Promise<ScratchOrgInfo>;
 /**
  * after we successfully signup an org we need to trade the auth token for access and refresh token.
  *
@@ -83,12 +52,17 @@ export declare const requestScratchOrgCreation: (hubOrg: Org, scratchOrgRequest:
  */
 export declare const pollForScratchOrgInfo: (hubOrg: Org, scratchOrgInfoId: string, timeout?: Duration) => Promise<ScratchOrgInfo>;
 /**
- * This authenticates into the newly created org and sets org preferences
+ * Deploy settings to the newly created scratch org
+ *
+ * @param scratchOrg an instance of the Org class
+ * @param orgSettings an instance of the SettingsGenerator class
+ * @param apiVersion the api version (used when created the package.xml)
+ */
+export declare const deploySettings: (scratchOrg: Org, orgSettings: SettingsGenerator, apiVersion: string, timeout?: Duration) => Promise<void>;
+/**
  *
- * @param scratchOrgAuthInfo - an object containing the AuthInfo of the ScratchOrg
- * @param apiVersion - the target api version
- * @param orgSettings - The ScratchOrg settings
- * @param scratchOrg - The scratchOrg Org info
- * @returns {Promise<Optional<AuthInfo>>}
+ * @param scratchOrgAuthInfo an AuthInfo class from the scratch org
+ * @returns AuthInfo
  */
-export declare const deploySettingsAndResolveUrl: (scratchOrgAuthInfo: AuthInfo, apiVersion: string, orgSettings: SettingsGenerator, scratchOrg: Org) => Promise<Optional<AuthInfo>>;
+export declare const resolveUrl: (scratchOrgAuthInfo: AuthInfo) => Promise<AuthInfo>;
+export declare const updateRevisionCounterToZero: (scratchOrg: Org) => Promise<void>;

package/lib/org/scratchOrgInfoApi.js

@@ -6,23 +6,23 @@
  * 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.deploySettingsAndResolveUrl = exports.pollForScratchOrgInfo = exports.requestScratchOrgCreation = exports.authorizeScratchOrg = void 0;
+exports.updateRevisionCounterToZero = exports.resolveUrl = exports.deploySettings = exports.pollForScratchOrgInfo = exports.requestScratchOrgCreation = exports.authorizeScratchOrg = exports.queryScratchOrgInfo = void 0;
 const kit_1 = require("@salesforce/kit");
-const ts_types_1 = require("@salesforce/ts-types");
 const ts_retry_promise_1 = require("ts-retry-promise");
 const logger_1 = require("../logger");
-const mapKeys_1 = require("../util/mapKeys");
 const messages_1 = require("../messages");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const sfdcUrl_1 = require("../util/sfdcUrl");
 const pollingClient_1 = require("../status/pollingClient");
 const myDomainResolver_1 = require("../status/myDomainResolver");
+const lifecycleEvents_1 = require("../lifecycleEvents");
+const mapKeys_1 = require("../util/mapKeys");
 const authInfo_1 = require("./authInfo");
 const org_1 = require("./org");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
-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']);
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
+const messages = new messages_1.Messages('@salesforce/core', 'scratchOrgInfoApi', new Map([["SignupFieldsMissingError", "Required fields are missing for org creation: [%s]"], ["SignupDuplicateSettingsSpecifiedError", "You cannot use 'settings' and `'orgPreferences' in your scratch definition file, please specify one or the other."], ["DeprecatedPrefFormat", "We've deprecated OrgPreferences. Update the scratch org definition file to replace OrgPreferences with their corresponding settings."], ["SourceStatusResetFailureError", "Successfully created org with ID: %s and name: %s. Unfortunately, source tracking isn\u2019t working as expected. If you run force:source:status, the results may be incorrect. Try again by creating another scratch org."], ["hubOrgIsNotDevHub", "Make sure that the org with username %s and ID %s is enabled as a Dev Hub. To enable it, open the org in your browser, navigate to the Dev Hub page in Setup, and click Enable.\nIf you still see this error after enabling the Dev Hub feature, then re-authenticate to the org."]]));
+const errorCodes = new messages_1.Messages('@salesforce/core', 'scratchOrgErrorCodes', new Map([["SignupFailedError", "The request to create a scratch org failed with error code: %s."], ["SignupFailedUnknownError", "An unknown server error occurred. Please try again. If you still see this error, contact Salesforce support for assistance. Include the information from 'sfdx force:data:record:get -s ScratchOrgInfo -i %s -u %s'."], ["SignupFailedActionError", "See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_error_codes.htm for information on error code %s."], ["SignupUnexpectedError", "The request to create a scratch org returned an unexpected status"], ["StillInProgressError", "The scratch org is not ready yet (Status = %s)."], ["action.StillInProgress", "Wait for a few minutes, and then try the command again"], ["NoScratchOrgInfoError", "No ScratchOrgInfo object found in the Dev Hub you specified. Check that the ID and the Dev Hub are correct."], ["ScratchOrgDeletedError", "That scratch org has been deleted, so you can't connect to it anymore."], ["INVALID_ID_FIELD", "Provide a valid template ID, in the format 0TTxxxxxxxxxxxx."], ["T-0002", "We couldn\u2019t find a template or snapshot with the ID or name specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["T-0003", "The template specified in the scratch org definition is unapproved. Contact Salesforce Support to request template approval."], ["T-0004", "The Trialforce Source Organization (TSO) for the template doesn\u2019t exist or has expired."], ["S-1006", "Provide a valid email address in your scratch org definition or your %s file."], ["S-2006", "Provide a valid country code in your scratch org definition or your %s file."], ["S-1017", "Specify a namespace that\u2019s used by a release org associated with your Dev Hub org."], ["S-1018", "Provide a valid My Domain value. This value can\u2019t include double hyphens, end in a hyphen, include restricted words, or be more than 40 characters long."], ["S-1019", "The My Domain value you chose is already in use."], ["S-1026", "Provide a valid namespace value. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["S-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance."], ["SH-0001", "Can\u2019t create scratch org. Contact the source org admin to add your Dev Hub org ID to Setup > Org Shape. Then try again."], ["SH-0002", "Can\u2019t create scratch org. No org shape exists for the specified sourceOrg. Create an org shape and try again."], ["SH-0003", "Can\u2019t create scratch org from org shape. The org shape version is outdated. Recreate the org shape and try again."], ["C-1007", "The username provided to the org:create command is already in use. Run 'force:org:list --clean' to remove stale org authentications or create the org with a different username."], ["C-1015", "We encountered a problem while registering your My Domain value with the DNS provider. Please try again."], ["C-1016", "We encountered a problem while attempting to configure and approve the Connected App for your org. Verify the Connected App configuration with your Salesforce admin."], ["C-1017", "Provide a valid namespace prefix. This value must begin with a letter. It can\u2019t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed."], ["C-1020", "We couldn't find a template with the ID specified in the scratch org definition. If you\u2019re sure the ID is correct, contact Salesforce Support."], ["C-1027", "The template specified in the Scratch Definition isn\u2019t supported. Specify a generic edition (such as Developer or Enterprise), or specify a template ID."], ["C-9999", "A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance"]]));
 /**
  * Returns the url to be used to authorize into the new scratch org
  *
@@ -45,7 +45,7 @@ const getOrgInstanceAuthority = function (scratchOrgInfoComplete, hubOrgLoginUrl
         // For Falcon sandboxes, try the LoginURL instead; createdOrgInstance will not yield a valid URL
         altUrl = scratchOrgInfoComplete.LoginUrl;
     }
-    return signupTargetLoginUrlConfig !== null && signupTargetLoginUrlConfig !== void 0 ? signupTargetLoginUrlConfig : altUrl;
+    return signupTargetLoginUrlConfig ?? altUrl;
 };
 /**
  * Returns OAuth2Options object
@@ -62,8 +62,8 @@ const buildOAuth2Options = async (options) => {
     logger.debug(`isJwtFlow: ${isJwtFlow}`);
     if (isJwtFlow && !process.env.SFDX_CLIENT_SECRET) {
         oauth2Options.privateKeyFile = options.hubOrg.getConnection().getAuthInfoFields().privateKey;
-        const retries = (options === null || options === void 0 ? void 0 : options.retry) || kit_1.env.getNumber('SFDX_JWT_AUTH_RETRY_ATTEMPTS') || 0;
-        const timeoutInSeconds = kit_1.env.getNumber('SFDX_JWT_AUTH_RETRY_TIMEOUT') || 300;
+        const retries = options?.retry ?? kit_1.env.getNumber('SFDX_JWT_AUTH_RETRY_ATTEMPTS') ?? 0;
+        const timeoutInSeconds = kit_1.env.getNumber('SFDX_JWT_AUTH_RETRY_TIMEOUT') ?? 300;
         const timeout = kit_1.Duration.seconds(timeoutInSeconds).milliseconds;
         const delay = retries ? timeout / retries : 1000;
         return {
@@ -130,6 +130,14 @@ const getAuthInfo = async (options) => {
         });
     }
 };
+/**
+ *
+ * @param hubOrg Org
+ * @param id Record ID for the ScratchOrgInfoObject
+ * @returns Promise<ScratchOrgInfo>
+ */
+const queryScratchOrgInfo = async (hubOrg, id) => (await hubOrg.getConnection().sobject('ScratchOrgInfo').retrieve(id));
+exports.queryScratchOrgInfo = queryScratchOrgInfo;
 /**
  * after we successfully signup an org we need to trade the auth token for access and refresh token.
  *
@@ -142,8 +150,8 @@ const getAuthInfo = async (options) => {
  * @returns {Promise<AuthInfo>}
  */
 const authorizeScratchOrg = async (options) => {
-    var _a;
-    const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry: maxRetries } = options;
+    const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry } = 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
@@ -154,7 +162,7 @@ const authorizeScratchOrg = async (options) => {
         hubOrg,
         clientSecret,
         scratchOrgInfoComplete,
-        retry: maxRetries,
+        retry,
         signupTargetLoginUrlConfig,
     });
     const authInfo = await getAuthInfo({
@@ -167,7 +175,7 @@ const authorizeScratchOrg = async (options) => {
     });
     await authInfo.save({
         devHubUsername: hubOrg.getUsername(),
-        created: new Date((_a = scratchOrgInfoComplete.CreatedDate) !== null && _a !== void 0 ? _a : new Date()).valueOf().toString(),
+        created: new Date(scratchOrgInfoComplete.CreatedDate ?? new Date()).valueOf().toString(),
         expirationDate: scratchOrgInfoComplete.ExpirationDate,
         clientId: scratchOrgInfoComplete.ConnectedAppConsumerKey,
         createdOrgInstance: scratchOrgInfoComplete.SignupInstance,
@@ -182,19 +190,19 @@ const checkOrgDoesntExist = async (scratchOrgInfo) => {
     if (!usernameKey) {
         return;
     }
-    const username = (0, ts_types_1.getString)(scratchOrgInfo, usernameKey);
+    const username = scratchOrgInfo[usernameKey];
     if (username && username.length > 0) {
         try {
             await authInfo_1.AuthInfo.create({ username: username.toLowerCase() });
         }
         catch (error) {
-            const sfdxError = sfdxError_1.SfdxError.wrap(error);
+            const sfError = sfError_1.SfError.wrap(error);
             // if an AuthInfo couldn't be created that means no AuthFile exists.
-            if (sfdxError.name === 'NamedOrgNotFound') {
+            if (sfError.name === 'NamedOrgNotFoundError') {
                 return;
             }
             // Something unexpected
-            throw sfdxError;
+            throw sfError;
         }
         // An org file already exists
         throw errorCodes.createError('C-1007');
@@ -209,6 +217,9 @@ const checkOrgDoesntExist = async (scratchOrgInfo) => {
  * @returns {Promise<SaveResult>}
  */
 const requestScratchOrgCreation = async (hubOrg, scratchOrgRequest, settings) => {
+    if (!hubOrg.isDevHubOrg()) {
+        throw messages.createError('hubOrgIsNotDevHub', [hubOrg.getUsername(), hubOrg.getOrgId()]);
+    }
     // If these were present, they were already used to initialize the scratchOrgSettingsGenerator.
     // They shouldn't be submitted as part of the scratchOrgInfo.
     delete scratchOrgRequest.settings;
@@ -216,24 +227,29 @@ const requestScratchOrgCreation = async (hubOrg, scratchOrgRequest, settings) =>
     // We do not allow you to specify the old and the new way of doing post create settings
     if (scratchOrgRequest.orgPreferences && settings.hasSettings()) {
         // This is not allowed
-        throw new sfdxError_1.SfdxError('SignupDuplicateSettingsSpecifiedError');
+        throw new sfError_1.SfError('SignupDuplicateSettingsSpecifiedError');
     }
     // deprecated old style orgPreferences
     if (scratchOrgRequest.orgPreferences) {
-        throw new sfdxError_1.SfdxError(messages.getMessage('DeprecatedPrefFormat'));
+        throw new sfError_1.SfError(messages.getMessage('DeprecatedPrefFormat'));
     }
     const scratchOrgInfo = (0, mapKeys_1.default)(scratchOrgRequest, kit_1.upperFirst, true);
+    if (typeof scratchOrgInfo.Username === 'string') {
+        scratchOrgInfo.Username = scratchOrgInfo.Username.toLowerCase();
+    }
     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) {
         // this is a jsforce error which contains the property "fields" which regular error don't
         const jsForceError = error;
         if (jsForceError.errorCode === 'REQUIRED_FIELD_MISSING') {
-            throw new sfdxError_1.SfdxError(messages.getMessage('SignupFieldsMissingError', [jsForceError.fields.toString()]));
+            throw new sfError_1.SfError(messages.getMessage('SignupFieldsMissingError', [jsForceError.fields.toString()]));
         }
-        throw sfdxError_1.SfdxError.wrap(jsForceError);
+        throw sfError_1.SfError.wrap(jsForceError);
     }
 };
 exports.requestScratchOrgCreation = requestScratchOrgCreation;
@@ -253,7 +269,7 @@ timeout = kit_1.Duration.minutes(15)) => {
     const pollingOptions = {
         async poll() {
             try {
-                const resultInProgress = await hubOrg.getConnection().sobject('ScratchOrgInfo').retrieve(scratchOrgInfoId);
+                const resultInProgress = await (0, exports.queryScratchOrgInfo)(hubOrg, scratchOrgInfoId);
                 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') {
@@ -262,6 +278,7 @@ timeout = kit_1.Duration.minutes(15)) => {
                         payload: resultInProgress,
                     };
                 }
+                await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'wait for org', scratchOrgInfo: resultInProgress });
                 logger.debug(`Scratch org status is ${resultInProgress.Status}`);
                 return {
                     completed: false,
@@ -283,68 +300,117 @@ timeout = kit_1.Duration.minutes(15)) => {
     const client = await pollingClient_1.PollingClient.create(pollingOptions);
     try {
         const resultInProgress = await client.subscribe();
-        return (0, scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors)(resultInProgress, hubOrg.getUsername(), logger);
+        return await (0, scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors)(resultInProgress, hubOrg.getUsername());
     }
     catch (error) {
-        const err = error;
-        if (err.message) {
-            throw sfdxError_1.SfdxError.wrap(err);
+        if (error instanceof Error) {
+            const sfError = sfError_1.SfError.wrap(error);
+            sfError.setData({
+                username: hubOrg.getUsername(),
+                orgId: hubOrg.getOrgId(),
+                scratchOrgInfoId,
+            });
+            throw sfError;
         }
-        throw new sfdxError_1.SfdxError(`The scratch org did not complete within ${timeout.minutes} minutes`, 'orgCreationTimeout', [
+        throw new sfError_1.SfError(`The scratch org did not complete within ${timeout.minutes} minutes`, 'orgCreationTimeout', [
             'Try your force:org:create command again with a longer --wait value',
         ]);
     }
 };
 exports.pollForScratchOrgInfo = pollForScratchOrgInfo;
 /**
- * This authenticates into the newly created org and sets org preferences
+ * Deploy settings to the newly created scratch org
  *
- * @param scratchOrgAuthInfo - an object containing the AuthInfo of the ScratchOrg
- * @param apiVersion - the target api version
- * @param orgSettings - The ScratchOrg settings
- * @param scratchOrg - The scratchOrg Org info
- * @returns {Promise<Optional<AuthInfo>>}
+ * @param scratchOrg an instance of the Org class
+ * @param orgSettings an instance of the SettingsGenerator class
+ * @param apiVersion the api version (used when created the package.xml)
  */
-const deploySettingsAndResolveUrl = async (scratchOrgAuthInfo, apiVersion, orgSettings, scratchOrg) => {
-    const logger = await logger_1.Logger.child('scratchOrgInfoApi-deploySettingsAndResolveUrl');
+const deploySettings = async (scratchOrg, orgSettings, apiVersion, timeout = kit_1.Duration.minutes(10)) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-deploySettings');
     if (orgSettings.hasSettings()) {
         // deploy the settings to the newly created scratch org
         logger.debug(`deploying scratch org settings with apiVersion ${apiVersion}`);
         try {
             await orgSettings.createDeploy();
-            await orgSettings.deploySettingsViaFolder(scratchOrg, apiVersion);
+            await orgSettings.deploySettingsViaFolder(scratchOrg, apiVersion, timeout);
+            // 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 (0, exports.updateRevisionCounterToZero)(scratchOrg);
+            logger.trace('Settings deployed to org');
         }
         catch (error) {
-            throw sfdxError_1.SfdxError.wrap(error);
+            throw sfError_1.SfError.wrap(error);
         }
     }
+};
+exports.deploySettings = deploySettings;
+/**
+ *
+ * @param scratchOrgAuthInfo an AuthInfo class from the scratch org
+ * @returns AuthInfo
+ */
+const resolveUrl = async (scratchOrgAuthInfo) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-resolveUrl');
     const { instanceUrl } = scratchOrgAuthInfo.getFields();
-    if (instanceUrl) {
-        logger.debug(`processScratchOrgInfoResult - resultData.instanceUrl: ${instanceUrl}`);
-        const options = {
-            timeout: kit_1.Duration.minutes(3),
-            frequency: kit_1.Duration.seconds(10),
-            url: new sfdcUrl_1.SfdcUrl(instanceUrl),
-        };
-        try {
-            const resolver = await myDomainResolver_1.MyDomainResolver.create(options);
-            await resolver.resolve();
-        }
-        catch (error) {
-            const sfdxError = sfdxError_1.SfdxError.wrap(error);
-            logger.debug('processScratchOrgInfoResult - err: %s', error);
-            if (sfdxError.name === 'MyDomainResolverTimeoutError') {
-                sfdxError.setData({
-                    orgId: scratchOrgAuthInfo.getFields().orgId,
-                    username: scratchOrgAuthInfo.getFields().username,
-                    instanceUrl,
-                });
-                logger.debug('processScratchOrgInfoResult - err data: %s', sfdxError.data);
-            }
-            throw sfdxError;
-        }
+    if (!instanceUrl) {
+        const sfError = new sfError_1.SfError('Org does not have instanceUrl');
+        sfError.setData({
+            orgId: scratchOrgAuthInfo.getFields().orgId,
+            username: scratchOrgAuthInfo.getFields().username,
+            instanceUrl,
+        });
+        throw sfError;
+    }
+    logger.debug(`processScratchOrgInfoResult - resultData.instanceUrl: ${instanceUrl}`);
+    const options = {
+        timeout: kit_1.Duration.minutes(3),
+        frequency: kit_1.Duration.seconds(10),
+        url: new sfdcUrl_1.SfdcUrl(instanceUrl),
+    };
+    try {
+        const resolver = await myDomainResolver_1.MyDomainResolver.create(options);
+        await resolver.resolve();
         return scratchOrgAuthInfo;
     }
+    catch (error) {
+        const sfError = sfError_1.SfError.wrap(error);
+        logger.debug('processScratchOrgInfoResult - err: %s', error);
+        if (sfError.name === 'MyDomainResolverTimeoutError') {
+            sfError.setData({
+                orgId: scratchOrgAuthInfo.getFields().orgId,
+                username: scratchOrgAuthInfo.getFields().username,
+                instanceUrl,
+            });
+            logger.debug('processScratchOrgInfoResult - err data: %s', sfError.data);
+        }
+        throw sfError;
+    }
+};
+exports.resolveUrl = resolveUrl;
+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 {
+        // jsforce has a bug in its `update` code such that tooling#update doesn't work right
+        // https://github.com/jsforce/jsforce/blob/265eba5c734439dd7b77610c05b63bde7d4b1e83/src/connection.ts#L1082
+        // will result in `this._ensureVersion is not a function`
+        // so until that is resolved, we hit the API with singular records
+        // once that's fixed, you can use the following code for a single API call
+        // await conn.tooling
+        //   .sobject('SourceMember')
+        //   .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+        await Promise.all(queryResult.map((record) => conn.tooling.sobject('SourceMember').update({ Id: record.Id, RevisionCounter: 0 })));
+    }
+    catch (err) {
+        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [
+            scratchOrg.getOrgId(),
+            scratchOrg.getUsername(),
+            err instanceof Error ? err.message : '',
+        ]));
+    }
 };
-exports.deploySettingsAndResolveUrl = deploySettingsAndResolveUrl;
+exports.updateRevisionCounterToZero = updateRevisionCounterToZero;
 //# sourceMappingURL=scratchOrgInfoApi.js.map

package/lib/org/scratchOrgInfoGenerator.d.ts

@@ -1,7 +1,7 @@
-import { SfdxProjectJson } from '../sfdxProject';
+import { SfProjectJson } from '../sfProject';
 import { Org } from './org';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
-declare type PartialScratchOrgInfo = Pick<ScratchOrgInfo, 'ConnectedAppConsumerKey' | 'AuthCode' | 'Snapshot' | 'Status' | 'LoginUrl' | 'SignupEmail' | 'SignupUsername' | 'SignupInstance' | 'Username'>;
+import { ScratchOrgInfo } from './scratchOrgTypes';
+type PartialScratchOrgInfo = Pick<ScratchOrgInfo, 'ConnectedAppConsumerKey' | 'AuthCode' | 'Snapshot' | 'Status' | 'LoginUrl' | 'SignupEmail' | 'SignupUsername' | 'SignupInstance' | 'Username'>;
 export interface ScratchOrgInfoPayload extends PartialScratchOrgInfo {
     orgName: string;
     package2AncestorIds: string;
@@ -9,15 +9,16 @@ export interface ScratchOrgInfoPayload extends PartialScratchOrgInfo {
     connectedAppConsumerKey: string;
     namespace: string;
     connectedAppCallbackUrl: string;
+    durationDays: number;
 }
 /**
  * Generates the package2AncestorIds scratch org property
  *
  * @param scratchOrgInfo - the scratchOrgInfo passed in by the user
- * @param projectJson - sfdxProjectJson
+ * @param projectJson - sfProjectJson
  * @param hubOrg - the hub org, in case we need to do queries
  */
-export declare const getAncestorIds: (scratchOrgInfo: ScratchOrgInfoPayload, projectJson: SfdxProjectJson, hubOrg: Org) => Promise<string>;
+export declare const getAncestorIds: (scratchOrgInfo: ScratchOrgInfoPayload, projectJson: SfProjectJson, hubOrg: Org) => Promise<string>;
 /**
  * Takes in a scratchOrgInfo and fills in the missing fields
  *