Add translations

.gitignore

@@ -29,3 +29,6 @@ package-lock.json
 # Yarn
 .yarnclean
 yarn-error.log
+
+# Exclude translation files
+src/lib/locales/*.json

README.md

@@ -143,6 +143,16 @@ const parsedError = parseErrors(error);
 serializer.serialize([parsedError]);
 ```
 
+## Import translations
+
+Import new or updated translations from the iCapps translation portal
+
+```javascript
+  import { importTranslations } from 'tree-house-errors';
+
+  await importTranslations('applicationToken');
+```
+
 ## Tests
 
 - You can run `yarn test` to run all tests

package.json

@@ -21,14 +21,17 @@
   "dependencies": {
     "express-validation": "~1.0.2",
     "http-status": "~1.0.1",
+    "i18n": "0.8.3",
     "joi": "~13.1.2",
     "uuid": "~3.2.1"
   },
   "devDependencies": {
     "@types/http-status": "~0.2.30",
+    "@types/i18n": "0.8.3",
     "@types/jest": "~22.2.0",
     "@types/uuid": "~3.4.3",
     "coveralls": "^3.0.0",
+    "icapps-translations": "^0.0.15",
     "jest": "^22.1.4",
     "np": "^2.20.1",
     "pre-commit": "^1.2.2",

src/index.ts

@@ -1,3 +1,4 @@
 export { parseErrors } from './lib/errorParser';
 export { errorConfig as errors } from './lib/errorConfig';
+export { importTranslations, Options } from './lib/importTranslations';
 export * from './lib/errors';

src/lib/errorParser.ts

@@ -2,8 +2,9 @@ import * as ev from 'express-validation';
 import { ApiError, ValidationError } from './errors';
 import { errorConfig as errors } from './errorConfig';
 import { errorDefaults } from './constants';
+import i18n from './i18nConfig';
 
-export function parseErrors(error: any) {
+export function parseErrors(error: any, language: string) {
   const metaData: any = {};
   let parsedError = new ApiError(errorDefaults.DEFAULT_HTTP_CODE, errorDefaults.DEFAULT_ERROR); // Default error
 
@@ -25,7 +26,10 @@ export function parseErrors(error: any) {
 
   // Own thrown ApiErrors
   if (error instanceof ApiError) {
-    parsedError = error;
+    i18n.setLocale(language);
+    const correctMessage = i18n.__(error.code);
+
+    parsedError = Object.assign({}, error, { message: correctMessage });
   }
 
   // Return object easy to use for serialisation

src/lib/i18nConfig.ts

@@ -0,0 +1,7 @@
+import * as i18n from 'i18n';
+
+i18n.configure({
+  directory: __dirname + '/locales',
+});
+
+export default i18n;

src/lib/importTranslations.ts

@@ -0,0 +1,23 @@
+const translations = require('icapps-translations');
+
+const url = '';
+const defaultOptions = {
+  destination: './lib/locales',
+};
+
+export function importTranslations(token: string, options?: Options) {
+  try {
+    const allOptions = Object.assign({}, defaultOptions, options);
+    return translations.import(url, token, allOptions);
+  } catch (ex) {
+    throw ex;
+  }
+}
+
+export interface Options {
+  destination?: string;
+  clean?: boolean;
+  verbose?: boolean;
+  seperateCategories?: boolean;
+  exportType?: string;
+}

tests/errorParser.test.ts

@@ -8,7 +8,7 @@ describe('errorParser', () => {
 
   describe('Unkown errors', () => {
     it('Should return the default error when unknown object is passed', () => {
-      const parsedError = parseErrors({ myProp: 'iDunno' });
+      const parsedError = parseErrors({ myProp: 'iDunno' }, 'en');
       expect(parsedError).toMatchObject({
         id: expect.any(String),
         status: defaultError.status,
@@ -27,7 +27,7 @@ describe('errorParser', () => {
     const error = new Error('Some error...');
     Object.assign(error, { stack: 'myStack', detail: 'some details', schema: 'public' });
 
-    const parsedError = parseErrors(error);
+    const parsedError = parseErrors(error, 'en');
     expect(parsedError).toMatchObject({
       id: expect.any(String),
       status: defaultError.status,
@@ -51,7 +51,7 @@ describe('errorParser', () => {
     };
 
     const expressValidationError = new ValidationError([{ name: 'myField' }], options);
-    const parsedError = parseErrors(expressValidationError);
+    const parsedError = parseErrors(expressValidationError, 'en');
     expect(parsedError).toMatchObject({
       id: expect.any(String),
       status: httpStatus.BAD_REQUEST,
@@ -66,7 +66,7 @@ describe('errorParser', () => {
       try {
         throw new ApiError(httpStatus.BAD_REQUEST, errors.INVALID_INPUT);
       } catch (err) {
-        const parsedError = parseErrors(err);
+        const parsedError = parseErrors(err, 'en');
         expect(parsedError).toMatchObject({
           id: expect.any(String),
           status: httpStatus.BAD_REQUEST,

tests/translations.test.ts

@@ -0,0 +1,9 @@
+import * as fs from 'fs';
+import { importTranslations, Options } from '../src';
+
+describe('importTranslations', () => {
+  it('should import the translations', async () => {
+    await importTranslations('randomToken');
+    expect(await fs.existsSync('./src/lib/locales/en.json')).toEqual(true);
+  });
+});

tsconfig.json

@@ -27,6 +27,6 @@
   "exclude": [
     "node_modules",
     "**/*.test.ts",
-    "build"
+    "build",
   ]
 }