@onereach/step-voice 6.0.15 → 6.0.17

package/dst/Choice.d.ts

@@ -13,6 +13,7 @@ interface INPUT {
     useInterspeechTimeout: boolean;
     interSpeechTimeout: number;
     recognitionModel?: string;
+    longRecognition: boolean;
 }
 interface EVENT extends VoiceEvent {
     callRecording?: TODO;

package/dst/Choice.js

@@ -69,7 +69,7 @@ const isRepromptTrigger = (recogResult, promptsTriggers) => {
 class Choice extends voice_1.default {
     async runStep() {
         const call = await this.fetchData();
-        const { textType, asr, tts, sensitiveData, noReplyDelay, usePromptsTriggers, recognitionModel, useInterspeechTimeout, interSpeechTimeout } = this.data;
+        const { textType, asr, tts, sensitiveData, noReplyDelay, usePromptsTriggers, recognitionModel, useInterspeechTimeout, interSpeechTimeout, longRecognition } = this.data;
         const exitExists = (exitId) => {
             return lodash_1.default.some(choices, (choice) => choice.exitId === exitId);
         };
@@ -87,7 +87,9 @@ class Choice extends voice_1.default {
             name: 'speak',
             params: {
                 grammar,
-                dictation: useInterspeechTimeout,
+                dictation: longRecognition
+                    ? 'continuous'
+                    : useInterspeechTimeout,
                 interSpeechTimeout: interSpeechTimeout * 1000,
                 sections: []
             }
@@ -111,7 +113,7 @@ class Choice extends voice_1.default {
                             actionFromBot: false
                         });
                         await this.resumeRecording(call, sensitiveData);
-                        return this.exitStep(exitId, this.exitChoiceData('dtmf', params));
+                        return this.exitStep(exitId, this.exitChoiceData('dtmf', params), longRecognition);
                     }
                     else if (this.rptsHasMore({ repromptsList })) {
                         await this.transcript(call, {
@@ -139,9 +141,7 @@ class Choice extends voice_1.default {
                         actionFromBot: false
                     });
                     await this.resumeRecording(call, sensitiveData);
-                    return this.exitStep('unrecognized', this.exitChoiceData('dtmf', {
-                        digit
-                    }));
+                    return this.exitStep('unrecognized', this.exitChoiceData('dtmf', { digit }), longRecognition);
                 }
                 case 'recognition': {
                     const params = event.params;
@@ -166,7 +166,7 @@ class Choice extends voice_1.default {
                         });
                         await this.resumeRecording(call, sensitiveData);
                         // There might be hooks after this step which we will try to avoid
-                        return this.exitStep(exitId, this.exitChoiceData('voice', params));
+                        return this.exitStep(exitId, this.exitChoiceData('voice', params), longRecognition);
                     }
                     else if (this.rptsHasMore({ repromptsList }) &&
                         (usePromptsTriggers ? isRepromptTrigger(phrases, this.data.promptsTriggers) : true)) {
@@ -197,7 +197,7 @@ class Choice extends voice_1.default {
                     });
                     await this.resumeRecording(call, sensitiveData);
                     // We might end up in same session
-                    return this.exitStep('unrecognized', this.exitChoiceData('voice', params));
+                    return this.exitStep('unrecognized', this.exitChoiceData('voice', params), longRecognition);
                 }
                 case 'timeout': {
                     if (this.rptsHasMore({ repromptsList })) {
@@ -225,7 +225,7 @@ class Choice extends voice_1.default {
                     });
                     await this.resumeRecording(call, sensitiveData);
                     // We might end up in same session
-                    return this.exitStep('no reply', {});
+                    return this.exitStep('no reply', {}, longRecognition);
                 }
                 case 'hangup': {
                     await this.handleHangup(call);

package/dst/Global Command.d.ts

@@ -37,7 +37,6 @@ export default class GlobalCommand extends VoiceStep<Partial<INPUT>, OUTPUT, EVE
     worker(): Promise<void>;
     hangup(call: IVoiceCall): Promise<unknown>;
     exitThread(event: ITypedEvent<EVENT>, type: string, stepExit: string): Promise<void>;
-    exitToThread(): void;
     buildGrammar(call: IVoiceCall, choices: TODO[]): Promise<any>;
     replyAck(eventParams: any): void;
 }

package/dst/Global Command.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const types_1 = require("@onereach/flow-sdk/dst/types");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const nanoid_1 = require("nanoid");
 const voice_1 = tslib_1.__importDefault(require("./voice"));
 class GlobalCommand extends voice_1.default {
     get isGlobal() {
@@ -81,10 +80,13 @@ class GlobalCommand extends voice_1.default {
         this.triggers.otherwise(async () => {
             await this.initGrammar(call);
         });
-        this.triggers.hook({ name: "waitEnd" /* ACTION.waitEnd */, thread: types_1.MAIN_THREAD_ID, sync: true }, async () => {
-            // todo: hook once
-            delete this.waits['@waitEnd']; // TODO is there beter way to unsubscribe?
-            delete this.waits.waitEnd; // TODO is there beter way to unsubscribe?
+        this.triggers.hook({ name: "waitEnd" /* ACTION.waitEnd */, thread: types_1.MAIN_THREAD_ID, sync: true, times: 1 }, async () => {
+            // TODO:  this is not required in newer versions, delete in v6.1+
+            const allowAck = this.canVoicerAck(call);
+            if (!allowAck) {
+                delete this.waits['@waitEnd'];
+                delete this.waits.waitEnd;
+            }
             if (!call.ended) {
                 this.state.passive = true;
                 await this.sendCommands(call, [{ name: 'grammar', params: {} }]);
@@ -116,6 +118,7 @@ class GlobalCommand extends voice_1.default {
                             reportingSettingsKey: 'transcript',
                             actionFromBot: false
                         });
+                        await this.resumeRecording(call, { muteStep: true, muteUser: false, muteBot: false });
                         return await this.exitThread(event, 'digit', exitId);
                     }
                     else {
@@ -139,6 +142,7 @@ class GlobalCommand extends voice_1.default {
                             reportingSettingsKey: 'transcript',
                             actionFromBot: false
                         });
+                        await this.resumeRecording(call, { muteStep: true, muteUser: false, muteBot: false });
                         return await this.exitThread(event, 'voice', exitId);
                     }
                     else {
@@ -209,7 +213,6 @@ class GlobalCommand extends voice_1.default {
         });
     }
     async exitThread(event, type, stepExit) {
-        this.log.debug('exitThread', type, stepExit);
         const params = event.params;
         const result = { type };
         if (!lodash_1.default.isEmpty(params.tags)) {
@@ -232,24 +235,7 @@ class GlobalCommand extends voice_1.default {
         if (!lodash_1.default.isEmpty(params.callRecording)) {
             result.callRecording = params.callRecording;
         }
-        const exitLabel = lodash_1.default.replace(this.getExitStepLabel(stepExit) ?? stepExit, /\W+/g, '');
-        await this.process.runThread({
-            id: `${exitLabel}_${(0, nanoid_1.nanoid)(8)}`,
-            state: {
-                name: this.exitToThread.name,
-                direct: true,
-                result: {
-                    conversation: this.conversation,
-                    conversationThreadId: this.dataThreadId,
-                    ...result
-                },
-                exitStep: stepExit,
-                step: this.currentStepId
-            }
-        });
-    }
-    exitToThread() {
-        this.thread.exitStep(this.state.exitStep, this.state.result);
+        await this.exitStepByThread(stepExit, result);
     }
     async buildGrammar(call, choices) {
         const { asr } = this.data;

package/dst/step.js

@@ -128,7 +128,7 @@ class ConvStep extends step_1.default {
     async waitGlobEnd() {
         const gcThreadId = this.workerThreadId;
         // wait for glob thread end (if exists)
-        this.triggers.hook({ name: "end" /* ACTION.end */, thread: gcThreadId }, async () => await this.onConvEnd());
+        this.triggers.hook({ name: "end" /* ACTION.end */, thread: gcThreadId, times: 1 }, async () => await this.onConvEnd());
         if (!this.process.getThread(gcThreadId))
             await this.onConvEnd();
     }

package/dst/voice.d.ts

@@ -8,6 +8,7 @@ export interface SensitiveData {
     muteBot: boolean;
 }
 export interface IVoiceCall extends IConversationData {
+    /** voicer protocol version */
     vv: number;
     id: string;
     ended: boolean;
@@ -51,7 +52,9 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends Vo
     handleZombie?: boolean;
 }, TOut, TParams> {
     runBefore(): Promise<void>;
-    exitStep(step: string, data?: any): any;
+    exitStep(exitId: string, data?: any, byThread?: boolean): any;
+    exitStepByThread(exitId: string, result: any): any;
+    exitToThread(): void;
     sendCommands({ id, type, callback }: IVoiceCall, commands: TODO[]): Promise<void>;
     handleDataThreadStart(): void;
     handleDataThreadEnd(): void;

package/dst/voice.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VoiceStepError = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const nanoid_1 = require("nanoid");
 const types_1 = require("@onereach/flow-sdk/dst/types");
 const uuid_1 = require("uuid");
 // TODO: !!!!! import ConvStep from '@onereach/step-conversation/dst/step' !!!!!
@@ -22,11 +23,34 @@ class VoiceStep extends step_1.default {
                 await this.handleHeartbeat(this.cache);
         }
     }
-    exitStep(step, data) {
+    exitStep(exitId, data, byThread = false) {
+        if (byThread)
+            return this.exitStepByThread(exitId, data);
         if (this.cache != null) {
             this.handleDataThreadEnd();
         }
-        return super.exitStep(step, data);
+        return super.exitStep(exitId, data);
+    }
+    exitStepByThread(exitId, result) {
+        this.log.debug('exitStepByThread', exitId, result);
+        const exitLabel = lodash_1.default.replace(this.getExitStepLabel(exitId) ?? exitId, /\W+/g, '');
+        return this.process.runThread({
+            id: `${exitLabel}_${(0, nanoid_1.nanoid)(8)}`,
+            state: {
+                name: this.exitToThread.name,
+                direct: true,
+                result: {
+                    conversation: this.conversation,
+                    conversationThreadId: this.dataThreadId,
+                    ...result
+                },
+                exitStep: exitId,
+                step: this.currentStepId
+            }
+        });
+    }
+    exitToThread() {
+        this.thread.exitStep(this.state.exitStep, this.state.result);
     }
     async sendCommands({ id, type, callback }, commands) {
         if (lodash_1.default.isEmpty(commands))
@@ -62,7 +86,8 @@ class VoiceStep extends step_1.default {
             dataThread.waits[`thread/end/${this.thread.id}`] = {};
             return;
         }
-        this.triggers.hook({ name: "ending" /* ACTION.ending */, thread: this.dataThreadId, sync: true }, async () => {
+        this.triggers.hook({ name: "ending" /* ACTION.ending */, thread: this.dataThreadId, sync: true, times: 1 }, async () => {
+            // TODO:  this is not required in newer versions, delete in v6.1+
             delete this.waits['@ending'];
             delete this.waits.ending;
             if (dataThread.state.name === this.sleepUntilHangup.name) {
@@ -145,29 +170,34 @@ class VoiceStep extends step_1.default {
             .value();
     }
     async pauseRecording(call, command, sensitiveData) {
-        await this.sendCommands(call, [
-            ...call.recordCall && sensitiveData?.muteStep
-                ? [{
-                        name: 'stop-record-session',
-                        params: {
-                            muteUser: sensitiveData.muteUser,
-                            muteBot: sensitiveData.muteBot
-                        }
-                    }]
-                : [],
-            command
-        ]);
-    }
-    async resumeRecording(call, sensitiveData) {
+        const commands = [command];
         if (call.recordCall && sensitiveData?.muteStep) {
-            await this.sendCommands(call, [{
-                    name: 'resume-record-session',
+            if (call.vv >= 2) {
+                // newer voicer version automaically should stop/resume session recording
+                command.params.sensitiveData = sensitiveData;
+            }
+            else {
+                commands.unshift({
+                    name: 'stop-record-session',
                     params: {
                         muteUser: sensitiveData.muteUser,
                         muteBot: sensitiveData.muteBot
                     }
-                }]);
+                });
+            }
         }
+        await this.sendCommands(call, commands);
+    }
+    async resumeRecording(call, sensitiveData) {
+        if (!call.recordCall || !sensitiveData?.muteStep || call.vv >= 2)
+            return;
+        await this.sendCommands(call, [{
+                name: 'resume-record-session',
+                params: {
+                    muteUser: sensitiveData.muteUser,
+                    muteBot: sensitiveData.muteBot
+                }
+            }]);
     }
     async transcript(call, data = {}) {
         const { previousTranscriptId = call.lastTranscriptId, action, keyPress, message, voiceProcessResult, reportingSettingsKey, sections, reprompt, recording, conferenceId, actionFromBot = false } = data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "6.0.15",
+  "version": "6.0.17",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",
@@ -19,7 +19,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@onereach/flow-sdk": "^3.2.16",
+    "@onereach/flow-sdk": "^3.2.45",
     "@onereach/step-voice": "./test",
     "@swc/cli": "^0.1.62",
     "@swc/core": "^1.3.57",