@fonoster/voice 0.6.2 → 0.7.0

package/dist/VoiceResponse.d.ts

@@ -1,5 +1,5 @@
-import { DialOptions, GatherOptions, GatherResponse, MuteOptions, PlayOptions, PlayResponse, PlaybackControlAction, RecordOptions, RecordResponse, SayOptions, SayResponse, StreamOptions, VerbResponse, VoiceRequest, VoiceSessionStreamServer } from "@fonoster/common";
-import { DialStatusStream, Stream } from "./verbs";
+import { DialOptions, GatherOptions, GatherResponse, MuteOptions, PlayOptions, PlayResponse, PlaybackControlAction, RecordOptions, RecordResponse, SayOptions, SayResponse, StreamGatherOptions, StreamOptions, VerbResponse, VoiceRequest, VoiceSessionStreamServer } from "@fonoster/common";
+import { DialStatusStream, Stream, StreamGatherStream } from "./verbs";
 /**
  * @classdesc Use the VoiceResponse object, to construct advance Interactive
  * Voice Response (IVR) applications.
@@ -11,11 +11,10 @@ import { DialStatusStream, Stream } from "./verbs";
  *
  * async function handler (request, response) {
  *   await response.answer();
- *   await response.play("sound:hello-world");
+ *   await response.play("https://soundsserver:9000/sounds/hello-world.wav");
  * }
  *
- * const voiceServer = new VoiceServer({base: '/voiceapp'})
- * voiceServer.listen(handler, { port: 3000 })
+ * new VoiceServer().listen(handler, { port: 3000 })
  */
 declare class VoiceResponse {
     voice: VoiceSessionStreamServer;
@@ -186,6 +185,24 @@ declare class VoiceResponse {
      * }
      */
     stream(options: StreamOptions): Promise<Stream>;
+    /**
+     * Starts a server-side stream gather operation which sends transcription data to the voice server.
+     *
+     * @param {StreamGatherOptions} options - Options to control the stream gather operation
+     * @param {StreamGatherSource} options.source - The source to gather data from (DTMF, SPEECH, SPEECH_AND_DTMF). Default is SPEECH
+     * @return {Promise<StreamGatherStream>} The stream gather object
+     * @see Gather
+     * @example
+     *
+     * async function handler (request, response) {
+     *  await response.answer();
+     *  const sGather = await response.streamGather({ source: StreamGatherSource.SPEECH });
+     *  sGather.onPayload((payload) => {
+     *    console.log("Payload: %s", payload);
+     *  });
+     * }
+     */
+    sgather(options: StreamGatherOptions): Promise<StreamGatherStream>;
     /**
      * Mutes a call.
      *

package/dist/VoiceResponse.js

@@ -42,11 +42,10 @@ const verbs_1 = require("./verbs");
  *
  * async function handler (request, response) {
  *   await response.answer();
- *   await response.play("sound:hello-world");
+ *   await response.play("https://soundsserver:9000/sounds/hello-world.wav");
  * }
  *
- * const voiceServer = new VoiceServer({base: '/voiceapp'})
- * voiceServer.listen(handler, { port: 3000 })
+ * new VoiceServer().listen(handler, { port: 3000 })
  */
 class VoiceResponse {
     /**
@@ -304,6 +303,42 @@ class VoiceResponse {
             return stream;
         });
     }
+    /**
+     * Starts a server-side stream gather operation which sends transcription data to the voice server.
+     *
+     * @param {StreamGatherOptions} options - Options to control the stream gather operation
+     * @param {StreamGatherSource} options.source - The source to gather data from (DTMF, SPEECH, SPEECH_AND_DTMF). Default is SPEECH
+     * @return {Promise<StreamGatherStream>} The stream gather object
+     * @see Gather
+     * @example
+     *
+     * async function handler (request, response) {
+     *  await response.answer();
+     *  const sGather = await response.streamGather({ source: StreamGatherSource.SPEECH });
+     *  sGather.onPayload((payload) => {
+     *    console.log("Payload: %s", payload);
+     *  });
+     * }
+     */
+    sgather(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const stream = new verbs_1.StreamGatherStream();
+            const startStreamGather = new verbs_1.StartStreamGather(this.request, this.voice);
+            const stopStreamGather = new verbs_1.StopStreamGather(this.request, this.voice);
+            yield startStreamGather.run(Object.assign({ sessionRef: this.request.sessionRef }, options));
+            this.voice.on(common_1.StreamEvent.DATA, (result) => {
+                if (result.streamGatherPayload) {
+                    stream.emit("data", result.streamGatherPayload);
+                }
+            });
+            stream.cleanup(() => {
+                stopStreamGather.run({
+                    sessionRef: this.request.sessionRef
+                });
+            });
+            return stream;
+        });
+    }
     /**
      * Mutes a call.
      *

package/dist/createSession.js

@@ -29,16 +29,25 @@ exports.createSession = createSession;
  * limitations under the License.
  */
 const common_1 = require("@fonoster/common");
