next-intl 2.3.0 → 2.3.4

package/README.md

@@ -11,30 +11,20 @@
 
 ![Gzipped size](https://badgen.net/bundlephobia/minzip/next-intl) ![Tree shaking supported](https://badgen.net/bundlephobia/tree-shaking/next-intl) [<img src="https://img.shields.io/npm/dw/next-intl.svg" />](https://www.npmjs.com/package/next-intl)
 
-This library complements the [internationalized routing](https://nextjs.org/docs/advanced-features/i18n-routing) capabilities of Next.js by managing translations and providing them to components.
-
 ## Features
 
-- 🌟 Messages use the **proven [ICU syntax](https://formatjs.io/docs/core-concepts/icu-syntax)** which covers interpolation, plurals, ordinal pluralization, label selection based on enums and rich text. I18n is an essential part of the user experience, therefore this library doesn't compromise on flexibility and never leaves you behind when you need to fine tune a translation.
-- 📅 Built-in **date, time and number formatting** provides all the necessary parts you need for localisation. You can use global formats for a consistent look & feel of your app and integrate them with translations.
-- 💡 A **hooks-only API** ensures that you can use the same API for `children` as well as for attributes which expect strings.
-- ⚔️ Based on **battle-tested** building blocks from [Format.JS](https://formatjs.io/) (used by `react-intl`) and modern browser APIs, this library is a thin wrapper around high-quality, lower-level APIs for i18n.
-- 🚀 By integrating with both **static as well as server side rendering** you always get the best possible performance from your app.
+This library complements the [internationalized routing](https://nextjs.org/docs/advanced-features/i18n-routing) capabilities of Next.js by managing translations and providing them to components.
+
+- 🌟 **Proven ICU syntax**: This covers interpolation, plurals, ordinal pluralization, label selection based on enums and rich text. I18n is an essential part of the user experience, therefore this library doesn't compromise on flexibility and never leaves you behind when you need to fine tune a translation.
+- 📅 **Built-in date, time and number formatting**: You can use global formats for a consistent look & feel of your app and integrate them with translations.
+- 💡 **Hooks-only API**: This ensures that you can use the same API for `children` as well as for attributes which expect strings.
+- ⚔️ **Battle-tested building blocks**: This library is a minimal wrapper around built-in browser APIs and supplemental lower-level APIs from Format.JS.
+- 🚀 **Fast**: By integrating with both static as well as server side rendering you always get the best possible performance from your app.
 
 ## What does it look like?
 
 This library is based on the premise that messages can be grouped by namespaces (typically a component name).
 
-```js
-// en.json
-{
-  "LatestFollower": {
-    "latestFollower": "{username} started following you",
-    "followBack": "Follow back"
-  }
-}
-```
-
 ```jsx
 // LatestFollower.js
 function LatestFollower({user}) {
@@ -49,9 +39,14 @@ function LatestFollower({user}) {
 }
 ```
 
-## Docs
+```js
+// en.json
+{
+  "LatestFollower": {
+    "latestFollower": "{username} started following you",
+    "followBack": "Follow back"
+  }
+}
+```
 
-- [Installation guide](./docs/installation.md)
-- [Usage guide](./docs/usage.md)
-- [FAQ](./docs/faq.md)
-- [Changelog](./CHANGELOG.md)
+### [→ Read the docs](https://next-intl-docs.vercel.app/)

package/dist/next-intl.cjs.development.js

@@ -24,11 +24,18 @@ function _objectWithoutPropertiesLoose(source, excluded) {
 }
 
 function NextIntlProvider(_ref) {
+  var _useRouter;
+
   var locale = _ref.locale,
       rest = _objectWithoutPropertiesLoose(_ref, ["locale"]);
 
-  var nextLocale = router.useRouter().locale;
-  if (!locale && nextLocale) locale = nextLocale;
+  // The router can be undefined if used in a context outside
+  // of Next.js (e.g. unit tests, Storybook, ...)
+  var nextLocale = (_useRouter = router.useRouter()) == null ? void 0 : _useRouter.locale;
+
+  if (!locale && nextLocale) {
+    locale = nextLocale;
+  }
 
   if (!locale) {
     throw new Error( "Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`." );

package/dist/next-intl.cjs.development.js.map

@@ -1 +1 @@
-{"version":3,"file":"next-intl.cjs.development.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  const nextLocale = useRouter().locale;\n  if (!locale && nextLocale) locale = nextLocale;\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["NextIntlProvider","locale","rest","nextLocale","useRouter","Error","React","IntlProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;SAQwBA;MAAkBC,cAAAA;MAAWC;;AACnD,MAAMC,UAAU,GAAGC,gBAAS,GAAGH,MAA/B;AACA,MAAI,CAACA,MAAD,IAAWE,UAAf,EAA2BF,MAAM,GAAGE,UAAT;;AAE3B,MAAI,CAACF,MAAL,EAAa;AACX,UAAM,IAAII,KAAJ,EAEA,+IADJ,CADI,CAAN;AAKD;;AAED,SAAOC,mBAAA,CAACC,oBAAD;AAAcN,IAAAA,MAAM,EAAEA;KAAYC,KAAlC,CAAP;AACD;;;;;;;;;;;;"}
+{"version":3,"file":"next-intl.cjs.development.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  // The router can be undefined if used in a context outside\n  // of Next.js (e.g. unit tests, Storybook, ...)\n  const nextLocale = useRouter()?.locale;\n\n  if (!locale && nextLocale) {\n    locale = nextLocale;\n  }\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["NextIntlProvider","locale","rest","nextLocale","useRouter","Error","React","IntlProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;SAQwBA;;;MAAkBC,cAAAA;MAAWC;;AACnD;AACA;AACA,MAAMC,UAAU,iBAAGC,gBAAS,EAAZ,qBAAG,WAAaH,MAAhC;;AAEA,MAAI,CAACA,MAAD,IAAWE,UAAf,EAA2B;AACzBF,IAAAA,MAAM,GAAGE,UAAT;AACD;;AAED,MAAI,CAACF,MAAL,EAAa;AACX,UAAM,IAAII,KAAJ,EAEA,+IADJ,CADI,CAAN;AAKD;;AAED,SAAOC,mBAAA,CAACC,oBAAD;AAAcN,IAAAA,MAAM,EAAEA;KAAYC,KAAlC,CAAP;AACD;;;;;;;;;;;;"}

package/dist/next-intl.cjs.production.min.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e,r=require("next/router"),t=(e=require("react"))&&"object"==typeof e&&"default"in e?e.default:e,n=require("use-intl");Object.keys(n).forEach((function(e){"default"!==e&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return n[e]}})})),exports.NextIntlProvider=function(e){var o=e.locale,u=function(e,r){if(null==e)return{};var t,n,o={},u=Object.keys(e);for(n=0;n<u.length;n++)r.indexOf(t=u[n])>=0||(o[t]=e[t]);return o}(e,["locale"]),l=r.useRouter().locale;if(!o&&l&&(o=l),!o)throw new Error(void 0);return t.createElement(n.IntlProvider,Object.assign({locale:o},u))};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e,r=require("next/router"),t=(e=require("react"))&&"object"==typeof e&&"default"in e?e.default:e,n=require("use-intl");Object.keys(n).forEach((function(e){"default"!==e&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return n[e]}})})),exports.NextIntlProvider=function(e){var o,u=e.locale,l=function(e,r){if(null==e)return{};var t,n,o={},u=Object.keys(e);for(n=0;n<u.length;n++)r.indexOf(t=u[n])>=0||(o[t]=e[t]);return o}(e,["locale"]),i=null==(o=r.useRouter())?void 0:o.locale;if(!u&&i&&(u=i),!u)throw new Error(void 0);return t.createElement(n.IntlProvider,Object.assign({locale:u},l))};
 //# sourceMappingURL=next-intl.cjs.production.min.js.map

package/dist/next-intl.cjs.production.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"next-intl.cjs.production.min.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  const nextLocale = useRouter().locale;\n  if (!locale && nextLocale) locale = nextLocale;\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["locale","rest","nextLocale","useRouter","Error","undefined","React","IntlProvider"],"mappings":"2WAQ0CA,IAAAA,OAAWC,mJAC7CC,EAAaC,cAAYH,WAC1BA,GAAUE,IAAYF,EAASE,IAE/BF,QACG,IAAII,WAGJC,UAIDC,gBAACC,8BAAaP,OAAQA,GAAYC"}
+{"version":3,"file":"next-intl.cjs.production.min.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  // The router can be undefined if used in a context outside\n  // of Next.js (e.g. unit tests, Storybook, ...)\n  const nextLocale = useRouter()?.locale;\n\n  if (!locale && nextLocale) {\n    locale = nextLocale;\n  }\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["locale","rest","nextLocale","useRouter","_useRouter","Error","undefined","React","IntlProvider"],"mappings":"6WAQ0CA,IAAAA,OAAWC,mJAG7CC,WAAaC,sBAAAC,EAAaJ,WAE3BA,GAAUE,IACbF,EAASE,IAGNF,QACG,IAAIK,WAGJC,UAIDC,gBAACC,8BAAaR,OAAQA,GAAYC"}

package/dist/next-intl.esm.js

@@ -19,11 +19,18 @@ function _objectWithoutPropertiesLoose(source, excluded) {
 }
 
 function NextIntlProvider(_ref) {
+  var _useRouter;
+
   var locale = _ref.locale,
       rest = _objectWithoutPropertiesLoose(_ref, ["locale"]);
 
-  var nextLocale = useRouter().locale;
-  if (!locale && nextLocale) locale = nextLocale;
+  // The router can be undefined if used in a context outside
+  // of Next.js (e.g. unit tests, Storybook, ...)
+  var nextLocale = (_useRouter = useRouter()) == null ? void 0 : _useRouter.locale;
+
+  if (!locale && nextLocale) {
+    locale = nextLocale;
+  }
 
   if (!locale) {
     throw new Error(process.env.NODE_ENV !== "production" ? "Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`." : undefined);

package/dist/next-intl.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"next-intl.esm.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  const nextLocale = useRouter().locale;\n  if (!locale && nextLocale) locale = nextLocale;\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["NextIntlProvider","locale","rest","nextLocale","useRouter","Error","undefined","React","IntlProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;SAQwBA;MAAkBC,cAAAA;MAAWC;;AACnD,MAAMC,UAAU,GAAGC,SAAS,GAAGH,MAA/B;AACA,MAAI,CAACA,MAAD,IAAWE,UAAf,EAA2BF,MAAM,GAAGE,UAAT;;AAE3B,MAAI,CAACF,MAAL,EAAa;AACX,UAAM,IAAII,KAAJ,CACJ,wCACI,+IADJ,GAEIC,SAHA,CAAN;AAKD;;AAED,SAAOC,mBAAA,CAACC,YAAD;AAAcP,IAAAA,MAAM,EAAEA;KAAYC,KAAlC,CAAP;AACD;;;;"}
+{"version":3,"file":"next-intl.esm.js","sources":["../src/NextIntlProvider.tsx"],"sourcesContent":["import {useRouter} from 'next/router';\nimport React, {ComponentProps} from 'react';\nimport {IntlProvider} from 'use-intl';\n\ntype Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {\n  locale?: string;\n};\n\nexport default function NextIntlProvider({locale, ...rest}: Props) {\n  // The router can be undefined if used in a context outside\n  // of Next.js (e.g. unit tests, Storybook, ...)\n  const nextLocale = useRouter()?.locale;\n\n  if (!locale && nextLocale) {\n    locale = nextLocale;\n  }\n\n  if (!locale) {\n    throw new Error(\n      __DEV__\n        ? \"Couldn't determine locale. Please make sure you use internationalized routing or alternatively pass an explicit locale to `NextIntlProvider`.\"\n        : undefined\n    );\n  }\n\n  return <IntlProvider locale={locale} {...rest} />;\n}\n"],"names":["NextIntlProvider","locale","rest","nextLocale","useRouter","Error","undefined","React","IntlProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;SAQwBA;;;MAAkBC,cAAAA;MAAWC;;AACnD;AACA;AACA,MAAMC,UAAU,iBAAGC,SAAS,EAAZ,qBAAG,WAAaH,MAAhC;;AAEA,MAAI,CAACA,MAAD,IAAWE,UAAf,EAA2B;AACzBF,IAAAA,MAAM,GAAGE,UAAT;AACD;;AAED,MAAI,CAACF,MAAL,EAAa;AACX,UAAM,IAAII,KAAJ,CACJ,wCACI,+IADJ,GAEIC,SAHA,CAAN;AAKD;;AAED,SAAOC,mBAAA,CAACC,YAAD;AAAcP,IAAAA,MAAM,EAAEA;KAAYC,KAAlC,CAAP;AACD;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "2.3.0",
+  "version": "2.3.4",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.me>",
   "description": "A minimal, but complete solution for managing translations, date and number formatting in Next.js apps.",
@@ -37,7 +37,7 @@
     "next.js"
   ],
   "dependencies": {
-    "use-intl": "^2.3.0"
+    "use-intl": "^2.3.4"
   },
   "peerDependencies": {
     "next": "^10.0.0 || ^11.0.0 || ^12.0.0",
@@ -58,5 +58,5 @@
   "engines": {
     "node": ">=10"
   },
-  "gitHead": "1571b78688fa2735011b2170e7811e83fd574204"
+  "gitHead": "674e4837d625785d1c4242d742f811b7383d8f89"
 }

package/src/NextIntlProvider.tsx

@@ -7,8 +7,13 @@ type Props = Omit<ComponentProps<typeof IntlProvider>, 'locale'> & {
 };
 
 export default function NextIntlProvider({locale, ...rest}: Props) {
-  const nextLocale = useRouter().locale;
-  if (!locale && nextLocale) locale = nextLocale;
+  // The router can be undefined if used in a context outside
+  // of Next.js (e.g. unit tests, Storybook, ...)
+  const nextLocale = useRouter()?.locale;
+
+  if (!locale && nextLocale) {
+    locale = nextLocale;
+  }
 
   if (!locale) {
     throw new Error(