i18next 17.3.1 → 19.0.1

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 19.0.1
+
+- ignore non valid keys in saveMissing [1359](https://github.com/i18next/i18next/pull/1359)
+
+### 19.0.0
+
+- typescript: Typescript use `export default` for esm-first approach [1352](https://github.com/i18next/i18next/pull/1352)
+
+### 18.0.1
+
+- check loadedNamespace only once per lng-ns inside using `t` for better performance
+
+### 18.0.0
+
+- When calling `i18next.changeLanguage()` both `i18next.language` and `i18next.languages` will be set to the new language after calling `loadResources` -> means when accessing `t` function meanwhile you will get still the translations for the previous language instead of the fallback.
+
+- **When is this breaking?** this does not break any current test - but if you depend on accessing i18next.language or i18next.dir during language change and expect the new language this will break your app.
+
+- Reasoning: In react-i18next we get in a not ready state for loaded translations while we would prefer just waiting for the new language ready and trigger a rerender then - also a triggered rerender outside of the bound events would end in Suspense...
+
+- How can I get the language i18next will be set to? `i18next.isLanguageChangingTo` is set to the language called
+
 ### 17.3.1
 
 - typescript: Add missing `cleanCode` option to TypeScript def [1344](https://github.com/i18next/i18next/pull/1344)

package/dist/cjs/i18next.js

@@ -478,6 +478,8 @@ var postProcessor = {
   }
 };
 
+var checkedLoadedFor = {};
+
 var Translator =
 /*#__PURE__*/
 function (_EventEmitter) {
@@ -550,7 +552,9 @@ function (_EventEmitter) {
 
       if (!options) options = {}; // non valid keys handling
 
-      if (keys === undefined || keys === null) return '';
+      if (keys === undefined || keys === null
+      /* || keys === ''*/
+      ) return '';
       if (!Array.isArray(keys)) keys = [String(keys)]; // separators
 
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator; // get namespace(s)
@@ -763,8 +767,10 @@ function (_EventEmitter) {
           if (_this4.isValidLookup(found)) return;
           usedNS = ns;
 
-          if (_this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
-            _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
+          if (!checkedLoadedFor["".concat(codes[0], "-").concat(ns)] && _this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
+            checkedLoadedFor["".concat(codes[0], "-").concat(ns)] = true;
+
+            _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" for languages \"").concat(codes.join(', '), "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
           }
 
           codes.forEach(function (code) {
@@ -1652,7 +1658,10 @@ function (_EventEmitter) {
       if (this.services.utils && this.services.utils.hasLoadedNamespace && !this.services.utils.hasLoadedNamespace(namespace)) {
         this.logger.warn("did not save key \"".concat(key, "\" for namespace \"").concat(namespace, "\" as the namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
         return;
-      }
+      } // ignore non valid keys
+
+
+      if (key === undefined || key === null || key === '') return;
 
       if (this.backend && this.backend.create) {
         this.backend.create(languages, namespace, key, fallbackValue, null
@@ -1933,13 +1942,16 @@ function (_EventEmitter) {
 
   }, {
     key: "loadResources",
-    value: function loadResources() {
+    value: function loadResources(language) {
       var _this3 = this;
 
-      var callback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : noop;
+      var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+      var usedCallback = callback;
+      var usedLng = typeof language === 'string' ? language : this.language;
+      if (typeof language === 'function') usedCallback = language;
 
       if (!this.options.resources || this.options.partialBundledLanguages) {
-        if (this.language && this.language.toLowerCase() === 'cimode') return callback(); // avoid loading resources for cimode
+        if (usedLng && usedLng.toLowerCase() === 'cimode') return usedCallback(); // avoid loading resources for cimode
 
         var toLoad = [];
 
@@ -1953,14 +1965,14 @@ function (_EventEmitter) {
           });
         };
 
-        if (!this.language) {
+        if (!usedLng) {
           // at least load fallbacks in this case
           var fallbacks = this.services.languageUtils.getFallbackCodes(this.options.fallbackLng);
           fallbacks.forEach(function (l) {
             return append(l);
           });
         } else {
-          append(this.language);
+          append(usedLng);
         }
 
         if (this.options.preload) {
@@ -1969,9 +1981,9 @@ function (_EventEmitter) {
           });
         }
 
-        this.services.backendConnector.load(toLoad, this.options.ns, callback);
+        this.services.backendConnector.load(toLoad, this.options.ns, usedCallback);
       } else {
-        callback(null);
+        usedCallback(null);
       }
     }
   }, {
@@ -2022,16 +2034,24 @@ function (_EventEmitter) {
     value: function changeLanguage(lng, callback) {
       var _this4 = this;
 
+      this.isLanguageChangingTo = lng;
       var deferred = defer();
       this.emit('languageChanging', lng);
 
       var done = function done(err, l) {
-        _this4.translator.changeLanguage(l);
-
         if (l) {
+          _this4.language = l;
+          _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+
+          _this4.translator.changeLanguage(l);
+
+          _this4.isLanguageChangingTo = undefined;
+
           _this4.emit('languageChanged', l);
 
           _this4.logger.log('languageChanged', l);
+        } else {
+          _this4.isLanguageChangingTo = undefined;
         }
 
         deferred.resolve(function () {
@@ -2044,13 +2064,16 @@ function (_EventEmitter) {
 
       var setLng = function setLng(l) {
         if (l) {
-          _this4.language = l;
-          _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+          if (!_this4.language) {
+            _this4.language = l;
+            _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+          }
+
           if (!_this4.translator.language) _this4.translator.changeLanguage(l);
           if (_this4.services.languageDetector) _this4.services.languageDetector.cacheUserLanguage(l);
         }
 
-        _this4.loadResources(function (err) {
+        _this4.loadResources(l, function (err) {
           done(err, l);
         });
       };

package/dist/esm/i18next.js

@@ -474,6 +474,8 @@ var postProcessor = {
   }
 };
 
+var checkedLoadedFor = {};
+
 var Translator =
 /*#__PURE__*/
 function (_EventEmitter) {
@@ -546,7 +548,9 @@ function (_EventEmitter) {
 
       if (!options) options = {}; // non valid keys handling
 
-      if (keys === undefined || keys === null) return '';
+      if (keys === undefined || keys === null
+      /* || keys === ''*/
+      ) return '';
       if (!Array.isArray(keys)) keys = [String(keys)]; // separators
 
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator; // get namespace(s)
@@ -759,8 +763,10 @@ function (_EventEmitter) {
           if (_this4.isValidLookup(found)) return;
           usedNS = ns;
 
-          if (_this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
-            _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
+          if (!checkedLoadedFor["".concat(codes[0], "-").concat(ns)] && _this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
+            checkedLoadedFor["".concat(codes[0], "-").concat(ns)] = true;
+
+            _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" for languages \"").concat(codes.join(', '), "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
           }
 
           codes.forEach(function (code) {
@@ -1648,7 +1654,10 @@ function (_EventEmitter) {
       if (this.services.utils && this.services.utils.hasLoadedNamespace && !this.services.utils.hasLoadedNamespace(namespace)) {
         this.logger.warn("did not save key \"".concat(key, "\" for namespace \"").concat(namespace, "\" as the namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
         return;
-      }
+      } // ignore non valid keys
+
+
+      if (key === undefined || key === null || key === '') return;
 
       if (this.backend && this.backend.create) {
         this.backend.create(languages, namespace, key, fallbackValue, null
@@ -1929,13 +1938,16 @@ function (_EventEmitter) {
 
   }, {
     key: "loadResources",
-    value: function loadResources() {
+    value: function loadResources(language) {
       var _this3 = this;
 
-      var callback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : noop;
+      var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+      var usedCallback = callback;
+      var usedLng = typeof language === 'string' ? language : this.language;
+      if (typeof language === 'function') usedCallback = language;
 
       if (!this.options.resources || this.options.partialBundledLanguages) {
-        if (this.language && this.language.toLowerCase() === 'cimode') return callback(); // avoid loading resources for cimode
+        if (usedLng && usedLng.toLowerCase() === 'cimode') return usedCallback(); // avoid loading resources for cimode
 
         var toLoad = [];
 
@@ -1949,14 +1961,14 @@ function (_EventEmitter) {
           });
         };
 
-        if (!this.language) {
+        if (!usedLng) {
           // at least load fallbacks in this case
           var fallbacks = this.services.languageUtils.getFallbackCodes(this.options.fallbackLng);
           fallbacks.forEach(function (l) {
             return append(l);
           });
         } else {
-          append(this.language);
+          append(usedLng);
         }
 
         if (this.options.preload) {
@@ -1965,9 +1977,9 @@ function (_EventEmitter) {
           });
         }
 
-        this.services.backendConnector.load(toLoad, this.options.ns, callback);
+        this.services.backendConnector.load(toLoad, this.options.ns, usedCallback);
       } else {
-        callback(null);
+        usedCallback(null);
       }
     }
   }, {
@@ -2018,16 +2030,24 @@ function (_EventEmitter) {
     value: function changeLanguage(lng, callback) {
       var _this4 = this;
 
+      this.isLanguageChangingTo = lng;
       var deferred = defer();
       this.emit('languageChanging', lng);
 
       var done = function done(err, l) {
-        _this4.translator.changeLanguage(l);
-
         if (l) {
+          _this4.language = l;
+          _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+
+          _this4.translator.changeLanguage(l);
+
+          _this4.isLanguageChangingTo = undefined;
+
           _this4.emit('languageChanged', l);
 
           _this4.logger.log('languageChanged', l);
+        } else {
+          _this4.isLanguageChangingTo = undefined;
         }
 
         deferred.resolve(function () {
@@ -2040,13 +2060,16 @@ function (_EventEmitter) {
 
       var setLng = function setLng(l) {
         if (l) {
-          _this4.language = l;
-          _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+          if (!_this4.language) {
+            _this4.language = l;
+            _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+          }
+
           if (!_this4.translator.language) _this4.translator.changeLanguage(l);
           if (_this4.services.languageDetector) _this4.services.languageDetector.cacheUserLanguage(l);
         }
 
-        _this4.loadResources(function (err) {
+        _this4.loadResources(l, function (err) {
           done(err, l);
         });
       };

package/dist/umd/i18next.js

@@ -610,6 +610,8 @@
     }
   };
 
+  var checkedLoadedFor = {};
+
   var Translator =
   /*#__PURE__*/
   function (_EventEmitter) {
@@ -682,7 +684,9 @@
 
         if (!options) options = {}; // non valid keys handling
 
-        if (keys === undefined || keys === null) return '';
+        if (keys === undefined || keys === null
+        /* || keys === ''*/
+        ) return '';
         if (!Array.isArray(keys)) keys = [String(keys)]; // separators
 
         var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator; // get namespace(s)
@@ -895,8 +899,10 @@
             if (_this4.isValidLookup(found)) return;
             usedNS = ns;
 
-            if (_this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
-              _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
+            if (!checkedLoadedFor["".concat(codes[0], "-").concat(ns)] && _this4.utils && _this4.utils.hasLoadedNamespace && !_this4.utils.hasLoadedNamespace(usedNS)) {
+              checkedLoadedFor["".concat(codes[0], "-").concat(ns)] = true;
+
+              _this4.logger.warn("key \"".concat(usedKey, "\" for namespace \"").concat(usedNS, "\" for languages \"").concat(codes.join(', '), "\" won't get resolved as namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
             }
 
             codes.forEach(function (code) {
@@ -1822,7 +1828,10 @@
         if (this.services.utils && this.services.utils.hasLoadedNamespace && !this.services.utils.hasLoadedNamespace(namespace)) {
           this.logger.warn("did not save key \"".concat(key, "\" for namespace \"").concat(namespace, "\" as the namespace was not yet loaded"), 'This means something IS WRONG in your application setup. You access the t function before i18next.init / i18next.loadNamespace / i18next.changeLanguage was done. Wait for the callback or Promise to resolve before accessing it!!!');
           return;
-        }
+        } // ignore non valid keys
+
+
+        if (key === undefined || key === null || key === '') return;
 
         if (this.backend && this.backend.create) {
           this.backend.create(languages, namespace, key, fallbackValue, null
@@ -2103,13 +2112,16 @@
 
     }, {
       key: "loadResources",
-      value: function loadResources() {
+      value: function loadResources(language) {
         var _this3 = this;
 
-        var callback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : noop;
+        var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+        var usedCallback = callback;
+        var usedLng = typeof language === 'string' ? language : this.language;
+        if (typeof language === 'function') usedCallback = language;
 
         if (!this.options.resources || this.options.partialBundledLanguages) {
-          if (this.language && this.language.toLowerCase() === 'cimode') return callback(); // avoid loading resources for cimode
+          if (usedLng && usedLng.toLowerCase() === 'cimode') return usedCallback(); // avoid loading resources for cimode
 
           var toLoad = [];
 
@@ -2123,14 +2135,14 @@
             });
           };
 
-          if (!this.language) {
+          if (!usedLng) {
             // at least load fallbacks in this case
             var fallbacks = this.services.languageUtils.getFallbackCodes(this.options.fallbackLng);
             fallbacks.forEach(function (l) {
               return append(l);
             });
           } else {
-            append(this.language);
+            append(usedLng);
           }
 
           if (this.options.preload) {
@@ -2139,9 +2151,9 @@
             });
           }
 
-          this.services.backendConnector.load(toLoad, this.options.ns, callback);
+          this.services.backendConnector.load(toLoad, this.options.ns, usedCallback);
         } else {
-          callback(null);
+          usedCallback(null);
         }
       }
     }, {
@@ -2192,16 +2204,24 @@
       value: function changeLanguage(lng, callback) {
         var _this4 = this;
 
+        this.isLanguageChangingTo = lng;
         var deferred = defer();
         this.emit('languageChanging', lng);
 
         var done = function done(err, l) {
-          _this4.translator.changeLanguage(l);
-
           if (l) {
+            _this4.language = l;
+            _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+
+            _this4.translator.changeLanguage(l);
+
+            _this4.isLanguageChangingTo = undefined;
+
             _this4.emit('languageChanged', l);
 
             _this4.logger.log('languageChanged', l);
+          } else {
+            _this4.isLanguageChangingTo = undefined;
           }
 
           deferred.resolve(function () {
@@ -2214,13 +2234,16 @@
 
         var setLng = function setLng(l) {
           if (l) {
-            _this4.language = l;
-            _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+            if (!_this4.language) {
+              _this4.language = l;
+              _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+            }
+
             if (!_this4.translator.language) _this4.translator.changeLanguage(l);
             if (_this4.services.languageDetector) _this4.services.languageDetector.cacheUserLanguage(l);
           }
 
-          _this4.loadResources(function (err) {
+          _this4.loadResources(l, function (err) {
             done(err, l);
           });
         };