@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/dialogContext.js

@@ -0,0 +1,444 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogContext = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const memory_1 = require("./memory");
+const dialogContainer_1 = require("./dialogContainer");
+const dialogEvents_1 = require("./dialogEvents");
+const dialogTurnStateConstants_1 = require("./dialogTurnStateConstants");
+const dialogContextError_1 = require("./dialogContextError");
+const dialogReason_1 = require("./dialogReason");
+const dialogTurnStatus_1 = require("./dialogTurnStatus");
+/**
+ * Wraps a promise in a try-catch that automatically enriches errors with extra dialog context.
+ *
+ * @param dialogContext source dialog context from which enriched error properties are sourced
+ * @param promise a promise to await inside a try-catch for error enrichment
+ * @returns A promise representing the asynchronous operation.
+ */
+const wrapErrors = async (dialogContext, promise) => {
+    try {
+        return await promise;
+    }
+    catch (err) {
+        if (err instanceof dialogContextError_1.DialogContextError) {
+            throw err;
+        }
+        else {
+            throw new dialogContextError_1.DialogContextError(err, dialogContext);
+        }
+    }
+};
+/**
+ * @private
+ */
+const ACTIVITY_RECEIVED_EMITTED = Symbol('ActivityReceivedEmitted');
+/**
+ * The context for the current dialog turn with respect to a specific 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
+ * 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.
+ *
+ */
+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 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, contextOrDialogContext, state) {
+        /**
+           * Gets the services collection which is contextual to this dialog context.
+           */
+        this.services = new agents_hosting_1.TurnContextStateCollection();
+        this.dialogs = dialogs;
+        if (contextOrDialogContext instanceof DialogContext) {
+            this.context = contextOrDialogContext.context;
+            this.parent = contextOrDialogContext;
+            if (this.parent.services) {
+                this.parent.services.forEach((value, key) => {
+                    this.services.set(key, value);
+                });
+            }
+        }
+        else {
+            this.context = contextOrDialogContext;
+        }
+        if (!Array.isArray(state.dialogStack)) {
+            state.dialogStack = [];
+        }
+        this.stack = state.dialogStack;
+        this.state = new memory_1.DialogStateManager(this);
+        this.state.setValue(memory_1.TurnPath.activity, this.context.activity);
+    }
+    /**
+       * @returns Dialog context for child if the active dialog is a container.
+       */
+    get child() {
+        const instance = this.activeDialog;
+        if (instance !== undefined) {
+            // Is active dialog a container?
+            const dialog = this.findDialog(instance.id);
+            if (dialog instanceof dialogContainer_1.DialogContainer) {
+                return dialog.createChildContext(this);
+            }
+        }
+        return undefined;
+    }
+    /**
+       * @returns The state information for the dialog on the top of the dialog stack, or `undefined` if
+       * the stack is empty.
+       */
+    get activeDialog() {
+        return this.stack.length > 0 ? this.stack[this.stack.length - 1] : undefined;
+    }
+    /**
+       * @deprecated This property serves no function.
+       * @returns The current dialog manager instance. This property is deprecated.
+       */
+    get dialogManager() {
+        return this.context.turnState.get(dialogTurnStateConstants_1.DialogTurnStateConstants.dialogManager);
+    }
+    /**
+       * Obtain the CultureInfo in DialogContext.
+       *
+       * @returns a locale string.
+       */
+    getLocale() {
+        var _a;
+        const _turnLocaleProperty = 'turn.locale';
+        const turnLocaleValue = this.state.getValue(_turnLocaleProperty);
+        if (turnLocaleValue) {
+            return turnLocaleValue;
+        }
+        const locale = (_a = this.context.activity) === null || _a === void 0 ? void 0 : _a.locale;
+        if (locale !== undefined) {
+            return locale;
+        }
+        return Intl.DateTimeFormat().resolvedOptions().locale;
+    }
+    /**
+       * Starts a dialog instance and pushes it onto the dialog stack.
+       * Creates a new instance of the dialog and pushes it onto the stack.
+       *
+       * @param dialogId ID of the dialog to start.
+       * @param options Optional. Arguments to pass into the dialog when it starts.
+       * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
+       * @remarks
+       * 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 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
+       * or any of its ancestors.
+       *
+       */
+    async beginDialog(dialogId, options) {
+        // Lookup dialog
+        const dialog = this.findDialog(dialogId);
+        if (!dialog) {
+            throw new dialogContextError_1.DialogContextError(`DialogContext.beginDialog(): A dialog with an id of '${dialogId}' wasn't found.`, this);
+        }
+        // Push new instance onto stack.
+        const instance = {
+            id: dialogId,
+            state: {},
+        };
+        this.stack.push(instance);
+        // Call dialogs begin() method.
+        return wrapErrors(this, dialog.beginDialog(this, options));
+    }
+    /**
+       * Cancels all dialogs on the dialog stack, and clears stack.
+       *
+       * @param cancelParents Optional. If `true` all parent dialogs will be cancelled as well.
+       * @param eventName Optional. Name of a custom event to raise as dialogs are cancelled. This defaults to DialogEvents.cancelDialog.
+       * @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
+       * 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.
+       *
+       */
+    async cancelAllDialogs(cancelParents = false, eventName, eventValue) {
+        eventName = eventName || dialogEvents_1.DialogEvents.cancelDialog;
+        if (this.stack.length > 0 || this.parent !== undefined) {
+            // Cancel all local and parent dialogs while checking for interception
+            let notify = false;
+            let dialogContext = this;
+            while (dialogContext !== undefined) {
+                if (dialogContext.stack.length > 0) {
+                    // Check to see if the dialog wants to handle the event
+                    // - We skip notifying the first dialog which actually called cancelAllDialogs()
+                    if (notify) {
+                        const handled = await dialogContext.emitEvent(eventName, eventValue, false, false);
+                        if (handled) {
+                            break;
+                        }
+                    }
+                    // End the active dialog
+                    await dialogContext.endActiveDialog(dialogReason_1.DialogReason.cancelCalled);
+                }
+                else {
+                    dialogContext = cancelParents ? dialogContext.parent : undefined;
+                }
+                notify = true;
+            }
+            return { status: dialogTurnStatus_1.DialogTurnStatus.cancelled };
+        }
+        else {
+            return { status: dialogTurnStatus_1.DialogTurnStatus.empty };
+        }
+    }
+    /**
+       * Searches for a dialog with a given ID.
+       *
+       * @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
+       * with this dialog context, it attempts to find the dialog in its parent dialog context.
+       *
+       */
+    findDialog(dialogId) {
+        let dialog = this.dialogs.find(dialogId);
+        if (!dialog && this.parent) {
+            dialog = this.parent.findDialog(dialogId);
+        }
+        return dialog;
+    }
+    /**
+       * Helper function to simplify formatting the options for calling a prompt dialog.
+       *
+       * @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.
+       * @param choices Optional. Array of choices for the user to choose from,
+       * for use with a 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.
+       *
+       */
+    async prompt(dialogId, promptOrOptions, choices) {
+        let options;
+        if ((typeof promptOrOptions === 'object' && promptOrOptions.type !== undefined) ||
+            typeof promptOrOptions === 'string') {
+            options = { prompt: promptOrOptions };
+        }
+        else {
+            options = { ...promptOrOptions };
+        }
+        if (choices) {
+            options.choices = choices;
+        }
+        return wrapErrors(this, this.beginDialog(dialogId, options));
+    }
+    /**
+       * Continues execution of the active dialog, if there is one, by passing this dialog context to its
+       * Dialog.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
+       * property to determine if the dialog sent a reply to the user.
+       *
+       * The 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.
+       *
+       */
+    async continueDialog() {
+        // if we are continuing and haven't emitted the activityReceived event, emit it
+        // NOTE: This is backward compatible way for activity received to be fired even if you have legacy dialog loop
+        if (!this.context.turnState.has(ACTIVITY_RECEIVED_EMITTED)) {
+            this.context.turnState.set(ACTIVITY_RECEIVED_EMITTED, true);
+            // Dispatch "activityReceived" event
+            // - This fired from teh leaf and will queue up any interruptions.
+            await this.emitEvent(dialogEvents_1.DialogEvents.activityReceived, this.context.activity, true, true);
+        }
+        // Check for a dialog on the stack
+        const instance = this.activeDialog;
+        if (instance) {
+            // Lookup dialog
+            const dialog = this.findDialog(instance.id);
+            if (!dialog) {
+                throw new dialogContextError_1.DialogContextError(`DialogContext.continueDialog(): Can't continue dialog. A dialog with an id of '${instance.id}' wasn't found.`, this);
+            }
+            // Continue execution of dialog
+            return wrapErrors(this, dialog.continueDialog(this));
+        }
+        else {
+            return { status: dialogTurnStatus_1.DialogTurnStatus.empty };
+        }
+    }
+    /**
+       * Ends a dialog and pops it off the stack. Returns an optional result to the dialog's parent.
+       *
+       * @param result Optional. A result to pass to the parent logic. This might be the next dialog
+       *      on the stack, or if this was the last dialog on the stack, a parent dialog context or
+       *      the agent's turn handler.
+       * @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,
+       * 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.
+       *
+       * The 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
+       * the dialog context that the dialog has completed, the dialog should be removed from the stack,
+       * and the parent dialog should resume.
+       *
+       */
+    async endDialog(result) {
+        // End the active dialog
+        await this.endActiveDialog(dialogReason_1.DialogReason.endCalled, result);
+        // Resume parent dialog
+        const instance = this.activeDialog;
+        if (instance) {
+            // Lookup dialog
+            const dialog = this.findDialog(instance.id);
+            if (!dialog) {
+                throw new dialogContextError_1.DialogContextError(`DialogContext.endDialog(): Can't resume previous dialog. A dialog with an id of '${instance.id}' wasn't found.`, this);
+            }
+            // Return result to previous dialog
+            return wrapErrors(this, dialog.resumeDialog(this, dialogReason_1.DialogReason.endCalled, result));
+        }
+        else {
+            // Signal completion
+            return { status: dialogTurnStatus_1.DialogTurnStatus.complete, result };
+        }
+    }
+    /**
+       * Ends the active dialog and starts a new dialog in its place.
+       *
+       * @param dialogId ID of the dialog to start.
+       * @param options Optional. Arguments to pass into the new dialog when it starts.
+       * @returns {Promise<DialogTurnResult>} a promise resolving to the dialog turn result.
+       * @remarks
+       * This is particularly useful for creating a loop or redirecting to another dialog.
+       *
+       * The 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.
+       * However, the parent dialog is neither resumed nor otherwise notified.
+       *
+       */
+    async replaceDialog(dialogId, options) {
+        // End the active dialog
+        await this.endActiveDialog(dialogReason_1.DialogReason.replaceCalled);
+        // Start replacement dialog
+        return this.beginDialog(dialogId, options);
+    }
+    /**
+       * Requests the active dialog to re-prompt the user for input.
+       *
+       * @remarks
+       * This calls the active dialog's Dialog.repromptDialog method.
+       *
+       */
+    async repromptDialog() {
+        // Try raising event first
+        const handled = await this.emitEvent(dialogEvents_1.DialogEvents.repromptDialog, undefined, false, false);
+        if (!handled) {
+            // Check for a dialog on the stack
+            const instance = this.activeDialog;
+            if (instance) {
+                // Lookup dialog
+                const dialog = this.findDialog(instance.id);
+                if (!dialog) {
+                    throw new dialogContextError_1.DialogContextError(`DialogContext.repromptDialog(): Can't find a dialog with an id of '${instance.id}'.`, this);
+                }
+                // Ask dialog to re-prompt if supported
+                await wrapErrors(this, dialog.repromptDialog(this.context, instance));
+            }
+        }
+    }
+    /**
+       * Searches for a dialog with a given ID.
+       *
+       * @remarks
+       * Emits a named event for the current dialog, or someone who started it, to handle.
+       * @param name Name of the event to raise.
+       * @param value Optional. Value to send along with the event.
+       * @param bubble Optional. Flag to control whether the event should be bubbled to its parent if not handled locally. Defaults to a value of `true`.
+       * @param fromLeaf Optional. Whether the event is emitted from a leaf node.
+       * @returns `true` if the event was handled.
+       */
+    async emitEvent(name, value, bubble = true, fromLeaf = false) {
+        // Initialize event
+        const dialogEvent = {
+            bubble,
+            name,
+            value,
+        };
+        // Find starting dialog
+        let dialogContext = this;
+        if (fromLeaf) {
+            while (true) {
+                const childDialogContext = dialogContext.child;
+                if (childDialogContext !== undefined) {
+                    dialogContext = childDialogContext;
+                }
+                else {
+                    break;
+                }
+            }
+        }
+        // Dispatch to active dialog first
+        // - The active dialog will decide if it should bubble the event to its parent.
+        const instance = dialogContext.activeDialog;
+        if (instance !== undefined) {
+            const dialog = dialogContext.findDialog(instance.id);
+            if (dialog !== undefined) {
+                return wrapErrors(this, dialog.onDialogEvent(dialogContext, dialogEvent));
+            }
+        }
+        return false;
+    }
+    /**
+       * @private
+       * @param reason
+       * @param result
+       */
+    async endActiveDialog(reason, result) {
+        const instance = this.activeDialog;
+        if (instance) {
+            // Lookup dialog
+            const dialog = this.findDialog(instance.id);
+            if (dialog) {
+                // Notify dialog of end
+                await wrapErrors(this, dialog.endDialog(this.context, instance, reason));
+            }
+            // Pop dialog off stack
+            this.stack.pop();
+            this.state.setValue(memory_1.TurnPath.lastResult, result);
+        }
+    }
+}
+exports.DialogContext = DialogContext;
+//# sourceMappingURL=dialogContext.js.map

