@salesforce/core 3.7.2 → 3.7.3

package/CHANGELOG.md

@@ -2,21 +2,21 @@
 
 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.7.2](https://github.com/forcedotcom/sfdx-core/compare/v3.7.1...v3.7.2) (2021-10-28)
+### [3.7.3](https://github.com/forcedotcom/sfdx-core/compare/v3.7.2...v3.7.3) (2021-12-16)
 
+### [3.7.2](https://github.com/forcedotcom/sfdx-core/compare/v3.7.1...v3.7.2) (2021-10-28)
 
 ### Bug Fixes
 
-* make @types/sfdx-faye a dependendcy ([683680b](https://github.com/forcedotcom/sfdx-core/commit/683680b8133048f71d25ef4df7aa24d9700dc5e8))
+- make @types/sfdx-faye a dependendcy ([683680b](https://github.com/forcedotcom/sfdx-core/commit/683680b8133048f71d25ef4df7aa24d9700dc5e8))
 
 ### [3.7.1](https://github.com/forcedotcom/sfdx-core/compare/v3.7.0...v3.7.1) (2021-10-28)
 
 ## [3.7.0](https://github.com/forcedotcom/sfdx-core/compare/v3.6.6...v3.7.0) (2021-10-12)
 
-
 ### Features
 
-* use jsforce v2 ([#457](https://github.com/forcedotcom/sfdx-core/issues/457)) ([4a9094e](https://github.com/forcedotcom/sfdx-core/commit/4a9094e958288cdcc6c69f5d87b10a70a437d8e9))
+- use jsforce v2 ([#457](https://github.com/forcedotcom/sfdx-core/issues/457)) ([4a9094e](https://github.com/forcedotcom/sfdx-core/commit/4a9094e958288cdcc6c69f5d87b10a70a437d8e9))
 
 ### [3.6.6](https://github.com/forcedotcom/sfdx-core/compare/v3.6.5...v3.6.6) (2021-10-08)
 
@@ -222,6 +222,81 @@ All notable changes to this project will be documented in this file. See [standa
 - add GlobalInfo config file ([#397](https://github.com/forcedotcom/sfdx-core/issues/397)) ([579998b](https://github.com/forcedotcom/sfdx-core/commit/579998b6ee70dbb9772e65896bbabf6d812aae23))
 - default to reading files from cache ([12b5930](https://github.com/forcedotcom/sfdx-core/commit/12b59301df96395c4edcbfb0816dbddd45af95db))
 
+### [2.33.1](https://github.com/forcedotcom/sfdx-core/compare/v2.33.0...v2.33.1) (2021-12-15)
+
+### Bug Fixes
+
+- faye doesn't use custom stuff passed it ([b1cefc7](https://github.com/forcedotcom/sfdx-core/commit/b1cefc76afde7f0dd56ed72b5539a47c118eef63))
+
+## [2.33.0](https://github.com/forcedotcom/sfdx-core/compare/v2.32.0...v2.33.0) (2021-12-14)
+
+### Features
+
+- sandbox creation ([314dcf1](https://github.com/forcedotcom/sfdx-core/commit/314dcf164d93bd0e3a5f4763a4dfcdde7d0cb14a))
+
+## [2.32.0](https://github.com/forcedotcom/sfdx-core/compare/v2.31.1...v2.32.0) (2021-12-14)
+
+### Features
+
+- switch sfdx-faye with faye ([a0545e5](https://github.com/forcedotcom/sfdx-core/commit/a0545e57d5041c97e499f284afbd7fcb16cf2247))
+
+### Bug Fixes
+
+- no maxquery warning when records.length is 0 ([758f912](https://github.com/forcedotcom/sfdx-core/commit/758f912a23bd3e9f8d4f854f3e07682dd4d4c4aa))
+
+### [2.31.1](https://github.com/forcedotcom/sfdx-core/compare/v2.31.0...v2.31.1) (2021-12-06)
+
+## [2.31.0](https://github.com/forcedotcom/sfdx-core/compare/v2.30.1...v2.31.0) (2021-11-30)
+
+### Features
+
+- bump version of jsforce ([7d89024](https://github.com/forcedotcom/sfdx-core/commit/7d89024f593968c031af22ac817efc26d00fcd54))
+
+### [2.30.1](https://github.com/forcedotcom/sfdx-core/compare/v2.30.0...v2.30.1) (2021-11-30)
+
+### Bug Fixes
+
+- better output for authUrl errors ([f3ec729](https://github.com/forcedotcom/sfdx-core/commit/f3ec7298bdbd3194d3d14bfea09f47f413669376))
+
+## [2.30.0](https://github.com/forcedotcom/sfdx-core/compare/v2.29.0...v2.30.0) (2021-11-25)
+
+### Features
+
+- delete scratch orgs and sandboxes ([#491](https://github.com/forcedotcom/sfdx-core/issues/491)) ([468c348](https://github.com/forcedotcom/sfdx-core/commit/468c348f0ecc69ddeea02927bf7a26ca660a86ca))
+
+## [2.29.0](https://github.com/forcedotcom/sfdx-core/compare/v2.28.4...v2.29.0) (2021-11-17)
+
+### Features
+
+- cleans up old listeners from upgraded instance ([e3f2d69](https://github.com/forcedotcom/sfdx-core/commit/e3f2d69ccd5c096d37addb1b982e19354175f11a))
+- use warnings instead of process in sfdx-core ([c1f7e98](https://github.com/forcedotcom/sfdx-core/commit/c1f7e98f6b19d57da1a2ee0cdf58e449079f0ee7))
+- warning and telemetry events ([80a8039](https://github.com/forcedotcom/sfdx-core/commit/80a8039e2f686d973ddbc24c9a2980fb93928d13))
+- warning and telemetry events ([a04b293](https://github.com/forcedotcom/sfdx-core/commit/a04b29355c8ca6c7e37e071ccc159aff5e5e9ca0))
+
+### Bug Fixes
+
+- transfer listeners when upgrading the global instance to newer version ([0a40831](https://github.com/forcedotcom/sfdx-core/commit/0a408317c132548771ced0fe196178d2e9c76232))
+
+### [2.28.4](https://github.com/forcedotcom/sfdx-core/compare/v2.28.3...v2.28.4) (2021-11-10)
+
+### Bug Fixes
+
+- bump jsforce types and run unit tests on Windows ([#485](https://github.com/forcedotcom/sfdx-core/issues/485)) ([3952c8f](https://github.com/forcedotcom/sfdx-core/commit/3952c8fe248531a0597477ed12240f611048caba))
+
+### [2.28.3](https://github.com/forcedotcom/sfdx-core/compare/v2.28.2...v2.28.3) (2021-11-08)
+
+### Bug Fixes
+
+- fix unit test ([d903c04](https://github.com/forcedotcom/sfdx-core/commit/d903c04e5f3e4f01fccb3f00b91560c443013ddf))
+- force new release ([124bb74](https://github.com/forcedotcom/sfdx-core/commit/124bb744c5ecc28cb8babf285c6d8c3032eb7ef6))
+- improve error message when providing an invalid username ([2ab4bbd](https://github.com/forcedotcom/sfdx-core/commit/2ab4bbdefd962283d88ccb735de88c88fe189d39))
+
+### [2.28.2](https://github.com/forcedotcom/sfdx-core/compare/v2.28.1...v2.28.2) (2021-10-13)
+
+### Bug Fixes
+
+- support for .mil sandboxes ([9ef35c7](https://github.com/forcedotcom/sfdx-core/commit/9ef35c7b1ef0fe974c3bd3b89b862a436e00f7d9))
+
 ### [2.28.1](https://github.com/forcedotcom/sfdx-core/compare/v2.28.0...v2.28.1) (2021-10-06)
 
 ### Bug Fixes

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018, Salesforce.com, Inc.
+Copyright (c) 2021, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/config/configStore.js

@@ -218,7 +218,6 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
     }
     // Allows extended classes the ability to override the set method. i.e. maybe they want
     // nested object set from kit.
-    // NOTE: Key and value must stay string and value to be reliably overwritten.
     setMethod(contents, key, value) {
         kit_1.set(contents, key, value);
     }

package/lib/exported.d.ts

@@ -17,7 +17,7 @@ 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 } from './org/org';
+export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, } from './org';
 export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
 export { PackageDir, NamedPackageDir, PackageDirDependency, SfdxProject, SfdxProjectJson } from './sfdxProject';
 export { SchemaPrinter } from './schema/printer';

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.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.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.ConfigFile = void 0;
+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.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.ConfigFile = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -62,8 +62,10 @@ Object.defineProperty(exports, "LoggerLevel", { enumerable: true, get: function
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
 var messages_2 = require("./messages");
 Object.defineProperty(exports, "Messages", { enumerable: true, get: function () { return messages_2.Messages; } });
-var org_1 = require("./org/org");
+var org_1 = require("./org");
 Object.defineProperty(exports, "Org", { enumerable: true, get: function () { return org_1.Org; } });
+Object.defineProperty(exports, "SandboxEvents", { enumerable: true, get: function () { return org_1.SandboxEvents; } });
+Object.defineProperty(exports, "OrgTypes", { enumerable: true, get: function () { return org_1.OrgTypes; } });
 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; } });

package/lib/lifecycleEvents.d.ts

@@ -16,16 +16,29 @@ declare type callback = (data: any) => Promise<void>;
  *
  * // Deep in the deploy code, fire the event for all libraries and plugins to hear.
  * Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed);
+ *
+ * // if you don't need to await anything
+ * use `void Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed)` ;
  * ```
  */
 export declare class Lifecycle {
-    private debug;
     private readonly listeners;
+    static readonly telemetryEventName = "telemetry";
+    static readonly warningEventName = "warning";
+    private debug;
     private constructor();
+    /**
+     * return the package.json version of the sfdx-core library.
+     */
+    static staticVersion(): string;
     /**
      * Retrieve the singleton instance of this class so that all listeners and emitters can interact from any library or tool
      */
     static getInstance(): Lifecycle;
+    /**
+     * return the package.json version of the sfdx-core library.
+     */
+    version(): string;
     /**
      * Remove all listeners for a given event
      *
@@ -38,6 +51,18 @@ export declare class Lifecycle {
      * @param eventName The name of the event to get listeners of
      */
     getListeners(eventName: string): callback[];
+    /**
+     * Create a listener for the `telemetry` event
+     *
+     * @param cb The callback function to run when the event is emitted
+     */
+    onTelemetry(cb: (data: Record<string, unknown>) => Promise<void>): void;
+    /**
+     * Create a listener for the `warning` event
+     *
+     * @param cb The callback function to run when the event is emitted
+     */
+    onWarning(cb: (warning: string) => Promise<void>): void;
     /**
      * Create a new listener for a given event
      *
@@ -45,6 +70,18 @@ export declare class Lifecycle {
      * @param cb The callback function to run when the event is emitted
      */
     on<T = AnyJson>(eventName: string, cb: (data: T) => Promise<void>): void;
+    /**
+     * Emit a `telemetry` event, causing all callback functions to be run in the order they were registered
+     *
+     * @param data The data to emit
+     */
+    emitTelemetry(data: AnyJson): Promise<void>;
+    /**
+     * Emit a `warning` event, causing all callback functions to be run in the order they were registered
+     *
+     * @param data The warning (string) to emit
+     */
+    emitWarning(warning: string): Promise<void>;
     /**
      * Emit a given event, causing all callback functions to be run in the order they were registered
      *

package/lib/lifecycleEvents.js

@@ -8,6 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Lifecycle = void 0;
 const Debug = require("debug");
+const semver_1 = require("semver");
+// needed for TS to not put everything inside /lib/src
+// @ts-ignore
+const pjson = require("../package.json");
 /**
  * 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
@@ -24,12 +28,21 @@ const Debug = require("debug");
  *
  * // Deep in the deploy code, fire the event for all libraries and plugins to hear.
  * Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed);
+ *
+ * // if you don't need to await anything
+ * use `void Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed)` ;
  * ```
  */
 class Lifecycle {
-    constructor() {
+    constructor(listeners = {}) {
+        this.listeners = listeners;
         this.debug = Debug(`sfdx:${this.constructor.name}`);
-        this.listeners = {};
+    }
+    /**
+     * return the package.json version of the sfdx-core library.
+     */
+    static staticVersion() {
+        return pjson.version;
     }
     /**
      * Retrieve the singleton instance of this class so that all listeners and emitters can interact from any library or tool
@@ -52,10 +65,29 @@ class Lifecycle {
         //
         // Nothing should EVER be removed, even across major versions.
         if (!global.salesforceCoreLifecycle) {
+            // it's not been loaded yet (basic singleton pattern)
             global.salesforceCoreLifecycle = new Lifecycle();
         }
+        else if (
+        // an older version was loaded that should be replaced
+        semver_1.compare(global.salesforceCoreLifecycle.version(), Lifecycle.staticVersion()) === -1) {
+            const oldInstance = global.salesforceCoreLifecycle;
+            // use the newer version and transfer any listeners from the old version
+            // object spread keeps them from being references
+            global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners });
+            // clean up any listeners on the old version
+            Object.keys(oldInstance.listeners).map((eventName) => {
+                oldInstance.removeAllListeners(eventName);
+            });
+        }
         return global.salesforceCoreLifecycle;
     }
+    /**
+     * return the package.json version of the sfdx-core library.
+     */
+    version() {
+        return pjson.version;
+    }
     /**
      * Remove all listeners for a given event
      *
@@ -79,6 +111,22 @@ class Lifecycle {
             return [];
         }
     }
+    /**
+     * Create a listener for the `telemetry` event
+     *
+     * @param cb The callback function to run when the event is emitted
+     */
+    onTelemetry(cb) {
+        this.on(Lifecycle.telemetryEventName, cb);
+    }
+    /**
+     * Create a listener for the `warning` event
+     *
+     * @param cb The callback function to run when the event is emitted
+     */
+    onWarning(cb) {
+        this.on(Lifecycle.warningEventName, cb);
+    }
     /**
      * Create a new listener for a given event
      *
@@ -93,6 +141,27 @@ class Lifecycle {
         listeners.push(cb);
         this.listeners[eventName] = listeners;
     }
+    /**
+     * Emit a `telemetry` event, causing all callback functions to be run in the order they were registered
+     *
+     * @param data The data to emit
+     */
+    async emitTelemetry(data) {
+        return this.emit(Lifecycle.telemetryEventName, data);
+    }
+    /**
+     * Emit a `warning` event, causing all callback functions to be run in the order they were registered
+     *
+     * @param data The warning (string) to emit
+     */
+    async emitWarning(warning) {
+        // if there are no listeners, warnings should go to the node process so they're not lost
+        // this also preserves behavior in UT where there's a spy on process.emitWarning
+        if (this.getListeners(Lifecycle.warningEventName).length === 0) {
+            process.emitWarning(warning);
+        }
+        return this.emit(Lifecycle.warningEventName, warning);
+    }
     /**
      * Emit a given event, causing all callback functions to be run in the order they were registered
      *
@@ -112,4 +181,6 @@ class Lifecycle {
     }
 }
 exports.Lifecycle = Lifecycle;
+Lifecycle.telemetryEventName = 'telemetry';
+Lifecycle.warningEventName = 'warning';
 //# sourceMappingURL=lifecycleEvents.js.map

package/lib/logger.js

@@ -344,6 +344,7 @@ class Logger {
     /**
      * Gets the underlying Bunyan logger.
      */
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     getBunyanLogger() {
         return this.bunyan;
     }

package/lib/org/authInfo.d.ts

@@ -165,12 +165,7 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * ```
      * @param sfdxAuthUrl
      */
-    static parseSfdxAuthUrl(sfdxAuthUrl: string): {
-        clientId: string;
-        clientSecret: string;
-        refreshToken: string;
-        loginUrl: string;
-    };
+    static parseSfdxAuthUrl(sfdxAuthUrl: string): Pick<AuthFields, 'clientId' | 'clientSecret' | 'refreshToken' | 'loginUrl'>;
     /**
      * Get the username.
      */
@@ -307,5 +302,6 @@ export declare namespace AuthInfo {
          * creation.
          */
         parentUsername?: string;
+        isDevHub?: boolean;
     }
 }

package/lib/org/authInfo.js

@@ -236,7 +236,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     static parseSfdxAuthUrl(sfdxAuthUrl) {
         const match = sfdxAuthUrl.match(/^force:\/\/([a-zA-Z0-9._-]+):([a-zA-Z0-9._-]*):([a-zA-Z0-9._-]+={0,2})@([a-zA-Z0-9._-]+)/);
         if (!match) {
-            throw new sfdxError_1.SfdxError('Invalid sfdx auth url. Must be in the format `force://<clientId>:<clientSecret>:<refreshToken>@<loginUrl>`. The instanceUrl must not have the protocol set.', 'INVALID_SFDX_AUTH_URL');
+            throw new sfdxError_1.SfdxError('Invalid SFDX auth URL. Must be in the format "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".  Note that the SFDX auth URL uses the "force" protocol, and not "http" or "https".  Also note that the "instanceUrl" inside the SFDX auth URL doesn\'t include the protocol ("https://").', 'INVALID_SFDX_AUTH_URL');
         }
         const [, clientId, clientSecret, refreshToken, loginUrl] = match;
         return {

package/lib/org/connection.js

@@ -20,6 +20,7 @@ const logger_1 = require("../logger");
 const sfdxError_1 = require("../sfdxError");
 const sfdc_1 = require("../util/sfdc");
 const messages_1 = require("../messages");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'connection', [
     'incorrectAPIVersionError',
@@ -104,7 +105,8 @@ class Connection extends jsforce_1.Connection {
                 conn.logger.debug(`The apiVersion ${baseOptions.version} was found from ${((_b = options.connectionOptions) === null || _b === void 0 ? void 0 : _b.version) ? 'passed in options' : 'config'}`);
             }
         }
-        catch (e) {
+        catch (err) {
+            const e = err;
             if (e.name === exports.DNS_ERROR_NAME) {
                 throw e;
             }
@@ -336,8 +338,8 @@ class Connection extends jsforce_1.Connection {
             maxFetch,
         });
         const query = await this.query(soql, options);
-        if (query.totalSize > query.records.length) {
-            process.emitWarning(`The query result is missing ${query.totalSize - query.records.length} records due to a ${maxFetch} record limit. Increase the number of records returned by setting the config value "maxQueryLimit" or the environment variable "SFDX_MAX_QUERY_LIMIT" to ${query.totalSize} or greater than ${maxFetch}.`);
+        if (query.records.length && query.totalSize > query.records.length) {
+            void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`The query result is missing ${query.totalSize - query.records.length} records due to a ${maxFetch} record limit. Increase the number of records returned by setting the config value "maxQueryLimit" or the environment variable "SFDX_MAX_QUERY_LIMIT" to ${query.totalSize} or greater than ${maxFetch}.`);
         }
         return query;
     }

package/lib/org/org.d.ts

@@ -1,4 +1,4 @@
-import { AsyncOptionalCreatable } from '@salesforce/kit';
+import { AsyncOptionalCreatable, Duration } from '@salesforce/kit';
 import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
 import { ConfigAggregator } from '../config/configAggregator';
 import { OrgUsersConfig } from '../config/orgUsersConfig';
@@ -12,6 +12,57 @@ export declare type OrganizationInformation = {
     TrialExpirationDate: string | null;
     NamespacePrefix: string | null;
 };
+export declare enum OrgTypes {
+    Scratch = "scratch",
+    Sandbox = "sandbox"
+}
+export interface StatusEvent {
+    sandboxProcessObj: SandboxProcessObject;
+    interval: number;
+    retries: number;
+    waitingOnAuth: boolean;
+}
+export interface ResultEvent {
+    sandboxProcessObj: SandboxProcessObject;
+    sandboxRes: SandboxUserAuthResponse;
+}
+export interface SandboxUserAuthRequest {
+    sandboxName: string;
+    clientId: string;
+    callbackUrl: string;
+}
+export declare enum SandboxEvents {
+    EVENT_STATUS = "status",
+    EVENT_ASYNC_RESULT = "asyncResult",
+    EVENT_RESULT = "result",
+    EVENT_AUTH = "auth"
+}
+export interface SandboxUserAuthResponse {
+    authUserName: string;
+    authCode: string;
+    instanceUrl: string;
+    loginUrl: string;
+}
+export interface SandboxProcessObject {
+    Id: string;
+    Status: string;
+    SandboxName: string;
+    SandboxInfoId: string;
+    LicenseType: string;
+    CreatedDate: string;
+    SandboxOrganization?: string;
+    CopyProgress?: number;
+    SourceId?: string;
+    Description?: string;
+    ApexClassId?: string;
+    EndDate?: string;
+}
+export declare type SandboxRequest = {
+    SandboxName: string;
+    LicenseType?: string;
+    SourceId?: string;
+    Description?: string;
+};
 /**
  * Provides a way to manage a locally authenticated Org.
  *
@@ -49,6 +100,17 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @ignore
      */
     constructor(options?: Org.Options);
+    /**
+     * create a sandbox from a production org
+     * 'this' needs to be a production org with sandbox licenses available
+     *
+     * @param sandboxReq SandboxRequest options to create the sandbox with
+     * @param options Wait: The amount of time to wait before timing out, Interval: The time interval between polling
+     */
+    createSandbox(sandboxReq: SandboxRequest, options: {
+        wait?: Duration;
+        interval?: Duration;
+    }): Promise<SandboxProcessObject>;
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -68,6 +130,11 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @param throwWhenRemoveFails Determines if the call should throw an error or fail silently.
      */
     remove(throwWhenRemoveFails?: boolean): Promise<void>;
+    /**
+     * Check if org is a sandbox org by checking its SandboxOrgConfig.
+     *
+     */
+    isSandbox(): Promise<boolean>;
     /**
      * Check that this org is a scratch org by asking the dev hub if it knows about it.
      *
@@ -90,6 +157,16 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * dev hub**. If you need accuracy, use the {@link Org.determineIfDevHubOrg} method.
      */
     isDevHubOrg(): boolean;
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     *
+     * @param controllingOrg username or Org that 'this.devhub' or 'this.production' refers to. AKA a DevHub for a scratch org, or a Production Org for a sandbox
+     */
+    deleteFrom(controllingOrg: string | Org): Promise<void>;
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     */
+    delete(): Promise<void>;
     /**
      * Returns `true` if the org is a Dev Hub.
      *
@@ -117,14 +194,6 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * using {@link Org.retrieveOrganizationInformation}.
      */
     determineIfScratch(): Promise<boolean>;
-    /**
-     * Returns `true` if the org is a sandbox.
-     *
-     * **Note** This relies on a cached value in the auth file. If that property
-     * is not cached, this method will **always return false even if the org is a
-     * sandbox**. If you need accuracy, use the {@link Org.determineIfDevHubOrg} method.
-     */
-    isSandbox(): boolean;
     /**
      * Returns `true` if the org is a sandbox.
      *
@@ -229,6 +298,23 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * **Throws** *{@link SfdxError}{ name: 'NotSupportedError' }* Throws an unsupported error.
      */
     protected getDefaultOptions(): Org.Options;
+    private queryProduction;
+    private destorySandbox;
+    private destoryScratchOrg;
+    /**
+     * this method will delete the sandbox org from the production org and clean up any local files
+     *
+     * @param prodOrg - Production org associated with this sandbox
+     * @private
+     */
+    private deleteSandbox;
+    /**
+     * If this Org is a scratch org, calling this method will delete the scratch org from the DevHub and clean up any local files
+     *
+     * @param devHub - optional DevHub Org of the to-be-deleted scratch org
+     * @private
+     */
+    private deleteScratchOrg;
     /**
      * Delete an auth info file from the local file system and any related cache information for
      * this Org. You don't want to call this method directly. Instead consider calling Org.remove()
@@ -255,6 +341,32 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @param throwWhenRemoveFails true if manageDelete should throw or not if the deleted fails.
      */
     private removeSandboxConfig;
+    private writeSandboxAuthFile;
+    /**
+     * Polls for the new sandbox to be created - and will write the associated auth files
+     *
+     * @private
+     * @param options
+     *  sandboxProcessObj: The in-progress sandbox signup request
+     *  retries: the number of retries to poll for every 30s
+     *  shouldPoll: wait for polling, or just return
+     *  pollInterval: Duration to sleep between poll events, default 30 seconds
+     */
+    private pollStatusAndAuth;
+    /**
+     * query SandboxProcess via SandboxInfoId
+     *
+     * @param id SandboxInfoId to query for
+     * @private
+     */
+    private querySandboxProcess;
+    /**
+     * determines if the sandbox has successfully been created
+     *
+     * @param sandboxProcessObj sandbox signup progeress
+     * @private
+     */
+    private sandboxSignupComplete;
 }
 export declare namespace Org {
     /**