next-intl 4.0.3 → 4.2.0

package/dist/esm/development/navigation/shared/createSharedNavigationFns.js

@@ -40,8 +40,10 @@ function createSharedNavigationFns(getLocale, routing) {
       href: pathnames == null ? pathname : {
         pathname,
         params
-      }
-    }, locale != null || undefined) : pathname;
+      },
+      // Always include a prefix when changing locales
+      forcePrefix: locale != null || undefined
+    }) : pathname;
     return /*#__PURE__*/jsx(BaseLink, {
       ref: ref
       // @ts-expect-error -- This is ok
@@ -56,9 +58,9 @@ function createSharedNavigationFns(getLocale, routing) {
     });
   }
   const LinkWithRef = /*#__PURE__*/forwardRef(Link);
-  function getPathname(args, /** @private Removed in types returned below */
-  _forcePrefix) {
+  function getPathname(args) {
     const {
+      forcePrefix,
       href,
       locale
     } = args;
@@ -81,7 +83,7 @@ function createSharedNavigationFns(getLocale, routing) {
         pathnames: config.pathnames
       });
     }
-    return applyPathnamePrefix(pathname, locale, config, _forcePrefix);
+    return applyPathnamePrefix(pathname, locale, config, forcePrefix);
   }
   function getRedirectFn(fn) {
     /** @see https://next-intl.dev/docs/routing/navigation#redirect */
@@ -96,8 +98,7 @@ function createSharedNavigationFns(getLocale, routing) {
     Link: LinkWithRef,
     redirect: redirect$1,
     permanentRedirect: permanentRedirect$1,
-    // Remove `_forcePrefix` from public API
-    getPathname: getPathname
+    getPathname
   };
 }
 

package/dist/esm/development/navigation/shared/utils.js

