botium-core 1.15.9 → 1.15.12

package/dist/botium-es.js

@@ -8,7 +8,6 @@ import sanitizeFilename from 'sanitize-filename';
 import moment from 'moment';
 import randomatic from 'randomatic';
 import lodash from 'lodash';
-import boolean$1 from 'boolean';
 import events from 'events';
 import debug$o from 'debug';
 import isClass from 'is-class';
@@ -34,8 +33,49 @@ import undici from 'undici';
 import express from 'express';
 import bodyParser from 'body-parser';
 
+/**
+ * Converts a value to a boolean.
+ * Similar to the 'boolean' npm package implementation.
+ *
+ * @param {*} value - The value to convert to boolean
+ * @returns {boolean} The boolean representation of the value
+ */
+function boolean$1(value) {
+  // Handle null and undefined
+  if (value == null) {
+    return false;
+  }
+
+  // Handle boolean values
+  if (typeof value === 'boolean') {
+    return value;
+  }
+
+  // Handle numbers
+  if (typeof value === 'number') {
+    return value !== 0 && !isNaN(value);
+  }
+
+  // Handle strings
+  if (typeof value === 'string') {
+    const normalized = value.trim().toLowerCase();
+    if (normalized === 'true' || normalized === 'yes' || normalized === 'on' || normalized === '1') {
+      return true;
+    }
+    if (normalized === 'false' || normalized === 'no' || normalized === 'off' || normalized === '0' || normalized === '') {
+      return false;
+    }
+  }
+
+  // For all other values, use JavaScript's truthiness
+  return Boolean(value);
+}
+var boolean_1 = {
+  boolean: boolean$1
+};
+
 var name = "botium-core";
