wingbot 3.48.0 → 3.49.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.48.0",
+  "version": "3.49.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {

package/src/analytics/onInteractionHandler.js

@@ -32,6 +32,7 @@ const {
  * @prop {string} [label]
  * @prop {number} [value]
  * @prop {string} [lang]
+ * @prop {string|null} [pageCategory]
  */
 
 /**
@@ -60,6 +61,8 @@ const {
  * @prop {string} [intent]
  * @prop {number} [intentScore]
  * @prop {string[]|string} [entities]
+ * @prop {string|null} [pagePath]
+ * @prop {string|null} [pageCategory]
  * @prop {string[]|string} allActions
  * @prop {boolean} nonInteractive
  *
@@ -96,6 +99,8 @@ const {
  * @prop {number} [sessionStart]
  * @prop {number} [sessionDuration]
  * @prop {string[]} [responseTexts]
+ * @prop {string|null} [pagePath]
+ * @prop {string|null} [pageCategory]
  */
 
 /**
@@ -153,6 +158,12 @@ const {
  * @returns {string}
  */
 
+/**
+ * @callback PathCategoryExtractor
+ * @param {string} pathName
+ * @returns {string}
+ */
+
 /**
  * @typedef {object} TrackingEvents
  * @prop {TrackingEvent[]} events
@@ -165,6 +176,7 @@ const {
 
 /**
  * @typedef {object} HandlerConfig
+ * @prop {string} [pagePathVar]
  * @prop {string} [snapshot]
  * @prop {string} [botId]
  * @prop {string} [timeZone] - default UTC
@@ -173,6 +185,7 @@ const {
  * @prop {IGALogger} [log] - console like logger
  * @prop {Anonymizer} [anonymize] - text anonymization function
  * @prop {UserExtractor} [userExtractor] - text anonymization function
+ * @prop {PathCategoryExtractor} [pathCategoryExtractor]
  */
 
 /**
@@ -192,6 +205,17 @@ const {
  * @returns {Promise}
  */
 
+function defaultPathExtractor (pathName) {
+    if (!pathName) {
+        return null;
+    }
+
+    const [firstElem] = pathName.split('/')
+        .filter((e) => !!e);
+
+    return firstElem || '/';
+}
+
 /**
  *
  * @param {HandlerConfig} config
@@ -207,6 +231,8 @@ function onInteractionHandler (
         snapshot,
         botId,
         timeZone = 'UTC',
+        pagePathVar = '§pathname',
+        pathCategoryExtractor = defaultPathExtractor,
         anonymize = (x) => x,
         userExtractor = (state) => null // eslint-disable-line no-unused-vars
     },
@@ -233,7 +259,7 @@ function onInteractionHandler (
         req,
         actions,
         lastAction,
-        // state,
+        state,
         // data,
         skill,
         events,
@@ -258,8 +284,11 @@ function onInteractionHandler (
                 _sid: sessionId,
                 _sst: sessionStart,
                 _sts: sessionTs,
-                lang
-            } = req.state;
+                lang,
+                [pagePathVar]: pagePath
+            } = state;
+
+            const pageCategory = pathCategoryExtractor(pagePath);
 
             const trackEvents = [];
 
@@ -297,7 +326,9 @@ function onInteractionHandler (
                 timeZone,
                 sessionStart,
                 responseTexts,
-                sessionDuration: sessionTs - sessionStart
+                sessionDuration: sessionTs - sessionStart,
+                pagePath,
+                pageCategory
             };
 
             let sessionPromise;
@@ -391,7 +422,9 @@ function onInteractionHandler (
                 intentScore: score,
                 entities: asArray(req.entities.map((e) => e.entity)),
                 text,
-                allActions
+                allActions,
+                pagePath,
+                pageCategory
             };
 
             const notHandled = actions.some((a) => a.match(/\*$/)) && !req.isQuickReply();
@@ -513,6 +546,7 @@ function onInteractionHandler (
                     action,
                     label,
                     value,
+                    pageCategory,
                     ...langsExtension
                 });
             }