@microsoft/agents-hosting-dialogs 0.2.10-g3ac88ff25e → 0.3.5

package/dist/src/memory/turnPath.js

@@ -6,33 +6,69 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TurnPath = void 0;
 /**
- * Defines path for avaiable turns.
+ * Defines path for available turns.
  */
 class TurnPath {
 }
 exports.TurnPath = TurnPath;
-/// The result from the last dialog that was called.
+/**
+ * The result from the last dialog that was called.
+ * @constant A string key representing the last result path (`'turn.lastresult'`).
+ */
 TurnPath.lastResult = 'turn.lastresult';
-/// The current activity for the turn.
+/**
+ * The current activity for the turn.
+ * @constant A string key representing the activity path (`'turn.activity'`).
+ */
 TurnPath.activity = 'turn.activity';
-/// The recognized result for the current turn.
+/**
+ * The recognized result for the current turn.
+ * @constant A string key representing the recognized result path (`'turn.recognized'`).
+ */
 TurnPath.recognized = 'turn.recognized';
-/// Path to the top intent.
+/**
+ * Path to the top intent.
+ * @constant A string key representing the top intent path (`'turn.recognized.intent'`).
+ */
 TurnPath.topIntent = 'turn.recognized.intent';
-/// Path to the top score.
+/**
+ * Path to the top score.
+ * @constant A string key representing the top score path (`'turn.recognized.score'`).
+ */
 TurnPath.topScore = 'turn.recognized.score';
-/// Original text.
+/**
+ * Original text.
+ * @constant A string key representing the original text path (`'turn.recognized.text'`).
+ */
 TurnPath.text = 'turn.recognized.text';
-/// Original utterance split into unrecognized strings.
+/**
+ * Original utterance split into unrecognized strings.
+ * @constant A string key representing the unrecognized text path (`'turn.unrecognizedText'`).
+ */
 TurnPath.unrecognizedText = 'turn.unrecognizedText';
-/// Entities that were recognized from text.
+/**
+ * Entities that were recognized from text.
+ * @constant A string key representing the recognized entities path (`'turn.recognizedEntities'`).
+ */
 TurnPath.recognizedEntities = 'turn.recognizedEntities';
-/// If true an interruption has occured.
+/**
+ * If true, an interruption has occurred.
+ * @constant A string key representing the interrupted path (`'turn.interrupted'`).
+ */
 TurnPath.interrupted = 'turn.interrupted';
-/// The current dialog event (set during event processings).
+/**
+ * The current dialog event (set during event processing).
+ * @constant A string key representing the dialog event path (`'turn.dialogEvent'`).
+ */
 TurnPath.dialogEvent = 'turn.dialogEvent';
-/// Used to track that we don't end up in infinite loop of RepeatDialogs().
+/**
+ * Used to track that we don't end up in an infinite loop of RepeatDialogs().
+ * @constant A string key representing the repeated IDs path (`'turn.repeatedIds'`).
+ */
 TurnPath.repeatedIds = 'turn.repeatedIds';
-/// This is a bool which if set means that the turncontext.activity has been consumed by some component in the system.
+/**
+ * Indicates whether the turncontext.activity has been consumed by some component in the system.
+ * @constant A string key representing the activity processed path (`'turn.activityProcessed'`).
+ */
 TurnPath.activityProcessed = 'turn.activityProcessed';
 //# sourceMappingURL=turnPath.js.map

package/dist/src/memory/turnPath.js.map

