@incanta/config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Incanta Games
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/config.d.ts

@@ -0,0 +1,17 @@
+export interface IConfigOptions {
+    configDir?: string;
+    configEnv?: string;
+}
+export declare class Config {
+    private configDir;
+    private values;
+    private customValues;
+    constructor(options?: IConfigOptions);
+    get<T>(key: string): T;
+    getWithParts<T>(keyParts: string[]): T;
+    has(key: string): boolean;
+    set<T>(key: string, value: T): void;
+    setWithParts<T>(keyParts: string[], value: T): void;
+    save(): Promise<void>;
+}
+//# sourceMappingURL=config.d.ts.map

package/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,MAAM,CAAM;IACpB,OAAO,CAAC,YAAY,CAAM;gBAEP,OAAO,CAAC,EAAE,cAAc;IAgCpC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC;IAKtB,YAAY,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC;IAkBtC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAUzB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAKnC,YAAY,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAe7C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAMnC"}

package/lib/config.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const loader_1 = require("./loader");
+class Config {
+    configDir;
+    values;
+    customValues;
+    constructor(options) {
+        this.values = {};
+        this.customValues = {};
+        this.configDir = options?.configDir || path_1.default.join(process.cwd(), "config");
+        const defaultValues = loader_1.Loader.load(path_1.default.join(this.configDir, "default"));
+        let envValues = {};
+        const configEnvDir = options?.configEnv || process.env["NODE_CONFIG_ENV"];
+        if (configEnvDir) {
+            if (fs_1.default.existsSync(path_1.default.join(this.configDir, configEnvDir))) {
+                envValues = loader_1.Loader.load(path_1.default.join(this.configDir, configEnvDir));
+            }
+            else {
+                console.log(`Cannot use environment deployment value of ${configEnvDir} because ${path_1.default.join(this.configDir, configEnvDir)} doesn't exist`);
+            }
+        }
+        const localValues = loader_1.Loader.load(path_1.default.join(this.configDir, "local"));
+        const overrideValues = loader_1.Loader.loadFile(path_1.default.join(this.configDir, "override.json"));
+        (0, lodash_merge_1.default)(this.values, defaultValues, envValues, localValues, overrideValues);
+    }
+    get(key) {
+        const parts = key.split(".");
+        return this.getWithParts(parts);
+    }
+    getWithParts(keyParts) {
+        if (keyParts.length === 0) {
+            throw new Error("Cannot use an empty key");
+        }
+        let obj = this.values;
+        for (const part of keyParts) {
+            if (typeof obj[part] === "undefined") {
+                throw new Error(`Could not find value for key ${keyParts.join(".")}`);
+            }
+            obj = obj[part];
+        }
+        return obj;
+    }
+    has(key) {
+        try {
+            this.get(key);
+        }
+        catch {
+            return false;
+        }
+        return true;
+    }
+    set(key, value) {
+        const parts = key.split(".");
+        this.setWithParts(parts, value);
+    }
+    setWithParts(keyParts, value) {
+        if (keyParts.length === 0) {
+            throw new Error("Cannot use an empty key");
+        }
+        const obj = {};
+        for (let i = 0; i < keyParts.length - 1; i++) {
+            obj[keyParts[i]] = {};
+        }
+        obj[keyParts[keyParts.length - 1]] = value;
+        (0, lodash_merge_1.default)(this.customValues, obj);
+    }
+    async save() {
+        const fileContents = JSON.stringify(this.customValues, null, 2);
+        await fs_1.default.promises.writeFile(this.configDir, fileContents, {
+            encoding: "utf-8",
+        });
+    }
+}
+exports.Config = Config;
+//# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAiC;AACjC,gDAAwB;AACxB,4CAAoB;AACpB,qCAAkC;AAOlC,MAAa,MAAM;IACT,SAAS,CAAS;IAElB,MAAM,CAAM;IACZ,YAAY,CAAM;IAE1B,YAAmB,OAAwB;QACzC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;QAE1E,MAAM,aAAa,GAAG,eAAM,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;QAExE,IAAI,SAAS,GAAQ,EAAE,CAAC;QACxB,MAAM,YAAY,GAAG,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC1E,IAAI,YAAY,EAAE;YAChB,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,EAAE;gBAC1D,SAAS,GAAG,eAAM,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;aAClE;iBAAM;gBACL,OAAO,CAAC,GAAG,CACT,8CAA8C,YAAY,YAAY,cAAI,CAAC,IAAI,CAC7E,IAAI,CAAC,SAAS,EACd,YAAY,CACb,gBAAgB,CAClB,CAAC;aACH;SACF;QAED,MAAM,WAAW,GAAG,eAAM,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAEpE,MAAM,cAAc,GAAG,eAAM,CAAC,QAAQ,CACpC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAC3C,CAAC;QAEF,IAAA,sBAAK,EAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAEM,GAAG,CAAI,GAAW;QACvB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAI,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,YAAY,CAAI,QAAkB;QACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QAED,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAEtB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;YAC3B,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,WAAW,EAAE;gBACpC,MAAM,IAAI,KAAK,CAAC,gCAAgC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aACvE;YAED,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;SACjB;QAED,OAAO,GAAQ,CAAC;IAClB,CAAC;IAEM,GAAG,CAAC,GAAW;QACpB,IAAI;YACF,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACf;QAAC,MAAM;YACN,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,GAAG,CAAI,GAAW,EAAE,KAAQ;QACjC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,YAAY,CAAI,KAAK,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,YAAY,CAAI,QAAkB,EAAE,KAAQ;QACjD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QAED,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;SACvB;QAED,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QAE3C,IAAA,sBAAK,EAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAChE,MAAM,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE;YACxD,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC;IACL,CAAC;CACF;AAjGD,wBAiGC"}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { Config } from "./config";
+declare const _default: Config;
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;;AAYlC,kBAAqB"}

