@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/serviceCollection.js

@@ -0,0 +1,209 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// 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.ServiceCollection = void 0;
+const assert_1 = __importStar(require("assert"));
+const dependency_graph_1 = require("dependency-graph");
+/**
+ * ServiceCollection is an interface that describes a set of methods to register services. This, in a lighter way,
+ * mimics the .NET dependency injection service collection functionality, except for instances rather than types.
+ */
+class ServiceCollection {
+    /**
+       * Construct a Providers instance
+       *
+       * @template S services interface
+       * @param defaultServices default set of services
+       */
+    constructor(defaultServices = {}) {
+        // We store the full set of dependencies as a workaround to the fact that `DepGraph` throws an error if you
+        // attempt to register a dependency to a node that does not yet exist.
+        this.dependencies = new Map();
+        /**
+           * `DepGraph` is a dependency graph data structure. In our case, the services we support are encoded as a
+           * dependency graph where nodes are named with a key and store a list of factory methods.
+           */
+        this.graph = new dependency_graph_1.DepGraph();
+        /**
+           * Cache constructed instances for reuse
+           */
+        this.cache = {};
+        Object.entries(defaultServices).forEach(([key, instance]) => {
+            this.addInstance(key, instance);
+        });
+    }
+    /**
+       * Register an instance by key. This will overwrite existing instances.
+       *
+       * @param key key of the instance being provided
+       * @param instance instance to provide
+       * @returns this for chaining
+       */
+    addInstance(key, instance) {
+        if (this.graph.hasNode(key)) {
+            this.graph.removeNode(key);
+        }
+        this.graph.addNode(key, [() => instance]);
+        return this;
+    }
+    /**
+       * @internal
+       */
+    addFactory(key, depsOrFactory, maybeFactory) {
+        const dependencies = Array.isArray(depsOrFactory) ? depsOrFactory : undefined;
+        let factory = maybeFactory;
+        if (!factory && typeof depsOrFactory === 'function') {
+            factory = (_services, value) => depsOrFactory(value);
+        }
+        // Asserts factory is not undefined
+        (0, assert_1.ok)(factory, 'illegal invocation with undefined factory');
+        if (dependencies) {
+            this.dependencies.set(key, dependencies);
+        }
+        // If the graph already has this key, fetch its data and remove it (to be replaced)
+        let factories = [];
+        if (this.graph.hasNode(key)) {
+            factories = this.graph.getNodeData(key);
+            this.graph.removeNode(key);
+        }
+        this.graph.addNode(key, factories.concat(factory));
+        return this;
+    }
+    /**
+       * @internal
+       */
+    composeFactory(key, depsOrFactory, maybeFactory) {
+        if (maybeFactory) {
+            return this.addFactory(key, Array.isArray(depsOrFactory) ? depsOrFactory : [], (dependencies, value) => {
+                (0, assert_1.ok)(value, `unable to create ${key}, initial value undefined`);
+                return maybeFactory(dependencies, value);
+            });
+        }
+        else {
+            (0, assert_1.ok)(typeof depsOrFactory === 'function', 'illegal invocation with undefined factory');
+            return this.addFactory(key, (value) => {
+                (0, assert_1.ok)(value, `unable to create ${key}, initial value undefined`);
+                return depsOrFactory(value);
+            });
+        }
+    }
+    // Register dependencies and then build nodes. Note: `nodes` is a function because ordering may
+    // depend on results of dependency registration
+    buildNodes(generateNodes, reuseServices = {}) {
+        // Consume all dependencies and then reset so updating registrations without re-registering
+        // dependencies works
+        this.dependencies.forEach((dependencies, node) => dependencies.forEach((dependency) => this.graph.addDependency(node, dependency)));
+        // Generate nodes after registering dependencies so ordering is correct
+        const nodes = generateNodes();
+        const services = nodes.reduce((services, service) => {
+            // Extra precaution
+            if (!this.graph.hasNode(service)) {
+                return services;
+            }
+            // Helper to generate return value
+            const assignValue = (value) => ({
+                ...services,
+                [service]: value,
+            });
+            // Optionally reuse existing service
+            const reusedService = reuseServices[service];
+            if (reusedService !== undefined) {
+                return assignValue(reusedService);
+            }
+            // Each node stores a list of factory methods.
+            const factories = this.graph.getNodeData(service);
+            // Produce the instance by reducing those factories, passing the instance along for composition.
+            const instance = factories.reduce((value, factory) => factory(services, value), services[service]);
+            return assignValue(instance);
+        }, {});
+        // Cache results for subsequent invocations that may desire pre-constructed instances
+        Object.assign(this.cache, services);
+        return services;
+    }
+    /**
+       * Build a single service.
+       *
+       * @param key service to build
+       * @param deep reconstruct all dependencies
+       * @returns the service instance, or undefined
+       */
+    makeInstance(key, deep = false) {
+        // If this is not a deep reconstruction, reuse any services that `key` depends on
+        let initialServices;
+        if (!deep) {
+            const { [key]: _, ...cached } = this.cache;
+            initialServices = cached;
+        }
+        const services = this.buildNodes(() => this.graph.dependenciesOf(key).concat(key), initialServices);
+        return services[key];
+    }
+    /**
+       * Build a single service and assert that it is not undefined.
+       *
+       * @param key service to build
+       * @param deep reconstruct all dependencies
+       * @returns the service instance
+       */
+    mustMakeInstance(key, deep = false) {
+        const instance = this.makeInstance(key, deep);
+        assert_1.default.ok(instance, `\`${key}\` instance undefined!`);
+        return instance;
+    }
+    /**
+       * Build the full set of services.
+       *
+       * @returns all resolved services
+       */
+    makeInstances() {
+        return this.buildNodes(() => this.graph.overallOrder());
+    }
+    /**
+       * Build the full set of services, asserting that the specified keys are not undefined.
+       *
+       * @param keys instances that must be not undefined
+       * @returns all resolve services
+       */
+    mustMakeInstances(...keys) {
+        const instances = this.makeInstances();
+        keys.forEach((key) => {
+            assert_1.default.ok(instances[key], `\`${key}\` instance undefined!`);
+        });
+        return instances;
+    }
+}
+exports.ServiceCollection = ServiceCollection;
+//# sourceMappingURL=serviceCollection.js.map

