@aneuhold/be-ts-lib 1.0.78 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Anton G Neuhold Jr]
+
+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/README.md

@@ -1,5 +1,48 @@
 # Personal Backend TypeScript Library
 
-![npm](https://img.shields.io/npm/v/%40aneuhold%2Fbe-ts-lib)
+[![JSR](https://jsr.io/badges/@aneuhold/be-ts-lib)](https://jsr.io/@aneuhold/be-ts-lib)
+[![NPM](https://img.shields.io/npm/v/%40aneuhold%2Fbe-ts-lib)](https://www.npmjs.com/package/@aneuhold/be-ts-lib)
 
 This is a library meant to contain any common code between backend TypeScript projects.
+
+## 📦 Installation
+
+To add to a repo, follow the instructions below for your environment:
+
+### For Node using NPM
+
+Run `yarn add @aneuhold/be-ts-lib`
+
+### For Node using JSR
+
+The below instructions still allow for things like Renovate to work, and normal commands with yarn such as `yarn up`.
+
+1. Add the required JSR configuration to a `.yarnrc.yml` file if not there already:
+   ```yml
+   npmScopes:
+     jsr:
+       npmRegistryServer: 'https://npm.jsr.io'
+   ```
+1. Add the package with `yarn add @jsr/aneuhold__be-ts-lib`
+
+### For Deno
+
+Run `deno add jsr:@aneuhold/be-ts-lib`
+
+## 🟢 Usage
+
+Pull in one of the services and use it like so:
+
+```ts
+import { ConfigService } from '@aneuhold/be-ts-lib';
+// If using Node with JSR
+// import { ConfigService } from '@jsr/aneuhold__be-ts-lib';
+
+export default async function getConfig() {
+  await ConfigService.useConfig('local');
+  const config = ConfigService.config;
+  console.log(config);
+}
+```
+
+[See full documentation on usage at JSR!](https://jsr.io/@aneuhold/be-ts-lib/doc)

package/lib/index.d.ts

@@ -1,13 +1,6 @@
-import { sleep } from '@aneuhold/core-ts-lib';
-import CLIService from './services/CLIService';
-import ChromeService from './services/applications/ChromeService';
-import DockerService from './services/applications/DockerService';
-import OSFileSystemService from './services/applications/OSFileSystemService';
-import CurrentEnv, { OperatingSystemType, ShellType, TerminalType } from './utils/CurrentEnv';
-import ITermService from './services/applications/ITermService';
-import ConfigService from './services/ConfigService/ConfigService';
-import Config from './services/ConfigService/ConfigDefinition';
-import TranslationService, { TranslationSource } from './services/TranslationService/TranslationService';
-export { CLIService, CurrentEnv, ChromeService, DockerService, OSFileSystemService, sleep, OperatingSystemType, ShellType, TerminalType, ITermService, ConfigService, TranslationService, TranslationSource };
+import Config from './services/ConfigService/ConfigDefinition.js';
+import ConfigService from './services/ConfigService/ConfigService.js';
+import TranslationService, { TranslationSource } from './services/TranslationService/TranslationService.js';
+export { ConfigService, TranslationService, TranslationSource };
 export type { Config };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,mBAAmB,MAAM,6CAA6C,CAAC;AAC9E,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,YAAY,MAAM,sCAAsC,CAAC;AAChE,OAAO,aAAa,MAAM,wCAAwC,CAAC;AACnE,OAAO,MAAM,MAAM,2CAA2C,CAAC;AAC/D,OAAO,kBAAkB,EAAE,EACzB,iBAAiB,EAClB,MAAM,kDAAkD,CAAC;AAG1D,OAAO,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EAClB,CAAC;AAGF,YAAY,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,8CAA8C,CAAC;AAClE,OAAO,aAAa,MAAM,2CAA2C,CAAC;AACtE,OAAO,kBAAkB,EAAE,EACzB,iBAAiB,EAClB,MAAM,qDAAqD,CAAC;AAG7D,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;AAGhE,YAAY,EAAE,MAAM,EAAE,CAAC"}

package/lib/index.js

@@ -1,51 +1,5 @@
-"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.TranslationSource = exports.TranslationService = exports.ConfigService = exports.ITermService = exports.TerminalType = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.OSFileSystemService = exports.DockerService = exports.ChromeService = exports.CurrentEnv = exports.CLIService = void 0;
-const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
-Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return core_ts_lib_1.sleep; } });
-const CLIService_1 = __importDefault(require("./services/CLIService"));
-exports.CLIService = CLIService_1.default;
-const ChromeService_1 = __importDefault(require("./services/applications/ChromeService"));
-exports.ChromeService = ChromeService_1.default;
-const DockerService_1 = __importDefault(require("./services/applications/DockerService"));
-exports.DockerService = DockerService_1.default;
-const OSFileSystemService_1 = __importDefault(require("./services/applications/OSFileSystemService"));
-exports.OSFileSystemService = OSFileSystemService_1.default;
-const CurrentEnv_1 = __importStar(require("./utils/CurrentEnv"));
-exports.CurrentEnv = CurrentEnv_1.default;
-Object.defineProperty(exports, "OperatingSystemType", { enumerable: true, get: function () { return CurrentEnv_1.OperatingSystemType; } });
-Object.defineProperty(exports, "ShellType", { enumerable: true, get: function () { return CurrentEnv_1.ShellType; } });
-Object.defineProperty(exports, "TerminalType", { enumerable: true, get: function () { return CurrentEnv_1.TerminalType; } });
-const ITermService_1 = __importDefault(require("./services/applications/ITermService"));
-exports.ITermService = ITermService_1.default;
-const ConfigService_1 = __importDefault(require("./services/ConfigService/ConfigService"));
-exports.ConfigService = ConfigService_1.default;
-const TranslationService_1 = __importStar(require("./services/TranslationService/TranslationService"));
-exports.TranslationService = TranslationService_1.default;
-Object.defineProperty(exports, "TranslationSource", { enumerable: true, get: function () { return TranslationService_1.TranslationSource; } });
+import ConfigService from './services/ConfigService/ConfigService.js';
+import TranslationService, { TranslationSource } from './services/TranslationService/TranslationService.js';
+// Export all the functions and classes from this library
+export { ConfigService, TranslationService, TranslationSource };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,2CAA2C,CAAC;AACtE,OAAO,kBAAkB,EAAE,EACzB,iBAAiB,EAClB,MAAM,qDAAqD,CAAC;AAE7D,yDAAyD;AACzD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC"}

package/lib/index.ts

@@ -0,0 +1,11 @@
+import Config from './services/ConfigService/ConfigDefinition.js';
+import ConfigService from './services/ConfigService/ConfigService.js';
+import TranslationService, {
+  TranslationSource
+} from './services/TranslationService/TranslationService.js';
+
+// Export all the functions and classes from this library
+export { ConfigService, TranslationService, TranslationSource };
+
+// Export TypeScript types where needed
+export type { Config };

package/lib/services/ConfigService/ConfigDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigDefinition.d.ts","sourceRoot":"","sources":["../../../src/services/ConfigService/ConfigDefinition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,MAAM;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"ConfigDefinition.d.ts","sourceRoot":"./src/","sources":["services/ConfigService/ConfigDefinition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,MAAM;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/lib/services/ConfigService/ConfigDefinition.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
+//# sourceMappingURL=ConfigDefinition.js.map

package/lib/services/ConfigService/ConfigDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigDefinition.js","sourceRoot":"./src/","sources":["services/ConfigService/ConfigDefinition.ts"],"names":[],"mappings":""}

package/lib/services/ConfigService/ConfigDefinition.ts

@@ -0,0 +1,10 @@
+/**
+ * The environment configuration that is pulled in for the current environment
+ * from the GitHub repository.
+ */
+export default interface Config {
+  someKey: string;
+  mongoRootUsername: string;
+  mongoRootPassword: string;
+  mongoUrl: string;
+}

package/lib/services/ConfigService/ConfigService.d.ts

@@ -1,28 +1,49 @@
 import 'dotenv/config';
-import Config from './ConfigDefinition';
+import Config from './ConfigDefinition.js';
 export type ConfigEnv = 'local' | 'dev' | 'prod';
 /**
- * A class which can be used to load configuration into the ConfigService
- * from a pre-defined location. This requries that a `.env` file exists in the
+ * Service for managing configuration settings.
+ *
+ * The {@link ConfigService} class provides methods to load and access configuration
+ * settings from a GitHub repository. It ensures that the configuration is loaded
+ * and available for the current environment.
+ *
+ * This requires that a `.env` file exists in the
  * root of the project / machine with a `CONFIG_GITHUB_TOKEN` variable set.
  */
 export default class ConfigService {
+    /**
+     * The current environment configuration.
+     */
     static env: ConfigEnv | null;
     private static configObject;
     /**
      * Returns the configuration object that has been loaded in for the current
      * environment.
+     *
+     * @throws {Error} If the {@link ConfigService} has not been initialized.
+     * @returns The configuration object for the current environment.
      */
     static get config(): Config;
+    /**
+     * Checks if the {@link ConfigService} has been initialized.
+     *
+     * @returns True if the {@link ConfigService} has been initialized, false otherwise.
+     */
     static get isInitialized(): boolean;
     /**
-     * Loads configuration from the GitHub repository into the ConfigService.
+     * Loads configuration from the GitHub repository into the {@link ConfigService}.
+     *
+     * @param env - The environment for which to load the configuration.
+     * @throws {Error} If the configuration fails to load.
      */
     static useConfig(env: ConfigEnv): Promise<void>;
     /**
      * Inserts the provided configuration into the local environment.
      *
      * This may not actually need to happen.
+     *
+     * @param config - The configuration object to insert into the environment.
      */
     private static insertPropertiesIntoEnv;
 }

package/lib/services/ConfigService/ConfigService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigService.d.ts","sourceRoot":"","sources":["../../../src/services/ConfigService/ConfigService.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAGvB,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAGxC,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEpC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAuB;IAElD;;;OAGG;IACH,MAAM,KAAK,MAAM,IAAI,MAAM,CAO1B;IAED,MAAM,KAAK,aAAa,IAAI,OAAO,CAElC;IAED;;OAEG;WACU,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;CASvC"}
+{"version":3,"file":"ConfigService.d.ts","sourceRoot":"./src/","sources":["services/ConfigService/ConfigService.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAC;AAGvB,OAAO,MAAM,MAAM,uBAAuB,CAAC;AAE3C,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEpC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAuB;IAElD;;;;;;OAMG;IACH,MAAM,KAAK,MAAM,IAAI,MAAM,CAO1B;IAED;;;;OAIG;IACH,MAAM,KAAK,aAAa,IAAI,OAAO,CAElC;IAED;;;;;OAKG;WACU,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrD;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;CASvC"}

package/lib/services/ConfigService/ConfigService.js

@@ -1,23 +1,29 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-require("dotenv/config");
-const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
-const jsonc_parser_1 = require("jsonc-parser");
-const GitHubService_1 = __importDefault(require("../GitHubService"));
+import { Logger } from '@aneuhold/core-ts-lib';
+import 'dotenv/config';
+import { parse } from 'jsonc-parser';
+import GitHubService from '../GitHubService.js';
 /**
- * A class which can be used to load configuration into the ConfigService
- * from a pre-defined location. This requries that a `.env` file exists in the
+ * Service for managing configuration settings.
+ *
+ * The {@link ConfigService} class provides methods to load and access configuration
+ * settings from a GitHub repository. It ensures that the configuration is loaded
+ * and available for the current environment.
+ *
+ * This requires that a `.env` file exists in the
  * root of the project / machine with a `CONFIG_GITHUB_TOKEN` variable set.
  */
-class ConfigService {
+export default class ConfigService {
+    /**
+     * The current environment configuration.
+     */
     static env = null;
     static configObject = null;
     /**
      * Returns the configuration object that has been loaded in for the current
      * environment.
+     *
+     * @throws {Error} If the {@link ConfigService} has not been initialized.
+     * @returns The configuration object for the current environment.
      */
     static get config() {
         if (!ConfigService.configObject) {
@@ -25,20 +31,28 @@ class ConfigService {
         }
         return ConfigService.configObject;
     }
+    /**
+     * Checks if the {@link ConfigService} has been initialized.
+     *
+     * @returns True if the {@link ConfigService} has been initialized, false otherwise.
+     */
     static get isInitialized() {
         return !!ConfigService.configObject;
     }
     /**
-     * Loads configuration from the GitHub repository into the ConfigService.
+     * Loads configuration from the GitHub repository into the {@link ConfigService}.
+     *
+     * @param env - The environment for which to load the configuration.
+     * @throws {Error} If the configuration fails to load.
      */
     static async useConfig(env) {
         ConfigService.env = env;
         try {
-            const jsonString = await GitHubService_1.default.getContentFromRepo('config', `${env}.jsonc`);
-            ConfigService.configObject = (0, jsonc_parser_1.parse)(jsonString);
+            const jsonString = await GitHubService.getContentFromRepo('config', `${env}.jsonc`);
+            ConfigService.configObject = parse(jsonString);
         }
         catch (error) {
-            core_ts_lib_1.Logger.error(`Failed to load ${env}.json, error: ${error}`);
+            Logger.error(`Failed to load ${env}.json, error: ${error}`);
             throw error;
         }
     }
@@ -46,6 +60,8 @@ class ConfigService {
      * Inserts the provided configuration into the local environment.
      *
      * This may not actually need to happen.
+     *
+     * @param config - The configuration object to insert into the environment.
      */
     static insertPropertiesIntoEnv(config) {
         Object.entries(config).forEach(([key, value]) => {
@@ -58,4 +74,4 @@ class ConfigService {
         });
     }
 }
-exports.default = ConfigService;
+//# sourceMappingURL=ConfigService.js.map

package/lib/services/ConfigService/ConfigService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigService.js","sourceRoot":"./src/","sources":["services/ConfigService/ConfigService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAKhD;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC;;OAEG;IACH,MAAM,CAAC,GAAG,GAAqB,IAAI,CAAC;IAE5B,MAAM,CAAC,YAAY,GAAkB,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,MAAM,KAAK,MAAM;QACf,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F,CAAC;QACJ,CAAC;QACD,OAAO,aAAa,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,MAAM,KAAK,aAAa;QACtB,OAAO,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,GAAc;QACnC,aAAa,CAAC,GAAG,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,kBAAkB,CACvD,QAAQ,EACR,GAAG,GAAG,QAAQ,CACf,CAAC;YACF,aAAa,CAAC,YAAY,GAAG,KAAK,CAAC,UAAU,CAAW,CAAC;QAC3D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,kBAAkB,GAAG,iBAAiB,KAAe,EAAE,CAAC,CAAC;YACtE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,uBAAuB,CAAC,MAAc;QACnD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,aAAa,CAAC,uBAAuB,CAAC,KAAe,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAe,CAAC;YACrC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC"}

package/lib/services/ConfigService/ConfigService.spec.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest';
+import ConfigService from './ConfigService.js';
+
+describe('ConfigService', () => {
+  describe('useConfig', () => {
+    /**
+     * Depends upon a GitHub token being available in the local environment.
+     * This will be a local `.env` file with the CONFIG_GITHUB_TOKEN variable
+     * set.
+     */
+    it('should load configuration from GitHub', async () => {
+      const env = 'local';
+      await ConfigService.useConfig(env);
+      expect(ConfigService.config.someKey).toEqual('SOME_VALUE');
+    });
+  });
+});

package/lib/services/ConfigService/ConfigService.ts

@@ -0,0 +1,88 @@
+import { Logger } from '@aneuhold/core-ts-lib';
+import 'dotenv/config';
+import { parse } from 'jsonc-parser';
+import GitHubService from '../GitHubService.js';
+import Config from './ConfigDefinition.js';
+
+export type ConfigEnv = 'local' | 'dev' | 'prod';
+
+/**
+ * Service for managing configuration settings.
+ *
+ * The {@link ConfigService} class provides methods to load and access configuration
+ * settings from a GitHub repository. It ensures that the configuration is loaded
+ * and available for the current environment.
+ *
+ * This requires that a `.env` file exists in the
+ * root of the project / machine with a `CONFIG_GITHUB_TOKEN` variable set.
+ */
+export default class ConfigService {
+  /**
+   * The current environment configuration.
+   */
+  static env: ConfigEnv | null = null;
+
+  private static configObject: Config | null = null;
+
+  /**
+   * Returns the configuration object that has been loaded in for the current
+   * environment.
+   *
+   * @throws {Error} If the {@link ConfigService} has not been initialized.
+   * @returns The configuration object for the current environment.
+   */
+  static get config(): Config {
+    if (!ConfigService.configObject) {
+      throw new Error(
+        'ConfigService has not been initialized yet. Use ConfigService.useConfig() to initialize it.'
+      );
+    }
+    return ConfigService.configObject;
+  }
+
+  /**
+   * Checks if the {@link ConfigService} has been initialized.
+   *
+   * @returns True if the {@link ConfigService} has been initialized, false otherwise.
+   */
+  static get isInitialized(): boolean {
+    return !!ConfigService.configObject;
+  }
+
+  /**
+   * Loads configuration from the GitHub repository into the {@link ConfigService}.
+   *
+   * @param env - The environment for which to load the configuration.
+   * @throws {Error} If the configuration fails to load.
+   */
+  static async useConfig(env: ConfigEnv): Promise<void> {
+    ConfigService.env = env;
+    try {
+      const jsonString = await GitHubService.getContentFromRepo(
+        'config',
+        `${env}.jsonc`
+      );
+      ConfigService.configObject = parse(jsonString) as Config;
+    } catch (error) {
+      Logger.error(`Failed to load ${env}.json, error: ${error as string}`);
+      throw error;
+    }
+  }
+
+  /**
+   * Inserts the provided configuration into the local environment.
+   *
+   * This may not actually need to happen.
+   *
+   * @param config - The configuration object to insert into the environment.
+   */
+  private static insertPropertiesIntoEnv(config: object) {
+    Object.entries(config).forEach(([key, value]) => {
+      if (typeof value === 'object') {
+        ConfigService.insertPropertiesIntoEnv(value as object);
+      } else {
+        process.env[key] = value as string;
+      }
+    });
+  }
+}

package/lib/services/GitHubService.d.ts

@@ -5,10 +5,20 @@ export type ConfigEnv = 'local' | 'dev' | 'prod';
  */
 export default class GitHubService {
     private static gitHub;
+    /**
+     * Retrieves the content of a file from a specified GitHub repository.
+     *
+     * @param repoName - The name of the repository.
+     * @param filePath - The path to the file within the repository.
+     * @returns The content of the file as a string.
+     * @throws Will throw an error if the content cannot be retrieved.
+     */
     static getContentFromRepo(repoName: string, filePath: string): Promise<string>;
     /**
      * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
      * local environment or .env file.
+     *
+     * @returns A new GitHub client.
      */
     private static getGitHubClient;
 }

package/lib/services/GitHubService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GitHubService.d.ts","sourceRoot":"","sources":["../../src/services/GitHubService.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAC;AAGvB,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAwB;WAEhC,kBAAkB,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAsBlB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAW/B"}
+{"version":3,"file":"GitHubService.d.ts","sourceRoot":"./src/","sources":["services/GitHubService.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAC;AAGvB,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAwB;IAE7C;;;;;;;OAOG;WACU,kBAAkB,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAsBlB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAW/B"}

package/lib/services/GitHubService.js

@@ -1,13 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const octokit_1 = require("octokit");
-require("dotenv/config");
-const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+import { Logger } from '@aneuhold/core-ts-lib';
+import 'dotenv/config';
+import { Octokit } from 'octokit';
 /**
  * A class which can be used to interact with GitHub.
  */
-class GitHubService {
+export default class GitHubService {
     static gitHub = null;
+    /**
+     * Retrieves the content of a file from a specified GitHub repository.
+     *
+     * @param repoName - The name of the repository.
+     * @param filePath - The path to the file within the repository.
+     * @returns The content of the file as a string.
+     * @throws Will throw an error if the content cannot be retrieved.
+     */
     static async getContentFromRepo(repoName, filePath) {
         if (!GitHubService.gitHub) {
             GitHubService.gitHub = GitHubService.getGitHubClient();
@@ -24,22 +30,24 @@ class GitHubService {
             return result.data;
         }
         catch (error) {
-            core_ts_lib_1.Logger.error(`Failed to load ${filePath} from ${repoName}, error: ${error}`);
+            Logger.error(`Failed to load ${filePath} from ${repoName}, error: ${error}`);
             throw error;
         }
     }
     /**
      * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
      * local environment or .env file.
+     *
+     * @returns A new GitHub client.
      */
     static getGitHubClient() {
         const authToken = process.env.CONFIG_GITHUB_TOKEN;
         if (!authToken) {
             throw new Error('No CONFIG_GITHUB_TOKEN key found in environment variables.');
         }
-        return new octokit_1.Octokit({
+        return new Octokit({
             auth: authToken
         });
     }
 }
-exports.default = GitHubService;
+//# sourceMappingURL=GitHubService.js.map

package/lib/services/GitHubService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GitHubService.js","sourceRoot":"./src/","sources":["services/GitHubService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,eAAe,CAAC;AACvB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIlC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IACxB,MAAM,CAAC,MAAM,GAAmB,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,QAAgB,EAChB,QAAgB;QAEhB,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAC1B,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,eAAe,EAAE,CAAC;QACzD,CAAC;QACD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC9D,SAAS,EAAE;oBACT,MAAM,EAAE,KAAK;iBACd;gBACD,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC,CAAC;YACH,OAAO,MAAM,CAAC,IAAyB,CAAC;QAC1C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,kBAAkB,QAAQ,SAAS,QAAQ,YAAY,KAAe,EAAE,CACzE,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,eAAe;QAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAClD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,OAAO,CAAC;YACjB,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC"}

package/lib/services/GitHubService.ts

@@ -0,0 +1,63 @@
+import { Logger } from '@aneuhold/core-ts-lib';
+import 'dotenv/config';
+import { Octokit } from 'octokit';
+
+export type ConfigEnv = 'local' | 'dev' | 'prod';
+
+/**
+ * A class which can be used to interact with GitHub.
+ */
+export default class GitHubService {
+  private static gitHub: Octokit | null = null;
+
+  /**
+   * Retrieves the content of a file from a specified GitHub repository.
+   *
+   * @param repoName - The name of the repository.
+   * @param filePath - The path to the file within the repository.
+   * @returns The content of the file as a string.
+   * @throws Will throw an error if the content cannot be retrieved.
+   */
+  static async getContentFromRepo(
+    repoName: string,
+    filePath: string
+  ): Promise<string> {
+    if (!GitHubService.gitHub) {
+      GitHubService.gitHub = GitHubService.getGitHubClient();
+    }
+    try {
+      const result = await GitHubService.gitHub.rest.repos.getContent({
+        mediaType: {
+          format: 'raw'
+        },
+        owner: 'aneuhold',
+        repo: repoName,
+        path: filePath
+      });
+      return result.data as unknown as string;
+    } catch (error) {
+      Logger.error(
+        `Failed to load ${filePath} from ${repoName}, error: ${error as string}`
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
+   * local environment or .env file.
+   *
+   * @returns A new GitHub client.
+   */
+  private static getGitHubClient(): Octokit {
+    const authToken = process.env.CONFIG_GITHUB_TOKEN;
+    if (!authToken) {
+      throw new Error(
+        'No CONFIG_GITHUB_TOKEN key found in environment variables.'
+      );
+    }
+    return new Octokit({
+      auth: authToken
+    });
+  }
+}

package/lib/services/TranslationService/TranslationService.d.ts

@@ -1,5 +1,8 @@
-import 'dotenv/config';
 import { Translations } from '@aneuhold/core-ts-api-lib';
+import 'dotenv/config';
+/**
+ * An enum which defines the sources of translations which can be loaded.
+ */
 export declare enum TranslationSource {
     dashboard = "dashboard"
 }
@@ -11,6 +14,9 @@ export declare enum TranslationSource {
 export default class TranslationService {
     /**
      * Gets translations for the provided source.
+     *
+     * @param source - The source of the translations.
+     * @returns The translations for the provided source.
      */
     static getTranslations(source: TranslationSource): Promise<Translations>;
 }

package/lib/services/TranslationService/TranslationService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TranslationService.d.ts","sourceRoot":"","sources":["../../../src/services/TranslationService/TranslationService.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAIzD,oBAAY,iBAAiB;IAC3B,SAAS,cAAc;CACxB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC;;OAEG;WACU,eAAe,CAAC,MAAM,EAAE,iBAAiB;CAYvD"}
+{"version":3,"file":"TranslationService.d.ts","sourceRoot":"./src/","sources":["services/TranslationService/TranslationService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,eAAe,CAAC;AAIvB;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,SAAS,cAAc;CACxB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC;;;;;OAKG;WACU,eAAe,CAC1B,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,YAAY,CAAC;CAYzB"}