@aneuhold/be-ts-lib 1.0.1 → 1.0.3

package/lib/index.d.ts

@@ -6,6 +6,7 @@ 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';
 export { CLIService, CurrentEnv, ChromeService, DockerService, OSFileSystemService, sleep, OperatingSystemType, ShellType, TerminalType, ITermService, ConfigService };
-export type {};
+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;AAGnE,OAAO,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACd,CAAC;AAGF,YAAY,EAAE,CAAC"}
+{"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;AAG/D,OAAO,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACd,CAAC;AAGF,YAAY,EAAE,MAAM,EAAE,CAAC"}

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

@@ -0,0 +1,11 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=ConfigDefinition.d.ts.map

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

@@ -0,0 +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"}

package/lib/services/ConfigService/ConfigDefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,12 +1,25 @@
 import 'dotenv/config';
+import Config from './ConfigDefinition';
 export type ConfigEnv = 'local' | 'dev' | 'prod';
 /**
- * A class which can be used to load configuration into the local environment
- * from a pre-defined location.
+ * 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
+ * root of the project / machine with a `CONFIG_GITHUB_TOKEN` variable set.
  */
 export default class ConfigService {
+    static env: ConfigEnv | null;
     private static gitHub;
-    static useConfig(env: string): Promise<void>;
+    private static configObject;
+    /**
+     * Returns the configuration object that has been loaded in for the current
+     * environment.
+     */
+    static get config(): Config;
+    static get isInitialized(): boolean;
+    /**
+     * Loads configuration from the GitHub repository into the ConfigService.
+     */
+    static useConfig(env: ConfigEnv): Promise<void>;
     /**
      * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
      * local environment or .env file.
@@ -14,6 +27,8 @@ export default class ConfigService {
     private static getGitHubClient;
     /**
      * Inserts the provided configuration into the local environment.
+     *
+     * This may not actually need to happen.
      */
     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":"AACA,OAAO,eAAe,CAAC;AAGvB,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAwB;WAEhC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBlD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAY9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAUtC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAG9B;CACH"}
+{"version":3,"file":"ConfigService.d.ts","sourceRoot":"","sources":["../../../src/services/ConfigService/ConfigService.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAC;AAEvB,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAExC,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,MAAM,CAAwB;IAE7C,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;IAwBrD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAY9B;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAUtC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAG9B;CACH"}

package/lib/services/ConfigService/ConfigService.js

@@ -4,12 +4,32 @@ const octokit_1 = require("octokit");
 require("dotenv/config");
 const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
 /**
- * A class which can be used to load configuration into the local environment
- * from a pre-defined location.
+ * 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
+ * root of the project / machine with a `CONFIG_GITHUB_TOKEN` variable set.
  */
 class ConfigService {
+    static env = null;
     static gitHub = null;
+    static configObject = null;
+    /**
+     * Returns the configuration object that has been loaded in for the current
+     * environment.
+     */
+    static get config() {
+        if (!ConfigService.configObject) {
+            throw new Error('ConfigService has not been initialized yet. Use ConfigService.useConfig() to initialize it.');
+        }
+        return ConfigService.configObject;
+    }
+    static get isInitialized() {
+        return !!ConfigService.configObject;
+    }
+    /**
+     * Loads configuration from the GitHub repository into the ConfigService.
+     */
     static async useConfig(env) {
+        ConfigService.env = env;
         if (!ConfigService.gitHub) {
             ConfigService.gitHub = ConfigService.getGitHubClient();
         }
@@ -23,8 +43,7 @@ class ConfigService {
                 path: `${env}.jsonc`
             });
             const strippedJson = ConfigService.stripJsonComments(result.data);
-            const config = JSON.parse(strippedJson);
-            ConfigService.insertPropertiesIntoEnv(config);
+            ConfigService.configObject = JSON.parse(strippedJson);
         }
         catch (error) {
             core_ts_lib_1.Logger.error(`Failed to load ${env}.json, error: ${error}`);
@@ -46,6 +65,8 @@ class ConfigService {
     }
     /**
      * Inserts the provided configuration into the local environment.
+     *
+     * This may not actually need to happen.
      */
     static insertPropertiesIntoEnv(config) {
         Object.entries(config).forEach(([key, value]) => {

package/lib/services/ConfigService/ConfigService.spec.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const console_1 = require("console");
-const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
 const ConfigService_1 = __importDefault(require("./ConfigService"));
 describe('ConfigService', () => {
     describe('useConfig', () => {
@@ -16,13 +15,7 @@ describe('ConfigService', () => {
         it('should load configuration from GitHub', async () => {
             const env = 'local';
             await ConfigService_1.default.useConfig(env);
-            (0, console_1.assert)(process.env.SOME_KEY === 'SOME_VALUE');
-        });
-        it('should throw an error when loading configuration fails', async () => {
-            const env = 'invalid_env';
-            core_ts_lib_1.TestUtils.suppressConsole();
-            await expect(ConfigService_1.default.useConfig(env)).rejects.toThrow();
-            core_ts_lib_1.TestUtils.restoreConsole();
+            (0, console_1.assert)(ConfigService_1.default.config.someKey === 'SOME_VALUE');
         });
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/be-ts-lib",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A backend TypeScript library used for common functionality in personal backend projects.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",