@routr/common 2.0.8-alpha.3 → 2.0.8-alpha.31

package/dist/ip_utils.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLocalnetIp = exports.isLocalnet = exports.addressCount = exports.hasIp = exports.formatNet = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/protos/common.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -33,5 +33,3 @@ enum Transport {
   WS = 4;
   WSS = 5;
 }
-
-message Empty {}

package/dist/protos/location.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -25,16 +25,17 @@ option java_package = "io.routr.location";
 option java_outer_classname = "LocationProto";
 option objc_class_prefix = "LC";
 
+import "google/protobuf/empty.proto";
 import "common.proto";
 import "processor.proto";
 
 service Location {
-  rpc AddRoute (AddRouteRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+  rpc AddRoute (AddRouteRequest) returns (.google.protobuf.Empty) {}
   rpc FindRoutes (FindRoutesRequest) returns (FindRoutesResponse) {}
-  rpc RemoveRoutes (RemoveRoutesRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+  rpc RemoveRoutes (RemoveRoutesRequest) returns (.google.protobuf.Empty) {}
 }
 
-// A binding create by an actual endpoint (Softphone, PBX, Conference System, etc.)
+// A binding created by an actual endpoint (Softphone, PBX, Conference System, etc.)
 message Route {
   string user = 1;
   string host = 2;
@@ -44,11 +45,13 @@ message Route {
   int32 expires = 6;
   int32 session_count = 7;
   string edge_port_ref = 8;
-  fonoster.routr.processor.v2draft1.NetInterface egress_listening_point = 9;
+  repeated fonoster.routr.processor.v2draft1.NetInterface listening_points = 9;
+  repeated string localnets = 10;
+  repeated string external_addrs = 11;
   // During route creation, an endpoint can request to add labels than can later be
   // used as selectors. For example, a Softphone can add a label `priority=1` to indicate
   // that it is the prefered endpoint for the given AOR.
-  map<string, string> labels = 10;
+  map<string, string> labels = 12;
 }
 
 message AddRouteRequest {
@@ -58,8 +61,20 @@ message AddRouteRequest {
 }
 
 message FindRoutesRequest {
-  string aor = 1;
-  map<string, string> labels = 2;
+  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;
+  Backend backend = 4;
+  map<string, string> labels = 5;
 }
 
 message FindRoutesResponse {

package/dist/protos/processor.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -86,5 +86,6 @@ message MessageRequest {
 }
 
 message MessageResponse {
-  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 1;
+  NetInterface sender = 1;
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 2;
 }

package/dist/protos/requester.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/protos/sipmessage.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -130,6 +130,11 @@ message Via {
   int32 port = 2;
   string branch = 3;
   string transport = 4;
+  bool r_port_flag = 5;
+  int32 r_port = 6;
+  string received = 7;
+  string m_addr = 8;
+  int32 ttl = 9;
 }
 
 message SipURI {
@@ -207,4 +212,6 @@ message SIPMessage {
   repeated Via via = 13;
   repeated Route route = 14;
   repeated RecordRoute record_route = 15;
+  string reason_phrase = 16;
+  string body = 17;
 }

package/dist/requester/grpc_client.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.REQUESTER_PROTO = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/requester/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster
  *
  * This file is part of Routr.

package/dist/service.d.ts

@@ -1,5 +1,5 @@
 import { ObjectProto, ServiceInfo } from "./types";
-import { ServiceDefinitionNotFound } from "./errors";
+import { ServiceDefinitionNotFoundError } from "./errors";
 export declare const PROCESSOR_OBJECT_PROTO: unknown;
 export declare const LOCATION_OBJECT_PROTO: unknown;
 /**
@@ -8,7 +8,7 @@ export declare const LOCATION_OBJECT_PROTO: unknown;
  * @param {ObjectProt} objectProto - The object proto to load.
  * @return {A} The proto definition.
  */
-export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFound;
+export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFoundError;
 /**
  * Creates a new service using the given service definition.
  *

package/dist/service.js

@@ -24,10 +24,31 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getObjectProto = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = void 0;
-const errors_1 = require("./errors");
+/*
+ * Copyright (C) 2023 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 grpc = __importStar(require("@grpc/grpc-js"));
 const protoLoader = __importStar(require("@grpc/proto-loader"));
+const errors_1 = require("./errors");
 const logger_1 = require("@fonoster/logger");
+const grpc_health_check_1 = require("@fonoster/grpc-health-check");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const interceptor = require("grpc-interceptors");
 const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
 const loadOptions = {
     keepCase: false,
@@ -62,7 +83,7 @@ function getObjectProto(objectProto) {
     const objProto = (_b = (_a = grpc.loadPackageDefinition(definitions)) === null || _a === void 0 ? void 0 : _a.fonoster) === null || _b === void 0 ? void 0 : _b.routr[objectProto.name];
     return (objProto === null || objProto === void 0 ? void 0 : objProto[objectProto.version])
         ? objProto[objectProto.version]
-        : new errors_1.ServiceDefinitionNotFound(objectProto.name, objectProto.version);
+        : new errors_1.ServiceDefinitionNotFoundError(objectProto.name, objectProto.version);
 }
 exports.getObjectProto = getObjectProto;
 /**
@@ -76,11 +97,12 @@ function createService(serviceInfo) {
             name: serviceInfo.name,
             bindAddr: serviceInfo.bindAddr
         });
-        server.start();
+        withHealthChecks.start();
     };
     const credentials = grpc.ServerCredentials.createInsecure();
     const server = new grpc.Server();
     server.addService(serviceInfo.service, serviceInfo.handlers);
-    server.bindAsync(serviceInfo.bindAddr, credentials, cb);
+    const withHealthChecks = interceptor.serverProxy((0, grpc_health_check_1.useHealth)(server));
+    withHealthChecks.bindAsync(serviceInfo.bindAddr, credentials, cb);
 }
 exports.default = createService;

package/dist/tracer.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/types.d.ts

@@ -1,4 +1,7 @@
+import * as grpc from "@grpc/grpc-js";
 import { ServiceDefinition } from "@grpc/proto-loader";
+import { JsonArray, JsonValue, Struct } from "pb-util/build";
+export type JsonData = Record<string, string | number | boolean | JsonValue | JsonArray | Struct>;
 export declare enum Method {
     UNKNOWN = "UNKNOWN",
     REGISTER = "REGISTER",
@@ -13,23 +16,33 @@ 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 {
+    UNSPECIFIED = "UNSPECIFIED",
+    ROUND_ROBIN = "ROUND_ROBIN",
+    LEAST_SESSIONS = "LEAST_SESSIONS"
 }
 export declare enum ExtraHeader {
     REQUEST_URI = "X-Request-Uri",
     GATEWAY_AUTH = "X-Gateway-Auth",
     EDGEPORT_REF = "X-Edgeport-Ref",
-    SESSION_COUNT = "X-Session-Count"
+    SESSION_COUNT = "X-Session-Count",
+    DOD_NUMBER = "X-DOD-Number",
+    DOD_PRIVACY = "X-DOD-Privacy"
 }
 export declare enum Privacy {
-    NONE = "none",
-    PRIVATE = "id"
+    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;
@@ -57,6 +70,7 @@ export interface ProcessorConfig {
 export interface MiddlewareConfig {
     ref: string;
     addr: string;
+    postProcessor: boolean;
 }
 export interface ServiceInfo {
     name: string;
@@ -72,32 +86,32 @@ export interface ObjectProto {
 export interface AuthChallengeRequest {
     realm: string;
     domain: string;
-    scheme: string;
-    nonce: string;
-    algorithm: string;
-    qop: string;
     opaque: string;
     stale: boolean;
+    nonce: string;
+    scheme: AuthorizationScheme;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
 }
 export interface AuthChallengeResponse {
     realm: string;
     domain: string;
-    scheme: string;
     cNonce: string;
+    nonce: string;
     nonceCount: number;
     response: string;
     username: string;
-    nonce: string;
-    algorithm: string;
-    qop: string;
     opaque: string;
     stale: boolean;
     uri: string;
-    method: string;
+    method: Method;
+    scheme: AuthorizationScheme;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
 }
 export declare enum HeaderModifierAction {
-    ADD = "add",
-    REMOVE = "remove"
+    ADD = 0,
+    REMOVE = 1
 }
 export interface HeaderModifier {
     name: string;
@@ -110,72 +124,81 @@ export interface Route {
     port: number;
     transport: Transport;
     registeredOn?: number;
+    /**
+     * Number of active sessions. This is used to determine if a route is
+     * overloaded and for load balancing.
+     *
+     * This value is reported by the endpoint during the REGISTER request,
+     * using the X-Session-Count header.
+     */
     sessionCount?: number;
     expires?: number;
     edgePortRef: string;
-    egressListeningPoint: NetInterface;
+    listeningPoints: NetInterface[];
+    localnets: string[];
+    externalAddrs: string[];
     labels?: Map<string, string>;
     headers?: HeaderModifier[];
 }
 export declare enum ResponseType {
-    UNKNOWN = 0,
-    TRYING = 1,
-    RINGING = 2,
-    CALL_IS_BEING_FORWARDED = 3,
-    QUEUED = 4,
-    SESSION_PROGRESS = 5,
-    SUCCESS = 6,
-    OK = 7,
-    ACCEPTED = 8,
-    REDIRECTION = 9,
-    MULTIPLE_CHOICES = 10,
-    MOVED_PERMANENTLY = 11,
-    MOVED_TEMPORARILY = 12,
-    USE_PROXY = 13,
-    ALTERNATIVE_SERVICE = 14,
-    CLIENT_ERROR = 15,
-    BAD_REQUEST = 16,
-    UNAUTHORIZED = 17,
-    PAYMENT_REQUIRED = 18,
-    FORBIDDEN = 19,
-    NOT_FOUND = 20,
-    METHOD_NOT_ALLOWED = 21,
-    NOT_ACCEPTABLE = 22,
-    PROXY_AUTHENTICATION_REQUIRED = 23,
-    REQUEST_TIMEOUT = 24,
-    GONE = 25,
-    REQUEST_ENTITY_TOO_LARGE = 26,
-    REQUEST_URI_TOO_LONG = 27,
-    UNSUPPORTED_MEDIA_TYPE = 28,
-    UNSUPPORTED_URI_SCHEME = 29,
-    BAD_EXTENSION = 30,
-    EXTENSION_REQUIRED = 31,
-    INTERVAL_TOO_BRIEF = 32,
-    TEMPORARILY_UNAVAILABLE = 33,
-    CALL_OR_TRANSACTION_DOES_NOT_EXIST = 34,
-    LOOP_DETECTED = 35,
-    TOO_MANY_HOPS = 36,
-    ADDRESS_INCOMPLETE = 37,
-    AMBIGUOUS = 38,
-    BUSY_HERE = 39,
-    REQUEST_TERMINATED = 40,
-    NOT_ACCEPTABLE_HERE = 41,
-    BAD_EVENT = 42,
-    REQUEST_PENDING = 43,
-    UNDECIPHERABLE = 44,
-    SERVER_ERROR = 45,
-    SERVER_INTERNAL_ERROR = 46,
-    NOT_IMPLEMENTED = 47,
-    BAD_GATEWAY = 48,
-    SERVICE_UNAVAILABLE = 49,
-    SERVER_TIMEOUT = 50,
-    VERSION_NOT_SUPPORTED = 51,
-    MESSAGE_TOO_LARGE = 52,
-    GLOBAL_ERROR = 53,
-    BUSY_EVERYWHERE = 54,
-    DECLINE = 55,
-    DOES_NOT_EXIST_ANYWHERE = 56,
-    SESSION_NOT_ACCEPTABLE = 57
+    UNKNOWN = "UNKNOWN",
+    TRYING = "TRYING",
+    RINGING = "RINGING",
+    CALL_IS_BEING_FORWARDED = "CALL_IS_BEING_FORWARDED",
+    QUEUED = "QUEUED",
+    SESSION_PROGRESS = "SESSION_PROGRESS",
+    SUCCESS = "SUCCESS",
+    OK = "OK",
+    ACCEPTED = "ACCEPTED",
+    REDIRECTION = "REDIRECTION",
+    MULTIPLE_CHOICES = "MULTIPLE_CHOICES",
+    MOVED_PERMANENTLY = "MOVED_PERMANENTLY",
+    MOVED_TEMPORARILY = "MOVED_TEMPORARILY",
+    USE_PROXY = "USE_PROXY",
+    ALTERNATIVE_SERVICE = "ALTERNATIVE_SERVICE",
+    CLIENT_ERROR = "CLIENT_ERROR",
+    BAD_REQUEST = "BAD_REQUEST",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    PAYMENT_REQUIRED = "PAYMENT_REQUIRED",
+    FORBIDDEN = "FORBIDDEN",
+    NOT_FOUND = "NOT_FOUND",
+    METHOD_NOT_ALLOWED = "METHOD_NOT_ALLOWED",
+    NOT_ACCEPTABLE = "NOT_ACCEPTABLE",
+    PROXY_AUTHENTICATION_REQUIRED = "PROXY_AUTHENTICATION_REQUIRED",
+    REQUEST_TIMEOUT = "REQUEST_TIMEOUT",
+    GONE = "GONE",
+    REQUEST_ENTITY_TOO_LARGE = "REQUEST_ENTITY_TOO_LARGE",
+    REQUEST_URI_TOO_LONG = "REQUEST_URI_TOO_LONG",
+    UNSUPPORTED_MEDIA_TYPE = "UNSUPPORTED_MEDIA_TYPE",
+    UNSUPPORTED_URI_SCHEME = "UNSUPPORTED_URI_SCHEME",
+    BAD_EXTENSION = "BAD_EXTENSION",
+    EXTENSION_REQUIRED = "EXTENSION_REQUIRED",
+    INTERVAL_TOO_BRIEF = "INTERVAL_TOO_BRIEF",
+    TEMPORARILY_UNAVAILABLE = "TEMPORARILY_UNAVAILABLE",
+    CALL_OR_TRANSACTION_DOES_NOT_EXIST = "CALL_OR_TRANSACTION_DOES_NOT_EXIST",
+    LOOP_DETECTED = "LOOP_DETECTED",
+    TOO_MANY_HOPS = "TOO_MANY_HOPS",
+    ADDRESS_INCOMPLETE = "ADDRESS_INCOMPLETE",
+    AMBIGUOUS = "AMBIGUOUS",
+    BUSY_HERE = "BUSY_HERE",
+    REQUEST_TERMINATED = "REQUEST_TERMINATED",
+    NOT_ACCEPTABLE_HERE = "NOT_ACCEPTABLE_HERE",
+    BAD_EVENT = "BAD_EVENT",
+    REQUEST_PENDING = "REQUEST_PENDING",
+    UNDECIPHERABLE = "UNDECIPHERABLE",
+    SERVER_ERROR = "SERVER_ERROR",
+    SERVER_INTERNAL_ERROR = "SERVER_INTERNAL_ERROR",
+    NOT_IMPLEMENTED = "NOT_IMPLEMENTED",
+    BAD_GATEWAY = "BAD_GATEWAY",
+    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
+    SERVER_TIMEOUT = "SERVER_TIMEOUT",
+    VERSION_NOT_SUPPORTED = "VERSION_NOT_SUPPORTED",
+    MESSAGE_TOO_LARGE = "MESSAGE_TOO_LARGE",
+    GLOBAL_ERROR = "GLOBAL_ERROR",
+    BUSY_EVERYWHERE = "BUSY_EVERYWHERE",
+    DECLINE = "DECLINE",
+    DOES_NOT_EXIST_ANYWHERE = "DOES_NOT_EXIST_ANYWHERE",
+    SESSION_NOT_ACCEPTABLE = "SESSION_NOT_ACCEPTABLE"
 }
 export interface WWWAuthenticate {
     realm: string;
@@ -189,17 +212,17 @@ export interface WWWAuthenticate {
 }
 export interface Authorization {
     realm: string;
-    scheme: string;
+    scheme: AuthorizationScheme;
     nonce: string;
     cNonce: string;
     nonceCount: number;
     response: string;
     username: string;
     uri: string;
-    algorithm: string;
-    qop: string;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
     opaque: string;
-    method?: string;
+    method?: Method;
 }
 export interface CallID {
     callId: string;
@@ -216,12 +239,17 @@ export interface Via {
     port: number;
     branch?: string;
     transport: Transport;
+    received?: string;
+    rPortFlag?: boolean;
+    rPort?: number;
+    ttl?: number;
+    mAddr?: string;
 }
 export interface SipURI {
     user?: string;
     host: string;
     port?: number;
-    transportParam: string;
+    transportParam: Transport;
     mAddrParam?: string;
     userParam?: string;
     ttlParam?: number;
@@ -281,10 +309,11 @@ export interface SIPMessage {
     wwwAuthenticate?: WWWAuthenticate;
     maxForwards: MaxForwards;
     authorization?: Authorization;
-    extensions?: Extension[];
-    via?: Via[];
-    route?: RouteHeader[];
-    recordRoute?: RecordRoute[];
+    extensions: Extension[];
+    via: Via[];
+    route: RouteHeader[];
+    recordRoute: RecordRoute[];
+    body?: string;
 }
 export interface GrpcCallback {
     (error: Error | {
@@ -293,4 +322,5 @@ export interface GrpcCallback {
 }
 export interface GrpcCall {
     request: Record<string, any>;
+    metadata?: grpc.Metadata;
 }