@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/memory/componentMemoryScopes.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComponentMemoryScopes = isComponentMemoryScopes;
+const z = __importStar(require("zod"));
+const componentMemoryScopes = z.custom((val) => typeof val.getMemoryScopes === 'function', {
+    message: 'ComponentMemoryScopes',
+});
+/**
+ * Check if a ComponentRegistration is ComponentMemoryScopes or not.
+ *
+ * @param {any} component The component registration.
+ * @returns {boolean} Type check result.
+ */
+function isComponentMemoryScopes(component) {
+    return componentMemoryScopes.safeParse(component).success;
+}
+//# sourceMappingURL=componentMemoryScopes.js.map

package/dist/src/memory/componentMemoryScopes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentMemoryScopes.js","sourceRoot":"","sources":["../../../src/memory/componentMemoryScopes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBH,0DAEC;AAtBD,uCAAwB;AAUxB,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAwB,CAAC,GAAQ,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,eAAe,KAAK,UAAU,EAAE;IACrH,OAAO,EAAE,uBAAuB;CACjC,CAAC,CAAA;AAEF;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAE,SAAkB;IACzD,OAAO,qBAAqB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAA;AAC3D,CAAC"}

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

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { PathResolver } from './pathResolvers';
+/**
+ * Interface for declaring path resolvers.
+ */
+export interface ComponentPathResolvers {
+    getPathResolvers(): PathResolver[];
+}
+/**
+ * Check if a ComponentRegistration) is ComponentPathResolvers or not.
+ *
+ * @param {any} component The component registration.
+ * @returns {boolean} Type check result.
+ */
+export declare function isComponentPathResolvers(component: unknown): component is ComponentPathResolvers;

package/dist/src/memory/componentPathResolvers.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComponentPathResolvers = isComponentPathResolvers;
+const z = __importStar(require("zod"));
+const componentPathResolvers = z.custom((val) => typeof val.getPathResolvers === 'function', { message: 'ComponentPathResolvers' });
+/**
+ * Check if a ComponentRegistration) is ComponentPathResolvers or not.
+ *
+ * @param {any} component The component registration.
+ * @returns {boolean} Type check result.
+ */
+function isComponentPathResolvers(component) {
+    return componentPathResolvers.safeParse(component).success;
+}
+//# sourceMappingURL=componentPathResolvers.js.map

package/dist/src/memory/componentPathResolvers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentPathResolvers.js","sourceRoot":"","sources":["../../../src/memory/componentPathResolvers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBH,4DAEC;AAvBD,uCAAwB;AAUxB,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CACrC,CAAC,GAAQ,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,gBAAgB,KAAK,UAAU,EACxD,EAAE,OAAO,EAAE,wBAAwB,EAAE,CACtC,CAAA;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAE,SAAkB;IAC1D,OAAO,sBAAsB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAA;AAC5D,CAAC"}

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

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Defines path for available dialogs.
+ */
+export declare class DialogPath {
+    static readonly eventCounter = "dialog.eventCounter";
+    static readonly expectedProperties = "dialog.expectedProperties";
+    static readonly defaultOperation = "dialog.defaultOperation";
+    static readonly lastEvent = "dialog.lastEvent";
+    static readonly requiredProperties = "dialog.requiredProperties";
+    static readonly retries = "dialog.retries";
+    static readonly lastIntent = "dialog.lastIntent";
+    static readonly lastTriggerEvent = "dialog.lastTriggerEvent";
+}

package/dist/src/memory/dialogPath.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogPath = void 0;
+/**
+ * Defines path for available dialogs.
+ */
+class DialogPath {
+}
+exports.DialogPath = DialogPath;
+/// Counter of emitted events.
+DialogPath.eventCounter = 'dialog.eventCounter';
+/// Currently expected properties.
+DialogPath.expectedProperties = 'dialog.expectedProperties';
+/// Default operation to use for entities where there is no identified operation entity.
+DialogPath.defaultOperation = 'dialog.defaultOperation';
+/// Last surfaced entity ambiguity event.
+DialogPath.lastEvent = 'dialog.lastEvent';
+/// Currently required properties.
+DialogPath.requiredProperties = 'dialog.requiredProperties';
+/// Number of retries for the current Ask.
+DialogPath.retries = 'dialog.retries';
+/// Last intent.
+DialogPath.lastIntent = 'dialog.lastIntent';
+/// Last trigger event: defined in FormEvent, ask, clarifyEntity etc..
+DialogPath.lastTriggerEvent = 'dialog.lastTriggerEvent';
+//# sourceMappingURL=dialogPath.js.map

package/dist/src/memory/dialogPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogPath.js","sourceRoot":"","sources":["../../../src/memory/dialogPath.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,UAAU;;AAAvB,gCAwBC;AAvBC,8BAA8B;AACd,uBAAY,GAAG,qBAAqB,CAAA;AAEpD,kCAAkC;AAClB,6BAAkB,GAAG,2BAA2B,CAAA;AAEhE,wFAAwF;AACxE,2BAAgB,GAAG,yBAAyB,CAAA;AAE5D,yCAAyC;AACzB,oBAAS,GAAG,kBAAkB,CAAA;AAE9C,kCAAkC;AAClB,6BAAkB,GAAG,2BAA2B,CAAA;AAEhE,0CAA0C;AAC1B,kBAAO,GAAG,gBAAgB,CAAA;AAE1C,gBAAgB;AACA,qBAAU,GAAG,mBAAmB,CAAA;AAEhD,sEAAsE;AACtD,2BAAgB,GAAG,yBAAyB,CAAA"}

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