-var version$1 = "1.15.9";
+var version$1 = "1.15.12";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -48,8 +88,6 @@ var scripts = {
 	eslint: "eslint \"./src/**/*.js\" \"./test/**/*.js\"",
 	"eslint-fix": "eslint --fix \"./src/**/*.js\" \"./test/**/*.js\"",
 	newpatch: "npm version patch",
-	agent: "node ./src/grid/agent/agent.js",
-	"agent-jsdoc": "swagger-jsdoc -d ./src/grid/agent/swaggerDef.json -o ./src/grid/agent/swagger.json ./src/grid/agent/routes.js",
 	link: "npm link botium-connector-dialogflow botium-connector-webdriverio botium-connector-directline3 botium-connector-watson botium-connector-alexa-smapi botium-connector-echo",
 	test: "cross-env NODE_PATH=\"./test/plugins/plugindir/fromfolder:./test/plugins/plugindir/fromfile:./test/security/resources\" mocha \"./test/**/*.spec.js\"",
 	"coverage:report": "nyc report --reporter=lcov npm test",
@@ -66,66 +104,63 @@ var bugs = {
 };
 var homepage = "https://www.botium.ai";
 var dependencies = {
-	"@babel/runtime": "^7.23.9",
-	async: "^3.2.5",
-	"body-parser": "^1.20.2",
-	boolean: "^3.2.0",
+	"@babel/runtime": "^7.28.6",
+	async: "^3.2.6",
+	"body-parser": "^2.2.2",
 	bottleneck: "^2.19.5",
-	"csv-parse": "^5.5.3",
-	debug: "^4.3.4",
-	express: "^4.18.2",
+	"csv-parse": "^6.1.0",
+	debug: "^4.4.3",
+	express: "^5.2.1",
 	globby: "11.0.4",
-	ioredis: "^5.3.2",
+	ioredis: "^5.10.0",
 	"is-class": "^0.0.9",
 	"is-json": "^2.0.1",
-	jsonpath: "^1.1.1",
-	lodash: "^4.17.21",
-	"markdown-it": "^14.0.0",
-	"mime-types": "^2.1.35",
+	jsonpath: "^1.3.0",
+	lodash: "^4.17.23",
+	"markdown-it": "^14.1.1",
+	"mime-types": "^3.0.2",
 	mkdirp: "^3.0.1",
 	moment: "^2.30.1",
-	"moment-timezone": "^0.5.45",
+	"moment-timezone": "^0.6.0",
 	mustache: "^4.2.0",
 	"promise-retry": "^2.0.1",
 	"promise.allsettled": "^1.0.7",
 	randomatic: "^3.1.1",
-	rimraf: "^5.0.5",
+	rimraf: "^6.1.3",
 	"sanitize-filename": "^1.6.3",
 	slugify: "^1.6.6",
-	"socket.io": "^4.7.4",
-	"socket.io-client": "^4.7.4",
+	"socket.io": "^4.8.3",
+	"socket.io-client": "^4.8.3",
 	"socketio-auth": "^0.1.1",
-	"swagger-jsdoc": "^6.2.8",
-	"swagger-ui-express": "^5.0.0",
-	tinyglobby: "^0.2.10",
-	undici: "^6.21.0",
+	tinyglobby: "^0.2.15",
+	undici: "^7.22.0",
 	uuid: "^9.0.1",
 	"word-error-rate": "0.0.7",
 	"write-yaml": "^1.0.0",
 	xlsx: "^0.18.5",
-	xregexp: "^5.1.1",
-	yaml: "^2.3.4"
+	xregexp: "^5.1.2",
+	yaml: "^2.8.2"
 };
 var devDependencies = {
-	"@babel/core": "^7.23.9",
-	"@babel/node": "^7.23.9",
-	"@babel/plugin-transform-runtime": "^7.23.9",
-	"@babel/preset-env": "^7.23.9",
+	"@babel/core": "^7.29.0",
+	"@babel/node": "^7.29.0",
+	"@babel/plugin-transform-runtime": "^7.29.0",
+	"@babel/preset-env": "^7.29.0",
 	chai: "4.3.10",
-	"chai-as-promised": "^7.1.1",
-	"cross-env": "^7.0.3",
-	eslint: "^8.56.0",
+	"chai-as-promised": "^7.1.2",
+	"cross-env": "^10.1.0",
+	eslint: "^8.57.1",
 	"eslint-config-standard": "^17.1.0",
-	"eslint-plugin-import": "^2.29.1",
-	"eslint-plugin-mocha": "^10.2.0",
+	"eslint-plugin-import": "^2.32.0",
+	"eslint-plugin-mocha": "^10.5.0",
 	"eslint-plugin-n": "^16.6.2",
-	"eslint-plugin-promise": "^6.1.1",
+	"eslint-plugin-promise": "^6.6.0",
 	"eslint-plugin-standard": "^4.1.0",
-	mocha: "^10.3.0",
-	nock: "^14.0.0-beta.19",
-	"npm-check-updates": "^16.14.15",
-	nyc: "^15.1.0",
-	rollup: "2.79.1",
+	mocha: "^11.7.5",
+	nock: "^14.0.11",
+	"npm-check-updates": "^19.6.3",
+	nyc: "^18.0.0",
+	rollup: "2.80.0",
 	"rollup-plugin-babel": "^4.4.0",
 	"rollup-plugin-commonjs": "^10.1.0",
 	"rollup-plugin-json": "^4.0.0",
@@ -859,9 +894,7 @@ var Events = {
   MESSAGE_RECEIVEDFROMBOT: 'MESSAGE_RECEIVEDFROMBOT',
   MESSAGE_RECEIVEFROMBOT_ERROR: 'MESSAGE_RECEIVEFROMBOT_ERROR',
   MESSAGE_ATTACHMENT: 'MESSAGE_ATTACHMENT',
-  MESSAGE_TRANSCRIPT: 'MESSAGE_TRANSCRIPT',
-  // Botium Agent Events
-  TOOMUCHWORKERS_ERROR: 'TOOMUCHWORKERS_ERROR'
+  MESSAGE_TRANSCRIPT: 'MESSAGE_TRANSCRIPT'
 };
 Events.CONTAINER_BUILDING;
 Events.CONTAINER_BUILT;
@@ -883,7 +916,6 @@ Events.MESSAGE_RECEIVEDFROMBOT;
 Events.MESSAGE_RECEIVEFROMBOT_ERROR;
 Events.MESSAGE_ATTACHMENT;
 Events.MESSAGE_TRANSCRIPT;
-Events.TOOMUCHWORKERS_ERROR;
 
 function commonjsRequire () {
 	throw new Error('Dynamic requires are not currently supported by rollup-plugin-commonjs');
@@ -2997,6 +3029,7 @@ class Convo$6 {
   }
   async runConversation(container, scriptingMemory, transcript) {
     const transcriptSteps = [];
+    transcript.steps = transcriptSteps;
     try {
       let lastMeConvoStep = null;
       let botMsg = null;
@@ -3181,6 +3214,21 @@ class Convo$6 {
               throw failErr;
             }
           } else if (convoStep.sender === 'bot') {
+            if (this.scriptingEvents.executeBotStep) {
+              const executeBotStepResult = await this.scriptingEvents.executeBotStep({
+                convo: this,
+                convoStep,
+                container,
+                scriptingMemory,
+                transcript,
+                transcriptStep,
+                transcriptSteps
+              });
+              if (executeBotStepResult) {
+                skipTranscriptStep = true;
+                continue;
+              }
+            }
             if (waitForBotSays) {
               botMsg = null;
             } else {
@@ -5754,6 +5802,31 @@ var ScriptingProvider_1 = class ScriptingProvider {
           ...rest
         });
       },
+      executeBotStep: ({
+        convo,
+        convoStep,
+        container,
+        scriptingMemory,
+        ...rest
+      }) => {
+        const logicHooks = convoStep?.logicHooks || [];
+        const executeBotStepHooks = logicHooks.filter(l => this.logicHooks[l.name] && typeof this.logicHooks[l.name].executeBotStep === 'function');
+        if (executeBotStepHooks.length > 1) {
+          throw new Error(`${convo?.header?.name}/${convoStep?.stepTag}: Multiple logic hooks implement executeBotStep: ${executeBotStepHooks.map(l => l.name).join(', ')}. Only one is allowed per step.`);
+        }
+        if (executeBotStepHooks.length === 1) {
+          const lh = executeBotStepHooks[0];
+          return this.logicHooks[lh.name].executeBotStep({
+            convo,
+            convoStep,
+            scriptingMemory,
+            container,
+            args: ScriptingMemory.applyToArgs(lh.args, scriptingMemory, container.caps),
+            ...rest
+          });
+        }
+        return null;
+      },
       assertConvoBegin: ({
         convo,
         convoStep,
@@ -6156,6 +6229,7 @@ var ScriptingProvider_1 = class ScriptingProvider {
         onBotStart: this.scriptingEvents.onBotStart.bind(this),
         onBotPrepare: this.scriptingEvents.onBotPrepare.bind(this),
         onBotEnd: this.scriptingEvents.onBotEnd.bind(this),
+        executeBotStep: this.scriptingEvents.executeBotStep.bind(this),
         setUserInput: this.scriptingEvents.setUserInput.bind(this),
         fail: this.scriptingEvents.fail && this.scriptingEvents.fail.bind(this)
       }
@@ -6676,7 +6750,11 @@ var ScriptingProvider_1 = class ScriptingProvider {
       // use skip and keep, or justHeader
       justHeader: false,
       // drop unwanted convos
-      convoFilter: null
+      convoFilter: null,
+      mediaInput: {
+        // MESSAGE_TEXT_FROM_FILENAME or MESSAGE_TEXT_FROM_TRANSCRIPTION or falsy
+        messageTextMode: 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
@@ -6714,7 +6792,11 @@ var ScriptingProvider_1 = class ScriptingProvider {
   ExpandConvosIterable(options = {}) {
     options = Object.assign({
       // drop unwanted convos
-      convoFilter: null
+      convoFilter: null,
+      mediaInput: {
+        // MESSAGE_TEXT_FROM_FILENAME or MESSAGE_TEXT_FROM_TRANSCRIPTION or falsy
+        messageTextMode: 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 = {
@@ -6861,7 +6943,8 @@ var ScriptingProvider_1 = class ScriptingProvider {
               const expandedUserInputs = userInput.expandConvo({
                 convo: currentConvo,
                 convoStep: currentStep,
-                args: ui.args
+                args: ui.args,
+                options
               });
               if (expandedUserInputs && expandedUserInputs.length > 0) {
                 // let sampleinputs = expandedUserInputs
@@ -6873,9 +6956,16 @@ var ScriptingProvider_1 = class ScriptingProvider {
                   }
                 };
                 const processSampleInput = function* (sampleinput, length, index, myContext, uiIndex) {
+                  const {
+                    messageText,
+                    ...userInput
+                  } = sampleinput;
                   const currentStepsStack = convoStepsStack.slice();
                   const currentStepMod = lodash.cloneDeep(currentStep);
-                  currentStepMod.userInputs[uiIndex] = sampleinput;
+                  currentStepMod.userInputs[uiIndex] = userInput;
+                  if (messageText) {
+                    currentStepMod.messageText = messageText;
+                  }
                   currentStepsStack.push(currentStepMod);
                   const currentConvoLabeled = lodash.cloneDeep(currentConvo);
                   if (length > 1) {
@@ -7709,10 +7799,6 @@ var GridContainer_1 = class GridContainer extends BaseContainer_1 {
         debug$6(`unauthorized ${err.message}`);
         socketComplete(`Grid Access not authorized: ${err.message}`);
       });
-      this.socket.on(Events.TOOMUCHWORKERS_ERROR, err => {
-        debug$6(`TOOMUCHWORKERS_ERROR ${err.message}`);
-        socketComplete(`Grid Access not possible: ${err.message}`);
-      });
       this.socket.on(Events.CONTAINER_BUILT, () => {
         debug$6(Events.CONTAINER_BUILT);
         socketComplete();
@@ -9343,7 +9429,7 @@ const {
 } = rimraf$1;
 const {
   boolean
-} = boolean$1;
+} = boolean_1;
 const debug$1 = debug$o('botium-core-BotDriver');
 const {
   version
@@ -9795,6 +9881,79 @@ Plugins.PLUGIN_TYPE_LOGICHOOK;
 Plugins.PLUGIN_TYPE_USERINPUT;
 Plugins.TYPE_TO_PREFIX;
 
+const {
+  parse: csvParseSync
+} = sync;
+
+/**
+ * Find transcription for an audio file: .txt same base name, or transcript.csv in parent dirs.
+ * @param {string} baseDir - Base directory for resolving paths
+ * @param {string} audioFile - Relative path to audio file
+ * @param {object} [options] - Optional: { csvCache: {}, onError: (msg) => {} }
+ * @returns {string|null} Transcription text or null
+ */
+var findTranscription = (baseDir, audioFile, options = {}) => {
+  const {
+    csvCache = {},
+    onError
+  } = options;
+  const transcriptionFilename = `${audioFile.substring(0, audioFile.lastIndexOf('.'))}.txt`;
+  const transcriptionFilenameAbs = path.resolve(baseDir, transcriptionFilename);
+  try {
+    if (fs.existsSync(transcriptionFilenameAbs)) {
+      return fs.readFileSync(transcriptionFilenameAbs, {
+        encoding: 'utf-8'
+      }).trim();
+    }
+  } catch (err) {
+    if (onError) onError(`Transcription File ${transcriptionFilenameAbs} not readable: ${err.message}`);
+    throw new Error(`Reading transcription file ${transcriptionFilename} for ${audioFile} failed`);
+  }
+  if (csvCache[audioFile]) {
+    return csvCache[audioFile];
+  }
+  const audioFileComponents = audioFile.split('/');
+  for (let parentIndex = audioFileComponents.length - 1; parentIndex >= 0; parentIndex--) {
+    const csvDirectory = audioFileComponents.slice(0, parentIndex);
+    const csvFilename = path.join(...csvDirectory, 'transcript.csv');
+    const csvFilenameAbs = path.resolve(baseDir, csvFilename);
+    try {
+      if (fs.existsSync(csvFilenameAbs)) {
+        const records = csvParseSync(fs.readFileSync(csvFilenameAbs, {
+          encoding: 'utf-8'
+        }).trim(), {
+          columns: ['filename', 'transcription'],
+          delimiter: [',', ';', ':', '\t'],
+          trim: true,
+          skip_empty_lines: true
+        });
+        if (records && records.length > 0) {
+          for (const record of records) {
+            const fnKey = path.join(...csvDirectory, record.filename);
+            csvCache[fnKey] = record.transcription;
+          }
+        }
+      }
+    } catch (err) {
+      if (onError) onError(`Transcription CSV File ${csvFilenameAbs} not readable: ${err.message}`);
+      throw new Error(`Reading transcription CSV file for ${csvFilename} failed`);
+    }
+    if (csvCache[audioFile]) {
+      return csvCache[audioFile];
+    }
+  }
+  return null;
+};
+
+/**
+ * Derive transcription text from audio filename (basename without extension, underscores/hyphens → spaces).
+ * @param {string} audioFile - Path or filename of audio file
+ * @returns {string}
+ */
+var transcriptionFromFilename = audioFile => {
+  const filename = path.basename(audioFile, path.extname(audioFile));
+  return filename.split(/[_-]+/).join(' ');
+};
 var hasWaitForBotTimeout = transciptError => {
   if (!transciptError) {
     return false;
@@ -9806,6 +9965,8 @@ var hasWaitForBotTimeout = transciptError => {
   return str.indexOf(': error waiting for bot - Bot did not respond within') > 0;
 };
 var TranscriptUtils = {
+  findTranscription: findTranscription,
+  transcriptionFromFilename: transcriptionFromFilename,
   hasWaitForBotTimeout: hasWaitForBotTimeout
 };