@@ -62,12 +62,15 @@ function compileLocalizedPathname({
 
     // Clean up optional catch-all segments that were not replaced
     compiled = compiled.replace(/\[\[\.\.\..+\]\]/g, '');
-    compiled = normalizeTrailingSlash(compiled);
     if (compiled.includes('[')) {
       // Next.js throws anyway, therefore better provide a more helpful error message
       throw new Error(`Insufficient params provided for localized pathname.\nTemplate: ${template}\nParams: ${JSON.stringify(params)}`);
     }
+    compiled = normalizeTrailingSlash(compiled);
+    compiled = encodePathname(compiled);
     if (query) {
+      // This also encodes non-ASCII characters by
+      // using `new URLSearchParams()` internally
       compiled += serializeSearchParams(query);
     }
     return compiled;
@@ -90,6 +93,29 @@ function compileLocalizedPathname({
     return result;
   }
 }
+function encodePathname(pathname) {
+  // Generally, to comply with RFC 3986 and Google's best practices for URL structures
+  // (https://developers.google.com/search/docs/crawling-indexing/url-structure),
+  // we should always encode non-ASCII characters.
+  //
+  // There are two places where next-intl interacts with potentially non-ASCII URLs:
+  // 1. Middleware: When mapping a localized pathname to a non-localized pathname internally
+  // 2. Navigation APIs: When generating a URLs to be used for <Link /> & friends
+  //
+  // Next.js normalizes incoming pathnames to always be encoded, therefore we can safely
+  // decode them there (see middleware.tsx). On the other hand, Next.js doesn't consistently
+  // encode non-ASCII characters that are passed to navigation APIs:
+  // 1. <Link /> doesn't encode non-ASCII characters
+  // 2. useRouter() uses `new URL()` internally, which will encode—but only if necessary
+  // 3. redirect() uses useRouter() on the client, but on the server side only
+  //    assigns the location header without encoding.
+  //
+  // In addition to this, for getPathname() we need to encode non-ASCII characters.
+  //
+  // Therefore, the bottom line is that next-intl should take care of encoding non-ASCII
+  // characters in all cases, but can rely on `new URL()` to not double-encode characters.
+  return pathname.split('/').map(segment => encodeURIComponent(segment)).join('/');
+}
 function getRoute(locale, pathname, pathnames) {
   const sortedPathnames = getSortedPathnames(Object.keys(pathnames));
   const decoded = decodeURI(pathname);

package/dist/esm/production/navigation/shared/createSharedNavigationFns.js

@@ -1 +1 @@
-import{redirect as e,permanentRedirect as t}from"next/navigation";import{forwardRef as o}from"react";import{receiveRoutingConfig as r}from"../../routing/config.js";import n from"../../shared/use.js";import{isLocalizableHref as a,isPromise as i}from"../../shared/utils.js";import m from"./BaseLink.js";import{serializeSearchParams as c,compileLocalizedPathname as l,applyPathnamePrefix as f,normalizeNameOrNameWithParams as s}from"./utils.js";import{jsx as p}from"react/jsx-runtime";function u(u,h){const j=r(h||{}),d=j.pathnames;function g({href:e,locale:t,...o},r){let c,l;"object"==typeof e?(c=e.pathname,l=e.params):c=e;const f=a(e),s=u(),h=i(s)?n(s):s,g=f?k({locale:t||h,href:null==d?c:{pathname:c,params:l}},null!=t||void 0):c;return p(m,{ref:r,href:"object"==typeof e?{...e,pathname:g}:g,locale:t,localeCookie:j.localeCookie,...o})}const y=o(g);function k(e,t){const{href:o,locale:r}=e;let n;return null==d?"object"==typeof o?(n=o.pathname,o.query&&(n+=c(o.query))):n=o:n=l({locale:r,...s(o),pathnames:j.pathnames}),f(n,r,j,t)}function b(e){return function(t,...o){return e(k(t),...o)}}const x=b(e),q=b(t);return{config:j,Link:y,redirect:x,permanentRedirect:q,getPathname:k}}export{u as default};
+import{redirect as e,permanentRedirect as t}from"next/navigation";import{forwardRef as o}from"react";import{receiveRoutingConfig as r}from"../../routing/config.js";import n from"../../shared/use.js";import{isLocalizableHref as a,isPromise as i}from"../../shared/utils.js";import c from"./BaseLink.js";import{serializeSearchParams as f,compileLocalizedPathname as m,applyPathnamePrefix as l,normalizeNameOrNameWithParams as s}from"./utils.js";import{jsx as p}from"react/jsx-runtime";function u(u,h){const j=r(h||{}),d=j.pathnames;function g({href:e,locale:t,...o},r){let f,m;"object"==typeof e?(f=e.pathname,m=e.params):f=e;const l=a(e),s=u(),h=i(s)?n(s):s,g=l?y({locale:t||h,href:null==d?f:{pathname:f,params:m},forcePrefix:null!=t||void 0}):f;return p(c,{ref:r,href:"object"==typeof e?{...e,pathname:g}:g,locale:t,localeCookie:j.localeCookie,...o})}const x=o(g);function y(e){const{forcePrefix:t,href:o,locale:r}=e;let n;return null==d?"object"==typeof o?(n=o.pathname,o.query&&(n+=f(o.query))):n=o:n=m({locale:r,...s(o),pathnames:j.pathnames}),l(n,r,j,t)}function k(e){return function(t,...o){return e(y(t),...o)}}const b=k(e),P=k(t);return{config:j,Link:x,redirect:b,permanentRedirect:P,getPathname:y}}export{u as default};

package/dist/esm/production/navigation/shared/utils.js

@@ -1 +1 @@
-import{getSortedPathnames as e,matchesPathname as n,isLocalizableHref as t,prefixPathname as r,getLocalizedTemplate as o,normalizeTrailingSlash as a,getLocalePrefix as i}from"../../shared/utils.js";function c(e){return"string"==typeof e?{pathname:e}:e}function s(e){function n(e){return String(e)}const t=new URLSearchParams;for(const[r,o]of Object.entries(e))Array.isArray(o)?o.forEach((e=>{t.append(r,n(e))})):t.set(r,n(o));return"?"+t.toString()}function f({pathname:e,locale:n,params:t,pathnames:r,query:i}){function c(e){let n=r[e];return n||(n=e),n}function f(e,r){let c=o(e,n,r);return t&&Object.entries(t).forEach((([e,n])=>{let t,r;Array.isArray(n)?(t=`(\\[)?\\[...${e}\\](\\])?`,r=n.map((e=>String(e))).join("/")):(t=`\\[${e}\\]`,r=String(n)),c=c.replace(new RegExp(t,"g"),r)})),c=c.replace(/\[\[\.\.\..+\]\]/g,""),c=a(c),i&&(c+=s(i)),c}if("string"==typeof e){return f(c(e),e)}{const{pathname:n,...t}=e;return{...t,pathname:f(c(n),n)}}}function u(t,r,a){const i=e(Object.keys(a)),c=decodeURI(r);for(const e of i){const r=a[e];if("string"==typeof r){if(n(r,c))return e}else if(n(o(r,t,e),c))return e}return r}function l(e,n=window.location.pathname){return"/"===e?n:n.replace(e,"")}function p(e,n,o,a){const{mode:c}=o.localePrefix;let s;return void 0!==a?s=a:t(e)&&("always"===c?s=!0:"as-needed"===c&&(s=o.domains?!o.domains.some((e=>e.defaultLocale===n)):n!==o.defaultLocale)),s?r(i(n,o.localePrefix),e):e}export{p as applyPathnamePrefix,f as compileLocalizedPathname,l as getBasePath,u as getRoute,c as normalizeNameOrNameWithParams,s as serializeSearchParams};
+import{getSortedPathnames as e,matchesPathname as n,isLocalizableHref as t,prefixPathname as r,getLocalizedTemplate as o,normalizeTrailingSlash as a,getLocalePrefix as i}from"../../shared/utils.js";function c(e){return"string"==typeof e?{pathname:e}:e}function s(e){function n(e){return String(e)}const t=new URLSearchParams;for(const[r,o]of Object.entries(e))Array.isArray(o)?o.forEach((e=>{t.append(r,n(e))})):t.set(r,n(o));return"?"+t.toString()}function f({pathname:e,locale:n,params:t,pathnames:r,query:i}){function c(e){let n=r[e];return n||(n=e),n}function f(e,r){let c=o(e,n,r);return t&&Object.entries(t).forEach((([e,n])=>{let t,r;Array.isArray(n)?(t=`(\\[)?\\[...${e}\\](\\])?`,r=n.map((e=>String(e))).join("/")):(t=`\\[${e}\\]`,r=String(n)),c=c.replace(new RegExp(t,"g"),r)})),c=c.replace(/\[\[\.\.\..+\]\]/g,""),c=a(c),c=function(e){return e.split("/").map((e=>encodeURIComponent(e))).join("/")}(c),i&&(c+=s(i)),c}if("string"==typeof e){return f(c(e),e)}{const{pathname:n,...t}=e;return{...t,pathname:f(c(n),n)}}}function u(t,r,a){const i=e(Object.keys(a)),c=decodeURI(r);for(const e of i){const r=a[e];if("string"==typeof r){if(n(r,c))return e}else if(n(o(r,t,e),c))return e}return r}function l(e,n=window.location.pathname){return"/"===e?n:n.replace(e,"")}function p(e,n,o,a){const{mode:c}=o.localePrefix;let s;return void 0!==a?s=a:t(e)&&("always"===c?s=!0:"as-needed"===c&&(s=o.domains?!o.domains.some((e=>e.defaultLocale===n)):n!==o.defaultLocale)),s?r(i(n,o.localePrefix),e):e}export{p as applyPathnamePrefix,f as compileLocalizedPathname,l as getBasePath,u as getRoute,c as normalizeNameOrNameWithParams,s as serializeSearchParams};

package/dist/types/navigation/react-client/createNavigation.d.ts

@@ -335,6 +335,7 @@ export default function createNavigation<const AppLocales extends Locales, const
                 query?: import("../shared/utils.js").QueryParams;
             }) : never : never;
             locale: Locale;
+            forcePrefix?: boolean;
         }) => string>[0]["href"], options?: (Partial<import("next/dist/shared/lib/app-router-context.shared-runtime.js").NavigateOptions> & {
             locale?: Locale;
         }) | undefined) => void;