package/lib/index.js

@@ -0,0 +1,11 @@
+"use strict";
+const config_1 = require("./config");
+let config = undefined;
+function GetConfig() {
+    if (!config) {
+        config = new config_1.Config();
+    }
+    return config;
+}
+module.exports = GetConfig();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,qCAAkC;AAElC,IAAI,MAAM,GAAuB,SAAS,CAAC;AAE3C,SAAS,SAAS;IAChB,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;KACvB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,iBAAS,SAAS,EAAE,CAAC"}

package/lib/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAOA,qBAAa,MAAM;WACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG;WAgC/B,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG;CAkExC"}

package/lib/loader.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Loader = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const jsonc_parser_1 = require("jsonc-parser");
+const json5_1 = __importDefault(require("json5"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+class Loader {
+    static loadFile(filePath) {
+        if (!fs_1.default.existsSync(filePath)) {
+            return {};
+        }
+        const fileContents = fs_1.default.readFileSync(filePath, {
+            encoding: "utf-8",
+        });
+        const fileParts = filePath.split(".");
+        const extension = fileParts[fileParts.length - 1];
+        if (/^ya?ml$/i.exec(extension)) {
+            // yaml file
+            return js_yaml_1.default.load(fileContents);
+        }
+        else if (/^json$/i.exec(extension)) {
+            // json file
+            return JSON.parse(fileContents);
+        }
+        else if (/^jsonc$/i.exec(extension)) {
+            // jsonc file
+            return (0, jsonc_parser_1.parse)(fileContents); // todo: handle error callback
+        }
+        else if (/^json5$/i.exec(extension)) {
+            // json5 file
+            return json5_1.default.parse(fileContents);
+        }
+        else {
+            console.log(`Invalid file name ${filePath}. Only yml, yaml, json, jsonc, json5 extensions are supported (case insensitive).`);
+            return {};
+        }
+    }
+    static load(folder) {
+        if (!fs_1.default.existsSync(folder)) {
+            return {};
+        }
+        const contents = fs_1.default.readdirSync(folder, {
+            encoding: "utf-8",
+            withFileTypes: true,
+        });
+        const baseObj = {};
+        for (const content of contents) {
+            if (!content.isDirectory() && content.name.startsWith("index.")) {
+                (0, lodash_merge_1.default)(baseObj, Loader.loadFile(path_1.default.join(folder, content.name)));
+            }
+        }
+        for (const content of contents) {
+            if (content.isDirectory()) {
+                const key = content.name;
+                if (typeof baseObj[key] !== "undefined") {
+                    console.log(`Could not load the directory ${key} because we already loaded a config for a file with the same name`);
+                    continue;
+                }
+                const obj = Loader.load(path_1.default.join(folder, content.name));
+                baseObj[key] = obj;
+            }
+            else {
+                if (content.name.startsWith("index.")) {
+                    // we already loaded this to be be in the base config
+                    continue;
+                }
+                const fileParts = content.name.split(".");
+                if (fileParts.length === 2) {
+                    const key = fileParts[0];
+                    if (typeof baseObj[key] !== "undefined") {
+                        console.log(`Could not load the file ${path_1.default.join(folder, content.name)} because we already loaded a config for a folder with the same name`);
+                        continue;
+                    }
+                    const obj = Loader.loadFile(path_1.default.join(folder, content.name));
+                    baseObj[key] = obj;
+                }
+                else {
+                    console.log(`Invalid file name ${content.name}. Config files must have a supported extension and contain no extra periods in the file name`);
+                    continue;
+                }
+            }
+        }
+        return baseObj;
+    }
+}
+exports.Loader = Loader;
+//# sourceMappingURL=loader.js.map

package/lib/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,+CAAmD;AACnD,kDAA0B;AAC1B,sDAA2B;AAC3B,gEAAiC;AAEjC,MAAa,MAAM;IACV,MAAM,CAAC,QAAQ,CAAC,QAAgB;QACrC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC5B,OAAO,EAAE,CAAC;SACX;QAED,MAAM,YAAY,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC7C,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAElD,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9B,YAAY;YACZ,OAAO,iBAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAChC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YACpC,YAAY;YACZ,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SACjC;aAAM,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YACrC,aAAa;YACb,OAAO,IAAA,oBAAU,EAAC,YAAY,CAAC,CAAC,CAAC,8BAA8B;SAChE;aAAM,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YACrC,aAAa;YACb,OAAO,eAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SAClC;aAAM;YACL,OAAO,CAAC,GAAG,CACT,qBAAqB,QAAQ,mFAAmF,CACjH,CAAC;YACF,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,MAAc;QAC/B,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QAED,MAAM,QAAQ,GAAG,YAAE,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,QAAQ,EAAE,OAAO;YACjB,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAQ,EAAE,CAAC;QAExB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC/D,IAAA,sBAAK,EAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAClE;SACF;QAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,OAAO,CAAC,WAAW,EAAE,EAAE;gBACzB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;gBAEzB,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACvC,OAAO,CAAC,GAAG,CACT,gCAAgC,GAAG,mEAAmE,CACvG,CAAC;oBACF,SAAS;iBACV;gBAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBAEzD,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;aACpB;iBAAM;gBACL,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;oBACrC,qDAAqD;oBACrD,SAAS;iBACV;gBAED,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC1B,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;oBAEzB,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;wBACvC,OAAO,CAAC,GAAG,CACT,2BAA2B,cAAI,CAAC,IAAI,CAClC,MAAM,EACN,OAAO,CAAC,IAAI,CACb,qEAAqE,CACvE,CAAC;wBACF,SAAS;qBACV;oBAED,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;oBAE7D,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;iBACpB;qBAAM;oBACL,OAAO,CAAC,GAAG,CACT,qBAAqB,OAAO,CAAC,IAAI,8FAA8F,CAChI,CAAC;oBACF,SAAS;iBACV;aACF;SACF;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAnGD,wBAmGC"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@incanta/config",
+  "version": "0.1.0",
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./config": "./lib/config.js"
+  },
+  "repository": "git@github.com:IncantaGames/config.git",
+  "author": "Incanta Games",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -b .",
+    "test": "jest"
+  },
+  "dependencies": {
+    "js-yaml": "^4.1.0",
+    "json5": "^2.2.3",
+    "jsonc-parser": "^3.2.0",
+    "lodash.merge": "^4.6.2"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/js-yaml": "^4.0.5",
+    "@types/lodash.merge": "^4.6.7",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
+    "eslint": "^8.31.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  }
+}

