enhancing local support

Author: perki

src/index-webpack.js

@@ -1,7 +1,7 @@
 import HDSModel from './HDSModel/HDSModel';
 import appTemplates from './appTemplates/appTemplates';
 import pryv from './patchedPryv';
-import { localizeText, setPreferredLocale } from './localizeText';
+import { localizeText, setPreferredLocales } from './localizeText';
 import logger from './logger';
 const l = localizeText;
 
@@ -13,7 +13,7 @@ export {
   appTemplates,
   pryv,
   localizeText,
-  setPreferredLocale,
+  setPreferredLocales,
   l,
   logger
 };

src/index.js

@@ -1,11 +1,12 @@
-const { localizeText, setPreferredLocale } = require('./localizeText');
+const { localizeText, setPreferredLocales } = require('./localizeText');
 
 module.exports = {
+  settings: require('./settings'),
   HDSModel: require('./HDSModel/HDSModel'),
   appTemplates: require('./appTemplates/appTemplates'),
   pryv: require('./patchedPryv'),
   localizeText,
-  setPreferredLocale,
+  setPreferredLocales,
   l: localizeText,
   logger: require('./logger')
 };

src/localizeText.js

@@ -6,10 +6,37 @@ const { HDSLibError } = require('./errors');
 
 module.exports = {
   localizeText,
-  setPreferredLocale
+  setPreferredLocales,
+  getPreferredLocales,
+  getSupportedLocales,
+  resetPreferredLocales
 };
 
-let preferredLocales = ['en', 'fr', 'es'];
+const supportedLocales = ['en', 'fr', 'es'];
+Object.freeze(supportedLocales);
+let preferredLocales = [...supportedLocales];
+
+/**
+ * get the current preferred locales
+* @returns {Array<string>}
+ */
+function getPreferredLocales () {
+  return [...preferredLocales];
+}
+/**
+ * get the current supported locales
+* @returns {Array<string>}
+ */
+function getSupportedLocales () {
+  return [...preferredLocales];
+}
+
+/**
+ * reset prefferedLocalesTo Original state
+ */
+function resetPreferredLocales () {
+  setPreferredLocales(supportedLocales);
+}
 
 /**
  * return the translation of this item considering the setting of preffered language
@@ -29,7 +56,16 @@ function localizeText (textItem) {
 
 /**
  * Change prefferedLocal order
+ * @param {Array<string>} arrayOfLocals of local codes
  */
-function setPreferredLocale (arrayOfLocals) {
+function setPreferredLocales (arrayOfLocals) {
+  if (!Array.isArray(arrayOfLocals)) {
+    throw new HDSLibError('setPreferredLocales takes an array of language codes');
+  }
+  const unsupportedLocales = arrayOfLocals.filter(l => (supportedLocales.indexOf(l) < 0));
+  if (unsupportedLocales.length > 0) {
+    throw new HDSLibError(`locales "${unsupportedLocales.join(', ')}" are not supported`, arrayOfLocals);
+  }
+
   preferredLocales = [...new Set([...arrayOfLocals, ...preferredLocales])];
 }

src/settings.js

@@ -0,0 +1,5 @@
+const { setPreferredLocales } = require('./localizeText');
+
+module.exports = {
+  setPreferredLocales
+};

tests/libSettings.test.js

@@ -0,0 +1,21 @@
+/* eslint-env mocha */
+const assert = require('node:assert/strict');
+
+const HDSLib = require('../src');
+
+describe('[LISX] Lib settings', () => {
+  before(async () => {
+
+  });
+
+  it('[LISL] settings.setPreferredLocales default Local', async () => {
+    const text = {
+      en: 'Hello',
+      fr: 'Bonjour'
+    };
+    HDSLib.settings.setPreferredLocales(['en']);
+    assert.equal(HDSLib.l(text), text.en);
+    HDSLib.settings.setPreferredLocales(['fr']);
+    assert.equal(HDSLib.l(text), text.fr);
+  });
+});

tests/localizeText.test.js

@@ -0,0 +1,49 @@
+/* eslint-env mocha */
+const assert = require('node:assert/strict');
+const { setPreferredLocales, localizeText } = require('../src');
+const { resetPreferredLocales, getPreferredLocales, getSupportedLocales } = require('../src/localizeText');
+
+describe('[LOCX] Lib settings', () => {
+  beforeEach(() => {
+    resetPreferredLocales();
+  });
+
+  it('[LOCD] getSupportedLocales', () => {
+    const defaultLocales = getSupportedLocales();
+    assert.deepEqual(defaultLocales, ['en', 'fr', 'es']);
+  });
+
+  it('[LOCL] setPreferredLocales, resetPrefferedLocales', () => {
+    const defaultLocales = getSupportedLocales();
+    const text = {
+      en: 'Hello',
+      fr: 'Bonjour'
+    };
+    setPreferredLocales(['en']);
+    assert.equal(localizeText(text), text.en);
+    setPreferredLocales(['fr', 'es']);
+    assert.equal(localizeText(text), text.fr);
+    const prefferedLocales = getPreferredLocales();
+    assert.deepEqual(prefferedLocales, ['fr', 'es', 'en']);
+    resetPreferredLocales();
+    assert.deepEqual(getPreferredLocales(), defaultLocales);
+  });
+
+  it('[LOCE] setPreferredLocales throws error if language code unssuported', () => {
+    try {
+      setPreferredLocales(['ex', 'en', 'fr', 'ut']);
+      throw new Error('Should throw error');
+    } catch (e) {
+      assert.equal(e.message, 'locales "ex, ut" are not supported');
+    }
+  });
+
+  it('[LOCE] setPreferredLocales throws error if not array', () => {
+    try {
+      setPreferredLocales('en');
+      throw new Error('Should throw error');
+    } catch (e) {
+      assert.equal(e.message, 'setPreferredLocales takes an array of language codes');
+    }
+  });
+});