@sofit/view-locale 0.1.7 → 0.2.0

package/.circleci/config.yml

@@ -22,13 +22,17 @@ jobs:
             # fallback to using the latest cache if no exact match is found
             - v1-dependencies-
 
-      - run: npm install --production
+      - run: npm install
 
       - save_cache:
           paths:
             - node_modules
           key: v1-dependencies-{{ checksum "package.json" }}
 
+      - run:
+          name: Build from typescript to javascript
+          command: npm run build
+
       - run:
           name: Run code quality
           command: npm run lint
@@ -37,6 +41,13 @@ jobs:
           name: Run tests
           command: npm test
 
+      - store_artifacts:
+          path: ~/repo/coverage/lcov-report
+          destination: tests
+
+      - store_test_results:
+          path: ~/repo/coverage
+
       - persist_to_workspace:
           root: ~/repo
           paths: .

package/coverage/jest/results.xml

@@ -0,0 +1,12 @@
+<testsuites name="Sofit view locale tests" tests="4" failures="0" time="3.04">
+  <testsuite name="Vehicle locale test" errors="0" failures="0" skipped="0" timestamp="2018-07-20T13:20:30" time="2.202" tests="4">
+    <testcase classname="Vehicle locale test Should get translations with reach" name="Vehicle locale test Should get translations with reach" time="0.006">
+    </testcase>
+    <testcase classname="Vehicle locale test Should replace correctly with reach" name="Vehicle locale test Should replace correctly with reach" time="0">
+    </testcase>
+    <testcase classname="Vehicle locale test Should get translations with raw" name="Vehicle locale test Should get translations with raw" time="0.001">
+    </testcase>
+    <testcase classname="Vehicle locale test Should replace correctly with raw" name="Vehicle locale test Should replace correctly with raw" time="0">
+    </testcase>
+  </testsuite>
+</testsuites>

package/dist/index.d.ts

@@ -1 +1,3 @@
-export { locale, Locale } from './runner';
+import * as i18n from './translations';
+export { Locale } from './runner';
+export { i18n };

package/dist/index.js

@@ -1,5 +1,13 @@
 "use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const i18n = __importStar(require("./translations"));
+exports.i18n = i18n;
 var runner_1 = require("./runner");
-exports.locale = runner_1.locale;
 exports.Locale = runner_1.Locale;

package/dist/joi/joi.interface.d.ts

@@ -0,0 +1,12 @@
+export interface IContext {
+    key?: string;
+    label?: string;
+    limit?: number;
+    value?: string;
+}
+export interface IValidationErrorItem {
+    message: string;
+    type: string;
+    path: string[];
+    context?: IContext;
+}

package/dist/joi/joi.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/runner.d.ts

