@sfdx-falcon/builder-library/lib/questions/sfdx.d.ts

Collection of functions for building pre-defined SFDX-Falcon Tasks, Questions, and Task Bundles. Allows developers to quickly build common Task and Interview-driven workflows in their CLI plugins. Part of the SFDX-Falcon Library.

/**
 * @author        Vivek M. Chawla <@VivekMChawla>
 * @copyright     2019, Vivek M. Chawla / Salesforce. All rights reserved.
 * @license       BSD-3-Clause For full license text, see the LICENSE file in the repo root or
 *                `https://opensource.org/licenses/BSD-3-Clause`
 * @file          packages/builder-library/src/questions/sfdx.ts
 * @summary       Exports `Builder` classes for questions related to Salesforce DX functionality.
 * @description   Exports `Builder` classes for questions related to Salesforce DX functionality.
 */
import { InterviewQuestionsBuilder } from '@sfdx-falcon/builder';
import { SfdxFalconPrompt } from '@sfdx-falcon/prompt';
import { InterviewQuestionsBuilderOptions } from '@sfdx-falcon/builder';
import { InquirerChoices } from '@sfdx-falcon/types';
import { JsonMap } from '@sfdx-falcon/types';
import { InquirerValidateFunction } from '@sfdx-falcon/types';
import { Questions } from '@sfdx-falcon/types';
/**
 *  Interface. Specifies options for the `ChooseSingleOrg` constructor.
 */
export interface ChooseSingleOrgOptions extends InterviewQuestionsBuilderOptions {
    scratchOrgChoices: InquirerChoices;
    standardOrgChoices: InquirerChoices;
    validateFunction?: InquirerValidateFunction;
    msgStrings: {
        promptIsScratchOrg?: string;
        promptStandardOrgChoice?: string;
        promptScratchOrgChoice?: string;
    };
}
/**
 * @class       ChooseSingleOrg
 * @extends     InterviewQuestionsBuilder
 * @summary     Interview Questions Builder for choosing a single salesforce org.
 * @description Interview Questions Builder for choosing a single salesforce org.
 */
export declare class ChooseSingleOrg extends InterviewQuestionsBuilder {
    promptIsScratchOrg: string;
    promptStandardOrgChoice: string;
    promptScratchOrgChoice: string;
    standardOrgChoices: InquirerChoices;
    scratchOrgChoices: InquirerChoices;
    /**
     * @constructs  ChooseSingleOrg
     * @param       {ChooseSingleOrgOptions} opts  Required.
     */
    constructor(opts: ChooseSingleOrgOptions);
    /**
     * @method      build
     * @returns     {Questions}
     * @description Builds the Interview Questions.
     */
    build(): Questions;
}
/**
 *  Interface. Specifies options for the `ConfirmNoTargetOrg` constructor.
 */
export interface ConfirmNoTargetOrgOptions extends InterviewQuestionsBuilderOptions {
    msgStrings: {
        promptStartOver?: string;
    };
}
/**
 * @class       ConfirmNoTargetOrg
 * @extends     InterviewQuestionsBuilder
 * @summary     Interview Questions Builder for confirming refusal of a Target Org selection.
 * @description Interview Questions Builder for confirming refusal of a Target Org selection.
 */
export declare class ConfirmNoTargetOrg extends InterviewQuestionsBuilder {
    promptStartOver: string;
    /**
     * @constructs  ConfirmNoTargetOrg
     * @param       {ConfirmNoTargetOrgOptions} opts  Required.
     */
    constructor(opts: ConfirmNoTargetOrgOptions);
    /**
     * @method      build
     * @returns     {Questions}
     * @description Builds the Interview Questions.
     */
    build(buildCtx: SfdxFalconPrompt<JsonMap>): Questions;
}