@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/dialogHelper.js

@@ -0,0 +1,116 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runDialog = runDialog;
+exports.internalRun = internalRun;
+exports.getActiveDialogContext = getActiveDialogContext;
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const dialogEvents_1 = require("./dialogEvents");
+const dialogSet_1 = require("./dialogSet");
+const memory_1 = require("./memory");
+const dialogTurnStatus_1 = require("./dialogTurnStatus");
+/**
+ * Runs a dialog from a given context and accessor.
+ *
+ * @param dialog The Dialog to run.
+ * @param context TurnContext object for the current turn of conversation with the user.
+ * @param accessor Defined methods for accessing the state property created in a State object.
+ */
+async function runDialog(dialog, context, accessor) {
+    if (!dialog) {
+        throw new Error('runDialog(): missing dialog');
+    }
+    if (!context) {
+        throw new Error('runDialog(): missing context');
+    }
+    if (!context.activity) {
+        throw new Error('runDialog(): missing context.activity');
+    }
+    if (!accessor) {
+        throw new Error('runDialog(): missing accessor');
+    }
+    const dialogSet = new dialogSet_1.DialogSet(accessor);
+    dialogSet.add(dialog);
+    const dialogContext = await dialogSet.createContext(context);
+    await internalRun(context, dialog.id, dialogContext);
+}
+/**
+ * @param context The TurnContext for the turn.
+ * @param dialogId The dialog ID.
+ * @param dialogContext The DialogContext for the current turn of conversation.
+ * @param dialogStateManagerConfiguration Configuration for the dialog state manager.
+ * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
+ */
+async function internalRun(context, dialogId, dialogContext, dialogStateManagerConfiguration) {
+    // map TurnState into root dialog context.services
+    context.turnState.forEach((service, key) => {
+        dialogContext.services.push(key, service);
+    });
+    const dialogStateManager = new memory_1.DialogStateManager(dialogContext, dialogStateManagerConfiguration);
+    await dialogStateManager.loadAllScopes();
+    dialogContext.context.turnState.push('DialogStateManager', dialogStateManager);
+    let dialogTurnResult = null;
+    // Loop as long as we are getting valid OnError handled we should continue executing the actions for the turn.
+    // NOTE: We loop around this block because each pass through we either complete the turn and break out of the loop
+    // or we have had an exception AND there was an OnError action which captured the error. We need to continue the
+    // turn based on the actions the OnError handler introduced.
+    let endOfTurn = false;
+    while (!endOfTurn) {
+        try {
+            dialogTurnResult = await innerRun(context, dialogId, dialogContext);
+            // turn successfully completed, break the loop
+            endOfTurn = true;
+        }
+        catch (err) {
+            // fire error event, bubbling from the leaf.
+            const handled = await dialogContext.emitEvent(dialogEvents_1.DialogEvents.error, err, true, true);
+            if (!handled) {
+                // error was NOT handled, throw the exception and end the turn.
+                // (This will trigger the Adapter.OnError handler and end the entire dialog stack)
+                throw err;
+            }
+        }
+    }
+    // save all state scopes to their respective agentState locations.
+    await dialogStateManager.saveAllChanges();
+    // return the redundant result because the DialogManager contract expects it
+    return dialogTurnResult;
+}
+async function innerRun(context, dialogId, dialogContext) {
+    // Continue or start the dialog.
+    let result = await dialogContext.continueDialog();
+    if (result.status === dialogTurnStatus_1.DialogTurnStatus.empty) {
+        result = await dialogContext.beginDialog(dialogId);
+    }
+    await sendStateSnapshotTrace(dialogContext);
+    return result;
+}
+/**
+ * Recursively walk up the dialog context stack to find the active DC.
+ *
+ * @param dialogContext DialogContext for the current turn of conversation with the user.
+ * @returns Active DialogContext.
+ */
+function getActiveDialogContext(dialogContext) {
+    const child = dialogContext.child;
+    if (!child) {
+        return dialogContext;
+    }
+    return getActiveDialogContext(child);
+}
+// Helper to send a trace activity with a memory snapshot of the active dialog DC.
+const sendStateSnapshotTrace = async (dialogContext) => {
+    const traceLabel = 'Agent State';
+    // Send trace of memory
+    const snapshot = getActiveDialogContext(dialogContext).state.getMemorySnapshot();
+    const traceActivity = new agents_hosting_1.Activity(agents_hosting_1.ActivityTypes.Trace);
+    traceActivity.name = 'AgentState';
+    traceActivity.label = 'https://www.botframework.com/schemas/botState';
+    traceActivity.value = snapshot;
+    traceActivity.label = traceLabel;
+    await dialogContext.context.sendActivity(traceActivity);
+};
+//# sourceMappingURL=dialogHelper.js.map