package/dist/src/serviceCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceCollection.js","sourceRoot":"","sources":["../../src/serviceCollection.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAElC,iDAAmC;AACnC,uDAA2C;AAyB3C;;;GAGG;AACH,MAAa,iBAAiB;IAgB5B;;;;;SAKK;IACL,YAAa,kBAA2C,EAAE;QArB1D,2GAA2G;QAC3G,sEAAsE;QACrD,iBAAY,GAA0B,IAAI,GAAG,EAAoB,CAAA;QAElF;;;aAGK;QACY,UAAK,GAAG,IAAI,2BAAQ,EAAoE,CAAA;QAEzG;;aAEK;QACG,UAAK,GAA4B,EAAE,CAAA;QASzC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC1D,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;SAMK;IACL,WAAW,CAAe,GAAW,EAAE,QAAsB;QAC3D,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IAyBD;;SAEK;IACL,UAAU,CACR,GAAW,EACX,aAAsD,EACtD,YAAmE;QAEnE,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAA;QAE7E,IAAI,OAAO,GAAqE,YAAY,CAAA;QAC5F,IAAI,CAAC,OAAO,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACpD,OAAO,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QACtD,CAAC;QAED,mCAAmC;QACnC,IAAA,WAAE,EAAC,OAAO,EAAE,2CAA2C,CAAC,CAAA;QAExD,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;QAC1C,CAAC;QAED,mFAAmF;QACnF,IAAI,SAAS,GAAc,EAAE,CAAA;QAC7B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YACvC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO,CAAQ,CAAC,CAAA;QAEzD,OAAO,IAAI,CAAA;IACb,CAAC;IA0BD;;SAEK;IACL,cAAc,CACZ,GAAW,EACX,aAAqD,EACrD,YAAkE;QAElE,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,UAAU,CACpB,GAAG,EACH,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EACjD,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;gBACtB,IAAA,WAAE,EAAC,KAAK,EAAE,oBAAoB,GAAG,2BAA2B,CAAC,CAAA;gBAE7D,OAAO,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;YAC1C,CAAC,CACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,IAAA,WAAE,EAAC,OAAO,aAAa,KAAK,UAAU,EAAE,2CAA2C,CAAC,CAAA;YAEpF,OAAO,IAAI,CAAC,UAAU,CAAe,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClD,IAAA,WAAE,EAAC,KAAK,EAAE,oBAAoB,GAAG,2BAA2B,CAAC,CAAA;gBAE7D,OAAO,aAAa,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,+CAA+C;IACvC,UAAU,CAChB,aAA6B,EAC7B,gBAAyC,EAAE;QAE3C,2FAA2F;QAC3F,qBAAqB;QACrB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE,CAC/C,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CACjF,CAAA;QAED,uEAAuE;QACvE,MAAM,KAAK,GAAG,aAAa,EAAE,CAAA;QAE7B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAC3B,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;YACpB,mBAAmB;YACnB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjC,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,kCAAkC;YAClC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC;gBACvC,GAAG,QAAQ;gBACX,CAAC,OAAO,CAAC,EAAE,KAAK;aACjB,CAAC,CAAA;YAEF,oCAAoC;YACpC,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,WAAW,CAAC,aAAa,CAAC,CAAA;YACnC,CAAC;YAED,8CAA8C;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;YAEjD,gGAAgG;YAChG,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAC/B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,EACzB,QAAQ,CAAC,OAAO,CAAC,CACrC,CAAA;YAED,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAA;QAC9B,CAAC,EAC8B,EAAE,CAClC,CAAA;QAED,qFAAqF;QACrF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAEnC,OAAO,QAAsB,CAAA;IAC/B,CAAC;IAED;;;;;;SAMK;IACL,YAAY,CAAyB,GAAW,EAAE,IAAI,GAAG,KAAK;QAC5D,iFAAiF;QACjF,IAAI,eAAoD,CAAA;QACxD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;YAC1C,eAAe,GAAG,MAAM,CAAA;QAC1B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAC9B,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAChD,eAAe,CAChB,CAAA;QAED,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;IACtB,CAAC;IAED;;;;;;SAMK;IACL,gBAAgB,CAAyB,GAAW,EAAE,IAAI,GAAG,KAAK;QAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAe,GAAG,EAAE,IAAI,CAAC,CAAA;QAC3D,gBAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,GAAG,wBAAwB,CAAC,CAAA;QAErD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;SAIK;IACL,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAgB,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAA;IACxE,CAAC;IAED;;;;;SAKK;IACL,iBAAiB,CACf,GAAG,IAAc;QAEjB,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAiB,CAAA;QAErD,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,gBAAM,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,wBAAwB,CAAC,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AA/QD,8CA+QC"}

