next-intl 3.14.1 → 3.15.0-custom-prefixes.0

package/dist/types/src/navigation/react-client/ClientLink.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="node" />
 import React, { ComponentProps, ReactElement } from 'react';
-import { AllLocales } from '../../shared/types';
+import { Locales, LocalePrefixConfigVerbose } from '../../routing/types';
 import BaseLink from '../shared/BaseLink';
-type Props<Locales extends AllLocales> = Omit<ComponentProps<typeof BaseLink>, 'locale'> & {
-    locale?: Locales[number];
+type Props<AppLocales extends Locales> = Omit<ComponentProps<typeof BaseLink>, 'locale' | 'prefix' | 'localePrefixMode'> & {
+    locale?: AppLocales[number];
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
 };
 /**
  * Wraps `next/link` and prefixes the `href` with the current locale if
@@ -25,7 +26,7 @@ type Props<Locales extends AllLocales> = Omit<ComponentProps<typeof BaseLink>, '
  * the `set-cookie` response header would cause the locale cookie on the current
  * page to be overwritten before the user even decides to change the locale.
  */
-declare const ClientLinkWithRef: <Locales extends AllLocales>(props: Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
+declare const ClientLinkWithRef: <AppLocales extends Locales>(props: Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
     href: string | import("url").UrlObject;
     as?: (string | import("url").UrlObject) | undefined;
     replace?: boolean | undefined;
@@ -55,9 +56,11 @@ declare const ClientLinkWithRef: <Locales extends AllLocales>(props: Omit<Omit<O
     children?: React.ReactNode;
 } & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
     locale: string;
-    localePrefix?: import("../../shared/types").LocalePrefix | undefined;
-}, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
-    locale?: Locales[number] | undefined;
+    prefix: string;
+    localePrefixMode: import("../../routing/types").LocalePrefixMode;
+}, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale" | "prefix" | "localePrefixMode"> & {
+    locale?: AppLocales[number] | undefined;
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
 } & {
     ref?: React.LegacyRef<HTMLAnchorElement> | undefined;
 }) => ReactElement;

package/dist/types/src/navigation/react-client/createLocalizedPathnamesNavigation.d.ts

@@ -1,14 +1,11 @@
 /// <reference types="node" />
 import React, { ComponentProps, ReactElement } from 'react';
-import { AllLocales, LocalePrefix, Pathnames } from '../../shared/types';
+import { Locales, Pathnames } from '../../routing/types';
+import { LocalizedNavigationRoutingConfigInput } from '../shared/config';
 import { HrefOrHrefWithParams } from '../shared/utils';
 import ClientLink from './ClientLink';
-export default function createLocalizedPathnamesNavigation<Locales extends AllLocales, PathnamesConfig extends Pathnames<Locales>>(opts: {
-    locales: Locales;
-    pathnames: PathnamesConfig;
-    localePrefix?: LocalePrefix;
-}): {
-    Link: <Pathname extends keyof PathnamesConfig>(props: Omit<Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
+export default function createLocalizedPathnamesNavigation<AppLocales extends Locales, AppPathnames extends Pathnames<AppLocales>>(input: LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames>): {
+    Link: <Pathname extends keyof AppPathnames>(props: Omit<Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
         href: string | import("url").UrlObject;
         as?: (string | import("url").UrlObject) | undefined;
         replace?: boolean | undefined;
@@ -38,12 +35,14 @@ export default function createLocalizedPathnamesNavigation<Locales extends AllLo
         children?: React.ReactNode;
     } & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
         locale: string;
-        localePrefix?: LocalePrefix | undefined;
-    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
+        prefix: string;
+        localePrefixMode: import("../../routing/types").LocalePrefixMode;
+    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale" | "prefix" | "localePrefixMode"> & {
         locale?: string | undefined;
+        localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<Locales>;
     } & {
         ref?: React.LegacyRef<HTMLAnchorElement> | undefined;
-    }, "href" | "name"> & {
+    }, "href" | "localePrefix" | "name"> & {
         href: Pathname extends `${string}[[...${string}` ? Pathname | ({
             pathname: Pathname;
             params?: import("../shared/StrictParams").default<Pathname> | undefined;
@@ -53,29 +52,29 @@ export default function createLocalizedPathnamesNavigation<Locales extends AllLo
         } & Omit<import("url").UrlObject, "pathname"> : Pathname | ({
             pathname: Pathname;
         } & Omit<import("url").UrlObject, "pathname">);
-        locale?: Locales[number] | undefined;
+        locale?: AppLocales[number] | undefined;
     } & {
         ref?: ComponentProps<typeof ClientLink>['ref'];
     }) => ReactElement;
-    redirect: <Pathname_1 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_1>, type?: import("next/navigation").RedirectType | undefined) => never;
-    permanentRedirect: <Pathname_2 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_2>, type?: import("next/navigation").RedirectType | undefined) => never;
-    usePathname: () => keyof PathnamesConfig;
+    redirect: <Pathname_1 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_1>, type?: import("next/navigation").RedirectType | undefined) => never;
+    permanentRedirect: <Pathname_2 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_2>, type?: import("next/navigation").RedirectType | undefined) => never;
+    usePathname: () => keyof AppPathnames;
     useRouter: () => {
-        push<Pathname_3 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_3>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
-            locale?: string | undefined;
+        push<Pathname_3 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_3>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
+            locale?: AppLocales[number] | undefined;
         }) | undefined): void;
