botium-core 1.13.17 → 1.13.19

package/README.md

@@ -4,7 +4,6 @@
 
 [![NPM](https://nodei.co/npm/botium-core.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/botium-core/)
 
-[ ![Codeship Status for codeforequity-at/botium-core](https://app.codeship.com/projects/0389ad40-cecc-0135-2ddc-161d5c3cc5fd/status?branch=master)](https://app.codeship.com/projects/262204)
 [![npm version](https://badge.fury.io/js/botium-core.svg)](https://badge.fury.io/js/botium-core)
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
 [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fforum.botium.ai%2F)](https://forum.botium.ai)

package/dist/botium-cjs.js

@@ -6,7 +6,7 @@ var util = require('util');
 var fs = require('fs');
 var path = require('path');
 var async = require('async');
-var rimraf$2 = require('rimraf');
+var rimraf$1 = require('rimraf');
 var mkdirp = require('mkdirp');
 var sanitizeFilename = require('sanitize-filename');
 var moment = require('moment');
@@ -46,7 +46,7 @@ var util__default = /*#__PURE__*/_interopDefaultLegacy(util);
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var async__default = /*#__PURE__*/_interopDefaultLegacy(async);
-var rimraf__default = /*#__PURE__*/_interopDefaultLegacy(rimraf$2);
+var rimraf__default = /*#__PURE__*/_interopDefaultLegacy(rimraf$1);
 var mkdirp__default = /*#__PURE__*/_interopDefaultLegacy(mkdirp);
 var sanitizeFilename__default = /*#__PURE__*/_interopDefaultLegacy(sanitizeFilename);
 var moment__default = /*#__PURE__*/_interopDefaultLegacy(moment);
@@ -81,7 +81,7 @@ var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var bodyParser__default = /*#__PURE__*/_interopDefaultLegacy(bodyParser);
 
 var name = "botium-core";
-var version$1 = "1.13.17";
+var version$1 = "1.13.19";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module$1 = "dist/botium-es.js";
@@ -132,6 +132,7 @@ var dependencies = {
 	"mime-types": "^2.1.35",
 	mkdirp: "^3.0.1",
 	moment: "^2.29.4",
+	"moment-timezone": "^0.5.43",
 	mustache: "^4.2.0",
 	"promise-retry": "^2.0.1",
 	"promise.allsettled": "^1.0.6",
@@ -286,6 +287,12 @@ var Capabilities = {
   SIMPLEREST_POLL_INTERVAL: 'SIMPLEREST_POLL_INTERVAL',
   SIMPLEREST_POLL_TIMEOUT: 'SIMPLEREST_PING_TIMEOUT',
   SIMPLEREST_POLL_UPDATE_CONTEXT: 'SIMPLEREST_POLL_UPDATE_CONTEXT',
+  SIMPLEREST_CONTEXT_IGNORE_JSONPATH: 'SIMPLEREST_CONTEXT_IGNORE_JSONPATH',
+  SIMPLEREST_CONTEXT_IGNORE_MATCH: 'SIMPLEREST_CONTEXT_IGNORE_MATCH',
+  SIMPLEREST_CONTEXT_SKIP_JSONPATH: 'SIMPLEREST_CONTEXT_SKIP_JSONPATH',
+  SIMPLEREST_CONTEXT_SKIP_MATCH: 'SIMPLEREST_CONTEXT_SKIP_MATCH',
+  SIMPLEREST_CONTEXT_CONTINUE_JSONPATH: 'SIMPLEREST_CONTEXT_CONTINUE_JSONPATH',
+  SIMPLEREST_CONTEXT_CONTINUE_MATCH: 'SIMPLEREST_CONTEXT_CONTINUE_MATCH',
   SIMPLEREST_BODY_JSONPATH: 'SIMPLEREST_BODY_JSONPATH',
   SIMPLEREST_RESPONSE_JSONPATH: 'SIMPLEREST_RESPONSE_JSONPATH',
   SIMPLEREST_RESPONSE_HOOK: 'SIMPLEREST_RESPONSE_HOOK',
@@ -452,6 +459,12 @@ Capabilities.SIMPLEREST_POLL_REQUEST_HOOK;
 Capabilities.SIMPLEREST_POLL_INTERVAL;
 Capabilities.SIMPLEREST_POLL_TIMEOUT;
 Capabilities.SIMPLEREST_POLL_UPDATE_CONTEXT;
+Capabilities.SIMPLEREST_CONTEXT_IGNORE_JSONPATH;
+Capabilities.SIMPLEREST_CONTEXT_IGNORE_MATCH;
+Capabilities.SIMPLEREST_CONTEXT_SKIP_JSONPATH;
+Capabilities.SIMPLEREST_CONTEXT_SKIP_MATCH;
+Capabilities.SIMPLEREST_CONTEXT_CONTINUE_JSONPATH;
+Capabilities.SIMPLEREST_CONTEXT_CONTINUE_MATCH;
 Capabilities.SIMPLEREST_BODY_JSONPATH;
 Capabilities.SIMPLEREST_RESPONSE_JSONPATH;
 Capabilities.SIMPLEREST_RESPONSE_HOOK;
@@ -1192,6 +1205,18 @@ var LogicHookConsts = {
   }, {
     name: LOGIC_HOOK_INCLUDE$1,
     className: 'IncludeLogicHook'
+  }, {
+    name: 'CONDITIONAL_STEP_TIME_BASED',
+    className: 'ConditionalTimeBasedLogicHook'
+  }, {
+    name: 'CONDITIONAL_STEP_BUSINESS_HOURS',
+    className: 'ConditionalBusinessHoursLogicHook'
+  }, {
+    name: 'CONDITIONAL_STEP_CAPABILITY_VALUE_BASED',
+    className: 'ConditionalCapabilityValueBasedLogicHook'
+  }, {
+    name: 'CONDITIONAL_STEP_JSON_PATH_BASED',
+    className: 'ConditionalJsonPathBasedLogicHook.js'
   }],
   DEFAULT_USER_INPUTS: [{
     name: 'BUTTON',
@@ -3066,6 +3091,7 @@ class Convo$6 {
               throw failErr;
             }
           } else if (convoStep.sender === 'bot') {
+            const previousWaitForBotSays = waitForBotSays;
             if (waitForBotSays) {
               botMsg = null;
             } else {
@@ -3121,6 +3147,23 @@ class Convo$6 {
               } catch (failErr) {}
               throw failErr;
             }
+            if (convoStep.conditional) {
+              const nextConvoStep = this.conversation[i + 1];
+              if (!previousWaitForBotSays) {
+                skipTranscriptStep = true;
+              }
+              waitForBotSays = false;
+              if (!nextConvoStep || nextConvoStep.sender !== 'bot' || !nextConvoStep.logicHooks || !nextConvoStep.logicHooks.some(lh => lh.name.toUpperCase().startsWith('CONDITIONAL_STEP'))) {
+                waitForBotSays = true;
+              } else {
+                const conditionalLogicHook = convoStep.logicHooks.find(lh => lh.name.startsWith('CONDITIONAL_STEP'));
+                const nextConditionalLogicHook = nextConvoStep.logicHooks.find(lh => lh.name.startsWith('CONDITIONAL_STEP'));
+                waitForBotSays = conditionalLogicHook.args[1] !== nextConditionalLogicHook.args[1];
+              }
+              if (convoStep.conditional.skip) {
+                continue;
+              }
+            }
             if (!botMsg || !botMsg.messageText && !botMsg.media && !botMsg.buttons && !botMsg.cards && !botMsg.sourceData && !botMsg.nlp) {
               const failErr = new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: bot says nothing`);
               debug$j(failErr);
@@ -6415,10 +6458,16 @@ var ScriptingProvider_1 = class ScriptingProvider {
       convoFilter: null
     }, options);
     const expandedConvos = [];
+    // The globalContext is going to keep the data even if the Object.assign which happening to create the myContext in _expandConvo function
+    const context = {
+      globalContext: {
+        totalConvoCount: 0
+      }
+    };
     debug$9(`ExpandConvos - Using utterances expansion mode: ${this.caps[Capabilities.SCRIPTING_UTTEXPANSION_MODE]}`);
     this.convos.forEach(convo => {
       convo.expandPartialConvos();
-      for (const expanded of this._expandConvo(convo, options, {})) {
+      for (const expanded of this._expandConvo(convo, options, context)) {
         expanded.header.assertionCount = this.GetAssertionCount(expanded);
         if (options.justHeader) {
           const ConvoWithOnlyHeader = {
@@ -6434,6 +6483,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
       }
     });
     this.convos = expandedConvos;
+    this.totalConvoCount = context.globalContext.totalConvoCount;
     if (!options.justHeader) {
       this._sortConvos();
     } else {
@@ -6445,16 +6495,23 @@ var ScriptingProvider_1 = class ScriptingProvider {
       // drop unwanted convos
       convoFilter: null
     }, options);
+    // The globalContext is going to keep the data even if the Object.assign which happening to create the myContext in _expandConvo function
+    const context = {
+      globalContext: {
+        totalConvoCount: 0
+      }
+    };
     debug$9(`ExpandConvos - Using utterances expansion mode: ${this.caps[Capabilities.SCRIPTING_UTTEXPANSION_MODE]}`);
     // creating a nested generator, calling the other.
     // We hope this.convos does not changes while this iterator is used
     const _convosIterable = function* (options) {
       for (const convo of this.convos) {
         convo.expandPartialConvos();
-        yield* this._expandConvo(convo, options, {});
+        yield* this._expandConvo(convo, options, context);
       }
     }.bind(this);
     this.convosIterable = _convosIterable(options);
+    this.totalConvoCount = context.globalContext.totalConvoCount;
   }
 
   /**
@@ -6672,6 +6729,9 @@ var ScriptingProvider_1 = class ScriptingProvider {
       const expanded = Object.assign(lodash__default["default"].cloneDeep(currentConvo), {
         conversation: lodash__default["default"].cloneDeep(convoStepsStack)
       });
+      if (!lodash__default["default"].isNil(lodash__default["default"].get(context, 'globalContext.totalConvoCount'))) {
+        context.globalContext.totalConvoCount++;
+      }
       if (!options.convoFilter || options.convoFilter(expanded)) {
         yield expanded;
       }
@@ -7190,9 +7250,6 @@ var Queue_1 = class Queue {
   }
 };
 
-const {
-  rimraf: rimraf$1
-} = rimraf__default["default"];
 const debug$7 = debug__default["default"]('botium-connector-BaseContainer');
 const {
   executeHook: executeHook$1,
@@ -7325,7 +7382,12 @@ var BaseContainer_1 = class BaseContainer {
       }, rimraffed => {
         if (this.caps[Capabilities.CLEANUPTEMPDIR]) {
           debug$7(`Cleanup rimrafing temp dir ${this.tempDirectory}`);
-          rimraf$1(this.tempDirectory).catch(err => debug$7(`Cleanup temp dir ${this.tempDirectory} failed: ${util__default["default"].inspect(err)}`)).finally(() => rimraffed());
+          try {
+            rimraf__default["default"].sync(this.tempDirectory);
+            rimraffed();
+          } catch (err) {
+            rimraffed(new Error(`Cleanup temp directory ${this.tempDirectory} failed: ${util__default["default"].inspect(err)}`));
+          }
         } else {
           rimraffed();
         }
@@ -7944,6 +8006,43 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       }
       debug$4(`current session context: ${util__default["default"].inspect(this.view.context)}`);
     }
+    const _isAnyContextJsonPathMatch = (capName, capNameMatch) => {
+      const jsonPaths = getAllCapValues(capName, this.caps);
+      if (jsonPaths.length > 0) {
+        const jsonPathsMatch = getAllCapValues(capNameMatch, this.caps);
+        for (const [index, jsonPath] of jsonPaths.entries()) {
+          const contextNodes = jsonpath__default["default"].query(this.view.context, jsonPath);
+          if (lodash__default["default"].isArray(contextNodes) && contextNodes.length > 0) {
+            if (jsonPathsMatch[index]) {
+              if (contextNodes[0] === jsonPathsMatch[index]) {
+                return {
+                  jsonPath,
+                  match: contextNodes[0]
+                };
+              }
+            } else {
+              return {
+                jsonPath
+              };
+            }
+          }
+        }
+      }
+      return null;
+    };
+    const ignoreMatch = _isAnyContextJsonPathMatch(Capabilities.SIMPLEREST_CONTEXT_IGNORE_JSONPATH, Capabilities.SIMPLEREST_CONTEXT_IGNORE_MATCH);
+    if (ignoreMatch) {
+      if (ignoreMatch.match) debug$4(`ignoring response for context match: ${ignoreMatch.jsonPath} = ${ignoreMatch.match}`);else debug$4(`ignoring response for context: ${ignoreMatch.jsonPath}`);
+      return;
+    }
+    const skipMatch = _isAnyContextJsonPathMatch(Capabilities.SIMPLEREST_CONTEXT_SKIP_JSONPATH, Capabilities.SIMPLEREST_CONTEXT_SKIP_MATCH);
+    if (skipMatch) {
+      if (skipMatch.match) debug$4(`skipping response for context match: ${skipMatch.jsonPath} = ${skipMatch.match}`);else debug$4(`skipping response for context: ${skipMatch.jsonPath}`);
+      setTimeout(() => this._doRequest({
+        messageText: ''
+      }, true, true), 0);
+      return;
+    }
     const result = [];
     if (isFromUser) {
       const _extractFrom = (root, jsonPaths) => {
@@ -8092,6 +8191,13 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
         }
       }
     }
+    const continueMatch = _isAnyContextJsonPathMatch(Capabilities.SIMPLEREST_CONTEXT_CONTINUE_JSONPATH, Capabilities.SIMPLEREST_CONTEXT_CONTINUE_MATCH);
+    if (continueMatch) {
+      if (continueMatch.match) debug$4(`continue with next response for context match: ${continueMatch.jsonPath} = ${continueMatch.match}`);else debug$4(`continue with next response for context: ${continueMatch.jsonPath}`);
+      setTimeout(() => this._doRequest({
+        messageText: ''
+      }, true, true), 0);
+    }
     return result;
   }
   _doRequest(msg, isFromUser, updateContext) {
@@ -8849,21 +8955,18 @@ var PluginConnectorContainer_1 = class PluginConnectorContainer extends BaseCont
   }
 };
 
-var require$$4 = getCjsExportFromNamespace(_package$1);
+var require$$3 = getCjsExportFromNamespace(_package$1);
 
 const {
   rimraf
 } = rimraf__default["default"];
-const {
-  mkdirpSync
-} = mkdirp__default["default"];
 const {
   boolean
 } = boolean__default["default"];
 const debug$1 = debug__default["default"]('botium-core-BotDriver');
 const {
   version
-} = require$$4;
+} = require$$3;
 var BotDriver_1 = class BotDriver {
   constructor(caps = {}, sources = {}, envs = {}) {
     this.eventEmitter = new events__default["default"]();
@@ -8953,7 +9056,7 @@ var BotDriver_1 = class BotDriver {
       }, tempDirectoryCreated => {
         tempDirectory = path__default["default"].resolve(process.cwd(), this.caps[Capabilities.TEMPDIR], sanitizeFilename__default["default"](`${this.caps[Capabilities.PROJECTNAME]} ${moment__default["default"]().format('YYYYMMDD HHmmss')} ${randomatic__default["default"]('Aa0', 5)}`));
         try {
-          mkdirpSync(tempDirectory);
+          mkdirp__default["default"].sync(tempDirectory);
           tempDirectoryCreated();
         } catch (err) {
           tempDirectoryCreated(new Error(`Unable to create temp directory ${tempDirectory}: ${err.message}`));