@salesforce/core 2.32.0 → 2.34.2

package/lib/scratchOrgErrorCodes.js

@@ -0,0 +1,53 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkScratchOrgInfoForErrors = void 0;
+const messages_1 = require("./messages");
+const sfdxError_1 = require("./sfdxError");
+const WORKSPACE_CONFIG_FILENAME = 'sfdx-project.json';
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgErrorCodes');
+// 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) => {
+    try {
+        // only apply args if message requires them
+        let message = messages.getMessage(errorCode);
+        if (message.includes('%s')) {
+            message = messages.getMessage(errorCode, args);
+        }
+        return message;
+    }
+    catch {
+        // generic error message
+        return undefined;
+    }
+};
+const checkScratchOrgInfoForErrors = (orgInfo, hubUsername, logger) => {
+    if (orgInfo.Status === 'Active') {
+        return orgInfo;
+    }
+    if (orgInfo.Status === 'Error' && orgInfo.ErrorCode) {
+        const message = optionalErrorCodeMessage(orgInfo.ErrorCode, [WORKSPACE_CONFIG_FILENAME]);
+        if (message) {
+            throw new sfdxError_1.SfdxError(message, 'RemoteOrgSignupFailed', [
+                messages.getMessage('signupFailedAction', [orgInfo.ErrorCode]),
+            ]);
+        }
+        throw new sfdxError_1.SfdxError(messages.getMessage('signupFailed', [orgInfo.ErrorCode]));
+    }
+    if (orgInfo.Status === 'Error') {
+        // 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(messages.getMessage('signupFailedUnknown', [orgInfo.Id, hubUsername]), 'signupFailedUnknown');
+    }
+    throw new sfdxError_1.SfdxError(messages.getMessage('signupUnexpected'), 'UnexpectedSignupStatus');
+};
+exports.checkScratchOrgInfoForErrors = checkScratchOrgInfoForErrors;
+//# sourceMappingURL=scratchOrgErrorCodes.js.map

package/lib/scratchOrgFeatureDeprecation.d.ts

@@ -0,0 +1,26 @@
+interface FeatureTypes {
+    simpleFeatureMapping: {
+        [key: string]: string[];
+    };
+    quantifiedFeatureMapping: Record<string, string | number | boolean | null | undefined>;
+    deprecatedFeatures: string[];
+}
+export declare class ScratchOrgFeatureDeprecation {
+    private featureTypes;
+    constructor(options?: FeatureTypes);
+    /**
+     * Gets list of feature warnings that should be logged
+     *
+     * @param features The requested features.
+     * @returns List of string feature warnings.
+     */
+    getFeatureWarnings(features: string | string[]): string[];
+    /**
+     * Removes all deprecated features for the organization.
+     *
+     * @param features List of features to filter
+     * @returns feature array with proper mapping.
+     */
+    filterDeprecatedFeatures(features: string[]): string[];
+}
+export {};

package/lib/scratchOrgFeatureDeprecation.js

