next-i18next 5.0.0-beta.4 → 6.0.1

package/README.md

@@ -1,7 +1,6 @@
 # next-i18next
 [![npm version](https://badge.fury.io/js/next-i18next.svg)](https://badge.fury.io/js/next-i18next)
 [![CircleCI](https://circleci.com/gh/isaachinman/next-i18next.svg?style=shield)](https://circleci.com/gh/isaachinman/next-i18next)
-[![dependencies Status](https://david-dm.org/isaachinman/next-i18next/status.svg)](https://david-dm.org/isaachinman/next-i18next)
 [![Package Quality](https://npm.packagequality.com/shield/next-i18next.svg)](https://packagequality.com/#?package=next-i18next)
 
 **The easiest way to translate your NextJs apps.**
@@ -184,15 +183,12 @@ const SomeButton = () => (
 
 In many cases, you'll need to know the currently active language. Most of the time, to accomplish this, you should use the `withTranslation` HOC, which will pass an `i18n` prop to the wrapped component and further asserts your component will get re-rendered on language change or changes to the translation catalog itself (loaded translations). More info can be found [here](https://react.i18next.com/latest/withtranslation-hoc).
 
-If for some reason you need to access the current language inside `getInitialProps`, you'll need to switch over server and client contexts. For example:
+If for some reason you need to access the current language and `withTranslation` doesn't suit your needs, you can use the `I18nContext`:
 
 ```jsx
-// This is our initialised `NextI18Next` instance
-import { i18n } from '../i18n'
+import { I18nContext } from 'next-i18next'
 
-MyPage.getInitialProps = async({ req }) => {
-  const currentLanguage = req ? req.language : i18n.language
-}
+const { i18n: { language } } = useContext(I18nContext)
 ```
 
 ## Options
@@ -218,7 +214,7 @@ _This table contains options which are specific to next-i18next. All other [i18n
 
 ## Notes
 
-- [`next export` will result in a _client-side only_ React application.](https://github.com/isaachinman/next-i18next/issues/10)
+- [`next export` is not supported.](https://github.com/isaachinman/next-i18next/issues/780)
 - [To add a `lang` attribute to your top-level html DOM node, you must create a `_document.js` file.](https://github.com/isaachinman/next-i18next/issues/20#issuecomment-443461652)
 - [Localising `next/head` requires special consideration due to NextJs internals](https://github.com/isaachinman/next-i18next/issues/251#issuecomment-479421852).
 

package/babel.config.json

@@ -37,7 +37,7 @@
               "helpers": true,
               "regenerator": true,
               "useESModules": false
-            },
+            }
           }
         ]
       ],
@@ -76,6 +76,6 @@
           }
         ]
       ]
-    },
+    }
   }
 }

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

@@ -35,9 +35,10 @@ var defaultConfig = {
   ignoreRoutes: ['/_next/', '/static/', '/public/', '/api/'],
   customDetectors: [],
   detection: {
+    caches: ['cookie'],
+    cookieSameSite: 'strict',
     lookupCookie: 'next-i18next',
-    order: ['cookie', 'header', 'querystring'],
-    caches: ['cookie']
+    order: ['cookie', 'header', 'querystring']
   },
   react: {
     wait: true,

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

@@ -206,7 +206,7 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
       key: "getInitialProps",
       value: function () {
         var _getInitialProps = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(ctx) {
-          var wrappedComponentProps, _ctx$ctx, req, res, initialI18nStore, initialLanguage, i18nServerInstance, middlewares, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _loop, _iterator, _step, namespacesRequired, fallbackLng, languagesToLoad;
+          var _ctx$ctx, req, res, initialI18nStore, initialLanguage, i18nServerInstance, middlewares, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _loop, _iterator, _step, wrappedComponentProps, namespacesRequired, fallbackLng, languagesToLoad;
 
           return _regenerator["default"].wrap(function _callee2$(_context3) {
             while (1) {
@@ -216,30 +216,9 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                   return initPromise;
 
                 case 2:
-                  wrappedComponentProps = {
-                    pageProps: {}
-                  };
-
-                  if (!WrappedComponent.getInitialProps) {
-                    _context3.next = 7;
-                    break;
-                  }
-
-                  _context3.next = 6;
-                  return WrappedComponent.getInitialProps(ctx);
-
-                case 6:
-                  wrappedComponentProps = _context3.sent;
-
-                case 7:
-                  if (typeof wrappedComponentProps.pageProps === 'undefined') {
-                    consoleMessage('error', 'If you have a getInitialProps method in your custom _app.js file, you must explicitly return pageProps. For more information, see: https://github.com/zeit/next.js#custom-app');
-                  }
                   /*
                     Initiate vars to return
                   */
-
-
                   _ctx$ctx = ctx.ctx, req = _ctx$ctx.req, res = _ctx$ctx.res;
                   initialI18nStore = {};
                   initialLanguage = null;
@@ -249,7 +228,7 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                   */
 
                   if (!(req && res)) {
-                    _context3.next = 39;
+                    _context3.next = 33;
                     break;
                   }
 
@@ -257,7 +236,7 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                   _iteratorNormalCompletion = true;
                   _didIteratorError = false;
                   _iteratorError = undefined;
-                  _context3.prev = 17;
+                  _context3.prev = 11;
                   _loop = /*#__PURE__*/_regenerator["default"].mark(function _loop() {
                     var middleware;
                     return _regenerator["default"].wrap(function _loop$(_context2) {
@@ -279,54 +258,79 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                   });
                   _iterator = middlewares[Symbol.iterator]();
 
-                case 20:
+                case 14:
                   if (_iteratorNormalCompletion = (_step = _iterator.next()).done) {
-                    _context3.next = 25;
+                    _context3.next = 19;
                     break;
                   }
 
-                  return _context3.delegateYield(_loop(), "t0", 22);
+                  return _context3.delegateYield(_loop(), "t0", 16);
 
-                case 22:
+                case 16:
                   _iteratorNormalCompletion = true;
-                  _context3.next = 20;
+                  _context3.next = 14;
                   break;
 
-                case 25:
-                  _context3.next = 31;
+                case 19:
+                  _context3.next = 25;
                   break;
 
-                case 27:
-                  _context3.prev = 27;
-                  _context3.t1 = _context3["catch"](17);
+                case 21:
+                  _context3.prev = 21;
+                  _context3.t1 = _context3["catch"](11);
                   _didIteratorError = true;
                   _iteratorError = _context3.t1;
 
-                case 31:
-                  _context3.prev = 31;
-                  _context3.prev = 32;
+                case 25:
+                  _context3.prev = 25;
+                  _context3.prev = 26;
 
                   if (!_iteratorNormalCompletion && _iterator["return"] != null) {
                     _iterator["return"]();
                   }
 
-                case 34:
-                  _context3.prev = 34;
+                case 28:
+                  _context3.prev = 28;
 
                   if (!_didIteratorError) {
-                    _context3.next = 37;
+                    _context3.next = 31;
                     break;
                   }
 
                   throw _iteratorError;
 
+                case 31:
+                  return _context3.finish(28);
+
+                case 32:
+                  return _context3.finish(25);
+
+                case 33:
+                  /* Call getInitialProps on our wrapped _app */
+                  wrappedComponentProps = {
+                    pageProps: {}
+                  };
+
+                  if (!WrappedComponent.getInitialProps) {
+                    _context3.next = 38;
+                    break;
+                  }
+
+                  _context3.next = 37;
+                  return WrappedComponent.getInitialProps(ctx);
+
                 case 37:
-                  return _context3.finish(34);
+                  wrappedComponentProps = _context3.sent;
 
                 case 38:
-                  return _context3.finish(31);
+                  if (typeof wrappedComponentProps.pageProps === 'undefined') {
+                    consoleMessage('error', 'If you have a getInitialProps method in your custom _app.js file, you must explicitly return pageProps. For more information, see: https://github.com/zeit/next.js#custom-app');
+                  }
+                  /*
+                    Step 1: Determine initial language
+                  */
+
 
-                case 39:
                   if (!(req && req.i18n)) {
                     _context3.next = 45;
                     break;
@@ -439,7 +443,7 @@ var appWithTranslation = function appWithTranslation(WrappedComponent) {
                   return _context3.stop();
               }
             }
-          }, _callee2, null, [[17, 27, 31, 39], [32,, 34, 38]]);
+          }, _callee2, null, [[11, 21, 25, 33], [26,, 28, 32]]);
         }));
 
         return function getInitialProps(_x2) {

package/dist/commonjs/index.js

@@ -7,6 +7,12 @@ require("core-js/modules/es.function.bind");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "I18nContext", {
+  enumerable: true,
+  get: function get() {
+    return _reactI18next.I18nContext;
+  }
+});
 Object.defineProperty(exports, "withTranslation", {
   enumerable: true,
   get: function get() {
@@ -52,10 +58,6 @@ var NextI18Next = function NextI18Next(userConfig) {
   this.consoleMessage = _utils.consoleMessage.bind(this);
   /* Validation */
 
-  if (this.config.otherLanguages.length <= 0) {
-    throw new Error('To properly initialise a next-i18next instance you must provide one or more locale codes in config.otherLanguages.');
-  }
-
   this.withNamespaces = function () {
     throw new Error('next-i18next has upgraded to react-i18next v10 - please rename withNamespaces to withTranslation.');
   };

package/dist/commonjs/utils/is-server.js

@@ -1,16 +1,12 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isServer = void 0;
 
-var _detectNode = _interopRequireDefault(require("detect-node"));
-
 var isServer = function isServer() {
-  return _detectNode["default"] && typeof window === 'undefined';
+  return typeof window === 'undefined';
 };
 
 exports.isServer = isServer;

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

@@ -25,9 +25,10 @@ export const defaultConfig = {
   ignoreRoutes: ['/_next/', '/static/', '/public/', '/api/'],
   customDetectors: [],
   detection: {
+    caches: ['cookie'],
+    cookieSameSite: 'strict',
     lookupCookie: 'next-i18next',
-    order: ['cookie', 'header', 'querystring'],
-    caches: ['cookie']
+    order: ['cookie', 'header', 'querystring']
   },
   react: {
     wait: true,

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

@@ -73,22 +73,10 @@ export const appWithTranslation = function (WrappedComponent) {
 
     static async getInitialProps(ctx) {
       await initPromise;
-      let wrappedComponentProps = {
-        pageProps: {}
-      };
-
-      if (WrappedComponent.getInitialProps) {
-        wrappedComponentProps = await WrappedComponent.getInitialProps(ctx);
-      }
-
-      if (typeof wrappedComponentProps.pageProps === 'undefined') {
-        consoleMessage('error', 'If you have a getInitialProps method in your custom _app.js file, you must explicitly return pageProps. For more information, see: https://github.com/zeit/next.js#custom-app');
-      }
       /*
         Initiate vars to return
       */
 
-
       const {
         req,
         res
@@ -107,6 +95,20 @@ export const appWithTranslation = function (WrappedComponent) {
           await new Promise(resolve => middleware(req, res, resolve));
         }
       }
+      /* Call getInitialProps on our wrapped _app */
+
+
+      let wrappedComponentProps = {
+        pageProps: {}
+      };
+
+      if (WrappedComponent.getInitialProps) {
+        wrappedComponentProps = await WrappedComponent.getInitialProps(ctx);
+      }
+
+      if (typeof wrappedComponentProps.pageProps === 'undefined') {
+        consoleMessage('error', 'If you have a getInitialProps method in your custom _app.js file, you must explicitly return pageProps. For more information, see: https://github.com/zeit/next.js#custom-app');
+      }
       /*
         Step 1: Determine initial language
       */

package/dist/es/index.js

@@ -6,17 +6,13 @@ import { appWithTranslation, withInternals } from './hocs';
 import { consoleMessage } from './utils';
 import { Link } from './components';
 import { wrapRouter } from './router';
-export { withTranslation } from 'react-i18next';
+export { I18nContext, withTranslation } from 'react-i18next';
 export default class NextI18Next {
   constructor(userConfig) {
     this.config = createConfig(userConfig);
     this.consoleMessage = consoleMessage.bind(this);
     /* Validation */
 
-    if (this.config.otherLanguages.length <= 0) {
-      throw new Error('To properly initialise a next-i18next instance you must provide one or more locale codes in config.otherLanguages.');
-    }
-
     this.withNamespaces = () => {
       throw new Error('next-i18next has upgraded to react-i18next v10 - please rename withNamespaces to withTranslation.');
     };

package/dist/es/utils/is-server.js

@@ -1,2 +1 @@
-import isNode from 'detect-node';
-export const isServer = () => isNode && typeof window === 'undefined';
+export const isServer = () => typeof window === 'undefined';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "5.0.0-beta.4",
+  "version": "6.0.1",
   "repository": "git@github.com:isaachinman/next-i18next.git",
   "author": "Isaac Hinman <isaac@isaachinman.com>",
   "funding": {
@@ -50,15 +50,15 @@
   "bundlesize": [
     {
       "path": "./examples/simple/.next/static/chunks/commons*.js",
-      "maxSize": "62 kB"
+      "maxSize": "65 kB"
     },
     {
-      "path": "./examples/simple/.next/static/runtime/main*.js",
-      "maxSize": "6 kB"
+      "path": "./examples/simple/.next/static/chunks/main*.js",
+      "maxSize": "7 kB"
     },
     {
-      "path": "./examples/simple/.next/static/runtime/webpack*.js",
-      "maxSize": "750 B"
+      "path": "./examples/simple/.next/static/chunks/webpack*.js",
+      "maxSize": "760 B"
     }
   ],
   "devDependencies": {
@@ -69,7 +69,6 @@
     "@babel/preset-env": "^7.10.4",
     "@babel/preset-react": "^7.10.4",
     "@babel/preset-typescript": "^7.10.4",
-    "@types/express": "^4.16.1",
     "@types/jest": "^24.0.16",
     "@types/jest-environment-puppeteer": "^4.0.0",
     "@types/react": "^16.8.4",
@@ -100,21 +99,21 @@
     "typescript": "^3.5.3"
   },
   "dependencies": {
+    "@types/express": "^4.16.1",
     "core-js": "^3",
-    "detect-node": "^2.0.4",
     "hoist-non-react-statics": "^3.2.0",
-    "i18next": "^19.0.3",
-    "i18next-browser-languagedetector": "^4.0.0",
-    "i18next-fs-backend": "^1.0.2",
-    "i18next-http-backend": "^1.0.8",
-    "i18next-http-middleware": ">=1.0.2",
+    "i18next": "^19.6.3",
+    "i18next-browser-languagedetector": "^5.0.0",
+    "i18next-fs-backend": "^1.0.7",
+    "i18next-http-backend": "^1.0.17",
+    "i18next-http-middleware": "^3.0.2",
     "path-match": "^1.2.4",
     "prop-types": "^15.6.2",
-    "react-i18next": "^11.0.0",
+    "react-i18next": "^11.7.0",
     "url": "^0.11.0"
   },
   "peerDependencies": {
-    "next": ">= 9.3.0",
+    "next": ">= 9.5.0",
     "react": ">= 16.8.0"
   }
 }

package/types.d.ts

@@ -2,6 +2,7 @@
 
 import * as React from 'react'
 import {
+  I18nContext,
   useTranslation,
   TransProps,
   withTranslation,
@@ -18,6 +19,7 @@ export type InitConfig = {
   strictMode?: boolean;
   defaultLanguage: string;
   ignoreRoutes?: string[];
+  localeExtension?: string;
   localePath?: string;
   localeStructure?: string;
   otherLanguages: string[];
@@ -43,6 +45,7 @@ export type Trans = (props: TransProps) => any
 export type Link = React.ComponentClass<LinkProps>
 export type Router = SingletonRouter
 export type UseTranslation = typeof useTranslation
+export type I18nContext = typeof I18nContext
 export type AppWithTranslation = <P extends object>(Component: React.ComponentType<P> | React.ElementType<P>) => any
 export type TFunction = I18NextTFunction
 export type I18n = i18n