-        replace<Pathname_4 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_4>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
-            locale?: string | undefined;
+        replace<Pathname_4 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_4>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
+            locale?: AppLocales[number] | undefined;
         }) | undefined): void;
-        prefetch<Pathname_5 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_5>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").PrefetchOptions & {
-            locale?: string | undefined;
+        prefetch<Pathname_5 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_5>, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").PrefetchOptions & {
+            locale?: AppLocales[number] | undefined;
         }) | undefined): void;
         back(): void;
         forward(): void;
         refresh(): void;
     };
     getPathname: ({ href, locale }: {
-        locale: Locales[number];
-        href: HrefOrHrefWithParams<keyof PathnamesConfig>;
+        locale: AppLocales[number];
+        href: HrefOrHrefWithParams<keyof AppPathnames>;
     }) => string;
 };

package/dist/types/src/navigation/react-client/createSharedPathnamesNavigation.d.ts

@@ -1,11 +1,8 @@
 /// <reference types="node" />
 import React, { ReactElement } from 'react';
-import { AllLocales, LocalePrefix } from '../../shared/types';
-import useBaseRouter from './useBaseRouter';
-export default function createSharedPathnamesNavigation<Locales extends AllLocales>(opts?: {
-    locales?: Locales;
-    localePrefix?: LocalePrefix;
-}): {
+import { Locales } from '../../routing/types';
+import { SharedNavigationRoutingConfigInput } from '../shared/config';
+export default function createSharedPathnamesNavigation<const AppLocales extends Locales>(input?: SharedNavigationRoutingConfigInput<AppLocales>): {
     Link: (props: Omit<Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
         href: string | import("url").UrlObject;
         as?: (string | import("url").UrlObject) | undefined;
@@ -36,9 +33,11 @@ export default function createSharedPathnamesNavigation<Locales extends AllLocal
         children?: React.ReactNode;
     } & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
         locale: string;
-        localePrefix?: LocalePrefix | undefined;
-    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
-        locale?: Locales[number] | undefined;
+        prefix: string;
+        localePrefixMode: import("../../routing/types").LocalePrefixMode;
+    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale" | "prefix" | "localePrefixMode"> & {
+        locale?: AppLocales[number] | undefined;
+        localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<AppLocales>;
     } & {
         ref?: React.LegacyRef<HTMLAnchorElement> | undefined;
     }, "localePrefix"> & {
@@ -47,5 +46,18 @@ export default function createSharedPathnamesNavigation<Locales extends AllLocal
     redirect: (pathname: string, type?: import("next/navigation").RedirectType | undefined) => never;
     permanentRedirect: (pathname: string, type?: import("next/navigation").RedirectType | undefined) => never;
     usePathname: () => string;
-    useRouter: typeof useBaseRouter;
+    useRouter: () => {
+        push: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
+            locale?: AppLocales[number] | undefined;
+        }) | undefined) => void;
+        replace: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & {
+            locale?: AppLocales[number] | undefined;
+        }) | undefined) => void;
+        prefetch: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").PrefetchOptions & {
+            locale?: AppLocales[number] | undefined;
+        }) | undefined) => void;
+        back(): void;
+        forward(): void;
+        refresh(): void;
+    };
 };