@@ -0,0 +1,106 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScratchOrgFeatureDeprecation = void 0;
+/**
+ * Certain Org Features require a translation or should be deprecated.
+ * Encapsulates feature mappings and deprecated features.
+ */
+const ts_types_1 = require("@salesforce/ts-types");
+// Local
+const messages_1 = require("./messages");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgFeatureDeprecation');
+const FEATURE_TYPES = {
+    // simpleFeatureMapping holds a set of direct replacement values for features.
+    simpleFeatureMapping: {
+        SALESWAVE: ['DEVELOPMENTWAVE'],
+        SERVICEWAVE: ['DEVELOPMENTWAVE'],
+    },
+    quantifiedFeatureMapping: {},
+    deprecatedFeatures: [
+        'EXPANDEDSOURCETRACKING',
+        'LISTCUSTOMSETTINGCREATION',
+        'AppNavCapabilities',
+        'EditInSubtab',
+        'OldNewRecordFlowConsole',
+        'OldNewRecordFlowStd',
+        'DesktopLayoutStandardOff',
+        'SplitViewOnStandardOff',
+        'PopOutUtilities',
+    ],
+};
+class ScratchOrgFeatureDeprecation {
+    // Allow override for testing.
+    constructor(options = FEATURE_TYPES) {
+        this.featureTypes = options;
+        this.featureTypes.deprecatedFeatures = this.featureTypes.deprecatedFeatures.map((deprecatedFeature) => deprecatedFeature.toUpperCase());
+        // Make all of the keys in simpleFeatureMapping upper case.
+        const sfm = {};
+        Object.keys(this.featureTypes.simpleFeatureMapping).forEach((key) => {
+            sfm[key.toUpperCase()] = this.featureTypes.simpleFeatureMapping[key];
+        });
+        this.featureTypes.simpleFeatureMapping = sfm;
+    }
+    /**
+     * Gets list of feature warnings that should be logged
+     *
+     * @param features The requested features.
+     * @returns List of string feature warnings.
+     */
+    getFeatureWarnings(features) {
+        /* Get warning messages for deprecated features and feature mappings.*/
+        const featureWarningMessages = [];
+        const requestedFeatures = (ts_types_1.isString(features) ? features : features.join(';')).toUpperCase();
+        /* If a public quantified feature is defined without a quantity, throw a warning.*/
+        Object.keys(this.featureTypes.quantifiedFeatureMapping).forEach((key) => {
+            if (new RegExp(`${key};|${key},|${key}$`, 'i').test(requestedFeatures)) {
+                featureWarningMessages.push(messages.getMessage('quantifiedFeatureWithoutQuantityWarning', [
+                    key,
+                    this.featureTypes.quantifiedFeatureMapping[key],
+                ]));
+            }
+        });
+        /* If a simply mapped feature is defined, log a warning.*/
+        Object.keys(this.featureTypes.simpleFeatureMapping).forEach((key) => {
+            if (new RegExp(`${key};|${key},|${key}$`, 'i').test(requestedFeatures)) {
+                const tokens = '[' + this.featureTypes.simpleFeatureMapping[key].map((v) => "'" + v + "'").join(',') + ']';
+                featureWarningMessages.push(messages.getMessage('mappedFeatureWarning', [key, tokens]));
+            }
+        });
+        /* If a deprecated feature is identified as deprecated, throw a warning.*/
+        this.featureTypes.deprecatedFeatures.forEach((deprecatedFeature) => {
+            if (requestedFeatures.includes(deprecatedFeature)) {
+                featureWarningMessages.push(messages.getMessage('deprecatedFeatureWarning', [deprecatedFeature]));
+            }
+        });
+        return featureWarningMessages;
+    }
+    /**
+     * Removes all deprecated features for the organization.
+     *
+     * @param features List of features to filter
+     * @returns feature array with proper mapping.
+     */
+    filterDeprecatedFeatures(features) {
+        return features.reduce((previousValue, currentValue) => {
+            const feature = currentValue.toUpperCase();
+            if (this.featureTypes.deprecatedFeatures.includes(feature)) {
+                return previousValue;
+            }
+            else if (this.featureTypes.simpleFeatureMapping[feature]) {
+                /* If a simply mapped feature is specified, then perform the mapping. */
+                const simpleFeatureMapping = this.featureTypes.simpleFeatureMapping[feature];
+                return [...previousValue, ...simpleFeatureMapping];
+            }
+            return [...previousValue, currentValue];
+        }, []);
+    }
+}
+exports.ScratchOrgFeatureDeprecation = ScratchOrgFeatureDeprecation;
+//# sourceMappingURL=scratchOrgFeatureDeprecation.js.map

package/lib/scratchOrgInfoApi.d.ts

