@salesforce/core 3.13.1 → 3.15.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.15.1](https://github.com/forcedotcom/sfdx-core/compare/v3.15.0...v3.15.1) (2022-04-28)
+
+### Bug Fixes
+
+- replace jsen ([664da58](https://github.com/forcedotcom/sfdx-core/commit/664da58cbe06019465ccf70ed17dfafb2425e06b))
+
+## [3.15.0](https://github.com/forcedotcom/sfdx-core/compare/v3.14.0...v3.15.0) (2022-04-26)
+
+### Features
+
+- core changes to support create scratch and sandboxes ([#570](https://github.com/forcedotcom/sfdx-core/issues/570)) ([916eeb1](https://github.com/forcedotcom/sfdx-core/commit/916eeb1f96bebd5dce255f13c838ac0b10bf5b96))
+
+## [3.14.0](https://github.com/forcedotcom/sfdx-core/compare/v3.13.1...v3.14.0) (2022-04-25)
+
+### Features
+
+- add SfdxConfigAggregator ([#563](https://github.com/forcedotcom/sfdx-core/issues/563)) ([cd4debd](https://github.com/forcedotcom/sfdx-core/commit/cd4debdc99046580090b5d21bbd9da9030822d4a))
+
 ### [3.13.1](https://github.com/forcedotcom/sfdx-core/compare/v3.13.0...v3.13.1) (2022-04-21)
 
 ### Bug Fixes

package/lib/config/config.d.ts

@@ -1,4 +1,4 @@
-import { JsonPrimitive } from '@salesforce/ts-types';
+import { JsonPrimitive, Nullable } from '@salesforce/ts-types';
 import { OrgConfigProperties } from '../org/orgConfigProperties';
 import { ConfigFile } from './configFile';
 import { ConfigContents, ConfigValue } from './configStore';
@@ -240,6 +240,7 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      * Clear all the configured properties both local and global.
      */
     static clear(): Promise<void>;
+    static getPropertyConfigMeta(propertyName: string): Nullable<ConfigPropertyMeta>;
     private static propertyConfigMap;
     /**
      * Read, assign, and return the config contents.
@@ -298,3 +299,24 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      */
     private cryptProperties;
 }
+export declare class SfdxConfig {
+    private options;
+    private config;
+    private sfdxPath;
+    constructor(options: ConfigFile.Options, config: Config);
+    /**
+     * If Global.SFDX_INTEROPERABILITY is enabled, merge the sfdx config into the sf config
+     */
+    merge(config: ConfigProperties): ConfigProperties | undefined;
+    write(config?: import("@salesforce/ts-types").JsonMap): Promise<void>;
+    private readSync;
+    private getSfdxPath;
+    /**
+     * If toNew is specified: migrate all deprecated configs with a newKey to the newKey.
+     * - For example, defaultusername will be renamed to target-org.
+     *
+     * If toOld is specified: migrate all deprecated configs back to their original key.
+     * - For example, target-org will be renamed to defaultusername.
+     */
+    private translate;
+}

package/lib/config/config.js

@@ -6,7 +6,7 @@
  * 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.Config = exports.SfProperty = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.SF_ALLOWED_PROPERTIES = exports.SfConfigProperties = void 0;
+exports.SfdxConfig = exports.Config = exports.SfProperty = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.SF_ALLOWED_PROPERTIES = exports.SfConfigProperties = void 0;
 const path_1 = require("path");
 const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
@@ -316,6 +316,13 @@ class Config extends configFile_1.ConfigFile {
         localConfig.clear();
         await localConfig.write();
     }
+    static getPropertyConfigMeta(propertyName) {
+        const prop = Config.propertyConfigMap()[propertyName];
+        if ((prop === null || prop === void 0 ? void 0 : prop.deprecated) && (prop === null || prop === void 0 ? void 0 : prop.newKey)) {
+            return Config.propertyConfigMap()[prop.newKey];
+        }
+        return prop;
+    }
     static propertyConfigMap() {
         return (0, kit_1.keyBy)(Config.allowedProperties, 'key');
     }
@@ -354,7 +361,7 @@ class Config extends configFile_1.ConfigFile {
         await this.cryptProperties(true);
         await super.write();
         if (global_1.Global.SFDX_INTEROPERABILITY)
-            await this.sfdxConfig.writeSync();
+            await this.sfdxConfig.write();
         await this.cryptProperties(false);
         return this.getContents();
     }
@@ -499,25 +506,25 @@ class SfdxConfig {
         }
         return Object.assign(config, sfdxConfig);
     }
-    readSync() {
+    async write(config = this.config.toObject()) {
         try {
-            const contents = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getSfdxPath(), 'utf8'));
-            return this.normalize(contents, 'toNew');
+            const translated = this.translate(config, 'toOld');
+            const sfdxPath = this.getSfdxPath();
+            await mkdirp((0, path_1.dirname)(sfdxPath));
+            await fs.promises.writeFile(sfdxPath, JSON.stringify(translated, null, 2));
         }
         catch (error) {
             /* Do nothing */
-            return {};
         }
     }
-    async writeSync(config = this.config.toObject()) {
+    readSync() {
         try {
-            const sfdxPath = this.getSfdxPath();
-            await mkdirp((0, path_1.dirname)(sfdxPath));
-            const mapped = this.normalize(config, 'toOld');
-            await fs.promises.writeFile(sfdxPath, JSON.stringify(mapped, null, 2));
+            const contents = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getSfdxPath(), 'utf8'));
+            return this.translate(contents, 'toNew');
         }
         catch (error) {
             /* Do nothing */
+            return {};
         }
     }
     getSfdxPath() {
@@ -544,22 +551,23 @@ class SfdxConfig {
      * If toOld is specified: migrate all deprecated configs back to their original key.
      * - For example, target-org will be renamed to defaultusername.
      */
-    normalize(contents, direction) {
+    translate(contents, direction) {
         var _a;
-        const mapped = {};
+        const translated = {};
         for (const [key, value] of Object.entries(contents)) {
             const propConfig = direction === 'toNew'
                 ? this.config.getPropertyConfig(key)
                 : (_a = Config.getAllowedProperties().find((c) => c.newKey === key)) !== null && _a !== void 0 ? _a : {};
             if (propConfig.deprecated && propConfig.newKey) {
                 const normalizedKey = direction === 'toNew' ? propConfig.newKey : propConfig.key;
-                mapped[normalizedKey] = value;
+                translated[normalizedKey] = value;
             }
             else {
-                mapped[key] = value;
+                translated[key] = value;
             }
         }
-        return mapped;
+        return translated;
     }
 }
+exports.SfdxConfig = SfdxConfig;
 //# sourceMappingURL=config.js.map

package/lib/config/configAggregator.d.ts

@@ -40,11 +40,11 @@ export interface ConfigInfo {
 }
 /**
  * Aggregate global and local project config files, as well as environment variables for
- * `sfdx-config.json`. The resolution happens in the following bottom-up order:
+ * `config.json`. The resolution happens in the following bottom-up order:
  *
- * 1. Environment variables  (`SFDX_LOG_LEVEL`)
- * 1. Workspace settings  (`<workspace-root>/.sfdx/sfdx-config.json`)
- * 1. Global settings  (`$HOME/.sfdx/sfdx-config.json`)
+ * 1. Environment variables  (`SF_LOG_LEVEL`)
+ * 1. Workspace settings  (`<workspace-root>/.sf/config.json`)
+ * 1. Global settings  (`$HOME/.sf/config.json`)
  *
  * Use {@link ConfigAggregator.create} to instantiate the aggregator.
  *
@@ -67,12 +67,6 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      * @ignore
      */
     constructor(options?: JsonMap);
-    /**
-     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
-     * the **encrypted** config values. Encrypted config values need to be resolved
-     * asynchronously by calling {@link ConfigAggregator.reload}
-     */
-    static getInstance<P, T extends AsyncOptionalCreatable<P>>(this: new () => T): T;
     static create<P, T extends AsyncOptionalCreatable<P>>(this: new (options?: P) => T, options?: P): Promise<T>;
     /**
      * Get the info for a given key. If the ConfigAggregator was not asynchronously created OR
@@ -81,6 +75,12 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      * @param key The config key.
      */
     static getValue(key: string): ConfigInfo;
+    /**
+     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
+     * the **encrypted** config values. Encrypted config values need to be resolved
+     * asynchronously by calling {@link ConfigAggregator.reload}
+     */
+    private static getInstance;
     /**
      * Initialize this instances async dependencies.
      */
@@ -123,9 +123,9 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      * Get a resolved file path or environment variable name of the property.
      *
      * For example, `getPath('logLevel')` will return:
-     * 1. `$SFDX_LOG_LEVEL` if resolved to an environment variable.
-     * 1. `./.sfdx/sfdx-config.json` if resolved to the local config.
-     * 1. `~/.sfdx/sfdx-config.json` if resolved to the global config.
+     * 1. `$SF_LOG_LEVEL` if resolved to an environment variable.
+     * 1. `./.sf/config.json` if resolved to the local config.
+     * 1. `~/.sf/config.json` if resolved to the global config.
      * 1. `undefined`, if not resolved.
      *
      * **Note:** that the path returned may be the absolute path instead of
@@ -140,7 +140,7 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      * ```
      * > console.log(aggregator.getConfigInfo());
      * [
-     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SFDX_LOG_LEVEL'}
+     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SF_LOG_LEVEL'}
      *     { key: 'target-org', val: '<username>', location: 'Local', path: './.sf/config.json'}
      * ]
      * ```
@@ -170,6 +170,16 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      * Add an allowed config property.
      */
     addAllowedProperties(configMetas: ConfigPropertyMeta | ConfigPropertyMeta[]): void;
+    /**
+     * Set the allowed properties.
+     *
+     * @param properties The properties to set.
+     */
+    protected setAllowedProperties(properties: ConfigPropertyMeta[]): void;
+    /**
+     * Get the allowed properties.
+     */
+    protected getAllowedProperties(): ConfigPropertyMeta[];
     /**
      * Loads all the properties and aggregates them according to location.
      */
@@ -179,16 +189,6 @@ export declare class ConfigAggregator extends AsyncOptionalCreatable<JsonMap> {
      */
     private loadPropertiesSync;
     private resolveProperties;
-    /**
-     * Get the allowed properties.
-     */
-    private getAllowedProperties;
-    /**
-     * Set the allowed properties.
-     *
-     * @param properties The properties to set.
-     */
-    private setAllowedProperties;
 }
 export declare namespace ConfigAggregator {
     /**
@@ -209,3 +209,16 @@ export declare namespace ConfigAggregator {
         ENVIRONMENT = "Environment"
     }
 }
+/**
+ * A ConfigAggregator that will work with deprecated config vars (e.g. defaultusername, apiVersion).
+ * We do NOT recommend using this class unless you absolutelty have to.
+ */
+export declare class SfdxConfigAggregator extends ConfigAggregator {
+    getPropertyMeta(key: string): ConfigPropertyMeta;
+    getPropertyValue<T extends AnyJson>(key: string): Optional<T>;
+    getInfo(key: string): ConfigInfo;
+    getLocation(key: string): Optional<ConfigAggregator.Location>;
+    getPath(key: string): Optional<string>;
+    getConfigInfo(): ConfigInfo[];
+    private translate;
+}

package/lib/config/configAggregator.js

@@ -6,23 +6,21 @@
  * 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.ConfigAggregator = void 0;
+exports.SfdxConfigAggregator = exports.ConfigAggregator = void 0;
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
-const change_case_1 = require("change-case");
 const messages_1 = require("../messages");
 const envVars_1 = require("./envVars");
 const config_1 = require("./config");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'config', ['unknownConfigKey', 'deprecatedConfigKey']);
-const propertyToEnvName = (property, prefix = 'SFDX_') => `${prefix || ''}${(0, change_case_1.snakeCase)(property).toUpperCase()}`;
 /**
  * Aggregate global and local project config files, as well as environment variables for
- * `sfdx-config.json`. The resolution happens in the following bottom-up order:
+ * `config.json`. The resolution happens in the following bottom-up order:
  *
- * 1. Environment variables  (`SFDX_LOG_LEVEL`)
- * 1. Workspace settings  (`<workspace-root>/.sfdx/sfdx-config.json`)
- * 1. Global settings  (`$HOME/.sfdx/sfdx-config.json`)
+ * 1. Environment variables  (`SF_LOG_LEVEL`)
+ * 1. Workspace settings  (`<workspace-root>/.sf/config.json`)
+ * 1. Global settings  (`$HOME/.sf/config.json`)
  *
  * Use {@link ConfigAggregator.create} to instantiate the aggregator.
  *
@@ -55,20 +53,6 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     get config() {
         return this.resolveProperties(this.globalConfig.getContents(), this.localConfig && this.localConfig.getContents());
     }
-    /**
-     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
-     * the **encrypted** config values. Encrypted config values need to be resolved
-     * asynchronously by calling {@link ConfigAggregator.reload}
-     */
-    // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
-    // We really don't want ConfigAggregator extended but typescript doesn't support a final.
-    static getInstance() {
-        if (!ConfigAggregator.instance) {
-            ConfigAggregator.instance = new this();
-            ConfigAggregator.instance.loadPropertiesSync();
-        }
-        return ConfigAggregator.instance;
-    }
     // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
     // We really don't want ConfigAggregator extended but typescript doesn't support a final.
     static async create(options) {
@@ -91,6 +75,20 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
     static getValue(key) {
         return this.getInstance().getInfo(key);
     }
+    /**
+     * Get the static ConfigAggregator instance. If one doesn't exist, one will be created with
+     * the **encrypted** config values. Encrypted config values need to be resolved
+     * asynchronously by calling {@link ConfigAggregator.reload}
+     */
+    // Use typing from AsyncOptionalCreatable to support extending ConfigAggregator.
+    // We really don't want ConfigAggregator extended but typescript doesn't support a final.
+    static getInstance() {
+        if (!ConfigAggregator.instance) {
+            ConfigAggregator.instance = new this();
+            ConfigAggregator.instance.loadPropertiesSync();
+        }
+        return ConfigAggregator.instance;
+    }
     /**
      * Initialize this instances async dependencies.
      */
@@ -106,7 +104,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      */
     getPropertyValue(key) {
         if (this.getAllowedProperties().some((element) => key === element.key)) {
-            return this.getConfig()[key];
+            return this.getConfig()[key] || this.getEnvVars().get(key);
         }
         else {
             throw messages.createError('unknownConfigKey', [key]);
@@ -177,9 +175,9 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * Get a resolved file path or environment variable name of the property.
      *
      * For example, `getPath('logLevel')` will return:
-     * 1. `$SFDX_LOG_LEVEL` if resolved to an environment variable.
-     * 1. `./.sfdx/sfdx-config.json` if resolved to the local config.
-     * 1. `~/.sfdx/sfdx-config.json` if resolved to the global config.
+     * 1. `$SF_LOG_LEVEL` if resolved to an environment variable.
+     * 1. `./.sf/config.json` if resolved to the local config.
+     * 1. `~/.sf/config.json` if resolved to the global config.
      * 1. `undefined`, if not resolved.
      *
      * **Note:** that the path returned may be the absolute path instead of
@@ -189,7 +187,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      */
     getPath(key) {
         if (this.envVars.getString(key) != null) {
-            return `$${propertyToEnvName(key)}`;
+            return `$${this.envVars.propertyToEnvName(key)}`;
         }
         if (this.localConfig && this.localConfig.getContents()[key] != null) {
             return this.localConfig.getPath();
@@ -204,7 +202,7 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
      * ```
      * > console.log(aggregator.getConfigInfo());
      * [
-     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SFDX_LOG_LEVEL'}
+     *     { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SF_LOG_LEVEL'}
      *     { key: 'target-org', val: '<username>', location: 'Local', path: './.sf/config.json'}
      * ]
      * ```
@@ -258,6 +256,20 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
             this.allowedProperties.push(configMetas);
         }
     }
+    /**
+     * Set the allowed properties.
+     *
+     * @param properties The properties to set.
+     */
+    setAllowedProperties(properties) {
+        this.allowedProperties = properties;
+    }
+    /**
+     * Get the allowed properties.
+     */
+    getAllowedProperties() {
+        return this.allowedProperties;
+    }
     /**
      * Loads all the properties and aggregates them according to location.
      */
@@ -288,21 +300,51 @@ class ConfigAggregator extends kit_1.AsyncOptionalCreatable {
         const reduced = configs.filter(ts_types_1.isJsonMap).reduce((acc, el) => (0, kit_1.merge)(acc, el), json);
         return reduced;
     }
-    /**
-     * Get the allowed properties.
-     */
-    getAllowedProperties() {
-        return this.allowedProperties;
-    }
-    /**
-     * Set the allowed properties.
-     *
-     * @param properties The properties to set.
-     */
-    setAllowedProperties(properties) {
-        this.allowedProperties = properties;
-    }
 }
 exports.ConfigAggregator = ConfigAggregator;
 ConfigAggregator.encrypted = true;
+/**
+ * A ConfigAggregator that will work with deprecated config vars (e.g. defaultusername, apiVersion).
+ * We do NOT recommend using this class unless you absolutelty have to.
+ */
+class SfdxConfigAggregator extends ConfigAggregator {
+    getPropertyMeta(key) {
+        const match = this.getAllowedProperties().find((element) => key === element.key);
+        if ((match === null || match === void 0 ? void 0 : match.deprecated) && (match === null || match === void 0 ? void 0 : match.newKey)) {
+            return this.getPropertyMeta(match.newKey);
+        }
+        else if (match) {
+            return match;
+        }
+        else {
+            throw messages.createError('unknownConfigKey', [key]);
+        }
+    }
+    getPropertyValue(key) {
+        return super.getPropertyValue(this.translate(key));
+    }
+    getInfo(key) {
+        return super.getInfo(this.translate(key));
+    }
+    getLocation(key) {
+        return super.getLocation(this.translate(key));
+    }
+    getPath(key) {
+        return super.getPath(this.translate(key));
+    }
+    getConfigInfo() {
+        return super.getConfigInfo().map((c) => {
+            c.key = this.translate(c.key, 'toOld');
+            return c;
+        });
+    }
+    translate(key, direction = 'toNew') {
+        var _a;
+        const propConfig = direction === 'toNew'
+            ? this.getPropertyMeta(key)
+            : (_a = config_1.Config.getAllowedProperties().find((c) => c.newKey === key)) !== null && _a !== void 0 ? _a : {};
+        return propConfig.key || key;
+    }
+}
+exports.SfdxConfigAggregator = SfdxConfigAggregator;
 //# sourceMappingURL=configAggregator.js.map

package/lib/config/envVars.js

@@ -260,11 +260,11 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SF_TARGET_ORG]: {
         description: getMessage(EnvironmentVariable.SF_TARGET_ORG),
-        synonymOf: null,
+        synonymOf: EnvironmentVariable.SFDX_DEFAULTUSERNAME,
     },
     [EnvironmentVariable.SF_TARGET_DEV_HUB]: {
         description: getMessage(EnvironmentVariable.SF_TARGET_DEV_HUB),
-        synonymOf: null,
+        synonymOf: EnvironmentVariable.SFDX_DEFAULTDEVHUBUSERNAME,
     },
     // sf vars
     [EnvironmentVariable.SF_ACCESS_TOKEN]: {
@@ -273,7 +273,7 @@ exports.SUPPORTED_ENV_VARS = {
     },
     [EnvironmentVariable.SF_ORG_API_VERSION]: {
         description: getMessage(EnvironmentVariable.SF_ORG_API_VERSION),
-        synonymOf: null,
+        synonymOf: EnvironmentVariable.SFDX_API_VERSION,
     },
     [EnvironmentVariable.SF_AUDIENCE_URL]: {
         description: getMessage(EnvironmentVariable.SF_AUDIENCE_URL),

package/lib/config/sandboxProcessCache.d.ts

@@ -0,0 +1,15 @@
+import { SandboxProcessObject, SandboxRequest } from '../org';
+import { TTLConfig } from './ttlConfig';
+export declare type SandboxRequestCacheEntry = {
+    alias?: string;
+    setDefault: boolean;
+    prodOrgUsername: string;
+    sandboxProcessObject: Partial<SandboxProcessObject>;
+    sandboxRequest: Partial<SandboxRequest>;
+};
+export declare class SandboxRequestCache extends TTLConfig<TTLConfig.Options, SandboxRequestCacheEntry> {
+    static getDefaultOptions(): TTLConfig.Options;
+    static unset(key: string): Promise<void>;
+    static set(key: string, sandboxProcessObject: SandboxRequestCacheEntry): Promise<void>;
+    static getFileName(): string;
+}

package/lib/config/sandboxProcessCache.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SandboxRequestCache = void 0;
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const kit_1 = require("@salesforce/kit");
+const global_1 = require("../global");
+const ttlConfig_1 = require("./ttlConfig");
+class SandboxRequestCache extends ttlConfig_1.TTLConfig {
+    static getDefaultOptions() {
+        return {
+            isGlobal: true,
+            isState: true,
+            filename: SandboxRequestCache.getFileName(),
+            stateFolder: global_1.Global.SF_STATE_FOLDER,
+            ttl: kit_1.Duration.days(14),
+        };
+    }
+    static async unset(key) {
+        const cache = await SandboxRequestCache.create();
+        cache.unset(key);
+        await cache.write();
+    }
+    static async set(key, sandboxProcessObject) {
+        const cache = await SandboxRequestCache.create();
+        cache.set(key, sandboxProcessObject);
+        await cache.write();
+    }
+    static getFileName() {
+        return 'sandbox-create-cache.json';
+    }
+}
+exports.SandboxRequestCache = SandboxRequestCache;
+//# sourceMappingURL=sandboxProcessCache.js.map

package/lib/exported.d.ts

@@ -7,7 +7,8 @@ export { GlobalInfo, SfEntry, SfInfo, SfInfoKeys, SfOrg, SfOrgs, SfToken, SfToke
 export { DeviceOauthService, DeviceCodeResponse, DeviceCodePollingResponse } from './deviceOauthService';
 export { OrgUsersConfig } from './config/orgUsersConfig';
 export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SfConfigProperties, SFDX_ALLOWED_PROPERTIES, SF_ALLOWED_PROPERTIES, } from './config/config';
-export { ConfigInfo, ConfigAggregator } from './config/configAggregator';
+export { SandboxRequestCacheEntry, SandboxRequestCache } from './config/sandboxProcessCache';
+export { ConfigInfo, ConfigAggregator, SfdxConfigAggregator } from './config/configAggregator';
 export { AuthFields, AuthInfo, AuthSideEffects, OrgAuthorization } from './org/authInfo';
 export { AuthRemover } from './org/authRemover';
 export { Connection, SFDX_HTTP_HEADERS } from './org/connection';
@@ -18,7 +19,7 @@ export { SfdcUrl } from './util/sfdcUrl';
 export { getJwtAudienceUrl } from './util/getJwtAudienceUrl';
 export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptions, LoggerStream, Logger, } from './logger';
 export { Messages, StructuredMessage } from './messages';
-export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
+export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, ResumeSandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
 export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
 export { PackageDir, NamedPackageDir, PackageDirDependency, SfProject, SfProjectJson, SfdxProject, SfdxProjectJson, } from './sfProject';
 export { SchemaPrinter } from './schema/printer';
@@ -29,8 +30,9 @@ export { CometClient, CometSubscription, StreamingClient, StatusResult } from '.
 export { MyDomainResolver } from './status/myDomainResolver';
 export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user';
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
-export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
+export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate, scratchOrgResume, } from './org/scratchOrgCreate';
 export { ScratchOrgInfo } from './org/scratchOrgTypes';
 export { ScratchOrgLifecycleEvent, scratchOrgLifecycleEventName, scratchOrgLifecycleStages, } from './org/scratchOrgLifecycleEvents';
+export { ScratchOrgCache } from './org/scratchOrgCache';
 export * from './util/sfdc';
 export * from './util/sfdcUrl';

package/lib/exported.js

@@ -16,8 +16,8 @@ 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.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.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = 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.TTLConfig = exports.ConfigFile = void 0;
-exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.scratchOrgCreate = exports.PermissionSetAssignment = void 0;
+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.SfdxConfigAggregator = exports.ConfigAggregator = exports.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = 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.TTLConfig = exports.ConfigFile = void 0;
+exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.scratchOrgResume = exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -44,8 +44,11 @@ Object.defineProperty(exports, "SfdxPropertyKeys", { enumerable: true, get: func
 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; } });
+Object.defineProperty(exports, "SfdxConfigAggregator", { enumerable: true, get: function () { return configAggregator_1.SfdxConfigAggregator; } });
 var authInfo_1 = require("./org/authInfo");
 Object.defineProperty(exports, "AuthInfo", { enumerable: true, get: function () { return authInfo_1.AuthInfo; } });
 var authRemover_1 = require("./org/authRemover");
@@ -103,9 +106,12 @@ 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/sfdc"), exports);
 __exportStar(require("./util/sfdcUrl"), exports);

package/lib/globalInfo/accessors/sandboxAccessor.d.ts

@@ -0,0 +1,36 @@
+import { Nullable } from '@salesforce/ts-types';
+import { GlobalInfo } from '../globalInfoConfig';
+import { SfSandbox, SfSandboxes } from '../types';
+export declare class SandboxAccessor {
+    private globalInfo;
+    constructor(globalInfo: GlobalInfo);
+    /**
+     * Returns all the sandboxes (or all the sandboxes for a given prod org)
+     *
+     * @param entity entity as a string should be a production org username
+     * and when entity is a SfSandbox, the prod org entity.prodOrgUsername will
+     * used in the filter.
+     */
+    getAll(entity?: string | SfSandbox): SfSandboxes;
+    /**
+     * Returns the SfSandbox config entry that corresponds to the given
+     * sandbox org id if it exists
+     *
+     * @param sandboxOrgId the sandboxOrgId that corresponds to a sandbox
+     */
+    get(sandboxOrgId?: string): Nullable<SfSandbox>;
+    /**
+     * Returns true if the given sandbox org id exists
+     *
+     * @param sandboxOrgId the sandboxOrgId that corresponds to a sandbox
+     */
+    has(sandboxOrgId?: string): boolean;
+    /**
+     * Set an sandboxOrgId for the given sandbox entity
+     *
+     * @param sandboxOrgId the sandboxOrgId you want to set
+     * @param entity the sandbox entity
+     */
+    set(sandboxOrgId: string, entity: SfSandbox): void;
+    unset(sandboxOrgId: string): void;
+}