@fonoster/common 0.5.5 → 0.6.0

package/dist/voice/voice.d.ts

@@ -0,0 +1,101 @@
+import { DialRequest, DialStatus } from "./Dial";
+import { GatherRequest, GatherResponse } from "./Gather";
+import { MuteRequest } from "./Mute";
+import { PlayRequest, PlayResponse } from "./Play";
+import { PlayDtmfRequest } from "./PlayDtmf";
+import { RecordRequest, RecordResponse } from "./Record";
+import { SayRequest, SayResponse } from "./Say";
+import { StartStreamRequest, StartStreamResponse, StopStreamRequest, StreamPayload } from "./Stream";
+import { VerbRequest, VerbResponse, VoiceRequest } from "./Verb";
+import { GRPCError } from "../errors";
+declare const DATA: "data";
+declare const END: "end";
+declare const ERROR: "error";
+declare enum StreamEvent {
+    DATA = "data",
+    END = "end",
+    ERROR = "error"
+}
+declare enum StreamContent {
+    ANSWER_REQUEST = "answerRequest",
+    ANSWER_RESPONSE = "answerResponse",
+    HANGUP_REQUEST = "hangupRequest",
+    HANGUP_RESPONSE = "hangupResponse",
+    PLAY_REQUEST = "playRequest",
+    PLAY_RESPONSE = "playResponse",
+    PLAY_DTMF_REQUEST = "playDtmfRequest",
+    PLAY_DTMF_RESPONSE = "playDtmfResponse",
+    PLAYBACK_CONTROL_REQUEST = "playbackControlRequest",
+    PLAYBACK_CONTROL_RESPONSE = "playbackControlResponse",
+    MUTE_REQUEST = "muteRequest",
+    MUTE_RESPONSE = "muteResponse",
+    UNMUTE_REQUEST = "unmuteRequest",
+    UNMUTE_RESPONSE = "unmuteResponse",
+    GATHER_REQUEST = "gatherRequest",
+    GATHER_RESPONSE = "gatherResponse",
+    SAY_REQUEST = "sayRequest",
+    SAY_RESPONSE = "sayResponse",
+    RECORD_REQUEST = "recordRequest",
+    RECORD_RESPONSE = "recordResponse",
+    DIAL_REQUEST = "dialRequest",
+    DIAL_RESPONSE = "dialResponse",
+    START_STREAM_REQUEST = "startStreamRequest",
+    START_STREAM_RESPONSE = "startStreamResponse",
+    STOP_STREAM_REQUEST = "stopStreamRequest",
+    STREAM_PAYLOAD = "streamPayload"
+}
+type VoiceClientConfig = {
+    appRef: string;
+    accessKeyId: string;
+    appEndpoint: string;
+    ingressNumber: string;
+    callerName: string;
+    callerNumber: string;
+    sessionRef: string;
+    sessionToken: string;
+    metadata?: Record<string, string>;
+};
+type VoiceIn = {
+    request?: VoiceRequest;
+    content?: StreamContent;
+    answerResponse?: VerbResponse;
+    hangupResponse?: VerbResponse;
+    playResponse?: PlayResponse;
+    playDtmfResponse?: VerbResponse;
+    playbackControlResponse?: VerbResponse;
+    muteResponse?: VerbResponse;
+    unmuteResponse?: VerbResponse;
+    gatherResponse?: GatherResponse;
+    sayResponse?: SayResponse;
+    recordResponse?: RecordResponse;
+    dialResponse?: {
+        status: DialStatus;
+    };
+    startStreamResponse?: StartStreamResponse;
+    streamPayload?: StreamPayload;
+};
+type VoiceOut = {
+    answerRequest?: VerbRequest;
+    hangupRequest?: VerbRequest;
+    playRequest?: PlayRequest;
+    playDtmfRequest?: PlayDtmfRequest;
+    playbackControlRequest?: VerbRequest;
+    muteRequest?: MuteRequest;
+    unmuteRequest?: MuteRequest;
+    gatherRequest?: GatherRequest;
+    sayRequest?: SayRequest;
+    recordRequest?: RecordRequest;
+    dialRequest?: DialRequest;
+    startStreamRequest?: StartStreamRequest;
+    stopStreamRequest?: StopStreamRequest;
+    streamPayload?: StreamPayload;
+};
+type BaseVoiceStream<T, W> = {
+    removeListener: (e: StreamEvent, cb: (voice: T) => void) => void;
+    on: (e: StreamEvent, cb: (voice: T) => void) => void;
+    write: (voice: W) => void;
+    end: () => void;
+};
+type VoiceSessionStreamServer = BaseVoiceStream<VoiceIn, VoiceOut>;
+type VoiceSessionStreamClient = BaseVoiceStream<VoiceOut | GRPCError, VoiceIn | GRPCError>;
+export { VoiceClientConfig, VoiceSessionStreamServer, VoiceSessionStreamClient, StreamEvent, StreamContent, VoiceIn, VoiceOut, DATA, END, ERROR };

