@salesforce/core 4.0.0 → 4.0.1

package/lib/exported.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -16,21 +20,20 @@ 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.scratchOrgCreate = 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.scratchOrgLifecycleEventName = exports.scratchOrgResume = exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfError = exports.SchemaPrinter = exports.SchemaValidator = 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.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.StateAggregator = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
+exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = void 0;
 const messages_1 = require("./messages");
-messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
 Object.defineProperty(exports, "ConfigFile", { enumerable: true, get: function () { return configFile_1.ConfigFile; } });
+var ttlConfig_1 = require("./config/ttlConfig");
+Object.defineProperty(exports, "TTLConfig", { enumerable: true, get: function () { return ttlConfig_1.TTLConfig; } });
 var envVars_1 = require("./config/envVars");
 Object.defineProperty(exports, "envVars", { enumerable: true, get: function () { return envVars_1.envVars; } });
 Object.defineProperty(exports, "EnvironmentVariable", { enumerable: true, get: function () { return envVars_1.EnvironmentVariable; } });
 Object.defineProperty(exports, "SUPPORTED_ENV_VARS", { enumerable: true, get: function () { return envVars_1.SUPPORTED_ENV_VARS; } });
 Object.defineProperty(exports, "EnvVars", { enumerable: true, get: function () { return envVars_1.EnvVars; } });
-var configStore_1 = require("./config/configStore");
-Object.defineProperty(exports, "BaseConfigStore", { enumerable: true, get: function () { return configStore_1.BaseConfigStore; } });
-var globalInfo_1 = require("./globalInfo");
-Object.defineProperty(exports, "GlobalInfo", { enumerable: true, get: function () { return globalInfo_1.GlobalInfo; } });
-Object.defineProperty(exports, "SfInfoKeys", { enumerable: true, get: function () { return globalInfo_1.SfInfoKeys; } });
+var stateAggregator_1 = require("./stateAggregator");
+Object.defineProperty(exports, "StateAggregator", { enumerable: true, get: function () { return stateAggregator_1.StateAggregator; } });
 var deviceOauthService_1 = require("./deviceOauthService");
 Object.defineProperty(exports, "DeviceOauthService", { enumerable: true, get: function () { return deviceOauthService_1.DeviceOauthService; } });
 var orgUsersConfig_1 = require("./config/orgUsersConfig");
@@ -38,7 +41,11 @@ Object.defineProperty(exports, "OrgUsersConfig", { enumerable: true, get: functi
 var config_1 = require("./config/config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
 Object.defineProperty(exports, "SfdxPropertyKeys", { enumerable: true, get: function () { return config_1.SfdxPropertyKeys; } });
+Object.defineProperty(exports, "SfConfigProperties", { enumerable: true, get: function () { return config_1.SfConfigProperties; } });
 Object.defineProperty(exports, "SFDX_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return config_1.SFDX_ALLOWED_PROPERTIES; } });
+Object.defineProperty(exports, "SF_ALLOWED_PROPERTIES", { enumerable: true, get: function () { return config_1.SF_ALLOWED_PROPERTIES; } });
+var sandboxProcessCache_1 = require("./config/sandboxProcessCache");
+Object.defineProperty(exports, "SandboxRequestCache", { enumerable: true, get: function () { return sandboxProcessCache_1.SandboxRequestCache; } });
 var configAggregator_1 = require("./config/configAggregator");
 Object.defineProperty(exports, "ConfigAggregator", { enumerable: true, get: function () { return configAggregator_1.ConfigAggregator; } });
 var authInfo_1 = require("./org/authInfo");
@@ -71,15 +78,15 @@ 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 printer_1 = require("./schema/printer");
-Object.defineProperty(exports, "SchemaPrinter", { enumerable: true, get: function () { return printer_1.SchemaPrinter; } });
+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; } });
 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 printer_1 = require("./schema/printer");
+Object.defineProperty(exports, "SchemaPrinter", { enumerable: true, get: function () { return printer_1.SchemaPrinter; } });
+var sfError_1 = require("./sfError");
+Object.defineProperty(exports, "SfError", { enumerable: true, get: function () { return sfError_1.SfError; } });
 var pollingClient_1 = require("./status/pollingClient");
 Object.defineProperty(exports, "PollingClient", { enumerable: true, get: function () { return pollingClient_1.PollingClient; } });
 var streamingClient_1 = require("./status/streamingClient");
@@ -95,8 +102,13 @@ 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; } });
+Object.defineProperty(exports, "scratchOrgResume", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgResume; } });
+var scratchOrgLifecycleEvents_1 = require("./org/scratchOrgLifecycleEvents");
+Object.defineProperty(exports, "scratchOrgLifecycleEventName", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleEventName; } });
+Object.defineProperty(exports, "scratchOrgLifecycleStages", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleStages; } });
+var scratchOrgCache_1 = require("./org/scratchOrgCache");
+Object.defineProperty(exports, "ScratchOrgCache", { enumerable: true, get: function () { return scratchOrgCache_1.ScratchOrgCache; } });
 // 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.d.ts

