@microsoft/agents-hosting-dialogs 0.1.49

package/dist/src/choices/findValues.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findValues = findValues;
+const tokenizer_1 = require("./tokenizer");
+/**
+ * INTERNAL: Low-level function that searches for a set of values within an utterance. Higher level
+ * functions like `findChoices()` and `recognizeChoices()` are layered above this function.  In most
+ * cases its easier to just call one of the higher level functions instead but this function contains
+ * the fuzzy search algorithm that drives choice recognition.
+ *
+ * @param utterance The text or user utterance to search over.
+ * @param values List of values to search over.
+ * @param options (Optional) options used to tweak the search that's performed.
+ * @returns A list of found values.
+ */
+function findValues(utterance, values, options) {
+    function indexOfToken(token, startPos) {
+        for (let i = startPos; i < tokens.length; i++) {
+            if (tokens[i].normalized === token.normalized) {
+                return i;
+            }
+        }
+        return -1;
+    }
+    function findExactMatch(utterance, values) {
+        const entry = values.find(({ value }) => value.toLowerCase() === utterance.toLowerCase());
+        if (!entry) {
+            return null;
+        }
+        return {
+            text: utterance,
+            start: 0,
+            end: utterance.length - 1,
+            typeName: 'value',
+            resolution: {
+                value: entry.value,
+                index: entry.index,
+                score: 1,
+            },
+        };
+    }
+    const exactMatch = findExactMatch(utterance, values);
+    if (exactMatch) {
+        return [exactMatch];
+    }
+    function matchValue(index, value, vTokens, startPos) {
+        let matched = 0;
+        let totalDeviation = 0;
+        let start = -1;
+        let end = -1;
+        vTokens.forEach((token) => {
+            const pos = indexOfToken(token, startPos);
+            if (pos >= 0) {
+                const distance = matched > 0 ? pos - startPos : 0;
+                if (distance <= maxDistance) {
+                    matched++;
+                    totalDeviation += distance;
+                    startPos = pos + 1;
+                    if (start < 0) {
+                        start = pos;
+                    }
+                    end = pos;
+                }
+            }
+        });
+        let result;
+        if (matched > 0 && (matched === vTokens.length || opt.allowPartialMatches)) {
+            const completeness = matched / vTokens.length;
+            const accuracy = matched / (matched + totalDeviation);
+            const score = completeness * accuracy;
+            result = {
+                start,
+                end,
+                typeName: 'value',
+                resolution: {
+                    value,
+                    index,
+                    score,
+                },
+            };
+        }
+        return result;
+    }
+    const list = values.sort((a, b) => b.value.length - a.value.length);
+    let matches = [];
+    const opt = options || {};
+    const tokenizer = opt.tokenizer || tokenizer_1.defaultTokenizer;
+    const tokens = tokenizer(utterance, opt.locale);
+    const maxDistance = opt.maxTokenDistance !== undefined ? opt.maxTokenDistance : 2;
+    list.forEach((entry) => {
+        let startPos = 0;
+        const vTokens = tokenizer(entry.value.trim(), opt.locale);
+        while (startPos < tokens.length) {
+            const match = matchValue(entry.index, entry.value, vTokens, startPos);
+            if (match) {
+                startPos = match.end + 1;
+                matches.push(match);
+            }
+            else {
+                break;
+            }
+        }
+    });
+    matches = matches.sort((a, b) => b.resolution.score - a.resolution.score);
+    const results = [];
+    const foundIndexes = {};
+    const usedTokens = {};
+    matches.forEach((match) => {
+        let add = !Object.prototype.hasOwnProperty.call(foundIndexes, match.resolution.index);
+        for (let i = match.start; i <= match.end; i++) {
+            if (usedTokens[i]) {
+                add = false;
+                break;
+            }
+        }
+        if (add) {
+            foundIndexes[match.resolution.index] = true;
+            for (let i = match.start; i <= match.end; i++) {
+                usedTokens[i] = true;
+            }
+            match.start = tokens[match.start].start;
+            match.end = tokens[match.end].end;
+            match.text = utterance.substring(match.start, match.end + 1);
+            results.push(match);
+        }
+    });
+    return results.sort((a, b) => a.start - b.start);
+}
+//# sourceMappingURL=findValues.js.map