package/dist/src/dialogHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogHelper.js","sourceRoot":"","sources":["../../src/dialogHelper.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAuBH,8BA2BC;AASD,kCA6CC;AAwBD,wDAOC;AArID,8DAKkC;AAGlC,iDAA6C;AAC7C,2CAAuC;AACvC,qCAA8E;AAE9E,yDAAqD;AAErD;;;;;;GAMG;AACI,KAAK,UAAU,SAAS,CAC7B,MAAc,EACd,OAAoB,EACpB,QAAiD;IAEjD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAChD,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IACjD,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAC1D,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;IAClD,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,QAAQ,CAAC,CAAA;IACzC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAErB,MAAM,aAAa,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;IAE5D,MAAM,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,aAAa,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAoB,EACpB,QAAgB,EAChB,aAA4B,EAC5B,+BAAiE;IAEjE,kDAAkD;IAClD,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;QACzC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAI,2BAAkB,CAAC,aAAa,EAAE,+BAA+B,CAAC,CAAA;IAEjG,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAA;IACxC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAA;IAC9E,IAAI,gBAAgB,GAAqB,IAAI,CAAA;IAE7C,8GAA8G;IAC9G,kHAAkH;IAClH,gHAAgH;IAChH,4DAA4D;IAC5D,IAAI,SAAS,GAAG,KAAK,CAAA;IACrB,OAAO,CAAC,SAAS,EAAE,CAAC;QAClB,IAAI,CAAC;YACH,gBAAgB,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAA;YAEnE,8CAA8C;YAC9C,SAAS,GAAG,IAAI,CAAA;QAClB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,4CAA4C;YAC5C,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,2BAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;YAElF,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,+DAA+D;gBAC/D,kFAAkF;gBAClF,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,MAAM,kBAAkB,CAAC,cAAc,EAAE,CAAA;IAEzC,4EAA4E;IAC5E,OAAO,gBAAgB,CAAA;AACzB,CAAC;AAED,KAAK,UAAU,QAAQ,CACrB,OAAoB,EACpB,QAAgB,EAChB,aAA4B;IAE5B,gCAAgC;IAChC,IAAI,MAAM,GAAG,MAAM,aAAa,CAAC,cAAc,EAAE,CAAA;IACjD,IAAI,MAAM,CAAC,MAAM,KAAK,mCAAgB,CAAC,KAAK,EAAE,CAAC;QAC7C,MAAM,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IACpD,CAAC;IAED,MAAM,sBAAsB,CAAC,aAAa,CAAC,CAAA;IAE3C,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAE,aAA4B;IAClE,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAA;IACjC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAA;AACtC,CAAC;AAED,kFAAkF;AAClF,MAAM,sBAAsB,GAAG,KAAK,EAAE,aAA4B,EAAiB,EAAE;IACnF,MAAM,UAAU,GAAG,aAAa,CAAA;IAEhC,uBAAuB;IACvB,MAAM,QAAQ,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAA;IAChF,MAAM,aAAa,GAAG,IAAI,yBAAQ,CAAC,8BAAa,CAAC,KAAK,CAAC,CAAA;IACvD,aAAa,CAAC,IAAI,GAAG,YAAY,CAAA;IACjC,aAAa,CAAC,KAAK,GAAG,+CAA+C,CAAA;IACrE,aAAa,CAAC,KAAK,GAAG,QAAQ,CAAA;IAC9B,aAAa,CAAC,KAAK,GAAG,UAAU,CAAA;IAEhC,MAAM,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;AACzD,CAAC,CAAA"}

package/dist/src/dialogInstance.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Contains state information for an instance of a dialog on the stack.
+ *
+ * @template T Optional. The type that represents state information for the dialog.
+ *
+ * @remarks
+ * This contains information for a specific instance of a dialog on a dialog stack.
+ * The dialog stack is associated with a specific dialog context and dialog set.
+ * Information about the dialog stack as a whole is persisted to storage using a dialog state object.
+ *
+ */
+export interface DialogInstance<T = any> {
+    /**
+         * ID of this dialog
+         *
+         * @remarks
+         * Dialog state is associated with a specific dialog set.
+         * This ID is the the dialog's Dialog.id within that dialog set.
+         *
+         */
+    id: string;
+    /**
+         * The state information for this instance of this dialog.
+         */
+    state: T;
+    /**
+         * Hash code used to detect that a dialog has changed since the curent instance was started.
+         */
+    version?: string;
+}

