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

package/dist/connect/schemas/trunk.js

@@ -25,7 +25,7 @@ exports.default = {
     type: "object",
     properties: {
         apiVersion: {
-            enum: ["v2draft1", "v2.0", "v2"]
+            enum: ["v2draft1", "v2"]
         },
         kind: {
             enum: ["Trunk", "trunk"]
@@ -40,7 +40,9 @@ exports.default = {
             properties: {
                 name: {
                     description: "Resource's friendly name",
-                    type: "string"
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 64
                 }
             },
             required: ["name"]
@@ -55,7 +57,8 @@ exports.default = {
                     properties: {
                         uri: {
                             description: "URI of the inbound endpoint",
-                            type: "string"
+                            type: "string",
+                            maxLength: 255
                         },
                         accessControlListRef: {
                             description: "Reference to the ACL to be used for inbound traffic",
@@ -100,7 +103,20 @@ exports.default = {
                                             },
                                             transport: {
                                                 description: "Transport of the URI",
-                                                enum: ["tcp", "sctp", "udp", "tls", "ws", "wss"]
+                                                enum: [
+                                                    "TCP",
+                                                    "SCTP",
+                                                    "UDP",
+                                                    "TLS",
+                                                    "WS",
+                                                    "WSS",
+                                                    "tcp",
+                                                    "sctp",
+                                                    "udp",
+                                                    "tls",
+                                                    "ws",
+                                                    "wss"
+                                                ]
                                             },
                                             user: {
                                                 description: "Username of the URI",

package/dist/connect/types.d.ts

@@ -1,4 +1,5 @@
-import { JsonData, Privacy, Transport } from "../types";
+import { JsonObject } from "pb-util/build";
+import { LoadBalancingAlgorithm, Privacy, Transport } from "../types";
 export declare enum Kind {
     AGENT = "agent",
     PEER = "peer",
@@ -9,6 +10,7 @@ export declare enum Kind {
     CREDENTIALS = "credentials",
     ACL = "accesscontrollist"
 }
+export type KindWithoutUnknown = Exclude<Kind, Kind.UNKNOWN>;
 export declare enum APIVersion {
     V2DRAFT1 = "v2draft1",
     V2 = "v2"
@@ -19,7 +21,7 @@ export interface BaseConnectModel {
     name: string;
     createdAt?: Date;
     updatedAt?: Date;
-    extended?: JsonData;
+    extended?: JsonObject;
 }
 export interface AccessControlList extends BaseConnectModel {
     allow: string[];
@@ -27,18 +29,22 @@ export interface AccessControlList extends BaseConnectModel {
 }
 export interface Domain extends BaseConnectModel {
     domainUri: string;
-    accessControlList: AccessControlList;
-    egressPolicies: EgressPolicy[];
+    accessControlListRef?: string;
+    accessControlList?: AccessControlList;
+    egressPolicies?: EgressPolicy[];
 }
 export interface EgressPolicy {
-    number: INumber;
+    numberRef: string;
+    number?: INumber;
     rule: string;
 }
 export interface Agent extends BaseConnectModel {
     username: string;
     privacy: Privacy;
     enabled: boolean;
+    domainRef?: string;
     domain?: Domain;
+    credentialsRef?: string;
     credentials?: Credentials;
 }
 export interface Credentials extends BaseConnectModel {
@@ -50,19 +56,23 @@ export interface INumber extends BaseConnectModel {
     aorLink: string;
     city: string;
     country: string;
-    countryIsoCode: string;
+    countryISOCode: string;
     sessionAffinityHeader: string;
     extraHeaders: {
         name: string;
         value: string;
     }[];
+    trunkRef?: string;
     trunk?: Trunk;
 }
 export interface Trunk extends BaseConnectModel {
     sendRegister: boolean;
     inboundUri: string;
+    accessControlListRef?: string;
     accessControlList?: AccessControlList;
+    inboundCredentialsRef?: string;
     inboundCredentials?: Credentials;
+    outboundCredentialsRef?: string;
     outboundCredentials?: Credentials;
     uris: TrunkURI[];
 }
@@ -80,8 +90,12 @@ export interface Peer extends BaseConnectModel {
     aor: string;
     contactAddr: string;
     enabled: boolean;
+    accessControlListRef?: string;
     accessControlList?: AccessControlList;
+    credentialsRef?: string;
     credentials?: Credentials;
+    balancingAlgorithm?: LoadBalancingAlgorithm;
+    withSessionAffinity?: boolean;
 }
 export type ConnectModel = Agent | Peer | INumber | Trunk | Domain | Credentials | AccessControlList;
 export type RoutableResourceUnion = Agent | Peer | INumber;

package/dist/helper.js

@@ -79,8 +79,8 @@ exports.deepCopy = deepCopy;
  */
 const getListeningPoint = (listeningPoints, transport) => {
     const listeningPoint = transport
-        ? listeningPoints.find((lp) => lp.transport.toLowerCase() === transport.toLowerCase())
-        : listeningPoints.find((lp) => lp.transport.toLowerCase() === types_1.Transport.UDP);
+        ? listeningPoints.find((lp) => lp.transport.toUpperCase() === transport.toUpperCase())
+        : listeningPoints.find((lp) => lp.transport.toUpperCase() === types_1.Transport.UDP);
     if (!listeningPoint) {
         throw new Error(`no listening point found for transport ${transport}`);
     }

package/dist/protos/location.proto

@@ -61,10 +61,20 @@ message AddRouteRequest {
 }
 
 message FindRoutesRequest {
+  message Backend {
+    enum Algoritm {
+      ROUND_ROBIN = 0;
+      LEAST_SESSIONS = 1;
+    }
+    string ref = 1;
+    bool with_session_affinity = 2;
+    Algoritm algorithm = 3;
+  }
   string call_id = 1;
   string aor = 2;
   string session_affinity_ref = 3;
-  map<string, string> labels = 4;
+  Backend backend = 4;
+  map<string, string> labels = 5;
 }
 
 message FindRoutesResponse {

package/dist/types.d.ts

@@ -15,12 +15,16 @@ export declare enum Method {
     OPTIONS = "OPTIONS"
 }
 export declare enum Transport {
-    TCP = "tcp",
-    UDP = "udp",
-    TLS = "tls",
-    SCTP = "sctp",
-    WS = "ws",
-    WSS = "wss"
+    TCP = "TCP",
+    UDP = "UDP",
+    TLS = "TLS",
+    SCTP = "SCTP",
+    WS = "WS",
+    WSS = "WSS"
+}
+export declare enum LoadBalancingAlgorithm {
+    ROUND_ROBIN = "ROUND-ROBIN",
+    LEAST_SESSIONS = "LEAST-SESSIONS"
 }
 export declare enum ExtraHeader {
     REQUEST_URI = "X-Request-Uri",
@@ -31,20 +35,12 @@ export declare enum ExtraHeader {
     DOD_PRIVACY = "X-DOD-Privacy"
 }
 export declare enum Privacy {
-    NONE = "none",
-    PRIVATE = "id"
-}
-export declare enum AuthorizationAlgorithm {
-    MD5 = "MD5"
-}
-export declare enum AuthorizationScheme {
-    DIGEST = "Digest"
-}
-export declare enum Qop {
-    AUTH = "auth",
-    AUTH_INT = "auth-int",
-    NONE = ""
+    NONE = "NONE",
+    PRIVATE = "ID"
 }
+export type AuthorizationAlgorithm = "MD5";
+export type AuthorizationScheme = "Digest";
+export type Qop = "auth" | "auth-int" | "";
 export interface NetInterface {
     host: string;
     port: number;
@@ -111,8 +107,8 @@ export interface AuthChallengeResponse {
     qop: Qop;
 }
 export declare enum HeaderModifierAction {
-    ADD = "add",
-    REMOVE = "remove"
+    ADD = 0,
+    REMOVE = 1
 }
 export interface HeaderModifier {
     name: string;
@@ -245,7 +241,7 @@ export interface SipURI {
     user?: string;
     host: string;
     port?: number;
-    transportParam: string;
+    transportParam: Transport;
     mAddrParam?: string;
     userParam?: string;
     ttlParam?: number;

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Qop = exports.AuthorizationScheme = exports.AuthorizationAlgorithm = exports.Privacy = exports.ExtraHeader = exports.Transport = exports.Method = void 0;
+exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Privacy = exports.ExtraHeader = exports.LoadBalancingAlgorithm = exports.Transport = exports.Method = void 0;
 var Method;
 (function (Method) {
     Method["UNKNOWN"] = "UNKNOWN";
@@ -17,13 +17,18 @@ var Method;
 })(Method = exports.Method || (exports.Method = {}));
 var Transport;
 (function (Transport) {
-    Transport["TCP"] = "tcp";
-    Transport["UDP"] = "udp";
-    Transport["TLS"] = "tls";
-    Transport["SCTP"] = "sctp";
-    Transport["WS"] = "ws";
-    Transport["WSS"] = "wss";
+    Transport["TCP"] = "TCP";
+    Transport["UDP"] = "UDP";
+    Transport["TLS"] = "TLS";
+    Transport["SCTP"] = "SCTP";
+    Transport["WS"] = "WS";
+    Transport["WSS"] = "WSS";
 })(Transport = exports.Transport || (exports.Transport = {}));
+var LoadBalancingAlgorithm;
+(function (LoadBalancingAlgorithm) {
+    LoadBalancingAlgorithm["ROUND_ROBIN"] = "ROUND-ROBIN";
+    LoadBalancingAlgorithm["LEAST_SESSIONS"] = "LEAST-SESSIONS";
+})(LoadBalancingAlgorithm = exports.LoadBalancingAlgorithm || (exports.LoadBalancingAlgorithm = {}));
 var ExtraHeader;
 (function (ExtraHeader) {
     ExtraHeader["REQUEST_URI"] = "X-Request-Uri";
@@ -35,27 +40,13 @@ var ExtraHeader;
 })(ExtraHeader = exports.ExtraHeader || (exports.ExtraHeader = {}));
 var Privacy;
 (function (Privacy) {
-    Privacy["NONE"] = "none";
-    Privacy["PRIVATE"] = "id";
+    Privacy["NONE"] = "NONE";
+    Privacy["PRIVATE"] = "ID";
 })(Privacy = exports.Privacy || (exports.Privacy = {}));
-var AuthorizationAlgorithm;
-(function (AuthorizationAlgorithm) {
-    AuthorizationAlgorithm["MD5"] = "MD5";
-})(AuthorizationAlgorithm = exports.AuthorizationAlgorithm || (exports.AuthorizationAlgorithm = {}));
-var AuthorizationScheme;
-(function (AuthorizationScheme) {
-    AuthorizationScheme["DIGEST"] = "Digest";
-})(AuthorizationScheme = exports.AuthorizationScheme || (exports.AuthorizationScheme = {}));
-var Qop;
-(function (Qop) {
-    Qop["AUTH"] = "auth";
-    Qop["AUTH_INT"] = "auth-int";
-    Qop["NONE"] = "";
-})(Qop = exports.Qop || (exports.Qop = {}));
 var HeaderModifierAction;
 (function (HeaderModifierAction) {
-    HeaderModifierAction["ADD"] = "add";
-    HeaderModifierAction["REMOVE"] = "remove";
+    HeaderModifierAction[HeaderModifierAction["ADD"] = 0] = "ADD";
+    HeaderModifierAction[HeaderModifierAction["REMOVE"] = 1] = "REMOVE";
 })(HeaderModifierAction = exports.HeaderModifierAction || (exports.HeaderModifierAction = {}));
 var ResponseType;
 (function (ResponseType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.17",
+  "version": "2.0.8-alpha.19",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -51,5 +51,5 @@
   "devDependencies": {
     "@types/js-yaml": "^4.0.5"
   },
-  "gitHead": "58f2415a0c32ab860a254a6fac0c1d3de8718dfb"
+  "gitHead": "ff62abb0ff7704a79f98a8e0b10c0036b949cc11"
 }

package/dist/connect/converters.d.ts

@@ -1,10 +0,0 @@
-import { UserConfig } from "./config";
-import { AccessControlList, Agent, Credentials, Domain, INumber, Peer, Trunk } from "./types";
-export declare const getConverter: (kind: string) => typeof convertAgentConfigToAgent | typeof convertDomainConfigToDomain | typeof convertPeerConfigToPeer | typeof convertNumberConfigToNumber | typeof convertTrunkConfigToTrunk | typeof convertCredentialsConfigToCredentials | typeof convertACLConfigToACL;
-export declare function convertAgentConfigToAgent(config: UserConfig, list: UserConfig[]): Agent;
-export declare function convertDomainConfigToDomain(config: UserConfig, list: UserConfig[]): Domain;
-export declare function convertPeerConfigToPeer(config: UserConfig, list: UserConfig[]): Peer;
-export declare function convertNumberConfigToNumber(config: UserConfig, list: UserConfig[]): INumber;
-export declare function convertTrunkConfigToTrunk(config: UserConfig, list: UserConfig[]): Trunk;
-export declare function convertCredentialsConfigToCredentials(config: UserConfig): Credentials;
-export declare function convertACLConfigToACL(config: UserConfig): AccessControlList;

package/dist/connect/converters.js

@@ -1,178 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertACLConfigToACL = exports.convertCredentialsConfigToCredentials = exports.convertTrunkConfigToTrunk = exports.convertNumberConfigToNumber = exports.convertPeerConfigToPeer = exports.convertDomainConfigToDomain = exports.convertAgentConfigToAgent = exports.getConverter = 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 logger_1 = require("@fonoster/logger");
-const types_1 = require("../types");
-const types_2 = require("./types");
-const logger = (0, logger_1.getLogger)({ service: "simpledata", filePath: __filename });
-const findByRef = (ref, list) => {
-    const resource = list.find((r) => r.ref === ref);
-    if (ref != null && resource == null) {
-        logger.error(`the resource with ref ${ref} does not exist in the configuration file; exiting`);
-        process.exit(1);
-    }
-    return resource ? (0, exports.getConverter)(resource.kind)(resource, list) : null;
-};
-const getConverter = (kind) => {
-    switch (kind) {
-        case types_2.Kind.AGENT:
-            return convertAgentConfigToAgent;
-        case types_2.Kind.DOMAIN:
-            return convertDomainConfigToDomain;
-        case types_2.Kind.PEER:
-            return convertPeerConfigToPeer;
-        case types_2.Kind.NUMBER:
-            return convertNumberConfigToNumber;
-        case types_2.Kind.TRUNK:
-            return convertTrunkConfigToTrunk;
-        case types_2.Kind.CREDENTIALS:
-            return convertCredentialsConfigToCredentials;
-        case types_2.Kind.ACL:
-            return convertACLConfigToACL;
-    }
-};
-exports.getConverter = getConverter;
-function convertAgentConfigToAgent(config, list) {
-    var _a, _b;
-    if (config.kind !== types_2.Kind.AGENT)
-        throw new Error("invalid resource type `Agent`");
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        username: config.spec.username,
-        privacy: (_b = (_a = config.spec.privacy) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : types_1.Privacy.NONE,
-        enabled: config.spec.enabled,
-        domain: findByRef(config.spec.domainRef, list),
-        credentials: findByRef(config.spec.credentialsRef, list)
-    };
-}
-exports.convertAgentConfigToAgent = convertAgentConfigToAgent;
-function convertDomainConfigToDomain(config, list) {
-    var _a;
-    if (config.kind !== types_2.Kind.DOMAIN)
-        throw new Error("invalid resource type `Domain`");
-    const egressPolicies = (_a = config.spec.context.egressPolicies) === null || _a === void 0 ? void 0 : _a.map((policy) => {
-        return {
-            rule: policy.rule,
-            number: findByRef(policy.numberRef, list)
-        };
-    });
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        domainUri: config.spec.context.domainUri,
-        accessControlList: findByRef(config.spec.accessControlListRef, list),
-        egressPolicies
-    };
-}
-exports.convertDomainConfigToDomain = convertDomainConfigToDomain;
-function convertPeerConfigToPeer(config, list) {
-    if (config.kind !== types_2.Kind.PEER)
-        throw new Error("invalid resource type `Peer`");
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        username: config.spec.username,
-        aor: config.spec.aor,
-        contactAddr: config.spec.contactAddr,
-        enabled: config.spec.enabled,
-        credentials: findByRef(config.spec.credentialsRef, list)
-    };
-}
-exports.convertPeerConfigToPeer = convertPeerConfigToPeer;
-function convertNumberConfigToNumber(config, list) {
-    if (config.kind !== types_2.Kind.NUMBER)
-        throw new Error("invalid resource type `Number`");
-    const metadata = config.metadata;
-    const location = config.spec.location;
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: metadata.name,
-        city: metadata.geoInfo.city,
-        country: metadata.geoInfo.country,
-        countryIsoCode: metadata.geoInfo.countryISOCode,
-        telUrl: location.telUrl,
-        aorLink: location.aorLink,
-        sessionAffinityHeader: location.sessionAffinityHeader,
-        extraHeaders: location.extraHeaders,
-        trunk: findByRef(config.spec.trunkRef, list)
-    };
-}
-exports.convertNumberConfigToNumber = convertNumberConfigToNumber;
-function convertTrunkConfigToTrunk(config, list) {
-    var _a;
-    if (config.kind !== types_2.Kind.TRUNK)
-        throw new Error("invalid resource type `Trunk`");
-    const inbound = config.spec.inbound;
-    const outbound = config.spec.outbound;
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        sendRegister: outbound.sendRegister,
-        inboundUri: inbound.uri,
-        inboundCredentials: findByRef(inbound.credentialsRef, list),
-        outboundCredentials: findByRef(outbound.credentialsRef, list),
-        accessControlList: findByRef(inbound.accessControlListRef, list),
-        uris: (_a = config.spec.outbound.uris) === null || _a === void 0 ? void 0 : _a.map((entry) => {
-            return {
-                user: entry.uri.user,
-                host: entry.uri.host,
-                port: entry.uri.port,
-                transport: entry.uri.transport,
-                enabled: entry.enabled,
-                weight: entry.weight,
-                priority: entry.priority
-            };
-        })
-    };
-}
-exports.convertTrunkConfigToTrunk = convertTrunkConfigToTrunk;
-function convertCredentialsConfigToCredentials(config) {
-    if (config.kind !== types_2.Kind.CREDENTIALS)
-        throw new Error("invalid resource type `Credentials`");
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        username: config.spec.credentials.username,
-        password: config.spec.credentials.password
-    };
-}
-exports.convertCredentialsConfigToCredentials = convertCredentialsConfigToCredentials;
-function convertACLConfigToACL(config) {
-    var _a, _b, _c, _d;
-    if (config.kind !== types_2.Kind.ACL)
-        throw new Error("invalid resource type `AccessControlList`");
-    return {
-        apiVersion: config.apiVersion,
-        ref: config.ref,
-        name: config.metadata.name,
-        allow: (_b = (_a = config.spec.accessControlList) === null || _a === void 0 ? void 0 : _a.allow) !== null && _b !== void 0 ? _b : [],
-        deny: (_d = (_c = config.spec.accessControlList) === null || _c === void 0 ? void 0 : _c.deny) !== null && _d !== void 0 ? _d : []
-    };
-}
-exports.convertACLConfigToACL = convertACLConfigToACL;