@nlxai/core 1.2.4 → 1.2.7-alpha.1

package/eslint.config.js

@@ -0,0 +1,5 @@
+import baseConfig from "@nlxai/eslint-config";
+import documentation from "@nlxai/eslint-config/documentation";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [...baseConfig, ...documentation];

package/lib/index.cjs

@@ -1,12 +1,11 @@
 'use strict';
 
-var fetch = require('isomorphic-fetch');
 var ramda = require('ramda');
 var ReconnectingWebSocket = require('reconnecting-websocket');
 var uuid = require('uuid');
 
 var name = "@nlxai/core";
-var version$1 = "1.2.4";
+var version$1 = "1.2.7-alpha.1";
 var description = "Low-level SDK for building NLX experiences";
 var type = "module";
 var main = "lib/index.cjs";
@@ -22,8 +21,8 @@ var exports$1 = {
 };
 var scripts = {
 	build: "rm -rf lib && rollup -c --configPlugin typescript --configImportAttributesKey with",
-	"lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0 && markdown-link-check README.md",
-	lint: "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
+	"lint:check": "eslint src/",
+	lint: "eslint src/ --fix",
 	prepublish: "npm run build",
 	test: "typedoc --emit none",
 	tsc: "tsc",
@@ -34,36 +33,31 @@ var scripts = {
 var author = "Peter Szerzo <peter@nlx.ai>";
 var license = "MIT";
 var devDependencies = {
-	"@boillodmanuel/markdown-link-check": "^4.7.0",
+	"@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",
-	"@types/isomorphic-fetch": "^0.0.39",
+	"@rollup/plugin-typescript": "^11.1.6",
 	"@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-plugin-node-polyfills": "^0.2.1",
+	rollup: "^4.59.0",
 	typedoc: "^0.28.14",
 	"typedoc-plugin-markdown": "^4.9.0",
 	typescript: "^5.5.4"
 };
 var dependencies = {
-	"isomorphic-fetch": "^3.0.0",
 	ramda: "^0.32.0",
 	"reconnecting-websocket": "^4.4.0",
-	uuid: "^9.0.1"
+	uuid: "^14.0.0"
 };
 var publishConfig = {
 	access: "public"
 };
-var gitHead = "bbfa1fad3f009a0f509903d6db4f51bec17b1f6c";
+var gitHead = "548c2c6c876cf86572aeb63a6810ed87c9b0382a";
 var packageJson = {
 	name: name,
 	version: version$1,
@@ -94,6 +88,10 @@ const Console = console;
  */
 exports.Protocol = void 0;
 (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.
      */
@@ -196,14 +194,15 @@ const parseConnection = (config) => {
         return null;
     }
     // `applicationUrl`-based definition: http case
-    const host = getHost(applicationUrl);
+    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,
+            protocol: urlObject.protocol === "http:" ? exports.Protocol.Http : protocol,
             channelKey: parseResult.pathname.groups.channelKey,
             deploymentKey: parseResult.pathname.groups.deploymentKey,
             host,
@@ -216,13 +215,16 @@ const toWebsocketUrl = (connection) => {
     return `wss://us-east-1-ws.${connection.host}?deploymentKey=${connection.deploymentKey}&channelKey=${connection.channelKey}&apiKey=${connection.apiKey}`;
 };
 const toHttpUrl = (connection) => {
-    return `https://${connection.host}/c/${connection.deploymentKey}/${connection.channelKey}`;
+    return `${connection.protocol === exports.Protocol.Http ? "http" : "https"}://${connection.host}/c/${connection.deploymentKey}/${connection.channelKey}`;
 };
 const isWebsocketUrl = (url) => {
     return url.indexOf("wss://") === 0;
 };
 const fetchUserMessage = async ({ fullApplicationUrl, apiKey, headers, body, stream, eventListeners, }) => {
     const streamRequest = async (body) => {
+        eventListeners.interimMessage.forEach((listener) => {
+            listener("Thinking...");
+        });
         const response = await fetch(fullApplicationUrl, {
             method: "POST",
             headers: {
@@ -280,7 +282,7 @@ const fetchUserMessage = async ({ fullApplicationUrl, apiKey, headers, body, str
                             foundObject = true;
                             break;
                         }
-                        catch (e) {
+                        catch (_e) {
                             /* keep scanning */
                         }
                     }
@@ -354,16 +356,28 @@ function createConversation(configuration) {
     let voicePlusSocketMessageQueue = [];
     let voicePlusSocketMessageQueueCheckInterval = null;
     const connection = parseConnection(configuration);
-    const websocketApplicationUrl = connection != null
-        ? toWebsocketUrl(connection)
-        : configuration.applicationUrl ?? "";
-    const httpApplicationUrl = connection != null
-        ? toHttpUrl(connection)
-        : configuration.applicationUrl ?? "";
+    const complete = configuration.experimental?.completeApplicationUrl === true;
+    const websocketApplicationUrl = complete && isWebsocketUrl(configuration.applicationUrl ?? "")
+        ? (configuration.applicationUrl ?? "")
+        : connection != null
+            ? toWebsocketUrl(connection)
+            : (configuration.applicationUrl ?? "");
+    const httpApplicationUrl = complete && !isWebsocketUrl(configuration.applicationUrl ?? "")
+        ? (configuration.applicationUrl ?? "")
+        : 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.");
     }
+    const protocol = connection != null
+        ? connection.protocol
+        : isWebsocketUrl(configuration.applicationUrl ?? "")
+            ? exports.Protocol.Websocket
+            : configuration.experimental?.streamHttp === false
+                ? exports.Protocol.Https
+                : exports.Protocol.HttpsWithStreaming;
     const eventListeners = {
         voicePlusCommand: [],
         interimMessage: [],
@@ -375,9 +389,7 @@ function createConversation(configuration) {
         userId: configuration.userId,
         conversationId: initialConversationId,
     };
-    const fullApplicationHttpUrl = () => `${httpApplicationUrl}${configuration.experimental?.completeApplicationUrl === true
-        ? ""
-        : `-${state.languageCode}`}`;
+    const fullApplicationHttpUrl = () => `${httpApplicationUrl}${complete ? "" : `-${state.languageCode}`}`;
     const setState = (change, 
     // Optionally send the response that causes the current state change, to be sent to subscribers
     newResponse) => {
@@ -446,6 +458,11 @@ function createConversation(configuration) {
             voicePlusSocketMessageQueue = [...voicePlusSocketMessageQueue, message];
         }
     };
+    const setInterimMessage = (message) => {
+        eventListeners.interimMessage.forEach((listener) => {
+            listener(message);
+        });
+    };
     const sendToApplication = async (body) => {
         if (requestOverride != null) {
             requestOverride(body, (payload) => {
@@ -469,7 +486,7 @@ function createConversation(configuration) {
             channelType: configuration.experimental?.channelType,
             environment: configuration.environment,
         };
-        if (connection?.protocol === exports.Protocol.Websocket) {
+        if (protocol === exports.Protocol.Websocket) {
             if (socket?.readyState === 1) {
                 socket.send(JSON.stringify(bodyWithContext));
             }
@@ -483,7 +500,7 @@ function createConversation(configuration) {
                     fullApplicationUrl: fullApplicationHttpUrl(),
                     apiKey: connection?.apiKey ?? "",
                     headers: configuration.headers ?? {},
-                    stream: connection?.protocol === exports.Protocol.HttpsWithStreaming,
+                    stream: protocol === exports.Protocol.HttpsWithStreaming,
                     eventListeners,
                     body: bodyWithContext,
                 });
@@ -579,7 +596,7 @@ function createConversation(configuration) {
             voicePlusSocket = undefined;
         }
     };
-    if (connection?.protocol === exports.Protocol.Websocket) {
+    if (protocol === exports.Protocol.Websocket) {
         setupWebsocket();
     }
     setupCommandWebsocket();
@@ -713,6 +730,7 @@ function createConversation(configuration) {
                 responses: [...state.responses, newResponseWithTimestamp],
             }, newResponseWithTimestamp);
         },
+        setInterimMessage,
         sendStructured: (structured, context) => {
             appendStructuredUserResponse(structured, context);
             void sendToApplication({

package/lib/index.d.ts

@@ -235,6 +235,11 @@ export interface ConversationHandler {
      * @internal
      */
     sendVoicePlusContext: (context: VoicePlusContext) => void;
+    /**
+     * Set interim message. Setting `undefined` clears the current interim message.
+     * @param message - interim message.
+     */
+    setInterimMessage: (message?: string) => void;
 }
 /**
  * [Context](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables) for usage later in the flow.
@@ -260,6 +265,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.
      */

package/lib/index.esm.js

@@ -1,17 +1,16 @@
-import fetch from 'isomorphic-fetch';
 import { equals, adjust } from 'ramda';
 import ReconnectingWebSocket from 'reconnecting-websocket';
 import { v4 } from 'uuid';
 
 var name = "@nlxai/core";
-var version$1 = "1.2.4";
+var version$1 = "1.2.7-alpha.1";
 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",
@@ -20,8 +19,8 @@ var exports = {
 };
 var scripts = {
 	build: "rm -rf lib && rollup -c --configPlugin typescript --configImportAttributesKey with",
-	"lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0 && markdown-link-check README.md",
-	lint: "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
+	"lint:check": "eslint src/",
+	lint: "eslint src/ --fix",
 	prepublish: "npm run build",
 	test: "typedoc --emit none",
 	tsc: "tsc",
@@ -32,46 +31,41 @@ var scripts = {
 var author = "Peter Szerzo <peter@nlx.ai>";
 var license = "MIT";
 var devDependencies = {
-	"@boillodmanuel/markdown-link-check": "^4.7.0",
+	"@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",
-	"@types/isomorphic-fetch": "^0.0.39",
+	"@rollup/plugin-typescript": "^11.1.6",
 	"@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-plugin-node-polyfills": "^0.2.1",
+	rollup: "^4.59.0",
 	typedoc: "^0.28.14",
 	"typedoc-plugin-markdown": "^4.9.0",
 	typescript: "^5.5.4"
 };
 var dependencies = {
-	"isomorphic-fetch": "^3.0.0",
 	ramda: "^0.32.0",
 	"reconnecting-websocket": "^4.4.0",
-	uuid: "^9.0.1"
+	uuid: "^14.0.0"
 };
 var publishConfig = {
 	access: "public"
 };
-var gitHead = "bbfa1fad3f009a0f509903d6db4f51bec17b1f6c";
+var gitHead = "548c2c6c876cf86572aeb63a6810ed87c9b0382a";
 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,
@@ -92,6 +86,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.
      */
@@ -194,14 +192,15 @@ const parseConnection = (config) => {
         return null;
     }
     // `applicationUrl`-based definition: http case
-    const host = getHost(applicationUrl);
+    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,
+            protocol: urlObject.protocol === "http:" ? Protocol.Http : protocol,
             channelKey: parseResult.pathname.groups.channelKey,
             deploymentKey: parseResult.pathname.groups.deploymentKey,
             host,
@@ -214,13 +213,16 @@ const toWebsocketUrl = (connection) => {
     return `wss://us-east-1-ws.${connection.host}?deploymentKey=${connection.deploymentKey}&channelKey=${connection.channelKey}&apiKey=${connection.apiKey}`;
 };
 const toHttpUrl = (connection) => {
-    return `https://${connection.host}/c/${connection.deploymentKey}/${connection.channelKey}`;
+    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, apiKey, headers, body, stream, eventListeners, }) => {
     const streamRequest = async (body) => {
+        eventListeners.interimMessage.forEach((listener) => {
+            listener("Thinking...");
+        });
         const response = await fetch(fullApplicationUrl, {
             method: "POST",
             headers: {
@@ -278,7 +280,7 @@ const fetchUserMessage = async ({ fullApplicationUrl, apiKey, headers, body, str
                             foundObject = true;
                             break;
                         }
-                        catch (e) {
+                        catch (_e) {
                             /* keep scanning */
                         }
                     }
@@ -352,16 +354,28 @@ function createConversation(configuration) {
     let voicePlusSocketMessageQueue = [];
     let voicePlusSocketMessageQueueCheckInterval = null;
     const connection = parseConnection(configuration);
-    const websocketApplicationUrl = connection != null
-        ? toWebsocketUrl(connection)
-        : configuration.applicationUrl ?? "";
-    const httpApplicationUrl = connection != null
-        ? toHttpUrl(connection)
-        : configuration.applicationUrl ?? "";
+    const complete = configuration.experimental?.completeApplicationUrl === true;
+    const websocketApplicationUrl = complete && isWebsocketUrl(configuration.applicationUrl ?? "")
+        ? (configuration.applicationUrl ?? "")
+        : connection != null
+            ? toWebsocketUrl(connection)
+            : (configuration.applicationUrl ?? "");
+    const httpApplicationUrl = complete && !isWebsocketUrl(configuration.applicationUrl ?? "")
+        ? (configuration.applicationUrl ?? "")
+        : 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.");
     }
+    const protocol = connection != null
+        ? connection.protocol
+        : isWebsocketUrl(configuration.applicationUrl ?? "")
+            ? Protocol.Websocket
+            : configuration.experimental?.streamHttp === false
+                ? Protocol.Https
+                : Protocol.HttpsWithStreaming;
     const eventListeners = {
         voicePlusCommand: [],
         interimMessage: [],
@@ -373,9 +387,7 @@ function createConversation(configuration) {
         userId: configuration.userId,
         conversationId: initialConversationId,
     };
-    const fullApplicationHttpUrl = () => `${httpApplicationUrl}${configuration.experimental?.completeApplicationUrl === true
-        ? ""
-        : `-${state.languageCode}`}`;
+    const fullApplicationHttpUrl = () => `${httpApplicationUrl}${complete ? "" : `-${state.languageCode}`}`;
     const setState = (change, 
     // Optionally send the response that causes the current state change, to be sent to subscribers
     newResponse) => {
@@ -444,6 +456,11 @@ function createConversation(configuration) {
             voicePlusSocketMessageQueue = [...voicePlusSocketMessageQueue, message];
         }
     };
+    const setInterimMessage = (message) => {
+        eventListeners.interimMessage.forEach((listener) => {
+            listener(message);
+        });
+    };
     const sendToApplication = async (body) => {
         if (requestOverride != null) {
             requestOverride(body, (payload) => {
@@ -467,7 +484,7 @@ function createConversation(configuration) {
             channelType: configuration.experimental?.channelType,
             environment: configuration.environment,
         };
-        if (connection?.protocol === Protocol.Websocket) {
+        if (protocol === Protocol.Websocket) {
             if (socket?.readyState === 1) {
                 socket.send(JSON.stringify(bodyWithContext));
             }
@@ -481,7 +498,7 @@ function createConversation(configuration) {
                     fullApplicationUrl: fullApplicationHttpUrl(),
                     apiKey: connection?.apiKey ?? "",
                     headers: configuration.headers ?? {},
-                    stream: connection?.protocol === Protocol.HttpsWithStreaming,
+                    stream: protocol === Protocol.HttpsWithStreaming,
                     eventListeners,
                     body: bodyWithContext,
                 });
@@ -577,7 +594,7 @@ function createConversation(configuration) {
             voicePlusSocket = undefined;
         }
     };
-    if (connection?.protocol === Protocol.Websocket) {
+    if (protocol === Protocol.Websocket) {
         setupWebsocket();
     }
     setupCommandWebsocket();
@@ -711,6 +728,7 @@ function createConversation(configuration) {
                 responses: [...state.responses, newResponseWithTimestamp],
             }, newResponseWithTimestamp);
         },
+        setInterimMessage,
         sendStructured: (structured, context) => {
             appendStructuredUserResponse(structured, context);
             void sendToApplication({