@microsoft/agents-hosting-dialogs 0.2.14 → 0.3.5

package/dist/src/recognizerResult.d.ts

@@ -7,10 +7,25 @@ import { IntentScore } from './intentScore';
  * Value returned from a recognizer.
  */
 export interface RecognizerResult {
+    /**
+     * The original text input provided by the user.
+     */
     text: string;
+    /**
+     * Optional. The modified version of the text input, if applicable.
+     */
     alteredText?: string;
+    /**
+     * A mapping of intent names to their corresponding confidence scores.
+     */
     intents: Record<string, IntentScore>;
+    /**
+     * Optional. Entities recognized in the input, if any.
+     */
     entities?: any;
+    /**
+     * Additional properties that may be included in the recognizer result.
+     */
     [propName: string]: any;
 }
 export declare const getTopScoringIntent: (result: RecognizerResult) => {

package/dist/src/recognizerResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"recognizerResult.js","sourceRoot":"","sources":["../../src/recognizerResult.ts"],"names":[],"mappings":";;;AAiBO,MAAM,mBAAmB,GAAG,CAAC,MAAwB,EAAqC,EAAE;;IACjG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACpC,CAAC;IAED,IAAI,SAAS,GAAG,EAAE,CAAA;IAClB,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAA;IACjB,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;YACnC,SAAS,GAAG,UAAU,CAAA;YACtB,QAAQ,GAAG,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,KAAK,EAAE,QAAQ;KAChB,CAAA;AACH,CAAC,CAAA;AAnBY,QAAA,mBAAmB,uBAmB/B"}
+{"version":3,"file":"recognizerResult.js","sourceRoot":"","sources":["../../src/recognizerResult.ts"],"names":[],"mappings":";;;AAoCO,MAAM,mBAAmB,GAAG,CAAC,MAAwB,EAAqC,EAAE;;IACjG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACpC,CAAC;IAED,IAAI,SAAS,GAAG,EAAE,CAAA;IAClB,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAA;IACjB,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;YACnC,SAAS,GAAG,UAAU,CAAA;YACtB,QAAQ,GAAG,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,KAAK,EAAE,QAAQ;KAChB,CAAA;AACH,CAAC,CAAA;AAnBY,QAAA,mBAAmB,uBAmB/B"}

package/dist/src/serviceCollection.d.ts