@@ -0,0 +1,94 @@
+import { Optional } from '@salesforce/ts-types';
+import { Duration } from '@salesforce/kit';
+import { RecordResult } from 'jsforce';
+import { retry } from 'ts-retry-promise';
+import { Org } from './org';
+import { AuthInfo } from './authInfo';
+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[];
+    };
+}
+export interface JsForceError extends Error {
+    errorCode: string;
+    fields: string[];
+}
+/**
+ * after we successfully signup an org we need to trade the auth token for access and refresh token.
+ *
+ * @param scratchOrgInfoComplete - The completed ScratchOrgInfo which should contain an access token.
+ * @param hubOrg - the environment hub org
+ * @param clientSecret - The OAuth client secret. May be null for JWT OAuth flow.
+ * @param signupTargetLoginUrlConfig - Login url
+ * @param retry - auth retry attempts
+ * @returns {Promise<AuthInfo>}
+ */
+export declare const authorizeScratchOrg: (options: {
+    scratchOrgInfoComplete: ScratchOrgInfo;
+    hubOrg: Org;
+    clientSecret?: string;
+    signupTargetLoginUrlConfig?: string;
+    retry?: number;
+}) => Promise<AuthInfo>;
+/**
+ * This extracts orgPrefs/settings from the user input and performs a basic scratchOrgInfo request.
+ *
+ * @param hubOrg - the environment hub org
+ * @param scratchOrgRequest - An object containing the fields of the ScratchOrgInfo
+ * @param settings - An object containing org settings
+ * @returns {Promise<RecordResult>}
+ */
+export declare const requestScratchOrgCreation: (hubOrg: Org, scratchOrgRequest: ScratchOrgInfo, settings: SettingsGenerator) => Promise<RecordResult>;
+/**
+ * This retrieves the ScratchOrgInfo, polling until the status is Active or Error
+ *
+ * @param hubOrg
+ * @param scratchOrgInfoId - the id of the scratchOrgInfo that we are retrieving
+ * @param timeout - A Duration object
+ * @returns {Promise<ScratchOrgInfo>}
+ */
+export declare const pollForScratchOrgInfo: (hubOrg: Org, scratchOrgInfoId: string, timeout?: Duration) => Promise<ScratchOrgInfo>;
+/**
+ * This authenticates into the newly created org and sets org preferences
+ *
+ * @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>>}
+ */
+export declare const deploySettingsAndResolveUrl: (scratchOrgAuthInfo: AuthInfo, apiVersion: string, orgSettings: SettingsGenerator, scratchOrg: Org) => Promise<Optional<AuthInfo>>;

package/lib/scratchOrgInfoApi.js

