@fonoster/voice 0.5.5 → 0.6.1

package/dist/voice.d.ts

@@ -1,284 +0,0 @@
-import { PlaybackControl } from "./playback/playback";
-import { SayOptions } from "./say/types";
-import { VoiceRequest } from "./types";
-import { Plugin } from "@fonoster/common";
-import { DialOptions } from "./dial/types";
-import { SGatherStream } from "./sgather/types";
-import { DtmfOptions } from "./dtmf/types";
-import { SGatherOptions } from "./sgather/gather";
-import StreamStatus from "./dial/status_stream";
-import { GatherOptions } from "./gather/gather";
-import { MuteOptions } from "./mute/mute";
-import { PlayOptions } from "./play/play";
-import { RecordOptions, RecordResult } from "./record/record";
-/**
- * @classdesc Use the VoiceResponse object, to construct advance Interactive
- * Voice Response (IVR) applications.
- *
- * @extends Verb
- * @example
- *
- * import { VoiceServer } from "@fonoster/voice";
- *
- * async function handler (request, response) {
- *   await response.answer();
- *   await response.play("sound:hello-world");
- * }
- *
- * const voiceServer = new VoiceServer({base: '/voiceapp'})
- * voiceServer.listen(handler, { port: 3000 })
- */
-export default class VoiceResponse {
-    request: VoiceRequest;
-    plugins: {};
-    /**
-     * Constructs a new VoiceResponse object.
-     *
-     * @param {VoiceRequest} request - Options to indicate the objects endpoint
-     * @see module:core:APIClient
-     */
-    constructor(request: VoiceRequest);
-    /**
-     * Adds a tts or asr plugin. Only one type of plugin can be attached.
-     *
-     * @param plugin
-     * @see GoogleTTS
-     * @see GoogleASR
-     */
-    use(plugin: Plugin): void;
-    /**
-     * Play an audio in the channel.
-     *
-     * @param {string} media - Sound name or uri with audio file
-     * @param {PlayOptions} options - Optional parameters to alter the command's normal
-     * behavior
-     * @param {string} options.offset - Milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified
-     * @param {string} options.skip - Milliseconds to skip for forward/reverse operations
-     * @param {string} options.playbackId - Playback identifier to use in Playback operations
-     * @see Playback
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav");
-     * }
-     */
-    play(media: string, options?: PlayOptions): Promise<void>;
-    /**
-     * Converts a text into a sound and sends sound to media server. To use this verb, you must
-     * first setup a TTS plugin such as GoogleTTS, or AWS PollyTTS
-     *
-     * @param {string} text - Converts a text into a sound and sends sound to media server
-     * @param {SayOptions} options - Optional parameters to alter the command's normal
-     * behavior
-     * @param {string} options.offset - Milliseconds to skip before playing
-     * @param {string} options.skip - Milliseconds to skip for forward/reverse operations
-     * @param {string} options.playbackId - Playback identifier to use in Playback operations
-     * @see Play
-     * @see Voice.use
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.use(new GoogleTTS())
-     *   await response.say("Hello workd");   // Plays the sound using GoogleTTS's default values
-     * }
-     */
-    say(text: string, options?: SayOptions): Promise<void>;
-    /**
-     * Waits for data entry from the user's keypad or from a speech provider.
-     *
-     * @param {GatherOptions} options - Options to select the maximum number of digits, final character, and timeout
-     * @param {number} options.numDigits - Milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified
-     * @param {number} options.timeout - Milliseconds to wait before timeout. Defaults to 4000. Use zero for no timeout.
-     * @param {string} options.finishOnKey - Optional last character to wait for. Defaults to '#'. It will not be included in the returned digits
-     * @param {string} options.source - Where to listen as input source. This option accepts `dtmf` and `speech`. A speech provider must be configure
-     * when including the `speech` source. You might inclue both with `dtmf,speech`. Defaults to `dtmf`
-     * @note When including `speech` the default timeout is 10000 (10s).
-     * @see SpeechProvider
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   const digits = await response.gather({source: "dtmf,speech", numDigits: 3});
-     *   console.log("digits: " + digits);
-     * }
-     */
-    gather(options?: GatherOptions): Promise<string>;
-    /**
-     * Waits for data entry from the user's keypad or from a stream speech provider. This command is different from `gather`
-     * in that it returns a stream of results instead of a single result. You can think of it as active listening.
-     *
-     * @param {SGatherOptions} options - Options object for the SGather verb
-     * @param {string} options.source - Where to listen as input source. This option accepts `dtmf` and `speech`. A speech provider must be configure
-     * when including the `speech` source. You might inclue both with `dtmf,speech`. Defaults to `speech,dtmf`
-     * @return {SGatherStream} The SGatherStream fires events via the `on` method for `transcription`, `dtmf`, and `error`. And the stream can be close
-     * with the `close` function.
-     * @see StreamSpeechProvider
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   const stream = await response.sgather({source: "dtmf,speech"});
-     *
-     *   stream.on("transcript", (text, isFinal) => {
-     *      console.log("transcript: %s", text);
-     *   })
-     *
-     *   stream.on("dtmf", digit => {
-     *      console.log("digit: " + digit);
-     *      if (digit === "#") stream.close();
-     *   })
-     * }
-     */
-    sgather(options?: SGatherOptions): Promise<SGatherStream>;
-    /**
-     * Sends dtmf tones to the current session.
-     *
-     * @param {DtmfOptions} options - Options object for the Dtmf verb
-     * @param {string} options.dtmf - A string of the dtmf tones
-     * @example
-     *
-     * async function handler (request, response) {
-     *    await response.answer();
-     *    await response.play("sound:hello-world");
-     *    await response.dtmf({dtmf: "1234"});
-     * }
-     */
-    dtmf(options: DtmfOptions): Promise<void>;
-    /**
-     * Forwards the call to an Agent or the PSTN.
-     *
-     * @param {string} destination - Number or Agent to forward the call to
-     * @param {DialOptions} options - Options object for the Dial verb
-     * @param {timeout} options.timeout - Dial timeout
-     * @return {StatusStream} The StatusStream fires events via the `on` method for `progress`, `answer`, `noanswer`, and `busy`. And the stream can be close
-     * with the `close` function.
-     * @example
-     *
-     * async function handler (request, response) {
-     *    await response.answer();
-     *    await response.say("dialing number");
-     *    const stream = await response.dial("17853178070");
-     *    stream.on("progress", console.log)
-     *    stream.on("answer", console.log)
-     *    stream.on("busy", console.log)
-     * }
-     */
-    dial(destination: string, options?: DialOptions): Promise<StreamStatus>;
-    /**
-     * Returns a PlaybackControl control object.
-     *
-     * @param {string} playbackId - Playback identifier to use in Playback operations
-     * @see Play
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.onDtmfReceived(async(digit) => {
-     *      const control = response.playback("1234")
-     *      digit === "3"
-     *        ? await control.restart()
-     *        : await control.forward()
-     *   })
-     *
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav", {
-     *      playbackId: "1234"
-     *   });
-     * }
-     */
-    playback(playbackId: string): PlaybackControl;
-    /**
-     * Listens event publication.
-     *
-     * @param {Function} handler - Event handler
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.on("DtmfReceived", async(digit) => {
-     *      const control = response.playback("1234")
-     *      digit === "3"
-     *        ? await control.restart()
-     *        : await control.forward()
-     *   })
-     *
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav", {
-     *      playbackId: "1234"
-     *   });
-     * }
-     */
-    on(topic: string, handler: Function): Promise<void>;
-    /**
-     * Mutes a channel.
-     *
-     * @param {MuteOptions} options - Indicate which direction of he communication to mute
-     * @param {string} options.direction - Possible values are 'in', 'out', and 'both'
-     * @see unmute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.mute();       // Will mute both directions
-     * }
-     */
-    mute(options?: MuteOptions): Promise<void>;
-    /**
-     * Unmutes a channel.
-     *
-     * @param {MuteOptions} options - Indicate which direction of he communication to unmute
-     * @param {string} options.direction - Possible values are 'in', 'out', and 'both'
-     * @see mute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   ...
-     *   await response.unmute({direction: "out"});       // Will unmute only the "out" direction
-     * }
-     */
-    unmute(options?: MuteOptions): Promise<void>;
-    /**
-     * Answer the communication channel. Before running any other verb you
-     * must run the anwer command.
-     *
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   ...
-     * }
-     */
-    answer(): Promise<void>;
-    /**
-     * Terminates the communication channel.
-     *
-     * @example
-     *
-     * async function handler (request, response) {
-     *   ...
-     *   await response.hangup();
-     * }
-     */
-    hangup(): Promise<void>;
-    /**
-     * Records the current channel and uploads the file to the storage subsystem.
-     *
-     * @param {RecordOptions} options - optional parameters to alter the command's normal
-     * behavior
-     * @param {number} options.maxDuration - Maximum duration of the recording, in seconds. Use `0` for no limit
-     * @param {number} options.maxSilence - Maximum duration of silence, in seconds. Use `0` for no limit
-     * @param {boolean} options.beep - Play beep when recording begins
-     * @param {string} options.finishOnKey - DTMF input to terminate recording
-     * @return {Promise<RecordResult>} Returns useful information such as the duration of the recording, etc.
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();;
-     *   const result = await response.record({finishOnKey: "#"});
-     *   console.log("recording result: " + JSON.stringify(result))     // recording result: { duration: 30 ...}
-     * }
-     */
-    record(options: RecordOptions): Promise<RecordResult>;
-    openMediaPipe(): Promise<void>;
-    closeMediaPipe(): Promise<void>;
-}

