@salesforce/core 4.0.0 → 4.0.1

package/lib/org/scratchOrgSettingsGenerator.js

@@ -6,16 +6,16 @@
  * 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;
+exports.createRecordTypeAndBusinessProcessFileContent = exports.createObjectFileContent = exports.RequestStatus = void 0;
 const path = require("path");
 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 sfError_1 = require("../sfError");
 const pollingClient_1 = require("../status/pollingClient");
+const zipWriter_1 = require("../util/zipWriter");
+const directoryWriter_1 = require("../util/directoryWriter");
 var RequestStatus;
 (function (RequestStatus) {
     RequestStatus["Pending"] = "Pending";
@@ -27,24 +27,141 @@ var RequestStatus;
     RequestStatus["Canceled"] = "Canceled";
 })(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
 const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
+const createObjectFileContent = ({ allRecordTypes = [], allBusinessProcesses = [], apiVersion, settingData, objectSettingsData, }) => {
+    const output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+        types: [],
+    };
+    if (settingData) {
+        const strings = Object.keys(settingData).map((item) => (0, kit_1.upperFirst)(item).replace('Settings', ''));
+        output.types.push({ members: strings, name: 'Settings' });
+    }
+    if (objectSettingsData) {
+        const strings = Object.keys(objectSettingsData).map((item) => (0, kit_1.upperFirst)(item));
+        output.types.push({ members: strings, name: 'CustomObject' });
+        if (allRecordTypes.length > 0) {
+            output.types.push({ members: allRecordTypes, name: 'RecordType' });
+        }
+        if (allBusinessProcesses.length > 0) {
+            output.types.push({ members: allBusinessProcesses, name: 'BusinessProcess' });
+        }
+    }
+    return { ...output, ...{ version: apiVersion } };
+};
+exports.createObjectFileContent = createObjectFileContent;
+const calculateBusinessProcess = (objectName, defaultRecordType) => {
+    let businessProcessName = null;
+    let businessProcessPicklistVal = null;
+    // These four objects require any record type to specify a "business process"--
+    // a restricted set of items from a standard picklist on the object.
+    if (['Case', 'Lead', 'Opportunity', 'Solution'].includes(objectName)) {
+        businessProcessName = (0, kit_1.upperFirst)(defaultRecordType) + 'Process';
+        switch (objectName) {
+            case 'Case':
+                businessProcessPicklistVal = 'New';
+                break;
+            case 'Lead':
+                businessProcessPicklistVal = 'New - Not Contacted';
+                break;
+            case 'Opportunity':
+                businessProcessPicklistVal = 'Prospecting';
+                break;
+            case 'Solution':
+                businessProcessPicklistVal = 'Draft';
+        }
+    }
+    return [businessProcessName, businessProcessPicklistVal];
+};
+const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allRecordTypes, allBusinessProcesses) => {
+    let output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+    };
+    const name = (0, kit_1.upperFirst)(objectName);
+    const sharingModel = json.sharingModel;
+    if (sharingModel) {
+        output = {
+            ...output,
+            sharingModel: (0, kit_1.upperFirst)(sharingModel),
+        };
+    }
+    const defaultRecordType = json.defaultRecordType;
+    if (typeof defaultRecordType === 'string') {
+        // We need to keep track of these globally for when we generate the package XML.
+        allRecordTypes.push(`${name}.${(0, kit_1.upperFirst)(defaultRecordType)}`);
+        const [businessProcessName, businessProcessPicklistVal] = calculateBusinessProcess(name, defaultRecordType);
+        // Create the record type
+        const recordTypes = {
+            fullName: (0, kit_1.upperFirst)(defaultRecordType),
+            label: (0, kit_1.upperFirst)(defaultRecordType),
+            active: true,
+        };
+        output = {
+            ...output,
+            recordTypes: {
+                ...recordTypes,
+            },
+        };
+        if (businessProcessName) {
+            // We need to keep track of these globally for the package.xml
+            const values = {
+                fullName: businessProcessPicklistVal,
+            };
+            if (name !== 'Opportunity') {
+                values.default = true;
+            }
+            allBusinessProcesses.push(`${name}.${businessProcessName}`);
+            output = {
+                ...output,
+                recordTypes: {
+                    ...recordTypes,
+                    businessProcess: businessProcessName,
+                },
+                businessProcesses: {
+                    fullName: businessProcessName,
+                    isActive: true,
+                    values,
+                },
+            };
+        }
+    }
+    return output;
+};
+exports.createRecordTypeAndBusinessProcessFileContent = createRecordTypeAndBusinessProcessFileContent;
 /**
  * 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()}`;
+    constructor(options) {
+        this.allRecordTypes = [];
+        this.allBusinessProcesses = [];
         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);
+        const mdApiTmpDir = options?.mdApiTmpDir ?? kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
+        this.shapeDirName = options?.shapeDirName ?? `shape_${Date.now()}`;
+        this.packageFilePath = path.join(this.shapeDirName, 'package.xml');
+        let storePath;
+        if (!options?.asDirectory) {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, `${this.shapeDirName}.zip`) : undefined;
+            this.writer = new zipWriter_1.ZipWriter(storePath);
+        }
+        else {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, this.shapeDirName) : undefined;
+            this.writer = new directoryWriter_1.DirectoryWriter(storePath);
+        }
     }
     /** extract the settings from the scratch def file, if they are present. */
