@routr/pgdata 2.0.8-alpha.17 → 2.0.8-alpha.19

package/dist/mappers/peer.js

@@ -0,0 +1,164 @@
+"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 });
+exports.PeerManager = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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.
+ */
+/* eslint-disable require-jsdoc */
+const Validator = __importStar(require("validator"));
+const common_1 = require("@routr/common");
+const acl_1 = require("./acl");
+const credentials_1 = require("./credentials");
+const manager_1 = require("./manager");
+// Needs testing
+class PeerManager extends manager_1.EntityManager {
+    constructor(peer) {
+        super();
+        this.peer = peer;
+    }
+    static includeFields() {
+        return {
+            accessControlList: true,
+            credentials: true
+        };
+    }
+    validOrThrowCreate() {
+        if (!this.peer.name) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name for the resource is required");
+        }
+        if (!Validator.default.isLength(this.peer.name, { min: 3, max: 64 })) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name must be between 3 and 64 characters");
+        }
+        if (!this.peer.username) {
+            throw new common_1.CommonErrors.BadRequestError("the username is required");
+        }
+        if (!Validator.default.isAlphanumeric(this.peer.username)) {
+            throw new common_1.CommonErrors.BadRequestError("the username must be alphanumeric and without spaces");
+        }
+        if (!this.peer.aor) {
+            throw new common_1.CommonErrors.BadRequestError("the address of record (aor) is required");
+        }
+        // TODO: We will need a better way to validate this so is a valid SIP URI
+        if (!this.peer.aor.startsWith("backend:") &&
+            !this.peer.aor.startsWith("sip:")) {
+            throw new common_1.CommonErrors.BadRequestError("the aor schema must start with `backend:` or `sip:`");
+        }
+        if (this.peer.aor.startsWith("backend:")) {
+            if (!this.peer.balancingAlgorithm) {
+                throw new common_1.CommonErrors.BadRequestError("when the aor schema is `backend:`, the balancing algorithm is required");
+            }
+        }
+        if (this.peer.aor.startsWith("sip:")) {
+            if (this.peer.balancingAlgorithm) {
+                throw new common_1.CommonErrors.BadRequestError("when the aor schema is `sip:`, the balancing algorithm is not allowed");
+            }
+        }
+    }
+    validOrThrowUpdate() {
+        if (!this.peer.ref) {
+            throw new common_1.CommonErrors.BadRequestError("the reference to the resource is required");
+        }
+        if (!this.peer.name) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name for the resource is required");
+        }
+        if (!Validator.default.isLength(this.peer.name, { min: 3, max: 64 })) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name must be between 3 and 64 characters");
+        }
+        if (this.peer.aor) {
+            // TODO: We will need a better way to validate this so is a valid SIP URI
+            if (!this.peer.aor.startsWith("backend:") &&
+                !this.peer.aor.startsWith("sip:")) {
+                throw new common_1.CommonErrors.BadRequestError("the aor schema must start with `backend:` or `sip:`");
+            }
+        }
+        if (this.peer.aor.startsWith("backend:")) {
+            if (!this.peer.balancingAlgorithm) {
+                throw new common_1.CommonErrors.BadRequestError("when the aor schema is `backend:`, the balancing algorithm is required");
+            }
+        }
+        if (this.peer.aor.startsWith("sip:")) {
+            if (this.peer.balancingAlgorithm) {
+                throw new common_1.CommonErrors.BadRequestError("when the aor schema is `sip:`, the balancing algorithm is not allowed");
+            }
+        }
+    }
+    mapToPrisma() {
+        return {
+            // TODO: Set a default value for apiVersion
+            apiVersion: "v2",
+            ref: this.peer.ref,
+            name: this.peer.name,
+            username: this.peer.username,
+            aor: this.peer.aor,
+            contactAddr: this.peer.contactAddr,
+            balancingAlgorithm: this.peer
+                .balancingAlgorithm,
+            withSessionAffinity: this.peer.withSessionAffinity,
+            enabled: this.peer.enabled,
+            credentialsRef: this.peer.credentialsRef,
+            accessControlListRef: this.peer.accessControlListRef,
+            createdAt: this.peer.createdAt,
+            updatedAt: this.peer.updatedAt,
+            extended: this.peer.extended
+        };
+    }
+    static mapToDto(peer) {
+        return {
+            apiVersion: peer.apiVersion,
+            ref: peer.ref,
+            name: peer.name,
+            username: peer.username,
+            aor: peer.aor,
+            contactAddr: peer.contactAddr,
+            balancingAlgorithm: peer.balancingAlgorithm,
+            withSessionAffinity: peer.withSessionAffinity,
+            enabled: peer.enabled,
+            credentialsRef: peer.credentialsRef,
+            credentials: credentials_1.CredentialsManager.mapToDto(peer.credentials),
+            accessControlListRef: peer.accessControlListRef,
+            accessControlList: acl_1.ACLManager.mapToDto(peer.accessControlList),
+            createdAt: peer.createdAt,
+            updatedAt: peer.updatedAt,
+            extended: peer.extended
+        };
+    }
+}
+exports.PeerManager = PeerManager;

