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

package/dist/connect/validations.js

@@ -0,0 +1,272 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidE164 = exports.isValidWeight = exports.isValidPriority = exports.isValidContactAddress = exports.isValidHost = exports.hasHost = exports.isValidPort = exports.isValidBalancingAlgorithm = exports.isValidInboundUri = exports.hasInboundUri = exports.hasValidACLRules = exports.isValidACLRule = exports.hasACLRules = exports.hasCountryISOCode = exports.hasCountry = exports.hasCity = exports.isValidAORLink = exports.hasAORLink = exports.isValidAOR = exports.hasAOR = exports.hasValidHeaders = exports.isValidHeader = exports.isValidSessionAffinityHeader = exports.hasTelUrl = exports.isValidDomainUri = exports.hasDomainUri = exports.hasPassword = exports.isValidUsername = exports.hasUsername = exports.isValidName = exports.hasName = exports.hasReference = 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 Validator = __importStar(require("validator"));
+const errors_1 = require("../errors");
+const types_1 = require("../types");
+const phone_1 = require("phone");
+const hasReference = (ref) => ref ? true : new errors_1.BadRequestError("the reference to the resource is required");
+exports.hasReference = hasReference;
+const hasName = (name) => name
+    ? true
+    : new errors_1.BadRequestError("the friendly name for the resource is required");
+exports.hasName = hasName;
+const isValidName = (name) => {
+    return Validator.default.isLength(name, { min: 1, max: 60 })
+        ? true
+        : new errors_1.BadRequestError("the friendly name must have less than 60 characters");
+};
+exports.isValidName = isValidName;
+const hasUsername = (username) => username ? true : new errors_1.BadRequestError("the username is required");
+exports.hasUsername = hasUsername;
+const isValidUsername = (username) => {
+    if (username &&
+        (!Validator.default.isAlphanumeric(username) ||
+            !Validator.default.isLowercase(username))) {
+        return new errors_1.BadRequestError("the username must be a lowercase, alphanumeric, and without spaces");
+    }
+    return true;
+};
+exports.isValidUsername = isValidUsername;
+const hasPassword = (password) => password ? true : new errors_1.BadRequestError("the password is required");
+exports.hasPassword = hasPassword;
+const hasDomainUri = (domainUri) => domainUri ? true : new errors_1.BadRequestError("the domainUri is required");
+exports.hasDomainUri = hasDomainUri;
+const isValidDomainUri = (domainUri) => {
+    return Validator.default.isFQDN(domainUri)
+        ? true
+        : new errors_1.BadRequestError("the domainUri must be a valid fully qualified domain name");
+};
+exports.isValidDomainUri = isValidDomainUri;
+const hasTelUrl = (telUrl) => telUrl ? true : new errors_1.BadRequestError("the telUrl is required");
+exports.hasTelUrl = hasTelUrl;
+// Supports alphanumeric, underscore, and dash (cannot end with dash)
+const isValidAlphanumeric = (value) => {
+    if (value.endsWith("-")) {
+        return false;
+    }
+    const regex = /^[a-zA-Z0-9-]+$/;
+    return regex.test(value);
+};
+const isValidSessionAffinityHeader = (sessionAffinityHeader) => {
+    return sessionAffinityHeader
+        ? isValidAlphanumeric(sessionAffinityHeader)
+            ? true
+            : new errors_1.BadRequestError("the sessionAffinityHeader must be alphanumeric and without spaces")
+        : true;
+};
+exports.isValidSessionAffinityHeader = isValidSessionAffinityHeader;
+const isValidHeader = (header) => {
+    return header
+        ? isValidAlphanumeric(header)
+            ? true
+            : new errors_1.BadRequestError("the header must be alphanumeric and without spaces")
+        : true;
+};
+exports.isValidHeader = isValidHeader;
+const hasValidHeaders = (headers) => {
+    // eslint-disable-next-line no-loops/no-loops
+    for (const header of headers) {
+        const E = (0, exports.isValidHeader)(header.name);
+        if (!header.value) {
+            return new errors_1.BadRequestError("the header value cannot be empty");
+        }
+        if (E instanceof errors_1.BadRequestError) {
+            return E;
+        }
+    }
+    return true;
+};
+exports.hasValidHeaders = hasValidHeaders;
+const hasAOR = (aor) => aor ? true : new errors_1.BadRequestError("the address of record (aor) is required");
+exports.hasAOR = hasAOR;
+const isValidAOR = (aor) => {
+    if (aor) {
+        if (!aor.startsWith("backend:") && !aor.startsWith("sip:")) {
+            return new errors_1.BadRequestError("the aor schema must start with `backend:` or `sip:`");
+        }
+    }
+    return true;
+};
+exports.isValidAOR = isValidAOR;
+const hasAORLink = (aorLink) => aorLink ? true : new errors_1.BadRequestError("the aorLink is required");
+exports.hasAORLink = hasAORLink;
+const isValidAORLink = (aorLink) => {
+    if (aorLink) {
+        if (!aorLink.startsWith("backend:") && !aorLink.startsWith("sip:")) {
+            return new errors_1.BadRequestError("the aorLink must start with backend: or sip:");
+        }
+    }
+    return true;
+};
+exports.isValidAORLink = isValidAORLink;
+const hasCity = (city) => city ? true : new errors_1.BadRequestError("the city is required");
+exports.hasCity = hasCity;
+const hasCountry = (country) => country ? true : new errors_1.BadRequestError("the country is required");
+exports.hasCountry = hasCountry;
+const hasCountryISOCode = (countryIsoCode) => countryIsoCode ? true : new errors_1.BadRequestError("the countryISOCode is required");
+exports.hasCountryISOCode = hasCountryISOCode;
+const hasACLRules = (acl) => {
+    var _a, _b;
+    if (!(acl === null || acl === void 0 ? void 0 : acl.deny) ||
+        !(acl === null || acl === void 0 ? void 0 : acl.allow) ||
+        ((_a = acl.deny) === null || _a === void 0 ? void 0 : _a.length) === 0 ||
+        ((_b = acl.allow) === null || _b === void 0 ? void 0 : _b.length) === 0) {
+        return new errors_1.BadRequestError("acl rules are required");
+    }
+    return true;
+};
+exports.hasACLRules = hasACLRules;
+const isValidACLRule = (rules) => {
+    // eslint-disable-next-line no-loops/no-loops
+    for (const cidr of rules) {
+        if (!Validator.default.isIPRange(cidr, 4) &&
+            !Validator.default.isIP(cidr, 4)) {
+            return new errors_1.BadRequestError(`${cidr} is not a valid cidr or ip`);
+        }
+    }
+    return true;
+};
+exports.isValidACLRule = isValidACLRule;
+const hasValidACLRules = (acl) => {
+    const deny = (0, exports.isValidACLRule)(acl === null || acl === void 0 ? void 0 : acl.deny);
+    if (deny instanceof errors_1.BadRequestError) {
+        return deny;
+    }
+    const allow = (0, exports.isValidACLRule)(acl === null || acl === void 0 ? void 0 : acl.allow);
+    if (allow instanceof errors_1.BadRequestError) {
+        return allow;
+    }
+    return true;
+};
+exports.hasValidACLRules = hasValidACLRules;
+const hasInboundUri = (inboundUri) => inboundUri ? true : new errors_1.BadRequestError("the inboundUri is required");
+exports.hasInboundUri = hasInboundUri;
+const isValidInboundUri = (inboundUri) => {
+    if (inboundUri && !Validator.default.isFQDN(inboundUri)) {
+        return new errors_1.BadRequestError("the inbound URI must be a valid FQDN (e.g. sip.example.com)");
+    }
+    return true;
+};
+exports.isValidInboundUri = isValidInboundUri;
+const isValidBalancingAlgorithm = (aor, algorithm) => {
+    if (aor.startsWith("backend:")) {
+        if (!algorithm || algorithm === types_1.LoadBalancingAlgorithm.UNSPECIFIED) {
+            return new errors_1.BadRequestError("when the aor schema is `backend:`, the balancing algorithm is required");
+        }
+    }
+    else {
+        if (algorithm && algorithm !== types_1.LoadBalancingAlgorithm.UNSPECIFIED) {
+            return new errors_1.BadRequestError("when the aor schema is `sip:`, the balancing algorithm is not allowed");
+        }
+    }
+};
+exports.isValidBalancingAlgorithm = isValidBalancingAlgorithm;
+const isValidPort = (port) => {
+    if (port) {
+        if (!Validator.default.isPort(port)) {
+            return new errors_1.BadRequestError("the port must be a valid port");
+        }
+    }
+};
+exports.isValidPort = isValidPort;
+const hasHost = (host) => host ? true : new errors_1.BadRequestError("the host is required");
+exports.hasHost = hasHost;
+const isValidHost = (host) => {
+    if (host) {
+        if (!Validator.default.isFQDN(host) && !Validator.default.isIP(host)) {
+            return new errors_1.BadRequestError("the host must be a valid FQDN or IP");
+        }
+    }
+    return true;
+};
+exports.isValidHost = isValidHost;
+const isValidContactAddress = (contactAddress) => {
+    if (contactAddress) {
+        const hostPart = contactAddress.split(":")[0];
+        const portPart = hostPart.split(":")[1] || "5060";
+        if (!Validator.default.isFQDN(hostPart) &&
+            !Validator.default.isIP(hostPart)) {
+            return new errors_1.BadRequestError("the contact address must be a valid FQDN or IP");
+        }
+        if (!Validator.default.isPort(portPart)) {
+            return new errors_1.BadRequestError("the contact port must be a valid port");
+        }
+    }
+};
+exports.isValidContactAddress = isValidContactAddress;
+const isValidPriority = (priority) => {
+    if (priority) {
+        if (!Validator.default.isInt(priority)) {
+            return new errors_1.BadRequestError("the priority must be a valid integer");
+        }
+        const p = parseInt(priority);
+        if (p < 0 || p > 65535) {
+            return new errors_1.BadRequestError("the priority must be between 0 and 65535");
+        }
+    }
+};
+exports.isValidPriority = isValidPriority;
+const isValidWeight = (weight) => {
+    if (weight) {
+        if (!Validator.default.isInt(weight)) {
+            return new errors_1.BadRequestError("the priority must be a valid integer");
+        }
+        const w = parseInt(weight);
+        if (w < 1 || w > 65535) {
+            return new errors_1.BadRequestError("the weight must be between 1 and 65535");
+        }
+    }
+};
+exports.isValidWeight = isValidWeight;
+const isValidE164 = (e164Number, countryISOCode, validateMobilePrefix = false) => {
+    const result = (0, phone_1.phone)(e164Number, {
+        country: countryISOCode,
+        validateMobilePrefix
+    });
+    if (!result.isValid) {
+        return new errors_1.BadRequestError("the telUrl must be a valid e164 number");
+    }
+};
+exports.isValidE164 = isValidE164;

