@salesforce/core 2.32.0 → 2.34.2

package/lib/scratchOrgInfoGenerator.js

@@ -0,0 +1,226 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getScratchOrgInfoPayload = exports.generateScratchOrgInfo = exports.getAncestorIds = void 0;
+/*
+ * 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
+ */
+// Node
+const fs_1 = require("fs");
+// @salesforce
+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 webOAuthServer_1 = require("./webOAuthServer");
+const messages_1 = require("./messages");
+const sfdxError_1 = require("./sfdxError");
+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 SNAPSHOT_UNSUPPORTED_OPTIONS = [
+    'features',
+    'orgPreferences',
+    'edition',
+    'sourceOrg',
+    'settingsPath',
+    'releaseVersion',
+    'language',
+];
+// A validator function to ensure any options parameters entered by the user adhere
+// to a allowlist of valid option settings. Because org:create allows options to be
+// input either key=value pairs or within the definition file, this validator is
+// 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');
+    }
+    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');
+        }
+    }
+};
+/**
+ * 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
+ */
+const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
+    if (Reflect.has(scratchOrgInfo, 'package2AncestorIds')) {
+        throw new sfdxError_1.SfdxError(messages.getMessage('errorpackage2AncestorIdsKeyNotSupported'), 'DeprecationError');
+    }
+    const packagesWithAncestors = (await projectJson.getPackageDirectories())
+        // check that the package has any ancestor types (id or version)
+        .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
+        if (packageDir.ancestorVersion) {
+            if (!/^[0-9]+.[0-9]+.[0-9]+(.[0-9]+)?$/.test(packageDir.ancestorVersion)) {
+                throw sfdxError_1.SfdxError.create('@salesforce/core', 'scratchOrgInfoGenerator', 'errorInvalidAncestorVersionFormat', [
+                    packageDir.ancestorVersion,
+                ]);
+            }
+            // package can be an ID, but not according to docs
+            const packageAliases = projectJson.get('packageAliases');
+            const packageId = (_a = packageAliases[ts_types_1.ensureString(packageDir.package)]) !== null && _a !== void 0 ? _a : packageDir.package;
+            const [major, minor, patch] = packageDir.ancestorVersion.split('.');
+            let releasedAncestor;
+            try {
+                releasedAncestor = await hubOrg
+                    .getConnection()
+                    .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('errorNoMatchingAncestor', [packageDir.ancestorVersion, packageDir.package]), 'ErrorNoMatchingAncestor', [messages.getMessage('errorAncestorNotReleased', [packageDir.ancestorVersion])]);
+            }
+            if (packageDir.ancestorId && packageDir.ancestorId !== releasedAncestor.Id) {
+                throw sfdxError_1.SfdxError.create('@salesforce/core', 'scratchOrgInfogenerator', 'ErrorAncestorIdVersionMismatch', [
+                    packageDir.ancestorVersion,
+                    packageDir.ancestorId,
+                ]);
+            }
+            return releasedAncestor.Id;
+        }
+        if ((_b = packageDir === null || packageDir === void 0 ? void 0 : packageDir.ancestorId) === null || _b === void 0 ? void 0 : _b.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')) {
+            // 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])) {
+            return packageAliases[packageDir.ancestorId];
+        }
+        throw new sfdxError_1.SfdxError(`Invalid ancestorId ${packageDir.ancestorId}`, 'InvalidAncestorId');
+    }));
+    return Array.from(new Set(ancestorIds)).join(';');
+};
+exports.getAncestorIds = getAncestorIds;
+/**
+ * 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
+ */
+const generateScratchOrgInfo = async ({ hubOrg, scratchOrgInfoPayload, nonamespace, ignoreAncestorIds, }) => {
+    var _a, _b;
+    let sfdxProject;
+    try {
+        sfdxProject = await sfdxProject_1.SfdxProjectJson.create({});
+    }
+    catch (e) {
+        // project is not required
+    }
+    scratchOrgInfoPayload.orgName = (_a = scratchOrgInfoPayload.orgName) !== null && _a !== void 0 ? _a : 'Company';
+    scratchOrgInfoPayload.package2AncestorIds =
+        !ignoreAncestorIds && (sfdxProject === null || sfdxProject === void 0 ? void 0 : sfdxProject.hasPackages())
+            ? await exports.getAncestorIds(scratchOrgInfoPayload, sfdxProject, 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;
+    }
+    if (!nonamespace && (sfdxProject === null || sfdxProject === void 0 ? void 0 : sfdxProject.get('namespace'))) {
+        scratchOrgInfoPayload.namespace = sfdxProject.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`;
+    return scratchOrgInfoPayload;
+};
+exports.generateScratchOrgInfo = generateScratchOrgInfo;
+/**
+ * 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[];
+ */
+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 = 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);
+        }
+    }
+    // scratchOrgInfoPayload must be heads down camelcase.
+    const upperCaseKey = sfdc_1.sfdc.findUpperCaseKeys(scratchOrgInfoPayload);
+    if (upperCaseKey) {
+        throw new sfdxError_1.SfdxError('InvalidJsonCasing', upperCaseKey);
+    }
+    // Now run the fully resolved user input against the validator
+    Object.keys(scratchOrgInfoPayload).forEach((key) => {
+        optionsValidator(key, scratchOrgInfoPayload);
+    });
+    if (options.connectedAppConsumerKey) {
+        scratchOrgInfoPayload.connectedAppConsumerKey = options.connectedAppConsumerKey;
+    }
+    scratchOrgInfoPayload.durationDays = options.durationDays;
+    // Throw warnings for deprecated scratch org features.
+    const scratchOrgFeatureDeprecation = new scratchOrgFeatureDeprecation_1.ScratchOrgFeatureDeprecation();
+    // convert various supported array and string formats to a semi-colon-delimited string
+    if (scratchOrgInfoPayload.features) {
+        if (typeof scratchOrgInfoPayload.features === 'string') {
+            scratchOrgInfoPayload.features = scratchOrgInfoPayload.features.split(/[;,]/);
+        }
+        warnings = scratchOrgFeatureDeprecation.getFeatureWarnings(scratchOrgInfoPayload.features);
+        scratchOrgInfoPayload.features = scratchOrgInfoPayload.features.map((feature) => feature.trim());
+        scratchOrgInfoPayload.features = scratchOrgFeatureDeprecation
+            .filterDeprecatedFeatures(scratchOrgInfoPayload.features)
+            .join(';');
+    }
+    return {
+        scratchOrgInfoPayload,
+        // Ignore ancestor ids only when 'nonamespace' or 'noancestors' options are specified
+        ignoreAncestorIds: options.nonamespace || options.noancestors || false,
+        warnings,
+    };
+};
+exports.getScratchOrgInfoPayload = getScratchOrgInfoPayload;
+//# sourceMappingURL=scratchOrgInfoGenerator.js.map

package/lib/scratchOrgSettingsGenerator.d.ts

@@ -0,0 +1,56 @@
+import { JsonMap } from '@salesforce/ts-types';
+import { Org } from './org';
+import { ScratchOrgInfo } from './scratchOrgInfoApi';
+export declare enum RequestStatus {
+    Pending = "Pending",
+    InProgress = "InProgress",
+    Succeeded = "Succeeded",
+    SucceededPartial = "SucceededPartial",
+    Failed = "Failed",
+    Canceling = "Canceling",
+    Canceled = "Canceled"
+}
+export interface ObjectSetting extends JsonMap {
+    sharingModel?: string;
+    defaultRecordType?: string;
+}
+export interface BusinessProcessFileContent extends JsonMap {
+    fullName: string;
+    isActive: boolean;
+    values: [
+        {
+            fullName: string;
+            default?: boolean;
+        }
+    ];
+}
+/**
+ * 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.
+ */
+export default class SettingsGenerator {
+    private settingData?;
+    private objectSettingsData?;
+    private logger;
+    private writer;
+    private shapeDirName;
+    constructor();
+    /** extract the settings from the scratch def file, if they are present. */
+    extract(scratchDef: ScratchOrgInfo): Promise<void>;
+    /** True if we are currently tracking setting or object setting data. */
+    hasSettings(): boolean;
+    /** Create temporary deploy directory used to upload the scratch org shape.
+     * This will create the dir, all of the .setting files and minimal object files needed for objectSettings
+     */
+    createDeploy(): Promise<void>;
+    /**
+     * Deploys the settings to the org.
+     */
+    deploySettingsViaFolder(scratchOrg: Org, apiVersion: string): Promise<void>;
+    private writeObjectSettingsIfNeeded;
+    private writeSettingsIfNeeded;
+    private createPackageXml;
+    private createObjectFileContent;
+    private createRecordTypeFileContent;
+    private createBusinessProcessFileContent;
+}

package/lib/scratchOrgSettingsGenerator.js

@@ -0,0 +1,208 @@
+"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.RequestStatus = void 0;
+// Node
+const path = require("path");
+// @salesforce
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+const js2xmlparser = require("js2xmlparser");
+const logger_1 = require("./logger");
+const sfdxError_1 = require("./sfdxError");
+const jsonXmlTools_1 = require("./util/jsonXmlTools");
+const zipWriter_1 = require("./util/zipWriter");
+const pollingClient_1 = require("./status/pollingClient");
+var RequestStatus;
+(function (RequestStatus) {
+    RequestStatus["Pending"] = "Pending";
+    RequestStatus["InProgress"] = "InProgress";
+    RequestStatus["Succeeded"] = "Succeeded";
+    RequestStatus["SucceededPartial"] = "SucceededPartial";
+    RequestStatus["Failed"] = "Failed";
+    RequestStatus["Canceling"] = "Canceling";
+    RequestStatus["Canceled"] = "Canceled";
+})(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
+const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
+/**
+ * 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.
+ */
+class SettingsGenerator {
+    constructor() {
+        this.shapeDirName = `shape_${Date.now()}`;
+        this.logger = logger_1.Logger.childFromRoot('SettingsGenerator');
+        // If SFDX_MDAPI_TEMP_DIR is set, copy settings to that dir for people to inspect.
+        const mdapiTmpDir = kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
+        this.writer = new zipWriter_1.ZipWriter(mdapiTmpDir);
+    }
+    /** extract the settings from the scratch def file, if they are present. */
+    async extract(scratchDef) {
+        this.logger.debug('extracting settings from scratch definition file');
+        this.settingData = scratchDef.settings;
+        this.objectSettingsData = scratchDef.objectSettings;
+        this.logger.debug('settings are', this.settingData);
+    }
+    /** True if we are currently tracking setting or object setting data. */
+    hasSettings() {
+        return !kit_1.isEmpty(this.settingData) || !kit_1.isEmpty(this.objectSettingsData);
+    }
+    /** Create temporary deploy directory used to upload the scratch org shape.
+     * This will create the dir, all of the .setting files and minimal object files needed for objectSettings
+     */
+    async createDeploy() {
+        const settingsDir = path.join(this.shapeDirName, 'settings');
+        const objectsDir = path.join(this.shapeDirName, 'objects');
+        await Promise.all([this.writeSettingsIfNeeded(settingsDir), this.writeObjectSettingsIfNeeded(objectsDir)]);
+    }
+    /**
+     * Deploys the settings to the org.
+     */
+    async deploySettingsViaFolder(scratchOrg, apiVersion) {
+        const username = scratchOrg.getUsername();
+        const logger = await logger_1.Logger.child('deploySettingsViaFolder');
+        this.createPackageXml(apiVersion);
+        await this.writer.finalize();
+        const connection = scratchOrg.getConnection();
+        logger.debug(`deploying to apiVersion: ${apiVersion}`);
+        connection.setApiVersion(apiVersion);
+        const { id } = await connection.deploy(this.writer.buffer, {});
+        logger.debug(`deploying settings id ${id}`);
+        let result = await connection.metadata.checkDeployStatus(id);
+        const pollingOptions = {
+            async poll() {
+                try {
+                    result = await connection.metadata.checkDeployStatus(id);
+                    logger.debug(`Deploy id: ${id} status: ${result.status}`);
+                    if (breakPolling.includes(result.status)) {
+                        return {
+                            completed: true,
+                            payload: result.status,
+                        };
+                    }
+                    return {
+                        completed: false,
+                    };
+                }
+                catch (error) {
+                    logger.debug(`An error occurred trying to check deploy id: ${id}`);
+                    logger.debug(`Error: ${error.message}`);
+                    logger.debug('Re-trying deploy check again....');
+                    return {
+                        completed: false,
+                    };
+                }
+            },
+            timeout: kit_1.Duration.minutes(10),
+            frequency: kit_1.Duration.seconds(1),
+            timeoutErrorName: 'DeployingSettingsTimeoutError',
+        };
+        const client = await pollingClient_1.PollingClient.create(pollingOptions);
+        const status = (await client.subscribe());
+        if (status !== RequestStatus.Succeeded) {
+            const error = new sfdxError_1.SfdxError(`A scratch org was created with username ${username}, but the settings failed to deploy`, 'ProblemDeployingSettings');
+            error.setData(result);
+            throw error;
+        }
+    }
+    async writeObjectSettingsIfNeeded(objectsDir) {
+        if (!this.objectSettingsData || !Object.keys(this.objectSettingsData).length) {
+            return;
+        }
+        for (const objectName of Object.keys(this.objectSettingsData)) {
+            const value = this.objectSettingsData[objectName];
+            // writes the object file in source format
+            const objectDir = path.join(objectsDir, kit_1.upperFirst(objectName));
+            const customObjectDir = path.join(objectDir, `${kit_1.upperFirst(objectName)}.object`);
+            const customObjectXml = jsonXmlTools_1.JsonAsXml({
+                json: this.createObjectFileContent(value),
+                type: 'RecordType',
+            });
+            this.writer.addToZip(customObjectXml, customObjectDir);
+            if (value.defaultRecordType) {
+                const recordTypesDir = path.join(objectDir, 'recordTypes', `${kit_1.upperFirst(value.defaultRecordType)}.recordType`);
+                const recordTypesFileContent = this.createRecordTypeFileContent(objectName, value);
+                const recordTypesXml = jsonXmlTools_1.JsonAsXml({
+                    json: recordTypesFileContent,
+                    type: 'RecordType',
+                });
+                this.writer.addToZip(recordTypesXml, recordTypesDir);
+                // for things that required a businessProcess
+                if (recordTypesFileContent.businessProcess) {
+                    const businessProcessesDir = path.join(objectDir, 'businessProcesses', `${recordTypesFileContent.businessProcess}.businessProcess`);
+                    const businessProcessesXml = jsonXmlTools_1.JsonAsXml({
+                        json: this.createBusinessProcessFileContent(objectName, recordTypesFileContent.businessProcess),
+                        type: 'BusinessProcess',
+                    });
+                    this.writer.addToZip(businessProcessesXml, businessProcessesDir);
+                }
+            }
+        }
+    }
+    async writeSettingsIfNeeded(settingsDir) {
+        if (this.settingData) {
+            for (const item of Object.keys(this.settingData)) {
+                const value = ts_types_1.getObject(this.settingData, item);
+                const typeName = kit_1.upperFirst(item);
+                const fname = typeName.replace('Settings', '');
+                const fileContent = js2xmlparser.parse(typeName, value);
+                this.writer.addToZip(fileContent, path.join(settingsDir, fname + '.settings'));
+            }
+        }
+    }
+    createPackageXml(apiVersion) {
+        const pkg = `<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>*</members>
+        <name>Settings</name>
+    </types>
+    <types>
+        <members>*</members>
+        <name>CustomObject</name>
+    </types>
+    <version>${apiVersion}</version>
+</Package>`;
+        this.writer.addToZip(pkg, path.join(this.shapeDirName, 'package.xml'));
+    }
+    createObjectFileContent(json) {
+        const output = {};
+        if (json.sharingModel) {
+            output.sharingModel = kit_1.upperFirst(json.sharingModel);
+        }
+        return output;
+    }
+    createRecordTypeFileContent(objectName, setting) {
+        const defaultRecordType = kit_1.upperFirst(setting.defaultRecordType);
+        const output = {
+            fullName: defaultRecordType,
+            label: defaultRecordType,
+            active: true,
+        };
+        // all the edge cases
+        if (['Case', 'Lead', 'Opportunity', 'Solution'].includes(kit_1.upperFirst(objectName))) {
+            return { ...output, businessProcess: `${defaultRecordType}Process` };
+        }
+        return output;
+    }
+    createBusinessProcessFileContent(objectName, businessProcessName) {
+        const objectToBusinessProcessPicklist = {
+            Opportunity: { fullName: 'Prospecting' },
+            Case: { fullName: 'New', default: true },
+            Lead: { fullName: 'New - Not Contacted', default: true },
+            Solution: { fullName: 'Draft', default: true },
+        };
+        return {
+            fullName: businessProcessName,
+            isActive: true,
+            values: [objectToBusinessProcessPicklist[kit_1.upperFirst(objectName)]],
+        };
+    }
+}
+exports.default = SettingsGenerator;
+//# sourceMappingURL=scratchOrgSettingsGenerator.js.map

package/lib/status/streamingClient.d.ts

@@ -261,7 +261,6 @@ export declare namespace StreamingClient {
         handshakeTimeout: Duration;
         channel: string;
         streamingImpl: StreamingClientIfc;
-        private envDep;
         /**
          * Constructor for DefaultStreamingOptions
          *

package/lib/status/streamingClient.js

@@ -335,6 +335,10 @@ exports.StreamingClient = StreamingClient;
          * @see {@link StatusResult}
          */
         constructor(org, channel, streamProcessor, envDep = lib_1.env) {
+            if (envDep) {
+                const logger = logger_1.Logger.childFromRoot('StreamingClient');
+                logger.warn('envDep is deprecated');
+            }
             if (!streamProcessor) {
                 throw new sfdxError_1.SfdxError('Missing stream processor', 'MissingArg');
             }
@@ -344,7 +348,6 @@ exports.StreamingClient = StreamingClient;
             if (!channel) {
                 throw new sfdxError_1.SfdxError('Missing streaming channel', 'MissingArg');
             }
-            this.envDep = envDep;
             this.org = org;
             this.apiVersion = org.getConnection().getApiVersion();
             if (channel.startsWith('/system')) {
@@ -359,18 +362,7 @@ exports.StreamingClient = StreamingClient;
             this.handshakeTimeout = StreamingClient.DefaultOptions.DEFAULT_HANDSHAKE_TIMEOUT;
             this.streamingImpl = {
                 getCometClient: (url) => {
-                    const x = this.envDep.getString(StreamingClient.DefaultOptions.SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS);
-                    return new Faye.Client(url, {
-                        // This parameter ensures all cookies regardless of path are included in subsequent requests. Otherwise
-                        // only cookies with the path "/" and "/cometd" are known to be included.
-                        // if SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS is *not* set the default to true.
-                        cookiesAllowAllPaths: x === undefined
-                            ? true
-                            : this.envDep.getBoolean(StreamingClient.DefaultOptions.SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS),
-                        // WARNING - The allows request/response exchanges to be written to the log instance which includes
-                        // header and cookie information.
-                        enableRequestResponseLogging: this.envDep.getBoolean(StreamingClient.DefaultOptions.SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING),
-                    });
+                    return new Faye.Client(url);
                 },
                 setLogger: (logLine) => {
                     Faye.logger = {};

package/lib/util/jsonXmlTools.d.ts

@@ -0,0 +1,14 @@
+import { JsonMap } from '@salesforce/ts-types';
+import { IOptions } from 'js2xmlparser/lib/options';
+export interface JSONasXML {
+    json: JsonMap;
+    type: string;
+    options?: IOptions;
+}
+export interface WriteJSONasXMLInputs extends JSONasXML {
+    path: string;
+}
+export declare const standardOptions: IOptions;
+export declare const writeJSONasXML: ({ path, json, type, options, }: WriteJSONasXMLInputs) => Promise<void>;
+export declare const JsonAsXml: ({ json, type, options }: JSONasXML) => string;
+export declare const fixExistingDollarSign: (existing: WriteJSONasXMLInputs['json']) => Record<string, unknown>;

package/lib/util/jsonXmlTools.js

@@ -0,0 +1,41 @@
+"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.fixExistingDollarSign = exports.JsonAsXml = exports.writeJSONasXML = exports.standardOptions = void 0;
+const fs_1 = require("fs");
+const jsToXml = require("js2xmlparser");
+exports.standardOptions = {
+    declaration: {
+        include: true,
+        encoding: 'UTF-8',
+        version: '1.0',
+    },
+    format: {
+        doubleQuotes: true,
+    },
+};
+const writeJSONasXML = async ({ path, json, type, options = exports.standardOptions, }) => {
+    const xml = jsToXml.parse(type, exports.fixExistingDollarSign(json), options);
+    return await fs_1.promises.writeFile(path, xml);
+};
+exports.writeJSONasXML = writeJSONasXML;
+const JsonAsXml = ({ json, type, options = exports.standardOptions }) => {
+    return jsToXml.parse(type, exports.fixExistingDollarSign(json), options);
+};
+exports.JsonAsXml = JsonAsXml;
+const fixExistingDollarSign = (existing) => {
+    const existingCopy = { ...existing };
+    if (existingCopy.$) {
+        const temp = existingCopy.$;
+        delete existingCopy.$;
+        existingCopy['@'] = temp;
+    }
+    return existingCopy;
+};
+exports.fixExistingDollarSign = fixExistingDollarSign;
+//# sourceMappingURL=jsonXmlTools.js.map

package/lib/util/mapKeys.d.ts

@@ -0,0 +1,14 @@
+/**
+ *  Use mapKeys to convert object keys to another format using the specified conversion function.
+ *
+ *  E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
+ *        to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
+ *
+ *  NOTE: This mutates the object passed in for conversion.
+ *
+ *  @param target - {Object} The object to convert the keys
+ *  @param converter - {Function} The function that converts the object key
+ *  @param deep - {boolean} Whether to do a deep object key conversion
+ *  @return {Object} - the object with the converted keys
+ */
+export default function mapKeys(obj: any, converter: (key: string) => string, deep?: boolean): Record<string, unknown>;

package/lib/util/mapKeys.js

@@ -0,0 +1,48 @@
+"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 });
+const ts_types_1 = require("@salesforce/ts-types");
+/**
+ *  Use mapKeys to convert object keys to another format using the specified conversion function.
+ *
+ *  E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
+ *        to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
+ *
+ *  NOTE: This mutates the object passed in for conversion.
+ *
+ *  @param target - {Object} The object to convert the keys
+ *  @param converter - {Function} The function that converts the object key
+ *  @param deep - {boolean} Whether to do a deep object key conversion
+ *  @return {Object} - the object with the converted keys
+ */
+function mapKeys(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+obj, converter, deep) {
+    const target = Object.assign({}, obj);
+    return Object.fromEntries(Object.entries(target).map(([key, value]) => {
+        const k = converter.call(null, key);
+        if (deep) {
+            let v = value;
+            if (Array.isArray(value)) {
+                v = value.map((v1) => {
+                    if (ts_types_1.isPlainObject(v1)) {
+                        return mapKeys(v1, converter, deep);
+                    }
+                    return v1;
+                });
+            }
+            else if (ts_types_1.isPlainObject(value)) {
+                v = mapKeys(value, converter, deep);
+            }
+            return [k, v];
+        }
+        return [k, value];
+    }));
+}
+exports.default = mapKeys;
+//# sourceMappingURL=mapKeys.js.map