@microsoft/agents-hosting-dialogs 1.0.0 → 1.0.7-g73d3d58001

package/dist/src/waterfallDialog.d.ts

@@ -19,10 +19,12 @@ export declare 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>[]);
     /**
@@ -44,9 +46,11 @@ export declare 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.
+       *
        */
     beginDialog(dialogContext: DialogContext, options?: O): Promise<DialogTurnResult>;
     /**
@@ -55,10 +59,12 @@ export declare 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.
+       *
        */
     continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult>;
     /**
@@ -74,11 +80,12 @@ export declare 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 onStep(step: WaterfallStepContext<O>): Promise<DialogTurnResult>;
     /**

package/dist/src/waterfallDialog.js

@@ -18,10 +18,12 @@ class WaterfallDialog extends dialog_1.Dialog {
     /**
        * 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, steps) {
         super(dialogId);
@@ -56,9 +58,11 @@ class WaterfallDialog extends dialog_1.Dialog {
        * @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, options) {
         const state = dialogContext.activeDialog.state;
@@ -75,10 +79,12 @@ class WaterfallDialog extends dialog_1.Dialog {
        *
        * @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) {
         // Don't do anything for non-message activities
@@ -105,11 +111,12 @@ class WaterfallDialog extends dialog_1.Dialog {
     /**
        * 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.
        */
     async onStep(step) {
         return await this.steps[step.index](step);

package/dist/src/waterfallDialog.js.map

@@ -1 +1 @@
-{"version":3,"file":"waterfallDialog.js","sourceRoot":"","sources":["../../src/waterfallDialog.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+BAAmC;AACnC,gEAA0D;AAC1D,qCAAiC;AAEjC,iEAA6D;AAE7D,iDAA6C;AAU7C;;;GAGG;AACH,MAAa,eAAuC,SAAQ,eAAS;IAGnE;;;;;;;SAOK;IACL,YAAa,QAAgB,EAAE,KAA0B;QACvD,KAAK,CAAC,QAAQ,CAAC,CAAA;QACf,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC;IAED;;;;SAIK;IACL,UAAU;QACR,4EAA4E;QAC5E,mCAAmC;QACnC,OAAO,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;IAC1C,CAAC;IAED;;;;;SAKK;IACL,OAAO,CAAE,IAAsB;QAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;SASK;IACL,KAAK,CAAC,WAAW,CAAE,aAA4B,EAAE,OAAW;QAC1D,MAAM,KAAK,GAAyB,aAAa,CAAC,YAAY,CAAC,KAA6B,CAAA;QAC5F,KAAK,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QAC7B,KAAK,CAAC,MAAM,GAAG;YACb,UAAU,EAAE,IAAA,SAAM,GAAE;SACrB,CAAA;QAED,qBAAqB;QACrB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE,2BAAY,CAAC,WAAW,CAAC,CAAA;IACvE,CAAC;IAED;;;;;;;;;;SAUK;IACL,KAAK,CAAC,cAAc,CAAE,aAA4B;QAChD,+CAA+C;QAC/C,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,OAAO,EAAE,CAAC;YAClE,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,2BAAY,CAAC,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACjH,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,YAAY,CAAE,EAAiB,EAAE,MAAoB,EAAE,MAAY;QACvE,oCAAoC;QACpC,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;QAEjF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,MAAM,CAAE,IAA6B;QACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,OAAO,CACrB,EAAiB,EACjB,KAAa,EACb,MAAoB,EACpB,MAAY;QAEZ,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC9B,8BAA8B;YAC9B,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;YACjF,KAAK,CAAC,SAAS,GAAG,KAAK,CAAA;YAEvB,sBAAsB;YACtB,IAAI,UAAU,GAAG,KAAK,CAAA;YACtB,MAAM,IAAI,GAA4B,IAAI,2CAAoB,CAAI,EAAE,EAAE;gBACpE,KAAK;gBACL,OAAO,EAAK,KAAK,CAAC,OAAO;gBACzB,MAAM;gBACN,MAAM;gBACN,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,MAAM,EAAE,KAAK,EAAE,UAAgB,EAAkC,EAAE;oBACjE,IAAI,UAAU,EAAE,CAAC;wBACf,MAAM,IAAI,KAAK,CACC,2EAA2E,IAAI,CAAC,EAAE,IAAI,KAAK,KAAK,CAC/G,CAAA;oBACH,CAAC;oBACD,UAAU,GAAG,IAAI,CAAA;oBACjB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,2BAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;gBACzE,CAAC;aACF,CAAC,CAAA;YAEF,eAAe;YACf,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,4CAA4C;YAC5C,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACG,iBAAiB,CAAE,KAAa;QACtC,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,QAAQ,GAAG,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;YACnC,CAAC;oBAAS,CAAC;gBACT,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAC9C,QAAQ,GAAG,MAAM,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AArLD,0CAqLC"}
+{"version":3,"file":"waterfallDialog.js","sourceRoot":"","sources":["../../src/waterfallDialog.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+BAAmC;AACnC,gEAA0D;AAC1D,qCAAiC;AAEjC,iEAA6D;AAE7D,iDAA6C;AAU7C;;;GAGG;AACH,MAAa,eAAuC,SAAQ,eAAS;IAGnE;;;;;;;;;SASK;IACL,YAAa,QAAgB,EAAE,KAA0B;QACvD,KAAK,CAAC,QAAQ,CAAC,CAAA;QACf,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC;IAED;;;;SAIK;IACL,UAAU;QACR,4EAA4E;QAC5E,mCAAmC;QACnC,OAAO,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;IAC1C,CAAC;IAED;;;;;SAKK;IACL,OAAO,CAAE,IAAsB;QAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;SAWK;IACL,KAAK,CAAC,WAAW,CAAE,aAA4B,EAAE,OAAW;QAC1D,MAAM,KAAK,GAAyB,aAAa,CAAC,YAAY,CAAC,KAA6B,CAAA;QAC5F,KAAK,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QAC7B,KAAK,CAAC,MAAM,GAAG;YACb,UAAU,EAAE,IAAA,SAAM,GAAE;SACrB,CAAA;QAED,qBAAqB;QACrB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE,2BAAY,CAAC,WAAW,CAAC,CAAA;IACvE,CAAC;IAED;;;;;;;;;;;;SAYK;IACL,KAAK,CAAC,cAAc,CAAE,aAA4B;QAChD,+CAA+C;QAC/C,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,OAAO,EAAE,CAAC;YAClE,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,2BAAY,CAAC,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACjH,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,YAAY,CAAE,EAAiB,EAAE,MAAoB,EAAE,MAAY;QACvE,oCAAoC;QACpC,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;QAEjF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;;SASK;IACK,KAAK,CAAC,MAAM,CAAE,IAA6B;QACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,OAAO,CACrB,EAAiB,EACjB,KAAa,EACb,MAAoB,EACpB,MAAY;QAEZ,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC9B,8BAA8B;YAC9B,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;YACjF,KAAK,CAAC,SAAS,GAAG,KAAK,CAAA;YAEvB,sBAAsB;YACtB,IAAI,UAAU,GAAG,KAAK,CAAA;YACtB,MAAM,IAAI,GAA4B,IAAI,2CAAoB,CAAI,EAAE,EAAE;gBACpE,KAAK;gBACL,OAAO,EAAK,KAAK,CAAC,OAAO;gBACzB,MAAM;gBACN,MAAM;gBACN,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,MAAM,EAAE,KAAK,EAAE,UAAgB,EAAkC,EAAE;oBACjE,IAAI,UAAU,EAAE,CAAC;wBACf,MAAM,IAAI,KAAK,CACC,2EAA2E,IAAI,CAAC,EAAE,IAAI,KAAK,KAAK,CAC/G,CAAA;oBACH,CAAC;oBACD,UAAU,GAAG,IAAI,CAAA;oBACjB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,2BAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;gBACzE,CAAC;aACF,CAAC,CAAA;YAEF,eAAe;YACf,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,4CAA4C;YAC5C,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACG,iBAAiB,CAAE,KAAa;QACtC,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,QAAQ,GAAG,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;YACnC,CAAC;oBAAS,CAAC;gBACT,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAC9C,QAAQ,GAAG,MAAM,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AA5LD,0CA4LC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@microsoft/agents-hosting-dialogs",
-  "version": "1.0.0",
+  "version": "1.0.7-g73d3d58001",
   "homepage": "https://github.com/microsoft/Agents-for-js",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "@microsoft/agents-hosting": "1.0.0",
+    "@microsoft/agents-hosting": "1.0.7-g73d3d58001",
     "@types/lodash": "^4.17.16",
     "dependency-graph": "^1.0.0",
     "@microsoft/recognizers-text-suite": "^1.3.1",

package/src/agentStateSet.ts

@@ -6,29 +6,31 @@ import { AgentState, TurnContext } from '@microsoft/agents-hosting'
 
 /**
  * A collection of `AgentState` plugins that should be loaded or saved in parallel as a single unit.
+ *
+ * @remarks
  * See `AutoSaveStateMiddleware` for an implementation of this class.
  */
 export class AgentStateSet {
   /**
-     * Array of the sets `AgentState` plugins.
-     */
+    * Array of the sets `AgentState` plugins.
+    */
   readonly agentStates: AgentState[] = []
 
   /**
-     * Creates a new AgentStateSet instance.
-     *
-     * @param agentStates One or more AgentState plugins to register.
-     */
+    * Creates a new AgentStateSet instance.
+    *
+    * @param agentStates One or more AgentState plugins to register.
+    */
   constructor (...agentStates: AgentState[]) {
     AgentStateSet.prototype.add.apply(this, agentStates)
   }
 
   /**
-     * Registers one or more `AgentState` plugins with the set.
-     *
-     * @param agentStates One or more AgentState plugins to register.
-     * @returns The updated AgentStateSet.
-     */
+    * Registers one or more `AgentState` plugins with the set.
+    *
+    * @param agentStates One or more AgentState plugins to register.
+    * @returns The updated AgentStateSet.
+    */
   add (...agentStates: AgentState[]): this {
     agentStates.forEach((agentstate: AgentState) => {
       if (typeof agentstate.load === 'function' && typeof agentstate.saveChanges === 'function') {
@@ -42,14 +44,15 @@ export class AgentStateSet {
   }
 
   /**
-     * Calls the {@link AgentState.load | AgentState.load method} on all of the AgentState plugins in the set.
-     *
-     * @remarks
-     * This will trigger all of the plugins to read in their state in parallel.
-     *
-     * @param context Context for current turn of conversation with the user.
-     * @param force (Optional) If `true` the cache will be bypassed and the state will always be read in directly from storage. Defaults to `false`.
-     */
+    * Calls the {@link AgentState.load | AgentState.load method} on all of the AgentState plugins in the set.
+    *
+    * @param context Context for current turn of conversation with the user.
+    * @param force (Optional) If `true` the cache will be bypassed and the state will always be read in directly from storage. Defaults to `false`.
+    *
+    * @remarks
+    * This will trigger all of the plugins to read in their state in parallel.
+    *
+    */
   async loadAll (context: TurnContext, force = false): Promise<void> {
     const promises: Promise<any>[] = this.agentStates.map((agentstate: AgentState) => agentstate.load(context, force))
 
@@ -57,14 +60,14 @@ export class AgentStateSet {
   }
 
   /**
-     * Calls {@link AgentState.saveChanges | AgentState.saveChanges method} on all of the AgentState plugins in the set.
-     *
-     * @remarks
-     * This will trigger all of the plugins to write out their state in parallel.
-     *
-     * @param context Context for current turn of conversation with the user.
-     * @param force (Optional) if `true` the state will always be written out regardless of its change state. Defaults to `false`.
-     */
+    * Calls {@link AgentState.saveChanges | AgentState.saveChanges method} on all of the AgentState plugins in the set.
+    *
+    * @param context Context for current turn of conversation with the user.
+    * @param force (Optional) if `true` the state will always be written out regardless of its change state. Defaults to `false`.
+    *
+    * @remarks
+    * This will trigger all of the plugins to write out their state in parallel.
+    */
   async saveAllChanges (context: TurnContext, force = false): Promise<void> {
     const promises: Promise<void>[] = this.agentStates.map((agentstate: AgentState) =>
       agentstate.saveChanges(context, force)

package/src/choices/findValues.ts

@@ -31,7 +31,7 @@ export interface FindValuesOptions {
 }
 
 /**
- * @summary Represents a value that was successfully found and matched during a search operation.
+ * Represents a value that was successfully found and matched during a search operation.
  *
  * @remarks
  * This interface contains the matched value along with metadata about the match quality
@@ -49,7 +49,8 @@ export interface FindValuesOptions {
  */
 export interface FoundValue {
   /**
-   * @summary The exact value that was matched from the original search list.
+   * The exact value that was matched from the original search list.
+   *
    * @remarks
    * This is the original string value, not the user's input that matched it.
    *
@@ -58,7 +59,8 @@ export interface FoundValue {
   value: string;
 
   /**
-   * @summary The zero-based index position of this value in the original list that was searched.
+   * The zero-based index position of this value in the original list that was searched.
+   *
    * @remarks
    * This allows you to correlate the found value back to its position in the source array.
    *
@@ -67,7 +69,8 @@ export interface FoundValue {
   index: number;
 
   /**
-   * @summary A confidence score between 0 and 1 indicating the quality of the match.
+   * A confidence score between 0 and 1 indicating the quality of the match.
+   *
    * @remarks
    * - 1.0 indicates a perfect exact match
    * - Lower values indicate partial or fuzzy matches
@@ -79,7 +82,8 @@ export interface FoundValue {
 }
 
 /**
- * @summary Represents a value with its original position that can be used in search operations.
+ * Represents a value with its original position that can be used in search operations.
+ *
  * @remarks
  * This interface is used internally by the search algorithm to maintain the relationship
  * between search values and their original positions in the source array.
@@ -102,7 +106,8 @@ export interface FoundValue {
  */
 export interface SortedValue {
   /**
-   * @summary The string value to be searched for during matching operations.
+   * The string value to be searched for during matching operations.
+   *
    * @remarks
    * This is the actual text content that will be compared against user input.
    *
@@ -111,7 +116,8 @@ export interface SortedValue {
   value: string;
 
   /**
-   * @summary The zero-based index position of this value in the original source array.
+   * The zero-based index position of this value in the original source array.
+   *
    * @remarks
    * This allows the search algorithm to correlate found matches back to their
    * original positions, which is essential for maintaining proper choice selection.
@@ -122,17 +128,20 @@ export interface SortedValue {
 }
 
 /**
- * @summary Low-level function that searches for a set of values within an utterance.
+ * Low-level function that searches for a set of values within an utterance.
+ *
+ * @param utterance The text or user utterance to search over.
+ * @param values List of values to search over.
+ * @param options (Optional) options used to tweak the search that's performed.
+ * @returns A list of found values.
+ *
  * @remarks
  * Higher level functions like `findChoices()` and `recognizeChoices()` are layered above this function.  In most
  * cases its easier to just call one of the higher level functions instead but this function contains
  * the fuzzy search algorithm that drives choice recognition.
  *
  * @internal
- * @param utterance The text or user utterance to search over.
- * @param values List of values to search over.
- * @param options (Optional) options used to tweak the search that's performed.
- * @returns A list of found values.
+
  */
 export function findValues (
   utterance: string,