@botfabrik/engine-webclient 4.36.1 → 4.37.3

package/dist/createSessionInfo.d.ts

@@ -1,12 +1,7 @@
-import type { SessionInfo, SessionInfoClient, SessionInfoUser } from '@botfabrik/engine-core';
-import type express from 'express';
+import type { SessionInfo } from '@botfabrik/engine-core';
+import type { Environment } from '@botfabrik/engine-domain';
 import type { Socket } from 'socket.io';
 import { WebClientProps } from './index';
 import type { SessionInfoClientPayload, SessionInfoUserPayload } from './types';
-export declare const createSessionInfoFromRequest: (req: express.Request, name: string, sessionInfo: SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>, props: WebClientProps) => Promise<{
-    client: SessionInfoClient<SessionInfoClientPayload>;
-    user: SessionInfoUser<SessionInfoUserPayload>;
-    contexts: string[];
-}>;
-declare const createSessionInfo: (socket: Socket, name: string, sessionInfo: SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>, props: WebClientProps) => () => Promise<SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>>;
+declare const createSessionInfo: (socket: Socket, clientName: string, environment: Environment, sessionInfo: SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>, props: WebClientProps) => () => Promise<SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>>;
 export default createSessionInfo;

package/dist/createSessionInfo.js

@@ -3,22 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSessionInfoFromRequest = void 0;
 const buildUserAgentInfos_1 = __importDefault(require("./buildUserAgentInfos"));
 const extractIP_1 = __importDefault(require("./extractIP"));
 const extractLocale_1 = __importDefault(require("./extractLocale"));
 const index_1 = require("./index");
-const createSessionInfoFromRequest = async (req, name, sessionInfo, props) => {
-    const ip = (0, extractIP_1.default)(req);
-    return await createSessionInfoBase(req.query, req.headers, ip, name, sessionInfo, props);
-};
-exports.createSessionInfoFromRequest = createSessionInfoFromRequest;
-const createSessionInfoBase = async (querystrings, headers, ip, name, sessionInfo, props) => {
+const createSessionInfoBase = async (querystrings, headers, ip, clientName, environment, sessionInfo, props) => {
     const userId = querystrings.userId;
     const userAgent = (0, buildUserAgentInfos_1.default)(headers['user-agent'], querystrings);
     const client = {
         ...sessionInfo.client,
-        name,
+        name: clientName,
         type: index_1.CLIENT_TYPE,
         payload: {
             ...sessionInfo.client.payload,
@@ -41,12 +35,12 @@ const createSessionInfoBase = async (querystrings, headers, ip, name, sessionInf
         const userInfos = await props.requestUserInfos(querystrings);
         user = Object.assign({}, user, userInfos);
     }
-    return { client, user, contexts };
+    return { client, user, contexts, environment };
 };
-const createSessionInfo = (socket, name, sessionInfo, props) => async () => {
+const createSessionInfo = (socket, clientName, environment, sessionInfo, props) => async () => {
     const request = socket.request;
     const querystrings = socket.handshake.query;
     const ip = (0, extractIP_1.default)(request);
-    return await createSessionInfoBase(querystrings, request.headers, ip, name, sessionInfo, props);
+    return await createSessionInfoBase(querystrings, request.headers, ip, clientName, environment, sessionInfo, props);
 };
 exports.default = createSessionInfo;

package/dist/createSessionInfo.test.js

@@ -50,9 +50,10 @@ const createSessionInfo_1 = __importDefault(require("./createSessionInfo"));
         },
         user: { id: 'my-user-id', displayName: 'my user', payload: {} },
         contexts: [],
+        environment: 'PROD',
     };
     (0, globals_1.it)('without user payload', async () => {
-        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', defaultSessionInfo, {})();
+        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', 'TEST', defaultSessionInfo, {})();
         // client
         (0, globals_1.expect)(sessionInfo.client.name).toBe('my-client');
         (0, globals_1.expect)(sessionInfo.client.type).toBe('webclient');
@@ -82,7 +83,7 @@ const createSessionInfo_1 = __importDefault(require("./createSessionInfo"));
         const props = {
             requestUserInfos,
         };
-        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', defaultSessionInfo, props)();
+        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', 'TEST', defaultSessionInfo, props)();
         (0, globals_1.expect)(sessionInfo.user.id).toBe('hans.muster@PRIMARY');
         (0, globals_1.expect)(sessionInfo.user.displayName).toBe('Hans Muster');
         (0, globals_1.expect)(sessionInfo.user.payload.username).toBe('hans.muster');
@@ -96,10 +97,11 @@ const createSessionInfo_1 = __importDefault(require("./createSessionInfo"));
         const props = {
             requestUserInfos,
         };
-        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', defaultSessionInfo, props)();
+        const sessionInfo = await (0, createSessionInfo_1.default)(socket, 'my-client', 'TEST', defaultSessionInfo, props)();
         (0, globals_1.expect)(sessionInfo.user.id).toBe('user-id');
         (0, globals_1.expect)(sessionInfo.user.displayName).toBe('Webseiten Besucher');
         (0, globals_1.expect)(sessionInfo.user.locale).toBe('de_DE');
         (0, globals_1.expect)(sessionInfo.user.payload).toStrictEqual({});
+        (0, globals_1.expect)(sessionInfo.environment).toBe('TEST');
     });
 });

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { Client, SessionInfoUser } from '@botfabrik/engine-core';
+import type { Environment } from '@botfabrik/engine-domain';
 import { Action } from '@botfabrik/engine-domain';
 import { SpeechToTextProps } from './speechToText';
 import type { SessionInfoUserPayload, WebclientMiddlewareState } from './types';