@@ -39,26 +39,26 @@ export declare class ServiceCollection {
     /**
        * Register an instance by key. This will overwrite existing instances.
        *
-       * @param key key of the instance being provided
-       * @param instance instance to provide
-       * @returns this for chaining
+       * @param key Key of the instance being provided.
+       * @param instance Instance to provide.
+       * @returns `this` for chaining.
        */
     addInstance<InstanceType>(key: string, instance: InstanceType): this;
     /**
        * Register a factory for a key.
        *
-       * @param key key that factory will provide
-       * @param factory function that creates an instance to provide
-       * @returns this for chaining
+       * @param key Key that factory will provide.
+       * @param factory Function that creates an instance to provide.
+       * @returns `this` for chaining.
        */
     addFactory<InstanceType>(key: string, factory: Factory<InstanceType, false>): this;
     /**
        * Register a factory for a key with a set of dependencies.
        *
-       * @param key key that factory will provide
-       * @param dependencies set of things this instance depends on. Will be provided to factory function via `services`.
-       * @param factory function that creates an instance to provide
-       * @returns this for chaining
+       * @param key Key that factory will provide.
+       * @param dependencies Set of things this instance depends on. Will be provided to factory function via `services`.
+       * @param factory Function that creates an instance to provide.
+       * @returns `this` for chaining.
        */
     addFactory<InstanceType, Dependencies>(key: string, dependencies: string[], factory: DependencyFactory<InstanceType, Dependencies, false>): this;
     /**
@@ -72,27 +72,27 @@ export declare class ServiceCollection {
        * Register a factory (that expects an initial value that is not undefined) for a key
        * with a set of dependencies.
        *
-       * @param key key that factory will provide
-       * @param dependencies set of things this instance depends on. Will be provided to factory function via `services`.
-       * @param factory function that creates an instance to provide
-       * @returns this for chaining
+       * @param key Key that factory will provide.
+       * @param dependencies Set of things this instance depends on. Will be provided to factory function via `services`.
+       * @param factory Function that creates an instance to provide.
+       * @returns `this` for chaining.
        */
     composeFactory<InstanceType, Dependencies>(key: string, dependencies: string[], factory: DependencyFactory<InstanceType, Dependencies, true>): this;
     private buildNodes;
     /**
        * Build a single service.
        *
-       * @param key service to build
-       * @param deep reconstruct all dependencies
-       * @returns the service instance, or undefined
+       * @param key Service to build.
+       * @param deep Whether to reconstruct all dependencies.
+       * @returns The service instance, or undefined.
        */
     makeInstance<InstanceType = unknown>(key: string, deep?: boolean): InstanceType | undefined;
     /**
        * Build a single service and assert that it is not undefined.
        *
-       * @param key service to build
-       * @param deep reconstruct all dependencies
-       * @returns the service instance
+       * @param key Service to build.
+       * @param deep Wheter to reconstruct all dependencies.
+       * @returns The service instance
        */
     mustMakeInstance<InstanceType = unknown>(key: string, deep?: boolean): InstanceType;
     /**
@@ -104,8 +104,8 @@ export declare class ServiceCollection {
     /**
        * Build the full set of services, asserting that the specified keys are not undefined.
        *
-       * @param keys instances that must be not undefined
-       * @returns all resolve services
+       * @param keys Instances that must be not undefined
+       * @returns All resolve services
        */
     mustMakeInstances<InstancesType extends Record<string, unknown> = Record<string, unknown>>(...keys: string[]): InstancesType;
 }

package/dist/src/serviceCollection.js

