@onereach/step-voice 7.0.9-VOIC1575.9 → 7.0.9-processttschunk.0

package/dst/Initiate Call.js

@@ -49,7 +49,6 @@ class InitiateCall extends voice_1.default {
     async waitForCall() {
         const { asr, tts, from: botNumber, endUserNumber, sipHost, sipUser, sipPassword, timeout, headers, enableSpoofCallerId, spoofCallerId, isAMD, otherCallRef, otherCallRefThread, handleCancel } = this.data;
         const call = await this.fetchData();
-        const callALegId = headers?.find(h => h.name === 'X-Leg-A')?.value;
         this.triggers.once(`in/voice/${call.id}/event`, async (event) => {
             switch (event.params.type) {
                 case 'is_flow_ready': {
@@ -101,46 +100,7 @@ class InitiateCall extends voice_1.default {
                                         type: asr.serverSettings.engine
                                     }
                                 }]
-                            : [],
-                        {
-                            name: 'whisper.hold',
-                            params: {
-                                id: callALegId
-                            }
-                        },
-                        {
-                            name: 'playback',
-                            params: {
-                                'sections': [
-                                    {
-                                        'text': '<speak>This is a live transfer from the automated system. Stand by for connection.</speak>',
-                                        'url': '',
-                                        'bargeInVoice': false,
-                                        'bargeInKeypad': false,
-                                        'textType': 'ssml',
-                                        'provider': 'polly',
-                                        'voiceId': 'Joanna',
-                                        'engine': 'standard',
-                                        'isStream': false,
-                                    },
-                                ],
-                                'useWhisperFeature': false,
-                                'sensitiveData': {},
-                                resumeAfterGc: true,
-                            }
-                        },
-                        {
-                            name: 'whisper.hold_off',
-                            params: {
-                                id: callALegId
-                            }
-                        },
-                        {
-                            name: 'whisper.transfer',
-                            params: {
-                                id: callALegId
-                            }
-                        },
+                            : []
                     ]);
                     return this.exitStep('success');
                 }
@@ -218,8 +178,7 @@ class InitiateCall extends voice_1.default {
                     : undefined,
                 timeout: originateTimeout,
                 version: 2,
-                sessionExpireTime: this.session.expireTime,
-                useWhisperFeature: false
+                sessionExpireTime: this.session.expireTime
             };
             if (otherCallRef) {
                 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

package/dst/Process TTS Chunk.d.ts

@@ -0,0 +1,13 @@
+import VoiceStep, { VoiceEvent } from './voice';
+interface INPUT {
+    textChunk: string;
+    isFinal: boolean;
+    flush?: boolean;
+}
+interface EVENT extends VoiceEvent {
+    exitId?: string;
+}
+export default class ProcessTtsChunk extends VoiceStep<INPUT, {}, EVENT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Process TTS Chunk.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const voice_1 = tslib_1.__importDefault(require("./voice"));
+class ProcessTtsChunk extends voice_1.default {
+    async runStep() {
+        const call = await this.fetchData();
+        const { textChunk, isFinal, flush } = this.data;
+        const command = {
+            name: 'process-tts-chunk',
+            params: {
+                chunk: textChunk,
+                isFinal,
+                flush,
+            }
+        };
+        this.log.info('ProcessTtsChunk command', { command });
+        this.triggers.local(`in/voice/${call.id}`, async (event) => {
+            this.log.info('Received event from voicer', event);
+        });
+        this.triggers.otherwise(async () => {
+            await this.sendCommands({ ...call, type: 'tts-chunk' }, [command]);
+            this.exitStep('next');
+        });
+    }
+}
+exports.default = ProcessTtsChunk;

package/dst/Say Message.js

@@ -46,8 +46,7 @@ class SayMessage extends voice_1.default {
                 name: 'speak',
                 params: {
                     sections: speechSections,
-                    reporterTranscriptEventId: '',
-                    useWhisperFeature: true
+                    reporterTranscriptEventId: ''
                 }
             };
             const eventId = await this.transcript(call, {

package/dst/Start TTS Chunks Processing.d.ts

@@ -0,0 +1,18 @@
+import VoiceStep, { TODO, VoiceEvent } from './voice';
+interface INPUT {
+    voiceId: string;
+    infiniteProcessing: boolean;
+    asr: TODO;
+    endpointing: number;
+    voiceSettings: any;
+    queryParams: any;
+    minConfidence: number;
+    confirmationConfidence?: number;
+}
+interface EVENT extends VoiceEvent {
+    phrases?: TODO[];
+}
+export default class StartTTSChunksProcessing extends VoiceStep<INPUT, {}, EVENT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Start TTS Chunks Processing.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const voice_1 = tslib_1.__importDefault(require("./voice"));
+class StartTTSChunksProcessing extends voice_1.default {
+    async runStep() {
+        const call = await this.fetchData();
+        const { voiceId, infiniteProcessing, asr, endpointing, minConfidence, confirmationConfidence, voiceSettings: getSettings, queryParams: getParams } = this.data;
+        const grammar = {
+            id: this.currentStepId,
+            asr: {
+                ...asr.getSettings(call.asr),
+                config: {
+                    endpointing,
+                }
+            },
+        };
+        const voiceSettings = await getSettings.call(this);
+        const queryParams = await getParams.call(this);
+        const command = {
+            name: 'start-TTS-chunks-processing',
+            params: {
+                voiceId,
+                infiniteProcessing,
+                grammar,
+                voiceSettings,
+                queryParams,
+                minConfidence,
+                confirmationConfidence
+            }
+        };
+        this.log.debug('StartTTSChunksProcessing command', { command });
+        this.triggers.local(`in/voice/${call.id}`, async (event) => {
+            this.log.info('Received event from voicer', event);
+            switch (event.params.type) {
+                case 'tts-chunks-playback-done': {
+                    this.log.info('tts-chunks-playback-done', event.params);
+                    return this.exitStep('next', {}, false);
+                }
+                case 'timeout': {
+                    this.log.info('timeout', event.params);
+                    return this.exitStep(event.params.type, {}, false);
+                }
+                case 'recognition': {
+                    this.log.info('recognition', event.params);
+                    const params = event.params;
+                    const exitData = this.exitChoiceData('voice', params);
+                    this.log.info('exitData', exitData);
+                    return this.exitStep(event.params.type, exitData, false);
+                }
+                case 'hangup': {
+                    await this.handleHangup(call);
+                    return await this.waitConvEnd();
+                }
+                case 'cancel': {
+                    return this.handleCancel();
+                }
+                case 'error':
+                    return this.throwError(event.params.error);
+            }
+        });
+        this.triggers.otherwise(async () => {
+            await this.pauseRecording(call, command);
+            return this.exitFlow();
+        });
+    }
+}
+exports.default = StartTTSChunksProcessing;

package/dst/voice.d.ts

@@ -1,9 +1,9 @@
 import { ICallback } from '@onereach/flow-sdk/dst/types/eventManager';
-import { IPromtpSection, IVoiceReporterTranscriptEventArgs } from '@onereach/flow-sdk/dst/types/reporter';
+import { IPromtpSection as IPromptSection, IVoiceReporterTranscriptEventArgs } from '@onereach/flow-sdk/dst/types/reporter';
 import { IEvent } from '@onereach/flow-sdk/dst/types/event';
 import ConvStep, { IConversationData } from './step';
 import BasicError from '@onereach/flow-sdk/dst/errors/base';
-import { WITH_VAR } from "@onereach/flow-sdk/types/thread";
+import { WITH_VAR } from '@onereach/flow-sdk/dst/types/thread';
 export type TODO = any;
 export interface SensitiveData {
     muteStep: boolean;
@@ -33,7 +33,7 @@ export interface IVoiceCall extends IConversationData {
         user: string;
     };
 }
-export type EventType = 'hangup' | 'ack' | 'error' | 'cancel' | 'background' | 'avm-detected' | 'recognition' | 'digit' | 'digits' | 'conference-start' | 'conference-end' | 'playback' | 'timeout' | 'record' | 'bridge' | 'bridge/ended' | 'is_flow_ready' | 'call' | 'dtmf-sent';
+export type EventType = 'hangup' | 'ack' | 'error' | 'cancel' | 'background' | 'avm-detected' | 'recognition' | 'digit' | 'digits' | 'conference-start' | 'conference-end' | 'playback' | 'timeout' | 'record' | 'bridge' | 'bridge/ended' | 'is_flow_ready' | 'call' | 'dtmf-sent' | 'tts-chunks-playback-done';
 export declare class VoiceStepError extends BasicError {
 }
 export type VoicerError = Error & {
@@ -69,11 +69,11 @@ export interface CallStartEvent extends VoiceEvent {
 export interface HandleInterruptionParams<TParams extends VoiceEvent = VoiceEvent> {
     call: IVoiceCall;
     event: IEvent<TParams>;
-    speechSections: IPromtpSection[];
-    repromptsList?: {
+    speechSections: IPromptSection[];
+    repromptsList?: Array<{
         message?: string;
         fileName?: string;
-    }[];
+    }>;
     reportingSettingsKey?: string;
 }
 export type VoiceEvents<TParams> = IEvent<TParams, WITH_VAR<'in/voice/'>> | IEvent<TParams, WITH_VAR<'in/voice/', '/event'>>;
@@ -87,9 +87,9 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends Vo
     sendCommands({ id, type, callback }: IVoiceCall, commands: TODO[]): Promise<void>;
     handleHeartbeat(call: IVoiceCall): Promise<void>;
     handleCancel(): void;
-    extractSectionMessages(sections: IPromtpSection[], interruptionMetadata?: VoiceInterruptionMetadata): string;
+    extractSectionMessages(sections: IPromptSection[], interruptionMetadata?: VoiceInterruptionMetadata): string;
     extractPlayedSectionMessage(text: string, sectionDuration: number, playedTime: number): string;
-    extractSectionFiles(sections: IPromtpSection[]): Array<{
+    extractSectionFiles(sections: IPromptSection[]): Array<{
         fileUrl: string;
         fileType: string;
     }>;
@@ -109,6 +109,8 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends Vo
     rptsHasMore({ repromptsList }: TODO): boolean;
     get rptsIndex(): number;
     get rptsStarted(): boolean;
+    canVoicerHeartbeat(call: IVoiceCall): boolean;
+    /** @deprecated use `this.canVoicerHeartbeat` instead */
     canVoicerHearbeat(call: IVoiceCall): boolean;
     canVoicerAck(call: IVoiceCall): boolean;
     getInterruptionMetadata(event: IEvent<TParams>): VoiceInterruptionMetadata | null;

package/dst/voice.js

@@ -63,7 +63,7 @@ class VoiceStep extends step_1.default {
                 step: { key: this.session.key, trd: this.isGlobal ? this.workerThreadId : this.thread.id } // response should be sent to this session
             },
             reporting: {
-                ...this.session.getSessionRef(),
+                ...this.session.getSessionRef()
             }
         };
         const result = await this.thread.eventManager.emit(event, {
@@ -75,14 +75,14 @@ class VoiceStep extends step_1.default {
             throw new Error(`failed to send command to call: ${id}`);
     }
     async handleHeartbeat(call) {
-        const allowHeartbeat = this.canVoicerHearbeat(call);
+        const allowHeartbeat = this.canVoicerHeartbeat(call);
         if (allowHeartbeat) {
             if (this.thread.background) {
                 delete this.waits.timeout;
                 return;
             }
-            const expectHearbeatBefore = Date.now() + 290000;
-            this.triggers.deadline(expectHearbeatBefore, () => {
+            const expectHeartbeatBefore = Date.now() + 290000;
+            this.triggers.deadline(expectHeartbeatBefore, () => {
                 this.thread.background = true;
                 if (call.ended) {
                     this.log.warn('missing heartbeat, call is ended');
@@ -149,7 +149,7 @@ class VoiceStep extends step_1.default {
         const commands = [command];
         const stopRecording = (call.recordCall && sensitiveData?.muteStep);
         if (call.vv >= 2) {
-            // newer voicer version automaically should stop/resume session recording
+            // newer voicer version automatically should stop/resume session recording
             command.params.sensitiveData = stopRecording ? sensitiveData : {};
         }
         else if (stopRecording) {
@@ -232,14 +232,14 @@ class VoiceStep extends step_1.default {
                 EventValue: {
                     eventId: interruptionMetadata.reporterTranscriptEventId,
                     eventValue: {
-                        Message: reportingObject.message,
-                    },
-                },
+                        Message: reportingObject.message
+                    }
+                }
             };
-            this.log.debug(`Augment Transcript`, {
+            this.log.debug('Augment Transcript', {
                 interruptionMetadata,
                 updateReportingObject,
-                shouldBeSendToHitl: this.process.cache.hitl != null,
+                shouldBeSendToHitl: this.process.cache.hitl != null
             });
             if (this.process.cache.hitl) {
                 await this.process.cache.hitl.queueEvents([updateReportingObject]);
@@ -401,16 +401,20 @@ class VoiceStep extends step_1.default {
     get rptsStarted() {
         return this.rptsIndex !== 0;
     }
-    canVoicerHearbeat(call) {
+    canVoicerHeartbeat(call) {
         return call.vv >= 1;
     }
+    /** @deprecated use `this.canVoicerHeartbeat` instead */
+    canVoicerHearbeat(call) {
+        return this.canVoicerHeartbeat(call);
+    }
     canVoicerAck(call) {
         return call.vv >= 2;
     }
     getInterruptionMetadata(event) {
-        return event.params?.interruptionMetadata
-            ?? event.params?.result?.interruptionMetadata
-            ?? null;
+        return event.params?.interruptionMetadata ??
+            event.params?.result?.interruptionMetadata ??
+            null;
     }
     async handleInterruption(params) {
         const { call, event, speechSections, repromptsList = [], reportingSettingsKey = 'transcript' } = params;
@@ -423,7 +427,7 @@ class VoiceStep extends step_1.default {
             const current = repromptsList[this.rptsIndex - 1];
             sections.push({
                 url: current?.fileName,
-                text: current?.message,
+                text: current?.message
             });
         }
         else {
@@ -433,7 +437,7 @@ class VoiceStep extends step_1.default {
             action: 'Call Prompt',
             actionFromBot: true,
             sections,
-            reportingSettingsKey,
+            reportingSettingsKey
         }, interruptionMetadata);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "7.0.9-VOIC1575.9",
+  "version": "7.0.9-processttschunk.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",