@aneuhold/core-ts-lib 1.0.10 → 1.0.12

package/lib/index.d.ts

@@ -6,8 +6,9 @@ import DockerService from './services/applications/DockerService';
 import FileSystemService from './services/applications/FileSystemService';
 import ITermService from './services/applications/ITermService';
 import CLIService from './services/CLIService';
+import ConfigService from './services/ConfigService/ConfigService';
 import StringService from './services/StringService';
 import CurrentEnv, { OperatingSystemType, ShellType, TerminalType } from './utils/CurrentEnv';
 import Logger from './utils/Logger';
-export { CLIService, StringService, CurrentEnv, ChromeService, DockerService, FileSystemService, sleep, OperatingSystemType, ShellType, Logger, TerminalType, datesAreOnSameDay, getFileNameExtension, ITermService };
+export { CLIService, StringService, CurrentEnv, ChromeService, DockerService, FileSystemService, sleep, OperatingSystemType, ShellType, Logger, TerminalType, datesAreOnSameDay, getFileNameExtension, ITermService, ConfigService };
 //# 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,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,mCAAmC,CAAC;AACrE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAC1E,OAAO,YAAY,MAAM,sCAAsC,CAAC;AAChE,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAGpC,OAAO,EACL,UAAU,EACV,aAAa,EACb,UAAU,EACV,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACb,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,mCAAmC,CAAC;AACrE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAC1E,OAAO,YAAY,MAAM,sCAAsC,CAAC;AAChE,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,wCAAwC,CAAC;AACnE,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAGpC,OAAO,EACL,UAAU,EACV,aAAa,EACb,UAAU,EACV,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACd,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.ITermService = exports.getFileNameExtension = exports.datesAreOnSameDay = exports.TerminalType = exports.Logger = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.FileSystemService = exports.DockerService = exports.ChromeService = exports.CurrentEnv = exports.StringService = exports.CLIService = void 0;
+exports.ConfigService = exports.ITermService = exports.getFileNameExtension = exports.datesAreOnSameDay = exports.TerminalType = exports.Logger = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.FileSystemService = exports.DockerService = exports.ChromeService = exports.CurrentEnv = exports.StringService = exports.CLIService = void 0;
 const dateFunctions_1 = __importDefault(require("./helperFunctions/dateFunctions"));
 exports.datesAreOnSameDay = dateFunctions_1.default;
 const sleep_1 = __importDefault(require("./helperFunctions/sleep"));