@@ -69,9 +69,9 @@ class ServiceCollection {
     /**
        * Register an instance by key. This will overwrite existing instances.
        *
-       * @param key key of the instance being provided
-       * @param instance instance to provide
-       * @returns this for chaining
+       * @param key Key of the instance being provided.
+       * @param instance Instance to provide.
+       * @returns `this` for chaining.
        */
     addInstance(key, instance) {
         if (this.graph.hasNode(key)) {
@@ -157,9 +157,9 @@ class ServiceCollection {
     /**
        * Build a single service.
        *
-       * @param key service to build
-       * @param deep reconstruct all dependencies
-       * @returns the service instance, or undefined
+       * @param key Service to build.
+       * @param deep Whether to reconstruct all dependencies.
+       * @returns The service instance, or undefined.
        */
     makeInstance(key, deep = false) {
         // If this is not a deep reconstruction, reuse any services that `key` depends on
@@ -174,9 +174,9 @@ class ServiceCollection {
     /**
        * Build a single service and assert that it is not undefined.
        *
-       * @param key service to build
-       * @param deep reconstruct all dependencies
-       * @returns the service instance
+       * @param key Service to build.
+       * @param deep Wheter to reconstruct all dependencies.
+       * @returns The service instance
        */
     mustMakeInstance(key, deep = false) {
         const instance = this.makeInstance(key, deep);
@@ -194,8 +194,8 @@ class ServiceCollection {
     /**
        * Build the full set of services, asserting that the specified keys are not undefined.
        *
-       * @param keys instances that must be not undefined
-       * @returns all resolve services
+       * @param keys Instances that must be not undefined
+       * @returns All resolve services
        */
     mustMakeInstances(...keys) {
         const instances = this.makeInstances();

package/dist/src/waterfallDialog.d.ts

@@ -20,7 +20,7 @@ export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
        * Creates a new waterfall dialog containing the given array of steps.
        *
        * @remarks
-       * See the addstep function for details on creating a valid step function.
+       * 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.
        */
@@ -41,7 +41,7 @@ export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
     /**
        * Called when the WaterfallDialog is started and pushed onto the dialog stack.
        *
-       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @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
@@ -53,7 +53,7 @@ export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
        * Called when the WaterfallDialog is _continued_, where it is the active dialog and the
        * user replies with a new Activity.
        *
-       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @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
@@ -64,7 +64,7 @@ export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
     /**
        * Called when a child WaterfallDialog completed its turn, returning control to this dialog.
        *
-       * @param dc The DialogContext for the current turn of the conversation.
+       * @param dc The {@link DialogContext} for the current turn of the conversation.
        * @param reason DialogReason why the dialog resumed.
        * @param result Optional, value returned from the dialog that was called. The type
        * of the value returned is dependent on the child dialog.
@@ -84,7 +84,7 @@ export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
     /**
        * Executes a step of the WaterfallDialog.
        *
-       * @param dc The DialogContext for the current turn of conversation.
+       * @param dc The {@link DialogContext} for the current turn of conversation.
        * @param index The index of the current waterfall step to execute.
        * @param reason The DialogReason the waterfall step is being executed.
        * @param result Optional, result returned by a dialog called in the previous waterfall step.

package/dist/src/waterfallDialog.js

@@ -19,7 +19,7 @@ class WaterfallDialog extends dialog_1.Dialog {
        * Creates a new waterfall dialog containing the given array of steps.
        *
        * @remarks
-       * See the addstep function for details on creating a valid step function.
+       * 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.
        */
@@ -53,7 +53,7 @@ class WaterfallDialog extends dialog_1.Dialog {
     /**
        * Called when the WaterfallDialog is started and pushed onto the dialog stack.
        *
-       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @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
@@ -73,7 +73,7 @@ class WaterfallDialog extends dialog_1.Dialog {
        * Called when the WaterfallDialog is _continued_, where it is the active dialog and the
        * user replies with a new Activity.
        *
-       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @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
@@ -91,7 +91,7 @@ class WaterfallDialog extends dialog_1.Dialog {
     /**
        * Called when a child WaterfallDialog completed its turn, returning control to this dialog.
        *
-       * @param dc The DialogContext for the current turn of the conversation.
+       * @param dc The {@link DialogContext} for the current turn of the conversation.
        * @param reason DialogReason why the dialog resumed.
        * @param result Optional, value returned from the dialog that was called. The type
        * of the value returned is dependent on the child dialog.
@@ -117,7 +117,7 @@ class WaterfallDialog extends dialog_1.Dialog {
     /**
        * Executes a step of the WaterfallDialog.
        *
-       * @param dc The DialogContext for the current turn of conversation.
+       * @param dc The {@link DialogContext} for the current turn of conversation.
        * @param index The index of the current waterfall step to execute.
        * @param reason The DialogReason the waterfall step is being executed.
        * @param result Optional, result returned by a dialog called in the previous waterfall step.

package/dist/src/waterfallStepContext.d.ts

@@ -9,11 +9,32 @@ import { DialogTurnResult } from './dialogTurnResult';
  * Values passed to the `WaterfallStepContext` constructor.
  */
 export interface WaterfallStepInfo<O extends object> {
+    /**
+     * The index of the current step in the waterfall dialog.
+     */
     index: number;
+    /**
+     * The options passed to the waterfall dialog when it was started.
+     */
     options: O;
+    /**
+     * The reason the current step is being executed.
+     */
     reason: DialogReason;
+    /**
+     * The result returned by the previous step or dialog.
+     */
     result: any;
+    /**
+     * A dictionary of values shared across all steps in the waterfall dialog.
+     */
     values: object;
+    /**
+     * A function to proceed to the next step in the waterfall dialog.
+     *
+     * @param result Optional result to pass to the next step.
+     * @returns A promise resolving to the result of the next dialog turn.
+     */
     onNext(result?: any): Promise<DialogTurnResult>;
 }
 /**

package/dist/src/waterfallStepContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"waterfallStepContext.js","sourceRoot":"","sources":["../../src/waterfallStepContext.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,mDAA+C;AAgB/C;;;;GAIG;AACH,MAAa,oBAA4C,SAAQ,6BAAa;IAG5E;;;;;SAKK;IACL,YAAa,aAA4B,EAAE,QAA8B;QACvE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,aAAa,CAAC,KAAK,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAA;IACpC,CAAC;IAED;;;;SAIK;IACL,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAA;IAC7B,CAAC;IAED;;;;;SAKK;IACL,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAA;IAC/B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;;SAKK;IACL,KAAK,CAAC,IAAI,CAAE,MAAY;QACtB,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;CACF;AAtED,oDAsEC"}
+{"version":3,"file":"waterfallStepContext.js","sourceRoot":"","sources":["../../src/waterfallStepContext.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,mDAA+C;AA0C/C;;;;GAIG;AACH,MAAa,oBAA4C,SAAQ,6BAAa;IAG5E;;;;;SAKK;IACL,YAAa,aAA4B,EAAE,QAA8B;QACvE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,aAAa,CAAC,KAAK,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAA;IACpC,CAAC;IAED;;;;SAIK;IACL,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAA;IAC7B,CAAC;IAED;;;;;SAKK;IACL,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAA;IAC/B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;SAIK;IACL,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;;;SAKK;IACL,KAAK,CAAC,IAAI,CAAE,MAAY;QACtB,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;CACF;AAtED,oDAsEC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@microsoft/agents-hosting-dialogs",
-  "version": "0.2.14",
+  "version": "0.3.5",
   "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": "0.2.14",
+    "@microsoft/agents-hosting": "0.3.5",
     "@types/lodash": "^4.17.16",
     "dependency-graph": "^1.0.0",
     "@microsoft/recognizers-text-suite": "^1.3.1",

package/src/agentComponent.ts

@@ -8,16 +8,30 @@ import { ServiceCollection } from './serviceCollection'
 import { Configuration } from './configuration'
 
 /**
- * Definition of an AgentComponent that allows registration of services, custom actions, memory scopes and adapters.
+ * Abstract base class for defining an AgentComponent.
  *
- * To make your components available to the system you derive from AgentComponent and register services to add functionality.
- * These components then are consumed in appropriate places by the systems that need them. When using Composer, configureServices
- * gets called automatically on the components by the agent runtime, as long as the components are registered in the configuration.
+ * @remarks
+ * An `AgentComponent` allows the registration of services, custom actions, memory scopes, and adapters.
+ * To make components available to the system, derive from this class and implement the `configureServices` method.
+ * These components are consumed by the system in appropriate places. When using Composer, the `configureServices`
+ * method is called automatically by the agent runtime, provided the components are registered in the configuration.
  */
 export abstract class AgentComponent {
+  /**
+   * A Zod schema for validating that an object is an `AgentComponent`.
+   *
+   * @remarks
+   * This schema checks if the object has a `configureServices` method.
+   */
   static z = z.custom<AgentComponent>((val: any) => typeof val.configureServices === 'function', {
     message: 'AgentComponent',
   })
 
+  /**
+   * Configures the services, custom actions, memory scopes, and adapters for the component.
+   *
+   * @param services - The service collection to which services can be added.
+   * @param configuration - The configuration object for accessing settings.
+   */
   abstract configureServices (services: ServiceCollection, configuration: Configuration): void
 }

package/src/agentStateSet.ts

@@ -42,7 +42,7 @@ export class AgentStateSet {
   }
 
   /**
-     * Calls `AgentState.load()` on all of the AgentState plugins in the set.
+     * 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.
@@ -57,7 +57,7 @@ export class AgentStateSet {
   }
 
   /**
-     * Calls `AgentState.saveChanges()` on all of the AgentState plugins in the set.
+     * 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.

package/src/choices/choice.ts

@@ -10,7 +10,18 @@ import { CardAction } from '@microsoft/agents-activity'
  * user picked.
  */
 export interface Choice {
+  /**
+   * The value of the choice, which is used to identify the choice.
+   */
   value: string;
+
+  /**
+   * An optional action associated with the choice, such as a button click.
+   */
   action?: CardAction;
+
+  /**
+   * Optional synonyms that can be used to recognize the choice.
+   */
   synonyms?: string[];
 }

package/src/choices/findChoices.ts

@@ -8,9 +8,24 @@ import { ModelResult } from './modelResult'
 import { Choice } from './choice'
 
 export interface FindChoicesOptions extends FindValuesOptions {
+  /**
+   * If true, the value of the choice will not be included in the search.
+   */
   noValue?: boolean;
+
+  /**
+   * If true, the action title of the choice will not be included in the search.
+   */
   noAction?: boolean;
+
+  /**
+   * If true, numbers will be recognized as choices.
+   */
   recognizeNumbers?: boolean;
+
+  /**
+   * If true, ordinals (e.g., first, second) will be recognized as choices.
+   */
   recognizeOrdinals?: boolean;
 }
 

package/src/choices/findValues.ts

@@ -9,20 +9,53 @@ import { defaultTokenizer, Token, TokenizerFunction } from './tokenizer'
  * Basic search options used to control how choices are recognized in a users utterance.
  */
 export interface FindValuesOptions {
+  /**
+   * If true, allows partial matches of values in the search.
+   */
   allowPartialMatches?: boolean;
+
+  /**
+   * The locale to use for tokenization and comparison.
+   */
   locale?: string;
+
+  /**
+   * The maximum token distance allowed between matches.
+   */
   maxTokenDistance?: number;
+
+  /**
+   * The tokenizer function to use for breaking the utterance into tokens.
+   */
   tokenizer?: TokenizerFunction;
 }
 
 export interface FoundValue {
+  /**
+   * The value that was found in the search.
+   */
   value: string;
+
+  /**
+   * The index of the value in the original list.
+   */
   index: number;
+
+  /**
+   * The confidence score of the match.
+   */
   score: number;
 }
 
 export interface SortedValue {
+  /**
+   * The value to be searched for.
+   */
   value: string;
+
+  /**
+   * The index of the value in the original list.
+   */
   index: number;
 }
 

package/src/choices/modelResult.ts

@@ -2,10 +2,35 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
+/**
+ * Represents the result of a model recognition process.
+ *
+ * @template T - The type of the resolution containing additional details about the match.
+ */
 export interface ModelResult<T extends Record<string, any> = {}> {
+  /**
+   * The text that was matched.
+   */
   text: string;
+
+  /**
+   * The start index of the match in the input text.
+   */
   start: number;
+
+  /**
+   * The end index of the match in the input text.
+   */
   end: number;
+
+  /**
+   * The type of the recognized model result.
+   */
   typeName: string;
+
+  /**
+   * The resolution containing additional details about the match.
+   */
   resolution: T;
 }

package/src/choices/tokenizer.ts

@@ -2,10 +2,29 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
+/**
+ * Represents a token extracted from a text string.
+ */
 export interface Token {
+  /**
+   * The start index of the token in the original text.
+   */
   start: number;
+
+  /**
+   * The end index of the token in the original text.
+   */
   end: number;
+
+  /**
+   * The original text of the token.
+   */
   text: string;
+
+  /**
+   * The normalized (lowercase) version of the token text.
+   */
   normalized: string;
 }
 

package/src/configurable.ts

@@ -46,6 +46,7 @@ export abstract class Configurable {
   }
 
   /**
+   * Gets the converter for the selector configuration.
      * @param _property The key of the conditional selector configuration.
      * @returns The converter for the selector configuration.
      */

package/src/converter.ts

@@ -4,12 +4,21 @@
  */
 
 /**
- * The converter converts object from one type to another.
+ * The converter converts objects from one type to another.
+ *
+ * @typeParam From - The type of the input value to be converted.
+ * @typeParam To - The type of the output value after conversion.
  */
 export interface Converter<From = unknown, To = unknown> {
   convert(value: From | To): To;
 }
 
+/**
+ * A factory type for creating instances of a `Converter`.
+ *
+ * @typeParam From - The type of the input value to be converted.
+ * @typeParam To - The type of the output value after conversion.
+ */
 export type ConverterFactory<From = unknown, To = unknown> = {
   new (...args: unknown[]): Converter<From, To>;
 }