package/dist/envs.d.ts

@@ -0,0 +1,2 @@
+export declare const ENFORCE_E164: boolean;
+export declare const ENFORCE_E164_WITH_MOBILE_PREFIX: boolean;

package/dist/envs.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENFORCE_E164_WITH_MOBILE_PREFIX = exports.ENFORCE_E164 = 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.
+ */
+exports.ENFORCE_E164 = process.env.ENFORCE_E164 === "true" ? true : false;
+exports.ENFORCE_E164_WITH_MOBILE_PREFIX = process.env.ENFORCE_E164_WITH_MOBILE_PREFIX === "true" ? true : false;

package/dist/errors.d.ts

@@ -1,7 +1,7 @@
 /**
  * Error thrown if the definition for a service is not found.
  */
-export declare class ServiceDefinitionNotFound extends Error {
+export declare class ServiceDefinitionNotFoundError extends Error {
     /**
      * Constructs a new ServiceDefinitionNotFound error.
      *
@@ -22,3 +22,37 @@ export declare class ServiceUnavailableError extends Error {
      */
     constructor(address: string);
 }
+/**
+ * Thrown for unimplemented handlers.
+ */
+export declare class UnimplementedError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     */
+    constructor();
+}
+/**
+ * Thrown if the resource is not found.
+ */
+export declare class ResourceNotFoundError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} ref - the reference of the resource
+     */
+    constructor(ref: string);
+}
+/**
+ * Thrown if the request is invalid.
+ */
+export declare class BadRequestError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} message - optional message with the error. Defaults to "bad request."
+     */
+    constructor(message?: string);
+}

