@routr/common 2.0.8-alpha.3 → 2.0.8-alpha.30

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

@@ -0,0 +1,125 @@
+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: {
+                inbound: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        uri: {
+                            description: string;
+                            type: string;
+                            maxLength: number;
+                        };
+                        accessControlListRef: {
+                            description: string;
+                            type: string;
+                        };
+                        credentialsRef: {
+                            description: string;
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+                outbound: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        sendRegister: {
+                            description: string;
+                            type: string;
+                        };
+                        credentialsRef: {
+                            description: string;
+                            type: string;
+                        };
+                        uris: {
+                            description: string;
+                            type: string;
+                            items: {
+                                type: string;
+                                properties: {
+                                    uri: {
+                                        description: string;
+                                        type: string;
+                                        properties: {
+                                            host: {
+                                                description: string;
+                                                type: string;
+                                                maxLength: number;
+                                            };
+                                            port: {
+                                                description: string;
+                                                type: string;
+                                                maximum: number;
+                                            };
+                                            transport: {
+                                                description: string;
+                                                enum: string[];
+                                            };
+                                            user: {
+                                                description: string;
+                                                type: string;
+                                                maxLength: number;
+                                            };
+                                        };
+                                        required: string[];
+                                    };
+                                    weight: {
+                                        description: string;
+                                        type: string;
+                                        minimum: number;
+                                        maximum: number;
+                                    };
+                                    priority: {
+                                        description: string;
+                                        type: string;
+                                        minimum: number;
+                                        maximum: number;
+                                    };
+                                    enabled: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/trunk.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2022 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 Peer validation",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2"]
+        },
+        kind: {
+            enum: ["Trunk", "trunk"]
+        },
+        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 Trunk",
+            type: "object",
+            properties: {
+                inbound: {
+                    description: "Inbound configuration",
+                    type: "object",
+                    properties: {
+                        uri: {
+                            description: "URI of the inbound endpoint",
+                            type: "string",
+                            maxLength: 255
+                        },
+                        accessControlListRef: {
+                            description: "Reference to the ACL to be used for inbound traffic",
+                            type: "string"
+                        },
+                        credentialsRef: {
+                            description: "Reference to the credentials to be used for inbound traffic",
+                            type: "string"
+                        }
+                    },
+                    required: ["uri"]
+                },
+                outbound: {
+                    description: "Outbound configuration",
+                    type: "object",
+                    properties: {
+                        sendRegister: {
+                            description: "Whether to send register messages",
+                            type: "boolean"
+                        },
+                        credentialsRef: {
+                            description: "Reference to the credentials to be used for outbound traffic",
+                            type: "string"
+                        },
+                        uris: {
+                            description: "List of URIs to be used for outbound traffic",
+                            type: "array",
+                            items: {
+                                type: "object",
+                                properties: {
+                                    uri: {
+                                        description: "URI to be used for outbound traffic",
+                                        type: "object",
+                                        properties: {
+                                            host: {
+                                                description: "Hostname of the URI",
+                                                type: "string",
+                                                maxLength: 255
+                                            },
+                                            port: {
+                                                description: "Port of the URI",
+                                                type: "integer",
+                                                maximum: 65535
+                                            },
+                                            transport: {
+                                                description: "Transport of the URI",
+                                                enum: [
+                                                    "TCP",
+                                                    "SCTP",
+                                                    "UDP",
+                                                    "TLS",
+                                                    "WS",
+                                                    "WSS",
+                                                    "tcp",
+                                                    "sctp",
+                                                    "udp",
+                                                    "tls",
+                                                    "ws",
+                                                    "wss"
+                                                ]
+                                            },
+                                            user: {
+                                                description: "Username of the URI",
+                                                type: "string",
+                                                maxLength: 60
+                                            }
+                                        },
+                                        required: ["host", "port", "transport"]
+                                    },
+                                    weight: {
+                                        description: "Weight of the URI",
+                                        type: "integer",
+                                        minimum: 1,
+                                        maximum: 65535
+                                    },
+                                    priority: {
+                                        description: "Priority of the URI",
+                                        type: "integer",
+                                        minimum: 0,
+                                        maximum: 65535
+                                    },
+                                    enabled: {
+                                        description: "Whether the URI is enabled",
+                                        type: "boolean"
+                                    }
+                                },
+                                required: ["uri"]
+                            }
+                        }
+                    },
+                    required: ["uris"]
+                }
+            }
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

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

@@ -0,0 +1,2 @@
+declare const schemaValidators: Map<any, any>;
+export { schemaValidators };

package/dist/connect/schemas/validators.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemaValidators = void 0;
+/*
+ * Copyright (C) 2022 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 types_1 = require("../types");
+const ajv_1 = __importDefault(require("ajv"));
+const acl_1 = __importDefault(require("./acl"));
+const agent_1 = __importDefault(require("./agent"));
+const crendentials_1 = __importDefault(require("./crendentials"));
+const domain_1 = __importDefault(require("./domain"));
+const number_1 = __importDefault(require("./number"));
+const peer_1 = __importDefault(require("./peer"));
+const trunk_1 = __importDefault(require("./trunk"));
+const validator = (schema) => new ajv_1.default().compile(schema);
+const schemaValidators = new Map();
+exports.schemaValidators = schemaValidators;
+schemaValidators.set(types_1.Kind.ACL, validator(acl_1.default));
+schemaValidators.set(types_1.Kind.AGENT, validator(agent_1.default));
+schemaValidators.set(types_1.Kind.CREDENTIALS, validator(crendentials_1.default));
+schemaValidators.set(types_1.Kind.DOMAIN, validator(domain_1.default));
+schemaValidators.set(types_1.Kind.NUMBER, validator(number_1.default));
+schemaValidators.set(types_1.Kind.PEER, validator(peer_1.default));
+schemaValidators.set(types_1.Kind.TRUNK, validator(trunk_1.default));

package/dist/connect/types.d.ts

@@ -1,35 +1,103 @@
-export declare enum KIND {
+import { JsonObject } from "pb-util/build";
+import { LoadBalancingAlgorithm, Privacy, Transport } from "../types";
+export declare enum Kind {
     AGENT = "agent",
     PEER = "peer",
     NUMBER = "number",
     TRUNK = "trunk",
     DOMAIN = "domain",
     UNKNOWN = "unknown",
-    CREDENTIAL = "credential"
+    CREDENTIALS = "credentials",
+    ACL = "accesscontrollist"
 }
-export declare enum FindCriteria {
-    FIND_AGENT_BY_USERNAME = "find_agent_by_username",
-    FIND_CREDENTIAL_BY_REFERENCE = "find_credential_by_reference",
-    FIND_DOMAIN_BY_DOMAINURI = "find_domain_by_domainuri",
-    FIND_NUMBER_BY_TELURL = "find_number_by_telurl",
-    FIND_TRUNKS_WITH_SEND_REGISTER = "find_trunks_with_send_register"
+export type KindWithoutUnknown = Exclude<Kind, Kind.UNKNOWN>;
+export declare enum APIVersion {
+    V2DRAFT1 = "v2draft1",
+    V2 = "v2"
 }
-export interface FindParameters {
-    kind: KIND;
-    criteria: FindCriteria;
-    parameters: Record<string, string>;
-}
-export interface DataAPI {
-    get: (ref: string) => Promise<Resource>;
-    findBy: (request: FindParameters) => Promise<Resource[]>;
-}
-export interface Resource {
+export interface BaseConnectModel {
     apiVersion: string;
-    kind: string;
     ref: string;
-    metadata: {
+    name: string;
+    createdAt?: number;
+    updatedAt?: number;
+    extended?: JsonObject;
+}
+export interface AccessControlList extends BaseConnectModel {
+    allow: string[];
+    deny: string[];
+}
+export interface Domain extends BaseConnectModel {
+    domainUri: string;
+    accessControlListRef?: string;
+    accessControlList?: AccessControlList;
+    egressPolicies?: EgressPolicy[];
+}
+export interface EgressPolicy {
+    numberRef: string;
+    number?: INumber;
+    rule: string;
+}
+export interface Agent extends BaseConnectModel {
+    username: string;
+    privacy: Privacy;
+    enabled: boolean;
+    domainRef?: string;
+    domain?: Domain;
+    credentialsRef?: string;
+    credentials?: Credentials;
+}
+export interface Credentials extends BaseConnectModel {
+    username: string;
+    password: string;
+}
+export interface INumber extends BaseConnectModel {
+    telUrl: string;
+    aorLink: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    sessionAffinityHeader: string;
+    extraHeaders: {
         name: string;
-        region?: string;
-    };
-    spec: Record<string, any>;
+        value: string;
+    }[];
+    trunkRef?: string;
+    trunk?: Trunk;
+}
+export interface Trunk extends BaseConnectModel {
+    sendRegister: boolean;
+    inboundUri: string;
+    accessControlListRef?: string;
+    accessControlList?: AccessControlList;
+    inboundCredentialsRef?: string;
+    inboundCredentials?: Credentials;
+    outboundCredentialsRef?: string;
+    outboundCredentials?: Credentials;
+    uris?: TrunkURI[];
+}
+export interface TrunkURI {
+    ref?: string;
+    trunkRef?: string;
+    host: string;
+    port: number;
+    transport: Transport;
+    user: string;
+    weight: number;
+    priority: number;
+    enabled: boolean;
+}
+export interface Peer extends BaseConnectModel {
+    username: string;
+    aor: string;
+    contactAddr: string;
+    enabled: boolean;
+    accessControlListRef?: string;
+    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/connect/types.js

@@ -1,39 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FindCriteria = exports.KIND = void 0;
-/*
- * Copyright (C) 2022 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.
- */
-var KIND;
-(function (KIND) {
-    KIND["AGENT"] = "agent";
-    KIND["PEER"] = "peer";
-    KIND["NUMBER"] = "number";
-    KIND["TRUNK"] = "trunk";
-    KIND["DOMAIN"] = "domain";
-    KIND["UNKNOWN"] = "unknown";
-    KIND["CREDENTIAL"] = "credential";
-})(KIND = exports.KIND || (exports.KIND = {}));
-var FindCriteria;
-(function (FindCriteria) {
-    FindCriteria["FIND_AGENT_BY_USERNAME"] = "find_agent_by_username";
-    FindCriteria["FIND_CREDENTIAL_BY_REFERENCE"] = "find_credential_by_reference";
-    FindCriteria["FIND_DOMAIN_BY_DOMAINURI"] = "find_domain_by_domainuri";
-    FindCriteria["FIND_NUMBER_BY_TELURL"] = "find_number_by_telurl";
-    FindCriteria["FIND_TRUNKS_WITH_SEND_REGISTER"] = "find_trunks_with_send_register";
-})(FindCriteria = exports.FindCriteria || (exports.FindCriteria = {}));
+exports.APIVersion = exports.Kind = void 0;
+var Kind;
+(function (Kind) {
+    Kind["AGENT"] = "agent";
+    Kind["PEER"] = "peer";
+    Kind["NUMBER"] = "number";
+    Kind["TRUNK"] = "trunk";
+    Kind["DOMAIN"] = "domain";
+    Kind["UNKNOWN"] = "unknown";
+    Kind["CREDENTIALS"] = "credentials";
+    Kind["ACL"] = "accesscontrollist";
+})(Kind = exports.Kind || (exports.Kind = {}));
+var APIVersion;
+(function (APIVersion) {
+    APIVersion["V2DRAFT1"] = "v2draft1";
+    APIVersion["V2"] = "v2";
+})(APIVersion = exports.APIVersion || (exports.APIVersion = {}));

package/dist/connect/validations.d.ts

@@ -0,0 +1,43 @@
+import { BadRequestError } from "../errors";
+import { LoadBalancingAlgorithm } from "../types";
+export declare const hasReference: (ref: string) => true | BadRequestError;
+export declare const hasName: (name: string) => true | BadRequestError;
+export declare const isValidName: (name: string) => true | BadRequestError;
+export declare const hasUsername: (username: string) => true | BadRequestError;
+export declare const isValidUsername: (username: string) => true | BadRequestError;
+export declare const hasPassword: (password: string) => true | BadRequestError;
+export declare const hasDomainUri: (domainUri: string) => true | BadRequestError;
+export declare const isValidDomainUri: (domainUri: string) => true | BadRequestError;
+export declare const hasTelUrl: (telUrl: string) => true | BadRequestError;
+export declare const isValidSessionAffinityHeader: (sessionAffinityHeader: string) => true | BadRequestError;
+export declare const isValidHeader: (header: string) => true | BadRequestError;
+export declare const hasValidHeaders: (headers: {
+    name: string;
+    value: string;
+}[]) => true | BadRequestError;
+export declare const hasAOR: (aor: string) => true | BadRequestError;
+export declare const isValidAOR: (aor: string) => true | BadRequestError;
+export declare const hasAORLink: (aorLink: string) => true | BadRequestError;
+export declare const isValidAORLink: (aorLink: string) => true | BadRequestError;
+export declare const hasCity: (city: string) => true | BadRequestError;
+export declare const hasCountry: (country: string) => true | BadRequestError;
+export declare const hasCountryISOCode: (countryIsoCode: string) => true | BadRequestError;
+export declare const hasACLRules: (acl: {
+    deny: string[];
+    allow: string[];
+}) => true | BadRequestError;
+export declare const isValidACLRule: (rules: string[]) => true | BadRequestError;
+export declare const hasValidACLRules: (acl: {
+    deny: string[];
+    allow: string[];
+}) => true | BadRequestError;
+export declare const hasInboundUri: (inboundUri: string) => true | BadRequestError;
+export declare const isValidInboundUri: (inboundUri: string) => true | BadRequestError;
+export declare const isValidBalancingAlgorithm: (aor: string, algorithm: LoadBalancingAlgorithm) => BadRequestError;
+export declare const isValidPort: (port: string) => BadRequestError;
+export declare const hasHost: (host: string) => true | BadRequestError;
+export declare const isValidHost: (host: string) => true | BadRequestError;
+export declare const isValidContactAddress: (contactAddress: string) => BadRequestError;
+export declare const isValidPriority: (priority: string) => BadRequestError;
+export declare const isValidWeight: (weight: string) => BadRequestError;
+export declare const isValidE164: (e164Number: string, countryISOCode: string, validateMobilePrefix?: boolean) => BadRequestError;