@onereach/step-voice 4.0.2 → 4.0.3

package/dst/Cancel.d.ts

@@ -1,5 +1,5 @@
-export default class VoiceCancel extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<unknown>;
+import VoiceStep from './voice';
+export default class VoiceCancel extends VoiceStep {
+    get useQueue(): boolean;
+    runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Cancel.js

@@ -10,7 +10,7 @@ class VoiceCancel extends voice_1.default {
         const channel = await this.fetchData();
         await this.cancel();
         await this.sendCommands(channel, [{ name: 'cancel' }]);
-        return this.exitStep('next');
+        this.exitStep('next');
     }
 }
 exports.default = VoiceCancel;

package/dst/Choice.d.ts

@@ -1,5 +1,30 @@
-export default class Choice extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep, { TODO, VoiceEvent } from './voice';
+interface INPUT {
+    textType: string;
+    asr: TODO;
+    tts: TODO;
+    audio: TODO[];
+    choices: TODO[];
+    prompts: TODO[];
+    sensitiveData: {
+        muteStep: boolean;
+        muteUser: boolean;
+        muteBot: boolean;
+    };
+    noReplyDelay: number;
+    promptsTriggers: TODO[];
+    usePromptsTriggers: boolean;
 }
-import VoiceStep from "./voice";
+interface EVENT extends VoiceEvent {
+    callRecording?: TODO;
+    exitId?: string;
+    digit?: string;
+    digits?: string;
+    phrases?: TODO[];
+    tags?: string[];
+    out?: string;
+}
+export default class Choice extends VoiceStep<INPUT, {}, EVENT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Choice.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 const digitWords = [
     'zero',
     'one',
@@ -28,7 +28,7 @@ const containsOnlyDigits = (stringsList) => {
     return isOnlyDigits;
 };
 const getPhrasesForSpeechRec = (choices) => {
-    const texts = _.flatMap(choices, (choice) => choice.options.map((opt) => opt.text));
+    const texts = lodash_1.default.flatMap(choices, (choice) => choice.options.map((opt) => opt.text));
     if (containsOnlyDigits(texts)) {
         return ['$OOV_CLASS_DIGIT_SEQUENCE'];
     }
@@ -54,7 +54,7 @@ const isRepromptTrigger = (recogResult, promptsTriggers) => {
         return r.lexical;
     });
     const triggers = promptsTriggers.flatMap((trigger) => {
-        if (_.isEmpty(trigger.grammar)) {
+        if (lodash_1.default.isEmpty(trigger.grammar)) {
             return trigger.text.replace(/`/g, '');
         }
         else {
@@ -63,14 +63,14 @@ const isRepromptTrigger = (recogResult, promptsTriggers) => {
             });
         }
     });
-    return !_.isEmpty(phrases.filter((e) => triggers.indexOf(e) !== -1));
+    return !lodash_1.default.isEmpty(phrases.filter((e) => triggers.includes(e)));
 };
 class Choice extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
         const { textType, asr, tts, sensitiveData, noReplyDelay, usePromptsTriggers } = this.data;
         const exitExists = (exitId) => {
-            return _.some(choices, (choice) => choice.exitId === exitId);
+            return lodash_1.default.some(choices, (choice) => choice.exitId === exitId);
         };
         const choices = this.buildChoices({ choices: this.data.choices });
         const ttsSettings = tts.getSettings(channel.tts);
@@ -90,8 +90,7 @@ class Choice extends voice_1.default {
             }
         };
         // There's a specific need to do so. There might be ${variable} section
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             if (channel.recordCall && sensitiveData?.muteStep) {
                 await this.sendCommands(channel, [{
                         name: 'resume-record-session',
@@ -106,13 +105,13 @@ class Choice extends voice_1.default {
                 case 'digit':
                 case 'digits': {
                     const params = event.params;
-                    const digit = params.digit || params.digits;
-                    const exitId = params.exitId;
+                    const digit = params.digit ?? params.digits;
+                    const exitId = params.exitId ?? '';
                     // On bargeIn, we should stop playback
                     if (exitExists(exitId)) {
                         await this.transcript(channel, {
                             keyPress: digit,
-                            message: _.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
+                            message: lodash_1.default.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
                             reportingSettingsKey,
                             action: 'Call DTMF',
                             actionFromBot: false
@@ -150,19 +149,19 @@ class Choice extends voice_1.default {
                 }
                 case 'recognition': {
                     const params = event.params;
-                    const exitId = params.exitId;
+                    const exitId = params.exitId ?? '';
                     const phrases = params.phrases;
-                    if (_.isEmpty(phrases)) {
+                    if (lodash_1.default.isEmpty(phrases)) {
                         return this.exitStep('unrecognized', {});
                     }
-                    const voiceProcessResult = _.chain(phrases)
+                    const voiceProcessResult = lodash_1.default.chain(phrases)
                         .map((p) => p.lexical)
                         .join(' | ')
                         .value();
                     // On bargeIn, we should stop playback
                     if (exitExists(exitId)) {
                         await this.transcript(channel, {
-                            message: _.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
+                            message: lodash_1.default.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
                             voiceProcessResult,
                             reportingSettingsKey,
                             action: 'Call Recognition',
@@ -241,8 +240,8 @@ class Choice extends voice_1.default {
                 default:
                     return this.exitFlow();
             }
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             await this.transcript(channel, {
                 sections: speechSections,
                 reprompt: {
@@ -256,13 +255,15 @@ class Choice extends voice_1.default {
             command.params.sections = speechSections;
             command.params.timeout = this.rptsTimeout({ noReplyDelay, repromptsList });
             await this.sendCommands(channel, [
-                ...channel.recordCall && sensitiveData?.muteStep ? [{
-                        name: 'stop-record-session',
-                        params: {
-                            muteUser: sensitiveData.muteUser,
-                            muteBot: sensitiveData.muteBot
-                        }
-                    }] : [],
+                ...channel.recordCall && sensitiveData?.muteStep
+                    ? [{
+                            name: 'stop-record-session',
+                            params: {
+                                muteUser: sensitiveData.muteUser,
+                                muteBot: sensitiveData.muteBot
+                            }
+                        }]
+                    : [],
                 command
             ]);
             return this.exitFlow();

package/dst/Conference Dial.d.ts

@@ -1,5 +1,10 @@
-export default class ConferenceDial extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
+import VoiceStep from './voice';
+export default class ConferenceDial extends VoiceStep<{
+    stayInConference: boolean;
+    sourceConf: string;
+    botNumber: string;
+    headers?: Record<string, string>;
+    hearOnly: boolean;
+}> {
     runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Conference Dial.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 class ConferenceDial extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
@@ -17,7 +17,7 @@ class ConferenceDial extends voice_1.default {
                         return this.exitFlow();
                     }
                     else {
-                        return this.exitStep('next', _.omit(event.params, ['type']));
+                        return this.exitStep('next', lodash_1.default.omit(event.params, ['type']));
                     }
                 case 'conference-end':
                     return this.data.stayInConference ? this.exitStep('next') : this.exitFlow();

package/dst/Global Command.d.ts

@@ -1,16 +1,39 @@
-export default class GlobalCommand extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    get autoCancel(): undefined;
+import { ITypedEvent } from '@onereach/flow-sdk/dst/types';
+import VoiceStep, { IVoiceChannel, TODO, VoiceEvent } from './voice';
+interface INPUT {
+    asr: TODO;
+    processHangUp: 'user' | 'bot' | 'both' | 'none';
+    recordAfterTransfer: boolean;
+    recordCall: boolean;
+    choices: TODO[];
+}
+interface OUTPUT {
+    type: string;
+    digit?: string;
+    value?: string;
+    interpretation?: TODO[];
+    callRecording?: TODO;
+    tags?: string[];
+    out?: string;
+}
+interface EVENT extends VoiceEvent {
+    callRecording?: TODO;
+    exitId?: string;
+    digit?: string;
+    digits?: string;
+    phrases?: TODO[];
+    tags?: string[];
+    out?: string;
+}
+export default class GlobalCommand extends VoiceStep<INPUT, OUTPUT, EVENT> {
+    get isGlobal(): boolean;
+    get autoCancel(): boolean | undefined;
     runStep(): Promise<void>;
     globThread(): Promise<void>;
-    hangup(channel: any, event: any): Promise<unknown>;
-    exitThread(event: any, type: any, stepExit: any): Promise<void>;
-    exitToThread(): Promise<void>;
-    buildGrammar(channel: any, choices: any): Promise<{
-        id: string;
-        choices: any;
-        asr: any;
-    }>;
+    hangup(channel: IVoiceChannel): Promise<unknown>;
+    exitThread(event: ITypedEvent<EVENT>, type: string, stepExit: string): Promise<void>;
+    exitToThread(): void;
+    buildGrammar(channel: IVoiceChannel, choices: TODO[]): Promise<any>;
     exitFlow(): unknown;
 }
-import VoiceStep from "./voice";
+export {};

package/dst/Global Command.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const nanoid_1 = require("nanoid");
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const { nanoid } = require('nanoid');
-const _ = require('lodash');
 class GlobalCommand extends voice_1.default {
     get isGlobal() {
         return true;
@@ -60,9 +60,9 @@ class GlobalCommand extends voice_1.default {
     async globThread() {
         const channel = await this.fetchData();
         const choices = this.buildChoices({ choices: this.data.choices });
-        const exitExists = (exitId) => {
-            return _.some(choices, (choice) => choice.exitId === exitId);
-        };
+        function exitExists(exitId) {
+            return lodash_1.default.some(choices, (choice) => choice.exitId === exitId);
+        }
         if (channel.autoHangup) {
             this.triggers.local('thread/end/main', async () => {
                 delete this.thread.waits['thread/end/main'];
@@ -71,8 +71,8 @@ class GlobalCommand extends voice_1.default {
                     channel.autoHangup = false;
                     await this.updateData();
                     this.local.background = undefined;
-                    this.sendCommands(channel, [{ name: 'hangup' }]);
-                    this.process.main.enqueueAndRun({ name: 'ending' });
+                    await this.sendCommands(channel, [{ name: 'hangup' }]);
+                    void this.process.main.enqueueAndRun({ name: 'ending' });
                     this.exitFlow();
                 }
             });
@@ -81,46 +81,46 @@ class GlobalCommand extends voice_1.default {
             event.processed = undefined;
             switch (event.params.type) {
                 case 'hangup': {
-                    await this.hangup(channel, event);
+                    await this.hangup(channel);
                     return this.end();
                 }
                 case 'avm-detected':
                     // this.event = {};
-                    return this.exitThread(event, 'AMD', 'AMD');
+                    return await this.exitThread(event, 'AMD', 'AMD');
                 case 'digit':
                 case 'digits': {
                     const params = event.params;
-                    const exitId = params.exitId;
-                    if (exitExists(params.exitId)) {
+                    const exitId = params.exitId ?? '';
+                    if (exitExists(exitId)) {
                         await this.transcript(channel, {
                             previousTranscriptId: channel.lastTranscriptId,
                             keyPress: params.digit,
-                            message: _.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
+                            message: lodash_1.default.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
                             action: 'Call DTMF',
                             reportingSettingsKey: 'transcript',
                             actionFromBot: false
                         });
-                        return this.exitThread(event, 'digit', params.exitId);
+                        return await this.exitThread(event, 'digit', exitId);
                     }
                     return {};
                 }
                 case 'recognition': {
                     const params = event.params;
-                    const exitId = params.exitId;
-                    if (exitExists(params.exitId)) {
-                        const voiceProcessResult = _.chain(params.phrases)
+                    const exitId = params.exitId ?? '';
+                    if (exitExists(exitId)) {
+                        const voiceProcessResult = lodash_1.default.chain(params.phrases)
                             .map((p) => p.lexical)
                             .join(' | ')
                             .value();
                         await this.transcript(channel, {
                             previousTranscriptId: channel.lastTranscriptId,
-                            message: _.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
+                            message: lodash_1.default.replace(this.getExitStepLabel(exitId), /^(\d+\. )?(~ )?/, ''),
                             action: 'Call Recognition',
                             voiceProcessResult,
                             reportingSettingsKey: 'transcript',
                             actionFromBot: false
                         });
-                        return this.exitThread(event, 'voice', params.exitId);
+                        return await this.exitThread(event, 'voice', exitId);
                     }
                     return {};
                 }
@@ -131,7 +131,7 @@ class GlobalCommand extends voice_1.default {
             }
         });
     }
-    async hangup(channel, event) {
+    async hangup(channel) {
         await this.handleHangup(channel);
         // if (channel.recordCall || _.includes(['bot', 'both'], processHangUp)) {
         //   // turn off protection of session deletion by "End" step
@@ -140,20 +140,20 @@ class GlobalCommand extends voice_1.default {
         const isHangedUpByBot = channel.sessionEndedBy === 'Bot';
         const hangUpType = isHangedUpByBot ? 'bot hang up' : 'user hang up';
         // process call recording in hangup event
-        if (channel.recordCall && event.params.callRecording) {
-            return this.exitThread(event, hangUpType, 'hang up');
+        if (channel.recordCall && this.event.params.callRecording != null) {
+            return await this.exitThread(this.event, hangUpType, 'hang up');
         }
         switch (this.data.processHangUp) {
             case 'user':
                 return isHangedUpByBot
                     ? this.exitFlow()
-                    : this.exitThread({}, hangUpType, 'hang up');
+                    : await this.exitThread(this.event, hangUpType, 'hang up');
             case 'bot':
                 return isHangedUpByBot
-                    ? this.exitThread({}, hangUpType, 'hang up')
+                    ? await this.exitThread(this.event, hangUpType, 'hang up')
                     : this.exitFlow();
             case 'both':
-                return this.exitThread({}, hangUpType, 'hang up');
+                return await this.exitThread(this.event, hangUpType, 'hang up');
             case 'none':
             default:
                 return this.exitFlow();
@@ -161,28 +161,26 @@ class GlobalCommand extends voice_1.default {
     }
     async exitThread(event, type, stepExit) {
         // this.log.warn('EXIT HOOK', type, stepExit);
-        const params = event.params || {};
-        const data = {
-            type
-        };
-        if (!_.isEmpty(params.tags)) {
+        const params = event.params;
+        const data = { type };
+        if (!lodash_1.default.isEmpty(params.tags)) {
             data.tags = params.tags;
         }
-        if (!_.isEmpty(params.out)) {
+        if (!lodash_1.default.isEmpty(params.out)) {
             data.out = params.out;
         }
-        const digits = params.digits || params.digit;
-        if (!_.isEmpty(digits)) {
+        const digits = params.digits ?? params.digit;
+        if (!lodash_1.default.isEmpty(digits)) {
             data.digit = digits;
             data.value = digits;
         }
-        if (!_.isEmpty(params.phrases)) {
+        if (!lodash_1.default.isEmpty(params.phrases)) {
             const phrases = params.phrases;
             data.value = phrases[0].text;
             data.interpretation = phrases;
         }
         // add information about call recording to a merge field
-        if (!_.isEmpty(params.callRecording)) {
+        if (!lodash_1.default.isEmpty(params.callRecording)) {
             data.callRecording = params.callRecording;
         }
         // await this.sendCommands(channel, [{
@@ -192,7 +190,7 @@ class GlobalCommand extends voice_1.default {
         // channel.global = null;
         await this.updateData();
         await this.process.runThread({
-            id: `${stepExit}_${nanoid(8)}`,
+            id: `${stepExit}_${(0, nanoid_1.nanoid)(8)}`,
             state: {
                 name: 'exitToThread',
                 result: {
@@ -207,7 +205,7 @@ class GlobalCommand extends voice_1.default {
         // this is required to mark event as handled
         // this.gotoState(this.state, { name: 'exiting' })
     }
-    async exitToThread() {
+    exitToThread() {
         this.thread.jumpTo(this.state.exitStep, this.state.result);
     }
     async buildGrammar(channel, choices) {

package/dst/Hangup.d.ts

@@ -1,5 +1,4 @@
-export default class Hangup extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
+import VoiceStep from './voice';
+export default class Hangup extends VoiceStep {
     runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Hangup.js

@@ -24,7 +24,7 @@ class Hangup extends voice_1.default {
                 await this.sendCommands(channel, [{ name: 'hangup' }]);
             }
             catch (err) {
-                this.log.warn(`Catch hangup error: ${err}`);
+                this.log.warn('hangup error', err);
                 return this.exitStep('next');
             }
             return this.exitFlow();

package/dst/Idle Music.d.ts

@@ -1,5 +1,12 @@
-export default class IdleMusic extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<unknown>;
+import VoiceStep from './voice';
+interface INPUT {
+    idleDuration: number;
+    idleMusicDelay: number;
+    idleMusicEnabled: boolean;
+    customIdleMusic: boolean;
+    idleMusicUrl: string;
 }
-import VoiceStep from "./voice";
+export default class IdleMusic extends VoiceStep<INPUT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Idle Music.js

@@ -1,29 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const timestring_1 = tslib_1.__importDefault(require("timestring"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const joi = require('joi');
-const timestring = require('timestring');
-const _ = require('lodash');
-const schema = joi.object().keys({
-    idleMusicEnabled: joi.boolean().required(),
-    idleDuration: joi.number().min(10000).max(1800000).required(),
-    idleMusicDelay: joi.when('idleMusicEnabled', {
+const schema = joi_1.default.object().keys({
+    idleMusicEnabled: joi_1.default.boolean().required(),
+    idleDuration: joi_1.default.number().min(10000).max(1800000).required(),
+    idleMusicDelay: joi_1.default.when('idleMusicEnabled', {
         is: true,
-        then: joi.number().min(1).max(30000).required()
+        then: joi_1.default.number().min(1).max(30000).required()
     }),
-    customIdleMusic: joi.boolean(),
-    idleMusicUrl: joi.when('customIdleMusic', {
+    customIdleMusic: joi_1.default.boolean(),
+    idleMusicUrl: joi_1.default.when('customIdleMusic', {
         is: true,
-        then: joi.string().uri().required()
+        then: joi_1.default.string().uri().required()
     })
 });
 class IdleMusic extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
         const { idleDuration, idleMusicDelay, idleMusicEnabled, customIdleMusic, idleMusicUrl } = this.data;
-        const idleDurationMs = timestring(_.get(idleDuration, 'input', '30s'), _.get(idleDuration, 'outputMode', 'ms'));
-        const idleMusicDelayMs = timestring(_.get(idleMusicDelay, 'input', '3s'), _.get(idleMusicDelay, 'outputMode', 'ms'));
+        const idleDurationMs = (0, timestring_1.default)(lodash_1.default.get(idleDuration, 'input', '30s'), lodash_1.default.get(idleDuration, 'outputMode', 'ms'));
+        const idleMusicDelayMs = (0, timestring_1.default)(lodash_1.default.get(idleMusicDelay, 'input', '3s'), lodash_1.default.get(idleMusicDelay, 'outputMode', 'ms'));
         const { error: validationError } = await schema.validateAsync({
             idleMusicEnabled,
             customIdleMusic,
@@ -31,7 +31,7 @@ class IdleMusic extends voice_1.default {
             idleMusicDelay: idleMusicDelayMs,
             idleDuration: idleDurationMs
         });
-        if (validationError)
+        if (validationError != null)
             throw new Error(validationError.message);
         const command = {
             name: 'idle',
@@ -39,11 +39,11 @@ class IdleMusic extends voice_1.default {
                 disabled: !idleMusicEnabled,
                 timeout: idleMusicDelayMs,
                 maxDuration: idleDurationMs,
-                musicUrl: idleMusicUrl || null
+                musicUrl: idleMusicUrl !== '' ? idleMusicUrl : undefined
             }
         };
         await this.sendCommands(channel, [command]);
-        return this.exitStep('next');
+        this.exitStep('next');
     }
 }
 exports.default = IdleMusic;

package/dst/Initiate Call.d.ts

@@ -1,11 +1,11 @@
-export default class InitiateCall extends VoiceStep<any, any> {
+export default class InitiateCall extends VoiceStep<any, any, import("./voice").VoiceEvent> {
     constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
     get conversation(): string;
     get autoCancel(): undefined;
     runStep(): Promise<void>;
     waitForCall(): Promise<void>;
     error: {
-        name: any;
+        name: string;
         message: string;
         stack: {};
     } | undefined;

package/dst/Join Conference.d.ts

@@ -1,5 +1,9 @@
-export default class JoinConference extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep from './voice';
+interface INPUT {
+    conferenceName: string;
+    stayInConference: boolean;
 }
-import VoiceStep from "./voice";
+export default class JoinConference extends VoiceStep<INPUT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Join Conference.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 class JoinConference extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
         const { conferenceName, stayInConference } = this.data;
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             switch (event.params.type) {
                 case 'hangup':
                     await this.handleHangup(channel);
@@ -24,7 +23,7 @@ class JoinConference extends voice_1.default {
                         return this.exitFlow();
                     }
                     else {
-                        return this.exitStep('next', _.omit(event.params, ['type']));
+                        return this.exitStep('next', lodash_1.default.omit(event.params, ['type']));
                     }
                 case 'conference-end':
                     await this.transcript(channel, {
@@ -39,8 +38,8 @@ class JoinConference extends voice_1.default {
                 default:
                     return this.exitFlow();
             }
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             const command = {
                 name: 'conference.start',
                 params: {

package/dst/Keypad Input.d.ts

@@ -1,5 +1,35 @@
-export default class KeypadInput extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep, { TODO, VoiceEvent } from './voice';
+interface INPUT {
+    textType: string;
+    asr: TODO;
+    tts: TODO;
+    audio: TODO[];
+    prompts: TODO[];
+    sensitiveData: {
+        muteStep: boolean;
+        muteUser: boolean;
+        muteBot: boolean;
+    };
+    noReplyDelay: number;
+    interTimeout: number;
+    endUserInputValidationOther: TODO;
+    keypadBargeIn: boolean;
+    endInput: TODO;
+    terminationKey: string;
+    expectedNumberOfDigits: number;
+    regExToValidate: string;
+    mfVersion: string;
 }
-import VoiceStep from "./voice";
+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>;
+}
+export {};

package/dst/Keypad Input.js

@@ -12,8 +12,8 @@ const validateInput = ({ input = '', type, regex, expectedLength }) => {
     switch (type) {
         case 'regEx': {
             const regExInput = /^\/(.+)\/(\w*)$/.exec(regex);
-            if (!regExInput)
-                throw new Error('invalid regular expression: ' + regex);
+            if (regExInput == null)
+                throw new Error(`invalid regular expression: ${regex}`);
             const regexp = new RegExp(regExInput[1], regExInput[2]);
             return regexp.test(input);
         }
@@ -65,8 +65,7 @@ class KeypadInput extends voice_1.default {
         }
         const repromptsList = this.buildReprompts({ prompts: this.data.prompts, allowKeypadBargeIn: keypadBargeIn });
         const speechSections = this.buildSections({ sections: this.data.audio, textType, ttsSettings, allowKeypadBargeIn: keypadBargeIn });
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
             if (channel.recordCall && sensitiveData?.muteStep) {
                 await this.sendCommands(channel, [{
@@ -162,8 +161,8 @@ class KeypadInput extends voice_1.default {
                 default:
                     return this.exitFlow();
             }
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             await this.transcript(channel, {
                 sections: speechSections,
                 reprompt: {
@@ -177,13 +176,15 @@ class KeypadInput extends voice_1.default {
             command.params.firstDigitTimeout = this.rptsTimeout({ noReplyDelay, repromptsList });
             command.params.sections = speechSections;
             await this.sendCommands(channel, [
-                ...channel.recordCall && sensitiveData?.muteStep ? [{
-                        name: 'stop-record-session',
-                        params: {
-                            muteUser: sensitiveData.muteUser,
-                            muteBot: sensitiveData.muteBot
-                        }
-                    }] : [],
+                ...channel.recordCall && sensitiveData?.muteStep
+                    ? [{
+                            name: 'stop-record-session',
+                            params: {
+                                muteUser: sensitiveData.muteUser,
+                                muteBot: sensitiveData.muteBot
+                            }
+                        }]
+                    : [],
                 command
             ]);
             return this.exitFlow();

package/dst/Kick From Conference.d.ts

@@ -1,5 +1,9 @@
-export default class KickFromConference extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep from './voice';
+interface INPUT {
+    room: string;
+    user: string;
 }
-import VoiceStep from "./voice";
+export default class KickFromConference extends VoiceStep<INPUT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Kick From Conference.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 class KickFromConference extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
         const { room, user } = this.data;
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             switch (event.params.type) {
                 case 'hangup':
                     await this.handleHangup(channel);
@@ -20,14 +19,14 @@ class KickFromConference extends voice_1.default {
                         action: 'Conference Leave',
                         actionFromBot: true
                     });
-                    return this.exitStep('next', _.omit(event.params, ['type']));
+                    return this.exitStep('next', lodash_1.default.omit(event.params, ['type']));
                 case 'error':
                     return this.throwError(event.params.error);
                 default:
                     return this.exitFlow();
             }
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             const command = {
                 name: 'conference.kick',
                 params: {

package/dst/Pause.d.ts

@@ -1,5 +1,5 @@
-export default class VoicePause extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<unknown>;
+import VoiceStep from './voice';
+export default class VoicePause extends VoiceStep {
+    get useQueue(): boolean;
+    runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Pause.js

@@ -10,7 +10,7 @@ class VoicePause extends voice_1.default {
         const channel = await this.fetchData();
         await this.pause();
         await this.sendCommands(channel, [{ name: 'cancel' }]);
-        return this.exitStep('next');
+        this.exitStep('next');
     }
 }
 exports.default = VoicePause;

package/dst/Pickup.d.ts

@@ -1,5 +1,6 @@
-export default class Pickup extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<unknown>;
+import VoiceStep, { TODO } from './voice';
+export default class Pickup extends VoiceStep<{
+    asr: TODO;
+}> {
+    runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Pickup.js

@@ -7,7 +7,7 @@ class Pickup extends voice_1.default {
         const channel = await this.fetchData();
         channel.asr = this.data.asr.getSettings(channel.asr);
         await this.updateData();
-        return this.exitStep('next');
+        this.exitStep('next');
     }
 }
 exports.default = Pickup;

package/dst/Resume.d.ts

@@ -1,5 +1,5 @@
-export default class VoiceResume extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<unknown>;
+import VoiceStep from './voice';
+export default class VoiceResume extends VoiceStep {
+    get useQueue(): boolean;
+    runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";

package/dst/Resume.js

@@ -9,7 +9,7 @@ class VoiceResume extends voice_1.default {
     async runStep() {
         await this.fetchData();
         await this.resume();
-        return this.exitStep('next');
+        this.exitStep('next');
     }
 }
 exports.default = VoiceResume;

package/dst/Say Message.d.ts

@@ -1,5 +1,18 @@
-export default class SayMessage extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
+import VoiceStep, { TODO } from './voice';
+interface INPUT {
+    textType: string;
+    tts: TODO;
+    audio: TODO[];
+    choices: TODO[];
+    prompts: TODO[];
+    sensitiveData: {
+        muteStep: boolean;
+        muteUser: boolean;
+        muteBot: boolean;
+    };
+    interSpeechTimeout: number;
+}
+export default class SayMessage extends VoiceStep<INPUT> {
     runStep(): Promise<void>;
 }
-import VoiceStep from "./voice";
+export {};

package/dst/Say Message.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 class SayMessage extends voice_1.default {
     async runStep() {
         const { audio, textType, tts, sensitiveData, interSpeechTimeout } = this.data;
@@ -39,7 +39,7 @@ class SayMessage extends voice_1.default {
                 params: {
                     dictation: true,
                     interSpeechTimeout: interSpeechTimeout * 1000,
-                    sections: _.map(audio, (section) => ({
+                    sections: lodash_1.default.map(audio, (section) => ({
                         text: section.voiceTextMsg,
                         url: section.audioUrl,
                         bargeInVoice: false,

package/dst/Transfer.d.ts

@@ -1,5 +1,19 @@
-export default class Transfer extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep, { EventType } from './voice';
+interface INPUT {
+    destination: string;
+    phoneNumber: string;
+    sessionTimeout: number;
+    sipHeaders: Array<{
+        name: string;
+        value: string;
+    }>;
+    refer: boolean;
 }
-import VoiceStep from "./voice";
+interface EVENT {
+    type: EventType;
+    error?: string | Error;
+}
+export default class Transfer extends VoiceStep<INPUT, {}, EVENT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Transfer.js

@@ -5,8 +5,7 @@ const voice_1 = tslib_1.__importDefault(require("./voice"));
 class Transfer extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             switch (event.params.type) {
                 case 'bridge': {
                     await this.transcript(channel, {
@@ -47,8 +46,8 @@ class Transfer extends voice_1.default {
                     return this.throwError(event.params.error);
             }
             return this.exitFlow();
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             const { phoneNumber, sessionTimeout, destination, sipHeaders = [], refer } = this.data;
             const destinationIsSip = (/^sip:/i).test(destination);
             const destinationIsUser = (/^user:/i).test(destination);

package/dst/Voice Recording.d.ts

@@ -1,5 +1,21 @@
-export default class Recording extends VoiceStep<any, any> {
-    constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
-    runStep(): Promise<import("@onereach/flow-sdk/dst/types").ITriggers>;
+import VoiceStep, { TODO, VoiceEvent } from './voice';
+interface INPUT {
+    textType: string;
+    audio: TODO;
+    tts: TODO;
+    sensitiveData: {
+        muteStep: boolean;
+        muteUser: boolean;
+        muteBot: boolean;
+    };
+    terminationKey: string;
+    recordDurationSeconds: string;
 }
-import VoiceStep from "./voice";
+interface EVENT extends VoiceEvent {
+    mediaPath: string;
+    zombie: boolean;
+}
+export default class Recording extends VoiceStep<INPUT, {}, EVENT> {
+    runStep(): Promise<void>;
+}
+export {};

package/dst/Voice Recording.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const voice_1 = tslib_1.__importDefault(require("./voice"));
-const _ = require('lodash');
 class Recording extends voice_1.default {
     async runStep() {
         const channel = await this.fetchData();
@@ -23,8 +23,7 @@ class Recording extends voice_1.default {
                 sections
             }
         };
-        return this.triggers
-            .once(`in/voice/${channel.id}/event`, async (event) => {
+        this.triggers.once(`in/voice/${channel.id}/event`, async (event) => {
             if (channel.recordCall && sensitiveData?.muteStep) {
                 await this.sendCommands(channel, [{
                         name: 'resume-record-session',
@@ -42,7 +41,7 @@ class Recording extends voice_1.default {
                     await this.handleHangup(channel);
                     return this.exitFlow();
                 case 'record':
-                    if (url) {
+                    if (!lodash_1.default.isEmpty(url)) {
                         await this.transcript(channel, {
                             message: 'Voicemail',
                             reportingSettingsKey: 'transcriptRecording',
@@ -53,23 +52,23 @@ class Recording extends voice_1.default {
                         // TODO do we need zombie?
                         this.event.params.zombie = this.state.zombie;
                         // TODO figure out Global Command compatibility
-                        _.unset(this.state.hooks, 'skipVoiceEventTypes');
+                        lodash_1.default.unset(this.state.hooks, 'skipVoiceEventTypes');
                         return this.exitStep('success', url);
                     }
                     else {
                         // TODO What happens with reporting here?
                         this.log.warn('Event params', event.params);
-                        throw new Error(_.get(event, ['params', 'error', 'message']) || 'Cannot finalize recording');
+                        throw new Error(event.params.error?.message ?? 'Cannot finalize recording');
                     }
                 case 'error':
                     return this.throwError(event.params.error);
                 default:
                     return this.exitFlow();
             }
-        })
-            .otherwise(async () => {
+        });
+        this.triggers.otherwise(async () => {
             // TODO figure out Global Command compatibility
-            _.set(this.state.hooks, 'skipVoiceEventTypes', ['hangup']);
+            lodash_1.default.set(this.state.hooks, 'skipVoiceEventTypes', ['hangup']);
             await this.transcript(channel, {
                 sections,
                 reportingSettingsKey: 'transcriptPrompt',
@@ -77,13 +76,15 @@ class Recording extends voice_1.default {
                 actionFromBot: true
             });
             await this.sendCommands(channel, [
-                ...channel.recordCall && sensitiveData?.muteStep ? [{
-                        name: 'stop-record-session',
-                        params: {
-                            muteUser: sensitiveData.muteUser,
-                            muteBot: sensitiveData.muteBot
-                        }
-                    }] : [],
+                ...channel.recordCall && sensitiveData?.muteStep
+                    ? [{
+                            name: 'stop-record-session',
+                            params: {
+                                muteUser: sensitiveData.muteUser,
+                                muteBot: sensitiveData.muteBot
+                            }
+                        }]
+                    : [],
                 command
             ]);
             return this.exitFlow();

package/dst/Wait For Call.d.ts

@@ -1,4 +1,4 @@
-export default class WaitForCall extends VoiceStep<any, any> {
+export default class WaitForCall extends VoiceStep<any, any, import("./voice").VoiceEvent> {
     constructor(thread: import("@onereach/flow-sdk/dst/types").IThread, stepData: import("@onereach/flow-sdk/dst/types").IStepData<any>);
     get conversation(): string | undefined;
     get autoCancel(): boolean;

package/dst/voice.d.ts

@@ -1,6 +1,7 @@
 import { ICallback, IVoiceReporterTranscriptEventArgs, IPromtpSection } from '@onereach/flow-sdk/dst/types';
 import ConvStep from '@onereach/step-conversation/dst/step';
 import BasicError from '@onereach/flow-sdk/dst/errors/base';
+export declare type TODO = any;
 export interface IVoiceChannel {
     id: string;
     autoHangup: boolean;
@@ -10,38 +11,45 @@ export interface IVoiceChannel {
     lastTranscriptId: string;
     type: string;
     callback: ICallback;
-    global?: any;
-    recordCall?: boolean;
-    asr?: any;
-    tts?: any;
+    global?: TODO;
+    recordCall: boolean;
+    asr?: TODO;
+    tts?: TODO;
     sessionEndedBy?: string;
 }
+export declare type EventType = 'hangup' | 'error' | 'cancel' | 'avm-detected' | 'recognition' | 'digit' | 'digits' | 'conference-start' | 'conference-end' | 'playback' | 'timeout' | 'record' | 'bridge' | 'bridge/ended';
 export declare class VoiceStepError extends BasicError {
 }
-export default class VoiceStep<TIn = unknown, TOut = unknown> extends ConvStep<IVoiceChannel, TIn, TOut> {
+export interface VoiceEvent {
+    type: EventType;
+    error?: Error;
+}
+export default class VoiceStep<TIn = unknown, TOut = unknown, TParams = VoiceEvent> extends ConvStep<IVoiceChannel, TIn & {
+    handleCancel?: boolean;
+}, TOut, TParams> {
     get autoCancel(): boolean | undefined;
     onCancel(): Promise<void>;
-    sendCommands({ id, type, callback }: IVoiceChannel, commands: any[]): Promise<any>;
+    sendCommands({ id, type, callback }: IVoiceChannel, commands: TODO[]): Promise<unknown>;
     extractSectionMessages(sections: IPromtpSection[]): string;
     extractSectionFiles(sections: IPromtpSection[]): Array<{
         fileUrl: string;
         fileType: string;
     }>;
     transcript(channel: IVoiceChannel, data?: Partial<IVoiceReporterTranscriptEventArgs>): Promise<string>;
-    throwError(error: {
+    throwError(error?: {
         name: string;
         message: string;
     }): never;
     handleHangup(channel: IVoiceChannel): Promise<void>;
-    buildSections({ sections, textType, ttsSettings, allowKeypadBargeIn }: any): any;
-    buildReprompts({ prompts, allowKeypadBargeIn }: any): any;
-    buildChoices({ choices }: any): any;
-    buildChoice(choice: any): any;
-    exitChoiceData(type: string, params?: any): any;
-    rptsSend(channel: IVoiceChannel, { command, reporting, repromptsList, noReplyDelay, speechSections, textType, ttsSettings }: any): Promise<void>;
-    rptsTimeout({ noReplyDelay, repromptsList }: any): number;
+    buildSections({ sections, textType, ttsSettings, allowKeypadBargeIn }: TODO): TODO;
+    buildReprompts({ prompts, allowKeypadBargeIn }: TODO): TODO;
+    buildChoices({ choices }: TODO): TODO;
+    buildChoice(choice: TODO): TODO;
+    exitChoiceData(type: string, params?: TODO): TODO;
+    rptsSend(channel: IVoiceChannel, { command, reporting, repromptsList, noReplyDelay, speechSections, textType, ttsSettings }: TODO): Promise<void>;
+    rptsTimeout({ noReplyDelay, repromptsList }: TODO): number;
     rptsRestart(): void;
-    rptsHasMore({ repromptsList }: any): boolean;
+    rptsHasMore({ repromptsList }: TODO): boolean;
     get rptsIndex(): number;
     get rptsStarted(): boolean;
 }

package/dst/voice.js

@@ -17,7 +17,9 @@ class VoiceStep extends step_1.default {
     }
     async onCancel() {
         await super.onCancel();
-        this.exitStep('cancel');
+        if (this.data.handleCancel === true) {
+            this.exitStep('cancel');
+        }
     }
     async sendCommands({ id, type, callback }, commands) {
         if (lodash_1.default.isEmpty(commands))
@@ -105,7 +107,7 @@ class VoiceStep extends step_1.default {
         await this.updateData();
         return eventId;
     }
-    throwError(error) {
+    throwError(error = new Error('unknown')) {
         throw new VoiceStepError(error.message, null, { name: error.name });
     }
     async handleHangup(channel) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",
@@ -13,19 +13,20 @@
     "npm": ">= 6.0.0"
   },
   "dependencies": {
-    "@onereach/step-conversation": "^1.0.31",
+    "@onereach/step-conversation": "^1.0.32",
     "lodash": "^4.17.21",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@onereach/flow-sdk": "^3.0.5",
+    "@onereach/flow-sdk": "^3.0.12",
     "@swc/cli": "^0.1.57",
     "@swc/core": "^1.2.196",
     "@swc/jest": "^0.2.21",
     "@types/jest": "^28.1.0",
     "@types/lodash": "^4.14.182",
+    "@types/timestring": "^6.0.2",
     "@types/uuid": "^8.3.4",
-    "aws-sdk": "^2.1147.0",
+    "aws-sdk": "^2.1148.0",
     "babel-runtime": "^6.26.0",
     "docdash": "^1.2.0",
     "husky": "^8.0.1",