package/dist/mappers/trunk.d.ts

@@ -0,0 +1,22 @@
+import { Trunk as TrunkPrismaModel, Prisma } from "@prisma/client";
+import { CommonConnect as CC } from "@routr/common";
+import { JsonObject } from "pb-util/build";
+import { EntityManager } from "./manager";
+type TrunkWithEagerLoading = Prisma.TrunkGetPayload<{
+    include: {
+        accessControlList: true;
+        inboundCredentials: true;
+        outboundCredentials: true;
+        uris: true;
+    };
+}>;
+export declare class TrunkManager extends EntityManager {
+    private trunk;
+    constructor(trunk: CC.Trunk | Omit<CC.Trunk, "uris">);
+    static includeFields(): JsonObject;
+    validOrThrowCreate(): void;
+    validOrThrowUpdate(): void;
+    mapToPrisma(): TrunkPrismaModel;
+    static mapToDto(trunk: TrunkWithEagerLoading): CC.Trunk;
+}
+export {};

package/dist/mappers/trunk.js

@@ -0,0 +1,144 @@
+"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 });
+exports.TrunkManager = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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.
+ */
+/* eslint-disable require-jsdoc */
+const Validator = __importStar(require("validator"));
+const common_1 = require("@routr/common");
+const acl_1 = require("./acl");
+const credentials_1 = require("./credentials");
+const manager_1 = require("./manager");
+// Needs testing
+class TrunkManager extends manager_1.EntityManager {
+    constructor(trunk) {
+        super();
+        this.trunk = trunk;
+    }
+    static includeFields() {
+        return {
+            accessControlList: true,
+            inboundCredentials: true,
+            outboundCredentials: true,
+            uris: true
+        };
+    }
+    validOrThrowCreate() {
+        if (!this.trunk.name) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name for the resource is required");
+        }
+        if (!Validator.default.isLength(this.trunk.name, { min: 3, max: 64 })) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name must be between 3 and 64 characters");
+        }
+        if (!this.trunk.inboundUri) {
+            throw new common_1.CommonErrors.BadRequestError("the inboundUri is required");
+        }
+        if (!Validator.default.isFQDN(this.trunk.inboundUri)) {
+            throw new common_1.CommonErrors.BadRequestError("the inbound URI must be a valid FQDN (e.g. sip.example.com)");
+        }
+    }
+    validOrThrowUpdate() {
+        if (!this.trunk.ref) {
+            throw new common_1.CommonErrors.BadRequestError("the reference to the resource is required");
+        }
+        if (!this.trunk.name) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name for the resource is required");
+        }
+        if (!Validator.default.isLength(this.trunk.name, { min: 3, max: 64 })) {
+            throw new common_1.CommonErrors.BadRequestError("the friendly name must be between 3 and 64 characters");
+        }
+        if (this.trunk.inboundUri) {
+            if (!Validator.default.isFQDN(this.trunk.inboundUri)) {
+                throw new common_1.CommonErrors.BadRequestError("the inbound URI must be a valid FQDN (e.g. sip.example.com)");
+            }
+        }
+    }
+    mapToPrisma() {
+        return {
+            // TODO: Set a default value for apiVersion
+            apiVersion: "v2",
+            ref: this.trunk.ref,
+            name: this.trunk.name,
+            accessControlListRef: this.trunk.accessControlListRef,
+            inboundUri: this.trunk.inboundUri,
+            inboundCredentialsRef: this.trunk.inboundCredentialsRef,
+            outboundCredentialsRef: this.trunk.outboundCredentialsRef,
+            extended: this.trunk.extended,
+            sendRegister: this.trunk.sendRegister,
+            createdAt: this.trunk.createdAt,
+            updatedAt: this.trunk.updatedAt
+        };
+    }
+    static mapToDto(trunk) {
+        var _a, _b, _c;
+        return {
+            apiVersion: trunk.apiVersion,
+            ref: trunk.ref,
+            name: trunk.name,
+            accessControlListRef: (_a = trunk.accessControlList) === null || _a === void 0 ? void 0 : _a.ref,
+            accessControlList: acl_1.ACLManager.mapToDto(trunk.accessControlList),
+            inboundUri: trunk.inboundUri,
+            inboundCredentialsRef: (_b = trunk.inboundCredentials) === null || _b === void 0 ? void 0 : _b.ref,
+            inboundCredentials: credentials_1.CredentialsManager.mapToDto(trunk.inboundCredentials),
+            outboundCredentialsRef: (_c = trunk.outboundCredentials) === null || _c === void 0 ? void 0 : _c.ref,
+            outboundCredentials: credentials_1.CredentialsManager.mapToDto(trunk.outboundCredentials),
+            extended: trunk.extended,
+            sendRegister: trunk.sendRegister,
+            uris: trunk.uris.map((uri) => {
+                return {
+                    ref: uri.ref,
+                    trunkRef: uri.trunkRef,
+                    host: uri.host,
+                    port: uri.port,
+                    transport: uri.transport.toUpperCase(),
+                    user: uri.user,
+                    weight: uri.weight,
+                    priority: uri.priority,
+                    enabled: uri.enabled
+                };
+            }),
+            createdAt: trunk.createdAt,
+            updatedAt: trunk.updatedAt
+        };
+    }
+}
+exports.TrunkManager = TrunkManager;