@@ -359,6 +360,7 @@ export default function createNavigation<const AppLocales extends Locales, const
                 query?: import("../shared/utils.js").QueryParams;
             }) : never : never;
             locale: Locale;
+            forcePrefix?: boolean;
         }) => string>[0]["href"], options?: (Partial<import("next/dist/shared/lib/app-router-context.shared-runtime.js").NavigateOptions> & {
             locale?: Locale;
         }) | undefined) => void;
@@ -383,6 +385,7 @@ export default function createNavigation<const AppLocales extends Locales, const
                 query?: import("../shared/utils.js").QueryParams;
             }) : never : never;
             locale: Locale;
+            forcePrefix?: boolean;
         }) => string>[0]["href"], options?: (Partial<import("next/dist/shared/lib/app-router-context.shared-runtime.js").PrefetchOptions> & {
             locale?: Locale;
         }) | undefined) => void;
@@ -410,8 +413,9 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: Locale;
+        forcePrefix?: boolean;
     }) => string;
-    redirect: (args: Omit<{
+    redirect: (args: {
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: import("../shared/utils.js").QueryParams;
@@ -431,8 +435,9 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: Locale;
-    }, "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
-    permanentRedirect: (args: Omit<{
+        forcePrefix?: boolean;
+    }, type?: import("next/navigation.js").RedirectType | undefined) => never;
+    permanentRedirect: (args: {
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: import("../shared/utils.js").QueryParams;
@@ -452,5 +457,6 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: Locale;
-    }, "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
+        forcePrefix?: boolean;
+    }, type?: import("next/navigation.js").RedirectType | undefined) => never;
 };

package/dist/types/navigation/react-server/createNavigation.d.ts

@@ -313,7 +313,7 @@ export default function createNavigation<const AppLocales extends Locales, const
             pathname: T;
         } & Omit<import("url").UrlObject, "pathname">) : never : never;
     }, "ref"> & import("react").RefAttributes<HTMLAnchorElement>>;