@@ -0,0 +1,156 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DialogContext } from '../dialogContext';
+import { MemoryScope } from './scopes';
+import { PathResolver } from './pathResolvers';
+export interface DialogStateManagerConfiguration {
+    /**
+       * List of path resolvers used to evaluate memory paths.
+       */
+    readonly pathResolvers: PathResolver[];
+    /**
+       * List of the supported memory scopes.
+       */
+    readonly memoryScopes: MemoryScope[];
+}
+/**
+ * The DialogStateManager manages memory scopes and path resolvers.
+ *
+ * @remarks
+ * MemoryScopes are named root level objects, which can exist either in the dialog context or off
+ * of turn state. Path resolvers allow for shortcut behavior for mapping things like
+ * $foo -> dialog.foo
+ */
+export declare class DialogStateManager {
+    private readonly dialogContext;
+    /**
+       * Initializes a new instance of the DialogStateManager class.
+       *
+       * @param dc The dialog context for the current turn of the conversation.
+       * @param configuration Configuration for the dialog state manager.
+       */
+    constructor(dc: DialogContext, configuration?: DialogStateManagerConfiguration);
+    /**
+       * Gets or sets the configured path resolvers and memory scopes for the dialog state manager.
+       *
+       * @remarks
+       * There is a single set of configuration information for a given chain of dialog contexts.
+       * Assigning a new configuration to any DialogStateManager within the chain will update the
+       * configuration for the entire chain.
+       */
+    configuration: DialogStateManagerConfiguration;
+    /**
+       * Get the value from memory using path expression.
+       *
+       * @remarks
+       * This always returns a CLONE of the memory, any modifications to the result will not affect memory.
+       * @template T The value type to return.
+       * @param pathExpression Path expression to use.
+       * @param defaultValue (Optional) default value to use if the path isn't found. May be a function that returns the default value to use.
+       * @returns The found value or undefined if not found and no `defaultValue` specified.
+       */
+    getValue<T = any>(pathExpression: string, defaultValue?: T | (() => T)): T;
+    /**
+       * Set memory to value.
+       *
+       * @param pathExpression Path to memory.
+       * @param value Value to set.
+       */
+    setValue(pathExpression: string, value: any): void;
+    /**
+       * Delete property from memory
+       *
+       * @param pathExpression The leaf property to remove.
+       */
+    deleteValue(pathExpression: string): void;
+    /**
+       * Ensures that all memory scopes have been loaded for the current turn.
+       *
+       * @remarks
+       * This should be called at the beginning of the turn.
+       */
+    loadAllScopes(): Promise<void>;
+    /**
+       * Saves any changes made to memory scopes.
+       *
+       * @remarks
+       * This should be called at the end of the turn.
+       */
+    saveAllChanges(): Promise<void>;
+    /**
+       * Deletes all of the backing memory for a given scope.
+       *
+       * @param name Name of the scope.
+       */
+    deleteScopesMemory(name: string): Promise<void>;
+    /**
+       * Normalizes the path segments of a passed in path.
+       *
+       * @remarks
+       * A path of `profile.address[0]` will be normalized to `profile.address.0`.
+       * @param pathExpression The path to normalize.
+       * @param allowNestedPaths Optional. If `false` then detection of a nested path will cause an empty path to be returned. Defaults to 'true'.
+       * @returns The normalized path.
+       */
+    parsePath(pathExpression: string, allowNestedPaths?: boolean): (string | number)[];
+    /**
+       * Transform the path using the registered path transformers.
+       *
+       * @param pathExpression The path to transform.
+       * @returns The transformed path.
+       */
+    transformPath(pathExpression: string): string;
+    /**
+       * Gets all memory scopes suitable for logging.
+       *
+       * @returns Object which represents all memory scopes.
+       */
+    getMemorySnapshot(): object;
+    /**
+       * Track when specific paths are changed.
+       *
+       * @param paths Paths to track.
+       * @returns Normalized paths to pass to [anyPathChanged()](#anypathchanged).
+       */
+    trackPaths(paths: string[]): string[];
+    /**
+       * Check to see if any path has changed since watermark.
+       *
+       * @param counter Time counter to compare to.
+       * @param paths Paths from [trackPaths()](#trackpaths) to check.
+       * @returns True if any path has changed since counter.
+       */
+    anyPathChanged(counter: number, paths: string[]): boolean;
+    /**
+       * @private
+       * @param path Track path to change.
+       */
+    private trackChange;
+    /**
+       * @private
+       * @param memory Object memory to resolve.
+       * @param segments Segments of the memory to resolve.
+       * @param assignment Optional.
+       * @returns The value of the memory segment.
+       */
+    private resolveSegments;
+    /**
+       * @private
+       */
+    private findObjectKey;
+    /**
+       * @private
+       * Gets MemoryScope by name.
+       * @param name Name of scope.
+       * @returns The MemoryScope.
+       */
+    private getMemoryScope;
+    /**
+       * Gets the version number.
+       *
+       * @returns A string with the version number.
+       */
+    version(): string;
+}