@routr/common 2.0.5-alpha.9 → 2.0.6-alpha.1

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;
@@ -22,19 +40,14 @@ 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;
   fonoster.routr.processor.v2draft1.NetInterface listening_point = 9;
-  // 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.
+  // 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;
 }
 

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 {

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,109 @@
+// 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 resource's api version
+  string apiVersion = 1;
+  // The resource's kind
+  string kind = 2;
+  // The resource's metadata
+  Metadata metadata = 3;
+  // The resource's data
+  .google.protobuf.Struct spec = 4;
+}
+
+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;
@@ -90,7 +108,8 @@ message Authorization {
   string response = 8;
   string username = 9;
   string uri = 10;
-  int32 nonce_count = 11;
+  string method = 11;
+  int32 nonce_count = 12;
 }
 
 message CallID {
@@ -124,23 +143,40 @@ message SipURI {
   int32 ttl_param = 8;
   int32 port = 9;
   bool lr_param = 10;
-  bool secure = 11;
+  bool bnc_param = 11;
+  bool secure = 12;
 }
 
 message Address {
   SipURI uri = 1;
-  string displayName = 2;
+  string display_name = 2;
   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 {
@@ -164,8 +200,11 @@ message SIPMessage {
   CallID call_id = 6;
   ContentLength content_length = 7;
   Expires expires = 8;
-  repeated Via via = 9;
-  repeated Extension extensions = 10;
-  WWWAuthenticate www_authenticate = 11;
-  Authorization authorization = 12;
+  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;

package/dist/service.js

@@ -1,13 +1,34 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.getObjectProto = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = void 0;
 const errors_1 = require("./errors");
-const logger_1 = __importDefault(require("@fonoster/logger"));
-const protoLoader = require('@grpc/proto-loader');
-const grpc = require('@grpc/grpc-js');
+const grpc = __importStar(require("@grpc/grpc-js"));
+const protoLoader = __importStar(require("@grpc/proto-loader"));
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
 const loadOptions = {
     keepCase: false,
     longs: String,
@@ -15,29 +36,46 @@ const loadOptions = {
     defaults: true,
     oneofs: true
 };
+// TODO: Get version from the proto or package
+const API_VERSION = "v2draft1";
 // We currenly don't have a way to obtain the proto type
 exports.PROCESSOR_OBJECT_PROTO = getObjectProto({
     name: "processor",
-    version: "v2draft1",
-    path: __dirname + '/protos/processor.proto'
+    version: API_VERSION,
+    path: __dirname + "/protos/processor.proto"
 });
 exports.LOCATION_OBJECT_PROTO = getObjectProto({
     name: "location",
-    version: "v2draft1",
-    path: __dirname + '/protos/location.proto'
+    version: API_VERSION,
+    path: __dirname + "/protos/location.proto"
 });
+/**
+ * Gets the proto definition for the given object.
+ *
+ * @param {ObjectProt} objectProto - The object proto to load.
+ * @return {A} The proto definition.
+ */
 function getObjectProto(objectProto) {
     var _a, _b;
     const definitions = protoLoader.loadSync(objectProto.path, loadOptions);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     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 && objProto[objectProto.version]
+    return (objProto === null || objProto === void 0 ? void 0 : objProto[objectProto.version])
         ? objProto[objectProto.version]
         : new errors_1.ServiceDefinitionNotFound(objectProto.name, objectProto.version);
 }
 exports.getObjectProto = getObjectProto;
+/**
+ * Creates a new service using the given service definition.
+ *
+ * @param {ServiceInfo} serviceInfo - The service info to create the service from.
+ */
 function createService(serviceInfo) {
     const cb = () => {
-        logger_1.default.info(`starting ${serviceInfo.name} service @ ${serviceInfo.bindAddr}`);
+        logger.info("starting routr service", {
+            name: serviceInfo.name,
+            bindAddr: serviceInfo.bindAddr
+        });
         server.start();
     };
     const credentials = grpc.ServerCredentials.createInsecure();

package/dist/tracer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
+export declare function init(serviceName: string): import("@opentelemetry/api").Tracer;

package/dist/tracer.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = 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 api_1 = __importDefault(require("@opentelemetry/api"));
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const exporter_jaeger_1 = require("@opentelemetry/exporter-jaeger");
+const instrumentation_grpc_1 = require("@opentelemetry/instrumentation-grpc");
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
+function init(serviceName) {
+    const provider = new sdk_trace_node_1.NodeTracerProvider({
+        resource: new resources_1.Resource({
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName
+        })
+    });
+    const exporter = new exporter_jaeger_1.JaegerExporter();
+    provider.addSpanProcessor(new sdk_trace_base_1.SimpleSpanProcessor(exporter));
+    provider.register();
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [new instrumentation_grpc_1.GrpcInstrumentation()]
+    });
+    return api_1.default.trace.getTracer("routr-tracer");
+}
+exports.init = init;