@fonoster/common 0.5.5 → 0.6.0

package/dist/{trust_util.js → utils/getServerCredentials.js}

@@ -22,13 +22,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.getServerCredentials = exports.getClientCredentials = void 0;
+exports.getServerCredentials = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -45,41 +51,31 @@ exports.getServerCredentials = exports.getClientCredentials = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const grpc = __importStar(require("@grpc/grpc-js"));
-const os = __importStar(require("os"));
 const fs = __importStar(require("fs"));
 const logger_1 = require("@fonoster/logger");
-const path_1 = __importDefault(require("path"));
-const atob_1 = __importDefault(require("atob"));
-const envs_1 = require("./envs");
-const prepCert = (cert) => Buffer.from((0, atob_1.default)(cert), "utf-8");
+const grpc = __importStar(require("@grpc/grpc-js"));
 const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
-let config = {};
-try {
-    config = JSON.parse(fs
-        .readFileSync(path_1.default.join(os.homedir(), ".fonoster", "config"))
-        .toString("utf-8"));
-}
-catch (e) {
-    logger.verbose("no config found at " + path_1.default.join(os.homedir(), ".fonoster", "config"));
-}
-const getServerCredentials = () => {
-    try {
-        return grpc.ServerCredentials.createSsl(prepCert(config.caCertificate), [
-            {
-                cert_chain: prepCert(config.serverCertificate),
-                private_key: prepCert(config.serverKey)
-            }
-        ], true);
-    }
-    catch (e) {
-        logger.info("unable to load security certificates");
-        logger.info("starting server in insecure mode");
+function getServerCredentials(config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { tlsOn, verifyClientCert, caCert, serverCert, serverKey } = config;
+        logger.verbose("get server credentials", {
+            tlsOn,
+            verifyClientCert,
+            caCert,
+            serverCert,
+            serverKey
+        });
+        if (tlsOn) {
+            // TODO: Assert that all the required fields are present
+            const cacert = verifyClientCert ? fs.readFileSync(caCert) : null;
+            return grpc.ServerCredentials.createSsl(cacert, [
+                {
+                    private_key: yield fs.promises.readFile(serverKey),
+                    cert_chain: yield fs.promises.readFile(serverCert)
+                }
+            ]);
+        }
         return grpc.ServerCredentials.createInsecure();
-    }
-};
+    });
+}
 exports.getServerCredentials = getServerCredentials;
-const getClientCredentials = () => envs_1.GRPC_ALLOW_INSECURE === "true"
-    ? grpc.credentials.createInsecure()
-    : grpc.credentials.createSsl();
-exports.getClientCredentials = getClientCredentials;

package/dist/utils/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./assertEnvsAreSet";
+export * from "./assertFileExists";
+export * from "./createService";
+export * from "./createInterceptingCall";
+export * from "./datesMapper";
+export * from "./getServerCredentials";
+export * from "./toPascalCase";
+export * from "./toCamelCase";

package/dist/utils/index.js

@@ -0,0 +1,42 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * 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.
+ */
+__exportStar(require("./assertEnvsAreSet"), exports);
+__exportStar(require("./assertFileExists"), exports);
+__exportStar(require("./createService"), exports);
+__exportStar(require("./createInterceptingCall"), exports);
+__exportStar(require("./datesMapper"), exports);
+__exportStar(require("./getServerCredentials"), exports);
+__exportStar(require("./toPascalCase"), exports);
+__exportStar(require("./toCamelCase"), exports);

package/dist/utils/toCamelCase.d.ts

@@ -0,0 +1,2 @@
+declare function toCamelCase(str: string): string;
+export { toCamelCase };

package/dist/utils/toCamelCase.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCamelCase = 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 toPascalCase_1 = require("./toPascalCase");
+function toCamelCase(str) {
+    const pascalCase = (0, toPascalCase_1.toPascalCase)(str);
+    return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
+}
+exports.toCamelCase = toCamelCase;

package/dist/utils/toPascalCase.d.ts

@@ -0,0 +1,2 @@
+declare function toPascalCase(str: string): string;
+export { toPascalCase };

