Skip to content

Latest commit

 

History

History
582 lines (308 loc) · 29.8 KB

CHANGELOG.md

File metadata and controls

582 lines (308 loc) · 29.8 KB

5.1.4 (2024-09-02)

5.1.3 (2024-04-01)

5.1.2 (2024-03-23)

5.1.1 (2024-03-03)

5.1.0 (2024-02-29)

Features

  • remove Next.js experimental esmExternals config and update packages (2464094)

5.0.37 (2024-02-11)

5.0.36 (2024-01-28)

5.0.35 (2024-01-16)

5.0.34 (2024-01-07)

5.0.33 (2024-01-01)

5.0.32 (2023-12-24)

5.0.31 (2023-12-16)

5.0.30 (2023-12-09)

5.0.29 (2023-12-02)

5.0.28 (2023-11-25)

5.0.27 (2023-11-18)

5.0.26 (2023-11-04)

5.0.25 (2023-10-28)

5.0.24 (2023-10-21)

5.0.23 (2023-10-13)

5.0.22 (2023-09-30)

5.0.21 (2023-09-23)

5.0.20 (2023-09-17)

5.0.19 (2023-09-10)

5.0.18 (2023-09-02)

5.0.17 (2023-08-26)

5.0.16 (2023-08-19)

5.0.15 (2023-08-11)

Features

  • add support for Next.js 13.4.13 (67367ab)

5.0.14 (2023-08-05)

5.0.13 (2023-08-03)

Bug Fixes

  • allow leading/trailing non-breaking in .properties files (c69d821)

5.0.12 (2023-07-29)

5.0.11 (2023-07-22)

5.0.10 (2023-07-15)

5.0.9 (2023-07-09)

5.0.8 (2023-07-01)

5.0.7 (2023-06-24)

5.0.6 (2023-06-17)

5.0.5 (2023-06-09)

5.0.4 (2023-06-02)

5.0.3 (2023-05-26)

5.0.2 (2023-05-20)

5.0.1 (2023-05-13)

5.0.0 (2023-05-06)

BREAKING CHANGES

  • Dropping support for Node.js 14 since it is no longer maintained.

4.2.23 (2023-04-30)

4.2.22 (2023-04-24)

4.2.21 (2023-04-16)

4.2.20 (2023-04-08)

4.2.19 (2023-04-01)

4.2.18 (2023-03-25)

4.2.17 (2023-03-18)

Bug Fixes

  • locale cookie being set as a session cookie (a46a311)

4.2.16 (2023-03-11)

4.2.15 (2023-03-04)

4.2.14 (2023-02-27)

4.2.14-0 (2023-02-27)

Bug Fixes

  • fix race condition where the actual locale is not updated (454ae01)

4.2.13 (2023-02-25)

4.2.12 (2023-02-18)

4.2.11 (2023-02-11)

4.2.10 (2023-02-03)

4.2.9 (2023-01-30)

Reverts

  • Revert esmExternals as it is causing build issues (bfb5a5f)

4.2.8 (2023-01-30)

4.2.7 (2023-01-29)

4.2.6 (2023-01-21)

4.2.5 (2023-01-15)

4.2.4 (2023-01-10)

4.2.3 (2022-12-31)

4.2.2 (2022-12-26)

4.2.1 (2022-12-19)

4.2.0 (2022-12-13)

Features

  • add a isLoading property to useGetLocalizedUrl (5e35b5d)

BREAKING CHANGES

  • useGetLocalizedUrl no longer returns a function. It needs to be decomposed using { getLocalizedUrl } to also support the new isLoading property.

4.1.0 (2022-12-13)

Features

  • add the new useGetLocalizedUrl hook (6f87152)

4.0.0 (2022-12-13)

Bug Fixes

  • fix TypeError: Cannot read properties of undefined (reading '__rewrites') (dd688ee)
  • fix incorrect handling of casing in dynamic route parameters (36af5f1)

BREAKING CHANGES

  • getLocalizedUrl is now async to avoid triggering a rare error (TypeError: Cannot read properties of undefined (reading '__rewrites')) because of how Next.js works.. This only occurred when performing fast operations on the site and was amplified while upgrading to Cypress 12 which seems to be much faster at running tests.

3.0.12 (2022-12-07)

Bug Fixes

  • Fix Watchpack errors that could occur in large projects (d0a6aa6)

3.0.11 (2022-12-07)

Performance Improvements

  • cache useMessage to make it more performant (e3996b1)

3.0.10 (2022-12-06)

Bug Fixes

  • fix a routing issue where localized dynamic routes would intercept static routes (4cc82c6)
  • fix an issue where redirects would have the wrong casing for localized dynamic route parameters (73dccf2)

3.0.9 (2022-12-04)

3.0.8 (2022-11-28)

3.0.5-3.0.7 (2022-11-18)

Bug Fixes

  • fix internal server errors on the homepage when deploying on Vercel and Netlify

3.0.4 (2022-11-13)

3.0.3 (2022-11-06)

