@botfabrik/engine-webclient 4.104.15 → 4.104.17

package/dist/index.js

@@ -52,14 +52,18 @@ export default (clientName, environment, props) => async (bot) => {
         res.write(index(serverUrl.toString(), `${server}/embed/bundle.js`));
         res.end();
     });
-    if (!isFabVisible(props)) {
+    if (!isFabAlwaysVisible(props)) {
         bot.webserver.express.get(`/${clientName}/embed/bundle.js`, (req, res) => {
             const caller = req.query['caller'];
             const referer = req.get('referer');
-            if (caller === 'bookmarklet' ||
-                referer
-                    ?.toLowerCase()
-                    .startsWith(bot.webserver.baseUrl.toLowerCase())) {
+            const visibleUrls = Array.isArray(props.fabVisible)
+                ? props.fabVisible
+                : [];
+            const isFromBaseUrl = referer
+                ?.toLowerCase()
+                .includes(bot.webserver.baseUrl.toLowerCase());
+            const isFromVisibleUrl = visibleUrls.some((url) => referer?.toLowerCase().startsWith(url.toLowerCase()));
+            if (caller === 'bookmarklet' || isFromBaseUrl || isFromVisibleUrl) {
                 res.sendFile(`${__dirname}/embed/bundle.js`);
             }
             else {
@@ -126,7 +130,7 @@ const serveStaticOptions = {
         }
     },
 };
-const isFabVisible = ({ fabVisible = true }) => fabVisible;
+const isFabAlwaysVisible = ({ fabVisible = true }) => typeof fabVisible === 'boolean' ? fabVisible : false;
 const onTerminateSession = (socket, bot) => async ({ sessionId, // passed if the user wants to restart the chat
  }) => {
     const session = await bot.createSession(sessionId);

package/dist/types.d.ts

@@ -8,8 +8,8 @@ export type ConversationRating = {
     value: number;
     feedback: string;
 };
-export type SessionInfoUserPayload = {};
-export type WebclientMiddlewareState = {};
+export type SessionInfoUserPayload = object;
+export type WebclientMiddlewareState = object;
 export type RequestUserInfos = (querystrings: any) => Promise<Partial<SessionInfoUser<SessionInfoUserPayload>>>;
 export type RequestSessionRecordQuery = (params: {
     querystrings: any;
@@ -91,7 +91,19 @@ export interface WebClientProps {
     requestSessionRecordQuery?: RequestSessionRecordQuery;
     speech?: SpeechToTextProps | undefined;
     expandChatWindowAtStart?: Devices;
-    fabVisible?: boolean;
+    /**
+     * Controls the visibility of the FAB.
+     *
+     * - If set to `true`, the FAB is always visible.
+     * - If set to `false`, the FAB is hidden.
+     * - If set to an array of strings, the FAB will only be visible when the web client is accessed from a page
+     *   whose URL includes one of the specified strings.
+     *
+     * The FAB is always visible on the base URL pages and bookmarklet.
+     *
+     * @default true
+     */
+    fabVisible?: boolean | string[];
     /**
      * SAML authentication configuration for the web client.
      * If set, users must authenticate via SAML before accessing the chat.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botfabrik/engine-webclient",
-  "version": "4.104.15",
+  "version": "4.104.17",
   "description": "Webclient for Botfabriks Bot Engine",
   "type": "module",
   "main": "./dist/index.js",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@botfabrik/engine-domain": "^4.104.14",
-    "@botfabrik/engine-transcript-export": "^4.104.14",
+    "@botfabrik/engine-transcript-export": "^4.104.16",
     "@botfabrik/engine-utils": "^4.104.14",
     "@google-cloud/speech": "^7.2.1",
     "@node-saml/passport-saml": "^5.1.0",
@@ -50,5 +50,5 @@
     "tsx": "^4.21.0",
     "typescript": "5.9.3"
   },
-  "gitHead": "0fe554a465082ade413eb55610d9dc6885e5e8b6"
+  "gitHead": "517482ad1f063dbdfdf50d855b72049af97d94d5"
 }