@fonoster/apiserver 0.7.0 → 0.7.2

package/dist/applications/createGetFnUtil.d.ts

@@ -23,7 +23,7 @@ declare function createGetFnUtil(prisma: Prisma): (ref: string) => Promise<{
         productRef: string;
     };
     name: string;
-    type: "PROGRAMMABLE_VOICE";
+    type: "EXTERNAL";
     ref: string;
     createdAt: Date;
     updatedAt: Date;

package/dist/applications/utils/convertToApplicationData.js

@@ -4,7 +4,7 @@ exports.convertToApplicationData = convertToApplicationData;
 const client_1 = require("@prisma/client");
 const pb_util_1 = require("pb-util");
 function convertToApplicationData(request) {
-    const type = request.type || client_1.ApplicationType.PROGRAMMABLE_VOICE;
+    const type = request.type || client_1.ApplicationType.EXTERNAL;
     const result = {
         ref: request.ref, // Only for UpdateApplicationRequest
         name: request.name,

package/dist/applications/utils/getApplicationValidationSchema.d.ts

@@ -5,7 +5,7 @@ declare function getApplicationValidationSchema(request: {
 }): z.ZodObject<{
     name: z.ZodString;
     type: z.ZodNativeEnum<{
-        PROGRAMMABLE_VOICE: "PROGRAMMABLE_VOICE";
+        EXTERNAL: "EXTERNAL";
     }>;
     endpoint: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string, string>;
     textToSpeech: z.ZodUndefined | z.ZodObject<{
@@ -34,7 +34,7 @@ declare function getApplicationValidationSchema(request: {
     }>;
 }, "strip", z.ZodTypeAny, {
     name?: string;
-    type?: "PROGRAMMABLE_VOICE";
+    type?: "EXTERNAL";
     endpoint?: string;
     textToSpeech?: {
         [x: string]: any;
@@ -48,7 +48,7 @@ declare function getApplicationValidationSchema(request: {
     };
 }, {
     name?: string;
-    type?: "PROGRAMMABLE_VOICE";
+    type?: "EXTERNAL";
     endpoint?: string;
     textToSpeech?: {
         [x: string]: any;

package/dist/applications/utils/getApplicationValidationSchema.js

@@ -24,16 +24,20 @@ const zod_1 = require("zod");
 const Deepgram_1 = require("../../voice/stt/Deepgram");
 const Google_1 = require("../../voice/stt/Google");
 const Azure_1 = require("../../voice/tts/Azure");
+const Deepgram_2 = require("../../voice/tts/Deepgram");
 const Google_2 = require("../../voice/tts/Google");
 const hostOrHostPortSchema_1 = require("../hostOrHostPortSchema");
+// TODO: We need a way to add this values dynamically
 const validators = {
     ttsConfigValidators: {
         "tts.google": Google_2.Google.getConfigValidationSchema,
-        "tts.azure": Azure_1.Azure.getConfigValidationSchema
+        "tts.azure": Azure_1.Azure.getConfigValidationSchema,
+        "tts.deepgram": Deepgram_2.Deepgram.getConfigValidationSchema
     },
     ttsCredentialsValidators: {
         "tts.google": Google_2.Google.getCredentialsValidationSchema,
-        "tts.azure": Azure_1.Azure.getCredentialsValidationSchema
+        "tts.azure": Azure_1.Azure.getCredentialsValidationSchema,
+        "tts.deepgram": Deepgram_2.Deepgram.getCredentialsValidationSchema
     },
     sttConfigValidators: {
         "stt.google": Google_1.Google.getConfigValidationSchema,

package/dist/applications/utils/prepareForValidation.js

@@ -4,7 +4,7 @@ exports.prepareForValidation = prepareForValidation;
 const client_1 = require("@prisma/client");
 const pb_util_1 = require("pb-util");
 function prepareForValidation(request) {
-    const type = request.type || client_1.ApplicationType.PROGRAMMABLE_VOICE;
+    const type = request.type || client_1.ApplicationType.EXTERNAL;
     const result = {
         ref: request.ref, // Only for UpdateApplicationRequest
         name: request.name,

package/dist/voice/VoiceClientImpl.d.ts

@@ -1,7 +1,7 @@
 import { Stream } from "stream";
 import { SayOptions, VoiceClientConfig, VoiceIn, VoiceSessionStreamClient } from "@fonoster/common";
 import { AudioSocket } from "@fonoster/streams";
-import { Client } from "ari-client";
+import { Bridge, Client } from "ari-client";
 import { SpeechResult } from "./stt/types";
 import { GRPCClient, SpeechToText, TextToSpeech, VoiceClient } from "./types";
 declare class VoiceClientImpl implements VoiceClient {
@@ -15,6 +15,7 @@ declare class VoiceClientImpl implements VoiceClient {
     audioSocket: AudioSocket;
     asStream: Stream;
     ari: Client;
+    bridge: Bridge;
     constructor(params: {
         ari: Client;
         config: VoiceClientConfig;
@@ -23,9 +24,11 @@ declare class VoiceClientImpl implements VoiceClient {
     });
     connect(): Promise<void>;
     setupAudioSocket(port: number): void;
-    setupExternalMedia(port: number): Promise<void>;
     on(type: string, callback: (data: VoiceIn) => void): void;
     sendResponse(response: VoiceIn): void;
+    getBridge(): Bridge;
+    getTranscriptionsStream(): Stream;
+    setupExternalMedia(port: number): Promise<void>;
     synthesize(text: string, options: SayOptions): Promise<string>;
     transcribe(): Promise<SpeechResult>;
     startSpeechGather(callback: (stream: {

package/dist/voice/VoiceClientImpl.js

@@ -107,17 +107,36 @@ class VoiceClientImpl {
             });
         });
     }
+    on(type, callback) {
+        this.verbsStream.on(type.toString(), (data) => {
+            callback(data[type]);
+        });
+    }
+    sendResponse(response) {
+        this.voice.write(response);
+    }
+    getBridge() {
+        return this.bridge;
+    }
+    getTranscriptionsStream() {
+        return this.transcriptionsStream;
+    }
     setupExternalMedia(port) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Snoop from the main channel
+            const snoopChannel = yield this.ari.channels.snoopChannel({
+                app: common_1.STASIS_APP_NAME,
+                channelId: this.config.sessionRef,
+                snoopId: "snoop-" + this.config.sessionRef,
+                spy: "in"
+            });
             const bridge = this.ari.Bridge();
             yield bridge.create({ type: "mixing" });
+            this.bridge = bridge;
             const channel = this.ari.Channel();
             channel.externalMedia((0, createExternalMediaConfig_1.createExternalMediaConfig)(port));
             channel.once(types_1.AriEvent.STASIS_START, (_, channel) => __awaiter(this, void 0, void 0, function* () {
-                yield bridge.addChannel({
-                    channel: [this.config.sessionRef, channel.id]
-                });
-                yield channel.answer();
+                bridge.addChannel({ channel: [snoopChannel.id, channel.id] });
             }));
             channel.once("ChannelLeftBridge", () => __awaiter(this, void 0, void 0, function* () {
                 // TODO: Evaluate a better way to handle this
@@ -133,14 +152,6 @@ class VoiceClientImpl {
             }));
         });
     }
-    on(type, callback) {
-        this.verbsStream.on(type.toString(), (data) => {
-            callback(data[type]);
-        });
-    }
-    sendResponse(response) {
-        this.voice.write(response);
-    }
     synthesize(text, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.tts.synthesize(text, options);

package/dist/voice/VoiceDispatcher.js

@@ -31,6 +31,7 @@ exports.VoiceDispatcher = void 0;
 const common_1 = require("@fonoster/common");
 const logger_1 = require("@fonoster/logger");
 const handlers_1 = require("./handlers");
+const Stream_1 = require("./handlers/Stream");
 const makeGetChannelVar_1 = require("./makeGetChannelVar");
 const types_1 = require("./types");
 const utils_1 = require("../utils");
@@ -83,6 +84,7 @@ class VoiceDispatcher {
                 vc.on(common_1.StreamContent.STOP_STREAM_GATHER_REQUEST, () => {
                     vc.stopStreamGather();
                 });
+                vc.on(common_1.StreamContent.START_STREAM_REQUEST, (0, Stream_1.streamHandler)(vc).bind(this));
             }
             catch (err) {
                 logger.error("error handling stasis start", { error: err.message });

package/dist/voice/handlers/PlaybackControl.js

@@ -10,14 +10,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.playbackControlHandler = playbackControlHandler;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * 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 common_1 = require("@fonoster/common");
+const zod_1 = require("zod");
 const withErrorHandling_1 = require("./utils/withErrorHandling");
+const requestSchema = zod_1.z.object({
+    sessionRef: zod_1.z.string(),
+    playbackRef: zod_1.z.string().optional().nullable(),
+    action: zod_1.z.nativeEnum(common_1.PlaybackControlAction)
+});
 function playbackControlHandler(ari, voiceClient) {
     return (0, withErrorHandling_1.withErrorHandling)((playbackControlReq) => __awaiter(this, void 0, void 0, function* () {
-        const { sessionRef, playbackRef, action } = playbackControlReq;
-        yield ari.playbacks.control({
-            playbackId: playbackRef,
-            operation: action
-        });
+        requestSchema.parse(playbackControlReq);
+        const { sessionRef, playbackRef: playbackId, action } = playbackControlReq;
+        try {
+            if (action === common_1.PlaybackControlAction.STOP) {
+                yield ari.playbacks.stop({ playbackId });
+            }
+            else {
+                yield ari.playbacks.control({ playbackId, operation: action });
+            }
+        }
+        catch (err) {
+            // Ignore error
+        }
         voiceClient.sendResponse({
             playbackControlResponse: {
                 sessionRef

package/dist/voice/handlers/Say.js

@@ -25,13 +25,13 @@ const sayRequestSchema = zod_1.z.object({
 const getMediaUrl = (filename) => `sound:http://${envs_1.APISERVER_HOST}:${envs_1.FILES_SERVER_PORT}/sounds/${filename}.sln16`;
 function sayHandler(ari, voiceClient) {
     return (0, withErrorHandling_1.withErrorHandling)((request) => __awaiter(this, void 0, void 0, function* () {
-        const { sessionRef } = request;
+        const { sessionRef: channelId } = request;
         // Error handled by withErrorHandling
         sayRequestSchema.parse(request);
         const playbackRef = request.playbackRef || (0, nanoid_1.nanoid)(10);
         const filename = yield voiceClient.synthesize(request.text, request.options ? pb_util_1.struct.decode(request.options) : {});
         yield ari.channels.play({
-            channelId: sessionRef,
+            channelId,
             media: getMediaUrl(filename),
             playbackId: playbackRef
         });

package/dist/voice/handlers/Stream.d.ts

@@ -0,0 +1,3 @@
+import { VoiceClient } from "../types";
+declare function streamHandler(voiceClient: VoiceClient): (request: import("@fonoster/common").VerbRequest) => Promise<void>;
+export { streamHandler };

package/dist/voice/handlers/Stream.js

@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamHandler = streamHandler;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * 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 common_1 = require("@fonoster/common");
+const zod_1 = require("zod");
+const withErrorHandling_1 = require("./utils/withErrorHandling");
+const streamRequestSchema = zod_1.z.object({
+    direction: zod_1.z.nativeEnum(common_1.StreamDirection).optional(),
+    format: zod_1.z.nativeEnum(common_1.StreamAudioFormat).optional()
+});
+function streamHandler(voiceClient) {
+    return (0, withErrorHandling_1.withErrorHandling)((request) => __awaiter(this, void 0, void 0, function* () {
+        const { sessionRef, direction, format } = request;
+        // Error handled by withErrorHandling
+        streamRequestSchema.parse(request);
+        const effectiveDirection = direction || common_1.StreamDirection.BOTH;
+        const effectiveFormat = format || common_1.StreamAudioFormat.WAV;
+        // FIXME: Implement stream IN and correct streamRef
+        if (effectiveDirection.includes(common_1.StreamDirection.OUT) ||
+            effectiveDirection === common_1.StreamDirection.BOTH) {
+            voiceClient.getTranscriptionsStream().on("data", (data) => {
+                voiceClient.sendResponse({
+                    streamPayload: {
+                        sessionRef,
+                        type: common_1.StreamMessageType.AUDIO_OUT,
+                        data,
+                        streamRef: "fixme",
+                        format: effectiveFormat
+                    }
+                });
+            });
+        }
+        voiceClient.sendResponse({
+            startStreamResponse: {
+                sessionRef,
+                streamRef: "fixme"
+            }
+        });
+    }));
+}

package/dist/voice/handlers/StreamGather.js

@@ -62,5 +62,10 @@ function streamGatherHandler(voiceClient) {
                 });
             });
         }
+        voiceClient.sendResponse({
+            startStreamGatherResponse: {
+                sessionRef
+            }
+        });
     }));
 }

package/dist/voice/stt/Deepgram.js

@@ -73,13 +73,6 @@ class Deepgram extends AbstractSpeechToText_1.AbstractSpeechToText {
         const connection = this.client.listen.live(buildTranscribeConfig(this.engineConfig.config));
         const out = new stream_1.Stream();
         connection.on(LiveTranscriptionEvents.Open, () => {
-            // WARNING: This is a workaround to keep the connection open while the system
-            // is playing a file which causes the stream to be paused. We need to look into why
-            // the stream is being paused.
-            const keepAliveInterval = setInterval(() => {
-                const keepAliveMsg = JSON.stringify({ type: "KeepAlive" });
-                connection.send(keepAliveMsg);
-            }, 3000);
             stream.on("data", (chunk) => {
                 connection.send(chunk);
             });
@@ -93,7 +86,6 @@ class Deepgram extends AbstractSpeechToText_1.AbstractSpeechToText {
             });
             connection.on(LiveTranscriptionEvents.Error, (err) => {
                 logger.warn("error on Deepgram connection", { err });
-                clearInterval(keepAliveInterval);
                 connection.destroy();
             });
         });

package/dist/voice/tts/Deepgram.js

@@ -86,7 +86,8 @@ class Deepgram extends AbstractTextToSpeech_1.AbstractTextToSpeech {
             const response = yield this.client.speak.request({ text }, {
                 model: voice || common_1.DeepgramVoice.AURA_ASTERIA_EN,
                 encoding: this.AUDIO_ENCODING,
-                sample_rate: this.SAMPLE_RATE_HERTZ
+                sample_rate: this.SAMPLE_RATE_HERTZ,
+                container: "none"
             });
             const writeFile = util.promisify(fs.writeFile);
             const audioBuffer = yield getAudioBuffer(yield response.getStream());

package/dist/voice/types/voice.d.ts

@@ -1,6 +1,7 @@
 import { Stream } from "stream";
 import { SayOptions, StreamContent, VoiceClientConfig, VoiceIn, VoiceSessionStreamClient } from "@fonoster/common";
 import * as grpc from "@grpc/grpc-js";
+import { Bridge } from "ari-client";
 import { SpeechResult, StreamSpeech } from "../stt/types";
 type VoiceClient = {
     config: VoiceClientConfig;
@@ -26,6 +27,8 @@ type VoiceClient = {
     }) => Promise<{
         digits: string;
     }>;
+    getBridge: () => Bridge;
+    getTranscriptionsStream: () => Stream;
 };
 type TextToSpeech = {
     synthesize: (text: string, options: Record<string, unknown>) => Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/apiserver",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "APIServer for Fonoster",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -21,12 +21,12 @@
   },
   "dependencies": {
     "@deepgram/sdk": "^3.5.1",
-    "@fonoster/common": "^0.7.0",
-    "@fonoster/identity": "^0.7.0",
-    "@fonoster/logger": "^0.7.0",
-    "@fonoster/sipnet": "^0.7.0",
-    "@fonoster/streams": "^0.7.0",
-    "@fonoster/types": "^0.7.0",
+    "@fonoster/common": "^0.7.2",
+    "@fonoster/identity": "^0.7.2",
+    "@fonoster/logger": "^0.7.2",
+    "@fonoster/sipnet": "^0.7.2",
+    "@fonoster/streams": "^0.7.2",
+    "@fonoster/types": "^0.7.2",
     "@google-cloud/speech": "^6.6.0",
     "@google-cloud/text-to-speech": "^5.3.0",
     "@grpc/grpc-js": "~1.10.6",
@@ -71,5 +71,5 @@
     "@types/uuid": "^9.0.8",
     "@types/validator": "^13.12.0"
   },
-  "gitHead": "afa950ace3b1d022b6dc8be0c3b87a6b8a5ba3c5"
+  "gitHead": "6d858d9920132dfef0dba8965e5005f44de61563"
 }