@fonoster/common 0.6.6 → 0.7.2

package/dist/protos/applications.proto

@@ -39,7 +39,7 @@ service Applications {
 // The type of application
 enum ApplicationType {
   // Programmable Voice
-  PROGRAMMABLE_VOICE = 0;
+  EXTERNAL = 0;
 }
 
 message ProductContainer {
@@ -60,7 +60,7 @@ message Application {
   // Application type
   ApplicationType type = 3;
   // Endpoint for programmable voice
-  string app_endpoint = 4;
+  string endpoint = 4;
   // Text to speech product
   ProductContainer text_to_speech = 5;
   // Speech to text product
@@ -80,7 +80,7 @@ message CreateApplicationRequest {
   // Application type
   ApplicationType type = 2;
   // App URL for programmable voice
-  string app_endpoint = 3;
+  string endpoint = 3;
   // Text to speech product
   ProductContainer text_to_speech = 4;
   // Speech to text product
@@ -126,7 +126,7 @@ message UpdateApplicationRequest {
   // Application type
   ApplicationType type = 3;
   // App URL for programmable voice
-  string app_endpoint = 4;
+  string endpoint = 4;
   // Text to speech product
   ProductContainer text_to_speech = 5;
   // Speech to text product

package/dist/protos/calls.proto

@@ -33,55 +33,40 @@ service Calls {
 }
 
 enum CallType {
-  PROGRAMMABLE = 0;
-  SIP_TRUNKING = 1;
-}
-
-enum HangupCause {
-  NORMAL_CLEARING = 0;
-  CALL_REJECTED = 1;
-  UNALLOCATED = 2;
-  NO_USER_RESPONSE = 3;
-  NO_ROUTE_DESTINATION = 4;
-  NO_ANSWER = 5;
-  USER_BUSY = 6;
-  NOT_ACCEPTABLE_HERE = 7;
-  SERVICE_UNAVAILABLE = 8;
-  INVALID_NUMBER_FORMAT = 9;
-  UNKNOWN = 10;
+  SIP_ORIGINATED = 0;
+  API_ORIGINATED = 1;
 }
 
 enum CallStatus {
-  QUEUED = 0;
-  RINGING = 1;
-  IN_PROGRESS = 2;
-  COMPLETED = 3;
-  FAILED = 4;
-  BUSY = 5;
-  // TODO: Refactor to avoid clash with HangupCause
-  // NO_ANSWER = 6;
-  CANCELED = 7;
-  REJECTED = 8;
-  TIMEOUT = 9;
-  // TODO: Refactor to avoid clash with HangupCause
-  // UNKNOWN = 10;
+  UNKNOWN = 0;
+  NORMAL_CLEARING = 1;
+  CALL_REJECTED = 2;
+  UNALLOCATED = 3;
+  NO_USER_RESPONSE = 4;
+  NO_ROUTE_DESTINATION = 5;
+  NO_ANSWER = 6;
+  USER_BUSY = 7;
+  NOT_ACCEPTABLE_HERE = 8;
+  SERVICE_UNAVAILABLE = 9;
+  INVALID_NUMBER_FORMAT = 10;
 }
 
 enum CallDirection {
-  INBOUND = 0;
-  OUTBOUND = 1;
+  FROM_PSTN = 0;
+  TO_PSTN = 1;
+  INTRA_NETWORK = 2;
 }
 
 // Message for a Call Detail Record
 message CallDetailRecord {
   // The unique identifier of the Call
   string ref = 1;
+  // Call identifier from the SIP stack
+  string call_id = 2;
   // The call type
-  CallType type = 2;
+  CallType type = 3;
   // The call status
-  CallStatus status = 3;
-  // Hangup cause
-  HangupCause hangup_cause = 4;
+  CallStatus status = 4;
   // Start time of the call
   int32 started_at = 5;
   // End time of the call
@@ -104,6 +89,8 @@ message CreateCallRequest {
   string to = 2;
   // Optional application reference
   string app_ref = 3;
+  // Optional timeout in seconds
+  int32 timeout = 4;
 }
 
 // The response message for Calls.Call
@@ -154,8 +141,16 @@ message TrackCallRequest {
 
 // The response message for Calls.TrackCall
 message TrackCallResponse {
-  // The reference of the call
-  string ref = 1;
-  // The call status
-  CallStatus status = 2;
+  // The status of the dial
+  enum Status {
+    TRYING = 0;
+    CANCEL = 1;
+    ANSWER = 2;
+    BUSY = 3;
+    PROGRESS = 4;
+    NOANSWER = 5;
+    // Maps from Asterisk's CHANUNAVAIL and CONGESTION
+    FAILED = 6;
+  }
+  Status status = 1;
 }

package/dist/protos/voice.proto

@@ -250,6 +250,7 @@ message DialStatus {
     BUSY = 3;
     PROGRESS = 4;
     NOANSWER = 5;
+    // Maps from Asterisk's CHANUNAVAIL and CONGESTION
     FAILED = 6;
   }
   Status status = 2;
@@ -273,9 +274,6 @@ message StartStreamRequest {
     WAV = 0;
   }
   StreamAudioFormat format = 3;
-
-  // Enable VAD (Voice Activity Detection)
-  bool enableVad = 4;
 }
 
 // Response to a start stream request
@@ -309,8 +307,6 @@ message StreamPayload {
     AUDIO_IN = 0;
     AUDIO_OUT = 1;
     ERROR = 2;
-    VOICE_ACTIVITY_START = 3;
-    VOICE_ACTIVITY_END = 4;
   }
   StreamMessageType type = 3;
 
@@ -326,6 +322,38 @@ message StreamPayload {
   string message = 6;
 }
 
+// Request for Stream Gather
+message StartStreamGatherRequest {
+  // The session reference generated by the Media Server
+  string session_ref = 1;
+
+  // The source of the gather
+  enum StreamGatherSource {
+    SPEECH = 0;
+    DTMF = 1;
+    SPEECH_AND_DTMF = 2;
+  }
+  StreamGatherSource source = 2;
+}
+
+// Request to stop a Stream Gather
+message StopStreamGatherRequest {
+  // The session reference generated by the Media Server
+  string session_ref = 1;
+}
+
+// Response to Stream Gather request
+message StreamGatherPayload {
+  // The session reference generated by the Media Server
+  string session_ref = 1;
+
+  // The gathered speech or a single digit
+  oneof content {
+    string speech = 2;
+    string digit = 3;
+  }
+}
+
 // VoiceInStream is the input stream for the voice service
 message VoiceInStream {
   oneof content {
@@ -369,7 +397,16 @@ message VoiceInStream {
     StartStreamResponse start_stream_response = 13;
 
     // Message for the bidirectional streams
-    StreamPayload stream_payload = 154;
+    StreamPayload stream_payload = 14;
+
+    // Response to start a stream gather
+    VerbResponse start_stream_gather_response = 15;
+
+    // Response to stop a stream gather
+    VerbResponse stop_stream_gather_response = 16;
+
+    // Message with payload for the stream gather
+    StreamGatherPayload stream_gather_payload = 17;
   }
 }
 
@@ -417,5 +454,11 @@ message VoiceOutStream {
 
     // Message for the bidirectional streams
     StreamPayload stream_payload = 16;
+
+    // Request to start a stream gather
+    StartStreamGatherRequest start_stream_gather_request = 17;
+
+    // Request to stop a stream gather
+    StopStreamGatherRequest stop_stream_gather_request = 18;
   }
 }

package/dist/tts/DeepgramVoices.d.ts

@@ -0,0 +1,22 @@
+import { VoiceGender, VoiceLanguage } from "./types";
+declare enum DeepgramVoice {
+    AURA_ASTERIA_EN = "aura-asteria-en",
+    AURA_LUNA_EN = "aura-luna-en",
+    AURA_STELLA_EN = "aura-stella-en",
+    AURA_ATHENA_EN = "aura-athena-en",
+    AURA_HERA_EN = "aura-hera-en",
+    AURA_ORION_EN = "aura-orion-en",
+    AURA_ARCAS_EN = "aura-arcas-en",
+    AURA_PERSEUS_EN = "aura-perseus-en",
+    AURA_ANGUS_EN = "aura-angus-en",
+    AURA_ORPHEUS_EN = "aura-orpheus-en",
+    AURA_HELIOS_EN = "aura-helios-en",
+    AURA_ZEUS_EN = "aura-zeus-en"
+}
+declare const DeepgramVoiceDetails: {
+    name: DeepgramVoice;
+    displayName: string;
+    languageCode: VoiceLanguage;
+    gender: VoiceGender;
+}[];
+export { DeepgramVoice, DeepgramVoiceDetails };

package/dist/tts/DeepgramVoices.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeepgramVoiceDetails = exports.DeepgramVoice = void 0;
+/* eslint-disable sonarjs/no-duplicate-string */
+/*
+ * 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 types_1 = require("./types");
+var DeepgramVoice;
+(function (DeepgramVoice) {
+    DeepgramVoice["AURA_ASTERIA_EN"] = "aura-asteria-en";
+    DeepgramVoice["AURA_LUNA_EN"] = "aura-luna-en";
+    DeepgramVoice["AURA_STELLA_EN"] = "aura-stella-en";
+    DeepgramVoice["AURA_ATHENA_EN"] = "aura-athena-en";
+    DeepgramVoice["AURA_HERA_EN"] = "aura-hera-en";
+    DeepgramVoice["AURA_ORION_EN"] = "aura-orion-en";
+    DeepgramVoice["AURA_ARCAS_EN"] = "aura-arcas-en";
+    DeepgramVoice["AURA_PERSEUS_EN"] = "aura-perseus-en";
+    DeepgramVoice["AURA_ANGUS_EN"] = "aura-angus-en";
+    DeepgramVoice["AURA_ORPHEUS_EN"] = "aura-orpheus-en";
+    DeepgramVoice["AURA_HELIOS_EN"] = "aura-helios-en";
+    DeepgramVoice["AURA_ZEUS_EN"] = "aura-zeus-en";
+})(DeepgramVoice || (exports.DeepgramVoice = DeepgramVoice = {}));
+const DeepgramVoiceDetails = [
+    {
+        name: DeepgramVoice.AURA_ASTERIA_EN,
+        displayName: "Asteria",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.FEMALE
+    },
+    {
+        name: DeepgramVoice.AURA_LUNA_EN,
+        displayName: "Luna",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.FEMALE
+    },
+    {
+        name: DeepgramVoice.AURA_STELLA_EN,
+        displayName: "Stella",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.FEMALE
+    },
+    {
+        name: DeepgramVoice.AURA_ATHENA_EN,
+        displayName: "Athena",
+        languageCode: types_1.VoiceLanguage.EN_GB,
+        gender: types_1.VoiceGender.FEMALE
+    },
+    {
+        name: DeepgramVoice.AURA_HERA_EN,
+        displayName: "Hera",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.FEMALE
+    },
+    {
+        name: DeepgramVoice.AURA_ORION_EN,
+        displayName: "Orion",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_ARCAS_EN,
+        displayName: "Arcas",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_PERSEUS_EN,
+        displayName: "Perseus",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_ANGUS_EN,
+        displayName: "Angus",
+        languageCode: types_1.VoiceLanguage.EN_IE,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_ORPHEUS_EN,
+        displayName: "Orpheus",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_HELIOS_EN,
+        displayName: "Helios",
+        languageCode: types_1.VoiceLanguage.EN_GB,
+        gender: types_1.VoiceGender.MALE
+    },
+    {
+        name: DeepgramVoice.AURA_ZEUS_EN,
+        displayName: "Zeus",
+        languageCode: types_1.VoiceLanguage.EN_US,
+        gender: types_1.VoiceGender.MALE
+    }
+];
+exports.DeepgramVoiceDetails = DeepgramVoiceDetails;

package/dist/tts/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./GoogleVoices";
 export * from "./AzureVoices";
+export * from "./DeepgramVoices";
 export * from "./types";

package/dist/tts/index.js

@@ -34,4 +34,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./GoogleVoices"), exports);
 __exportStar(require("./AzureVoices"), exports);
+__exportStar(require("./DeepgramVoices"), exports);
 __exportStar(require("./types"), exports);

package/dist/voice/Dial.js

@@ -15,5 +15,6 @@ var DialStatus;
     DialStatus["BUSY"] = "BUSY";
     DialStatus["PROGRESS"] = "PROGRESS";
     DialStatus["NOANSWER"] = "NOANSWER";
+    // Maps from Asterisk's CHANUNAVAIL and CONGESTION
     DialStatus["FAILED"] = "FAILED";
 })(DialStatus || (exports.DialStatus = DialStatus = {}));

package/dist/voice/PlaybackControl.d.ts

@@ -1,10 +1,10 @@
 import { VerbRequest } from "./Verb";
 declare enum PlaybackControlAction {
-    STOP = "stop",
-    RESTART = "restart",
-    PAUSE = "pause",
-    UNPAUSE = "unpause",
-    FORWARD = "forward"
+    STOP = "STOP",
+    RESTART = "RESTART",
+    PAUSE = "PAUSE",
+    UNPAUSE = "UNPAUSE",
+    FORWARD = "FORWARD"
 }
 type PlaybackControlRequest = VerbRequest & {
     playbackRef: string;

package/dist/voice/PlaybackControl.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaybackControlAction = void 0;
 var PlaybackControlAction;
 (function (PlaybackControlAction) {
-    PlaybackControlAction["STOP"] = "stop";
-    PlaybackControlAction["RESTART"] = "restart";
-    PlaybackControlAction["PAUSE"] = "pause";
-    PlaybackControlAction["UNPAUSE"] = "unpause";
-    PlaybackControlAction["FORWARD"] = "forward";
+    PlaybackControlAction["STOP"] = "STOP";
+    PlaybackControlAction["RESTART"] = "RESTART";
+    PlaybackControlAction["PAUSE"] = "PAUSE";
+    PlaybackControlAction["UNPAUSE"] = "UNPAUSE";
+    PlaybackControlAction["FORWARD"] = "FORWARD";
 })(PlaybackControlAction || (exports.PlaybackControlAction = PlaybackControlAction = {}));

package/dist/voice/Stream.d.ts

@@ -10,14 +10,11 @@ declare enum StreamAudioFormat {
 declare enum StreamMessageType {
     AUDIO_IN = "AUDIO_IN",
     AUDIO_OUT = "AUDIO_OUT",
-    ERROR = "ERROR",
-    VOICE_ACTIVITY_START = "VOICE_ACTIVITY_START",
-    VOICE_ACTIVITY_STOP = "VOICE_ACTIVITY_STOP"
+    ERROR = "ERROR"
 }
 type StreamOptions = {
-    direction: StreamDirection;
-    format: StreamAudioFormat;
-    enableVad: boolean;
+    direction?: StreamDirection;
+    format?: StreamAudioFormat;
 };
 type StartStreamRequest = VerbRequest & StreamOptions;
 type StartStreamResponse = VerbResponse & {
@@ -29,10 +26,8 @@ type StopStreamRequest = VerbRequest & {
 type StreamPayload = {
     sessionRef: string;
     streamRef: string;
-    direction: StreamDirection;
     format: StreamAudioFormat;
     type: StreamMessageType;
-    enableVad?: boolean;
     data?: Buffer;
     code?: string;
     message?: string;

package/dist/voice/Stream.js

@@ -34,6 +34,4 @@ var StreamMessageType;
     StreamMessageType["AUDIO_IN"] = "AUDIO_IN";
     StreamMessageType["AUDIO_OUT"] = "AUDIO_OUT";
     StreamMessageType["ERROR"] = "ERROR";
-    StreamMessageType["VOICE_ACTIVITY_START"] = "VOICE_ACTIVITY_START";
-    StreamMessageType["VOICE_ACTIVITY_STOP"] = "VOICE_ACTIVITY_STOP";
 })(StreamMessageType || (exports.StreamMessageType = StreamMessageType = {}));

package/dist/voice/StreamGather.d.ts

@@ -0,0 +1,15 @@
+import { VerbRequest, VerbResponse } from "./Verb";
+declare enum StreamGatherSource {
+    SPEECH = "speech",
+    DTMF = "dtmf",
+    SPEECH_AND_DTMF = "speech,dtmf"
+}
+type StreamGatherOptions = {
+    source?: StreamGatherSource;
+};
+type StartStreamGatherRequest = VerbRequest & StreamGatherOptions;
+type StreamGatherPayload = VerbResponse & {
+    speech?: string;
+    digit?: string;
+};
+export { StreamGatherSource, StreamGatherPayload, StartStreamGatherRequest, StreamGatherOptions };

package/dist/voice/StreamGather.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamGatherSource = void 0;
+var StreamGatherSource;
+(function (StreamGatherSource) {
+    StreamGatherSource["SPEECH"] = "speech";
+    StreamGatherSource["DTMF"] = "dtmf";
+    StreamGatherSource["SPEECH_AND_DTMF"] = "speech,dtmf";
+})(StreamGatherSource || (exports.StreamGatherSource = StreamGatherSource = {}));

package/dist/voice/index.d.ts

@@ -9,3 +9,4 @@ export * from "./PlayDtmf";
 export * from "./Record";
 export * from "./Say";
 export * from "./Stream";
+export * from "./StreamGather";

package/dist/voice/index.js

@@ -43,3 +43,4 @@ __exportStar(require("./PlayDtmf"), exports);
 __exportStar(require("./Record"), exports);
 __exportStar(require("./Say"), exports);
 __exportStar(require("./Stream"), exports);
+__exportStar(require("./StreamGather"), exports);

package/dist/voice/voice.d.ts

@@ -6,11 +6,12 @@ import { PlayDtmfRequest } from "./PlayDtmf";
 import { RecordRequest, RecordResponse } from "./Record";
 import { SayRequest, SayResponse } from "./Say";
 import { StartStreamRequest, StartStreamResponse, StopStreamRequest, StreamPayload } from "./Stream";
+import { StartStreamGatherRequest, StreamGatherPayload } from "./StreamGather";
 import { VerbRequest, VerbResponse, VoiceRequest } from "./Verb";
 import { GrpcError } from "../GrpcError";
-declare const DATA: "data";
-declare const END: "end";
-declare const ERROR: "error";
+declare const DATA = "data";
+declare const END = "end";
+declare const ERROR = "error";
 declare enum StreamEvent {
     DATA = "data",
     END = "end",
@@ -42,12 +43,18 @@ declare enum StreamContent {
     START_STREAM_REQUEST = "startStreamRequest",
     START_STREAM_RESPONSE = "startStreamResponse",
     STOP_STREAM_REQUEST = "stopStreamRequest",
-    STREAM_PAYLOAD = "streamPayload"
+    STOP_STREAM_RESPONSE = "stopStreamResponse",
+    STREAM_PAYLOAD = "streamPayload",
+    START_STREAM_GATHER_REQUEST = "startStreamGatherRequest",
+    START_STREAM_GATHER_RESPONSE = "startStreamGatherResponse",
+    STOP_STREAM_GATHER_REQUEST = "stopStreamGatherRequest",
+    STOP_STREAM_GATHER_RESPONSE = "stopStreamGatherResponse",
+    STREAM_GATHER_PAYLOAD = "streamGatherPayload"
 }
 type VoiceClientConfig = {
     appRef: string;
     accessKeyId: string;
-    appEndpoint: string;
+    endpoint: string;
     ingressNumber: string;
     callerName: string;
     callerNumber: string;
@@ -73,6 +80,9 @@ type VoiceIn = {
     };
     startStreamResponse?: StartStreamResponse;
     streamPayload?: StreamPayload;
+    streamGatherPayload?: StreamGatherPayload;
+    startStreamGatherResponse?: VerbResponse;
+    stopStreamGatherResponse?: VerbResponse;
 };
 type VoiceOut = {
     answerRequest?: VerbRequest;
@@ -89,10 +99,13 @@ type VoiceOut = {
     startStreamRequest?: StartStreamRequest;
     stopStreamRequest?: StopStreamRequest;
     streamPayload?: StreamPayload;
+    startStreamGatherRequest?: StartStreamGatherRequest;
+    stopStreamGatherRequest?: VerbRequest;
 };
 type BaseVoiceStream<T, W> = {
     removeListener: (e: StreamEvent, cb: (voice: T) => void) => void;
     on: (e: StreamEvent, cb: (voice: T) => void) => void;
+    once: (e: StreamEvent, cb: (voice: T) => void) => void;
     write: (voice: W) => void;
     end: () => void;
 };

package/dist/voice/voice.js

@@ -40,5 +40,11 @@ var StreamContent;
     StreamContent["START_STREAM_REQUEST"] = "startStreamRequest";
     StreamContent["START_STREAM_RESPONSE"] = "startStreamResponse";
     StreamContent["STOP_STREAM_REQUEST"] = "stopStreamRequest";
+    StreamContent["STOP_STREAM_RESPONSE"] = "stopStreamResponse";
     StreamContent["STREAM_PAYLOAD"] = "streamPayload";
+    StreamContent["START_STREAM_GATHER_REQUEST"] = "startStreamGatherRequest";
+    StreamContent["START_STREAM_GATHER_RESPONSE"] = "startStreamGatherResponse";
+    StreamContent["STOP_STREAM_GATHER_REQUEST"] = "stopStreamGatherRequest";
+    StreamContent["STOP_STREAM_GATHER_RESPONSE"] = "stopStreamGatherResponse";
+    StreamContent["STREAM_GATHER_PAYLOAD"] = "streamGatherPayload";
 })(StreamContent || (exports.StreamContent = StreamContent = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/common",
-  "version": "0.6.6",
+  "version": "0.7.2",
   "description": "Common library for Fonoster projects",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -18,7 +18,7 @@
     "clean": "rimraf ./dist node_modules tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@fonoster/logger": "^0.6.2",
+    "@fonoster/logger": "^0.7.2",
     "@grpc/grpc-js": "~1.10.6",
     "@grpc/proto-loader": "^0.7.12",
     "grpc-health-check": "^2.0.2",
@@ -42,5 +42,5 @@
   "devDependencies": {
     "@types/nodemailer": "^6.4.14"
   },
-  "gitHead": "258137711c4897a4bda49de369db1722da17ec3f"
+  "gitHead": "6d858d9920132dfef0dba8965e5005f44de61563"
 }