next-i18next 6.0.1 → 7.0.1

package/README.md

@@ -69,7 +69,7 @@ After creating and exporting your `NextI18Next` instance, you need to take the f
 
 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 functional component [(explanation here)](https://github.com/isaachinman/next-i18next/issues/615#issuecomment-575578375).
-2. Create a `next.config.js` file inside your root directory if you want to use locale subpaths. You can see this approach in the [examples/simple/next.config.js](./examples/simple/next.config.js).
+2. Create a `next.config.js` file inside your root directory if you want to use locale subpaths. You can see this approach in the [examples/simple/next.config.js](./examples/simple/next.config.js) (Next.js 9.5+ required).
 
 Note: You can pass `shallowRender: true` into config options to avoid triggering getInitialProps when `changeLanguage` method is invoked.
 
@@ -217,6 +217,11 @@ _This table contains options which are specific to next-i18next. All other [i18n
 - [`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).
+- [How to use multiple namespaces in the same component](https://github.com/isaachinman/next-i18next/issues/762#issuecomment-661348457)
+
+## Usage with TypeScript
+
+`next-i18next` is written in TypeScript and has full support for it. Refer to the usage guide [here](./TYPESCRIPT.md).
 
 ## Contributors
 

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

@@ -6,6 +6,8 @@ require("core-js/modules/es.array.concat");
 
 require("core-js/modules/es.array.filter");
 
+require("core-js/modules/es.array.find");
+
 require("core-js/modules/es.array.for-each");
 
 require("core-js/modules/es.array.index-of");
@@ -55,69 +57,89 @@ var createConfig = function createConfig(userConfig) {
     Sensible defaults to prevent user duplication
   */
 
-  combinedConfig.allLanguages = dedupe(combinedConfig.otherLanguages.concat([combinedConfig.defaultLanguage]));
-  combinedConfig.whitelist = combinedConfig.allLanguages;
+  combinedConfig.allLanguages = dedupe(combinedConfig.otherLanguages.concat([combinedConfig.defaultLanguage])); // https://github.com/i18next/i18next/blob/master/CHANGELOG.md#1950
+
+  combinedConfig.supportedLngs = combinedConfig.allLanguages; // temporal backwards compatibility WHITELIST REMOVAL
+
+  combinedConfig.whitelist = combinedConfig.allLanguages; // end temporal backwards compatibility WHITELIST REMOVAL
+
   var allLanguages = combinedConfig.allLanguages,
       defaultLanguage = combinedConfig.defaultLanguage,
       localeExtension = combinedConfig.localeExtension,
       localePath = combinedConfig.localePath,
       localeStructure = combinedConfig.localeStructure;
+  /** 
+   * Skips translation file resolution while in cimode
+   * https://github.com/isaachinman/next-i18next/pull/851#discussion_r503113620
+  */
 
-  if ((0, _utils.isServer)()) {
-    var fs = eval("require('fs')");
-
-    var path = require('path');
+  if ((0, _utils.isCIMode)(defaultLanguage)) {
+    return combinedConfig;
+  }
 
-    var serverLocalePath = localePath;
+  if ((0, _utils.isServer)()) {
     /*
-      Validate defaultNS
-      https://github.com/isaachinman/next-i18next/issues/358
+      On Server side preload (languages)
     */
-
-    if (typeof combinedConfig.defaultNS === 'string') {
-      var defaultFile = "/".concat(defaultLanguage, "/").concat(combinedConfig.defaultNS, ".").concat(localeExtension);
-      var defaultNSPath = path.join(localePath, defaultFile);
-      var defaultNSExists = fs.existsSync(defaultNSPath);
-
-      if (!defaultNSExists) {
-        /*
-          If defaultNS doesn't exist, try to fall back to the deprecated static folder
-          https://github.com/isaachinman/next-i18next/issues/523
-        */
-        var staticDirPath = path.resolve(process.cwd(), STATIC_LOCALE_PATH, defaultFile);
-        var staticDirExists = fs.existsSync(staticDirPath);
-
-        if (staticDirExists) {
-          (0, _utils.consoleMessage)('warn', 'next-i18next: Falling back to /static folder, deprecated in next@9.1.*', combinedConfig);
-          serverLocalePath = STATIC_LOCALE_PATH;
-        } else if (process.env.NODE_ENV !== 'production') {
-          throw new Error("Default namespace not found at ".concat(defaultNSPath));
+    combinedConfig.preload = allLanguages;
+    var hasCustomBackend = userConfig.use && userConfig.use.find(function (b) {
+      return b.type === 'backend';
+    });
+
+    if (!hasCustomBackend) {
+      var fs = eval("require('fs')");
+
+      var path = require('path');
+
+      var serverLocalePath = localePath;
+      /*
+        Validate defaultNS
+        https://github.com/isaachinman/next-i18next/issues/358
+      */
+
+      if (typeof combinedConfig.defaultNS === 'string') {
+        var defaultFile = "/".concat(defaultLanguage, "/").concat(combinedConfig.defaultNS, ".").concat(localeExtension);
+        var defaultNSPath = path.join(localePath, defaultFile);
+        var defaultNSExists = fs.existsSync(defaultNSPath);
+
+        if (!defaultNSExists) {
+          /*
+            If defaultNS doesn't exist, try to fall back to the deprecated static folder
+            https://github.com/isaachinman/next-i18next/issues/523
+          */
+          var staticDirPath = path.resolve(process.cwd(), STATIC_LOCALE_PATH, defaultFile);
+          var staticDirExists = fs.existsSync(staticDirPath);
+
+          if (staticDirExists) {
+            (0, _utils.consoleMessage)('warn', 'next-i18next: Falling back to /static folder, deprecated in next@9.1.*', combinedConfig);
+            serverLocalePath = STATIC_LOCALE_PATH;
+          } else if (process.env.NODE_ENV !== 'production') {
+            throw new Error("Default namespace not found at ".concat(defaultNSPath));
+          }
         }
       }
-    }
-    /*
-      Set server side backend
-    */
+      /*
+        Set server side backend
+      */
 
 
-    combinedConfig.backend = {
-      loadPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".").concat(localeExtension)),
-      addPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension))
-    };
-    /*
-      Set server side preload (languages and namespaces)
-    */
-
-    combinedConfig.preload = allLanguages;
-
-    if (!combinedConfig.ns) {
-      var getAllNamespaces = function getAllNamespaces(p) {
-        return fs.readdirSync(p).map(function (file) {
-          return file.replace(".".concat(localeExtension), '');
-        });
+      combinedConfig.backend = {
+        loadPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".").concat(localeExtension)),
+        addPath: path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(localeStructure, ".missing.").concat(localeExtension))
       };
-
-      combinedConfig.ns = getAllNamespaces(path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(defaultLanguage)));
+      /*
+        Set server side preload (namespaces)
+      */
+
+      if (!combinedConfig.ns) {
+        var getAllNamespaces = function getAllNamespaces(p) {
+          return fs.readdirSync(p).map(function (file) {
+            return file.replace(".".concat(localeExtension), '');
+          });
+        };
+
+        combinedConfig.ns = getAllNamespaces(path.resolve(process.cwd(), "".concat(serverLocalePath, "/").concat(defaultLanguage)));
+      }
     }
   } else {
     var clientLocalePath = localePath;

package/dist/commonjs/utils/index.js

@@ -69,6 +69,12 @@ Object.defineProperty(exports, "subpathIsRequired", {
     return _subpathIsRequired.subpathIsRequired;
   }
 });
+Object.defineProperty(exports, "isCIMode", {
+  enumerable: true,
+  get: function get() {
+    return _isCimode.isCIMode;
+  }
+});
 
 var _addSubpath = require("./add-subpath");
 
@@ -90,4 +96,6 @@ var _subpathFromLng = require("./subpath-from-lng");
 
 var _subpathIsPresent = require("./subpath-is-present");
 
-var _subpathIsRequired = require("./subpath-is-required");
+var _subpathIsRequired = require("./subpath-is-required");
+
+var _isCimode = require("./is-cimode");

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

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isCIMode = void 0;
+
+// Detects if in CI mode due language used
+// https://www.i18next.com/overview/api#changelanguage
+var isCIMode = function isCIMode(language) {
+  return language === 'cimode';
+};
+
+exports.isCIMode = isCIMode;

package/dist/commonjs/utils/lng-path-corrector.js

@@ -74,7 +74,7 @@ var lngPathCorrector = function lngPathCorrector(config, currentRoute, currentLa
   var originalAs = currentRoute.as,
       originalHref = currentRoute.href;
 
-  if (!allLanguages.includes(currentLanguage)) {
+  if (!(0, _index.isCIMode)(currentLanguage) && !allLanguages.includes(currentLanguage)) {
     throw new Error('Invalid configuration: Current language is not included in all languages array');
   }
 

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

@@ -1,5 +1,5 @@
 import { defaultConfig } from './default-config';
-import { consoleMessage, isServer } from '../utils';
+import { consoleMessage, isServer, isCIMode } from '../utils';
 const deepMergeObjects = ['backend', 'detection'];
 
 const dedupe = names => names.filter((v, i) => names.indexOf(v) === i);
@@ -21,8 +21,12 @@ export const createConfig = userConfig => {
     Sensible defaults to prevent user duplication
   */
 
-  combinedConfig.allLanguages = dedupe(combinedConfig.otherLanguages.concat([combinedConfig.defaultLanguage]));
-  combinedConfig.whitelist = combinedConfig.allLanguages;
+  combinedConfig.allLanguages = dedupe(combinedConfig.otherLanguages.concat([combinedConfig.defaultLanguage])); // https://github.com/i18next/i18next/blob/master/CHANGELOG.md#1950
+
+  combinedConfig.supportedLngs = combinedConfig.allLanguages; // temporal backwards compatibility WHITELIST REMOVAL
+
+  combinedConfig.whitelist = combinedConfig.allLanguages; // end temporal backwards compatibility WHITELIST REMOVAL
+
   const {
     allLanguages,
     defaultLanguage,
@@ -30,58 +34,72 @@ export const createConfig = userConfig => {
     localePath,
     localeStructure
   } = combinedConfig;
+  /** 
+   * Skips translation file resolution while in cimode
+   * https://github.com/isaachinman/next-i18next/pull/851#discussion_r503113620
+  */
 
-  if (isServer()) {
-    const fs = eval("require('fs')");
-
-    const path = require('path');
+  if (isCIMode(defaultLanguage)) {
+    return combinedConfig;
+  }
 
-    let serverLocalePath = localePath;
+  if (isServer()) {
     /*
-      Validate defaultNS
-      https://github.com/isaachinman/next-i18next/issues/358
+      On Server side preload (languages)
     */
-
-    if (typeof combinedConfig.defaultNS === 'string') {
-      const defaultFile = `/${defaultLanguage}/${combinedConfig.defaultNS}.${localeExtension}`;
-      const defaultNSPath = path.join(localePath, defaultFile);
-      const defaultNSExists = fs.existsSync(defaultNSPath);
-
-      if (!defaultNSExists) {
-        /*
-          If defaultNS doesn't exist, try to fall back to the deprecated static folder
-          https://github.com/isaachinman/next-i18next/issues/523
-        */
-        const staticDirPath = path.resolve(process.cwd(), STATIC_LOCALE_PATH, defaultFile);
-        const staticDirExists = fs.existsSync(staticDirPath);
-
-        if (staticDirExists) {
-          consoleMessage('warn', 'next-i18next: Falling back to /static folder, deprecated in next@9.1.*', combinedConfig);
-          serverLocalePath = STATIC_LOCALE_PATH;
-        } else if (process.env.NODE_ENV !== 'production') {
-          throw new Error(`Default namespace not found at ${defaultNSPath}`);
+    combinedConfig.preload = allLanguages;
+    const hasCustomBackend = userConfig.use && userConfig.use.find(b => b.type === 'backend');
+
+    if (!hasCustomBackend) {
+      const fs = eval("require('fs')");
+
+      const path = require('path');
+
+      let serverLocalePath = localePath;
+      /*
+        Validate defaultNS
+        https://github.com/isaachinman/next-i18next/issues/358
+      */
+
+      if (typeof combinedConfig.defaultNS === 'string') {
+        const defaultFile = `/${defaultLanguage}/${combinedConfig.defaultNS}.${localeExtension}`;
+        const defaultNSPath = path.join(localePath, defaultFile);
+        const defaultNSExists = fs.existsSync(defaultNSPath);
+
+        if (!defaultNSExists) {
+          /*
+            If defaultNS doesn't exist, try to fall back to the deprecated static folder
+            https://github.com/isaachinman/next-i18next/issues/523
+          */
+          const staticDirPath = path.resolve(process.cwd(), STATIC_LOCALE_PATH, defaultFile);
+          const staticDirExists = fs.existsSync(staticDirPath);
+
+          if (staticDirExists) {
+            consoleMessage('warn', 'next-i18next: Falling back to /static folder, deprecated in next@9.1.*', combinedConfig);
+            serverLocalePath = STATIC_LOCALE_PATH;
+          } else if (process.env.NODE_ENV !== 'production') {
+            throw new Error(`Default namespace not found at ${defaultNSPath}`);
+          }
         }
       }
-    }
-    /*
-      Set server side backend
-    */
-
+      /*
+        Set server side backend
+      */
 
-    combinedConfig.backend = {
-      loadPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.${localeExtension}`),
-      addPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.missing.${localeExtension}`)
-    };
-    /*
-      Set server side preload (languages and namespaces)
-    */
 
-    combinedConfig.preload = allLanguages;
+      combinedConfig.backend = {
+        loadPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.${localeExtension}`),
+        addPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.missing.${localeExtension}`)
+      };
+      /*
+        Set server side preload (namespaces)
+      */
 
-    if (!combinedConfig.ns) {
-      const getAllNamespaces = p => fs.readdirSync(p).map(file => file.replace(`.${localeExtension}`, ''));
+      if (!combinedConfig.ns) {
+        const getAllNamespaces = p => fs.readdirSync(p).map(file => file.replace(`.${localeExtension}`, ''));
 
-      combinedConfig.ns = getAllNamespaces(path.resolve(process.cwd(), `${serverLocalePath}/${defaultLanguage}`));
+        combinedConfig.ns = getAllNamespaces(path.resolve(process.cwd(), `${serverLocalePath}/${defaultLanguage}`));
+      }
     }
   } else {
     let clientLocalePath = localePath;

package/dist/es/utils/index.js

@@ -8,4 +8,5 @@ export { redirectWithoutCache } from './redirect-without-cache';
 export { removeSubpath } from './remove-subpath';
 export { subpathFromLng } from './subpath-from-lng';
 export { subpathIsPresent } from './subpath-is-present';
-export { subpathIsRequired } from './subpath-is-required';
+export { subpathIsRequired } from './subpath-is-required';
+export { isCIMode } from './is-cimode';

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

@@ -0,0 +1,3 @@
+// Detects if in CI mode due language used
+// https://www.i18next.com/overview/api#changelanguage
+export const isCIMode = language => language === 'cimode';

package/dist/es/utils/lng-path-corrector.js

@@ -1,5 +1,5 @@
 import { format as formatUrl, parse as parseUrl } from 'url';
-import { removeSubpath, subpathIsPresent, subpathIsRequired, subpathFromLng } from './index';
+import { removeSubpath, subpathIsPresent, subpathIsRequired, subpathFromLng, isCIMode } from './index';
 
 const parseAs = (originalAs, href) => {
   const asType = typeof originalAs;
@@ -48,7 +48,7 @@ export const lngPathCorrector = (config, currentRoute, currentLanguage) => {
     href: originalHref
   } = currentRoute;
 
-  if (!allLanguages.includes(currentLanguage)) {
+  if (!isCIMode(currentLanguage) && !allLanguages.includes(currentLanguage)) {
     throw new Error('Invalid configuration: Current language is not included in all languages array');
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "6.0.1",
+  "version": "7.0.1",
   "repository": "git@github.com:isaachinman/next-i18next.git",
   "author": "Isaac Hinman <isaac@isaachinman.com>",
   "funding": {
@@ -50,7 +50,7 @@
   "bundlesize": [
     {
       "path": "./examples/simple/.next/static/chunks/commons*.js",
-      "maxSize": "65 kB"
+      "maxSize": "67 kB"
     },
     {
       "path": "./examples/simple/.next/static/chunks/main*.js",
@@ -109,7 +109,7 @@
     "i18next-http-middleware": "^3.0.2",
     "path-match": "^1.2.4",
     "prop-types": "^15.6.2",
-    "react-i18next": "^11.7.0",
+    "react-i18next": "^11.7.3",
     "url": "^0.11.0"
   },
   "peerDependencies": {

package/types.d.ts

@@ -32,7 +32,11 @@ export type InitConfig = {
 export type Config = {
   fallbackLng: boolean;
   allLanguages: string[];
+  // https://github.com/i18next/i18next/blob/master/CHANGELOG.md#1950
+  supportedLngs: string[];
+  // temporal backwards compatibility WHITELIST REMOVAL
   whitelist: string[];
+  // end temporal backwards compatibility WHITELIST REMOVAL
   preload: string[];
 } & InitConfig
 
@@ -45,7 +49,6 @@ 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
@@ -53,6 +56,11 @@ export type WithTranslationHocType = typeof withTranslation
 export type WithTranslation = ReactI18nextWithTranslation
 export type InitPromise = Promise<TFunction>
 
+export {
+  I18nContext,
+  withTranslation,
+}
+
 declare class NextI18Next {
   constructor(config: InitConfig);
   Trans: Trans