botium-core 1.15.5 → 1.15.8

package/dist/botium-es.js

@@ -35,7 +35,7 @@ import express from 'express';
 import bodyParser from 'body-parser';
 
 var name = "botium-core";
-var version$1 = "1.15.5";
+var version$1 = "1.15.8";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -273,6 +273,21 @@ var Capabilities = {
   SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH: 'SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH',
   SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT: 'SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT',
   SIMPLEREST_COOKIE_REPLICATION: 'SIMPLEREST_COOKIE_REPLICATION',
+  SIMPLEREST_NLP_INTENT_JSONPATH: 'SIMPLEREST_NLP_INTENT_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_CONFIDENCE_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100: 'SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100',
+  SIMPLEREST_NLP_FALLBACK_INTENTS: 'SIMPLEREST_NLP_FALLBACK_INTENTS',
+  SIMPLEREST_NLP_LIST_JSONPATH: 'SIMPLEREST_NLP_LIST_JSONPATH',
+  SIMPLEREST_NLP_LIST_INTENT_JSONPATH: 'SIMPLEREST_NLP_LIST_INTENT_JSONPATH',
+  SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH',
+  /**
+   * Single response can contain a list of messages. This capability defines how to merge the list into a single message.
+   * It can be 'OFF' (default), 'MERGE_TEXT'
+   * @type {string}
+   * @default 'OFF'
+   * @description Merge message list into single message
+   */
+  SIMPLEREST_MESSAGE_LIST_MERGE: 'SIMPLEREST_MESSAGE_LIST_MERGE',
   // Script Compiler
   SCRIPTING_TXT_EOL: 'SCRIPTING_TXT_EOL',
   // ROW_PER_MESSAGE or QUESTION_ANSWER
@@ -451,6 +466,14 @@ Capabilities.SIMPLEREST_REDIS_TOPIC;
 Capabilities.SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH;
 Capabilities.SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT;
 Capabilities.SIMPLEREST_COOKIE_REPLICATION;
+Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH;
+Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH;
+Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100;
+Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS;
+Capabilities.SIMPLEREST_NLP_LIST_JSONPATH;
+Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH;
+Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH;
+Capabilities.SIMPLEREST_MESSAGE_LIST_MERGE;
 Capabilities.SCRIPTING_TXT_EOL;
 Capabilities.SCRIPTING_XLSX_MODE;
 Capabilities.SCRIPTING_XLSX_EOL_WRITE;
@@ -8270,7 +8293,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       }, true, true), 0);
       return;
     }
-    const result = [];
+    let result = [];
     if (isFromUser) {
       const _extractFrom = (root, jsonPaths, acceptFn = null) => {
         const result = [];
@@ -8301,6 +8324,13 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       } else {
         jsonPathRoots.push(body);
       }
+      if (jsonPathRoots.length === 0 && !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+        debug$4(`found empty body, and processed because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(body)}`);
+        result.push({
+          messageText: '',
+          sourceData: body
+        });
+      }
       for (const jsonPathRoot of jsonPathRoots) {
         const _retrieveMedia = (jsonPathMediaRoot, jsonPathsMedia) => {
           const retrievedMedia = [];
@@ -8383,6 +8413,75 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
           }
         });
         debug$4(`found response cards: ${util.inspect(cards)}`);
