botium-core 1.15.6 → 1.15.9

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.6";
+var version$1 = "1.15.9";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -280,6 +280,14 @@ var Capabilities = {
   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
@@ -465,6 +473,7 @@ 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;
@@ -6046,12 +6055,18 @@ var ScriptingProvider_1 = class ScriptingProvider {
     if (hookType !== 'onMeStart' && hookType !== 'onMePrepare' && hookType !== 'onMeEnd' && hookType !== 'onBotStart' && hookType !== 'onBotPrepare' && hookType !== 'onBotEnd' && hookType !== 'onConvoBegin' && hookType !== 'onConvoEnd') {
       throw Error(`Unknown hookType ${hookType}`);
     }
-    const localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType]);
+    let localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType]);
+    // Scripting memory file are injected via SET_SCRIPTING_MEMORY in the BEGIN step
+    // But there might be other logic hooks that need the scripting memory variables
+    // Order is important (SET_SCRIPTING_MEMORY in begin can be because the user added it,
+    // or because the scripting memory file added it. User one has to be the last one.
+    localHooks = [...localHooks.filter(l => l.name === 'SET_SCRIPTING_MEMORY'), ...localHooks.filter(l => l.name !== 'SET_SCRIPTING_MEMORY')];
     const convoStepPromises = localHooks.map(l => p(this.retryHelperLogicHook, () => this.logicHooks[l.name][hookType]({
       convo,
       convoStep,
       scriptingMemory,
       container,
+      // Do this more sensitve for SET_SCRIPTING_MEMORY? It can have scripting variables in the args
       args: ScriptingMemory.applyToArgs(l.args, scriptingMemory, container.caps, rest.botMsg),
       isGlobal: false,
       ...rest
@@ -8284,7 +8299,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       }, true, true), 0);
       return;
     }
-    const result = [];
+    let result = [];
     if (isFromUser) {
       const _extractFrom = (root, jsonPaths, acceptFn = null) => {
         const result = [];
@@ -8315,6 +8330,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 = [];
@@ -8506,8 +8528,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 || botMsg.nlp || !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)}`);
           }
         }
       }
@@ -8519,6 +8546,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) {
@@ -8531,8 +8573,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) {
@@ -9494,8 +9535,8 @@ var BotDriver_1 = class BotDriver {
         if (lodash.isString(newCaps[capKey])) {
           try {
             caps[capKey] = JSON.parse(newCaps[capKey]);
-            if (lodash.isFinite(caps[capKey])) {
-              caps[capKey] = caps[capKey].toString();
+            if (lodash.isFinite(Number(newCaps[capKey]))) {
+              caps[capKey] = newCaps[capKey].toString();
             }
           } catch (err) {
             caps[capKey] = newCaps[capKey];