package/dist/src/stringUtils.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Helper class containing string utility methods.
+ */
+export declare class StringUtils {
+    /**
+       * Truncate string with ...
+       *
+       * @param text Text.
+       * @param length Length to truncate text.
+       * @returns Original string modified.
+       */
+    static ellipsis(text: string, length: number): string;
+    /**
+       * UniqueHash - create a unique hash from a string.
+       *
+       * @remarks
+       * The source for this function was derived from the following article:
+       *
+       * https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+       * @param text Text to hash.
+       * @returns A string which is an unique hash.
+       */
+    static hash(text: string): string;
+    /**
+       * EllipsisHash - create truncated string with unique hash for the truncated part.
+       *
+       * @param text Text to truncate.
+       * @param length Length to truncate at.
+       * @returns The truncated string with unique hash for the truncated part.
+       */
+    static ellipsisHash(text: string, length: number): string;
+}

package/dist/src/stringUtils.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringUtils = void 0;
+/**
+ * Helper class containing string utility methods.
+ */
+class StringUtils {
+    /**
+       * Truncate string with ...
+       *
+       * @param text Text.
+       * @param length Length to truncate text.
+       * @returns Original string modified.
+       */
+    static ellipsis(text, length) {
+        text = text || '';
+        if (text.length <= length) {
+            return text;
+        }
+        return `${text.substr(0, length)}...`;
+    }
+    /**
+       * UniqueHash - create a unique hash from a string.
+       *
+       * @remarks
+       * The source for this function was derived from the following article:
+       *
+       * https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+       * @param text Text to hash.
+       * @returns A string which is an unique hash.
+       */
+    static hash(text) {
+        const length = text.length;
+        let hash = 0;
+        for (let i = 0; i < length; i++) {
+            const chr = text.charCodeAt(i);
+            hash = (hash << 5) - hash + chr;
+            hash |= 0; // Convert to 32 bit integer
+        }
+        return hash.toString();
+    }
+    /**
+       * EllipsisHash - create truncated string with unique hash for the truncated part.
+       *
+       * @param text Text to truncate.
+       * @param length Length to truncate at.
+       * @returns The truncated string with unique hash for the truncated part.
+       */
+    static ellipsisHash(text, length) {
+        text = text || '';
+        if (text.length <= length) {
+            return text;
+        }
+        return `${this.ellipsis(text, length)}${this.hash(text)}`;
+    }
+}
+exports.StringUtils = StringUtils;
+//# sourceMappingURL=stringUtils.js.map

