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

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

@@ -0,0 +1,112 @@
+/*
+ * 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.connect.acl.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+
+// AccessControlList(ACL) service definition
+service ACLService {
+  // Create a new ACL
+  rpc Create (CreateACLRequest) returns (AccessControlList) {}
+  // Update an existing ACL
+  rpc Update (UpdateACLRequest) returns (AccessControlList) {}
+  // Get an existing ACL
+  rpc Get (GetACLRequest) returns (AccessControlList) {}
+  // Delete an existing ACL
+  rpc Delete (DeleteACLRequest) returns (.google.protobuf.Empty) {}
+  // Get a list of ACLs
+  rpc List (ListACLsRequest) returns (ListACLsResponse) {}
+}
+
+// The message for AccessControlList resource
+message AccessControlList {
+  // The version of the API
+  string api_version = 1;
+  // The ACL reference
+  string ref = 2;
+  // A friendly name for the ACL
+  string name = 3;
+  // The list of allowed IP addresses
+  repeated string allow = 4;
+  // 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;
+  // The extended attributes of the ACL
+  .google.protobuf.Struct extended = 8;
+}
+
+// The request message for the AccessControlList.Create method
+message CreateACLRequest {
+  // 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 extended attributes of the ACL
+  .google.protobuf.Struct extended = 5;  
+}
+
+// The request message for the AccessControlList.Update method
+message UpdateACLRequest {
+  // The ACL reference
+  string ref = 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 extended attributes of the ACL
+  .google.protobuf.Struct extended = 5;
+} 
+
+// The request message for the AccessControlList.Get method
+message GetACLRequest  {
+  string ref = 1;
+}
+
+// The request message for the AccessControlList.Delete method
+message DeleteACLRequest  {
+  string ref = 1;
+}
+
+// The request message for the AccessControlList.List method
+message ListACLsRequest {
+  // 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 response message for the AccessControlList.List method
+message ListACLsResponse {
+  // List of items
+  repeated AccessControlList items = 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;
+}

package/dist/connect/protos/agents.proto

@@ -0,0 +1,155 @@
+/*
+ * 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.connect.agents.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "domains.proto";
+import "credentials.proto";
+
+// The Agents service definition
+service Agents {
+  // Creates a new Agent
+  rpc Create (CreateAgentRequest) returns (Agent) {}
+  // Updates an existing Agent
+  rpc Update (UpdateAgentRequest) returns (Agent) {}
+  // Gets an existing Agent
+  rpc Get (GetAgentRequest) returns (Agent) {}
+  // Deletes an existing Agent
+  rpc Delete (DeleteAgentRequest) returns (.google.protobuf.Empty) {}
+  // Lists all Agents
+  rpc List (ListAgentsRequest) returns (ListAgentsResponse) {}
+  // Find Agents by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+enum Privacy {
+  PRIVATE = 0;
+  NONE = 1;
+}
+
+// The message for the Agent resource
+message Agent {
+  // The API version of the Agent
+  string api_version = 1;
+  // The unique identifier of the Agent
+  string ref = 2;
+  // The name of the Agent
+  string name = 3;
+  // The username of the Agent
+  string username = 4;
+  // The password of the Agent
+  Privacy privacy = 5;
+  // The enabled status of the Agent
+  bool enabled = 6;
+  // The created_at timestamp of the Agent
+  int32 created_at = 7;
+  // The updated_at timestamp of the Agent
+  int32 updated_at = 8;
+  // The domain of the Agent
+  fonoster.routr.connect.domains.v2draft1.Domain domain = 9;
+  // The credentials of the Agent
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 10;
+  // The extended attributes of the Agent
+  .google.protobuf.Struct extended = 11;  
+}
+
+// The request message for the Agents.Create method
+message CreateAgentRequest {
+  // The name of the Agent
+  string name = 1;
+  // The username of the Agent
+  string username = 2;
+  // The password of the Agent
+  Privacy privacy = 3;
+  // The enabled status of the Agent
+  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 = 7;  
+}
+
+// The request message for the Agents.Update method
+message UpdateAgentRequest {
+  // The unique identifier of the Agent
+  string ref = 1;
+  // The name of the Agent
+  string name = 2;
+  // The username of the Agent
+  string username = 3;
+  // The privacy settings of the Agent
+  Privacy privacy = 4;
+  // The enabled status of the Agent
+  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 = 8;
+}
+
+// The request message for the Agents.Get method
+message GetAgentRequest {
+  // The unique identifier of the Agent
+  string ref = 1;
+}
+
+// The request message for the Agents.Delete method
+message DeleteAgentRequest  {
+  // The unique identifier of the Agent
+  string ref = 1;
+}
+
+// The request message for the Agents.FindBy method
+message FindByRequest {
+  // The field name to search
+  string field_name = 1;
+  // The value to search
+  string field_value = 2;
+}
+
+// The response message for the Agents.FindBy method
+message FindByResponse {
+  // The list of Agents
+  repeated Agent items = 1;
+} 
+
+// The request message for the Agents.List method
+message ListAgentsRequest {
+  // 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 response message for the Agents.List method
+message ListAgentsResponse {
+  // List of Agents
+  repeated Agent items = 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;
+}