@routr/common 2.0.8-alpha.12 → 2.0.8-alpha.14

package/dist/connect/schemas/number.js

@@ -0,0 +1,96 @@
+"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: "Number Schema",
+    description: "A JSON Schema for validating numbers.",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2.0", "v2"]
+        },
+        kind: {
+            enum: ["Number", "number"]
+        },
+        ref: {
+            description: "Reference to the resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string"
+                }
+            }
+        },
+        spec: {
+            description: "Operations spec for Numbers",
+            type: "object",
+            properties: {
+                trunkRef: {
+                    description: "Reference to the trunk",
+                    type: "string"
+                },
+                location: {
+                    description: "Location of the number",
+                    type: "object",
+                    properties: {
+                        telUrl: {
+                            description: "Tel URL",
+                            type: "string"
+                        },
+                        aorLink: {
+                            description: "AOR link",
+                            type: "string"
+                        },
+                        sessionAffinityHeader: {
+                            description: "Session affinity",
+                            type: "string"
+                        },
+                        extraHeaders: {
+                            description: "Properties",
+                            type: "array",
+                            items: {
+                                type: "object",
+                                properties: {
+                                    name: {
+                                        description: "Name of the header",
+                                        type: "string"
+                                    },
+                                    value: {
+                                        description: "Value of the header",
+                                        type: "string"
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    required: ["telUrl", "aorLink"]
+                }
+            },
+            required: ["trunkRef", "location"]
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

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

@@ -0,0 +1,67 @@
+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;
+                };
+            };
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                username: {
+                    description: string;
+                    type: string;
+                    minLength: number;
+                    maxLength: number;
+                    readOnly: boolean;
+                };
+                aor: {
+                    description: string;
+                    type: string;
+                    minLength: number;
+                    maxLength: number;
+                };
+                contactAddr: {
+                    description: string;
+                    type: string;
+                    maxLength: number;
+                };
+                credentialsRef: {
+                    description: string;
+                    type: string;
+                };
+                accessControlListRef: {
+                    description: string;
+                    type: string;
+                };
+                enabled: {
+                    description: string;
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/peer.js

@@ -0,0 +1,86 @@
+"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.0", "v2"]
+        },
+        kind: {
+            enum: ["Peer", "peer"]
+        },
+        ref: {
+            description: "Reference to the resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string"
+                }
+            }
+        },
+        spec: {
+            description: "Operations spec for an Peer",
+            type: "object",
+            properties: {
+                username: {
+                    description: "The username for the Peer",
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 60,
+                    readOnly: true
+                },
+                aor: {
+                    description: "Address of the Peer (acceptable schemas are sip, backend.)",
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 255
+                },
+                contactAddr: {
+                    description: "Contact address of the Peer",
+                    type: "string",
+                    maxLength: 255
+                },
+                credentialsRef: {
+                    description: "The credential the Peer uses to authenticate",
+                    type: "string"
+                },
+                accessControlListRef: {
+                    description: "The ACL the Peer uses to control access to the Peer (Reserved for future use)",
+                    type: "string"
+                },
+                enabled: {
+                    description: "Whether the Peer is enabled",
+                    type: "boolean"
+                }
+            },
+            required: ["username", "aor"]
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

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

@@ -0,0 +1,113 @@
+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;
+                };
+            };
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                inbound: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        uri: {
+                            description: string;
+                            type: string;
+                        };
+                        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;
+                                            };
+                                            port: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            transport: {
+                                                description: string;
+                                                enum: string[];
+                                            };
+                                            user: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                        };
+                                    };
+                                    weight: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    priority: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    enabled: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/trunk.js

