@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/prompts/activityPrompt.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityPrompt = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const dialog_1 = require("../dialog");
+/**
+ * Waits for an activity to be received.
+ *
+ * @remarks
+ * This prompt requires a validator be passed in and is useful when waiting for non-message
+ * activities like an event to be received. The validator can ignore received events until the
+ * expected activity is received.
+ */
+class ActivityPrompt extends dialog_1.Dialog {
+    /**
+       * Creates a new ActivityPrompt instance.
+       *
+       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param validator Validator that will be called each time a new activity is received.
+       */
+    constructor(dialogId, validator) {
+        super(dialogId);
+        this.validator = validator;
+    }
+    /**
+       * Called when a prompt dialog is pushed onto the dialog stack and is being activated.
+       *
+       * @param dialogContext The DialogContext for the current
+       * turn of the conversation.
+       * @param options PromptOptions, additional
+       * information to pass to the prompt being started.
+       * @returns A `Promise` representing the asynchronous operation.
+       * @remarks
+       * If the promise is successful, the result indicates whether the prompt is still
+       * active after the turn has been processed by the prompt.
+       */
+    async beginDialog(dialogContext, options) {
+        // Ensure prompts have input hint set
+        const opt = { ...options };
+        if (opt.prompt && typeof opt.prompt === 'object' && typeof opt.prompt.inputHint !== 'string') {
+            opt.prompt.inputHint = agents_hosting_1.InputHints.ExpectingInput;
+        }
+        if (opt.retryPrompt && typeof opt.retryPrompt === 'object' && typeof opt.retryPrompt.inputHint !== 'string') {
+            opt.retryPrompt.inputHint = agents_hosting_1.InputHints.ExpectingInput;
+        }
+        // Initialize prompt state
+        const state = dialogContext.activeDialog.state;
+        state.options = opt;
+        state.state = {};
+        // Send initial prompt
+        await this.onPrompt(dialogContext.context, state.state, state.options, false);
+        return dialog_1.Dialog.EndOfTurn;
+    }
+    /**
+       * Called when a prompt dialog is the active dialog and the user replied with a new activity.
+       *
+       * @param dialogContext The DialogContext for the current
+       * turn of conversation.
+       * @returns A `Promise` representing the asynchronous operation.
+       * @remarks
+       * If the promise is successful, the result indicates whether the dialog is still
+       * active after the turn has been processed by the dialog.
+       * The prompt generally continues to receive the user's replies until it accepts the
+       * user's reply as valid input for the prompt.
+       */
+    async continueDialog(dialogContext) {
+        // Perform base recognition
+        const state = dialogContext.activeDialog.state;
+        const recognized = await this.onRecognize(dialogContext.context, state.state, state.options);
+        if (state.state['attemptCount'] === undefined) {
+            state.state['attemptCount'] = 0;
+        }
+        // Validate the return value
+        // - Unlike the other prompts a validator is required for an ActivityPrompt so we don't
+        //   need to check for its existence before calling it.
+        const isValid = await this.validator({
+            context: dialogContext.context,
+            recognized,
+            state: state.state,
+            options: state.options,
+            attemptCount: ++state.state['attemptCount'],
+        });
+        // Return recognized value or re-prompt
+        if (isValid) {
+            return await dialogContext.endDialog(recognized.value);
+        }
+        else {
+            if (dialogContext.context.activity.type === agents_hosting_1.ActivityTypes.Message && !dialogContext.context.responded) {
+                await this.onPrompt(dialogContext.context, state.state, state.options, true);
+            }
+            return dialog_1.Dialog.EndOfTurn;
+        }
+    }
+    /**
+       * Called when a prompt dialog resumes being the active dialog on the dialog stack, such as
+       * when the previous active dialog on the stack completes.
+       *
+       * @param dialogContext The DialogContext for the current turn
+       * of the conversation.
+       * @param _reason DialogReason, an enum indicating why
+       * the dialog resumed.
+       * @param _result Optional. Value returned from the previous dialog on the stack.
+       * The type of the value returned is dependent on the previous dialog.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async resumeDialog(dialogContext, _reason, _result) {
+        // Prompts are typically leaf nodes on the stack but the dev is free to push other dialogs
+        // on top of the stack which will result in the prompt receiving an unexpected call to
+        // resumeDialog() when the pushed on dialog ends.
+        // To avoid the prompt prematurely ending we need to implement this method and
+        // simply re-prompt the user.
+        await this.repromptDialog(dialogContext.context, dialogContext.activeDialog);
+        return dialog_1.Dialog.EndOfTurn;
+    }
+    /**
+       * Called when a prompt dialog has been requested to re-prompt the user for input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param instance DialogInstance, the instance
+       * of the dialog on the stack.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async repromptDialog(context, instance) {
+        const state = instance.state;
+        await this.onPrompt(context, state.state, state.options, false);
+    }
+    /**
+       * When overridden in a derived class, prompts the user for input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @param isRetry A boolean representing if the prompt is a retry.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async onPrompt(context, state, options, isRetry) {
+        if (isRetry && options.retryPrompt) {
+            await context.sendActivity(options.retryPrompt, undefined, agents_hosting_1.InputHints.ExpectingInput);
+        }
+        else if (options.prompt) {
+            await context.sendActivity(options.prompt, undefined, agents_hosting_1.InputHints.ExpectingInput);
+        }
+    }
+    /**
+       * When overridden in a derived class, attempts to recognize the incoming Activity.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param _state Contains state for the current instance of the prompt on the dialog stack.
+       * @param _options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async onRecognize(context, _state, _options) {
+        return { succeeded: true, value: context.activity };
+    }
+}
+exports.ActivityPrompt = ActivityPrompt;
+//# sourceMappingURL=activityPrompt.js.map

package/dist/src/prompts/activityPrompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activityPrompt.js","sourceRoot":"","sources":["../../../src/prompts/activityPrompt.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,8DAA4F;AAC5F,sCAAkC;AAOlC;;;;;;;GAOG;AACH,MAAa,cAAe,SAAQ,eAAM;IACxC;;;;;SAKK;IACL,YACE,QAAgB,EACR,SAAoC;QAE5C,KAAK,CAAC,QAAQ,CAAC,CAAA;QAFP,cAAS,GAAT,SAAS,CAA2B;IAG9C,CAAC;IAED;;;;;;;;;;;SAWK;IACL,KAAK,CAAC,WAAW,CAAE,aAA4B,EAAE,OAAsB;QACrE,qCAAqC;QACrC,MAAM,GAAG,GAA2B,EAAE,GAAG,OAAO,EAAE,CAAA;QAClD,IAAI,GAAG,CAAC,MAAM,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC7F,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,2BAAU,CAAC,cAAc,CAAA;QAClD,CAAC;QACD,IAAI,GAAG,CAAC,WAAW,IAAI,OAAO,GAAG,CAAC,WAAW,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,WAAW,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5G,GAAG,CAAC,WAAW,CAAC,SAAS,GAAG,2BAAU,CAAC,cAAc,CAAA;QACvD,CAAC;QAED,0BAA0B;QAC1B,MAAM,KAAK,GAAQ,aAAa,CAAC,YAAY,CAAC,KAA4B,CAAA;QAC1E,KAAK,CAAC,OAAO,GAAG,GAAG,CAAA;QACnB,KAAK,CAAC,KAAK,GAAG,EAAE,CAAA;QAEhB,sBAAsB;QACtB,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAE7E,OAAO,eAAM,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;;;;;;;;;;SAWK;IACL,KAAK,CAAC,cAAc,CAAE,aAA4B;QAChD,2BAA2B;QAC3B,MAAM,KAAK,GAAQ,aAAa,CAAC,YAAY,CAAC,KAA4B,CAAA;QAC1E,MAAM,UAAU,GAAqC,MAAM,IAAI,CAAC,WAAW,CACzE,aAAa,CAAC,OAAO,EACrB,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,OAAO,CACd,CAAA;QAED,IAAI,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;YAC9C,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;QACjC,CAAC;QAED,4BAA4B;QAC5B,uFAAuF;QACvF,uDAAuD;QACvD,MAAM,OAAO,GAAY,MAAM,IAAI,CAAC,SAAS,CAAC;YAC5C,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,UAAU;YACV,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,YAAY,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC;SAC5C,CAAC,CAAA;QAEF,uCAAuC;QACvC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,MAAM,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACxD,CAAC;aAAM,CAAC;YACN,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,8BAAa,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBACtG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC9E,CAAC;YAED,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;SAWK;IACL,KAAK,CAAC,YAAY,CAAE,aAA4B,EAAE,OAAqB,EAAE,OAAa;QACpF,0FAA0F;QAC1F,sFAAsF;QACtF,iDAAiD;QACjD,8EAA8E;QAC9E,6BAA6B;QAC7B,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;QAE5E,OAAO,eAAM,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,cAAc,CAAE,OAAoB,EAAE,QAAwB;QAClE,MAAM,KAAK,GAAwB,QAAQ,CAAC,KAA4B,CAAA;QACxE,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACjE,CAAC;IAED;;;;;;;;;;SAUK;IACK,KAAK,CAAC,QAAQ,CACtB,OAAoB,EACpB,KAAa,EACb,OAAsB,EACtB,OAAgB;QAEhB,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;QACvF,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;QAClF,CAAC;IACH,CAAC;IAED;;;;;;;;;SASK;IACK,KAAK,CAAC,WAAW,CACzB,OAAoB,EACpB,MAAc,EACd,QAAuB;QAEvB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACrD,CAAC;CACF;AA7KD,wCA6KC"}

package/dist/src/prompts/attachmentPrompt.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Attachment, TurnContext } from '@microsoft/agents-hosting';
+import { Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
+/**
+ * Prompts a user to upload attachments like images.
+ *
+ * @remarks
+ * By default the prompt will return to the calling dialog an `Attachment[]`.
+ */
+export declare class AttachmentPrompt extends Prompt<Attachment[]> {
+    constructor(dialogId: string, validator?: PromptValidator<Attachment[]>);
+    /**
+       * Prompts the user for input.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A prompt options object constructed from the options initially provided
+       * in the call to Prompt.
+       * @param isRetry `true` if this is the first time this prompt dialog instance
+       * on the stack is prompting the user for input; otherwise, false.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    protected onPrompt(context: TurnContext, state: any, options: PromptOptions, isRetry: boolean): Promise<void>;
+    /**
+       * Attempts to recognize the user's input.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @param _state Contains state for the current instance of the prompt on the dialog stack.
+       * @param _options A prompt options object constructed from the options initially provided
+       * in the call to Prompt.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    protected onRecognize(context: TurnContext, _state: any, _options: PromptOptions): Promise<PromptRecognizerResult<Attachment[]>>;
+}

package/dist/src/prompts/attachmentPrompt.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentPrompt = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const prompt_1 = require("./prompt");
+/**
+ * Prompts a user to upload attachments like images.
+ *
+ * @remarks
+ * By default the prompt will return to the calling dialog an `Attachment[]`.
+ */
+class AttachmentPrompt extends prompt_1.Prompt {
+    // eslint-disable-next-line @typescript-eslint/no-useless-constructor
+    constructor(dialogId, validator) {
+        super(dialogId, validator);
+    }
+    /**
+       * Prompts the user for input.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A prompt options object constructed from the options initially provided
+       * in the call to Prompt.
+       * @param isRetry `true` if this is the first time this prompt dialog instance
+       * on the stack is prompting the user for input; otherwise, false.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    async onPrompt(context, state, options, isRetry) {
+        if (isRetry && options.retryPrompt) {
+            await context.sendActivity(options.retryPrompt, undefined, agents_hosting_1.InputHints.ExpectingInput);
+        }
+        else if (options.prompt) {
+            await context.sendActivity(options.prompt, undefined, agents_hosting_1.InputHints.ExpectingInput);
+        }
+    }
+    /**
+       * Attempts to recognize the user's input.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @param _state Contains state for the current instance of the prompt on the dialog stack.
+       * @param _options A prompt options object constructed from the options initially provided
+       * in the call to Prompt.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    async onRecognize(context, _state, _options) {
+        const value = context.activity.attachments;
+        return Array.isArray(value) && value.length > 0 ? { succeeded: true, value } : { succeeded: false };
+    }
+}
+exports.AttachmentPrompt = AttachmentPrompt;
+//# sourceMappingURL=attachmentPrompt.js.map

package/dist/src/prompts/attachmentPrompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachmentPrompt.js","sourceRoot":"","sources":["../../../src/prompts/attachmentPrompt.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,8DAA+E;AAC/E,qCAAyF;AAEzF;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,eAAoB;IACxD,qEAAqE;IACrE,YAAa,QAAgB,EAAE,SAAyC;QACtE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;SAUK;IACK,KAAK,CAAC,QAAQ,CACtB,OAAoB,EACpB,KAAU,EACV,OAAsB,EACtB,OAAgB;QAEhB,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;QACvF,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;QAClF,CAAC;IACH,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,WAAW,CACzB,OAAoB,EACpB,MAAW,EACX,QAAuB;QAEvB,MAAM,KAAK,GAAiB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAA;QAExD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;IACrG,CAAC;CACF;AAhDD,4CAgDC"}

package/dist/src/prompts/choicePrompt.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TurnContext } from '@microsoft/agents-hosting';
+import { ChoiceFactoryOptions, FindChoicesOptions, FoundChoice } from '../choices';
+import { ListStyle, Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
+interface ChoiceDefaultsChoicePrompt {
+    [locale: string]: ChoiceFactoryOptions;
+}
+/**
+ * Prompts a user to select from a list of choices.
+ *
+ * @remarks
+ * By default the prompt will return to the calling dialog a `FoundChoice` object containing the
+ * choice that was selected.
+ */
+export declare class ChoicePrompt extends Prompt<FoundChoice> {
+    /**
+       * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+       * Can be replaced by user using the constructor that contains choiceDefaults.
+       */
+    private choiceDefaults;
+    /**
+       * The prompts default locale that should be recognized.
+       */
+    defaultLocale: string | undefined;
+    /**
+       * Style of the "yes" and "no" choices rendered to the user when prompting.
+       *
+       * @remarks
+       * Defaults to `ListStyle.auto`.
+       */
+    style: ListStyle;
+    /**
+       * Additional options passed to the `ChoiceFactory` and used to tweak the style of choices
+       * rendered to the user.
+       */
+    choiceOptions: ChoiceFactoryOptions | undefined;
+    /**
+       * Additional options passed to the underlying `recognizeChoices()` function.
+       */
+    recognizerOptions: FindChoicesOptions | undefined;
+    /**
+       * Creates a new `ChoicePrompt` instance.
+       *
+       * @param dialogId Unique ID of the dialog within its parent `DialogSet`.
+       * @param validator (Optional) validator that will be called each time the user responds to the prompt. If the validator replies with a message no additional retry prompt will be sent.
+       * @param defaultLocale (Optional) locale to use if `dc.context.activity.locale` not specified. Defaults to a value of `en-us`.
+       * @param choiceDefaults (Optional) Overrides the dictionary of Bot Framework SDK-supported _choiceDefaults (for prompt localization).
+       *  Must be passed in to each ConfirmPrompt that needs the custom choice defaults.
+       */
+    constructor(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt);
+    /**
+       * Prompts the user for input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @param isRetry `true` if this is the first time this prompt dialog instance
+       * on the stack is prompting the user for input; otherwise, false.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    protected onPrompt(context: TurnContext, state: any, options: PromptOptions, isRetry: boolean): Promise<void>;
+    /**
+       * Attempts to recognize the user's input.
+       *
+       * @param context TurnContext context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    protected onRecognize(context: TurnContext, state: any, options: PromptOptions): Promise<PromptRecognizerResult<FoundChoice>>;
+    /**
+       * @private
+       */
+    private determineCulture;
+}
+export {};

package/dist/src/prompts/choicePrompt.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChoicePrompt = void 0;
+const choices_1 = require("../choices");
+const prompt_1 = require("./prompt");
+const promptCultureModels_1 = require("./promptCultureModels");
+/**
+ * Prompts a user to select from a list of choices.
+ *
+ * @remarks
+ * By default the prompt will return to the calling dialog a `FoundChoice` object containing the
+ * choice that was selected.
+ */
+class ChoicePrompt extends prompt_1.Prompt {
+    /**
+       * Creates a new `ChoicePrompt` instance.
+       *
+       * @param dialogId Unique ID of the dialog within its parent `DialogSet`.
+       * @param validator (Optional) validator that will be called each time the user responds to the prompt. If the validator replies with a message no additional retry prompt will be sent.
+       * @param defaultLocale (Optional) locale to use if `dc.context.activity.locale` not specified. Defaults to a value of `en-us`.
+       * @param choiceDefaults (Optional) Overrides the dictionary of Bot Framework SDK-supported _choiceDefaults (for prompt localization).
+       *  Must be passed in to each ConfirmPrompt that needs the custom choice defaults.
+       */
+    constructor(dialogId, validator, defaultLocale, choiceDefaults) {
+        super(dialogId, validator);
+        this.style = prompt_1.ListStyle.auto;
+        this.defaultLocale = defaultLocale;
+        if (choiceDefaults === undefined) {
+            const supported = {};
+            promptCultureModels_1.PromptCultureModels.getSupportedCultures().forEach((culture) => {
+                supported[culture.locale] = {
+                    inlineSeparator: culture.separator,
+                    inlineOr: culture.inlineOr,
+                    inlineOrMore: culture.inlineOrMore,
+                    includeNumbers: true,
+                };
+            });
+            this.choiceDefaults = supported;
+        }
+        else {
+            this.choiceDefaults = choiceDefaults;
+        }
+    }
+    /**
+       * Prompts the user for input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @param isRetry `true` if this is the first time this prompt dialog instance
+       * on the stack is prompting the user for input; otherwise, false.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async onPrompt(context, state, options, isRetry) {
+        // Determine locale
+        const locale = this.determineCulture(context.activity);
+        // Format prompt to send
+        let prompt;
+        const choices = (this.style === prompt_1.ListStyle.suggestedAction ? choices_1.ChoiceFactory.toChoices(options.choices) : options.choices) ||
+            [];
+        const channelId = context.activity.channelId;
+        const choiceOptions = this.choiceOptions || this.choiceDefaults[locale];
+        const choiceStyle = options.style === 0 ? 0 : options.style || this.style;
+        if (isRetry && options.retryPrompt) {
+            prompt = this.appendChoices(options.retryPrompt, channelId, choices, choiceStyle, choiceOptions);
+        }
+        else {
+            prompt = this.appendChoices(options.prompt, channelId, choices, choiceStyle, choiceOptions);
+        }
+        // Send prompt
+        await context.sendActivity(prompt);
+    }
+    /**
+       * Attempts to recognize the user's input.
+       *
+       * @param context TurnContext context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    async onRecognize(context, state, options) {
+        const result = { succeeded: false };
+        const activity = context.activity;
+        const utterance = activity.text;
+        if (!utterance) {
+            return result;
+        }
+        const choices = (this.style === prompt_1.ListStyle.suggestedAction ? choices_1.ChoiceFactory.toChoices(options.choices) : options.choices) ||
+            [];
+        const opt = this.recognizerOptions || {};
+        opt.locale = this.determineCulture(activity, opt);
+        const results = (0, choices_1.recognizeChoices)(utterance, choices, opt);
+        if (Array.isArray(results) && results.length > 0) {
+            result.succeeded = true;
+            result.value = results[0].resolution;
+        }
+        return result;
+    }
+    /**
+       * @private
+       */
+    determineCulture(activity, opt) {
+        const optLocale = opt && opt.locale ? opt.locale : null;
+        let culture = promptCultureModels_1.PromptCultureModels.mapToNearestLanguage(activity.locale || optLocale || this.defaultLocale || promptCultureModels_1.PromptCultureModels.English.locale);
+        if (!(culture && this.choiceDefaults[culture])) {
+            culture = promptCultureModels_1.PromptCultureModels.English.locale;
+        }
+        return culture;
+    }
+}
+exports.ChoicePrompt = ChoicePrompt;
+//# sourceMappingURL=choicePrompt.js.map

package/dist/src/prompts/choicePrompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"choicePrompt.js","sourceRoot":"","sources":["../../../src/prompts/choicePrompt.ts"],"names":[],"mappings":";;;AAKA,wCAAmH;AACnH,qCAAoG;AACpG,+DAA2D;AAO3D;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,eAAmB;IA+BnD;;;;;;;;SAQK;IACL,YACE,QAAgB,EAChB,SAAwC,EACxC,aAAsB,EACtB,cAA2C;QAE3C,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,kBAAS,CAAC,IAAI,CAAA;QAC3B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAElC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,SAAS,GAA+B,EAAE,CAAA;YAChD,yCAAmB,CAAC,oBAAoB,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,EAAQ,EAAE;gBACnE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG;oBAC1B,eAAe,EAAE,OAAO,CAAC,SAAS;oBAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;oBAClC,cAAc,EAAE,IAAI;iBACrB,CAAA;YACH,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;SAWK;IACK,KAAK,CAAC,QAAQ,CACtB,OAAoB,EACpB,KAAU,EACV,OAAsB,EACtB,OAAgB;QAEhB,mBAAmB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAEtD,wBAAwB;QACxB,IAAI,MAAgB,CAAA;QACpB,MAAM,OAAO,GACL,CAAC,IAAI,CAAC,KAAK,KAAK,kBAAS,CAAC,eAAe,CAAC,CAAC,CAAC,uBAAa,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YACvG,EAAE,CAAA;QACV,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAA;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;QACvE,MAAM,WAAW,GAAc,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;QACpF,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,CAAA;QAClG,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,CAAA;QAC7F,CAAC;QAED,cAAc;QACd,MAAM,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;;;SASK;IACK,KAAK,CAAC,WAAW,CACzB,OAAoB,EACpB,KAAU,EACV,OAAsB;QAEtB,MAAM,MAAM,GAAwC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;QACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACjC,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAA;QAC/B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,OAAO,GACL,CAAC,IAAI,CAAC,KAAK,KAAK,kBAAS,CAAC,eAAe,CAAC,CAAC,CAAC,uBAAa,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YACvG,EAAE,CAAA;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAA;QACxC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,IAAA,0BAAgB,EAAC,SAAS,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;QACzD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,SAAS,GAAG,IAAI,CAAA;YACvB,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;QACtC,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;SAEK;IACG,gBAAgB,CAAE,QAAkB,EAAE,GAAwB;QACpE,MAAM,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;QACvD,IAAI,OAAO,GAAG,yCAAmB,CAAC,oBAAoB,CACpD,QAAQ,CAAC,MAAM,IAAI,SAAS,IAAI,IAAI,CAAC,aAAa,IAAI,yCAAmB,CAAC,OAAO,CAAC,MAAM,CACzF,CAAA;QACD,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,yCAAmB,CAAC,OAAO,CAAC,MAAM,CAAA;QAC9C,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;CACF;AA1JD,oCA0JC"}

package/dist/src/prompts/confirmPrompt.d.ts

@@ -0,0 +1,82 @@
+import { TurnContext } from '@microsoft/agents-hosting';
+import { Choice, ChoiceFactoryOptions } from '../choices';
+import { ListStyle, Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
+interface ChoiceDefaultsConfirmPrompt {
+    [locale: string]: {
+        choices: (string | Choice)[];
+        options: ChoiceFactoryOptions;
+    };
+}
+/**
+ * Prompts a user to confirm something with a "yes" or "no" response.
+ *
+ * @remarks
+ * By default the prompt will return to the calling dialog a `boolean` representing the users
+ * selection.
+ */
+export declare class ConfirmPrompt extends Prompt<boolean> {
+    /**
+       * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+       * Can be replaced by user using the constructor that contains choiceDefaults.
+       * This is initially set in the constructor.
+       */
+    private choiceDefaults;
+    /**
+       * The prompts default locale that should be recognized.
+       */
+    defaultLocale: string | undefined;
+    /**
+       * Style of the "yes" and "no" choices rendered to the user when prompting.
+       *
+       * @remarks
+       * Defaults to `ListStyle.auto`.
+       */
+    style: ListStyle;
+    /**
+       * Additional options passed to the `ChoiceFactory` and used to tweak the style of choices
+       * rendered to the user.
+       */
+    choiceOptions: ChoiceFactoryOptions | undefined;
+    /**
+       * Custom list of choices to send for the prompt.
+       */
+    confirmChoices: (string | Choice)[] | undefined;
+    /**
+       * Creates a new ConfirmPrompt instance.
+       *
+       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param validator (Optional) validator that will be called each time the user responds to the prompt.
+       * @param defaultLocale (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`.
+       * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on [[PromptCultureModels.getSupportedCultures()]].
+       */
+    constructor(dialogId: string, validator?: PromptValidator<boolean>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsConfirmPrompt);
+    /**
+       * Prompts the user for input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param state Contains state for the current instance of the prompt on the dialog stack.
+       * @param options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @param isRetry `true` if this is the first time this prompt dialog instance
+       * on the stack is prompting the user for input; otherwise, false.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    protected onPrompt(context: TurnContext, state: any, options: PromptOptions, isRetry: boolean): Promise<void>;
+    /**
+       * Attempts to recognize the user's input.
+       *
+       * @param context TurnContext, context for the current
+       * turn of conversation with the user.
+       * @param _state Contains state for the current instance of the prompt on the dialog stack.
+       * @param _options A PromptOptions object constructed
+       * from the options initially provided in the call to Prompt.
+       * @returns A `Promise` representing the asynchronous operation.
+       */
+    protected onRecognize(context: TurnContext, _state: any, _options: PromptOptions): Promise<PromptRecognizerResult<boolean>>;
+    /**
+       * @private
+       */
+    private determineCulture;
+}
+export {};