package/dist/src/stringUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringUtils.js","sourceRoot":"","sources":["../../src/stringUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,WAAW;IACtB;;;;;;SAMK;IACL,MAAM,CAAC,QAAQ,CAAE,IAAY,EAAE,MAAc;QAC3C,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAA;IACvC,CAAC;IAED;;;;;;;;;SASK;IACL,MAAM,CAAC,IAAI,CAAE,IAAY;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAC1B,IAAI,IAAI,GAAG,CAAC,CAAA;QACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;YAC9B,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAA;YAC/B,IAAI,IAAI,CAAC,CAAA,CAAC,4BAA4B;QACxC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;SAMK;IACL,MAAM,CAAC,YAAY,CAAE,IAAY,EAAE,MAAc;QAC/C,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IAC3D,CAAC;CACF;AArDD,kCAqDC"}

package/dist/src/template.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DialogContext } from './dialogContext';
+/**
+ * Defines Template interface for binding data to T.
+ */
+export interface TemplateInterface<T, D = Record<string, unknown>> {
+    /**
+       * Given the turn context bind to the data to create the object
+       *
+       * @param dialogContext DialogContext.
+       * @param data Data to bind to.
+       * @returns Instance of T.
+       */
+    bind(dialogContext: DialogContext, data?: D): Promise<T>;
+}

package/dist/src/template.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=template.js.map

package/dist/src/template.js.map

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

package/dist/src/waterfallDialog.d.ts