@@ -23,6 +24,6 @@ export declare enum Devices {
     Desktop = "desktop",
     None = "none"
 }
-declare const _default: (name: string, props: WebClientProps) => Client<WebclientMiddlewareState>;
+declare const _default: (clientName: string, environment: Environment, props: WebClientProps) => Client<WebclientMiddlewareState>;
 export default _default;
 export declare const CLIENT_TYPE = "webclient";

package/dist/index.js

@@ -45,11 +45,11 @@ var Devices;
     Devices["Desktop"] = "desktop";
     Devices["None"] = "none";
 })(Devices = exports.Devices || (exports.Devices = {}));
-exports.default = (name, props) => async (bot) => {
+exports.default = (clientName, environment, props) => async (bot) => {
     const logger = bot.logger;
     bot.webserver.express.enable('trust proxy');
     bot.webserver.express.get('/', (_req, res) => {
-        res.redirect(`/${name}/embed`);
+        res.redirect(`/${clientName}/embed`);
     });
     // serve transcript pdf
     bot.webserver.express.use('/transcript-pdf/:sessionId', async (req, res) => {
@@ -66,14 +66,14 @@ exports.default = (name, props) => async (bot) => {
         }
     });
     // serve embed resources
-    bot.webserver.express.get(`/${name}/embed`, (req, res) => {
-        const server = `${req.protocol}://${req.get('host')}/${name}`;
+    bot.webserver.express.get(`/${clientName}/embed`, (req, res) => {
+        const server = `${req.protocol}://${req.get('host')}/${clientName}`;
         res.set('Content-Type', 'text/html; charset=utf-8');
         res.write((0, views_1.default)(server, `${server}/embed/bundle.js`));
         res.end();
     });
     if (!isFabVisible(props)) {
-        bot.webserver.express.get(`/${name}/embed/bundle.js`, (req, res) => {
+        bot.webserver.express.get(`/${clientName}/embed/bundle.js`, (req, res) => {
             const caller = req.query['caller'];
             if (caller === 'bookmarklet') {
                 res.sendFile(`${__dirname}/embed/bundle.js`);
@@ -85,23 +85,23 @@ exports.default = (name, props) => async (bot) => {
             }
         });
     }
-    bot.webserver.express.use(`/${name}/embed`, express.static(__dirname + '/embed', serveStaticOptions));
+    bot.webserver.express.use(`/${clientName}/embed`, express.static(__dirname + '/embed', serveStaticOptions));
     // serve chat client resources
-    bot.webserver.express.use(`/${name}`, express.static(__dirname + '/client', serveStaticOptions));
-    logger.info(`Webclient will be available on route: /${name}`);
-    const nsp = bot.webserver.socket.of(`/${name}/chat`);
+    bot.webserver.express.use(`/${clientName}`, express.static(__dirname + '/client', serveStaticOptions));
+    logger.info(`Webclient will be available on route: /${clientName}`);
+    const nsp = bot.webserver.socket.of(`/${clientName}/chat`);
     nsp.on('connection', async (socket) => {
         try {
             const querystrings = socket.handshake.query;
             const sessionsCollection = bot.store.db.collection('sessions');
-            const { sessionId, sessionInfo: defaultSessionInfo, isNew, } = await (0, requestSessionData_1.default)(querystrings, sessionsCollection, name, props);
+            const { sessionId, sessionInfo: defaultSessionInfo, isNew, } = await (0, requestSessionData_1.default)(querystrings, sessionsCollection, clientName, props);
             // create a channel for each session
             socket.join(sessionId);
-            const sessionInfo = await (0, createSessionInfo_1.default)(socket, name, defaultSessionInfo, props)();
+            const sessionInfo = await (0, createSessionInfo_1.default)(socket, clientName, environment, defaultSessionInfo, props)();
             const session = await bot.createSession(sessionId, sessionInfo);
             // sending active language and translations to client
             const clientLocale = (0, getSupportedClientLocale_1.default)(session.translator.locale);
-            nsp.to(sessionId).emit('set-translations', clientLocale, bot.translation.getResourceBundle(clientLocale)[name] || {});
+            nsp.to(sessionId).emit('set-translations', clientLocale, bot.translation.getResourceBundle(clientLocale)[clientName] || {});
             // sending persisted state to client
             const previousConversations = await (0, loadPreviousConversation_1.default)(bot.store, sessionId);
             nsp.to(sessionId).emit('restore-client-state', { sessionId, messages: previousConversations });
@@ -172,8 +172,8 @@ exports.default = (name, props) => async (bot) => {
         }
     });
     const client = {
-        name: `${name}Webclient`,
-        middleware: (0, middleware_1.default)(name, nsp),
+        name: `${clientName}Webclient`,
+        middleware: (0, middleware_1.default)(clientName, nsp),
     };
     return client;
 };

package/dist/requestSessionData.d.ts

@@ -6,5 +6,5 @@ interface SessionData {
     sessionInfo: SessionInfo<SessionInfoClientPayload, SessionInfoUserPayload>;
     isNew: boolean;
 }
-declare const requestSessionData: (querystrings: any, sessionsCollection: any, name: string, props: WebClientProps) => Promise<SessionData>;
+declare const requestSessionData: (querystrings: any, sessionsCollection: any, clientName: string, props: WebClientProps) => Promise<SessionData>;
 export default requestSessionData;

package/dist/requestSessionData.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const uuid_1 = require("uuid");
 const index_1 = require("./index");
-const requestSessionData = async (querystrings, sessionsCollection, name, props) => {
+const requestSessionData = async (querystrings, sessionsCollection, clientName, props) => {
     const baseQuery = {
         'sessionInfo.client.type': index_1.CLIENT_TYPE,
-        'sessionInfo.client.name': name,
+        'sessionInfo.client.name': clientName,
     };
     let findSessionRecordQuery = { _id: querystrings.sessionId, ...baseQuery };
     if (props.requestSessionRecordQuery) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@botfabrik/engine-webclient",
-    "version": "4.36.1",
+    "version": "4.37.3",
     "description": "Webclient for Botfabriks Bot Engine",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -18,10 +18,10 @@
         "prepublishOnly": "npm run build"
     },
     "dependencies": {
-        "@botfabrik/engine-core": "^4.36.0",
-        "@botfabrik/engine-domain": "^4.36.0",
-        "@botfabrik/engine-transcript-export": "^4.36.0",
-        "@botfabrik/engine-utils": "^4.36.0",
+        "@botfabrik/engine-core": "^4.37.2",
+        "@botfabrik/engine-domain": "^4.37.2",
+        "@botfabrik/engine-transcript-export": "^4.37.2",
+        "@botfabrik/engine-utils": "^4.37.2",
         "@google-cloud/speech": "^5.1.0",
         "accept-language-parser": "^1.5.0",
         "express": "^4.18.1",
@@ -40,5 +40,5 @@
         "rimraf": "^3.0.2",
         "typescript": "^4.8.3"
     },
-    "gitHead": "d9a7940c0c71e8d4753c2855ced22291bfd9b6ce"
+    "gitHead": "81b633ae15a6ce846176fe354d27dbaa6835706f"
 }