@aneuhold/be-ts-lib 1.0.4 → 1.0.5

package/lib/index.d.ts

@@ -7,7 +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';
-import TranslationService, { TranslationProject } from './services/TranslationService/TranslationService';
-export { CLIService, CurrentEnv, ChromeService, DockerService, OSFileSystemService, sleep, OperatingSystemType, ShellType, TerminalType, ITermService, ConfigService, TranslationService };
-export type { Config, TranslationProject };
+import TranslationService, { TranslationSource } from './services/TranslationService/TranslationService';
+export { CLIService, CurrentEnv, ChromeService, DockerService, OSFileSystemService, sleep, OperatingSystemType, ShellType, TerminalType, ITermService, 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,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"}
+{"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"}

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.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;
+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"));
@@ -46,5 +46,6 @@ 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"));
+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; } });

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

@@ -1,9 +1,8 @@
 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];
+export declare enum TranslationSource {
+    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
@@ -11,8 +10,8 @@ export type TranslationProject = (typeof TranslationProject)[keyof typeof Transl
  */
 export default class TranslationService {
     /**
-     * Gets translations for the provided project.
+     * Gets translations for the provided source.
      */
-    static getTranslations(project: TranslationProject): Promise<Translations>;
+    static getTranslations(source: TranslationSource): Promise<Translations>;
 }
 //# sourceMappingURL=TranslationService.d.ts.map

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;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"}
+{"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,oBAAY,iBAAiB;IAC3B,SAAS,cAAc;CACxB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC;;OAEG;WACU,eAAe,CAAC,MAAM,EAAE,iBAAiB;CAavD"}

package/lib/services/TranslationService/TranslationService.js

@@ -3,13 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslationProject = void 0;
+exports.TranslationSource = 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'
-};
+var TranslationSource;
+(function (TranslationSource) {
+    TranslationSource["dashboard"] = "dashboard";
+})(TranslationSource || (exports.TranslationSource = TranslationSource = {}));
 /**
  * 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
@@ -17,16 +18,16 @@ exports.TranslationProject = {
  */
 class TranslationService {
     /**
-     * Gets translations for the provided project.
+     * Gets translations for the provided source.
      */
-    static async getTranslations(project) {
+    static async getTranslations(source) {
         try {
-            const jsonString = await GitHubService_1.default.getContentFromRepo('translations', `${project}.jsonc`);
+            const jsonString = await GitHubService_1.default.getContentFromRepo('translations', `${source}.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}`);
+            core_ts_lib_1.Logger.error(`Failed to load ${source}.json, error: ${error}`);
             throw error;
         }
     }

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

@@ -32,7 +32,7 @@ describe('TranslationService', () => {
          * set.
          */
         it('should load translations from GitHub', async () => {
-            const translations = await TranslationService_1.default.getTranslations(TranslationService_1.TranslationProject.dashboard);
+            const translations = await TranslationService_1.default.getTranslations(TranslationService_1.TranslationSource.dashboard);
             expect(translations['test-translation'].value).toEqual('something');
         });
     });

package/package.json

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