@@ -0,0 +1,101 @@
+import { Dialog } from './dialog';
+import { DialogContext } from './dialogContext';
+import { WaterfallStepContext } from './waterfallStepContext';
+import { DialogTurnResult } from './dialogTurnResult';
+import { DialogReason } from './dialogReason';
+/**
+ * Function signature of an individual waterfall step.
+ *
+ * @param O (Optional) type of dialog options passed into the step.
+ * @param WaterfallStep.step Contextual information for the current step being executed.
+ */
+export type WaterfallStep<O extends object = {}> = (step: WaterfallStepContext<O>) => Promise<DialogTurnResult>;
+/**
+ * A waterfall is a dialog that's optimized for prompting a user with a series of questions.
+ *
+ */
+export declare class WaterfallDialog<O extends object = {}> extends Dialog<O> {
+    private readonly steps;
+    /**
+       * Creates a new waterfall dialog containing the given array of steps.
+       *
+       * @remarks
+       * See the addstep function for details on creating a valid step function.
+       * @param dialogId Unique ID of the dialog within the component or set its being added to.
+       * @param steps (Optional) array of asynchronous waterfall step functions.
+       */
+    constructor(dialogId: string, steps?: WaterfallStep<O>[]);
+    /**
+       * Gets the dialog version, composed of the ID and number of steps.
+       *
+       * @returns Dialog version, composed of the ID and number of steps.
+       */
+    getVersion(): string;
+    /**
+       * Adds a new step to the waterfall.
+       *
+       * @param step Asynchronous step function to call.
+       * @returns Waterfall dialog for fluent calls to `addStep()`.
+       */
+    addStep(step: WaterfallStep<O>): this;
+    /**
+       * Called when the WaterfallDialog is started and pushed onto the dialog stack.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @param options Optional, initial information to pass to the Dialog.
+       * @returns A Promise representing the asynchronous operation.
+       * @remarks
+       * If the task is successful, the result indicates whether the Dialog is still
+       * active after the turn has been processed by the dialog.
+       */
+    beginDialog(dialogContext: DialogContext, options?: O): Promise<DialogTurnResult>;
+    /**
+       * Called when the WaterfallDialog is _continued_, where it is the active dialog and the
+       * user replies with a new Activity.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @returns A Promise representing the asynchronous operation.
+       * @remarks
+       * If the task is successful, the result indicates whether the dialog is still
+       * active after the turn has been processed by the dialog. The result may also contain a
+       * return value.
+       */
+    continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult>;
+    /**
+       * Called when a child WaterfallDialog completed its turn, returning control to this dialog.
+       *
+       * @param dc The DialogContext for the current turn of the conversation.
+       * @param reason DialogReason why the dialog resumed.
+       * @param result Optional, value returned from the dialog that was called. The type
+       * of the value returned is dependent on the child dialog.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>;
+    /**
+       * Called when an individual waterfall step is being executed.
+       *
+       * @remarks
+       * SHOULD be overridden by derived class that want to add custom logging semantics.
+       *
+       * @param step Context object for the waterfall step to execute.
+       * @returns A promise with the DialogTurnResult.
+       */
+    protected onStep(step: WaterfallStepContext<O>): Promise<DialogTurnResult>;
+    /**
+       * Executes a step of the WaterfallDialog.
+       *
+       * @param dc The DialogContext for the current turn of conversation.
+       * @param index The index of the current waterfall step to execute.
+       * @param reason The DialogReason the waterfall step is being executed.
+       * @param result Optional, result returned by a dialog called in the previous waterfall step.
+       * @returns A Promise that represents the work queued to execute.
+       */
+    protected runStep(dc: DialogContext, index: number, reason: DialogReason, result?: any): Promise<DialogTurnResult>;
+    /**
+       * Identifies the step name by its position index.
+       *
+       * @param index Step position
+       * @returns A string that identifies the step name.
+       */
+    private waterfallStepName;
+}

