botium-core 1.12.1 → 1.12.4

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.1";
+var version$1 = "1.12.4";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -68,23 +68,23 @@ var bugs = {
 };
 var homepage = "https://www.botium.ai";
 var dependencies = {
-	"@babel/runtime": "^7.16.7",
+	"@babel/runtime": "^7.17.8",
 	async: "^3.2.3",
-	"body-parser": "^1.19.1",
-	boolean: "^3.1.4",
+	"body-parser": "^1.19.2",
+	boolean: "^3.2.0",
 	bottleneck: "^2.19.5",
 	"csv-parse": "^5.0.4",
-	debug: "^4.3.3",
+	debug: "^4.3.4",
 	esprima: "^4.0.1",
-	express: "^4.17.2",
+	express: "^4.17.3",
 	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",
 	lodash: "^4.17.21",
 	"markdown-it": "^12.3.2",
-	"mime-types": "^2.1.34",
+	"mime-types": "^2.1.35",
 	mkdirp: "^1.0.4",
 	moment: "^2.29.1",
 	mustache: "^4.2.0",
@@ -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.9",
 	"write-yaml": "^1.0.0",
-	xlsx: "^0.17.5",
+	xlsx: "^0.18.4",
 	xregexp: "^5.1.0",
 	yaml: "^1.10.2"
 };
 var devDependencies = {
-	"@babel/core": "^7.16.12",
+	"@babel/core": "^7.17.8",
 	"@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.11.0",
 	"eslint-config-standard": "^16.0.3",
 	"eslint-plugin-import": "^2.25.4",
 	"eslint-plugin-node": "^11.1.0",
@@ -123,11 +123,11 @@ var devDependencies = {
 	"eslint-plugin-standard": "^4.1.0",
 	"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",
+	mocha: "^9.2.2",
+	nock: "^13.2.4",
+	"npm-check-updates": "^12.5.4",
 	nyc: "^15.1.0",
-	rollup: "^2.66.0",
+	rollup: "^2.70.1",
 	"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',
@@ -314,6 +319,7 @@ var Capabilities = {
   // API Calls Rate Limiting
   RATELIMIT_USERSAYS_MAXCONCURRENT: 'RATELIMIT_USERSAYS_MAXCONCURRENT',
   RATELIMIT_USERSAYS_MINTIME: 'RATELIMIT_USERSAYS_MINTIME',
+  RATELIMIT_BOTTLENECK_FN: 'RATELIMIT_BOTTLENECK_FN',
   SECURITY_ALLOW_UNSAFE: 'SECURITY_ALLOW_UNSAFE',
   PRECOMPILERS: 'PRECOMPILERS'
 };
@@ -389,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;
@@ -448,6 +459,7 @@ Capabilities.LOGIC_HOOKS;
 Capabilities.USER_INPUTS;
 Capabilities.RATELIMIT_USERSAYS_MAXCONCURRENT;
 Capabilities.RATELIMIT_USERSAYS_MINTIME;
+Capabilities.RATELIMIT_BOTTLENECK_FN;
 Capabilities.SECURITY_ALLOW_UNSAFE;
 Capabilities.PRECOMPILERS;
 
@@ -496,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',
@@ -3049,7 +3060,8 @@ class Convo$6 {
                 scriptingMemory,
                 meMsg,
                 transcript,
-                transcriptStep
+                transcriptStep,
+                transcriptSteps
               });
               await this.scriptingEvents.onMeStart({
                 convo: this,
@@ -3058,7 +3070,8 @@ class Convo$6 {
                 scriptingMemory,
                 meMsg,
                 transcript,
-                transcriptStep
+                transcriptStep,
+                transcriptSteps
               });
               await this.scriptingEvents.onMePrepare({
                 convo: this,
@@ -3067,7 +3080,8 @@ class Convo$6 {
                 scriptingMemory,
                 meMsg,
                 transcript,
-                transcriptStep
+                transcriptStep,
+                transcriptSteps
               });
               await this._checkBotRepliesConsumed(container);
 
@@ -7537,7 +7551,7 @@ var BaseContainer_1 = class BaseContainer {
     this.tempDirectory = tempDirectory;
     this.cleanupTasks = [];
     this.queues = {};
-    this.userSaysLimiter = null;
+    this.bottleneck = null;
   }
 
   Validate() {
@@ -7547,18 +7561,33 @@ var BaseContainer_1 = class BaseContainer {
     this.onBotResponseHook = getHook$1(this.caps, this.caps[Capabilities.CUSTOMHOOK_ONBOTRESPONSE]);
     this.onStopHook = getHook$1(this.caps, this.caps[Capabilities.CUSTOMHOOK_ONSTOP]);
     this.onCleanHook = getHook$1(this.caps, this.caps[Capabilities.CUSTOMHOOK_ONCLEAN]);
-    return Promise.resolve();
-  }
 
-  Build() {
-    if (this.caps[Capabilities.RATELIMIT_USERSAYS_MAXCONCURRENT] || this.caps[Capabilities.RATELIMIT_USERSAYS_MINTIME]) {
+    if (this.caps[Capabilities.RATELIMIT_BOTTLENECK_FN]) {
+      if (lodash.isFunction(this.caps[Capabilities.RATELIMIT_BOTTLENECK_FN])) {
+        this.bottleneck = this.caps[Capabilities.RATELIMIT_BOTTLENECK_FN];
+        debug$7('Validate: Applying userSays rate limits from capability');
+      } else {
+        const limiter = new bottleneck(this.caps[Capabilities.RATELIMIT_BOTTLENECK_FN]);
+
+        this.bottleneck = fn => limiter.schedule(fn);
+
+        debug$7(`Validate: Applying userSays rate limits ${util.inspect(this.caps[Capabilities.RATELIMIT_BOTTLENECK_FN])}`);
+      }
+    } else if (this.caps[Capabilities.RATELIMIT_USERSAYS_MAXCONCURRENT] || this.caps[Capabilities.RATELIMIT_USERSAYS_MINTIME]) {
       const opts = {};
       if (this.caps[Capabilities.RATELIMIT_USERSAYS_MAXCONCURRENT]) opts.maxConcurrent = this.caps[Capabilities.RATELIMIT_USERSAYS_MAXCONCURRENT];
       if (this.caps[Capabilities.RATELIMIT_USERSAYS_MINTIME]) opts.minTime = this.caps[Capabilities.RATELIMIT_USERSAYS_MINTIME];
-      this.userSaysLimiter = new bottleneck(opts);
-      debug$7(`Build: Applying userSays rate limits ${util.inspect(opts)}`);
+      const limiter = new bottleneck(opts);
+
+      this.bottleneck = fn => limiter.schedule(fn);
+
+      debug$7(`Validate: Applying userSays rate limits ${util.inspect(opts)}`);
     }
 
+    return Promise.resolve();
+  }
+
+  Build() {
     return new Promise((resolve, reject) => {
       this._RunCustomHook('onBuild', this.onBuildHook).then(() => resolve(this)).catch(err => reject(err));
     });
@@ -7584,8 +7613,8 @@ var BaseContainer_1 = class BaseContainer {
       meMsg
     }).then(() => this.UserSaysImpl(meMsg));
 
-    if (this.userSaysLimiter) {
-      return this.userSaysLimiter.schedule(run);
+    if (this.bottleneck) {
+      return this.bottleneck(run);
     } else {
       return run();
     }
@@ -8073,10 +8102,14 @@ mustache.escape = s => s;
 var SimpleRestContainer_1 = class SimpleRestContainer {
   constructor({
     queueBotSays,
-    caps
+    caps,
+    bottleneck
   }) {
     this.queueBotSays = queueBotSays;
     this.caps = Object.assign({}, Defaults, caps);
+
+    this.bottleneck = bottleneck || (fn => fn());
+
     this.processInbound = false;
     this.redisTopic = this.caps[Capabilities.SIMPLEREST_REDIS_TOPIC] || 'SIMPLEREST_INBOUND_SUBSCRIPTION';
 
@@ -8363,31 +8396,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);
 
@@ -8404,7 +8488,8 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
               sourceData: body,
               messageText,
               media,
-              buttons
+              buttons,
+              cards
             };
             await executeHook(this.caps, this.responseHook, Object.assign({
               botMsg,
@@ -8420,7 +8505,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({
@@ -8429,7 +8515,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);
           }
         }
@@ -8615,7 +8701,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
         err,
         response,
         body
-      } = await new Promise(resolve => {
+      } = await this.bottleneck(() => new Promise(resolve => {
         request(pingConfig, (err, response, body) => {
           resolve({
             err,
@@ -8623,7 +8709,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
             body
           });
         });
-      });
+      }));
 
       if (err) {
         debug$4(`_waitForUrlResponse error on url check ${pingConfig.uri}: ${err}`);
@@ -9147,6 +9233,7 @@ var PluginConnectorContainer_1 = class PluginConnectorContainer extends BaseCont
     this.pluginInstance = tryLoadPlugin(this.caps[Capabilities.CONTAINERMODE], this.caps[Capabilities.PLUGINMODULEPATH], {
       container: this,
       queueBotSays: msg => this._QueueBotSays(msg),
+      bottleneck: this.bottleneck,
       eventEmitter: this.eventEmitter,
       caps: this.caps,
       sources: this.sources,
@@ -9394,9 +9481,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;