@@ -1 +1 @@
-{"version":3,"file":"turnPath.js","sourceRoot":"","sources":["../../../src/memory/turnPath.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,QAAQ;;AAArB,4BAoCC;AAnCC,oDAAoD;AACpC,mBAAU,GAAG,iBAAiB,CAAA;AAE9C,sCAAsC;AACtB,iBAAQ,GAAG,eAAe,CAAA;AAE1C,+CAA+C;AAC/B,mBAAU,GAAG,iBAAiB,CAAA;AAE9C,2BAA2B;AACX,kBAAS,GAAG,wBAAwB,CAAA;AAEpD,0BAA0B;AACV,iBAAQ,GAAG,uBAAuB,CAAA;AAElD,kBAAkB;AACF,aAAI,GAAG,sBAAsB,CAAA;AAE7C,uDAAuD;AACvC,yBAAgB,GAAG,uBAAuB,CAAA;AAE1D,4CAA4C;AAC5B,2BAAkB,GAAG,yBAAyB,CAAA;AAE9D,wCAAwC;AACxB,oBAAW,GAAG,kBAAkB,CAAA;AAEhD,4DAA4D;AAC5C,oBAAW,GAAG,kBAAkB,CAAA;AAEhD,2EAA2E;AAC3D,oBAAW,GAAG,kBAAkB,CAAA;AAEhD,sHAAsH;AACtG,0BAAiB,GAAG,wBAAwB,CAAA"}
+{"version":3,"file":"turnPath.js","sourceRoot":"","sources":["../../../src/memory/turnPath.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,QAAQ;;AAArB,4BAwEC;AAvEC;;;GAGG;AACa,mBAAU,GAAW,iBAAiB,CAAA;AAEtD;;;GAGG;AACa,iBAAQ,GAAW,eAAe,CAAA;AAElD;;;GAGG;AACa,mBAAU,GAAW,iBAAiB,CAAA;AAEtD;;;GAGG;AACa,kBAAS,GAAW,wBAAwB,CAAA;AAE5D;;;GAGG;AACa,iBAAQ,GAAW,uBAAuB,CAAA;AAE1D;;;GAGG;AACa,aAAI,GAAW,sBAAsB,CAAA;AAErD;;;GAGG;AACa,yBAAgB,GAAW,uBAAuB,CAAA;AAElE;;;GAGG;AACa,2BAAkB,GAAW,yBAAyB,CAAA;AAEtE;;;GAGG;AACa,oBAAW,GAAW,kBAAkB,CAAA;AAExD;;;GAGG;AACa,oBAAW,GAAW,kBAAkB,CAAA;AAExD;;;GAGG;AACa,oBAAW,GAAW,kBAAkB,CAAA;AAExD;;;GAGG;AACa,0BAAiB,GAAW,wBAAwB,CAAA"}

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

@@ -9,7 +9,7 @@ import { Attachment } from '@microsoft/agents-activity';
  * Prompts a user to upload attachments like images.
  *
  * @remarks
- * By default the prompt will return to the calling dialog an `Attachment[]`.
+ * By default the prompt will return to the calling dialog an {@link Attachment[]}.
  */
 export declare class AttachmentPrompt extends Prompt<Attachment[]> {
     constructor(dialogId: string, validator?: PromptValidator<Attachment[]>);

package/dist/src/prompts/attachmentPrompt.js

@@ -7,7 +7,7 @@ const agents_activity_1 = require("@microsoft/agents-activity");
  * Prompts a user to upload attachments like images.
  *
  * @remarks
- * By default the prompt will return to the calling dialog an `Attachment[]`.
+ * By default the prompt will return to the calling dialog an {@link Attachment[]}.
  */
 class AttachmentPrompt extends prompt_1.Prompt {
     // eslint-disable-next-line @typescript-eslint/no-useless-constructor

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

@@ -5,19 +5,33 @@
 import { TurnContext } from '@microsoft/agents-hosting';
 import { ChoiceFactoryOptions, FindChoicesOptions, FoundChoice } from '../choices';
 import { ListStyle, Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
-interface ChoiceDefaultsChoicePrompt {
+/**
+ * Represents a dictionary of default choice options for different locales.
+ *
+ * @remarks
+ * This interface is used to define the default options for rendering choices in prompts,
+ * such as separators, inline options, and whether to include numbers.
+ */
+export interface ChoiceDefaultsChoicePrompt {
+    /**
+     * A mapping of locale strings to their corresponding choice factory options.
+     *
+     * @remarks
+     * Each locale key maps to a `ChoiceFactoryOptions` object that defines the
+     * default behavior for rendering choices in that locale.
+     */
     [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
+ * By default the prompt will return to the calling dialog a {@link FoundChoice} object containing the
  * choice that was selected.
  */
 export declare class ChoicePrompt extends Prompt<FoundChoice> {
     /**
-       * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+       * A dictionary of Default Choices based on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures method}.
        * Can be replaced by user using the constructor that contains choiceDefaults.
        */
     private choiceDefaults;
@@ -38,7 +52,7 @@ export declare class ChoicePrompt extends Prompt<FoundChoice> {
        */
     choiceOptions: ChoiceFactoryOptions | undefined;
     /**
-       * Additional options passed to the underlying `recognizeChoices()` function.
+       * Additional options passed to the underlying {@link recognizeChoices | recognizeChoices function }.
        */
     recognizerOptions: FindChoicesOptions | undefined;
     /**
@@ -80,4 +94,3 @@ export declare class ChoicePrompt extends Prompt<FoundChoice> {
        */
     private determineCulture;
 }
-export {};

package/dist/src/prompts/choicePrompt.js

@@ -8,7 +8,7 @@ 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
+ * By default the prompt will return to the calling dialog a {@link FoundChoice} object containing the
  * choice that was selected.
  */
 class ChoicePrompt extends prompt_1.Prompt {

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

@@ -1 +1 @@
-{"version":3,"file":"choicePrompt.js","sourceRoot":"","sources":["../../../src/prompts/choicePrompt.ts"],"names":[],"mappings":";;;AAKA,wCAAmH;AACnH,qCAAoG;AACpG,+DAA2D;AAQ3D;;;;;;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"}
+{"version":3,"file":"choicePrompt.js","sourceRoot":"","sources":["../../../src/prompts/choicePrompt.ts"],"names":[],"mappings":";;;AAKA,wCAAmH;AACnH,qCAAoG;AACpG,+DAA2D;AAuB3D;;;;;;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

@@ -1,7 +1,7 @@
 import { TurnContext } from '@microsoft/agents-hosting';
 import { Choice, ChoiceFactoryOptions } from '../choices';
 import { ListStyle, Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
-interface ChoiceDefaultsConfirmPrompt {
+export interface ChoiceDefaultsConfirmPrompt {
     [locale: string]: {
         choices: (string | Choice)[];
         options: ChoiceFactoryOptions;
@@ -16,7 +16,7 @@ interface ChoiceDefaultsConfirmPrompt {
  */
 export declare class ConfirmPrompt extends Prompt<boolean> {
     /**
-       * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+       * A dictionary of Default Choices based on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method.
        * Can be replaced by user using the constructor that contains choiceDefaults.
        * This is initially set in the constructor.
        */
@@ -29,11 +29,11 @@ export declare class ConfirmPrompt extends Prompt<boolean> {
        * Style of the "yes" and "no" choices rendered to the user when prompting.
        *
        * @remarks
-       * Defaults to `ListStyle.auto`.
+       * Defaults to {@link ListStyle.auto}.
        */
     style: ListStyle;
     /**
-       * Additional options passed to the `ChoiceFactory` and used to tweak the style of choices
+       * Additional options passed to the {@link ChoiceFactory } and used to tweak the style of choices
        * rendered to the user.
        */
     choiceOptions: ChoiceFactoryOptions | undefined;
@@ -44,10 +44,10 @@ export declare class ConfirmPrompt extends Prompt<boolean> {
     /**
        * Creates a new ConfirmPrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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()]].
+       * @param defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
+       * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method.
        */
     constructor(dialogId: string, validator?: PromptValidator<boolean>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsConfirmPrompt);
     /**
@@ -79,4 +79,3 @@ export declare class ConfirmPrompt extends Prompt<boolean> {
        */
     private determineCulture;
 }
-export {};

package/dist/src/prompts/confirmPrompt.js

@@ -53,10 +53,10 @@ class ConfirmPrompt extends prompt_1.Prompt {
     /**
        * Creates a new ConfirmPrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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()]].
+       * @param defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
+       * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method.
        */
     constructor(dialogId, validator, defaultLocale, choiceDefaults) {
         super(dialogId, validator);

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

@@ -1,7 +1,7 @@
 import { TurnContext } from '@microsoft/agents-hosting';
 import { Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt';
 /**
- * Result returned by the `DateTimePrompt`.
+ * Result returned by the {@link DateTimePrompt}.
  */
 export interface DateTimeResolution {
     /**
@@ -14,8 +14,8 @@ export interface DateTimeResolution {
        */
     type: string;
     /**
-       * Value of the specified [type](#type) that's a reasonable approximation given the ambiguity
-       * of the [timex](#timex).
+       * Value of the specified `type` that's a reasonable approximation given the ambiguity
+       * of the `timex`.
        */
     value: string;
 }
@@ -23,7 +23,7 @@ export interface DateTimeResolution {
  * Prompts a user to enter a datetime expression.
  *
  * @remarks
- * By default the prompt will return to the calling dialog a `DateTimeResolution[]`.
+ * By default the prompt will return to the calling dialog a {@link DateTimeResolution | DateTimeResolution[] }.
  */
 export declare class DateTimePrompt extends Prompt<DateTimeResolution[]> {
     /**
@@ -33,9 +33,9 @@ export declare class DateTimePrompt extends Prompt<DateTimeResolution[]> {
     /**
        * Creates a new DateTimePrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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 defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
        */
     constructor(dialogId: string, validator?: PromptValidator<DateTimeResolution[]>, defaultLocale?: string);
     /**

package/dist/src/prompts/datetimePrompt.js

@@ -45,15 +45,15 @@ const agents_activity_1 = require("@microsoft/agents-activity");
  * Prompts a user to enter a datetime expression.
  *
  * @remarks
- * By default the prompt will return to the calling dialog a `DateTimeResolution[]`.
+ * By default the prompt will return to the calling dialog a {@link DateTimeResolution | DateTimeResolution[] }.
  */
 class DateTimePrompt extends prompt_1.Prompt {
     /**
        * Creates a new DateTimePrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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 defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
        */
     constructor(dialogId, validator, defaultLocale) {
         super(dialogId, validator);

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

@@ -18,18 +18,18 @@ export declare class NumberPrompt extends Prompt<number> {
     /**
        * Creates a new NumberPrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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 defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
        */
     constructor(dialogId: string, validator?: PromptValidator<number>, defaultLocale?: string);
     /**
        * Prompts the user for input.
        *
-       * @param context [TurnContext] context for the current
+       * @param context {@link 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
+       * @param options A {@link 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.
@@ -39,10 +39,10 @@ export declare class NumberPrompt extends Prompt<number> {
     /**
        * Attempts to recognize the user's input.
        *
-       * @param context [TurnContext], context for the current
+       * @param context {@link 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
+       * @param _options A {@link PromptOptions} object constructed
        * from the options initially provided in the call to Prompt.
        * @returns A `Promise` representing the asynchronous operation.
        */

package/dist/src/prompts/numberPrompt.js

@@ -58,9 +58,9 @@ class NumberPrompt extends prompt_1.Prompt {
     /**
        * Creates a new NumberPrompt instance.
        *
-       * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link 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 defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
        */
     constructor(dialogId, validator, defaultLocale) {
         super(dialogId, validator);
@@ -69,10 +69,10 @@ class NumberPrompt extends prompt_1.Prompt {
     /**
        * Prompts the user for input.
        *
-       * @param context [TurnContext] context for the current
+       * @param context {@link 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
+       * @param options A {@link 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.
@@ -89,10 +89,10 @@ class NumberPrompt extends prompt_1.Prompt {
     /**
        * Attempts to recognize the user's input.
        *
-       * @param context [TurnContext], context for the current
+       * @param context {@link 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
+       * @param _options A {@link PromptOptions} object constructed
        * from the options initially provided in the call to Prompt.
        * @returns A `Promise` representing the asynchronous operation.
        */

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

@@ -12,7 +12,7 @@ import { DialogReason } from '../dialogReason';
 import { DialogEvent } from '../dialogEvent';
 import { Activity } from '@microsoft/agents-activity';
 /**
- * Controls the way that choices for a `ChoicePrompt` or yes/no options for a `ConfirmPrompt` are
+ * Controls the way that choices for a {@link ChoicePrompt} or yes/no options for a {@link ConfirmPrompt} are
  * presented to a user.
  */
 export declare enum ListStyle {
@@ -78,12 +78,12 @@ export interface PromptOptions {
  */
 export interface PromptRecognizerResult<T> {
     /**
-       * If `true` the users utterance was successfully recognized and [value](#value) contains the
+       * If `true` the user's utterance was successfully recognized and `value` contains the
        * recognized result.
        */
     succeeded: boolean;
     /**
-       * Value that was recognized if [succeeded](#succeeded) is `true`.
+       * Value that was recognized if `succeeded` is `true`.
        */
     value?: T;
 }
@@ -101,7 +101,7 @@ export interface PromptRecognizerResult<T> {
  * > [!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.
+ * > case the prompts default re-prompt logic will not be run.
  * @param T Type of recognizer result being validated.
  * @param prompt Contextual information containing the recognizer result and original options passed to the prompt.
  */
@@ -123,8 +123,8 @@ export interface PromptValidatorContext<T> {
        * 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`.
+       * The {@link prompt.recognized.succeeded} field can be checked to determine of the recognizer found
+       * anything and then the value can be retrieved from {@link prompt.recognized.value}.
        */
     readonly recognized: PromptRecognizerResult<T>;
     /**
@@ -158,7 +158,7 @@ export declare abstract class Prompt<T> extends Dialog {
     /**
        * Creates a new Prompt instance.
        *
-       * @param dialogId Unique ID of the prompt within its parent `DialogSet` or `ComponentDialog`.
+       * @param dialogId Unique ID of the prompt within its parent {@link DialogSet} or {@link 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>);

package/dist/src/prompts/prompt.js

@@ -10,7 +10,7 @@ const choices_1 = require("../choices");
 const dialog_1 = require("../dialog");
 const agents_activity_1 = require("@microsoft/agents-activity");
 /**
- * Controls the way that choices for a `ChoicePrompt` or yes/no options for a `ConfirmPrompt` are
+ * Controls the way that choices for a {@link ChoicePrompt} or yes/no options for a {@link ConfirmPrompt} are
  * presented to a user.
  */
 var ListStyle;
@@ -49,7 +49,7 @@ 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 dialogId Unique ID of the prompt within its parent {@link DialogSet} or {@link ComponentDialog}.
        * @param validator (Optional) custom validator used to provide additional validation and re-prompting logic for the prompt.
        */
     constructor(dialogId, validator) {

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

@@ -46,27 +46,62 @@ export interface PromptCultureModel {
  * Class container for currently-supported Culture Models in Confirm and Choice Prompt.
  */
 export declare class PromptCultureModels {
+    /**
+     * Represents the Chinese culture model with locale and language-specific settings.
+     */
     static Chinese: PromptCultureModel;
+    /**
+     * Represents the Dutch culture model with locale and language-specific settings.
+     */
     static Dutch: PromptCultureModel;
+    /**
+     * Represents the English culture model with locale and language-specific settings.
+     */
     static English: PromptCultureModel;
+    /**
+     * Represents the French culture model with locale and language-specific settings.
+     */
     static French: PromptCultureModel;
+    /**
+     * Represents the German culture model with locale and language-specific settings.
+     */
     static German: PromptCultureModel;
+    /**
+     * Represents the Italian culture model with locale and language-specific settings.
+     */
     static Italian: PromptCultureModel;
+    /**
+     * Represents the Japanese culture model with locale and language-specific settings.
+     */
     static Japanese: PromptCultureModel;
+    /**
+     * Represents the Portuguese culture model with locale and language-specific settings.
+     */
     static Portuguese: PromptCultureModel;
+    /**
+     * Represents the Spanish culture model with locale and language-specific settings.
+     */
     static Spanish: PromptCultureModel;
     /**
+       * Retrieves a list of supported culture codes.
+       *
+       * @returns An array of supported locale strings.
        * @private
        */
     private static getSupportedCultureCodes;
     /**
-       * Use Recognizers-Text to normalize various potential Locale strings to a standard.
+       * Normalizes a given locale string to the nearest supported language.
        *
+       * @param cultureCode The locale string to normalize (e.g., "en-US").
+       * @returns The normalized locale string.
        * @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;
+    /**
+       * Retrieves a list of supported culture models.
+       *
+       * @returns An array of `PromptCultureModel` objects representing supported cultures.
+       */
     static getSupportedCultures: () => PromptCultureModel[];
 }