@routr/processor 2.0.8-alpha.3 → 2.0.8-alpha.30

package/dist/alterations.d.ts

@@ -1,13 +1,15 @@
 import { MessageRequest, Route } from "@routr/common";
 export declare const updateRequestURI: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const addSelfVia: (route: Route) => (request: MessageRequest) => MessageRequest;
-export declare const addRoute: (route: Route) => (request: MessageRequest) => MessageRequest;
-export declare const addRouteToListeningPoint: (route: Route) => (request: MessageRequest) => MessageRequest;
+export declare const addRouteToNextHop: (route: Route) => (request: MessageRequest) => MessageRequest;
+export declare const addRouteToPeerEdgePort: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const applyXHeaders: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const addSelfRecordRoute: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const addXEdgePortRef: (request: MessageRequest) => MessageRequest;
 export declare const removeXEdgePortRef: (request: MessageRequest) => MessageRequest;
 export declare const removeAuthorization: (request: MessageRequest) => MessageRequest;
-export declare const removeRoutes: (request: MessageRequest) => MessageRequest;
+export declare const removeSelfRoutes: (request: MessageRequest) => MessageRequest;
 export declare const removeTopVia: (request: MessageRequest) => MessageRequest;
 export declare const decreaseMaxForwards: (request: MessageRequest) => MessageRequest;
+export declare const fixNatedContact: (request: MessageRequest) => MessageRequest;
+export declare const enforceE164: (enforceE164: boolean, validateMobilePrefix: boolean) => (request: MessageRequest) => MessageRequest;

package/dist/alterations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decreaseMaxForwards = exports.removeTopVia = exports.removeRoutes = exports.removeAuthorization = exports.removeXEdgePortRef = exports.addXEdgePortRef = exports.addSelfRecordRoute = exports.applyXHeaders = exports.addRouteToListeningPoint = exports.addRoute = exports.addSelfVia = exports.updateRequestURI = void 0;
+exports.enforceE164 = exports.fixNatedContact = exports.decreaseMaxForwards = exports.removeTopVia = exports.removeSelfRoutes = exports.removeAuthorization = exports.removeXEdgePortRef = exports.addXEdgePortRef = exports.addSelfRecordRoute = exports.applyXHeaders = exports.addRouteToPeerEdgePort = exports.addRouteToNextHop = exports.addSelfVia = exports.updateRequestURI = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -20,8 +20,8 @@ exports.decreaseMaxForwards = exports.removeTopVia = exports.removeRoutes = expo
  * limitations under the License.
  */
 const common_1 = require("@routr/common");