3.0.2 (2022-11-04)

Features

  • add ref support on our Link component. This will enable using the as={Link} on many popular UI frameworks following the Next.js 13 Link breaking change (8400b5b)

3.0.1 (2022-10-31)

Bug Fixes

  • preserve casing for dynamic route parameter names (9f43bcd)

3.0.0 (2022-10-27)

Features

  • add catch-all dynamic route support (668ba1d)

BREAKING CHANGES

  • The configuration now requires a new defaultLocale parameter (it used to be implicit).
  • getHtmlLang now takes a DocumentProps object as an argument to better align with functional components.
  • getLocalizedRouteParameters takes new parameter: import.meta.url
    • <Link>, useLocalizedUrl, getLocalizedUrl no longer allow UrlObject to be passed in argument. Only strings are supported to simplify the API types. UrlObject.href can easily be used instead of passing the object directly. - useRouter().query is no longer used to pass dynamic route parameters. Full URLs should be provided instead.
  • useLocalizedUrl and getLocalizedUrl have a new 3rd parameter: localizedRouteParameters - meaning the existing parameters will shift by 1 position.
  • slugify's locale argument is now mandatory.

2.0.4 (2022-10-13)

2.0.3 (2022-10-09)

2.0.2 (2022-10-03)

2.0.1 (2022-09-25)

2.0.0 (2022-09-18)

Features

  • simplified APIs to access locale values (ac2dcb3)

BREAKING CHANGES

  • replaced the first few getLocalizedRouteParameters arguments to take directly the getStaticProps or getServerSideProps contexts.
  • useRouter will now return the locales used by next-multilingual instead of those used by Next.js:
    • getActualLocale, getActualLocales and getActualDefaultLocale should not longer be required
  • replacing MultilingualStaticProps by getStaticPropsLocales
  • replacing MultilingualServerSideProps by getServerSidePropsLocales

1.5.0 (2022-09-15)

Features

  • support localized dynamic route (159e0b2)
  • support the .. syntax in localized URL APIs (bad63d5)

BREAKING CHANGES

  • Move useRouter to next-multilingual/router
  • Dynamic routes no longer works without using getLocalizedRouteParameters

1.4.2 (2022-08-23)

1.4.1 (2022-08-17)

Features

  • add the new MultilingualServerSideProps & MultilingualStaticProps types (4351938)

1.4.0 (2022-08-14)

Bug Fixes

  • missing argument while deleting the locale cookie (344adf5)

Features

  • add new argument to useActualLocale to simplify integration and a new resolveLocale API (93b1c8e)

1.3.0 (2022-08-14)

Features

  • add new hooks and APIs to simplify integration (details in README):

    • useActualLocale: used in _app for smart locale detection. (99d10b4)
    • useResolvedLocale: used in the homepage for smart locale detection. (abadb36)
    • getHtmlLang: used in _document to get the html tag lang attribute value (99d10b4)
    • useRouter: wrapper on top of Next.js' to avoid undefined types on locale properties (they are never undefined with next-multilingual) (99d10b4)

Performance Improvements

  • optimize useRouter with a useMemo (fde5af0)
  • fix locales must be configured in Next.js error being thrown during other unrelated Internal Server Errors. (99d10b4)

1.2.1 (2022-08-12)

Features

  • support directories for 404 and 500 error pages (1564860)

1.2.0 (2022-08-12)

Code Refactoring

  • add eslint-plugin-unicorn to help increase code quality (3f109e4)

Features

  • support export from syntax for shared messages (d78a846)

BREAKING CHANGES

  • Using the node: scheme to better identify Node.js modules requires advanced config users to extend the new webpackConfigurationHandler (see README for details)

1.1.2 (2022-08-01)

Bug Fixes

  • fix ESLint exports import resolver issue (61048e3)
  • fix ESLint issues (5056cb9)
  • remove non-standard Apple character (8cfd32a)

1.1.1 (2022-07-25)

1.1.0 (2022-07-25)

Code Refactoring

  • use the new messages-modules package to generate the Babel plugin (127caad)

BREAKING CHANGES

  • namespace imports (import * as messages from 'next-multilingual/messages') of useMessages and getMessages are no longer be supported

1.0.7 (2022-07-23)

1.0.6 (2022-07-17)

1.0.5 (2022-07-11)

Features

  • add new exists method on messages (b16babc)

1.0.4 (2022-07-10)

Bug Fixes

  • fix a bug that did prevented automatic content refresh during development for .ts files (80e0ae9)

1.0.3 (2022-07-03)

1.0.2 (2022-06-30)

1.0.1 (2022-06-18)

1.0.0 (2022-06-13)

🎉 After almost a year of development, we consider our APIs mature enough to release version 1.

Features

  • add key collision detection in .properties files (6c37ada)

0.12.0 (2022-06-04)

Bug Fixes

  • apply LightHouse recommendations to improve the example's score (5ac3c3c)
  • remove generic JSX.Element type on Head and Link components (b4aafda)