package/dist/src/dialogInstance.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dialogInstance.js.map

package/dist/src/dialogInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogInstance.js","sourceRoot":"","sources":["../../src/dialogInstance.ts"],"names":[],"mappings":""}

package/dist/src/dialogManager.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TurnContext, AgentState, ConversationState, UserState, TurnContextStateCollection } from '@microsoft/agents-hosting';
+import { Configurable } from './configurable';
+import { DialogSet } from './dialogSet';
+import { Dialog } from './dialog';
+import { DialogStateManagerConfiguration } from './memory';
+import { DialogTurnResult } from './dialogTurnResult';
+export interface DialogManagerResult {
+    turnResult: DialogTurnResult;
+}
+export interface DialogManagerConfiguration {
+    conversationState: AgentState;
+    rootDialog: Dialog;
+    userState?: UserState;
+    expireAfter?: number;
+    stateConfiguration?: DialogStateManagerConfiguration;
+}
+/**
+ * Class which runs the dialog system.
+ *
+ * @deprecated This class will be deprecated.
+ */
+export declare class DialogManager extends Configurable {
+    private _rootDialogId;
+    private readonly _dialogStateProperty;
+    private readonly _initialTurnState;
+    /**
+       * Creates an instance of the DialogManager class.
+       *
+       * @param rootDialog Optional, root Dialog to use.
+       * @param dialogStateProperty Optional, alternate name for the dialogState property. (Default is "DialogStateProperty")
+       */
+    constructor(rootDialog?: Dialog, dialogStateProperty?: string);
+    conversationState: ConversationState;
+    userState?: UserState;
+    /**
+       * Values that will be copied to the `TurnContext.turnState` at the beginning of each turn.
+       *
+       * @returns The turn state collection.
+       */
+    get initialTurnState(): TurnContextStateCollection;
+    /**
+       * Root dialog to start from [onTurn()](#onturn) method.
+       */
+    set rootDialog(value: Dialog);
+    /**
+       * Gets the root Dialog ID.
+       *
+       * @returns The root Dialog ID.
+       */
+    get rootDialog(): Dialog;
+    dialogs: DialogSet;
+    stateConfiguration?: DialogStateManagerConfiguration;
+    expireAfter?: number;
+    /**
+       * Set configuration settings.
+       *
+       * @param config Configuration settings to apply.
+       * @returns The cofigured DialogManager context.
+       */
+    configure(config: Partial<DialogManagerConfiguration>): this;
+    /**
+       * Runs dialog system in the context of a TurnContext.
+       *
+       * @param context TurnContext for the current turn of conversation with the user.
+       * @returns Result of running the logic against the activity.
+       */
+    onTurn(context: TurnContext): Promise<DialogManagerResult>;
+    private registerContainerDialogs;
+}

package/dist/src/dialogManager.js