-const helper_1 = require("@routr/common/src/helper");
-const helper_2 = require("./helper");
+const phone_1 = require("phone");
+const helper_1 = require("./helper");
 // Q: Should we deprecate this method since we are not doing strict routing?
 const updateRequestURI = (route) => (request) => {
     const req = common_1.Helper.deepCopy(request);
@@ -38,29 +38,20 @@ const updateRequestURI = (route) => (request) => {
 };
 exports.updateRequestURI = updateRequestURI;
 const addSelfVia = (route) => (request) => {
-    var _a;
     const req = common_1.Helper.deepCopy(request);
-    // If is comming from a different edgeport we use the listening point instead
-    // of the endpoint to ensure connectivity.
-    const nextHopHost = request.edgePortRef === route.edgePortRef
-        ? route.host
-        : route.egressListeningPoint.host;
-    const egressListeningPoint = common_1.Helper.getListeningPoint(request, route.transport);
-    // If the nextHopHost host is local, then use use lp to construct via
-    // otherwise, we use the first available external ip.
-    const via = common_1.IpUtils.isLocalnet(req.localnets, nextHopHost)
-        ? route.egressListeningPoint
-        : {
-            // fallback to lp host if there is no external ips
-            host: (_a = req.externalAddrs[0]) !== null && _a !== void 0 ? _a : egressListeningPoint.host,
-            port: egressListeningPoint.port,
-            transport: egressListeningPoint.transport
-        };
-    req.message.via = [via, ...req.message.via];
+    const routingObjects = request.edgePortRef === route.edgePortRef ? route : request;
+    const targetIntf = (0, helper_1.getEdgeInterface)(Object.assign(Object.assign({}, routingObjects), { endpointIntf: route }));
+    req.message.via = [
+        Object.assign(Object.assign({}, targetIntf), { rPortFlag: true }),
+        ...req.message.via
+    ];
     return req;
 };
 exports.addSelfVia = addSelfVia;
-const addRoute = (route) => (request) => {
+const addRouteToNextHop = (route) => (request) => {
+    if (request.message.requestUri.host === route.host) {
+        return request;
+    }
     const req = common_1.Helper.deepCopy(request);
     const r = {
         address: {
@@ -75,15 +66,21 @@ const addRoute = (route) => (request) => {
     req.message.route = [r, ...req.message.route];
     return req;
 };
-exports.addRoute = addRoute;
-const addRouteToListeningPoint = (route) => (request) => {
+exports.addRouteToNextHop = addRouteToNextHop;
+const addRouteToPeerEdgePort = (route) => (request) => {
     const req = common_1.Helper.deepCopy(request);
+    const targetIntf = (0, helper_1.getEdgeInterface)({
+        listeningPoints: route.listeningPoints,
+        localnets: route.localnets,
+        externalAddrs: route.externalAddrs,
+        endpointIntf: route
+    });
     const r = {
         address: {
             uri: {
-                host: route.egressListeningPoint.host,
-                port: route.egressListeningPoint.port,
-                transportParam: route.egressListeningPoint.transport,
+                host: targetIntf.host,
+                port: targetIntf.port,
+                transportParam: targetIntf.transport,
                 lrParam: true
             }
         }
@@ -91,14 +88,14 @@ const addRouteToListeningPoint = (route) => (request) => {
     req.message.route = [r, ...req.message.route];
     return req;
 };
-exports.addRouteToListeningPoint = addRouteToListeningPoint;
+exports.addRouteToPeerEdgePort = addRouteToPeerEdgePort;
 const applyXHeaders = (route) => (request) => {
     const req = common_1.Helper.deepCopy(request);
     if (route.headers && route.headers.length > 0) {
         const headersToRemove = route.headers
             .filter((h) => h.action === common_1.CommonTypes.HeaderModifierAction.REMOVE)
-            .map((h) => h.name);
-        const headersToAdd = route.headers.filter((h) => h.action !== common_1.CommonTypes.HeaderModifierAction.REMOVE);
+            .map((h) => h.name.toLowerCase());
+        const headersToAdd = route.headers.filter((h) => h.action === common_1.CommonTypes.HeaderModifierAction.ADD);
         req.message.extensions = req.message.extensions.filter((h) => !headersToRemove.includes(h.name.toLowerCase()));
         headersToAdd.forEach((h) => {
             req.message.extensions.push({ name: h.name, value: h.value });
@@ -109,8 +106,18 @@ const applyXHeaders = (route) => (request) => {
 exports.applyXHeaders = applyXHeaders;
 const addSelfRecordRoute = (route) => (request) => {
     const req = common_1.Helper.deepCopy(request);
-    const originIntf = (0, helper_2.getEdgeInterface)(request, request.sender);
-    const targetIntf = (0, helper_2.getEdgeInterface)(request, route);
+    const originIntf = (0, helper_1.getEdgeInterface)({
+        listeningPoints: request.listeningPoints,
+        localnets: request.localnets,
+        externalAddrs: request.externalAddrs,
+        endpointIntf: request.sender
+    });
+    const targetIntf = (0, helper_1.getEdgeInterface)({
+        listeningPoints: request.listeningPoints,
+        localnets: request.localnets,
+        externalAddrs: request.externalAddrs,
+        endpointIntf: route
+    });
     const originRoute = {
         address: {
             uri: {
@@ -175,21 +182,21 @@ const removeAuthorization = (request) => {
     return req;
 };
 exports.removeAuthorization = removeAuthorization;
-const removeRoutes = (request) => {
+const removeSelfRoutes = (request) => {
     const req = common_1.Helper.deepCopy(request);
+    const localIps = request.localnets.map((ln) => ln.split("/")[0]);
     req.message.route = req.message.route.filter((r) => {
         var _a;
-        const localIps = request.localnets.map((ln) => ln.split("/")[0]);
-        const lp = (0, helper_1.getListeningPoint)(request, ((_a = r.address.uri.transportParam) === null || _a === void 0 ? void 0 : _a.toLowerCase()) ||
+        const lp = common_1.Helper.getListeningPoint(request.listeningPoints, ((_a = r.address.uri.transportParam) === null || _a === void 0 ? void 0 : _a.toUpperCase()) ||
             common_1.Transport.UDP);
-        const route = r.address.uri;
-        return !((localIps.includes(route.host) ||
-            request.externalAddrs.includes(route.host)) &&
-            route.port === lp.port);
+        const routeUri = r.address.uri;
+        return !((localIps.includes(routeUri.host) ||
+            request.externalAddrs.includes(routeUri.host)) &&
+            routeUri.port === lp.port);
     });
     return req;
 };
-exports.removeRoutes = removeRoutes;
+exports.removeSelfRoutes = removeSelfRoutes;
 const removeTopVia = (request) => {
     const req = common_1.Helper.deepCopy(request);
     req.message.via.shift();
@@ -205,3 +212,44 @@ const decreaseMaxForwards = (request) => {
     return req;
 };
 exports.decreaseMaxForwards = decreaseMaxForwards;
+const fixNatedContact = (request) => {
+    var _a;
+    const req = common_1.Helper.deepCopy(request);
+    if ((_a = req.message.contact) === null || _a === void 0 ? void 0 : _a.address.uri.host.includes(".invalid")) {
+        req.message.contact.address.uri.host = request.sender.host;
+        req.message.contact.address.uri.port = request.sender.port;
+    }
+    return req;
+};
+exports.fixNatedContact = fixNatedContact;
+// Will do the best effort to normalize from/to/requestUri users as e164 values
+const enforceE164 = (enforceE164, validateMobilePrefix) => (request) => {
+    var _a, _b, _c;
+    if (!enforceE164)
+        return request;
+    const req = common_1.Helper.deepCopy(request);
+    // Removes the + to ensure not having duplicates
+    const fromUser = (_a = req.message.from.address.uri.user) === null || _a === void 0 ? void 0 : _a.replace("+", "");
+    const toUser = (_b = req.message.to.address.uri.user) === null || _b === void 0 ? void 0 : _b.replace("+", "");
+    const requestUriUser = (_c = req.message.requestUri.user) === null || _c === void 0 ? void 0 : _c.replace("+", "");
+    // Normalizing as e164
+    const normalizedTo = (0, phone_1.phone)(`+${toUser}`, { validateMobilePrefix });
+    const normalizedFrom = (0, phone_1.phone)(`+${fromUser}`, {
+        validateMobilePrefix: true
+    });
+    const normalizedReqUri = (0, phone_1.phone)(`+${requestUriUser}`, {
+        validateMobilePrefix
+    });
+    // If the normalization worked we overwrite the original values
+    if (normalizedFrom.isValid) {
+        req.message.from.address.uri.user = normalizedFrom.phoneNumber;
+    }
+    if (normalizedTo.isValid) {
+        req.message.to.address.uri.user = normalizedTo.phoneNumber;
+    }
+    if (normalizedReqUri.isValid) {
+        req.message.requestUri.user = normalizedReqUri.phoneNumber;
+    }
+    return req;
+};
+exports.enforceE164 = enforceE164;

package/dist/extensions.js

@@ -22,7 +22,7 @@ exports.removeHeader = exports.addHeader = exports.updateHeader = exports.getHea
 const common_1 = require("@routr/common");
 const getHeaderValue = (request, name) => {
     var _a;
-    return (_a = request.message.extensions.find((ext) => ext.name.toLowerCase() === name.toLowerCase())) === null || _a === void 0 ? void 0 : _a.value;
+    return ((_a = request.message.extensions.find((ext) => ext.name.toLowerCase() === (name === null || name === void 0 ? void 0 : name.toLowerCase()))) === null || _a === void 0 ? void 0 : _a.value) || null;
 };
 exports.getHeaderValue = getHeaderValue;
 const updateHeader = (request, header) => {

package/dist/helper.d.ts

@@ -1,12 +1,24 @@
-import { MessageRequest, Route, NetInterface } from "@routr/common";
+import { MessageRequest, Route, Transport, NetInterface } from "@routr/common";
 export declare const isTypeResponse: (request: MessageRequest) => boolean;
 export declare const isTypeRequest: (request: MessageRequest) => boolean;
-export declare const getEdgeInterface: (request: MessageRequest, endpointIntf: NetInterface) => NetInterface;
+export declare const getEdgeInterface: (nets: {
+    listeningPoints: NetInterface[];
+    endpointIntf: NetInterface;
+    localnets: string[];
+    externalAddrs: string[];
+}) => NetInterface;
 /**
- * A request traversing a second EdgePort would have an updated the requestUri.
+ * A request traversing a second EdgePort would have updated the requestUri.
  * Therefore, we are able to re-construct the Route from the request.
  *
  * @param {MessageRequest} request - the request
  * @return {Route} the route
  */
 export declare function createRouteFromLastMessage(request: MessageRequest): Route;
+export declare const hasSDP: (request: MessageRequest) => boolean;
+export declare const isOk: (request: MessageRequest) => boolean;
+export declare const isRinging: (request: MessageRequest) => boolean;
+export declare const isWebRTC: (transport: Transport) => boolean;
+export declare const isInviteOrAckWithSDP: (request: MessageRequest) => boolean;
+export declare const isOkOrRingingWithSDP: (request: MessageRequest) => boolean;
+export declare const isBye: (request: MessageRequest) => boolean;

package/dist/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRouteFromLastMessage = exports.getEdgeInterface = exports.isTypeRequest = exports.isTypeResponse = void 0;
+exports.isBye = exports.isOkOrRingingWithSDP = exports.isInviteOrAckWithSDP = exports.isWebRTC = exports.isRinging = exports.isOk = exports.hasSDP = exports.createRouteFromLastMessage = exports.getEdgeInterface = exports.isTypeRequest = exports.isTypeResponse = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -26,11 +26,12 @@ const isTypeResponse = (request) => request.message.messageType === common_1.Com
 exports.isTypeResponse = isTypeResponse;
 const isTypeRequest = (request) => !(0, exports.isTypeResponse)(request);
 exports.isTypeRequest = isTypeRequest;
-const getEdgeInterface = (request, endpointIntf) => {
-    const localnetIp = common_2.IpUtils.getLocalnetIp(request.localnets, endpointIntf.host);
-    const host = localnetIp !== null && localnetIp !== void 0 ? localnetIp : request.externalAddrs[0];
-    const lp = common_1.Helper.getListeningPoint(request, endpointIntf.transport);
-    if (!localnetIp && request.externalAddrs.length === 0) {
+const getEdgeInterface = (nets) => {
+    const { listeningPoints, endpointIntf, localnets, externalAddrs } = nets;
+    const localnetIp = common_2.IpUtils.getLocalnetIp(localnets, endpointIntf.host);
+    const host = localnetIp !== null && localnetIp !== void 0 ? localnetIp : externalAddrs[0];
+    const lp = common_1.Helper.getListeningPoint(listeningPoints, endpointIntf.transport);
+    if (!localnetIp && externalAddrs.length === 0) {
         throw new Error(`unable to find a valid interface for host ${endpointIntf.host} and transport ${lp.transport}`);
     }
     if (localnetIp && lp.host !== "0.0.0.0" && lp.host !== host) {
@@ -44,28 +45,48 @@ const getEdgeInterface = (request, endpointIntf) => {
 };
 exports.getEdgeInterface = getEdgeInterface;
 /**
- * A request traversing a second EdgePort would have an updated the requestUri.
+ * A request traversing a second EdgePort would have updated the requestUri.
  * Therefore, we are able to re-construct the Route from the request.
  *
  * @param {MessageRequest} request - the request
  * @return {Route} the route
  */
 function createRouteFromLastMessage(request) {
+    var _a;
     const uri = request.message.requestUri;
     const sessionCount = index_1.Extensions.getHeaderValue(request, common_1.CommonTypes.ExtraHeader.SESSION_COUNT)
         ? parseInt(index_1.Extensions.getHeaderValue(request, common_1.CommonTypes.ExtraHeader.SESSION_COUNT))
         : -1;
-    const egressListeningPoint = common_1.Helper.getListeningPoint(request, uri.transportParam.toLowerCase());
     return {
         edgePortRef: request.edgePortRef,
         user: uri.user,
         host: uri.host,
         port: uri.port,
-        transport: uri.transportParam.toLowerCase(),
+        transport: (_a = uri.transportParam) === null || _a === void 0 ? void 0 : _a.toUpperCase(),
         registeredOn: Date.now(),
         sessionCount,
         expires: index_1.Target.getTargetExpires(request),
-        egressListeningPoint
+        listeningPoints: request.listeningPoints,
+        localnets: request.localnets,
+        externalAddrs: request.externalAddrs
     };
 }
 exports.createRouteFromLastMessage = createRouteFromLastMessage;
+const hasSDP = (request) => { var _a; return ((_a = request.message.body) === null || _a === void 0 ? void 0 : _a.length) > 0; };
+exports.hasSDP = hasSDP;
+const isOk = (request) => request.message.responseType === common_1.CommonTypes.ResponseType.OK;
+exports.isOk = isOk;
+const isRinging = (request) => request.message.responseType === common_1.CommonTypes.ResponseType.RINGING;
+exports.isRinging = isRinging;
+const isWebRTC = (transport) => transport === common_1.Transport.WS || transport === common_1.Transport.WSS;
+exports.isWebRTC = isWebRTC;
+const isInviteOrAckWithSDP = (request) => (0, exports.isTypeRequest)(request) &&
+    (0, exports.hasSDP)(request) &&
+    (request.method === common_1.Method.INVITE || request.method === common_1.Method.ACK);
+exports.isInviteOrAckWithSDP = isInviteOrAckWithSDP;
+const isOkOrRingingWithSDP = (request) => (0, exports.isTypeResponse)(request) &&
+    (0, exports.hasSDP)(request) &&
+    ((0, exports.isOk)(request) || (0, exports.isRinging)(request));
+exports.isOkOrRingingWithSDP = isOkOrRingingWithSDP;
+const isBye = (request) => (0, exports.isTypeRequest)(request) && request.method === common_1.Method.BYE;
+exports.isBye = isBye;

package/dist/response.d.ts

@@ -31,6 +31,10 @@ export default class Response {
      * Sends a not implemented response.
      */
     sendNotImplemented(): void;
+    /**
+     * Sends a internal server error response.
+     */
+    sendInternalServerError(): void;
     /**
      * Sends a response with a SIP Message.
      *
@@ -41,6 +45,7 @@ export default class Response {
      * Sends an error response.
      *
      * @param {Error} error - The error to be sent.
+     * @deprecated
      */
     sendError(error: Error): void;
 }

package/dist/response.js

@@ -1,7 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const buildResponse = (code, extraHeaders) => {
-    return { message: { responseType: code, extensions: extraHeaders } };
+/*
+ * 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");
+const buildResponse = (info) => {
+    return {
+        message: {
+            responseType: info.code,
+            reasonPhrase: info.reasonPhrase,
+            extensions: info.extraHeaders
+        }
+    };
 };
 /**
  * Response object.
@@ -21,25 +46,43 @@ class Response {
      * @param {object[]} extraHeaders - Optional extra headers to be sent.
      */
     sendOk(extraHeaders) {
-        this.callback(null, buildResponse(7, extraHeaders));
+        this.callback(null, buildResponse({ code: common_1.CommonTypes.ResponseType.OK, extraHeaders }));
     }
     /**
      * Sends a method not allowed response.
      */
     sendMethodNotAllowed() {
-        this.callback(null, buildResponse(21));
+        this.callback(null, buildResponse({
+            code: common_1.CommonTypes.ResponseType.METHOD_NOT_ALLOWED,
+            reasonPhrase: "Method Not Allowed"
+        }));
     }
     /**
      * Sends a not found response.
      */
     sendNotFound() {
-        this.callback(null, buildResponse(20));
+        this.callback(null, buildResponse({
+            code: common_1.CommonTypes.ResponseType.NOT_FOUND,
+            reasonPhrase: "Not Found"
+        }));
     }
     /**
      * Sends a not implemented response.
      */
     sendNotImplemented() {
-        this.callback(null, buildResponse(47));
+        this.callback(null, buildResponse({
+            code: common_1.CommonTypes.ResponseType.NOT_IMPLEMENTED,
+            reasonPhrase: "Not Implemented"
+        }));
+    }
+    /**
+     * Sends a internal server error response.
+     */
+    sendInternalServerError() {
+        this.callback(null, buildResponse({
+            code: common_1.CommonTypes.ResponseType.SERVER_INTERNAL_ERROR,
+            reasonPhrase: "Internal Server Error"
+        }));
     }
     /**
      * Sends a response with a SIP Message.
@@ -53,6 +96,7 @@ class Response {
      * Sends an error response.
      *
      * @param {Error} error - The error to be sent.
+     * @deprecated
      */
     sendError(error) {
         this.callback(error, null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/processor",
-  "version": "2.0.8-alpha.3",
+  "version": "2.0.8-alpha.30",
   "description": "Processor server and API",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@fonoster/logger": "0.3.18",
-    "@grpc/grpc-js": "^1.5.9",
+    "@grpc/grpc-js": "^1.8.4",
     "@grpc/proto-loader": "^0.6.9",
     "@opentelemetry/api": "^1.0.4",
     "@opentelemetry/exporter-jaeger": "^1.0.4",
@@ -23,8 +23,9 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
-    "@routr/common": "^2.0.8-alpha.3",
-    "fp-ts": "^2.11.8"
+    "@routr/common": "^2.0.8-alpha.30",
+    "fp-ts": "^2.11.8",
+    "phone": "^3.1.32"
   },
   "directories": {
     "src": "src",
@@ -43,5 +44,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "aad4c5c31af1fef5e657ee6b445879706757bbbf"
+  "gitHead": "6466c3e5262850c85dc6d15eec3e25f915a37667"
 }