package/dist/{speech/plugin.js → utils/toPascalCase.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Plugin = void 0;
+exports.toPascalCase = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -19,15 +19,11 @@ exports.Plugin = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-class Plugin {
-    type;
-    name;
-    constructor(type, name) {
-        this.name = name;
-        this.type = type;
-    }
-    getType() {
-        return this.type;
-    }
+function toPascalCase(str) {
+    return str
+        .replace(/(?:^\w|[A-Z]|\b\w)/g, (word) => {
+        return word.toUpperCase();
+    })
+        .replace(/\s+/g, "");
 }
-exports.Plugin = Plugin;
+exports.toPascalCase = toPascalCase;

package/dist/voice/Dial.d.ts

@@ -0,0 +1,23 @@
+import { VerbRequest } from "./Verb";
+declare enum DialRecordDirection {
+    IN = "IN",
+    OUT = "OUT",
+    BOTH = "BOTH"
+}
+declare enum DialStatus {
+    TRYING = "TRYING",
+    CANCEL = "CANCEL",
+    ANSWER = "ANSWER",
+    BUSY = "BUSY",
+    PROGRESS = "PROGRESS",
+    NOANSWER = "NOANSWER",
+    FAILED = "FAILED"
+}
+type DialOptions = {
+    timeout?: number;
+    recordDirection?: DialRecordDirection;
+};
+type DialRequest = VerbRequest & DialOptions & {
+    destination: string;
+};
+export { DialRequest, DialOptions, DialStatus, DialRecordDirection };

package/dist/voice/Dial.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialRecordDirection = exports.DialStatus = void 0;
+var DialRecordDirection;
+(function (DialRecordDirection) {
+    DialRecordDirection["IN"] = "IN";
+    DialRecordDirection["OUT"] = "OUT";
+    DialRecordDirection["BOTH"] = "BOTH";
+})(DialRecordDirection || (exports.DialRecordDirection = DialRecordDirection = {}));
+var DialStatus;
+(function (DialStatus) {
+    DialStatus["TRYING"] = "TRYING";
+    DialStatus["CANCEL"] = "CANCEL";
+    DialStatus["ANSWER"] = "ANSWER";
+    DialStatus["BUSY"] = "BUSY";
+    DialStatus["PROGRESS"] = "PROGRESS";
+    DialStatus["NOANSWER"] = "NOANSWER";
+    DialStatus["FAILED"] = "FAILED";
+})(DialStatus || (exports.DialStatus = DialStatus = {}));

package/dist/voice/Gather.d.ts

@@ -0,0 +1,18 @@
+import { VerbRequest, VerbResponse } from "./Verb";
+declare enum GatherSource {
+    SPEECH = "speech",
+    DTMF = "dtmf",
+    SPEECH_AND_DTMF = "speech,dtmf"
+}
+type GatherOptions = {
+    finishOnKey?: string;
+    maxDigits?: number;
+    timeout?: number;
+    source?: GatherSource;
+};
+type GatherRequest = VerbRequest & GatherOptions;
+type GatherResponse = VerbResponse & {
+    speech?: string;
+    digits?: string;
+};
+export { GatherOptions, GatherRequest, GatherResponse, GatherSource };

package/dist/voice/Gather.js

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

package/dist/voice/Mute.d.ts

@@ -0,0 +1,13 @@
+import { VerbRequest } from "./Verb";
+type MuteOptions = {
+    direction?: MuteDirection;
+};
+declare enum MuteDirection {
+    IN = "IN",
+    OUT = "OUT",
+    BOTH = "BOTH"
+}
+type MuteRequest = VerbRequest & {
+    direction: MuteDirection;
+};
+export { MuteOptions, MuteRequest, MuteDirection };

package/dist/voice/Mute.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MuteDirection = void 0;
+var MuteDirection;
+(function (MuteDirection) {
+    MuteDirection["IN"] = "IN";
+    MuteDirection["OUT"] = "OUT";
+    MuteDirection["BOTH"] = "BOTH";
+})(MuteDirection || (exports.MuteDirection = MuteDirection = {}));

package/dist/voice/Play.d.ts

@@ -0,0 +1,12 @@
+import { VerbRequest } from "./Verb";
+type PlayOptions = {
+    playbackRef?: string;
+};
+type PlayRequest = VerbRequest & {
+    url: string;
+} & PlayOptions;
+type PlayResponse = {
+    sessionRef: string;
+    playbackRef: string;
+};
+export { PlayRequest, PlayResponse, PlayOptions };

package/dist/voice/PlayDtmf.d.ts

@@ -0,0 +1,5 @@
+import { VerbRequest } from "./Verb";
+type PlayDtmfRequest = VerbRequest & {
+    digits: string;
+};
+export { PlayDtmfRequest };

package/dist/voice/PlaybackControl.d.ts

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

package/dist/voice/PlaybackControl.js

@@ -0,0 +1,11 @@
+"use strict";
+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 || (exports.PlaybackControlAction = PlaybackControlAction = {}));

package/dist/voice/Record.d.ts

@@ -0,0 +1,18 @@
+import { VerbRequest } from "./Verb";
+declare enum RecordFormat {
+    WAV = "wav"
+}
+type RecordOptions = {
+    maxDuration?: number;
+    maxSilence?: number;
+    beep?: boolean;
+    finishOnKey?: string;
+};
+type RecordRequest = VerbRequest & RecordOptions;
+type RecordResponse = {
+    sessionRef: string;
+    name: string;
+    duration: number;
+    format: RecordFormat;
+};
+export { RecordOptions, RecordRequest, RecordResponse, RecordFormat };

package/dist/voice/Record.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordFormat = void 0;
+var RecordFormat;
+(function (RecordFormat) {
+    RecordFormat["WAV"] = "wav";
+})(RecordFormat || (exports.RecordFormat = RecordFormat = {}));

package/dist/voice/Say.d.ts

@@ -0,0 +1,15 @@
+import { Struct } from "pb-util";
+import { VerbRequest } from "./Verb";
+type SayRequest = VerbRequest & {
+    text: string;
+    playbackRef?: string;
+    options?: Struct;
+};
+type SayResponse = {
+    playbackRef: string;
+};
+type SayOptions = {
+    playbackRef?: string;
+    [key: string]: any;
+};
+export { SayRequest, SayResponse, SayOptions };

package/dist/voice/Say.js

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

package/dist/voice/Stream.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+import { VerbRequest, VerbResponse } from "./Verb";
+declare enum StreamDirection {
+    IN = "IN",
+    OUT = "OUT",
+    BOTH = "BOTH"
+}
+declare enum StreamAudioFormat {
+    WAV = "WAV"
+}
+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"
+}
+type StreamOptions = {
+    direction: StreamDirection;
+    format: StreamAudioFormat;
+    enableVad: boolean;
+};
+type StartStreamRequest = VerbRequest & StreamOptions;
+type StartStreamResponse = VerbResponse & {
+    streamRef: string;
+};
+type StopStreamRequest = VerbRequest & {
+    streamRef: string;
+};
+type StreamPayload = {
+    sessionRef: string;
+    streamRef: string;
+    direction: StreamDirection;
+    format: StreamAudioFormat;
+    type: StreamMessageType;
+    enableVad?: boolean;
+    data?: Buffer;
+    code?: string;
+    message?: string;
+};
+export { StreamDirection, StreamAudioFormat, StreamMessageType, StreamOptions, StartStreamRequest, StartStreamResponse, StopStreamRequest, StreamPayload };

