@salesforce/core 2.33.0 → 2.34.3

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 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.
 
+### [2.34.3](https://github.com/forcedotcom/sfdx-core/compare/v2.34.2...v2.34.3) (2022-01-25)
+
+### Bug Fixes
+
+- refresh auth on a connection, too ([ff32a70](https://github.com/forcedotcom/sfdx-core/commit/ff32a705d87d6e410d06597eefa407b54eeb215d))
+
+### [2.34.2](https://github.com/forcedotcom/sfdx-core/compare/v2.33.2...v2.34.2) (2022-01-25)
+
+### [2.33.2](https://github.com/forcedotcom/sfdx-core/compare/v2.33.1...v2.33.2) (2022-01-25)
+
+### Bug Fixes
+
+- cant use require on json as module use readFileSync instead ([3085029](https://github.com/forcedotcom/sfdx-core/commit/3085029e70d7f88e2535bf0b80240855f13abf37))
+- correct import declaration ([4c69d2d](https://github.com/forcedotcom/sfdx-core/commit/4c69d2dc3370c5f920becfe260ccb178279e4d92))
+- exit deploy loop with error on status SucceededPartial ([492e891](https://github.com/forcedotcom/sfdx-core/commit/492e89184e4c865cc7fcf7df41b9c6af6a6f2237))
+- remove unwanted dep ([12ccc3a](https://github.com/forcedotcom/sfdx-core/commit/12ccc3adc0efbe687059187ab4d849b1741c823d))
+- save auth info ([226bbd2](https://github.com/forcedotcom/sfdx-core/commit/226bbd2dc09a7a8df5887c0ae7548c83ae19b748))
+- use correct dir structure ([e947fec](https://github.com/forcedotcom/sfdx-core/commit/e947fecf33a1c19ff80b33f7515e39d4e524f77f))
+
+### [2.33.1](https://github.com/forcedotcom/sfdx-core/compare/v2.33.0...v2.33.1) (2021-12-15)
+
+### Bug Fixes
+
+- faye doesn't use custom stuff passed it ([b1cefc7](https://github.com/forcedotcom/sfdx-core/commit/b1cefc76afde7f0dd56ed72b5539a47c118eef63))
+
 ## [2.33.0](https://github.com/forcedotcom/sfdx-core/compare/v2.32.0...v2.33.0) (2021-12-14)
 
 ### Features

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021, Salesforce.com, Inc.
+Copyright (c) 2022, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/connection.d.ts

@@ -173,6 +173,11 @@ export declare class Connection extends JSForceConnection {
      * @param options The query options.
      */
     singleRecordQuery<T>(soql: string, options?: SingleRecordQueryOptions): Promise<T>;
+    /**
+     * Executes a get request on the baseUrl to force an auth refresh
+     * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
+     */
+    refreshAuth(): Promise<void>;
     private loadInstanceApiVersion;
 }
 export declare const SingleRecordQueryErrors: {

package/lib/connection.js

@@ -127,6 +127,8 @@ class Connection extends jsforce_1.Connection {
         delete options.rest;
         if (rest) {
             this.logger.debug('deploy with REST');
+            // do a quick auth refresh because the raw transport used doesn't handle expired AccessTokens
+            await this.refreshAuth();
             const headers = {
                 Authorization: this && `OAuth ${this.accessToken}`,
                 clientId: this.oauth2 && this.oauth2.clientId,
@@ -182,6 +184,7 @@ class Connection extends jsforce_1.Connection {
      * @param request HTTP request object or URL to GET request.
      */
     async requestRaw(request) {
+        await this.refreshAuth();
         const headers = this.accessToken ? { Authorization: `Bearer ${this.accessToken}` } : {};
         kit_1.merge(headers, exports.SFDX_HTTP_HEADERS, request.headers);
         return this._transport.httpRequest({
@@ -389,6 +392,18 @@ class Connection extends jsforce_1.Connection {
         }
         return result.records[0];
     }
+    /**
+     * Executes a get request on the baseUrl to force an auth refresh
+     * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
+     */
+    async refreshAuth() {
+        this.logger.debug('Refreshing auth for org.');
+        const requestInfo = {
+            url: this.baseUrl(),
+            method: 'GET',
+        };
+        await this.request(requestInfo);
+    }
     async loadInstanceApiVersion() {
         const authFileFields = this.options.authInfo.getFields();
         const lastCheckedDateString = authFileFields.instanceApiVersionLastRetrieved;

package/lib/exported.d.ts

@@ -18,7 +18,7 @@ export { SfdcUrl } from './util/sfdcUrl';
 export { getJwtAudienceUrl } from './util/getJwtAudienceUrl';
 export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptions, LoggerStream, Logger, } from './logger';
 export { Messages } from './messages';
-export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, } from './org';
+export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
 export { PackageDir, NamedPackageDir, PackageDirDependency, SfdxProject, SfdxProjectJson } from './sfdxProject';
 export { SchemaPrinter } from './schema/printer';
 export { SchemaValidator } from './schema/validator';
@@ -29,5 +29,7 @@ export { CometClient, CometSubscription, StreamingClient } from './status/stream
 export { MyDomainResolver } from './status/myDomainResolver';
 export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './user';
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './permissionSetAssignment';
+export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './scratchOrgCreate';
+export { ScratchOrgInfo } from './scratchOrgInfoApi';
 export * from './util/fs';
 export * from './util/sfdc';

package/lib/exported.js

@@ -16,7 +16,7 @@ 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.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxErrorConfig = exports.SfdxError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = 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.OAuth2WithVerifier = exports.AuthInfo = exports.ConfigAggregator = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.BaseConfigStore = exports.ConfigGroup = exports.ConfigFile = exports.AuthInfoConfig = exports.AliasGroup = exports.Aliases = void 0;
+exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxErrorConfig = exports.SfdxError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = 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.OAuth2WithVerifier = exports.AuthInfo = exports.ConfigAggregator = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.BaseConfigStore = exports.ConfigGroup = exports.ConfigFile = exports.AuthInfoConfig = exports.AliasGroup = exports.Aliases = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var aliases_1 = require("./config/aliases");
@@ -89,6 +89,8 @@ Object.defineProperty(exports, "REQUIRED_FIELDS", { enumerable: true, get: funct
 Object.defineProperty(exports, "User", { enumerable: true, get: function () { return user_1.User; } });
 var permissionSetAssignment_1 = require("./permissionSetAssignment");
 Object.defineProperty(exports, "PermissionSetAssignment", { enumerable: true, get: function () { return permissionSetAssignment_1.PermissionSetAssignment; } });
+var scratchOrgCreate_1 = require("./scratchOrgCreate");
+Object.defineProperty(exports, "scratchOrgCreate", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgCreate; } });
 // Utility sub-modules
 __exportStar(require("./util/fs"), exports);
 __exportStar(require("./util/sfdc"), exports);

package/lib/org.d.ts

@@ -1,5 +1,6 @@
 import { AsyncCreatable, Duration } from '@salesforce/kit';
 import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
+import { ScratchOrgCreateOptions, ScratchOrgCreateResult } from './scratchOrgCreate';
 import { AuthFields, AuthInfo } from './authInfo';
 import { ConfigAggregator } from './config/configAggregator';
 import { OrgUsersConfig } from './config/orgUsersConfig';
@@ -56,6 +57,7 @@ export declare type SandboxRequest = {
     SourceId?: string;
     Description?: string;
 };
+export declare type ScratchOrgRequest = Pick<ScratchOrgCreateOptions, 'connectedAppConsumerKey' | 'durationDays' | 'nonamespace' | 'noancestors' | 'wait' | 'retry' | 'apiversion' | 'definitionjson' | 'definitionfile' | 'orgConfig' | 'clientSecret'>;
 /**
  * Provides a way to manage a locally authenticated Org.
  *
@@ -103,6 +105,14 @@ export declare class Org extends AsyncCreatable<Org.Options> {
         wait?: Duration;
         interval?: Duration;
     }): Promise<SandboxProcessObject>;
+    /**
+     * Creates a scratchOrg
+     * 'this' needs to be a valid dev-hub
+     *
+     * @param {options} ScratchOrgCreateOptions
+     * @returns {ScratchOrgCreateResult}
+     */
+    scratchOrgCreate(options: ScratchOrgRequest): Promise<ScratchOrgCreateResult>;
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *

package/lib/org.js

@@ -10,6 +10,7 @@ exports.Org = exports.SandboxEvents = exports.OrgTypes = void 0;
 const path_1 = require("path");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
+const scratchOrgCreate_1 = require("./scratchOrgCreate");
 const authInfo_1 = require("./authInfo");
 const aliases_1 = require("./config/aliases");
 const authInfoConfig_1 = require("./config/authInfoConfig");
@@ -99,6 +100,16 @@ class Org extends kit_1.AsyncCreatable {
             pollInterval,
         });
     }
+    /**
+     * Creates a scratchOrg
+     * 'this' needs to be a valid dev-hub
+     *
+     * @param {options} ScratchOrgCreateOptions
+     * @returns {ScratchOrgCreateResult}
+     */
+    async scratchOrgCreate(options) {
+        return scratchOrgCreate_1.scratchOrgCreate({ ...options, hubOrg: this });
+    }
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -295,13 +306,8 @@ class Org extends kit_1.AsyncCreatable {
      * Refreshes the auth for this org's instance by calling HTTP GET on the baseUrl of the connection object.
      */
     async refreshAuth() {
-        this.logger.debug('Refreshing auth for org.');
-        const requestInfo = {
-            url: this.getConnection().baseUrl(),
-            method: 'GET',
-        };
         const conn = this.getConnection();
-        await conn.request(requestInfo);
+        await conn.refreshAuth();
     }
     /**
      * Reads and returns the content of all user auth files for this org as an array.

package/lib/scratchOrgCreate.d.ts

@@ -0,0 +1,43 @@
+import { Duration } from '@salesforce/kit';
+import { Org } from './org';
+import { AuthInfo, AuthFields } from './authInfo';
+import { ScratchOrgInfo } from './scratchOrgInfoApi';
+export declare const DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
+export interface ScratchOrgCreateResult {
+    username?: string;
+    scratchOrgInfo?: ScratchOrgInfo;
+    authInfo?: AuthInfo;
+    authFields?: AuthFields;
+    warnings: string[];
+}
+/**
+ * interface ScratchOrgCreateOptions
+ *
+ * @param hubOrg the environment hub org
+ * @param connectedAppConsumerKey The connected app consumer key.
+ * @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 wait the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6, min:2)
+ * @param retry number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10)
+ * @param apiversion target server instance API version
+ * @param definitionjson org definition in JSON format
+ * @param definitionfile path to an org definition file
+ * @param orgConfig overrides definitionjson
+ * @param clientSecret OAuth client secret of personal connected app
+ */
+export interface ScratchOrgCreateOptions {
+    hubOrg: Org;
+    connectedAppConsumerKey?: string;
+    durationDays?: number;
+    nonamespace?: boolean;
+    noancestors?: boolean;
+    wait?: Duration;
+    retry?: number;
+    apiversion?: string;
+    definitionjson?: string;
+    definitionfile?: string;
+    orgConfig?: Record<string, unknown>;
+    clientSecret?: string;
+}
+export declare const scratchOrgCreate: (options: ScratchOrgCreateOptions) => Promise<ScratchOrgCreateResult>;

package/lib/scratchOrgCreate.js

@@ -0,0 +1,135 @@
+"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 });
+exports.scratchOrgCreate = exports.DEFAULT_STREAM_TIMEOUT_MINUTES = void 0;
+// third
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+// Local
+const org_1 = require("./org");
+const logger_1 = require("./logger");
+const messages_1 = require("./messages");
+const sfdxError_1 = require("./sfdxError");
+const connection_1 = require("./connection");
+const sfdxProject_1 = require("./sfdxProject");
+const configAggregator_1 = require("./config/configAggregator");
+const scratchOrgInfoApi_1 = require("./scratchOrgInfoApi");
+const scratchOrgSettingsGenerator_1 = require("./scratchOrgSettingsGenerator");
+const scratchOrgInfoGenerator_1 = require("./scratchOrgInfoGenerator");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgCreate');
+exports.DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
+const validateDuration = (durationDays) => {
+    const min = 1;
+    const max = 30;
+    if (Number.isInteger(durationDays)) {
+        if (durationDays < min) {
+            throw new sfdxError_1.SfdxError(`Expected 'durationDays' greater than or equal to ${min} but received ${durationDays}`, 'BoundsError');
+        }
+        if (durationDays > max) {
+            throw new sfdxError_1.SfdxError(`Expected 'durationDays' less than or equal to ${max} but received ${durationDays}`, 'BoundsError');
+        }
+        return;
+    }
+    throw new sfdxError_1.SfdxError("Expected 'durationDays' to be an integer number", 'TypeError');
+};
+const validateRetry = (retry) => {
+    if (Number.isInteger(retry)) {
+        return;
+    }
+    throw new sfdxError_1.SfdxError("Expected 'retry' to be an integer number", 'TypeError');
+};
+const validateWait = (wait) => {
+    const min = 2;
+    if (wait.minutes < min) {
+        throw new sfdxError_1.SfdxError(`Expected 'wait' greater than or equal to ${min} but received ${wait}`, 'BoundsError');
+    }
+};
+const scratchOrgCreate = async (options) => {
+    var _a;
+    const logger = await logger_1.Logger.child('scratchOrgCreate');
+    logger.debug('scratchOrgCreate');
+    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);
+    validateWait(wait);
+    const { scratchOrgInfoPayload, ignoreAncestorIds, warnings } = await scratchOrgInfoGenerator_1.getScratchOrgInfoPayload({
+        definitionjson,
+        definitionfile,
+        connectedAppConsumerKey,
+        durationDays,
+        nonamespace,
+        noancestors,
+        orgConfig,
+    });
+    const scratchOrgInfo = await scratchOrgInfoGenerator_1.generateScratchOrgInfo({
+        hubOrg,
+        scratchOrgInfoPayload,
+        nonamespace,
+        ignoreAncestorIds,
+    });
+    // gets the scratch org settings (will use in both signup paths AND to deploy the settings)
+    const settingsGenerator = new scratchOrgSettingsGenerator_1.default();
+    await settingsGenerator.extract(scratchOrgInfo);
+    logger.debug(`the scratch org def file has settings: ${settingsGenerator.hasSettings()}`);
+    // creates the scratch org info in the devhub
+    const scratchOrgInfoRequestResult = await scratchOrgInfoApi_1.requestScratchOrgCreation(hubOrg, scratchOrgInfo, settingsGenerator);
+    const scratchOrgInfoId = ts_types_1.ensureString(ts_types_1.getString(scratchOrgInfoRequestResult, 'id'));
+    logger.debug(`scratch org has recordId ${scratchOrgInfoId}`);
+    const scratchOrgInfoResult = await scratchOrgInfoApi_1.pollForScratchOrgInfo(hubOrg, scratchOrgInfoId, wait);
+    const signupTargetLoginUrlConfig = await getSignupTargetLoginUrl();
+    const scratchOrgAuthInfo = await scratchOrgInfoApi_1.authorizeScratchOrg({
+        scratchOrgInfoComplete: scratchOrgInfoResult,
+        hubOrg,
+        clientSecret,
+        signupTargetLoginUrlConfig,
+        retry: retry || 0,
+    });
+    // we'll need this scratch org connection later;
+    const connection = await connection_1.Connection.create({ authInfo: scratchOrgAuthInfo });
+    const scratchOrg = await org_1.Org.create({ connection }); // scartchOrg should come from command
+    const username = scratchOrg.getUsername();
+    logger.debug(`scratch org username ${username}`);
+    const configAggregator = new configAggregator_1.ConfigAggregator();
+    const authInfo = await 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);
+    return {
+        username,
+        scratchOrgInfo: scratchOrgInfoResult,
+        authInfo,
+        authFields: authInfo === null || authInfo === void 0 ? void 0 : authInfo.getFields(),
+        warnings,
+    };
+};
+exports.scratchOrgCreate = scratchOrgCreate;
+const getSignupTargetLoginUrl = async () => {
+    try {
+        const project = await sfdxProject_1.SfdxProject.resolve();
+        const projectJson = await project.resolveProjectConfig();
+        return projectJson.signupTargetLoginUrl;
+    }
+    catch {
+        // a project isn't required for org:create
+    }
+};
+const updateRevisionCounterToZero = async (scratchOrg) => {
+    const conn = scratchOrg.getConnection();
+    const queryResult = await conn.tooling.sobject('SourceMember').find({ RevisionCounter: { $gt: 0 } }, ['Id']);
+    try {
+        await conn.tooling
+            .sobject('SourceMember')
+            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+    }
+    catch (err) {
+        const message = messages.getMessage('SourceStatusResetFailure', [scratchOrg.getOrgId(), scratchOrg.getUsername()]);
+        throw new sfdxError_1.SfdxError(message, 'SourceStatusResetFailure');
+    }
+};
+//# sourceMappingURL=scratchOrgCreate.js.map

package/lib/scratchOrgErrorCodes.d.ts

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

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