package/dist/types/src/navigation/react-client/index.d.ts

@@ -1,3 +1,5 @@
 export { default as createSharedPathnamesNavigation } from './createSharedPathnamesNavigation';
 export { default as createLocalizedPathnamesNavigation } from './createLocalizedPathnamesNavigation';
-export type { Pathnames } from '../../shared/types';
+import type { Pathnames as PathnamesDeprecatedExport, Locales } from '../../routing/types';
+/** @deprecated Please import from `next-intl/routing` instead. */
+export type Pathnames<AppLocales extends Locales> = PathnamesDeprecatedExport<AppLocales>;

package/dist/types/src/navigation/react-client/redirects.d.ts

@@ -0,0 +1,10 @@
+export declare const clientRedirect: (params: Omit<{
+    pathname: string;
+    locale: string;
+    localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<import("../../routing/types").Locales>;
+}, "locale">, type?: import("next/navigation").RedirectType | undefined) => never;
+export declare const clientPermanentRedirect: (params: Omit<{
+    pathname: string;
+    locale: string;
+    localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<import("../../routing/types").Locales>;
+}, "locale">, type?: import("next/navigation").RedirectType | undefined) => never;

package/dist/types/src/navigation/react-client/useBasePathname.d.ts

@@ -1,3 +1,4 @@
+import { Locales, LocalePrefixConfigVerbose } from '../../routing/types';
 /**
  * Returns the pathname without a potential locale prefix.
  *
@@ -11,4 +12,4 @@
  * const pathname = usePathname();
  * ```
  */
-export default function useBasePathname(): string | null;
+export default function useBasePathname<AppLocales extends Locales>(localePrefix: LocalePrefixConfigVerbose<AppLocales>): string | null;

package/dist/types/src/navigation/react-client/useBaseRouter.d.ts

@@ -1,6 +1,6 @@
-import { AllLocales } from '../../shared/types';
-type IntlNavigateOptions<Locales extends AllLocales> = {
-    locale?: Locales[number];
+import { Locales, LocalePrefixConfigVerbose } from '../../routing/types';
+type IntlNavigateOptions<AppLocales extends Locales> = {
+    locale?: AppLocales[number];
 };
 /**
  * Returns a wrapped instance of `useRouter` from `next/navigation` that
@@ -21,10 +21,10 @@ type IntlNavigateOptions<Locales extends AllLocales> = {
  * router.push('/about', {locale: 'de'});
  * ```
  */
-export default function useBaseRouter<Locales extends AllLocales>(): {
-    push: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & IntlNavigateOptions<Locales>) | undefined) => void;
-    replace: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & IntlNavigateOptions<Locales>) | undefined) => void;
-    prefetch: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").PrefetchOptions & IntlNavigateOptions<Locales>) | undefined) => void;
+export default function useBaseRouter<AppLocales extends Locales>(localePrefix: LocalePrefixConfigVerbose<AppLocales>): {
+    push: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & IntlNavigateOptions<AppLocales>) | undefined) => void;
+    replace: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").NavigateOptions & IntlNavigateOptions<AppLocales>) | undefined) => void;
+    prefetch: (href: string, options?: (import("next/dist/shared/lib/app-router-context.shared-runtime").PrefetchOptions & IntlNavigateOptions<AppLocales>) | undefined) => void;
     back(): void;
     forward(): void;
     refresh(): void;

package/dist/types/src/navigation/react-server/ServerLink.d.ts

@@ -1,8 +1,9 @@
 import React, { ComponentProps } from 'react';