+    // eslint-disable-next-line @typescript-eslint/require-await
     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);
+        return { settings: this.settingData, objectSettings: this.objectSettingsData };
     }
     /** True if we are currently tracking setting or object setting data. */
     hasSettings() {
@@ -56,16 +173,18 @@ class SettingsGenerator {
     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)]);
+        await Promise.all([
+            this.writeSettingsIfNeeded(settingsDir),
+            this.writeObjectSettingsIfNeeded(objectsDir, this.allRecordTypes, this.allBusinessProcesses),
+        ]);
     }
     /**
      * Deploys the settings to the org.
      */
-    async deploySettingsViaFolder(scratchOrg, apiVersion) {
+    async deploySettingsViaFolder(scratchOrg, apiVersion, timeout = kit_1.Duration.minutes(10)) {
         const username = scratchOrg.getUsername();
         const logger = await logger_1.Logger.child('deploySettingsViaFolder');
-        this.createPackageXml(apiVersion);
-        await this.writer.finalize();
+        await this.createDeployPackageContents(apiVersion);
         const connection = scratchOrg.getConnection();
         logger.debug(`deploying to apiVersion: ${apiVersion}`);
         connection.setApiVersion(apiVersion);
@@ -96,7 +215,7 @@ class SettingsGenerator {
                     };
                 }
             },
-            timeout: kit_1.Duration.minutes(10),
+            timeout,
             frequency: kit_1.Duration.seconds(1),
             timeoutErrorName: 'DeployingSettingsTimeoutError',
         };
