next-i18next 3.0.1 → 4.2.1

package/README.md

@@ -73,7 +73,8 @@ It's recommended to export this `NextI18Next` instance from a single file in you
 
 After creating and exporting your `NextI18Next` instance, you need to take the following steps to get things working:
 
-1. Create an `_app.js` file inside your `pages` directory, and wrap it with the `NextI18Next.appWithTranslation` higher order component (HOC). You can see this approach in the [examples/simple/pages/_app.js](./examples/simple/pages/_app.js). 
+1. Create an `_app.js` file inside your `pages` directory, and wrap it with the `NextI18Next.appWithTranslation` higher order component (HOC). You can see this approach in the [examples/simple/pages/_app.js](./examples/simple/pages/_app.js).
+Your app component must either extend `App` if it's a class component or define a `getInitialProps` if it's a function component [(explanation here)](https://github.com/isaachinman/next-i18next/issues/615#issuecomment-575578375).
 2. Create a `server.js` file inside your root directory, initialise an [express](https://www.npmjs.com/package/express) server, and use the `nextI18NextMiddleware` middleware with your `nextI18Next` instance passed in. You can see this approach in the [examples/simple/server.js](./examples/simple/server.js).
 3. Update the scripts in `package.json` to:
 ```
@@ -87,6 +88,8 @@ After creating and exporting your `NextI18Next` instance, you need to take the f
 ```
 For more info, see [the NextJs section on custom servers](https://github.com/zeit/next.js#custom-server-and-routing).
 
+Note: You can pass `shallowRender: true` into config options to avoid triggering getInitialProps when `changeLanguage` method is invoked.
+
 That's it! Your app is ready to go. You can now use the `NextI18Next.withTranslation` HOC to make your components or pages translatable, based on namespaces:
 
 ```jsx
@@ -239,7 +242,7 @@ MyPage.getInitialProps = async({ req }) => {
 | `browserLanguageDetection`  | `true`  |
 | `defaultNS` | `'common'`  |
 | `defaultLanguage`  | `'en'`  |
-| `ignoreRoutes`  | `['/_next/', '/static/', '/public/']`  |
+| `ignoreRoutes`  | `['/_next/', '/static/', '/public/', '/api/']`  |
 | `otherLanguages` (required) | `[]`  |
 | `localeExtension` | `'json'`  |
 | `localePath` | `'public/static/locales'`  |
@@ -249,6 +252,7 @@ MyPage.getInitialProps = async({ req }) => {
 | `strictMode` | `true`  |
 | `use` (for plugins) | `[]`  |
 | `customDetectors` | `[]`  |
+| `shallowRender` | `false`  |
 
 _This table contains options which are specific to next-i18next. All other [i18next options](https://www.i18next.com/overview/configuration-options) can be passed in as well._
 

package/dist/commonjs/config/default-config.js

@@ -34,7 +34,7 @@ var defaultConfig = {
   },
   browserLanguageDetection: true,
   serverLanguageDetection: true,
-  ignoreRoutes: ['/_next/', '/static/', '/public/'],
+  ignoreRoutes: ['/_next/', '/static/', '/public/', '/api/'],
   customDetectors: [],
   detection: {
     lookupCookie: 'next-i18next',
@@ -47,6 +47,7 @@ var defaultConfig = {
   },
   strictMode: true,
   errorStackTraceLimit: 0,
+  shallowRender: false,
 
   get initImmediate() {
     return !(0, _utils.isServer)();

package/dist/commonjs/create-i18next-client.js

@@ -20,6 +20,8 @@ var _i18nextXhrBackend = _interopRequireDefault(require("i18next-xhr-backend"));
 var _i18nextBrowserLanguagedetector = _interopRequireDefault(require("i18next-browser-languagedetector"));
 
 var _default = function _default(config) {
+  var initPromise;
+
   if (!_i18next["default"].isInitialized) {
     if (_detectNode["default"]) {
       var i18nextNodeBackend = eval("require('i18next-node-fs-backend')");
@@ -51,11 +53,13 @@ var _default = function _default(config) {
     config.use.forEach(function (x) {
       return _i18next["default"].use(x);
     });
-
-    _i18next["default"].init(config);
+    initPromise = _i18next["default"].init(config);
   }
 
-  return _i18next["default"];
+  return {
+    i18n: _i18next["default"],
+    initPromise: initPromise
+  };
 };
 
 exports["default"] = _default;

package/dist/commonjs/hocs/app-with-translation.js

@@ -117,7 +117,9 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                 as = _lngPathCorrector.as,
                 href = _lngPathCorrector.href;
 
-            router.replace(href, as);
+            router.replace(href, as, {
+              shallow: config.shallowRender
+            });
           }
         };
 

package/dist/commonjs/index.js

@@ -43,6 +43,7 @@ var NextI18Next = function NextI18Next(userConfig) {
   (0, _defineProperty2["default"])(this, "Link", void 0);
   (0, _defineProperty2["default"])(this, "Router", void 0);
   (0, _defineProperty2["default"])(this, "i18n", void 0);
+  (0, _defineProperty2["default"])(this, "initPromise", void 0);
   (0, _defineProperty2["default"])(this, "config", void 0);
   (0, _defineProperty2["default"])(this, "useTranslation", void 0);
   (0, _defineProperty2["default"])(this, "withTranslation", void 0);
@@ -61,7 +62,12 @@ var NextI18Next = function NextI18Next(userConfig) {
     throw new Error('next-i18next has upgraded to react-i18next v10 - please rename withNamespaces to withTranslation.');
   };
 
-  this.i18n = (0, _createI18nextClient["default"])(this.config);
+  var _createI18NextClient = (0, _createI18nextClient["default"])(this.config),
+      i18n = _createI18NextClient.i18n,
+      initPromise = _createI18NextClient.initPromise;
+
+  this.i18n = i18n;
+  this.initPromise = initPromise;
   this.appWithTranslation = _hocs.appWithTranslation.bind(this);
 
   this.withTranslation = function (namespace, options) {

package/dist/es/config/default-config.js

@@ -22,7 +22,7 @@ export const defaultConfig = {
   },
   browserLanguageDetection: true,
   serverLanguageDetection: true,
-  ignoreRoutes: ['/_next/', '/static/', '/public/'],
+  ignoreRoutes: ['/_next/', '/static/', '/public/', '/api/'],
   customDetectors: [],
   detection: {
     lookupCookie: 'next-i18next',
@@ -35,6 +35,7 @@ export const defaultConfig = {
   },
   strictMode: true,
   errorStackTraceLimit: 0,
+  shallowRender: false,
 
   get initImmediate() {
     return !isServer();

package/dist/es/create-i18next-client.js

@@ -3,6 +3,8 @@ import i18n from 'i18next';
 import i18nextXHRBackend from 'i18next-xhr-backend';
 import I18nextBrowserLanguageDetector from 'i18next-browser-languagedetector';
 export default (config => {
+  let initPromise;
+
   if (!i18n.isInitialized) {
     if (isNode) {
       const i18nextNodeBackend = eval("require('i18next-node-fs-backend')");
@@ -25,8 +27,11 @@ export default (config => {
     }
 
     config.use.forEach(x => i18n.use(x));
-    i18n.init(config);
+    initPromise = i18n.init(config);
   }
 
-  return i18n;
+  return {
+    i18n,
+    initPromise
+  };
 });

package/dist/es/hocs/app-with-translation.js

@@ -44,7 +44,9 @@ export const appWithTranslation = function (WrappedComponent) {
               as: asPath,
               href: routeInfo
             }, newLng);
-            router.replace(href, as);
+            router.replace(href, as, {
+              shallow: config.shallowRender
+            });
           }
         };
 

package/dist/es/index.js

@@ -21,7 +21,12 @@ export default class NextI18Next {
       throw new Error('next-i18next has upgraded to react-i18next v10 - please rename withNamespaces to withTranslation.');
     };
 
-    this.i18n = createI18NextClient(this.config);
+    const {
+      i18n,
+      initPromise
+    } = createI18NextClient(this.config);
+    this.i18n = i18n;
+    this.initPromise = initPromise;
     this.appWithTranslation = appWithTranslation.bind(this);
 
     this.withTranslation = (namespace, options) => Component => hoistNonReactStatics(withTranslation(namespace, options)(Component), Component);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "3.0.1",
+  "version": "4.2.1",
   "repository": "git@github.com:isaachinman/next-i18next.git",
   "author": "Isaac Hinman <isaac@isaachinman.com>",
   "funding": {
@@ -103,7 +103,7 @@
     "core-js": "^2",
     "detect-node": "^2.0.4",
     "hoist-non-react-statics": "^3.2.0",
-    "i18next": "^18.0.1",
+    "i18next": "^19.0.3",
     "i18next-browser-languagedetector": "^4.0.0",
     "i18next-express-middleware": "^1.5.0",
     "i18next-node-fs-backend": "^2.1.0",

package/types.d.ts

@@ -9,7 +9,7 @@ import {
 } from 'react-i18next'
 import { LinkProps } from 'next/link'
 import { SingletonRouter } from 'next/router'
-import i18next from 'i18next'
+import { InitOptions, i18n, TFunction as I18NextTFunction } from 'i18next'
 
 export type InitConfig = {
   browserLanguageDetection?: boolean;
@@ -23,7 +23,8 @@ export type InitConfig = {
   localeSubpaths?: Record<string, string>;
   use?: any[];
   customDetectors?: any[];
-} & i18next.InitOptions
+  shallowRender?: boolean;
+} & InitOptions
 
 export type Config = {
   fallbackLng: boolean;
@@ -42,10 +43,11 @@ export type Link = React.ComponentClass<LinkProps>
 export type Router = SingletonRouter
 export type UseTranslation = typeof useTranslation
 export type AppWithTranslation = <P extends object>(Component: React.ComponentType<P> | React.ElementType<P>) => any
-export type TFunction = i18next.TFunction
-export type I18n = i18next.i18n
+export type TFunction = I18NextTFunction
+export type I18n = i18n
 export type WithTranslationHocType = typeof withTranslation
 export type WithTranslation = ReactI18nextWithTranslation
+export type InitPromise = Promise<TFunction>
 
 declare class NextI18Next {
   constructor(config: InitConfig);
@@ -53,6 +55,7 @@ declare class NextI18Next {
   Link: Link
   Router: Router
   i18n: I18n
+  initPromise: InitPromise
   config: Config
   useTranslation: UseTranslation
   withTranslation: WithTranslationHocType