-import { AllLocales } from '../../shared/types';
+import { Locales, LocalePrefixConfigVerbose } from '../../routing/types';
 import BaseLink from '../shared/BaseLink';
-type Props<Locales extends AllLocales> = Omit<ComponentProps<typeof BaseLink>, 'locale'> & {
-    locale?: Locales[number];
+type Props<AppLocales extends Locales> = Omit<ComponentProps<typeof BaseLink>, 'locale' | 'prefix' | 'localePrefixMode'> & {
+    locale?: AppLocales[number];
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
 };
-export default function ServerLink<Locales extends AllLocales>({ locale, ...rest }: Props<Locales>): Promise<React.JSX.Element>;
+export default function ServerLink<AppLocales extends Locales>({ locale, localePrefix, ...rest }: Props<AppLocales>): Promise<React.JSX.Element>;
 export {};

package/dist/types/src/navigation/react-server/createLocalizedPathnamesNavigation.d.ts

@@ -1,13 +1,10 @@
 /// <reference types="node" />
 import React from 'react';
-import { AllLocales, LocalePrefix, Pathnames } from '../../shared/types';
+import { Locales, Pathnames } from '../../routing/types';
+import { LocalizedNavigationRoutingConfigInput } from '../shared/config';
 import { HrefOrHrefWithParams } from '../shared/utils';
-export default function createLocalizedPathnamesNavigation<Locales extends AllLocales, PathnamesConfig extends Pathnames<Locales>>({ localePrefix, locales, pathnames }: {
-    locales: Locales;
-    pathnames: Pathnames<Locales>;
-    localePrefix?: LocalePrefix;
-}): {
-    Link: <Pathname extends keyof PathnamesConfig>({ href, locale, ...rest }: Omit<Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
+export default function createLocalizedPathnamesNavigation<AppLocales extends Locales, AppPathnames extends Pathnames<AppLocales>>(input: LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames>): {
+    Link: <Pathname extends keyof AppPathnames>({ href, locale, ...rest }: Omit<Omit<Omit<Omit<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
         href: string | import("url").UrlObject;
         as?: (string | import("url").UrlObject) | undefined;
         replace?: boolean | undefined;
@@ -37,10 +34,12 @@ export default function createLocalizedPathnamesNavigation<Locales extends AllLo
         children?: React.ReactNode;
     } & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
         locale: string;
-        localePrefix?: LocalePrefix | undefined;
-    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale"> & {
+        prefix: string;
+        localePrefixMode: import("../../routing/types").LocalePrefixMode;
+    }, "ref"> & React.RefAttributes<HTMLAnchorElement>, "locale" | "prefix" | "localePrefixMode"> & {
         locale?: string | undefined;
-    }, "href" | "name"> & {
+        localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<Locales>;
+    }, "href" | "localePrefix" | "name"> & {
         href: Pathname extends `${string}[[...${string}` ? Pathname | ({
             pathname: Pathname;
             params?: import("../shared/StrictParams").default<Pathname> | undefined;
@@ -50,13 +49,13 @@ export default function createLocalizedPathnamesNavigation<Locales extends AllLo
         } & Omit<import("url").UrlObject, "pathname"> : Pathname | ({
             pathname: Pathname;
         } & Omit<import("url").UrlObject, "pathname">);
-        locale?: Locales[number] | undefined;
+        locale?: AppLocales[number] | undefined;
     }) => React.JSX.Element;
-    redirect: <Pathname_1 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_1>, type?: import("next/navigation").RedirectType | undefined) => never;
-    permanentRedirect: <Pathname_2 extends keyof PathnamesConfig>(href: HrefOrHrefWithParams<Pathname_2>, type?: import("next/navigation").RedirectType | undefined) => never;
+    redirect: <Pathname_1 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_1>, type?: import("next/navigation").RedirectType | undefined) => never;
+    permanentRedirect: <Pathname_2 extends keyof AppPathnames>(href: HrefOrHrefWithParams<Pathname_2>, type?: import("next/navigation").RedirectType | undefined) => never;
     getPathname: ({ href, locale }: {
-        locale: Locales[number];
-        href: HrefOrHrefWithParams<keyof PathnamesConfig>;
+        locale: AppLocales[number];
+        href: HrefOrHrefWithParams<keyof AppPathnames>;
     }) => string;
     usePathname: () => never;
     useRouter: () => never;

package/dist/types/src/navigation/react-server/createSharedPathnamesNavigation.d.ts

@@ -1,11 +1,9 @@
 import React, { ComponentProps } from 'react';
-import { AllLocales, LocalePrefix } from '../../shared/types';
+import { Locales } from '../../routing/types';
+import { SharedNavigationRoutingConfigInput } from '../shared/config';
 import ServerLink from './ServerLink';
-export default function createSharedPathnamesNavigation<Locales extends AllLocales>(opts?: {
-    locales?: Locales;
-    localePrefix?: LocalePrefix;
-}): {
-    Link: (props: ComponentProps<typeof ServerLink<Locales>>) => React.JSX.Element;
+export default function createSharedPathnamesNavigation<AppLocales extends Locales>(input?: SharedNavigationRoutingConfigInput<AppLocales>): {
+    Link: (props: Omit<ComponentProps<typeof ServerLink<AppLocales>>, 'localePrefix' | 'locales'>) => React.JSX.Element;
     redirect: (pathname: string, type?: import("next/navigation").RedirectType | undefined) => never;
     permanentRedirect: (pathname: string, type?: import("next/navigation").RedirectType | undefined) => never;
     usePathname: () => never;

package/dist/types/src/navigation/react-server/index.d.ts

@@ -1,3 +1,3 @@
 export { default as createSharedPathnamesNavigation } from './createSharedPathnamesNavigation';
 export { default as createLocalizedPathnamesNavigation } from './createLocalizedPathnamesNavigation';
-export type { Pathnames } from '../../shared/types';
+export type { Pathnames } from '../../routing/types';

package/dist/types/src/navigation/react-server/redirects.d.ts

@@ -0,0 +1,10 @@
+export declare const serverRedirect: (params: Omit<{
+    pathname: string;
+    locale: string;
+    localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<import("../../routing/types").Locales>;
+}, "locale">, type?: import("next/navigation").RedirectType | undefined) => never;
+export declare const serverPermanentRedirect: (params: Omit<{
+    pathname: string;
+    locale: string;
+    localePrefix: import("../../routing/types").LocalePrefixConfigVerbose<import("../../routing/types").Locales>;
+}, "locale">, type?: import("next/navigation").RedirectType | undefined) => never;

package/dist/types/src/navigation/shared/BaseLink.d.ts

@@ -1,9 +1,10 @@
 import NextLink from 'next/link';
 import React, { ComponentProps } from 'react';
-import { LocalePrefix } from '../../shared/types';
+import { LocalePrefixMode } from '../../routing/types';
 type Props = Omit<ComponentProps<typeof NextLink>, 'locale'> & {
     locale: string;
-    localePrefix?: LocalePrefix;
+    prefix: string;
+    localePrefixMode: LocalePrefixMode;
 };
 declare const BaseLinkWithRef: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
 export default BaseLinkWithRef;

package/dist/types/src/navigation/shared/config.d.ts

@@ -0,0 +1,24 @@
+import { RoutingBaseConfigInput } from '../../routing/config';
+import { Locales, LocalePrefixConfigVerbose, Pathnames } from '../../routing/types';
+/**
+ * Shared pathnames
+ */
+export type SharedNavigationRoutingConfigInput<AppLocales extends Locales> = RoutingBaseConfigInput<AppLocales> & {
+    locales?: AppLocales;
+};
+export type SharedNavigationRoutingConfig<AppLocales extends Locales> = SharedNavigationRoutingConfigInput<AppLocales> & {
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
+};
+export declare function receiveSharedNavigationRoutingConfig<AppLocales extends Locales>(input?: SharedNavigationRoutingConfigInput<AppLocales>): SharedNavigationRoutingConfig<AppLocales>;
+/**
+ * Localized pathnames
+ */
+export type LocalizedNavigationRoutingConfigInput<AppLocales extends Locales, AppPathnames extends Pathnames<AppLocales>> = RoutingBaseConfigInput<AppLocales> & {
+    locales: AppLocales;
+    /** Maps internal pathnames to external ones which can be localized per locale. */
+    pathnames: AppPathnames;
+};
+export type LocalizedNavigationRoutingConfig<AppLocales extends Locales, AppPathnames extends Pathnames<AppLocales>> = LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames> & {
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
+};
+export declare function receiveLocalizedNavigationRoutingConfig<AppLocales extends Locales, AppPathnames extends Pathnames<AppLocales>>(input: LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames>): LocalizedNavigationRoutingConfig<AppLocales, AppPathnames>;

package/dist/types/src/navigation/shared/redirects.d.ts

@@ -0,0 +1,11 @@
+import { Locales, LocalePrefixConfigVerbose } from '../../routing/types';
+export declare const baseRedirect: <AppLocales extends Locales>(params: {
+    pathname: string;
+    locale: Locales[number];
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
+}, type?: import("next/navigation").RedirectType | undefined) => never;
+export declare const basePermanentRedirect: <AppLocales extends Locales>(params: {
+    pathname: string;
+    locale: Locales[number];
+    localePrefix: LocalePrefixConfigVerbose<AppLocales>;
+}, type?: import("next/navigation").RedirectType | undefined) => never;

package/dist/types/src/navigation/shared/utils.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 import type { ParsedUrlQueryInput } from 'node:querystring';
 import type { UrlObject } from 'url';
-import { AllLocales, Pathnames } from '../../shared/types';
+import { Locales, Pathnames } from '../../routing/types';
 import StrictParams from './StrictParams';
 type SearchParamValue = ParsedUrlQueryInput[keyof ParsedUrlQueryInput];
 type HrefOrHrefWithParamsImpl<Pathname, Other> = Pathname extends `${string}[[...${string}` ? // Optional catch-all
@@ -29,24 +29,24 @@ export declare function serializeSearchParams(searchParams: Record<string, Searc
 type StrictUrlObject<Pathname> = Omit<UrlObject, 'pathname'> & {
     pathname: Pathname;
 };
-export declare function compileLocalizedPathname<Locales extends AllLocales, Pathname>(opts: {
-    locale: Locales[number];
+export declare function compileLocalizedPathname<AppLocales extends Locales, Pathname>(opts: {
+    locale: AppLocales[number];
     pathname: Pathname;
     params?: StrictParams<Pathname>;
-    pathnames: Pathnames<Locales>;
+    pathnames: Pathnames<AppLocales>;
     query?: Record<string, SearchParamValue>;
 }): string;
-export declare function compileLocalizedPathname<Locales extends AllLocales, Pathname>(opts: {
-    locale: Locales[number];
+export declare function compileLocalizedPathname<AppLocales extends Locales, Pathname>(opts: {
+    locale: AppLocales[number];
     pathname: StrictUrlObject<Pathname>;
     params?: StrictParams<Pathname>;
-    pathnames: Pathnames<Locales>;
+    pathnames: Pathnames<AppLocales>;
     query?: Record<string, SearchParamValue>;
 }): UrlObject;
-export declare function getRoute<Locales extends AllLocales>({ locale, pathname, pathnames }: {
-    locale: Locales[number];
+export declare function getRoute<AppLocales extends Locales>({ locale, pathname, pathnames }: {
+    locale: AppLocales[number];
     pathname: string;
-    pathnames: Pathnames<Locales>;
+    pathnames: Pathnames<AppLocales>;
 }): string;
 export declare function getBasePath(pathname: string, windowPathname?: string): string;
 export {};

package/dist/types/src/routing/config.d.ts

@@ -0,0 +1,14 @@
+import { Locales, DomainConfig, LocalePrefix, LocalePrefixConfigVerbose } from './types';
+/**
+ * Maintainer note: The config that is accepted by the middleware, the shared
+ * and the localized pathnames navigation factory function is slightly
+ * different. This type declares the shared base config that is accepted by all
+ * of them. Properties that are different are declared in consuming types.
+ */
+export type RoutingBaseConfigInput<AppLocales extends Locales> = {
+    /** @see https://next-intl-docs.vercel.app/docs/routing#locale-prefix */
+    localePrefix?: LocalePrefix<AppLocales>;
+    /** Can be used to change the locale handling per domain. */
+    domains?: Array<DomainConfig<AppLocales>>;
+};
+export declare function receiveLocalePrefixConfig<AppLocales extends Locales>(localePrefix?: LocalePrefix<AppLocales>): LocalePrefixConfigVerbose<AppLocales>;

package/dist/types/src/routing/index.d.ts

@@ -0,0 +1,2 @@
+export type { LocalePrefix } from './types';
+export type { Pathnames } from './types';

package/dist/types/src/routing/types.d.ts

@@ -0,0 +1,23 @@
+export type Locales = ReadonlyArray<string>;
+export type LocalePrefixMode = 'always' | 'as-needed' | 'never';
+type Pathname = string;
+export type LocalePrefixes<AppLocales extends Locales> = Partial<Record<AppLocales[number], Pathname>>;
+export type LocalePrefixConfigVerbose<AppLocales extends Locales> = {
+    mode: 'always';
+    prefixes?: LocalePrefixes<AppLocales>;
+} | {
+    mode: 'as-needed';
+    prefixes?: LocalePrefixes<AppLocales>;
+} | {
+    mode: 'never';
+};
+export type LocalePrefix<AppLocales extends Locales = never> = LocalePrefixMode | LocalePrefixConfigVerbose<AppLocales>;
+export type Pathnames<AppLocales extends Locales> = Record<Pathname, Record<AppLocales[number], Pathname> | Pathname>;
+export type DomainConfig<AppLocales extends Locales> = {
+    defaultLocale: AppLocales[number];
+    /** The domain name (e.g. "example.com", "www.example.com" or "fr.example.com"). Note that the `x-forwarded-host` or alternatively the `host` header will be used to determine the requested domain. */
+    domain: string;
+    /** Optionally restrict which locales are available on this domain. */
+    locales?: AppLocales;
+};
+export {};

package/dist/types/src/routing.d.ts

@@ -0,0 +1 @@
+export * from './routing/index';

package/dist/types/src/shared/types.d.ts

@@ -1,7 +1,2 @@
-export type AllLocales = ReadonlyArray<string>;
-export type LocalePrefix = 'as-needed' | 'always' | 'never';
-export type Pathnames<Locales extends AllLocales> = Record<string, {
-    [Key in Locales[number]]: string;
-} | string>;
 export type ParametersExceptFirst<Fn> = Fn extends (arg0: any, ...rest: infer R) => any ? R : never;
 export type ParametersExceptFirstTwo<Fn> = Fn extends (arg0: any, arg1: any, ...rest: infer R) => any ? R : never;

package/dist/types/src/shared/utils.d.ts

@@ -2,20 +2,23 @@
 import { UrlObject } from 'url';
 import NextLink from 'next/link';
 import { ComponentProps } from 'react';
+import { Locales, LocalePrefixConfigVerbose } from '../routing/types';
 type Href = ComponentProps<typeof NextLink>['href'];
 export declare function isRelativeHref(href: Href): boolean;
 export declare function isLocalHref(href: Href): boolean;
-export declare function localizeHref(href: string, locale: string, curLocale: string, curPathname: string): string;
-export declare function localizeHref(href: UrlObject | string, locale: string, curLocale: string, curPathname: string): UrlObject | string;
-export declare function prefixHref(href: string, locale: string): string;
-export declare function prefixHref(href: UrlObject | string, locale: string): UrlObject | string;
-export declare function unlocalizePathname(pathname: string, locale: string): string;
-export declare function prefixPathname(locale: string, pathname: string): string;
-export declare function hasPathnamePrefixed(locale: string, pathname: string): boolean;
+export declare function isLocalizableHref(href: Href): boolean;
+export declare function localizeHref(href: string, locale: string, curLocale: string, curPathname: string, prefix: string): string;
+export declare function localizeHref(href: UrlObject | string, locale: string, curLocale: string, curPathname: string, prefix: string): UrlObject | string;
+export declare function prefixHref(href: string, prefix: string): string;
+export declare function prefixHref(href: UrlObject | string, prefix: string): UrlObject | string;
+export declare function unprefixPathname(pathname: string, prefix: string): string;
+export declare function prefixPathname(prefix: string, pathname: string): string;
+export declare function hasPathnamePrefixed(prefix: string, pathname: string): boolean;
 export declare function matchesPathname(
 /** E.g. `/users/[userId]-[userName]` */
 template: string, 
 /** E.g. `/users/23-jane` */
 pathname: string): boolean;
+export declare function getLocalePrefix<AppLocales extends Locales>(locale: AppLocales[number], localePrefix: LocalePrefixConfigVerbose<AppLocales>): string;
 export declare function templateToRegex(template: string): RegExp;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "3.14.1",
+  "version": "3.15.0-custom-prefixes.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "funding": [
@@ -16,16 +16,6 @@
     "type": "git",
     "url": "https://github.com/amannn/next-intl"
   },
-  "scripts": {
-    "build": "rm -rf dist && rollup -c",
-    "test": "TZ=Europe/Berlin vitest",
-    "lint": "pnpm run lint:source && pnpm run lint:package",
-    "lint:source": "eslint src test && tsc --noEmit",
-    "lint:package": "publint && attw --pack",
-    "prepublishOnly": "CI=true turbo test && turbo lint && turbo build && cp ../../README.md .",
-    "postpublish": "git checkout . && rm ./README.md",
-    "size": "size-limit"
-  },
   "main": "./dist/index.react-client.js",
   "module": "./dist/esm/index.react-client.js",
   "typings": "./dist/types/src/index.react-client.d.ts",
@@ -53,6 +43,10 @@
       "react-server": "./dist/esm/navigation.react-server.js",
       "default": "./dist/navigation.react-client.js"
     },
+    "./routing": {
+      "types": "./routing.d.ts",
+      "default": "./dist/routing.js"
+    },
     "./plugin": {
       "types": "./plugin.d.ts",
       "default": "./dist/plugin.js"
@@ -64,6 +58,7 @@
     "navigation.d.ts",
     "middleware.d.ts",
     "plugin.d.ts",
+    "routing.d.ts",
     "config.d.ts"
   ],
   "keywords": [
@@ -111,6 +106,7 @@
     "typescript": "^5.2.2",
     "vitest": "^1.0.1"
   },
+  "prettier": "../../.prettierrc.json",
   "size-limit": [
     {
       "path": "dist/production/index.react-client.js",
@@ -122,11 +118,11 @@
     },
     {
       "path": "dist/production/navigation.react-client.js",
-      "limit": "2.965 KB"
+      "limit": "3.235 KB"
     },
     {
       "path": "dist/production/navigation.react-server.js",
-      "limit": "17.64 KB"
+      "limit": "17.815 KB"
     },
     {
       "path": "dist/production/server.react-client.js",
@@ -138,8 +134,19 @@
     },
     {
       "path": "dist/production/middleware.js",
-      "limit": "6.19 KB"
+      "limit": "6.42 KB"
+    },
+    {
+      "path": "dist/production/routing.js",
+      "limit": "0 KB"
     }
   ],
-  "gitHead": "d2668b856468b7203dd9e16cf134ea0219e59b39"
-}
+  "scripts": {
+    "build": "rm -rf dist && rollup -c",
+    "test": "TZ=Europe/Berlin vitest",
+    "lint": "pnpm run lint:source && pnpm run lint:package",
+    "lint:source": "eslint src test && tsc --noEmit",
+    "lint:package": "publint && attw --pack",
+    "size": "size-limit"
+  }
+}

package/routing.d.ts

@@ -0,0 +1 @@
+export * from './dist/types/src/routing';