@onereach/step-voice 7.0.0-VOIC1406.5 → 7.0.0-VOIC1406.7

package/dst/Choice.js

@@ -97,19 +97,13 @@ class Choice extends voice_1.default {
         // There's a specific need to do so. There might be ${variable} section
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
-            const interruptionMetadata = event.params.interruptionMetadata ?? null;
-            if (interruptionMetadata) {
-                await this.transcript(call, {
-                    sections: speechSections,
-                    reprompt: {
-                        maxAttempts: repromptsList.length,
-                        attempt: 0
-                    },
-                    reportingSettingsKey: 'transcriptPrompt',
-                    action: 'Call Prompt',
-                    actionFromBot: true
-                }, interruptionMetadata);
-            }
+            await this.handleInterruption({
+                call,
+                event,
+                speechSections,
+                repromptsList,
+                reportingSettingsKey
+            });
             switch (event.params.type) {
                 case 'digit':
                 case 'digits': {
@@ -279,4 +273,4 @@ class Choice extends voice_1.default {
     }
 }
 exports.default = Choice;
-// ------------------------------------------------------------------
+// --------------------------------------------------------------------

package/dst/Custom Voice Input.js

@@ -88,6 +88,13 @@ class CustomVoiceInput extends voice_1.default {
         // There's a specific need to do so. There might be ${variable} section
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
+            await this.handleInterruption({
+                call,
+                event,
+                speechSections,
+                repromptsList,
+                reportingSettingsKey
+            });
             switch (event.params.type) {
                 // digit recognition removed
                 case 'recognition': {
@@ -191,7 +198,7 @@ class CustomVoiceInput extends voice_1.default {
             }
         });
         this.triggers.otherwise(async () => {
-            await this.transcript(call, {
+            const eventId = await this.transcript(call, {
                 sections: speechSections,
                 reprompt: {
                     maxAttempts: repromptsList.length,
@@ -201,6 +208,7 @@ class CustomVoiceInput extends voice_1.default {
                 action: 'Call Prompt',
                 actionFromBot: true
             });
+            command.params.reporterTranscriptEventId = eventId;
             command.params.sections = speechSections;
             command.params.timeout = this.rptsTimeout({ noReplyDelay, repromptsList, initial: true });
             await this.pauseRecording(call, command, sensitiveData);

package/dst/Keypad Input.js

@@ -70,6 +70,13 @@ class KeypadInput extends voice_1.default {
         const speechSections = this.buildSections({ sections: this.data.audio, textType, ttsSettings, allowKeypadBargeIn: keypadBargeIn });
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
+            await this.handleInterruption({
+                call,
+                event,
+                speechSections,
+                repromptsList,
+                reportingSettingsKey
+            });
             switch (event.params.type) {
                 case 'digits': {
                     const digits = event.params.digits;
@@ -162,7 +169,7 @@ class KeypadInput extends voice_1.default {
             }
         });
         this.triggers.otherwise(async () => {
-            await this.transcript(call, {
+            const eventId = await this.transcript(call, {
                 sections: speechSections,
                 reprompt: {
                     maxAttempts: repromptsList.length,
@@ -172,6 +179,7 @@ class KeypadInput extends voice_1.default {
                 action: 'Call Prompt',
                 actionFromBot: true
             });
+            command.params.reporterTranscriptEventId = eventId;
             command.params.firstDigitTimeout = this.rptsTimeout({ noReplyDelay, repromptsList, initial: true });
             command.params.sections = speechSections;
             await this.pauseRecording(call, command, sensitiveData);

package/dst/Say Message.js

@@ -19,15 +19,11 @@ class SayMessage extends voice_1.default {
             ...ttsSettings
         }));
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
-            const interruptionMetadata = event.params.interruptionMetadata ?? null;
-            if (interruptionMetadata) {
-                await this.transcript(call, {
-                    action: 'Call Prompt',
-                    sections: speechSections,
-                    reportingSettingsKey: 'transcript',
-                    actionFromBot: true
-                }, interruptionMetadata);
-            }
+            await this.handleInterruption({
+                call,
+                event,
+                speechSections
+            });
             switch (event.params.type) {
                 case 'hangup':
                     await this.handleHangup(call);
@@ -48,15 +44,17 @@ class SayMessage extends voice_1.default {
             const command = {
                 name: 'speak',
                 params: {
-                    sections: speechSections
+                    sections: speechSections,
+                    reporterTranscriptEventId: ''
                 }
             };
-            await this.transcript(call, {
+            const eventId = await this.transcript(call, {
                 action: 'Call Prompt',
                 sections: command.params.sections,
                 reportingSettingsKey: 'transcript',
                 actionFromBot: true
             });
+            command.params.reporterTranscriptEventId = eventId;
             await this.pauseRecording(call, command, sensitiveData);
             return this.exitFlow();
         });

package/dst/Voice Recording.js

@@ -24,11 +24,18 @@ class Recording extends voice_1.default {
                     terminator: this.data.terminationKey
                 }),
                 duration: parseInt(this.data.recordDurationSeconds),
-                sections
+                sections,
+                reporterTranscriptEventId: ''
             }
         };
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             const url = event.params.mediaPath;
+            await this.handleInterruption({
+                call,
+                event,
+                speechSections: sections,
+                reportingSettingsKey: 'transcriptPrompt'
+            });
             switch (event.params.type) {
                 case 'hangup':
                     // TODO do we need zombie?
@@ -65,12 +72,13 @@ class Recording extends voice_1.default {
         this.triggers.otherwise(async () => {
             // TODO figure out Global Command compatibility
             lodash_1.default.set(this.state.hooks, 'skipVoiceEventTypes', ['hangup']);
-            await this.transcript(call, {
+            const eventId = await this.transcript(call, {
                 sections,
                 reportingSettingsKey: 'transcriptPrompt',
                 action: 'Call Prompt',
                 actionFromBot: true
             });
+            command.params.reporterTranscriptEventId = eventId;
             await this.pauseRecording(call, command, sensitiveData);
             return this.exitFlow();
         });

package/dst/voice.d.ts

@@ -1,4 +1,4 @@
-import { ICallback, IVoiceReporterTranscriptEventArgs, IPromtpSection } from '@onereach/flow-sdk/dst/types';
+import { ICallback, IVoiceReporterTranscriptEventArgs, IPromtpSection, ITypedEvent } from '@onereach/flow-sdk/dst/types';
 import ConvStep, { IConversationData } from './step';
 import BasicError from '@onereach/flow-sdk/dst/errors/base';
 export type TODO = any;
@@ -54,12 +54,25 @@ export interface VoiceEvent {
     type: EventType;
     global?: boolean;
     error?: VoicerError;
-    interruptionMetadata: VoiceInterruptionMetadata;
+    interruptionMetadata?: VoiceInterruptionMetadata;
+    result?: {
+        interruptionMetadata?: VoiceInterruptionMetadata;
+    };
 }
 export interface CallStartEvent extends VoiceEvent {
     channel: IVoiceCall;
     headers?: Record<string, string>;
 }
+export interface HandleInterruptionParams<TParams extends VoiceEvent = VoiceEvent> {
+    call: IVoiceCall;
+    event: ITypedEvent<TParams>;
+    speechSections: IPromtpSection[];
+    repromptsList?: {
+        message?: string;
+        fileName?: string;
+    }[];
+    reportingSettingsKey?: string;
+}
 export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends VoiceEvent = VoiceEvent> extends ConvStep<IVoiceCall, TIn & {
     handleCancel?: boolean;
 }, TOut, TParams> {
@@ -94,4 +107,6 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends Vo
     get rptsStarted(): boolean;
     canVoicerHearbeat(call: IVoiceCall): boolean;
     canVoicerAck(call: IVoiceCall): boolean;
+    getInterruptionMetadata(event: ITypedEvent<TParams>): VoiceInterruptionMetadata | null;
+    handleInterruption(params: HandleInterruptionParams<TParams>): Promise<void>;
 }

package/dst/voice.js

@@ -104,22 +104,26 @@ class VoiceStep extends step_1.default {
             this.end();
     }
     extractSectionMessages(sections, interruptionMetadata) {
-        return lodash_1.default.chain(sections)
-            .filter(s => Boolean(s.text))
+        const { sectionIndex } = interruptionMetadata ?? {};
+        const slicedTo = sectionIndex != null ? sectionIndex + 1 : sections.length;
+        return sections
+            .slice(0, slicedTo)
             .map((s, index) => {
             // Should escape html, max length 4000 symbols
-            let text = s.text?.slice(0, 4000).replace(/(<[^>]+>|<\/[^>]+>)/gi, ' ') ?? '';
+            let text = (s.text ?? '')
+                .slice(0, 4000)
+                .replace(/(<[^>]+>|<\/[^>]+>)/gi, ' ')
+                .trim();
             // Extracts the portion of the section text that corresponds to the played time.
             if (interruptionMetadata) {
-                const { playedTime, sectionDuration, sectionIndex } = interruptionMetadata;
+                const { playedTime, sectionDuration } = interruptionMetadata;
                 if (sectionIndex === index) {
                     text = this.extractPlayedSectionMessage(text, sectionDuration, playedTime);
                 }
             }
             return text;
         })
-            .join(' ')
-            .value();
+            .join(' ');
     }
     extractPlayedSectionMessage(text, sectionDuration, playedTime) {
         const words = text.split(' ');
@@ -128,7 +132,7 @@ class VoiceStep extends step_1.default {
         const playedTimeSec = playedTime / 1000;
         const wordsPerSecond = totalWords / sectionDurationSec;
         const wordsPlayed = Math.floor(wordsPerSecond * playedTimeSec);
-        return words.slice(0, wordsPlayed).join(' ');
+        return words.slice(0, wordsPlayed).join(' ').trim();
     }
     extractSectionFiles(sections) {
         return lodash_1.default.chain(sections)
@@ -217,19 +221,25 @@ class VoiceStep extends step_1.default {
          * which was returned from the interrupted message,
          * try to update the reporting message.
          */
-        if (interruptionMetadata?.reporterTranscriptEventId) {
+        if (interruptionMetadata?.reporterTranscriptEventId &&
+            reportingObject.message) {
+            const updateReportingObject = {
+                EventId: eventId,
+                Timestamp: new Date().toISOString(),
+                Event: 'Augment',
+                EventValue: {
+                    eventId: interruptionMetadata.reporterTranscriptEventId,
+                    eventValue: {
+                        Message: reportingObject.message,
+                    },
+                },
+            };
+            this.log.debug(`Augment Transcript`, {
+                interruptionMetadata,
+                updateReportingObject,
+                shouldBeSendToHitl: this.process.cache.hitl != null,
+            });
             if (this.process.cache.hitl) {
-                const updateReportingObject = {
-                    EventId: eventId,
-                    Timestamp: new Date().toISOString(),
-                    Event: 'Augment',
-                    EventValue: {
-                        eventId: interruptionMetadata.reporterTranscriptEventId,
-                        eventValue: {
-                            Message: reportingObject.message,
-                        }
-                    }
-                };
                 await this.process.cache.hitl.queueEvents([updateReportingObject]);
             }
         }
@@ -366,7 +376,8 @@ class VoiceStep extends step_1.default {
         if (reporting) {
             lodash_1.default.assign(reportingObject, reporting);
         }
-        await this.transcript(call, reportingObject);
+        const eventId = await this.transcript(call, reportingObject);
+        params.reporterTranscriptEventId = eventId;
         if (call.vv >= 2)
             await this.pauseRecording(call, command, sensitiveData);
         else
@@ -394,6 +405,35 @@ class VoiceStep extends step_1.default {
     canVoicerAck(call) {
         return call.vv >= 2;
     }
+    getInterruptionMetadata(event) {
+        return event.params?.interruptionMetadata
+            ?? event.params?.result?.interruptionMetadata
+            ?? null;
+    }
+    async handleInterruption(params) {
+        const { call, event, speechSections, repromptsList = [], reportingSettingsKey = 'transcript' } = params;
+        const interruptionMetadata = this.getInterruptionMetadata(event);
+        this.log.debug('handleInterruption', { event, speechSections, repromptsList });
+        if (!interruptionMetadata)
+            return;
+        const sections = [];
+        if (repromptsList.length && reportingSettingsKey === 'transcriptRepromptResponse') {
+            const current = repromptsList[this.rptsIndex - 1];
+            sections.push({
+                url: current?.fileName,
+                text: current?.message,
+            });
+        }
+        else {
+            sections.push(...speechSections);
+        }
+        await this.transcript(call, {
+            action: 'Call Prompt',
+            actionFromBot: true,
+            sections,
+            reportingSettingsKey,
+        }, interruptionMetadata);
+    }
 }
 exports.default = VoiceStep;
 module.exports = VoiceStep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "7.0.0-VOIC1406.5",
+  "version": "7.0.0-VOIC1406.7",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",