package/dist/src/dialogContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogContext.js","sourceRoot":"","sources":["../../src/dialogContext.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,8DAA6F;AAI7F,qCAAuD;AACvD,uDAAmD;AACnD,iDAA6C;AAE7C,yEAAqE;AACrE,6DAAyD;AAEzD,iDAA6C;AAG7C,yDAAqD;AAGrD;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,KAAK,EAAK,aAA4B,EAAE,OAAmB,EAAc,EAAE;IAC5F,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAA;IACtB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,YAAY,uCAAkB,EAAE,CAAC;YACtC,MAAM,GAAG,CAAA;QACX,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uCAAkB,CAAC,GAAY,EAAE,aAAa,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAA;AAmBnE;;;;;;;;;;;GAWG;AACH,MAAa,aAAa;IAuBxB;;;;;;;SAOK;IACL,YAAa,OAAkB,EAAE,sBAAmD,EAAE,KAAkB;QA2ExG;;aAEK;QACL,aAAQ,GAA+B,IAAI,2CAA0B,EAAE,CAAA;QA7ErE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,sBAAsB,YAAY,aAAa,EAAE,CAAC;YACpD,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,OAAO,CAAA;YAC7C,IAAI,CAAC,MAAM,GAAG,sBAAsB,CAAA;YACpC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAQ,EAAE;oBAChD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBAC/B,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAA;QACvC,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,WAAW,GAAG,EAAE,CAAA;QACxB,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,WAAW,CAAA;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAkB,CAAC,IAAI,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC/D,CAAC;IA2BD;;SAEK;IACL,IAAI,KAAK;QACP,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAA;QAClC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,gCAAgC;YAChC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YAC3C,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;gBACtC,OAAO,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;SAGK;IACL,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC9E,CAAC;IAYD;;;SAGK;IACL,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,mDAAwB,CAAC,aAAa,CAAC,CAAA;IAC3E,CAAC;IAED;;;;SAIK;IACL,SAAS;;QACP,MAAM,mBAAmB,GAAG,aAAa,CAAA;QAEzC,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAA;QAChE,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,eAAe,CAAA;QACxB,CAAC;QAED,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,QAAQ,0CAAE,MAAM,CAAA;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,MAAM,CAAA;QACf,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,EAAE,CAAC,MAAM,CAAA;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;SAiBK;IACL,KAAK,CAAC,WAAW,CAAE,QAAgB,EAAE,OAAgB;QACnD,gBAAgB;QAChB,MAAM,MAAM,GAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,uCAAkB,CAClB,wDAAwD,QAAQ,iBAAiB,EACjF,IAAI,CACb,CAAA;QACH,CAAC;QAED,gCAAgC;QAChC,MAAM,QAAQ,GAAwB;YACpC,EAAE,EAAE,QAAQ;YACZ,KAAK,EAAE,EAAE;SACV,CAAA;QACD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEzB,+BAA+B;QAC/B,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,KAAK,CAAC,gBAAgB,CAAE,aAAa,GAAG,KAAK,EAAE,SAAkB,EAAE,UAAgB;QACjF,SAAS,GAAG,SAAS,IAAI,2BAAY,CAAC,YAAY,CAAA;QAClD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACvD,sEAAsE;YACtE,IAAI,MAAM,GAAG,KAAK,CAAA;YAElB,IAAI,aAAa,GAAkB,IAAI,CAAA;YACvC,OAAO,aAAa,KAAK,SAAS,EAAE,CAAC;gBACnC,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACnC,uDAAuD;oBACvD,gFAAgF;oBAChF,IAAI,MAAM,EAAE,CAAC;wBACX,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;wBAClF,IAAI,OAAO,EAAE,CAAC;4BACZ,MAAK;wBACP,CAAC;oBACH,CAAC;oBAED,wBAAwB;oBACxB,MAAM,aAAa,CAAC,eAAe,CAAC,2BAAY,CAAC,YAAY,CAAC,CAAA;gBAChE,CAAC;qBAAM,CAAC;oBACN,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;gBAClE,CAAC;gBAED,MAAM,GAAG,IAAI,CAAA;YACf,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,mCAAgB,CAAC,SAAS,EAAE,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,MAAM,EAAE,mCAAgB,CAAC,KAAK,EAAE,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;;;SASK;IACL,UAAU,CAAE,QAAgB;QAC1B,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAC3C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IA0CD;;;;;;;;;;;;SAYK;IACL,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,eAAkC,EAClC,OAA6B;QAE7B,IAAI,OAAsB,CAAA;QAC1B,IACE,CAAC,OAAO,eAAe,KAAK,QAAQ,IAAK,eAA4B,CAAC,IAAI,KAAK,SAAS,CAAC;YACnF,OAAO,eAAe,KAAK,QAAQ,EACzC,CAAC;YACD,OAAO,GAAG,EAAE,MAAM,EAAE,eAAoC,EAAE,CAAA;QAC5D,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,EAAE,GAAI,eAAiC,EAAE,CAAA;QACrD,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,OAAO,GAAG,OAAO,CAAA;QAC3B,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;;;;;;;;;SAcK;IACL,KAAK,CAAC,cAAc;QAClB,+EAA+E;QAC/E,8GAA8G;QAC9G,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAA;YAE3D,oCAAoC;YACpC,kEAAkE;YAClE,MAAM,IAAI,CAAC,SAAS,CAAC,2BAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QACxF,CAAC;QAED,kCAAkC;QAClC,MAAM,QAAQ,GAAwB,IAAI,CAAC,YAAY,CAAA;QACvD,IAAI,QAAQ,EAAE,CAAC;YACb,gBAAgB;YAChB,MAAM,MAAM,GAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACvD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,uCAAkB,CAChB,kFAAkF,QAAQ,CAAC,EAAE,iBAAiB,EAC9G,IAAI,CACf,CAAA;YACH,CAAC;YAED,+BAA+B;YAC/B,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAA;QACtD,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,MAAM,EAAE,mCAAgB,CAAC,KAAK,EAAE,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;SAqBK;IACL,KAAK,CAAC,SAAS,CAAE,MAAY;QAC3B,wBAAwB;QACxB,MAAM,IAAI,CAAC,eAAe,CAAC,2BAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAE1D,uBAAuB;QACvB,MAAM,QAAQ,GAAwB,IAAI,CAAC,YAAY,CAAA;QACvD,IAAI,QAAQ,EAAE,CAAC;YACb,gBAAgB;YAChB,MAAM,MAAM,GAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACvD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,uCAAkB,CAChB,oFAAoF,QAAQ,CAAC,EAAE,iBAAiB,EAChH,IAAI,CACf,CAAA;YACH,CAAC;YAED,mCAAmC;YACnC,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,2BAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;QACpF,CAAC;aAAM,CAAC;YACN,oBAAoB;YACpB,OAAO,EAAE,MAAM,EAAE,mCAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;QACtD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,KAAK,CAAC,aAAa,CAAE,QAAgB,EAAE,OAAgB;QACrD,wBAAwB;QACxB,MAAM,IAAI,CAAC,eAAe,CAAC,2BAAY,CAAC,aAAa,CAAC,CAAA;QAEtD,2BAA2B;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;;SAMK;IACL,KAAK,CAAC,cAAc;QAClB,0BAA0B;QAC1B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,2BAAY,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;QAC1F,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,kCAAkC;YAClC,MAAM,QAAQ,GAAwB,IAAI,CAAC,YAAY,CAAA;YACvD,IAAI,QAAQ,EAAE,CAAC;gBACb,gBAAgB;gBAChB,MAAM,MAAM,GAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;gBACvD,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,uCAAkB,CACd,sEAAsE,QAAQ,CAAC,EAAE,IAAI,EACrF,IAAI,CACjB,CAAA;gBACH,CAAC;gBAED,uCAAuC;gBACvC,MAAM,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;SAUK;IACL,KAAK,CAAC,SAAS,CAAE,IAAY,EAAE,KAAW,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,GAAG,KAAK;QACzE,mBAAmB;QACnB,MAAM,WAAW,GAAgB;YAC/B,MAAM;YACN,IAAI;YACJ,KAAK;SACN,CAAA;QAED,uBAAuB;QAEvB,IAAI,aAAa,GAAkB,IAAI,CAAA;QACvC,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,kBAAkB,GAAG,aAAa,CAAC,KAAK,CAAA;gBAC9C,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;oBACrC,aAAa,GAAG,kBAAkB,CAAA;gBACpC,CAAC;qBAAM,CAAC;oBACN,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC;QAED,kCAAkC;QAClC,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAA;QAC3C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACpD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,CAAA;YAC3E,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;SAIK;IACG,KAAK,CAAC,eAAe,CAAE,MAAoB,EAAE,MAAY;QAC/D,MAAM,QAAQ,GAAwB,IAAI,CAAC,YAAY,CAAA;QACvD,IAAI,QAAQ,EAAE,CAAC;YACb,gBAAgB;YAChB,MAAM,MAAM,GAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACvD,IAAI,MAAM,EAAE,CAAC;gBACX,uBAAuB;gBACvB,MAAM,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAA;YAC1E,CAAC;YAED,uBAAuB;YACvB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;YAEhB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QAClD,CAAC;IACH,CAAC;CACF;AAphBD,sCAohBC"}