@@ -0,0 +1,132 @@
+"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.0", "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"
+                }
+            }
+        },
+        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"
+                        },
+                        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"
+                                            },
+                                            port: {
+                                                description: "Port of the URI",
+                                                type: "integer"
+                                            },
+                                            transport: {
+                                                description: "Transport of the URI",
+                                                enum: ["tcp", "sctp", "udp", "tls", "ws", "wss"]
+                                            },
+                                            user: {
+                                                description: "Username of the URI",
+                                                type: "string"
+                                            }
+                                        }
+                                    },
+                                    weight: {
+                                        description: "Weight of the URI",
+                                        type: "integer"
+                                    },
+                                    priority: {
+                                        description: "Priority of the URI",
+                                        type: "integer"
+                                    },
+                                    enabled: {
+                                        description: "Whether the URI is enabled",
+                                        type: "boolean"
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    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

@@ -5,13 +5,13 @@ export declare enum Kind {
     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_PEER_BY_USERNAME = "find_peer_by_username",
-    FIND_CREDENTIAL_BY_REFERENCE = "find_credential_by_reference",
+    FIND_CREDENTIALS_BY_REFERENCE = "find_credentials_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",

package/dist/connect/types.js

@@ -27,14 +27,14 @@ var Kind;
     Kind["TRUNK"] = "trunk";
     Kind["DOMAIN"] = "domain";
     Kind["UNKNOWN"] = "unknown";
-    Kind["CREDENTIAL"] = "credential";
+    Kind["CREDENTIALS"] = "credentials";
     Kind["ACL"] = "accesscontrollist";
 })(Kind = exports.Kind || (exports.Kind = {}));
 var FindCriteria;
 (function (FindCriteria) {
     FindCriteria["FIND_AGENT_BY_USERNAME"] = "find_agent_by_username";
     FindCriteria["FIND_PEER_BY_USERNAME"] = "find_peer_by_username";
-    FindCriteria["FIND_CREDENTIAL_BY_REFERENCE"] = "find_credential_by_reference";
+    FindCriteria["FIND_CREDENTIALS_BY_REFERENCE"] = "find_credentials_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";

package/dist/helper.d.ts

@@ -14,3 +14,15 @@ export declare const deepCopy: <T>(source: T) => T;
  * @return {NetInterface} transport The deep copy of the source object.
  */
 export declare const getListeningPoint: (listeningPoints: NetInterface[], transport: Transport) => NetInterface;
+/**
+ * Reads a file and returns a JSON object or throws an error.
+ * The file must be a valid JSON, YAML, or TOML file.
+ *
+ * @param {string} path - The path to the file.
+ * @return {object} The JSON object.
+ * @throws {Error} If the file is not a valid JSON, YAML, or TOML file.
+ * @throws {Error} If the file does not exist.
+ * @throws {Error} If the file is not readable.
+ * @throws {Error} If the file is empty.
+ */
+export declare const readConfigFile: (path: string) => Record<string, any>;

package/dist/helper.js

@@ -1,6 +1,32 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getListeningPoint = exports.deepCopy = void 0;
+exports.readConfigFile = exports.getListeningPoint = exports.deepCopy = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -20,6 +46,9 @@ exports.getListeningPoint = exports.deepCopy = void 0;
  * limitations under the License.
  */
 const types_1 = require("./types");
+const fs_1 = __importDefault(require("fs"));
+const yaml = __importStar(require("js-yaml"));
+const toml = __importStar(require("toml"));
 /**
  * Makes a deep copy of an object.
  *
@@ -58,3 +87,40 @@ const getListeningPoint = (listeningPoints, transport) => {
     return listeningPoint;
 };
 exports.getListeningPoint = getListeningPoint;
+/**
+ * Reads a file and returns a JSON object or throws an error.
+ * The file must be a valid JSON, YAML, or TOML file.
+ *
+ * @param {string} path - The path to the file.
+ * @return {object} The JSON object.
+ * @throws {Error} If the file is not a valid JSON, YAML, or TOML file.
+ * @throws {Error} If the file does not exist.
+ * @throws {Error} If the file is not readable.
+ * @throws {Error} If the file is empty.
+ */
+const readConfigFile = (path) => {
+    if (!fs_1.default.existsSync(path) || !fs_1.default.statSync(path).isFile()) {
+        throw new Error(`config file ${path} does not exist`);
+    }
+    const content = fs_1.default.readFileSync(path, "utf8");
+    try {
+        return yaml.load(content);
+    }
+    catch (e) {
+        // Ignore
+    }
+    // Experimental TOML support
+    try {
+        return toml.parse(content);
+    }
+    catch (e) {
+        // Ignore
+    }
+    try {
+        return JSON.parse(content);
+    }
+    catch (e) {
+        throw new Error("file is not a valid JSON or YAML file");
+    }
+};
+exports.readConfigFile = readConfigFile;

package/dist/index.d.ts

@@ -11,3 +11,4 @@ export * as Assertions from "./assertions";
 export * as CommonConnect from "./connect";
 export * as CommonRequester from "./requester";
 export * as Auth from "./auth";
+export * as ConnectSchemas from "./connect/schemas";