@hyper.software/visitor-common-translations 1.1.535

package/README.md

@@ -0,0 +1,15 @@
+#### Common translations
+
+#### Common tasks
+
+```
+# Publish
+yarn translations-fix
+yarn deploy // used in dev when you add a new translation
+yarn publish-package // will publish to npm
+
+# Development
+yarn lint
+yarn test
+yarn build
+```

package/lib/TranslationsProvider.d.ts

@@ -0,0 +1,9 @@
+export declare class TranslationsProvider {
+    static getTranslation: (language: string, key: string, values?: any) => string;
+    static getCurrentInstance: () => TranslationsProvider;
+    static initialize: (translations?: any) => void;
+    private static getMessageFormat;
+    private static currentInstance;
+    private translations;
+    constructor(translations?: any);
+}

package/lib/TranslationsProvider.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var intl_messageformat_1 = require("intl-messageformat");
+var intl_format_cache_1 = require("intl-format-cache");
+var constants_1 = require("./constants");
+var TranslationsProvider = /** @class */ (function () {
+    function TranslationsProvider(translations) {
+        if (translations === void 0) { translations = {}; }
+        this.translations = null;
+        this.translations = translations;
+    }
+    TranslationsProvider.getTranslation = function (language, key, values) {
+        if (language === void 0) { language = constants_1.LANGUAGE.DE_DE; }
+        if (values === void 0) { values = {}; }
+        if (!TranslationsProvider.getCurrentInstance()) {
+            return null;
+        }
+        var translations = TranslationsProvider.getCurrentInstance().translations;
+        if (!language || !translations[language.toLowerCase()]) {
+            language = constants_1.LANGUAGE.DE_DE;
+        }
+        var message = translations[language.toLowerCase()][key];
+        if (!message) {
+            return key;
+        }
+        try {
+            var formatter = TranslationsProvider.getMessageFormat(message, language);
+            var formattedMessage = formatter.format(values);
+            return formattedMessage;
+        }
+        catch (_er) {
+            // @TODO: should trigger logger
+            return message;
+        }
+    };
+    TranslationsProvider.getCurrentInstance = function () {
+        return TranslationsProvider.currentInstance;
+    };
+    TranslationsProvider.initialize = function (translations) {
+        if (translations === void 0) { translations = {}; }
+        TranslationsProvider.getMessageFormat = intl_format_cache_1.default(intl_messageformat_1.default);
+        TranslationsProvider.currentInstance = new TranslationsProvider(translations);
+    };
+    TranslationsProvider.getMessageFormat = null;
+    return TranslationsProvider;
+}());
+exports.TranslationsProvider = TranslationsProvider;
+//# sourceMappingURL=TranslationsProvider.js.map

package/lib/TranslationsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationsProvider.js","sourceRoot":"","sources":["../src/TranslationsProvider.ts"],"names":[],"mappings":";;AAAA,yDAAmD;AACnD,uDAAuD;AACvD,yCAAuC;AAEvC;IAyCE,8BAAY,YAAsB;QAAtB,6BAAA,EAAA,iBAAsB;QAF1B,iBAAY,GAAQ,IAAI,CAAC;QAG/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IA1Ca,mCAAc,GAAG,UAAC,QAA4C,EAAE,GAAW,EAAE,MAAgB;QAA3E,yBAAA,EAAA,WAA8B,oBAAQ,CAAC,KAAK;QAAe,uBAAA,EAAA,WAAgB;QACzG,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,EAAE;YAC9C,OAAO,IAAI,CAAC;SACb;QAED,IAAM,YAAY,GAAG,oBAAoB,CAAC,kBAAkB,EAAE,CAAC,YAAY,CAAC;QAE5E,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE;YACtD,QAAQ,GAAG,oBAAQ,CAAC,KAAK,CAAC;SAC3B;QAED,IAAM,OAAO,GAAW,YAAY,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;QAElE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,CAAC;SACZ;QAED,IAAI;YACF,IAAM,SAAS,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC3E,IAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAClD,OAAO,gBAAgB,CAAC;SACzB;QAAC,OAAO,GAAG,EAAE;YACZ,+BAA+B;YAC/B,OAAO,OAAO,CAAC;SAChB;IACH,CAAC,CAAC;IAEY,uCAAkB,GAAG;QACjC,OAAO,oBAAoB,CAAC,eAAe,CAAC;IAC9C,CAAC,CAAC;IAEY,+BAAU,GAAG,UAAC,YAAsB;QAAtB,6BAAA,EAAA,iBAAsB;QAChD,oBAAoB,CAAC,gBAAgB,GAAG,2BAAsB,CAAC,4BAAiB,CAAC,CAAC;QAClF,oBAAoB,CAAC,eAAe,GAAG,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAChF,CAAC,CAAC;IAEa,qCAAgB,GAAG,IAAI,CAAC;IAOzC,2BAAC;CAAA,AA5CD,IA4CC;AA5CY,oDAAoB"}

