@salesforce/core 3.7.5 → 3.7.8

package/lib/config/configStore.js

@@ -11,7 +11,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const ts_types_2 = require("@salesforce/ts-types");
 const crypto_1 = require("../crypto/crypto");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 /**
  * An abstract class that implements all the config management functions but
  * none of the storage functions.
@@ -206,7 +206,8 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         });
     }
     getEncryptedKeys() {
-        return [...(this.options.encryptedKeys || []), ...(this.statics.encryptedKeys || [])];
+        var _a, _b;
+        return [...(((_a = this.options) === null || _a === void 0 ? void 0 : _a.encryptedKeys) || []), ...(((_b = this.statics) === null || _b === void 0 ? void 0 : _b.encryptedKeys) || [])];
     }
     /**
      * This config file has encrypted keys and it should attempt to encrypt them.
@@ -286,18 +287,18 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         if (!value)
             return;
         if (!this.crypto)
-            throw new sfdxError_1.SfdxError('crypto is not initialized', 'CryptoNotInitializedError');
+            throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfdxError_1.SfdxError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? value : this.crypto.encrypt(value);
     }
     decrypt(value) {
         if (!value)
             return;
         if (!this.crypto)
-            throw new sfdxError_1.SfdxError('crypto is not initialized', 'CryptoNotInitializedError');
+            throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfdxError_1.SfdxError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? this.crypto.decrypt(value) : value;
     }
     /**

package/lib/config/keychainConfig.js

@@ -8,7 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeychainConfig = void 0;
 const path_1 = require("path");
-const fs_1 = require("../util/fs");
+const fs = require("fs");
+const mkdirp = require("mkdirp");
 const configFile_1 = require("./configFile");
 /**
  * Represent a key chain config backed by a json file.
@@ -34,8 +35,8 @@ class KeychainConfig extends configFile_1.ConfigFile {
         if (newContents != null) {
             this.setContents(newContents);
         }
-        await fs_1.fs.mkdirp((0, path_1.dirname)(this.getPath()));
-        await fs_1.fs.writeFile(this.getPath(), JSON.stringify(this.getContents(), null, 4), { mode: '600' });
+        await mkdirp((0, path_1.dirname)(this.getPath()));
+        await fs.promises.writeFile(this.getPath(), JSON.stringify(this.getContents(), null, 4), { mode: '600' });
         return this.getContents();
     }
 }

package/lib/crypto/keyChainImpl.js

@@ -9,12 +9,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.keyChainImpl = exports.GenericWindowsKeychainAccess = exports.GenericUnixKeychainAccess = exports.GenericKeychainAccess = exports.KeychainAccess = void 0;
 const childProcess = require("child_process");
 const nodeFs = require("fs");
+const fs = require("fs");
 const os = require("os");
-const path = require("path");
 const os_1 = require("os");
+const path = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
+const kit_1 = require("@salesforce/kit");
+const mkdirp = require("mkdirp");
 const global_1 = require("../global");
-const fs_1 = require("../util/fs");
 const messages_1 = require("../messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'encryption', [
@@ -58,9 +60,9 @@ const _isExe = (mode, gid, uid) => {
 /**
  * Private helper to validate that a program exists on the file system and is executable.
  *
- * **Throws** *{@link SfdxError}{ name: 'MissingCredentialProgramError' }* When the OS credential program isn't found.
+ * **Throws** *{@link SfError}{ name: 'MissingCredentialProgramError' }* When the OS credential program isn't found.
  *
- * **Throws** *{@link SfdxError}{ name: 'CredentialProgramAccessError' }* When the OS credential program isn't accessible.
+ * **Throws** *{@link SfError}{ name: 'CredentialProgramAccessError' }* When the OS credential program isn't accessible.
  *
  * @param programPath The absolute path of the program.
  * @param fsIfc The file system interface.
@@ -216,7 +218,6 @@ const _linuxImpl = {
             // This is a workaround for linux.
             // Calling secret-tool too fast can cause it to return an unexpected error. (below)
             if (stderr != null && stderr.includes('invalid or unencryptable secret')) {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore TODO: make an error subclass with this field
                 error.retry = true;
                 // Throwing here allows us to perform a retry in KeychainAccess
@@ -330,8 +331,8 @@ async function _writeFile(opts, fn) {
             [SecretField.KEY]: opts.password,
             [SecretField.SERVICE]: opts.service,
         };
-        await fs_1.fs.mkdirp(path.dirname(secretFile));
-        await fs_1.fs.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
+        await mkdirp(path.dirname(secretFile));
+        await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
         fn(null, contents);
     }
     catch (err) {
@@ -340,7 +341,7 @@ async function _writeFile(opts, fn) {
 }
 async function _readFile() {
     // The file and access is validated before this method is called
-    const fileContents = await fs_1.fs.readJsonMap(secretFile);
+    const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(secretFile, 'utf8'));
     return {
         account: (0, ts_types_1.ensureString)(fileContents[SecretField.ACCOUNT]),
         password: (0, ts_types_1.asString)(fileContents[SecretField.KEY]),
@@ -407,7 +408,7 @@ class GenericKeychainAccess {
     async isValidFileAccess(cb) {
         try {
             const root = (0, os_1.homedir)();
-            await fs_1.fs.access(path.join(root, global_1.Global.SFDX_STATE_FOLDER), fs_1.fs.constants.R_OK | fs_1.fs.constants.X_OK | fs_1.fs.constants.W_OK);
+            await fs.promises.access(path.join(root, global_1.Global.SFDX_STATE_FOLDER), fs.constants.R_OK | fs.constants.X_OK | fs.constants.W_OK);
             await cb(null);
         }
         catch (err) {
@@ -427,7 +428,7 @@ class GenericUnixKeychainAccess extends GenericKeychainAccess {
                 await cb(err);
             }
             else {
-                const stats = await fs_1.fs.stat(secretFile);
+                const stats = await fs.promises.stat(secretFile);
                 const octalModeStr = (stats.mode & 0o777).toString(8);
                 const EXPECTED_OCTAL_PERM_VALUE = '600';
                 if (octalModeStr === EXPECTED_OCTAL_PERM_VALUE) {
@@ -452,7 +453,7 @@ class GenericWindowsKeychainAccess extends GenericKeychainAccess {
             }
             else {
                 try {
-                    await fs_1.fs.access(secretFile, fs_1.fs.constants.R_OK | fs_1.fs.constants.W_OK);
+                    await fs.promises.access(secretFile, fs.constants.R_OK | fs.constants.W_OK);
                     await cb(null);
                 }
                 catch (e) {

package/lib/deviceOauthService.js

@@ -15,7 +15,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const logger_1 = require("./logger");
 const authInfo_1 = require("./org/authInfo");
-const sfdxError_1 = require("./sfdxError");
+const sfError_1 = require("./sfError");
 const connection_1 = require("./org/connection");
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
@@ -29,7 +29,7 @@ async function makeRequest(options) {
     const rawResponse = await new transport_1.default().httpRequest(options);
     const response = (0, kit_1.parseJsonMap)(rawResponse.body);
     if (response.error) {
-        const err = new sfdxError_1.SfdxError('Request Failed.');
+        const err = new sfError_1.SfError('Request Failed.');
         err.data = Object.assign(response, { status: rawResponse.statusCode });
         throw err;
     }

package/lib/exported.d.ts

@@ -16,18 +16,19 @@ export { WebOAuthServer } from './webOAuthServer';
 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 { Messages, StructuredMessage } from './messages';
+export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
 export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
-export { PackageDir, NamedPackageDir, PackageDirDependency, SfdxProject, SfdxProjectJson } from './sfdxProject';
+export { PackageDir, NamedPackageDir, PackageDirDependency, SfProject, SfProjectJson, SfdxProject, SfdxProjectJson, } from './sfProject';
 export { SchemaPrinter } from './schema/printer';
 export { SchemaValidator } from './schema/validator';
-export { SfdxError } from './sfdxError';
+export { SfError, SfdxError } from './sfError';
 export { PollingClient } from './status/pollingClient';
 export { CometClient, CometSubscription, StreamingClient, StatusResult } from './status/streamingClient';
 export { MyDomainResolver } from './status/myDomainResolver';
 export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user';
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
-export * from './util/fs';
+export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
+export { ScratchOrgInfo } from './org/scratchOrgInfoApi';
 export * from './util/sfdc';
 export * from './util/sfdcUrl';

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.SfdxError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = 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.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.ConfigFile = void 0;
+exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SfError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = 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.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.ConfigFile = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -71,15 +71,18 @@ Object.defineProperty(exports, "OrgTypes", { enumerable: true, get: function ()
 var orgConfigProperties_1 = require("./org/orgConfigProperties");
 Object.defineProperty(exports, "OrgConfigProperties", { enumerable: true, get: function () { return orgConfigProperties_1.OrgConfigProperties; } });
 Object.defineProperty(exports, "ORG_CONFIG_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return orgConfigProperties_1.ORG_CONFIG_ALLOWED_PROPERTIES; } });
-var sfdxProject_1 = require("./sfdxProject");
-Object.defineProperty(exports, "SfdxProject", { enumerable: true, get: function () { return sfdxProject_1.SfdxProject; } });
-Object.defineProperty(exports, "SfdxProjectJson", { enumerable: true, get: function () { return sfdxProject_1.SfdxProjectJson; } });
+var sfProject_1 = require("./sfProject");
+Object.defineProperty(exports, "SfProject", { enumerable: true, get: function () { return sfProject_1.SfProject; } });
+Object.defineProperty(exports, "SfProjectJson", { enumerable: true, get: function () { return sfProject_1.SfProjectJson; } });
+Object.defineProperty(exports, "SfdxProject", { enumerable: true, get: function () { return sfProject_1.SfdxProject; } });
+Object.defineProperty(exports, "SfdxProjectJson", { enumerable: true, get: function () { return sfProject_1.SfdxProjectJson; } });
 var printer_1 = require("./schema/printer");
 Object.defineProperty(exports, "SchemaPrinter", { enumerable: true, get: function () { return printer_1.SchemaPrinter; } });
 var validator_1 = require("./schema/validator");
 Object.defineProperty(exports, "SchemaValidator", { enumerable: true, get: function () { return validator_1.SchemaValidator; } });
-var sfdxError_1 = require("./sfdxError");
-Object.defineProperty(exports, "SfdxError", { enumerable: true, get: function () { return sfdxError_1.SfdxError; } });
+var sfError_1 = require("./sfError");
+Object.defineProperty(exports, "SfError", { enumerable: true, get: function () { return sfError_1.SfError; } });
+Object.defineProperty(exports, "SfdxError", { enumerable: true, get: function () { return sfError_1.SfdxError; } });
 var pollingClient_1 = require("./status/pollingClient");
 Object.defineProperty(exports, "PollingClient", { enumerable: true, get: function () { return pollingClient_1.PollingClient; } });
 var streamingClient_1 = require("./status/streamingClient");
@@ -93,8 +96,9 @@ 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("./org/permissionSetAssignment");
 Object.defineProperty(exports, "PermissionSetAssignment", { enumerable: true, get: function () { return permissionSetAssignment_1.PermissionSetAssignment; } });
+var scratchOrgCreate_1 = require("./org/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);
 __exportStar(require("./util/sfdcUrl"), exports);
 //# sourceMappingURL=exported.js.map

package/lib/global.js

@@ -10,7 +10,7 @@ exports.Global = exports.Mode = void 0;
 const os = require("os");
 const path = require("path");
 const kit_1 = require("@salesforce/kit");
-const fs_1 = require("./util/fs");
+const mkdirp = require("mkdirp");
 /**
  * Represents an environment mode.  Supports `production`, `development`, `demo`, and `test`
  * with the default mode being `production`.
@@ -46,7 +46,7 @@ class Global {
      */
     static async createDir(dirPath) {
         dirPath = dirPath ? path.join(Global.SFDX_DIR, dirPath) : Global.SFDX_DIR;
-        await fs_1.fs.mkdirp(dirPath, fs_1.fs.DEFAULT_USER_DIR_MODE);
+        await mkdirp(dirPath, '700');
     }
 }
 exports.Global = Global;