package/dist/voice/voice.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR = exports.END = exports.DATA = exports.StreamContent = exports.StreamEvent = void 0;
+const DATA = "data";
+exports.DATA = DATA;
+const END = "end";
+exports.END = END;
+const ERROR = "error";
+exports.ERROR = ERROR;
+var StreamEvent;
+(function (StreamEvent) {
+    StreamEvent["DATA"] = "data";
+    StreamEvent["END"] = "end";
+    StreamEvent["ERROR"] = "error";
+})(StreamEvent || (exports.StreamEvent = StreamEvent = {}));
+var StreamContent;
+(function (StreamContent) {
+    StreamContent["ANSWER_REQUEST"] = "answerRequest";
+    StreamContent["ANSWER_RESPONSE"] = "answerResponse";
+    StreamContent["HANGUP_REQUEST"] = "hangupRequest";
+    StreamContent["HANGUP_RESPONSE"] = "hangupResponse";
+    StreamContent["PLAY_REQUEST"] = "playRequest";
+    StreamContent["PLAY_RESPONSE"] = "playResponse";
+    StreamContent["PLAY_DTMF_REQUEST"] = "playDtmfRequest";
+    StreamContent["PLAY_DTMF_RESPONSE"] = "playDtmfResponse";
+    StreamContent["PLAYBACK_CONTROL_REQUEST"] = "playbackControlRequest";
+    StreamContent["PLAYBACK_CONTROL_RESPONSE"] = "playbackControlResponse";
+    StreamContent["MUTE_REQUEST"] = "muteRequest";
+    StreamContent["MUTE_RESPONSE"] = "muteResponse";
+    StreamContent["UNMUTE_REQUEST"] = "unmuteRequest";
+    StreamContent["UNMUTE_RESPONSE"] = "unmuteResponse";
+    StreamContent["GATHER_REQUEST"] = "gatherRequest";
+    StreamContent["GATHER_RESPONSE"] = "gatherResponse";
+    StreamContent["SAY_REQUEST"] = "sayRequest";
+    StreamContent["SAY_RESPONSE"] = "sayResponse";
+    StreamContent["RECORD_REQUEST"] = "recordRequest";
+    StreamContent["RECORD_RESPONSE"] = "recordResponse";
+    StreamContent["DIAL_REQUEST"] = "dialRequest";
+    StreamContent["DIAL_RESPONSE"] = "dialResponse";
+    StreamContent["START_STREAM_REQUEST"] = "startStreamRequest";
+    StreamContent["START_STREAM_RESPONSE"] = "startStreamResponse";
+    StreamContent["STOP_STREAM_REQUEST"] = "stopStreamRequest";
+    StreamContent["STREAM_PAYLOAD"] = "streamPayload";
+})(StreamContent || (exports.StreamContent = StreamContent = {}));

package/package.json

