botium-core 1.15.9 → 1.15.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.15.9",
+  "version": "1.15.12",
   "description": "The Selenium for Chatbots",
   "main": "index.js",
   "module": "dist/botium-es.js",
@@ -13,8 +13,6 @@
     "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",
@@ -31,66 +29,63 @@
   },
   "homepage": "https://www.botium.ai",
   "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"
   },
   "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",

package/src/BotDriver.js

@@ -8,7 +8,7 @@ const sanitize = require('sanitize-filename')
 const moment = require('moment')
 const randomize = require('randomatic')
 const _ = require('lodash')
-const { boolean } = require('boolean')
+const { boolean } = require('./utils/boolean')
 const EventEmitter = require('events')
 const debug = require('debug')('botium-core-BotDriver')
 

package/src/Events.js

@@ -20,7 +20,5 @@ module.exports = {
   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'
 }

package/src/containers/GridContainer.js

@@ -49,10 +49,6 @@ module.exports = class GridContainer extends BaseContainer {
           debug(`unauthorized ${err.message}`)
           socketComplete(`Grid Access not authorized: ${err.message}`)
         })
-        this.socket.on(Events.TOOMUCHWORKERS_ERROR, (err) => {
-          debug(`TOOMUCHWORKERS_ERROR ${err.message}`)
-          socketComplete(`Grid Access not possible: ${err.message}`)
-        })
         this.socket.on(Events.CONTAINER_BUILT, () => {
           debug(Events.CONTAINER_BUILT)
           socketComplete()

package/src/helpers/TranscriptUtils.js

@@ -1,4 +1,70 @@
+const path = require('path')
+const fs = require('fs')
 const _ = require('lodash')
+const { parse: csvParseSync } = require('csv-parse/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
+ */
+module.exports.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}
+ */
+module.exports.transcriptionFromFilename = (audioFile) => {
+  const filename = path.basename(audioFile, path.extname(audioFile))
+  return filename.split(/[_-]+/).join(' ')
+}
 
 module.exports.hasWaitForBotTimeout = (transciptError) => {
   if (!transciptError) {

package/src/scripting/Convo.js

@@ -270,6 +270,7 @@ class Convo {
 
   async runConversation (container, scriptingMemory, transcript) {
     const transcriptSteps = []
+    transcript.steps = transcriptSteps
     try {
       let lastMeConvoStep = null
       let botMsg = null
@@ -416,6 +417,14 @@ class Convo {
               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 {

package/src/scripting/ScriptingProvider.js

@@ -115,6 +115,25 @@ module.exports = class ScriptingProvider {
       onBotEnd: ({ convo, convoStep, scriptingMemory, ...rest }) => {
         return this._createLogicHookPromises({ hookType: 'onBotEnd', logicHooks: (convoStep?.logicHooks || []), convo, convoStep, scriptingMemory, ...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, scriptingMemory, ...rest }) => {
         return this._createAsserterPromises({ asserterType: 'assertConvoBegin', asserters: (convo?.beginAsserter || []), convo, convoStep, scriptingMemory, ...rest })
       },
@@ -480,6 +499,7 @@ module.exports = 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)
       }
@@ -1004,7 +1024,11 @@ module.exports = 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
@@ -1043,7 +1067,11 @@ module.exports = 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 = {
@@ -1176,7 +1204,7 @@ module.exports = class ScriptingProvider {
             const ui = currentStep.userInputs[uiIndex]
             const userInput = this.userInputs[ui.name]
             if (userInput && userInput.expandConvo) {
-              const expandedUserInputs = userInput.expandConvo({ convo: currentConvo, convoStep: currentStep, args: ui.args })
+              const expandedUserInputs = userInput.expandConvo({ convo: currentConvo, convoStep: currentStep, args: ui.args, options })
               if (expandedUserInputs && expandedUserInputs.length > 0) {
                 // let sampleinputs = expandedUserInputs
                 const processSampleInputs = function * (sampleinputs, myContext, uiIndex) {
@@ -1185,10 +1213,13 @@ module.exports = class ScriptingProvider {
                   }
                 }
                 const processSampleInput = function * (sampleinput, length, index, myContext, uiIndex) {
+                  const { messageText, ...userInput } = sampleinput
                   const currentStepsStack = convoStepsStack.slice()
                   const currentStepMod = _.cloneDeep(currentStep)
-                  currentStepMod.userInputs[uiIndex] = sampleinput
-
+                  currentStepMod.userInputs[uiIndex] = userInput
+                  if (messageText) {
+                    currentStepMod.messageText = messageText
+                  }
                   currentStepsStack.push(currentStepMod)
                   const currentConvoLabeled = _.cloneDeep(currentConvo)
                   if (length > 1) {

package/src/scripting/logichook/userinput/MediaInput.js

@@ -8,6 +8,7 @@ const _ = require('lodash')
 const { BotiumMockMedia } = require('../../../../src/mocks/BotiumMockRichMessageTypes')
 const { BotiumError } = require('../../../../src/scripting/BotiumError')
 const Capabilities = require('../../../../src/Capabilities')
+const TranscriptUtils = require('../../../helpers/TranscriptUtils')
 
 const DEFAULT_BASE_SELECTOR = 'sourceTag.testSetId'
 
@@ -151,7 +152,7 @@ module.exports = class MediaInput {
     return mime.lookup(arg)
   }
 
-  expandConvo ({ convo, convoStep, args }) {
+  expandConvo ({ convo, convoStep, args, options }) {
     const hasWildcard = args.findIndex(a => this._isWildcard(a)) >= 0
 
     if (args && (args.length > 1 || hasWildcard)) {
@@ -161,10 +162,17 @@ module.exports = class MediaInput {
           // we need to escape brackets to find files
           const mediaFiles = globSync(arg.replace(/[()[\]{}]/g, '\\$&'), { cwd: baseDir })
           mediaFiles.forEach(mf => {
+            let messageText = null
+            if (options.mediaInput.messageTextMode === 'MESSAGE_TEXT_FROM_FILENAME') {
+              messageText = TranscriptUtils.transcriptionFromFilename(mf)
+            } else if (options.mediaInput.messageTextMode === 'MESSAGE_TEXT_FROM_TRANSCRIPTION') {
+              messageText = TranscriptUtils.findTranscription(baseDir, mf)
+            }
             e.push({
               name: 'MEDIA',
               args: [mf],
-              convoPostfix: _.last(mf.split('/'))
+              convoPostfix: _.last(mf.split('/')),
+              ...messageText ? { messageText } : {}
             })
           })
         } else {

package/src/utils/boolean.js

@@ -0,0 +1,39 @@
+/**
+ * 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 (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)
+}
+
+module.exports = { boolean }