@microsoft/agents-hosting-dialogs 0.2.14 → 0.4.1

package/src/dialog.ts

@@ -61,7 +61,7 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * An encoded string used to aid in the detection of agent changes on re-deployment.
      *
      * @remarks
-     * This defaults to returning the dialogs [id](#id) but can be overridden to provide more
+     * This defaults to returning the dialog's `id` but can be overridden to provide more
      * precise change detection logic. Any dialog on the stack that has its version change will
      * result in a `versionChanged` event will be raised. If this event is not handled by the agent,
      * an error will be thrown resulting in the agent error handler logic being run.
@@ -82,12 +82,12 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * @remarks
      * Derived dialogs must override this method.
      *
-     * The DialogContext calls this method when it creates
-     * a new DialogInstance for this dialog, pushes it
+     * The {@link DialogContext} calls this method when it creates
+     * a new {@link DialogInstance} for this dialog, pushes it
      * onto the dialog stack, and starts the dialog.
      *
      * A dialog that represents a single-turn conversation should await
-     * DialogContext.endDialog before exiting this method.
+     * {@link DialogContext.endDialog} before exiting this method.
      *
      */
   abstract beginDialog (dc: DialogContext, options?: O): Promise<DialogTurnResult>
@@ -101,11 +101,11 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * Derived dialogs that support multiple-turn conversations should override this method.
      * By default, this method signals that the dialog is complete and returns.
      *
-     * The DialogContext calls this method when it continues
+     * The {@link DialogContext} calls this method when it continues
      * the dialog.
      *
      * To signal to the dialog context that this dialog has completed, await
-     * DialogContext.endDialog before exiting this method.
+     * {@link DialogContext.endDialog} before exiting this method.
      *
      * @returns {Promise<DialogTurnResult>} A promise resolving to the dialog turn result.
      */
@@ -125,13 +125,13 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * Derived dialogs that support multiple-turn conversations should override this method.
      * By default, this method signals that the dialog is complete and returns.
      *
-     * The DialogContext calls this method when it resumes
+     * The {@link DialogContext} calls this method when it resumes
      * the dialog. If the previous dialog on the stack returned a value, that value is in the `result`
      * parameter.
      *
-     * To start a _child_ dialog, use DialogContext.beginDialog or DialogContext.prompt; however, this dialog will not
+     * To start a _child_ dialog, use {@link DialogContext.beginDialog} or {@link DialogContext.prompt}; however, this dialog will not
      * necessarily be the one that started the child dialog.
-     * To signal to the dialog context that this dialog has completed, await DialogContext.endDialog before exiting this method.
+     * To signal to the dialog context that this dialog has completed, await {@link DialogContext.endDialog} before exiting this method.
      *
      * @returns {Promise<DialogTurnResult>} A promise resolving to the dialog turn result.
      */
@@ -141,7 +141,7 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
   }
 
   /**
-     * When overridden in a derived class, reprompts the user for input.
+     * When overridden in a derived class, prompts the user again for input.
      *
      * @param _context The context object for the turn.
      * @param _instance Current state information for this dialog.
@@ -150,7 +150,7 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * Derived dialogs that support validation and re-prompt logic should override this method.
      * By default, this method has no effect.
      *
-     * The DialogContext calls this method when the current
+     * The {@link DialogContext} calls this method when the current
      * dialog should re-request input from the user. This method is implemented for prompt dialogs.
      *
      */
@@ -169,7 +169,7 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
      * Derived dialogs that need to perform logging or cleanup before ending should override this method.
      * By default, this method has no effect.
      *
-     * The DialogContext calls this method when the current
+     * The {@link DialogContext} calls this method when the current
      * dialog is ending.
      *
      */