@@ -1,42 +1,45 @@
 {
   "name": "@fonoster/common",
-  "version": "0.5.5",
-  "description": "Common artifacts",
+  "version": "0.6.0",
+  "description": "Common library for Fonoster projects",
+  "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
-  "bugs": {
-    "url": "https://github.com/fonoster/fonoster/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/fonoster/fonoster.git"
-  },
   "license": "MIT",
-  "author": "Pedro Sanders <psanders@fonoster.com>",
   "main": "dist/index",
   "types": "dist/index",
   "directories": {
-    "test": "test",
-    "src": "src"
+    "src": "src",
+    "test": "test"
   },
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
-    "build": "tsc -b tsconfig.json"
+    "build": "tsc -b tsconfig.json",
+    "postbuild": "cp -a src/protos dist && node ../../.scripts/copy-hbs.js",
+    "clean": "rimraf ./dist node_modules tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@fonoster/grpc-health-check": "^3.1.6",
-    "@fonoster/logger": "^0.5.5",
-    "@grpc/grpc-js": "~1.8.21",
-    "@grpc/proto-loader": "^0.7.2",
-    "atob": "^2.1.2",
-    "axios": "^1.6.2",
-    "deepmerge": "^4.2.2",
-    "grpc-interceptors": "github:fonoster/node-grpc-interceptors"
+    "@fonoster/logger": "^0.6.0",
+    "@grpc/grpc-js": "^1.10.6",
+    "@grpc/proto-loader": "^0.7.12",
+    "grpc-health-check": "^2.0.2",
+    "handlebars": "^4.7.8",
+    "nodemailer": "^6.9.13",
+    "zod-validation-error": "^3.3.0"
   },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4a1438d9dedeaf7b2a5b6a50d5e233f994e2b2cf"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fonoster/fonoster.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fonoster/fonoster/issues"
