@salesforce/core 4.0.0 → 4.1.0

package/lib/org/scratchOrgInfoGenerator.js

@@ -10,19 +10,13 @@ exports.getScratchOrgInfoPayload = exports.generateScratchOrgInfo = exports.getA
 const fs_1 = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
-const sfdc_1 = require("../util/sfdc");
-const sfdxProject_1 = require("../sfdxProject");
+const sfProject_1 = require("../sfProject");
 const webOAuthServer_1 = require("../webOAuthServer");
 const messages_1 = require("../messages");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const scratchOrgFeatureDeprecation_1 = require("./scratchOrgFeatureDeprecation");
-const defaultConnectedAppInfo = {
-    clientId: 'PlatformCLI',
-    legacyClientId: 'SalesforceDevelopmentExperience',
-    legacyClientSecret: '1384510088588713504',
-};
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgInfoGenerator');
+const authInfo_1 = require("./authInfo");
+const messages = new messages_1.Messages('@salesforce/core', 'scratchOrgInfoGenerator', new Map([["Package2AncestorsIdsKeyNotSupportedError", "The package2AncestorIds key is no longer supported in a scratch org definition. Ancestors defined in sfdx-project.json will be included in the scratch org.\","], ["InvalidAncestorVersionFormatError", "The ancestor versionNumber must be in the format major.minor.patch but the value found is %s\","], ["NoMatchingAncestorError", "The ancestor for ancestorVersion %s can't be found. Package ID %s.\","], ["NoMatchingAncestorIdError", "The ancestor for ancestorId [%s] can't be found. Package ID %s.\""], ["AncestorNotReleasedError", "The ancestor package version [%s] specified in the sfdx-project.json file may exist hasn\u2019t been promoted and released. Release the ancestor package version before specifying it as the ancestor in a new package or patch version.\","], ["AncestorIdVersionMismatchError", "The ancestorVersion in sfdx-project.json is not the version expected for the ancestorId you supplied. ancestorVersion %s. ancestorID %s.\""], ["unsupportedSnapshotOrgCreateOptions", "Org snapshots don\u2019t support one or more options you specified: %s"]]));
 const SNAPSHOT_UNSUPPORTED_OPTIONS = [
     'features',
     'orgPreferences',
@@ -38,12 +32,12 @@ const SNAPSHOT_UNSUPPORTED_OPTIONS = [
 // executed within the ctor and also after parsing/normalization of the definition file.
 const optionsValidator = (key, scratchOrgInfoPayload) => {
     if (key.toLowerCase() === 'durationdays') {
-        throw new sfdxError_1.SfdxError('unrecognizedScratchOrgOption', 'durationDays');
+        throw new sfError_1.SfError('unrecognizedScratchOrgOption', 'durationDays');
     }
     if (key.toLowerCase() === 'snapshot') {
         const foundInvalidFields = SNAPSHOT_UNSUPPORTED_OPTIONS.filter((invalidField) => invalidField in scratchOrgInfoPayload);
         if (foundInvalidFields.length > 0) {
-            throw new sfdxError_1.SfdxError(messages.getMessage('unsupportedSnapshotOrgCreateOptions', [foundInvalidFields.join(', ')]), 'orgSnapshot');
+            throw new sfError_1.SfError(messages.getMessage('unsupportedSnapshotOrgCreateOptions', [foundInvalidFields.join(', ')]), 'orgSnapshot');
         }
     }
 };
@@ -51,30 +45,50 @@ const optionsValidator = (key, scratchOrgInfoPayload) => {
  * 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
  */
 const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
     if (Reflect.has(scratchOrgInfo, 'package2AncestorIds')) {
-        throw new sfdxError_1.SfdxError(messages.getMessage('Package2AncestorsIdsKeyNotSupportedError'), 'DeprecationError');
+        throw new sfError_1.SfError(messages.getMessage('Package2AncestorsIdsKeyNotSupportedError'), 'DeprecationError');
     }
     const packagesWithAncestors = (await projectJson.getPackageDirectories())
         // check that the package has any ancestor types (id or version)
-        .filter((packageDir) => packageDir.ancestorId || packageDir.ancestorVersion);
+        .filter((packageDir) => packageDir.ancestorId ?? packageDir.ancestorVersion);
     if (packagesWithAncestors.length === 0) {
         return '';
     }
     const ancestorIds = await Promise.all(packagesWithAncestors.map(async (packageDir) => {
-        var _a, _b, _c;
         // ancestorID can be 05i, or 04t, alias; OR "ancestorVersion": "4.6.0.1"
         // according to docs, 05i is not ok: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev2gp_config_file.htm
+        // package can be an ID, but not according to docs
+        const packageAliases = projectJson.get('packageAliases');
+        const packageId = packageAliases[(0, ts_types_1.ensureString)(packageDir.package)] ?? packageDir.package;
+        // Handle HIGHEST and NONE in ancestor(Version|Id).
+        // Precedence chain: NONE -> HIGHEST -> ancestorVersion & ancestoryId
+        if (packageDir.ancestorVersion === 'NONE' || packageDir.ancestorId === 'NONE') {
+            return '';
+        }
+        else if (packageDir.ancestorVersion === 'HIGHEST' || packageDir.ancestorId === 'HIGHEST') {
+            const query = 'SELECT Id FROM Package2Version ' +
+                `WHERE Package2Id = '${packageId}' AND IsReleased = True AND IsDeprecated = False AND PatchVersion = 0 ` +
+                'ORDER BY MajorVersion Desc, MinorVersion Desc, PatchVersion Desc, BuildNumber Desc LIMIT 1';
+            try {
+                return (await hubOrg.getConnection().singleRecordQuery(query, { tooling: true })).Id;
+            }
+            catch (err) {
+                if (packageDir.ancestorVersion === 'HIGHEST') {
+                    throw new sfError_1.SfError(messages.getMessage('NoMatchingAncestorError', [packageDir.ancestorVersion, packageDir.package]), 'NoMatchingAncestorError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorVersion])]);
+                }
+                else {
+                    throw new sfError_1.SfError(messages.getMessage('NoMatchingAncestorIdError', [packageDir.ancestorId, packageDir.package]), 'NoMatchingAncestorIdError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorId])]);
+                }
+            }
+        }
         if (packageDir.ancestorVersion) {
             if (!/^[0-9]+.[0-9]+.[0-9]+(.[0-9]+)?$/.test(packageDir.ancestorVersion)) {
                 throw messages.createError('InvalidAncestorVersionFormatError', [packageDir.ancestorVersion]);
             }
-            // package can be an ID, but not according to docs
-            const packageAliases = projectJson.get('packageAliases');
-            const packageId = (_a = packageAliases[(0, ts_types_1.ensureString)(packageDir.package)]) !== null && _a !== void 0 ? _a : packageDir.package;
             const [major, minor, patch] = packageDir.ancestorVersion.split('.');
             let releasedAncestor;
             try {
@@ -83,7 +97,7 @@ const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
                     .singleRecordQuery(`SELECT Id, IsReleased FROM Package2Version WHERE Package2Id = '${packageId}' AND MajorVersion = ${major} AND MinorVersion = ${minor} AND PatchVersion = ${patch} and IsReleased = true`, { tooling: true });
             }
             catch (err) {
-                throw new sfdxError_1.SfdxError(messages.getMessage('NoMatchingAncestorError', [packageDir.ancestorVersion, packageDir.package]), 'NoMatchingAncestorError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorVersion])]);
+                throw new sfError_1.SfError(messages.getMessage('NoMatchingAncestorError', [packageDir.ancestorVersion, packageDir.package]), 'NoMatchingAncestorError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorVersion])]);
             }
             if (packageDir.ancestorId && packageDir.ancestorId !== releasedAncestor.Id) {
                 throw messages.createError('AncestorIdVersionMismatchError', [
@@ -93,24 +107,24 @@ const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
             }
             return releasedAncestor.Id;
         }
-        if ((_b = packageDir === null || packageDir === void 0 ? void 0 : packageDir.ancestorId) === null || _b === void 0 ? void 0 : _b.startsWith('05i')) {
+        if (packageDir?.ancestorId?.startsWith('05i')) {
             // if it's already a 05i return it, otherwise query for it
             return packageDir.ancestorId;
         }
-        if ((_c = packageDir === null || packageDir === void 0 ? void 0 : packageDir.ancestorId) === null || _c === void 0 ? void 0 : _c.startsWith('04t')) {
+        if (packageDir?.ancestorId?.startsWith('04t')) {
             // query for the Id
             return (await hubOrg
                 .getConnection()
                 .singleRecordQuery(`SELECT Id FROM Package2Version WHERE SubscriberPackageVersionId = '${packageDir.ancestorId}'`, { tooling: true })).Id;
         }
-        // ancestorID can be an alias get it from projectJson
-        const packageAliases = projectJson.get('packageAliases');
-        if (packageDir.ancestorId && (packageAliases === null || packageAliases === void 0 ? void 0 : packageAliases[packageDir.ancestorId])) {
+        // ancestorID can be an alias; get it from projectJson
+        if (packageDir.ancestorId && packageAliases?.[packageDir.ancestorId]) {
             return packageAliases[packageDir.ancestorId];
         }
-        throw new sfdxError_1.SfdxError(`Invalid ancestorId ${packageDir.ancestorId}`, 'InvalidAncestorId');
+        throw new sfError_1.SfError(`Invalid ancestorId ${packageDir.ancestorId}`, 'InvalidAncestorId');
     }));
-    return Array.from(new Set(ancestorIds)).join(';');
+    // strip out '' due to NONE
+    return Array.from(new Set(ancestorIds.filter((id) => id !== ''))).join(';');
 };
 exports.getAncestorIds = getAncestorIds;
 /**
@@ -122,26 +136,25 @@ exports.getAncestorIds = getAncestorIds;
  * @param ignoreAncestorIds true if the sfdx-project.json ancestorId keys should be ignored
  */
 const generateScratchOrgInfo = async ({ hubOrg, scratchOrgInfoPayload, nonamespace, ignoreAncestorIds, }) => {
-    var _a, _b;
-    let sfdxProject;
+    let sfProject;
     try {
-        sfdxProject = await sfdxProject_1.SfdxProjectJson.create({});
+        sfProject = await sfProject_1.SfProjectJson.create({});
     }
     catch (e) {
         // project is not required
     }
-    scratchOrgInfoPayload.orgName = (_a = scratchOrgInfoPayload.orgName) !== null && _a !== void 0 ? _a : 'Company';
+    scratchOrgInfoPayload.orgName = scratchOrgInfoPayload.orgName ?? 'Company';
     scratchOrgInfoPayload.package2AncestorIds =
-        !ignoreAncestorIds && (sfdxProject === null || sfdxProject === void 0 ? void 0 : sfdxProject.hasPackages())
-            ? await (0, exports.getAncestorIds)(scratchOrgInfoPayload, sfdxProject, hubOrg)
+        !ignoreAncestorIds && sfProject?.hasPackages()
+            ? await (0, exports.getAncestorIds)(scratchOrgInfoPayload, sfProject, hubOrg)
             : '';
     // Use the Hub org's client ID value, if one wasn't provided to us, or the default
     if (!scratchOrgInfoPayload.connectedAppConsumerKey) {
         scratchOrgInfoPayload.connectedAppConsumerKey =
-            (_b = hubOrg.getConnection().getAuthInfoFields().clientId) !== null && _b !== void 0 ? _b : defaultConnectedAppInfo.clientId;
+            hubOrg.getConnection().getAuthInfoFields().clientId ?? authInfo_1.DEFAULT_CONNECTED_APP_INFO.clientId;
     }
-    if (!nonamespace && (sfdxProject === null || sfdxProject === void 0 ? void 0 : sfdxProject.get('namespace'))) {
-        scratchOrgInfoPayload.namespace = sfdxProject.get('namespace');
+    if (!nonamespace && sfProject?.get('namespace')) {
+        scratchOrgInfoPayload.namespace = sfProject.get('namespace');
     }
     // we already have the info, and want to get rid of configApi, so this doesn't use that
     scratchOrgInfoPayload.connectedAppCallbackUrl = `http://localhost:${await webOAuthServer_1.WebOAuthServer.determineOauthPort()}/OauthRedirect`;
@@ -164,33 +177,20 @@ exports.generateScratchOrgInfo = generateScratchOrgInfo;
  warnings: string[];
  */
 const getScratchOrgInfoPayload = async (options) => {
-    var _a;
     let warnings = [];
-    // orgConfig input overrides definitionjson (-j option; hidden/deprecated)
-    const definitionJson = options.definitionjson ? JSON.parse(options.definitionjson) : {};
-    const orgConfigInput = { ...definitionJson, ...((_a = options.orgConfig) !== null && _a !== void 0 ? _a : {}) };
-    let scratchOrgInfoPayload = orgConfigInput;
-    // the -f option
-    if (options.definitionfile) {
-        try {
-            const fileData = await fs_1.promises.readFile(options.definitionfile, 'utf8');
-            const defFileContents = (0, kit_1.parseJson)(fileData);
-            // definitionjson and orgConfig override file input
-            scratchOrgInfoPayload = { ...defFileContents, ...orgConfigInput };
-        }
-        catch (err) {
-            const error = err;
-            if (error.name === 'JsonParseError') {
-                throw new sfdxError_1.SfdxError(`An error occurred parsing ${options.definitionfile}`);
-            }
-            throw sfdxError_1.SfdxError.wrap(error);
-        }
-    }
+    // orgConfig input overrides definitionjson (-j option; hidden/deprecated) overrides definitionfile (-f option)
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const scratchOrgInfoPayload = {
+        ...(options.definitionfile ? await parseDefinitionFile(options.definitionfile) : {}),
+        ...(options.definitionjson ? JSON.parse(options.definitionjson) : {}),
+        ...(options.orgConfig ?? {}),
+    };
     // scratchOrgInfoPayload must be heads down camelcase.
-    const upperCaseKey = sfdc_1.sfdc.findUpperCaseKeys(scratchOrgInfoPayload);
-    if (upperCaseKey) {
-        throw new sfdxError_1.SfdxError('InvalidJsonCasing', upperCaseKey);
-    }
+    Object.keys(scratchOrgInfoPayload).forEach((key) => {
+        if (key[0].toUpperCase() === key[0]) {
+            throw new sfError_1.SfError('InvalidJsonCasing', key);
+        }
+    });
     // Now run the fully resolved user input against the validator
     Object.keys(scratchOrgInfoPayload).forEach((key) => {
         optionsValidator(key, scratchOrgInfoPayload);
@@ -215,9 +215,23 @@ const getScratchOrgInfoPayload = async (options) => {
     return {
         scratchOrgInfoPayload,
         // Ignore ancestor ids only when 'nonamespace' or 'noancestors' options are specified
-        ignoreAncestorIds: options.nonamespace || options.noancestors || false,
+        ignoreAncestorIds: options.nonamespace ?? options.noancestors ?? false,
         warnings,
     };
 };
 exports.getScratchOrgInfoPayload = getScratchOrgInfoPayload;
+const parseDefinitionFile = async (definitionFile) => {
+    try {
+        const fileData = await fs_1.promises.readFile(definitionFile, 'utf8');
+        const defFileContents = (0, kit_1.parseJson)(fileData);
+        return defFileContents;
+    }
+    catch (err) {
+        const error = err;
+        if (error.name === 'JsonParseError') {
+            throw new sfError_1.SfError(`An error occurred parsing ${definitionFile}`);
+        }
+        throw sfError_1.SfError.wrap(error);
+    }
+};
 //# sourceMappingURL=scratchOrgInfoGenerator.js.map

package/lib/org/scratchOrgLifecycleEvents.d.ts

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

package/lib/org/scratchOrgLifecycleEvents.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitPostOrgCreate = exports.emit = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const lifecycleEvents_1 = require("../lifecycleEvents");
+const emitter = lifecycleEvents_1.Lifecycle.getInstance();
+exports.scratchOrgLifecycleEventName = 'scratchOrgLifecycleEvent';
+exports.scratchOrgLifecycleStages = [
+    'prepare request',
+    'send request',
+    'wait for org',
+    'available',
+    'authenticate',
+    'deploy settings',
+    'done',
+];
+const emit = async (event) => emitter.emit(exports.scratchOrgLifecycleEventName, event);
+exports.emit = emit;
+const postOrgCreateHookFields = [
+    'accessToken',
+    'clientId',
+    'created',
+    'createdOrgInstance',
+    'devHubUsername',
+    'expirationDate',
+    'instanceUrl',
+    'loginUrl',
+    'orgId',
+    'username',
+];
+const isHookField = (key) => postOrgCreateHookFields.includes(key);
+const emitPostOrgCreate = async (authFields) => {
+    await emitter.emit('postorgcreate', Object.fromEntries(Object.entries(authFields).filter(([key]) => isHookField(key))));
+};
+exports.emitPostOrgCreate = emitPostOrgCreate;
+//# sourceMappingURL=scratchOrgLifecycleEvents.js.map

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -1,5 +1,6 @@
+import { Duration } from '@salesforce/kit';
 import { JsonMap } from '@salesforce/ts-types';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo, ObjectSetting } from './scratchOrgTypes';
 import { Org } from './org';
 export declare enum RequestStatus {
     Pending = "Pending",
@@ -10,20 +11,27 @@ export declare enum RequestStatus {
     Canceling = "Canceling",
     Canceled = "Canceled"
 }
-export interface ObjectSetting extends JsonMap {
-    sharingModel?: string;
-    defaultRecordType?: string;
+export interface SettingType {
+    members: string[];
+    name: 'CustomObject' | 'RecordType' | 'BusinessProcess' | 'Settings';
 }
-export interface BusinessProcessFileContent extends JsonMap {
-    fullName: string;
-    isActive: boolean;
-    values: [
-        {
-            fullName: string;
-            default?: boolean;
-        }
-    ];
+export interface PackageFile {
+    '@': {
+        xmlns: string;
+    };
+    types: SettingType[];
+    version: string;
 }
+export declare const createObjectFileContent: ({ allRecordTypes, allBusinessProcesses, apiVersion, settingData, objectSettingsData, }: {
+    allRecordTypes?: string[] | undefined;
+    allBusinessProcesses?: string[] | undefined;
+    apiVersion: string;
+    settingData?: Record<string, unknown> | undefined;
+    objectSettingsData?: {
+        [objectName: string]: ObjectSetting;
+    } | undefined;
+}) => PackageFile;
+export declare const createRecordTypeAndBusinessProcessFileContent: (objectName: string, json: Record<string, unknown>, allRecordTypes: string[], allBusinessProcesses: string[]) => JsonMap;
 /**
  * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
  * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
@@ -33,10 +41,22 @@ export default class SettingsGenerator {
     private objectSettingsData?;
     private logger;
     private writer;
-    private shapeDirName;
-    constructor();
+    private allRecordTypes;
+    private allBusinessProcesses;
+    private readonly shapeDirName;
+    private readonly packageFilePath;
+    constructor(options?: {
+        mdApiTmpDir?: string;
+        shapeDirName?: string;
+        asDirectory?: boolean;
+    });
     /** extract the settings from the scratch def file, if they are present. */
-    extract(scratchDef: ScratchOrgInfo): Promise<void>;
+    extract(scratchDef: ScratchOrgInfo): Promise<{
+        settings: Record<string, unknown> | undefined;
+        objectSettings: {
+            [objectName: string]: ObjectSetting;
+        } | undefined;
+    }>;
     /** True if we are currently tracking setting or object setting data. */
     hasSettings(): boolean;
     /** Create temporary deploy directory used to upload the scratch org shape.
@@ -46,11 +66,14 @@ export default class SettingsGenerator {
     /**
      * Deploys the settings to the org.
      */
-    deploySettingsViaFolder(scratchOrg: Org, apiVersion: string): Promise<void>;
+    deploySettingsViaFolder(scratchOrg: Org, apiVersion: string, timeout?: Duration): Promise<void>;
+    createDeployPackageContents(apiVersion: string): Promise<void>;
+    getShapeDirName(): string;
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath(): string | undefined;
     private writeObjectSettingsIfNeeded;
     private writeSettingsIfNeeded;
-    private createPackageXml;
-    private createObjectFileContent;
-    private createRecordTypeFileContent;
-    private createBusinessProcessFileContent;
 }