next-i18next 11.2.2 → 11.3.0

package/README.md

@@ -159,7 +159,32 @@ To do that, you can pass an array of required namespaces for each page into `ser
 
 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.
 
-### 5. Advanced configuration
+### 5. Declaring locale dependencies
+
+By default, `next-i18next` will send _only the active locale_ down to the client on each request. This helps reduce the size of the
+initial payload sent to the client. However in some cases one may need the translations for other languages at runtime too. For example
+when using [getFixedT](https://www.i18next.com/overview/api#getfixedt) of `useTranslation` hook.
+
+To change the behavior and load extra locales just pass in an array of locales as the last argument to `serverSideTranslations`.
+
+```diff
+  import { serverSideTranslations } from 'next-i18next/serverSideTranslations';
+
+  export async function getStaticProps({ locale }) {
+    return {
+      props: {
+-       ...(await serverSideTranslations(locale, ['common', 'footer'])),
++       ...(await serverSideTranslations(locale, ['common', 'footer'], null, ['en', 'no'])),
+      },
+    };
+  }
+```
+
+As a result the translations for both `no` and `en` locales will always be loaded regardless of the current language.
+
+> Note: The extra argument should be added to all pages that use `getFixedT` function.
+
+### 6. Advanced configuration
 
 #### Passing other config options
 

package/dist/commonjs/serverSideTranslations.js

@@ -101,18 +101,18 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 
 var DEFAULT_CONFIG_PATH = './next-i18next.config.js';
 
-var getFallbackLocales = function getFallbackLocales(fallbackLng) {
-  if (typeof fallbackLng === 'string') {
-    return [fallbackLng];
+var flatLocales = function flatLocales(locales) {
+  if (typeof locales === 'string') {
+    return [locales];
   }
 
-  if (Array.isArray(fallbackLng)) {
-    return fallbackLng;
+  if (Array.isArray(locales)) {
+    return locales;
   }
 
-  if ((0, _typeof2["default"])(fallbackLng) === 'object' && fallbackLng !== null) {
-    return Object.values(fallbackLng).reduce(function (all, locales) {
-      return [].concat((0, _toConsumableArray2["default"])(all), (0, _toConsumableArray2["default"])(locales));
+  if ((0, _typeof2["default"])(locales) === 'object' && locales !== null) {
+    return Object.values(locales).reduce(function (all, items) {
+      return [].concat((0, _toConsumableArray2["default"])(all), (0, _toConsumableArray2["default"])(items));
     }, []);
   }
 
@@ -143,6 +143,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(initialLocale) {
     var namespacesRequired,
         configOverride,
+        extraLocales,
         userConfig,
         config,
         localeExtension,
@@ -163,78 +164,79 @@ var serverSideTranslations = /*#__PURE__*/function () {
           case 0:
             namespacesRequired = _args.length > 1 && _args[1] !== undefined ? _args[1] : undefined;
             configOverride = _args.length > 2 && _args[2] !== undefined ? _args[2] : null;
+            extraLocales = _args.length > 3 && _args[3] !== undefined ? _args[3] : false;
 
             if (!(typeof initialLocale !== 'string')) {
-              _context.next = 4;
+              _context.next = 5;
               break;
             }
 
             throw new Error('Initial locale argument was not passed into serverSideTranslations');
 
-          case 4:
+          case 5:
             userConfig = configOverride;
 
             if (!(!userConfig && _fs["default"].existsSync(_path["default"].resolve(DEFAULT_CONFIG_PATH)))) {
-              _context.next = 9;
+              _context.next = 10;
               break;
             }
 
-            _context.next = 8;
+            _context.next = 9;
             return Promise.resolve("".concat(_path["default"].resolve(DEFAULT_CONFIG_PATH))).then(function (s) {
               return _interopRequireWildcard(require(s));
             });
 
-          case 8:
+          case 9:
             userConfig = _context.sent;
 
-          case 9:
+          case 10:
             if (!(userConfig === null)) {
-              _context.next = 11;
+              _context.next = 12;
               break;
             }
 
             throw new Error('next-i18next was unable to find a user config');
 
-          case 11:
+          case 12:
             config = (0, _createConfig.createConfig)(_objectSpread(_objectSpread({}, userConfig), {}, {
               lng: initialLocale
             }));
             localeExtension = config.localeExtension, localePath = config.localePath, fallbackLng = config.fallbackLng, reloadOnPrerender = config.reloadOnPrerender;
 
             if (!reloadOnPrerender) {
-              _context.next = 16;
+              _context.next = 17;
               break;
             }
 
-            _context.next = 16;
+            _context.next = 17;
             return _appWithTranslation.globalI18n === null || _appWithTranslation.globalI18n === void 0 ? void 0 : _appWithTranslation.globalI18n.reloadResources();
 
-          case 16:
+          case 17:
             _createClient = (0, _createClient2["default"])(_objectSpread(_objectSpread({}, config), {}, {
               lng: initialLocale
             })), i18n = _createClient.i18n, initPromise = _createClient.initPromise;
-            _context.next = 19;
+            _context.next = 20;
             return initPromise;
 
-          case 19:
+          case 20:
             initialI18nStore = (0, _defineProperty2["default"])({}, initialLocale, {});
-            getFallbackLocales(fallbackLng).forEach(function (lng) {
+            flatLocales(fallbackLng).concat(flatLocales(extraLocales)).forEach(function (lng) {
               initialI18nStore[lng] = {};
             });
 
             if (Array.isArray(namespacesRequired)) {
-              _context.next = 27;
+              _context.next = 28;
               break;
             }
 
             if (!(typeof localePath === 'function')) {
-              _context.next = 24;
+              _context.next = 25;
               break;
             }
 
             throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
 
-          case 24:
+          case 25:
             getLocaleNamespaces = function getLocaleNamespaces(path) {
               return _fs["default"].readdirSync(path).map(function (file) {
                 return file.replace(".".concat(localeExtension), '');
@@ -246,7 +248,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
             });
             namespacesRequired = flatNamespaces(namespacesByLocale);
 
-          case 27:
+          case 28:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -261,7 +263,7 @@ var serverSideTranslations = /*#__PURE__*/function () {
               }
             });
 
-          case 29:
+          case 30:
           case "end":
             return _context.stop();
         }

package/dist/es/serverSideTranslations.js

@@ -5,17 +5,17 @@ import createClient from './createClient';
 import { globalI18n } from './appWithTranslation';
 const DEFAULT_CONFIG_PATH = './next-i18next.config.js';
 
-const getFallbackLocales = fallbackLng => {
-  if (typeof fallbackLng === 'string') {
-    return [fallbackLng];
+const flatLocales = locales => {
+  if (typeof locales === 'string') {
+    return [locales];
   }
 
-  if (Array.isArray(fallbackLng)) {
-    return fallbackLng;
+  if (Array.isArray(locales)) {
+    return locales;
   }
 
-  if (typeof fallbackLng === 'object' && fallbackLng !== null) {
-    return Object.values(fallbackLng).reduce((all, locales) => [...all, ...locales], []);
+  if (typeof locales === 'object' && locales !== null) {
+    return Object.values(locales).reduce((all, items) => [...all, ...items], []);
   }
 
   return [];
@@ -31,7 +31,7 @@ const flatNamespaces = namespacesByLocale => {
   return Array.from(new Set(allNamespaces));
 };
 
-export const serverSideTranslations = async (initialLocale, namespacesRequired = undefined, configOverride = null) => {
+export const serverSideTranslations = async (initialLocale, namespacesRequired = undefined, configOverride = null, extraLocales = false) => {
   if (typeof initialLocale !== 'string') {
     throw new Error('Initial locale argument was not passed into serverSideTranslations');
   }
@@ -70,7 +70,7 @@ export const serverSideTranslations = async (initialLocale, namespacesRequired =
   const initialI18nStore = {
     [initialLocale]: {}
   };
-  getFallbackLocales(fallbackLng).forEach(lng => {
+  flatLocales(fallbackLng).concat(flatLocales(extraLocales)).forEach(lng => {
     initialI18nStore[lng] = {};
   });
 

package/dist/esm/serverSideTranslations.js

@@ -21,18 +21,18 @@ import createClient from './createClient';
 import { globalI18n } from './appWithTranslation';
 var DEFAULT_CONFIG_PATH = './next-i18next.config.js';
 
-var getFallbackLocales = function getFallbackLocales(fallbackLng) {
-  if (typeof fallbackLng === 'string') {
-    return [fallbackLng];
+var flatLocales = function flatLocales(locales) {
+  if (typeof locales === 'string') {
+    return [locales];
   }
 
-  if (Array.isArray(fallbackLng)) {
-    return fallbackLng;
+  if (Array.isArray(locales)) {
+    return locales;
   }
 
-  if (_typeof(fallbackLng) === 'object' && fallbackLng !== null) {
-    return Object.values(fallbackLng).reduce(function (all, locales) {
-      return [].concat(_toConsumableArray(all), _toConsumableArray(locales));
+  if (_typeof(locales) === 'object' && locales !== null) {
+    return Object.values(locales).reduce(function (all, items) {
+      return [].concat(_toConsumableArray(all), _toConsumableArray(items));
     }, []);
   }
 
@@ -63,6 +63,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(initialLocale) {
     var namespacesRequired,
         configOverride,
+        extraLocales,
         userConfig,
         config,
         localeExtension,
@@ -83,76 +84,77 @@ export var serverSideTranslations = /*#__PURE__*/function () {
           case 0:
             namespacesRequired = _args.length > 1 && _args[1] !== undefined ? _args[1] : undefined;
             configOverride = _args.length > 2 && _args[2] !== undefined ? _args[2] : null;
+            extraLocales = _args.length > 3 && _args[3] !== undefined ? _args[3] : false;
 
             if (!(typeof initialLocale !== 'string')) {
-              _context.next = 4;
+              _context.next = 5;
               break;
             }
 
             throw new Error('Initial locale argument was not passed into serverSideTranslations');
 
-          case 4:
+          case 5:
             userConfig = configOverride;
 
             if (!(!userConfig && fs.existsSync(path.resolve(DEFAULT_CONFIG_PATH)))) {
-              _context.next = 9;
+              _context.next = 10;
               break;
             }
 
-            _context.next = 8;
+            _context.next = 9;
             return import(path.resolve(DEFAULT_CONFIG_PATH));
 
-          case 8:
+          case 9:
             userConfig = _context.sent;
 
-          case 9:
+          case 10:
             if (!(userConfig === null)) {
-              _context.next = 11;
+              _context.next = 12;
               break;
             }
 
             throw new Error('next-i18next was unable to find a user config');
 
-          case 11:
+          case 12:
             config = createConfig(_objectSpread(_objectSpread({}, userConfig), {}, {
               lng: initialLocale
             }));
             localeExtension = config.localeExtension, localePath = config.localePath, fallbackLng = config.fallbackLng, reloadOnPrerender = config.reloadOnPrerender;
 
             if (!reloadOnPrerender) {
-              _context.next = 16;
+              _context.next = 17;
               break;
             }
 
-            _context.next = 16;
+            _context.next = 17;
             return globalI18n === null || globalI18n === void 0 ? void 0 : globalI18n.reloadResources();
 
-          case 16:
+          case 17:
             _createClient = createClient(_objectSpread(_objectSpread({}, config), {}, {
               lng: initialLocale
             })), i18n = _createClient.i18n, initPromise = _createClient.initPromise;
-            _context.next = 19;
+            _context.next = 20;
             return initPromise;
 
-          case 19:
+          case 20:
             initialI18nStore = _defineProperty({}, initialLocale, {});
-            getFallbackLocales(fallbackLng).forEach(function (lng) {
+            flatLocales(fallbackLng).concat(flatLocales(extraLocales)).forEach(function (lng) {
               initialI18nStore[lng] = {};
             });
 
             if (Array.isArray(namespacesRequired)) {
-              _context.next = 27;
+              _context.next = 28;
               break;
             }
 
             if (!(typeof localePath === 'function')) {
-              _context.next = 24;
+              _context.next = 25;
               break;
             }
 
             throw new Error('Must provide namespacesRequired to serverSideTranslations when using a function as localePath');
 
-          case 24:
+          case 25:
             getLocaleNamespaces = function getLocaleNamespaces(path) {
               return fs.readdirSync(path).map(function (file) {
                 return file.replace(".".concat(localeExtension), '');
@@ -164,7 +166,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
             });
             namespacesRequired = flatNamespaces(namespacesByLocale);
 
-          case 27:
+          case 28:
             namespacesRequired.forEach(function (ns) {
               for (var locale in initialI18nStore) {
                 initialI18nStore[locale][ns] = (i18n.services.resourceStore.data[locale] || {})[ns] || {};
@@ -179,7 +181,7 @@ export var serverSideTranslations = /*#__PURE__*/function () {
               }
             });
 
-          case 29:
+          case 30:
           case "end":
             return _context.stop();
         }

package/dist/types/serverSideTranslations.d.ts

@@ -1,2 +1,2 @@
 import { UserConfig, SSRConfig } from './types';
-export declare const serverSideTranslations: (initialLocale: string, namespacesRequired?: string[] | undefined, configOverride?: UserConfig | null) => Promise<SSRConfig>;
+export declare const serverSideTranslations: (initialLocale: string, namespacesRequired?: string[] | undefined, configOverride?: UserConfig | null, extraLocales?: string[] | false) => Promise<SSRConfig>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-i18next",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "repository": "git@github.com:i18next/next-i18next.git",
   "author": "i18next",
   "funding": [