package/dist/src/dialogContextError.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DialogContext } from './dialogContext';
+import { DialogInstance } from './dialogInstance';
+/**
+ * An Error that includes extra dialog context, including the dialog stack.
+ */
+export declare class DialogContextError extends Error {
+    readonly error: Error | string;
+    /**
+       * Represents the state of a dialog when an error occurred.
+       */
+    readonly dialogContext: {
+        activeDialog?: string;
+        parent?: string;
+        stack: DialogInstance[];
+    };
+    /**
+       * Construct a DialogError.
+       *
+       * @param {Error | string} error Source error or error message.
+       * @param {DialogContext} dialogContext Dialog context that is the source of the error.
+       */
+    constructor(error: Error | string, dialogContext: DialogContext);
+}

package/dist/src/dialogContextError.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogContextError = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const dialogContext_1 = require("./dialogContext");
+/**
+ * An Error that includes extra dialog context, including the dialog stack.
+ */
+class DialogContextError extends Error {
+    /**
+       * Construct a DialogError.
+       *
+       * @param {Error | string} error Source error or error message.
+       * @param {DialogContext} dialogContext Dialog context that is the source of the error.
+       */
+    constructor(error, dialogContext) {
+        var _a, _b, _c;
+        super();
+        this.error = error;
+        if (!(error instanceof Error) && typeof error !== 'string') {
+            throw new Error('`error` argument must be an Error or a string');
+        }
+        if (!(dialogContext instanceof dialogContext_1.DialogContext)) {
+            throw new Error('`dialogContext` argument must be of type DialogContext');
+        }
+        this.name = 'DialogContextError';
+        this.message = error instanceof Error ? error.message : error;
+        this.dialogContext = {
+            activeDialog: (_a = dialogContext.activeDialog) === null || _a === void 0 ? void 0 : _a.id,
+            parent: (_c = (_b = dialogContext.parent) === null || _b === void 0 ? void 0 : _b.activeDialog) === null || _c === void 0 ? void 0 : _c.id,
+            stack: dialogContext.stack,
+        };
+    }
+}
+exports.DialogContextError = DialogContextError;
+//# sourceMappingURL=dialogContextError.js.map