package/dist/src/waterfallDialog.js

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WaterfallDialog = void 0;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const uuid_1 = require("uuid");
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const dialog_1 = require("./dialog");
+const waterfallStepContext_1 = require("./waterfallStepContext");
+const dialogReason_1 = require("./dialogReason");
+/**
+ * A waterfall is a dialog that's optimized for prompting a user with a series of questions.
+ *
+ */
+class WaterfallDialog extends dialog_1.Dialog {
+    /**
+       * Creates a new waterfall dialog containing the given array of steps.
+       *
+       * @remarks
+       * See the addstep function for details on creating a valid step function.
+       * @param dialogId Unique ID of the dialog within the component or set its being added to.
+       * @param steps (Optional) array of asynchronous waterfall step functions.
+       */
+    constructor(dialogId, steps) {
+        super(dialogId);
+        this.steps = [];
+        if (steps) {
+            this.steps = steps.slice(0);
+        }
+    }
+    /**
+       * Gets the dialog version, composed of the ID and number of steps.
+       *
+       * @returns Dialog version, composed of the ID and number of steps.
+       */
+    getVersion() {
+        // Simply return the id + number of steps to help detect when new steps have
+        // been added to a given waterfall.
+        return `${this.id}:${this.steps.length}`;
+    }
+    /**
+       * Adds a new step to the waterfall.
+       *
+       * @param step Asynchronous step function to call.
+       * @returns Waterfall dialog for fluent calls to `addStep()`.
+       */
+    addStep(step) {
+        this.steps.push(step);
+        return this;
+    }
+    /**
+       * Called when the WaterfallDialog is started and pushed onto the dialog stack.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @param options Optional, initial information to pass to the Dialog.
+       * @returns A Promise representing the asynchronous operation.
+       * @remarks
+       * If the task is successful, the result indicates whether the Dialog is still
+       * active after the turn has been processed by the dialog.
+       */
+    async beginDialog(dialogContext, options) {
+        const state = dialogContext.activeDialog.state;
+        state.options = options || {};
+        state.values = {
+            instanceId: (0, uuid_1.v4)(),
+        };
+        // Run the first step
+        return await this.runStep(dialogContext, 0, dialogReason_1.DialogReason.beginCalled);
+    }
+    /**
+       * Called when the WaterfallDialog is _continued_, where it is the active dialog and the
+       * user replies with a new Activity.
+       *
+       * @param dialogContext The DialogContext for the current turn of conversation.
+       * @returns A Promise representing the asynchronous operation.
+       * @remarks
+       * If the task is successful, the result indicates whether the dialog is still
+       * active after the turn has been processed by the dialog. The result may also contain a
+       * return value.
+       */
+    async continueDialog(dialogContext) {
+        // Don't do anything for non-message activities
+        if (dialogContext.context.activity.type !== agents_hosting_1.ActivityTypes.Message) {
+            return dialog_1.Dialog.EndOfTurn;
+        }
+        // Run next step with the message text as the result.
+        return await this.resumeDialog(dialogContext, dialogReason_1.DialogReason.continueCalled, dialogContext.context.activity.text);
+    }
+    /**
+       * Called when a child WaterfallDialog completed its turn, returning control to this dialog.
+       *
+       * @param dc The DialogContext for the current turn of the conversation.
+       * @param reason DialogReason why the dialog resumed.
+       * @param result Optional, value returned from the dialog that was called. The type
+       * of the value returned is dependent on the child dialog.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    async resumeDialog(dc, reason, result) {
+        // Increment step index and run step
+        const state = dc.activeDialog.state;
+        return await this.runStep(dc, state.stepIndex + 1, reason, result);
+    }
+    /**
+       * Called when an individual waterfall step is being executed.
+       *
+       * @remarks
+       * SHOULD be overridden by derived class that want to add custom logging semantics.
+       *
+       * @param step Context object for the waterfall step to execute.
+       * @returns A promise with the DialogTurnResult.
+       */
+    async onStep(step) {
+        return await this.steps[step.index](step);
+    }
+    /**
+       * Executes a step of the WaterfallDialog.
+       *
+       * @param dc The DialogContext for the current turn of conversation.
+       * @param index The index of the current waterfall step to execute.
+       * @param reason The DialogReason the waterfall step is being executed.
+       * @param result Optional, result returned by a dialog called in the previous waterfall step.
+       * @returns A Promise that represents the work queued to execute.
+       */
+    async runStep(dc, index, reason, result) {
+        if (index < this.steps.length) {
+            // Update persisted step index
+            const state = dc.activeDialog.state;
+            state.stepIndex = index;
+            // Create step context
+            let nextCalled = false;
+            const step = new waterfallStepContext_1.WaterfallStepContext(dc, {
+                index,
+                options: state.options,
+                reason,
+                result,
+                values: state.values,
+                onNext: async (stepResult) => {
+                    if (nextCalled) {
+                        throw new Error(`WaterfallStepContext.next(): method already called for dialog and step '${this.id}[${index}]'.`);
+                    }
+                    nextCalled = true;
+                    return await this.resumeDialog(dc, dialogReason_1.DialogReason.nextCalled, stepResult);
+                },
+            });
+            // Execute step
+            return await this.onStep(step);
+        }
+        else {
+            // End of waterfall so just return to parent
+            return await dc.endDialog(result);
+        }
+    }
+    /**
+       * Identifies the step name by its position index.
+       *
+       * @param index Step position
+       * @returns A string that identifies the step name.
+       */
+    waterfallStepName(index) {
+        // Log Waterfall Step event. Each event has a distinct name to hook up
+        // to the Application Insights funnel.
+        let stepName = '';
+        if (this.steps[index]) {
+            try {
+                stepName = this.steps[index].name;
+            }
+            finally {
+                if (stepName === undefined || stepName === '') {
+                    stepName = 'Step' + (index + 1) + 'of' + this.steps.length;
+                }
+            }
+        }
+        return stepName;
+    }
+}
+exports.WaterfallDialog = WaterfallDialog;
+//# sourceMappingURL=waterfallDialog.js.map

