botium-core 1.11.16 → 1.12.0

package/dist/botium-es.js

@@ -23,7 +23,7 @@ import isJson$1 from 'is-json';
 import esprima from 'esprima';
 import markdownIt from 'markdown-it';
 import xlsx from 'xlsx';
-import sync from 'csv-parse/lib/sync';
+import sync from 'csv-parse/sync';
 import yaml from 'yaml';
 import child_process from 'child_process';
 import socket from 'socket.io-client';
@@ -36,12 +36,12 @@ import express from 'express';
 import bodyParser from 'body-parser';
 
 var name = "botium-core";
-var version$1 = "1.11.16";
+var version$1 = "1.12.0";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
 var engines = {
-	node: ">=10.0.0"
+	node: ">=14.0.0"
 };
 var scripts = {
 	postinstall: "node ./report.js",
@@ -68,23 +68,23 @@ var bugs = {
 };
 var homepage = "https://www.botium.ai";
 var dependencies = {
-	"@babel/runtime": "^7.16.0",
+	"@babel/runtime": "^7.16.5",
 	async: "^3.2.2",
-	"body-parser": "^1.19.0",
+	"body-parser": "^1.19.1",
 	boolean: "^3.1.4",
 	bottleneck: "^2.19.5",
-	"csv-parse": "^4.16.3",
-	debug: "^4.3.2",
+	"csv-parse": "^5.0.3",
+	debug: "^4.3.3",
 	esprima: "^4.0.1",
-	express: "^4.17.1",
+	express: "^4.17.2",
 	globby: "11.0.4",
-	ioredis: "^4.28.0",
+	ioredis: "^4.28.2",
 	"is-class": "^0.0.9",
 	"is-json": "^2.0.1",
 	jsonpath: "^1.1.1",
 	lodash: "^4.17.21",
-	"markdown-it": "^12.2.0",
-	"mime-types": "^2.1.33",
+	"markdown-it": "^12.3.0",
+	"mime-types": "^2.1.34",
 	mkdirp: "^1.0.4",
 	moment: "^2.29.1",
 	mustache: "^4.2.0",
@@ -94,40 +94,40 @@ var dependencies = {
 	request: "^2.88.2",
 	rimraf: "^3.0.2",
 	"sanitize-filename": "^1.6.3",
-	slugify: "^1.6.1",
-	"socket.io": "^4.3.1",
-	"socket.io-client": "^4.3.2",
+	slugify: "^1.6.4",
+	"socket.io": "^4.4.0",
+	"socket.io-client": "^4.4.0",
 	"socketio-auth": "^0.1.1",
 	"swagger-jsdoc": "^6.1.0",
-	"swagger-ui-express": "^4.1.6",
+	"swagger-ui-express": "^4.3.0",
 	uuid: "^8.3.2",
 	vm2: "^3.9.5",
 	"write-yaml": "^1.0.0",
-	xlsx: "^0.17.3",
+	xlsx: "^0.17.4",
 	xregexp: "^5.1.0",
 	yaml: "^1.10.2"
 };
 var devDependencies = {
-	"@babel/core": "^7.16.0",
-	"@babel/node": "^7.16.0",
-	"@babel/plugin-transform-runtime": "^7.16.0",
-	"@babel/preset-env": "^7.16.0",
+	"@babel/core": "^7.16.5",
+	"@babel/node": "^7.16.5",
+	"@babel/plugin-transform-runtime": "^7.16.5",
+	"@babel/preset-env": "^7.16.5",
 	chai: "^4.3.4",
 	"chai-as-promised": "^7.1.1",
 	"cross-env": "^7.0.3",
-	eslint: "^8.1.0",
+	eslint: "^8.4.1",
 	"eslint-config-standard": "^16.0.3",
-	"eslint-plugin-import": "^2.25.2",
+	"eslint-plugin-import": "^2.25.3",
 	"eslint-plugin-node": "^11.1.0",
-	"eslint-plugin-promise": "^5.1.1",
+	"eslint-plugin-promise": "^5.2.0",
 	"eslint-plugin-standard": "^4.1.0",
 	"license-checker": "^25.0.1",
 	"license-compatibility-checker": "^0.3.5",
 	mocha: "^9.1.3",
-	nock: "^13.1.4",
-	"npm-check-updates": "^12.0.0",
+	nock: "^13.2.1",
+	"npm-check-updates": "^12.0.5",
 	nyc: "^15.1.0",
-	rollup: "^2.59.0",
+	rollup: "^2.61.1",
 	"rollup-plugin-babel": "^4.4.0",
 	"rollup-plugin-commonjs": "^10.1.0",
 	"rollup-plugin-json": "^4.0.0",
@@ -831,7 +831,7 @@ function getCjsExportFromNamespace (n) {
 	return n && n['default'] || n;
 }
 
-const BotiumError$6 = class BotiumError extends Error {
+const BotiumError$7 = class BotiumError extends Error {
   /**
    *
    * @param message
@@ -917,10 +917,10 @@ const _getChildErrorsFromContext = context => {
 };
 
 const botiumErrorFromErr$2 = (message, err) => {
-  if (err instanceof BotiumError$6) {
-    return new BotiumError$6(message, err.context, true);
+  if (err instanceof BotiumError$7) {
+    return new BotiumError$7(message, err.context, true);
   } else {
-    return new BotiumError$6(message, {
+    return new BotiumError$7(message, {
       err
     }, true);
   }
@@ -935,7 +935,7 @@ const botiumErrorFromList$2 = (errors, {
   let children = [];
 
   for (const error of errors) {
-    if (error instanceof BotiumError$6) {
+    if (error instanceof BotiumError$7) {
       const childErrors = flat && _getChildErrorsFromContext(error.context);
 
       if (childErrors && childErrors.length) {
@@ -948,7 +948,7 @@ const botiumErrorFromList$2 = (errors, {
     }
   }
 
-  const result = new BotiumError$6(message, {
+  const result = new BotiumError$7(message, {
     errors: children,
     type,
     source
@@ -957,7 +957,7 @@ const botiumErrorFromList$2 = (errors, {
 };
 
 var BotiumError_1 = {
-  BotiumError: BotiumError$6,
+  BotiumError: BotiumError$7,
   botiumErrorFromErr: botiumErrorFromErr$2,
   botiumErrorFromList: botiumErrorFromList$2
 };
@@ -1138,7 +1138,7 @@ const {
 } = vm2;
 const debug$k = debug$l('botium-core-asserterUtils');
 const {
-  BotiumError: BotiumError$5
+  BotiumError: BotiumError$6
 } = BotiumError_1;
 const {
   DEFAULT_ASSERTERS,
@@ -1289,7 +1289,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
 
     const _checkUnsafe = () => {
       if (!this.caps[Capabilities.SECURITY_ALLOW_UNSAFE]) {
-        throw new BotiumError$5('Security Error. Using unsafe component is not allowed', {
+        throw new BotiumError$6('Security Error. Using unsafe component is not allowed', {
           type: 'security',
           subtype: 'allow unsafe',
           source: path.basename(__filename),
@@ -1433,6 +1433,11 @@ var LogicHookUtils_1 = class LogicHookUtils {
             ref,
             ...this.buildScriptContext
           }, this.caps, args);
+        } else if (lodash.isFunction(CheckClass.PluginClass)) {
+          return CheckClass.PluginClass({
+            ref,
+            ...this.buildScriptContext
+          }, this.caps, args);
         } else {
           throw new Error(`${src} class or function expected`);
         }
@@ -2243,7 +2248,7 @@ const {
   toString: toString$2
 } = helper;
 const {
-  BotiumError: BotiumError$4
+  BotiumError: BotiumError$5
 } = BotiumError_1; // If they got parameter, then it will be a string always.
 // the receiver can decide what to do with it,
 // convert to int,
@@ -2412,7 +2417,7 @@ const SCRIPTING_FUNCTIONS$1 = lodash.mapValues(SCRIPTING_FUNCTIONS_RAW, (funcOrS
   return {
     handler: (caps, ...rest) => {
       if (!caps[Capabilities.SECURITY_ALLOW_UNSAFE] && funcOrStruct.unsafe) {
-        throw new BotiumError$4(`Security Error. Using unsafe scripting memory function ${name} is not allowed`, {
+        throw new BotiumError$5(`Security Error. Using unsafe scripting memory function ${name} is not allowed`, {
           type: 'security',
           subtype: 'allow unsafe',
           source: path.basename(__filename),
@@ -2561,7 +2566,7 @@ ScriptingMemory.SCRIPTING_FUNCTIONS;
 
 const debug$i = debug$l('botium-core-Convo');
 const {
-  BotiumError: BotiumError$3,
+  BotiumError: BotiumError$4,
   botiumErrorFromErr: botiumErrorFromErr$1,
   botiumErrorFromList: botiumErrorFromList$1
 } = BotiumError_1;
@@ -3090,7 +3095,7 @@ class Convo$6 {
             }
 
             if (!botMsg || !botMsg.messageText && !botMsg.media && !botMsg.buttons && !botMsg.cards && !botMsg.sourceData && !botMsg.nlp) {
-              const failErr = new BotiumError$3(`${this.header.name}/${convoStep.stepTag}: bot says nothing`);
+              const failErr = new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: bot says nothing`);
               debug$i(failErr);
 
               try {
@@ -3193,7 +3198,7 @@ class Convo$6 {
                 this.scriptingEvents.fail && this.scriptingEvents.fail(failErr, lastMeConvoStep);
               } catch (failErr) {}
 
-              if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS] && err instanceof BotiumError$3) {
+              if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS] && err instanceof BotiumError$4) {
                 assertErrors.push(err);
               } else {
                 throw failErr;
@@ -3210,7 +3215,7 @@ class Convo$6 {
               }
             }
           } else {
-            const failErr = new BotiumError$3(`${this.header.name}/${convoStep.stepTag}: invalid sender - ${util.inspect(convoStep.sender)}`);
+            const failErr = new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: invalid sender - ${util.inspect(convoStep.sender)}`);
             debug$i(failErr);
 
             try {
@@ -3221,7 +3226,7 @@ class Convo$6 {
           }
         } catch (err) {
           if (lastMeConvoStep) {
-            if (err instanceof BotiumError$3 && err.context) {
+            if (err instanceof BotiumError$4 && err.context) {
               err.context.input = new ConvoStep$1(lastMeConvoStep);
               err.context.transcript = [...transcriptSteps, { ...transcriptStep
               }];
@@ -3256,11 +3261,11 @@ class Convo$6 {
 
     if (lodash.isArray(expected)) {
       if (!lodash.isArray(result)) {
-        throw new BotiumError$3(`${this.header.name}/${convoStep.stepTag}: bot response expected array, got "${result}"`);
+        throw new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: bot response expected array, got "${result}"`);
       }
 
       if (expected.length !== result.length) {
-        throw new BotiumError$3(`${this.header.name}/${convoStep.stepTag}: bot response expected array length ${expected.length}, got ${result.length}`);
+        throw new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: bot response expected array length ${expected.length}, got ${result.length}`);
       }
 
       for (let i = 0; i < expected.length; i++) {
@@ -3271,7 +3276,7 @@ class Convo$6 {
         if (Object.prototype.hasOwnProperty.call(result, key)) {
           this._compareObject(container, scriptingMemory, convoStep, result[key], expected[key]);
         } else {
-          throw new BotiumError$3(`${this.header.name}/${convoStep.stepTag}: bot response "${result}" missing expected property: ${key}`);
+          throw new BotiumError$4(`${this.header.name}/${convoStep.stepTag}: bot response "${result}" missing expected property: ${key}`);
         }
       });
     } else {
@@ -3399,17 +3404,17 @@ class Convo$6 {
           const alreadyThereAt = parentPConvos.indexOf(includeLogicHook);
 
           if (alreadyThereAt >= 0) {
-            throw new BotiumError$3(`Partial convos are included circular. "${includeLogicHook}" is referenced by "/${parentPConvos.slice(0, alreadyThereAt).join('/')}" and by "/${parentPConvos.join('/')}" `);
+            throw new BotiumError$4(`Partial convos are included circular. "${includeLogicHook}" is referenced by "/${parentPConvos.slice(0, alreadyThereAt).join('/')}" and by "/${parentPConvos.join('/')}" `);
           }
 
           if (!partialConvos || Object.keys(partialConvos).length === 0) {
-            throw new BotiumError$3(`Cant find partial convo with name ${includeLogicHook} (There are no partial convos)`);
+            throw new BotiumError$4(`Cant find partial convo with name ${includeLogicHook} (There are no partial convos)`);
           }
 
           const partialConvo = partialConvos[includeLogicHook];
 
           if (!partialConvo) {
-            throw new BotiumError$3(`Cant find partial convo with name ${includeLogicHook} (available partial convos: ${Object.keys(partialConvos).join(',')})`);
+            throw new BotiumError$4(`Cant find partial convo with name ${includeLogicHook} (available partial convos: ${Object.keys(partialConvos).join(',')})`);
           }
 
           _getEffectiveConversationRecursive(partialConvo.conversation, [...parentPConvos, includeLogicHook], result, true);
@@ -3791,7 +3796,7 @@ const {
 } = vm2;
 const debug$h = debug$l('botium-core-HookUtils');
 const {
-  BotiumError: BotiumError$2
+  BotiumError: BotiumError$3
 } = BotiumError_1;
 
 const executeHook$2 = async (caps, hook, args) => {
@@ -3863,7 +3868,7 @@ const getHook$3 = (caps, data) => {
 
     if (resultWithRequire) {
       if (!allowUnsafe) {
-        throw new BotiumError$2('Security Error. Using unsafe custom hook with require is not allowed', {
+        throw new BotiumError$3('Security Error. Using unsafe custom hook with require is not allowed', {
           type: 'security',
           subtype: 'allow unsafe',
           source: path.basename(__filename),
@@ -5030,6 +5035,9 @@ var CompilerTxt_1 = class CompilerTxt extends CompilerBase_1 {
 
 };
 
+const {
+  parse
+} = sync;
 const debug$c = debug$l('botium-core-CompilerCsv');
 const {
   Convo: Convo$3
@@ -5102,7 +5110,7 @@ var CompilerCsv_1 = class CompilerCsv extends CompilerBase_1 {
     let rows;
 
     try {
-      rows = sync(scriptData, {
+      rows = parse(scriptData, {
         delimiter,
         escape: this.caps[Capabilities.SCRIPTING_CSV_ESCAPE],
         quote: this.caps[Capabilities.SCRIPTING_CSV_QUOTE],
@@ -5565,7 +5573,7 @@ const {
   ConvoStep
 } = Convo_1;
 const {
-  BotiumError: BotiumError$1,
+  BotiumError: BotiumError$2,
   botiumErrorFromList,
   botiumErrorFromErr
 } = BotiumError_1;
@@ -5845,7 +5853,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
           message += ' expected to match ';
           message += tomatch && tomatch.length > 1 ? 'one of ' : '';
           message += `${tomatch.map(e => e ? '"' + e + '"' : '<any response>').join(', ')}`;
-          throw new BotiumError$1(message, {
+          throw new BotiumError$2(message, {
             type: 'asserter',
             source: 'TextMatchAsserter',
             context: {
@@ -5875,7 +5883,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
           message += ' expected NOT to match ';
           message += nottomatch && nottomatch.length > 1 ? 'one of ' : '';
           message += `${nottomatch.map(e => e ? '"' + e + '"' : '<any response>').join(', ')}`;
-          throw new BotiumError$1(message, {
+          throw new BotiumError$2(message, {
             type: 'asserter',
             source: 'TextMatchAsserter',
             context: {
@@ -5922,7 +5930,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
         if (asserter[notAsserterType]) {
           return p(this.retryHelperAsserter, () => asserter[notAsserterType](params));
         } else {
-          return pnot(this.retryHelperAsserter, () => asserter[asserterType](params), new BotiumError$1(`${convoStep.stepTag}: Expected asserter ${asserter.name || asserterSpec.name} with args "${params.args}" to fail`, {
+          return pnot(this.retryHelperAsserter, () => asserter[asserterType](params), new BotiumError$2(`${convoStep.stepTag}: Expected asserter ${asserter.name || asserterSpec.name} with args "${params.args}" to fail`, {
             type: 'asserter',
             source: asserter.name || asserterSpec.name,
             params: {
@@ -6356,7 +6364,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
     });
 
     if (aggregatedNoNames.length) {
-      throw new BotiumError$1('Scripting Memory Definition(s) without name', {
+      throw new BotiumError$2('Scripting Memory Definition(s) without name', {
         type: 'Scripting Memory',
         subtype: 'Scripting Memory without name',
         source: 'ScriptingProvider',
@@ -6372,7 +6380,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
     });
 
     if (aggregatedNoVariables.length) {
-      throw new BotiumError$1(`Scripting Memory Definition(s) ${aggregatedNoVariables.map(e => e.header.name).join(', ')} without variable`, {
+      throw new BotiumError$2(`Scripting Memory Definition(s) ${aggregatedNoVariables.map(e => e.header.name).join(', ')} without variable`, {
         type: 'Scripting Memory',
         subtype: 'Scripting Memory without variable',
         source: 'ScriptingProvider',
@@ -6388,7 +6396,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
     });
 
     if (aggregatedNoVariableNames.length) {
-      throw new BotiumError$1(`Scripting Memory Definition(s) ${aggregatedNoVariableNames.map(e => e.header.name).join(', ')} without variable name`, {
+      throw new BotiumError$2(`Scripting Memory Definition(s) ${aggregatedNoVariableNames.map(e => e.header.name).join(', ')} without variable name`, {
         type: 'Scripting Memory',
         subtype: 'Scripting Memory without variable name',
         source: 'ScriptingProvider',
@@ -6420,7 +6428,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
     }
 
     if (aggregatedDuplicates.length) {
-      throw new BotiumError$1(`Scripting Memory Definition name(s) "${lodash.uniq(aggregatedDuplicates.map(d => d.scriptingMemory.header.name)).join(', ')}" are not unique`, {
+      throw new BotiumError$2(`Scripting Memory Definition name(s) "${lodash.uniq(aggregatedDuplicates.map(d => d.scriptingMemory.header.name)).join(', ')}" are not unique`, {
         type: 'Scripting Memory',
         subtype: 'Scripting Memory name collision',
         source: 'ScriptingProvider',
@@ -6457,7 +6465,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
     }
 
     if (aggregatedIntersections.length) {
-      throw new BotiumError$1(`Scripting Memory Definitions "${aggregatedIntersections.map(i => i.scriptingMemory.header.name).join(', ')}" are invalid because variable name collision"`, {
+      throw new BotiumError$2(`Scripting Memory Definitions "${aggregatedIntersections.map(i => i.scriptingMemory.header.name).join(', ')}" are invalid because variable name collision"`, {
         type: 'Scripting Memory',
         subtype: 'Scripting Memory variable name collision',
         source: 'ScriptingProvider',
@@ -6900,7 +6908,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
       }
     } else if (scriptingMemories) {
       if (!scriptingMemories.header || !scriptingMemories.header.name) {
-        throw new BotiumError$1('Scripting Memory Definition has no name', {
+        throw new BotiumError$2('Scripting Memory Definition has no name', {
           type: 'Compiler',
           subtype: 'Scripting memory without name',
           source: 'ScriptingProvider',
@@ -6911,7 +6919,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
       }
 
       if (!scriptingMemories.values || !Object.keys(scriptingMemories.values).length) {
-        throw new BotiumError$1('Scripting Memory Definition has no variables', {
+        throw new BotiumError$2('Scripting Memory Definition has no variables', {
           type: 'Compiler',
           subtype: 'Scripting memory without variable',
           source: 'ScriptingProvider',
@@ -6922,7 +6930,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
       }
 
       if (scriptingMemories.values && !lodash.isUndefined(scriptingMemories.values[''])) {
-        throw new BotiumError$1('Scripting Memory Definition variable has no name', {
+        throw new BotiumError$2('Scripting Memory Definition variable has no name', {
           type: 'Compiler',
           subtype: 'Scripting memory without variable name',
           source: 'ScriptingProvider',
@@ -7884,6 +7892,9 @@ const {
 const {
   escapeJSONString
 } = Utils;
+const {
+  BotiumError: BotiumError$1
+} = BotiumError_1;
 
 mustache.escape = s => s;
 
@@ -8273,6 +8284,17 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
               debug$4(Utils.shortenJsonString(body));
             }
 
+            if (body) {
+              const jsonBody = Utils.toJsonWeak(body);
+              const errKey = Object.keys(jsonBody).find(k => k.startsWith('err') || k.startsWith('fail'));
+
+              if (errKey) {
+                return reject(new BotiumError$1(`got error response: ${response.statusCode}/${response.statusMessage} - ${jsonBody[errKey]}`, {
+                  message: Utils.shortenJsonString(body)
+                }));
+              }
+            }
+
             return reject(new Error(`got error response: ${response.statusCode}/${response.statusMessage}`));
           }
 
@@ -8370,6 +8392,16 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
       }
     }
 
+    if (msg.ADD_FORM_PARAM && Object.keys(msg.ADD_FORM_PARAM).length > 0) {
+      requestOptions.form = {};
+
+      for (const formKey of Object.keys(msg.ADD_FORM_PARAM)) {
+        const formValue = this._getMustachedVal(lodash.isString(msg.ADD_FORM_PARAM[formKey]) ? msg.ADD_FORM_PARAM[formKey] : JSON.stringify(msg.ADD_FORM_PARAM[formKey]), false);
+
+        requestOptions.form[formKey] = formValue;
+      }
+    }
+
     if (msg.ADD_HEADER && Object.keys(msg.ADD_HEADER).length > 0) {
       requestOptions.headers = requestOptions.headers || {};