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

package/dist/ip_utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLocalnet = exports.addressCount = exports.hasIp = exports.formatNet = 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 ip_utils_1 = require("ip-utils");
+const formatNet = (net) => {
+    if (net.split("/").length === 1) {
+        if ((0, ip_utils_1.isValidIpv4)(net))
+            return `${net}/32`;
+        if ((0, ip_utils_1.isValidIpv6)(net))
+            return `${net}/128`;
+        throw new Error("Invalid address! Must be a valid Ipv4 or Ipv6");
+    }
+    const p1 = net.split("/")[0];
+    const p2 = net.split("/")[1];
+    return (0, ip_utils_1.isValidIpv4)(p2)
+        ? `${p1}/${(0, ip_utils_1.subnetInfo)(p1, p2).cidrMask}`
+        : `${p1}/${p2}`;
+};
+exports.formatNet = formatNet;
+const hasIp = (net, addr) => (0, ip_utils_1.subnet)((0, exports.formatNet)(net)).contains(addr);
+exports.hasIp = hasIp;
+const addressCount = (net) => (0, ip_utils_1.cidrInfo)((0, exports.formatNet)(net)).inclusiveNumberHosts;
+exports.addressCount = addressCount;
+const isLocalnet = (nets, addr) => nets && nets.length > 0 && nets.filter((net) => (0, exports.hasIp)(net, addr)).length > 0;
+exports.isLocalnet = isLocalnet;

package/dist/protos/common.proto

@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 syntax = "proto3";
 
 package fonoster.routr.common.v2draft1;
