@microsoft/agents-hosting-dialogs 1.0.0 → 1.0.3-g444d99f704

package/src/prompts/promptCultureModels.ts

@@ -8,6 +8,8 @@ import { Culture } from '@microsoft/recognizers-text-suite'
 export interface PromptCultureModel {
   /**
    * The locale identifier for this culture model.
+   *
+   * @remarks
    * This follows the standard IETF language tag format (e.g., "en-US", "fr-FR", "ja-JP").
    * Used to identify the target language and region for localization.
    *
@@ -22,6 +24,8 @@ export interface PromptCultureModel {
 
   /**
    * The separator string used to delimit items in a list when presenting choices.
+   *
+   * @remarks
    * This is typically used between items in the middle of a list, not before the final item.
    *
    * @example
@@ -33,6 +37,8 @@ export interface PromptCultureModel {
 
   /**
    * The conjunction string used before the final item in a two-item list.
+   *
+   * @remarks
    * This is used when presenting exactly two choices to the user.
    *
    * @example
@@ -46,6 +52,8 @@ export interface PromptCultureModel {
 
   /**
    * The conjunction string used before the final item in a list of three or more items.
+   *
+   * @remarks
    * This combines with the separator to create properly formatted choice lists.
    *
    * @example
@@ -59,6 +67,8 @@ export interface PromptCultureModel {
 
   /**
    * The affirmative response word in the target language.
+   *
+   * @remarks
    * Used in confirmation prompts and boolean choice scenarios.
    *
    * @example
@@ -72,6 +82,8 @@ export interface PromptCultureModel {
 
   /**
    * The negative response word in the target language.
+   *
+   * @remarks
    * Used in confirmation prompts and boolean choice scenarios.
    *
    * @example
@@ -211,8 +223,11 @@ export class PromptCultureModels {
      *
      * @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
+     *
+     * @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.
+     *
      */
   static mapToNearestLanguage (cultureCode: string): string {
     if (cultureCode) {

package/src/prompts/textPrompt.ts

@@ -13,6 +13,7 @@ import { InputHints } from '@microsoft/agents-activity'
  *
  * @remarks
  * By default the prompt will return to the calling dialog a `string` representing the users reply.
+ *
  */
 export class TextPrompt extends Prompt<string> {
   // eslint-disable-next-line @typescript-eslint/no-useless-constructor
@@ -72,10 +73,12 @@ export class TextPrompt extends Prompt<string> {
      * 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 async onPreBubbleEvent (_dc: DialogContext, _event: DialogEvent): Promise<boolean> {
     return false

package/src/recognizer.ts

@@ -15,6 +15,7 @@ import { RecognizerResult, getTopScoringIntent } from './recognizerResult'
  * This interface defines the configuration properties that can be used to customize
  * the behavior and identification of a recognizer. Recognizers use this configuration
  * to set up their basic properties and operational parameters.
+ *
  */
 export interface RecognizerConfiguration {
   /**
@@ -24,6 +25,7 @@ export interface RecognizerConfiguration {
    * The id property allows you to distinguish between multiple recognizer instances
    * and can be useful for logging, debugging, and telemetry purposes. If not provided,
    * the recognizer will operate without a specific identifier.
+   *
    */
   id?: string;
 }
@@ -35,6 +37,7 @@ export interface RecognizerConfiguration {
  * Recognizers process user input, such as text or speech, and return structured data representing
  * the recognized intents, entities, and other relevant information. This class provides a foundation
  * for creating custom recognizers by defining common methods and properties.
+ *
  */
 export class Recognizer extends Configurable implements RecognizerConfiguration {
   /**

package/src/recognizerResult.ts

@@ -35,7 +35,11 @@ export interface RecognizerResult {
 }
 
 /**
- * @summary Finds the intent with the highest confidence score from a recognizer result.
+ * Finds the intent with the highest confidence score from a recognizer result.
+ *
+ * @param result - The recognizer result containing intents and their scores
+ * @returns An object containing the top-scoring intent name and its confidence score
+ * @throws {Error} Throws an error if the result is empty or doesn't contain intents
  *
  * @remarks
  * This function iterates through all intents in the recognizer result and returns
@@ -57,9 +61,6 @@ export interface RecognizerResult {
  * // Returns: { intent: "BookFlight", score: 0.95 }
  * ```
  *
- * @param result - The recognizer result containing intents and their scores
- * @returns An object containing the top-scoring intent name and its confidence score
- * @throws {Error} Throws an error if the result is empty or doesn't contain intents
  */
 export const getTopScoringIntent = (result: RecognizerResult): { intent: string; score: number } => {
   if (!result || !result.intents) {

package/src/stringUtils.ts

@@ -26,12 +26,13 @@ export class StringUtils {
   /**
      * UniqueHash - create a unique hash from a string.
      *
+     * @param text Text to hash.
+     * @returns A string which is an unique hash.
+     *
      * @remarks
      * The source for this function was derived from the following article:
-     *
      * https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
-     * @param text Text to hash.
-     * @returns A string which is an unique hash.
+     *
      */
   static hash (text: string): string {
     const length = text.length

package/src/waterfallDialog.ts

@@ -28,10 +28,12 @@ export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
   /**
      * Creates a new waterfall dialog containing the given array of steps.
      *
-     * @remarks
-     * See the {@link WaterfallDialog.addStep | addStep function} for details on creating a valid step function.
      * @param dialogId Unique ID of the dialog within the component or set its being added to.
      * @param steps (Optional) array of asynchronous waterfall step functions.
+     *
+     * @remarks
+     * See the {@link WaterfallDialog.addStep | addStep function} for details on creating a valid step function.
+
      */
   constructor (dialogId: string, steps?: WaterfallStep<O>[]) {
     super(dialogId)
@@ -70,9 +72,11 @@ export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
      * @param dialogContext The {@link DialogContext} for the current turn of conversation.
      * @param options Optional, initial information to pass to the 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 beginDialog (dialogContext: DialogContext, options?: O): Promise<DialogTurnResult> {
     const state: WaterfallDialogState = dialogContext.activeDialog.state as WaterfallDialogState
@@ -91,10 +95,12 @@ export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
      *
      * @param dialogContext The {@link 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 result may also contain a
      * return value.
+     *
      */
   async continueDialog (dialogContext: DialogContext): Promise<DialogTurnResult> {
     // Don't do anything for non-message activities
@@ -125,11 +131,12 @@ export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
   /**
      * Called when an individual waterfall step is being executed.
      *
+     * @param step Context object for the waterfall step to execute.
+     * @returns A promise with the DialogTurnResult.
+     *
      * @remarks
      * SHOULD be overridden by derived class that want to add custom logging semantics.
      *
-     * @param step Context object for the waterfall step to execute.
-     * @returns A promise with the DialogTurnResult.
      */
   protected async onStep (step: WaterfallStepContext<O>): Promise<DialogTurnResult> {
     return await this.steps[step.index](step)