@@ -178,7 +178,8 @@ export abstract class Dialog<O extends object = {}> extends Configurable {
   }
 
   /**
-     * Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started.
+     * Called when an event has been raised, using {@link DialogContext.emitEvent | DialogContext.emitEvent method },
+     * by either the current dialog or a dialog that the current dialog started.
      *
      * @param dialogContext - The dialog context for the current turn of conversation.
      * @param event - The event being raised.

package/src/dialogContext.ts

@@ -45,10 +45,10 @@ const wrapErrors = async <T>(dialogContext: DialogContext, promise: Promise<T>):
 const ACTIVITY_RECEIVED_EMITTED = Symbol('ActivityReceivedEmitted')
 
 /**
- * Contains dialog state, information about the state of the dialog stack, for a specific DialogSet.
+ * Contains dialog state, information about the state of the dialog stack, for a specific {@link DialogSet}.
  *
  * @remarks
- * State is read from and saved to storage each turn, and state cache for the turn is managed through the TurnContext.
+ * State is read from and saved to storage each turn, and state cache for the turn is managed through the {@link @microsoft/agents-hosting.TurnContext}.
  *
  * For more information, see the articles on
  * [Managing state](https://docs.microsoft.com/azure/bot-service/bot-builder-concept-state) and
@@ -56,18 +56,18 @@ const ACTIVITY_RECEIVED_EMITTED = Symbol('ActivityReceivedEmitted')
  */
 export interface DialogState {
   /**
-     * Contains state information for each Dialog on the stack.
+     * Contains state information for each {@link Dialog} on the stack.
      */
   dialogStack: DialogInstance[];
 }
 
 /**
- * The context for the current dialog turn with respect to a specific DialogSet.
+ * The context for the current dialog turn with respect to a specific {@link DialogSet}.
  *
  * @remarks
  * This includes the turn context, information about the dialog set, and the state of the dialog stack.
  *
- * From code outside of a dialog in the set, use DialogSet.createContext
+ * From code outside of a dialog in the set, use {@link DialogSet.createContext | DialogSet.createContext method}
  * to create the dialog context. Then use the methods of the dialog context to manage the progression of dialogs in the set.
  *
  * When you implement a dialog, the dialog context is a parameter available to the various methods you override or implement.
@@ -77,32 +77,32 @@ export class DialogContext {
   /**
      * Creates an new instance of the DialogContext class.
      *
-     * @param dialogs The DialogSet for which to create the dialog context.
-     * @param contextOrDialogContext The TurnContext object for the current turn.
-     * @param state The state object to use to read and write DialogState to storage.
+     * @param dialogs The `DialogSet` for which to create the dialog context.
+     * @param contextOrDialogContext The `TurnContext` object for the current turn.
+     * @param state The state object to use to read and write `DialogState` to storage.
      * @remarks
-     * Passing in a DialogContext instance will clone the dialog context.
+     * Passing in a `DialogContext` instance will clone the dialog context.
      */
   constructor (dialogs: DialogSet, contextOrDialogContext: TurnContext, state: DialogState)
 
   /**
      * Creates an new instance of the DialogContext class.
      *
-     * @param dialogs The DialogSet for which to create the dialog context.
-     * @param contextOrDialogContext The DialogContext object for the current turn.
-     * @param state The state object to use to read and write DialogState to storage.
+     * @param dialogs The `DialogSet` for which to create the dialog context.
+     * @param contextOrDialogContext The `DialogContext` object for the current turn.
+     * @param state The state object to use to read and write `DialogState` to storage.
      * @remarks
-     * Passing in a DialogContext instance will clone the dialog context.
+     * Passing in a `DialogContext` instance will clone the dialog context.
      */
   constructor (dialogs: DialogSet, contextOrDialogContext: DialogContext, state: DialogState)
 
   /**
-     * Creates an new instance of the DialogContext class.
+     * Creates an new instance of the `DialogContext` class.
      *
-     * @param dialogs The DialogSet for which to create the dialog context.
-     * @param contextOrDialogContext The TurnContext or DialogContext for the current turn.
-     * @param state The state object to use to read and write DialogState to storage.
-     * @remarks Passing in a DialogContext instance will clone the dialog context.
+     * @param dialogs The `DialogSet` for which to create the dialog context.
+     * @param contextOrDialogContext The `TurnContext` or `DialogContext` for the current turn.
+     * @param state The state object to use to read and write `DialogState` to storage.
+     * @remarks Passing in a `DialogContext` instance will clone the dialog context.
      */
   constructor (dialogs: DialogSet, contextOrDialogContext: TurnContext | DialogContext, state: DialogState) {
     this.dialogs = dialogs
@@ -144,8 +144,8 @@ export class DialogContext {
      * The parent dialog context for this dialog context, or `undefined` if this context doesn't have a parent.
      *
      * @remarks
-     * When it attempts to start a dialog, the dialog context searches for the Dialog.id
-     * in its DialogContext.dialogs. If the dialog to start is not found
+     * When it attempts to start a dialog, the dialog context searches for the {@link Dialog.id}
+     * in its {@link DialogContext.dialogs}. If the dialog to start is not found
      * in this dialog context, it searches in its parent dialog context, and so on.
      */
   parent: DialogContext | undefined
@@ -175,7 +175,7 @@ export class DialogContext {
   }
 
   /**
-     * Gets the DialogStateManager which manages view of all memory scopes.
+     * Gets the {@link DialogStateManager} which manages view of all memory scopes.
      */
   state: DialogStateManager
 
@@ -185,8 +185,7 @@ export class DialogContext {
   services: TurnContextStateCollection = new TurnContextStateCollection()
 
   /**
-     * @deprecated This property serves no function.
-     * @returns The current dialog manager instance. This property is deprecated.
+     * @returns The current dialog manager instance.
      */
   get dialogManager (): DialogManager {
     return this.context.turnState.get(DialogTurnStateConstants.dialogManager)
@@ -224,7 +223,7 @@ export class DialogContext {
      * If there's already an active dialog on the stack, that dialog will be paused until
      * it is again the top dialog on the stack.
      *
-     * The DialogTurnResult.status of returned object describes
+     * The {@link DialogTurnResult.status} of returned object describes
      * the status of the dialog stack after this method completes.
      *
      * This method throws an exception if the requested dialog can't be found in this dialog context
@@ -260,12 +259,12 @@ export class DialogContext {
      * @param eventValue Optional. Value to pass along with custom cancellation event.
      * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
      * @remarks
-     * This calls each dialog's .Dialog.endDialog method before
+     * This calls each dialog's {@link Dialog.endDialog | endDialog method} before
      * removing the dialog from the stack.
      *
      * If there were any dialogs on the stack initially, the DialogTurnResult.status
-     * of the return value is DialogTurnStatus.cancelled; otherwise, it's
-     * DialogTurnStatus.empty.
+     * of the return value is {@link DialogTurnStatus.cancelled}; otherwise, it's
+     * {@link DialogTurnStatus.empty}.
      *
      */
   async cancelAllDialogs (cancelParents = false, eventName?: string, eventValue?: any): Promise<DialogTurnResult> {
@@ -307,7 +306,7 @@ export class DialogContext {
      * @param dialogId ID of the dialog to search for.
      * @returns The dialog for the provided ID.
      * @remarks
-     * If the dialog to start is not found in the DialogSet associated
+     * If the dialog to start is not found in the {@link DialogSet} associated
      * with this dialog context, it attempts to find the dialog in its parent dialog context.
      *
      */
@@ -329,7 +328,7 @@ export class DialogContext {
      *
      * @remarks
      * This helper method formats the object to use as the `options` parameter, and then calls
-     * DialogContext.beginDialog to start the specified prompt dialog.
+     * {@link DialogContext.beginDialog} to start the specified prompt dialog.
      *
      */
   async prompt (
@@ -342,13 +341,13 @@ export class DialogContext {
      *
      * @param dialogId ID of the prompt dialog to start.
      * @param promptOrOptions The text of the initial prompt to send the user,
-     * the Activity to send as the initial prompt, or
+     * the {@link @microsoft/agents-activity.Activity} to send as the initial prompt, or
      * the object with which to format the prompt dialog.
      * @param choices Optional. Array of choices for the user to choose from,
-     * for use with a ChoicePrompt.
+     * for use with a {@link ChoicePrompt}.
      * @remarks
      * This helper method formats the object to use as the `options` parameter, and then calls
-     * DialogContext.beginDialog to start the specified prompt dialog.
+     * {@link DialogContext.beginDialog} to start the specified prompt dialog.
      *
      */
   async prompt (
@@ -362,12 +361,12 @@ export class DialogContext {
      *
      * @param dialogId ID of the prompt dialog to start.
      * @param promptOrOptions The text of the initial prompt to send the user,
-     * or the Activity to send as the initial prompt.
+     * or the {@link @microsoft/agents-activity.Activity} to send as the initial prompt.
      * @param choices Optional. Array of choices for the user to choose from,
-     * for use with a ChoicePrompt.
+     * for use with a {@link ChoicePrompt}.
      * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
      * @remarks This helper method formats the object to use as the `options` parameter, and then calls
-     * beginDialog to start the specified prompt dialog.
+     * {@link DialogContext.beginDialog} to start the specified prompt dialog.
      *
      */
   async prompt (
@@ -394,14 +393,14 @@ export class DialogContext {
 
   /**
      * Continues execution of the active dialog, if there is one, by passing this dialog context to its
-     * Dialog.continueDialog method.
+     * {@link DialogContext.continueDialog} method.
      *
      * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
      * @remarks
-     * After the call completes, you can check the turn context's TurnContext.responded
+     * After the call completes, you can check the turn context's {@link @microsoft/agents-hosting.TurnContext.responded | TurnContext.responded}
      * property to determine if the dialog sent a reply to the user.
      *
-     * The DialogTurnResult.status of returned object describes
+     * The {@link DialogTurnResult.status} of returned object describes
      * the status of the dialog stack after this method completes.
      *
      * Typically, you would call this from within your agent's turn handler.
@@ -446,12 +445,12 @@ export class DialogContext {
      * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
      * @remarks
      * The _parent_ dialog is the next dialog on the dialog stack, if there is one. This method
-     * calls the parent's Dialog.resumeDialog method,
+     * calls the parent's {@link Dialog.resumeDialog} method,
      * passing the result returned by the ending dialog. If there is no parent dialog, the turn ends
      * and the result is available to the agent through the returned object's
-     * DialogTurnResult.result property.
+     * {@link DialogTurnResult.result} property.
      *
-     * The DialogTurnResult.status of returned object describes
+     * The {@link DialogTurnResult.status} of returned object describes
      * the status of the dialog stack after this method completes.
      *
      * Typically, you would call this from within the logic for a specific dialog to signal back to
@@ -492,7 +491,7 @@ export class DialogContext {
      * @remarks
      * This is particularly useful for creating a loop or redirecting to another dialog.
      *
-     * The DialogTurnResult.status of returned object describes
+     * The {@link DialogTurnResult.status} of returned object describes
      * the status of the dialog stack after this method completes.
      *
      * This method is similar to ending the current dialog and immediately beginning the new one.
@@ -511,7 +510,7 @@ export class DialogContext {
      * Requests the active dialog to re-prompt the user for input.
      *
      * @remarks
-     * This calls the active dialog's Dialog.repromptDialog method.
+     * This calls the active dialog's {@link Dialog.repromptDialog} method.
      *
      */
   async repromptDialog (): Promise<void> {

package/src/dialogEvent.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents an event that occurs within a dialog, providing details such as its name, whether it should bubble to parent contexts, and any associated value.
+ */
 export interface DialogEvent {
   /**
        * Flag indicating whether the event will be bubbled to the parent `DialogContext`.

package/src/dialogEvents.ts

@@ -5,12 +5,37 @@
 
 /**
  * Represents the events related to the "lifecycle" of the dialog.
+ *
+ * These events are used to signal various stages or actions within a dialog's lifecycle.
  */
 export class DialogEvents {
+  /**
+   * Event triggered when a dialog begins.
+   */
   static readonly beginDialog = 'beginDialog'
+
+  /**
+   * Event triggered to reprompt a dialog.
+   */
   static readonly repromptDialog = 'repromptDialog'
+
+  /**
+   * Event triggered when a dialog is canceled.
+   */
   static readonly cancelDialog = 'cancelDialog'
+
+  /**
+   * Event triggered when an activity is received.
+   */
   static readonly activityReceived = 'activityReceived'
+
+  /**
+   * Event triggered when the dialog version changes.
+   */
   static readonly versionChanged = 'versionChanged'
+
+  /**
+   * Event triggered when an error occurs.
+   */
   static readonly error = 'error'
 }

package/src/dialogHelper.ts

@@ -106,6 +106,14 @@ export async function internalRun (
   return dialogTurnResult
 }
 
+/**
+ * Executes the dialog by either continuing an existing dialog or starting a new one.
+ *
+ * @param context The TurnContext for the turn.
+ * @param dialogId The ID of the dialog to start or continue.
+ * @param dialogContext The DialogContext for the current turn of conversation.
+ * @returns A promise resolving to the result of the dialog turn.
+ */
 async function innerRun (
   context: TurnContext,
   dialogId: string,
@@ -136,8 +144,13 @@ export function getActiveDialogContext (dialogContext: DialogContext): DialogCon
 
   return getActiveDialogContext(child)
 }
-
 // Helper to send a trace activity with a memory snapshot of the active dialog DC.
+/**
+ * Sends a trace activity containing a memory snapshot of the active dialog context.
+ *
+ * @param dialogContext The DialogContext for the current turn of conversation.
+ * @returns A promise that resolves when the trace activity is sent.
+ */
 const sendStateSnapshotTrace = async (dialogContext: DialogContext): Promise<void> => {
   const traceLabel = 'Agent State'
 

package/src/dialogManager.ts

@@ -40,7 +40,6 @@ export interface DialogManagerConfiguration {
 /**
  * Class which runs the dialog system.
  *
- * @deprecated This class will be deprecated.
  */
 export class DialogManager extends Configurable {
   private _rootDialogId: string

package/src/dialogSet.ts

@@ -25,8 +25,8 @@ export interface DialogDependencies {
  * The constructor for the dialog set should be passed a state property that will be used to
  * persist the dialog stack for the set:
  *
- * To interact with the sets dialogs you can call createcontext with the
- * current `TurnContext`. That will create a `DialogContext` that can be used to start or continue
+ * To interact with the sets dialogs you can call `createcontext` with the
+ * current {@link @microsoft/agents-hosting.TurnContext}. That will create a {@link DialogContext} that can be used to start or continue
  * execution of the sets dialogs:
  *
  */
@@ -39,8 +39,8 @@ export class DialogSet {
      * Creates a new DialogSet instance.
      *
      * @remarks
-     * If the `dialogState` property is not passed in, calls to createcontext
-     * will return an error.  You will need to create a `DialogContext` for the set manually and
+     * If the `dialogState` parameter is not passed in, calls to {@link @microsoft/agents-hosting-dialogs.DialogSet.createcontext | createContext}
+     * will return an error.  You will need to create a {@link DialogContext} for the set manually and
      * pass in your own state object for persisting the sets dialog stack:
      *
      * @param dialogState (Optional) state property used to persist the sets dialog stack.
@@ -75,7 +75,7 @@ export class DialogSet {
      * Adds a new dialog or prompt to the set.
      *
      * @remarks
-     * If the `Dialog.id` being added already exists in the set, the dialogs id will be updated to
+     * If the {@link Dialog.id} being added already exists in the set, the dialogs id will be updated to
      * include a suffix which makes it unique. So adding 2 dialogs named "duplicate" to the set
      * would result in the first one having an id of "duplicate" and the second one having an id
      * of "duplicate2".
@@ -146,10 +146,6 @@ export class DialogSet {
 
   /**
      * Finds a dialog that was previously added to the set using add.
-     *
-     * @remarks
-     * This example finds a dialog named "greeting":
-     *
      * @param dialogId ID of the dialog or prompt to lookup.
      * @returns The dialog if found; otherwise undefined.
      */

package/src/dialogTurnStateConstants.ts

@@ -4,10 +4,24 @@
  */
 
 /**
- * Defines dialog turn state constants.
+ * Provides constants used to manage the state of a dialog turn.
+ *
+ * These constants are used as keys to store and retrieve specific state information
+ * during the execution of a dialog turn.
  */
 export class DialogTurnStateConstants {
+  /**
+   * Symbol representing the configuration for the dialog turn.
+   */
   static configuration = Symbol('configuration')
+
+  /**
+   * Symbol representing the dialog manager instance.
+   */
   static dialogManager = Symbol('dialogManager')
+
+  /**
+   * Symbol representing the queue storage for the dialog turn.
+   */
   static queueStorage = Symbol('queueStorage')
 }

package/src/intentScore.ts

@@ -6,6 +6,13 @@
  * Score plus any extra information about an intent.
  */
 export interface IntentScore {
-  score?: number;
-  [key: string]: unknown;
+  /**
+   * Optional. The confidence score of the intent, ranging from 0.0 to 1.0.
+   */
+  score?: number
+
+  /**
+   * Additional properties related to the intent.
+   */
+  [key: string]: unknown
 }

package/src/memory/dialogPath.ts

@@ -7,27 +7,51 @@
  * Defines path for available dialogs.
  */
 export class DialogPath {
-  /// Counter of emitted events.
-  static readonly eventCounter = 'dialog.eventCounter'
-
-  /// Currently expected properties.
-  static readonly expectedProperties = 'dialog.expectedProperties'
-
-  /// Default operation to use for entities where there is no identified operation entity.
-  static readonly defaultOperation = 'dialog.defaultOperation'
-
-  /// Last surfaced entity ambiguity event.
-  static readonly lastEvent = 'dialog.lastEvent'
-
-  /// Currently required properties.
-  static readonly requiredProperties = 'dialog.requiredProperties'
-
-  /// Number of retries for the current Ask.
-  static readonly retries = 'dialog.retries'
-
-  /// Last intent.
-  static readonly lastIntent = 'dialog.lastIntent'
-
-  /// Last trigger event: defined in FormEvent, ask, clarifyEntity etc..
-  static readonly lastTriggerEvent = 'dialog.lastTriggerEvent'
+  /**
+   * Counter of emitted events.
+   * @constant A string key representing the event counter path (`'dialog.eventCounter'`).
+   */
+  static readonly eventCounter: string = 'dialog.eventCounter'
+
+  /**
+   * Currently expected properties.
+   * @constant A string key representing the expected properties path (`'dialog.expectedProperties'`).
+   */
+  static readonly expectedProperties: string = 'dialog.expectedProperties'
+
+  /**
+   * Default operation to use for entities where there is no identified operation entity.
+   * @constant A string key representing the default operation path (`'dialog.defaultOperation'`).
+   */
+  static readonly defaultOperation: string = 'dialog.defaultOperation'
+
+  /**
+   * Last surfaced entity ambiguity event.
+   * @constant A string key representing the last event path (`'dialog.lastEvent'`).
+   */
+  static readonly lastEvent: string = 'dialog.lastEvent'
+
+  /**
+   * Currently required properties.
+   * @constant A string key representing the required properties path (`'dialog.requiredProperties'`).
+   */
+  static readonly requiredProperties: string = 'dialog.requiredProperties'
+
+  /**
+   * Number of retries for the current Ask.
+   * @constant A string key representing the retries path (`'dialog.retries'`).
+   */
+  static readonly retries: string = 'dialog.retries'
+
+  /**
+   * Last intent.
+   * @constant A string key representing the last intent path (`'dialog.lastIntent'`).
+   */
+  static readonly lastIntent: string = 'dialog.lastIntent'
+
+  /**
+   * Last trigger event: defined in FormEvent, ask, clarifyEntity etc.
+   * @constant A string key representing the last trigger event path (`'dialog.lastTriggerEvent'`).
+   */
+  static readonly lastTriggerEvent: string = 'dialog.lastTriggerEvent'
 }

package/src/memory/dialogStateManager.ts

@@ -435,7 +435,7 @@ export class DialogStateManager {
      * Track when specific paths are changed.
      *
      * @param paths Paths to track.
-     * @returns Normalized paths to pass to [anyPathChanged()](#anypathchanged).
+     * @returns Normalized paths to pass to `anyPathChanged` method.
      */
   trackPaths (paths: string[]): string[] {
     const allPaths: string[] = []
@@ -459,7 +459,7 @@ export class DialogStateManager {
      * Check to see if any path has changed since watermark.
      *
      * @param counter Time counter to compare to.
-     * @param paths Paths from [trackPaths()](#trackpaths) to check.
+     * @param paths Paths from `trackPaths` method to check.
      * @returns True if any path has changed since counter.
      */
   anyPathChanged (counter: number, paths: string[]): boolean {

package/src/memory/pathResolvers/aliasPathResolver.ts

@@ -4,6 +4,10 @@
  */
 import { PathResolver } from './pathResolver'
 
+/**
+ * A class that resolves paths by replacing an alias with a specified prefix and optional postfix.
+ * This is useful for transforming paths that use shorthand aliases into fully qualified paths.
+ */
 export class AliasPathResolver implements PathResolver {
   private readonly alias: string
   private readonly prefix: string

package/src/memory/pathResolvers/atAtPathResolver.ts

@@ -4,10 +4,14 @@
  */
 import { AliasPathResolver } from './aliasPathResolver'
 
+/**
+ * A specialized path resolver that replaces the '@@' alias with the prefix 'turn.recognized.entities.'.
+ * This is used to resolve paths related to recognized entities in a conversational turn.
+ */
 export class AtAtPathResolver extends AliasPathResolver {
   /**
-     * Initializes a new instance of the AtAtPathResolver class.
-     */
+   * Initializes a new instance of the AtAtPathResolver class.
+   */
   constructor () {
     super('@@', 'turn.recognized.entities.')
   }

package/src/memory/pathResolvers/atPathResolver.ts

@@ -4,23 +4,29 @@
  */
 import { AliasPathResolver } from './aliasPathResolver'
 
+/**
+ * A path resolver that replaces the '@' alias with a specific prefix and transforms paths
+ * to access recognized entities in a conversational turn. It ensures that the resolved
+ * path includes the 'first()' function for entity properties.
+ */
 export class AtPathResolver extends AliasPathResolver {
   private readonly _prefix = 'turn.recognized.entities.'
   private readonly _delims = ['.', '[']
 
   /**
-     * Initializes a new instance of the AtPathResolver class.
-     */
+   * Initializes a new instance of the AtPathResolver class.
+   */
   constructor () {
     super('@', '')
   }
 
   /**
-     * Transforms the path.
-     *
-     * @param path Path to inspect.
-     * @returns The transformed path.
-     */
+   * Transforms the path by replacing the '@' alias and appending the 'first()' function
+   * to entity properties.
+   *
+   * @param path The path to inspect and transform.
+   * @returns The transformed path.
+   */
   transformPath (path: string): string {
     path = path.trim()
     if (path.startsWith('@') && path.length > 1 && !path.startsWith('@@')) {