+  },
+  "devDependencies": {
+    "@types/nodemailer": "^6.4.14"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Fonoster Inc
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/api_client.d.ts

@@ -1,27 +0,0 @@
-import { ClientOptions } from "./types";
-import { Metadata } from "@grpc/grpc-js";
-export default class {
-    options: ClientOptions;
-    metadata: Metadata;
-    ServiceClient: any;
-    service: any;
-    /**
-     * Use the Options object to overwrite the service default configuration.
-     * @typedef {ClientOptions} Options
-     * @property {string} endpoint - The endpoint URI to send requests to.
-     * The endpoint should be a string like '{serviceHost}:{servicePort}'.
-     * @property {string} accessKeyId - your Fonoster access key ID.
-     * @property {string} accessKeySecret - your Fonoster secret access key.
-     * @property {string} bucket - The bucket to upload apps and media files.
-     */
-    /**
-     * Constructs a service object.
-     *
-     * @param {Options} options - Overwrite for the service's defaults configuration.
-     */
-    constructor(ServiceClient: any, options: ClientOptions);
-    init(): void;
-    getOptions(): ClientOptions;
-    getService(): any;
-    getMeta(): Metadata;
-}

package/dist/api_client.js

@@ -1,110 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const trust_util_1 = require("./trust_util");
-const grpc_js_1 = require("@grpc/grpc-js");
-const envs_1 = require("./envs");
-const CONFIG_FILE = path.join(require("os").homedir(), ".fonoster", "config");
-const configFileExit = () => fs.existsSync(CONFIG_FILE);
-const getConfigFile = () => JSON.parse(fs.readFileSync(CONFIG_FILE).toString());
-const defaultOptions = {
-    endpoint: envs_1.APISERVER_ENDPOINT || "api.fonoster.io",
-    accessKeyId: envs_1.APISERVER_ACCESS_KEY_ID,
-    accessKeySecret: envs_1.APISERVER_ACCESS_KEY_SECRET
-};
-class default_1 {
-    options;
-    metadata;
-    ServiceClient;
-    service;
-    /**
-     * Use the Options object to overwrite the service default configuration.
-     * @typedef {ClientOptions} Options
-     * @property {string} endpoint - The endpoint URI to send requests to.
-     * The endpoint should be a string like '{serviceHost}:{servicePort}'.
-     * @property {string} accessKeyId - your Fonoster access key ID.
-     * @property {string} accessKeySecret - your Fonoster secret access key.
-     * @property {string} bucket - The bucket to upload apps and media files.
-     */
-    /**
-     * Constructs a service object.
-     *
-     * @param {Options} options - Overwrite for the service's defaults configuration.
-     */
-    constructor(ServiceClient, options) {
-        this.ServiceClient = ServiceClient;
-        this.options = options;
-    }
-    init() {
-        try {
-            if (!this.options && configFileExit()) {
-                this.options = getConfigFile();
-            }
-        }
-        catch (err) {
-            throw new Error(`Malformed config file found at: ${CONFIG_FILE}`);
-        }
-        if (!this.options) {
-            this.options = defaultOptions;
-        }
-        if (!this.options.accessKeyId || !this.options.accessKeySecret) {
-            throw new Error("Not valid credentials found");
-        }
-        this.metadata = new grpc_js_1.Metadata();
-        this.metadata.add("access_key_id", this.options.accessKeyId);
-        this.metadata.add("access_key_secret", this.options.accessKeySecret);
-        this.service = new this.ServiceClient(this.options.endpoint || defaultOptions.endpoint, (0, trust_util_1.getClientCredentials)());
-    }
-    getOptions() {
-        return this.options;
-    }
-    getService() {
-        return this.service;
-    }
-    getMeta() {
-        return this.metadata;
-    }
-}
-exports.default = default_1;

package/dist/env_is_set.d.ts

@@ -1 +0,0 @@
-export default function assertEnvIsSet(name: string): void;

package/dist/envs.d.ts

@@ -1,4 +0,0 @@
-export declare const APISERVER_ENDPOINT: string;
-export declare const APISERVER_ACCESS_KEY_ID: string;
-export declare const APISERVER_ACCESS_KEY_SECRET: string;
-export declare const GRPC_ALLOW_INSECURE: string;

package/dist/healthcheck.d.ts

@@ -1,2 +0,0 @@
-declare const _default: () => Promise<void>;
-export default _default;

package/dist/service_runner.d.ts

@@ -1,13 +0,0 @@
-interface ServiceInf {
-    name: string;
-    version: string;
-    service: any;
-    server: any;
-}
-interface Middleware {
-    name: string;
-    description?: string;
-    middlewareObj: any;
-}
-export default function run(srvInfList: ServiceInf[], middlewareList?: Middleware[]): void;
-export {};

package/dist/speech/plugin.d.ts

@@ -1,6 +0,0 @@
-export declare abstract class Plugin {
-    type: string;
-    name: string;
-    constructor(type: string, name: string);
-    getType(): string;
-}

package/dist/speech/types.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="node" />
-import { Stream } from "stream";
-export interface SpeechProvider {
-    createSpeechTracker(options: unknown): SpeechTracker;
-}
-export interface SpeechTracker {
-    transcribe(stream: Stream): Promise<SpeechResult>;
-    streamTranscribe(stream: Stream): StreamSpeechResult;
-}
-export interface SpeechResult {
-    transcript: string;
-    isFinal: boolean;
-}
-export interface StreamSpeechResult {
-    on(events: string, callback: Function): void;
-    close: Function;
-}

package/dist/trust_util.d.ts

@@ -1,4 +0,0 @@
-import * as grpc from "@grpc/grpc-js";
-declare const getServerCredentials: () => grpc.ServerCredentials;
-declare const getClientCredentials: () => grpc.ChannelCredentials;
-export { getClientCredentials, getServerCredentials };

package/dist/types.d.ts

@@ -1,6 +0,0 @@
-export interface ClientOptions {
-    endpoint?: string;
-    bucket?: string;
-    accessKeyId?: string;
-    accessKeySecret?: string;
-}