@microsoft/agents-hosting-dialogs 0.2.14 → 0.4.1

package/dist/src/memory/scopes/classMemoryScope.d.ts

@@ -5,25 +5,29 @@
 import { MemoryScope } from './memoryScope';
 import { DialogContext } from '../../dialogContext';
 import { Dialog } from '../../dialog';
+/**
+ * A memory scope that provides access to the properties of the active dialog.
+ * This scope binds to the active dialog and clones its properties for use in memory.
+ */
 export declare class ClassMemoryScope extends MemoryScope {
     /**
-       * Initializes a new instance of the ClassMemoryScope class.
-       *
-       * @param name Name of the scope class.
-       */
+     * Initializes a new instance of the ClassMemoryScope class.
+     *
+     * @param name - Name of the scope class. Defaults to `ScopePath.class`.
+     */
     constructor(name?: string);
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope, containing cloned properties of the active dialog.
+     */
     getMemory(dialogContext: DialogContext): object;
     /**
-       * Override to find the dialog instance referenced by the scope.
-       *
-       * @param dialogContext Current dialog context.
-       * @returns The dialog instance referenced by the scope.
-       */
+     * Override to find the dialog instance referenced by the scope.
+     *
+     * @param dialogContext - Current dialog context.
+     * @returns The dialog instance referenced by the scope, or undefined if not found.
+     */
     protected onFindDialog(dialogContext: DialogContext): Dialog | undefined;
 }

package/dist/src/memory/scopes/classMemoryScope.js

@@ -7,21 +7,25 @@ exports.ClassMemoryScope = void 0;
  */
 const memoryScope_1 = require("./memoryScope");
 const scopePath_1 = require("../scopePath");