@@ -107,104 +226,52 @@ class SettingsGenerator {
             const failures = (Array.isArray(componentFailures) ? componentFailures : [componentFailures])
                 .map((failure) => failure.problem)
                 .join('\n');
-            const error = new sfdxError_1.SfdxError(`A scratch org was created with username ${username}, but the settings failed to deploy due to: \n${failures}`, 'ProblemDeployingSettings');
+            const error = new sfError_1.SfError(`A scratch org was created with username ${username}, but the settings failed to deploy due to: \n${failures}`, '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, (0, kit_1.upperFirst)(objectName));
-            const customObjectDir = path.join(objectDir, `${(0, kit_1.upperFirst)(objectName)}.object`);
-            const customObjectXml = (0, jsonXmlTools_1.JsonAsXml)({
-                json: this.createObjectFileContent(value),
-                type: 'RecordType',
-            });
-            this.writer.addToZip(customObjectXml, customObjectDir);
-            if (value.defaultRecordType) {
-                const recordTypesDir = path.join(objectDir, 'recordTypes', `${(0, kit_1.upperFirst)(value.defaultRecordType)}.recordType`);
-                const recordTypesFileContent = this.createRecordTypeFileContent(objectName, value);
-                const recordTypesXml = (0, 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 = (0, jsonXmlTools_1.JsonAsXml)({
-                        json: this.createBusinessProcessFileContent(objectName, recordTypesFileContent.businessProcess),
-                        type: 'BusinessProcess',
-                    });
-                    this.writer.addToZip(businessProcessesXml, businessProcessesDir);
-                }
-            }
+    async createDeployPackageContents(apiVersion) {
+        const packageObjectProps = (0, exports.createObjectFileContent)({
+            allRecordTypes: this.allRecordTypes,
+            allBusinessProcesses: this.allBusinessProcesses,
+            apiVersion,
+            settingData: this.settingData,
+            objectSettingsData: this.objectSettingsData,
+        });
+        const xml = js2xmlparser.parse('Package', packageObjectProps);
+        await this.writer.addToStore(xml, this.packageFilePath);
+        await this.writer.finalize();
+    }
+    getShapeDirName() {
+        return this.shapeDirName;
+    }
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath() {
+        return this.writer.getDestinationPath();
+    }
+    async writeObjectSettingsIfNeeded(objectsDir, allRecordTypes, allbusinessProcesses) {
+        if (this.objectSettingsData) {
+            await Promise.all(Object.entries(this.objectSettingsData).map(([item, value]) => {
+                const fileContent = (0, exports.createRecordTypeAndBusinessProcessFileContent)(item, value, allRecordTypes, allbusinessProcesses);
+                const xml = js2xmlparser.parse('CustomObject', fileContent);
+                return this.writer.addToStore(xml, path.join(objectsDir, (0, kit_1.upperFirst)(item) + '.object'));
+            }));
         }
     }
     async writeSettingsIfNeeded(settingsDir) {
         if (this.settingData) {
-            for (const item of Object.keys(this.settingData)) {
-                const value = (0, ts_types_1.getObject)(this.settingData, item);
+            await Promise.all(Object.entries(this.settingData).map(([item, value]) => {
                 const typeName = (0, kit_1.upperFirst)(item);
                 const fname = typeName.replace('Settings', '');
                 const fileContent = js2xmlparser.parse(typeName, value);
-                this.writer.addToZip(fileContent, path.join(settingsDir, fname + '.settings'));
-            }
+                return this.writer.addToStore(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 = (0, kit_1.upperFirst)(json.sharingModel);
-        }
-        return output;
-    }
-    createRecordTypeFileContent(objectName, setting) {
-        const defaultRecordType = (0, kit_1.upperFirst)(setting.defaultRecordType);
-        const output = {
-            fullName: defaultRecordType,
-            label: defaultRecordType,
-            active: true,
-        };
-        // all the edge cases
-        if (['Case', 'Lead', 'Opportunity', 'Solution'].includes((0, 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[(0, kit_1.upperFirst)(objectName)]],
-        };
-    }
 }
 exports.default = SettingsGenerator;
 //# sourceMappingURL=scratchOrgSettingsGenerator.js.map

package/lib/org/scratchOrgTypes.d.ts

@@ -0,0 +1,43 @@
+import { JsonMap } from '@salesforce/ts-types';
+export interface ScratchOrgInfo {
+    AdminEmail?: string;
+    readonly CreatedDate?: string;
+    ConnectedAppCallbackUrl?: string;
+    ConnectedAppConsumerKey?: string;
+    Country?: string;
+    Description?: string;
+    DurationDays?: number;
+    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 ObjectSetting extends JsonMap {
+    sharingModel?: string;
+    defaultRecordType?: string;
+}

package/lib/org/scratchOrgTypes.js

@@ -0,0 +1,9 @@
+"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 });
+//# sourceMappingURL=scratchOrgTypes.js.map

package/lib/org/user.d.ts

@@ -22,7 +22,7 @@ export declare const REQUIRED_FIELDS: {
  *
  * **See** https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_user.htm
  */
-export declare type UserFields = {
+export type UserFields = {
     -readonly [K in keyof typeof REQUIRED_FIELDS]: string;
 };
 /**

package/lib/org/user.js

@@ -14,7 +14,7 @@ const http_api_1 = require("jsforce/lib/http-api");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const secureBuffer_1 = require("../crypto/secureBuffer");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const sfdc_1 = require("../util/sfdc");
 const connection_1 = require("./connection");
 const permissionSetAssignment_1 = require("./permissionSetAssignment");
@@ -36,16 +36,7 @@ const PASSWORD_COMPLEXITY = {
 };
 const scimEndpoint = '/services/scim/v1/Users';
 const scimHeaders = { 'auto-approve-user': 'true' };
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'user', [
-    'invalidHttpResponseCreatingUser',
-    'userQueryFailed',
-    'missingId',
-    'permsetNamesAreRequired',
-    'missingFields',
-    'lengthOutOfBound',
-    'complexityOutOfBound',
-]);
+const messages = new messages_1.Messages('@salesforce/core', 'user', new Map([["orgRequired", "An org instance is required."], ["userQueryFailed", "Failed to query for the user %s."], ["invalidHttpResponseCreatingUser", "An invalid http response code (%s) was received while trying to create a user."], ["missingFields", "The fields parameters is undefined."], ["missingId", "The Salesforce id for the user is required."], ["permsetNamesAreRequired", "The permission set names are missing but required."], ["complexityOutOfBound", "Invalid complexity value. Specify a value between 0 and 5, inclusive."], ["lengthOutOfBound", "Invalid length value. Specify a value between 8 and 1000, inclusive."], ["problemsDescribingTheUserObject", "Problems occurred while attempting to describe the user object."]]));
 /**
  * A Map of Required Salesforce User fields.
  */
@@ -71,7 +62,7 @@ async function retrieveUserFields(logger, username) {
     const connection = await connection_1.Connection.create({
         authInfo: await authInfo_1.AuthInfo.create({ username }),
     });
-    if (sfdc_1.sfdc.matchesAccessToken(username)) {
+    if ((0, sfdc_1.matchesAccessToken)(username)) {
         logger.debug('received an accessToken for the username.  Converting...');
         username = (await connection.identity()).username;
         logger.debug(`accessToken converted to ${username}`);
@@ -80,22 +71,23 @@ async function retrieveUserFields(logger, username) {
         logger.debug('not a accessToken');
     }
     const fromFields = Object.keys(exports.REQUIRED_FIELDS).map(kit_1.upperFirst);
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
     const requiredFieldsFromAdminQuery = `SELECT ${fromFields} FROM User WHERE Username='${username}'`;
     const result = await connection.query(requiredFieldsFromAdminQuery);
     logger.debug('Successfully retrieved the admin user for this org.');
     if (result.totalSize === 1) {
         const results = (0, kit_1.mapKeys)(result.records[0], (value, key) => (0, kit_1.lowerFirst)(key));
         const fields = {
-            id: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.id)),
+            id: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.id]),
             username,
-            alias: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.alias)),
-            email: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.email)),
-            emailEncodingKey: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.emailEncodingKey)),
-            languageLocaleKey: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.languageLocaleKey)),
-            localeSidKey: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.localeSidKey)),
-            profileId: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.profileId)),
-            lastName: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.lastName)),
-            timeZoneSidKey: (0, ts_types_1.ensure)((0, ts_types_1.getString)(results, exports.REQUIRED_FIELDS.timeZoneSidKey)),
+            alias: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.alias]),
+            email: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.email]),
+            emailEncodingKey: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.emailEncodingKey]),
+            languageLocaleKey: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.languageLocaleKey]),
+            localeSidKey: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.localeSidKey]),
+            profileId: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.profileId]),
+            lastName: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.lastName]),
+            timeZoneSidKey: (0, ts_types_1.ensureString)(results[exports.REQUIRED_FIELDS.timeZoneSidKey]),
         };
         return fields;
     }