BREAKING CHANGES

  • This change should be backward compatible but there is a slight risk of breaking certain implementations since the return type is changing.

0.11.2 (2022-06-04)

Bug Fixes

  • use localized URL instead of the default locale for canonical links (a4e98b8)

0.11.1 (2022-05-14)

Features

  • replicate Next.js' behavior with trailing slashes in URLs (fe98515)

0.11.0 (2022-04-25)

Bug Fixes

  • example: abort API calls when switching language on the example's homepage (bf1e658)

Features

  • add basePath support and new getLocalizedUrl API (fb7f9cf)

BREAKING CHANGES

  • useLocalizedUrl was moved from next-multilingual/link to next-multilingual/url

0.10.4 (2022-03-14)

Features

  • link: add support for absolute URLs in the link component (90cabc2)## 0.10.3 (2022-02-07)

0.10.3 (2022-02-06)

Features

  • link: add localized anchor links support (6b1351f)

0.10.2 (2022-01-26)

Bug Fixes

  • re-export Message and Messages classes to be usable as types (690e41f)

0.10.1 (2022-01-26)

Bug Fixes

  • downgrade to Node.js 14 for Vercel support (f4cf125)

0.10.0 (2022-01-25)

Features

  • inline-jsx: complete the inline-jsx feature including tests and documentation (855c8af)
  • encoding: support optional BOM characters of .properties file (e9e79ab)

0.9.7 (2022-01-06)

Bug Fixes

  • SSR: disable esmExternals until we support ES modules to fix localized URLs SSR markup (26ddb22)

0.9.6 (2022-01-05)

Bug Fixes

  • SSR: replace Chokidar with CheapWatch (e5a1951)

0.9.5 (2022-01-05)

Features

  • debug: add new debug option for advanced configuration (33f4320)

0.9.4 (2022-01-05)

0.9.3 (2022-01-04)

Bug Fixes

  • test: add test for builds and fix failing tests (c493655)

0.9.2 (2022-01-04)

Bug Fixes

  • TypeError: Cannot read properties of undefined (reading '__rewrites') (ee2a5e4)

0.9.1 (2022-01-04)

0.9.0 (2021-12-27)

Bug Fixes

  • cookies: fix SameSite warning on cookies (28f6403)
  • favicon: fix missing favicon browser warnings (871f87d)
  • head: normalize locale capitalization in HTML attributes (269cab9)
  • ssr: fix an issue where the server would be desynchronized with the client (777a719)
  • urls: make localized dynamic routes work (7c185bd)

Features

  • urls: add new hook useLocalizedUrl to enable localized URLs outside of the <Link> component (b759923)
  • tests: add automated Cypress tests (fb1bd95)
  • encoding: add warnings when file encoding issues are detected (4c21b0a)

0.8.4 (2021-11-28)

  • 🐛 fix NEXT_PUBLIC_ORIGIN trailing slash bug (493b96c)

0.8.3 (2021-11-28)

  • 🐛 fix NEXT_PUBLIC_ORIGIN trailing slash bug (8a8cb07)

0.8.2 (2021-11-28)

  • 🐛 fix 0.8.1 client-side non-localized URLs bug (2ff53e2)

0.8.1 (2021-11-27)

  • 🐛 fix non-localized SSR URLs in <Head> (841669a)

0.8.0 (2021-11-21)

  • 💥 breaking change - rename core APIs: MulConfig -> Config, getMulConfig -> getConfig, MulLink -> Link, MulHead -> Head (47a1c7c)
  • 🐛 revert change introduced in 0.7.4 to correctly hydrate dynamic route links

0.7.4 (2021-11-15)

0.7.3 (2021-11-15)

  • ✨ added dynamic routes support

0.7.2 (2021-10-31)

0.7.1 (2021-10-31)

0.7.0 (2021-10-28)

  • 💥 breaking change - the slugKeyId parameter has been removed from MulConfig to keep the overall solution simpler (4a8a805)

0.6.0 (2021-10-27)

  • 💥 breaking change - refactoring the getTitle to return a string instead of a Message object (9283a67)
  • ⚡️ increased performance of messages.format()

0.5.0 (2021-10-25)

  • ✨ added getMessages to support localized Next.js API Routes

0.4.1 (2021-10-20)

0.4.0 (2021-10-18)

  • 💥 breaking change - renaming the pageTitle message key by slug for localized URLs (6082034)

0.3.2 (2021-09-25)

0.3.1 (2021-09-24)

0.3.0 (2021-09-18)

0.2.0 (2021-09-12)

0.1.5 (2021-09-07)

0.1.4 (2021-09-06)

0.1.3 (2021-09-06)

0.1.2 (2021-09-01)

0.1.1 (2021-08-28)

0.1.0 Initial release (2021-08-28)

  • localized URLs supporting UTF-8 characters
  • locale prefix for all locales, including the default locale
  • dynamic localized display on / without the need of redirection
  • useMessages() hook to access local scope messages
  • <MulHead> component generating canonical and alternate links HTML markup