+const logger_1 = require("@fonoster/logger");
 const VoiceResponse_1 = require("./VoiceResponse");
+const logger = (0, logger_1.getLogger)({ service: "voice", filePath: __filename });
 function createSession(handler) {
     return (voice) => new Promise((resolve) => {
-        voice.on(common_1.StreamEvent.DATA, (params) => __awaiter(this, void 0, void 0, function* () {
+        let sessionRef;
+        voice.once(common_1.StreamEvent.DATA, (params) => __awaiter(this, void 0, void 0, function* () {
             const { request } = params;
             if (params.request) {
+                sessionRef = params.request.sessionRef;
                 const response = new VoiceResponse_1.VoiceResponse(request, voice);
                 yield handler(request, response);
                 resolve();
             }
         }));
+        voice.once(common_1.StreamEvent.END, () => {
+            logger.verbose("session ended", { sessionRef });
+            voice.end();
+            resolve();
+        });
     });
 }

package/dist/demo.js

@@ -34,12 +34,10 @@ const common_1 = require("@fonoster/common");
 const logger_1 = require("@fonoster/logger");
 const VoiceServer_1 = __importDefault(require("./VoiceServer"));
 const logger = (0, logger_1.getLogger)({ service: "voice", filePath: __filename });
-const config = {
-    // Only do this for testing
-    skipIdentity: true
-};
-new VoiceServer_1.default(config).listen((req, res) => __awaiter(void 0, void 0, void 0, function* () {
-    logger.verbose("voice request", JSON.stringify(req, null, 2));
+// Only skip identity for local development
+new VoiceServer_1.default({ skipIdentity: true }).listen((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const { ingressNumber, sessionRef, appRef } = req;
+    logger.verbose("voice request", { ingressNumber, sessionRef, appRef });
     yield res.answer();
     yield res.say("Hi there! What's your name?");
     const { speech: name } = yield res.gather({

package/dist/index.d.ts

@@ -2,5 +2,6 @@
 import { AzureVoice, AzureVoiceDetails, GoogleVoice, GoogleVoiceDetails } from "@fonoster/common";
 import VoiceServer from "./VoiceServer";
 export default VoiceServer;
+export * from "./VoiceResponse";
 export * from "./types";
 export { GoogleVoice, GoogleVoiceDetails, AzureVoice, AzureVoiceDetails };

package/dist/index.js

@@ -44,4 +44,5 @@ Object.defineProperty(exports, "GoogleVoice", { enumerable: true, get: function
 Object.defineProperty(exports, "GoogleVoiceDetails", { enumerable: true, get: function () { return common_1.GoogleVoiceDetails; } });
 const VoiceServer_1 = __importDefault(require("./VoiceServer"));
 exports.default = VoiceServer_1.default;
+__exportStar(require("./VoiceResponse"), exports);
 __exportStar(require("./types"), exports);

package/dist/verbs/StreamGather.d.ts

@@ -0,0 +1,19 @@
+import { Stream as StreamObj } from "stream";
+import { StartStreamGatherRequest, StreamGatherPayload, VerbRequest } from "@fonoster/common";
+import { z } from "zod";
+import { Verb } from "./Verb";
+declare class StartStreamGather extends Verb<StartStreamGatherRequest> {
+    getValidationSchema(): z.Schema;
+}
+declare class StopStreamGather extends Verb<VerbRequest> {
+    getValidationSchema(): z.Schema;
+}
+declare class StreamGatherStream {
+    stream: StreamObj;
+    constructor();
+    close(): void;
+    onPayload(callback: (payload: StreamGatherPayload) => void): void;
+    emit(event: "data", payload: StreamGatherPayload): void;
+    cleanup(callback: () => void): void;
+}
+export { StartStreamGather, StopStreamGather, StreamGatherStream };

package/dist/verbs/StreamGather.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamGatherStream = exports.StopStreamGather = exports.StartStreamGather = void 0;
+/*
+ * 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 stream_1 = require("stream");
+const common_1 = require("@fonoster/common");
+const zod_1 = require("zod");
+const Verb_1 = require("./Verb");
+class StartStreamGather extends Verb_1.Verb {
+    getValidationSchema() {
+        return zod_1.z.object({
+            source: zod_1.z.optional(zod_1.z.nativeEnum(common_1.StreamGatherSource))
+        });
+    }
+}
+exports.StartStreamGather = StartStreamGather;
+class StopStreamGather extends Verb_1.Verb {
+    getValidationSchema() {
+        return zod_1.z.object({
+            sessionRef: zod_1.z.string()
+        });
+    }
+}
+exports.StopStreamGather = StopStreamGather;
+class StreamGatherStream {
+    constructor() {
+        this.stream = new stream_1.Stream();
+    }
+    close() {
+        this.stream.removeAllListeners();
+    }
+    // TODO: We should hide this method from the public API
+    // Private API
+    onPayload(callback) {
+        this.stream.on("data", (payload) => {
+            callback(payload);
+        });
+    }
+    // Private API
+    emit(event, payload) {
+        this.stream.emit(event, payload);
+    }
+    // Private API
+    cleanup(callback) {
+        this.stream.on("close", callback);
+    }
+}
+exports.StreamGatherStream = StreamGatherStream;

package/dist/verbs/index.d.ts

@@ -9,6 +9,7 @@ export * from "./PlaybackControl";
 export * from "./Record";
 export * from "./Say";
 export * from "./Stream";
+export * from "./StreamGather";
 export * from "./Unmute";
 export * from "./validateRequest";
 export * from "./Verb";

package/dist/verbs/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./PlaybackControl"), exports);
 __exportStar(require("./Record"), exports);
 __exportStar(require("./Say"), exports);
 __exportStar(require("./Stream"), exports);
+__exportStar(require("./StreamGather"), exports);
 __exportStar(require("./Unmute"), exports);
 __exportStar(require("./validateRequest"), exports);
 __exportStar(require("./Verb"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/voice",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Voice Server for Fonoster",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -20,9 +20,9 @@
     "fonoster": "./dist/index.js"
   },
   "dependencies": {
-    "@fonoster/common": "^0.6.2",
-    "@fonoster/identity": "^0.6.2",
-    "@fonoster/logger": "^0.6.2",
+    "@fonoster/common": "^0.7.0",
+    "@fonoster/identity": "^0.7.0",
+    "@fonoster/logger": "^0.7.0",
     "@grpc/grpc-js": "~1.10.6",
     "deepmerge": "^4.3.1",
     "grpc-health-check": "^2.0.2",
@@ -43,5 +43,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "9b55399d2906479d826a53a5e3bd10206aaaa86d"
+  "gitHead": "afa950ace3b1d022b6dc8be0c3b87a6b8a5ba3c5"
 }