package/dist/errors.js

@@ -23,9 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceUnavailableError = exports.ServiceDefinitionNotFound = void 0;
+exports.BadRequestError = exports.ResourceNotFoundError = exports.UnimplementedError = exports.ServiceUnavailableError = exports.ServiceDefinitionNotFoundError = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -46,7 +46,7 @@ const grpc = __importStar(require("@grpc/grpc-js"));
 /**
  * Error thrown if the definition for a service is not found.
  */
-class ServiceDefinitionNotFound extends Error {
+class ServiceDefinitionNotFoundError extends Error {
     /**
      * Constructs a new ServiceDefinitionNotFound error.
      *
@@ -54,12 +54,12 @@ class ServiceDefinitionNotFound extends Error {
      * @param {string} version - The version of the service definition.
      */
     constructor(name, version) {
-        super(`Service definition for ${name}/${version} not found`);
+        super(`service definition for ${name}/${version} not found`);
         // Set the prototype explicitly.
-        Object.setPrototypeOf(this, ServiceDefinitionNotFound.prototype);
+        Object.setPrototypeOf(this, ServiceDefinitionNotFoundError.prototype);
     }
 }
-exports.ServiceDefinitionNotFound = ServiceDefinitionNotFound;
+exports.ServiceDefinitionNotFoundError = ServiceDefinitionNotFoundError;
 /**
  * Error thrown if the service is not available.
  */
@@ -76,3 +76,49 @@ class ServiceUnavailableError extends Error {
     }
 }
 exports.ServiceUnavailableError = ServiceUnavailableError;