package/src/config.ts

@@ -0,0 +1,108 @@
+import merge from "lodash.merge";
+import path from "path";
+import fs from "fs";
+import { Loader } from "./loader";
+
+export interface IConfigOptions {
+  configDir?: string;
+  configEnv?: string;
+}
+
+export class Config {
+  private configDir: string;
+
+  private values: any;
+  private customValues: any;
+
+  public constructor(options?: IConfigOptions) {
+    this.values = {};
+    this.customValues = {};
+
+    this.configDir = options?.configDir || path.join(process.cwd(), "config");
+
+    const defaultValues = Loader.load(path.join(this.configDir, "default"));
+
+    let envValues: any = {};
+    const configEnvDir = options?.configEnv || process.env["NODE_CONFIG_ENV"];
+    if (configEnvDir) {
+      if (fs.existsSync(path.join(this.configDir, configEnvDir))) {
+        envValues = Loader.load(path.join(this.configDir, configEnvDir));
+      } else {
+        console.log(
+          `Cannot use environment deployment value of ${configEnvDir} because ${path.join(
+            this.configDir,
+            configEnvDir
+          )} doesn't exist`
+        );
+      }
+    }
+
+    const localValues = Loader.load(path.join(this.configDir, "local"));
+
+    const overrideValues = Loader.loadFile(
+      path.join(this.configDir, "override.json")
+    );
+
+    merge(this.values, defaultValues, envValues, localValues, overrideValues);
+  }
+
+  public get<T>(key: string): T {
+    const parts = key.split(".");
+    return this.getWithParts<T>(parts);
+  }
+
+  public getWithParts<T>(keyParts: string[]): T {
+    if (keyParts.length === 0) {
+      throw new Error("Cannot use an empty key");
+    }
+
+    let obj = this.values;
+
+    for (const part of keyParts) {
+      if (typeof obj[part] === "undefined") {
+        throw new Error(`Could not find value for key ${keyParts.join(".")}`);
+      }
+
+      obj = obj[part];
+    }
+
+    return obj as T;
+  }
+
+  public has(key: string): boolean {
+    try {
+      this.get(key);
+    } catch {
+      return false;
+    }
+
+    return true;
+  }
+
+  public set<T>(key: string, value: T): void {
+    const parts = key.split(".");
+    this.setWithParts<T>(parts, value);
+  }
+
+  public setWithParts<T>(keyParts: string[], value: T): void {
+    if (keyParts.length === 0) {
+      throw new Error("Cannot use an empty key");
+    }
+
+    const obj: any = {};
+    for (let i = 0; i < keyParts.length - 1; i++) {
+      obj[keyParts[i]] = {};
+    }
+
+    obj[keyParts[keyParts.length - 1]] = value;
+
+    merge(this.customValues, obj);
+  }
+
+  public async save(): Promise<void> {
+    const fileContents = JSON.stringify(this.customValues, null, 2);
+    await fs.promises.writeFile(this.configDir, fileContents, {
+      encoding: "utf-8",
+    });
+  }
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+import { Config } from "./config";
+
+let config: Config | undefined = undefined;
+
+function GetConfig(): Config {
+  if (!config) {
+    config = new Config();
+  }
+
+  return config;
+}
+
+export = GetConfig();

package/src/loader.ts

@@ -0,0 +1,107 @@
+import fs from "fs";
+import path from "path";
+import { parse as parseJsonc } from "jsonc-parser";
+import JSON5 from "json5";
+import YAML from "js-yaml";
+import merge from "lodash.merge";
+
+export class Loader {
+  public static loadFile(filePath: string): any {
+    if (!fs.existsSync(filePath)) {
+      return {};
+    }
+
+    const fileContents = fs.readFileSync(filePath, {
+      encoding: "utf-8",
+    });
+
+    const fileParts = filePath.split(".");
+    const extension = fileParts[fileParts.length - 1];
+
+    if (/^ya?ml$/i.exec(extension)) {
+      // yaml file
+      return YAML.load(fileContents);
+    } else if (/^json$/i.exec(extension)) {
+      // json file
+      return JSON.parse(fileContents);
+    } else if (/^jsonc$/i.exec(extension)) {
+      // jsonc file
+      return parseJsonc(fileContents); // todo: handle error callback
+    } else if (/^json5$/i.exec(extension)) {
+      // json5 file
+      return JSON5.parse(fileContents);
+    } else {
+      console.log(
+        `Invalid file name ${filePath}. Only yml, yaml, json, jsonc, json5 extensions are supported (case insensitive).`
+      );
+      return {};
+    }
+  }
+
+  public static load(folder: string): any {
+    if (!fs.existsSync(folder)) {
+      return {};
+    }
+
+    const contents = fs.readdirSync(folder, {
+      encoding: "utf-8",
+      withFileTypes: true,
+    });
+
+    const baseObj: any = {};
+
+    for (const content of contents) {
+      if (!content.isDirectory() && content.name.startsWith("index.")) {
+        merge(baseObj, Loader.loadFile(path.join(folder, content.name)));
+      }
+    }
+
+    for (const content of contents) {
+      if (content.isDirectory()) {
+        const key = content.name;
+
+        if (typeof baseObj[key] !== "undefined") {
+          console.log(
+            `Could not load the directory ${key} because we already loaded a config for a file with the same name`
+          );
+          continue;
+        }
+
+        const obj = Loader.load(path.join(folder, content.name));
+
+        baseObj[key] = obj;
+      } else {
+        if (content.name.startsWith("index.")) {
+          // we already loaded this to be be in the base config
+          continue;
+        }
+
+        const fileParts = content.name.split(".");
+        if (fileParts.length === 2) {
+          const key = fileParts[0];
+
+          if (typeof baseObj[key] !== "undefined") {
+            console.log(
+              `Could not load the file ${path.join(
+                folder,
+                content.name
+              )} because we already loaded a config for a folder with the same name`
+            );
+            continue;
+          }
+
+          const obj = Loader.loadFile(path.join(folder, content.name));
+
+          baseObj[key] = obj;
+        } else {
+          console.log(
+            `Invalid file name ${content.name}. Config files must have a supported extension and contain no extra periods in the file name`
+          );
+          continue;
+        }
+      }
+    }
+
+    return baseObj;
+  }
+}

package/test/config-env/config-env.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with env folder", () => {
+  test("correctly loaded production directory", () => {
+    const config = new Config({
+      configDir: path.join(__dirname),
+      configEnv: "production",
+    });
+    expect(config.get<number>("thing.test")).toBe(2);
+  });
+
+  test("correctly loaded dev directory", () => {
+    const config = new Config({
+      configDir: path.join(__dirname),
+      configEnv: "dev",
+    });
+    expect(config.get<number>("thing.test")).toBe(3);
+  });
+
+  test("correctly shows default value for invalid env directory", () => {
+    const config = new Config({
+      configDir: path.join(__dirname),
+      configEnv: "invalid",
+    });
+    expect(config.get<number>("thing.test")).toBe(1);
+  });
+});