package/dist/voice/Stream.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamMessageType = exports.StreamAudioFormat = exports.StreamDirection = 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.
+ */
+var StreamDirection;
+(function (StreamDirection) {
+    StreamDirection["IN"] = "IN";
+    StreamDirection["OUT"] = "OUT";
+    StreamDirection["BOTH"] = "BOTH";
+})(StreamDirection || (exports.StreamDirection = StreamDirection = {}));
+var StreamAudioFormat;
+(function (StreamAudioFormat) {
+    StreamAudioFormat["WAV"] = "WAV";
+})(StreamAudioFormat || (exports.StreamAudioFormat = StreamAudioFormat = {}));
+var StreamMessageType;
+(function (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/Verb.d.ts

@@ -0,0 +1,9 @@
+import { VoiceClientConfig } from "./voice";
+type VoiceRequest = VoiceClientConfig;
+type VerbRequest = {
+    sessionRef: string;
+};
+type VerbResponse = {
+    sessionRef: string;
+};
+export { VerbRequest, VerbResponse, VoiceRequest };

package/dist/{healthcheck.js → voice/Verb.js}

@@ -1,7 +1,6 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -18,6 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/* eslint-disable require-jsdoc */
-const grpc_health_check_1 = require("@fonoster/grpc-health-check");
-exports.default = async () => (0, grpc_health_check_1.checker)("", `localhost:50052`);
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/voice/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./voice";
+export * from "./Dial";
+export * from "./Gather";
+export * from "./Verb";
+export * from "./Mute";
+export * from "./Play";
+export * from "./PlaybackControl";
+export * from "./PlayDtmf";
+export * from "./Record";
+export * from "./Say";
+export * from "./Stream";

package/dist/voice/index.js

@@ -0,0 +1,45 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * 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.
+ */
+__exportStar(require("./voice"), exports);
+__exportStar(require("./Dial"), exports);
+__exportStar(require("./Gather"), exports);
+__exportStar(require("./Verb"), exports);
+__exportStar(require("./Mute"), exports);
+__exportStar(require("./Play"), exports);
+__exportStar(require("./PlaybackControl"), exports);
+__exportStar(require("./PlayDtmf"), exports);
+__exportStar(require("./Record"), exports);
+__exportStar(require("./Say"), exports);
+__exportStar(require("./Stream"), exports);