@@ -1,3 +1,4 @@
+import { IValidationErrorItem } from './joi/joi.interface';
 import { IAccessKey, LANGUAGES } from './languages';
 export interface IReplaces {
     [key: string]: string;
@@ -6,6 +7,6 @@ export declare class Locale {
     private readonly language;
     constructor(language: LANGUAGES);
     reach(accessKey: IAccessKey, replaces?: IReplaces): string;
-    raw(context: any, path: string, replaces?: IReplaces): string;
+    raw(path: string, replaces?: IReplaces): string;
+    joi(detail: IValidationErrorItem): string;
 }
-export declare function locale(language: LANGUAGES): Locale;

package/dist/runner.js

@@ -1,5 +1,13 @@
 "use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const TRANSLATIONS = __importStar(require("./translations"));
 class Locale {
     constructor(language) {
         this.language = language;
@@ -19,9 +27,10 @@ class Locale {
         }
         return 'Translation not found';
     }
-    raw(context, path, replaces) {
+    raw(path, replaces) {
         const paths = path.split('.');
-        let target = context;
+        let target = TRANSLATIONS[paths[0]];
+        paths.shift();
         for (const element of paths) {
             target = target[element];
             if (!target) {
@@ -33,16 +42,15 @@ class Locale {
         }
         return 'Translation not found';
     }
-}
-exports.Locale = Locale;
-const cache = {
-    ptBR: null,
-    es: null
-};
-function locale(language) {
-    if (cache[language] === null) {
-        cache[language] = new Locale(language);
+    joi(detail) {
+        const accessKey = TRANSLATIONS.joi[detail.type];
+        if (accessKey) {
+            if (detail.context) {
+                detail.context.label = this.raw(detail.context.label);
+            }
+            return this.reach(TRANSLATIONS.joi[detail.type], detail.context);
+        }
+        return `There is no translation for joi type '${detail.type}'`;
     }
-    return cache[language];
 }
-exports.locale = locale;
+exports.Locale = Locale;

package/dist/translations/common/buttons.d.ts

@@ -1,6 +1,2 @@
-export declare const button: {
-    maria: {
-        ptBR: string;
-        es: string;
-    };
-};
+import { ITranslation } from '../translation.interface';
+export declare const button: ITranslation;

package/dist/translations/common/database-errors.d.ts

@@ -0,0 +1,2 @@
+import { ITranslation } from '../translation.interface';
+export declare const databaseErrors: ITranslation;

package/dist/translations/common/database-errors.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.databaseErrors = {
+    generic: {
+        ptBR: 'Ocorreu um erro ao processar a requisição.',
+        es: 'Se produjo un error al procesar la solicitud.'
+    },
+    unique_constraint: {
+        ptBR: 'Já existe um {{label}} com valor "{{value}}".',
+        es: 'Ya existe un {{label}} con valor "{{value}}".'
+    }
+};

package/dist/translations/common/joi.d.ts

@@ -0,0 +1,2 @@
+import { ITranslation } from '../translation.interface';
+export declare const joi: ITranslation;

package/dist/translations/common/joi.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joi = {
+    'string.base': {
+        ptBR: 'Campo "{{label}}" deve ser um texto.',
+        es: 'Campo "{{label}}" debe se uno texto.'
+    },
+    'number.base': {
+        ptBR: 'Campo "{{label}}" precisa se um numero.',
+        es: ''
+    },
+    'number.min': {
+        ptBR: 'Campo "{{label}}" precisa ter no minimo {{limit}}',
+        es: ''
+    }
+};

package/dist/translations/index.d.ts

@@ -1,2 +1,4 @@
-export * from './modules/vehicle';
-export * from './common/buttons';
+export { gate } from './modules/gate/gate';
+export { button } from './common/buttons';
+export { joi } from './common/joi';
+export { databaseErrors } from './common/database-errors';

package/dist/translations/index.js

@@ -1,7 +1,10 @@
 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./modules/vehicle"));
-__export(require("./common/buttons"));
+var gate_1 = require("./modules/gate/gate");
+exports.gate = gate_1.gate;
+var buttons_1 = require("./common/buttons");
+exports.button = buttons_1.button;
+var joi_1 = require("./common/joi");
+exports.joi = joi_1.joi;
+var database_errors_1 = require("./common/database-errors");
+exports.databaseErrors = database_errors_1.databaseErrors;

package/dist/translations/modules/gate/gate.d.ts

@@ -0,0 +1,2 @@
+import { ITranslation } from '../../translation.interface';
+export declare const gate: ITranslation;

package/dist/translations/modules/gate/gate.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gate = {
+    name: {
+        ptBR: 'Nome',
+        es: 'Nombre'
+    }
+};

package/dist/translations/translation.interface.d.ts

@@ -0,0 +1,4 @@
+import { IAccessKey } from '../languages';
+export interface ITranslation {
+    [key: string]: IAccessKey;
+}

package/dist/translations/translation.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.json

@@ -5,6 +5,16 @@
 	"transform": {
 		"^.+\\.ts$": "ts-jest"
 	},
+	"reporters": [
+		"default",
+		[
+			"jest-junit",
+			{
+				"suiteName": "Sofit view locale tests",
+				"output":"./coverage/jest/results.xml"
+			}
+		]
+	],
 	"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
 	"moduleFileExtensions": [
 		"ts",

package/lib/index.ts

@@ -1 +1,4 @@
-export { locale, Locale } from './runner';
+import * as i18n from './translations';
+
+export { Locale } from './runner';
+export { i18n };

package/lib/joi/joi.interface.ts

@@ -0,0 +1,13 @@
+export interface IContext {
+	key?: string;
+	label?: string;
+	limit?: number;
+	value?: string;
+}
+
+export interface IValidationErrorItem {
+	message: string;
+	type: string;
+	path: string[];
+	context?: IContext;
+}

package/lib/runner.ts

@@ -1,4 +1,6 @@
-import { IAccessKey, ICreator, LANGUAGES } from './languages';
+import { IValidationErrorItem } from './joi/joi.interface';
+import { IAccessKey, LANGUAGES } from './languages';
+import * as TRANSLATIONS from './translations';
 
 export interface IReplaces {
 	[key: string]: string;
@@ -30,21 +32,20 @@ export class Locale {
 			}
 
 			return text;
-
 		}
 
 		return 'Translation not found';
 	}
 
-	// tslint:disable-next-line:no-any
-	public raw(context: any, path: string, replaces?: IReplaces): string {
+	public raw(path: string, replaces?: IReplaces): string {
 
 		const paths = path.split('.');
-		let target = context;
+		let target = TRANSLATIONS[paths[0]];
+
+		paths.shift();
 
 		for (const element of paths) {
 
-			// tslint:disable-next-line
 			target = target[element];
 
 			if (!target) {
@@ -55,25 +56,26 @@ export class Locale {
 
 		if (target) {
 
-			// tslint:disable-next-line
 			return this.reach(target, replaces);
 		}
 
 		return 'Translation not found';
 	}
-}
 
-const cache: ICreator = {
-	ptBR: null,
-	es: null
-};
+	public joi(detail: IValidationErrorItem) {
 
-export function locale(language: LANGUAGES): Locale {
+		const accessKey = TRANSLATIONS.joi[detail.type];
 
-	if (cache[language] === null) {
+		if (accessKey) {
 
-		cache[language] = new Locale(language);
-	}
+			if (detail.context) {
 
-	return cache[language] as Locale;
+				detail.context.label = this.raw(detail.context.label as string);
+			}
+
+			return this.reach(TRANSLATIONS.joi[detail.type], detail.context as IReplaces);
+		}
+
+		return `There is no translation for joi type '${detail.type}'`;
+	}
 }

package/lib/tests/basic.spec.ts

@@ -0,0 +1,49 @@
+import { i18n, Locale } from '../index';
+
+describe('Vehicle locale test', () => {
+
+	const localeptBR = new Locale('ptBR');
+	const localeptES = new Locale('es');
+
+	it('Should get translations with reach', () => {
+
+		expect(localeptBR.reach(i18n.gate.name))
+			.toEqual(i18n.gate.name.ptBR);
+		expect(localeptES.reach(i18n.gate.name))
+			.toEqual(i18n.gate.name.es);
+	});
+
+	it('Should replace correctly with reach', () => {
+
+		expect(localeptBR.reach(i18n.databaseErrors.unique_constraint, {
+			label: 'label',
+			value: 'value'
+		})).toEqual('Já existe um label com valor "value".');
+
+		expect(localeptES.reach(i18n.databaseErrors.unique_constraint, {
+			label: 'label2',
+			value: 'value2'
+		})).toEqual('Ya existe un label2 con valor "value2".');
+	});
+
+	it('Should get translations with raw', () => {
+
+		expect(localeptBR.raw('databaseErrors.generic'))
+			.toEqual(i18n.databaseErrors.generic.ptBR);
+		expect(localeptES.raw('databaseErrors.generic'))
+			.toEqual(i18n.databaseErrors.generic.es);
+	});
+
+	it('Should replace correctly with raw', () => {
+
+		expect(localeptBR.raw('databaseErrors.unique_constraint', {
+			label: 'label',
+			value: 'value'
+		})).toEqual('Já existe um label com valor "value".');
+
+		expect(localeptES.raw('databaseErrors.unique_constraint', {
+			label: 'label2',
+			value: 'value2'
+		})).toEqual('Ya existe un label2 con valor "value2".');
+	});
+});

package/lib/translations/common/buttons.ts

@@ -1,4 +1,6 @@
-export const button = {
+import { ITranslation } from '../translation.interface';
+
+export const button: ITranslation = {
 	maria: {
 		ptBR: 'maira',
 		es: 'pedro'

package/lib/translations/common/database-errors.ts

@@ -0,0 +1,12 @@
+import { ITranslation } from '../translation.interface';
+
+export const databaseErrors: ITranslation = {
+	generic: {
+		ptBR: 'Ocorreu um erro ao processar a requisição.',
+		es: 'Se produjo un error al procesar la solicitud.'
+	},
+	unique_constraint: {
+		ptBR: 'Já existe um {{label}} com valor "{{value}}".',
+		es: 'Ya existe un {{label}} con valor "{{value}}".'
+	}
+};

package/lib/translations/common/joi.ts

@@ -0,0 +1,16 @@
+import { ITranslation } from '../translation.interface';
+
+export const joi: ITranslation = {
+	'string.base': {
+		ptBR: 'Campo "{{label}}" deve ser um texto.',
+		es: 'Campo "{{label}}" debe se uno texto.'
+	},
+	'number.base': {
+		ptBR: 'Campo "{{label}}" precisa se um numero.',
+		es: ''
+	},
+	'number.min': {
+		ptBR: 'Campo "{{label}}" precisa ter no minimo {{limit}}',
+		es: ''
+	}
+};

package/lib/translations/index.ts

@@ -1,2 +1,4 @@
-export * from './modules/vehicle';
-export * from './common/buttons';
+export { gate } from './modules/gate/gate';
+export { button } from './common/buttons';
+export { joi } from './common/joi';
+export { databaseErrors } from './common/database-errors';

package/lib/translations/modules/gate/gate.ts

@@ -0,0 +1,8 @@
+import { ITranslation } from '../../translation.interface';
+
+export const gate: ITranslation = {
+	name: {
+		ptBR: 'Nome',
+		es: 'Nombre'
+	}
+};

package/lib/translations/translation.interface.ts

@@ -0,0 +1,5 @@
+import { IAccessKey } from '../languages';
+
+export interface ITranslation {
+	[key: string]: IAccessKey;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sofit/view-locale",
-	"version": "0.1.7",
+	"version": "0.2.0",
 	"description": "Traduções do Sofit View",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -8,7 +8,8 @@
 		"test": "jest --config ./jest.config.json",
 		"dev": "nodemon",
 		"lint": "tslint --project ./",
-		"build": "tsc --p ./"
+		"build": "tsc --p ./",
+		"postinstall": "node .vscode/commit-msg.js"
 	},
 	"author": "desenvolvimento@sofit4.com.br",
 	"contributors": [
@@ -21,14 +22,16 @@
 	},
 	"dependencies": {
 		"typescript": "^2.8.3",
-		"@types/node": "^9.6.6",
+		"@types/node": "^9.6.6"
+	},
+	"devDependencies": {
+		"@sofit/tslint-rules": "0.1.11",
 		"@types/jest": "^22.2.3",
+		"jest-junit": "^5.1.0",
 		"jest": "^22.4.3",
 		"ts-jest": "^22.4.4",
 		"tslint": "^5.9.1",
-		"tslint-eslint-rules": "^5.1.0"
-	},
-	"devDependencies": {
+		"tslint-eslint-rules": "^5.1.0",
 		"nodemon": "^1.17.3",
 		"ts-node": "^6.0.0"
 	}

package/dist/translations/modules/vehicle.d.ts

@@ -1,18 +0,0 @@
-export declare const vehicle: {
-    label: {
-        name: {
-            ptBR: string;
-            es: string;
-        };
-    };
-    messages: {
-        not_found: {
-            ptBR: string;
-            es: string;
-        };
-        test: {
-            ptBR: string;
-            es: string;
-        };
-    };
-};

package/dist/translations/modules/vehicle.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.vehicle = {
-    label: {
-        name: {
-            ptBR: 'Nome',
-            es: 'Nuombre'
-        }
-    },
-    messages: {
-        not_found: {
-            ptBR: 'Não encontrado',
-            es: 'nao coisado'
-        },
-        test: {
-            ptBR: 'Teste de coisa pra {{variable}}',
-            es: 'Carai {{variable}}'
-        }
-    }
-};

package/lib/tests/vehicle.spec.ts

@@ -1,43 +0,0 @@
-import { locale } from '../index';
-import * as translations from '../translations';
-
-describe('Vehicle locale test', () => {
-
-	it('Should get translations with reach', () => {
-
-		expect(locale('ptBR').reach(translations.vehicle.messages.not_found))
-			.toEqual(translations.vehicle.messages.not_found.ptBR);
-		expect(locale('es').reach(translations.vehicle.messages.not_found))
-			.toEqual(translations.vehicle.messages.not_found.es);
-	});
-
-	it('Should replace correctly with reach', () => {
-
-		expect(locale('ptBR').reach(translations.vehicle.messages.test, {
-			variable: 'varai'
-		})).toEqual('Teste de coisa pra varai');
-
-		expect(locale('es').reach(translations.vehicle.messages.test, {
-			variable: 'varai'
-		})).toEqual('Carai varai');
-	});
-
-	it('Should get translations with raw', () => {
-
-		expect(locale('ptBR').raw(translations.vehicle, 'messages.not_found'))
-			.toEqual(translations.vehicle.messages.not_found.ptBR);
-		expect(locale('es').raw(translations.vehicle, 'messages.not_found'))
-			.toEqual(translations.vehicle.messages.not_found.es);
-	});
-
-	it('Should replace correctly with raw', () => {
-
-		expect(locale('ptBR').raw(translations.vehicle, 'messages.test', {
-			variable: 'varai'
-		})).toEqual('Teste de coisa pra varai');
-
-		expect(locale('es').raw(translations.vehicle, 'messages.test', {
-			variable: 'varai'
-		})).toEqual('Carai varai');
-	});
-});

package/lib/translations/modules/vehicle.ts

@@ -1,20 +0,0 @@
-
-export const vehicle = {
-	label: {
-		name: {
-			ptBR: 'Nome',
-			es: 'Nuombre'
-		}
-	},
-	messages: {
-		/** Não encontrado */
-		not_found: {
-			ptBR: 'Não encontrado',
-			es: 'nao coisado'
-		},
-		test: {
-			ptBR: 'Teste de coisa pra {{variable}}',
-			es: 'Carai {{variable}}'
-		}
-	}
-};