package/test/config-env/default/thing.yaml

@@ -0,0 +1 @@
+test: 1

package/test/config-env/dev/thing.yaml

@@ -0,0 +1 @@
+test: 3

package/test/config-env/production/thing.yaml

@@ -0,0 +1 @@
+test: 2

package/test/config-json/config-json.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with JSON files", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded default directory", () => {
+    expect(config.get<string>("hello")).toBe("world");
+    expect(config.get<number>("foo.bar")).toBe(42);
+  });
+
+  test("correctly loaded sub default directory", () => {
+    const arr = config.get<number[]>("goodbye.universe");
+    expect(arr.length).toBe(4);
+    expect(arr[0]).toBe(1);
+    expect(arr[1]).toBe(3);
+    expect(arr[2]).toBe(3);
+    expect(arr[3]).toBe(7);
+  });
+});

package/test/config-json/default/foo.json

@@ -0,0 +1,3 @@
+{
+  "bar": 42
+}

package/test/config-json/default/goodbye/index.json

@@ -0,0 +1,8 @@
+{
+  "universe": [
+    1,
+    3,
+    3,
+    7
+  ]
+}

package/test/config-json/default/index.json

@@ -0,0 +1,3 @@
+{
+  "hello": "world"
+}

package/test/config-json5/config-json5.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with JSON5 files", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded default directory", () => {
+    expect(config.get<string>("hello")).toBe("world");
+    expect(config.get<number>("foo.bar")).toBe(42);
+  });
+
+  test("correctly loaded sub default directory", () => {
+    const arr = config.get<number[]>("goodbye.universe");
+    expect(arr.length).toBe(4);
+    expect(arr[0]).toBe(1);
+    expect(arr[1]).toBe(3);
+    expect(arr[2]).toBe(3);
+    expect(arr[3]).toBe(7);
+  });
+});

