Rename languages key and fix tests

README.md

@@ -26,7 +26,7 @@ yarn add @qntm-code/nest-translate
 
 ## Usage
 
-Import the `TranslateModule` into your root module. The `TranslateModule` requires a configuration object with the default language and a list of languages with their translations.
+Import the `TranslateModule` into your root module. The `TranslateModule` requires a configuration object with the default language and a list of namespaces with the translations for each language.
 
 ```typescript
 import { Module } from '@nestjs/common';
@@ -36,7 +36,7 @@ import { TranslateModule } from '@qntm-code/nest-translate';
   imports: [
     TranslateModule.forRoot({
       defaultLanguage: 'en',
-      languages: [
+      translations: [
         {
           language: 'en',
           namespace: 'greetings',
@@ -80,7 +80,7 @@ import deGreetings from './greetings.de.json';
   imports: [
     TranslateModule.forRoot({
       defaultLanguage: 'en',
-      languages: [
+      translations: [
         {
           language: 'en',
           namespace: 'greetings',

src/index.ts

@@ -1,5 +1,5 @@
-export * from './language-config.model';
 export * from './tokens';
 export * from './translate-module-config.model';
 export * from './translate.module';
 export * from './translate.service';
+export * from './translation-config.model';

src/translate-module-config.model.ts

@@ -1,8 +1,8 @@
-import { LanguageConfig } from './language-config.model';
+import { TranslationConfig } from './translation-config.model';
 
 export interface TranslateModuleConfig {
   defaultLanguage: string;
-  languages: LanguageConfig[];
+  translations: TranslationConfig[];
   enableMissingTranslationLogging?: boolean;
   missingTranslationHandler?: (language: string, key: string) => void;
 }

src/translate.service.spec.ts

@@ -2,23 +2,26 @@ import { TranslateService } from './translate.service';
 
 describe(`TranslateService`, () => {
   it(`Should return a translated string`, () => {
-    const translateService = new TranslateService('en', [
-      {
-        language: 'en',
-        namespace: 'test',
-        values: {
-          hello: 'Hello',
+    const translateService = new TranslateService({
+      defaultLanguage: 'en',
+      translations: [
+        {
+          language: 'en',
+          namespace: 'test',
+          values: {
+            hello: 'Hello',
+          },
         },
-      },
-    ]);
+      ],
+    });
 
     expect(translateService.translate('en', 'test.hello')).toBe('Hello');
   });
 
   it(`Should log an error if a translated string cannot be found`, () => {
-    const translateService = new TranslateService(
-      'en',
-      [
+    const translateService = new TranslateService({
+      defaultLanguage: 'en',
+      translations: [
         {
           language: 'en',
           namespace: 'test',
@@ -27,8 +30,8 @@ describe(`TranslateService`, () => {
           },
         },
       ],
-      true
-    );
+      enableMissingTranslationLogging: true,
+    });
 
     const consoleError = console.error;
 
@@ -44,9 +47,9 @@ describe(`TranslateService`, () => {
   it(`Should utilise a custom missing translation handler`, () => {
     let handlerCalled = false;
 
-    const translateService = new TranslateService(
-      'en',
-      [
+    const translateService = new TranslateService({
+      defaultLanguage: 'en',
+      translations: [
         {
           language: 'en',
           namespace: 'test',
@@ -55,11 +58,10 @@ describe(`TranslateService`, () => {
           },
         },
       ],
-      false,
-      () => {
+      missingTranslationHandler: () => {
         handlerCalled = true;
-      }
-    );
+      },
+    });
 
     expect(handlerCalled).toBe(false);
 
@@ -69,9 +71,9 @@ describe(`TranslateService`, () => {
   });
 
   it(`Should attempt to find a translation in the default language if the translation is not found in the requested language`, () => {
-    const translateService = new TranslateService(
-      'en',
-      [
+    const translateService = new TranslateService({
+      defaultLanguage: 'en',
+      translations: [
         {
           language: 'en',
           namespace: 'test',
@@ -85,8 +87,7 @@ describe(`TranslateService`, () => {
           values: {},
         },
       ],
-      false
-    );
+    });
 
     expect(translateService.translate('fr', 'test.hello')).toBe('Hello');
   });

src/translate.service.ts

@@ -16,7 +16,7 @@ export class TranslateService {
       missingTranslationHandler: translateModuleConfig.missingTranslationHandler,
     });
 
-    translateModuleConfig.languages.forEach(({ language, namespace, values }) =>
+    translateModuleConfig.translations.forEach(({ language, namespace, values: values }) =>
       this.store.addLanguageNamespace(language, namespace, values)
     );
   }

src/language-config.model.ts → src/translation-config.model.ts

@@ -1,6 +1,6 @@
 import { TranslationLanguage } from '@qntm-code/translation-key-store';
 
-export interface LanguageConfig {
+export interface TranslationConfig {
   language: string;
   namespace: string;
   values: TranslationLanguage;