@microsoft/agents-hosting-dialogs 0.1.49

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

@@ -0,0 +1,256 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Activity, TurnContext } from '@microsoft/agents-hosting';
+import { Choice, ChoiceFactoryOptions } from '../choices';
+import { Dialog } from '../dialog';
+import { DialogContext } from '../dialogContext';
+import { DialogInstance } from '../dialogInstance';
+import { DialogTurnResult } from '../dialogTurnResult';
+import { DialogReason } from '../dialogReason';
+import { DialogEvent } from '../dialogEvent';
+/**
+ * Controls the way that choices for a `ChoicePrompt` or yes/no options for a `ConfirmPrompt` are
+ * presented to a user.
+ */
+export declare enum ListStyle {
+    /**
+       * Don't include any choices for prompt.
+       */
+    none = 0,
+    /**
+       * Automatically select the appropriate style for the current channel.
+       */
+    auto = 1,
+    /**
+       * Add choices to prompt as an inline list.
+       */
+    inline = 2,
+    /**
+       * Add choices to prompt as a numbered list.
+       */
+    list = 3,
+    /**
+       * Add choices to prompt as suggested actions.
+       */
+    suggestedAction = 4,
+    /**
+       * Add choices to prompt as a HeroCard with buttons.
+       */
+    heroCard = 5
+}
+/**
+ * Basic configuration options supported by all prompts.
+ */
+export interface PromptOptions {
+    /**
+       * (Optional) Initial prompt to send the user.
+       */
+    prompt?: string | Activity;
+    /**
+       * (Optional) Retry prompt to send the user.
+       */
+    retryPrompt?: string | Activity;
+    /**
+       * (Optional) List of choices associated with the prompt.
+       */
+    choices?: (string | Choice)[];
+    /**
+       * (Optional) Property that can be used to override or set the value of ChoicePrompt.Style
+       * when the prompt is executed using DialogContext.prompt.
+       */
+    style?: ListStyle;
+    /**
+       * (Optional) Additional validation rules to pass the prompts validator routine.
+       */
+    validations?: object;
+    /**
+       * The locale to be use for recognizing the utterance.
+       */
+    recognizeLanguage?: string;
+}
+/**
+ * Result returned by a prompts recognizer function.
+ *
+ * @param T Type of value being recognized.
+ */
+export interface PromptRecognizerResult<T> {
+    /**
+       * If `true` the users utterance was successfully recognized and [value](#value) contains the
+       * recognized result.
+       */
+    succeeded: boolean;
+    /**
+       * Value that was recognized if [succeeded](#succeeded) is `true`.
+       */
+    value?: T;
+}
+/**
+ * Function signature for providing a custom prompt validator.
+ *
+ * ```TypeScript
+ * type PromptValidator<T> = (prompt: PromptValidatorContext<T>) => Promise<boolean>;
+ * ```
+ *
+ * @remarks
+ * The validator should be an asynchronous function that returns `true` if
+ * `prompt.recognized.value` is valid and the prompt should end.
+ *
+ * > [!NOTE]
+ * > If the validator returns `false` the prompts default re-prompt logic will be run unless the
+ * > validator sends a custom re-prompt to the user using `prompt.context.sendActivity()`. In that
+ * > case the prompts default re-rpompt logic will not be run.
+ * @param T Type of recognizer result being validated.
+ * @param PromptValidator.prompt Contextual information containing the recognizer result and original options passed to the prompt.
+ */
+export type PromptValidator<T> = (prompt: PromptValidatorContext<T>) => Promise<boolean>;
+/**
+ * Contextual information passed to a custom `PromptValidator`.
+ *
+ * @param T Type of recognizer result being validated.
+ */
+export interface PromptValidatorContext<T> {
+    /**
+       * The context for the current turn of conversation with the user.
+       *
+       * @remarks
+       * The validator can use this to re-prompt the user.
+       */
+    readonly context: TurnContext;
+    /**
+       * Result returned from the prompts recognizer function.
+       *
+       * @remarks
+       * The `prompt.recognized.succeeded` field can be checked to determine of the recognizer found
+       * anything and then the value can be retrieved from `prompt.recognized.value`.
+       */
+    readonly recognized: PromptRecognizerResult<T>;
+    /**
+       * A dictionary of values persisted for each conversational turn while the prompt is active.
+       *
+       * @remarks
+       * The validator can use this to persist things like turn counts or other state information.
+       */
+    readonly state: object;
+    /**
+       * Original set of options passed to the prompt by the calling dialog.
+       *
+       * @remarks
+       * The validator can extend this interface to support additional prompt options.
+       */
+    readonly options: PromptOptions;
+    /**
+       * A count of the number of times the prompt has been executed.
+       *
+       * A number indicating how many times the prompt was invoked (starting at 1 for the first time it was invoked).
+       */
+    readonly attemptCount: number;
+}
+/**
+ * Base class for all prompts.
+ *
+ * @param T Type of value being returned by the prompts recognizer function.
+ */
+export declare abstract class Prompt<T> extends Dialog {
+    private validator?;
+    /**
+       * Creates a new Prompt instance.
+       *
+       * @param dialogId Unique ID of the prompt within its parent `DialogSet` or `ComponentDialog`.
+       * @param validator (Optional) custom validator used to provide additional validation and re-prompting logic for the prompt.
+       */
+    protected constructor(dialogId: string, validator?: PromptValidator<T>);
+    /**
+       * 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 Optional. PromptOptions,
+       * additional information to pass to the prompt being started.
+       * @returns A `Promise` representing the asynchronous operation.
+       * @remarks
+       * If the task is successful, the result indicates whether the prompt is still
+       * active after the turn has been processed by the prompt.
+       */
+    beginDialog(dialogContext: DialogContext, options: PromptOptions): Promise<DialogTurnResult>;
+    /**
+       * 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 task 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.
+       */
+    continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult>;
+    /**
+       * Called before an event is bubbled to its parent.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @param event DialogEvent, the event being raised.
+       * @returns Whether the event is handled by the current dialog and further processing should stop.
+       * @remarks
+       * This is a good place to perform interception of an event as returning `true` will prevent
+       * any further bubbling of the event to the dialogs parents and will also prevent any child
+       * dialogs from performing their default processing.
+       */
+    protected onPreBubbleEvent(dialogContext: DialogContext, event: DialogEvent): Promise<boolean>;
+    /**
+       * 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 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.
+       * @remarks
+       * If the task is successful, the result indicates whether the dialog is still
+       * active after the turn has been processed by the dialog.
+       */
+    resumeDialog(dialogContext: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>;
+    /**
+       * 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.
+       */
+    repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>;
+    /**
+       * Called anytime the derived class should send the user a prompt.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @param state Additional state being persisted for the prompt.
+       * @param options Options that the prompt was started with in the call to `DialogContext.prompt()`.
+       * @param isRetry If `true` the users response wasn't recognized and the re-prompt should be sent.
+       */
+    protected abstract onPrompt(context: TurnContext, state: object, options: PromptOptions, isRetry: boolean): Promise<void>;
+    /**
+       * Called to recognize an utterance received from the user.
+       *
+       * @remarks
+       * The Prompt class filters out non-message activities so its safe to assume that the users
+       * utterance can be retrieved from `context.activity.text`.
+       * @param context Context for the current turn of conversation with the user.
+       * @param state Additional state being persisted for the prompt.
+       * @param options Options that the prompt was started with in the call to `DialogContext.prompt()`.
+       */
+    protected abstract onRecognize(context: TurnContext, state: object, options: PromptOptions): Promise<PromptRecognizerResult<T>>;
+    /**
+       * Helper function to compose an output activity containing a set of choices.
+       *
+       * @param prompt The prompt to append the users choices to.
+       * @param channelId ID of the channel the prompt is being sent to.
+       * @param choices List of choices to append.
+       * @param style Configured style for the list of choices.
+       * @param options (Optional) options to configure the underlying ChoiceFactory call.
+       * @returns The composed activity ready to send to the user.
+       */
+    protected appendChoices(prompt: string | Activity, channelId: string, choices: (string | Choice)[], style: ListStyle, options?: ChoiceFactoryOptions): Activity;
+}

package/dist/src/prompts/prompt.js

@@ -0,0 +1,260 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prompt = exports.ListStyle = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const choices_1 = require("../choices");
+const dialog_1 = require("../dialog");
+/**
+ * Controls the way that choices for a `ChoicePrompt` or yes/no options for a `ConfirmPrompt` are
+ * presented to a user.
+ */
+var ListStyle;
+(function (ListStyle) {
+    /**
+       * Don't include any choices for prompt.
+       */
+    ListStyle[ListStyle["none"] = 0] = "none";
+    /**
+       * Automatically select the appropriate style for the current channel.
+       */
+    ListStyle[ListStyle["auto"] = 1] = "auto";
+    /**
+       * Add choices to prompt as an inline list.
+       */
+    ListStyle[ListStyle["inline"] = 2] = "inline";
+    /**
+       * Add choices to prompt as a numbered list.
+       */
+    ListStyle[ListStyle["list"] = 3] = "list";
+    /**
+       * Add choices to prompt as suggested actions.
+       */
+    ListStyle[ListStyle["suggestedAction"] = 4] = "suggestedAction";
+    /**
+       * Add choices to prompt as a HeroCard with buttons.
+       */
+    ListStyle[ListStyle["heroCard"] = 5] = "heroCard";
+})(ListStyle || (exports.ListStyle = ListStyle = {}));
+/**
+ * Base class for all prompts.
+ *
+ * @param T Type of value being returned by the prompts recognizer function.
+ */
+class Prompt extends dialog_1.Dialog {
+    /**
+       * Creates a new Prompt instance.
+       *
+       * @param dialogId Unique ID of the prompt within its parent `DialogSet` or `ComponentDialog`.
+       * @param validator (Optional) custom validator used to provide additional validation and re-prompting logic for the prompt.
+       */
+    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 Optional. PromptOptions,
+       * additional information to pass to the prompt being started.
+       * @returns A `Promise` representing the asynchronous operation.
+       * @remarks
+       * If the task 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 task 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) {
+        // Don't do anything for non-message activities
+        if (dialogContext.context.activity.type !== agents_hosting_1.ActivityTypes.Message) {
+            return dialog_1.Dialog.EndOfTurn;
+        }
+        // Are we being continued after an interruption?
+        // - The stepCount will be 1 or more if we're running in the context of an AdaptiveDialog
+        //   and we're coming back from an interruption.
+        const stepCount = dialogContext.state.getValue('turn.stepCount');
+        if (typeof stepCount === 'number' && stepCount > 0) {
+            // re-prompt and then end
+            await this.repromptDialog(dialogContext.context, dialogContext.activeDialog);
+            return dialog_1.Dialog.EndOfTurn;
+        }
+        // Perform base recognition
+        const state = dialogContext.activeDialog.state;
+        const recognized = await this.onRecognize(dialogContext.context, state.state, state.options);
+        // Validate the return value
+        let isValid = false;
+        if (this.validator) {
+            if (state.state['attemptCount'] === undefined) {
+                state.state['attemptCount'] = 0;
+            }
+            isValid = await this.validator({
+                context: dialogContext.context,
+                recognized,
+                state: state.state,
+                options: state.options,
+                attemptCount: ++state.state['attemptCount'],
+            });
+        }
+        else if (recognized.succeeded) {
+            isValid = true;
+        }
+        // Return recognized value or re-prompt
+        if (isValid) {
+            return await dialogContext.endDialog(recognized.value);
+        }
+        else {
+            if (!dialogContext.context.responded) {
+                await this.onPrompt(dialogContext.context, state.state, state.options, true);
+            }
+            return dialog_1.Dialog.EndOfTurn;
+        }
+    }
+    /**
+       * Called before an event is bubbled to its parent.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @param event DialogEvent, the event being raised.
+       * @returns Whether the event is handled by the current dialog and further processing should stop.
+       * @remarks
+       * This is a good place to perform interception of an event as returning `true` will prevent
+       * any further bubbling of the event to the dialogs parents and will also prevent any child
+       * dialogs from performing their default processing.
+       */
+    async onPreBubbleEvent(dialogContext, event) {
+        if (event.name === 'activityReceived' && dialogContext.context.activity.type === agents_hosting_1.ActivityTypes.Message) {
+            // Perform base recognition
+            const state = dialogContext.activeDialog.state;
+            const recognized = await this.onRecognize(dialogContext.context, state.state, state.options);
+            return recognized.succeeded;
+        }
+        return false;
+    }
+    /**
+       * 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 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.
+       * @remarks
+       * If the task is successful, the result indicates whether the dialog is still
+       * active after the turn has been processed by the dialog.
+       */
+    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);
+    }
+    /**
+       * Helper function to compose an output activity containing a set of choices.
+       *
+       * @param prompt The prompt to append the users choices to.
+       * @param channelId ID of the channel the prompt is being sent to.
+       * @param choices List of choices to append.
+       * @param style Configured style for the list of choices.
+       * @param options (Optional) options to configure the underlying ChoiceFactory call.
+       * @returns The composed activity ready to send to the user.
+       */
+    appendChoices(prompt, channelId, choices, style, options) {
+        // Get base prompt text (if any)
+        let text = '';
+        if (typeof prompt === 'string') {
+            text = prompt;
+        }
+        else if (prompt && prompt.text) {
+            text = prompt.text;
+        }
+        // Create temporary msg
+        let msg;
+        switch (style) {
+            case ListStyle.inline:
+                msg = choices_1.ChoiceFactory.inline(choices, text, undefined, options);
+                break;
+            case ListStyle.list:
+                msg = choices_1.ChoiceFactory.list(choices, text, undefined, options);
+                break;
+            case ListStyle.none:
+                msg = agents_hosting_1.MessageFactory.text(text);
+                break;
+            default:
+                msg = choices_1.ChoiceFactory.forChannel(channelId, choices, text, undefined, options);
+                break;
+        }
+        // Update prompt with text, actions and attachments
+        if (typeof prompt === 'object') {
+            // Clone the prompt Activity as to not modify the original prompt.
+            prompt = JSON.parse(JSON.stringify(prompt));
+            prompt.text = msg.text;
+            if (msg.suggestedActions &&
+                Array.isArray(msg.suggestedActions.actions) &&
+                msg.suggestedActions.actions.length > 0) {
+                prompt.suggestedActions = msg.suggestedActions;
+            }
+            if (msg.attachments) {
+                if (prompt.attachments) {
+                    prompt.attachments = prompt.attachments.concat(msg.attachments);
+                }
+                else {
+                    prompt.attachments = msg.attachments;
+                }
+            }
+            return prompt;
+        }
+        else {
+            msg.inputHint = agents_hosting_1.InputHints.ExpectingInput;
+            return msg;
+        }
+    }
+}
+exports.Prompt = Prompt;
+//# sourceMappingURL=prompt.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../src/prompts/prompt.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,8DAA4G;AAC5G,wCAAwE;AACxE,sCAAkC;AAOlC;;;GAGG;AACH,IAAY,SA8BX;AA9BD,WAAY,SAAS;IACnB;;SAEK;IACL,yCAAI,CAAA;IAEJ;;SAEK;IACL,yCAAI,CAAA;IAEJ;;SAEK;IACL,6CAAM,CAAA;IAEN;;SAEK;IACL,yCAAI,CAAA;IAEJ;;SAEK;IACL,+DAAe,CAAA;IAEf;;SAEK;IACL,iDAAQ,CAAA;AACV,CAAC,EA9BW,SAAS,yBAAT,SAAS,QA8BpB;AA2HD;;;;GAIG;AACH,MAAsB,MAAU,SAAQ,eAAM;IAC5C;;;;;SAKK;IACL,YACE,QAAgB,EACR,SAA8B;QAEtC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAFP,cAAS,GAAT,SAAS,CAAqB;IAGxC,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,GAAgB,aAAa,CAAC,YAAY,CAAC,KAAoB,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;;;;;;;;;;SAUK;IACL,KAAK,CAAC,cAAc,CAAE,aAA4B;QAChD,+CAA+C;QAC/C,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,8BAAa,CAAC,OAAO,EAAE,CAAC;YAClE,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;QAED,gDAAgD;QAChD,yFAAyF;QACzF,gDAAgD;QAChD,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QAChE,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YACnD,yBAAyB;YACzB,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;YAC5E,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;QAED,2BAA2B;QAC3B,MAAM,KAAK,GAAgB,aAAa,CAAC,YAAY,CAAC,KAAoB,CAAA;QAC1E,MAAM,UAAU,GAA8B,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;QAEvH,4BAA4B;QAC5B,IAAI,OAAO,GAAG,KAAK,CAAA;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9C,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;YACjC,CAAC;YACD,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;gBAC7B,OAAO,EAAE,aAAa,CAAC,OAAO;gBAC9B,UAAU;gBACV,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,YAAY,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC;aAC5C,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YAChC,OAAO,GAAG,IAAI,CAAA;QAChB,CAAC;QAED,uCAAuC;QACvC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,MAAM,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACxD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBACrC,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;;;;;;;;;;SAUK;IACK,KAAK,CAAC,gBAAgB,CAAE,aAA4B,EAAE,KAAkB;QAChF,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,8BAAa,CAAC,OAAO,EAAE,CAAC;YACvG,2BAA2B;YAC3B,MAAM,KAAK,GAAgB,aAAa,CAAC,YAAY,CAAC,KAAoB,CAAA;YAC1E,MAAM,UAAU,GAA8B,MAAM,IAAI,CAAC,WAAW,CAClE,aAAa,CAAC,OAAO,EACrB,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,OAAO,CACd,CAAA;YACD,OAAO,UAAU,CAAC,SAAS,CAAA;QAC7B,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;SAYK;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,GAAgB,QAAQ,CAAC,KAAoB,CAAA;QACxD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACjE,CAAC;IAiCD;;;;;;;;;SASK;IACK,aAAa,CACrB,MAAyB,EACzB,SAAiB,EACjB,OAA4B,EAC5B,KAAgB,EAChB,OAA8B;QAE9B,gCAAgC;QAChC,IAAI,IAAI,GAAG,EAAE,CAAA;QACb,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,GAAG,MAAM,CAAA;QACf,CAAC;aAAM,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACpB,CAAC;QAED,uBAAuB;QACvB,IAAI,GAAa,CAAA;QACjB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,SAAS,CAAC,MAAM;gBACnB,GAAG,GAAG,uBAAa,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;gBAC7D,MAAK;YAEP,KAAK,SAAS,CAAC,IAAI;gBACjB,GAAG,GAAG,uBAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;gBAC3D,MAAK;YAEP,KAAK,SAAS,CAAC,IAAI;gBACjB,GAAG,GAAG,+BAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC/B,MAAK;YAEP;gBACE,GAAG,GAAG,uBAAa,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;gBAC5E,MAAK;QACT,CAAC;QAED,mDAAmD;QACnD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,kEAAkE;YAClE,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAa,CAAA;YACvD,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;YACtB,IACE,GAAG,CAAC,gBAAgB;gBACZ,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBAC3C,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAC/C,CAAC;gBACD,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAA;YAChD,CAAC;YAED,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;oBACvB,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;gBACjE,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAA;gBACtC,CAAC;YACH,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,SAAS,GAAG,2BAAU,CAAC,cAAc,CAAA;YAEzC,OAAO,GAAG,CAAA;QACZ,CAAC;IACH,CAAC;CACF;AAnRD,wBAmRC"}

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

