@microsoft/agents-hosting-dialogs 0.1.49

package/dist/index.js

@@ -0,0 +1,20 @@
+"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 __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 });
+__exportStar(require("./src"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/agentComponent.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as z from 'zod';
+import { ServiceCollection } from './serviceCollection';
+import { Configuration } from './configuration';
+/**
+ * Definition of an AgentComponent that allows registration of services, custom actions, memory scopes and adapters.
+ *
+ * To make your components available to the system you derive from AgentComponent and register services to add functionality.
+ * These components then are consumed in appropriate places by the systems that need them. When using Composer, configureServices
+ * gets called automatically on the components by the agent runtime, as long as the components are registered in the configuration.
+ */
+export declare abstract class AgentComponent {
+    static z: z.ZodType<AgentComponent, z.ZodTypeDef, AgentComponent>;
+    abstract configureServices(services: ServiceCollection, configuration: Configuration): void;
+}

package/dist/src/agentComponent.js

@@ -0,0 +1,55 @@
+"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.AgentComponent = void 0;
+const z = __importStar(require("zod"));
+/**
+ * Definition of an AgentComponent that allows registration of services, custom actions, memory scopes and adapters.
+ *
+ * To make your components available to the system you derive from AgentComponent and register services to add functionality.
+ * These components then are consumed in appropriate places by the systems that need them. When using Composer, configureServices
+ * gets called automatically on the components by the agent runtime, as long as the components are registered in the configuration.
+ */
+class AgentComponent {
+}
+exports.AgentComponent = AgentComponent;
+AgentComponent.z = z.custom((val) => typeof val.configureServices === 'function', {
+    message: 'AgentComponent',
+});
+//# sourceMappingURL=agentComponent.js.map

package/dist/src/agentComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentComponent.js","sourceRoot":"","sources":["../../src/agentComponent.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAwB;AAIxB;;;;;;GAMG;AACH,MAAsB,cAAc;;AAApC,wCAMC;AALQ,gBAAC,GAAG,CAAC,CAAC,MAAM,CAAiB,CAAC,GAAQ,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,iBAAiB,KAAK,UAAU,EAAE;IAC7F,OAAO,EAAE,gBAAgB;CAC1B,CAAC,CAAA"}

package/dist/src/agentStateSet.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AgentState, TurnContext } from '@microsoft/agents-hosting';
+/**
+ * A collection of `AgentState` plugins that should be loaded or saved in parallel as a single unit.
+ * See `AutoSaveStateMiddleware` for an implementation of this class.
+ */
+export declare class AgentStateSet {
+    /**
+       * Array of the sets `AgentState` plugins.
+       */
+    readonly agentStates: AgentState[];
+    /**
+       * Creates a new AgentStateSet instance.
+       *
+       * @param agentStates One or more AgentState plugins to register.
+       */
+    constructor(...agentStates: AgentState[]);
+    /**
+       * Registers one or more `AgentState` plugins with the set.
+       *
+       * @param agentStates One or more AgentState plugins to register.
+       * @returns The updated AgentStateSet.
+       */
+    add(...agentStates: AgentState[]): this;
+    /**
+       * Calls `AgentState.load()` on all of the AgentState plugins in the set.
+       *
+       * @remarks
+       * This will trigger all of the plugins to read in their state in parallel.
+       *
+       * @param context Context for current turn of conversation with the user.
+       * @param force (Optional) If `true` the cache will be bypassed and the state will always be read in directly from storage. Defaults to `false`.
+       */
+    loadAll(context: TurnContext, force?: boolean): Promise<void>;
+    /**
+       * Calls `AgentState.saveChanges()` on all of the AgentState plugins in the set.
+       *
+       * @remarks
+       * This will trigger all of the plugins to write out their state in parallel.
+       *
+       * @param context Context for current turn of conversation with the user.
+       * @param force (Optional) if `true` the state will always be written out regardless of its change state. Defaults to `false`.
+       */
+    saveAllChanges(context: TurnContext, force?: boolean): Promise<void>;
+}

package/dist/src/agentStateSet.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentStateSet = void 0;
+/**
+ * A collection of `AgentState` plugins that should be loaded or saved in parallel as a single unit.
+ * See `AutoSaveStateMiddleware` for an implementation of this class.
+ */
+class AgentStateSet {
+    /**
+       * Creates a new AgentStateSet instance.
+       *
+       * @param agentStates One or more AgentState plugins to register.
+       */
+    constructor(...agentStates) {
+        /**
+           * Array of the sets `AgentState` plugins.
+           */
+        this.agentStates = [];
+        AgentStateSet.prototype.add.apply(this, agentStates);
+    }
+    /**
+       * Registers one or more `AgentState` plugins with the set.
+       *
+       * @param agentStates One or more AgentState plugins to register.
+       * @returns The updated AgentStateSet.
+       */
+    add(...agentStates) {
+        agentStates.forEach((agentstate) => {
+            if (typeof agentstate.load === 'function' && typeof agentstate.saveChanges === 'function') {
+                this.agentStates.push(agentstate);
+            }
+            else {
+                throw new Error("AgentStateSet: a object was added that isn't an instance of AgentStateSet.");
+            }
+        });
+        return this;
+    }
+    /**
+       * Calls `AgentState.load()` on all of the AgentState plugins in the set.
+       *
+       * @remarks
+       * This will trigger all of the plugins to read in their state in parallel.
+       *
+       * @param context Context for current turn of conversation with the user.
+       * @param force (Optional) If `true` the cache will be bypassed and the state will always be read in directly from storage. Defaults to `false`.
+       */
+    async loadAll(context, force = false) {
+        const promises = this.agentStates.map((agentstate) => agentstate.load(context, force));
+        await Promise.all(promises);
+    }
+    /**
+       * Calls `AgentState.saveChanges()` on all of the AgentState plugins in the set.
+       *
+       * @remarks
+       * This will trigger all of the plugins to write out their state in parallel.
+       *
+       * @param context Context for current turn of conversation with the user.
+       * @param force (Optional) if `true` the state will always be written out regardless of its change state. Defaults to `false`.
+       */
+    async saveAllChanges(context, force = false) {
+        const promises = this.agentStates.map((agentstate) => agentstate.saveChanges(context, force));
+        await Promise.all(promises);
+    }
+}
+exports.AgentStateSet = AgentStateSet;
+//# sourceMappingURL=agentStateSet.js.map

package/dist/src/agentStateSet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentStateSet.js","sourceRoot":"","sources":["../../src/agentStateSet.ts"],"names":[],"mappings":";;;AAMA;;;GAGG;AACH,MAAa,aAAa;IAMxB;;;;SAIK;IACL,YAAa,GAAG,WAAyB;QAVzC;;aAEK;QACI,gBAAW,GAAiB,EAAE,CAAA;QAQrC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACtD,CAAC;IAED;;;;;SAKK;IACL,GAAG,CAAE,GAAG,WAAyB;QAC/B,WAAW,CAAC,OAAO,CAAC,CAAC,UAAsB,EAAE,EAAE;YAC7C,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,UAAU,CAAC,WAAW,KAAK,UAAU,EAAE,CAAC;gBAC1F,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACnC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;YAC/F,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,OAAO,CAAE,OAAoB,EAAE,KAAK,GAAG,KAAK;QAChD,MAAM,QAAQ,GAAmB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAElH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;;;;SAQK;IACL,KAAK,CAAC,cAAc,CAAE,OAAoB,EAAE,KAAK,GAAG,KAAK;QACvD,MAAM,QAAQ,GAAoB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAsB,EAAE,EAAE,CAChF,UAAU,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CACvC,CAAA;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC7B,CAAC;CACF;AAhED,sCAgEC"}

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

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { CardAction } from '@microsoft/agents-hosting';
+/**
+ * An instance of a choice that can be used to render a choice to a user or recognize something a
+ * user picked.
+ */
+export interface Choice {
+    value: string;
+    action?: CardAction;
+    synonyms?: string[];
+}

package/dist/src/choices/choice.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=choice.js.map

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

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

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

@@ -0,0 +1,81 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Activity, TurnContext } from '@microsoft/agents-hosting';
+import { Choice } from './choice';
+/**
+ * Additional options used to tweak the formatting of choice lists.
+ */
+export interface ChoiceFactoryOptions {
+    /**
+       * (Optional) character used to separate individual choices when there are more than 2 choices.
+       * The default value is `", "`.
+       */
+    inlineSeparator?: string;
+    /**
+       * (Optional) separator inserted between the choices when their are only 2 choices. The default
+       * value is `" or "`.
+       */
+    inlineOr?: string;
+    /**
+       * (Optional) separator inserted between the last 2 choices when their are more than 2 choices.
+       * The default value is `", or "`.
+       */
+    inlineOrMore?: string;
+    /**
+       * (Optional) if `true`, inline and list style choices will be prefixed with the index of the
+       * choice as in "1. choice". If `false`, the list style will use a bulleted list instead. The
+       * default value is `true`.
+       */
+    includeNumbers?: boolean;
+}
+/**
+ * A set of utility functions to assist with the formatting a 'message' activity containing a list
+ * of choices.
+ *
+ */
+export declare class ChoiceFactory {
+    static readonly MAX_ACTION_TITLE_LENGTH = 20;
+    /**
+       * Returns a 'message' activity containing a list of choices that has been automatically
+       * formatted based on the capabilities of a given channel.
+       *
+       * @param channelOrContext Channel ID or context object for the current turn of conversation.
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to use when rendering as a list.
+       * @returns The created message activity.
+       */
+    static forChannel(channelOrContext: string | TurnContext, choices: (string | Choice)[], text?: string, speak?: string, options?: ChoiceFactoryOptions): Activity;
+    /**
+       * Returns a 'message' activity containing a list of choices that has been formatted as an
+       * inline list.
+       *
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to tweak rendering of list.
+       * @returns The created message activity.
+       */
+    static inline(choices: (string | Choice)[], text?: string, speak?: string, options?: ChoiceFactoryOptions): Activity;
+    /**
+       * Returns a 'message' activity containing a list of choices that has been formatted as an
+       * numbered or bulleted list.
+       *
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to tweak rendering of list.
+       * @returns The created message activity.
+       */
+    static list(choices: (string | Choice)[], text?: string, speak?: string, options?: ChoiceFactoryOptions): Activity;
+    /**
+       * Takes a mixed list of `string` and `Choice` based choices and returns them as a `Choice[]`.
+       *
+       * @param choices List of choices to add.
+       * @returns A list of choices.
+       */
+    static toChoices(choices: (string | Choice)[] | undefined): Choice[];
+}