package/dist/src/choices/findValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findValues.js","sourceRoot":"","sources":["../../../src/choices/findValues.ts"],"names":[],"mappings":";;AAuCA,gCA2IC;AA7KD,2CAAwE;AAuBxE;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,SAAiB,EACjB,MAAqB,EACrB,OAA2B;IAE3B,SAAS,YAAY,CAAE,KAAY,EAAE,QAAgB;QACnD,KAAK,IAAI,CAAC,GAAW,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;gBAC9C,OAAO,CAAC,CAAA;YACV,CAAC;QACH,CAAC;QAED,OAAO,CAAC,CAAC,CAAA;IACX,CAAC;IAED,SAAS,cAAc,CAAE,SAAiB,EAAE,MAAqB;QAC/D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAA;QACzF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO;YACL,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,CAAC;YACR,GAAG,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC;YACzB,QAAQ,EAAE,OAAO;YACjB,UAAU,EAAE;gBACV,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,CAAC;aACT;SACF,CAAA;IACH,CAAC;IAED,MAAM,UAAU,GAAG,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACpD,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,CAAC,UAAU,CAAC,CAAA;IACrB,CAAC;IAED,SAAS,UAAU,CACjB,KAAa,EACb,KAAa,EACb,OAAgB,EAChB,QAAgB;QAEhB,IAAI,OAAO,GAAG,CAAC,CAAA;QACf,IAAI,cAAc,GAAG,CAAC,CAAA;QACtB,IAAI,KAAK,GAAG,CAAC,CAAC,CAAA;QACd,IAAI,GAAG,GAAG,CAAC,CAAC,CAAA;QACZ,OAAO,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YAC/B,MAAM,GAAG,GAAW,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;YACjD,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;gBACb,MAAM,QAAQ,GAAW,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;gBACzD,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;oBAC5B,OAAO,EAAE,CAAA;oBACT,cAAc,IAAI,QAAQ,CAAA;oBAC1B,QAAQ,GAAG,GAAG,GAAG,CAAC,CAAA;oBAElB,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;wBACd,KAAK,GAAG,GAAG,CAAA;oBACb,CAAC;oBACD,GAAG,GAAG,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,MAA2C,CAAA;QAC/C,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC3E,MAAM,YAAY,GAAW,OAAO,GAAG,OAAO,CAAC,MAAM,CAAA;YAErD,MAAM,QAAQ,GAAW,OAAO,GAAG,CAAC,OAAO,GAAG,cAAc,CAAC,CAAA;YAE7D,MAAM,KAAK,GAAW,YAAY,GAAG,QAAQ,CAAA;YAE7C,MAAM,GAAG;gBACP,KAAK;gBACL,GAAG;gBACH,QAAQ,EAAE,OAAO;gBACjB,UAAU,EAAE;oBACV,KAAK;oBACL,KAAK;oBACL,KAAK;iBACN;aACyB,CAAA;QAC9B,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,MAAM,IAAI,GAAkB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAE5G,IAAI,OAAO,GAA8B,EAAE,CAAA;IAC3C,MAAM,GAAG,GAAsB,OAAO,IAAI,EAAE,CAAA;IAC5C,MAAM,SAAS,GAAsB,GAAG,CAAC,SAAS,IAAI,4BAAgB,CAAA;IACtE,MAAM,MAAM,GAAY,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,WAAW,GAAW,GAAG,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;IACzF,IAAI,CAAC,OAAO,CAAC,CAAC,KAAkB,EAAE,EAAE;QAClC,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,MAAM,OAAO,GAAY,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAClE,OAAO,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;YACrE,IAAI,KAAK,EAAE,CAAC;gBACV,QAAQ,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,CAAA;gBACxB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACrB,CAAC;iBAAM,CAAC;gBACN,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,GAAG,OAAO,CAAC,IAAI,CACpB,CAAC,CAA0B,EAAE,CAA0B,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,KAAK,CACpG,CAAA;IAED,MAAM,OAAO,GAA8B,EAAE,CAAA;IAC7C,MAAM,YAAY,GAAiC,EAAE,CAAA;IACrD,MAAM,UAAU,GAAiC,EAAE,CAAA;IACnD,OAAO,CAAC,OAAO,CAAC,CAAC,KAA8B,EAAE,EAAE;QACjD,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACrF,KAAK,IAAI,CAAC,GAAW,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClB,GAAG,GAAG,KAAK,CAAA;gBACX,MAAK;YACP,CAAC;QACH,CAAC;QAED,IAAI,GAAG,EAAE,CAAC;YACR,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YAC3C,KAAK,IAAI,CAAC,GAAW,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtD,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;YACtB,CAAC;YAED,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAA;YACvC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAA;YACjC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;YAC5D,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrB,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAA0B,EAAE,CAA0B,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAA;AACpG,CAAC"}