package/lib/globalInfo/accessors/aliasAccessor.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AliasAccessor = void 0;
-const sfdxError_1 = require("../../sfdxError");
+const sfError_1 = require("../../sfError");
 const types_1 = require("../types");
 class AliasAccessor {
     constructor(globalInfo) {
@@ -121,7 +121,7 @@ class AliasAccessor {
             return entity;
         const aliaseeName = (_a = entity.username) !== null && _a !== void 0 ? _a : entity.user;
         if (!aliaseeName) {
-            throw new sfdxError_1.SfdxError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
+            throw new sfError_1.SfError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
         }
         return aliaseeName;
     }

package/lib/globalInfo/sfdxDataHandler.d.ts

@@ -1,5 +1,5 @@
 import { ConfigFile } from '../config/configFile';
-import { SfOrgs, SfOrg, SfInfo, SfInfoKeys } from './types';
+import { SfInfo, SfInfoKeys, SfOrg, SfOrgs } from './types';
 interface Handler<T extends SfInfoKeys> {
     sfKey: T;
     merge: (sfData: SfInfo) => Promise<Partial<SfInfo>>;

package/lib/globalInfo/sfdxDataHandler.js

@@ -8,10 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AliasesHandler = exports.AuthHandler = exports.SfdxDataHandler = void 0;
 const path_1 = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const global_1 = require("../global");
-const fs_1 = require("../util/fs");
 const configFile_1 = require("../config/configFile");
 const globalInfoConfig_1 = require("./globalInfoConfig");
 const types_1 = require("./types");
@@ -141,7 +141,7 @@ class AuthHandler extends BaseHandler {
         return config;
     }
     async listAllAuthFiles() {
-        const globalFiles = await fs_1.fs.readdir(global_1.Global.SFDX_DIR);
+        const globalFiles = await fs.promises.readdir(global_1.Global.SFDX_DIR);
         return globalFiles.filter((file) => file.match(AuthHandler.authFilenameFilterRegEx));
     }
     async listAllAuthorizations() {
@@ -169,7 +169,8 @@ class AliasesHandler extends BaseHandler {
     async migrate() {
         const aliasesFilePath = (0, path_1.join)(global_1.Global.SFDX_DIR, AliasesHandler.SFDX_ALIASES_FILENAME);
         try {
-            const sfdxAliases = (await fs_1.fs.readJson(aliasesFilePath)).orgs;
+            const x = await fs.promises.readFile(aliasesFilePath, 'utf8');
+            const sfdxAliases = (0, kit_1.parseJson)(x).orgs;
             return { [this.sfKey]: { ...sfdxAliases } };
         }
         catch (e) {
@@ -209,7 +210,7 @@ class AliasesHandler extends BaseHandler {
     }
     async write(latest) {
         const aliasesFilePath = (0, path_1.join)(global_1.Global.SFDX_DIR, AliasesHandler.SFDX_ALIASES_FILENAME);
-        fs_1.fs.writeJson(aliasesFilePath, { orgs: latest[types_1.SfInfoKeys.ALIASES] });
+        await fs.promises.writeFile(aliasesFilePath, JSON.stringify({ orgs: latest[types_1.SfInfoKeys.ALIASES] }, null, 2));
     }
 }
 exports.AliasesHandler = AliasesHandler;

package/lib/lifecycleEvents.js

@@ -170,7 +170,7 @@ class Lifecycle {
      */
     async emit(eventName, data) {
         const listeners = this.getListeners(eventName);
-        if (listeners.length === 0) {
+        if (listeners.length === 0 && eventName !== Lifecycle.warningEventName) {
             this.debug(`A lifecycle event with the name ${eventName} does not exist. An event must be registered before it can be emitted.`);
         }
         else {

package/lib/logger.d.ts

@@ -174,7 +174,7 @@ export declare class Logger {
      *
      * @param optionsOrName A set of `LoggerOptions` or name to use with the default options.
      *
-     * **Throws** *{@link SfdxError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
+     * **Throws** *{@link SfError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
      * `Logger`.
      */
     constructor(optionsOrName: LoggerOptions | string);
@@ -211,7 +211,7 @@ export declare class Logger {
      *
      * @param {string} levelName The level name to convert to a `LoggerLevel` enum value.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
      * @see {@Link LoggerLevel}
      */
     static getLevelByName(levelName: string): LoggerLevelValue;
@@ -249,7 +249,7 @@ export declare class Logger {
      *
      * @param {LoggerLevelValue} [level] The logger level.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
      * was invalid.
      *
      * ```

package/lib/logger.js

@@ -11,15 +11,16 @@ const events_1 = require("events");
 const os = require("os");
 const path = require("path");
 const stream_1 = require("stream");
+const fs = require("fs");
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const Bunyan = require("@salesforce/bunyan");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const Debug = require("debug");
+const mkdirp = require("mkdirp");
 const global_1 = require("./global");
-const sfdxError_1 = require("./sfdxError");
-const fs_1 = require("./util/fs");
+const sfError_1 = require("./sfError");
 /**
  * Standard `Logger` levels.
  *
@@ -69,7 +70,7 @@ class Logger {
      *
      * @param optionsOrName A set of `LoggerOptions` or name to use with the default options.
      *
-     * **Throws** *{@link SfdxError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
+     * **Throws** *{@link SfError}{ name: 'RedundantRootLoggerError' }* More than one attempt is made to construct the root
      * `Logger`.
      */
     constructor(optionsOrName) {
@@ -103,7 +104,7 @@ class Logger {
             options = optionsOrName;
         }
         if (Logger.rootLogger && options.name === Logger.ROOT_NAME) {
-            throw new sfdxError_1.SfdxError('Can not create another root logger.', 'RedundantRootLoggerError');
+            throw new sfError_1.SfError('Can not create another root logger.', 'RedundantRootLoggerError');
         }
         // Inspect format to know what logging format to use then delete from options to
         // ensure it doesn't conflict with Bunyan.
@@ -199,13 +200,13 @@ class Logger {
      *
      * @param {string} levelName The level name to convert to a `LoggerLevel` enum value.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* The level name was not case-insensitively recognized as a valid `LoggerLevel` value.
      * @see {@Link LoggerLevel}
      */
     static getLevelByName(levelName) {
         levelName = levelName.toUpperCase();
         if (!(0, ts_types_1.isKeyOf)(LoggerLevel, levelName)) {
-            throw new sfdxError_1.SfdxError(`Invalid log level "${levelName}".`, 'UnrecognizedLoggerLevelNameError');
+            throw new sfError_1.SfError(`Invalid log level "${levelName}".`, 'UnrecognizedLoggerLevelNameError');
         }
         return LoggerLevel[levelName];
     }
@@ -229,22 +230,22 @@ class Logger {
     async addLogFileStream(logFile) {
         try {
             // Check if we have write access to the log file (i.e., we created it already)
-            await fs_1.fs.access(logFile, fs_1.fs.constants.W_OK);
+            await fs.promises.access(logFile, fs.constants.W_OK);
         }
         catch (err1) {
             try {
-                await fs_1.fs.mkdirp(path.dirname(logFile), {
-                    mode: fs_1.fs.DEFAULT_USER_DIR_MODE,
+                await mkdirp(path.dirname(logFile), {
+                    mode: '700',
                 });
             }
             catch (err2) {
                 // noop; directory exists already
             }
             try {
-                await fs_1.fs.writeFile(logFile, '', { mode: fs_1.fs.DEFAULT_USER_FILE_MODE });
+                await fs.promises.writeFile(logFile, '', { mode: '600' });
             }
             catch (err3) {
-                throw sfdxError_1.SfdxError.wrap(err3);
+                throw sfError_1.SfError.wrap(err3);
             }
         }
         // avoid multiple streams to same log file
@@ -269,22 +270,22 @@ class Logger {
     addLogFileStreamSync(logFile) {
         try {
             // Check if we have write access to the log file (i.e., we created it already)
-            fs_1.fs.accessSync(logFile, fs_1.fs.constants.W_OK);
+            fs.accessSync(logFile, fs.constants.W_OK);
         }
         catch (err1) {
             try {
-                fs_1.fs.mkdirpSync(path.dirname(logFile), {
-                    mode: fs_1.fs.DEFAULT_USER_DIR_MODE,
+                mkdirp.sync(path.dirname(logFile), {
+                    mode: '700',
                 });
             }
             catch (err2) {
                 // noop; directory exists already
             }
             try {
-                fs_1.fs.writeFileSync(logFile, '', { mode: fs_1.fs.DEFAULT_USER_FILE_MODE });
+                fs.writeFileSync(logFile, '', { mode: '600' });
             }
             catch (err3) {
-                throw sfdxError_1.SfdxError.wrap(err3);
+                throw sfError_1.SfError.wrap(err3);
             }
         }
         // avoid multiple streams to same log file
@@ -320,7 +321,7 @@ class Logger {
      *
      * @param {LoggerLevelValue} [level] The logger level.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
+     * **Throws** *{@link SfError}{ name: 'UnrecognizedLoggerLevelNameError' }* A value of `level` read from `SFDX_LOG_LEVEL`
      * was invalid.
      *
      * ```
@@ -401,7 +402,7 @@ class Logger {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             this.bunyan.streams.forEach(async (stream) => {
                 if (stream.type === 'file') {
-                    content += await fs_1.fs.readFile(stream.path, 'utf8');
+                    content += await fs.promises.readFile(stream.path, 'utf8');
                 }
             });
             return content;
@@ -453,7 +454,7 @@ class Logger {
      */
     child(name, fields = {}) {
         if (!name) {
-            throw new sfdxError_1.SfdxError('LoggerNameRequired');
+            throw new sfError_1.SfError('LoggerNameRequired');
         }
         fields.log = name;
         const child = new Logger(name);

package/lib/messages.d.ts

@@ -1,6 +1,11 @@
 import { AnyJson } from '@salesforce/ts-types';
-import { SfdxError } from './sfdxError';
+import { SfError } from './sfError';
 export declare type Tokens = Array<string | boolean | number | null | undefined>;
+export declare type StructuredMessage = {
+    message: string;
+    name: string;
+    actions?: string[];
+};
 /**
  * A loader function to return messages.
  *
@@ -244,9 +249,43 @@ export declare class Messages<T extends string> {
      * @param key The key of the error message.
      * @param tokens The error message tokens.
      * @param actionTokens The action messages tokens.
-     * @param exitCodeOrCause The exit code which will be used by SfdxCommand or he underlying error that caused this error to be raised.
+     * @param exitCodeOrCause The exit code which will be used by SfdxCommand or the underlying error that caused this error to be raised.
      * @param cause The underlying error that caused this error to be raised.
      */
-    createError(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfdxError;
+    createError(key: T, tokens?: Tokens, actionTokens?: Tokens, exitCodeOrCause?: number | Error, cause?: Error): SfError;
+    /**
+     * Convenience method to create warning using message labels.
+     *
+     * `warning.name` will be the upper-cased key, remove prefixed `warning.` and will always end in Warning.
+     * `warning.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the warning message.
+     * @param tokens The warning message tokens.
+     * @param actionTokens The action messages tokens.
+     */
+    createWarning(key: T, tokens?: Tokens, actionTokens?: Tokens): StructuredMessage;
+    /**
+     * Convenience method to create info using message labels.
+     *
+     * `info.name` will be the upper-cased key, remove prefixed `info.` and will always end in Info.
+     * `info.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param key The key of the warning message.
+     * @param tokens The warning message tokens.
+     * @param actionTokens The action messages tokens.
+     */
+    createInfo(key: T, tokens?: Tokens, actionTokens?: Tokens): StructuredMessage;
+    /**
+     * Formats message contents given a message type, key, tokens and actions tokens
+     *
+     * `<type>.name` will be the upper-cased key, remove prefixed `<type>.` and will always end in 'Error | Warning | Info.
+     * `<type>.actions` will be loaded using `${key}.actions` if available.
+     *
+     * @param type The type of the message set must 'error' | 'warning' | 'info'.
+     * @param key The key of the warning message.
+     * @param tokens The warning message tokens.
+     * @param actionTokens The action messages tokens.
+     */
+    private formatMessageContents;
     private getMessageWithMap;
 }