@@ -43,6 +43,8 @@ const ITermService_1 = __importDefault(require("./services/applications/ITermSer
 exports.ITermService = ITermService_1.default;
 const CLIService_1 = __importDefault(require("./services/CLIService"));
 exports.CLIService = CLIService_1.default;
+const ConfigService_1 = __importDefault(require("./services/ConfigService/ConfigService"));
+exports.ConfigService = ConfigService_1.default;
 const StringService_1 = __importDefault(require("./services/StringService"));
 exports.StringService = StringService_1.default;
 const CurrentEnv_1 = __importStar(require("./utils/CurrentEnv"));

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

@@ -0,0 +1,25 @@
+import 'dotenv/config';
+export type ConfigEnv = 'local' | 'dev' | 'prod';
+/**
+ * A class which can be used to load configuration into the local environment
+ * from a pre-defined location.
+ */
+export default class ConfigService {
+    private static gitHub;
+    static useConfig(env: string): 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.
+     */
+    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

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

package/lib/services/ConfigService/ConfigService.js

@@ -0,0 +1,72 @@
+"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 Logger_1 = __importDefault(require("../../utils/Logger"));
+/**
+ * A class which can be used to load configuration into the local environment
+ * from a pre-defined location.
+ */
+class ConfigService {
+    static gitHub = null;
+    static async useConfig(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 config = JSON.parse(strippedJson);
+            ConfigService.insertPropertiesIntoEnv(config);
+        }
+        catch (error) {
+            Logger_1.default.error(`Failed to load ${env}.json, 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
+        });
+    }
+    /**
+     * Inserts the provided configuration into the local environment.
+     */
+    static insertPropertiesIntoEnv(config) {
+        Object.entries(config).forEach(([key, value]) => {
+            if (typeof value === 'object') {
+                ConfigService.insertPropertiesIntoEnv(value);
+            }
+            else {
+                process.env[key] = value;
+            }
+        });
+    }
+    /**
+     * 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/DOFunctionService.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Output from a Digital Ocean function must always be an object.
+ */
+export type DOFunctionOutput<TOutput extends object> = {
+    /**
+     * The body is an object, which means it will automatically be serialized to
+     * JSON and the Content-Type header will be set to application/json.
+     */
+    body: TOutput;
+};
+/**
+ * A service to provide some utility common to multiple Digital Ocean functions.
+ */
+export default class DOFunctionService {
+}
+//# sourceMappingURL=DOFunctionService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"","sources":["../../src/services/DOFunctionService.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,MAAM,IAAI;IACrD;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;CAAG"}

package/lib/services/DOFunctionService.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A service to provide some utility common to multiple Digital Ocean functions.
+ */
+class DOFunctionService {
+}
+exports.default = DOFunctionService;

package/lib/utils/TestUtils.d.ts

@@ -0,0 +1,14 @@
+export default class TestUtils {
+    private static consoleLoggers;
+    /**
+     * Suppresses the console output of all console loggers (error, log, info, etc.).
+     * Use `restoreConsole` when the test is finished to restore the console.
+     */
+    static suppressConsole(): void;
+    /**
+     * Restores the normal console output functionality of all console loggers
+     * (error, log, info, etc.).
+     */
+    static restoreConsole(): void;
+}
+//# sourceMappingURL=TestUtils.d.ts.map

package/lib/utils/TestUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestUtils.d.ts","sourceRoot":"","sources":["../../src/utils/TestUtils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,MAAM,CAAC,cAAc,CAK3B;IAEF;;;OAGG;WACW,eAAe;IAO7B;;;OAGG;WACW,cAAc;CAM7B"}

package/lib/utils/TestUtils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TestUtils {
+    static consoleLoggers = {
+        error: console.error,
+        log: console.log,
+        info: console.info,
+        warn: console.warn
+    };
+    /**
+     * Suppresses the console output of all console loggers (error, log, info, etc.).
+     * Use `restoreConsole` when the test is finished to restore the console.
+     */
+    static suppressConsole() {
+        console.error = jest.fn();
+        console.log = jest.fn();
+        console.info = jest.fn();
+        console.warn = jest.fn();
+    }
+    /**
+     * Restores the normal console output functionality of all console loggers
+     * (error, log, info, etc.).
+     */
+    static restoreConsole() {
+        console.error = TestUtils.consoleLoggers.error;
+        console.log = TestUtils.consoleLoggers.log;
+        console.info = TestUtils.consoleLoggers.info;
+        console.warn = TestUtils.consoleLoggers.warn;
+    }
+}
+exports.default = TestUtils;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-lib",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "A core library for all of my TypeScript projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -8,7 +8,8 @@
     "pushpub": "npm run build && npm version patch && git push && npm publish --access public",
     "build": "tsc",
     "watch": "tsc -w",
-    "upgrade:all": "yarn upgrade --latest"
+    "upgrade:all": "yarn upgrade --latest",
+    "test": "jest"
   },
   "type": "commonjs",
   "repository": {
@@ -28,8 +29,12 @@
   "files": [
     "lib/**/*"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "dotenv": "^16.3.1",
+    "octokit": "^3.1.2"
+  },
   "devDependencies": {
+    "@types/jest": "^29.5.8",
     "@types/node": "^18.15.0",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
@@ -38,7 +43,9 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^29.7.0",
     "prettier": "^2.4.1",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.2.1",
     "typescript": "^4.4.3"
   }