@nlxai/core 1.2.3 → 1.2.4-alpha.3

package/lib/index.cjs

@@ -5,75 +5,9 @@ var ramda = require('ramda');
 var ReconnectingWebSocket = require('reconnecting-websocket');
 var uuid = require('uuid');
 
-var name = "@nlxai/core";
-var version$1 = "1.2.3";
-var description = "Low-level SDK for building NLX experiences";
-var type = "module";
-var main = "lib/index.cjs";
-var module$1 = "lib/index.esm.js";
-var browser = "lib/index.umd.js";
-var types = "lib/index.d.ts";
-var exports$1 = {
-	".": {
-		types: "./lib/index.d.ts",
-		"import": "./lib/index.esm.js",
-		require: "./lib/index.cjs"
-	}
-};
-var scripts = {
-	build: "rm -rf lib && rollup -c --configPlugin typescript --configImportAttributesKey with",
-	"lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0",
-	lint: "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
-	prepublish: "npm run build",
-	test: "typedoc --emit none",
-	tsc: "tsc",
-	"update-readme:docs": "rm -rf docs/ && typedoc",
-	"update-readme:merge": "../../scripts/transclude-markdown.js",
-	"update-readme": "npm run update-readme:docs && npm run update-readme:merge"
-};
-var author = "Peter Szerzo <peter@nlx.ai>";
-var license = "MIT";
-var devDependencies = {
-	"@types/isomorphic-fetch": "^0.0.39",
-	"@types/node": "^24.10.1",
-	"@types/ramda": "0.31.1",
-	"@types/uuid": "^9.0.7",
-	"concat-md": "^0.5.1",
-	"eslint-config-nlx": "*",
-	prettier: "^3.1.0",
-	"rollup-config-nlx": "*",
-	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"
-};
-var publishConfig = {
-	access: "public"
-};
-var gitHead = "3902161e95745dd4a9cfb68bb469755a62b421f5";
+var version$1 = "1.2.4-alpha.3";
 var packageJson = {
-	name: name,
-	version: version$1,
-	description: description,
-	type: type,
-	main: main,
-	module: module$1,
-	browser: browser,
-	types: types,
-	exports: exports$1,
-	scripts: scripts,
-	author: author,
-	license: license,
-	devDependencies: devDependencies,
-	dependencies: dependencies,
-	publishConfig: publishConfig,
-	gitHead: gitHead
-};
+	version: version$1};
 
 /**
  * Package version
@@ -163,6 +97,96 @@ const normalizeToHttp = (applicationUrl) => {
 const isWebsocketUrl = (url) => {
     return url.indexOf("wss://") === 0;
 };
+const fetchUserMessage = async ({ fullApplicationUrl, headers, body, stream, eventListeners, }) => {
+    const streamRequest = async (body) => {
+        const response = await fetch(fullApplicationUrl, {
+            method: "POST",
+            headers: {
+                ...headers,
+                "Content-Type": "application/json",
+                "nlx-sdk-version": packageJson.version,
+            },
+            body: JSON.stringify({ ...body, stream: true }),
+        });
+        if (!response.ok || response.body == null)
+            throw new Error(`HTTP Error: ${response.status}`);
+        const reader = response.body.getReader();
+        const decoder = new TextDecoder();
+        let buffer = "";
+        const messages = [];
+        let finalResponse = {};
+        while (true) {
+            const { done, value } = await reader.read();
+            if (done)
+                break;
+            buffer += decoder.decode(value, { stream: true });
+            while (true) {
+                const openBrace = buffer.indexOf("{");
+                if (openBrace === -1)
+                    break;
+                let foundObject = false;
+                for (let i = 0; i < buffer.length; i++) {
+                    if (buffer[i] === "}") {
+                        const candidate = buffer.substring(openBrace, i + 1);
+                        try {
+                            const json = JSON.parse(candidate);
+                            if (json.type === "interim") {
+                                const text = json.text;
+                                if (typeof text === "string") {
+                                    eventListeners.interimMessage.forEach((listener) => {
+                                        listener(text);
+                                    });
+                                }
+                            }
+                            else if (json.type === "message") {
+                                messages.push({
+                                    text: json.text,
+                                    choices: json.choices ?? [],
+                                    messageId: json.messageId,
+                                    metadata: json.metadata,
+                                });
+                            }
+                            else if (json.type === "final_response") {
+                                finalResponse = json.data;
+                            }
+                            buffer = buffer.substring(i + 1);
+                            foundObject = true;
+                            break;
+                        }
+                        catch (e) {
+                            /* keep scanning */
+                        }
+                    }
+                }
+                if (!foundObject)
+                    break;
+            }
+        }
+        eventListeners.interimMessage.forEach((listener) => {
+            listener(undefined);
+        });
+        return { ...finalResponse, messages };
+    };
+    if (stream) {
+        return await streamRequest(body);
+    }
+    else {
+        const response = await fetch(fullApplicationUrl, {
+            method: "POST",
+            headers: {
+                ...(headers ?? {}),
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                "nlx-sdk-version": packageJson.version,
+            },
+            body: JSON.stringify(body),
+        });
+        if (!response.ok || response.body == null)
+            throw new Error(`HTTP Error: ${response.status}`);
+        const json = await response.json();
+        return json;
+    }
+};
 /**
  * Call this to create a conversation handler.
  * @param configuration - The necessary configuration to create the conversation.
@@ -193,7 +217,10 @@ function createConversation(configuration) {
     if (/[-|_][a-z]{2,}[-|_][A-Z]{2,}$/.test(applicationUrl)) {
         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 eventListeners = { voicePlusCommand: [] };
+    const eventListeners = {
+        voicePlusCommand: [],
+        interimMessage: [],
+    };
     const initialConversationId = configuration.conversationId ?? uuid.v4();
     let state = {
         responses: configuration.responses ?? [],
@@ -305,20 +332,13 @@ function createConversation(configuration) {
         }
         else {
             try {
-                const res = await fetch(fullApplicationHttpUrl(), {
-                    method: "POST",
-                    headers: {
-                        ...(configuration.headers ?? {}),
-                        Accept: "application/json",
-                        "Content-Type": "application/json",
-                        "nlx-sdk-version": packageJson.version,
-                    },
-                    body: JSON.stringify(bodyWithContext),
+                const json = await fetchUserMessage({
+                    fullApplicationUrl: fullApplicationHttpUrl(),
+                    headers: configuration.headers ?? {},
+                    stream: configuration.experimental?.streamHttp ?? false,
+                    eventListeners,
+                    body: bodyWithContext,
                 });
-                if (res.status >= 400) {
-                    throw new Error(`Responded with ${res.status}`);
-                }
-                const json = await res.json();
                 messageResponseHandler(json);
             }
             catch (err) {
@@ -591,6 +611,23 @@ function createConversation(configuration) {
             sendFlow(welcomeIntent, context);
         },
         sendChoice,
+        submitFeedback: async (feedbackUrl, feedback) => {
+            const res = await fetch(feedbackUrl, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify({
+                    languageCode: state.languageCode,
+                    conversationId: state.conversationId,
+                    userId: state.userId,
+                    ...feedback,
+                }),
+            });
+            if (res.status >= 400) {
+                throw new Error(`Responded with ${res.status}`);
+            }
+        },
         currentConversationId: () => {
             return state.conversationId;
         },

package/lib/index.d.ts

@@ -55,6 +55,10 @@ export interface Config {
      * @internal
      */
     experimental?: {
+        /**
+         * Check whether HTTP streaming should be enabled
+         */
+        streamHttp?: boolean;
         /**
          * Simulate alternative channel types
          */
@@ -145,6 +149,15 @@ export interface ConversationHandler {
      * @param context - [Context](https://docs.studio.nlx.ai/workspacesettings/documentation-settings/settings-context-attributes) for usage later in the intent.
      */
     sendStructured: (request: StructuredRequest, context?: Context) => void;
+    /**
+     * Submit feedback about a response.
+     * @param url - The URL comming from the Application response `metadata.feedbackURL` field.
+     * @param feedback - Either a numerical rating or a textual comment.
+     */
+    submitFeedback: (url: string, feedback: {
+        rating?: number;
+        comment?: string;
+    }) => Promise<void>;
     /**
      * Subscribe a callback to the conversation. On subscribe, the subscriber will receive all of the Responses that the conversation has already received.
      * @param subscriber - The callback to subscribe
@@ -351,6 +364,16 @@ export interface ApplicationResponseMetadata {
      * Knowledge base sources
      */
     sources?: KnowledgeBaseResponseSource[];
+    /**
+     * URL to use for submitting feedback about this response. See `feedbackConfig` for what the expected feedback type is.
+     *
+     * You can pass this as the first argument to `submitFeedback`.
+     */
+    feedbackUrl?: string;
+    /**
+     * If present, the application would like to collect feedback from the user.
+     */
+    feedbackConfig?: FeedbackConfiguration;
 }
 /**
  * Response for knowlege base sources
@@ -541,6 +564,52 @@ export type Response = ApplicationResponse | UserResponse | FailureMessage;
  * The time value in milliseconds since midnight, January 1, 1970 UTC.
  */
 export type Time = number;
+/**
+ * Configuration for feedback collection. You can use this to render an appropriate feedback widget in your application.
+ */
+export interface FeedbackConfiguration {
+    /** Unique identifier for the feedback collection. */
+    feedbackId: string;
+    /** Human readable name of this feedback collection. */
+    feedbackName: string;
+    /**
+     * Type of feedback being collected.
+     * At the moment only binary feedback is supported, but we plan to introduce more types in the future.
+     * Hence your code should make sure to check the `type` attribute to make sure the expected feedback type is handled.
+     */
+    feedbackType: FeedbackType;
+    /** Whether comments are enabled for this feedback collection. */
+    commentsEnabled: boolean;
+    /** Optional question to show to the user when collecting feedback. */
+    question?: string;
+    /** Labels for individual feedback UI elements as customised by the builder. */
+    labels: {
+        /** Label for positive feedback */
+        positive?: string;
+        /** Label for negative feedback */
+        negative?: string;
+        /** Label for comment */
+        comment?: string;
+    };
+}
+/**
+ * @inline @hidden
+ */
+export type FeedbackType = {
+    /** A binary feedback type is a thumbs up/down sort of choice. */
+    type: "binary";
+    /** Configuration specific to binary feedback. */
+    config: BinaryFeedbackConfig;
+};
+/**
+ * @inline @hidden
+ */
+export interface BinaryFeedbackConfig {
+    /** Value to send for positive feedback. Default `1`. */
+    positiveValue: number;
+    /** Value to send for negative feedback. Default `-1`. */
+    negativeValue: number;
+}
 /**
  * @hidden
  */
@@ -709,7 +778,15 @@ export interface VoicePlusMessage {
  * Handler events
  * @event voicePlusCommand
  */
-export type ConversationHandlerEvent = "voicePlusCommand";
+export type ConversationHandlerEvent = "voicePlusCommand" | "interimMessage";
+/**
+ * Voice+ command listener
+ */
+export type VoicePlusCommandListener = (payload: any) => void;
+/**
+ * Interim message listener
+ */
+export type InterimMessageListener = (message?: string) => void;
 /**
  * Dictionary of handler methods per event
  */
@@ -717,7 +794,11 @@ export interface EventHandlers {
     /**
      * Voice+ command event handler
      */
-    voicePlusCommand: (payload: any) => void;
+    voicePlusCommand: VoicePlusCommandListener;
+    /**
+     * Interim message event handler
+     */
+    interimMessage: InterimMessageListener;
 }
 /**
  * The callback function for listening to all responses.

package/lib/index.esm.js

@@ -3,75 +3,9 @@ import { equals, adjust } from 'ramda';
 import ReconnectingWebSocket from 'reconnecting-websocket';
 import { v4 } from 'uuid';
 
-var name = "@nlxai/core";
-var version$1 = "1.2.3";
-var description = "Low-level SDK for building NLX experiences";
-var type = "module";
-var main = "lib/index.cjs";
-var module = "lib/index.esm.js";
-var browser = "lib/index.umd.js";
-var types = "lib/index.d.ts";
-var exports = {
-	".": {
-		types: "./lib/index.d.ts",
-		"import": "./lib/index.esm.js",
-		require: "./lib/index.cjs"
-	}
-};
-var scripts = {
-	build: "rm -rf lib && rollup -c --configPlugin typescript --configImportAttributesKey with",
-	"lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0",
-	lint: "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
-	prepublish: "npm run build",
-	test: "typedoc --emit none",
-	tsc: "tsc",
-	"update-readme:docs": "rm -rf docs/ && typedoc",
-	"update-readme:merge": "../../scripts/transclude-markdown.js",
-	"update-readme": "npm run update-readme:docs && npm run update-readme:merge"
-};
-var author = "Peter Szerzo <peter@nlx.ai>";
-var license = "MIT";
-var devDependencies = {
-	"@types/isomorphic-fetch": "^0.0.39",
-	"@types/node": "^24.10.1",
-	"@types/ramda": "0.31.1",
-	"@types/uuid": "^9.0.7",
-	"concat-md": "^0.5.1",
-	"eslint-config-nlx": "*",
-	prettier: "^3.1.0",
-	"rollup-config-nlx": "*",
-	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"
-};
-var publishConfig = {
-	access: "public"
-};
-var gitHead = "3902161e95745dd4a9cfb68bb469755a62b421f5";
+var version$1 = "1.2.4-alpha.3";
 var packageJson = {
-	name: name,
-	version: version$1,
-	description: description,
-	type: type,
-	main: main,
-	module: module,
-	browser: browser,
-	types: types,
-	exports: exports,
-	scripts: scripts,
-	author: author,
-	license: license,
-	devDependencies: devDependencies,
-	dependencies: dependencies,
-	publishConfig: publishConfig,
-	gitHead: gitHead
-};
+	version: version$1};
 
 /**
  * Package version
@@ -161,6 +95,96 @@ const normalizeToHttp = (applicationUrl) => {
 const isWebsocketUrl = (url) => {
     return url.indexOf("wss://") === 0;
 };
+const fetchUserMessage = async ({ fullApplicationUrl, headers, body, stream, eventListeners, }) => {
+    const streamRequest = async (body) => {
+        const response = await fetch(fullApplicationUrl, {
+            method: "POST",
+            headers: {
+                ...headers,
+                "Content-Type": "application/json",
+                "nlx-sdk-version": packageJson.version,
+            },
+            body: JSON.stringify({ ...body, stream: true }),
+        });
+        if (!response.ok || response.body == null)
+            throw new Error(`HTTP Error: ${response.status}`);
+        const reader = response.body.getReader();
+        const decoder = new TextDecoder();
+        let buffer = "";
+        const messages = [];
+        let finalResponse = {};
+        while (true) {
+            const { done, value } = await reader.read();
+            if (done)
+                break;
+            buffer += decoder.decode(value, { stream: true });
+            while (true) {
+                const openBrace = buffer.indexOf("{");
+                if (openBrace === -1)
+                    break;
+                let foundObject = false;
+                for (let i = 0; i < buffer.length; i++) {
+                    if (buffer[i] === "}") {
+                        const candidate = buffer.substring(openBrace, i + 1);
+                        try {
+                            const json = JSON.parse(candidate);
+                            if (json.type === "interim") {
+                                const text = json.text;
+                                if (typeof text === "string") {
+                                    eventListeners.interimMessage.forEach((listener) => {
+                                        listener(text);
+                                    });
+                                }
+                            }
+                            else if (json.type === "message") {
+                                messages.push({
+                                    text: json.text,
+                                    choices: json.choices ?? [],
+                                    messageId: json.messageId,
+                                    metadata: json.metadata,
+                                });
+                            }
+                            else if (json.type === "final_response") {
+                                finalResponse = json.data;
+                            }
+                            buffer = buffer.substring(i + 1);
+                            foundObject = true;
+                            break;
+                        }
+                        catch (e) {
+                            /* keep scanning */
+                        }
+                    }
+                }
+                if (!foundObject)
+                    break;
+            }
+        }
+        eventListeners.interimMessage.forEach((listener) => {
+            listener(undefined);
+        });
+        return { ...finalResponse, messages };
+    };
+    if (stream) {
+        return await streamRequest(body);
+    }
+    else {
+        const response = await fetch(fullApplicationUrl, {
+            method: "POST",
+            headers: {
+                ...(headers ?? {}),
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                "nlx-sdk-version": packageJson.version,
+            },
+            body: JSON.stringify(body),
+        });
+        if (!response.ok || response.body == null)
+            throw new Error(`HTTP Error: ${response.status}`);
+        const json = await response.json();
+        return json;
+    }
+};
 /**
  * Call this to create a conversation handler.
  * @param configuration - The necessary configuration to create the conversation.
@@ -191,7 +215,10 @@ function createConversation(configuration) {
     if (/[-|_][a-z]{2,}[-|_][A-Z]{2,}$/.test(applicationUrl)) {
         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 eventListeners = { voicePlusCommand: [] };
+    const eventListeners = {
+        voicePlusCommand: [],
+        interimMessage: [],
+    };
     const initialConversationId = configuration.conversationId ?? v4();
     let state = {
         responses: configuration.responses ?? [],
@@ -303,20 +330,13 @@ function createConversation(configuration) {
         }
         else {
             try {
-                const res = await fetch(fullApplicationHttpUrl(), {
-                    method: "POST",
-                    headers: {
-                        ...(configuration.headers ?? {}),
-                        Accept: "application/json",
-                        "Content-Type": "application/json",
-                        "nlx-sdk-version": packageJson.version,
-                    },
-                    body: JSON.stringify(bodyWithContext),
+                const json = await fetchUserMessage({
+                    fullApplicationUrl: fullApplicationHttpUrl(),
+                    headers: configuration.headers ?? {},
+                    stream: configuration.experimental?.streamHttp ?? false,
+                    eventListeners,
+                    body: bodyWithContext,
                 });
-                if (res.status >= 400) {
-                    throw new Error(`Responded with ${res.status}`);
-                }
-                const json = await res.json();
                 messageResponseHandler(json);
             }
             catch (err) {
@@ -589,6 +609,23 @@ function createConversation(configuration) {
             sendFlow(welcomeIntent, context);
         },
         sendChoice,
+        submitFeedback: async (feedbackUrl, feedback) => {
+            const res = await fetch(feedbackUrl, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify({
+                    languageCode: state.languageCode,
+                    conversationId: state.conversationId,
+                    userId: state.userId,
+                    ...feedback,
+                }),
+            });
+            if (res.status >= 400) {
+                throw new Error(`Responded with ${res.status}`);
+            }
+        },
         currentConversationId: () => {
             return state.conversationId;
         },