-    redirect: (args: Omit<{
+    redirect: (args: {
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: import("../shared/utils.js").QueryParams;
@@ -333,8 +333,9 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: import("use-intl").Locale;
-    }, "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
-    permanentRedirect: (args: Omit<{
+        forcePrefix?: boolean;
+    }, type?: import("next/navigation.js").RedirectType | undefined) => never;
+    permanentRedirect: (args: {
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: import("../shared/utils.js").QueryParams;
@@ -354,7 +355,8 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: import("use-intl").Locale;
-    }, "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
+        forcePrefix?: boolean;
+    }, type?: import("next/navigation.js").RedirectType | undefined) => never;
     getPathname: (args: {
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
@@ -375,5 +377,6 @@ export default function createNavigation<const AppLocales extends Locales, const
             query?: import("../shared/utils.js").QueryParams;
         }) : never : never;
         locale: import("use-intl").Locale;
+        forcePrefix?: boolean;
     }) => string;
 };

package/dist/types/navigation/shared/createSharedNavigationFns.d.ts

@@ -331,29 +331,38 @@ export default function createSharedNavigationFns<const AppLocales extends Local
             pathname: T;
         } & Omit<import("url").UrlObject, "pathname">) : never : never;
     }, "ref"> & import("react").RefAttributes<HTMLAnchorElement>>;
-    redirect: (args: Omit<Parameters<(args: {
+    redirect: (args: Parameters<(args: {
         /** @see https://next-intl.dev/docs/routing/navigation#getpathname */
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: QueryParams;
         } : HrefOrHrefWithParams<keyof AppPathnames>;
+        /** The locale to compute the pathname for. */
         locale: Locale;
-    }, _forcePrefix?: boolean) => string>[0], "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
-    permanentRedirect: (args: Omit<Parameters<(args: {
+        /** Will prepend the pathname with the locale prefix, regardless of your `localePrefix` setting. This can be helpful to update a locale cookie when changing locales. */
+        forcePrefix?: boolean;
+    }) => string>[0], type?: import("next/navigation.js").RedirectType | undefined) => never;
+    permanentRedirect: (args: Parameters<(args: {
         /** @see https://next-intl.dev/docs/routing/navigation#getpathname */
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: QueryParams;
         } : HrefOrHrefWithParams<keyof AppPathnames>;
+        /** The locale to compute the pathname for. */
         locale: Locale;
-    }, _forcePrefix?: boolean) => string>[0], "domain">, type?: import("next/navigation.js").RedirectType | undefined) => never;
-    getPathname: (args: Parameters<(args: {
+        /** Will prepend the pathname with the locale prefix, regardless of your `localePrefix` setting. This can be helpful to update a locale cookie when changing locales. */
+        forcePrefix?: boolean;
+    }) => string>[0], type?: import("next/navigation.js").RedirectType | undefined) => never;
+    getPathname: (args: {
         /** @see https://next-intl.dev/docs/routing/navigation#getpathname */
         href: [AppPathnames] extends [never] ? string | {
             pathname: string;
             query?: QueryParams;
         } : HrefOrHrefWithParams<keyof AppPathnames>;
+        /** The locale to compute the pathname for. */
         locale: Locale;
-    }, _forcePrefix?: boolean) => string>[0]) => string;
+        /** Will prepend the pathname with the locale prefix, regardless of your `localePrefix` setting. This can be helpful to update a locale cookie when changing locales. */
+        forcePrefix?: boolean;
+    }) => string;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "4.0.3",
+  "version": "4.2.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "funding": [
@@ -112,7 +112,7 @@
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
     "negotiator": "^1.0.0",
-    "use-intl": "^4.0.3"
+    "use-intl": "^4.2.0"
   },
   "peerDependencies": {
     "next": "^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0",
@@ -124,5 +124,5 @@
       "optional": true
     }
   },
-  "gitHead": "19c27a23384fdf746fde30bf3919c2fd8c0fd568"
+  "gitHead": "e303923f7339356cf2c1d64adcdc9498531d8db8"
 }