package/dist/src/choices/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from './choice';
+export * from './choiceFactory';
+export * from './findChoices';
+export * from './findValues';
+export * from './modelResult';
+export * from './recognizeChoices';
+export * from './tokenizer';

package/dist/src/choices/index.js

@@ -0,0 +1,28 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+__exportStar(require("./choice"), exports);
+__exportStar(require("./choiceFactory"), exports);
+__exportStar(require("./findChoices"), exports);
+__exportStar(require("./findValues"), exports);
+__exportStar(require("./modelResult"), exports);
+__exportStar(require("./recognizeChoices"), exports);
+__exportStar(require("./tokenizer"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/choices/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/choices/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;GAGG;AACH,2CAAwB;AACxB,kDAA+B;AAC/B,gDAA6B;AAC7B,+CAA4B;AAC5B,gDAA6B;AAC7B,qDAAkC;AAClC,8CAA2B"}

package/dist/src/choices/modelResult.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export interface ModelResult<T extends Record<string, any> = {}> {
+    text: string;
+    start: number;
+    end: number;
+    typeName: string;
+    resolution: T;
+}

package/dist/src/choices/modelResult.js

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

package/dist/src/choices/modelResult.js.map

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

package/dist/src/choices/recognizeChoices.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FindChoicesOptions, FoundChoice } from './findChoices';
+import { ModelResult } from './modelResult';
+import { Choice } from './choice';
+/**
+ * High level function for recognizing a choice in a users utterance.
+ *
+ * @param utterance The text or user utterance to search over. For an incoming 'message' activity you can simply use `context.activity.text`.
+ * @param choices List of choices to search over.
+ * @param options (Optional) options used to tweak the search that's performed.
+ * @returns A list of found choices, sorted by most relevant first.
+ */
+export declare function recognizeChoices(utterance: string, choices: (string | Choice)[], options?: FindChoicesOptions): ModelResult<FoundChoice>[];

package/dist/src/choices/recognizeChoices.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recognizeChoices = recognizeChoices;
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const findChoices_1 = require("./findChoices");
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const logger = (0, agents_hosting_1.debug)('dialogs:recognizeChoices');
+/**
+ * High level function for recognizing a choice in a users utterance.
+ *
+ * @param utterance The text or user utterance to search over. For an incoming 'message' activity you can simply use `context.activity.text`.
+ * @param choices List of choices to search over.
+ * @param options (Optional) options used to tweak the search that's performed.
+ * @returns A list of found choices, sorted by most relevant first.
+ */
+function recognizeChoices(utterance, choices, options) {
+    function matchChoiceByIndex(match) {
+        try {
+            const index = parseInt(match.resolution.value, 10) - 1;
+            if (index >= 0 && index < list.length) {
+                const choice = list[index];
+                matched.push({
+                    start: match.start,
+                    end: match.end,
+                    typeName: 'choice',
+                    text: match.text,
+                    resolution: {
+                        value: choice.value,
+                        index,
+                        score: 1,
+                    },
+                });
+            }
+        }
+        catch (error) {
+            logger.error('Error: ', error);
+            throw error;
+        }
+    }
+    // Initialize options
+    options = Object.assign({
+        locale: 'en-us',
+        recognizeNumbers: true,
+        recognizeOrdinals: true,
+    }, options);
+    // Normalize choices
+    const list = (choices || [])
+        .map((choice) => (typeof choice === 'string' ? { value: choice } : choice))
+        .filter((choice) => choice // TODO: does this do anything?
+    );
+    // Try finding choices by text search first
+    // - We only want to use a single strategy for returning results to avoid issues where utterances
+    //   like the "the third one" or "the red one" or "the first division book" would miss-recognize as
+    //   a numerical index or ordinal as well.
+    let matched = (0, findChoices_1.findChoices)(utterance, list, options);
+    if (matched.length === 0) {
+        // Next try finding by ordinal
+        if (options.recognizeOrdinals) {
+            // TODO: Review recognizeOrdinal function
+            // const ordinals: ModelResult[] = Recognizers.recognizeOrdinal(utterance, options.locale ?? '')
+            const ordinals = [];
+            ordinals.forEach(matchChoiceByIndex);
+        }
+        // Finally try by numerical index
+        if (matched.length === 0 && options.recognizeNumbers) {
+            // TODO: Review recognizeNumber function
+            // const numbers: ModelResult[] = Recognizers.recognizeNumber(utterance, options.locale ?? '').forEach(matchChoiceByIndex)
+            const numbers = [];
+            numbers.forEach(matchChoiceByIndex);
+        }
+        // Sort any found matches by their position within the utterance.
+        // - The results from findChoices() are already properly sorted so we just need this
+        //   for ordinal & numerical lookups.
+        matched = matched.sort((a, b) => a.start - b.start);
+    }
+    return matched;
+}
+//# sourceMappingURL=recognizeChoices.js.map

package/dist/src/choices/recognizeChoices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recognizeChoices.js","sourceRoot":"","sources":["../../../src/choices/recognizeChoices.ts"],"names":[],"mappings":";;AAmBA,4CA0EC;AA7FD;;;GAGG;AACH,+CAA4E;AAG5E,8DAAiD;AAEjD,MAAM,MAAM,GAAG,IAAA,sBAAK,EAAC,0BAA0B,CAAC,CAAA;AAEhD;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,OAA4B,EAC5B,OAA4B;IAE5B,SAAS,kBAAkB,CAAE,KAAuB;QAClD,IAAI,CAAC;YACH,MAAM,KAAK,GAAW,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;YAC9D,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM,MAAM,GAAW,IAAI,CAAC,KAAK,CAAC,CAAA;gBAClC,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,QAAQ,EAAE,QAAQ;oBAClB,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,UAAU,EAAE;wBACV,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,KAAK;wBACL,KAAK,EAAE,CAAC;qBACT;iBACF,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;YAC9B,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED,qBAAqB;IACrB,OAAO,GAAG,MAAM,CAAC,MAAM,CACrB;QACE,MAAM,EAAE,OAAO;QACf,gBAAgB,EAAE,IAAI;QACtB,iBAAiB,EAAE,IAAI;KACF,EACvB,OAAO,CACR,CAAA;IAED,oBAAoB;IACpB,MAAM,IAAI,GAAa,CAAC,OAAO,IAAI,EAAE,CAAC;SACnC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;SAC1E,MAAM,CACL,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,+BAA+B;KAC3D,CAAA;IAEH,2CAA2C;IAC3C,iGAAiG;IACjG,mGAAmG;IACnG,0CAA0C;IAC1C,IAAI,OAAO,GAA+B,IAAA,yBAAW,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAC/E,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,8BAA8B;QAC9B,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC9B,yCAAyC;YACzC,gGAAgG;YAChG,MAAM,QAAQ,GAAkB,EAAE,CAAA;YAClC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;QACtC,CAAC;QAED,iCAAiC;QACjC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACrD,wCAAwC;YACxC,0HAA0H;YAC1H,MAAM,OAAO,GAAkB,EAAE,CAAA;YACjC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;QACrC,CAAC;QAED,iEAAiE;QACjE,oFAAoF;QACpF,qCAAqC;QACrC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAA2B,EAAE,CAA2B,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAA;IACzG,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/src/choices/tokenizer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export interface Token {
+    start: number;
+    end: number;
+    text: string;
+    normalized: string;
+}
+/**
+ * Signature for an alternate word breaker.
+ *
+ * @param TokenizerFunction.text The text to be tokenized.
+ * @param TokenizerFunction.locale (Optional) locale of the text if known.
+ */
+export type TokenizerFunction = (text: string, locale?: string) => Token[];
+/**
+ * Simple tokenizer that breaks on spaces and punctuation.
+ *
+ * @param text The input text.
+ * @param _locale Optional, identifies the locale of the input text.
+ * @returns A list of tokens.
+ */
+export declare function defaultTokenizer(text: string, _locale?: string): Token[];

package/dist/src/choices/tokenizer.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultTokenizer = defaultTokenizer;
+/**
+ * Simple tokenizer that breaks on spaces and punctuation.
+ *
+ * @param text The input text.
+ * @param _locale Optional, identifies the locale of the input text.
+ * @returns A list of tokens.
+ */
+function defaultTokenizer(text, _locale) {
+    const tokens = [];
+    let token;
+    function appendToken(end) {
+        if (token) {
+            token.end = end;
+            token.normalized = token.text.toLowerCase();
+            tokens.push(token);
+            token = undefined;
+        }
+    }
+    // Parse text
+    const length = text ? text.length : 0;
+    let i = 0;
+    while (i < length) {
+        const codePoint = text.codePointAt(i) || text.charCodeAt(i);
+        const chr = String.fromCodePoint(codePoint);
+        if (isBreakingChar(codePoint)) {
+            appendToken(i - 1);
+        }
+        else if (codePoint > 0xffff) {
+            appendToken(i - 1);
+            tokens.push({
+                start: i,
+                end: i + (chr.length - 1),
+                text: chr,
+                normalized: chr,
+            });
+        }
+        else if (!token) {
+            token = { start: i, text: chr };
+        }
+        else {
+            token.text += chr;
+        }
+        i += chr.length;
+    }
+    appendToken(length - 1);
+    return tokens;
+}
+/**
+ * @private
+ * @param codePoint number of character
+ */
+function isBreakingChar(codePoint) {
+    return (isBetween(codePoint, 0x0000, 0x002f) ||
+        isBetween(codePoint, 0x003a, 0x0040) ||
+        isBetween(codePoint, 0x005b, 0x0060) ||
+        isBetween(codePoint, 0x007b, 0x00bf) ||
+        isBetween(codePoint, 0x02b9, 0x036f) ||
+        isBetween(codePoint, 0x2000, 0x2bff) ||
+        isBetween(codePoint, 0x2e00, 0x2e7f));
+}
+/**
+ * @private
+ * @param value number value
+ * @param from low range
+ * @param to high range
+ */
+function isBetween(value, from, to) {
+    return value >= from && value <= to;
+}
+//# sourceMappingURL=tokenizer.js.map

package/dist/src/choices/tokenizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenizer.js","sourceRoot":"","sources":["../../../src/choices/tokenizer.ts"],"names":[],"mappings":";;AA0BA,4CAwCC;AA/CD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAE,IAAY,EAAE,OAAgB;IAC9D,MAAM,MAAM,GAAY,EAAE,CAAA;IAC1B,IAAI,KAAwB,CAAA;IAE5B,SAAS,WAAW,CAAE,GAAW;QAC/B,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,CAAC,GAAG,GAAG,GAAG,CAAA;YACf,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;YAC3C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClB,KAAK,GAAG,SAAS,CAAA;QACnB,CAAC;IACH,CAAC;IAED,aAAa;IACb,MAAM,MAAM,GAAW,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7C,IAAI,CAAC,GAAG,CAAC,CAAA;IACT,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC;QAClB,MAAM,SAAS,GAAW,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACnE,MAAM,GAAG,GAAW,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QAEnD,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;QACpB,CAAC;aAAM,IAAI,SAAS,GAAG,MAAM,EAAE,CAAC;YAC9B,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAClB,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACzB,IAAI,EAAE,GAAG;gBACT,UAAU,EAAE,GAAG;aAChB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YAClB,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAW,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,IAAI,GAAG,CAAA;QACnB,CAAC;QACD,CAAC,IAAI,GAAG,CAAC,MAAM,CAAA;IACjB,CAAC;IACD,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAEvB,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAE,SAAiB;IACxC,OAAO,CACL,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QAChC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,CACzC,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAE,KAAa,EAAE,IAAY,EAAE,EAAU;IACzD,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAA;AACrC,CAAC"}

package/dist/src/componentDialog.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TurnContext } from '@microsoft/agents-hosting';
+import { Dialog } from './dialog';
+import { DialogContext } from './dialogContext';
+import { DialogContainer } from './dialogContainer';
+import { DialogTurnResult } from './dialogTurnResult';
+import { DialogReason } from './dialogReason';
+import { DialogInstance } from './dialogInstance';
+/**
+ * Base class for a dialog that contains other child dialogs.
+ *
+ * @remarks
+ * Component dialogs let you break your agent's logic up into components that can themselves be added
+ * as a dialog to another `ComponentDialog` or `DialogSet`. Components can also be exported as part
+ * of a node package and used within other agents.
+ *
+ * @param O (Optional) options that can be passed into the `DialogContext.beginDialog()` method.
+ */
+export declare class ComponentDialog<O extends object = {}> extends DialogContainer<O> {
+    /**
+       * ID of the child dialog that should be started anytime the component is started.
+       *
+       * @remarks
+       * This defaults to the ID of the first child dialog added using [addDialog()](#adddialog).
+       */
+    protected initialDialogId: string;
+    /**
+       * Called when the dialog is started and pushed onto the parent's dialog stack.
+       * By default, this calls the
+       * Dialog.BeginDialogAsync(DialogContext, object, CancellationToken) method
+       * of the component dialog's initial dialog, as defined by InitialDialogId.
+       * Override this method in a derived class to implement interrupt logic.
+       *
+       * @param outerDialogContext The parent 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(outerDialogContext: DialogContext, options?: O): Promise<DialogTurnResult>;
+    /**
+       * Called when the dialog is _continued_, where it is the active dialog and the
+       * user replies with a new Activity.
+       * If this method is *not* overridden, the dialog automatically ends when the user replies.
+       *
+       * @param outerDialogContext The parent 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(outerDialogContext: DialogContext): Promise<DialogTurnResult>;
+    /**
+       * Called when a child dialog on the parent's dialog stack completed this turn, returning
+       * control to this dialog component.
+       *
+       * @param outerDialogContext The DialogContext for the current turn of conversation.
+       * @param _reason Reason 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.
+       * @remarks
+       * If the task is successful, the result indicates whether this dialog is still
+       * active after this dialog turn has been processed.
+       * Generally, the child dialog was started with a call to
+       * beginDialog(DialogContext, object) in the parent's
+       * context. However, if the DialogContext.replaceDialog(string, object) method
+       * is called, the logical child dialog may be different than the original.
+       * If this method is *not* overridden, the dialog automatically calls its
+       * RepromptDialog(ITurnContext, DialogInstance) when the user replies.
+       */
+    resumeDialog(outerDialogContext: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>;
+    /**
+       * Called when the dialog should re-prompt the user for input.
+       *
+       * @param context The TurnContext object for this turn.
+       * @param instance State information for this dialog.
+       * @returns A Promise representing the asynchronous operation.
+       */
+    repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>;
+    /**
+       * Called when the Dialog is ending.
+       *
+       * @param context The TurnContext object for this turn.
+       * @param instance State information associated with the instance of this component Dialog on its parent's dialog stack.
+       * @param reason Reason why the Dialog ended.
+       * @returns A Promise representing the asynchronous operation.
+       * @remarks When this method is called from the parent dialog's context, the component Dialog
+       * cancels all of the dialogs on its inner dialog stack before ending.
+       */
+    endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>;
+    /**
+       * Adds a child Dialog or prompt to the components internal DialogSet.
+       *
+       * @param dialog The child Dialog or prompt to add.
+       * @returns The ComponentDialog after the operation is complete.
+       * @remarks
+       * The Dialog.id of the first child added to the component will be assigned to the initialDialogId property.
+       */
+    addDialog(dialog: Dialog): this;
+    /**
+       * Creates the inner dialog context
+       *
+       * @param outerDialogContext the outer dialog context
+       * @returns The created Dialog Context.
+       */
+    createChildContext(outerDialogContext: DialogContext): DialogContext;
+    /**
+       * Called anytime an instance of the component has been started.
+       *
+       * @remarks
+       * SHOULD be overridden by components that wish to perform custom interruption logic. The
+       * default implementation calls `innerDC.beginDialog()` with the dialog assigned to
+       * initialdialogid.
+       * @param innerDialogContext Dialog context for the components internal `DialogSet`.
+       * @param options (Optional) options that were passed to the component by its parent.
+       * @returns {Promise<DialogTurnResult>} A promise resolving to the dialog turn result.
+       */
+    protected onBeginDialog(innerDialogContext: DialogContext, options?: O): Promise<DialogTurnResult>;
+    /**
+       * Called anytime a multi-turn component receives additional activities.
+       *
+       * @remarks
+       * SHOULD be overridden by components that wish to perform custom interruption logic. The
+       * default implementation calls `innerDC.continueDialog()`.
+       * @param innerDC Dialog context for the components internal `DialogSet`.
+       * @returns {Promise<DialogTurnResult>} A promise resolving to the dialog turn result.
+       */
+    protected onContinueDialog(innerDC: DialogContext): Promise<DialogTurnResult>;
+    /**
+       * Called when the component is ending.
+       *
+       * @remarks
+       * If the `reason` code is equal to `DialogReason.cancelCalled`, then any active child dialogs
+       * will be cancelled before this method is called.
+       * @param _context Context for the current turn of conversation.
+       * @param _instance The components instance data within its parents dialog stack.
+       * @param _reason The reason the component is ending.
+       * @returns A promise representing the asynchronous operation.
+       */
+    protected onEndDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>;
+    /**
+       * Called when the component has been requested to re-prompt the user for input.
+       *
+       * @remarks
+       * The active child dialog will have already been asked to reprompt before this method is called.
+       * @param _context Context for the current turn of conversation.
+       * @param _instance The instance of the current dialog.
+       * @returns A promise representing the asynchronous operation.
+       */
+    protected onRepromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>;
+    /**
+       * Called when the components last active child dialog ends and the component is ending.
+       *
+       * @remarks
+       * SHOULD be overridden by components that wish to perform custom logic before the component
+       * ends.  The default implementation calls `outerDC.endDialog()` with the `result` returned
+       * from the last active child dialog.
+       * @param outerDC Dialog context for the parents `DialogSet`.
+       * @param result Result returned by the last active child dialog. Can be a value of `undefined`.
+       * @returns {Promise<DialogTurnResult>} A promise resolving to the dialog turn result.
+       */
+    protected endComponent(outerDC: DialogContext, result: any): Promise<DialogTurnResult>;
+    /**
+       * @private
+       * @param context DialogContext for the current turn of conversation with the user.
+       * @param instance DialogInstance which contains the current state information for this dialog.
+       * @returns A new DialogContext instance.
+       * @remarks
+       * You should only call this if you don't have a dialogContext to work with (such as OnResume())
+       */
+    private createInnerDC;
+}