@nlxai/core 1.2.4-alpha.9 → 1.2.6

package/lib/index.d.ts

@@ -30,15 +30,14 @@ export interface Config {
      * Channel key.
      */
     channelKey?: string;
+    /**
+     * API key.
+     */
+    apiKey?: string;
     /**
      * Headers to forward to the NLX API.
      */
-    headers: Record<string, string> & {
-        /**
-         * The `nlx-api-key` is required. Fetch this from the application's API channel tab.
-         */
-        "nlx-api-key": string;
-    };
+    headers?: Record<string, string>;
     /**
      * Set `conversationId` to continue an existing conversation. If not set, a new conversation will be started (and a new conversationId will be generated internally).
      */
@@ -106,7 +105,7 @@ export interface ConversationHandler {
      */
     sendSlots: (slots: SlotsRecordOrArray, context?: Context) => void;
     /**
-     * Respond to [a choice](https://docs.studio.nlx.ai/intentflows/documentation-flows/flows-build-mode/nodes#user-choice) from the application.
+     * Respond to [a choice](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/nodes#user-choice) from the application.
      * @param choiceId - The `choiceId` is in the {@link ApplicationResponse}'s `.payload.messages[].choices[].choiceId` fields
      * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/build-with-nlx/flows/context-variables#what-are-context-variables) for usage later in the flow.
      * @param metadata - links the choice to the specific message and node in the conversation.
@@ -126,8 +125,8 @@ export interface ConversationHandler {
     sendWelcomeIntent: (context?: Context) => void;
     /**
      * Trigger a specific flow.
-     * @param flowId - the flow to trigger. The id is the name under the application's _Intents_.
-     * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/build-with-nlx/flows/context-variables#what-are-context-variables) for usage later in the intent.
+     * @param flowId - the flow to trigger. The id is the name under the application's _Flows_.
+     * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/build-with-nlx/flows/context-variables#what-are-context-variables) for usage later in the flow.
      */
     sendFlow: (flowId: string, context?: Context) => void;
     /**
@@ -140,7 +139,7 @@ export interface ConversationHandler {
     sendIntent: (intentId: string, context?: Context) => void;
     /**
      * Send context without sending a message
-     * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/build-with-nlx/flows/context-variables#what-are-context-variables) for usage later in the intent.
+     * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/build-with-nlx/flows/context-variables#what-are-context-variables) for usage later in the flow.
      */
     sendContext: (context: Context) => Promise<void>;
     /**
@@ -164,9 +163,9 @@ export interface ConversationHandler {
         receivedAt?: Time;
     })) => void;
     /**
-     * Send a combination of choice, slots, and intent in one request.
+     * Send a combination of choice, slots, and flow in one request.
      * @param request -
-     * @param context - [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
+     * @param context - [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
      */
     sendStructured: (request: StructuredRequest, context?: Context) => void;
     /**
@@ -238,11 +237,11 @@ export interface ConversationHandler {
     sendVoicePlusContext: (context: VoicePlusContext) => void;
 }
 /**
- * [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
+ * [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
  */
 export type Context = Record<string, any>;
 /**
- * Values to fill an intent's [attached slots](https://docs.studio.nlx.ai/intents/documentation-intents/intents-attached-slots).
+ * Values to fill an flow's [attached slots](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup#attached-slots).
  *
  * An array of `SlotValue` objects is equivalent to a {@link SlotsRecord}.
  */
@@ -252,7 +251,7 @@ export interface SlotValue {
      */
     slotId: string;
     /**
-     * Usually this will be a discrete value matching the slots's [type](https://docs.studio.nlx.ai/slots/documentation-slots/slots-values#system-slots).
+     * Usually this will be a discrete value matching the slots's [type](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup#custom-vs-built-in-slots).
      * for custom slots, this can optionally be the value's ID.
      */
     value: any;
@@ -261,6 +260,10 @@ export interface SlotValue {
  * The protocol used to communicate with the application
  */
 export declare enum Protocol {
+    /**
+     * Supported for development purposes only
+     */
+    Http = "http",
     /**
      * Regular encrypted HTTPS, without support for post-escalation message handling, interim messages and other streaming features.
      */
@@ -292,18 +295,18 @@ export declare enum ResponseType {
     Failure = "failure"
 }
 /**
- * Values to fill an intent's [attached slots](https://docs.studio.nlx.ai/intents/documentation-intents/intents-attached-slots).
+ * Values to fill an flow's [attached slots](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup#attached-slots).
  *
  * `SlotRecord` Keys are the attached slot's name
  *
- * `SlotRecord` Values are usually a discrete value matching the slots's [type](https://docs.studio.nlx.ai/slots/documentation-slots/slots-values#system-slots).
+ * `SlotRecord` Values are usually a discrete value matching the slots's [type](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup#custom-vs-built-in-slots).
  * for custom slots, this can optionally be the value's ID.
  *
  * A `SlotsRecord` is equivalent to an array of {@link SlotValue} objects.
  */
 export type SlotsRecord = Record<string, any>;
 /**
- * Values to fill an intent's [attached slots](https://docs.studio.nlx.ai/intents/documentation-intents/intents-attached-slots).
+ * Values to fill an flow's [attached slots](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup#attached-slots).
  *
  * Supports either a {@link SlotsRecord} or an array of {@link SlotValue} objects
  */
@@ -352,7 +355,7 @@ export interface ApplicationResponsePayload {
      */
     metadata?: ApplicationResponseMetadata;
     /**
-     * If configured, the [node's payload.](See: https://docs.studio.nlx.ai/intentflows/documentation-flows/flows-build-mode/advanced-messaging-+-functionality#add-functionality)
+     * If configured, the [node's payload](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/nodes#node-payload).
      */
     payload?: string;
     /**
@@ -374,7 +377,7 @@ export type ModalityPayloads = Record<string, any>;
  */
 export interface ApplicationResponseMetadata {
     /**
-     * The conversation's intent
+     * The conversation's flow ID (called `intentId` here for legacy reasons).
      */
     intentId?: string;
     /**
@@ -443,7 +446,7 @@ export interface KnowledgeBaseResponseSource {
  */
 export interface ApplicationMessageMetadata {
     /**
-     * The message node's intent
+     * The message node's flow ID (called `intentId` here for legacy reasons).
      */
     intentId?: string;
 }
@@ -544,7 +547,7 @@ export type UserResponsePayload = {
      */
     text: string;
     /**
-     * [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
+     * [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
      */
     context?: Context;
 } | {
@@ -558,7 +561,7 @@ export type UserResponsePayload = {
      */
     choiceId: string;
     /**
-     * [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
+     * [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
      */
     context?: Context;
 } | ({
@@ -567,7 +570,7 @@ export type UserResponsePayload = {
      */
     type: "structured";
     /**
-     * [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
+     * [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
      */
     context?: Context;
 } & StructuredRequest);
@@ -653,7 +656,7 @@ export interface BinaryFeedbackConfig {
 export type Environment = "production" | "development";
 /**
  * The body of `sendStructured`
- * Includes a combination of choice, slots, and intent in one request.
+ * Includes a combination of choice, slots, and flow in one request.
  */
 export interface StructuredRequest {
     /**
@@ -784,9 +787,14 @@ export interface ChoiceRequestMetadata {
      */
     nodeId?: string;
     /**
-     * Intent ID, used for sending to the NLU to allow it to double-check
+     * Intent ID, used for sending to the NLU to allow it to double-check.
+     * @deprecated use `flowId` instead.
      */
     intentId?: string;
+    /**
+     * Flow ID, used for sending to the NLU to allow it to double-check.
+     */
+    flowId?: string;
 }
 /**
  * Language code named for clarity, may restrict it to a finite list

package/lib/index.esm.js

@@ -4,14 +4,14 @@ import ReconnectingWebSocket from 'reconnecting-websocket';
 import { v4 } from 'uuid';
 
 var name = "@nlxai/core";
-var version$1 = "1.2.4-alpha.9";
+var version$1 = "1.2.6";
 var description = "Low-level SDK for building NLX experiences";
 var type = "module";
 var main = "lib/index.cjs";
-var module = "lib/index.esm.js";
+var module$1 = "lib/index.esm.js";
 var browser = "lib/index.umd.js";
 var types = "lib/index.d.ts";
-var exports = {
+var exports$1 = {
 	".": {
 		types: "./lib/index.d.ts",
 		"import": "./lib/index.esm.js",
@@ -32,20 +32,20 @@ var scripts = {
 var author = "Peter Szerzo <peter@nlx.ai>";
 var license = "MIT";
 var devDependencies = {
+	"@nlxai/eslint-config": "*",
+	"@nlxai/rollup-config": "*",
 	"@rollup/plugin-commonjs": "^25.0.7",
-	"@rollup/plugin-json": "^6.0.1",
+	"@rollup/plugin-json": "^6.1.0",
 	"@rollup/plugin-node-resolve": "^15.2.3",
 	"@rollup/plugin-replace": "^5.0.5",
 	"@rollup/plugin-terser": "^0.4.4",
-	"@rollup/plugin-typescript": "^11.1.5",
+	"@rollup/plugin-typescript": "^11.1.6",
 	"@types/isomorphic-fetch": "^0.0.39",
 	"@types/node": "^24.10.1",
 	"@types/ramda": "0.31.1",
 	"@types/uuid": "^9.0.7",
-	"eslint-config-nlx": "*",
 	prettier: "^3.1.0",
-	rollup: "^4.3.0",
-	"rollup-config-nlx": "*",
+	rollup: "^4.59.0",
 	"rollup-plugin-node-polyfills": "^0.2.1",
 	typedoc: "^0.28.14",
 	"typedoc-plugin-markdown": "^4.9.0",
@@ -60,17 +60,17 @@ var dependencies = {
 var publishConfig = {
 	access: "public"
 };
-var gitHead = "a749667b96b11c1d187e9f0447abb2ebc755094c";
+var gitHead = "fb9a0b00ca2184fb69ffd1e11e8f55d30fe1d85e";
 var packageJson = {
 	name: name,
 	version: version$1,
 	description: description,
 	type: type,
 	main: main,
-	module: module,
+	module: module$1,
 	browser: browser,
 	types: types,
-	exports: exports,
+	exports: exports$1,
 	scripts: scripts,
 	author: author,
 	license: license,
@@ -91,6 +91,10 @@ const Console = console;
  */
 var Protocol;
 (function (Protocol) {
+    /**
+     * Supported for development purposes only
+     */
+    Protocol["Http"] = "http";
     /**
      * Regular encrypted HTTPS, without support for post-escalation message handling, interim messages and other streaming features.
      */
@@ -150,48 +154,82 @@ const safeJsonParse = (val) => {
         return null;
     }
 };
-const getBaseDomain = (url) => url.match(/(bots\.dev\.studio\.nlx\.ai|bots\.studio\.nlx\.ai|apps\.nlx\.ai|dev\.apps\.nlx\.ai)/g)?.[0] ?? "apps.nlx.ai";
+const getHost = (url) => url.match(/(bots\.dev\.studio\.nlx\.ai|bots\.studio\.nlx\.ai|apps\.nlx\.ai|dev\.apps\.nlx\.ai)/g)?.[0] ?? "apps.nlx.ai";
 /**
- * When a HTTP URL is provided, deduce the websocket URL. Otherwise, return the argument.
- * @param applicationUrl - the websocket URL
- * @returns httpUrl - the HTTP URL
+ * Parse configuration into structured connection information, taking into account `applicationUrl`-based configs.
+ * @param config - client configuration.
+ * @returns connection - connection information, or `null` if the configuration is invalid.
  */
-const normalizeToWebsocket = (applicationUrl) => {
+const parseConnection = (config) => {
+    const applicationUrl = config.applicationUrl ?? "";
+    const apiKey = config.apiKey ?? config.headers?.["nlx-api-key"] ?? "";
+    const protocol = config.protocol ??
+        /**
+         * Backwards-compatibility: if a websocket URL was specified, assume it's websocket. Otherwise, look at the legacy experimental streamsetting
+         * and only assume non-streaming if it's explicitly set to false.
+         */
+        (isWebsocketUrl(applicationUrl)
+            ? Protocol.Websocket
+            : config.experimental?.streamHttp === false
+                ? Protocol.Https
+                : Protocol.HttpsWithStreaming);
+    if (config.host != null &&
+        config.channelKey != null &&
+        config.deploymentKey != null) {
+        return {
+            protocol,
+            apiKey,
+            host: config.host,
+            channelKey: config.channelKey,
+            deploymentKey: config.deploymentKey,
+        };
+    }
+    // `applicationUrl`-based definition: websocket case
     if (isWebsocketUrl(applicationUrl)) {
-        return applicationUrl;
+        const host = getHost(applicationUrl);
+        const url = new URL(applicationUrl);
+        const params = new URLSearchParams(url.search);
+        const channelKey = params.get("channelKey");
+        const deploymentKey = params.get("deploymentKey");
+        if (channelKey != null && deploymentKey != null) {
+            return { protocol, channelKey, deploymentKey, host, apiKey };
+        }
+        return null;
     }
-    const base = getBaseDomain(applicationUrl);
-    const url = new URL(applicationUrl);
-    const pathChunks = url.pathname.split("/");
-    const deploymentKey = pathChunks[2];
-    const channelKey = pathChunks[3];
-    return `wss://us-east-1-ws.${base}?deploymentKey=${deploymentKey}&channelKey=${channelKey}`;
-};
-/**
- * When a websocket URL is provided, deduce the HTTP URL. Otherwise, return the argument.
- * @param applicationUrl - the websocket URL
- * @returns httpUrl - the HTTP URL
- */
-const normalizeToHttp = (applicationUrl) => {
-    if (!isWebsocketUrl(applicationUrl)) {
-        return applicationUrl;
+    // `applicationUrl`-based definition: http case
+    const urlObject = new URL(applicationUrl);
+    const host = urlObject.host;
+    const parseResult = new URLPattern({
+        pathname: "/c/:deploymentKey/:channelKey",
+    }).exec(applicationUrl);
+    if (parseResult?.pathname.groups.channelKey != null &&
+        parseResult?.pathname.groups.deploymentKey != null) {
+        return {
+            protocol: urlObject.protocol === "http:" ? Protocol.Http : protocol,
+            channelKey: parseResult.pathname.groups.channelKey,
+            deploymentKey: parseResult.pathname.groups.deploymentKey,
+            host,
+            apiKey,
+        };
     }
-    const base = getBaseDomain(applicationUrl);
-    const url = new URL(applicationUrl);
-    const params = new URLSearchParams(url.search);
-    const channelKey = params.get("channelKey");
-    const deploymentKey = params.get("deploymentKey");
-    return `https://${base}/c/${deploymentKey}/${channelKey}`;
+    return null;
+};
+const toWebsocketUrl = (connection) => {
+    return `wss://us-east-1-ws.${connection.host}?deploymentKey=${connection.deploymentKey}&channelKey=${connection.channelKey}&apiKey=${connection.apiKey}`;
+};
+const toHttpUrl = (connection) => {
+    return `${connection.protocol === Protocol.Http ? "http" : "https"}://${connection.host}/c/${connection.deploymentKey}/${connection.channelKey}`;
 };
 const isWebsocketUrl = (url) => {
     return url.indexOf("wss://") === 0;
 };
-const fetchUserMessage = async ({ fullApplicationUrl, headers, body, stream, eventListeners, }) => {
+const fetchUserMessage = async ({ fullApplicationUrl, apiKey, headers, body, stream, eventListeners, }) => {
     const streamRequest = async (body) => {
         const response = await fetch(fullApplicationUrl, {
             method: "POST",
             headers: {
                 ...headers,
+                "nlx-api-key": apiKey,
                 "Content-Type": "application/json",
                 // Legacy header
                 "nlx-sdk-version": packageJson.version,
@@ -277,6 +315,7 @@ const fetchUserMessage = async ({ fullApplicationUrl, headers, body, stream, eve
             method: "POST",
             headers: {
                 ...(headers ?? {}),
+                "nlx-api-key": apiKey,
                 Accept: "application/json",
                 "Content-Type": "application/json",
                 // Legacy header
@@ -316,31 +355,13 @@ function createConversation(configuration) {
     let voicePlusSocket;
     let voicePlusSocketMessageQueue = [];
     let voicePlusSocketMessageQueueCheckInterval = null;
-    const protocol = configuration.protocol ??
-        /**
-         * Backwards-compatibility: if a websocket URL was specified, assume it's websocket. Otherwise, look at the legacy experimental streamsetting
-         * and only assume non-streaming if it's explicitly set to false.
-         */
-        (isWebsocketUrl(configuration.applicationUrl ?? "")
-            ? Protocol.Websocket
-            : configuration.experimental?.streamHttp === false
-                ? Protocol.Https
-                : Protocol.HttpsWithStreaming);
-    /**
-     * TODO: Instead of re-serializing the host/deploymentKey/channelKey combo and normalizing them again into various socket and HTTP URL's,
-     * parse them out of the `applicationUrl` if specified, and use them to build up the URL's in use. This way we avoid serializing and then
-     * parsing again.
-     */
-    const applicationUrl = (() => {
-        if (configuration.host != null &&
-            configuration.deploymentKey != null &&
-            configuration.channelKey != null) {
-            return `https://${configuration.host}/c/${configuration.deploymentKey}/${configuration.channelKey}`;
-        }
-        return configuration.applicationUrl ?? "";
-    })();
-    const websocketApplicationUrl = normalizeToWebsocket(applicationUrl);
-    const httpApplicationUrl = normalizeToHttp(applicationUrl);
+    const connection = parseConnection(configuration);
+    const websocketApplicationUrl = connection != null
+        ? toWebsocketUrl(connection)
+        : configuration.applicationUrl ?? "";
+    const httpApplicationUrl = connection != null
+        ? toHttpUrl(connection)
+        : configuration.applicationUrl ?? "";
     // Check if the application URL has a language code appended to it
     if (/[-|_][a-z]{2,}[-|_][A-Z]{2,}$/.test(httpApplicationUrl)) {
         Console.warn("Since v1.0.0, the language code is no longer added at the end of the application URL. Please remove the modifier (e.g. '-en-US') from the URL, and specify it in the `languageCode` parameter instead.");
@@ -450,7 +471,7 @@ function createConversation(configuration) {
             channelType: configuration.experimental?.channelType,
             environment: configuration.environment,
         };
-        if (protocol === Protocol.Websocket) {
+        if (connection?.protocol === Protocol.Websocket) {
             if (socket?.readyState === 1) {
                 socket.send(JSON.stringify(bodyWithContext));
             }
@@ -462,8 +483,9 @@ function createConversation(configuration) {
             try {
                 const json = await fetchUserMessage({
                     fullApplicationUrl: fullApplicationHttpUrl(),
+                    apiKey: connection?.apiKey ?? "",
                     headers: configuration.headers ?? {},
-                    stream: protocol === Protocol.HttpsWithStreaming,
+                    stream: connection?.protocol === Protocol.HttpsWithStreaming,
                     eventListeners,
                     body: bodyWithContext,
                 });
@@ -498,10 +520,6 @@ function createConversation(configuration) {
             url.searchParams.set("channelKey", `${url.searchParams.get("channelKey") ?? ""}-${state.languageCode}`);
         }
         url.searchParams.set("conversationId", state.conversationId);
-        const apiKey = configuration.headers["nlx-api-key"];
-        if (apiKey != null) {
-            url.searchParams.set("apiKey", apiKey);
-        }
         socket = new ReconnectingWebSocket(url.href);
         socketMessageQueueCheckInterval = setInterval(() => {
             void checkSocketQueue();
@@ -525,9 +543,8 @@ function createConversation(configuration) {
         }
         url.searchParams.set("conversationId", state.conversationId);
         url.searchParams.set("type", "voice-plus");
-        const apiKey = configuration.headers["nlx-api-key"];
-        if (apiKey != null) {
-            url.searchParams.set("apiKey", apiKey);
+        if (connection?.apiKey != null) {
+            url.searchParams.set("apiKey", connection.apiKey);
         }
         voicePlusSocket = new ReconnectingWebSocket(url.href);
         voicePlusSocketMessageQueueCheckInterval = setInterval(() => {
@@ -564,7 +581,7 @@ function createConversation(configuration) {
             voicePlusSocket = undefined;
         }
     };
-    if (protocol === Protocol.Websocket) {
+    if (connection?.protocol === Protocol.Websocket) {
         setupWebsocket();
     }
     setupCommandWebsocket();
@@ -647,7 +664,7 @@ function createConversation(configuration) {
             request: {
                 structured: {
                     nodeId: metadata?.nodeId,
-                    intentId: metadata?.intentId,
+                    intentId: metadata?.flowId ?? metadata?.intentId,
                     choiceId,
                 },
             },
@@ -670,6 +687,7 @@ function createConversation(configuration) {
                 method: "POST",
                 headers: {
                     ...(configuration.headers ?? {}),
+                    "nlx-api-key": connection?.apiKey ?? "",
                     Accept: "application/json",
                     "Content-Type": "application/json",
                     "nlx-conversation-id": state.conversationId,
@@ -755,7 +773,7 @@ function createConversation(configuration) {
                 Console.warn("Attempted to set language code to the one already active.");
                 return;
             }
-            if (protocol === Protocol.Websocket) {
+            if (connection?.protocol === Protocol.Websocket) {
                 setupWebsocket();
             }
             setupCommandWebsocket();
@@ -769,6 +787,7 @@ function createConversation(configuration) {
                 method: "POST",
                 headers: {
                     ...(configuration.headers ?? {}),
+                    "nlx-api-key": connection?.apiKey ?? "",
                     Accept: "application/json",
                     "Content-Type": "application/json",
                     "nlx-conversation-id": state.conversationId,
@@ -804,14 +823,14 @@ function createConversation(configuration) {
                 conversationId: v4(),
                 responses: options?.clearResponses === true ? [] : state.responses,
             });
-            if (protocol === Protocol.Websocket) {
+            if (connection?.protocol === Protocol.Websocket) {
                 setupWebsocket();
             }
             setupCommandWebsocket();
         },
         destroy: () => {
             subscribers = [];
-            if (protocol === Protocol.Websocket) {
+            if (connection?.protocol === Protocol.Websocket) {
                 teardownWebsocket();
             }
             teardownCommandWebsocket();
@@ -836,13 +855,7 @@ function createConversation(configuration) {
  * @returns Whether the configuration is valid?
  */
 const isConfigValid = (configuration) => {
-    if (configuration.host != null &&
-        configuration.deploymentKey != null &&
-        configuration.channelKey != null) {
-        return true;
-    }
-    const applicationUrl = configuration.applicationUrl ?? "";
-    return applicationUrl.length > 0;
+    return parseConnection(configuration) != null;
 };
 /**
  * Helper method to decide when a new {@link Config} requires creating a new {@link ConversationHandler} or whether the old `Config`'s