package/dist/src/dialogContextError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogContextError.js","sourceRoot":"","sources":["../../src/dialogContextError.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,mDAA+C;AAG/C;;GAEG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAU3C;;;;;SAKK;IACL,YACW,KAAqB,EAC9B,aAA4B;;QAE5B,KAAK,EAAE,CAAA;QAHE,UAAK,GAAL,KAAK,CAAgB;QAK9B,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,CAAC,CAAC,aAAa,YAAY,6BAAa,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAA;QAE7D,IAAI,CAAC,aAAa,GAAG;YACnB,YAAY,EAAE,MAAA,aAAa,CAAC,YAAY,0CAAE,EAAE;YAC5C,MAAM,EAAE,MAAA,MAAA,aAAa,CAAC,MAAM,0CAAE,YAAY,0CAAE,EAAE;YAC9C,KAAK,EAAE,aAAa,CAAC,KAAK;SAC3B,CAAA;IACH,CAAC;CACF;AAvCD,gDAuCC"}

package/dist/src/dialogEvent.d.ts

@@ -0,0 +1,20 @@
+export interface DialogEvent {
+    /**
+         * Flag indicating whether the event will be bubbled to the parent `DialogContext`.
+         */
+    bubble: boolean;
+    /**
+         * Name of the event being raised.
+         */
+    name: string;
+    /**
+         * Optional. Value associated with the event.
+         */
+    value?: any;
+}
+export interface DialogConfiguration {
+    /**
+         * Static id of the dialog.
+         */
+    id?: string;
+}