package/dist/src/waterfallDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waterfallDialog.js","sourceRoot":"","sources":["../../src/waterfallDialog.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+BAAmC;AACnC,8DAAyD;AACzD,qCAAiC;AAEjC,iEAA6D;AAE7D,iDAA6C;AAU7C;;;GAGG;AACH,MAAa,eAAuC,SAAQ,eAAS;IAGnE;;;;;;;SAOK;IACL,YAAa,QAAgB,EAAE,KAA0B;QACvD,KAAK,CAAC,QAAQ,CAAC,CAAA;QACf,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC;IAED;;;;SAIK;IACL,UAAU;QACR,4EAA4E;QAC5E,mCAAmC;QACnC,OAAO,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;IAC1C,CAAC;IAED;;;;;SAKK;IACL,OAAO,CAAE,IAAsB;QAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;SASK;IACL,KAAK,CAAC,WAAW,CAAE,aAA4B,EAAE,OAAW;QAC1D,MAAM,KAAK,GAAyB,aAAa,CAAC,YAAY,CAAC,KAA6B,CAAA;QAC5F,KAAK,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QAC7B,KAAK,CAAC,MAAM,GAAG;YACb,UAAU,EAAE,IAAA,SAAM,GAAE;SACrB,CAAA;QAED,qBAAqB;QACrB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE,2BAAY,CAAC,WAAW,CAAC,CAAA;IACvE,CAAC;IAED;;;;;;;;;;SAUK;IACL,KAAK,CAAC,cAAc,CAAE,aAA4B;QAChD,+CAA+C;QAC/C,IAAI,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,8BAAa,CAAC,OAAO,EAAE,CAAC;YAClE,OAAO,eAAM,CAAC,SAAS,CAAA;QACzB,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,2BAAY,CAAC,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACjH,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,YAAY,CAAE,EAAiB,EAAE,MAAoB,EAAE,MAAY;QACvE,oCAAoC;QACpC,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;QAEjF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,MAAM,CAAE,IAA6B;QACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;;;;SAQK;IACK,KAAK,CAAC,OAAO,CACrB,EAAiB,EACjB,KAAa,EACb,MAAoB,EACpB,MAAY;QAEZ,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC9B,8BAA8B;YAC9B,MAAM,KAAK,GAAyB,EAAE,CAAC,YAAY,CAAC,KAA6B,CAAA;YACjF,KAAK,CAAC,SAAS,GAAG,KAAK,CAAA;YAEvB,sBAAsB;YACtB,IAAI,UAAU,GAAG,KAAK,CAAA;YACtB,MAAM,IAAI,GAA4B,IAAI,2CAAoB,CAAI,EAAE,EAAE;gBACpE,KAAK;gBACL,OAAO,EAAK,KAAK,CAAC,OAAO;gBACzB,MAAM;gBACN,MAAM;gBACN,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,MAAM,EAAE,KAAK,EAAE,UAAgB,EAAkC,EAAE;oBACjE,IAAI,UAAU,EAAE,CAAC;wBACf,MAAM,IAAI,KAAK,CACC,2EAA2E,IAAI,CAAC,EAAE,IAAI,KAAK,KAAK,CAC/G,CAAA;oBACH,CAAC;oBACD,UAAU,GAAG,IAAI,CAAA;oBACjB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,2BAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;gBACzE,CAAC;aACF,CAAC,CAAA;YAEF,eAAe;YACf,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,4CAA4C;YAC5C,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACG,iBAAiB,CAAE,KAAa;QACtC,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,QAAQ,GAAG,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;YACnC,CAAC;oBAAS,CAAC;gBACT,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAC9C,QAAQ,GAAG,MAAM,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AArLD,0CAqLC"}