package/test/config-json5/default/foo.json5

@@ -0,0 +1,4 @@
+{
+  // Comment
+  "bar": 42
+}

package/test/config-json5/default/goodbye/index.json5

@@ -0,0 +1,9 @@
+{
+  // Comment
+  "universe": [
+    1,
+    3,
+    3,
+    7
+  ]
+}

package/test/config-json5/default/index.json5

@@ -0,0 +1,4 @@
+{
+  // Comment
+  "hello": "world"
+}

package/test/config-jsonc/config-jsonc.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with JSONC files", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded default directory", () => {
+    expect(config.get<string>("hello")).toBe("world");
+    expect(config.get<number>("foo.bar")).toBe(42);
+  });
+
+  test("correctly loaded sub default directory", () => {
+    const arr = config.get<number[]>("goodbye.universe");
+    expect(arr.length).toBe(4);
+    expect(arr[0]).toBe(1);
+    expect(arr[1]).toBe(3);
+    expect(arr[2]).toBe(3);
+    expect(arr[3]).toBe(7);
+  });
+});

package/test/config-jsonc/default/foo.jsonc

@@ -0,0 +1,4 @@
+{
+  // Comment
+  "bar": 42
+}

package/test/config-jsonc/default/goodbye/index.jsonc

@@ -0,0 +1,9 @@
+{
+  // Comment
+  "universe": [
+    1,
+    3,
+    3,
+    7
+  ]
+}

