@onereach/step-voice 6.1.20 → 6.1.22-HEAD.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "6.1.20",
+  "version": "6.1.22-HEAD.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",
@@ -54,6 +54,8 @@
     "download": "./scripts/download.sh",
     "upload": "./scripts/upload.sh",
     "pub": "./scripts/publish.sh",
+    "pub-beta": "./scripts/publish-beta.sh",
+    "update-module-versions": "./scripts/update-module-versions.sh",
     "test": "jest --forceExit"
   },
   "repository": {

package/dst/Cancel.d.ts

@@ -1,4 +0,0 @@
-import VoiceStep from './voice';
-export default class VoiceCancel extends VoiceStep {
-    runStep(): Promise<void>;
-}

package/dst/Cancel.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const voice_1 = tslib_1.__importDefault(require("./voice"));
-class VoiceCancel extends voice_1.default {
-    async runStep() {
-        // const conv = await this.getConversation()
-        // if (conv.lcl.length <= 1) {
-        //   this.log.debug('nothing to cancel')
-        //   this.exitStep('next')
-        //   return
-        // }
-        const call = await this.fetchData();
-        this.triggers.local(`in/voice/${call.id}`, async (event) => {
-            switch (event.params.type) {
-                case 'hangup':
-                    await this.handleHangup(call);
-                    return await this.waitConvEnd();
-                case 'error':
-                    return this.throwError(event.params.error);
-                case 'cancel': {
-                    // await this.popConvStep() // pop current command (cancel)
-                    await this.cancel(); // cancel previous command
-                    return this.exitStep('next');
-                }
-                default:
-                    return this.exitFlow();
-            }
-        });
-        this.triggers.otherwise(async () => {
-            await this.sendCommands(call, [{ name: 'cancel' }]);
-        });
-    }
-}
-exports.default = VoiceCancel;

package/dst/Choice.d.ts

@@ -1,31 +0,0 @@
-import VoiceStep, { SensitiveData, TODO, VoiceEvent } from './voice';
-interface INPUT {
-    textType: string;
-    asr: TODO;
-    tts: TODO;
-    audio: TODO[];
-    choices: TODO[];
-    prompts: TODO[];
-    usePromptsForUnrecognized?: boolean;
-    sensitiveData: SensitiveData;
-    noReplyDelay: number;
-    promptsTriggers: TODO[];
-    usePromptsTriggers: boolean;
-    useInterspeechTimeout: boolean;
-    interSpeechTimeout: number;
-    recognitionModel?: string;
-    longRecognition: boolean;
-}
-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,282 +0,0 @@
-"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 digitWords = [
-    'zero',
-    'one',
-    'two',
-    'three',
-    'four',
-    'five',
-    'six',
-    'seven',
-    'eight',
-    'nine'
-];
-const containsOnlyDigits = (stringsList) => {
-    let isOnlyDigits = true;
-    stringsList.forEach((str) => {
-        if (digitWords.includes(String(str).toLowerCase())) {
-            // Do nothing
-        }
-        else if (isNaN(str)) {
-            isOnlyDigits = false;
-        }
-    });
-    return isOnlyDigits;
-};
-const getPhrasesForSpeechRec = (choices) => {
-    const texts = lodash_1.default.flatMap(choices, (choice) => choice.options.map((opt) => opt.text));
-    if (containsOnlyDigits(texts)) {
-        return ['$OOV_CLASS_DIGIT_SEQUENCE'];
-    }
-    return texts;
-};
-const getAsrSettings = (settings, choices, recognitionModel) => {
-    if (settings.engine === 'google' || settings.engine === 'google_beta') {
-        return {
-            ...settings,
-            config: {
-                speechContexts: [
-                    {
-                        phrases: getPhrasesForSpeechRec(choices)
-                    }
-                ],
-                recognitionModel
-            }
-        };
-    }
-    return settings;
-};
-const isRepromptTrigger = (recogResult, promptsTriggers) => {
-    const phrases = recogResult.map((r) => {
-        return r.lexical;
-    });
-    const triggers = promptsTriggers.flatMap((trigger) => {
-        if (lodash_1.default.isEmpty(trigger.grammar)) {
-            return trigger.text.replace(/`/g, '');
-        }
-        else {
-            return trigger.grammar.value.map((v) => {
-                return v.replace(/`/g, '');
-            });
-        }
-    });
-    return !lodash_1.default.isEmpty(phrases.filter((e) => triggers.includes(e)));
-};
-class Choice extends voice_1.default {
-    async runStep() {
-        const call = await this.fetchData();
-        const { textType, asr, tts, sensitiveData, noReplyDelay, usePromptsTriggers, recognitionModel, useInterspeechTimeout, interSpeechTimeout, longRecognition, usePromptsForUnrecognized } = this.data;
-        const exitExists = (exitId) => {
-            return lodash_1.default.some(choices, (choice) => choice.exitId === exitId);
-        };
-        const choices = this.buildChoices({ choices: this.data.choices });
-        const ttsSettings = tts.getSettings(call.tts);
-        const asrSettings = getAsrSettings(asr.getSettings(call.asr), choices, recognitionModel);
-        const repromptsList = this.buildReprompts({ prompts: this.data.prompts });
-        const speechSections = this.buildSections({ sections: this.data.audio, textType, ttsSettings });
-        const grammar = {
-            id: this.currentStepId,
-            choices,
-            asr: asrSettings
-        };
-        const command = {
-            name: 'speak',
-            params: {
-                grammar,
-                dictation: longRecognition
-                    ? 'continuous'
-                    : useInterspeechTimeout,
-                interSpeechTimeout: interSpeechTimeout * 1000,
-                sections: []
-            }
-        };
-        // There's a specific need to do so. There might be ${variable} section
-        this.triggers.local(`in/voice/${call.id}`, async (event) => {
-            const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
-            const interruptionMetadata = event.params.interruptionMetadata ?? null;
-            if (interruptionMetadata) {
-                await this.transcript(call, {
-                    sections: speechSections,
-                    reprompt: {
-                        maxAttempts: repromptsList.length,
-                        attempt: 0
-                    },
-                    reportingSettingsKey: 'transcriptPrompt',
-                    action: 'Call Prompt',
-                    actionFromBot: true
-                }, interruptionMetadata);
-            }
-            switch (event.params.type) {
-                case 'digit':
-                case 'digits': {
-                    const params = event.params;
-                    const digit = params.digit ?? params.digits;
-                    const exitId = params.exitId;
-                    // On bargeIn, we should stop playback
-                    if (exitExists(exitId)) {
-                        const exitStepLabel = this.getExitStepLabel(exitId) ?? '';
-                        const message = lodash_1.default.replace(exitStepLabel, /^(\d+\. )?(~ )?/, '');
-                        await this.transcript(call, {
-                            keyPress: digit,
-                            message: message,
-                            reportingSettingsKey,
-                            action: 'Call DTMF',
-                            actionFromBot: false
-                        });
-                        await this.resumeRecording(call, sensitiveData);
-                        return this.exitStep(exitId, this.exitChoiceData('dtmf', params), longRecognition);
-                    }
-                    else if ((lodash_1.default.isUndefined(usePromptsForUnrecognized) || usePromptsForUnrecognized) && this.rptsHasMore({ repromptsList })) {
-                        await this.transcript(call, {
-                            message: 'Unrecognized',
-                            keyPress: digit,
-                            reportingSettingsKey,
-                            action: 'Call DTMF',
-                            actionFromBot: false
-                        });
-                        await this.rptsSend(call, {
-                            command,
-                            repromptsList,
-                            noReplyDelay,
-                            speechSections,
-                            textType,
-                            ttsSettings,
-                            sensitiveData
-                        });
-                        return this.exitFlow();
-                    }
-                    await this.transcript(call, {
-                        message: 'Not Recognized',
-                        keyPress: digit,
-                        reportingSettingsKey,
-                        action: 'Call DTMF',
-                        actionFromBot: false
-                    });
-                    await this.resumeRecording(call, sensitiveData);
-                    return this.exitStep('unrecognized', this.exitChoiceData('dtmf', { digit }), longRecognition);
-                }
-                case 'recognition': {
-                    const params = event.params;
-                    const exitId = params.exitId;
-                    const phrases = params.phrases;
-                    if (lodash_1.default.isEmpty(phrases)) {
-                        await this.resumeRecording(call, sensitiveData);
-                        return this.exitStep('unrecognized', {});
-                    }
-                    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(call, {
-                            message: lodash_1.default.replace(this.getExitStepLabel(exitId) ?? '', /^(\d+\. )?(~ )?/, ''),
-                            voiceProcessResult,
-                            reportingSettingsKey,
-                            action: 'Call Recognition',
-                            actionFromBot: false
-                        });
-                        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), longRecognition);
-                    }
-                    else if (((lodash_1.default.isUndefined(usePromptsForUnrecognized) || usePromptsForUnrecognized) ||
-                        (usePromptsTriggers ? isRepromptTrigger(phrases, this.data.promptsTriggers) : false)) &&
-                        this.rptsHasMore({ repromptsList })) {
-                        await this.transcript(call, {
-                            message: 'Unrecognized',
-                            voiceProcessResult,
-                            reportingSettingsKey,
-                            action: 'Call Recognition',
-                            actionFromBot: false
-                        });
-                        await this.rptsSend(call, {
-                            command,
-                            repromptsList,
-                            noReplyDelay,
-                            speechSections,
-                            textType,
-                            ttsSettings,
-                            sensitiveData
-                        });
-                        return this.exitFlow();
-                    }
-                    // There's no more reprompts, should move on to unrecognized direction
-                    await this.transcript(call, {
-                        message: 'Not Recognized',
-                        voiceProcessResult,
-                        reportingSettingsKey,
-                        action: 'Call Recognition',
-                        actionFromBot: false
-                    });
-                    await this.resumeRecording(call, sensitiveData);
-                    // We might end up in same session
-                    return this.exitStep('unrecognized', this.exitChoiceData('voice', params), longRecognition);
-                }
-                case 'timeout': {
-                    if (this.rptsHasMore({ repromptsList })) {
-                        await this.transcript(call, {
-                            message: 'No Reply',
-                            reportingSettingsKey,
-                            action: 'Call Prompt',
-                            actionFromBot: false
-                        });
-                        await this.rptsSend(call, {
-                            command,
-                            repromptsList,
-                            noReplyDelay,
-                            speechSections,
-                            textType,
-                            ttsSettings,
-                            sensitiveData
-                        });
-                        return this.exitFlow();
-                    }
-                    await this.transcript(call, {
-                        message: 'Not Replied',
-                        reportingSettingsKey,
-                        action: 'Call Prompt',
-                        actionFromBot: false
-                    });
-                    await this.resumeRecording(call, sensitiveData);
-                    // We might end up in same session
-                    return this.exitStep('no reply', {}, longRecognition);
-                }
-                case 'hangup': {
-                    await this.handleHangup(call);
-                    return await this.waitConvEnd();
-                }
-                case 'cancel': {
-                    return this.handleCancel();
-                }
-                case 'error':
-                    return this.throwError(event.params.error);
-                default:
-                    return this.exitFlow();
-            }
-        });
-        this.triggers.otherwise(async () => {
-            const eventId = await this.transcript(call, {
-                sections: speechSections,
-                reprompt: {
-                    maxAttempts: repromptsList.length,
-                    attempt: 0
-                },
-                reportingSettingsKey: 'transcriptPrompt',
-                action: 'Call Prompt',
-                actionFromBot: true
-            });
-            command.params.reporterTranscriptEventId = eventId;
-            command.params.sections = speechSections;
-            command.params.timeout = this.rptsTimeout({ noReplyDelay, repromptsList, initial: true });
-            await this.pauseRecording(call, command, sensitiveData);
-            return this.exitFlow();
-        });
-    }
-}
-exports.default = Choice;
-// --------------------------------------------------------------------