@@ -0,0 +1,156 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogManager = void 0;
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const agentStateSet_1 = require("./agentStateSet");
+const configurable_1 = require("./configurable");
+const dialogContainer_1 = require("./dialogContainer");
+const dialogContext_1 = require("./dialogContext");
+const dialogHelper_1 = require("./dialogHelper");
+const dialogSet_1 = require("./dialogSet");
+const dialogTurnStateConstants_1 = require("./dialogTurnStateConstants");
+const LAST_ACCESS = '_lastAccess';
+const CONVERSATION_STATE = 'ConversationState';
+const USER_STATE = 'UserState';
+/**
+ * Class which runs the dialog system.
+ *
+ * @deprecated This class will be deprecated.
+ */
+class DialogManager extends configurable_1.Configurable {
+    /**
+       * Creates an instance of the DialogManager class.
+       *
+       * @param rootDialog Optional, root Dialog to use.
+       * @param dialogStateProperty Optional, alternate name for the dialogState property. (Default is "DialogStateProperty")
+       */
+    constructor(rootDialog, dialogStateProperty) {
+        super();
+        this._initialTurnState = new agents_hosting_1.TurnContextStateCollection();
+        this.dialogs = new dialogSet_1.DialogSet();
+        if (rootDialog) {
+            this.rootDialog = rootDialog;
+        }
+        this._dialogStateProperty = dialogStateProperty !== null && dialogStateProperty !== void 0 ? dialogStateProperty : 'DialogState';
+        this._initialTurnState.set(dialogTurnStateConstants_1.DialogTurnStateConstants.dialogManager, this);
+    }
+    /**
+       * Values that will be copied to the `TurnContext.turnState` at the beginning of each turn.
+       *
+       * @returns The turn state collection.
+       */
+    get initialTurnState() {
+        return this._initialTurnState;
+    }
+    /**
+       * Root dialog to start from [onTurn()](#onturn) method.
+       */
+    set rootDialog(value) {
+        this.dialogs = new dialogSet_1.DialogSet();
+        if (value) {
+            this._rootDialogId = value.id;
+            this.dialogs.add(value);
+            this.registerContainerDialogs(this.rootDialog, false);
+        }
+        else {
+            this._rootDialogId = undefined;
+        }
+    }
+    /**
+       * Gets the root Dialog ID.
+       *
+       * @returns The root Dialog ID.
+       */
+    get rootDialog() {
+        return this._rootDialogId ? this.dialogs.find(this._rootDialogId) : undefined;
+    }
+    /**
+       * Set configuration settings.
+       *
+       * @param config Configuration settings to apply.
+       * @returns The cofigured DialogManager context.
+       */
+    configure(config) {
+        return super.configure(config);
+    }
+    /**
+       * Runs dialog system in the context of a TurnContext.
+       *
+       * @param context TurnContext for the current turn of conversation with the user.
+       * @returns Result of running the logic against the activity.
+       */
+    async onTurn(context) {
+        // Ensure properly configured
+        if (!this._rootDialogId) {
+            throw new Error("DialogManager.onTurn: the agent's 'rootDialog' has not been configured.");
+        }
+        // Copy initial turn state to context
+        this.initialTurnState.forEach((value, key) => {
+            context.turnState.set(key, value);
+        });
+        const agentStateSet = new agentStateSet_1.AgentStateSet();
+        if (!this.conversationState) {
+            this.conversationState = context.turnState.get(CONVERSATION_STATE);
+        }
+        else {
+            context.turnState.set(CONVERSATION_STATE, this.conversationState);
+        }
+        if (!this.conversationState) {
+            throw new Error("DialogManager.onTurn: the agent's 'conversationState' has not been configured.");
+        }
+        agentStateSet.add(this.conversationState);
+        if (!this.userState) {
+            this.userState = context.turnState.get(USER_STATE);
+        }
+        else {
+            context.turnState.set(USER_STATE, this.userState);
+        }
+        if (this.userState) {
+            agentStateSet.add(this.userState);
+        }
+        // Get last access
+        const lastAccessProperty = this.conversationState.createProperty(LAST_ACCESS);
+        const lastAccess = new Date(await lastAccessProperty.get(context, new Date().toISOString()));
+        // Check for expired conversation
+        const now = new Date();
+        if (this.expireAfter !== undefined && now.getTime() - lastAccess.getTime() >= this.expireAfter) {
+            // Clear conversation state
+            await this.conversationState.clear(context);
+        }
+        // Update last access time
+        await lastAccessProperty.set(context, lastAccess.toISOString());
+        // get dialog stack
+        const dialogsProperty = this.conversationState.createProperty(this._dialogStateProperty);
+        const dialogState = await dialogsProperty.get(context, {});
+        // Create DialogContext
+        const dc = new dialogContext_1.DialogContext(this.dialogs, context, dialogState);
+        // Call the common dialog "continue/begin" execution pattern shared with the classic RunAsync extension method
+        const turnResult = await (0, dialogHelper_1.internalRun)(context, this._rootDialogId, dc, this.stateConfiguration);
+        // Save agentState changes
+        await agentStateSet.saveAllChanges(dc.context, false);
+        return { turnResult };
+    }
+    // Recursively traverses the dialog tree and registers intances of `DialogContainer` in the `DialogSet`
+    // for this `DialogManager` instance.
+    registerContainerDialogs(dialog, registerRoot = true) {
+        if (!(dialog instanceof dialogContainer_1.DialogContainer)) {
+            return;
+        }
+        const container = dialog;
+        if (registerRoot) {
+            if (this.dialogs.getDialogs().find((dlg) => dlg === container)) {
+                return;
+            }
+            this.dialogs.add(container);
+        }
+        container.dialogs.getDialogs().forEach((inner) => {
+            this.registerContainerDialogs(inner);
+        });
+    }
+}
+exports.DialogManager = DialogManager;
+//# sourceMappingURL=dialogManager.js.map

