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

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

@@ -62,7 +62,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;
 /**

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;
@@ -72,32 +85,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,10 +123,19 @@ 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[];
 }
@@ -189,17 +211,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;
@@ -221,7 +243,7 @@ export interface SipURI {
     user?: string;
     host: string;
     port?: number;
-    transportParam: string;
+    transportParam: Transport;
     mAddrParam?: string;
     userParam?: string;
     ttlParam?: number;
@@ -281,10 +303,10 @@ 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[];
 }
 export interface GrpcCallback {
     (error: Error | {
@@ -293,4 +315,5 @@ export interface GrpcCallback {
 }
 export interface GrpcCall {
     request: Record<string, any>;
+    metadata?: grpc.Metadata;
 }

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Privacy = exports.ExtraHeader = exports.Transport = exports.Method = void 0;
+exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Privacy = exports.ExtraHeader = exports.LoadBalancingAlgorithm = exports.Transport = exports.Method = void 0;
 var Method;
 (function (Method) {
     Method["UNKNOWN"] = "UNKNOWN";
@@ -17,29 +17,37 @@ var Method;
 })(Method = exports.Method || (exports.Method = {}));
 var Transport;
 (function (Transport) {
-    Transport["TCP"] = "tcp";
-    Transport["UDP"] = "udp";
-    Transport["TLS"] = "tls";
-    Transport["SCTP"] = "sctp";
-    Transport["WS"] = "ws";
-    Transport["WSS"] = "wss";
+    Transport["TCP"] = "TCP";
+    Transport["UDP"] = "UDP";
+    Transport["TLS"] = "TLS";
+    Transport["SCTP"] = "SCTP";
+    Transport["WS"] = "WS";
+    Transport["WSS"] = "WSS";
 })(Transport = exports.Transport || (exports.Transport = {}));
+var LoadBalancingAlgorithm;
+(function (LoadBalancingAlgorithm) {
+    LoadBalancingAlgorithm["UNSPECIFIED"] = "UNSPECIFIED";
+    LoadBalancingAlgorithm["ROUND_ROBIN"] = "ROUND_ROBIN";
+    LoadBalancingAlgorithm["LEAST_SESSIONS"] = "LEAST_SESSIONS";
+})(LoadBalancingAlgorithm = exports.LoadBalancingAlgorithm || (exports.LoadBalancingAlgorithm = {}));
 var ExtraHeader;
 (function (ExtraHeader) {
     ExtraHeader["REQUEST_URI"] = "X-Request-Uri";
     ExtraHeader["GATEWAY_AUTH"] = "X-Gateway-Auth";
     ExtraHeader["EDGEPORT_REF"] = "X-Edgeport-Ref";
     ExtraHeader["SESSION_COUNT"] = "X-Session-Count";
+    ExtraHeader["DOD_NUMBER"] = "X-DOD-Number";
+    ExtraHeader["DOD_PRIVACY"] = "X-DOD-Privacy";
 })(ExtraHeader = exports.ExtraHeader || (exports.ExtraHeader = {}));
 var Privacy;
 (function (Privacy) {
-    Privacy["NONE"] = "none";
-    Privacy["PRIVATE"] = "id";
+    Privacy["NONE"] = "NONE";
+    Privacy["PRIVATE"] = "ID";
 })(Privacy = exports.Privacy || (exports.Privacy = {}));
 var HeaderModifierAction;
 (function (HeaderModifierAction) {
-    HeaderModifierAction["ADD"] = "add";
-    HeaderModifierAction["REMOVE"] = "remove";
+    HeaderModifierAction[HeaderModifierAction["ADD"] = 0] = "ADD";
+    HeaderModifierAction[HeaderModifierAction["REMOVE"] = 1] = "REMOVE";
 })(HeaderModifierAction = exports.HeaderModifierAction || (exports.HeaderModifierAction = {}));
 var ResponseType;
 (function (ResponseType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.2",
+  "version": "2.0.8-alpha.21",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -10,11 +10,11 @@
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
     "build": "tsc -b tsconfig.json",
-    "postbuild": "mkdir -p dist/protos && cp src/protos/* dist/protos"
+    "postbuild": "cp -a src/protos dist/protos && cp -a src/connect/protos dist/connect/protos"
   },
   "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",
@@ -24,9 +24,13 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
+    "ajv": "^6.12.6",
     "fp-ts": "^2.11.8",
     "ip-utils": "^2.4.0",
-    "pb-util": "^1.0.3"
+    "js-yaml": "^4.1.0",
+    "pb-util": "^1.0.3",
+    "toml": "^3.0.0",
+    "validator": "^13.7.0"
   },
   "directories": {
     "src": "src",
@@ -45,5 +49,8 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "28ab976b0ef8b5cd34e278ea6fda13c518d7d052"
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.5"
+  },
+  "gitHead": "1841d2d8d51bebfdc3af7e81435064e81b176449"
 }

package/dist/connect/data_api.d.ts

@@ -1,11 +0,0 @@
-import { FindParameters, Resource } from "./types";
-/**
- * Data API for the Connect module.
- *
- * @param {string} apiAddr - The address of the API server
- * @return {Promise<Resource[]>}
- */
-export declare function dataAPI(apiAddr: string): {
-    get: (ref: string) => Promise<Resource>;
-    findBy: (request: FindParameters) => Promise<Resource[]>;
-};

package/dist/connect/data_api.js

@@ -1,91 +0,0 @@
-"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.dataAPI = 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 protobufUtil = __importStar(require("pb-util"));
-const errors_1 = require("../errors");
-const grpc_client_1 = require("./grpc_client");
-const jsonToStruct = protobufUtil.struct.encode;
-const jsonFromStruct = protobufUtil.struct.decode;
-/**
- * Data API for the Connect module.
- *
- * @param {string} apiAddr - The address of the API server
- * @return {Promise<Resource[]>}
- */
-function dataAPI(apiAddr) {
-    const client = new grpc_client_1.RESOURCES_PROTO.v2draft1.Resources(apiAddr, grpc.credentials.createInsecure());
-    return {
-        get: (ref) => new Promise((resolve, reject) => {
-            client.get({ ref }, (err, response) => {
-                if (err) {
-                    return (err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE
-                        ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
-                        : reject(err);
-                }
-                // Convert back to Json
-                response.spec = jsonFromStruct(response.spec);
-                resolve(response);
-            });
-        }),
-        findBy: (request) => new Promise((resolve, reject) => {
-            request.parameters = jsonToStruct(request.parameters);
-            client.findBy(request, (err, response) => {
-                var _a;
-                if (err) {
-                    return (err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE
-                        ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
-                        : reject(err);
-                }
-                const res = (_a = response === null || response === void 0 ? void 0 : response.resources) === null || _a === void 0 ? void 0 : _a.map((resource) => {
-                    // Convert back to Json
-                    resource.spec = jsonFromStruct(resource.spec);
-                    return resource;
-                });
-                resolve(res);
-            });
-        })
-    };
-}
-exports.dataAPI = dataAPI;

package/dist/connect/grpc_client.d.ts

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

package/dist/protos/resources.proto

@@ -1,108 +0,0 @@
-// 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 {
-  // The resource's name
-  string name = 1;
-  // Created at
-  int32 create_time = 2;
-  // Updated at
-  int32 update_time = 3;
-}
-
-message Resource {
-  // The resource's api version
-  string apiVersion = 1;
-  // The resource's kind
-  string kind = 2;
-  // The resource's unique identifier
-  string ref = 3;
-  // The resource's metadata
-  Metadata metadata = 4;
-  // The resource's data
-  .google.protobuf.Struct spec = 5;
-}
-
-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 {}