next-i18next 10.3.0 → 11.0.0

package/README.md

@@ -153,7 +153,7 @@ export const Footer = () => {
 
 By default, `next-i18next` will send _all your namespaces_ down to the client on each initial request. This can be an appropriate approach for smaller apps with less content, but a lot of apps will benefit from splitting namespaces based on route.
 
-To do that, you can pass an array of required namespaces for each page into `serverSideTranslations`. You can see this approach in [examples/simple/pages/index.js](./examples/simple/pages/index.js). Passing in an empty array of required namespaces will send no namespaces. 
+To do that, you can pass an array of required namespaces for each page into `serverSideTranslations`. You can see this approach in [examples/simple/pages/index.js](./examples/simple/pages/index.js). Passing in an empty array of required namespaces will send no namespaces.
 
 Note: `useTranslation` provides namespaces to the component that you use it in. However, `serverSideTranslations` provides the total available namespaces to the entire React tree and belongs on the page level. Both are required.
 
@@ -213,6 +213,12 @@ export const getStaticProps = async ({ locale }) => ({
 });
 ```
 
+#### Client side loading of translations via HTTP
+
+Since v11.0.0 next-i18next also provides support for client side loading of translations.
+
+More information about that can be found [here](https://github.com/i18next/i18next-http-backend/tree/master/example/next).
+
 #### Reloading Resources in Development
 
 Because resources are loaded once when the server is started, any changes made to your translation JSON files in development will not be loaded until the server is restarted.
@@ -223,18 +229,20 @@ 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) | `[]`                 |
-
-All other [i18next options](https://www.i18next.com/overview/configuration-options) can be passed in as well.
+| 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) and [react-i18next options](https://react.i18next.com/latest/i18next-instance) can be passed in as well.
 
 #### Loading Namespaces Dynamically Client Side
 

package/dist/commonjs/appWithTranslation.js

@@ -86,22 +86,22 @@ 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 _nextI18Next$initialL, _props$router;
 
     var _ref = props.pageProps,
         _nextI18Next = _ref._nextI18Next;
-    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:
+    var locale = (_nextI18Next$initialL = _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) !== null && _nextI18Next$initialL !== void 0 ? _nextI18Next$initialL : props === null || props === void 0 ? void 0 : (_props$router = props.router) === null || _props$router === void 0 ? void 0 : _props$router.locale; // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
+    // 3. UserConfig override changes
 
     var i18n = (0, _react.useMemo)(function () {
-      var _userConfig;
+      var _userConfig, _userConfig2, _userConfig2$i18n;
 
-      if (!_nextI18Next) return null;
-      var userConfig = _nextI18Next.userConfig;
-      var initialI18nStore = _nextI18Next.initialI18nStore;
+      if (!_nextI18Next && !configOverride) return null;
+      var userConfig = configOverride !== null && configOverride !== void 0 ? configOverride : _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.userConfig;
 
-      if (userConfig === null && configOverride === null) {
+      if (!userConfig && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
       }
 
@@ -113,15 +113,24 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
         throw new Error('appWithTranslation was called without config.i18n');
       }
 
+      if (!((_userConfig2 = userConfig) !== null && _userConfig2 !== void 0 && (_userConfig2$i18n = _userConfig2.i18n) !== null && _userConfig2$i18n !== void 0 && _userConfig2$i18n.defaultLocale)) {
+        throw new Error('config.i18n does not include a defaultLocale property');
+      }
+
+      var _ref2 = _nextI18Next || {},
+          initialI18nStore = _ref2.initialI18nStore;
+
+      var resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
+      if (!locale) locale = userConfig.i18n.defaultLocale;
       var instance = (0, _createClient["default"])(_objectSpread(_objectSpread({}, (0, _createConfig.createConfig)(_objectSpread(_objectSpread({}, userConfig), {}, {
         lng: locale
       }))), {}, {
         lng: locale,
-        resources: initialI18nStore
+        resources: resources
       })).i18n;
       exports.globalI18n = globalI18n = instance;
       return instance;
-    }, [_nextI18Next, locale]);
+    }, [_nextI18Next, locale, configOverride]);
     return i18n !== null ? __jsx(_reactI18next.I18nextProvider, {
       i18n: i18n
     }, __jsx(WrappedComponent, (0, _extends2["default"])({

package/dist/commonjs/config/createConfig.js

@@ -61,14 +61,12 @@ 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"));
@@ -136,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));
         };
@@ -181,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 = [];
 
@@ -225,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

@@ -9,25 +9,23 @@ export { Trans, useTranslation, withTranslation } from 'react-i18next';
 export let globalI18n = null;
 export const appWithTranslation = (WrappedComponent, configOverride = null) => {
   const AppWithTranslation = props => {
+    var _props$router;
+
     const {
       _nextI18Next
     } = props.pageProps;
-    const locale = (_nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) ?? null; // Memoize the instance and only re-initialize when either:
+    let locale = (_nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) ?? (props === null || props === void 0 ? void 0 : (_props$router = props.router) === null || _props$router === void 0 ? void 0 : _props$router.locale); // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
+    // 3. UserConfig override changes
 
     const i18n = useMemo(() => {
-      var _userConfig;
+      var _userConfig, _userConfig2, _userConfig2$i18n;
 
-      if (!_nextI18Next) return null;
-      let {
-        userConfig
-      } = _nextI18Next;
-      const {
-        initialI18nStore
-      } = _nextI18Next;
+      if (!_nextI18Next && !configOverride) return null;
+      let userConfig = configOverride ?? (_nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.userConfig);
 
-      if (userConfig === null && configOverride === null) {
+      if (!userConfig && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
       }
 
@@ -39,15 +37,24 @@ export const appWithTranslation = (WrappedComponent, configOverride = null) => {
         throw new Error('appWithTranslation was called without config.i18n');
       }
 
+      if (!((_userConfig2 = userConfig) !== null && _userConfig2 !== void 0 && (_userConfig2$i18n = _userConfig2.i18n) !== null && _userConfig2$i18n !== void 0 && _userConfig2$i18n.defaultLocale)) {
+        throw new Error('config.i18n does not include a defaultLocale property');
+      }
+
+      const {
+        initialI18nStore
+      } = _nextI18Next || {};
+      const resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
+      if (!locale) locale = userConfig.i18n.defaultLocale;
       const instance = createClient({ ...createConfig({ ...userConfig,
           lng: locale
         }),
         lng: locale,
-        resources: initialI18nStore
+        resources
       }).i18n;
       globalI18n = instance;
       return instance;
-    }, [_nextI18Next, locale]);
+    }, [_nextI18Next, locale, configOverride]);
     return i18n !== null ? /*#__PURE__*/React.createElement(I18nextProvider, {
       i18n: i18n
     }, /*#__PURE__*/React.createElement(WrappedComponent, _extends({

package/dist/es/config/createConfig.js

@@ -52,45 +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') {
-        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 (typeof defaultNS === 'string' && typeof lng !== 'undefined') {
+        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}`);
+          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) {
@@ -121,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/serverSideTranslations.js

@@ -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,22 +17,22 @@ 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 _nextI18Next$initialL, _props$router;
 
     var _ref = props.pageProps,
         _nextI18Next = _ref._nextI18Next;
-    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:
+    var locale = (_nextI18Next$initialL = _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.initialLocale) !== null && _nextI18Next$initialL !== void 0 ? _nextI18Next$initialL : props === null || props === void 0 ? void 0 : (_props$router = props.router) === null || _props$router === void 0 ? void 0 : _props$router.locale; // Memoize the instance and only re-initialize when either:
     // 1. The route changes (non-shallowly)
     // 2. Router locale changes
+    // 3. UserConfig override changes
 
     var i18n = useMemo(function () {
-      var _userConfig;
+      var _userConfig, _userConfig2, _userConfig2$i18n;
 
-      if (!_nextI18Next) return null;
-      var userConfig = _nextI18Next.userConfig;
-      var initialI18nStore = _nextI18Next.initialI18nStore;
+      if (!_nextI18Next && !configOverride) return null;
+      var userConfig = configOverride !== null && configOverride !== void 0 ? configOverride : _nextI18Next === null || _nextI18Next === void 0 ? void 0 : _nextI18Next.userConfig;
 
-      if (userConfig === null && configOverride === null) {
+      if (!userConfig && configOverride === null) {
         throw new Error('appWithTranslation was called without a next-i18next config');
       }
 
@@ -44,15 +44,24 @@ export var appWithTranslation = function appWithTranslation(WrappedComponent) {
         throw new Error('appWithTranslation was called without config.i18n');
       }
 
+      if (!((_userConfig2 = userConfig) !== null && _userConfig2 !== void 0 && (_userConfig2$i18n = _userConfig2.i18n) !== null && _userConfig2$i18n !== void 0 && _userConfig2$i18n.defaultLocale)) {
+        throw new Error('config.i18n does not include a defaultLocale property');
+      }
+
+      var _ref2 = _nextI18Next || {},
+          initialI18nStore = _ref2.initialI18nStore;
+
+      var resources = configOverride !== null && configOverride !== void 0 && configOverride.resources ? configOverride.resources : initialI18nStore;
+      if (!locale) locale = userConfig.i18n.defaultLocale;
       var instance = createClient(_objectSpread(_objectSpread({}, createConfig(_objectSpread(_objectSpread({}, userConfig), {}, {
         lng: locale
       }))), {}, {
         lng: locale,
-        resources: initialI18nStore
+        resources: resources
       })).i18n;
       globalI18n = instance;
       return instance;
-    }, [_nextI18Next, locale]);
+    }, [_nextI18Next, locale, configOverride]);
     return i18n !== null ? __jsx(I18nextProvider, {
       i18n: i18n
     }, __jsx(WrappedComponent, _extends({

package/dist/esm/config/createConfig.js

@@ -1,5 +1,5 @@
-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"],
@@ -64,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));
         };
@@ -109,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 = [];
 
@@ -153,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

@@ -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), '');
-                });
-              };
-
-              namespacesByLocale = Object.keys(initialI18nStore).map(function (locale) {
-                return getLocaleNamespaces(path.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.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.3.0",
+  "version": "11.0.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": "^11.1.3",
+    "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-fs-backend": "^1.0.7",
-    "react-i18next": "^11.8.13"
+    "i18next": "^21.6.14",
+    "i18next-fs-backend": "^1.1.4",
+    "react-i18next": "^11.16.2"
   },
   "peerDependencies": {
     "next": ">= 10.0.0",

package/vercel.json

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