@salesforce/core 3.7.0 → 3.7.4

package/lib/org/authInfo.js

@@ -149,7 +149,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         const orgs = Object.values(globalInfo.orgs.getAll());
         const final = [];
         for (const org of orgs) {
-            const username = ts_types_1.ensureString(org.username);
+            const username = (0, ts_types_1.ensureString)(org.username);
             const aliases = (_a = globalInfo.aliases.getAll(username)) !== null && _a !== void 0 ? _a : undefined;
             // Get a list of configuration values that are set to either the username or one
             // of the aliases
@@ -170,7 +170,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
                     accessToken: authInfo.getConnectionOptions().accessToken,
                     oauthMethod: authInfo.isJwt() ? 'jwt' : authInfo.isOauth() ? 'web' : 'token',
                     isExpired: Boolean(devHubUsername) && expirationDate
-                        ? new Date(ts_types_1.ensureString(expirationDate)).getTime() < new Date().getTime()
+                        ? new Date((0, ts_types_1.ensureString)(expirationDate)).getTime() < new Date().getTime()
                         : 'unknown',
                 });
             }
@@ -196,13 +196,14 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     static async hasAuthentications() {
         try {
             const auths = (await globalInfo_1.GlobalInfo.getInstance()).orgs.getAll();
-            return !kit_1.isEmpty(auths);
+            return !(0, kit_1.isEmpty)(auths);
         }
         catch (err) {
-            if (err.name === 'OrgDataNotAvailableError' || err.code === 'ENOENT') {
+            const error = err;
+            if (error.name === 'OrgDataNotAvailableError' || error.code === 'ENOENT') {
                 return false;
             }
-            throw err;
+            throw error;
         }
     }
     /**
@@ -217,7 +218,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         // The state parameter allows the redirectUri callback listener to ignore request
         // that don't contain the state value.
         const params = {
-            state: crypto_1.randomBytes(Math.ceil(6)).toString('hex'),
+            state: (0, crypto_1.randomBytes)(Math.ceil(6)).toString('hex'),
             prompt: 'login',
             // Default connected app is 'refresh_token api web'
             scope: options.scope || kit_1.env.getString('SFDX_AUTH_SCOPES', 'refresh_token api web'),
@@ -236,7 +237,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 {
@@ -286,7 +287,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      */
     async save(authData) {
         this.update(authData);
-        const username = ts_types_1.ensure(this.getUsername());
+        const username = (0, ts_types_1.ensure)(this.getUsername());
         if (sfdc_1.sfdc.matchesAccessToken(username)) {
             this.logger.debug('Username is an accesstoken. Skip saving authinfo to disk.');
             return this;
@@ -303,7 +304,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      */
     update(authData) {
         // todo move into configstore
-        if (authData && ts_types_1.isPlainObject(authData)) {
+        if (authData && (0, ts_types_1.isPlainObject)(authData)) {
             this.username = authData.username || this.username;
             const existingFields = this.globalInfo.orgs.get(this.getUsername());
             const mergedFields = Object.assign({}, existingFields || {}, authData);
@@ -373,8 +374,8 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      */
     getOrgFrontDoorUrl() {
         const authFields = this.getFields(true);
-        const base = ts_types_1.ensureString(authFields.instanceUrl).replace(/\/+$/, '');
-        const accessToken = ts_types_1.ensureString(authFields.accessToken);
+        const base = (0, ts_types_1.ensureString)(authFields.instanceUrl).replace(/\/+$/, '');
+        const accessToken = (0, ts_types_1.ensureString)(authFields.accessToken);
         return `${base}/secur/frontdoor.jsp?sid=${accessToken}`;
     }
     /**
@@ -390,12 +391,12 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      */
     getSfdxAuthUrl() {
         const decryptedFields = this.getFields(true);
-        const instanceUrl = ts_types_1.ensure(decryptedFields.instanceUrl, 'undefined instanceUrl').replace(/^https?:\/\//, '');
+        const instanceUrl = (0, ts_types_1.ensure)(decryptedFields.instanceUrl, 'undefined instanceUrl').replace(/^https?:\/\//, '');
         let sfdxAuthUrl = 'force://';
         if (decryptedFields.clientId) {
             sfdxAuthUrl += `${decryptedFields.clientId}:${decryptedFields.clientSecret || ''}:`;
         }
-        sfdxAuthUrl += `${ts_types_1.ensure(decryptedFields.refreshToken, 'undefined refreshToken')}@${instanceUrl}`;
+        sfdxAuthUrl += `${(0, ts_types_1.ensure)(decryptedFields.refreshToken, 'undefined refreshToken')}@${instanceUrl}`;
         return sfdxAuthUrl;
     }
     /**
@@ -414,7 +415,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         catch {
             config = await config_1.Config.create({ isGlobal: true });
         }
-        const username = ts_types_1.ensureString(this.getUsername());
+        const username = (0, ts_types_1.ensureString)(this.getUsername());
         const alias = this.globalInfo.aliases.get(username);
         const value = alias !== null && alias !== void 0 ? alias : username;
         if (options.org) {
@@ -453,12 +454,12 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
                 throw messages.createError('authInfoOverwriteError');
             }
         }
-        const oauthUsername = username || ts_types_1.getString(authOptions, 'username');
+        const oauthUsername = username || (0, ts_types_1.getString)(authOptions, 'username');
         if (oauthUsername) {
             this.username = oauthUsername;
         } // Else it will be set in initAuthOptions below.
         // If the username is an access token, use that for auth and don't persist
-        if (ts_types_1.isString(oauthUsername) && sfdc_1.sfdc.matchesAccessToken(oauthUsername)) {
+        if ((0, ts_types_1.isString)(oauthUsername) && sfdc_1.sfdc.matchesAccessToken(oauthUsername)) {
             // Need to initAuthOptions the logger and authInfoCrypto since we don't call init()
             this.logger = await logger_1.Logger.child('AuthInfo');
             const aggregator = await configAggregator_1.ConfigAggregator.create();
@@ -480,7 +481,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         }
     }
     getInstanceUrl(options, aggregator) {
-        const instanceUrl = ts_types_1.getString(options, 'instanceUrl') || aggregator.getPropertyValue('instanceUrl');
+        const instanceUrl = (0, ts_types_1.getString)(options, 'instanceUrl') || aggregator.getPropertyValue('instanceUrl');
         return instanceUrl || sfdcUrl_1.SfdcUrl.PRODUCTION;
     }
     /**
@@ -497,10 +498,10 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         // If options were passed, use those before checking cache and reading an auth file.
         let authConfig;
         if (options) {
-            options = kit_1.cloneJson(options);
+            options = (0, kit_1.cloneJson)(options);
             if (this.isTokenOptions(options)) {
                 authConfig = options;
-                const userInfo = await this.retrieveUserInfo(ts_types_1.ensureString(options.instanceUrl), ts_types_1.ensureString(options.accessToken));
+                const userInfo = await this.retrieveUserInfo((0, ts_types_1.ensureString)(options.instanceUrl), (0, ts_types_1.ensureString)(options.accessToken));
                 this.update({ username: userInfo === null || userInfo === void 0 ? void 0 : userInfo.username, orgId: userInfo === null || userInfo === void 0 ? void 0 : userInfo.organizationId });
             }
             else {
@@ -514,14 +515,14 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
                         // Grab whatever flow is defined
                         Object.assign(options, {
                             clientSecret: parentFields.clientSecret,
-                            privateKey: parentFields.privateKey ? path_1.resolve(parentFields.privateKey) : parentFields.privateKey,
+                            privateKey: parentFields.privateKey ? (0, path_1.resolve)(parentFields.privateKey) : parentFields.privateKey,
                         });
                     }
                 }
                 // jwt flow
                 // Support both sfdx and jsforce private key values
                 if (!options.privateKey && options.privateKeyFile) {
-                    options.privateKey = path_1.resolve(options.privateKeyFile);
+                    options.privateKey = (0, path_1.resolve)(options.privateKeyFile);
                 }
                 if (options.privateKey) {
                     authConfig = await this.buildJwtConfig(options);
@@ -565,6 +566,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     // A callback function for a connection to refresh an access token.  This is used
     // both for a JWT connection and an OAuth connection.
     async refreshFn(conn, callback) {
+        var _a;
         this.logger.info('Access token has expired. Updating...');
         try {
             const fields = this.getFields(true);
@@ -573,19 +575,20 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
             return await callback(null, fields.accessToken);
         }
         catch (err) {
-            if (err.message && err.message.includes('Data Not Available')) {
+            const error = err;
+            if ((_a = error === null || error === void 0 ? void 0 : error.message) === null || _a === void 0 ? void 0 : _a.includes('Data Not Available')) {
                 // Set cause to keep original stacktrace
-                return await callback(messages.createError('orgDataNotAvailableError', [this.getUsername()], [], err));
+                return await callback(messages.createError('orgDataNotAvailableError', [this.getUsername()], [], error));
             }
-            return await callback(err);
+            return await callback(error);
         }
     }
     // Build OAuth config for a JWT auth flow
     async buildJwtConfig(options) {
-        const privateKeyContents = await fs_1.fs.readFile(ts_types_1.ensure(options.privateKey), 'utf8');
+        const privateKeyContents = await fs_1.fs.readFile((0, ts_types_1.ensure)(options.privateKey), 'utf8');
         const { loginUrl = sfdcUrl_1.SfdcUrl.PRODUCTION } = options;
         const url = new sfdcUrl_1.SfdcUrl(loginUrl);
-        const createdOrgInstance = ts_types_1.getString(options, 'createdOrgInstance', '').trim().toLowerCase();
+        const createdOrgInstance = (0, ts_types_1.getString)(options, 'createdOrgInstance', '').trim().toLowerCase();
         const audienceUrl = await url.getJwtAudienceUrl(createdOrgInstance);
         const jwtToken = jwt.sign({
             iss: options.clientId,
@@ -598,19 +601,19 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         const oauth2 = new JwtOAuth2({ loginUrl: options.loginUrl });
         let authFieldsBuilder;
         try {
-            authFieldsBuilder = ts_types_1.ensureJsonMap(await oauth2.jwtAuthorize(jwtToken));
+            authFieldsBuilder = (0, ts_types_1.ensureJsonMap)(await oauth2.jwtAuthorize(jwtToken));
         }
         catch (err) {
             throw messages.createError('jwtAuthError', [err.message]);
         }
         const authFields = {
-            accessToken: ts_types_1.asString(authFieldsBuilder.access_token),
-            orgId: parseIdUrl(ts_types_1.ensureString(authFieldsBuilder.id)).orgId,
+            accessToken: (0, ts_types_1.asString)(authFieldsBuilder.access_token),
+            orgId: parseIdUrl((0, ts_types_1.ensureString)(authFieldsBuilder.id)).orgId,
             loginUrl: options.loginUrl,
             privateKey: options.privateKey,
             clientId: options.clientId,
         };
-        const instanceUrl = ts_types_1.ensureString(authFieldsBuilder.instance_url);
+        const instanceUrl = (0, ts_types_1.ensureString)(authFieldsBuilder.instance_url);
         const sfdcUrl = new sfdcUrl_1.SfdcUrl(instanceUrl);
         try {
             // Check if the url is resolvable. This can fail when my-domains have not been replicated.
@@ -637,7 +640,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         const oauth2 = new jsforce_1.OAuth2(options);
         let authFieldsBuilder;
         try {
-            authFieldsBuilder = await oauth2.refreshToken(ts_types_1.ensure(options.refreshToken));
+            authFieldsBuilder = await oauth2.refreshToken((0, ts_types_1.ensure)(options.refreshToken));
         }
         catch (err) {
             throw messages.createError('refreshTokenAuthError', [err.message]);
@@ -648,7 +651,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         if (!username) {
             // @ts-ignore
             const userInfo = await this.retrieveUserInfo(authFieldsBuilder.instance_url, authFieldsBuilder.access_token);
-            username = ts_types_1.ensureString(userInfo === null || userInfo === void 0 ? void 0 : userInfo.username);
+            username = (0, ts_types_1.ensureString)(userInfo === null || userInfo === void 0 ? void 0 : userInfo.username);
         }
         return {
             orgId,
@@ -680,7 +683,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         let authFields;
         try {
             this.logger.info(`Exchanging auth code for access token using loginUrl: ${options.loginUrl}`);
-            authFields = await oauth2.requestToken(ts_types_1.ensure(options.authCode));
+            authFields = await oauth2.requestToken((0, ts_types_1.ensure)(options.authCode));
         }
         catch (err) {
             throw messages.createError('authCodeExchangeError', [err.message]);
@@ -713,7 +716,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         // but we don't want to create circular dependencies or lots of snowflakes
         // within this file to support it.
         const apiVersion = 'v51.0'; // hardcoding to v51.0 just for this call is okay.
-        const instance = ts_types_1.ensure(instanceUrl);
+        const instance = (0, ts_types_1.ensure)(instanceUrl);
         const baseUrl = new sfdcUrl_1.SfdcUrl(instance);
         const userInfoUrl = `${baseUrl}services/oauth2/userinfo`;
         const headers = Object.assign({ Authorization: `Bearer ${accessToken}` }, connection_1.SFDX_HTTP_HEADERS);
@@ -724,7 +727,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
                 this.throwUserGetException(response);
             }
             else {
-                const userInfoJson = kit_1.parseJsonMap(response.body);
+                const userInfoJson = (0, kit_1.parseJsonMap)(response.body);
                 const url = `${baseUrl}/services/data/${apiVersion}/sobjects/User/${userInfoJson.user_id}`;
                 this.logger.info(`Sending request for User SObject after successful auth code exchange to URL: ${url}`);
                 response = await new transport_1.default().httpRequest({ url, method: 'GET', headers });
@@ -733,7 +736,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
                 }
                 else {
                     // eslint-disable-next-line camelcase
-                    userInfoJson.preferred_username = kit_1.parseJsonMap(response.body).Username;
+                    userInfoJson.preferred_username = (0, kit_1.parseJsonMap)(response.body).Username;
                 }
                 return { username: userInfoJson.preferred_username, organizationId: userInfoJson.organization_id };
             }
@@ -751,16 +754,16 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     throwUserGetException(response) {
         var _a;
         let errorMsg = '';
-        const bodyAsString = ts_types_1.getString(response, 'body', JSON.stringify({ message: 'UNKNOWN', errorCode: 'UNKNOWN' }));
+        const bodyAsString = (0, ts_types_1.getString)(response, 'body', JSON.stringify({ message: 'UNKNOWN', errorCode: 'UNKNOWN' }));
         try {
-            const body = kit_1.parseJson(bodyAsString);
-            if (ts_types_1.isArray(body)) {
+            const body = (0, kit_1.parseJson)(bodyAsString);
+            if ((0, ts_types_1.isArray)(body)) {
                 errorMsg = body
-                    .map((line) => { var _a; return (_a = ts_types_1.getString(line, 'message')) !== null && _a !== void 0 ? _a : ts_types_1.getString(line, 'errorCode', 'UNKNOWN'); })
+                    .map((line) => { var _a; return (_a = (0, ts_types_1.getString)(line, 'message')) !== null && _a !== void 0 ? _a : (0, ts_types_1.getString)(line, 'errorCode', 'UNKNOWN'); })
                     .join(os.EOL);
             }
             else {
-                errorMsg = (_a = ts_types_1.getString(body, 'message')) !== null && _a !== void 0 ? _a : ts_types_1.getString(body, 'errorCode', 'UNKNOWN');
+                errorMsg = (_a = (0, ts_types_1.getString)(body, 'message')) !== null && _a !== void 0 ? _a : (0, ts_types_1.getString)(body, 'errorCode', 'UNKNOWN');
             }
         }
         catch (err) {

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',
@@ -85,7 +86,7 @@ class Connection extends jsforce_1.Connection {
         if (!baseOptions.version) {
             // Set the API version obtained from the config aggregator.
             const configAggregator = options.configAggregator || (await configAggregator_1.ConfigAggregator.create());
-            baseOptions.version = ts_types_1.asString(configAggregator.getInfo('apiVersion').value);
+            baseOptions.version = (0, ts_types_1.asString)(configAggregator.getInfo('apiVersion').value);
         }
         const providedOptions = options.authInfo.getConnectionOptions();
         // Get connection options from auth info and create a new jsForce connection
@@ -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;
             }
@@ -171,7 +173,7 @@ class Connection extends jsforce_1.Connection {
      * @param options HTTP API request options.
      */
     request(request, options) {
-        const httpRequest = ts_types_1.isString(request) ? { method: 'GET', url: request } : request;
+        const httpRequest = (0, ts_types_1.isString)(request) ? { method: 'GET', url: request } : request;
         httpRequest.headers = Object.assign({}, exports.SFDX_HTTP_HEADERS, httpRequest.headers);
         this.logger.debug(`request: ${JSON.stringify(httpRequest)}`);
         //  The "as" is a workaround for the jsforce typings.
@@ -224,7 +226,7 @@ class Connection extends jsforce_1.Connection {
         await this.isResolvable();
         const versions = await this.request(`${this.instanceUrl}/services/data`);
         this.logger.debug(`response for org versions: ${versions.map((item) => item.version).join(',')}`);
-        const max = ts_types_1.ensure(kit_1.maxBy(versions, (version) => version.version));
+        const max = (0, ts_types_1.ensure)((0, kit_1.maxBy)(versions, (version) => version.version));
         return max.version;
     }
     /**
@@ -235,11 +237,12 @@ class Connection extends jsforce_1.Connection {
             this.setApiVersion(await this.retrieveMaxApiVersion());
         }
         catch (err) {
-            if (err.name === exports.DNS_ERROR_NAME) {
-                throw err; // throws on DNS connection errors
+            const error = err;
+            if (error.name === exports.DNS_ERROR_NAME) {
+                throw error; // throws on DNS connection errors
             }
             // Don't fail if we can't use the latest, just use the default
-            this.logger.warn('Failed to set the latest API version:', err);
+            this.logger.warn('Failed to set the latest API version:', error);
         }
     }
     /**
@@ -336,8 +339,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;
     }
@@ -365,10 +368,10 @@ class Connection extends jsforce_1.Connection {
     async loadInstanceApiVersion() {
         const authFileFields = this.options.authInfo.getFields();
         const lastCheckedDateString = authFileFields.instanceApiVersionLastRetrieved;
-        let version = ts_types_1.getString(authFileFields, 'instanceApiVersion');
+        let version = (0, ts_types_1.getString)(authFileFields, 'instanceApiVersion');
         let lastChecked;
         try {
-            if (lastCheckedDateString && ts_types_1.isString(lastCheckedDateString)) {
+            if (lastCheckedDateString && (0, ts_types_1.isString)(lastCheckedDateString)) {
                 lastChecked = Date.parse(lastCheckedDateString);
             }
         }

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 {
     /**