i18next 21.6.16 → 21.8.0

package/README.md

@@ -13,8 +13,8 @@ i18next is a very popular internationalization framework for browser or any othe
 
 i18next provides:
 
-- Flexible connection to [backend](https://www.i18next.com/plugins-and-utils.html#backends) (loading translations via xhr, ...)
-- Optional [caching](https://www.i18next.com/plugins-and-utils.html#caches), user [language detection](https://www.i18next.com/plugins-and-utils.html#language-detector), ...
+- Flexible connection to [backend](https://www.i18next.com/overview/plugins-and-utils#backends) (loading translations via xhr, ...)
+- Optional [caching](https://www.i18next.com/how-to/caching), user [language detection](https://www.i18next.com/overview/plugins-and-utils#language-detector), ...
 - Proper [pluralizations](https://www.i18next.com/translation-function/plurals)
 - Translation [context](https://www.i18next.com/translation-function/context)
 - [Nesting](https://www.i18next.com/translation-function/nesting), [Variable replacement](https://www.i18next.com/translation-function/interpolation)

package/dist/cjs/i18next.js

@@ -672,6 +672,7 @@ var Translator = function (_EventEmitter) {
       if (!options) options = {};
       if (keys === undefined || keys === null) return '';
       if (!Array.isArray(keys)) keys = [String(keys)];
+      var returnDetails = options.returnDetails !== undefined ? options.returnDetails : this.options.returnDetails;
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
 
       var _this$extractFromKey = this.extractFromKey(keys[keys.length - 1], options),
@@ -685,7 +686,18 @@ var Translator = function (_EventEmitter) {
       if (lng && lng.toLowerCase() === 'cimode') {
         if (appendNamespaceToCIMode) {
           var nsSeparator = options.nsSeparator || this.options.nsSeparator;
-          return namespace + nsSeparator + key;
+
+          if (returnDetails) {
+            resolved.res = "".concat(namespace).concat(nsSeparator).concat(key);
+            return resolved;
+          }
+
+          return "".concat(namespace).concat(nsSeparator).concat(key);
+        }
+
+        if (returnDetails) {
+          resolved.res = key;
+          return resolved;
         }
 
         return key;
@@ -707,9 +719,16 @@ var Translator = function (_EventEmitter) {
             this.logger.warn('accessing an object - but returnObjects options is not enabled!');
           }
 
-          return this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread$2(_objectSpread$2({}, options), {}, {
+          var r = this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread$2(_objectSpread$2({}, options), {}, {
             ns: namespaces
           })) : "key '".concat(key, " (").concat(this.language, ")' returned an object instead of string.");
+
+          if (returnDetails) {
+            resolved.res = r;
+            return resolved;
+          }
+
+          return r;
         }
 
         if (keySeparator) {
@@ -815,6 +834,11 @@ var Translator = function (_EventEmitter) {
         }
       }
 
+      if (returnDetails) {
+        resolved.res = res;
+        return resolved;
+      }
+
       return res;
     }
   }, {
@@ -1824,13 +1848,9 @@ function _createSuper$2(Derived) { var hasNativeReflectConstruct = _isNativeRefl
 
 function _isNativeReflectConstruct$2() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
-function remove(arr, what) {
-  var found = arr.indexOf(what);
-
-  while (found !== -1) {
-    arr.splice(found, 1);
-    found = arr.indexOf(what);
-  }
+function removePending(q, name) {
+  delete q.pending[name];
+  q.pendingCount--;
 }
 
 var Connector = function (_EventEmitter) {
@@ -1857,6 +1877,9 @@ var Connector = function (_EventEmitter) {
     _this.languageUtils = services.languageUtils;
     _this.options = options;
     _this.logger = baseLogger.create('backendConnector');
+    _this.waitingReads = [];
+    _this.maxParallelReads = options.maxParallelReads || 10;
+    _this.readingCalls = 0;
     _this.state = {};
     _this.queue = [];
 
@@ -1872,10 +1895,10 @@ var Connector = function (_EventEmitter) {
     value: function queueLoad(languages, namespaces, options, callback) {
       var _this2 = this;
 
-      var toLoad = [];
-      var pending = [];
-      var toLoadLanguages = [];
-      var toLoadNamespaces = [];
+      var toLoad = {};
+      var pending = {};
+      var toLoadLanguages = {};
+      var toLoadNamespaces = {};
       languages.forEach(function (lng) {
         var hasAllNamespaces = true;
         namespaces.forEach(function (ns) {
@@ -1884,21 +1907,22 @@ var Connector = function (_EventEmitter) {
           if (!options.reload && _this2.store.hasResourceBundle(lng, ns)) {
             _this2.state[name] = 2;
           } else if (_this2.state[name] < 0) ; else if (_this2.state[name] === 1) {
-            if (pending.indexOf(name) < 0) pending.push(name);
+            if (pending[name] !== undefined) pending[name] = true;
           } else {
             _this2.state[name] = 1;
             hasAllNamespaces = false;
-            if (pending.indexOf(name) < 0) pending.push(name);
-            if (toLoad.indexOf(name) < 0) toLoad.push(name);
-            if (toLoadNamespaces.indexOf(ns) < 0) toLoadNamespaces.push(ns);
+            pending[name] = true;
+            toLoad[name] = true;
+            toLoadNamespaces[ns] = true;
           }
         });
-        if (!hasAllNamespaces) toLoadLanguages.push(lng);
+        if (!hasAllNamespaces) toLoadLanguages[lng] = true;
       });
 
-      if (toLoad.length || pending.length) {
+      if (Object.keys(toLoad).length || Object.keys(pending).length) {
         this.queue.push({
           pending: pending,
+          pendingCount: Object.keys(pending).length,
           loaded: {},
           errors: [],
           callback: callback
@@ -1906,10 +1930,10 @@ var Connector = function (_EventEmitter) {
       }
 
       return {
-        toLoad: toLoad,
-        pending: pending,
-        toLoadLanguages: toLoadLanguages,
-        toLoadNamespaces: toLoadNamespaces
+        toLoad: Object.keys(toLoad),
+        pending: Object.keys(pending),
+        toLoadLanguages: Object.keys(toLoadLanguages),
+        toLoadNamespaces: Object.keys(toLoadNamespaces)
       };
     }
   }, {
@@ -1928,16 +1952,17 @@ var Connector = function (_EventEmitter) {
       var loaded = {};
       this.queue.forEach(function (q) {
         pushPath(q.loaded, [lng], ns);
-        remove(q.pending, name);
+        removePending(q, name);
         if (err) q.errors.push(err);
 
-        if (q.pending.length === 0 && !q.done) {
+        if (q.pendingCount === 0 && !q.done) {
           Object.keys(q.loaded).forEach(function (l) {
-            if (!loaded[l]) loaded[l] = [];
+            if (!loaded[l]) loaded[l] = {};
+            var loadedKeys = Object.keys(loaded[l]);
 
-            if (q.loaded[l].length) {
-              q.loaded[l].forEach(function (ns) {
-                if (loaded[l].indexOf(ns) < 0) loaded[l].push(ns);
+            if (loadedKeys.length) {
+              loadedKeys.forEach(function (ns) {
+                if (loadedKeys[ns] !== undefined) loaded[l][ns] = true;
               });
             }
           });
@@ -1964,6 +1989,20 @@ var Connector = function (_EventEmitter) {
       var wait = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 350;
       var callback = arguments.length > 5 ? arguments[5] : undefined;
       if (!lng.length) return callback(null, {});
+
+      if (this.readingCalls >= this.maxParallelReads) {
+        this.waitingReads.push({
+          lng: lng,
+          ns: ns,
+          fcName: fcName,
+          tried: tried,
+          wait: wait,
+          callback: callback
+        });
+        return;
+      }
+
+      this.readingCalls++;
       return this.backend[fcName](lng, ns, function (err, data) {
         if (err && data && tried < 5) {
           setTimeout(function () {
@@ -1972,6 +2011,14 @@ var Connector = function (_EventEmitter) {
           return;
         }
 
+        _this3.readingCalls--;
+
+        if (_this3.waitingReads.length > 0) {
+          var next = _this3.waitingReads.shift();
+
+          _this3.read(next.lng, next.ns, next.fcName, next.tried, next.wait, next.callback);
+        }
+
         callback(err, data);
       });
     }

package/dist/esm/i18next.bundled.js

@@ -834,6 +834,7 @@ var Translator = function (_EventEmitter) {
       if (!options) options = {};
       if (keys === undefined || keys === null) return '';
       if (!Array.isArray(keys)) keys = [String(keys)];
+      var returnDetails = options.returnDetails !== undefined ? options.returnDetails : this.options.returnDetails;
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
 
       var _this$extractFromKey = this.extractFromKey(keys[keys.length - 1], options),
@@ -847,7 +848,18 @@ var Translator = function (_EventEmitter) {
       if (lng && lng.toLowerCase() === 'cimode') {
         if (appendNamespaceToCIMode) {
           var nsSeparator = options.nsSeparator || this.options.nsSeparator;
-          return namespace + nsSeparator + key;
+
+          if (returnDetails) {
+            resolved.res = "".concat(namespace).concat(nsSeparator).concat(key);
+            return resolved;
+          }
+
+          return "".concat(namespace).concat(nsSeparator).concat(key);
+        }
+
+        if (returnDetails) {
+          resolved.res = key;
+          return resolved;
         }
 
         return key;
@@ -869,9 +881,16 @@ var Translator = function (_EventEmitter) {
             this.logger.warn('accessing an object - but returnObjects options is not enabled!');
           }
 
-          return this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread2(_objectSpread2({}, options), {}, {
+          var r = this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread2(_objectSpread2({}, options), {}, {
             ns: namespaces
           })) : "key '".concat(key, " (").concat(this.language, ")' returned an object instead of string.");
+
+          if (returnDetails) {
+            resolved.res = r;
+            return resolved;
+          }
+
+          return r;
         }
 
         if (keySeparator) {
@@ -977,6 +996,11 @@ var Translator = function (_EventEmitter) {
         }
       }
 
+      if (returnDetails) {
+        resolved.res = res;
+        return resolved;
+      }
+
       return res;
     }
   }, {
@@ -1970,13 +1994,9 @@ var Formatter = function () {
   return Formatter;
 }();
 
-function remove(arr, what) {
-  var found = arr.indexOf(what);
-
-  while (found !== -1) {
-    arr.splice(found, 1);
-    found = arr.indexOf(what);
-  }
+function removePending(q, name) {
+  delete q.pending[name];
+  q.pendingCount--;
 }
 
 var Connector = function (_EventEmitter) {
@@ -2003,6 +2023,9 @@ var Connector = function (_EventEmitter) {
     _this.languageUtils = services.languageUtils;
     _this.options = options;
     _this.logger = baseLogger.create('backendConnector');
+    _this.waitingReads = [];
+    _this.maxParallelReads = options.maxParallelReads || 10;
+    _this.readingCalls = 0;
     _this.state = {};
     _this.queue = [];
 
@@ -2018,10 +2041,10 @@ var Connector = function (_EventEmitter) {
     value: function queueLoad(languages, namespaces, options, callback) {
       var _this2 = this;
 
-      var toLoad = [];
-      var pending = [];
-      var toLoadLanguages = [];
-      var toLoadNamespaces = [];
+      var toLoad = {};
+      var pending = {};
+      var toLoadLanguages = {};
+      var toLoadNamespaces = {};
       languages.forEach(function (lng) {
         var hasAllNamespaces = true;
         namespaces.forEach(function (ns) {
@@ -2030,21 +2053,22 @@ var Connector = function (_EventEmitter) {
           if (!options.reload && _this2.store.hasResourceBundle(lng, ns)) {
             _this2.state[name] = 2;
           } else if (_this2.state[name] < 0) ; else if (_this2.state[name] === 1) {
-            if (pending.indexOf(name) < 0) pending.push(name);
+            if (pending[name] !== undefined) pending[name] = true;
           } else {
             _this2.state[name] = 1;
             hasAllNamespaces = false;
-            if (pending.indexOf(name) < 0) pending.push(name);
-            if (toLoad.indexOf(name) < 0) toLoad.push(name);
-            if (toLoadNamespaces.indexOf(ns) < 0) toLoadNamespaces.push(ns);
+            pending[name] = true;
+            toLoad[name] = true;
+            toLoadNamespaces[ns] = true;
           }
         });
-        if (!hasAllNamespaces) toLoadLanguages.push(lng);
+        if (!hasAllNamespaces) toLoadLanguages[lng] = true;
       });
 
-      if (toLoad.length || pending.length) {
+      if (Object.keys(toLoad).length || Object.keys(pending).length) {
         this.queue.push({
           pending: pending,
+          pendingCount: Object.keys(pending).length,
           loaded: {},
           errors: [],
           callback: callback
@@ -2052,10 +2076,10 @@ var Connector = function (_EventEmitter) {
       }
 
       return {
-        toLoad: toLoad,
-        pending: pending,
-        toLoadLanguages: toLoadLanguages,
-        toLoadNamespaces: toLoadNamespaces
+        toLoad: Object.keys(toLoad),
+        pending: Object.keys(pending),
+        toLoadLanguages: Object.keys(toLoadLanguages),
+        toLoadNamespaces: Object.keys(toLoadNamespaces)
       };
     }
   }, {
@@ -2074,16 +2098,17 @@ var Connector = function (_EventEmitter) {
       var loaded = {};
       this.queue.forEach(function (q) {
         pushPath(q.loaded, [lng], ns);
-        remove(q.pending, name);
+        removePending(q, name);
         if (err) q.errors.push(err);
 
-        if (q.pending.length === 0 && !q.done) {
+        if (q.pendingCount === 0 && !q.done) {
           Object.keys(q.loaded).forEach(function (l) {
-            if (!loaded[l]) loaded[l] = [];
+            if (!loaded[l]) loaded[l] = {};
+            var loadedKeys = Object.keys(loaded[l]);
 
-            if (q.loaded[l].length) {
-              q.loaded[l].forEach(function (ns) {
-                if (loaded[l].indexOf(ns) < 0) loaded[l].push(ns);
+            if (loadedKeys.length) {
+              loadedKeys.forEach(function (ns) {
+                if (loadedKeys[ns] !== undefined) loaded[l][ns] = true;
               });
             }
           });
@@ -2110,6 +2135,20 @@ var Connector = function (_EventEmitter) {
       var wait = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 350;
       var callback = arguments.length > 5 ? arguments[5] : undefined;
       if (!lng.length) return callback(null, {});
+
+      if (this.readingCalls >= this.maxParallelReads) {
+        this.waitingReads.push({
+          lng: lng,
+          ns: ns,
+          fcName: fcName,
+          tried: tried,
+          wait: wait,
+          callback: callback
+        });
+        return;
+      }
+
+      this.readingCalls++;
       return this.backend[fcName](lng, ns, function (err, data) {
         if (err && data && tried < 5) {
           setTimeout(function () {
@@ -2118,6 +2157,14 @@ var Connector = function (_EventEmitter) {
           return;
         }
 
+        _this3.readingCalls--;
+
+        if (_this3.waitingReads.length > 0) {
+          var next = _this3.waitingReads.shift();
+
+          _this3.read(next.lng, next.ns, next.fcName, next.tried, next.wait, next.callback);
+        }
+
         callback(err, data);
       });
     }

package/dist/esm/i18next.js

@@ -658,6 +658,7 @@ var Translator = function (_EventEmitter) {
       if (!options) options = {};
       if (keys === undefined || keys === null) return '';
       if (!Array.isArray(keys)) keys = [String(keys)];
+      var returnDetails = options.returnDetails !== undefined ? options.returnDetails : this.options.returnDetails;
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
 
       var _this$extractFromKey = this.extractFromKey(keys[keys.length - 1], options),
@@ -671,7 +672,18 @@ var Translator = function (_EventEmitter) {
       if (lng && lng.toLowerCase() === 'cimode') {
         if (appendNamespaceToCIMode) {
           var nsSeparator = options.nsSeparator || this.options.nsSeparator;
-          return namespace + nsSeparator + key;
+
+          if (returnDetails) {
+            resolved.res = "".concat(namespace).concat(nsSeparator).concat(key);
+            return resolved;
+          }
+
+          return "".concat(namespace).concat(nsSeparator).concat(key);
+        }
+
+        if (returnDetails) {
+          resolved.res = key;
+          return resolved;
         }
 
         return key;
@@ -693,9 +705,16 @@ var Translator = function (_EventEmitter) {
             this.logger.warn('accessing an object - but returnObjects options is not enabled!');
           }
 
-          return this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread$2(_objectSpread$2({}, options), {}, {
+          var r = this.options.returnedObjectHandler ? this.options.returnedObjectHandler(resUsedKey, res, _objectSpread$2(_objectSpread$2({}, options), {}, {
             ns: namespaces
           })) : "key '".concat(key, " (").concat(this.language, ")' returned an object instead of string.");
+
+          if (returnDetails) {
+            resolved.res = r;
+            return resolved;
+          }
+
+          return r;
         }
 
         if (keySeparator) {
@@ -801,6 +820,11 @@ var Translator = function (_EventEmitter) {
         }
       }
 
+      if (returnDetails) {
+        resolved.res = res;
+        return resolved;
+      }
+
       return res;
     }
   }, {
@@ -1810,13 +1834,9 @@ function _createSuper$2(Derived) { var hasNativeReflectConstruct = _isNativeRefl
 
 function _isNativeReflectConstruct$2() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
-function remove(arr, what) {
-  var found = arr.indexOf(what);
-
-  while (found !== -1) {
-    arr.splice(found, 1);
-    found = arr.indexOf(what);
-  }
+function removePending(q, name) {
+  delete q.pending[name];
+  q.pendingCount--;
 }
 
 var Connector = function (_EventEmitter) {
@@ -1843,6 +1863,9 @@ var Connector = function (_EventEmitter) {
     _this.languageUtils = services.languageUtils;
     _this.options = options;
     _this.logger = baseLogger.create('backendConnector');
+    _this.waitingReads = [];
+    _this.maxParallelReads = options.maxParallelReads || 10;
+    _this.readingCalls = 0;
     _this.state = {};
     _this.queue = [];
 
@@ -1858,10 +1881,10 @@ var Connector = function (_EventEmitter) {
     value: function queueLoad(languages, namespaces, options, callback) {
       var _this2 = this;
 
-      var toLoad = [];
-      var pending = [];
-      var toLoadLanguages = [];
-      var toLoadNamespaces = [];
+      var toLoad = {};
+      var pending = {};
+      var toLoadLanguages = {};
+      var toLoadNamespaces = {};
       languages.forEach(function (lng) {
         var hasAllNamespaces = true;
         namespaces.forEach(function (ns) {
@@ -1870,21 +1893,22 @@ var Connector = function (_EventEmitter) {
           if (!options.reload && _this2.store.hasResourceBundle(lng, ns)) {
             _this2.state[name] = 2;
           } else if (_this2.state[name] < 0) ; else if (_this2.state[name] === 1) {
-            if (pending.indexOf(name) < 0) pending.push(name);
+            if (pending[name] !== undefined) pending[name] = true;
           } else {
             _this2.state[name] = 1;
             hasAllNamespaces = false;
-            if (pending.indexOf(name) < 0) pending.push(name);
-            if (toLoad.indexOf(name) < 0) toLoad.push(name);
-            if (toLoadNamespaces.indexOf(ns) < 0) toLoadNamespaces.push(ns);
+            pending[name] = true;
+            toLoad[name] = true;
+            toLoadNamespaces[ns] = true;
           }
         });
-        if (!hasAllNamespaces) toLoadLanguages.push(lng);
+        if (!hasAllNamespaces) toLoadLanguages[lng] = true;
       });
 
-      if (toLoad.length || pending.length) {
+      if (Object.keys(toLoad).length || Object.keys(pending).length) {
         this.queue.push({
           pending: pending,
+          pendingCount: Object.keys(pending).length,
           loaded: {},
           errors: [],
           callback: callback
@@ -1892,10 +1916,10 @@ var Connector = function (_EventEmitter) {
       }
 
       return {
-        toLoad: toLoad,
-        pending: pending,
-        toLoadLanguages: toLoadLanguages,
-        toLoadNamespaces: toLoadNamespaces
+        toLoad: Object.keys(toLoad),
+        pending: Object.keys(pending),
+        toLoadLanguages: Object.keys(toLoadLanguages),
+        toLoadNamespaces: Object.keys(toLoadNamespaces)
       };
     }
   }, {
@@ -1914,16 +1938,17 @@ var Connector = function (_EventEmitter) {
       var loaded = {};
       this.queue.forEach(function (q) {
         pushPath(q.loaded, [lng], ns);
-        remove(q.pending, name);
+        removePending(q, name);
         if (err) q.errors.push(err);
 
-        if (q.pending.length === 0 && !q.done) {
+        if (q.pendingCount === 0 && !q.done) {
           Object.keys(q.loaded).forEach(function (l) {
-            if (!loaded[l]) loaded[l] = [];
+            if (!loaded[l]) loaded[l] = {};
+            var loadedKeys = Object.keys(loaded[l]);
 
-            if (q.loaded[l].length) {
-              q.loaded[l].forEach(function (ns) {
-                if (loaded[l].indexOf(ns) < 0) loaded[l].push(ns);
+            if (loadedKeys.length) {
+              loadedKeys.forEach(function (ns) {
+                if (loadedKeys[ns] !== undefined) loaded[l][ns] = true;
               });
             }
           });
@@ -1950,6 +1975,20 @@ var Connector = function (_EventEmitter) {
       var wait = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 350;
       var callback = arguments.length > 5 ? arguments[5] : undefined;
       if (!lng.length) return callback(null, {});
+
+      if (this.readingCalls >= this.maxParallelReads) {
+        this.waitingReads.push({
+          lng: lng,
+          ns: ns,
+          fcName: fcName,
+          tried: tried,
+          wait: wait,
+          callback: callback
+        });
+        return;
+      }
+
+      this.readingCalls++;
       return this.backend[fcName](lng, ns, function (err, data) {
         if (err && data && tried < 5) {
           setTimeout(function () {
@@ -1958,6 +1997,14 @@ var Connector = function (_EventEmitter) {
           return;
         }
 
+        _this3.readingCalls--;
+
+        if (_this3.waitingReads.length > 0) {
+          var next = _this3.waitingReads.shift();
+
+          _this3.read(next.lng, next.ns, next.fcName, next.tried, next.wait, next.callback);
+        }
+
         callback(err, data);
       });
     }

package/dist/esm/package.json

@@ -1 +1 @@
-{"type":"module","version":"21.6.16"}
+{"type":"module","version":"21.8.0"}