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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.12",
+  "version": "2.0.8-alpha.13",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -26,7 +26,9 @@
     "@opentelemetry/semantic-conventions": "^1.0.4",
     "fp-ts": "^2.11.8",
     "ip-utils": "^2.4.0",
-    "pb-util": "^1.0.3"
+    "js-yaml": "^4.1.0",
+    "pb-util": "^1.0.3",
+    "toml": "^3.0.0"
   },
   "directories": {
     "src": "src",
@@ -45,5 +47,8 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "57f6f94ceeba177909e209222d5ad0a1bc375896"
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.5"
+  },
+  "gitHead": "d866d6c03c5ea7e8fc3ee074804005df3a5be42f"
 }