package/dst/Conference Dial.d.ts

@@ -1,10 +0,0 @@
-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>;
-}

package/dst/Conference Dial.js

@@ -1,46 +0,0 @@
-"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"));
-class ConferenceDial extends voice_1.default {
-    async runStep() {
-        const call = await this.fetchData();
-        this.triggers
-            .local(`in/voice/${call.id}`, async (event) => {
-            switch (event.params.type) {
-                case 'hangup':
-                    await this.handleHangup(call);
-                    return await this.waitConvEnd();
-                case 'conference-start':
-                    if (this.data.stayInConference) {
-                        return this.exitFlow();
-                    }
-                    else {
-                        return this.exitStep('next', lodash_1.default.omit(event.params, ['type']));
-                    }
-                case 'conference-end':
-                    return this.data.stayInConference ? this.exitStep('next') : this.exitFlow();
-                case 'error':
-                    return this.throwError(event.params.error);
-                default:
-                    return this.exitFlow();
-            }
-        });
-        this.triggers.otherwise(async () => {
-            const { sourceConf, botNumber, headers, hearOnly } = this.data;
-            const command = {
-                name: 'conference.joinBot',
-                params: {
-                    room: sourceConf,
-                    botNumber,
-                    headers,
-                    hearOnly,
-                    stayInConference: this.data.stayInConference
-                }
-            };
-            await this.sendCommands(call, [command]);
-        });
-    }
-}
-exports.default = ConferenceDial;

