@botfabrik/engine-webclient 4.121.7 → 4.122.0

package/README.md

@@ -135,18 +135,27 @@ Beispiel
 
 Eine Liste von projektspezifischen Einträgen, die im Chat-Menü angezeigt werden sollen.
 
-### requestUserInfos (optional)
+### enrichUserInfo (optional)
 
 Diese Funktion wird beim Erzeugen eines neuen Session Records aufgerufen. Man hat damit die Möglichkeit, die Session Daten unter `session.getSessionInfo().user` projektspezifisch anzupassen.
 
-Die Funktion erhält als Parameter sämtliche Querystrings in Form eines JSON Objektes. Als Resultat wird wiederum ein JSON Objekt erwartet. Alle Werte unter `session.getSessionInfo().user` werden damit überschrieben.
+Die Funktion erhält als Parameter ein Objekt mit folgenden Eigenschaften:
+
+- `user` – Das aktuelle Session-User-Objekt, aufgebaut aus Authentifizierung und Query-Parametern.
+- `querystrings` – Die geparsten Query-Parameter der Client-URL.
+- `headers` – Die eingehenden HTTP-Request-Header.
+- `ip` – Die IP-Adresse des Clients (oder `undefined`).
+
+Als Resultat wird ein partielles User-Info-Objekt erwartet. Dessen Eigenschaften werden in die bestehenden User-Daten eingemergt.
 
 Beispiel:
 
 ```typescript
-export default async (querystrings: any): Promise<any> => {
+const enrichUserInfo: EnrichUserInfo = async ({ querystrings }) => {
   const accessToken = querystrings.accessToken;
-  const userProfile: UserProfile = await fetchUserProfile(accessToken);
+  const userProfile: UserProfile = await fetchUserProfile(
+    accessToken as string
+  );
 
   return {
     id: userProfile.username + '@' + userProfile.domain,

package/dist/createSessionInfo.js

@@ -1,12 +1,16 @@
 import { CLIENT_TYPE } from './constants.js';
-const createSessionInfoBase = async (userId, querystrings, headers, clientName, environment, sessionInfo, locale, authenticatedUser, props) => {
+const createSessionInfo = (socket, clientName, environment, sessionInfo, userId, locale, querystrings, authenticatedUser, props) => async () => {
+    const headers = socket.request.headers;
+    const ip = extractIpFromSocket(socket);
     const client = {
         ...sessionInfo.client,
         name: clientName,
         type: CLIENT_TYPE,
         payload: {
             ...sessionInfo.client.payload,
-            referrer: decodeURIComponent(querystrings['referrer'] || headers['referer'] || 'unknown'),
+            referrer: decodeURIComponent(querystrings['referrer'] ||
+                headers['referer'] ||
+                'unknown'),
             querystrings,
         },
     };
@@ -29,17 +33,17 @@ const createSessionInfoBase = async (userId, querystrings, headers, clientName,
         locale,
     };
     const contexts = sessionInfo.contexts;
-    // enhance user infos
-    if (props.requestUserInfos) {
-        const userInfos = await props.requestUserInfos(querystrings);
-        user = Object.assign({}, user, userInfos);
+    if (props.enrichUserInfo) {
+        const userInfos = await props.enrichUserInfo({
+            user,
+            querystrings,
+            headers,
+            ip,
+        });
+        user = { ...user, ...userInfos };
     }
     return { client, user, contexts, environment };
 };
-const createSessionInfo = (socket, clientName, environment, sessionInfo, userId, locale, querystrings, authenticatedUser, props) => async () => {
-    const request = socket.request;
-    return await createSessionInfoBase(userId, querystrings, request.headers, clientName, environment, sessionInfo, locale, authenticatedUser, props);
-};
 const guestNamesFromEMail = (email) => {
     try {
         const namePart = email?.split('@')[0];
@@ -61,4 +65,15 @@ const capitalize = (s) => {
         return '';
     return s.charAt(0).toUpperCase() + s.slice(1);
 };
+const extractIpFromSocket = (socket) => {
+    const headers = socket.handshake.headers;
+    const forwarded = headers['x-forwarded-for'];
+    if (typeof forwarded === 'string') {
+        return forwarded.split(',')[0]?.trim();
+    }
+    if (Array.isArray(forwarded) && forwarded.length > 0) {
+        return forwarded[0];
+    }
+    return socket.handshake.address;
+};
 export default createSessionInfo;

package/dist/createSessionInfo.test.js

@@ -22,6 +22,7 @@ describe('create session info', () => {
         },
         handshake: {
             query: querystrings,
+            headers,
         },
     };
     const webClientProps = {
@@ -54,7 +55,7 @@ describe('create session info', () => {
         expect(sessionInfo.user.payload).toStrictEqual({});
     });
     it('with enhanced user data', async () => {
-        const requestUserInfos = async () => {
+        const enrichUserInfo = async () => {
             const userProfile = {
                 username: 'hans.muster',
                 domain: 'PRIMARY',
@@ -69,7 +70,7 @@ describe('create session info', () => {
         };
         const props = {
             ...webClientProps,
-            requestUserInfos,
+            enrichUserInfo,
         };
         const sessionInfo = await createSessionInfo(socket, 'my-client', 'TEST', defaultSessionInfo, 'my-user-id', 'de_DE', {}, undefined, props)();
         expect(sessionInfo.user.id).toBe('hans.muster@PRIMARY');

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 import type { Action, SessionInfoUser } from '@botfabrik/engine-domain';
+import { IncomingHttpHeaders } from 'node:http';
+import { ParsedUrlQuery } from 'node:querystring';
 export type SessionInfoClientPayload = {
     querystrings: any;
     referrer: string;
@@ -10,9 +12,26 @@ export type ConversationRating = {
 };
 export type SessionInfoUserPayload = object;
 export type WebclientMiddlewareState = object;
-export type RequestUserInfos = (querystrings: any) => Promise<Partial<SessionInfoUser<SessionInfoUserPayload>>>;
+/**
+ * Callback to enrich the user's session info with additional data from an external source.
+ *
+ * Called during session initialization with the current user, query strings, and HTTP headers.
+ * The returned partial object is merged into the existing user info.
+ *
+ * @param props.user - The current session user object built from authentication and query parameters.
+ * @param props.querystrings - The parsed query string parameters from the client URL.
+ * @param props.headers - The incoming HTTP request headers.
+ * @param props.ip - The client's IP address, extracted from the socket connection.
+ * @returns A promise resolving to a partial user info object whose properties will be merged into the session user.
+ */
+export type EnrichUserInfo = (props: {
+    user: SessionInfoUser<SessionInfoUserPayload>;
+    querystrings: ParsedUrlQuery;
+    headers: IncomingHttpHeaders;
+    ip: string | undefined;
+}) => Promise<Partial<SessionInfoUser<SessionInfoUserPayload>>>;
 export type RequestSessionRecordQuery = (params: {
-    querystrings: any;
+    querystrings: ParsedUrlQuery;
     sessionId: string;
 }) => Promise<Record<string, unknown>>;
 export type MenuItemType = 'link' | 'action';
@@ -87,7 +106,11 @@ export type Auth = {
 };
 export interface WebClientProps {
     getStartedAction?: Action;
-    requestUserInfos?: RequestUserInfos;
+    /**
+     * Optional callback to enrich the user's session info with additional data.
+     * See {@link EnrichUserInfo} for details.
+     */
+    enrichUserInfo?: EnrichUserInfo;
     requestSessionRecordQuery?: RequestSessionRecordQuery;
     speech?: SpeechToTextProps | undefined;
     expandChatWindowAtStart?: Devices;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botfabrik/engine-webclient",
-  "version": "4.121.7",
+  "version": "4.122.0",
   "description": "Webclient for Botfabriks Bot Engine",
   "type": "module",
   "main": "./dist/index.js",
@@ -55,5 +55,5 @@
     "tsx": "^4.22.3",
     "typescript": "6.0.3"
   },
-  "gitHead": "35ddae6f6e337b775ebde3567f67d3878fde1dc1"
+  "gitHead": "a44d1eec77571e783f80f244474873f286a3e83b"
 }