@fonoster/autopilot 0.5.4 → 0.7.0

package/dist/intents/dialogflow_es.d.ts

@@ -1,15 +0,0 @@
-import * as dialogflow from "@google-cloud/dialogflow";
-import { IntentsEngine, Intent, DialogFlowESConfig } from "./types";
-export default class DialogFlow implements IntentsEngine {
-    sessionClient: dialogflow.v2beta1.SessionsClient;
-    sessionPath: string;
-    config: DialogFlowESConfig;
-    sessionId: string;
-    projectId: string;
-    constructor(config: DialogFlowESConfig);
-    setProjectId(projectId: string): void;
-    findIntentWithEvent(name: string, payload?: Record<string, unknown>): Promise<Intent>;
-    findIntent(txt: string, payload?: Record<string, unknown>): Promise<Intent>;
-    private detectItent;
-    private getEffects;
-}

package/dist/intents/dialogflow_es.js

@@ -1,166 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-loops/no-loops */
-/* eslint-disable require-jsdoc */
-/*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/rox
- *
- * This file is part of Rox AI
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const dialogflow = __importStar(require("@google-cloud/dialogflow"));
-const df_utils_1 = require("./df_utils");
-const pb_util_1 = require("pb-util");
-const logger_1 = require("@fonoster/logger");
-const uuid = require("uuid");
-const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
-class DialogFlow {
-    sessionClient;
-    sessionPath;
-    config;
-    sessionId;
-    projectId;
-    constructor(config) {
-        this.sessionId = uuid.v4();
-        this.config = config;
-        this.projectId = config.projectId;
-        // Create a new session
-        this.sessionClient = new dialogflow.v2beta1.SessionsClient({
-            credentials: config.credentials
-        });
-        logger.verbose("created new dialogflow/es session", {
-            projectId: this.projectId,
-            sessionId: this.sessionId
-        });
-    }
-    setProjectId(projectId) {
-        this.projectId = projectId;
-    }
-    async findIntentWithEvent(name, payload) {
-        const request = {
-            queryInput: {
-                event: {
-                    name: name.toUpperCase(),
-                    languageCode: this.config.languageCode
-                }
-            }
-        };
-        return this.detectItent(request, payload);
-    }
-    async findIntent(txt, payload) {
-        const request = {
-            queryParams: {},
-            queryInput: {
-                text: {
-                    text: txt,
-                    languageCode: this.config.languageCode
-                }
-            }
-        };
-        return this.detectItent(request, payload);
-    }
-    async detectItent(request, payload) {
-        const sessionPath = this.sessionClient.projectAgentSessionPath(this.projectId, this.sessionId);
-        request.session = sessionPath;
-        if (payload) {
-            request.queryParams = {
-                payload: pb_util_1.struct.encode(payload)
-            };
-        }
-        const [response] = await this.sessionClient.detectIntent(request);
-        logger.silly("got speech from api", { text: JSON.stringify(response) });
-        if (!response.queryResult?.intent) {
-            throw new Error("got unexpect null intent");
-        }
-        let effects = [];
-        if (response.queryResult.fulfillmentMessages) {
-            const messages = response.queryResult.fulfillmentMessages.filter((f) => f.platform === this.config.platform);
-            effects = this.getEffects(messages);
-        }
-        else if (response.queryResult.fulfillmentText) {
-            effects = [
-                {
-                    type: "say",
-                    parameters: {
-                        response: response.queryResult.fulfillmentText
-                    }
-                }
-            ];
-        }
-        return {
-            ref: response.queryResult.intent.displayName || "unknown",
-            effects,
-            confidence: response.queryResult.intentDetectionConfidence || 0
-        };
-    }
-    getEffects(fulfillmentMessages) {
-        const effects = [];
-        for (const f of fulfillmentMessages) {
-            if (f.payload) {
-                effects.push((0, df_utils_1.transformPayloadToEffect)(f.payload));
-            }
-            else if (f.telephonySynthesizeSpeech) {
-                effects.push({
-                    type: "say",
-                    parameters: {
-                        response: f.telephonySynthesizeSpeech.text ||
-                            f.telephonySynthesizeSpeech.ssml
-                    }
-                });
-            }
-            else if (f.telephonyTransferCall) {
-                effects.push({
-                    type: "transfer",
-                    parameters: {
-                        destination: f.telephonyTransferCall.phoneNumber
-                    }
-                });
-            }
-            else if (f.text) {
-                effects.push({
-                    type: "say",
-                    parameters: {
-                        response: f.text.text[0]
-                    }
-                });
-            }
-        }
-        return effects;
-    }
-}
-exports.default = DialogFlow;

package/dist/intents/engines.d.ts

@@ -1,3 +0,0 @@
-import { App } from "@fonoster/apps";
-import { IntentsEngine } from "./types";
-export declare function getIntentsEngine(app: App): (credentials: Record<string, string>) => IntentsEngine;

package/dist/intents/engines.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentsEngine = void 0;
-const dialogflow_cx_1 = __importDefault(require("./dialogflow_cx"));
-const dialogflow_es_1 = __importDefault(require("./dialogflow_es"));
-function getIntentsEngine(app) {
-    return function getEngine(credentials) {
-        const platform = app.intentsEngineConfig.emulateTelephonyPlatform
-            ? "TELEPHONY"
-            : "PLATFORM_UNSPECIFIED";
-        if ("location" in app.intentsEngineConfig) {
-            return new dialogflow_cx_1.default({
-                credentials,
-                projectId: app.intentsEngineConfig.projectId,
-                agent: app.intentsEngineConfig.agent,
-                location: app.intentsEngineConfig.location,
-                platform,
-                languageCode: "en-US"
-            });
-        }
-        return new dialogflow_es_1.default({
-            credentials,
-            projectId: app.intentsEngineConfig.projectId,
-            platform,
-            languageCode: "en-US"
-        });
-    };
-}
-exports.getIntentsEngine = getIntentsEngine;

package/dist/intents/types.d.ts

@@ -1,25 +0,0 @@
-import { Effect } from "../cerebro/types";
-export interface Intent {
-    ref: string;
-    effects: Effect[];
-    confidence: number;
-}
-export interface IntentsEngine {
-    setProjectId: (id: string) => void;
-    findIntent: (text: string, payload?: Record<string, unknown>) => Promise<Intent>;
-    findIntentWithEvent?: (name: string, payload?: Record<string, unknown>) => Promise<Intent>;
-}
-export interface DialogFlowESConfig {
-    projectId: string;
-    languageCode: string;
-    platform: string;
-    credentials: Record<string, string>;
-}
-export interface DialogFlowCXConfig {
-    projectId: string;
-    languageCode: string;
-    location: string;
-    agent: string;
-    platform: string;
-    credentials: Record<string, string>;
-}

package/dist/intents/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pilot.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-import { ServerConfig } from "./types";
-export default function pilot(config: ServerConfig): void;

package/dist/pilot.js

@@ -1,150 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable require-jsdoc */
-/*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/rox
- *
- * This file is part of Rox AI
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const types_1 = require("./events/types");
-const voice_1 = require("@fonoster/voice");
-const cerebro_1 = require("./cerebro");
-const server_1 = require("./events/server");
-const engines_1 = require("./intents/engines");
-const util_1 = require("./util");
-const googleasr_1 = __importDefault(require("@fonoster/googleasr"));
-const logger_1 = require("@fonoster/logger");
-const apps_1 = __importDefault(require("@fonoster/apps"));
-const secrets_1 = __importDefault(require("@fonoster/secrets"));
-const envs_1 = require("./envs");
-const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
-function pilot(config) {
-    logger.info("starting autopilot");
-    const voiceServer = new voice_1.VoiceServer({
-        port: config.port
-    });
-    if (config.eventsServerEnabled)
-        server_1.eventsServer.start();
-    logger.verbose("events server enabled = " + config.eventsServerEnabled);
-    voiceServer.listen(async (voiceRequest, voiceResponse) => {
-        logger.verbose(`new request [sessionId: ${voiceRequest.sessionId}]`, {
-            voiceRequest
-        });
-        try {
-            if (!voiceRequest.appRef)
-                throw new Error("invalid voice request: missing appRef");
-            // If set, we overwrite the configuration with the values obtain from the webhook
-            const serviceCredentials = {
-                accessKeyId: voiceRequest.accessKeyId,
-                accessKeySecret: voiceRequest.sessionToken
-            };
-            const apps = new apps_1.default(serviceCredentials);
-            const secrets = new secrets_1.default(serviceCredentials);
-            const app = await apps.getApp(voiceRequest.appRef);
-            logger.verbose("requested app", { app, ref: app.ref });
-            const ieSecret = await secrets.getSecret(app.intentsEngineConfig.secretName);
-            const intentsEngine = (0, engines_1.getIntentsEngine)(app)(JSON.parse(ieSecret.secret));
-            intentsEngine?.setProjectId(app.intentsEngineConfig.projectId);
-            const speechSecret = await secrets.getSecret(app.speechConfig.secretName);
-            const speechCredentials = {
-                private_key: JSON.parse(speechSecret.secret).private_key,
-                client_email: JSON.parse(speechSecret.secret).client_email
-            };
-            const voiceConfig = (0, util_1.getVoiceConfig)({
-                secretString: speechSecret.secret,
-                app,
-                config
-            });
-            logger.verbose("voice config", { voiceConfig });
-            const ttsPlugin = (0, util_1.getTTSPlugin)({
-                languageCode: voiceConfig.languageCode,
-                vendor: voiceConfig.vendor,
-                secretString: speechSecret.secret,
-                path: config.fileRetentionPolicyDirectory
-            });
-            voiceResponse.use(ttsPlugin);
-            voiceResponse.use(new googleasr_1.default({
-                credentials: speechCredentials,
-                languageCode: config.defaultLanguageCode
-            }));
-            await voiceResponse.answer();
-            const eventsClient = app.enableEvents && config.eventsServerEnabled
-                ? server_1.eventsServer.getConnection(voiceRequest.callerNumber)
-                : null;
-            (0, util_1.sendClientEvent)(eventsClient, {
-                eventName: types_1.CLIENT_EVENTS.ANSWERED
-            });
-            if (app.initialDtmf) {
-                await voiceResponse.dtmf({ dtmf: app.initialDtmf });
-            }
-            if (app.intentsEngineConfig.welcomeIntentId &&
-                intentsEngine.findIntentWithEvent) {
-                const response = await intentsEngine.findIntentWithEvent(
-                // TODO: This should be renamed to welcomeEventId
-                app.intentsEngineConfig.welcomeIntentId, {
-                    telephony: {
-                        caller_id: voiceRequest.callerNumber
-                    }
-                });
-                if (response.effects.length > 0) {
-                    // eslint-disable-next-line no-loops/no-loops
-                    for await (const effect of response.effects) {
-                        if (effect.type === "say") {
-                            await voiceResponse.say(effect.parameters["response"], voiceConfig);
-                        }
-                    }
-                }
-                else {
-                    logger.warn("no effects found for welcome event", {
-                        eventId: app.intentsEngineConfig.welcomeIntentId
-                    });
-                }
-            }
-            const transfer = app.transferConfig;
-            transfer.messageNoAnswer = transfer.messageBusy =
-                transfer.messageBusy || envs_1.APISERVER_AUTOPILOT_MEDIA_BUSY_MESSAGE;
-            transfer.messageNoAnswer =
-                transfer.messageNoAnswer ||
-                    envs_1.APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE;
-            const cerebro = new cerebro_1.Cerebro({
-                voiceRequest,
-                voiceResponse,
-                eventsClient,
-                voiceConfig,
-                intentsEngine,
-                activationIntentId: app.activationIntentId,
-                activationTimeout: app.activationTimeout,
-                transfer: app.transferConfig,
-                alternativeLanguageCode: app.speechConfig.languageCode
-            });
-            // Open for bussiness
-            await cerebro.wake();
-        }
-        catch (e) {
-            (0, logger_1.ulogger)({
-                accessKeyId: voiceRequest.accessKeyId,
-                eventType: logger_1.ULogType.APP,
-                level: "error",
-                message: e.message
-            });
-        }
-    });
-}
-exports.default = pilot;

package/dist/util.d.ts

@@ -1,44 +0,0 @@
-import GoogleTTS from "@fonoster/googletts";
-import PollyTTS from "@fonoster/pollytts";
-import AzureTTS from "@fonoster/azuretts";
-import { EventsClient } from "./events/emitter";
-import { ClientEvent } from "./events/types";
-import { TTSVendor } from "./types";
-export declare const getEnvOrDefault: (envName: string, def: number) => number;
-export declare const getEnvOrBool: (envName: string) => boolean;
-export declare const removeEmpty: (obj: any) => {};
-export declare const sendClientEvent: (eventsClient: EventsClient | null, event: ClientEvent) => void;
-export declare const getTTSPlugin: (params: {
-    languageCode: string;
-    vendor: TTSVendor;
-    path: string;
-    secretString: string;
-}) => PollyTTS | AzureTTS | GoogleTTS;
-export declare const getVoiceConfig: (params: {
-    secretString: string;
-    app: {
-        speechConfig: {
-            voice: string;
-            languageCode: string;
-        };
-    };
-    config: {
-        defaultLanguageCode: string;
-    };
-}) => {
-    voice: string;
-    languageCode: string;
-    region: string;
-    vendor: TTSVendor;
-    cachingFields: string[];
-    playbackId: string;
-    name?: undefined;
-} | {
-    name: string;
-    languageCode: string;
-    cachingFields: string[];
-    playbackId: string;
-    vendor: TTSVendor;
-    voice?: undefined;
-    region?: undefined;
-};

package/dist/util.js

@@ -1,105 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVoiceConfig = exports.getTTSPlugin = exports.sendClientEvent = exports.removeEmpty = exports.getEnvOrBool = exports.getEnvOrDefault = void 0;
-/*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/rox
- *
- * This file is part of Rox AI
- *
- * Licensed under the MIT License (the "License")
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const googletts_1 = __importDefault(require("@fonoster/googletts"));
-const pollytts_1 = __importDefault(require("@fonoster/pollytts"));
-const azuretts_1 = __importDefault(require("@fonoster/azuretts"));
-const types_1 = require("./types");
-const nanoid_1 = require("nanoid");
-const getEnvOrDefault = (envName, def) => process.env[envName] ? parseInt(process.env[envName] || "") : def;
-exports.getEnvOrDefault = getEnvOrDefault;
-const getEnvOrBool = (envName) => process.env[envName]
-    ? (process.env[envName] || "false").toLowerCase() === "true"
-    : false;
-exports.getEnvOrBool = getEnvOrBool;
-const removeEmpty = (obj) => {
-    const newObj = {};
-    Object.keys(obj).forEach((key) => {
-        if (obj[key] === Object(obj[key]))
-            newObj[key] = (0, exports.removeEmpty)(obj[key]);
-        else if (obj[key] !== undefined)
-            newObj[key] = obj[key];
-    });
-    return newObj;
-};
-exports.removeEmpty = removeEmpty;
-const sendClientEvent = (eventsClient, event) => {
-    if (eventsClient) {
-        eventsClient.send(event);
-    }
-};
-exports.sendClientEvent = sendClientEvent;
-const getTTSPlugin = (params) => {
-    const { path, languageCode, vendor, secretString } = params;
-    if (vendor === types_1.TTSVendor.AMAZON) {
-        const config = JSON.parse(secretString);
-        return new pollytts_1.default({
-            accessKeyId: config.tts?.credentials?.accessKeyId,
-            secretAccessKey: config.tts?.credentials?.secretAccessKey,
-            path
-        });
-    }
-    if (vendor === types_1.TTSVendor.MICROSOFT) {
-        const config = JSON.parse(secretString);
-        return new azuretts_1.default({
-            subscriptionKey: config.tts?.subscriptionKey,
-            serviceRegion: config.tts?.serviceRegion,
-            path
-        });
-    }
-    // Default to Google
-    const credentials = JSON.parse(secretString);
-    return new googletts_1.default({
-        credentials: {
-            privateKey: credentials.private_key,
-            clientEmail: credentials.client_email
-        },
-        languageCode,
-        path
-    });
-};
-exports.getTTSPlugin = getTTSPlugin;
-const getVoiceConfig = (params) => {
-    const { secretString, app } = params;
-    const speechSecret = JSON.parse(secretString);
-    if ("tts" in speechSecret) {
-        const ttsConfig = speechSecret.tts;
-        return {
-            voice: ttsConfig.voice,
-            languageCode: ttsConfig.languageCode,
-            region: ttsConfig.region,
-            vendor: ttsConfig.vendor,
-            cachingFields: ttsConfig.cachingFields,
-            playbackId: (0, nanoid_1.nanoid)()
-        };
-    }
-    return {
-        name: app.speechConfig.voice,
-        languageCode: app.speechConfig.languageCode || params.config.defaultLanguageCode,
-        cachingFields: ["name"],
-        playbackId: (0, nanoid_1.nanoid)(),
-        vendor: types_1.TTSVendor.GOOGLE
-    };
-};
-exports.getVoiceConfig = getVoiceConfig;