+/**
+ * Thrown for unimplemented handlers.
+ */
+class UnimplementedError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     */
+    constructor() {
+        super("this operation is not supported/enabled in this data api implementation.");
+        this.code = grpc.status.UNIMPLEMENTED;
+        Object.setPrototypeOf(this, UnimplementedError.prototype);
+    }
+}
+exports.UnimplementedError = UnimplementedError;
+/**
+ * Thrown if the resource is not found.
+ */
+class ResourceNotFoundError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} ref - the reference of the resource
+     */
+    constructor(ref) {
+        super(`resource not found: ${ref}`);
+        this.code = grpc.status.NOT_FOUND;
+        Object.setPrototypeOf(this, ResourceNotFoundError.prototype);
+    }
+}
+exports.ResourceNotFoundError = ResourceNotFoundError;
+/**
+ * Thrown if the request is invalid.
+ */
+class BadRequestError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} message - optional message with the error. Defaults to "bad request."
+     */
+    constructor(message) {
+        super(message !== null && message !== void 0 ? message : "bad request");
+        this.code = grpc.status.INVALID_ARGUMENT;
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/dist/healthcheck.d.ts

@@ -0,0 +1 @@
+export declare const check: (address: string) => Promise<void>;

package/dist/healthcheck.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.check = 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 grpc_health_check_1 = require("@fonoster/grpc-health-check");
+const check = (address) => (0, grpc_health_check_1.checker)("", address);
+exports.check = check;

package/dist/helper.d.ts

@@ -1,4 +1,4 @@
-import { MessageRequest, Transport } from "./types";
+import { NetInterface, Transport } from "./types";
 /**
  * Makes a deep copy of an object.
  *
@@ -9,8 +9,21 @@ export declare const deepCopy: <T>(source: T) => T;
 /**
  * Gets a listening point from a request.
  *
- * @param {MessageRequest} request - The source object.
- * @param {Transport} transport - The source object.
+ * @param {NetInterface[]} listeningPoints - The listening points.
+ * @param {Transport} transport - The transport.
  * @return {NetInterface} transport The deep copy of the source object.
  */
-export declare const getListeningPoint: (request: MessageRequest, transport: Transport) => import("./types").NetInterface;
+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>;
+export declare const toPascaleCase: (str: string) => string;

package/dist/helper.js

@@ -1,6 +1,34 @@
 "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.toPascaleCase = exports.readConfigFile = exports.getListeningPoint = exports.deepCopy = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -17,8 +45,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getListeningPoint = exports.deepCopy = void 0;
+const yaml = __importStar(require("js-yaml"));
+const toml = __importStar(require("toml"));
+const fs_1 = __importDefault(require("fs"));
 const types_1 = require("./types");
 /**
  * Makes a deep copy of an object.
@@ -44,17 +73,62 @@ exports.deepCopy = deepCopy;
 /**
  * Gets a listening point from a request.
  *
- * @param {MessageRequest} request - The source object.
- * @param {Transport} transport - The source object.
+ * @param {NetInterface[]} listeningPoints - The listening points.
+ * @param {Transport} transport - The transport.
  * @return {NetInterface} transport The deep copy of the source object.
  */
-const getListeningPoint = (request, transport) => {
+const getListeningPoint = (listeningPoints, transport) => {
     const listeningPoint = transport
-        ? request.listeningPoints.find((lp) => lp.transport.toLowerCase() === transport.toLowerCase())
-        : request.listeningPoints.find((lp) => lp.transport.toLowerCase() === types_1.Transport.UDP);
+        ? listeningPoints.find((lp) => lp.transport.toUpperCase() === transport.toUpperCase())
+        : listeningPoints.find((lp) => lp.transport.toUpperCase() === types_1.Transport.UDP);
     if (!listeningPoint) {
         throw new Error(`no listening point found for transport ${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;
+const toPascaleCase = (str) => {
+    return str
+        .replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => {
+        return index === 0 ? word.toUpperCase() : word.toUpperCase();
+    })
+        .replace(/\s+/g, "");
+};
+exports.toPascaleCase = toPascaleCase;

package/dist/index.d.ts

@@ -1,13 +1,16 @@
-import { calculateAuthResponse, generateNonce } from "./auth";
-import { ServiceUnavailableError } from "./errors";
 import createService, { getObjectProto, LOCATION_OBJECT_PROTO, PROCESSOR_OBJECT_PROTO } from "./service";
 import { HeaderModifier, MessageRequest, MessageResponse, Method, NetInterface, ObjectProto, ProcessorConfig, Route, ServiceInfo, Transport } from "./types";
-export { createService, getObjectProto, generateNonce, calculateAuthResponse, HeaderModifier, Route, ServiceUnavailableError, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export { createService, getObjectProto, HeaderModifier, Route, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export * as Auth from "./auth";
 export * as Redis from "./redis";
-export * as CommonTypes from "./types";
 export * as Helper from "./helper";
 export * as IpUtils from "./ip_utils";
 export * as Tracer from "./tracer";
 export * as Assertions from "./assertions";
 export * as CommonConnect from "./connect";
 export * as CommonRequester from "./requester";
+export * as CommonTypes from "./types";
+export * as CommonErrors from "./errors";
+export * as ConnectSchemas from "./connect/schemas";
+export * as Environment from "./envs";
+export * as HealthCheck from "./healthcheck";

package/dist/index.js

@@ -23,9 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.CommonTypes = exports.Redis = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.ServiceUnavailableError = exports.calculateAuthResponse = exports.generateNonce = exports.getObjectProto = exports.createService = void 0;
+exports.HealthCheck = exports.Environment = exports.ConnectSchemas = exports.CommonErrors = exports.CommonTypes = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.Redis = exports.Auth = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.getObjectProto = exports.createService = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -42,11 +42,6 @@ exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.T
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const auth_1 = require("./auth");
-Object.defineProperty(exports, "calculateAuthResponse", { enumerable: true, get: function () { return auth_1.calculateAuthResponse; } });
-Object.defineProperty(exports, "generateNonce", { enumerable: true, get: function () { return auth_1.generateNonce; } });
-const errors_1 = require("./errors");
-Object.defineProperty(exports, "ServiceUnavailableError", { enumerable: true, get: function () { return errors_1.ServiceUnavailableError; } });
 const service_1 = __importStar(require("./service"));
 exports.createService = service_1.default;
 Object.defineProperty(exports, "getObjectProto", { enumerable: true, get: function () { return service_1.getObjectProto; } });
@@ -55,11 +50,16 @@ Object.defineProperty(exports, "PROCESSOR_OBJECT_PROTO", { enumerable: true, get
 const types_1 = require("./types");
 Object.defineProperty(exports, "Method", { enumerable: true, get: function () { return types_1.Method; } });
 Object.defineProperty(exports, "Transport", { enumerable: true, get: function () { return types_1.Transport; } });
+exports.Auth = __importStar(require("./auth"));
 exports.Redis = __importStar(require("./redis"));
-exports.CommonTypes = __importStar(require("./types"));
 exports.Helper = __importStar(require("./helper"));
 exports.IpUtils = __importStar(require("./ip_utils"));
 exports.Tracer = __importStar(require("./tracer"));
 exports.Assertions = __importStar(require("./assertions"));
 exports.CommonConnect = __importStar(require("./connect"));
 exports.CommonRequester = __importStar(require("./requester"));
+exports.CommonTypes = __importStar(require("./types"));
+exports.CommonErrors = __importStar(require("./errors"));
+exports.ConnectSchemas = __importStar(require("./connect/schemas"));
+exports.Environment = __importStar(require("./envs"));
+exports.HealthCheck = __importStar(require("./healthcheck"));