@@ -0,0 +1,331 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deploySettingsAndResolveUrl = exports.pollForScratchOrgInfo = exports.requestScratchOrgCreation = exports.authorizeScratchOrg = 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");
+// Local
+const org_1 = require("./org");
+const logger_1 = require("./logger");
+const mapKeys_1 = require("./util/mapKeys");
+const authInfo_1 = require("./authInfo");
+const messages_1 = require("./messages");
+const sfdxError_1 = require("./sfdxError");
+const sfdcUrl_1 = require("./util/sfdcUrl");
+const myDomainResolver_1 = require("./status/myDomainResolver");
+const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgInfoApi');
+/**
+ * Returns the url to be used to authorize into the new scratch org
+ *
+ * @param scratchOrgInfoComplete The completed ScratchOrgInfo
+ * @param hubOrgLoginUrl the hun org login url
+ * @param signupTargetLoginUrlConfig the login url
+ * @returns {string}
+ */
+const getOrgInstanceAuthority = function (scratchOrgInfoComplete, hubOrgLoginUrl, signupTargetLoginUrlConfig) {
+    const createdOrgInstance = scratchOrgInfoComplete.SignupInstance;
+    if (createdOrgInstance === 'utf8') {
+        return hubOrgLoginUrl;
+    }
+    let altUrl;
+    // For non-Falcon (ie - instance names not ending in -s) sandboxes, use the instance URL
+    if (createdOrgInstance && !createdOrgInstance.toLowerCase().endsWith('s')) {
+        altUrl = `https://${createdOrgInstance}.salesforce.com`;
+    }
+    else {
+        // 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;
+};
+/**
+ * Returns OAuth2Options object
+ *
+ * @param hubOrg the environment hub org
+ * @param clientSecret The OAuth client secret. May be null for JWT OAuth flow.
+ * @param scratchOrgInfoComplete The completed ScratchOrgInfo which should contain an access token.
+ * @param retry auth retry attempts
+ * @param signupTargetLoginUrlConfig the login url
+ * @returns {OAuth2Options, number, number, number} options, retries, timeout, delay
+ */
+const buildOAuth2Options = async (options) => {
+    const logger = await logger_1.Logger.child('buildOAuth2Options');
+    const isJwtFlow = !!options.hubOrg.getConnection().getAuthInfoFields().privateKey;
+    const oauth2Options = {
+        loginUrl: getOrgInstanceAuthority(options.scratchOrgInfoComplete, options.hubOrg.getField(org_1.Org.Fields.LOGIN_URL), options.signupTargetLoginUrlConfig),
+    };
+    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 timeout = kit_1.Duration.seconds(timeoutInSeconds).milliseconds;
+        const delay = retries ? timeout / retries : 1000;
+        return {
+            options: oauth2Options,
+            retries,
+            timeout,
+            delay,
+        };
+    }
+    else {
+        // Web Server OAuth "auth code exchange" flow
+        if (process.env.SFDX_CLIENT_SECRET) {
+            oauth2Options.clientSecret = process.env.SFDX_CLIENT_SECRET;
+        }
+        else if (options.clientSecret) {
+            oauth2Options.clientSecret = options.clientSecret;
+        }
+        oauth2Options.redirectUri = options.scratchOrgInfoComplete.ConnectedAppCallbackUrl;
+        oauth2Options.authCode = options.scratchOrgInfoComplete.AuthCode;
+        return {
+            options: oauth2Options,
+            retries: 0,
+        };
+    }
+};
+/**
+ * Returns OAuth2Options object
+ *
+ * @param hubOrg the environment hub org
+ * @param username The OAuth client secret. May be null for JWT OAuth flow.
+ * @param oauth2Options The completed ScratchOrgInfo which should contain an access token.
+ * @param retries auth retry attempts
+ * @param timeout the login url
+ * @param delay the login url
+ * @returns {OAuth2Options, number, number, number} options, retries, timeout, delay
+ */
+const getAuthInfo = async (options) => {
+    const logger = await logger_1.Logger.child('getAuthInfo');
+    const retryAuthorize = ts_retry_promise_1.retryDecorator(async (opts) => authInfo_1.AuthInfo.create(opts), {
+        timeout: options.timeout,
+        delay: options.delay,
+        retries: options.retries,
+    });
+    if (options.retries) {
+        try {
+            return await retryAuthorize({
+                username: options.username,
+                parentUsername: options.hubOrg.getUsername(),
+                oauth2Options: options.oauth2Options,
+            });
+        }
+        catch (err) {
+            const error = err;
+            logger.error(error);
+            throw error.lastError || error;
+        }
+    }
+    else {
+        return authInfo_1.AuthInfo.create({
+            username: options.username,
+            parentUsername: options.hubOrg.getUsername(),
+            oauth2Options: options.oauth2Options,
+        });
+    }
+};
+/**
+ * after we successfully signup an org we need to trade the auth token for access and refresh token.
+ *
+ * @param scratchOrgInfoComplete - The completed ScratchOrgInfo which should contain an access token.
+ * @param hubOrg - the environment hub org
+ * @param clientSecret - The OAuth client secret. May be null for JWT OAuth flow.
+ * @param signupTargetLoginUrlConfig - Login url
+ * @param retry - auth retry attempts
+ * @returns {Promise<AuthInfo>}
+ */
+const authorizeScratchOrg = async (options) => {
+    var _a;
+    const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry: maxRetries } = options;
+    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
+    if (!hubOrg.isDevHubOrg()) {
+        await hubOrg.determineIfDevHubOrg(true);
+    }
+    const oAuth2Options = await buildOAuth2Options({
+        hubOrg,
+        clientSecret,
+        scratchOrgInfoComplete,
+        retry: maxRetries,
+        signupTargetLoginUrlConfig,
+    });
+    const authInfo = await getAuthInfo({
+        hubOrg,
+        username: scratchOrgInfoComplete.SignupUsername,
+        oauth2Options: oAuth2Options.options,
+        retries: oAuth2Options.retries,
+        timeout: oAuth2Options.timeout,
+        delay: oAuth2Options.delay,
+    });
+    await authInfo.save({
+        devHubUsername: hubOrg.getUsername(),
+        created: new Date((_a = scratchOrgInfoComplete.CreatedDate) !== null && _a !== void 0 ? _a : new Date()).valueOf().toString(),
+        expirationDate: scratchOrgInfoComplete.ExpirationDate,
+        clientId: scratchOrgInfoComplete.ConnectedAppConsumerKey,
+        createdOrgInstance: scratchOrgInfoComplete.SignupInstance,
+        isDevHub: false,
+        snapshot: scratchOrgInfoComplete.Snapshot,
+    });
+    return authInfo;
+};
+exports.authorizeScratchOrg = authorizeScratchOrg;
+const checkOrgDoesntExist = async (scratchOrgInfo) => {
+    const usernameKey = Object.keys(scratchOrgInfo).find((key) => key.toUpperCase() === 'USERNAME');
+    if (!usernameKey) {
+        return;
+    }
+    const username = ts_types_1.getString(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);
+            // if an AuthInfo couldn't be created that means no AuthFile exists.
+            if (sfdxError.name === 'NamedOrgNotFound') {
+                return;
+            }
+            // Something unexpected
+            throw sfdxError;
+        }
+        // An org file already exists
+        throw sfdxError_1.SfdxError.create('@salesforce/core', 'scratchOrgErrorCodes', 'C-1007');
+    }
+};
+/**
+ * This extracts orgPrefs/settings from the user input and performs a basic scratchOrgInfo request.
+ *
+ * @param hubOrg - the environment hub org
+ * @param scratchOrgRequest - An object containing the fields of the ScratchOrgInfo
+ * @param settings - An object containing org settings
+ * @returns {Promise<RecordResult>}
+ */
+const requestScratchOrgCreation = async (hubOrg, scratchOrgRequest, settings) => {
+    // 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;
+    delete scratchOrgRequest.objectSettings;
+    // 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('signupDuplicateSettingsSpecified');
+    }
+    // deprecated old style orgPreferences
+    if (scratchOrgRequest.orgPreferences) {
+        throw new sfdxError_1.SfdxError(messages.getMessage('deprecatedPrefFormat'));
+    }
+    const scratchOrgInfo = mapKeys_1.default(scratchOrgRequest, kit_1.upperFirst, true);
+    await checkOrgDoesntExist(scratchOrgInfo); // throw if it does exists.
+    try {
+        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('signupFieldsMissing', [jsForceError.fields.toString()]));
+        }
+        throw sfdxError_1.SfdxError.wrap(jsForceError);
+    }
+};
+exports.requestScratchOrgCreation = requestScratchOrgCreation;
+/**
+ * This retrieves the ScratchOrgInfo, polling until the status is Active or Error
+ *
+ * @param hubOrg
+ * @param scratchOrgInfoId - the id of the scratchOrgInfo that we are retrieving
+ * @param timeout - A Duration object
+ * @returns {Promise<ScratchOrgInfo>}
+ */
+const pollForScratchOrgInfo = async (hubOrg, scratchOrgInfoId, 
+// org:create specifies a default timeout of 6.  This longer default is for other consumers
+timeout = kit_1.Duration.minutes(15)) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-pollForScratchOrgInfo');
+    logger.debug(`PollingTimeout in minutes: ${timeout.minutes}`);
+    const response = await ts_retry_promise_1.retry(async () => {
+        const resultInProgress = await hubOrg
+            .getConnection()
+            .sobject('ScratchOrgInfo')
+            .retrieve(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') {
+            return resultInProgress;
+        }
+        // all other statuses, OR lack of status (e.g. network errors) will cause a retry
+        throw new sfdxError_1.SfdxError(`Scratch org status is ${resultInProgress.Status}`);
+    }, {
+        retries: 'INFINITELY',
+        timeout: timeout.milliseconds,
+        delay: kit_1.Duration.seconds(2).milliseconds,
+        backoff: 'LINEAR',
+        maxBackOff: kit_1.Duration.seconds(30).milliseconds,
+    }).catch(() => {
+        throw new sfdxError_1.SfdxError(`The scratch org did not complete within ${timeout.minutes} minutes`, 'orgCreationTimeout', [
+            'Try your force:org:create command again with a longer --wait value',
+        ]);
+    });
+    return scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors(response, hubOrg.getUsername(), logger);
+};
+exports.pollForScratchOrgInfo = pollForScratchOrgInfo;
+/**
+ * This authenticates into the newly created org and sets org preferences
+ *
+ * @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>>}
+ */
+const deploySettingsAndResolveUrl = async (scratchOrgAuthInfo, apiVersion, orgSettings, scratchOrg) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-deploySettingsAndResolveUrl');
+    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);
+        }
+        catch (error) {
+            throw sfdxError_1.SfdxError.wrap(error);
+        }
+    }
+    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;
+        }
+        return scratchOrgAuthInfo;
+    }
+};
+exports.deploySettingsAndResolveUrl = deploySettingsAndResolveUrl;
+//# sourceMappingURL=scratchOrgInfoApi.js.map