@@ -8,8 +26,8 @@ option java_outer_classname = "CommonProto";
 option objc_class_prefix = "CM";
 
 enum Transport {
-  TCP = 0;
-  UDP = 1;
+  UDP = 0;
+  TCP = 1;
   TLS = 2;
   SCTP = 3;
   WS = 4;

package/dist/protos/location.proto

@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 syntax = "proto3";
 
 package fonoster.routr.location.v2draft1;
@@ -8,6 +26,7 @@ option java_outer_classname = "LocationProto";
 option objc_class_prefix = "LC";
 
 import "common.proto";
+import "processor.proto";
 
 service Location {
   rpc AddRoute (AddRouteRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
@@ -21,19 +40,15 @@ message Route {
   string host = 2;
   string port = 3;
   fonoster.routr.common.v2draft1.Transport transport = 4;
-  int32 registered_on = 5;
+  int64 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;
+  fonoster.routr.processor.v2draft1.NetInterface listening_point = 9;
+  // 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;
 }
 
 message AddRouteRequest {

package/dist/protos/processor.proto

@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 syntax = "proto3";
 
 package fonoster.routr.processor.v2draft1;
@@ -18,12 +36,34 @@ service Processor {
 
 enum Method {
   UNKNOWN = 0;
+  // Communicates user location (host name, IP)
   REGISTER = 1;
+  // Establishes a session
   INVITE = 2;
+  // Transports Instant Messages
   MESSAGE = 3;
+  // Publishes an event to the Server
   PUBLISH = 4;
+  // Notifies the subscriber of a new event
   NOTIFY = 5;
+  // Subscribes for Notification from the notifier
   SUBSCRIBE = 6;
+  // Confirms an INVITE request
+  ACK = 7;
+  // Terminates a session
+  BYE = 8;
+  // Cancels establishing of a session
+  CANCEL = 9;
+  // Communicates information about the capabilities of the calling and receiving SIP phones
+  OPTIONS = 10;
+  // Provisional Acknowledgement
+  PRACK = 11;
+  // Sends mid session information
+  INFO = 12;
+  // Asks the recipient to issue call transfer
+  REFER = 13;
+  // Modifies the state of a session
+  UPDATE = 14;
 }
 
 message NetInterface {
@@ -33,13 +73,16 @@ message NetInterface {
 }
 
 message MessageRequest {
+  // Same as the Call-Id header 
   string ref = 1;
-  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;
+  string edge_port_ref = 2;
+  Method method = 3;
+  NetInterface sender = 4;
+  NetInterface listening_point = 5;
+  repeated string external_ips = 6;
+  repeated string localnets = 7;
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 8;
+  // .google.protobuf.Struct metadata = 8;
 }
 
 message MessageResponse {

package/dist/protos/requester.proto

@@ -0,0 +1,47 @@
+/*
+ * 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.
+ */
+syntax = "proto3";
+
+package fonoster.routr.requester.v2draft1;
+
+option java_multiple_files = true;
+option java_package = "io.routr.requester";
+option java_outer_classname = "RequesterProto";
+option objc_class_prefix = "RP";
+
+import "common.proto";
+import "sipmessage.proto";
+import "processor.proto";
+
+// Requester service
+service Requester {
+  // Send Message Request
+  rpc SendMessage (SendMessageRequest) returns (SendMessageResponse) {}
+}
+
+message SendMessageRequest {
+  string target = 1;
+  fonoster.routr.processor.v2draft1.Method method = 2;
+  fonoster.routr.common.v2draft1.Transport transport = 3;
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 4;
+}
+
+message SendMessageResponse {
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 1;
+}

package/dist/protos/resources.proto

@@ -0,0 +1,107 @@
+// TODO: Show a link to were this proto was downloaded from
+syntax = "proto3";
+
+package fonoster.routr.resources.v2draft1;
+
+import "google/protobuf/struct.proto";
+
+// Resources service
+service Resources {
+  rpc Create (CreateRequest) returns (Resource) {}
+  rpc Update (UpdateRequest) returns (Resource) {}
+  rpc Get (GetRequest) returns (Resource) {}
+  rpc Delete (DeleteRequest) returns (Empty) {}
+  rpc List (ListRequest) returns (ListResponse) {}
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+message Metadata {
+  string ref = 1;
+  // The resource's name
+  string name = 2;
+  // Link to dependencies of this resource
+  repeated string depends_on = 3;
+  // Created at
+  int32 create_time = 4;
+  // Updated at
+  int32 update_time = 5;
+}
+
+message Resource {
+  // The resources's metadata
+
+  // The resource's metadata
+  Metadata metadata = 1;
+  // The resource's data
+  .google.protobuf.Struct spec = 2;
+}
+
+message CreateRequest  {
+  Metadata metadata = 1;
+  .google.protobuf.Struct spec = 2;
+}
+
+message UpdateRequest  {
+  Metadata metadata = 1;
+  .google.protobuf.Struct spec = 2;
+}
+
+message DeleteRequest  {
+  string ref = 1;
+}
+
+message GetRequest  {
+  string ref = 1;
+}
+
+message ListRequest {
+  // The maximum number of items in the list
+  int32 page_size = 1;
+
+  // The next_page_token value returned from the previous request, if any
+  string page_token = 2;
+
+  // The filter to apply to the list
+  string filter = 3;
+
+  // The type of resource to list
+  string kind = 4;
+
+  // Level of detail of the individual entities (reserved)
+  View view = 5;
+}
+
+message ListResponse {
+  // List of Resources
+  repeated Resource resources = 1;
+
+  // Token to retrieve the next page of results, or empty if there are no more results in the list
+  string next_page_token = 2;
+}
+
+message FindByRequest {
+  // The type of resource to find
+  string kind = 1;
+
+  // Search criteria for the request
+  string criteria = 2;
+
+  // Parameters to apply in combination with the search criteria
+  .google.protobuf.Struct parameters = 3; 
+
+  // Level of detail of the individual entities (reserved)
+  View view = 4;
+}
+
+message FindByResponse {
+  // List of Resources
+  repeated Resource resources = 1;
+}
+
+enum View {
+  BASIC = 0;
+  STANDARD = 1;
+  FULL = 2;
+}
+
+message Empty {}

package/dist/protos/sipmessage.proto

@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 syntax = "proto3";
 
 package fonoster.routr.sipmessage.v2draft1;
@@ -53,7 +71,7 @@ enum ResponseType {
   BAD_EVENT = 42;
   REQUEST_PENDING = 43;
   UNDECIPHERABLE = 44;
-  SERVER_ERROR =45;
+  SERVER_ERROR = 45;
   SERVER_INTERNAL_ERROR = 46;
   NOT_IMPLEMENTED = 47;
   BAD_GATEWAY = 48;
@@ -68,6 +86,32 @@ enum ResponseType {
   SESSION_NOT_ACCEPTABLE = 57;
 }
 
+message WWWAuthenticate {
+  string realm = 1;
+  string domain = 2;
+  string scheme = 3;
+  string nonce = 4;
+  string algorithm = 5;
+  string qop = 6;
+  string opaque = 7;
+  bool stale = 8;
+}
+
+message Authorization {
+  string realm = 1;
+  string scheme = 2;
+  string c_nonce = 3;
+  string nonce = 4;
+  string algorithm = 5;
+  string qop = 6;
+  string opaque = 7;
+  string response = 8;
+  string username = 9;
+  string uri = 10;
+  string method = 11;
+  int32 nonce_count = 12;
+}
+
 message CallID {
   string call_id = 1;
 }
@@ -96,10 +140,11 @@ message SipURI {
   string m_addr_param = 5;
   string method_param = 6;
   string user_param = 7;
-  int32 t_t_l_param = 8;
+  int32 ttl_param = 8;
   int32 port = 9;
   bool lr_param = 10;
-  bool secure = 11;
+  bool bnc_param = 11;
+  bool secure = 12;
 }
 
 message Address {
@@ -108,14 +153,36 @@ message Address {
   bool wildcard = 3;
 }
 
+message MaxForwards {
+  int32 max_forwards = 1;
+}
+
+message Route {
+  Address address = 1;
+  map<string, string> parameters = 2;
+}
+
+message RecordRoute {
+  Address address = 1;
+  map<string, string> parameters = 2;
+}
+
 message From {
   Address address = 1;
   string tag = 2;
+  map<string, string> parameters = 3;
 }
 
 message To {
   Address address = 1;
   string tag = 2;
+  map<string, string> parameters = 3;
+}
+
+message Contact {
+  Address address = 1;
+  int32 expires = 2;
+  float q_value = 3;
 }
 
 message Expires {
@@ -129,9 +196,15 @@ message SIPMessage {
   }
   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;
+  Contact contact = 5;
+  CallID call_id = 6;
+  ContentLength content_length = 7;
+  Expires expires = 8;
+  WWWAuthenticate www_authenticate = 9;
+  MaxForwards max_forwards = 10;
+  Authorization authorization = 11;
+  repeated Extension extensions = 12;
+  repeated Via via = 13;
+  repeated Route route = 14;
+  repeated RecordRoute record_route = 15;
 }

package/dist/redis.d.ts

@@ -0,0 +1,8 @@
+export interface RedisStoreConfig {
+    username?: string;
+    password?: string;
+    host: string;
+    port: number;
+    secure?: boolean;
+}
+export declare const getRedisUrlFromConfig: (config: RedisStoreConfig) => string;

package/dist/redis.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedisUrlFromConfig = void 0;
+const getRedisUrlFromConfig = (config) => {
+    return (`redis${config.secure ? "s" : ""}` +
+        `://${config.username ? config.username : ""}` +
+        `${config.password ? ":" + config.password + "@" : ""}` +
+        `${config.host}:${config.port}`);
+};
+exports.getRedisUrlFromConfig = getRedisUrlFromConfig;

package/dist/requester/grpc_client.d.ts

@@ -0,0 +1 @@
+export declare const REQUESTER_PROTO: any;

package/dist/requester/grpc_client.js

@@ -0,0 +1,56 @@
+"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.REQUESTER_PROTO = 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 grpc = __importStar(require("@grpc/grpc-js"));
+const protoLoader = require("@grpc/proto-loader");
+const packageDefinition = protoLoader.loadSync(__dirname + "/../protos/requester.proto", {
+    keepCase: false,
+    longs: String,
+    enums: String,
+    defaults: true,
+    oneofs: true
+});
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const protoDescriptor = grpc.loadPackageDefinition(packageDefinition);
+exports.REQUESTER_PROTO = protoDescriptor.fonoster.routr.requester;

package/dist/requester/index.d.ts

@@ -0,0 +1 @@
+export * from "./grpc_client";

package/dist/requester/index.js

@@ -0,0 +1,35 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2022 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.
+ */
+__exportStar(require("./grpc_client"), exports);

package/dist/service.d.ts

@@ -1,6 +1,17 @@
 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 const PROCESSOR_OBJECT_PROTO: unknown;
+export declare const LOCATION_OBJECT_PROTO: unknown;
+/**
+ * Gets the proto definition for the given object.
+ *
+ * @param {ObjectProt} objectProto - The object proto to load.
+ * @return {A} The proto definition.
+ */
 export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFound;
+/**
+ * Creates a new service using the given service definition.
+ *
+ * @param {ServiceInfo} serviceInfo - The service info to create the service from.
+ */
 export default function createService(serviceInfo: ServiceInfo): void;