next-i18next 10.2.0 → 10.5.0

package/README.md

@@ -223,16 +223,18 @@ This option will reload your translations whenever `serverSideTranslations` is c
 
 #### Options
 
-| Key                 | Default value        |
-| ------------------- | -------------------- |
-| `defaultNS`         | `'common'`           |
-| `localeExtension`   | `'json'`             |
-| `localePath`        | `'./public/locales'` |
-| `localeStructure`   | `'{{lng}}/{{ns}}'`   |
-| `reloadOnPrerender` | `false`              |
-| `serializeConfig`   | `true`               |
-| `strictMode`        | `true`               |
-| `use` (for plugins) | `[]`                 |
+| Key                 | Default value        | Note                                   |
+| ------------------- | -------------------- | -------------------------------------- |
+| `defaultNS`         | `'common'`           |                                        |
+| `localePath`        | `'./public/locales'` | Can be a function, see note below.     |
+| `localeExtension`   | `'json'`             | Ignored if `localePath` is a function. |
+| `localeStructure`   | `'{{lng}}/{{ns}}'`   | Ignored if `localePath` is a function. |
+| `reloadOnPrerender` | `false`              |                                        |
+| `serializeConfig`   | `true`               |                                        |
+| `strictMode`        | `true`               |                                        |
+| `use` (for plugins) | `[]`                 |                                        |
+
+`localePath` as a function is of the form `(locale: string, namespace: string, missing: boolean) => string` returning the entire path including filename and extension. When `missing` is true, return the path for the `addPath` option of `i18next-fs-backend`, when false, return the path for the `loadPath` option. [More info at the `i18next-fs-backend` repo.](https://github.com/i18next/i18next-fs-backend/tree/master#backend-options)
 
 All other [i18next options](https://www.i18next.com/overview/configuration-options) can be passed in as well.
 
@@ -254,6 +256,27 @@ const Component = () => {
 }
 ```
 
+#### Custom interpolation prefix/suffix
+
+By default, i18next uses `{{` as prefix and `}}` as suffix for [interpolation](https://www.i18next.com/translation-function/interpolation).
+If you want/need to override these interpolation settings, you **must** also specify an alternative `localeStructure` setting that matches your custom prefix and suffix.
+
+For example, if you want to use `{` and `}` the config would look like this:
+
+```js
+{
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en', 'nl'],
+  },
+  interpolation: {
+    prefix: '{',
+    suffix: '}',
+  },
+  localeStructure: '{lng}/{ns}',
+}
+```
+
 ## Migration to v8
 
 To migrate from previous versions to the version 8, check out the [v8-migration guide](https://github.com/isaachinman/next-i18next/tree/master/docs/v8-migration.md)

package/dist/commonjs/appWithTranslation.js

@@ -86,9 +86,11 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
   var configOverride = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
 
   var AppWithTranslation = function AppWithTranslation(props) {
+    var _nextI18Next$initialL;
+
     var _ref = props.pageProps,
         _nextI18Next = _ref._nextI18Next;
-    var locale = null; // Memoize the instance and only re-initialize when either:
+    var locale = (_nextI18Next$initialL = _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) !== null && _nextI18Next$initialL !== void 0 ? _nextI18Next$initialL : null; // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
 
@@ -97,9 +99,8 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
 
       if (!_nextI18Next) return null;
       var userConfig = _nextI18Next.userConfig;
-      var initialI18nStore = _nextI18Next.initialI18nStore,
-          initialLocale = _nextI18Next.initialLocale;
-      locale = initialLocale;
+      var initialI18nStore = _nextI18Next.initialI18nStore;
+      var resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
 
       if (userConfig === null && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
@@ -117,7 +118,7 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
         lng: locale
       }))), {}, {
         lng: locale,
-        resources: initialI18nStore
+        resources: resources
       })).i18n;
       exports.globalI18n = globalI18n = instance;
       return instance;

package/dist/commonjs/config/createConfig.js

@@ -61,20 +61,21 @@ require("core-js/modules/es.array.reduce.js");
 
 require("core-js/modules/es.object.values.js");
 
-require("core-js/modules/es.string.match.js");
-
 require("core-js/modules/es.array.for-each.js");
 
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 
 var _defaultConfig = require("./defaultConfig");
 
+var _excluded = ["i18n"],
+    _excluded2 = ["i18n"];
+
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
@@ -98,9 +99,9 @@ var createConfig = function createConfig(userConfig) {
 
 
   var userI18n = userConfig.i18n,
-      userConfigStripped = (0, _objectWithoutProperties2["default"])(userConfig, ["i18n"]);
+      userConfigStripped = (0, _objectWithoutProperties2["default"])(userConfig, _excluded);
   var defaultI18n = _defaultConfig.defaultConfig.i18n,
-      defaultConfigStripped = (0, _objectWithoutProperties2["default"])(_defaultConfig.defaultConfig, ["i18n"]);
+      defaultConfigStripped = (0, _objectWithoutProperties2["default"])(_defaultConfig.defaultConfig, _excluded2);
 
   var combinedConfig = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, defaultConfigStripped), userConfigStripped), defaultI18n), userI18n);
 
@@ -133,39 +134,66 @@ var createConfig = function createConfig(userConfig) {
     if (!hasCustomBackend) {
       var fs = require('fs');
 
-      var path = require('path');
-
-      var serverLocalePath = localePath; //
+      var path = require('path'); //
       // Validate defaultNS
       // https://github.com/isaachinman/next-i18next/issues/358
       //
 
+
       if (typeof defaultNS === 'string' && typeof lng !== 'undefined') {
-        var _userConfig$interpola, _userConfig$interpola2, _userConfig$interpola3, _userConfig$interpola4;
+        if (typeof localePath === 'string') {
+          var _userConfig$interpola, _userConfig$interpola2, _userConfig$interpola3, _userConfig$interpola4;
+
+          var prefix = (_userConfig$interpola = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola2 = userConfig.interpolation) === null || _userConfig$interpola2 === void 0 ? void 0 : _userConfig$interpola2.prefix) !== null && _userConfig$interpola !== void 0 ? _userConfig$interpola : '{{';
+          var suffix = (_userConfig$interpola3 = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola4 = userConfig.interpolation) === null || _userConfig$interpola4 === void 0 ? void 0 : _userConfig$interpola4.suffix) !== null && _userConfig$interpola3 !== void 0 ? _userConfig$interpola3 : '}}';
+          var defaultLocaleStructure = localeStructure.replace("".concat(prefix, "lng").concat(suffix), lng).replace("".concat(prefix, "ns").concat(suffix), defaultNS);
+          var defaultFile = "/".concat(defaultLocaleStructure, ".").concat(localeExtension);
+          var defaultNSPath = path.join(localePath, defaultFile);
+          var defaultNSExists = fs.existsSync(defaultNSPath);
+
+          if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error("Default namespace not found at ".concat(defaultNSPath));
+          }
+        } else if (typeof localePath === 'function') {
+          var _defaultNSPath = localePath(lng, defaultNS, false);
 
-        var prefix = (_userConfig$interpola = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola2 = userConfig.interpolation) === null || _userConfig$interpola2 === void 0 ? void 0 : _userConfig$interpola2.prefix) !== null && _userConfig$interpola !== void 0 ? _userConfig$interpola : '{{';
-        var suffix = (_userConfig$interpola3 = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola4 = userConfig.interpolation) === null || _userConfig$interpola4 === void 0 ? void 0 : _userConfig$interpola4.suffix) !== null && _userConfig$interpola3 !== void 0 ? _userConfig$interpola3 : '}}';
-        var defaultLocaleStructure = localeStructure.replace("".concat(prefix, "lng").concat(suffix), lng).replace("".concat(prefix, "ns").concat(suffix), defaultNS);
-        var defaultFile = "/".concat(defaultLocaleStructure, ".").concat(localeExtension);
-        var defaultNSPath = path.join(localePath, defaultFile);
-        var defaultNSExists = fs.existsSync(defaultNSPath);
+          var _defaultNSExists = fs.existsSync(_defaultNSPath);
 
-        if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
-          throw new Error("Default namespace not found at ".concat(defaultNSPath));
+          if (!_defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error("Default namespace not found at ".concat(_defaultNSPath));
+          }
         }
       } //
       // Set server side backend
       //
 
 
-      combinedConfig.backend = {
-        addPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension)),
-        loadPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".").concat(localeExtension))
-      }; //
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: path.resolve(process.cwd(), "".concat(localePath, "/").concat(localeStructure, ".missing.").concat(localeExtension)),
+          loadPath: path.resolve(process.cwd(), "".concat(localePath, "/").concat(localeStructure, ".").concat(localeExtension))
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: function addPath(locale, namespace) {
+            return localePath(locale, namespace, true);
+          },
+          loadPath: function loadPath(locale, namespace) {
+            return localePath(locale, namespace, false);
+          }
+        };
+      } else {
+        throw new Error("Unsupported localePath type: ".concat((0, _typeof2["default"])(localePath)));
+      } //
       // Set server side preload (namespaces)
       //
 
+
       if (!combinedConfig.ns && typeof lng !== 'undefined') {
+        if (typeof localePath === 'function') {
+          throw new Error('Must provide all namespaces in ns option if using a function as localePath');
+        }
+
         var unique = function unique(list) {
           return Array.from(new Set(list));
         };
@@ -178,7 +206,7 @@ var createConfig = function createConfig(userConfig) {
           };
 
           var namespacesByLocale = locales.map(function (locale) {
-            return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(locale)));
+            return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
           });
           var allNamespaces = [];
 
@@ -222,22 +250,25 @@ var createConfig = function createConfig(userConfig) {
       }
     }
   } else {
-    var clientLocalePath = localePath; //
-    // Remove public prefix from client site config
     //
-
-    if (localePath.match(/^\.?\/public\//)) {
-      clientLocalePath = localePath.replace(/^\.?\/public/, '');
-    } //
     // Set client side backend, if there is no custom backend
     //
-
-
     if (!hasCustomBackend) {
-      combinedConfig.backend = {
-        addPath: "".concat(clientLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension),
-        loadPath: "".concat(clientLocalePath, "/").concat(localeStructure, ".").concat(localeExtension)
-      };
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: "".concat(localePath, "/").concat(localeStructure, ".missing.").concat(localeExtension),
+          loadPath: "".concat(localePath, "/").concat(localeStructure, ".").concat(localeExtension)
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: function addPath(locale, namespace) {
+            return localePath(locale, namespace, true);
+          },
+          loadPath: function loadPath(locale, namespace) {
+            return localePath(locale, namespace, false);
+          }
+        };
+      }
     }
 
     if (typeof combinedConfig.ns !== 'string' && !Array.isArray(combinedConfig.ns)) {

package/dist/commonjs/serverSideTranslations.js

@@ -222,19 +222,31 @@ var serverSideTranslations = /*#__PURE__*/function () {
               initialI18nStore[lng] = {};
             });
 
-            if (!Array.isArray(namespacesRequired)) {
-              getLocaleNamespaces = function getLocaleNamespaces(path) {
-                return _fs["default"].readdirSync(path).map(function (file) {
-                  return file.replace(".".concat(localeExtension), '');
-                });
-              };
-
-              namespacesByLocale = Object.keys(initialI18nStore).map(function (locale) {
-                return getLocaleNamespaces(_path["default"].resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
-              });
-              namespacesRequired = flatNamespaces(namespacesByLocale);
+            if (Array.isArray(namespacesRequired)) {
+              _context.next = 27;
+              break;
+            }
+
+            if (!(typeof localePath === 'function')) {
+              _context.next = 24;
+              break;
             }
 
+            throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
+
+          case 24:
+            getLocaleNamespaces = function getLocaleNamespaces(path) {
+              return _fs["default"].readdirSync(path).map(function (file) {
+                return file.replace(".".concat(localeExtension), '');
+              });
+            };
+
+            namespacesByLocale = Object.keys(initialI18nStore).map(function (locale) {
+              return getLocaleNamespaces(_path["default"].resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
+            });
+            namespacesRequired = flatNamespaces(namespacesByLocale);
+
+          case 27:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -248,7 +260,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
               }
             });
 
-          case 24:
+          case 29:
           case "end":
             return _context.stop();
         }

package/dist/es/appWithTranslation.js

@@ -12,20 +12,21 @@ export const appWithTranslation = (WrappedComponent, configOverride = null) => {
     const {
       _nextI18Next
     } = props.pageProps;
-    let locale = null; // Memoize the instance and only re-initialize when either:
+    const locale = (_nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) ?? null; // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
 
     const i18n = useMemo(() => {
+      var _userConfig;
+
       if (!_nextI18Next) return null;
       let {
         userConfig
       } = _nextI18Next;
       const {
-        initialI18nStore,
-        initialLocale
+        initialI18nStore
       } = _nextI18Next;
-      locale = initialLocale;
+      const resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
 
       if (userConfig === null && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
@@ -35,7 +36,7 @@ export const appWithTranslation = (WrappedComponent, configOverride = null) => {
         userConfig = configOverride;
       }
 
-      if (!userConfig?.i18n) {
+      if (!((_userConfig = userConfig) !== null && _userConfig !== void 0 && _userConfig.i18n)) {
         throw new Error('appWithTranslation was called without config.i18n');
       }
 
@@ -43,7 +44,7 @@ export const appWithTranslation = (WrappedComponent, configOverride = null) => {
           lng: locale
         }),
         lng: locale,
-        resources: initialI18nStore
+        resources
       }).i18n;
       globalI18n = instance;
       return instance;

package/dist/es/config/createConfig.js

@@ -1,7 +1,9 @@
 import { defaultConfig } from './defaultConfig';
 const deepMergeObjects = ['backend', 'detection'];
 export const createConfig = userConfig => {
-  if (typeof userConfig?.lng !== 'string') {
+  var _userConfig$use;
+
+  if (typeof (userConfig === null || userConfig === void 0 ? void 0 : userConfig.lng) !== 'string') {
     throw new Error('config.lng was not passed into createConfig');
   } //
   // Initial merge of default and user-provided config
@@ -42,7 +44,7 @@ export const createConfig = userConfig => {
     combinedConfig.fallbackLng = combinedConfig.defaultLocale;
   }
 
-  const hasCustomBackend = userConfig?.use?.some(b => b.type === 'backend');
+  const hasCustomBackend = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$use = userConfig.use) === null || _userConfig$use === void 0 ? void 0 : _userConfig$use.some(b => b.type === 'backend');
 
   if (!process.browser && typeof window === 'undefined') {
     combinedConfig.preload = locales;
@@ -50,43 +52,67 @@ export const createConfig = userConfig => {
     if (!hasCustomBackend) {
       const fs = require('fs');
 
-      const path = require('path');
-
-      const serverLocalePath = localePath; //
+      const path = require('path'); //
       // Validate defaultNS
       // https://github.com/isaachinman/next-i18next/issues/358
       //
 
+
       if (typeof defaultNS === 'string' && typeof lng !== 'undefined') {
-        const prefix = userConfig?.interpolation?.prefix ?? '{{';
-        const suffix = userConfig?.interpolation?.suffix ?? '}}';
-        const defaultLocaleStructure = localeStructure.replace(`${prefix}lng${suffix}`, lng).replace(`${prefix}ns${suffix}`, defaultNS);
-        const defaultFile = `/${defaultLocaleStructure}.${localeExtension}`;
-        const defaultNSPath = path.join(localePath, defaultFile);
-        const defaultNSExists = fs.existsSync(defaultNSPath);
-
-        if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
-          throw new Error(`Default namespace not found at ${defaultNSPath}`);
+        if (typeof localePath === 'string') {
+          var _userConfig$interpola, _userConfig$interpola2;
+
+          const prefix = (userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola = userConfig.interpolation) === null || _userConfig$interpola === void 0 ? void 0 : _userConfig$interpola.prefix) ?? '{{';
+          const suffix = (userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola2 = userConfig.interpolation) === null || _userConfig$interpola2 === void 0 ? void 0 : _userConfig$interpola2.suffix) ?? '}}';
+          const defaultLocaleStructure = localeStructure.replace(`${prefix}lng${suffix}`, lng).replace(`${prefix}ns${suffix}`, defaultNS);
+          const defaultFile = `/${defaultLocaleStructure}.${localeExtension}`;
+          const defaultNSPath = path.join(localePath, defaultFile);
+          const defaultNSExists = fs.existsSync(defaultNSPath);
+
+          if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error(`Default namespace not found at ${defaultNSPath}`);
+          }
+        } else if (typeof localePath === 'function') {
+          const defaultNSPath = localePath(lng, defaultNS, false);
+          const defaultNSExists = fs.existsSync(defaultNSPath);
+
+          if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error(`Default namespace not found at ${defaultNSPath}`);
+          }
         }
       } //
       // Set server side backend
       //
 
 
-      combinedConfig.backend = {
-        addPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.missing.${localeExtension}`),
-        loadPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.${localeExtension}`)
-      }; //
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: path.resolve(process.cwd(), `${localePath}/${localeStructure}.missing.${localeExtension}`),
+          loadPath: path.resolve(process.cwd(), `${localePath}/${localeStructure}.${localeExtension}`)
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: (locale, namespace) => localePath(locale, namespace, true),
+          loadPath: (locale, namespace) => localePath(locale, namespace, false)
+        };
+      } else {
+        throw new Error(`Unsupported localePath type: ${typeof localePath}`);
+      } //
       // Set server side preload (namespaces)
       //
 
+
       if (!combinedConfig.ns && typeof lng !== 'undefined') {
+        if (typeof localePath === 'function') {
+          throw new Error('Must provide all namespaces in ns option if using a function as localePath');
+        }
+
         const unique = list => Array.from(new Set(list));
 
         const getNamespaces = locales => {
           const getLocaleNamespaces = p => fs.readdirSync(p).map(file => file.replace(`.${localeExtension}`, ''));
 
-          const namespacesByLocale = locales.map(locale => getLocaleNamespaces(path.resolve(process.cwd(), `${serverLocalePath}/${locale}`)));
+          const namespacesByLocale = locales.map(locale => getLocaleNamespaces(path.resolve(process.cwd(), `${localePath}/${locale}`)));
           const allNamespaces = [];
 
           for (const localNamespaces of namespacesByLocale) {
@@ -117,22 +143,21 @@ export const createConfig = userConfig => {
       }
     }
   } else {
-    let clientLocalePath = localePath; //
-    // Remove public prefix from client site config
     //
-
-    if (localePath.match(/^\.?\/public\//)) {
-      clientLocalePath = localePath.replace(/^\.?\/public/, '');
-    } //
     // Set client side backend, if there is no custom backend
     //
-
-
     if (!hasCustomBackend) {
-      combinedConfig.backend = {
-        addPath: `${clientLocalePath}/${localeStructure}.missing.${localeExtension}`,
-        loadPath: `${clientLocalePath}/${localeStructure}.${localeExtension}`
-      };
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: `${localePath}/${localeStructure}.missing.${localeExtension}`,
+          loadPath: `${localePath}/${localeStructure}.${localeExtension}`
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: (locale, namespace) => localePath(locale, namespace, true),
+          loadPath: (locale, namespace) => localePath(locale, namespace, false)
+        };
+      }
     }
 
     if (typeof combinedConfig.ns !== 'string' && !Array.isArray(combinedConfig.ns)) {

package/dist/es/createClient/browser.js

@@ -4,7 +4,9 @@ export default (config => {
   let initPromise;
 
   if (!instance.isInitialized) {
-    config?.use?.forEach(x => instance.use(x));
+    var _config$use;
+
+    config === null || config === void 0 ? void 0 : (_config$use = config.use) === null || _config$use === void 0 ? void 0 : _config$use.forEach(x => instance.use(x));
     initPromise = instance.init(config);
   } else {
     initPromise = Promise.resolve(i18n.t);

package/dist/es/createClient/node.js

@@ -16,13 +16,15 @@ export default (config => {
   let initPromise;
 
   if (!instance.isInitialized) {
-    const hasCustomBackend = config?.use?.some(b => b.type === 'backend');
+    var _config$use, _config$use2;
+
+    const hasCustomBackend = config === null || config === void 0 ? void 0 : (_config$use = config.use) === null || _config$use === void 0 ? void 0 : _config$use.some(b => b.type === 'backend');
 
     if (!hasCustomBackend) {
       instance.use(i18nextFSBackend);
     }
 
-    config?.use?.forEach(x => instance.use(x));
+    config === null || config === void 0 ? void 0 : (_config$use2 = config.use) === null || _config$use2 === void 0 ? void 0 : _config$use2.forEach(x => instance.use(x));
     initPromise = instance.init(config);
   } else {
     initPromise = Promise.resolve(i18n.t);

package/dist/es/serverSideTranslations.js

@@ -57,7 +57,7 @@ export const serverSideTranslations = async (initialLocale, namespacesRequired =
   } = config;
 
   if (reloadOnPrerender) {
-    await globalI18n?.reloadResources();
+    await (globalI18n === null || globalI18n === void 0 ? void 0 : globalI18n.reloadResources());
   }
 
   const {
@@ -75,6 +75,10 @@ export const serverSideTranslations = async (initialLocale, namespacesRequired =
   });
 
   if (!Array.isArray(namespacesRequired)) {
+    if (typeof localePath === 'function') {
+      throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
+    }
+
     const getLocaleNamespaces = path => fs.readdirSync(path).map(file => file.replace(`.${localeExtension}`, ''));
 
     const namespacesByLocale = Object.keys(initialI18nStore).map(locale => getLocaleNamespaces(path.resolve(process.cwd(), `${localePath}/${locale}`)));

package/dist/esm/appWithTranslation.js

@@ -17,9 +17,11 @@ export var appWithTranslation = function appWithTranslation(WrappedComponent) {
   var configOverride = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
 
   var AppWithTranslation = function AppWithTranslation(props) {
+    var _nextI18Next$initialL;
+
     var _ref = props.pageProps,
         _nextI18Next = _ref._nextI18Next;
-    var locale = null; // Memoize the instance and only re-initialize when either:
+    var locale = (_nextI18Next$initialL = _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) !== null && _nextI18Next$initialL !== void 0 ? _nextI18Next$initialL : null; // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
 
@@ -28,9 +30,8 @@ export var appWithTranslation = function appWithTranslation(WrappedComponent) {
 
       if (!_nextI18Next) return null;
       var userConfig = _nextI18Next.userConfig;
-      var initialI18nStore = _nextI18Next.initialI18nStore,
-          initialLocale = _nextI18Next.initialLocale;
-      locale = initialLocale;
+      var initialI18nStore = _nextI18Next.initialI18nStore;
+      var resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
 
       if (userConfig === null && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
@@ -48,7 +49,7 @@ export var appWithTranslation = function appWithTranslation(WrappedComponent) {
         lng: locale
       }))), {}, {
         lng: locale,
-        resources: initialI18nStore
+        resources: resources
       })).i18n;
       globalI18n = instance;
       return instance;

package/dist/esm/config/createConfig.js

@@ -1,7 +1,9 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _typeof from "@babel/runtime/helpers/typeof";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["i18n"],
+    _excluded2 = ["i18n"];
 
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 
@@ -26,10 +28,10 @@ export var createConfig = function createConfig(userConfig) {
 
 
   var userI18n = userConfig.i18n,
-      userConfigStripped = _objectWithoutProperties(userConfig, ["i18n"]);
+      userConfigStripped = _objectWithoutProperties(userConfig, _excluded);
 
   var defaultI18n = defaultConfig.i18n,
-      defaultConfigStripped = _objectWithoutProperties(defaultConfig, ["i18n"]);
+      defaultConfigStripped = _objectWithoutProperties(defaultConfig, _excluded2);
 
   var combinedConfig = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, defaultConfigStripped), userConfigStripped), defaultI18n), userI18n);
 
@@ -62,39 +64,66 @@ export var createConfig = function createConfig(userConfig) {
     if (!hasCustomBackend) {
       var fs = require('fs');
 
-      var path = require('path');
-
-      var serverLocalePath = localePath; //
+      var path = require('path'); //
       // Validate defaultNS
       // https://github.com/isaachinman/next-i18next/issues/358
       //
 
+
       if (typeof defaultNS === 'string' && typeof lng !== 'undefined') {
-        var _userConfig$interpola, _userConfig$interpola2, _userConfig$interpola3, _userConfig$interpola4;
+        if (typeof localePath === 'string') {
+          var _userConfig$interpola, _userConfig$interpola2, _userConfig$interpola3, _userConfig$interpola4;
+
+          var prefix = (_userConfig$interpola = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola2 = userConfig.interpolation) === null || _userConfig$interpola2 === void 0 ? void 0 : _userConfig$interpola2.prefix) !== null && _userConfig$interpola !== void 0 ? _userConfig$interpola : '{{';
+          var suffix = (_userConfig$interpola3 = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola4 = userConfig.interpolation) === null || _userConfig$interpola4 === void 0 ? void 0 : _userConfig$interpola4.suffix) !== null && _userConfig$interpola3 !== void 0 ? _userConfig$interpola3 : '}}';
+          var defaultLocaleStructure = localeStructure.replace("".concat(prefix, "lng").concat(suffix), lng).replace("".concat(prefix, "ns").concat(suffix), defaultNS);
+          var defaultFile = "/".concat(defaultLocaleStructure, ".").concat(localeExtension);
+          var defaultNSPath = path.join(localePath, defaultFile);
+          var defaultNSExists = fs.existsSync(defaultNSPath);
+
+          if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error("Default namespace not found at ".concat(defaultNSPath));
+          }
+        } else if (typeof localePath === 'function') {
+          var _defaultNSPath = localePath(lng, defaultNS, false);
 
-        var prefix = (_userConfig$interpola = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola2 = userConfig.interpolation) === null || _userConfig$interpola2 === void 0 ? void 0 : _userConfig$interpola2.prefix) !== null && _userConfig$interpola !== void 0 ? _userConfig$interpola : '{{';
-        var suffix = (_userConfig$interpola3 = userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$interpola4 = userConfig.interpolation) === null || _userConfig$interpola4 === void 0 ? void 0 : _userConfig$interpola4.suffix) !== null && _userConfig$interpola3 !== void 0 ? _userConfig$interpola3 : '}}';
-        var defaultLocaleStructure = localeStructure.replace("".concat(prefix, "lng").concat(suffix), lng).replace("".concat(prefix, "ns").concat(suffix), defaultNS);
-        var defaultFile = "/".concat(defaultLocaleStructure, ".").concat(localeExtension);
-        var defaultNSPath = path.join(localePath, defaultFile);
-        var defaultNSExists = fs.existsSync(defaultNSPath);
+          var _defaultNSExists = fs.existsSync(_defaultNSPath);
 
-        if (!defaultNSExists && process.env.NODE_ENV !== 'production') {
-          throw new Error("Default namespace not found at ".concat(defaultNSPath));
+          if (!_defaultNSExists && process.env.NODE_ENV !== 'production') {
+            throw new Error("Default namespace not found at ".concat(_defaultNSPath));
+          }
         }
       } //
       // Set server side backend
       //
 
 
-      combinedConfig.backend = {
-        addPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension)),
-        loadPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".").concat(localeExtension))
-      }; //
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: path.resolve(process.cwd(), "".concat(localePath, "/").concat(localeStructure, ".missing.").concat(localeExtension)),
+          loadPath: path.resolve(process.cwd(), "".concat(localePath, "/").concat(localeStructure, ".").concat(localeExtension))
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: function addPath(locale, namespace) {
+            return localePath(locale, namespace, true);
+          },
+          loadPath: function loadPath(locale, namespace) {
+            return localePath(locale, namespace, false);
+          }
+        };
+      } else {
+        throw new Error("Unsupported localePath type: ".concat(_typeof(localePath)));
+      } //
       // Set server side preload (namespaces)
       //
 
+
       if (!combinedConfig.ns && typeof lng !== 'undefined') {
+        if (typeof localePath === 'function') {
+          throw new Error('Must provide all namespaces in ns option if using a function as localePath');
+        }
+
         var unique = function unique(list) {
           return Array.from(new Set(list));
         };
@@ -107,7 +136,7 @@ export var createConfig = function createConfig(userConfig) {
           };
 
           var namespacesByLocale = locales.map(function (locale) {
-            return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(locale)));
+            return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
           });
           var allNamespaces = [];
 
@@ -151,22 +180,25 @@ export var createConfig = function createConfig(userConfig) {
       }
     }
   } else {
-    var clientLocalePath = localePath; //
-    // Remove public prefix from client site config
     //
-
-    if (localePath.match(/^\.?\/public\//)) {
-      clientLocalePath = localePath.replace(/^\.?\/public/, '');
-    } //
     // Set client side backend, if there is no custom backend
     //
-
-
     if (!hasCustomBackend) {
-      combinedConfig.backend = {
-        addPath: "".concat(clientLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension),
-        loadPath: "".concat(clientLocalePath, "/").concat(localeStructure, ".").concat(localeExtension)
-      };
+      if (typeof localePath === 'string') {
+        combinedConfig.backend = {
+          addPath: "".concat(localePath, "/").concat(localeStructure, ".missing.").concat(localeExtension),
+          loadPath: "".concat(localePath, "/").concat(localeStructure, ".").concat(localeExtension)
+        };
+      } else if (typeof localePath === 'function') {
+        combinedConfig.backend = {
+          addPath: function addPath(locale, namespace) {
+            return localePath(locale, namespace, true);
+          },
+          loadPath: function loadPath(locale, namespace) {
+            return localePath(locale, namespace, false);
+          }
+        };
+      }
     }
 
     if (typeof combinedConfig.ns !== 'string' && !Array.isArray(combinedConfig.ns)) {

package/dist/esm/serverSideTranslations.js

@@ -1,8 +1,8 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _typeof from "@babel/runtime/helpers/typeof";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -140,19 +140,31 @@ export var serverSideTranslations = /*#__PURE__*/function () {
               initialI18nStore[lng] = {};
             });
 
-            if (!Array.isArray(namespacesRequired)) {
-              getLocaleNamespaces = function getLocaleNamespaces(path) {
-                return fs.readdirSync(path).map(function (file) {
-                  return file.replace(".".concat(localeExtension), '');
-                });
-              };
+            if (Array.isArray(namespacesRequired)) {
+              _context.next = 27;
+              break;
+            }
 
-              namespacesByLocale = Object.keys(initialI18nStore).map(function (locale) {
-                return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
-              });
-              namespacesRequired = flatNamespaces(namespacesByLocale);
+            if (!(typeof localePath === 'function')) {
+              _context.next = 24;
+              break;
             }
 
+            throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
+
+          case 24:
+            getLocaleNamespaces = function getLocaleNamespaces(path) {
+              return fs.readdirSync(path).map(function (file) {
+                return file.replace(".".concat(localeExtension), '');
+              });
+            };
+
+            namespacesByLocale = Object.keys(initialI18nStore).map(function (locale) {
+              return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
+            });
+            namespacesRequired = flatNamespaces(namespacesByLocale);
+
+          case 27:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -166,7 +178,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
               }
             });
 
-          case 24:
+          case 29:
           case "end":
             return _context.stop();
         }

package/dist/types/types.d.ts

@@ -8,7 +8,7 @@ declare type NextJsI18NConfig = {
 export declare type UserConfig = {
     i18n: NextJsI18NConfig;
     localeExtension?: string;
-    localePath?: string;
+    localePath?: string | ((locale: string, namespace: string, missing: boolean) => string);
     localeStructure?: string;
     reloadOnPrerender?: boolean;
     serializeConfig?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "10.2.0",
+  "version": "10.5.0",
   "repository": "git@github.com:isaachinman/next-i18next.git",
   "author": "Isaac Hinman <isaac@isaachinman.com>",
   "funding": {
@@ -72,7 +72,7 @@
     "@babel/preset-env": "^7.10.4",
     "@babel/preset-react": "^7.10.4",
     "@babel/preset-typescript": "^7.10.4",
-    "@testing-library/react": "^11.2.5",
+    "@testing-library/react": "^12.1.3",
     "@types/i18next-fs-backend": "^1.1.2",
     "@types/jest": "^27.0.1",
     "@types/node": "^16.7.1",
@@ -96,7 +96,7 @@
     "eslint-plugin-typescript-sort-keys": "^2.1.0",
     "husky": "^3.0.0",
     "jest": "^26.6.3",
-    "next": "^10.0.4",
+    "next": "^12.1.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "start-server-and-test": "^1.12.0",
@@ -107,9 +107,9 @@
     "@types/hoist-non-react-statics": "^3.3.1",
     "core-js": "^3",
     "hoist-non-react-statics": "^3.2.0",
-    "i18next": "^21.5.3",
+    "i18next": "^21.6.12",
     "i18next-fs-backend": "^1.0.7",
-    "react-i18next": "^11.8.13"
+    "react-i18next": "^11.15.5"
   },
   "peerDependencies": {
     "next": ">= 10.0.0",

package/vercel.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "silent": true
+  }
+}