@salesforce/core 3.13.0 → 3.15.0

package/lib/org/org.d.ts

@@ -1,8 +1,8 @@
 import { AsyncOptionalCreatable, Duration } from '@salesforce/kit';
-import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
+import { AnyJson, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
 import { ConfigAggregator } from '../config/configAggregator';
 import { OrgUsersConfig } from '../config/orgUsersConfig';
-import { SandboxOrgConfig } from '../config/sandboxOrgConfig';
+import { SfSandbox } from '../globalInfo';
 import { Connection } from './connection';
 import { AuthFields, AuthInfo } from './authInfo';
 import { ScratchOrgCreateOptions, ScratchOrgCreateResult } from './scratchOrgCreate';
@@ -20,7 +20,7 @@ export declare enum OrgTypes {
 export interface StatusEvent {
     sandboxProcessObj: SandboxProcessObject;
     interval: number;
-    retries: number;
+    remainingWait: number;
     waitingOnAuth: boolean;
 }
 export interface ResultEvent {
@@ -36,7 +36,8 @@ export declare enum SandboxEvents {
     EVENT_STATUS = "status",
     EVENT_ASYNC_RESULT = "asyncResult",
     EVENT_RESULT = "result",
-    EVENT_AUTH = "auth"
+    EVENT_AUTH = "auth",
+    EVENT_RESUME = "resume"
 }
 export interface SandboxUserAuthResponse {
     authUserName: string;
@@ -44,7 +45,7 @@ export interface SandboxUserAuthResponse {
     instanceUrl: string;
     loginUrl: string;
 }
-export interface SandboxProcessObject {
+export declare type SandboxProcessObject = {
     Id: string;
     Status: string;
     SandboxName: string;
@@ -57,13 +58,17 @@ export interface SandboxProcessObject {
     Description?: string;
     ApexClassId?: string;
     EndDate?: string;
-}
+};
 export declare type SandboxRequest = {
     SandboxName: string;
     LicenseType?: string;
     SourceId?: string;
     Description?: string;
 };
+export declare type ResumeSandboxRequest = {
+    SandboxName?: string;
+    SandboxProcessObjId?: string;
+};
 export declare type ScratchOrgRequest = Pick<ScratchOrgCreateOptions, 'connectedAppConsumerKey' | 'durationDays' | 'nonamespace' | 'noancestors' | 'wait' | 'retry' | 'apiversion' | 'definitionjson' | 'definitionfile' | 'orgConfig' | 'clientSecret'>;
 /**
  * Provides a way to manage a locally authenticated Org.
@@ -109,9 +114,23 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @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: {
+    createSandbox(sandboxReq: SandboxRequest, options?: {
+        wait?: Duration;
+        interval?: Duration;
+        async?: boolean;
+    }): Promise<SandboxProcessObject>;
+    /**
+     * resume a sandbox creation from a production org
+     * 'this' needs to be a production org with sandbox licenses available
+     *
+     * @param resumeSandboxRequest SandboxRequest options to create the sandbox with
+     * @param options Wait: The amount of time to wait (default: 30 minutes) before timing out,
+     * Interval: The time interval (default: 30 seconds) between polling
+     */
+    resumeSandbox(resumeSandboxRequest: ResumeSandboxRequest, options?: {
         wait?: Duration;
         interval?: Duration;
+        async?: boolean;
     }): Promise<SandboxProcessObject>;
     /**
      * Creates a scratchOrg
@@ -133,9 +152,7 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      */
     retrieveOrgUsersConfig(): Promise<OrgUsersConfig>;
     /**
-     * Removes the scratch org config file at $HOME/.sfdx/[name].json, any project level org
-     * files, all user auth files for the org, matching default config settings, and any
-     * matching aliases.
+     * Cleans up all org related artifacts including users, sandbox config(if a sandbox and auth file.
      *
      * @param throwWhenRemoveFails Determines if the call should throw an error or fail silently.
      */
@@ -259,17 +276,18 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      */
     removeUsername(auth: AuthInfo | string): Promise<Org>;
     /**
-     * Sets the key/value pair in the sandbox config for this org. For convenience `this` object is returned.
+     * set the sandbox config related to this given org
      *
-     *
-     * @param {key} The key for this value
-     * @param {value} The value to save
+     * @param orgId {string} orgId of the sandbox
+     * @param config {SfSandbox} config of the sandbox
      */
-    setSandboxOrgConfigField(field: SandboxOrgConfig.Fields, value: string): Promise<Org>;
+    setSandboxConfig(orgId: string, config: SfSandbox): Promise<Org>;
     /**
-     * Returns an org config field. Returns undefined if the field is not set or invalid.
+     * get the sandbox config for the given orgId
+     *
+     * @param orgId {string} orgId of the sandbox
      */
-    getSandboxOrgConfigField(field: SandboxOrgConfig.Fields): Promise<any>;
+    getSandboxConfig(orgId: string): Promise<Nullable<SfSandbox>>;
     /**
      * Retrieves the highest api version that is supported by the target server instance. If the apiVersion configured for
      * Sfdx is greater than the one returned in this call an api version mismatch occurs. In the case of the CLI that
@@ -300,6 +318,28 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * Returns the JSForce connection for the org.
      */
     getConnection(): Connection;
+    supportsSourceTracking(): Promise<boolean>;
+    /**
+     * query SandboxProcess via sandbox name
+     *
+     * @param name SandboxName to query for
+     * @private
+     */
+    querySandboxProcessBySandboxName(name: string): Promise<SandboxProcessObject>;
+    /**
+     * query SandboxProcess via SandboxInfoId
+     *
+     * @param id SandboxInfoId to query for
+     * @private
+     */
+    querySandboxProcessBySandboxInfoId(id: string): Promise<SandboxProcessObject>;
+    /**
+     * query SandboxProcess via Id
+     *
+     * @param id SandboxProcessId to query for
+     * @private
+     */
+    querySandboxProcessById(id: string): Promise<SandboxProcessObject>;
     /**
      * Initialize async components.
      */
@@ -334,10 +374,6 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * Deletes the users config file
      */
     private removeUsersConfig;
-    /**
-     * @ignore
-     */
-    private retrieveSandboxOrgConfig;
     private manageDelete;
     /**
      * Remove the org users auth file.
@@ -345,38 +381,24 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @param throwWhenRemoveFails true if manageDelete should throw or not if the deleted fails.
      */
     private removeUsers;
-    /**
-     * Remove an associate sandbox config.
-     *
-     * @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
+     * query SandboxProcess using supplied where clause
      *
-     * @param id SandboxInfoId to query for
+     * @param where clause to query for
      * @private
      */
     private querySandboxProcess;
     /**
      * determines if the sandbox has successfully been created
      *
-     * @param sandboxProcessObj sandbox signup progeress
+     * @param sandboxProcessObj sandbox signup progress
      * @private
      */
     private sandboxSignupComplete;
+    private validateWaitOptions;
 }
 export declare namespace Org {
     /**