@routr/common 2.0.8-alpha.4 → 2.0.8-alpha.40

package/dist/connect/protos/peers.proto

@@ -0,0 +1,174 @@
+/*
+ * Copyright (C) 2023 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.peers.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "acl.proto";
+import "credentials.proto";
+
+// The Peer service definition
+service Peers {
+  // Creates a new Peer
+  rpc Create (CreatePeerRequest) returns (Peer) {}
+  // Updates an existing Peer
+  rpc Update (UpdatePeerRequest) returns (Peer) {}
+  // Gets an existing Peer
+  rpc Get (GetPeerRequest) returns (Peer) {}
+  // Deletes an existing Peer
+  rpc Delete (DeletePeerRequest) returns (.google.protobuf.Empty) {}
+  // Lists all Peers
+  rpc List (ListPeersRequest) returns (ListPeersResponse) {}
+  // Find Agents by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+enum LoadBalancingAlgorithm {
+  // Value for situations where the load balancing algorithm is not specified
+  // Such as having an aor starting with "sip:"
+  UNSPECIFIED = 0;
+  // The round robin load balancing algorithm
+  ROUND_ROBIN = 1;
+  // The least sessions load balancing algorithm
+  LEAST_SESSIONS = 2;
+}
+
+// The message for the Peer resource
+message Peer {
+  // The API version of the Peer
+  string api_version = 1;
+  // The unique identifier of the Peer
+  string ref = 2;
+  // The name of the Peer
+  string name = 3;
+  // The username of the Peer
+  string username = 4;
+  // The address of record of the Peer
+  string aor = 5;
+  // The contact address of the Peer
+  string contact_addr = 6;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm balancing_algorithm = 7;
+  // The session affinity of the Peer
+  bool with_session_affinity = 8;
+  // The status of the Peer
+  bool enabled = 9;
+  // The date and time when the Peer was created
+  int32 created_at = 10;
+  // The date and time when the Peer was last updated
+  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 = 12;
+  // The credentials of the Peer
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 13;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 14;
+}
+
+// The request message for the Peers.Create method
+message CreatePeerRequest  {
+  // The name of the Peer
+  string name = 1;
+  // The username of the Peer
+  string username = 2;
+  // The address of record of the Peer
+  string aor = 3;
+  // The contact address of the Peer
+  string contact_addr = 4;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm 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 = 7;
+  // Reference to the Credentials of the Peer
+  string credentials_ref = 8;
+  // The status of the Peer
+  bool enabled = 9;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 10;
+}
+
+// The request message for the Peers.Update method
+message UpdatePeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+  // The name of the Peer
+  string name = 2;
+  // The address of record of the Peer
+  string aor = 3;
+  // The contact address of the Peer
+  string contact_addr = 4;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm 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 = 7;
+  // Reference to the Credentials of the Peer
+  string credentials_ref = 8;
+  // The status of the Peer
+  bool enabled = 9;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 10;
+}
+
+// The request message for the Peers.Get method
+message GetPeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+}
+
+// The request message for the Peers.Delete method
+message DeletePeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+}
+
+// The request message for the Peers.FindBy method
+message FindByRequest {
+  // The field name to search
+  string fieldName = 1;
+  // The value to search
+  string fieldValue = 2;
+}
+
+// The response message for the Peers.FindBy method
+message FindByResponse {
+  // The list of Peers items
+  repeated Peer items = 1;
+} 
+
+message ListPeersRequest {
+  // 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;
+}
+
+message ListPeersResponse {
+  // List of Peers items
+  repeated Peer 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/trunks.proto

@@ -0,0 +1,178 @@
+/*
+ * Copyright (C) 2023 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.trunks.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "acl.proto";
+import "credentials.proto";
+
+// The Trunks service definition
+service Trunks {
+  // Create a new Trunk
+  rpc Create (CreateTrunkRequest) returns (Trunk) {}
+  // Update an existing Trunk
+  rpc Update (UpdateTrunkRequest) returns (Trunk) {}
+  // Get a Trunk by reference
+  rpc Get (GetTrunkRequest) returns (Trunk) {}
+  // Delete a Trunk by reference
+  rpc Delete (DeleteTrunkRequest) returns (.google.protobuf.Empty) {}
+  // List all Trunks
+  rpc List (ListTrunkRequest) returns (ListTrunksResponse) {}
+  // Find Trunks by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+// The message for the Trunk URIs
+message TrunkURI {
+  // The host name or IP address of the Trunk
+  string host = 1;
+  // The port number of the Trunk
+  int32 port = 2;
+  // The transport protocol of the Trunk
+  string transport = 3;
+  // The username to use when authenticating with the Trunk
+  string user = 4;
+  // The weight of the Trunk
+  int32 weight = 5;
+  // The priority of the Trunk
+  int32 priority = 6;
+  // The flag to enable or disable the Trunk
+  bool enabled = 7;
+} 
+
+// The message for the Trunk resource
+message Trunk {
+  // The API version of the Trunk
+  string api_version = 2;
+  // The reference of the Trunk
+  string ref = 1;
+  // The name of the Trunk
+  string name = 3;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 4;
+  // The URI for inbound requests
+  string inbound_uri = 5;
+  // The date and time when the Trunk was created
+  int32 created_at = 6;
+  // The date and time when the Trunk was last updated
+  int32 updated_at = 7;
+  // The list of IP addresses that are allowed to access the Trunks
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 8;
+  // The credentials to use when authenticating with the Trunk
+  fonoster.routr.connect.credentials.v2draft1.Credentials inbound_credentials = 9;
+  // The credentials to use when authenticating with the Provider
+  fonoster.routr.connect.credentials.v2draft1.Credentials outbound_credentials = 10;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 11;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 12;
+}
+
+// The message for the Trunk.Create
+message CreateTrunkRequest {
+  // The API version of the Trunk
+  string api_version = 1;
+  // The name of the Trunk
+  string name = 2;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 3;
+  // The URI for inbound requests
+  string inbound_uri = 4;
+  // Reference to the AccessControlList
+  string access_control_list_ref = 5;
+  // Reference to the inbound Credentials
+  string inbound_credentials_ref = 6;
+  // Reference to the outbound Credentials
+  string outbound_credentials_ref = 7;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 8;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 9;
+}
+
+// The message for the Trunk.Update
+message UpdateTrunkRequest {
+  // The API version of the Trunk
+  string api_version = 1;
+  // The reference of the Trunk
+  string ref = 2;
+  // The name of the Trunk
+  string name = 3;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 4;
+  // The URI for inbound requests
+  string inbound_uri = 5;
+  // Reference to the AccessControlList
+  string access_control_list_ref = 6;
+  // Reference to the inbound Credentials
+  string inbound_credentials_ref = 7;
+  // Reference to the outbound Credentials
+  string outbound_credentials_ref = 8;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 9;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 10;
+}
+
+// The message for the Trunk.Get
+message GetTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.Delete
+message DeleteTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.FindBy
+message FindByRequest {
+  // The field name to search
+  string field_name = 1;
+  // The value to search
+  string field_value = 2;
+}
+
+// The response message for the Trunks.FindBy method
+message FindByResponse {
+  // The list of Trunks items
+  repeated Trunk items = 1;
+} 
+
+// The message for the Trunk.List
+message ListTrunkRequest {
+  // 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 message for the Trunk.List response
+message ListTrunksResponse {
+  // List of Trunks
+  repeated Trunk 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/schemas/acl.d.ts

@@ -0,0 +1,66 @@
+declare const _default: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        apiVersion: {
+            enum: string[];
+        };
+        kind: {
+            enum: string[];
+        };
+        ref: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                name: {
+                    description: string;
+                    type: string;
+                    maxLength: number;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                accessControlList: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        allow: {
+                            description: string;
+                            type: string;
+                            items: {
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                            };
+                            minItems: number;
+                            uniqueItems: boolean;
+                        };
+                        deny: {
+                            description: string;
+                            type: string;
+                            items: {
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                            };
+                            minItems: number;
+                            uniqueItems: boolean;
+                        };
+                    };
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/acl.js

@@ -0,0 +1,85 @@
+"use strict";
+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.
+ */
+exports.default = {
+    $id: "https://json-schema.org/draft/2020-12/schema",
+    title: "Location Service configuration",
+    description: "Access Control List for Domains and Trunks",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2"]
+        },
+        kind: {
+            enum: ["AccessControlList", "accesscontrollist"]
+        },
+        ref: {
+            description: "Unique identifier for this resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string",
+                    maxLength: 60
+                }
+            },
+            required: ["name"]
+        },
+        spec: {
+            description: "Operations spec for ACL",
+            type: "object",
+            properties: {
+                accessControlList: {
+                    description: "An object with deny and allow list of access control rules",
+                    type: "object",
+                    properties: {
+                        allow: {
+                            description: "Allowed list of access control rules",
+                            type: "array",
+                            items: {
+                                type: "string",
+                                minLength: 7,
+                                maxLength: 18
+                            },
+                            minItems: 1,
+                            uniqueItems: true
+                        },
+                        deny: {
+                            description: "Denied list of access control rules",
+                            type: "array",
+                            items: {
+                                type: "string",
+                                minLength: 7,
+                                maxLength: 18
+                            },
+                            minItems: 1,
+                            uniqueItems: true
+                        }
+                    }
+                }
+            }
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

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

@@ -0,0 +1,61 @@
+declare const _default: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        apiVersion: {
+            enum: string[];
+        };
+        kind: {
+            enum: string[];
+        };
+        ref: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                name: {
+                    description: string;
+                    type: string;
+                    maxLength: number;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                username: {
+                    description: string;
+                    type: string;
+                    minLength: number;
+                    maxLength: number;
+                    readOnly: boolean;
+                };
+                domainRef: {
+                    description: string;
+                    type: string;
+                };
+                credentialsRef: {
+                    description: string;
+                    type: string;
+                };
+                enabled: {
+                    description: string;
+                    type: string;
+                };
+                privacy: {
+                    enum: string[];
+                };
+            };
+            required: string[];
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/agent.js

@@ -0,0 +1,80 @@
+"use strict";
+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.
+ */
+exports.default = {
+    $id: "https://json-schema.org/draft/2020-12/schema",
+    title: "Agent validation schema",
+    description: "The spec defined for Agent validation",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2"]
+        },
+        kind: {
+            enum: ["Agent", "agent"]
+        },
+        ref: {
+            description: "Reference to the resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string",
+                    maxLength: 60
+                }
+            },
+            required: ["name"]
+        },
+        spec: {
+            description: "Operations spec for an Agent",
+            type: "object",
+            properties: {
+                username: {
+                    description: "The username for the Agent",
+                    type: "string",
+                    minLength: 4,
+                    maxLength: 60,
+                    readOnly: true
+                },
+                domainRef: {
+                    description: "The domain the Agent belongs to",
+                    type: "string"
+                },
+                credentialsRef: {
+                    description: "The credential the Agent uses to authenticate",
+                    type: "string"
+                },
+                enabled: {
+                    description: "Whether the Agent is enabled (reserved for future use)",
+                    type: "boolean"
+                },
+                privacy: {
+                    enum: ["PRIVATE", "NONE", "Private", "None", "private", "none"]
+                }
+            },
+            required: ["username"]
+        }
+    },
+    required: ["apiVersion", "kind", "metadata", "spec"]
+};

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

@@ -0,0 +1,59 @@
+declare const _default: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        apiVersion: {
+            enum: string[];
+        };
+        kind: {
+            enum: string[];
+        };
+        ref: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                name: {
+                    description: string;
+                    type: string;
+                    maxLength: number;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                credentials: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        username: {
+                            description: string;
+                            type: string;
+                            readOnly: boolean;
+                            minLength: number;
+                            maxLength: number;
+                        };
+                        password: {
+                            description: string;
+                            type: string;
+                            writeOnly: boolean;
+                            maxLength: number;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            required: string[];
+        };
+    };
+    required: string[];
+};
+export default _default;