package/dist/src/dialogManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogManager.js","sourceRoot":"","sources":["../../src/dialogManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,8DAMkC;AAClC,mDAA+C;AAC/C,iDAA6C;AAC7C,uDAAmD;AACnD,mDAA4D;AAC5D,iDAA4C;AAC5C,2CAAuC;AACvC,yEAAqE;AAKrE,MAAM,WAAW,GAAG,aAAa,CAAA;AACjC,MAAM,kBAAkB,GAAG,mBAAmB,CAAA;AAC9C,MAAM,UAAU,GAAG,WAAW,CAAA;AAc9B;;;;GAIG;AACH,MAAa,aAAc,SAAQ,2BAAY;IAK7C;;;;;SAKK;IACL,YAAa,UAAmB,EAAE,mBAA4B;QAC5D,KAAK,EAAE,CAAA;QATQ,sBAAiB,GAA+B,IAAI,2CAA0B,EAAE,CAAA;QAoDjG,YAAO,GAAc,IAAI,qBAAS,EAAE,CAAA;QA1ClC,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC9B,CAAC;QACD,IAAI,CAAC,oBAAoB,GAAG,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,aAAa,CAAA;QAChE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,mDAAwB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAKD;;;;SAIK;IACL,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC/B,CAAC;IAED;;SAEK;IACL,IAAI,UAAU,CAAE,KAAa;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAS,EAAE,CAAA;QAC9B,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,EAAE,CAAA;YAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACvB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACvD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;QAChC,CAAC;IACH,CAAC;IAED;;;;SAIK;IACL,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC/E,CAAC;IAMD;;;;;SAKK;IACL,SAAS,CAAE,MAA2C;QACpD,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;IAED;;;;;SAKK;IACL,KAAK,CAAC,MAAM,CAAE,OAAoB;QAChC,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAA;QAC5F,CAAC;QAED,qCAAqC;QACrC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAQ,EAAE;YACjD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,MAAM,aAAa,GAAG,IAAI,6BAAa,EAAE,CAAA;QAEzC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QACpE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QACnE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAA;QACnG,CAAC;QACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAEzC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QACnD,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACnC,CAAC;QAED,kBAAkB;QAClB,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,WAAW,CAAC,CAAA;QAC7E,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,MAAM,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QAE5F,iCAAiC;QACjC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;QACtB,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC/F,2BAA2B;YAC3B,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,0BAA0B;QAC1B,MAAM,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAA;QAE/D,mBAAmB;QACnB,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;QACxF,MAAM,WAAW,GAAgB,MAAM,eAAe,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAEvE,uBAAuB;QACvB,MAAM,EAAE,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;QAEhE,8GAA8G;QAC9G,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAW,EAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAA;QAE9F,0BAA0B;QAC1B,MAAM,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAErD,OAAO,EAAE,UAAU,EAAE,CAAA;IACvB,CAAC;IAED,uGAAuG;IACvG,qCAAqC;IAC7B,wBAAwB,CAAE,MAAc,EAAE,YAAY,GAAG,IAAI;QACnE,IAAI,CAAC,CAAC,MAAM,YAAY,iCAAe,CAAC,EAAE,CAAC;YACzC,OAAM;QACR,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,CAAA;QACxB,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,EAAE,CAAC;gBAC/D,OAAM;YACR,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC7B,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/C,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;QACtC,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA7JD,sCA6JC"}

package/dist/src/dialogReason.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Indicates why a dialog method is being called.
+ *
+ * @remarks
+ * Use a dialog context to control the dialogs in a dialog set. The dialog context will pass a reference to itself
+ * to the dialog method it calls. It also passes in the _reason_ why the specific method is being called.
+ *
+ */
+export declare enum DialogReason {
+    /**
+         * The dialog is being started from DialogContext.beginDialog or DialogContext.replaceDialog.
+         */
+    beginCalled = "beginCalled",
+    /**
+         * The dialog is being continued from DialogContext.continueDialog.
+         */
+    continueCalled = "continueCalled",
+    /**
+         * The dialog is being ended from DialogContext.endDialog.
+         */
+    endCalled = "endCalled",
+    /**
+         * The dialog is being ended from DialogContext.replaceDialog.
+         */
+    replaceCalled = "replaceCalled",
+    /**
+         * The dialog is being cancelled from DialogContext.cancelAllDialogs.
+         */
+    cancelCalled = "cancelCalled",
+    /**
+         * A step in a WaterfallDialog is being called
+         * because the previous step in the waterfall dialog called WaterfallStepContext.next.
+         */
+    nextCalled = "nextCalled"
+}