+/**
+ * A memory scope that provides access to the properties of the active dialog.
+ * This scope binds to the active dialog and clones its properties for use in memory.
+ */
 class ClassMemoryScope extends memoryScope_1.MemoryScope {
     /**
-       * Initializes a new instance of the ClassMemoryScope class.
-       *
-       * @param name Name of the scope class.
-       */
+     * Initializes a new instance of the ClassMemoryScope class.
+     *
+     * @param name - Name of the scope class. Defaults to `ScopePath.class`.
+     */
     constructor(name = scopePath_1.ScopePath.class) {
         super(name, false);
     }
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope, containing cloned properties of the active dialog.
+     */
     getMemory(dialogContext) {
         // if active dialog is a container dialog then "dialog" binds to it
         if (dialogContext.activeDialog) {
@@ -49,11 +53,11 @@ class ClassMemoryScope extends memoryScope_1.MemoryScope {
         return {};
     }
     /**
-       * Override to find the dialog instance referenced by the scope.
-       *
-       * @param dialogContext Current dialog context.
-       * @returns The dialog instance referenced by the scope.
-       */
+     * Override to find the dialog instance referenced by the scope.
+     *
+     * @param dialogContext - Current dialog context.
+     * @returns The dialog instance referenced by the scope, or undefined if not found.
+     */
     onFindDialog(dialogContext) {
         return dialogContext.findDialog(dialogContext.activeDialog.id);
     }

package/dist/src/memory/scopes/classMemoryScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"classMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/classMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAIxC,MAAa,gBAAiB,SAAQ,yBAAW;IAC/C;;;;SAIK;IACL,YAAa,IAAI,GAAG,qBAAS,CAAC,KAAK;QACjC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACpB,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B;QACrC,mEAAmE;QACnE,IAAI,aAAa,CAAC,YAAY,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;YAC/C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,mBAAmB;gBACnB,MAAM,KAAK,GAAW,EAAE,CAAA;gBACxB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;oBACzB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;oBACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;wBACpF,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;4BAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;gCACX,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;4BACpB,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;wBACnB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;SAKK;IACK,YAAY,CAAE,aAA4B;QAClD,OAAO,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAChE,CAAC;CACF;AArDD,4CAqDC;AAED,SAAS,YAAY,CAAE,IAAS;IAC9B,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,UAAU,CAAA;AAC9E,CAAC"}
+{"version":3,"file":"classMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/classMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAIxC;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAC/C;;;;OAIG;IACH,YAAa,IAAI,GAAG,qBAAS,CAAC,KAAK;QACjC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAE,aAA4B;QACrC,mEAAmE;QACnE,IAAI,aAAa,CAAC,YAAY,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;YAC/C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,mBAAmB;gBACnB,MAAM,KAAK,GAAW,EAAE,CAAA;gBACxB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;oBACzB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;oBACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;wBACpF,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;4BAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;gCACX,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;4BACpB,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;wBACnB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACO,YAAY,CAAE,aAA4B;QAClD,OAAO,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAChE,CAAC;CACF;AArDD,4CAqDC;AAED,SAAS,YAAY,CAAE,IAAS;IAC9B,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,UAAU,CAAA;AAC9E,CAAC"}

package/dist/src/memory/scopes/dialogClassMemoryScope.d.ts

@@ -5,15 +5,21 @@
 import { ClassMemoryScope } from './classMemoryScope';
 import { DialogContext } from '../../dialogContext';
 import { Dialog } from '../../dialog';
+/**
+ * A memory scope that provides access to the properties of the active dialog class.
+ * This scope resolves to the active dialog if it is a container, or to its parent dialog.
+ */
 export declare class DialogClassMemoryScope extends ClassMemoryScope {
     /**
-       * Initializes a new instance of the DialogClassMemoryScope class.
-       */
+     * Initializes a new instance of the DialogClassMemoryScope class.
+     */
     constructor();
     /**
-       * @protected
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The current Dialog.
-       */
+     * @protected
+     * Finds the dialog instance referenced by the scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The current dialog, or its parent dialog if applicable.
+     */
     protected onFindDialog(dialogContext: DialogContext): Dialog | undefined;
 }

package/dist/src/memory/scopes/dialogClassMemoryScope.js

@@ -8,18 +8,24 @@ exports.DialogClassMemoryScope = void 0;
 const classMemoryScope_1 = require("./classMemoryScope");
 const scopePath_1 = require("../scopePath");
 const dialogContainer_1 = require("../../dialogContainer");
+/**
+ * A memory scope that provides access to the properties of the active dialog class.
+ * This scope resolves to the active dialog if it is a container, or to its parent dialog.
+ */
 class DialogClassMemoryScope extends classMemoryScope_1.ClassMemoryScope {
     /**
-       * Initializes a new instance of the DialogClassMemoryScope class.
-       */
+     * Initializes a new instance of the DialogClassMemoryScope class.
+     */
     constructor() {
         super(scopePath_1.ScopePath.dialogClass);
     }
     /**
-       * @protected
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The current Dialog.
-       */
+     * @protected
+     * Finds the dialog instance referenced by the scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The current dialog, or its parent dialog if applicable.
+     */
     onFindDialog(dialogContext) {
         // Is the active dialog a container?
         const dialog = dialogContext.findDialog(dialogContext.activeDialog.id);

package/dist/src/memory/scopes/dialogClassMemoryScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"dialogClassMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogClassMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,yDAAqD;AACrD,4CAAwC;AAGxC,2DAAuD;AAEvD,MAAa,sBAAuB,SAAQ,mCAAgB;IAC1D;;SAEK;IACL;QACE,KAAK,CAAC,qBAAS,CAAC,WAAW,CAAC,CAAA;IAC9B,CAAC;IAED;;;;SAIK;IACK,YAAY,CAAE,aAA4B;QAClD,oCAAoC;QACpC,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QACtE,IAAI,MAAM,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;YAChD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,wCAAwC;QACxC,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAA;QACnC,IAAI,MAAM,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YAC9D,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,YAAY,CAAA;YACrB,CAAC;QACH,CAAC;QAED,uCAAuC;QACvC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAhCD,wDAgCC"}
+{"version":3,"file":"dialogClassMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogClassMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,yDAAqD;AACrD,4CAAwC;AAGxC,2DAAuD;AAEvD;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,mCAAgB;IAC1D;;OAEG;IACH;QACE,KAAK,CAAC,qBAAS,CAAC,WAAW,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;;OAMG;IACO,YAAY,CAAE,aAA4B;QAClD,oCAAoC;QACpC,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QACtE,IAAI,MAAM,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;YAChD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,wCAAwC;QACxC,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAA;QACnC,IAAI,MAAM,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YAC9D,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,YAAY,CAAA;YACrB,CAAC;QACH,CAAC;QAED,uCAAuC;QACvC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAlCD,wDAkCC"}

package/dist/src/memory/scopes/dialogContextMemoryScope.d.ts

@@ -4,16 +4,20 @@
  */
 import { DialogContext } from '../../dialogContext';
 import { MemoryScope } from './memoryScope';
+/**
+ * A memory scope that provides access to the dialog context.
+ * This scope includes information about the active dialog, its parent, and the dialog stack.
+ */
 export declare class DialogContextMemoryScope extends MemoryScope {
     /**
-       * Initializes a new instance of the `DialogContextMemoryScope` class.
-       */
+     * Initializes a new instance of the `DialogContextMemoryScope` class.
+     */
     constructor();
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The `DialogContext` object for this turn.
-       * @returns Memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The `DialogContext` object for this turn.
+     * @returns An object containing the dialog stack, active dialog ID, and parent dialog ID.
+     */
     getMemory(dialogContext: DialogContext): Record<'stack' | 'activeDialog' | 'parent', unknown>;
 }

package/dist/src/memory/scopes/dialogContextMemoryScope.js

@@ -7,19 +7,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DialogContextMemoryScope = void 0;
 const memoryScope_1 = require("./memoryScope");
 const scopePath_1 = require("../scopePath");
+/**
+ * A memory scope that provides access to the dialog context.
+ * This scope includes information about the active dialog, its parent, and the dialog stack.
+ */
 class DialogContextMemoryScope extends memoryScope_1.MemoryScope {
     /**
-       * Initializes a new instance of the `DialogContextMemoryScope` class.
-       */
+     * Initializes a new instance of the `DialogContextMemoryScope` class.
+     */
     constructor() {
         super(scopePath_1.ScopePath.dialogContext, false);
     }
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The `DialogContext` object for this turn.
-       * @returns Memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The `DialogContext` object for this turn.
+     * @returns An object containing the dialog stack, active dialog ID, and parent dialog ID.
+     */
     getMemory(dialogContext) {
         const stack = [];
         let currentDialogContext = dialogContext;

package/dist/src/memory/scopes/dialogContextMemoryScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"dialogContextMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogContextMemoryScope.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+CAA2C;AAC3C,4CAAwC;AAExC,MAAa,wBAAyB,SAAQ,yBAAW;IACvD;;SAEK;IACL;QACE,KAAK,CAAC,qBAAS,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B;QACrC,MAAM,KAAK,GAAG,EAAE,CAAA;QAChB,IAAI,oBAAoB,GAA8B,aAAa,CAAA;QAEnE,kBAAkB;QAClB,OAAO,oBAAoB,CAAC,KAAK,EAAE,CAAC;YAClC,oBAAoB,GAAG,oBAAoB,CAAC,KAAK,CAAA;QACnD,CAAC;QAED,OAAO,oBAAoB,EAAE,CAAC;YAC5B,KAAK,IAAI,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChE,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1C,sEAAsE;gBACtE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;oBACxC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBACrB,CAAC;YACH,CAAC;YAED,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,CAAA;QACpD,CAAC;QAED,OAAO;YACL,KAAK;YACL,YAAY,EAAE,aAAa,CAAC,YAAY,IAAI,aAAa,CAAC,YAAY,CAAC,EAAE;YACzE,MAAM,EAAE,aAAa,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,YAAY,IAAI,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;SAC1G,CAAA;IACH,CAAC;CACF;AAzCD,4DAyCC"}
+{"version":3,"file":"dialogContextMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogContextMemoryScope.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+CAA2C;AAC3C,4CAAwC;AAExC;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,yBAAW;IACvD;;OAEG;IACH;QACE,KAAK,CAAC,qBAAS,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAE,aAA4B;QACrC,MAAM,KAAK,GAAG,EAAE,CAAA;QAChB,IAAI,oBAAoB,GAA8B,aAAa,CAAA;QAEnE,kBAAkB;QAClB,OAAO,oBAAoB,CAAC,KAAK,EAAE,CAAC;YAClC,oBAAoB,GAAG,oBAAoB,CAAC,KAAK,CAAA;QACnD,CAAC;QAED,OAAO,oBAAoB,EAAE,CAAC;YAC5B,KAAK,IAAI,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChE,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1C,sEAAsE;gBACtE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;oBACxC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBACrB,CAAC;YACH,CAAC;YAED,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,CAAA;QACpD,CAAC;QAED,OAAO;YACL,KAAK;YACL,YAAY,EAAE,aAAa,CAAC,YAAY,IAAI,aAAa,CAAC,YAAY,CAAC,EAAE;YACzE,MAAM,EAAE,aAAa,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,YAAY,IAAI,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;SAC1G,CAAA;IACH,CAAC;CACF;AAzCD,4DAyCC"}

package/dist/src/memory/scopes/dialogMemoryScope.d.ts

@@ -4,29 +4,36 @@
  */
 import { MemoryScope } from './memoryScope';
 import { DialogContext } from '../../dialogContext';
+/**
+ * A memory scope that provides access to the active dialog's state.
+ * This scope binds to the active dialog if it is a container, or to its parent dialog if applicable.
+ */
 export declare class DialogMemoryScope extends MemoryScope {
     /**
-       * Initializes a new instance of the DialogMemoryScope class.
-       */
+     * Initializes a new instance of the DialogMemoryScope class.
+     */
     constructor();
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope.
+     */
     getMemory(dialogContext: DialogContext): object;
     /**
-       * Changes the backing object for the memory scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @param memory Memory object to set for the scope.
-       */
+     * Changes the backing object for the memory scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @param memory - Memory object to set for the scope.
+     * @throws Will throw an error if the memory object is undefined or if no active dialog is found.
+     */
     setMemory(dialogContext: DialogContext, memory: object): void;
     /**
-       * @private
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns A boolean indicating whether is a cointainer or not.
-       */
+     * Determines if the given dialog context is a container.
+     *
+     * @private
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns A boolean indicating whether the dialog context is a container.
+     */
     private isContainer;
 }

package/dist/src/memory/scopes/dialogMemoryScope.js

@@ -8,19 +8,23 @@ exports.DialogMemoryScope = void 0;
 const memoryScope_1 = require("./memoryScope");
 const scopePath_1 = require("../scopePath");
 const dialogContainer_1 = require("../../dialogContainer");
+/**
+ * A memory scope that provides access to the active dialog's state.
+ * This scope binds to the active dialog if it is a container, or to its parent dialog if applicable.
+ */
 class DialogMemoryScope extends memoryScope_1.MemoryScope {
     /**
-       * Initializes a new instance of the DialogMemoryScope class.
-       */
+     * Initializes a new instance of the DialogMemoryScope class.
+     */
     constructor() {
         super(scopePath_1.ScopePath.dialog);
     }
     /**
-       * Gets the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope.
+     */
     getMemory(dialogContext) {
         // If active dialog is a container dialog then "dialog" binds to it.
         // Otherwise the "dialog" will bind to the dialogs parent assuming it
@@ -33,11 +37,12 @@ class DialogMemoryScope extends memoryScope_1.MemoryScope {
         return parent.activeDialog ? parent.activeDialog.state : {};
     }
     /**
-       * Changes the backing object for the memory scope.
-       *
-       * @param dialogContext The DialogContext object for this turn.
-       * @param memory Memory object to set for the scope.
-       */
+     * Changes the backing object for the memory scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @param memory - Memory object to set for the scope.
+     * @throws Will throw an error if the memory object is undefined or if no active dialog is found.
+     */
     setMemory(dialogContext, memory) {
         if (memory === undefined) {
             throw new Error('DialogMemoryScope.setMemory: undefined memory object passed in.');
@@ -56,10 +61,12 @@ class DialogMemoryScope extends memoryScope_1.MemoryScope {
         parent.activeDialog.state = memory;
     }
     /**
-       * @private
-       * @param dialogContext The DialogContext object for this turn.
-       * @returns A boolean indicating whether is a cointainer or not.
-       */
+     * Determines if the given dialog context is a container.
+     *
+     * @private
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns A boolean indicating whether the dialog context is a container.
+     */
     isContainer(dialogContext) {
         if (dialogContext !== undefined && dialogContext.activeDialog !== undefined) {
             const dialog = dialogContext.findDialog(dialogContext.activeDialog.id);

package/dist/src/memory/scopes/dialogMemoryScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"dialogMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAExC,2DAAuD;AAEvD,MAAa,iBAAkB,SAAQ,yBAAW;IAChD;;SAEK;IACL;QACE,KAAK,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B;QACrC,oEAAoE;QACpE,qEAAqE;QACrE,kBAAkB;QAClB,IAAI,MAAM,GAAkB,aAAa,CAAA;QACzC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAClF,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QACxB,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;IAC7D,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B,EAAE,MAAc;QACrD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;QACpF,CAAC;QAED,oEAAoE;QACpE,qEAAqE;QACrE,kBAAkB;QAClB,IAAI,MAAM,GAAkB,aAAa,CAAA;QACzC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAClF,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QACxB,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACzE,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,KAAK,GAAG,MAAM,CAAA;IACpC,CAAC;IAED;;;;SAIK;IACG,WAAW,CAAE,aAA4B;QAC/C,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAC5E,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YACtE,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AArED,8CAqEC"}
+{"version":3,"file":"dialogMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/dialogMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAExC,2DAAuD;AAEvD;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,yBAAW;IAChD;;OAEG;IACH;QACE,KAAK,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAE,aAA4B;QACrC,oEAAoE;QACpE,qEAAqE;QACrE,kBAAkB;QAClB,IAAI,MAAM,GAAkB,aAAa,CAAA;QACzC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAClF,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QACxB,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAE,aAA4B,EAAE,MAAc;QACrD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;QACpF,CAAC;QAED,oEAAoE;QACpE,qEAAqE;QACrE,kBAAkB;QAClB,IAAI,MAAM,GAAkB,aAAa,CAAA;QACzC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAClF,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QACxB,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACzE,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,KAAK,GAAG,MAAM,CAAA;IACpC,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CAAE,aAA4B;QAC/C,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAC5E,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YACtE,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAxED,8CAwEC"}

package/dist/src/memory/scopes/turnMemoryScope.d.ts

@@ -5,25 +5,26 @@
 import { MemoryScope } from './memoryScope';
 import { DialogContext } from '../../dialogContext';
 /**
- * TurnMemoryScope represents memory scoped to the current turn.
+ * A memory scope that provides access to the turn's state.
+ * This scope is used to store and retrieve information specific to the current turn.
  */
 export declare class TurnMemoryScope extends MemoryScope {
     /**
-       * Initializes a new instance of the TurnMemoryScope class.
-       */
+     * Initializes a new instance of the TurnMemoryScope class.
+     */
     constructor();
     /**
-       * Get the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope.
+     */
     getMemory(dialogContext: DialogContext): object;
     /**
-       * Changes the backing object for the memory scope.
-       *
-       * @param dialogContext The DialogContext for this turn.
-       * @param memory Memory object to set for the scope.
-       */
+     * Changes the backing object for the memory scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @param memory - Memory object to set for the scope.
+     */
     setMemory(dialogContext: DialogContext, memory: object): void;
 }

package/dist/src/memory/scopes/turnMemoryScope.js

@@ -12,21 +12,22 @@ const scopePath_1 = require("../scopePath");
  */
 const TURN_STATE = 'turn';
 /**
- * TurnMemoryScope represents memory scoped to the current turn.
+ * A memory scope that provides access to the turn's state.
+ * This scope is used to store and retrieve information specific to the current turn.
  */
 class TurnMemoryScope extends memoryScope_1.MemoryScope {
     /**
-       * Initializes a new instance of the TurnMemoryScope class.
-       */
+     * Initializes a new instance of the TurnMemoryScope class.
+     */
     constructor() {
         super(scopePath_1.ScopePath.turn, true);
     }
     /**
-       * Get the backing memory for this scope.
-       *
-       * @param dialogContext The DialogContext for this turn.
-       * @returns The memory for the scope.
-       */
+     * Gets the backing memory for this scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @returns The memory for the scope.
+     */
     getMemory(dialogContext) {
         let memory = dialogContext.context.turnState.get(TURN_STATE);
         if (typeof memory !== 'object') {
@@ -36,11 +37,11 @@ class TurnMemoryScope extends memoryScope_1.MemoryScope {
         return memory;
     }
     /**
-       * Changes the backing object for the memory scope.
-       *
-       * @param dialogContext The DialogContext for this turn.
-       * @param memory Memory object to set for the scope.
-       */
+     * Changes the backing object for the memory scope.
+     *
+     * @param dialogContext - The DialogContext object for this turn.
+     * @param memory - Memory object to set for the scope.
+     */
     setMemory(dialogContext, memory) {
         if (memory === undefined) {
             throw new Error('TurnMemoryScope.setMemory: undefined memory object passed in.');

package/dist/src/memory/scopes/turnMemoryScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"turnMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/turnMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAGxC;;GAEG;AACH,MAAM,UAAU,GAAG,MAAM,CAAA;AAEzB;;GAEG;AACH,MAAa,eAAgB,SAAQ,yBAAW;IAC9C;;SAEK;IACL;QACE,KAAK,CAAC,qBAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B;QACrC,IAAI,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC5D,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,EAAE,CAAA;YACX,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QACzD,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;SAKK;IACL,SAAS,CAAE,aAA4B,EAAE,MAAc;QACrD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;QAClF,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACzD,CAAC;CACF;AArCD,0CAqCC"}
+{"version":3,"file":"turnMemoryScope.js","sourceRoot":"","sources":["../../../../src/memory/scopes/turnMemoryScope.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+CAA2C;AAC3C,4CAAwC;AAGxC;;GAEG;AACH,MAAM,UAAU,GAAG,MAAM,CAAA;AAEzB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,yBAAW;IAC9C;;OAEG;IACH;QACE,KAAK,CAAC,qBAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAE,aAA4B;QACrC,IAAI,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC5D,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,EAAE,CAAA;YACX,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QACzD,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAE,aAA4B,EAAE,MAAc;QACrD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;QAClF,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACzD,CAAC;CACF;AArCD,0CAqCC"}

package/dist/src/memory/turnPath.d.ts

@@ -3,19 +3,67 @@
  * Licensed under the MIT License.
  */
 /**
- * Defines path for avaiable turns.
+ * Defines path for available turns.
  */
 export declare class TurnPath {
-    static readonly lastResult = "turn.lastresult";
-    static readonly activity = "turn.activity";
-    static readonly recognized = "turn.recognized";
-    static readonly topIntent = "turn.recognized.intent";
-    static readonly topScore = "turn.recognized.score";
-    static readonly text = "turn.recognized.text";
-    static readonly unrecognizedText = "turn.unrecognizedText";
-    static readonly recognizedEntities = "turn.recognizedEntities";
-    static readonly interrupted = "turn.interrupted";
-    static readonly dialogEvent = "turn.dialogEvent";
-    static readonly repeatedIds = "turn.repeatedIds";
-    static readonly activityProcessed = "turn.activityProcessed";
+    /**
+     * The result from the last dialog that was called.
+     * @constant A string key representing the last result path (`'turn.lastresult'`).
+     */
+    static readonly lastResult: string;
+    /**
+     * The current activity for the turn.
+     * @constant A string key representing the activity path (`'turn.activity'`).
+     */
+    static readonly activity: string;
+    /**
+     * The recognized result for the current turn.
+     * @constant A string key representing the recognized result path (`'turn.recognized'`).
+     */
+    static readonly recognized: string;
+    /**
+     * Path to the top intent.
+     * @constant A string key representing the top intent path (`'turn.recognized.intent'`).
+     */
+    static readonly topIntent: string;
+    /**
+     * Path to the top score.
+     * @constant A string key representing the top score path (`'turn.recognized.score'`).
+     */
+    static readonly topScore: string;
+    /**
+     * Original text.
+     * @constant A string key representing the original text path (`'turn.recognized.text'`).
+     */
+    static readonly text: string;
+    /**
+     * Original utterance split into unrecognized strings.
+     * @constant A string key representing the unrecognized text path (`'turn.unrecognizedText'`).
+     */
+    static readonly unrecognizedText: string;
+    /**
+     * Entities that were recognized from text.
+     * @constant A string key representing the recognized entities path (`'turn.recognizedEntities'`).
+     */
+    static readonly recognizedEntities: string;
+    /**
+     * If true, an interruption has occurred.
+     * @constant A string key representing the interrupted path (`'turn.interrupted'`).
+     */
+    static readonly interrupted: string;
+    /**
+     * The current dialog event (set during event processing).
+     * @constant A string key representing the dialog event path (`'turn.dialogEvent'`).
+     */
+    static readonly dialogEvent: string;
+    /**
+     * 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'`).
+     */
+    static readonly repeatedIds: string;
+    /**
+     * 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'`).
+     */
+    static readonly activityProcessed: string;
 }

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