package/lib/scratchOrgInfoGenerator.d.ts

@@ -0,0 +1,62 @@
+import { Org } from './org';
+import { SfdxProjectJson } from './sfdxProject';
+import { ScratchOrgInfo } from './scratchOrgInfoApi';
+declare type PartialScratchOrgInfo = Pick<ScratchOrgInfo, 'ConnectedAppConsumerKey' | 'AuthCode' | 'Snapshot' | 'Status' | 'LoginUrl' | 'SignupEmail' | 'SignupUsername' | 'SignupInstance' | 'Username'>;
+export interface ScratchOrgInfoPayload extends PartialScratchOrgInfo {
+    orgName: string;
+    package2AncestorIds: string;
+    features: string | string[];
+    connectedAppConsumerKey: string;
+    namespace: string;
+    connectedAppCallbackUrl: string;
+}
+/**
+ * Generates the package2AncestorIds scratch org property
+ *
+ * @param scratchOrgInfo - the scratchOrgInfo passed in by the user
+ * @param projectJson - sfdxProjectJson
+ * @param hubOrg - the hub org, in case we need to do queries
+ */
+export declare const getAncestorIds: (scratchOrgInfo: ScratchOrgInfoPayload, projectJson: SfdxProjectJson, hubOrg: Org) => Promise<string>;
+/**
+ * Takes in a scratchOrgInfo and fills in the missing fields
+ *
+ * @param hubOrg the environment hub org
+ * @param scratchOrgInfoPayload - the scratchOrgInfo passed in by the user
+ * @param nonamespace create the scratch org with no namespace
+ * @param ignoreAncestorIds true if the sfdx-project.json ancestorId keys should be ignored
+ */
+export declare const generateScratchOrgInfo: ({ hubOrg, scratchOrgInfoPayload, nonamespace, ignoreAncestorIds, }: {
+    hubOrg: Org;
+    scratchOrgInfoPayload: ScratchOrgInfoPayload;
+    nonamespace?: boolean | undefined;
+    ignoreAncestorIds?: boolean | undefined;
+}) => Promise<ScratchOrgInfoPayload>;
+/**
+ * Returns a valid signup json
+ *
+ * @param definitionjson org definition in JSON format
+ * @param definitionfile path to an org definition file
+ * @param connectedAppConsumerKey The connected app consumer key. May be null for JWT OAuth flow.
+ * @param durationdays duration of the scratch org (in days) (default:1, min:1, max:30)
+ * @param nonamespace create the scratch org with no namespace
+ * @param noancestors do not include second-generation package ancestors in the scratch org
+ * @param orgConfig overrides definitionjson
+ * @returns scratchOrgInfoPayload: ScratchOrgInfoPayload;
+            ignoreAncestorIds: boolean;
+            warnings: string[];
+ */
+export declare const getScratchOrgInfoPayload: (options: {
+    definitionjson?: string;
+    definitionfile?: string;
+    connectedAppConsumerKey?: string;
+    durationDays: number;
+    nonamespace?: boolean;
+    noancestors?: boolean;
+    orgConfig?: Record<string, unknown>;
+}) => Promise<{
+    scratchOrgInfoPayload: ScratchOrgInfoPayload;
+    ignoreAncestorIds: boolean;
+    warnings: string[];
+}>;
+export {};