package/dist/src/dialogReason.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogReason = void 0;
+/**
+ * Indicates why a dialog method is being called.
+ *
+ * @remarks
+ * Use a dialog context to control the dialogs in a dialog set. The dialog context will pass a reference to itself
+ * to the dialog method it calls. It also passes in the _reason_ why the specific method is being called.
+ *
+ */
+var DialogReason;
+(function (DialogReason) {
+    /**
+         * The dialog is being started from DialogContext.beginDialog or DialogContext.replaceDialog.
+         */
+    DialogReason["beginCalled"] = "beginCalled";
+    /**
+         * The dialog is being continued from DialogContext.continueDialog.
+         */
+    DialogReason["continueCalled"] = "continueCalled";
+    /**
+         * The dialog is being ended from DialogContext.endDialog.
+         */
+    DialogReason["endCalled"] = "endCalled";
+    /**
+         * The dialog is being ended from DialogContext.replaceDialog.
+         */
+    DialogReason["replaceCalled"] = "replaceCalled";
+    /**
+         * The dialog is being cancelled from DialogContext.cancelAllDialogs.
+         */
+    DialogReason["cancelCalled"] = "cancelCalled";
+    /**
+         * A step in a WaterfallDialog is being called
+         * because the previous step in the waterfall dialog called WaterfallStepContext.next.
+         */
+    DialogReason["nextCalled"] = "nextCalled";
+})(DialogReason || (exports.DialogReason = DialogReason = {}));
+//# sourceMappingURL=dialogReason.js.map

package/dist/src/dialogReason.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogReason.js","sourceRoot":"","sources":["../../src/dialogReason.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,IAAY,YA+BX;AA/BD,WAAY,YAAY;IACtB;;WAEO;IACP,2CAA2B,CAAA;IAE3B;;WAEO;IACP,iDAAiC,CAAA;IAEjC;;WAEO;IACP,uCAAuB,CAAA;IAEvB;;WAEO;IACP,+CAA+B,CAAA;IAE/B;;WAEO;IACP,6CAA6B,CAAA;IAE7B;;;WAGO;IACP,yCAAyB,CAAA;AAC3B,CAAC,EA/BW,YAAY,4BAAZ,YAAY,QA+BvB"}

package/dist/src/dialogSet.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AgentStatePropertyAccessor, TurnContext } from '@microsoft/agents-hosting';
+import { Dialog } from './dialog';
+import { DialogContext, DialogState } from './dialogContext';
+export interface DialogDependencies {
+    /**
+       * Returns a dialogs child dialog dependencies so they can be added to a containers dialog set.
+       */
+    getDependencies(): Dialog[];
+}
+/**
+ * A related set of dialogs that can all call each other.
+ *
+ * @remarks
+ * 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
+ * execution of the sets dialogs:
+ *
+ */
+export declare class DialogSet {
+    private readonly dialogs;
+    private readonly dialogState;
+    private _version;
+    /**
+       * 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
+       * pass in your own state object for persisting the sets dialog stack:
+       *
+       * @param dialogState (Optional) state property used to persist the sets dialog stack.
+       */
+    constructor(dialogState?: AgentStatePropertyAccessor<DialogState>);
+    /**
+       * Returns a 32-bit hash of the all the `Dialog.version` values in the set.
+       *
+       * @returns A version that will change when any of the child dialogs version changes.
+       * @remarks
+       * This hash is persisted to state storage and used to detect changes to a dialog set.
+       */
+    getVersion(): string;
+    /**
+       * 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
+       * 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".
+       * @param dialog The dialog or prompt to add.
+       * If a telemetryClient is present on the dialog set, it will be added to each dialog.
+       * @returns The dialog set after the operation is complete.
+       */
+    add<T extends Dialog>(dialog: T): this;
+    /**
+       * Creates a dialog context which can be used to work with the dialogs in the set.
+       *
+       * @param context Context for the current turn of conversation with the user.
+       * @returns A promise representing the asynchronous operation.
+       */
+    createContext(context: TurnContext): Promise<DialogContext>;
+    /**
+       * 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.
+       */
+    find(dialogId: string): Dialog | undefined;
+    /**
+       * Gets the Dialogs of the set.
+       *
+       * @returns {Dialog} An array of Dialog.
+       */
+    getDialogs(): Dialog[];
+}