@routr/common 2.0.8-alpha.18 → 2.0.8-alpha.19

package/dist/connect/config.d.ts

@@ -1,4 +1,4 @@
-import { Privacy, Transport } from "../types";
+import { LoadBalancingAlgorithm, Privacy, Transport } from "../types";
 import { Kind } from "./types";
 export interface ConfigBase {
     apiVersion: string;
@@ -34,6 +34,10 @@ export interface PeerConfig extends ConfigBase {
         credentialsRef?: string;
         contactAddr?: string;
         enabled?: boolean;
+        loadBalancing?: {
+            algorithm: LoadBalancingAlgorithm;
+            withSessionAffinity: boolean;
+        };
     };
 }
 export interface CredentialsConfig extends ConfigBase {

package/dist/connect/mappers/assertions.d.ts

@@ -1,2 +1,3 @@
 import { UserConfig } from "../config";
 export declare const assertValidSchema: (config: UserConfig, valid: (config: UserConfig) => boolean) => void;
+export declare const assertValidAorSchema: (config: UserConfig) => void;

package/dist/connect/mappers/assertions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertValidSchema = void 0;
+exports.assertValidAorSchema = exports.assertValidSchema = void 0;
 /*
  * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster
@@ -29,3 +29,15 @@ const assertValidSchema = (config, valid) => {
     }
 };
 exports.assertValidSchema = assertValidSchema;
+const assertValidAorSchema = (config) => {
+    const spec = config.spec;
+    if (spec.aor.startsWith("backend:") && !spec.loadBalancing) {
+        logger.error("found a bad resource: balancing algorithm is required for `backend:` aors");
+        process.exit(1);
+    }
+    if (spec.aor.startsWith("sip:") && spec.loadBalancing) {
+        logger.error("found a bad resource: balancing algorithm is not allowed for `sip:` aors");
+        process.exit(1);
+    }
+};
+exports.assertValidAorSchema = assertValidAorSchema;

package/dist/connect/mappers/peer.js

@@ -6,7 +6,9 @@ const types_1 = require("../types");
 const assertions_1 = require("./assertions");
 const valid = schemas_1.schemaValidators.get(types_1.Kind.PEER);
 function mapToPeer(config) {
+    var _a, _b;
     (0, assertions_1.assertValidSchema)(config, valid);
+    (0, assertions_1.assertValidAorSchema)(config);
     return {
         apiVersion: config.apiVersion,
         ref: config.ref,
@@ -15,7 +17,9 @@ function mapToPeer(config) {
         aor: config.spec.aor,
         contactAddr: config.spec.contactAddr,
         enabled: config.spec.enabled,
-        credentialsRef: config.spec.credentialsRef
+        credentialsRef: config.spec.credentialsRef,
+        balancingAlgorithm: (_a = config.spec.loadBalancing) === null || _a === void 0 ? void 0 : _a.algorithm.toUpperCase(),
+        withSessionAffinity: (_b = config.spec.loadBalancing) === null || _b === void 0 ? void 0 : _b.withSessionAffinity
     };
 }
 exports.mapToPeer = mapToPeer;

package/dist/connect/protos/peers.proto

@@ -41,6 +41,13 @@ service Peers {
   rpc FindBy (FindByRequest) returns (FindByResponse) {}
 }
 
+enum LoadBalancingAlgorithm {
+  // The round robin load balancing algorithm
+  ROUND_ROBIN = 0;
+  // The least sessions load balancing algorithm
+  LEAST_SESSIONS = 1;
+}
+
 // The message for the Peer resource
 message Peer {
   // The API version of the Peer
@@ -55,18 +62,22 @@ message Peer {
   string aor = 5;
   // The contact address of the Peer
   string contact_addr = 6;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 7;
+  // The session affinity of the Peer
+  bool with_session_affinity = 8;
   // The status of the Peer
-  bool enabled = 7;
+  bool enabled = 9;
   // The date and time when the Peer was created
-  int32 created_at = 8;
+  int32 created_at = 10;
   // The date and time when the Peer was last updated
-  int32 updated_at = 9;
+  int32 updated_at = 11;
   // The list of IP addresses that are allowed to access the Peer
-  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 10;
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 12;
   // The credentials of the Peer
-  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 11;
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 13;
   // The extended attributes of the Peer
-  .google.protobuf.Struct extended = 12;
+  .google.protobuf.Struct extended = 14;
 }
 
 // The request message for the Peers.Create method
@@ -79,14 +90,18 @@ message CreatePeerRequest  {
   string aor = 3;
   // The contact address of the Peer
   string contact_addr = 4;
-  // The status of the Peer
-  bool enabled = 5;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 5;
+  // The session affinity of the Peer
+  bool with_session_affinity = 6;
   // Reference to the ACL of the Peer
-  string access_control_list_ref = 6;
+  string access_control_list_ref = 7;
   // Reference to the Credentials of the Peer
-  string credentials_ref = 7;
+  string credentials_ref = 8;
+  // The status of the Peer
+  bool enabled = 9;
   // The extended attributes of the Peer
-  .google.protobuf.Struct extended = 8;
+  .google.protobuf.Struct extended = 10;
 }
 
 // The request message for the Peers.Update method
@@ -101,14 +116,18 @@ message UpdatePeerRequest {
   string aor = 4;
   // The contact address of the Peer
   string contact_addr = 5;
-  // The status of the Peer
-  bool enabled = 6;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 6;
+  // The session affinity of the Peer
+  bool with_session_affinity = 7;
   // Reference to the ACL of the Peer
-  string access_control_list_ref = 7;
+  string access_control_list_ref = 8;
   // Reference to the Credentials of the Peer
-  string credentials_ref = 8;
+  string credentials_ref = 9;
+  // The status of the Peer
+  bool enabled = 10;
   // The extended attributes of the Peer
-  .google.protobuf.Struct extended = 9;
+  .google.protobuf.Struct extended = 11;
 }
 
 // The request message for the Peers.Get method

package/dist/connect/schemas/peer.d.ts

@@ -57,6 +57,20 @@ declare const _default: {
                     description: string;
                     type: string;
                 };
+                loadBalancing: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        algorithm: {
+                            description: string;
+                            enum: string[];
+                        };
+                        withSessionAffinity: {
+                            description: string;
+                            type: string;
+                        };
+                    };
+                };
                 enabled: {
                     description: string;
                     type: string;

package/dist/connect/schemas/peer.js

@@ -77,6 +77,20 @@ exports.default = {
                     description: "The ACL the Peer uses to control access to the Peer (Reserved for future use)",
                     type: "string"
                 },
+                loadBalancing: {
+                    description: "The load balancing strategy for the Peer",
+                    type: "object",
+                    properties: {
+                        algorithm: {
+                            description: "The load balancing algorithm",
+                            enum: ["round-robin", "least-sessions"]
+                        },
+                        withSessionAffinity: {
+                            description: "Whether to allow session affinity",
+                            type: "boolean"
+                        }
+                    }
+                },
                 enabled: {
                     description: "Whether the Peer is enabled",
                     type: "boolean"

package/dist/connect/types.d.ts

@@ -1,5 +1,5 @@
 import { JsonObject } from "pb-util/build";
-import { Privacy, Transport } from "../types";
+import { LoadBalancingAlgorithm, Privacy, Transport } from "../types";
 export declare enum Kind {
     AGENT = "agent",
     PEER = "peer",
@@ -94,6 +94,8 @@ export interface Peer extends BaseConnectModel {
     accessControlList?: AccessControlList;
     credentialsRef?: string;
     credentials?: Credentials;
+    balancingAlgorithm?: LoadBalancingAlgorithm;
+    withSessionAffinity?: boolean;
 }
 export type ConnectModel = Agent | Peer | INumber | Trunk | Domain | Credentials | AccessControlList;
 export type RoutableResourceUnion = Agent | Peer | INumber;

package/dist/protos/location.proto

@@ -61,10 +61,20 @@ message AddRouteRequest {
 }
 
 message FindRoutesRequest {
+  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;
-  map<string, string> labels = 4;
+  Backend backend = 4;
+  map<string, string> labels = 5;
 }
 
 message FindRoutesResponse {

package/dist/types.d.ts

@@ -22,6 +22,10 @@ export declare enum Transport {
     WS = "WS",
     WSS = "WSS"
 }
+export declare enum LoadBalancingAlgorithm {
+    ROUND_ROBIN = "ROUND-ROBIN",
+    LEAST_SESSIONS = "LEAST-SESSIONS"
+}
 export declare enum ExtraHeader {
     REQUEST_URI = "X-Request-Uri",
     GATEWAY_AUTH = "X-Gateway-Auth",
@@ -103,8 +107,8 @@ export interface AuthChallengeResponse {
     qop: Qop;
 }
 export declare enum HeaderModifierAction {
-    ADD = "add",
-    REMOVE = "remove"
+    ADD = 0,
+    REMOVE = 1
 }
 export interface HeaderModifier {
     name: string;

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";
@@ -24,6 +24,11 @@ var Transport;
     Transport["WS"] = "WS";
     Transport["WSS"] = "WSS";
 })(Transport = exports.Transport || (exports.Transport = {}));
+var LoadBalancingAlgorithm;
+(function (LoadBalancingAlgorithm) {
+    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";
@@ -40,8 +45,8 @@ var Privacy;
 })(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.18",
+  "version": "2.0.8-alpha.19",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -51,5 +51,5 @@
   "devDependencies": {
     "@types/js-yaml": "^4.0.5"
   },
-  "gitHead": "66ce6b3ed832bb8c549d344b3367aceed4b6da8f"
+  "gitHead": "ff62abb0ff7704a79f98a8e0b10c0036b949cc11"
 }