next-i18next 13.2.2 → 13.3.0

package/README.md

@@ -5,11 +5,14 @@
 [![npm version](https://img.shields.io/npm/v/next-i18next.svg?style=flat-square)](https://www.npmjs.com/package/next-i18next)
 ![npm](https://img.shields.io/npm/dw/next-i18next)
 
-**The easiest way to translate your Next.js apps.**
+**The easiest way to translate your Next.js apps *(with pages setup)*.**
 
-If you are using next-i18next in production and like to unleash some super powers, you may have a look at [this blog post](https://locize.com/blog/next-i18next/).
+If you are using next-i18next *(pages directory)* in production and like to unleash some super powers, you may have a look at [this blog post](https://locize.com/blog/next-i18next/).
 [![](https://locize.com/blog/next-i18next/next-i18next.jpg)](https://locize.com/blog/next-i18next/)
 
+If you're using Next.js 13 with app directory, there is no need for next-i18next, you can directly use i18next and react-i18next, like described [in this blog post](https://locize.com/blog/next-13-app-dir-i18n/).
+[![](https://locize.com/blog/next-13-app-dir-i18n/next-13-app-dir-i18n.jpg)](https://locize.com/blog/next-13-app-dir-i18n/)
+
 ## What is this?
 
 Although Next.js [provides internationalised routing directly](https://nextjs.org/docs/advanced-features/i18n-routing), it does not handle any management of translation content, or the actual translation functionality itself. All Next.js does is keep your locales and URLs in sync.
@@ -74,6 +77,7 @@ This tells `next-i18next` what your `defaultLocale` and other locales are, so th
 #### `next-i18next.config.js`
 
 ```js
+/** @type {import('next-i18next').UserConfig} */
 module.exports = {
   i18n: {
     defaultLocale: 'en',
@@ -234,7 +238,7 @@ module.exports = {
     typeof window === 'undefined'
       ? require('path').resolve('./my-custom/path')
       : '/public/my-custom/path',
-  ns: ['common']
+  ns: ['common'],
 }
 ```
 
@@ -339,6 +343,7 @@ For example, if you want to use `{` and `}` the config would look like this:
 If you want to change the default config path, you can set the environment variable `I18NEXT_DEFAULT_CONFIG_PATH`.
 
 For example, inside the `.env` file you can set a static path:
+
 ```
 I18NEXT_DEFAULT_CONFIG_PATH=/path/to/project/apps/my-app/next-i18next.config.js
 ```
@@ -403,7 +408,6 @@ But there's a way to workaround that with the help of [next-language-detector](h
 Check out [this blog post](https://locize.com/blog/next-i18n-static/) and [this example project](./examples/ssg/).
 [![](https://locize.com/blog/next-i18n-static/title.jpg)](https://locize.com/blog/next-i18n-static/)
 
-
 ### Translate in child components
 
 You have multiple ways to use the t function in your child component:
@@ -413,7 +417,7 @@ You have multiple ways to use the t function in your child component:
 3. Use the [`useTranslation`](https://react.i18next.com/latest/usetranslation-hook) function, like in this example: https://github.com/i18next/next-i18next/blob/e6b5085b5e92004afa9516bd444b19b2c8cf5758/examples/simple/components/Footer.tsx#L6
 4. Use the [`withTranslation`](https://react.i18next.com/latest/withtranslation-hoc) function
 
-*And in general, you always needs to be sure serverSideTranslations contains all namespaces you need in the tree.*
+_And in general, you always needs to be sure serverSideTranslations contains all namespaces you need in the tree._
 
 ## Contributors
 

package/dist/commonjs/serverSideTranslations.js

@@ -19,6 +19,7 @@ exports.serverSideTranslations = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 require("core-js/modules/es.object.to-string.js");
 require("core-js/modules/es.promise.js");
+require("core-js/modules/es.array.some.js");
 require("core-js/modules/es.array.for-each.js");
 require("core-js/modules/web.dom-collections.for-each.js");
 require("core-js/modules/es.array.concat.js");
@@ -54,6 +55,7 @@ if (process.env.I18NEXT_DEFAULT_CONFIG_PATH) {
 }
 var serverSideTranslations = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(initialLocale) {
+    var _userConfig, _userConfig$use;
     var namespacesRequired,
       configOverride,
       extraLocales,
@@ -67,6 +69,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
       _createClient,
       i18n,
       initPromise,
+      hasCustomBackend,
       initialI18nStore,
       getLocaleNamespaces,
       namespacesByLocale,
@@ -120,20 +123,30 @@ var serverSideTranslations = /*#__PURE__*/function () {
             _context.next = 21;
             return initPromise;
           case 21:
+            hasCustomBackend = (_userConfig = userConfig) === null || _userConfig === void 0 ? void 0 : (_userConfig$use = _userConfig.use) === null || _userConfig$use === void 0 ? void 0 : _userConfig$use.some(function (b) {
+              return b.type === 'backend';
+            });
+            if (!(hasCustomBackend && namespacesRequired)) {
+              _context.next = 25;
+              break;
+            }
+            _context.next = 25;
+            return i18n.loadNamespaces(namespacesRequired);
+          case 25:
             initialI18nStore = (0, _defineProperty2["default"])({}, initialLocale, {});
             (0, _utils.getFallbackForLng)(initialLocale, fallbackLng !== null && fallbackLng !== void 0 ? fallbackLng : false).concat(extraLocales || []).forEach(function (lng) {
               initialI18nStore[lng] = {};
             });
             if (Array.isArray(namespacesRequired)) {
-              _context.next = 29;
+              _context.next = 33;
               break;
             }
             if (!(typeof localePath === 'function')) {
-              _context.next = 26;
+              _context.next = 30;
               break;
             }
             throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
-          case 26:
+          case 30:
             getLocaleNamespaces = function getLocaleNamespaces(path) {
               return _fs["default"].existsSync(path) ? _fs["default"].readdirSync(path).map(function (file) {
                 return file.replace(".".concat(localeExtension), '');
@@ -143,7 +156,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
               return getLocaleNamespaces(_path["default"].resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
             }).flat();
             namespacesRequired = (0, _utils.unique)(namespacesByLocale);
-          case 29:
+          case 33:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -157,7 +170,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
                 userConfig: config.serializeConfig ? userConfig : null
               }
             });
-          case 31:
+          case 35:
           case "end":
             return _context.stop();
         }

package/dist/es/serverSideTranslations.js

@@ -48,6 +48,10 @@ export const serverSideTranslations = async (initialLocale, namespacesRequired =
     lng: initialLocale
   });
   await initPromise;
+  const hasCustomBackend = userConfig?.use?.some(b => b.type === 'backend');
+  if (hasCustomBackend && namespacesRequired) {
+    await i18n.loadNamespaces(namespacesRequired);
+  }
   const initialI18nStore = {
     [initialLocale]: {}
   };

package/dist/esm/serverSideTranslations.js

@@ -22,6 +22,7 @@ if (process.env.I18NEXT_DEFAULT_CONFIG_PATH) {
 }
 export var serverSideTranslations = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(initialLocale) {
+    var _userConfig, _userConfig$use;
     var namespacesRequired,
       configOverride,
       extraLocales,
@@ -35,6 +36,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
       _createClient,
       i18n,
       initPromise,
+      hasCustomBackend,
       initialI18nStore,
       getLocaleNamespaces,
       namespacesByLocale,
@@ -86,20 +88,30 @@ export var serverSideTranslations = /*#__PURE__*/function () {
             _context.next = 21;
             return initPromise;
           case 21:
+            hasCustomBackend = (_userConfig = userConfig) === null || _userConfig === void 0 ? void 0 : (_userConfig$use = _userConfig.use) === null || _userConfig$use === void 0 ? void 0 : _userConfig$use.some(function (b) {
+              return b.type === 'backend';
+            });
+            if (!(hasCustomBackend && namespacesRequired)) {
+              _context.next = 25;
+              break;
+            }
+            _context.next = 25;
+            return i18n.loadNamespaces(namespacesRequired);
+          case 25:
             initialI18nStore = _defineProperty({}, initialLocale, {});
             getFallbackForLng(initialLocale, fallbackLng !== null && fallbackLng !== void 0 ? fallbackLng : false).concat(extraLocales || []).forEach(function (lng) {
               initialI18nStore[lng] = {};
             });
             if (Array.isArray(namespacesRequired)) {
-              _context.next = 29;
+              _context.next = 33;
               break;
             }
             if (!(typeof localePath === 'function')) {
-              _context.next = 26;
+              _context.next = 30;
               break;
             }
             throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
-          case 26:
+          case 30:
             getLocaleNamespaces = function getLocaleNamespaces(path) {
               return fs.existsSync(path) ? fs.readdirSync(path).map(function (file) {
                 return file.replace(".".concat(localeExtension), '');
@@ -109,7 +121,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
               return getLocaleNamespaces(path.resolve(process.cwd(), "".concat(localePath, "/").concat(locale)));
             }).flat();
             namespacesRequired = unique(namespacesByLocale);
-          case 29:
+          case 33:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -123,7 +135,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
                 userConfig: config.serializeConfig ? userConfig : null
               }
             });
-          case 31:
+          case 35:
           case "end":
             return _context.stop();
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "13.2.2",
+  "version": "13.3.0",
   "repository": "git@github.com:i18next/next-i18next.git",
   "author": "i18next",
   "funding": [
@@ -36,6 +36,7 @@
     "locale"
   ],
   "scripts": {
+    "prettier": "prettier --ignore-path .gitignore --write .",
     "lint": "eslint src examples",
     "clean": "rm -rf ./examples/simple/.next ./examples/ssg/.next ./dist && mkdir dist",
     "build:es": "BABEL_ENV=es babel src --extensions '.ts,.tsx' --out-dir dist/es --copy-files",
@@ -113,8 +114,8 @@
     "gh-release": "7.0.2",
     "husky": "^8.0.3",
     "i18next": "^22.4.10",
-    "jest": "^29.4.2",
-    "jest-environment-jsdom": "^29.4.2",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "next": "^13.1.6",
     "npm-run-all": "^4.1.5",
     "prettier": "2.8.3",

package/prettier.config.js

@@ -6,13 +6,13 @@
 
 module.exports = {
   // These settings are duplicated in .editorconfig:
-  tabWidth: 2, // indent_size = 2
-  useTabs: false, // indent_style = space
+  arrowParens: 'avoid',
+  bracketSpacing: true,
   endOfLine: 'lf', // end_of_line = lf
+  printWidth: 69, // default: 80
   semi: false, // default: true
   singleQuote: true, // default: false
-  printWidth: 69, // default: 80
+  tabWidth: 2, // indent_size = 2
   trailingComma: 'es5',
-  bracketSpacing: true,
-  arrowParens: 'avoid',
+  useTabs: false, // indent_style = space
 }