package/lib/__mocks_/translations.mock.d.ts

@@ -0,0 +1,7 @@
+export declare const allTranslations: {
+    [x: string]: {
+        'App.common.test1': string;
+        'App.common.with1Parameter': string;
+        'App.common.with2Parameters': string;
+    };
+};

package/lib/__mocks_/translations.mock.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var _a;
+var constants_1 = require("../constants");
+exports.allTranslations = (_a = {},
+    _a[constants_1.LANGUAGE.DE_DE.toLocaleLowerCase()] = {
+        'App.common.test1': 'test1_de',
+        'App.common.with1Parameter': '{items} items in the basket de_de',
+        'App.common.with2Parameters': '{items1} items in the basket {items2} in the cascket de_de',
+    },
+    _a[constants_1.LANGUAGE.EN_US.toLocaleLowerCase()] = {
+        'App.common.test1': 'test1_en',
+        'App.common.with1Parameter': '{items} items in the basket en_US',
+        'App.common.with2Parameters': '{items1} items in the basket {items2} in the cascket en_US',
+    },
+    _a);
+//# sourceMappingURL=translations.mock.js.map

package/lib/__mocks_/translations.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.mock.js","sourceRoot":"","sources":["../../src/__mocks_/translations.mock.ts"],"names":[],"mappings":";;;AAAA,0CAAwC;AAE3B,QAAA,eAAe;IAC1B,GAAC,oBAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAG;QACpC,kBAAkB,EAAE,UAAU;QAC9B,2BAA2B,EAAE,mCAAmC;QAChE,4BAA4B,EAAE,4DAA4D;KAC3F;IACD,GAAC,oBAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAG;QACpC,kBAAkB,EAAE,UAAU;QAC9B,2BAA2B,EAAE,mCAAmC;QAChE,4BAA4B,EAAE,4DAA4D;KAC3F;QACD"}

package/lib/__tests__/TranslationsProvider.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/TranslationsProvider.test.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var translations_mock_1 = require("../__mocks_/translations.mock");
+var constants_1 = require("../constants");
+var TranslationsProvider_1 = require("../TranslationsProvider");
+describe('WHEN testing TranslationsProvider', function () {
+    beforeEach(function () {
+        TranslationsProvider_1.TranslationsProvider.initialize(translations_mock_1.allTranslations);
+    });
+    var testSandbox = function (expectedValue, language, key, values) {
+        describe("WHEN testing language " + language + " key " + key + " withValues " + JSON.stringify(values), function () {
+            it("SHOULD return " + expectedValue, function () {
+                var message = TranslationsProvider_1.TranslationsProvider.getTranslation(language, key, values);
+                expect(message).toEqual(expectedValue);
+            });
+        });
+    };
+    testSandbox('test1_de', constants_1.LANGUAGE.DE_DE, 'App.common.test1');
+    testSandbox('test1_en', constants_1.LANGUAGE.EN_US, 'App.common.test1');
+    testSandbox('{items} items in the basket de_de', constants_1.LANGUAGE.DE_DE, 'App.common.with1Parameter');
+    testSandbox('{items} items in the basket en_US', constants_1.LANGUAGE.EN_US, 'App.common.with1Parameter');
+    testSandbox('10000 items in the basket de_de', constants_1.LANGUAGE.DE_DE, 'App.common.with1Parameter', { items: 10000 });
+    testSandbox('10000 items in the basket en_US', constants_1.LANGUAGE.EN_US, 'App.common.with1Parameter', { items: 10000 });
+    testSandbox('{items1} items in the basket {items2} in the cascket de_de', constants_1.LANGUAGE.DE_DE, 'App.common.with2Parameters', {
+        items1: 10000,
+    });
+    testSandbox('{items1} items in the basket {items2} in the cascket en_US', constants_1.LANGUAGE.EN_US, 'App.common.with2Parameters', {
+        items1: 10000,
+    });
+    testSandbox('10000 items in the basket 100 in the cascket de_de', constants_1.LANGUAGE.DE_DE, 'App.common.with2Parameters', {
+        items1: 10000,
+        items2: 100,
+    });
+    testSandbox('10000 items in the basket 100 in the cascket en_US', constants_1.LANGUAGE.EN_US, 'App.common.with2Parameters', {
+        items1: 10000,
+        items2: 100,
+    });
+});
+//# sourceMappingURL=TranslationsProvider.test.js.map