package/dist/src/dialogEvent.js

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

package/dist/src/dialogEvent.js.map

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

package/dist/src/dialogEvents.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Represents the events related to the "lifecycle" of the dialog.
+ */
+export declare class DialogEvents {
+    static readonly beginDialog = "beginDialog";
+    static readonly repromptDialog = "repromptDialog";
+    static readonly cancelDialog = "cancelDialog";
+    static readonly activityReceived = "activityReceived";
+    static readonly versionChanged = "versionChanged";
+    static readonly error = "error";
+}

package/dist/src/dialogEvents.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogEvents = void 0;
+/**
+ * Represents the events related to the "lifecycle" of the dialog.
+ */
+class DialogEvents {
+}
+exports.DialogEvents = DialogEvents;
+DialogEvents.beginDialog = 'beginDialog';
+DialogEvents.repromptDialog = 'repromptDialog';
+DialogEvents.cancelDialog = 'cancelDialog';
+DialogEvents.activityReceived = 'activityReceived';
+DialogEvents.versionChanged = 'versionChanged';
+DialogEvents.error = 'error';
+//# sourceMappingURL=dialogEvents.js.map

package/dist/src/dialogEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogEvents.js","sourceRoot":"","sources":["../../src/dialogEvents.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,YAAY;;AAAzB,oCAOC;AANiB,wBAAW,GAAG,aAAa,CAAA;AAC3B,2BAAc,GAAG,gBAAgB,CAAA;AACjC,yBAAY,GAAG,cAAc,CAAA;AAC7B,6BAAgB,GAAG,kBAAkB,CAAA;AACrC,2BAAc,GAAG,gBAAgB,CAAA;AACjC,kBAAK,GAAG,OAAO,CAAA"}

package/dist/src/dialogHelper.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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';
+import { DialogStateManagerConfiguration } from './memory';
+import { DialogTurnResult } from './dialogTurnResult';
+/**
+ * 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.
+ */
+export declare function runDialog(dialog: Dialog, context: TurnContext, accessor: AgentStatePropertyAccessor<DialogState>): Promise<void>;
+/**
+ * @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.
+ */
+export declare function internalRun(context: TurnContext, dialogId: string, dialogContext: DialogContext, dialogStateManagerConfiguration?: DialogStateManagerConfiguration): Promise<DialogTurnResult>;
+/**
+ * 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.
+ */
+export declare function getActiveDialogContext(dialogContext: DialogContext): DialogContext;