botium-core 1.12.2 → 1.12.3

package/dist/botium-es.js

@@ -36,7 +36,7 @@ import express from 'express';
 import bodyParser from 'body-parser';
 
 var name = "botium-core";
-var version$1 = "1.12.2";
+var version$1 = "1.12.3";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -68,7 +68,7 @@ var bugs = {
 };
 var homepage = "https://www.botium.ai";
 var dependencies = {
-	"@babel/runtime": "^7.16.7",
+	"@babel/runtime": "^7.17.2",
 	async: "^3.2.3",
 	"body-parser": "^1.19.1",
 	boolean: "^3.1.4",
@@ -78,7 +78,7 @@ var dependencies = {
 	esprima: "^4.0.1",
 	express: "^4.17.2",
 	globby: "11.0.4",
-	ioredis: "^4.28.3",
+	ioredis: "^4.28.5",
 	"is-class": "^0.0.9",
 	"is-json": "^2.0.1",
 	jsonpath: "^1.1.1",
@@ -101,21 +101,21 @@ var dependencies = {
 	"swagger-jsdoc": "^6.1.0",
 	"swagger-ui-express": "^4.3.0",
 	uuid: "^8.3.2",
-	vm2: "^3.9.5",
+	vm2: "^3.9.7",
 	"write-yaml": "^1.0.0",
-	xlsx: "^0.17.5",
+	xlsx: "^0.18.2",
 	xregexp: "^5.1.0",
 	yaml: "^1.10.2"
 };
 var devDependencies = {
-	"@babel/core": "^7.16.12",
+	"@babel/core": "^7.17.2",
 	"@babel/node": "^7.16.8",
-	"@babel/plugin-transform-runtime": "^7.16.10",
+	"@babel/plugin-transform-runtime": "^7.17.0",
 	"@babel/preset-env": "^7.16.11",
-	chai: "^4.3.4",
+	chai: "^4.3.6",
 	"chai-as-promised": "^7.1.1",
 	"cross-env": "^7.0.3",
-	eslint: "^8.7.0",
+	eslint: "^8.9.0",
 	"eslint-config-standard": "^16.0.3",
 	"eslint-plugin-import": "^2.25.4",
 	"eslint-plugin-node": "^11.1.0",
@@ -124,10 +124,10 @@ var devDependencies = {
 	"license-checker": "^25.0.1",
 	"license-compatibility-checker": "^0.3.5",
 	mocha: "^9.2.0",
-	nock: "^13.2.2",
-	"npm-check-updates": "^12.2.1",
+	nock: "^13.2.4",
+	"npm-check-updates": "^12.3.0",
 	nyc: "^15.1.0",
-	rollup: "^2.66.0",
+	rollup: "^2.67.2",
 	"rollup-plugin-babel": "^4.4.0",
 	"rollup-plugin-commonjs": "^10.1.0",
 	"rollup-plugin-json": "^4.0.0",
@@ -244,6 +244,11 @@ var Capabilities = {
   SIMPLEREST_RESPONSE_HOOK: 'SIMPLEREST_RESPONSE_HOOK',
   SIMPLEREST_MEDIA_JSONPATH: 'SIMPLEREST_MEDIA_JSONPATH',
   SIMPLEREST_BUTTONS_JSONPATH: 'SIMPLEREST_BUTTONS_JSONPATH',
+  SIMPLEREST_CARDS_JSONPATH: 'SIMPLEREST_CARDS_JSONPATH',
+  SIMPLEREST_CARD_TEXT_JSONPATH: 'SIMPLEREST_CARD_TEXT_JSONPATH',
+  SIMPLEREST_CARD_SUBTEXT_JSONPATH: 'SIMPLEREST_CARD_SUBTEXT_JSONPATH',
+  SIMPLEREST_CARD_BUTTONS_JSONPATH: 'SIMPLEREST_CARD_BUTTONS_JSONPATH',
+  SIMPLEREST_CARD_ATTACHMENTS_JSONPATH: 'SIMPLEREST_CARD_ATTACHMENTS_JSONPATH',
   SIMPLEREST_CONTEXT_JSONPATH: 'SIMPLEREST_CONTEXT_JSONPATH',
   SIMPLEREST_CONTEXT_MERGE_OR_REPLACE: 'SIMPLEREST_CONTEXT_MERGE_OR_REPLACE',
   SIMPLEREST_CONVERSATION_ID_TEMPLATE: 'SIMPLEREST_CONVERSATION_ID_TEMPLATE',
@@ -390,6 +395,11 @@ Capabilities.SIMPLEREST_RESPONSE_JSONPATH;
 Capabilities.SIMPLEREST_RESPONSE_HOOK;
 Capabilities.SIMPLEREST_MEDIA_JSONPATH;
 Capabilities.SIMPLEREST_BUTTONS_JSONPATH;
+Capabilities.SIMPLEREST_CARDS_JSONPATH;
+Capabilities.SIMPLEREST_CARD_TEXT_JSONPATH;
+Capabilities.SIMPLEREST_CARD_SUBTEXT_JSONPATH;
+Capabilities.SIMPLEREST_CARD_BUTTONS_JSONPATH;
+Capabilities.SIMPLEREST_CARD_ATTACHMENTS_JSONPATH;
 Capabilities.SIMPLEREST_CONTEXT_JSONPATH;
 Capabilities.SIMPLEREST_CONTEXT_MERGE_OR_REPLACE;
 Capabilities.SIMPLEREST_CONVERSATION_ID_TEMPLATE;
@@ -498,7 +508,6 @@ var Defaults$1 = {
     [Capabilities.SIMPLEREST_METHOD]: 'GET',
     [Capabilities.SIMPLEREST_IGNORE_EMPTY]: true,
     [Capabilities.SIMPLEREST_TIMEOUT]: 10000,
-    [Capabilities.SIMPLEREST_EXTRA_OPTIONS]: {},
     [Capabilities.SIMPLEREST_STRICT_SSL]: true,
     [Capabilities.SIMPLEREST_INBOUND_UPDATE_CONTEXT]: true,
     [Capabilities.SIMPLEREST_CONTEXT_MERGE_OR_REPLACE]: 'MERGE',
@@ -8384,31 +8393,82 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       }
 
       for (const jsonPathRoot of jsonPathRoots) {
-        const media = [];
-        const buttons = [];
-        const jsonPathsMedia = getAllCapValues(Capabilities.SIMPLEREST_MEDIA_JSONPATH, this.caps);
-        jsonPathsMedia.forEach(jsonPath => {
-          const responseMedia = jsonpath.query(jsonPathRoot, jsonPath);
-
-          if (responseMedia) {
-            (lodash.isArray(responseMedia) ? lodash.flattenDeep(responseMedia) : [responseMedia]).forEach(m => media.push({
-              mediaUri: m,
-              mimeType: mimeTypes.lookup(m) || 'application/unknown'
-            }));
-            debug$4(`found response media: ${util.inspect(media)}`);
+        const _retrieveMedia = (jsonPathMediaRoot, jsonPathsMedia) => {
+          const retrievedMedia = [];
+          jsonPathsMedia.forEach(jsonPath => {
+            const responseMedia = jsonpath.query(jsonPathMediaRoot, jsonPath);
+
+            if (responseMedia) {
+              (lodash.isArray(responseMedia) ? lodash.flattenDeep(responseMedia) : [responseMedia]).forEach(m => retrievedMedia.push({
+                mediaUri: m,
+                mimeType: mimeTypes.lookup(m) || 'application/unknown'
+              }));
+            }
+          });
+          return retrievedMedia;
+        };
+
+        const _retrieveButtons = (jsonPathButtonRoot, jsonPathsButtons) => {
+          const retrievedButtons = [];
+          jsonPathsButtons.forEach(jsonPath => {
+            const responseButtons = jsonpath.query(jsonPathButtonRoot, jsonPath);
+
+            if (responseButtons) {
+              (lodash.isArray(responseButtons) ? lodash.flattenDeep(responseButtons) : [responseButtons]).forEach(b => retrievedButtons.push({
+                text: b
+              }));
+            }
+          });
+          return retrievedButtons;
+        };
+
+        const _getCardText = responseCardText => {
+          if (responseCardText) {
+            const texts = lodash.isArray(responseCardText) ? lodash.flattenDeep(responseCardText) : [responseCardText];
+
+            if (texts.length > 1) {
+              debug$4(`more than one text found for card: ${util.inspect(texts)}`);
+            }
+
+            if (texts.length > 0) {
+              return texts[0];
+            }
           }
-        });
-        const jsonPathsButtons = getAllCapValues(Capabilities.SIMPLEREST_BUTTONS_JSONPATH, this.caps);
-        jsonPathsButtons.forEach(jsonPath => {
-          const responseButtons = jsonpath.query(jsonPathRoot, jsonPath);
-
-          if (responseButtons) {
-            (lodash.isArray(responseButtons) ? lodash.flattenDeep(responseButtons) : [responseButtons]).forEach(b => buttons.push({
-              text: b
-            }));
-            debug$4(`found response buttons: ${util.inspect(buttons)}`);
+        };
+
+        const media = _retrieveMedia(jsonPathRoot, getAllCapValues(Capabilities.SIMPLEREST_MEDIA_JSONPATH, this.caps));
+
+        debug$4(`found response media: ${util.inspect(media)}`);
+
+        const buttons = _retrieveButtons(jsonPathRoot, getAllCapValues(Capabilities.SIMPLEREST_BUTTONS_JSONPATH, this.caps));
+
+        debug$4(`found response buttons: ${util.inspect(buttons)}`);
+        const cards = [];
+        const jsonPathsCards = getAllCapValues(Capabilities.SIMPLEREST_CARDS_JSONPATH, this.caps);
+        jsonPathsCards.forEach(jsonPath => {
+          const responseCards = jsonpath.query(jsonPathRoot, jsonPath);
+
+          if (responseCards) {
+            (lodash.isArray(responseCards) ? lodash.flattenDeep(responseCards) : [responseCards]).forEach(c => {
+              const card = {};
+              const jsonPathsCardText = getAllCapValues(Capabilities.SIMPLEREST_CARD_TEXT_JSONPATH, this.caps);
+              jsonPathsCardText.forEach(jsonPath => {
+                card.text = _getCardText(jsonpath.query(c, jsonPath));
+              });
+              const jsonPathsCardSubText = getAllCapValues(Capabilities.SIMPLEREST_CARD_SUBTEXT_JSONPATH, this.caps);
+              jsonPathsCardSubText.forEach(jsonPath => {
+                card.subtext = _getCardText(jsonpath.query(c, jsonPath));
+              });
+              card.buttons = _retrieveButtons(c, getAllCapValues(Capabilities.SIMPLEREST_CARD_BUTTONS_JSONPATH, this.caps));
+              card.media = _retrieveMedia(c, getAllCapValues(Capabilities.SIMPLEREST_CARD_ATTACHMENTS_JSONPATH, this.caps));
+
+              if (lodash.keys(card).length > 0) {
+                cards.push(card);
+              }
+            });
           }
         });
+        debug$4(`found response cards: ${util.inspect(cards)}`);
         let hasMessageText = false;
         const jsonPathsTexts = getAllCapValues(Capabilities.SIMPLEREST_RESPONSE_JSONPATH, this.caps);
 
@@ -8425,7 +8485,8 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
               sourceData: body,
               messageText,
               media,
-              buttons
+              buttons,
+              cards
             };
             await executeHook(this.caps, this.responseHook, Object.assign({
               botMsg,
@@ -8441,7 +8502,8 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
             messageText: '',
             sourceData: body,
             media,
-            buttons
+            buttons,
+            cards
           };
           const beforeHookKeys = Object.keys(botMsg);
           await executeHook(this.caps, this.responseHook, Object.assign({
@@ -8450,7 +8512,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
           }, 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 || !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 || !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
             result.push(botMsg);
           }
         }
@@ -9416,9 +9478,9 @@ var BotDriver_1 = class BotDriver {
 
   Build() {
     debug$1(`Build - Botium Core Version: ${version}`);
-    debug$1(`Build - Capabilites: ${util.inspect(this.caps)}`);
-    debug$1(`Build - Sources : ${util.inspect(this.sources)}`);
-    debug$1(`Build - Envs : ${util.inspect(this.envs)}`);
+    debug$1(`Build - Capabilites: ${JSON.stringify(lodash.pickBy(this.caps, (value, key) => Defaults$1.Capabilities[key] !== value), null, 2)}`);
+    debug$1(`Build - Sources: ${JSON.stringify(lodash.pickBy(this.sources, (value, key) => Defaults$1.Sources[key] !== value), null, 2)}`);
+    debug$1(`Build - Envs: ${JSON.stringify(lodash.pickBy(this.envs, (value, key) => Defaults$1.Envs[key] !== value), null, 2)}`);
     this.eventEmitter.emit(Events.CONTAINER_BUILDING);
     return new Promise((resolve, reject) => {
       let repo = null;