package/lib/__tests__/TranslationsProvider.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationsProvider.test.js","sourceRoot":"","sources":["../../src/__tests__/TranslationsProvider.test.ts"],"names":[],"mappings":";;AAAA,mEAAgE;AAChE,0CAAwC;AACxC,gEAA+D;AAE/D,QAAQ,CAAC,mCAAmC,EAAE;IAC5C,UAAU,CAAC;QACT,2CAAoB,CAAC,UAAU,CAAC,mCAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,IAAM,WAAW,GAAG,UAAC,aAAqB,EAAE,QAAkB,EAAE,GAAW,EAAE,MAAO;QAClF,QAAQ,CAAC,2BAAyB,QAAQ,aAAQ,GAAG,oBAAe,IAAI,CAAC,SAAS,CAAC,MAAM,CAAG,EAAE;YAC5F,EAAE,CAAC,mBAAiB,aAAe,EAAE;gBACnC,IAAM,OAAO,GAAG,2CAAoB,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAC3E,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,WAAW,CAAC,UAAU,EAAE,oBAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IAC5D,WAAW,CAAC,UAAU,EAAE,oBAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IAE5D,WAAW,CAAC,mCAAmC,EAAE,oBAAQ,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;IAC9F,WAAW,CAAC,mCAAmC,EAAE,oBAAQ,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;IAE9F,WAAW,CAAC,iCAAiC,EAAE,oBAAQ,CAAC,KAAK,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9G,WAAW,CAAC,iCAAiC,EAAE,oBAAQ,CAAC,KAAK,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAE9G,WAAW,CAAC,4DAA4D,EAAE,oBAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;QACtH,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IACH,WAAW,CAAC,4DAA4D,EAAE,oBAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;QACtH,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IAEH,WAAW,CAAC,oDAAoD,EAAE,oBAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;QAC9G,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,GAAG;KACZ,CAAC,CAAC;IACH,WAAW,CAAC,oDAAoD,EAAE,oBAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;QAC9G,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,GAAG;KACZ,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/constants.d.ts

@@ -0,0 +1,9 @@
+export declare enum LANGUAGE {
+    DE_DE = "de-DE",
+    EN_US = "en-US",
+    IT_IT = "it-IT",
+    FR_FR = "fr-FR",
+    ES_ES = "es-ES",
+    PT_PT = "pt-PT"
+}
+export declare const ALL_LANGUAGE: LANGUAGE[];

