@routr/common 2.0.5-alpha.1 → 2.0.5-alpha.2

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-import createService, { PROCESSOR_OBJECT_PROTO, getObjectProto } from "./service";
+import createService, { PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO, getObjectProto } from "./service";
 import { Transport, ProcessorConfig, MessageRequest, NetInterface, Method, Direction, ObjectProto, ServiceInfo } from "./types";
-export { createService, getObjectProto, Transport, ProcessorConfig, MessageRequest, NetInterface, Method, Direction, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO };
+export { createService, getObjectProto, Transport, ProcessorConfig, MessageRequest, NetInterface, Method, Direction, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };

package/dist/index.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROCESSOR_OBJECT_PROTO = exports.getObjectProto = exports.createService = void 0;
+exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.getObjectProto = exports.createService = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -41,4 +41,5 @@ exports.PROCESSOR_OBJECT_PROTO = exports.getObjectProto = exports.createService
 var service_1 = __importStar(require("./service"));
 exports.createService = service_1.default;
 Object.defineProperty(exports, "PROCESSOR_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.PROCESSOR_OBJECT_PROTO; } });
+Object.defineProperty(exports, "LOCATION_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.LOCATION_OBJECT_PROTO; } });
 Object.defineProperty(exports, "getObjectProto", { enumerable: true, get: function () { return service_1.getObjectProto; } });

package/dist/protos/common.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package fonoster.routr.common.v2draft1;
+
+option java_multiple_files = true;
+option java_package = "io.routr.common";
+option java_outer_classname = "CommonProto";
+option objc_class_prefix = "CM";
+
+enum Transport {
+  TCP = 0;
+  UDP = 1;
+  TLS = 2;
+  SCTP = 3;
+  WS = 4;
+  WSS = 5;
+}
+
+message Empty {}

package/dist/protos/location.proto

@@ -0,0 +1,56 @@
+syntax = "proto3";
+
+package fonoster.routr.location.v2draft1;
+
+option java_multiple_files = true;
+option java_package = "io.routr.location";
+option java_outer_classname = "LocationProto";
+option objc_class_prefix = "LC";
+
+import "common.proto";
+
+service Location {
+  rpc AddRoute (AddRouteRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+  rpc FindRoutes (FindRoutesRequest) returns (FindRoutesResponse) {}
+  rpc RemoveRoutes (RemoveRoutesRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+}
+
+// A binding create by an actual endpoint (Softphone, PBX, Conference System, etc.)
+message Route {
+  string user = 1;
+  string host = 2;
+  string port = 3;
+  fonoster.routr.common.v2draft1.Transport transport = 4;
+  int32 registered_on = 5;
+  int32 expires = 6;
+  int32 session_count = 7;
+  string edge_port_ref = 8;
+  // During route creation, an endpoint can requet to add labels than can later be
+  // used as selector. For example, a Softphone can add a label `priority=1` to indicate
+  // that it is the prefer endpoint for the given AOR. 
+  //
+  // Another use case is to use the label to determine which endpoint will back certain 
+  // feature. For example, we could use the label `backend=voice` to indicate that this
+  // route can serve voice applications. If the FindRoutes method includes the label the 
+  // Location Service will only return routes that includes such label.
+  map<string, string> labels = 9;
+}
+
+message AddRouteRequest {
+  // Address of record for the endpoint or trunk
+  string aor = 1;
+  Route route = 2;
+}
+
+message FindRoutesRequest {
+  string aor = 1;
+  map<string, string> labels = 2;
+}
+
+message FindRoutesResponse {
+  repeated Route routes = 1;
+}
+
+message RemoveRoutesRequest {
+  string aor = 1;
+}

package/dist/protos/processor.proto

@@ -1,28 +1,19 @@
 syntax = "proto3";
 
+package fonoster.routr.processor.v2draft1;
+
 option java_multiple_files = true;
-option java_package = "io.routr";
+option java_package = "io.routr.processor";
 option java_outer_classname = "ProcessorProto";
 option objc_class_prefix = "PR";
 
-package fonoster.routr.processor.v2draft1;
+import "common.proto";
+import "sipmessage.proto";
 
 // Processor service
 service Processor {
   // Process Message Request
-  rpc ProcessMessage (MessageRequest) returns (MessageRequest) {}
-}
-
-// Message process IN or OUT
-enum Direction {
-  IN = 0;
-  OUT = 1;
-}
-
-// Message process IN or OUT
-enum Type {
-  REQUEST = 0;
-  RESPONSE = 1;
+  rpc ProcessMessage (MessageRequest) returns (MessageResponse) {}
 }
 
 enum Method {
@@ -35,32 +26,22 @@ enum Method {
   SUBSCRIBE = 6;
 }
 
-enum Transport {
-  TCP = 0;
-  UDP = 1;
-  TLS = 2;
-  SCTP = 3;
-  WS = 4;
-  WSS = 5;
-}
-
 message NetInterface {
   string host = 1;
   int32 port = 2;
-  Transport transport = 3;
-}
-
-message SIPMessage {
-  string call_id = 1;
+  fonoster.routr.common.v2draft1.Transport transport = 3;
 }
 
 message MessageRequest {
   string ref = 1;
-  Type type = 2;
-  Method method = 3;
-  Direction direction = 4;
-  // .google.protobuf.Struct metadata = 5
-  NetInterface origin_interface = 6;
-  NetInterface target_interface = 7;
-  SIPMessage sip_message = 8;
+  Method method = 2;
+  NetInterface sender = 3;
+  repeated NetInterface external_addrs = 4;
+  repeated string localnets = 5;
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 6;
+  // .google.protobuf.Struct metadata = 7;
+}
+
+message MessageResponse {
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 1;
 }

package/dist/protos/sipmessage.proto

@@ -0,0 +1,137 @@
+syntax = "proto3";
+
+package fonoster.routr.sipmessage.v2draft1;
+
+option java_multiple_files = true;
+option java_package = "io.routr.message";
+option java_outer_classname = "SIPMessageProto";
+option objc_class_prefix = "SM";
+
+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;
+}
+
+message CallID {
+  string call_id = 1;
+}
+
+message ContentLength {
+  int32 content_length = 1;
+}
+
+message Extension {
+  string name = 1;
+  string value = 2;
+}
+
+message Via {
+  string host = 1;
+  int32 port = 2;
+  string branch = 3;
+  string transport = 4;
+}
+
+message SipURI {
+  string user = 1;
+  string user_password = 2;
+  string host = 3;
+  string transport_param = 4;
+  string m_addr_param = 5;
+  string method_param = 6;
+  string user_param = 7;
+  int32 t_t_l_param = 8;
+  int32 port = 9;
+  bool lr_param = 10;
+  bool secure = 11;
+}
+
+message Address {
+  SipURI uri = 1;
+  string display_name = 2;
+  bool wildcard = 3;
+}
+
+message From {
+  Address address = 1;
+  string tag = 2;
+}
+
+message To {
+  Address address = 1;
+  string tag = 2;
+}
+
+message Expires {
+  int32 expires = 1;
+}
+
+message SIPMessage {
+  oneof message_type {
+    ResponseType response_type = 1;
+    SipURI request_uri = 2;
+  }
+  From from = 3;
+  To to = 4;
+  CallID call_id = 5;
+  ContentLength content_length = 6;
+  Expires expires = 7;
+  repeated Via via = 8;
+  repeated Extension extensions = 9;
+}

package/dist/service.d.ts

@@ -1,5 +1,6 @@
 import { ObjectProto, ServiceInfo } from "./types";
 import { ServiceDefinitionNotFound } from "./errors";
 export declare const PROCESSOR_OBJECT_PROTO: any;
+export declare const LOCATION_OBJECT_PROTO: any;
 export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFound;
 export default function createService(serviceInfo: ServiceInfo): void;

package/dist/service.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getObjectProto = exports.PROCESSOR_OBJECT_PROTO = void 0;
+exports.getObjectProto = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = void 0;
 var errors_1 = require("./errors");
 var logger_1 = __importDefault(require("@fonoster/logger"));
 var protoLoader = require('@grpc/proto-loader');
@@ -21,6 +21,11 @@ exports.PROCESSOR_OBJECT_PROTO = getObjectProto({
     version: "v2draft1",
     path: __dirname + '/protos/processor.proto'
 });
+exports.LOCATION_OBJECT_PROTO = getObjectProto({
+    name: "location",
+    version: "v2draft1",
+    path: __dirname + '/protos/location.proto'
+});
 function getObjectProto(objectProto) {
     var _a, _b;
     var definitions = protoLoader.loadSync(objectProto.path, loadOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.5-alpha.1",
+  "version": "2.0.5-alpha.2",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -15,7 +15,8 @@
   "dependencies": {
     "@fonoster/logger": "^0.3.3",
     "@grpc/grpc-js": "^1.5.5",
-    "@grpc/proto-loader": "^0.6.9"
+    "@grpc/proto-loader": "^0.6.9",
+    "fp-ts": "^2.11.8"
   },
   "directories": {
     "src": "src",
@@ -34,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "12ed1225fc28e8dfed240522319d8f8178620586"
+  "gitHead": "3570106be9a96cb6672de4a850a377bfa7d9bb3e"
 }