package/dist/mappers/utils.d.ts

@@ -0,0 +1,9 @@
+import { CommonConnect as CC } from "@routr/common";
+import { ACLManager } from "./acl";
+import { AgentManager } from "./agent";
+import { CredentialsManager } from "./credentials";
+import { DomainManager } from "./domain";
+import { NumberManager } from "./number";
+import { PeerManager } from "./peer";
+import { TrunkManager } from "./trunk";
+export declare function getManager(kind: CC.KindWithoutUnknown): typeof ACLManager | typeof CredentialsManager | typeof DomainManager | typeof AgentManager | typeof TrunkManager | typeof NumberManager | typeof PeerManager;

package/dist/mappers/utils.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getManager = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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.
+ */
+/* eslint-disable require-jsdoc */
+const common_1 = require("@routr/common");
+const acl_1 = require("./acl");
+const agent_1 = require("./agent");
+const credentials_1 = require("./credentials");
+const domain_1 = require("./domain");
+const number_1 = require("./number");
+const peer_1 = require("./peer");
+const trunk_1 = require("./trunk");
+function getManager(kind) {
+    switch (kind) {
+        case common_1.CommonConnect.Kind.AGENT:
+            return agent_1.AgentManager;
+        case common_1.CommonConnect.Kind.PEER:
+            return peer_1.PeerManager;
+        case common_1.CommonConnect.Kind.ACL:
+            return acl_1.ACLManager;
+        case common_1.CommonConnect.Kind.CREDENTIALS:
+            return credentials_1.CredentialsManager;
+        case common_1.CommonConnect.Kind.NUMBER:
+            return number_1.NumberManager;
+        case common_1.CommonConnect.Kind.TRUNK:
+            return trunk_1.TrunkManager;
+        case common_1.CommonConnect.Kind.DOMAIN:
+            return domain_1.DomainManager;
+    }
+}
+exports.getManager = getManager;

package/dist/service.js

@@ -43,11 +43,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const grpc = __importStar(require("@grpc/grpc-js"));
 const common_1 = require("@routr/common");
-const utils_1 = require("./utils");
 const logger_1 = require("@fonoster/logger");
-const api_1 = require("./api");
-const create_1 = require("./api/create");
 const client_1 = require("@prisma/client");