package/dist/voice.js

@@ -1,367 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/*
- * Copyright (C) 2023 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 playback_1 = require("./playback/playback");
-const asserts_1 = require("./asserts");
-const verb_1 = require("./verb");
-const utils_1 = require("./utils");
-const gather_1 = __importDefault(require("./sgather/gather"));
-const dtmf_1 = __importDefault(require("./dtmf/dtmf"));
-const dial_1 = __importDefault(require("./dial/dial"));
-const pubsub_js_1 = __importDefault(require("pubsub-js"));
-const answer_1 = __importDefault(require("./answer/answer"));
-const hangup_1 = __importDefault(require("./hangup/hangup"));
-const unmute_1 = __importDefault(require("./unmute/unmute"));
-const gather_2 = __importDefault(require("./gather/gather"));
-const mute_1 = __importDefault(require("./mute/mute"));
-const play_1 = __importDefault(require("./play/play"));
-const record_1 = __importDefault(require("./record/record"));
-/**
- * @classdesc Use the VoiceResponse object, to construct advance Interactive
- * Voice Response (IVR) applications.
- *
- * @extends Verb
- * @example
- *
- * import { VoiceServer } from "@fonoster/voice";
- *
- * async function handler (request, response) {
- *   await response.answer();
- *   await response.play("sound:hello-world");
- * }
- *
- * const voiceServer = new VoiceServer({base: '/voiceapp'})
- * voiceServer.listen(handler, { port: 3000 })
- */
-class VoiceResponse {
-    request;
-    plugins;
-    /**
-     * Constructs a new VoiceResponse object.
-     *
-     * @param {VoiceRequest} request - Options to indicate the objects endpoint
-     * @see module:core:APIClient
-     */
-    constructor(request) {
-        this.request = request;
-        this.plugins = {};
-    }
-    /**
-     * Adds a tts or asr plugin. Only one type of plugin can be attached.
-     *
-     * @param plugin
-     * @see GoogleTTS
-     * @see GoogleASR
-     */
-    use(plugin) {
-        this.plugins[plugin.getType()] = plugin;
-    }
-    /**
-     * Play an audio in the channel.
-     *
-     * @param {string} media - Sound name or uri with audio file
-     * @param {PlayOptions} options - Optional parameters to alter the command's normal
-     * behavior
-     * @param {string} options.offset - Milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified
-     * @param {string} options.skip - Milliseconds to skip for forward/reverse operations
-     * @param {string} options.playbackId - Playback identifier to use in Playback operations
-     * @see Playback
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav");
-     * }
-     */
-    async play(media, options = {}) {
-        await new play_1.default(this.request).run(media, options);
-    }
-    /**
-     * Converts a text into a sound and sends sound to media server. To use this verb, you must
-     * first setup a TTS plugin such as GoogleTTS, or AWS PollyTTS
-     *
-     * @param {string} text - Converts a text into a sound and sends sound to media server
-     * @param {SayOptions} options - Optional parameters to alter the command's normal
-     * behavior
-     * @param {string} options.offset - Milliseconds to skip before playing
-     * @param {string} options.skip - Milliseconds to skip for forward/reverse operations
-     * @param {string} options.playbackId - Playback identifier to use in Playback operations
-     * @see Play
-     * @see Voice.use
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.use(new GoogleTTS())
-     *   await response.say("Hello workd");   // Plays the sound using GoogleTTS's default values
-     * }
-     */
-    async say(text, options = {}) {
-        (0, asserts_1.assertPluginExist)(this, "tts");
-        const tts = this.plugins["tts"];
-        // It should return the filename and the generated file location
-        const result = await tts.synthesize(text, options);
-        const media = `sound:${this.request.selfEndpoint}/tts/${result.filename}`;
-        await new play_1.default(this.request).run(media, options);
-    }
-    /**
-     * Waits for data entry from the user's keypad or from a speech provider.
-     *
-     * @param {GatherOptions} options - Options to select the maximum number of digits, final character, and timeout
-     * @param {number} options.numDigits - Milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified
-     * @param {number} options.timeout - Milliseconds to wait before timeout. Defaults to 4000. Use zero for no timeout.
-     * @param {string} options.finishOnKey - Optional last character to wait for. Defaults to '#'. It will not be included in the returned digits
-     * @param {string} options.source - Where to listen as input source. This option accepts `dtmf` and `speech`. A speech provider must be configure
-     * when including the `speech` source. You might inclue both with `dtmf,speech`. Defaults to `dtmf`
-     * @note When including `speech` the default timeout is 10000 (10s).
-     * @see SpeechProvider
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   const digits = await response.gather({source: "dtmf,speech", numDigits: 3});
-     *   console.log("digits: " + digits);
-     * }
-     */
-    async gather(options = { source: "speech,dtmf" }) {
-        let asr = null;
-        if (options.source.includes("speech")) {
-            (0, asserts_1.assertPluginExist)(this, "asr");
-            asr = this.plugins["asr"];
-        }
-        const result = await new gather_2.default(this.request, asr).run(options);
-        return result;
-    }
-    /**
-     * Waits for data entry from the user's keypad or from a stream speech provider. This command is different from `gather`
-     * in that it returns a stream of results instead of a single result. You can think of it as active listening.
-     *
-     * @param {SGatherOptions} options - Options object for the SGather verb
-     * @param {string} options.source - Where to listen as input source. This option accepts `dtmf` and `speech`. A speech provider must be configure
-     * when including the `speech` source. You might inclue both with `dtmf,speech`. Defaults to `speech,dtmf`
-     * @return {SGatherStream} The SGatherStream fires events via the `on` method for `transcription`, `dtmf`, and `error`. And the stream can be close
-     * with the `close` function.
-     * @see StreamSpeechProvider
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   const stream = await response.sgather({source: "dtmf,speech"});
-     *
-     *   stream.on("transcript", (text, isFinal) => {
-     *      console.log("transcript: %s", text);
-     *   })
-     *
-     *   stream.on("dtmf", digit => {
-     *      console.log("digit: " + digit);
-     *      if (digit === "#") stream.close();
-     *   })
-     * }
-     */
-    async sgather(options = { source: "speech,dtmf" }) {
-        let asr = null;
-        if (options.source.includes("speech")) {
-            (0, asserts_1.assertPluginExist)(this, "asr");
-            asr = this.plugins["asr"];
-        }
-        return await new gather_1.default(this.request, asr).run(options);
-    }
-    /**
-     * Sends dtmf tones to the current session.
-     *
-     * @param {DtmfOptions} options - Options object for the Dtmf verb
-     * @param {string} options.dtmf - A string of the dtmf tones
-     * @example
-     *
-     * async function handler (request, response) {
-     *    await response.answer();
-     *    await response.play("sound:hello-world");
-     *    await response.dtmf({dtmf: "1234"});
-     * }
-     */
-    async dtmf(options) {
-        return await new dtmf_1.default(this.request).run(options);
-    }
-    /**
-     * Forwards the call to an Agent or the PSTN.
-     *
-     * @param {string} destination - Number or Agent to forward the call to
-     * @param {DialOptions} options - Options object for the Dial verb
-     * @param {timeout} options.timeout - Dial timeout
-     * @return {StatusStream} The StatusStream fires events via the `on` method for `progress`, `answer`, `noanswer`, and `busy`. And the stream can be close
-     * with the `close` function.
-     * @example
-     *
-     * async function handler (request, response) {
-     *    await response.answer();
-     *    await response.say("dialing number");
-     *    const stream = await response.dial("17853178070");
-     *    stream.on("progress", console.log)
-     *    stream.on("answer", console.log)
-     *    stream.on("busy", console.log)
-     * }
-     */
-    async dial(destination, options) {
-        return await new dial_1.default(this.request).run(destination, options);
-    }
-    /**
-     * Returns a PlaybackControl control object.
-     *
-     * @param {string} playbackId - Playback identifier to use in Playback operations
-     * @see Play
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.onDtmfReceived(async(digit) => {
-     *      const control = response.playback("1234")
-     *      digit === "3"
-     *        ? await control.restart()
-     *        : await control.forward()
-     *   })
-     *
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav", {
-     *      playbackId: "1234"
-     *   });
-     * }
-     */
-    playback(playbackId) {
-        return new playback_1.PlaybackControl(this.request, playbackId);
-    }
-    /**
-     * Listens event publication.
-     *
-     * @param {Function} handler - Event handler
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   response.on("DtmfReceived", async(digit) => {
-     *      const control = response.playback("1234")
-     *      digit === "3"
-     *        ? await control.restart()
-     *        : await control.forward()
-     *   })
-     *
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav", {
-     *      playbackId: "1234"
-     *   });
-     * }
-     */
-    async on(topic, handler) {
-        pubsub_js_1.default.subscribe(`${topic}.${this.request.sessionId}`, (type, data) => {
-            handler(data);
-        });
-    }
-    /**
-     * Mutes a channel.
-     *
-     * @param {MuteOptions} options - Indicate which direction of he communication to mute
-     * @param {string} options.direction - Possible values are 'in', 'out', and 'both'
-     * @see unmute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.mute();       // Will mute both directions
-     * }
-     */
-    async mute(options) {
-        return new mute_1.default(this.request).run(options);
-    }
-    /**
-     * Unmutes a channel.
-     *
-     * @param {MuteOptions} options - Indicate which direction of he communication to unmute
-     * @param {string} options.direction - Possible values are 'in', 'out', and 'both'
-     * @see mute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   ...
-     *   await response.unmute({direction: "out"});       // Will unmute only the "out" direction
-     * }
-     */
-    async unmute(options) {
-        return new unmute_1.default(this.request).run(options);
-    }
-    /**
-     * Answer the communication channel. Before running any other verb you
-     * must run the anwer command.
-     *
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   ...
-     * }
-     */
-    async answer() {
-        return new answer_1.default(this.request).run();
-    }
-    /**
-     * Terminates the communication channel.
-     *
-     * @example
-     *
-     * async function handler (request, response) {
-     *   ...
-     *   await response.hangup();
-     * }
-     */
-    async hangup() {
-        return new hangup_1.default(this.request).run();
-    }
-    /**
-     * Records the current channel and uploads the file to the storage subsystem.
-     *
-     * @param {RecordOptions} options - optional parameters to alter the command's normal
-     * behavior
-     * @param {number} options.maxDuration - Maximum duration of the recording, in seconds. Use `0` for no limit
-     * @param {number} options.maxSilence - Maximum duration of silence, in seconds. Use `0` for no limit
-     * @param {boolean} options.beep - Play beep when recording begins
-     * @param {string} options.finishOnKey - DTMF input to terminate recording
-     * @return {Promise<RecordResult>} Returns useful information such as the duration of the recording, etc.
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();;
-     *   const result = await response.record({finishOnKey: "#"});
-     *   console.log("recording result: " + JSON.stringify(result))     // recording result: { duration: 30 ...}
-     * }
-     */
-    async record(options) {
-        return await new record_1.default(this.request).run(options);
-    }
-    // Requests media from Media server
-    async openMediaPipe() {
-        const genericVerb = new verb_1.Verb(this.request);
-        await (0, utils_1.startMediaTransfer)(genericVerb, this.request.sessionId);
-    }
-    // Requests media stop from Media server
-    async closeMediaPipe() {
-        const genericVerb = new verb_1.Verb(this.request);
-        await (0, utils_1.stopMediaTransfer)(genericVerb, this.request.sessionId);
-    }
-}
-exports.default = VoiceResponse;