@@ -28,18 +28,26 @@ export declare class Global {
      * The global folder in which sf state is stored.
      */
     static readonly SF_STATE_FOLDER = ".sf";
+    /**
+     * The preferred global folder in which state is stored.
+     */
+    static readonly STATE_FOLDER = ".sfdx";
     /**
      * The full system path to the global sfdx state folder.
      *
      * **See** {@link Global.SFDX_STATE_FOLDER}
      */
-    static readonly SFDX_DIR: string;
+    static get SFDX_DIR(): string;
     /**
      * The full system path to the global sf state folder.
      *
-     * **See** {@link Global.SF_STATE_FOLDER}
+     * **See**  {@link Global.SF_STATE_FOLDER}
+     */
+    static get SF_DIR(): string;
+    /**
+     * The full system path to the preferred global state folder
      */
-    static readonly SF_DIR: string;
+    static get DIR(): string;
     /**
      * The full system path to the global log file.
      */

package/lib/global.js

@@ -7,10 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Global = exports.Mode = void 0;
+const fs = require("fs");
 const os = require("os");
 const path = require("path");
 const kit_1 = require("@salesforce/kit");
-const fs_1 = require("./util/fs");
+const sfError_1 = require("./sfError");
 /**
  * Represents an environment mode.  Supports `production`, `development`, `demo`, and `test`
  * with the default mode being `production`.
@@ -28,6 +29,28 @@ var Mode;
  * Global constants, methods, and configuration.
  */
 class Global {
+    /**
+     * The full system path to the global sfdx state folder.
+     *
+     * **See** {@link Global.SFDX_STATE_FOLDER}
+     */
+    static get SFDX_DIR() {
+        return path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
+    }
+    /**
+     * The full system path to the global sf state folder.
+     *
+     * **See**  {@link Global.SF_STATE_FOLDER}
+     */
+    static get SF_DIR() {
+        return path.join(os.homedir(), Global.SF_STATE_FOLDER);
+    }
+    /**
+     * The full system path to the preferred global state folder
+     */
+    static get DIR() {
+        return path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
+    }
     /**
      * Gets the current mode environment variable as a {@link Mode} instance.
      *
@@ -46,7 +69,17 @@ 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);
+        try {
+            if (process.platform === 'win32') {
+                await fs.promises.mkdir(dirPath, { recursive: true });
+            }
+            else {
+                await fs.promises.mkdir(dirPath, { recursive: true, mode: 0o700 });
+            }
+        }
+        catch (error) {
+            throw new sfError_1.SfError(`Failed to create directory or set permissions for: ${dirPath}`);
+        }
     }
 }
 exports.Global = Global;
@@ -65,19 +98,13 @@ Global.SFDX_STATE_FOLDER = '.sfdx';
  */
 Global.SF_STATE_FOLDER = '.sf';
 /**
- * The full system path to the global sfdx state folder.
- *
- * **See** {@link Global.SFDX_STATE_FOLDER}
- */
-Global.SFDX_DIR = path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
-/**
- * The full system path to the global sf state folder.
- *
- * **See** {@link Global.SF_STATE_FOLDER}
+ * The preferred global folder in which state is stored.
  */
-Global.SF_DIR = path.join(os.homedir(), Global.SF_STATE_FOLDER);
+Global.STATE_FOLDER = Global.SFDX_STATE_FOLDER;
 /**
  * The full system path to the global log file.
  */
+// member ordering conflicts with the TS use-before-declaration error
+// eslint-disable-next-line @typescript-eslint/member-ordering
 Global.LOG_FILE_PATH = path.join(Global.SF_DIR, 'sf.log');
 //# sourceMappingURL=global.js.map

package/lib/lifecycleEvents.d.ts

@@ -1,5 +1,5 @@
 import { AnyJson } from '@salesforce/ts-types';
-declare type callback = (data: any) => Promise<void>;
+type callback = (data: any) => Promise<void>;
 /**
  * An asynchronous event listener and emitter that follows the singleton pattern. The singleton pattern allows lifecycle
  * events to be emitted from deep within a library and still be consumed by any other library or tool. It allows other

package/lib/lifecycleEvents.js

@@ -10,6 +10,7 @@ exports.Lifecycle = void 0;
 const Debug = require("debug");
 const semver_1 = require("semver");
 // needed for TS to not put everything inside /lib/src
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const pjson = require("../package.json");
 /**
@@ -85,6 +86,7 @@ class Lifecycle {
     /**
      * return the package.json version of the sfdx-core library.
      */
+    // eslint-disable-next-line class-methods-use-this
     version() {
         return pjson.version;
     }
@@ -175,6 +177,7 @@ class Lifecycle {
         }
         else {
             for (const cb of listeners) {
+                // eslint-disable-next-line no-await-in-loop
                 await cb(data);
             }
         }

package/lib/logger.d.ts

@@ -6,7 +6,7 @@ import { Writable } from 'stream';
  * @param input The input to be serialized.
  * **See** {@link https://github.com/forcedotcom/node-bunyan#serializers|Bunyan Serializers API}
  */
-export declare type Serializer = (input: unknown) => unknown;
+export type Serializer = (input: unknown) => unknown;
 /**
  * A collection of named `Serializer`s.
  *
@@ -62,7 +62,7 @@ export declare enum LoggerLevel {
     FATAL = 60
 }
 /**
- *  `Logger` format types.
+ * `Logger` format types.
  */
 export declare enum LoggerFormat {
     JSON = 0,
@@ -99,7 +99,7 @@ export interface LoggerStream {
 /**
  * Any numeric `Logger` level.
  */
-export declare type LoggerLevelValue = LoggerLevel | number;
+export type LoggerLevelValue = LoggerLevel | number;
 /**
  * A collection of named `FieldValue`s.
  *
@@ -111,7 +111,7 @@ export interface Fields {
 /**
  * All possible field value types.
  */
-export declare type FieldValue = string | number | boolean;
+export type FieldValue = string | number | boolean;
 /**
  * Log line interface
  */
@@ -163,6 +163,17 @@ export declare class Logger {
     static readonly LEVEL_NAMES: string[];
     private static readonly lifecycle;
     private static rootLogger?;
+    /**
+     * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+     * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationPeriod: string;
+    /**
+     * The number of backup rotated log files to keep.
+     * Example: '3' will have the base sf.log file, and the past 3 (period) log files.
+     * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationCount: number;
     /**
      * Whether debug is enabled for this Logger.
      */
@@ -174,7 +185,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 +222,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 +260,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.
      *
      * ```
@@ -299,8 +310,7 @@ export declare class Logger {
     /**
      * Close the logger, including any streams, and remove all listeners.
      *
-     * @param fn A function with signature `(stream: LoggerStream) => void` to call for each stream with
-     *                        the stream as an arg.
+     * @param fn A function with signature `(stream: LoggerStream) => void` to call for each stream with the stream as an arg.
      */
     close(fn?: (stream: LoggerStream) => void): void;
     /**