package/test/config-jsonc/default/index.jsonc

@@ -0,0 +1,4 @@
+{
+  // Comment
+  "hello": "world"
+}

package/test/config-local/config-local.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with local folder", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded local directory", () => {
+    expect(config.get<number>("thing.test")).toBe(3);
+  });
+});

package/test/config-local/default/thing.yaml

@@ -0,0 +1 @@
+test: 1

package/test/config-local/local/thing.yaml

@@ -0,0 +1 @@
+test: 3

package/test/config-local/production/thing.yaml

@@ -0,0 +1 @@
+test: 2

package/test/config-multi/config-multi.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with mixed file types", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded default directory", () => {
+    expect(config.get<string>("hello")).toBe("world");
+    expect(config.get<number>("foo.bar")).toBe(42);
+  });
+
+  test("correctly loaded sub default directory", () => {
+    const arr = config.get<number[]>("goodbye.universe");
+    expect(arr.length).toBe(4);
+    expect(arr[0]).toBe(1);
+    expect(arr[1]).toBe(3);
+    expect(arr[2]).toBe(3);
+    expect(arr[3]).toBe(7);
+  });
+});

package/test/config-multi/default/foo.json

@@ -0,0 +1,3 @@
+{
+  "bar": 42
+}

package/test/config-multi/default/goodbye/index.json5

@@ -0,0 +1,9 @@
+{
+  // Comment
+  "universe": [
+    1,
+    3,
+    3,
+    7
+  ]
+}

package/test/config-multi/default/index.yaml

@@ -0,0 +1 @@
+hello: world

package/test/config-override/config-override.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with override folder", () => {
+  test("correctly loaded production directory", () => {
+    const config = new Config({
+      configDir: path.join(__dirname),
+      configEnv: "production",
+    });
+    expect(config.get<number>("thing.test")).toBe(4);
+  });
+});

package/test/config-override/default/thing.yaml

@@ -0,0 +1 @@
+test: 1

package/test/config-override/local/thing.yaml

@@ -0,0 +1 @@
+test: 3

package/test/config-override/override.json

@@ -0,0 +1,5 @@
+{
+  "thing": {
+    "test": 4
+  }
+}

package/test/config-override/production/thing.yaml

@@ -0,0 +1 @@
+test: 2

package/test/config-yaml/config-yaml.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from "@jest/globals";
+import { Config } from "../../src/config";
+import path from "path";
+
+describe("Config with YAML files", () => {
+  const config = new Config({
+    configDir: path.join(__dirname),
+  });
+
+  test("correctly loaded default directory", () => {
+    expect(config.get<string>("hello")).toBe("world");
+    expect(config.get<number>("foo.bar")).toBe(42);
+  });
+
+  test("correctly loaded sub default directory", () => {
+    const arr = config.get<number[]>("goodbye.universe");
+    expect(arr.length).toBe(4);
+    expect(arr[0]).toBe(1);
+    expect(arr[1]).toBe(3);
+    expect(arr[2]).toBe(3);
+    expect(arr[3]).toBe(7);
+  });
+});

package/test/config-yaml/default/foo.yaml

@@ -0,0 +1 @@
+bar: 42

package/test/config-yaml/default/goodbye/index.yaml

@@ -0,0 +1,5 @@
+universe:
+  - 1
+  - 3
+  - 3
+  - 7

package/test/config-yaml/default/index.yaml

@@ -0,0 +1 @@
+hello: world