package/dst/Custom Voice Input.d.ts

@@ -1,31 +0,0 @@
-import VoiceStep, { SensitiveData, TODO, VoiceEvent } from './voice';
-interface INPUT {
-    textType: string;
-    asr: TODO;
-    tts: TODO;
-    audio: TODO[];
-    choices: TODO[];
-    prompts: TODO[];
-    sensitiveData: SensitiveData;
-    noReplyDelay: number;
-    promptsTriggers: TODO[];
-    usePromptsTriggers: boolean;
-    recognitionModel?: string;
-    resultInterpretation: string[];
-    phraseList: Array<{
-        phrase: string;
-    }>;
-}
-interface EVENT extends VoiceEvent {
-    callRecording?: TODO;
-    exitId?: string;
-    digit?: string;
-    digits?: string;
-    phrases?: TODO[];
-    tags?: string[];
-    out?: string;
-}
-export default class CustomVoiceInput extends VoiceStep<INPUT, {}, EVENT> {
-    runStep(): Promise<void>;
-}
-export {};

package/dst/Custom Voice Input.js

@@ -1,212 +0,0 @@
-"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 getPhrasesForSpeechRec = (choices) => {
-    const texts = lodash_1.default.flatMap(choices, (choice) => choice.options.map((opt) => opt.text));
-    return texts;
-};
-const getAsrSettings = (choices, recognitionModel) => {
-    // this step works only with the Google engine
-    // hardcoded en-US lang will be changed to dynamic after step testing and design approval
-    return {
-        enabled: true,
-        engine: 'google',
-        language: 'en-US',
-        config: {
-            speechContexts: [
-                {
-                    phrases: getPhrasesForSpeechRec(choices)
-                }
-            ],
-            recognitionModel
-        }
-    };
-};
-const isRepromptTrigger = (recogResult, promptsTriggers) => {
-    const phrases = recogResult.map((r) => {
-        return r.lexical;
-    });
-    const triggers = promptsTriggers.flatMap((trigger) => {
-        if (lodash_1.default.isEmpty(trigger.grammar)) {
-            return trigger.text.replace(/`/g, '');
-        }
-        else {
-            return trigger.grammar.value.map((v) => {
-                return v.replace(/`/g, '');
-            });
-        }
-    });
-    return !lodash_1.default.isEmpty(phrases.filter((e) => triggers.includes(e)));
-};
-const alterRecognitionPhrases = (phrases, interpretation) => {
-    if (interpretation.length !== 1)
-        return;
-    switch (interpretation[0]) {
-        case '$POSTALCODE':
-            phrases.forEach(p => { p.lexical = p.lexical.replace(/\s+/g, ''); });
-            break;
-        case '$PERCENT':
-            phrases.forEach(p => { p.lexical = p.lexical.replace(/\s+(?=%)/, ''); });
-            break;
-    }
-};
-class CustomVoiceInput extends voice_1.default {
-    async runStep() {
-        const call = await this.fetchData();
-        const { textType, tts, sensitiveData, noReplyDelay, usePromptsTriggers, recognitionModel, phraseList } = this.data;
-        const exitExists = (exitId) => {
-            return lodash_1.default.some(choices, (choice) => choice.exitId === exitId);
-        };
-        const mainLeg = {
-            exitId: '5886d1ee-db6d-45ca-a2ce-d586862c65ff',
-            dtmf: null,
-            grxml: '',
-            text: '.+',
-            grammar: {}
-        };
-        const choices = this.buildChoices({ choices: [...this.data.choices, mainLeg] });
-        const ttsSettings = tts.getSettings(call.tts);
-        const asrSettings = getAsrSettings(choices, recognitionModel);
-        const repromptsList = this.buildReprompts({ prompts: this.data.prompts });
-        const speechSections = this.buildSections({ sections: this.data.audio, textType, ttsSettings });
-        const grammar = {
-            id: this.currentStepId,
-            choices,
-            asr: asrSettings
-        };
-        const command = {
-            name: 'double-asr',
-            params: {
-                grammar,
-                sections: [],
-                resultInterpretation: this.data.resultInterpretation,
-                tokenPhrases: phraseList || []
-            }
-        };
-        // There's a specific need to do so. There might be ${variable} section
-        this.triggers.local(`in/voice/${call.id}`, async (event) => {
-            const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
-            switch (event.params.type) {
-                // digit recognition removed
-                case 'recognition': {
-                    const params = event.params;
-                    const exitId = params.exitId;
-                    alterRecognitionPhrases(params.phrases, this.data.resultInterpretation);
-                    const phrases = params.phrases;
-                    if (lodash_1.default.isEmpty(phrases)) {
-                        await this.resumeRecording(call, sensitiveData);
-                        return this.exitStep('unrecognized', {});
-                    }
-                    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(call, {
-                            message: lodash_1.default.replace(this.getExitStepLabel(exitId) ?? '', /^(\d+\. )?(~ )?/, ''),
-                            voiceProcessResult,
-                            reportingSettingsKey,
-                            action: 'Call Recognition',
-                            actionFromBot: false
-                        });
-                        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));
-                    }
-                    else if (this.rptsHasMore({ repromptsList }) &&
-                        (usePromptsTriggers ? isRepromptTrigger(phrases, this.data.promptsTriggers) : true)) {
-                        await this.transcript(call, {
-                            message: 'Unrecognized',
-                            voiceProcessResult,
-                            reportingSettingsKey,
-                            action: 'Call Recognition',
-                            actionFromBot: false
-                        });
-                        await this.rptsSend(call, {
-                            command,
-                            repromptsList,
-                            noReplyDelay,
-                            speechSections,
-                            textType,
-                            ttsSettings,
-                            sensitiveData
-                        });
-                        return this.exitFlow();
-                    }
-                    // There's no more reprompts, should move on to unrecognized direction
-                    await this.transcript(call, {
-                        message: 'Not Recognized',
-                        voiceProcessResult,
-                        reportingSettingsKey,
-                        action: 'Call Recognition',
-                        actionFromBot: false
-                    });
-                    await this.resumeRecording(call, sensitiveData);
-                    // We might end up in same session
-                    return this.exitStep('unrecognized', this.exitChoiceData('voice', params));
-                }
-                case 'timeout': {
-                    if (this.rptsHasMore({ repromptsList })) {
-                        await this.transcript(call, {
-                            message: 'No Reply',
-                            reportingSettingsKey,
-                            action: 'Call Prompt',
-                            actionFromBot: false
-                        });
-                        await this.rptsSend(call, {
-                            command,
-                            repromptsList,
-                            noReplyDelay,
-                            speechSections,
-                            textType,
-                            ttsSettings,
-                            sensitiveData
-                        });
-                        return this.exitFlow();
-                    }
-                    await this.transcript(call, {
-                        message: 'Not Replied',
-                        reportingSettingsKey,
-                        action: 'Call Prompt',
-                        actionFromBot: false
-                    });
-                    await this.resumeRecording(call, sensitiveData);
-                    // We might end up in same session
-                    return this.exitStep('no reply', {});
-                }
-                case 'hangup': {
-                    await this.handleHangup(call);
-                    return await this.waitConvEnd();
-                }
-                case 'cancel': {
-                    return this.handleCancel();
-                }
-                case 'error':
-                    return this.throwError(event.params.error);
-                default:
-                    return this.exitFlow();
-            }
-        });
-        this.triggers.otherwise(async () => {
-            await this.transcript(call, {
-                sections: speechSections,
-                reprompt: {
-                    maxAttempts: repromptsList.length,
-                    attempt: 0
-                },
-                reportingSettingsKey: 'transcriptPrompt',
-                action: 'Call Prompt',
-                actionFromBot: true
-            });
-            command.params.sections = speechSections;
-            command.params.timeout = this.rptsTimeout({ noReplyDelay, repromptsList, initial: true });
-            await this.pauseRecording(call, command, sensitiveData);
-            return this.exitFlow();
-        });
-    }
-}
-exports.default = CustomVoiceInput;
-// --------------------------------------------------------------------