@@ -0,0 +1,72 @@
+export interface PromptCultureModel {
+    /**
+       * Culture Model's Locale.
+       *
+       * @example
+       * "en-US"
+       */
+    locale: string;
+    /**
+       * Culture Model's InlineSeparator.
+       *
+       * @example
+       * ", "
+       */
+    separator: string;
+    /**
+       * Culture Model's InlineOr.
+       *
+       * @example
+       * " or "
+       */
+    inlineOr: string;
+    /**
+       * Culture Model's InlineOrMore.
+       *
+       * @example
+       * ", or "
+       */
+    inlineOrMore: string;
+    /**
+       * Equivalent of "Yes" in Culture Model's Language.
+       *
+       * @example
+       * "Yes"
+       */
+    yesInLanguage: string;
+    /**
+       * Equivalent of "No" in Culture Model's Language.
+       *
+       * @example
+       * "No"
+       */
+    noInLanguage: string;
+}
+/**
+ * Class container for currently-supported Culture Models in Confirm and Choice Prompt.
+ */
+export declare class PromptCultureModels {
+    static Chinese: PromptCultureModel;
+    static Dutch: PromptCultureModel;
+    static English: PromptCultureModel;
+    static French: PromptCultureModel;
+    static German: PromptCultureModel;
+    static Italian: PromptCultureModel;
+    static Japanese: PromptCultureModel;
+    static Portuguese: PromptCultureModel;
+    static Spanish: PromptCultureModel;
+    /**
+       * @private
+       */
+    private static getSupportedCultureCodes;
+    /**
+       * Use Recognizers-Text to normalize various potential Locale strings to a standard.
+       *
+       * @remarks This is mostly a copy/paste from https://github.com/microsoft/Recognizers-Text/blob/master/JavaScript/packages/recognizers-text/src/culture.ts#L39
+       *          This doesn't directly use Recognizers-Text's MapToNearestLanguage because if they add language support before we do, it will break our prompts.
+       * @param cultureCode Represents locale. Examples: "en-US, en-us, EN".
+       * @returns Normalized locale.
+       */
+    static mapToNearestLanguage(cultureCode: string): string;
+    static getSupportedCultures: () => PromptCultureModel[];
+}