@botfabrik/engine-webclient 4.96.9 → 4.96.11

package/dist/index.js

@@ -1,13 +1,28 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIENT_TYPE = exports.Devices = void 0;
 const engine_domain_1 = require("@botfabrik/engine-domain");
 const engine_transcript_export_1 = require("@botfabrik/engine-transcript-export");
 const express_1 = require("express");
 const package_json_1 = require("../package.json");
+const auth_1 = require("./auth");
+const constants_1 = require("./constants");
 const createSessionInfo_1 = __importDefault(require("./createSessionInfo"));
 const extractLocale_1 = __importDefault(require("./extractLocale"));
 const getSupportedClientLocale_1 = __importDefault(require("./getSupportedClientLocale"));
@@ -16,16 +31,11 @@ const middleware_1 = __importDefault(require("./middleware"));
 const requestSessionData_1 = __importDefault(require("./requestSessionData"));
 const setTranslations_1 = __importDefault(require("./setTranslations"));
 const speechToText_1 = __importDefault(require("./speechToText"));
+const types_1 = require("./types");
 const views_1 = __importDefault(require("./views"));
-var Devices;
-(function (Devices) {
-    Devices["All"] = "all";
-    Devices["Mobile"] = "mobile";
-    Devices["Desktop"] = "desktop";
-    Devices["None"] = "none";
-})(Devices || (exports.Devices = Devices = {}));
+__exportStar(require("./types"), exports);
 exports.default = (clientName, environment, props) => async (bot) => {
-    const logger = bot.logger.child({ clientType: exports.CLIENT_TYPE, clientName });
+    const logger = bot.logger.child({ clientType: constants_1.CLIENT_TYPE, clientName });
     // serve transcript pdf
     bot.webserver.express.use('/transcript-pdf/:sessionId', async (req, res) => {
         const sessionId = req.params['sessionId'];
@@ -79,6 +89,11 @@ exports.default = (clientName, environment, props) => async (bot) => {
             sendConfigurationToClient(socket, props, bot, clientName);
             socket.on('start-chat', onStartChat(socket, props, bot, clientName, environment, logger));
             socket.on('terminate-session', onTerminateSession(socket, bot));
+            if (props.auth) {
+                socket.on('login-requested', (data) => {
+                    (0, auth_1.storeLoginRequestToken)(data.loginRequestToken, socket.id);
+                });
+            }
         }
         catch (error) {
             logger.error('Error while connecting webclient with backend.');
@@ -87,6 +102,9 @@ exports.default = (clientName, environment, props) => async (bot) => {
             socket.emit('action', engine_domain_1.Actions.sendMessageToGuest(errorMessage));
         }
     });
+    if (props.auth) {
+        (0, auth_1.setUpSamlAuth)(bot, props.auth, clientName, nsp);
+    }
     const client = {
         name: `${clientName}Webclient`,
         middleware: (0, middleware_1.default)(clientName, nsp),
@@ -116,59 +134,69 @@ const onTerminateSession = (socket, bot) => async ({ sessionId, // passed if the
     socket.leave(sessionId);
     await session.dispatch(engine_domain_1.Actions.guestDisconnected(sessionId));
 };
-const onStartChat = (socket, props, bot, clientName, environment, logger) => async ({ sessionId: sessionIdFromClient, userId: defaultUserId, querystrings, }) => {
-    const locale = (0, extractLocale_1.default)(querystrings, socket.request.headers['accept-language']);
-    const sessionsCollection = bot.store.db.collection('sessions');
-    const { sessionId, sessionInfo: defaultSessionInfo, isNew, } = await (0, requestSessionData_1.default)(sessionIdFromClient, querystrings, sessionsCollection, clientName, props);
-    // create a channel for each session
-    socket.join(sessionId);
-    const sessionInfo = await (0, createSessionInfo_1.default)(socket, clientName, environment, defaultSessionInfo, defaultUserId, locale, querystrings, props)();
-    const session = await bot.createSession(sessionId, sessionInfo);
-    sendConfigurationToClient(socket, props, bot, clientName);
-    // sending persisted state to client
-    const previousConversations = await (0, loadPreviousConversation_1.default)(bot.store, sessionId);
-    socket.emit('restore-client-state', {
-        sessionId,
-        messages: previousConversations,
-    });
-    // enable conversation rating
-    if (props.enableConversationRating) {
-        socket.emit('enable-conversation-rating', {
-            rating: sessionInfo.client.payload.conversationRating,
+const onStartChat = (socket, props, bot, clientName, environment, logger) => async ({ sessionId: sessionIdFromClient, userId: defaultUserId, querystrings, loginToken, }) => {
+    try {
+        const authenticatedUser = (0, auth_1.verifyLoginToken)(loginToken, props.auth, logger);
+        const locale = (0, extractLocale_1.default)(querystrings, socket.request.headers['accept-language']);
+        const sessionsCollection = bot.store.db.collection('sessions');
+        const { sessionId, sessionInfo: defaultSessionInfo, isNew, } = await (0, requestSessionData_1.default)(sessionIdFromClient, querystrings, sessionsCollection, clientName, props);
+        // create a channel for each session
+        socket.join(sessionId);
+        const sessionInfo = await (0, createSessionInfo_1.default)(socket, clientName, environment, defaultSessionInfo, defaultUserId, locale, querystrings, authenticatedUser, props)();
+        const session = await bot.createSession(sessionId, sessionInfo);
+        sendConfigurationToClient(socket, props, bot, clientName);
+        // sending persisted state to client
+        const previousConversations = await (0, loadPreviousConversation_1.default)(bot.store, sessionId);
+        socket.emit('restore-client-state', {
+            sessionId,
+            messages: previousConversations,
         });
-    }
-    // Notify middlewares about a connected or reconnected guest
-    await session.dispatch(engine_domain_1.Actions.guestConnected(sessionId));
-    if (isNew && props.getStartedAction) {
-        await session.dispatch(props.getStartedAction);
-    }
-    registerListener(socket, 'action', async (action) => {
-        await session.dispatch(JSON.parse(action));
-    });
-    registerListener(socket, 'disconnect', async () => {
-        await session.dispatch(engine_domain_1.Actions.guestDisconnected(sessionId));
-    });
-    registerListener(socket, 'conversation-rating', async (rating) => {
-        sessionsCollection.updateOne({ _id: sessionId }, { $set: { 'sessionInfo.client.payload.conversationRating': rating } });
-        session.dispatch({
-            type: engine_domain_1.ActionTypes.CONVERSATION_RATING_FROM_GUEST,
-            payload: { rating },
+        // enable conversation rating
+        if (props.enableConversationRating) {
+            socket.emit('enable-conversation-rating', {
+                rating: sessionInfo.client.payload.conversationRating,
+            });
+        }
+        // Notify middlewares about a connected or reconnected guest
+        await session.dispatch(engine_domain_1.Actions.guestConnected(sessionId));
+        if (isNew && props.getStartedAction) {
+            await session.dispatch(props.getStartedAction);
+        }
+        registerListener(socket, 'action', async (action) => {
+            await session.dispatch(JSON.parse(action));
         });
-    });
-    registerListener(socket, 'audio-message', async (buffer) => {
-        if (props.speech) {
-            try {
-                const text = await (0, speechToText_1.default)(props.speech, session.translator.locale, buffer);
-                if (text && text.length) {
-                    socket.emit('speech-transcription', text);
-                    session.dispatch(engine_domain_1.Actions.receiveTextMessageFromGuest(text));
+        registerListener(socket, 'disconnect', async () => {
+            await session.dispatch(engine_domain_1.Actions.guestDisconnected(sessionId));
+        });
+        registerListener(socket, 'conversation-rating', async (rating) => {
+            sessionsCollection.updateOne({ _id: sessionId }, {
+                $set: { 'sessionInfo.client.payload.conversationRating': rating },
+            });
+            session.dispatch({
+                type: engine_domain_1.ActionTypes.CONVERSATION_RATING_FROM_GUEST,
+                payload: { rating },
+            });
+        });
+        registerListener(socket, 'audio-message', async (buffer) => {
+            if (props.speech) {
+                try {
+                    const text = await (0, speechToText_1.default)(props.speech, session.translator.locale, buffer);
+                    if (text && text.length) {
+                        socket.emit('speech-transcription', text);
+                        session.dispatch(engine_domain_1.Actions.receiveTextMessageFromGuest(text));
+                    }
+                }
+                catch (error) {
+                    logger.error(error);
                 }
             }
-            catch (error) {
-                logger.error(error);
-            }
-        }
-    });
+        });
+    }
+    catch (error) {
+        logger.error('Error while starting chat session:', error);
+        socket.disconnect(true);
+        return;
+    }
 };
 const registerListener = (socket, event, listener) => {
     // remove all listeners for the event to avoid multiple listeners
@@ -183,7 +211,8 @@ const sendConfigurationToClient = (socket, props, bot, clientName) => {
     (0, setTranslations_1.default)(socket, bot, clientLocale, clientName);
     const settings = {
         version: package_json_1.version,
-        enableStartScreen: !!props.enableStartScreen,
+        requiresUserAuthentication: !!props.auth,
+        enableStartScreen: !!props.enableStartScreen || !!props.auth,
         enableStandaloneView: !!props.enableStandaloneView,
         enableTranscriptExportPdf: !!props.enableTranscriptExportPdf,
         enableTranscriptExportEmail: !!props.enableTranscriptExportEmail,
@@ -194,11 +223,10 @@ const sendConfigurationToClient = (socket, props, bot, clientName) => {
     };
     socket.emit('set-settings', settings);
     if (props.expandChatWindowAtStart &&
-        props.expandChatWindowAtStart !== Devices.None) {
+        props.expandChatWindowAtStart !== types_1.Devices.None) {
         socket.emit('expand-window', {
             devices: props.expandChatWindowAtStart,
             initial: true,
         });
     }
 };
-exports.CLIENT_TYPE = 'webclient';

package/dist/middleware/index.d.ts

@@ -1,5 +1,5 @@
 import { type Middleware } from '@botfabrik/engine-domain';
 import type { Namespace } from 'socket.io';
-import type { WebclientMiddlewareState } from '../types';
+import { type WebclientMiddlewareState } from '../types';
 declare const _default: (clientName: string, nsp: Namespace) => Middleware<WebclientMiddlewareState>;
 export default _default;

package/dist/middleware/index.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const engine_domain_1 = require("@botfabrik/engine-domain");
 const engine_utils_1 = require("@botfabrik/engine-utils");
-const __1 = require("..");
 const setTranslations_1 = __importDefault(require("../setTranslations"));
+const types_1 = require("../types");
 exports.default = (clientName, nsp) => async (bot) => {
     return async (next, _state, action, session) => {
         const sessionInfo = session.getSessionInfo();
@@ -57,7 +57,7 @@ const sendToChatClient = async (nsp, session, action) => {
 };
 const expandChatWindow = (nsp, session, action) => {
     const devices = action.payload?.devices;
-    if (!!devices && devices !== __1.Devices.None) {
+    if (!!devices && devices !== types_1.Devices.None) {
         nsp
             .to(session.id)
             .emit('expand-window', { devices: action.payload.devices });

package/dist/requestSessionData.d.ts

@@ -1,6 +1,5 @@
 import type { SessionInfo } from '@botfabrik/engine-domain';
-import { type WebClientProps } from './index';
-import type { SessionInfoClientPayload, SessionInfoUserPayload } from './types';
+import type { SessionInfoClientPayload, SessionInfoUserPayload, WebClientProps } from './types';
 interface SessionData {
     sessionId: string;
     sessionInfo: SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>;

package/dist/requestSessionData.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const crypto_1 = require("crypto");
-const index_1 = require("./index");
+const constants_1 = require("./constants");
 const requestSessionData = async (sessionId, querystrings, sessionsCollection, clientName, props) => {
     const baseQuery = {
-        'sessionInfo.client.type': index_1.CLIENT_TYPE,
+        'sessionInfo.client.type': constants_1.CLIENT_TYPE,
         'sessionInfo.client.name': clientName,
     };
     let findSessionRecordQuery;

package/dist/speechToText.d.ts

@@ -1,7 +1,3 @@
-export interface SpeechToTextProps {
-    clientEmail: string;
-    privateKey: string;
-    contextPhrases?: any;
-}
+import type { SpeechToTextProps } from './types';
 declare const speechToText: (speechProps: SpeechToTextProps, locale: string, speechBytes: any) => Promise<string>;
 export default speechToText;

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { Action, SessionInfoUser } from '@botfabrik/engine-domain';
 export type SessionInfoClientPayload = {
     querystrings: any;
     referrer: string;
@@ -9,3 +10,172 @@ export type ConversationRating = {
 };
 export type SessionInfoUserPayload = {};
 export type WebclientMiddlewareState = {};
+export type RequestUserInfos = (querystrings: any) => Promise<Partial<SessionInfoUser<SessionInfoUserPayload>>>;
+export type RequestSessionRecordQuery = (params: {
+    querystrings: any;
+    sessionId: string;
+}) => Promise<Record<string, unknown>>;
+export type MenuItemType = 'link' | 'action';
+export type MenuItemIcon = 'mail' | 'phone' | 'scroll' | 'link';
+export type MenuItemVisibility = 'always' | 'chat-only' | 'start-screen-only';
+type BaseMenuItem = {
+    /**
+     * Unique key for this menu item.
+     * Used for translation as `header.menu.<id>`.
+     */
+    id: string;
+    /**
+     * Icon displayed for this menu item.
+     */
+    icon: MenuItemIcon;
+    /**
+     * If true, a divider (line) will be displayed after this item in the menu.
+     */
+    withDivider?: boolean;
+    /**
+     * Visibility of the menu item.
+     * - `always`: visible in all contexts (start screen, chat)
+     * - `chat-only`: visible only in the chat context
+     * - `start-screen-only`: visible only in the start screen context
+     */
+    visibility: MenuItemVisibility;
+};
+/**
+ * Represents a menu item that points to a web link.
+ */
+type LinkMenuItem = BaseMenuItem & {
+    type: 'link';
+    /**
+     * The URL that the menu item points to.
+     */
+    url: string;
+};
+/**
+ * Represents a menu item that triggers an action.
+ */
+type ActionMenuItem = BaseMenuItem & {
+    type: 'action';
+    /**
+     * The action to be executed when the menu item is clicked.
+     */
+    action: Action;
+};
+export type MenuItem = LinkMenuItem | ActionMenuItem;
+export interface SpeechToTextProps {
+    clientEmail: string;
+    privateKey: string;
+    contextPhrases?: any;
+}
+export type SamlAuthConfig = {
+    entryPoint: string;
+    issuer: string;
+    idpCert: string | string[];
+    /**
+     * Options are passed to the passport-saml strategy.
+     */
+    options?: Record<string, unknown>;
+};
+export type Auth = {
+    /**
+     * JWT secret used to sign the login token.
+     */
+    jwtSecret: string;
+    /**
+     * SAML authentication configuration.
+     */
+    saml: SamlAuthConfig;
+};
+export interface WebClientProps {
+    getStartedAction?: Action;
+    requestUserInfos?: RequestUserInfos;
+    requestSessionRecordQuery?: RequestSessionRecordQuery;
+    speech?: SpeechToTextProps | undefined;
+    expandChatWindowAtStart?: Devices;
+    fabVisible?: boolean;
+    /**
+     * SAML authentication configuration for the web client.
+     * If set, users must authenticate via SAML before accessing the chat.
+     * If omitted, the chat is accessible without authentication.
+     *
+     * @default undefined
+     */
+    auth?: Auth;
+    /**
+     * Displays a start screen before a new chat begins, useful for user opt-in (e.g., terms acceptance).
+     * Contains a text (`start-screen.intro` in Markdown), form fields, and a start button (`start-screen.start-chat`).
+     * No user data is collected until the user clicks the start button.
+     *
+     * @default false (unless `auth` is set)
+     */
+    enableStartScreen?: boolean;
+    /**
+     * Enables the conversation rating feature.
+     * When set to true, users will be prompted to rate the conversation
+     * on a scale from 1 to 5 stars and optionally provide written feedback.
+     *
+     * Useful for collecting quality insights, improving support, or tracking user satisfaction.
+     *
+     * @default false
+     */
+    enableConversationRating?: boolean;
+    /**
+     * Enables the option to export the chat transcript as a PDF file.
+     *
+     * When set to `true`, users can download the current chat conversation
+     * as a PDF document.
+     *
+     * @default false
+     */
+    enableTranscriptExportPdf?: boolean;
+    /**
+     * Enables the option to send the chat transcript to the user via email.
+     *
+     * When set to `true`, users can request the current chat conversation
+     * to be sent to their email address.
+     *
+     * @default false
+     */
+    enableTranscriptExportEmail?: boolean;
+    /**
+     * Enables the option to open the chat client in a standalone tab or window.
+     * When set to true, a button will be shown that allows users to open the chat
+     * outside of an embedded iframe, in a new browser tab.
+     *
+     * @default false
+     */
+    enableStandaloneView?: boolean;
+    /**
+     * Enables the display of general terms and conditions above the chat window.
+     * When set to true, a section containing general conditions (e.g. legal notice,
+     * consent information, disclaimers) will be shown above the chat interface.
+     *
+     * Useful for compliance, legal requirements, or informing users before starting a conversation.
+     *
+     * @default false
+     * */
+    enableGeneralConditions?: boolean;
+    /**
+     * List of available chat commands that can be used in the input field.
+     *
+     * Each command may trigger a predefined action, insert a message template,
+     * or activate a special feature.
+     *
+     * Useful for advanced chat interactions, power-user features, or slash commands (e.g. /help, /end).
+     *
+     * @default []
+     * */
+    commands?: string[];
+    /**
+     * List of custom menu items displayed in the chat header.
+     *
+     * @default []
+     */
+    menuItems?: MenuItem[];
+}
+export declare enum Devices {
+    All = "all",
+    Mobile = "mobile",
+    Desktop = "desktop",
+    None = "none"
+}
+export {};

package/dist/types.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Devices = void 0;
+var Devices;
+(function (Devices) {
+    Devices["All"] = "all";
+    Devices["Mobile"] = "mobile";
+    Devices["Desktop"] = "desktop";
+    Devices["None"] = "none";
+})(Devices || (exports.Devices = Devices = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botfabrik/engine-webclient",
-  "version": "4.96.9",
+  "version": "4.96.11",
   "description": "Webclient for Botfabriks Bot Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,23 +21,27 @@
   },
   "dependencies": {
     "@botfabrik/engine-domain": "^4.96.6",
-    "@botfabrik/engine-transcript-export": "^4.96.6",
-    "@botfabrik/engine-utils": "^4.96.6",
+    "@botfabrik/engine-transcript-export": "^4.96.10",
+    "@botfabrik/engine-utils": "^4.96.10",
     "@google-cloud/speech": "^7.2.0",
+    "@node-saml/passport-saml": "^5.1.0",
     "accept-language-parser": "^1.5.0",
     "express": "^5.1.0",
+    "jsonwebtoken": "^9.0.2",
+    "passport": "^0.7.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@types/accept-language-parser": "^1.5.8",
     "@types/express": "^5.0.3",
+    "@types/jsonwebtoken": "^9.0.10",
     "@types/serve-static": "^1.15.8",
     "@types/ua-parser-js": "^0.7.39",
     "copyfiles": "^2.4.1",
     "rimraf": "^6.0.1",
     "socket.io": "^4.8.1",
     "tsx": "^4.20.3",
-    "typescript": "5.8.3"
+    "typescript": "5.9.2"
   },
-  "gitHead": "4e1e8a3d76989d4ba9000ca580c46236c04dc428"
+  "gitHead": "2d7dbdeb71d0a9e5567494da7927960b3309b5ac"
 }