@@ -110,7 +102,7 @@ async function retrieveUserFields(logger, username) {
  * @param connection The connection for the query.
  */
 async function retrieveProfileId(name, connection) {
-    if (!sfdc_1.sfdc.validateSalesforceId(name)) {
+    if (!(0, sfdc_1.validateSalesforceId)(name)) {
         const profileQuery = `SELECT Id FROM Profile WHERE name='${name}'`;
         const result = await connection.query(profileQuery);
         if (result.records.length > 0) {
@@ -185,11 +177,11 @@ class User extends kit_1.AsyncCreatable {
     static generatePasswordUtf8(passwordCondition = { length: 13, complexity: 5 }) {
         if (!PASSWORD_COMPLEXITY[passwordCondition.complexity]) {
             const msg = messages.getMessage('complexityOutOfBound');
-            throw new sfdxError_1.SfdxError(msg, 'complexityOutOfBound');
+            throw new sfError_1.SfError(msg, 'complexityOutOfBound');
         }
         if (passwordCondition.length < 8 || passwordCondition.length > 1000) {
             const msg = messages.getMessage('lengthOutOfBound');
-            throw new sfdxError_1.SfdxError(msg, 'lengthOutOfBound');
+            throw new sfError_1.SfError(msg, 'lengthOutOfBound');
         }
         let password = [];
         ['SYMBOLS', 'NUMBERS', 'UPPER', 'LOWER'].forEach((charSet) => {
@@ -225,10 +217,10 @@ class User extends kit_1.AsyncCreatable {
         this.logger.debug(`Attempting to set password for userId: ${info.getFields().userId} username: ${info.getFields().username}`);
         const userConnection = await connection_1.Connection.create({ authInfo: info });
         return new Promise((resolve, reject) => {
+            // no promises in async method
             // eslint-disable-next-line @typescript-eslint/no-misused-promises
             password.value(async (buffer) => {
                 try {
-                    // @ts-ignore TODO: expose `soap` on Connection however appropriate
                     const soap = userConnection.soap;
                     await soap.setPassword((0, ts_types_1.ensureString)(info.getFields().userId), buffer.toString('utf8'));
                     this.logger.debug(`Set password for userId: ${info.getFields().userId}`);
@@ -265,9 +257,7 @@ class User extends kit_1.AsyncCreatable {
             throw messages.createError('permsetNamesAreRequired');
         }
         const assignments = await permissionSetAssignment_1.PermissionSetAssignment.init(this.org);
-        for (const permsetName of permsetNames) {
-            await assignments.create(id, permsetName);
-        }
+        await Promise.all(permsetNames.map((permsetName) => assignments.create(id, permsetName)));
     }
     /**
      * Method for creating a new User.
@@ -293,7 +283,6 @@ class User extends kit_1.AsyncCreatable {
      * ```
      */
     async createUser(fields) {
-        var _a;
         // Create a user and get a refresh token
         const refreshTokenSecret = await this.createUserInternal(fields);
         // Create the initial auth info
@@ -302,7 +291,7 @@ class User extends kit_1.AsyncCreatable {
         // Setup oauth options for the new user
         const oauthOptions = {
             // Communities users require the instance for auth
-            loginUrl: (_a = adminUserAuthFields.instanceUrl) !== null && _a !== void 0 ? _a : adminUserAuthFields.loginUrl,
+            loginUrl: adminUserAuthFields.instanceUrl ?? adminUserAuthFields.loginUrl,
             refreshToken: refreshTokenSecret.buffer.value((buffer) => buffer.toString('utf8')),
             clientId: adminUserAuthFields.clientId,
             clientSecret: adminUserAuthFields.clientSecret,
@@ -338,7 +327,7 @@ class User extends kit_1.AsyncCreatable {
      * ```
      */
     async retrieve(username) {
-        return await retrieveUserFields(this.logger, username);
+        return retrieveUserFields(this.logger, username);
     }
     /**
      * Helper method that verifies the server's User object is available and if so allows persisting the Auth information.
@@ -349,7 +338,7 @@ class User extends kit_1.AsyncCreatable {
         const connection = await connection_1.Connection.create({ authInfo: newUserAuthInfo });
         this.logger.debug(`Created connection for user: ${newUserAuthInfo.getUsername()}`);
         const userDescribe = await connection.describe('User');
-        if (userDescribe && userDescribe.fields) {
+        if (userDescribe?.fields) {
             await newUserAuthInfo.save();
             return newUserAuthInfo;
         }
@@ -402,12 +391,13 @@ class User extends kit_1.AsyncCreatable {
                     errors.forEach((singleMessage) => {
                         if (!(0, ts_types_1.isJsonMap)(singleMessage))
                             return;
+                        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
                         message = `${message}${os_1.EOL}${singleMessage.description}`;
                     });
                 }
             }
             this.logger.debug(message);
-            throw new sfdxError_1.SfdxError(message, 'UserCreateHttpError');
+            throw new sfError_1.SfError(message, 'UserCreateHttpError');
         }
         fields.id = (0, ts_types_1.ensureString)(responseBody.id);
         await this.updateRequiredUserFields(fields);
@@ -420,9 +410,10 @@ class User extends kit_1.AsyncCreatable {
             userId: fields.id,
         };
     }
+    // eslint-disable-next-line class-methods-use-this
     async rawRequest(conn, options) {
         return new Promise((resolve, reject) => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
             const httpApi = new http_api_1.HttpApi(conn, options);
             httpApi.on('response', (response) => resolve(response));
             httpApi.request(options).catch(reject);

package/lib/schema/printer.d.ts

@@ -3,6 +3,9 @@ import { Logger } from '../logger';
 /**
  * Renders schema properties.  By default, this is simply an identity transform.  Subclasses may provide more
  * interesting decorations of each values, such as ANSI coloring.
+ *
+ * @deprecated
+ *
  */
 export declare class SchemaPropertyRenderer {
     /**
@@ -33,6 +36,9 @@ export declare class SchemaPropertyRenderer {
 /**
  * Prints a JSON schema in a human-friendly format.
  *
+ * @deprecated
+ * remaining reference: https://github.com/salesforcecli/plugin-data/blob/cc1bdfa2c707f93a6da96beea8117b25f9612d4a/src/commands/data/import/tree.ts#L75
+ *
  * ```
  * import chalk from 'chalk';
  * class MyPropertyRenderer extends SchemaPropertyRenderer {