+const create_1 = require("./api/create");
+const update_1 = require("./api/update");
+const get_1 = require("./api/get");
+const delete_1 = require("./api/delete");
+const find_1 = require("./api/find");
+const list_1 = require("./api/list");
 const prisma = new client_1.PrismaClient();
 const logger = (0, logger_1.getLogger)({ service: "pgdata", filePath: __filename });
 /**
@@ -59,13 +62,26 @@ function pgDataService(config) {
     const { bindAddr } = config;
     logger.info("starting routr service", { bindAddr, name: "pgdata" });
     const server = new grpc.Server();
-    server.addService(common_1.CommonConnect.createService(common_1.CommonConnect.Kind.AGENT), {
-        get: api_1.get,
-        findBy: utils_1.nyi,
-        delete: utils_1.nyi,
-        update: utils_1.nyi,
-        create: (0, create_1.create)(prisma),
-        list: utils_1.nyi
+    const kinds = [
+        common_1.CommonConnect.Kind.AGENT,
+        common_1.CommonConnect.Kind.CREDENTIALS,
+        common_1.CommonConnect.Kind.NUMBER,
+        common_1.CommonConnect.Kind.TRUNK,
+        common_1.CommonConnect.Kind.PEER,
+        common_1.CommonConnect.Kind.DOMAIN,
+        "accessControlList"
+    ];
+    kinds.forEach((kind) => {
+        const k = kind.toLowerCase();
+        const delegate = prisma[kind];
+        server.addService(common_1.CommonConnect.createService(k), {
+            create: (0, create_1.create)(delegate.create, k),
+            get: (0, get_1.get)(delegate.findUnique, k),
+            findBy: (0, find_1.findBy)(delegate.findMany, k),
+            delete: (0, delete_1.del)(delegate.delete),
+            update: (0, update_1.update)(delegate.update, k),
+            list: (0, list_1.list)(delegate.findMany, k)
+        });
     });
     server.bindAsync(config.bindAddr, grpc.ServerCredentials.createInsecure(), () => {
         server.start();

package/dist/types.d.ts

@@ -1,3 +1,38 @@
+import { CommonConnect as CC } from "@routr/common";
+import { JsonObject } from "pb-util/build";
 export interface PostgresDataConfig {
     bindAddr: string;
 }
+export type DBDelegate = Exclude<Exclude<CC.Kind, CC.Kind.UNKNOWN>, CC.Kind.ACL> | "accessControlList";
+export type PrismaOperation = (request: {
+    where: {
+        ref: string;
+    };
+    include?: JsonObject;
+}) => unknown;
+export type PrismaFindByOperation = (request: {
+    where: {
+        [key: string]: boolean | string | number;
+    };
+    include?: JsonObject;
+}) => unknown;
+export type PrismaListOperation = (request: {
+    take: number;
+    skip: number;
+    cursor: {
+        ref: string;
+    };
+    orderBy: JsonObject;
+    include?: JsonObject;
+}) => unknown;
+export type PrismaCreateOperation = (request: {
+    data: any;
+    include?: JsonObject;
+}) => unknown;
+export type PrismaUpdateOperation = (request: {
+    where: {
+        ref: string;
+    };
+    data: any;
+    include?: JsonObject;
+}) => unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/pgdata",
-  "version": "2.0.8-alpha.17",
+  "version": "2.0.8-alpha.19",
   "description": "Postgres API Server for Routr Connect",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -30,10 +30,11 @@
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
     "@prisma/client": "^4.8.0",
-    "@routr/common": "^2.0.8-alpha.17",
-    "@routr/processor": "^2.0.8-alpha.17",
+    "@routr/common": "^2.0.8-alpha.19",
+    "@routr/processor": "^2.0.8-alpha.19",
     "google-protobuf": "^3.9.2",
-    "pb-util": "^1.0.3"
+    "pb-util": "^1.0.3",
+    "validator": "^13.7.0"
   },
   "files": [
     "dist"
@@ -50,7 +51,8 @@
   },
   "devDependencies": {
     "@types/google-protobuf": "^3.15.6",
+    "@types/validator": "^13.7.10",
     "prisma": "^4.8.0"
   },
-  "gitHead": "58f2415a0c32ab860a254a6fac0c1d3de8718dfb"
+  "gitHead": "ff62abb0ff7704a79f98a8e0b10c0036b949cc11"
 }

package/dist/api.d.ts

@@ -1,2 +0,0 @@
-import { CommonTypes as CT } from "@routr/common";
-export declare function get(call: CT.GrpcCall, callback: CT.GrpcCallback): Promise<void>;

package/dist/utils.d.ts

@@ -1,8 +0,0 @@
-import { CommonTypes as CT } from "@routr/common";
-/**
- * Returns UnimplementedError via callback.
- *
- * @param {GrpcCall} call - the grpc request
- * @param {GrpcCallback} callback - the grpc callback
- */
-export declare function nyi(call: CT.GrpcCall, callback: CT.GrpcCallback): void;

package/dist/utils.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nyi = void 0;
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/routr
- *
- * This file is part of Routr
- *
- * 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 common_1 = require("@routr/common");
-/**
- * Returns UnimplementedError via callback.
- *
- * @param {GrpcCall} call - the grpc request
- * @param {GrpcCallback} callback - the grpc callback
- */
-function nyi(call, callback) {
-    callback(new common_1.CommonErrors.UnimplementedError());
-}
-exports.nyi = nyi;