botium-core 1.15.8 → 1.15.10

package/dist/botium-es.js

@@ -35,7 +35,7 @@ import express from 'express';
 import bodyParser from 'body-parser';
 
 var name = "botium-core";
-var version$1 = "1.15.8";
+var version$1 = "1.15.10";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -2997,6 +2997,7 @@ class Convo$6 {
   }
   async runConversation(container, scriptingMemory, transcript) {
     const transcriptSteps = [];
+    transcript.steps = transcriptSteps;
     try {
       let lastMeConvoStep = null;
       let botMsg = null;
@@ -3181,6 +3182,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 +5770,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,
@@ -6055,12 +6096,18 @@ var ScriptingProvider_1 = class ScriptingProvider {
     if (hookType !== 'onMeStart' && hookType !== 'onMePrepare' && hookType !== 'onMeEnd' && hookType !== 'onBotStart' && hookType !== 'onBotPrepare' && hookType !== 'onBotEnd' && hookType !== 'onConvoBegin' && hookType !== 'onConvoEnd') {
       throw Error(`Unknown hookType ${hookType}`);
     }
-    const localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType]);
+    let localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType]);
+    // Scripting memory file are injected via SET_SCRIPTING_MEMORY in the BEGIN step
+    // But there might be other logic hooks that need the scripting memory variables
+    // Order is important (SET_SCRIPTING_MEMORY in begin can be because the user added it,
+    // or because the scripting memory file added it. User one has to be the last one.
+    localHooks = [...localHooks.filter(l => l.name === 'SET_SCRIPTING_MEMORY'), ...localHooks.filter(l => l.name !== 'SET_SCRIPTING_MEMORY')];
     const convoStepPromises = localHooks.map(l => p(this.retryHelperLogicHook, () => this.logicHooks[l.name][hookType]({
       convo,
       convoStep,
       scriptingMemory,
       container,
+      // Do this more sensitve for SET_SCRIPTING_MEMORY? It can have scripting variables in the args
       args: ScriptingMemory.applyToArgs(l.args, scriptingMemory, container.caps, rest.botMsg),
       isGlobal: false,
       ...rest
@@ -6150,6 +6197,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)
       }
@@ -6670,7 +6718,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
@@ -6708,7 +6760,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 = {
@@ -6855,7 +6911,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
@@ -6867,9 +6924,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) {
@@ -9529,8 +9593,8 @@ var BotDriver_1 = class BotDriver {
         if (lodash.isString(newCaps[capKey])) {
           try {
             caps[capKey] = JSON.parse(newCaps[capKey]);
-            if (lodash.isFinite(caps[capKey])) {
-              caps[capKey] = caps[capKey].toString();
+            if (lodash.isFinite(Number(newCaps[capKey]))) {
+              caps[capKey] = newCaps[capKey].toString();
             }
           } catch (err) {
             caps[capKey] = newCaps[capKey];
@@ -9789,6 +9853,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;
@@ -9800,6 +9937,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
 };