i18next-http-middleware 3.10.0 → 3.10.2

package/README.md

@@ -270,6 +270,9 @@ const app = new App()
 
 ```js
 // missing keys make sure the body is parsed (i.e. with [body-parser](https://github.com/expressjs/body-parser#bodyparserjsonoptions))
+// this route takes writes from anyone who can reach it: every key in the body goes to the
+// backend's create (i18next-fs-backend writes it into a file) and stays in the server's memory,
+// so mount it only in development or behind authentication
 app.post('/locales/add/:lng/:ns', middleware.missingKeyHandler(i18next))
 // addPath for client: http://localhost:8080/locales/add/{{lng}}/{{ns}}
 

package/cjs/index.js

@@ -132,7 +132,7 @@ function handle(i18next) {
       i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
     }
     if (!req.lng) return next();
-    i18next.loadLanguages(req.lng, function () {
+    i18n.loadLanguages(req.lng, function () {
       return next();
     });
   };
@@ -253,17 +253,16 @@ function getResourcesHandler(i18next) {
     }
     languages = languages.filter(utils.isSafeLangIdentifier);
     namespaces = namespaces.filter(utils.isSafeNsIdentifier);
-    namespaces.forEach(function (ns) {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
-        i18next.options.ns.push(ns);
-      }
-    });
     var loaded = false;
     var onLoaded;
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(function (lng) {
         namespaces.forEach(function (ns) {
-          utils.setPath(resources, [lng, ns], i18next.getResourceBundle(lng, ns));
+          var bundle = i18next.getResourceBundle(lng, ns);
+          if (bundle && i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+            i18next.options.ns.push(ns);
+          }
+          utils.setPath(resources, [lng, ns], bundle);
         });
       });
       loaded = true;
@@ -302,6 +301,8 @@ function missingKeyHandler(i18next) {
     var keySeparator = i18next.options && i18next.options.keySeparator;
     var utilsOfRequest = req.i18n && req.i18n.services && req.i18n.services.utils;
     var hasLoadedNamespace = utilsOfRequest && utilsOfRequest.hasLoadedNamespace;
+    var sharedNs = i18next.options && i18next.options.ns;
+    var nsWasKnown = !Array.isArray(sharedNs) || sharedNs.indexOf(ns) > -1;
     var saveMissingKeys = function saveMissingKeys(src) {
       if (!src || _typeof(src) !== 'object') return;
       for (var _i = 0, _Object$keys = Object.keys(src); _i < _Object$keys.length; _i++) {
@@ -309,6 +310,7 @@ function missingKeyHandler(i18next) {
         if (utils.hasUnsafeKeySegment(m, keySeparator)) continue;
         i18next.services.backendConnector.saveMissing([lng], ns, m, src[m], undefined, undefined, undefined, hasLoadedNamespace);
       }
+      if (!nsWasKnown && sharedNs.indexOf(ns) > -1) sharedNs.splice(sharedNs.indexOf(ns), 1);
     };
     if (typeof body === 'function') {
       var promise = body();

package/esm/index.js

@@ -115,7 +115,7 @@ export function handle(i18next) {
       i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
     }
     if (!req.lng) return next();
-    i18next.loadLanguages(req.lng, function () {
+    i18n.loadLanguages(req.lng, function () {
       return next();
     });
   };
@@ -236,17 +236,16 @@ export function getResourcesHandler(i18next) {
     }
     languages = languages.filter(utils.isSafeLangIdentifier);
     namespaces = namespaces.filter(utils.isSafeNsIdentifier);
-    namespaces.forEach(function (ns) {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
-        i18next.options.ns.push(ns);
-      }
-    });
     var loaded = false;
     var onLoaded;
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(function (lng) {
         namespaces.forEach(function (ns) {
-          utils.setPath(resources, [lng, ns], i18next.getResourceBundle(lng, ns));
+          var bundle = i18next.getResourceBundle(lng, ns);
+          if (bundle && i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+            i18next.options.ns.push(ns);
+          }
+          utils.setPath(resources, [lng, ns], bundle);
         });
       });
       loaded = true;
@@ -285,6 +284,8 @@ export function missingKeyHandler(i18next) {
     var keySeparator = i18next.options && i18next.options.keySeparator;
     var utilsOfRequest = req.i18n && req.i18n.services && req.i18n.services.utils;
     var hasLoadedNamespace = utilsOfRequest && utilsOfRequest.hasLoadedNamespace;
+    var sharedNs = i18next.options && i18next.options.ns;
+    var nsWasKnown = !Array.isArray(sharedNs) || sharedNs.indexOf(ns) > -1;
     var saveMissingKeys = function saveMissingKeys(src) {
       if (!src || _typeof(src) !== 'object') return;
       for (var _i = 0, _Object$keys = Object.keys(src); _i < _Object$keys.length; _i++) {
@@ -292,6 +293,7 @@ export function missingKeyHandler(i18next) {
         if (utils.hasUnsafeKeySegment(m, keySeparator)) continue;
         i18next.services.backendConnector.saveMissing([lng], ns, m, src[m], undefined, undefined, undefined, hasLoadedNamespace);
       }
+      if (!nsWasKnown && sharedNs.indexOf(ns) > -1) sharedNs.splice(sharedNs.indexOf(ns), 1);
     };
     if (typeof body === 'function') {
       var promise = body();

package/lib/index.js

@@ -127,9 +127,11 @@ export function handle (i18next, options = {}) {
     if (i18next.services.languageDetector) {
       i18next.services.languageDetector.cacheUserLanguage(req, res, lng)
     }
-    // load resources
+    // load resources: through the request's clone, as loadLanguages() adds
+    // the language to options.preload, and every request on the shared
+    // instance pays for the length of that list until the process restarts
     if (!req.lng) return next()
-    i18next.loadLanguages(req.lng, () => next())
+    i18n.loadLanguages(req.lng, () => next())
   }
 }
 
@@ -265,23 +267,19 @@ export function getResourcesHandler (i18next, options = {}) {
     languages = languages.filter(utils.isSafeLangIdentifier)
     namespaces = namespaces.filter(utils.isSafeNsIdentifier)
 
-    // extend ns
-    namespaces.forEach(ns => {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
-        i18next.options.ns.push(ns)
-      }
-    })
-
     let loaded = false
     let onLoaded
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(lng => {
         namespaces.forEach(ns => {
-          utils.setPath(
-            resources,
-            [lng, ns],
-            i18next.getResourceBundle(lng, ns)
-          )
+          const bundle = i18next.getResourceBundle(lng, ns)
+          // extend ns only with a namespace the backend has: every request
+          // pays for the length of this shared list, and a made-up ns from
+          // the request would stay in it until the process restarts
+          if (bundle && i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+            i18next.options.ns.push(ns)
+          }
+          utils.setPath(resources, [lng, ns], bundle)
         })
       })
       loaded = true
@@ -337,6 +335,11 @@ export function missingKeyHandler (i18next, options = {}) {
     const keySeparator = i18next.options && i18next.options.keySeparator
     const utilsOfRequest = req.i18n && req.i18n.services && req.i18n.services.utils
     const hasLoadedNamespace = utilsOfRequest && utilsOfRequest.hasLoadedNamespace
+    // saveMissing() writes the key to the store, which also adds its namespace to the
+    // shared i18next.options.ns: every request walks that list, so a namespace that
+    // came from this request must not stay in it
+    const sharedNs = i18next.options && i18next.options.ns
+    const nsWasKnown = !Array.isArray(sharedNs) || sharedNs.indexOf(ns) > -1
 
     // iterate only over own, non-prototype-polluting keys. The check also
     // rejects dotted variants like `__proto__.polluted` whose segments under
@@ -349,6 +352,7 @@ export function missingKeyHandler (i18next, options = {}) {
         // request) as the 8th argument; without it, it checks the newest clone
         i18next.services.backendConnector.saveMissing([lng], ns, m, src[m], undefined, undefined, undefined, hasLoadedNamespace)
       }
+      if (!nsWasKnown && sharedNs.indexOf(ns) > -1) sharedNs.splice(sharedNs.indexOf(ns), 1)
     }
 
     if (typeof body === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18next-http-middleware",
-  "version": "3.10.0",
+  "version": "3.10.2",
   "private": false,
   "type": "module",
   "main": "./cjs/index.js",