@onereach/step-voice 4.0.48-missconv.9 → 5.0.0

package/dst/Global Command.d.ts

@@ -2,6 +2,7 @@ import { ITypedEvent } from '@onereach/flow-sdk/dst/types';
 import VoiceStep, { IVoiceCall, TODO, VoiceEvent } from './voice';
 interface INPUT {
     asr: TODO;
+    autoPause: boolean;
     processHangUp: 'user' | 'bot' | 'both' | 'none' | string;
     recordAfterTransfer: boolean;
     recordCall: boolean;
@@ -27,11 +28,13 @@ interface EVENT extends VoiceEvent {
 }
 export default class GlobalCommand extends VoiceStep<Partial<INPUT>, OUTPUT, EVENT> {
     get isGlobal(): boolean;
+    get useQueue(): boolean;
     runStep(): Promise<void>;
-    initThread(): Promise<void>;
+    initGrammar(): Promise<void>;
     globThread(): Promise<void>;
     hangup(call: IVoiceCall): Promise<unknown>;
     exitThread(event: ITypedEvent<EVENT>, type: string, stepExit: string): Promise<void>;
+    onAwake(): Promise<void>;
     exitToThread(): void;
     buildGrammar(call: IVoiceCall, choices: TODO[]): Promise<any>;
     exitFlow(): unknown;

package/dst/Global Command.js

@@ -7,23 +7,27 @@ const nanoid_1 = require("nanoid");
 const voice_1 = tslib_1.__importDefault(require("./voice"));
 class GlobalCommand extends voice_1.default {
     get isGlobal() {
-        return this.thread.id === `G:${this.dataThreadId}`;
+        return this.thread.id === `G:${this.conversationName}`;
+    }
+    get useQueue() {
+        return this.isGlobal;
     }
     async runStep() {
-        const gcThreadId = `G:${this.dataThreadId}`;
-        this._clearCache();
+        const gcThreadId = `G:${this.conversationName}`;
         await this.process.runThread({
             id: gcThreadId,
             state: {
-                name: 'initThread',
+                name: 'globThread',
                 step: this.step.id,
                 thread: this.dataThreadId
             }
         });
-        await this.fetchData();
+        // refresh cache after global thread was started
+        this._clearCache();
+        await this.initGrammar();
         this.exitStep('no commands');
     }
-    async initThread() {
+    async initGrammar() {
         const call = await this.fetchData();
         const choices = this.buildChoices({ choices: this.data.choices });
         const grammar = await this.buildGrammar(call, choices);
@@ -33,6 +37,7 @@ class GlobalCommand extends voice_1.default {
         const recordSession = this.data.recordCall && !call.recordCall;
         if (recordSession) {
             call.recordCall = true;
+            await this.updateData();
         }
         // set grammar on voicer
         await this.sendCommands(call, [
@@ -51,16 +56,28 @@ class GlobalCommand extends voice_1.default {
                 }
             }
         ]);
-        await this.updateData();
-        this.gotoState({ ...this.state, name: 'globThread' });
     }
     async globThread() {
         const call = await this.fetchData();
+        if (call.vv >= 1 && lodash_1.default.isFunction(this.triggers.hook)) {
+            this.triggers.hook({ name: 'ending', thread: 'main' }, async () => {
+                this.thread.background = call._conv.glb.length > 1;
+                this.log.debug('gc set background', { bg: this.thread.background, len: call._conv.glb.length });
+            });
+            this.triggers.hook({ name: 'end', thread: 'main' }, async () => {
+                this.log.debug('gc terminate', { bg: this.thread.background });
+                if (await this.popConvStep()) {
+                    await this.sendEventToStep({ toGlobal: this.isGlobal, action: 'onAwake' });
+                }
+                this.end();
+            });
+        }
         this.triggers.once(`in/voice/${call.id}/event`, async (event) => {
             event.processed = undefined;
             switch (event.params.type) {
                 case 'hangup': {
                     await this.hangup(call);
+                    await this.popConvStep();
                     await this.notifyConvEnd();
                     return this.end();
                 }
@@ -110,8 +127,14 @@ class GlobalCommand extends voice_1.default {
                     }
                     return {};
                 }
-                case 'error':
-                    return this.throwError(event.params.error);
+                case 'error': {
+                    const localHandler = await this.sendEventToStep({ toGlobal: false, event: { ...this.event, processed: undefined, action: 'local' } });
+                    if (!localHandler) {
+                        this.throwError(event.params.error);
+                    }
+                    this.event.processed = true;
+                    break;
+                }
                 default:
                     return {};
             }
@@ -165,6 +188,10 @@ class GlobalCommand extends voice_1.default {
         if (!lodash_1.default.isEmpty(params.callRecording)) {
             result.callRecording = params.callRecording;
         }
+        if (!this.data.autoPause) {
+            await this.notifyConvEnd({ onlyLocal: true });
+            await this._refreshCache();
+        }
         const exitLabel = lodash_1.default.replace(this.getExitStepLabel(stepExit) ?? stepExit, /\W+/g, '');
         await this.process.runThread({
             id: `${exitLabel}_${(0, nanoid_1.nanoid)(8)}`,
@@ -184,6 +211,12 @@ class GlobalCommand extends voice_1.default {
         // this is required to mark event as handled
         // this.gotoState(this.state, { name: 'exiting' })
     }
+    async onAwake() {
+        await super.onAwake();
+        await this.initGrammar();
+        await this.globThread();
+        this.triggers.refreshAll();
+    }
     exitToThread() {
         this.thread.exitStep(this.state.exitStep, this.state.result);
     }

package/dst/Initiate Call.js

@@ -31,8 +31,8 @@ class InitiateCall extends voice_1.default {
                 }
             });
         }
-        const convData = { id: callId, type: 'voicer' };
-        await this.startConversation(convData, { events: {} });
+        const convData = { id: callId, type: 'voicer', vv: 0 };
+        await this.startConversation(convData);
         await this.pushConvStep();
         this.gotoState('waitForCall');
     }
@@ -76,9 +76,7 @@ class InitiateCall extends voice_1.default {
                     };
                     delete call.from;
                     delete call.to;
-                    await this.startConversation(call, {
-                        events: { [`in/voice/${call.id}/event`]: {} }
-                    });
+                    await this.startConversation(call);
                     await this.transcript(call, {
                         action: 'Call Start',
                         reportingSettingsKey: 'transcript',

package/dst/Keypad Input.d.ts

@@ -22,13 +22,10 @@ interface INPUT {
     recognitionModel?: string;
 }
 interface EVENT extends VoiceEvent {
-    callRecording?: TODO;
     exitId?: string;
-    digit?: string;
     digits?: string;
     phrases?: TODO[];
     tags?: string[];
-    out?: string;
 }
 export default class KeypadInput extends VoiceStep<INPUT, {}, EVENT> {
     runStep(): Promise<void>;

package/dst/Say Message.d.ts

@@ -10,7 +10,6 @@ interface INPUT {
         muteUser: boolean;
         muteBot: boolean;
     };
-    interSpeechTimeout: number;
 }
 export default class SayMessage extends VoiceStep<Partial<INPUT>> {
     runStep(): Promise<void>;

package/dst/Say Message.js

@@ -6,7 +6,7 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
 class SayMessage extends voice_1.default {
     async runStep() {
-        const { audio, textType, tts, sensitiveData, interSpeechTimeout = 0 } = this.data;
+        const { audio, textType, tts, sensitiveData } = this.data;
         const call = await this.fetchData();
         this.triggers.once(`in/voice/${call.id}/event`, async (event) => {
             if (call.recordCall && sensitiveData?.muteStep) {
@@ -39,8 +39,6 @@ class SayMessage extends voice_1.default {
             const command = {
                 name: 'speak',
                 params: {
-                    dictation: true,
-                    interSpeechTimeout: interSpeechTimeout * 1000,
                     sections: lodash_1.default.map(audio, (section) => ({
                         text: section.voiceTextMsg,
                         url: section.audioUrl,

package/dst/Wait For Call.js

@@ -44,9 +44,7 @@ class WaitForCall extends voice_1.default {
                 sessionType: 'Phone'
             }
         });
-        await this.startConversation(call, {
-            events: { [`in/voice/${call.id}/event`]: {} }
-        });
+        await this.startConversation(call);
         await this.transcript(call, {
             action: 'Call Start',
             reportingSettingsKey: 'transcript',

package/dst/step.d.ts

@@ -1,21 +1,22 @@
 import Step from '@onereach/flow-sdk/dst/step';
-import { IThreadId, IEvent, IStepResult, IMergeField, IMergeFieldKey } from '@onereach/flow-sdk/dst/types';
+import { IThreadId, IEvent, IStepResult, IMergeField } from '@onereach/flow-sdk/dst/types';
 import { IConversationStep } from '@onereach/step-conversation/dst/types';
 export interface ConvStepDataIn {
-    conversation?: IMergeFieldKey | IMergeField;
+    conversation?: string | IMergeField;
     conversationThread?: string;
 }
 interface IConversation {
     glb: IConversationStep[];
     lcl: IConversationStep[];
-    trg: Record<string, {}>;
 }
 interface IConversationData {
     _conv: IConversation;
 }
 export default class ConvStep<TData = unknown, TIn = unknown, TOut = unknown, TParams = any> extends Step<TIn & ConvStepDataIn, TOut, TParams> {
-    convDataCache?: TData & IConversationData;
-    get conversation(): IMergeFieldKey | IMergeField;
+    private convDataCache?;
+    get cache(): TData & IConversationData | undefined;
+    get conversation(): string | IMergeField;
+    get conversationName(): string;
     /** id of the thread where conversation data is stored */
     get dataThreadId(): IThreadId;
     get isGlobal(): boolean;
@@ -29,20 +30,22 @@ export default class ConvStep<TData = unknown, TIn = unknown, TOut = unknown, TP
     hasActiveGlobal(): Promise<boolean>;
     setLocalTriggers(): Promise<void>;
     waitForConversation(): Promise<void>;
-    onSkipEvent(): Promise<void>;
+    protected onSkipEvent(): Promise<void>;
     cancel(): Promise<void>;
-    onCancel(): Promise<void>;
+    protected onCancel(): Promise<void>;
     onSleep(): Promise<void>;
     onAwake(): Promise<void>;
     onPause(): Promise<void>;
     onResume(): Promise<void>;
-    notifyConvEnd(): Promise<void>;
+    notifyConvEnd({ onlyLocal }?: {
+        onlyLocal?: boolean;
+    }): Promise<void>;
     waitConvEnd(): Promise<void>;
     waitGlobEnd(): Promise<void>;
     onConvEnd(): Promise<void>;
     pause(): Promise<void>;
     resume(): Promise<void>;
-    sendEventToStep({ toGlobal, toStep, action, event }: {
+    protected sendEventToStep({ toGlobal, toStep, action, event }: {
         action?: string;
         event?: IEvent;
         toStep?: IConversationStep;
@@ -50,14 +53,14 @@ export default class ConvStep<TData = unknown, TIn = unknown, TOut = unknown, TP
     }): Promise<IStepResult | undefined>;
     activeStep(isGlobal?: boolean): Promise<IConversationStep | undefined>;
     /** @returns true if current conv is active */
-    pushConvStep(): Promise<boolean>;
+    protected pushConvStep(): Promise<boolean>;
     /** @returns true if current conv was active */
-    popConvStep(popStep?: IConversationStep): Promise<boolean>;
-    startConversation(data: TData, { events }: {
-        events: Record<string, {}>;
+    protected popConvStep(popStep?: IConversationStep): Promise<boolean>;
+    startConversation(data: TData, { thread }?: {
         thread?: IThreadId;
     }): Promise<void>;
-    _fetchData(): Promise<(TData & IConversationData) | undefined>;
-    _clearCache(): void;
+    protected _fetchCache(): Promise<(TData & IConversationData) | undefined>;
+    protected _clearCache(): void;
+    protected _refreshCache(): Promise<void>;
 }
 export {};

package/dst/step.js

@@ -4,11 +4,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const step_1 = tslib_1.__importDefault(require("@onereach/flow-sdk/dst/step"));
 class ConvStep extends step_1.default {
+    get cache() {
+        return this.convDataCache;
+    }
     get conversation() {
         if (this.data.conversation == null)
             throw new Error('missing data.conversation');
         return this.data.conversation;
     }
+    get conversationName() {
+        const convOrName = this.conversation;
+        const conv = (typeof convOrName === 'string')
+            ? this.config.mergeFields[convOrName] ?? convOrName
+            : convOrName;
+        if (conv.type === 'thread')
+            return this.dataThreadId;
+        if (typeof conv.name === 'string')
+            return conv.name;
+        if (typeof convOrName === 'string')
+            return convOrName;
+        throw new Error(`invalid conversation ${JSON.stringify(conv)}`);
+    }
     /** id of the thread where conversation data is stored */
     get dataThreadId() {
         const dataThreadId = this.state.thread ?? this.data.conversationThread;
@@ -21,7 +37,7 @@ class ConvStep extends step_1.default {
         return true;
     }
     async fetchData() {
-        const data = await this._fetchData();
+        const data = await this._fetchCache();
         if (data?._conv == null)
             throw new Error(`missing conversation data in state ${this.state.name}`);
         return data;
@@ -37,7 +53,7 @@ class ConvStep extends step_1.default {
         await convDataThread.set(this.conversation, this.convDataCache);
     }
     async hasConversation() {
-        return (await this._fetchData())?._conv != null;
+        return (await this._fetchCache())?._conv != null;
     }
     async runBefore() {
         await super.runBefore();
@@ -60,12 +76,12 @@ class ConvStep extends step_1.default {
         if (this.useQueue && !await this.pushConvStep()) {
             return await this.waitForConversation();
         }
-        if (this.event.action == null && !this.event.processed && this.convDataCache?._conv?.trg?.[this.event.name] != null) {
+        if (this.event.action == null && !this.event.processed) {
             if (this.isGlobal)
                 return;
             const hasGlobal = await this.sendEventToStep({ event: { ...this.event, action: 'global' }, toGlobal: true }); // redirect to global (1)
-            this.log.debug('conv.sendEventToStep toGlobal', { hasGlobal });
             if (hasGlobal != null) {
+                this.log.debug('conv.sendEventToStep toGlobal', { hasGlobal });
                 this.state.prevSkipName = this.state.name;
                 this.state.name = 'onSkipEvent';
                 return;
@@ -77,6 +93,8 @@ class ConvStep extends step_1.default {
         await this.setLocalTriggers();
     }
     async runAfter() {
+        if (this.thread.ending)
+            return;
         if (!await this.hasConversation())
             return await super.runAfter();
         if (this.thread.hasControlAction()) {
@@ -142,6 +160,11 @@ class ConvStep extends step_1.default {
     async onAwake() {
         this.state.name = this.state.resumeState;
         this.state.resumeState = undefined;
+        const conv = await this.getConversation();
+        if (this.isGlobal && conv.glb.length === 1) {
+            this.log.debug('make global thread foreground');
+            this.thread.background = false;
+        }
     }
     async onPause() {
         this.state.resumeState = this.state.prevName;
@@ -151,11 +174,10 @@ class ConvStep extends step_1.default {
         this.state.name = this.state.resumeState;
         this.state.resumeState = undefined;
     }
-    async notifyConvEnd() {
-        await this.popConvStep();
+    async notifyConvEnd({ onlyLocal } = {}) {
         const conv = await this.getConversation();
         const lcl = conv.lcl.splice(0);
-        const glb = conv.glb.splice(0);
+        const glb = onlyLocal ? [] : conv.glb.splice(0);
         if (lcl.length > 0 || glb.length > 0) {
             await this.updateData();
             for (const step of lcl) {
@@ -264,20 +286,18 @@ class ConvStep extends step_1.default {
         // if (updated) await this.updateData()
         return false;
     }
-    async startConversation(data, { events }) {
+    async startConversation(data, { thread: _thread } = {}) {
         this.convDataCache = {
             ...data,
             _conv: {
-                trg: events,
                 glb: [],
-                // stk: [],
                 lcl: []
             }
         };
         await this.updateData();
         // this.state.thread = this.dataThreadId
     }
-    async _fetchData() {
+    async _fetchCache() {
         if (this.convDataCache != null)
             return this.convDataCache;
         const convDataThread = this.process.getSafeThread(this.dataThreadId);
@@ -288,5 +308,9 @@ class ConvStep extends step_1.default {
     _clearCache() {
         this.convDataCache = undefined;
     }
+    async _refreshCache() {
+        this._clearCache();
+        await this._fetchCache();
+    }
 }
 exports.default = ConvStep;

package/dst/voice.d.ts

@@ -36,7 +36,7 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams = VoiceEve
 }, TOut, TParams> {
     runBefore(): Promise<void>;
     sendCommands({ id, type, callback }: IVoiceCall, commands: TODO[]): Promise<unknown>;
-    handleHeartbeat(call: IVoiceCall): void;
+    handleHeartbeat(call: IVoiceCall): Promise<void>;
     extractSectionMessages(sections: IPromtpSection[]): string;
     extractSectionFiles(sections: IPromtpSection[]): Array<{
         fileUrl: string;

package/dst/voice.js

@@ -15,8 +15,8 @@ class VoiceStep extends step_1.default {
     // static Error = VoiceStepError
     async runBefore() {
         await super.runBefore();
-        if (this.convDataCache != null)
-            this.handleHeartbeat(this.convDataCache);
+        if (this.cache != null)
+            await this.handleHeartbeat(this.cache);
     }
     async sendCommands({ id, type, callback }, commands) {
         if (lodash_1.default.isEmpty(commands))
@@ -27,7 +27,8 @@ class VoiceStep extends step_1.default {
             params: {
                 id,
                 cancel: this.isGlobal ? undefined : true,
-                hbs: 60,
+                async: this.isGlobal ? true : undefined,
+                hbs: 99,
                 commands
             },
             reporting: this.session.getSessionRef()
@@ -37,17 +38,18 @@ class VoiceStep extends step_1.default {
             timeout: 5000
         });
     }
-    handleHeartbeat(call) {
+    async handleHeartbeat(call) {
         if (call.vv >= 1) {
-            const expectHearbeatBefore = Date.now() + 120000;
+            const expectHearbeatBefore = Date.now() + 290000;
             this.triggers.deadline(expectHearbeatBefore, () => {
                 this.end();
                 this.throwError(new Error('missing heartbeat, call is probably already hangup'));
             });
         }
-        else {
-            // refresh timeout?
-            this.log.warn('voicer is older than expected, please consider voicer upgrade');
+        else if (call.vv !== 0) {
+            this.log.debug('voicer is older than expected, please consider voicer upgrade', { version: call.vv });
+            call.vv = 0;
+            await this.updateData();
         }
     }
     extractSectionMessages(sections) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "4.0.48-missconv.9",
+  "version": "5.0.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",
@@ -19,22 +19,22 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@onereach/flow-sdk": "^3.1.83",
-    "@swc/cli": "^0.1.59",
-    "@swc/core": "^1.3.28",
+    "@onereach/flow-sdk": "^3.1.101",
+    "@swc/cli": "^0.1.60",
+    "@swc/core": "^1.3.32",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.4.0",
     "@types/lodash": "^4.14.191",
     "@types/timestring": "^6.0.2",
     "@types/uuid": "^9.0.0",
-    "aws-sdk": "^2.1301.0",
+    "aws-sdk": "^2.1306.0",
     "babel-runtime": "^6.26.0",
     "docdash": "^2.0.1",
     "husky": "^8.0.3",
-    "jest": "^29.4.0",
+    "jest": "^29.4.1",
     "pinst": "^3.0.0",
     "ts-standard": "^12.0.2",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "files": [
     "/dst"
@@ -78,4 +78,4 @@
       "node_modules"
     ]
   }
-}
+}