+        let nlp = {
+          intent: {}
+        };
+        const _normalizeIntent = intent => {
+          if ('name' in intent) {
+            if (!intent.name) {
+              intent.name = 'None';
+            }
+            const fallbackIntents = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS];
+            if (fallbackIntents) {
+              intent.incomprehension = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS].includes(intent.name) ? true : undefined;
+            } else {
+              intent.incomprehension = intent.name.toLowerCase() === 'none' ? true : undefined;
+            }
+          }
+          if (!lodash.isNil(intent.confidence)) {
+            if (typeof intent.confidence === 'string') {
+              intent.confidence = Number(intent.confidence);
+            }
+            if (lodash.isNil(this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) ? intent.confidence > 1 : this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) {
+              intent.confidence /= 100;
+            }
+          }
+          return intent;
+        };
+        const jsonPathIntent = this.caps[Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH];
+        if (jsonPathIntent) {
+          const name = jsonpath.query(jsonPathRoot, jsonPathIntent);
+          nlp.intent.name = name?.length ? name[0] : null;
+        }
+        const jsonPathConfidence = this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH];
+        if (jsonPathConfidence) {
+          const confidence = jsonpath.query(jsonPathRoot, jsonPathConfidence);
+          nlp.intent.confidence = confidence?.length ? confidence[0] : null;
+        }
+        _normalizeIntent(nlp.intent);
+        const jsonPathList = this.caps[Capabilities.SIMPLEREST_NLP_LIST_JSONPATH];
+        const jsonPathListIntent = this.caps[Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH];
+        const jsonPathListConfidence = this.caps[Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH];
+        if (jsonPathList) {
+          const list = jsonpath.query(jsonPathRoot, jsonPathList);
+          if (list?.length) {
+            const intentList = list[0].map(e => {
+              const name = jsonpath.query(e, jsonPathListIntent);
+              const res = {
+                name: name?.length ? name[0] : null
+              };
+              if (jsonPathListConfidence) {
+                const confidence = jsonpath.query(e, jsonPathListConfidence);
+                res.confidence = confidence?.length ? confidence[0] : null;
+              }
+              _normalizeIntent(res);
+              return res;
+            });
+            if (intentList.length > 0 && !nlp.intent.name) {
+              nlp.intent.name = intentList[0].name;
+              nlp.intent.confidence = intentList[0].confidence;
+            }
+            if (nlp.intent.name === intentList[0].name) {
+              intentList.shift();
+            }
+            nlp.intent.intents = intentList;
+          }
+        }
+        if (Object.keys(nlp.intent).length > 0) {
+          debug$4(`found response nlp: ${util.inspect(nlp)}`);
+        } else {
+          nlp = null;
+        }
         let hasMessageText = false;
         const jsonPathsTexts = getAllCapValues(Capabilities.SIMPLEREST_RESPONSE_JSONPATH, this.caps);
         for (const jsonPath of jsonPathsTexts) {
@@ -8398,7 +8497,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
               messageText,
               media,
               buttons,
-              cards
+              nlp
             };
             await executeHook(this.caps, this.responseHook, Object.assign({
               botMsg,
@@ -8414,7 +8513,8 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
             sourceData: body,
             media,
             buttons,
-            cards
+            cards,
+            nlp
           };
           const beforeHookKeys = Object.keys(botMsg);
           await executeHook(this.caps, this.responseHook, Object.assign({
@@ -8422,8 +8522,13 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
             botMsgRoot: jsonPathRoot
           }, this.view));
           const afterHookKeys = Object.keys(botMsg);
-          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || botMsg.nlp) {
             result.push(botMsg);
+          } else if (!this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+            debug$4(`found empty message, and processed because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(botMsg)}`);
+            result.push(botMsg);
+          } else {
+            debug$4(`found empty message, and ignored because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(botMsg)}`);
           }
         }
       }
@@ -8435,6 +8540,21 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
         messageText: ''
       }, true, true), 0);
     }
+    if (this.caps[Capabilities.SIMPLEREST_MESSAGE_LIST_MERGE] === 'MERGE_TEXT') {
+      const isTextMsg = msg => msg.messageText && (!msg.media || msg.media.length === 0) && (!msg.buttons || msg.buttons.length === 0) && (!msg.cards || msg.cards.length === 0);
+      result = result.reduce((acc, currentMsg) => {
+        if (acc.length > 0) {
+          const last = acc[acc.length - 1];
+          if (isTextMsg(last)) {
+            currentMsg.messageText = [last.messageText, currentMsg.messageText].filter(t => t).join('\n');
+            acc[acc.length - 1] = currentMsg;
+            return acc;
+          }
+        }
+        acc.push(currentMsg);
+        return acc;
+      }, []);
+    }
     return result;
   }
   _doRequest(msg, isFromUser, updateContext) {
@@ -8447,8 +8567,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
         fetch(requestOptions.uri, requestOptions).then(async bodyRaw => {
           let body;
           try {
-            const contentType = bodyRaw.headers.get('content-type');
-            if (contentType && contentType.includes('application/json')) {
+            if (bodyRaw?.headers?.get('content-type') && bodyRaw.headers.get('content-type').includes('application/json')) {
               try {
                 body = await bodyRaw.json();
               } catch (err) {