package/dist/src/choices/choiceFactory.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChoiceFactory = void 0;
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+/**
+ * A set of utility functions to assist with the formatting a 'message' activity containing a list
+ * of choices.
+ *
+ */
+class ChoiceFactory {
+    /**
+       * Returns a 'message' activity containing a list of choices that has been automatically
+       * formatted based on the capabilities of a given channel.
+       *
+       * @param channelOrContext Channel ID or context object for the current turn of conversation.
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to use when rendering as a list.
+       * @returns The created message activity.
+       */
+    static forChannel(channelOrContext, choices, text, speak, options) {
+        const list = ChoiceFactory.toChoices(choices);
+        let maxTitleLength = 0;
+        list.forEach((choice) => {
+            const l = choice.action && choice.action.title ? choice.action.title.length : choice.value.length;
+            if (l > maxTitleLength) {
+                maxTitleLength = l;
+            }
+        });
+        const longTitles = maxTitleLength > this.MAX_ACTION_TITLE_LENGTH;
+        if (!longTitles && choices.length <= 3) {
+            // If the titles are short and there are 3 or less choices we'll use an inline list.
+            return ChoiceFactory.inline(list, text, speak, options);
+        }
+        else {
+            return ChoiceFactory.list(list, text, speak, options);
+        }
+    }
+    /**
+       * Returns a 'message' activity containing a list of choices that has been formatted as an
+       * inline list.
+       *
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to tweak rendering of list.
+       * @returns The created message activity.
+       */
+    static inline(choices, text, speak, options) {
+        const opt = {
+            inlineSeparator: ', ',
+            inlineOr: ' or ',
+            inlineOrMore: ', or ',
+            includeNumbers: true,
+            ...options,
+        };
+        let connector = '';
+        let txt = text || '';
+        txt += ' ';
+        ChoiceFactory.toChoices(choices).forEach((choice, index) => {
+            const title = choice.action && choice.action.title ? choice.action.title : choice.value;
+            txt += `${connector}${opt.includeNumbers ? '(' + (index + 1).toString() + ') ' : ''}${title}`;
+            if (index === choices.length - 2) {
+                connector = (index === 0 ? opt.inlineOr : opt.inlineOrMore) || '';
+            }
+            else {
+                connector = opt.inlineSeparator || '';
+            }
+        });
+        txt += '';
+        return agents_hosting_1.MessageFactory.text(txt, speak, agents_hosting_1.InputHints.ExpectingInput);
+    }
+    /**
+       * Returns a 'message' activity containing a list of choices that has been formatted as an
+       * numbered or bulleted list.
+       *
+       * @param choices List of choices to render.
+       * @param text (Optional) text of the message.
+       * @param speak (Optional) SSML to speak for the message.
+       * @param options (Optional) formatting options to tweak rendering of list.
+       * @returns The created message activity.
+       */
+    static list(choices, text, speak, options) {
+        const opt = {
+            includeNumbers: true,
+            ...options,
+        };
+        let connector = '';
+        let txt = text || '';
+        txt += '\n\n   ';
+        ChoiceFactory.toChoices(choices).forEach((choice, index) => {
+            const title = choice.action && choice.action.title ? choice.action.title : choice.value;
+            txt += `${connector}${opt.includeNumbers ? (index + 1).toString() + '. ' : '- '}${title}`;
+            connector = '\n   ';
+        });
+        return agents_hosting_1.MessageFactory.text(txt, speak, agents_hosting_1.InputHints.ExpectingInput);
+    }
+    /**
+       * Takes a mixed list of `string` and `Choice` based choices and returns them as a `Choice[]`.
+       *
+       * @param choices List of choices to add.
+       * @returns A list of choices.
+       */
+    static toChoices(choices) {
+        return (choices || [])
+            .map((choice) => (typeof choice === 'string' ? { value: choice } : choice))
+            .map((choice) => {
+            const action = choice.action;
+            if (action) {
+                action.type = action.type ? action.type : agents_hosting_1.ActionTypes.ImBack;
+                if (!action.value && action.title) {
+                    action.value = action.title;
+                }
+                else if (!action.title && action.value) {
+                    action.title = action.value;
+                }
+                else if (!action.title && !action.value) {
+                    action.title = action.value = choice.value;
+                }
+            }
+            return choice;
+        })
+            .filter((choice) => choice);
+    }
+}
+exports.ChoiceFactory = ChoiceFactory;
+ChoiceFactory.MAX_ACTION_TITLE_LENGTH = 20;
+//# sourceMappingURL=choiceFactory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"choiceFactory.js","sourceRoot":"","sources":["../../../src/choices/choiceFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,8DAMkC;AAiClC;;;;GAIG;AACH,MAAa,aAAa;IAGxB;;;;;;;;;;SAUK;IACL,MAAM,CAAC,UAAU,CACf,gBAAsC,EACtC,OAA4B,EAC5B,IAAa,EACb,KAAc,EACd,OAA8B;QAE9B,MAAM,IAAI,GAAa,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAEvD,IAAI,cAAc,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YAC9B,MAAM,CAAC,GAAW,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAA;YACzG,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC;gBACvB,cAAc,GAAG,CAAC,CAAA;YACpB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAY,cAAc,GAAG,IAAI,CAAC,uBAAuB,CAAA;QACzE,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvC,oFAAoF;YACpF,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QACvD,CAAC;IACH,CAAC;IAED;;;;;;;;;SASK;IACL,MAAM,CAAC,MAAM,CACX,OAA4B,EAC5B,IAAa,EACb,KAAc,EACd,OAA8B;QAE9B,MAAM,GAAG,GAAyB;YAChC,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,YAAY,EAAE,OAAO;YACrB,cAAc,EAAE,IAAI;YACpB,GAAG,OAAO;SACa,CAAA;QAEzB,IAAI,SAAS,GAAG,EAAE,CAAA;QAClB,IAAI,GAAG,GAAW,IAAI,IAAI,EAAE,CAAA;QAC5B,GAAG,IAAI,GAAG,CAAA;QACV,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAW,EAAE,KAAa,EAAE,EAAE;YACtE,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAA;YAC/F,GAAG,IAAI,GAAG,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,CAAA;YAC7F,IAAI,KAAK,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjC,SAAS,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAA;YACnE,CAAC;iBAAM,CAAC;gBACN,SAAS,GAAG,GAAG,CAAC,eAAe,IAAI,EAAE,CAAA;YACvC,CAAC;QACH,CAAC,CAAC,CAAA;QACF,GAAG,IAAI,EAAE,CAAA;QAET,OAAO,+BAAc,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;SASK;IACL,MAAM,CAAC,IAAI,CACT,OAA4B,EAC5B,IAAa,EACb,KAAc,EACd,OAA8B;QAE9B,MAAM,GAAG,GAAyB;YAChC,cAAc,EAAE,IAAI;YACpB,GAAG,OAAO;SACa,CAAA;QAEzB,IAAI,SAAS,GAAG,EAAE,CAAA;QAClB,IAAI,GAAG,GAAW,IAAI,IAAI,EAAE,CAAA;QAC5B,GAAG,IAAI,SAAS,CAAA;QAChB,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAW,EAAE,KAAa,EAAE,EAAE;YACtE,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAA;YAC/F,GAAG,IAAI,GAAG,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,EAAE,CAAA;YACzF,SAAS,GAAG,OAAO,CAAA;QACrB,CAAC,CAAC,CAAA;QAEF,OAAO,+BAAc,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,2BAAU,CAAC,cAAc,CAAC,CAAA;IACnE,CAAC;IAED;;;;;SAKK;IACL,MAAM,CAAC,SAAS,CAAE,OAAwC;QACxD,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;aACnB,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;aAC1E,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE;YACtB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAC5B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,4BAAW,CAAC,MAAM,CAAA;gBAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBAClC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;gBAC7B,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACzC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;gBAC7B,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC1C,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;gBAC5C,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;;AA1IH,sCA2IC;AA1IiB,qCAAuB,GAAG,EAAE,CAAA"}

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

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FindValuesOptions } from './findValues';
+import { ModelResult } from './modelResult';
+import { Choice } from './choice';
+export interface FindChoicesOptions extends FindValuesOptions {
+    noValue?: boolean;
+    noAction?: boolean;
+    recognizeNumbers?: boolean;
+    recognizeOrdinals?: boolean;
+}
+export interface FoundChoice {
+    value: string;
+    index: number;
+    score: number;
+    synonym?: string;
+}
+/**
+ * Mid-level search function for recognizing a choice in an 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 findChoices(utterance: string, choices: (string | Choice)[], options?: FindChoicesOptions): ModelResult<FoundChoice>[];

package/dist/src/choices/findChoices.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findChoices = findChoices;
+const findValues_1 = require("./findValues");
+/**
+ * Mid-level search function for recognizing a choice in an 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 findChoices(utterance, choices, options) {
+    const opt = options || {};
+    const list = (choices || []).map((choice) => typeof choice === 'string' ? { value: choice } : choice);
+    const synonyms = [];
+    list.forEach((choice, index) => {
+        if (!opt.noValue) {
+            synonyms.push({ value: choice.value, index });
+        }
+        if (choice.action && choice.action.title && !opt.noAction) {
+            synonyms.push({ value: choice.action.title, index });
+        }
+        (choice.synonyms || []).forEach((synonym) => synonyms.push({ value: synonym, index }));
+    });
+    return (0, findValues_1.findValues)(utterance, synonyms, options).map((v) => {
+        const choice = list[v.resolution.index];
+        return {
+            start: v.start,
+            end: v.end,
+            typeName: 'choice',
+            text: v.text,
+            resolution: {
+                value: choice.value,
+                index: v.resolution.index,
+                score: v.resolution.score,
+                synonym: v.resolution.value,
+            },
+        };
+    });
+}
+//# sourceMappingURL=findChoices.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"findChoices.js","sourceRoot":"","sources":["../../../src/choices/findChoices.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AA4BH,kCAsCC;AAhED,6CAAqF;AAkBrF;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,SAAiB,EACjB,OAA4B,EAC5B,OAA4B;IAE5B,MAAM,GAAG,GAAuB,OAAO,IAAI,EAAE,CAAA;IAE7C,MAAM,IAAI,GAAa,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACpD,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CACxD,CAAA;IAED,MAAM,QAAQ,GAAkB,EAAE,CAAA;IAClC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,KAAa,EAAE,EAAE;QAC7C,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC1D,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QACtD,CAAC;QACD,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IAChG,CAAC,CAAC,CAAA;IAEF,OAAO,IAAA,uBAAU,EAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAA0B,EAAE,EAAE;QACjF,MAAM,MAAM,GAAW,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAE/C,OAAO;YACL,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,GAAG,EAAE,CAAC,CAAC,GAAG;YACV,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,UAAU,EAAE;gBACV,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK;gBACzB,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK;gBACzB,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK;aAC5B;SAC0B,CAAA;IAC/B,CAAC,CAAC,CAAA;AACJ,CAAC"}

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

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ModelResult } from './modelResult';
+import { TokenizerFunction } from './tokenizer';
+/**
+ * Basic search options used to control how choices are recognized in a users utterance.
+ */
+export interface FindValuesOptions {
+    allowPartialMatches?: boolean;
+    locale?: string;
+    maxTokenDistance?: number;
+    tokenizer?: TokenizerFunction;
+}
+export interface FoundValue {
+    value: string;
+    index: number;
+    score: number;
+}
+export interface SortedValue {
+    value: string;
+    index: number;
+}
+/**
+ * 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.
+ */
+export declare function findValues(utterance: string, values: SortedValue[], options?: FindValuesOptions): ModelResult<FoundValue>[];