package/lib/constants.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var getAllStatuses = function (value) {
+    return Object.keys(value)
+        .filter(function (key) { return key !== '__DEFAULT'; })
+        .map(function (key) { return value[key]; });
+};
+var LANGUAGE;
+(function (LANGUAGE) {
+    LANGUAGE["DE_DE"] = "de-DE";
+    LANGUAGE["EN_US"] = "en-US";
+    LANGUAGE["IT_IT"] = "it-IT";
+    LANGUAGE["FR_FR"] = "fr-FR";
+    LANGUAGE["ES_ES"] = "es-ES";
+    LANGUAGE["PT_PT"] = "pt-PT";
+})(LANGUAGE = exports.LANGUAGE || (exports.LANGUAGE = {}));
+exports.ALL_LANGUAGE = getAllStatuses(LANGUAGE);
+//# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;AAAA,IAAM,cAAc,GAAG,UAAU,KAAK;IACpC,OAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SACf,MAAM,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,KAAK,WAAW,EAAnB,CAAmB,CAAC;SACpC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,KAAK,CAAC,GAAG,CAAC,EAAV,CAAU,CAAC;AAF3B,CAE2B,CAAC;AAC9B,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;AACjB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AACY,QAAA,YAAY,GAAG,cAAc,CAAW,QAAQ,CAAC,CAAC"}

package/lib/getAllTranslations.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Do not reference this module in any index.js, because it has server-side modules references
+ */
+export interface IGetAllTranslationsParams {
+    encoding?: string;
+    filePattern?: string;
+}
+export declare function getAllTranslations(options?: IGetAllTranslationsParams): any;

package/lib/getAllTranslations.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * Do not reference this module in any index.js, because it has server-side modules references
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+var path = require("path");
+var fs_1 = require("fs");
+var glob_1 = require("glob");
+function getAllTranslations(options) {
+    if (options === void 0) { options = {}; }
+    var _a = options || {}, _b = _a.filePattern, filePattern = _b === void 0 ? './src/translations/locale/locale.*.json' : _b, _c = _a.encoding, encoding = _c === void 0 ? 'utf8' : _c;
+    var translations = glob_1.sync(filePattern)
+        .map(function (filename) { return [path.basename(filename, '.json').replace('locale.', ''), fs_1.readFileSync(filename, encoding)]; })
+        .map(function (_a) {
+        var locale = _a[0], file = _a[1];
+        return [locale, JSON.parse(file)];
+    })
+        .reduce(function (collection, _a) {
+        var locale = _a[0], messages = _a[1];
+        collection[(locale || '').toLowerCase()] = messages;
+        return collection;
+    }, {});
+    return translations;
+}
+exports.getAllTranslations = getAllTranslations;
+//# sourceMappingURL=getAllTranslations.js.map

package/lib/getAllTranslations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAllTranslations.js","sourceRoot":"","sources":["../src/getAllTranslations.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,2BAA6B;AAC7B,yBAAkC;AAClC,6BAAwC;AAMxC,SAAgB,kBAAkB,CAAC,OAAuC;IAAvC,wBAAA,EAAA,YAAuC;IAClE,IAAA,kBAA8F,EAA5F,mBAAuD,EAAvD,4EAAuD,EAAE,gBAAiB,EAAjB,sCAAmC,CAAC;IAErG,IAAM,YAAY,GAAG,WAAQ,CAAC,WAAW,CAAC;SACvC,GAAG,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,iBAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAA3F,CAA2F,CAAC;SAC9G,GAAG,CAAC,UAAC,EAAc;YAAb,cAAM,EAAE,YAAI;QAAM,OAAA,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAA1B,CAA0B,CAAC;SACnD,MAAM,CAAC,UAAC,UAAU,EAAE,EAAkB;YAAjB,cAAM,EAAE,gBAAQ;QACpC,UAAU,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,QAAQ,CAAC;QACpD,OAAO,UAAU,CAAC;IACpB,CAAC,EAAE,EAAE,CAAC,CAAC;IAET,OAAO,YAAY,CAAC;AACtB,CAAC;AAZD,gDAYC"}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './getAllTranslations';
+export * from './constants';
+export * from './TranslationsProvider';

package/lib/index.js

@@ -0,0 +1,9 @@
+"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("./getAllTranslations"));
+__export(require("./constants"));
+__export(require("./TranslationsProvider"));
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,0CAAqC;AACrC,iCAA4B;AAC5B,4CAAuC"}