@aneuhold/be-ts-lib 1.0.2 → 1.0.4

package/README.md

@@ -1,3 +1,5 @@
 # Personal Backend TypeScript Library
 
+![npm](https://img.shields.io/npm/v/%40aneuhold%2Fbe-ts-lib)
+
 This is a library meant to contain any common code between backend TypeScript projects.

package/lib/index.d.ts

@@ -7,6 +7,7 @@ import CurrentEnv, { OperatingSystemType, ShellType, TerminalType } from './util
 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 { Config };
+import TranslationService, { TranslationProject } from './services/TranslationService/TranslationService';
+export { CLIService, CurrentEnv, ChromeService, DockerService, OSFileSystemService, sleep, OperatingSystemType, ShellType, TerminalType, ITermService, ConfigService, TranslationService };
+export type { Config, TranslationProject };
 //# 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;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"}
+{"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,kBAAkB,EACnB,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,EACnB,CAAC;AAGF,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC"}

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigService = exports.ITermService = exports.TerminalType = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.OSFileSystemService = exports.DockerService = exports.ChromeService = exports.CurrentEnv = exports.CLIService = void 0;
+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"));
@@ -46,3 +46,5 @@ const ITermService_1 = __importDefault(require("./services/applications/ITermSer
 exports.ITermService = ITermService_1.default;
 const ConfigService_1 = __importDefault(require("./services/ConfigService/ConfigService"));
 exports.ConfigService = ConfigService_1.default;
+const TranslationService_1 = __importDefault(require("./services/TranslationService/TranslationService"));
+exports.TranslationService = TranslationService_1.default;

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

@@ -4,5 +4,8 @@
  */
 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

@@ -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;CACjB"}
+{"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/ConfigService.d.ts

@@ -8,32 +8,22 @@ export type ConfigEnv = 'local' | 'dev' | 'prod';
  */
 export default class ConfigService {
     static env: ConfigEnv | null;
-    private static gitHub;
     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.
-     */
-    private static getGitHubClient;
     /**
      * Inserts the provided configuration into the local environment.
      *
      * This may not actually need to happen.
      */
     private static insertPropertiesIntoEnv;
-    /**
-     * Strips JSON comments from the provided JSON string. Only `//` comments
-     * are supported at the moment.
-     */
-    private static stripJsonComments;
 }
 //# sourceMappingURL=ConfigService.d.ts.map

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;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;;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"}
+{"version":3,"file":"ConfigService.d.ts","sourceRoot":"","sources":["../../../src/services/ConfigService/ConfigService.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAEvB,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;IAerD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;CASvC"}

package/lib/services/ConfigService/ConfigService.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const octokit_1 = require("octokit");
 require("dotenv/config");
 const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const GitHubService_1 = __importDefault(require("../GitHubService"));
 /**
  * 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
@@ -10,7 +13,6 @@ const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
  */
 class ConfigService {
     static env = null;
-    static gitHub = null;
     static configObject = null;
     /**
      * Returns the configuration object that has been loaded in for the current
@@ -22,24 +24,17 @@ class ConfigService {
         }
         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();
-        }
         try {
-            const result = await ConfigService.gitHub.rest.repos.getContent({
-                mediaType: {
-                    format: 'raw'
-                },
-                owner: 'aneuhold',
-                repo: 'config',
-                path: `${env}.jsonc`
-            });
-            const strippedJson = ConfigService.stripJsonComments(result.data);
+            const jsonString = await GitHubService_1.default.getContentFromRepo('config', `${env}.jsonc`);
+            const strippedJson = core_ts_lib_1.StringService.stripJsonComments(jsonString);
             ConfigService.configObject = JSON.parse(strippedJson);
         }
         catch (error) {
@@ -47,19 +42,6 @@ class ConfigService {
             throw error;
         }
     }
-    /**
-     * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
-     * local environment or .env file.
-     */
-    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({
-            auth: authToken
-        });
-    }
     /**
      * Inserts the provided configuration into the local environment.
      *
@@ -75,13 +57,5 @@ class ConfigService {
             }
         });
     }
-    /**
-     * Strips JSON comments from the provided JSON string. Only `//` comments
-     * are supported at the moment.
-     */
-    static stripJsonComments = (jsonString) => {
-        const commentRegex = /\/\/(.*)/g;
-        return jsonString.replace(commentRegex, '');
-    };
 }
 exports.default = ConfigService;

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

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("console");
 const ConfigService_1 = __importDefault(require("./ConfigService"));
 describe('ConfigService', () => {
     describe('useConfig', () => {
@@ -15,7 +14,7 @@ describe('ConfigService', () => {
         it('should load configuration from GitHub', async () => {
             const env = 'local';
             await ConfigService_1.default.useConfig(env);
-            (0, console_1.assert)(ConfigService_1.default.config.someKey === 'SOME_VALUE');
+            expect(ConfigService_1.default.config.someKey).toEqual('SOME_VALUE');
         });
     });
 });

package/lib/services/GitHubService.d.ts

@@ -0,0 +1,15 @@
+import 'dotenv/config';
+export type ConfigEnv = 'local' | 'dev' | 'prod';
+/**
+ * A class which can be used to interact with GitHub.
+ */
+export default class GitHubService {
+    private static gitHub;
+    static getContentFromRepo(repoName: string, filePath: string): Promise<string>;
+    /**
+     * Creates a new GitHub client using `CONFIG_GITHUB_TOKEN` from the
+     * local environment or .env file.
+     */
+    private static getGitHubClient;
+}
+//# sourceMappingURL=GitHubService.d.ts.map

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

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

package/lib/services/GitHubService.js

@@ -0,0 +1,45 @@
+"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");
+/**
+ * A class which can be used to interact with GitHub.
+ */
+class GitHubService {
+    static gitHub = null;
+    static async getContentFromRepo(repoName, filePath) {
+        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;
+        }
+        catch (error) {
+            core_ts_lib_1.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.
+     */
+    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({
+            auth: authToken
+        });
+    }
+}
+exports.default = GitHubService;

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

@@ -0,0 +1,18 @@
+import 'dotenv/config';
+import { Translations } from '@aneuhold/core-ts-api-lib';
+export declare const TranslationProject: {
+    readonly dashboard: "dashboard";
+};
+export type TranslationProject = (typeof TranslationProject)[keyof typeof TranslationProject];
+/**
+ * A class which can be used to get translations for personal projects. It is
+ * expected that the translations will be loaded in fresh each time this class
+ * is called.
+ */
+export default class TranslationService {
+    /**
+     * Gets translations for the provided project.
+     */
+    static getTranslations(project: TranslationProject): Promise<Translations>;
+}
+//# sourceMappingURL=TranslationService.d.ts.map

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

@@ -0,0 +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;AAGzD,eAAO,MAAM,kBAAkB;;CAErB,CAAC;AACX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC;;OAEG;WACU,eAAe,CAAC,OAAO,EAAE,kBAAkB;CAazD"}

package/lib/services/TranslationService/TranslationService.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslationProject = void 0;
+require("dotenv/config");
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const GitHubService_1 = __importDefault(require("../GitHubService"));
+exports.TranslationProject = {
+    dashboard: 'dashboard'
+};
+/**
+ * A class which can be used to get translations for personal projects. It is
+ * expected that the translations will be loaded in fresh each time this class
+ * is called.
+ */
+class TranslationService {
+    /**
+     * Gets translations for the provided project.
+     */
+    static async getTranslations(project) {
+        try {
+            const jsonString = await GitHubService_1.default.getContentFromRepo('translations', `${project}.jsonc`);
+            const strippedJson = core_ts_lib_1.StringService.stripJsonComments(jsonString);
+            return JSON.parse(strippedJson);
+        }
+        catch (error) {
+            core_ts_lib_1.Logger.error(`Failed to load ${project}.json, error: ${error}`);
+            throw error;
+        }
+    }
+}
+exports.default = TranslationService;

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TranslationService.spec.d.ts.map

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

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

package/lib/services/TranslationService/TranslationService.spec.js

@@ -0,0 +1,39 @@
+"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 });
+const TranslationService_1 = __importStar(require("./TranslationService"));
+describe('TranslationService', () => {
+    describe('getTranslations', () => {
+        /**
+         * 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 translations from GitHub', async () => {
+            const translations = await TranslationService_1.default.getTranslations(TranslationService_1.TranslationProject.dashboard);
+            expect(translations['test-translation'].value).toEqual('something');
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/be-ts-lib",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A backend TypeScript library used for common functionality in personal backend projects.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -28,13 +28,15 @@
     "link:local": "cd lib && yarn link",
     "unlink:local": "cd lib && yarn unlink",
     "upgrade:all": "yarn upgrade --latest",
+    "upgrade:core": "yarn upgrade --latest --pattern @aneuhold",
     "test": "jest"
   },
   "dependencies": {
-    "@aneuhold/core-ts-lib": "^1.1.5",
+    "@aneuhold/core-ts-api-lib": "^1.0.4",
+    "@aneuhold/core-ts-lib": "^1.1.8",
+    "dotenv": "^16.3.1",
     "node-fetch": "^2",
-    "octokit": "^3.1.2",
-    "dotenv": "^16.3.1"
+    "octokit": "^3.1.2"
   },
   "devDependencies": {
     "@types/jest": "^29.5.8",