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

package/dist/auth.d.ts

@@ -2,8 +2,8 @@ import { AuthChallengeRequest, AuthChallengeResponse, ResponseType } from "./typ
 export declare const generateNonce: (algorithm?: string) => string;
 export declare const buildAuthChallenge: (request: AuthChallengeRequest) => {
     realm: string;
-    scheme: import("./types").AuthorizationScheme;
-    algorithm: import("./types").AuthorizationAlgorithm;
+    scheme: "Digest";
+    algorithm: "MD5";
     qop: import("./types").Qop;
     opaque: string;
     stale: boolean;

package/dist/connect/api/client.js

@@ -44,12 +44,10 @@ exports.serviceAPI = exports.apiClient = void 0;
  */
 /* eslint-disable require-jsdoc */
 const grpc = __importStar(require("@grpc/grpc-js"));
-const protobufUtil = __importStar(require("pb-util"));
+const pb_util_1 = require("pb-util");
 const errors_1 = require("../../errors");
 const grpc_client_1 = require("../grpc_client");
 const types_1 = require("../types");
-const jsonToStruct = protobufUtil.struct.encode;
-const structToJson = protobufUtil.struct.decode;
 function fire(err, apiAddr) {
     if (err.code === grpc.status.UNAVAILABLE) {
         return new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`);
@@ -79,28 +77,28 @@ function serviceAPI(options) {
     return {
         create: (request) => new Promise((resolve, reject) => {
             if (request.extended) {
-                request.extended = jsonToStruct(request.extended);
+                request.extended = pb_util_1.struct.encode(request.extended);
             }
             client.create(request, (err, response) => {
                 if (err) {
                     return reject(fire(err, apiAddr));
                 }
                 if (response.extended) {
-                    response.extended = structToJson(response.extended);
+                    response.extended = pb_util_1.struct.decode(response.extended);
                 }
                 resolve(response);
             });
         }),
         update: (request) => new Promise((resolve, reject) => {
             if (request.extended) {
-                request.extended = jsonToStruct(request.extended);
+                request.extended = pb_util_1.struct.encode(request.extended);
             }
             client.update(request, (err, response) => {
                 if (err) {
                     return reject(fire(err, apiAddr));
                 }
                 if (response.extended) {
-                    response.extended = structToJson(response.extended);
+                    response.extended = pb_util_1.struct.decode(response.extended);
                 }
                 resolve(response);
             });
@@ -111,7 +109,7 @@ function serviceAPI(options) {
                     return reject(fire(err, apiAddr));
                 }
                 if (response.extended) {
-                    response.extended = structToJson(response.extended);
+                    response.extended = pb_util_1.struct.decode(response.extended);
                 }
                 resolve(response);
             });
@@ -124,7 +122,7 @@ function serviceAPI(options) {
                 }
                 response.items.forEach((item) => {
                     if (item.extended) {
-                        item.extended = structToJson(item.extended);
+                        item.extended = pb_util_1.struct.decode(item.extended);
                     }
                 });
                 resolve({
@@ -140,7 +138,7 @@ function serviceAPI(options) {
                 }
                 response.items.forEach((item) => {
                     if (item.extended) {
-                        item.extended = structToJson(item.extended);
+                        item.extended = pb_util_1.struct.decode(item.extended);
                     }
                 });
                 resolve(response);

package/dist/connect/api/types.d.ts

@@ -1,5 +1,5 @@
 import * as grpc from "@grpc/grpc-js";
-import { JsonData } from "../../types";
+import { JsonObject } from "pb-util/build";
 import { AccessControlList, Agent, Credentials, Domain, INumber, Kind, Peer, Trunk } from "../types";
 export interface DataAPIOptions {
     apiAddr: string;
@@ -35,10 +35,10 @@ export type APIClient = {
     numbers: ServiceAPI<INumber>;
 };
 export type ServiceAPI<R extends {
-    extended?: JsonData;
+    extended?: JsonObject;
 }> = {
-    create: (request: JsonData) => Promise<R>;
-    update: (request: JsonData) => Promise<R>;
+    create: (request: JsonObject) => Promise<R>;
+    update: (request: JsonObject) => Promise<R>;
     get: (ref: string) => Promise<R>;
     del: (ref: string) => Promise<void>;
     list: (request: {

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;
@@ -31,9 +31,13 @@ export interface PeerConfig extends ConfigBase {
     spec: {
         aor: string;
         username: string;
-        credentialsRef: string;
-        contactAddr: string;
-        enabled: boolean;
+        credentialsRef?: string;
+        contactAddr?: string;
+        enabled?: boolean;
+        loadBalancing?: {
+            algorithm: LoadBalancingAlgorithm;
+            withSessionAffinity: boolean;
+        };
     };
 }
 export interface CredentialsConfig extends ConfigBase {
@@ -48,10 +52,10 @@ export interface CredentialsConfig extends ConfigBase {
 export interface DomainConfig extends ConfigBase {
     kind: Kind.DOMAIN;
     spec: {
-        accessControlListRef: string;
+        accessControlListRef?: string;
         context: {
             domainUri: string;
-            egressPolicies: {
+            egressPolicies?: {
                 rule: string;
                 numberRef: string;
             }[];

package/dist/connect/grpc_client.d.ts

@@ -1,8 +1,8 @@
 import * as grpc from "@grpc/grpc-js";
-import { Kind } from "./types";
+import { Kind, KindWithoutUnknown } from "./types";
 export declare function createClient(options: {
     kind: Kind;
     credentials: grpc.ChannelCredentials;
     apiAddr: string;
 }): any;
-export declare function createService(kind: Kind): any;
+export declare function createService(kind: KindWithoutUnknown): any;

package/dist/connect/index.d.ts

@@ -2,4 +2,4 @@ export * from "./api";
 export * from "./grpc_client";
 export * from "./types";
 export * from "./config";
-export * from "./converters";
+export * from "./mappers";

package/dist/connect/index.js

@@ -36,4 +36,4 @@ __exportStar(require("./api"), exports);
 __exportStar(require("./grpc_client"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./config"), exports);
-__exportStar(require("./converters"), exports);
+__exportStar(require("./mappers"), exports);

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

@@ -0,0 +1,3 @@
+import { AccessControlListConfig } from "../config";
+import { AccessControlList } from "../types";
+export declare function mapToACL(config: AccessControlListConfig): AccessControlList;

package/dist/connect/mappers/acl.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToACL = void 0;
+const schemas_1 = require("../schemas");
+const types_1 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_1.Kind.ACL);
+function mapToACL(config) {
+    var _a, _b, _c, _d;
+    (0, assertions_1.assertValidSchema)(config, valid);
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: config.metadata.name,
+        allow: (_b = (_a = config.spec.accessControlList) === null || _a === void 0 ? void 0 : _a.allow) !== null && _b !== void 0 ? _b : [],
+        deny: (_d = (_c = config.spec.accessControlList) === null || _c === void 0 ? void 0 : _c.deny) !== null && _d !== void 0 ? _d : []
+    };
+}
+exports.mapToACL = mapToACL;

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

@@ -0,0 +1,3 @@
+import { AgentConfig } from "../config";
+import { Agent } from "../types";
+export declare function mapToAgent(config: AgentConfig): Agent;

package/dist/connect/mappers/agent.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToAgent = void 0;
+/*
+ * Copyright (C) 2023 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.
+ */
+/* eslint-disable require-jsdoc */
+const types_1 = require("../../types");
+const schemas_1 = require("../schemas");
+const types_2 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_2.Kind.AGENT);
+function mapToAgent(config) {
+    var _a;
+    (0, assertions_1.assertValidSchema)(config, valid);
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: config.metadata.name,
+        username: config.spec.username,
+        privacy: (_a = config.spec.privacy) !== null && _a !== void 0 ? _a : types_1.Privacy.NONE,
+        enabled: config.spec.enabled,
+        domainRef: config.spec.domainRef,
+        credentialsRef: config.spec.credentialsRef
+    };
+}
+exports.mapToAgent = mapToAgent;

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

@@ -0,0 +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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidAorSchema = exports.assertValidSchema = void 0;
+/*
+ * Copyright (C) 2023 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.
+ */
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
+const assertValidSchema = (config, valid) => {
+    if (!valid(config)) {
+        const error = valid.errors[0];
+        logger.error("found a bad resource: " + error.message + " at `" + error.dataPath + "`");
+        process.exit(1);
+    }
+};
+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/credentials.d.ts

@@ -0,0 +1,3 @@
+import { CredentialsConfig } from "../config";
+import { Credentials } from "../types";
+export declare function mapToCredentials(config: CredentialsConfig): Credentials;

package/dist/connect/mappers/credentials.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToCredentials = void 0;
+const schemas_1 = require("../schemas");
+const types_1 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_1.Kind.CREDENTIALS);
+function mapToCredentials(config) {
+    (0, assertions_1.assertValidSchema)(config, valid);
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: config.metadata.name,
+        username: config.spec.credentials.username,
+        password: config.spec.credentials.password
+    };
+}
+exports.mapToCredentials = mapToCredentials;

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

@@ -0,0 +1,3 @@
+import { DomainConfig } from "../config";
+import { Domain } from "../types";
+export declare function mapToDomain(config: DomainConfig): Domain;

package/dist/connect/mappers/domain.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToDomain = void 0;
+const schemas_1 = require("../schemas");
+const types_1 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_1.Kind.DOMAIN);
+function mapToDomain(config) {
+    (0, assertions_1.assertValidSchema)(config, valid);
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: config.metadata.name,
+        domainUri: config.spec.context.domainUri,
+        accessControlListRef: config.spec.accessControlListRef,
+        egressPolicies: config.spec.context.egressPolicies
+    };
+}
+exports.mapToDomain = mapToDomain;

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

@@ -0,0 +1,7 @@
+export * from "./acl";
+export * from "./agent";
+export * from "./credentials";
+export * from "./trunk";
+export * from "./number";
+export * from "./peer";
+export * from "./domain";

package/dist/connect/mappers/index.js

@@ -0,0 +1,41 @@
+"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) 2023 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("./acl"), exports);
+__exportStar(require("./agent"), exports);
+__exportStar(require("./credentials"), exports);
+__exportStar(require("./trunk"), exports);
+__exportStar(require("./number"), exports);
+__exportStar(require("./peer"), exports);
+__exportStar(require("./domain"), exports);

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

@@ -0,0 +1,3 @@
+import { NumberConfig } from "../config";
+import { INumber } from "../types";
+export declare function mapToNumber(config: NumberConfig): INumber;

package/dist/connect/mappers/number.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToNumber = void 0;
+const schemas_1 = require("../schemas");
+const types_1 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_1.Kind.NUMBER);
+function mapToNumber(config) {
+    (0, assertions_1.assertValidSchema)(config, valid);
+    const metadata = config.metadata;
+    const location = config.spec.location;
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: metadata.name,
+        city: metadata.geoInfo.city,
+        country: metadata.geoInfo.country,
+        countryISOCode: metadata.geoInfo.countryISOCode,
+        telUrl: location.telUrl,
+        aorLink: location.aorLink,
+        sessionAffinityHeader: location.sessionAffinityHeader,
+        extraHeaders: location.extraHeaders,
+        trunkRef: config.spec.trunkRef
+    };
+}
+exports.mapToNumber = mapToNumber;

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

@@ -0,0 +1,3 @@
+import { PeerConfig } from "../config";
+import { Peer } from "../types";
+export declare function mapToPeer(config: PeerConfig): Peer;

package/dist/connect/mappers/peer.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToPeer = void 0;
+const schemas_1 = require("../schemas");
+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,
+        name: config.metadata.name,
+        username: config.spec.username,
+        aor: config.spec.aor,
+        contactAddr: config.spec.contactAddr,
+        enabled: config.spec.enabled,
+        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/mappers/trunk.d.ts

@@ -0,0 +1,3 @@
+import { TrunkConfig } from "../config";
+import { Trunk } from "../types";
+export declare function mapToTrunk(config: TrunkConfig): Trunk;

package/dist/connect/mappers/trunk.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToTrunk = void 0;
+const schemas_1 = require("../schemas");
+const types_1 = require("../types");
+const assertions_1 = require("./assertions");
+const valid = schemas_1.schemaValidators.get(types_1.Kind.TRUNK);
+function mapToTrunk(config) {
+    var _a, _b, _c, _d, _e, _f;
+    (0, assertions_1.assertValidSchema)(config, valid);
+    return {
+        apiVersion: config.apiVersion,
+        ref: config.ref,
+        name: config.metadata.name,
+        sendRegister: config.spec.outbound.sendRegister,
+        inboundUri: (_a = config.spec.inbound) === null || _a === void 0 ? void 0 : _a.uri,
+        inboundCredentialsRef: (_b = config.spec.inbound) === null || _b === void 0 ? void 0 : _b.credentialsRef,
+        outboundCredentialsRef: (_c = config.spec.outbound) === null || _c === void 0 ? void 0 : _c.credentialsRef,
+        accessControlListRef: (_d = config.spec.inbound) === null || _d === void 0 ? void 0 : _d.accessControlListRef,
+        uris: (_f = (_e = config.spec.outbound) === null || _e === void 0 ? void 0 : _e.uris) === null || _f === void 0 ? void 0 : _f.map((entry) => {
+            var _a;
+            return {
+                user: entry.uri.user,
+                host: entry.uri.host,
+                port: entry.uri.port,
+                transport: (_a = entry.uri.transport) === null || _a === void 0 ? void 0 : _a.toUpperCase(),
+                enabled: entry.enabled,
+                weight: entry.weight,
+                priority: entry.priority
+            };
+        })
+    };
+}
+exports.mapToTrunk = mapToTrunk;

package/dist/connect/protos/acl.proto

@@ -20,6 +20,7 @@ syntax = "proto3";
 
 package fonoster.routr.connect.acl.v2draft1;
 
+import "google/protobuf/struct.proto";
 import "google/protobuf/empty.proto";
 
 // AccessControlList(ACL) service definition
@@ -52,40 +53,34 @@ message AccessControlList {
   int32 created_at = 6;
   // The date the ACL was last updated
   int32 updated_at = 7;
+  // The extended attributes of the ACL
+  .google.protobuf.Struct extended = 8;
 }
 
 // The request message for the AccessControlList.Create method
 message CreateACLRequest {
-  // The version of the API
-  string api_version = 1;
   // A friendly name for the ACL
   string name = 2;
   // The list of allowed IP addresses
   repeated string allow = 3;
   // The list of denied IP addresses
   repeated string deny = 4;
-  // The date the ACL was created
-  int32 created_at = 5;
-  // The date the ACL was last updated
-  int32 updated_at = 6;
+  // The extended attributes of the ACL
+  .google.protobuf.Struct extended = 5;  
 }
 
 // The request message for the AccessControlList.Update method
 message UpdateACLRequest {
-  // The version of the API
-  string api_version = 1;
   // The ACL reference
-  string ref = 2;
+  string ref = 1;
   // A friendly name for the ACL
-  string name = 3;
+  string name = 2;
   // The list of allowed IP addresses
-  repeated string allow = 4;
+  repeated string allow = 3;
   // The list of denied IP addresses
-  repeated string deny = 5;
-  // The date the ACL was created
-  int32 created_at = 6;
-  // The date the ACL was last updated
-  int32 updated_at = 7;
+  repeated string deny = 4;
+  // The extended attributes of the ACL
+  .google.protobuf.Struct extended = 5;
 } 
 
 // The request message for the AccessControlList.Get method

package/dist/connect/protos/agents.proto

@@ -74,44 +74,40 @@ message Agent {
 
 // The request message for the Agents.Create method
 message CreateAgentRequest {
-  // The API version of the Agent
-  string api_version = 1;
   // The name of the Agent
-  string name = 2;
+  string name = 1;
   // The username of the Agent
-  string username = 3;
+  string username = 2;
   // The password of the Agent
-  Privacy privacy = 4;
+  Privacy privacy = 3;
   // The enabled status of the Agent
-  bool enabled = 5;
-  // The domain of the Agent
-  fonoster.routr.connect.domains.v2draft1.Domain domain = 6;
-  // The credentials of the Agent
-  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 7;
+  bool enabled = 4;
+  // Reference to the Domain of the Agent
+  string domain_ref = 5;
+  // Reference to the Credentials of the Agent
+  string credentials_ref = 6;
   // The extended attributes of the Agent
-  .google.protobuf.Struct extended = 8;  
+  .google.protobuf.Struct extended = 7;  
 }
 
 // The request message for the Agents.Update method
 message UpdateAgentRequest {
-  // The API version of the Agent
-  string api_version = 1;
   // The unique identifier of the Agent
-  string ref = 2;
+  string ref = 1;
   // The name of the Agent
-  string name = 3;
+  string name = 2;
   // The username of the Agent
-  string username = 4;
+  string username = 3;
   // The privacy settings of the Agent
-  Privacy privacy = 5;
+  Privacy privacy = 4;
   // The enabled status of the Agent
-  bool enabled = 6;
-  // The domain of the Agent
-  fonoster.routr.connect.domains.v2draft1.Domain domain = 7;
-  // The credentials of the Agent
-  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 8;
+  bool enabled = 5;
+  // Reference to the Domain of the Agent
+  string domain_ref = 6;
+  // Reference to the Credentials of the Agent
+  string credentials_ref = 7;
   // The extended attributes of the Agent
-  .google.protobuf.Struct extended = 9;
+  .google.protobuf.Struct extended = 8;
 }
 
 // The request message for the Agents.Get method