@bleedingdev/modern-js-plugin-i18n 3.2.0-ultramodern.12 → 3.2.0-ultramodern.120

package/dist/esm-node/server/index.mjs

@@ -1,8 +1,39 @@
 import "node:module";
 import { DEFAULT_I18NEXT_DETECTION_OPTIONS, mergeDetectionOptions } from "../runtime/i18n/detection/config.mjs";
+import { resolveLocalisedPath, resolveLocalisedUrlsConfig } from "../shared/localisedUrls.mjs";
 import { getLocaleDetectionOptions } from "../shared/utils.mjs";
 import * as __rspack_external__modern_js_server_core_hono_a76ca254 from "@modern-js/server-core/hono";
 const { languageDetector: languageDetector } = __rspack_external__modern_js_server_core_hono_a76ca254;
+const normalizeApiPrefix = (prefix)=>{
+    const trimmedPrefix = prefix.trim();
+    if (!trimmedPrefix) return null;
+    const prefixedPath = trimmedPrefix.startsWith('/') ? trimmedPrefix : `/${trimmedPrefix}`;
+    const withoutWildcard = prefixedPath.replace(/\/\*$/, '');
+    const normalizedPrefix = withoutWildcard.length > 1 ? withoutWildcard.replace(/\/+$/, '') : withoutWildcard;
+    return '/' === normalizedPrefix ? null : normalizedPrefix;
+};
+const collectApiPrefixes = (routes, bffPrefix)=>{
+    const prefixes = new Set();
+    for (const route of routes){
+        if (!route.isApi || !route.urlPath) continue;
+        const normalizedPrefix = normalizeApiPrefix(route.urlPath);
+        if (normalizedPrefix) prefixes.add(normalizedPrefix);
+    }
+    const bffPrefixes = Array.isArray(bffPrefix) ? bffPrefix : bffPrefix ? [
+        bffPrefix
+    ] : [];
+    for (const prefix of bffPrefixes){
+        const normalizedPrefix = normalizeApiPrefix(prefix);
+        if (normalizedPrefix) prefixes.add(normalizedPrefix);
+    }
+    return [
+        ...prefixes
+    ];
+};
+const matchesApiPrefix = (pathname, apiPrefixes)=>{
+    const normalizedPathname = pathname.startsWith('/') ? pathname : `/${pathname}`;
+    return apiPrefixes.some((prefix)=>normalizedPathname === prefix || normalizedPathname.startsWith(`${prefix}/`));
+};
 const convertToHonoLanguageDetectorOptions = (languages, fallbackLanguage, detectionOptions)=>{
     const mergedDetection = detectionOptions ? mergeDetectionOptions(detectionOptions) : DEFAULT_I18NEXT_DETECTION_OPTIONS;
     const order = (mergedDetection.order || []).filter((item)=>![
@@ -92,15 +123,20 @@ const getLanguageFromPath = (req, urlPath, languages)=>{
     if (languages.includes(firstSegment)) return firstSegment;
     return null;
 };
-const buildLocalizedUrl = (req, urlPath, language, languages)=>{
+const buildLocalizedUrl = (req, urlPath, language, languages, localisedUrls)=>{
     const url = new URL(req.url);
     const pathname = url.pathname;
     const basePath = urlPath.replace('/*', '');
     const remainingPath = pathname.startsWith(basePath) ? pathname.slice(basePath.length) : pathname;
     const segments = remainingPath.split('/').filter(Boolean);
-    if (segments.length > 0 && languages.includes(segments[0])) segments[0] = language;
-    else segments.unshift(language);
-    const newPathname = `/${segments.join('/')}`;
+    const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
+    const pathWithoutLanguage = segments.length > 0 && languages.includes(segments[0]) ? `/${segments.slice(1).join('/')}` : remainingPath;
+    const resolvedPath = localisedUrlsConfig.enabled ? resolveLocalisedPath(pathWithoutLanguage, language, languages, localisedUrlsConfig.map) : pathWithoutLanguage;
+    const resolvedSegments = resolvedPath.split('/').filter(Boolean);
+    const newPathname = `/${[
+        language,
+        ...resolvedSegments
+    ].join('/')}`;
     const suffix = `${url.search}${url.hash}`;
     const localizedUrl = '/' === basePath ? newPathname + suffix : basePath + newPathname + suffix;
     return localizedUrl;
@@ -110,6 +146,9 @@ const i18nServerPlugin = (options)=>({
         setup: (api)=>{
             api.onPrepare(()=>{
                 const { middlewares, routes } = api.getServerContext();
+                const serverConfig = api.getServerConfig();
+                const bffPrefix = serverConfig?.bff ? serverConfig.bff.prefix ?? '/api' : void 0;
+                const apiPrefixes = collectApiPrefixes(routes, bffPrefix);
                 const entryPaths = new Set();
                 routes.forEach((route)=>{
                     if (route.entryName && route.urlPath && '/' !== route.urlPath) {
@@ -121,7 +160,7 @@ const i18nServerPlugin = (options)=>({
                     const { entryName } = route;
                     if (!entryName) return;
                     if (!options.localeDetection) return;
-                    const { localePathRedirect, i18nextDetector = true, languages = [], fallbackLanguage = 'en', detection, ignoreRedirectRoutes } = getLocaleDetectionOptions(entryName, options.localeDetection);
+                    const { localePathRedirect, i18nextDetector = true, languages = [], fallbackLanguage = 'en', detection, ignoreRedirectRoutes, localisedUrls } = getLocaleDetectionOptions(entryName, options.localeDetection);
                     const staticRoutePrefixes = options.staticRoutePrefixes;
                     const originUrlPath = route.urlPath;
                     const urlPath = originUrlPath.endsWith('/') ? `${originUrlPath}*` : `${originUrlPath}/*`;
@@ -135,6 +174,7 @@ const i18nServerPlugin = (options)=>({
                                 handler: async (c, next)=>{
                                     const url = new URL(c.req.url);
                                     const pathname = url.pathname;
+                                    if (matchesApiPrefix(pathname, apiPrefixes)) return await next();
                                     if (isStaticResourceRequest(pathname, staticRoutePrefixes, languages)) return await next();
                                     if ('/' === originUrlPath) {
                                         const pathSegments = pathname.split('/').filter(Boolean);
@@ -153,6 +193,7 @@ const i18nServerPlugin = (options)=>({
                             handler: async (c, next)=>{
                                 const url = new URL(c.req.url);
                                 const pathname = url.pathname;
+                                if (matchesApiPrefix(pathname, apiPrefixes)) return await next();
                                 if (isStaticResourceRequest(pathname, staticRoutePrefixes, languages)) return await next();
                                 if (shouldIgnoreRedirect(pathname, urlPath, ignoreRedirectRoutes)) return await next();
                                 if ('/' === originUrlPath) {
@@ -167,9 +208,14 @@ const i18nServerPlugin = (options)=>({
                                     let detectedLanguage = null;
                                     if (i18nextDetector) detectedLanguage = c.get('language') || null;
                                     const targetLanguage = detectedLanguage || fallbackLanguage;
-                                    const localizedUrl = buildLocalizedUrl(c.req, originUrlPath, targetLanguage, languages);
+                                    const localizedUrl = buildLocalizedUrl(c.req, originUrlPath, targetLanguage, languages, localisedUrls);
                                     return c.redirect(localizedUrl);
                                 }
+                                const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
+                                if (localisedUrlsConfig.enabled) {
+                                    const expectedUrl = buildLocalizedUrl(c.req, originUrlPath, language, languages, localisedUrls);
+                                    if (expectedUrl !== `${pathname}${url.search}${url.hash}`) return c.redirect(expectedUrl);
+                                }
                                 await next();
                             }
                         });
@@ -180,4 +226,4 @@ const i18nServerPlugin = (options)=>({
     });
 const server = i18nServerPlugin;
 export default server;
-export { i18nServerPlugin };
+export { collectApiPrefixes, i18nServerPlugin, matchesApiPrefix };

package/dist/esm-node/shared/localisedUrls.mjs

@@ -0,0 +1,213 @@
+import "node:module";
+const LOCALE_PARAM_NAMES = new Set([
+    'lang',
+    'locale',
+    'language'
+]);
+const normalisePathPattern = (path)=>{
+    const withoutDuplicateSlashes = path.replace(/\/+/g, '/');
+    const withLeadingSlash = withoutDuplicateSlashes.startsWith('/') ? withoutDuplicateSlashes : `/${withoutDuplicateSlashes}`;
+    const withoutTrailingSlash = withLeadingSlash.length > 1 ? withLeadingSlash.replace(/\/+$/, '') : withLeadingSlash;
+    return withoutTrailingSlash.replace(/\[(.+?)\]/g, ':$1');
+};
+const normaliseRoutePath = (path)=>{
+    const normalized = normalisePathPattern(path);
+    return '/' === normalized ? '' : normalized.slice(1);
+};
+const getLocaleParamSegment = (segment)=>{
+    if (!segment.startsWith(':')) return null;
+    const paramName = segment.slice(1).replace(/\?$/, '');
+    return LOCALE_PARAM_NAMES.has(paramName) ? segment : null;
+};
+const splitPathSegments = (path)=>{
+    if (!path) return [];
+    return normalisePathPattern(path).split('/').filter(Boolean);
+};
+const stripLeadingLocaleParam = (path)=>{
+    const segments = splitPathSegments(path);
+    const leadingLocaleParam = getLocaleParamSegment(segments[0] || '');
+    if (!leadingLocaleParam) return path;
+    const remainingPath = segments.slice(1).join('/');
+    return remainingPath ? `/${remainingPath}` : void 0;
+};
+const getLeadingLocaleParam = (path)=>{
+    const segments = splitPathSegments(path);
+    return getLocaleParamSegment(segments[0] || '');
+};
+const resolveLocalisedUrlsConfig = (option)=>{
+    if (false === option) return {
+        enabled: false,
+        map: {}
+    };
+    if (option && 'object' == typeof option) return {
+        enabled: true,
+        map: option
+    };
+    return {
+        enabled: true,
+        map: {}
+    };
+};
+const isLocalisableRoutePath = (path)=>{
+    const pathWithoutLocale = stripLeadingLocaleParam(path);
+    if (!pathWithoutLocale || '/' === pathWithoutLocale || '*' === pathWithoutLocale) return false;
+    return true;
+};
+const joinPath = (parentPath, routePath)=>{
+    if (!isLocalisableRoutePath(routePath)) return parentPath;
+    const segment = normaliseRoutePath(stripLeadingLocaleParam(routePath) || '');
+    return normalisePathPattern(`${parentPath}/${segment}`);
+};
+const ensureLocalisedUrlsForPath = (canonicalPath, languages, localisedUrls)=>{
+    const entry = localisedUrls[canonicalPath];
+    if (!entry) throw new Error(`localisedUrls is enabled, but route "${canonicalPath}" does not define localised URLs for languages: ${languages.join(', ')}. Add localisedUrls["${canonicalPath}"] or set localeDetection.localisedUrls to false.`);
+    const missingLanguages = languages.filter((language)=>!entry[language]);
+    if (missingLanguages.length > 0) throw new Error(`localisedUrls["${canonicalPath}"] is missing languages: ${missingLanguages.join(', ')}. Every configured language must have a localised URL.`);
+    return entry;
+};
+const validateLocalisedUrls = (routes, languages, localisedUrls)=>{
+    const visit = (route, parentPath)=>{
+        const canonicalPath = joinPath(parentPath, route.path);
+        if (isLocalisableRoutePath(route.path)) ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls);
+        if ('children' in route && route.children) route.children.forEach((child)=>visit(child, canonicalPath));
+    };
+    routes.forEach((route)=>visit(route, ''));
+};
+const getLocalisedRoutePaths = (canonicalPath, parentLocalisedPaths, languages, entry)=>{
+    const paths = languages.map((language)=>{
+        const fullPath = normalisePathPattern(entry[language]);
+        const parentPath = normalisePathPattern(parentLocalisedPaths[language] || '/');
+        if ('/' === parentPath) return normaliseRoutePath(fullPath) || void 0;
+        const parentPrefix = `${parentPath}/`;
+        if (!fullPath.startsWith(parentPrefix)) throw new Error(`localisedUrls["${canonicalPath}"].${language} must be nested under "${parentPath}" because its parent route is localised there.`);
+        return normaliseRoutePath(fullPath.slice(parentPath.length));
+    });
+    return Array.from(new Set(paths.filter(Boolean)));
+};
+const transformLocalisedRoute = (route, parentCanonicalPath, parentLocalisedPaths, languages, localisedUrls)=>{
+    const canonicalPath = joinPath(parentCanonicalPath, route.path);
+    const localisedUrlEntry = isLocalisableRoutePath(route.path) ? ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls) : void 0;
+    const routeLocalisedPaths = localisedUrlEntry ? languages.reduce((acc, language)=>{
+        acc[language] = normalisePathPattern(localisedUrlEntry[language]);
+        return acc;
+    }, {}) : parentLocalisedPaths;
+    const children = 'children' in route && route.children ? route.children.flatMap((child)=>transformLocalisedRoute(child, canonicalPath, routeLocalisedPaths, languages, localisedUrls)) : void 0;
+    const baseRoute = {
+        ...route,
+        ...children ? {
+            children
+        } : {}
+    };
+    if (!localisedUrlEntry) return [
+        baseRoute
+    ];
+    return getLocalisedRoutePaths(canonicalPath, parentLocalisedPaths, languages, localisedUrlEntry).map((localisedPath, index)=>cloneRouteWithLocalisedPath(baseRoute, localisedPath, index, canonicalPath));
+};
+const legalRouteIdPart = (value)=>value.replace(/[^a-zA-Z0-9_$-]+/g, '_').replace(/^_+|_+$/g, '') || 'index';
+const suffixRouteIds = (route, suffix)=>{
+    const children = 'children' in route && route.children ? route.children.map((child)=>suffixRouteIds(child, suffix)) : void 0;
+    return {
+        ...route,
+        ...route.id ? {
+            id: `${route.id}__localised_${suffix}`
+        } : {},
+        ...children ? {
+            children
+        } : {}
+    };
+};
+const cloneRouteWithLocalisedPath = (route, path, index, canonicalPath)=>{
+    const leadingLocaleParam = getLeadingLocaleParam(route.path);
+    const localisedPath = leadingLocaleParam ? normaliseRoutePath(`${leadingLocaleParam}/${path}`) : path;
+    const routeWithPath = {
+        ...route,
+        path: localisedPath
+    };
+    routeWithPath.modernCanonicalPath = canonicalPath;
+    return 0 === index ? routeWithPath : suffixRouteIds(routeWithPath, legalRouteIdPart(localisedPath));
+};
+const applyLocalisedUrlsToRoutes = (routes, languages, localisedUrls)=>{
+    const rootLocalisedPaths = languages.reduce((acc, language)=>{
+        acc[language] = '/';
+        return acc;
+    }, {});
+    validateLocalisedUrls(routes, languages, localisedUrls);
+    return routes.flatMap((route)=>transformLocalisedRoute(route, '', rootLocalisedPaths, languages, localisedUrls));
+};
+const escapeRegExp = (value)=>value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+const getParamName = (segment)=>segment.slice(1).replace(/\?$/, '');
+const compilePathPattern = (pattern)=>{
+    const names = [];
+    const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+    const source = segments.map((segment)=>{
+        if (segment.startsWith(':')) {
+            names.push(getParamName(segment));
+            const paramPattern = '([^/]+)';
+            return segment.endsWith('?') ? `(?:/${paramPattern})?` : `/${paramPattern}`;
+        }
+        if ('*' === segment) {
+            names.push('*');
+            return '/(.*)';
+        }
+        return `/${escapeRegExp(segment)}`;
+    }).join('');
+    return {
+        names,
+        regexp: new RegExp(`^${source || '/'}$`)
+    };
+};
+const matchPathPattern = (pathname, pattern)=>{
+    const { names, regexp } = compilePathPattern(pattern);
+    const match = regexp.exec(normalisePathPattern(pathname));
+    if (!match) return null;
+    return names.reduce((params, name, index)=>{
+        params[name] = decodeURIComponent(match[index + 1] || '');
+        return params;
+    }, {});
+};
+const buildPathFromPattern = (pattern, params)=>{
+    const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+    const path = segments.map((segment)=>{
+        if (segment.startsWith(':')) {
+            const param = params[getParamName(segment)];
+            return param ? encodeURIComponent(param) : '';
+        }
+        if ('*' === segment) return params['*'] || '';
+        return segment;
+    }).filter(Boolean).join('/');
+    return `/${path}`;
+};
+const resolveLocalisedPath = (pathname, targetLanguage, languages, localisedUrls)=>{
+    const normalizedPathname = normalisePathPattern(pathname);
+    for (const [canonicalPattern, localisedUrlEntry] of Object.entries(localisedUrls)){
+        const targetPattern = localisedUrlEntry[targetLanguage];
+        if (!targetPattern) continue;
+        const params = matchPathPattern(normalizedPathname, canonicalPattern);
+        if (params) return buildPathFromPattern(targetPattern, params);
+    }
+    for (const localisedUrlEntry of Object.values(localisedUrls)){
+        const targetPattern = localisedUrlEntry[targetLanguage];
+        if (targetPattern) for (const language of languages){
+            const sourcePattern = localisedUrlEntry[language];
+            if (!sourcePattern) continue;
+            const params = matchPathPattern(normalizedPathname, sourcePattern);
+            if (params) return buildPathFromPattern(targetPattern, params);
+        }
+    }
+    return normalizedPathname;
+};
+const resolveCanonicalLocalisedPath = (pathname, languages, localisedUrls)=>{
+    const normalizedPathname = normalisePathPattern(pathname);
+    for (const [canonicalPattern, localisedUrlEntry] of Object.entries(localisedUrls)){
+        const canonicalParams = matchPathPattern(normalizedPathname, canonicalPattern);
+        if (canonicalParams) return buildPathFromPattern(canonicalPattern, canonicalParams);
+        for (const language of languages){
+            const sourcePattern = localisedUrlEntry[language];
+            if (!sourcePattern) continue;
+            const params = matchPathPattern(normalizedPathname, sourcePattern);
+            if (params) return buildPathFromPattern(canonicalPattern, params);
+        }
+    }
+    return normalizedPathname;
+};
+export { applyLocalisedUrlsToRoutes, buildPathFromPattern, matchPathPattern, normalisePathPattern, resolveCanonicalLocalisedPath, resolveLocalisedPath, resolveLocalisedUrlsConfig, validateLocalisedUrls };

package/dist/types/cli/index.d.ts

@@ -1,6 +1,7 @@
 import type { AppTools, CliPlugin } from '@modern-js/app-tools';
 import type { Entrypoint } from '@modern-js/types';
 import type { BackendOptions, LocaleDetectionOptions } from '../shared/type';
+import '../runtime/types';
 export type TransformRuntimeConfigFn = (extendedConfig: Record<string, any>, entrypoint: Entrypoint) => Record<string, any>;
 export interface I18nPluginOptions {
     localeDetection?: LocaleDetectionOptions;

package/dist/types/runtime/I18nLink.d.ts

@@ -4,5 +4,11 @@ export interface I18nLinkProps {
     children: React.ReactNode;
     [key: string]: any;
 }
+/**
+ * @deprecated Use {@link Link} from `@modern-js/plugin-i18n/runtime` instead.
+ * `Link` accepts the same language-agnostic `to` values and additionally
+ * supports `#hash`/`?query` targets, typed canonical routes, `params`
+ * interpolation and language-invariant active state.
+ */
 export declare const I18nLink: React.FC<I18nLinkProps>;
 export default I18nLink;

package/dist/types/runtime/Link.d.ts

@@ -0,0 +1,56 @@
+import type React from 'react';
+import type { LinkParamsProp, LinkTargetPathname, ValidateLinkTo } from './canonicalRoutes';
+export type LinkParams = Record<string, string | number | undefined>;
+/**
+ * Interpolate `$param`, `:param`, optional (`{-$param}` / `:param?`) and splat
+ * (`$` / `*`) segments with concrete values before localization, so
+ * pattern-mapped slugs localize correctly.
+ */
+export declare const interpolateRouteParams: (pathname: string, params?: LinkParams) => string;
+export interface LinkActiveOptions {
+    /**
+     * `true`: active only when the location matches the target exactly.
+     * `false`: also active when the location is nested under the target.
+     * Defaults to prefix matching, except for `/` which defaults to exact.
+     */
+    exact?: boolean;
+}
+type AnchorRest = Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href' | 'children'>;
+export interface LinkBaseProps extends AnchorRest {
+    children?: React.ReactNode;
+    /** Hash fragment without the leading `#`. Overrides a `#hash` inside `to`. */
+    hash?: string;
+    /** Search params. Object form is passed natively to TanStack Link. */
+    search?: string | Record<string, unknown>;
+    hashScrollIntoView?: boolean | ScrollIntoViewOptions;
+    replace?: boolean;
+    prefetch?: 'intent' | 'render' | 'viewport' | 'none';
+    preload?: unknown;
+    activeOptions?: LinkActiveOptions;
+    /** Extra anchor props applied when the link is active. */
+    activeProps?: AnchorRest & Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type LinkProps<TTo extends string = string> = LinkBaseProps & {
+    to: TTo;
+} & ValidateLinkTo<TTo> & LinkParamsProp<LinkTargetPathname<TTo>>;
+/**
+ * The standard UltraModern link: a vanilla link in every respect except that
+ * it localizes canonical, language-agnostic paths automatically.
+ *
+ * - `to` accepts canonical routes (`/talks/$slug`), optionally with `#hash`
+ *   and `?query` suffixes; both survive localization.
+ * - External URLs and bare `#hash` targets render a plain `<a>`.
+ * - Active state is language-invariant: a canonical `to` is active when the
+ *   current location matches any localized variant of that route.
+ *
+ * @example
+ * ```tsx
+ * <Link to="/talks/$slug" params={{ slug: talk.slug }} hash="abstract" />
+ * <Link to="/platform" />            // -> /cs/platforma under cs
+ * <Link to="/#work-with-me" />       // cross-page hash, SPA navigation
+ * <Link to="https://ai.bleeding.dev" /> // external -> plain <a>
+ * ```
+ */
+export declare const Link: <TTo extends string = string>(props: LinkProps<TTo>) => React.ReactElement;
+export default Link;

package/dist/types/runtime/canonicalRoutes.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Canonical (language-agnostic) route map.
+ *
+ * Empty by default; populated via declaration merging by the generated
+ * `register.gen.d.ts` that `@modern-js/plugin-tanstack` emits:
+ *
+ * ```ts
+ * declare module '@modern-js/plugin-i18n/runtime' {
+ *   interface UltramodernCanonicalRoutes {
+ *     '/': Record<string, never>;
+ *     '/talks': Record<string, never>;
+ *     '/talks/$slug': { slug: string };
+ *   }
+ * }
+ * ```
+ *
+ * Keys are canonical route patterns in TanStack notation (`$param`,
+ * `{-$param}`); values describe the route's path params.
+ */
+export interface UltramodernCanonicalRoutes {
+}
+export type CanonicalRoutePath = keyof UltramodernCanonicalRoutes & string;
+type HasCanonicalRoutes = [keyof UltramodernCanonicalRoutes] extends [never] ? false : true;
+/**
+ * Targets that bypass canonical-route validation: external URLs, same-page
+ * hash anchors, and canonical paths with a `?search` and/or `#hash` suffix
+ * (the pathname part of suffixed targets is still validated).
+ */
+type ExternalLinkTarget = `http://${string}` | `https://${string}` | `mailto:${string}` | `tel:${string}` | `//${string}`;
+type SuffixedCanonicalTarget = `${CanonicalRoutePath}?${string}` | `${CanonicalRoutePath}#${string}`;
+export type AllowedLinkTarget = CanonicalRoutePath | SuffixedCanonicalTarget | ExternalLinkTarget | `#${string}`;
+/**
+ * Validates a literal `to` against the canonical route map. Computed strings
+ * (type `string`) always pass — the escape hatch for dynamic values. When no
+ * canonical map has been generated, everything passes.
+ */
+export type ValidateLinkTo<TTo extends string> = HasCanonicalRoutes extends false ? unknown : string extends TTo ? unknown : TTo extends AllowedLinkTarget ? unknown : {
+    to: {
+        error: 'Not a canonical route. Authors must write language-agnostic paths; see UltramodernCanonicalRoutes.';
+        received: TTo;
+    };
+};
+/** Strip `?search`/`#hash` suffixes from a link target type. */
+export type LinkTargetPathname<TTo extends string> = TTo extends `${infer TPath}#${string}` ? TPath extends `${infer TPure}?${string}` ? TPure : TPath : TTo extends `${infer TPath}?${string}` ? TPath : TTo;
+/**
+ * `params` prop contract for a canonical target: required when the route has
+ * required params, optional when all params are optional, forbidden when the
+ * route has none. Non-canonical (computed/external) targets accept a loose
+ * record.
+ */
+export type LinkParamsProp<TPath extends string> = TPath extends CanonicalRoutePath ? UltramodernCanonicalRoutes[TPath] extends Record<string, never> ? {
+    params?: undefined;
+} : Record<string, never> extends UltramodernCanonicalRoutes[TPath] ? {
+    params?: UltramodernCanonicalRoutes[TPath];
+} : {
+    params: UltramodernCanonicalRoutes[TPath];
+} : {
+    params?: Record<string, string | number | undefined>;
+};
+export {};

package/dist/types/runtime/context.d.ts

@@ -1,4 +1,5 @@
 import type { FC, ReactNode } from 'react';
+import type { LocalisedUrlsOption } from '../shared/localisedUrls';
 import type { I18nInstance } from './i18n';
 export interface ModernI18nContextValue {
     language: string;
@@ -7,6 +8,7 @@ export interface ModernI18nContextValue {
     languages?: string[];
     localePathRedirect?: boolean;
     ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean);
+    localisedUrls?: LocalisedUrlsOption;
     updateLanguage?: (newLang: string) => void;
 }
 export interface ModernI18nProviderProps {
@@ -19,6 +21,7 @@ export interface UseModernI18nReturn {
     changeLanguage: (newLang: string) => Promise<void>;
     i18nInstance: I18nInstance;
     supportedLanguages: string[];
+    localisedUrls?: LocalisedUrlsOption;
     isLanguageSupported: (lang: string) => boolean;
     isResourcesReady: boolean;
 }

package/dist/types/runtime/hooks.d.ts

@@ -1,16 +1,18 @@
 import type { TRuntimeContext } from '@modern-js/runtime';
 import type React from 'react';
+import type { LocalisedUrlsOption } from '../shared/localisedUrls';
 import type { I18nInstance } from './i18n';
 interface RuntimeContextWithI18n extends TRuntimeContext {
     i18nInstance?: I18nInstance;
 }
-export declare function createContextValue(lang: string, i18nInstance: I18nInstance | undefined, entryName: string | undefined, languages: string[], localePathRedirect: boolean, ignoreRedirectRoutes: string[] | ((pathname: string) => boolean) | undefined, setLang: (lang: string) => void): {
+export declare function createContextValue(lang: string, i18nInstance: I18nInstance | undefined, entryName: string | undefined, languages: string[], localePathRedirect: boolean, ignoreRedirectRoutes: string[] | ((pathname: string) => boolean) | undefined, localisedUrls: LocalisedUrlsOption | undefined, setLang: (lang: string) => void): {
     language: string;
     i18nInstance: I18nInstance;
     entryName: string | undefined;
     languages: string[];
     localePathRedirect: boolean;
     ignoreRedirectRoutes: string[] | ((pathname: string) => boolean) | undefined;
+    localisedUrls: LocalisedUrlsOption | undefined;
     updateLanguage: (lang: string) => void;
 };
 export declare function useSdkResourcesLoader(i18nInstance: I18nInstance | undefined, setForceUpdate: React.Dispatch<React.SetStateAction<number>>): void;
@@ -23,6 +25,6 @@ export declare function useSdkResourcesLoader(i18nInstance: I18nInstance | undef
  * In SSR/SSG scenarios, server-side middleware handles redirects, so this hook is skipped.
  * We use process.env.MODERN_TARGET to ensure this code is only included in browser bundles.
  */
-export declare function useClientSideRedirect(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], fallbackLanguage: string, ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean)): void;
+export declare function useClientSideRedirect(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], fallbackLanguage: string, ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean), localisedUrls?: LocalisedUrlsOption): void;
 export declare function useLanguageSync(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], runtimeContextRef: React.MutableRefObject<RuntimeContextWithI18n>, prevLangRef: React.MutableRefObject<string>, setLang: (lang: string) => void): void;
 export {};

package/dist/types/runtime/i18n/backend/middleware.node.d.ts

@@ -1,4 +1,4 @@
-import Backend from 'i18next-fs-backend';
+import Backend from 'i18next-fs-backend/cjs';
 import type { ExtendedBackendOptions } from '../../../shared/type';
 import type { I18nInstance } from '../instance';
 /**

package/dist/types/runtime/i18n/instance.d.ts

@@ -1,7 +1,4 @@
 import type { BaseBackendOptions } from '../../shared/type';
-type ReactI18nextModule = typeof import('react-i18next');
-type InitReactI18next = ReactI18nextModule['initReactI18next'];
-type I18nextProviderComponent = ReactI18nextModule['I18nextProvider'];
 export interface I18nResourceStore {
     data?: {
         [language: string]: {
@@ -64,9 +61,12 @@ export interface BackendOptions extends Omit<BaseBackendOptions, 'enabled'> {
     stringify?: (data: any) => string;
     [key: string]: any;
 }
+export type ResourceValue = string | {
+    [key: string]: ResourceValue;
+};
 export interface Resources {
     [lng: string]: {
-        [source: string]: string | Record<string, string>;
+        [source: string]: ResourceValue;
     };
 }
 export type I18nInitOptions = {
@@ -91,6 +91,4 @@ export type I18nInitOptions = {
 export declare function isI18nInstance(obj: any): obj is I18nInstance;
 export declare function getI18nextInstanceForProvider(instance: I18nInstance | any): any;
 export declare function getI18nInstance(userInstance?: I18nInstance | any): Promise<I18nInstance>;
-export declare function getInitReactI18next(): Promise<InitReactI18next | null>;
-export declare function getI18nextProvider(): Promise<I18nextProviderComponent | null>;
 export {};

package/dist/types/runtime/i18n/react-i18next.d.ts

@@ -0,0 +1,7 @@
+import type React from 'react';
+interface ReactI18nextIntegration {
+    I18nextProvider: React.ComponentType<any> | null;
+    initReactI18next: any | null;
+}
+export declare function getReactI18nextIntegration(): Promise<ReactI18nextIntegration>;
+export {};

package/dist/types/runtime/index.d.ts

@@ -12,9 +12,14 @@ export interface I18nPluginOptions {
     changeLanguage?: (lang: string) => void;
     initOptions?: I18nInitOptions;
     htmlLangAttr?: boolean;
+    reactI18next?: boolean;
     [key: string]: any;
 }
 export declare const i18nPlugin: (options: I18nPluginOptions) => RuntimePlugin;
+export type { AllowedLinkTarget, CanonicalRoutePath, UltramodernCanonicalRoutes, } from './canonicalRoutes';
 export { useModernI18n } from './context';
-export { I18nLink } from './I18nLink';
+export { I18nLink, type I18nLinkProps } from './I18nLink';
+export { Link, type LinkActiveOptions, type LinkBaseProps, type LinkParams, type LinkProps, } from './Link';
+export { canonicalPath, type LocalizedPathsConfig, localizePath, type UseLocalizedLocationReturn, type UseLocalizedPathsReturn, useLocalizedLocation, useLocalizedPaths, } from './localizedPaths';
+export { buildLocalizedUrl, splitUrlTarget } from './utils';
 export default i18nPlugin;

package/dist/types/runtime/localizedPaths.d.ts

@@ -0,0 +1,39 @@
+import type { LocalisedUrlsOption } from '../shared/localisedUrls';
+export interface LocalizedPathsConfig {
+    languages: string[];
+    localisedUrls?: LocalisedUrlsOption;
+}
+/**
+ * Localize a canonical, language-agnostic target for the given language:
+ * adds the language prefix and applies `localisedUrls` pattern mapping.
+ * `?search`/`#hash` suffixes are preserved verbatim.
+ */
+export declare const localizePath: (pathname: string, language: string, config: LocalizedPathsConfig) => string;
+/**
+ * Reverse of {@link localizePath}: strip the language prefix and map localized
+ * slugs back to the canonical pattern's path. `?search`/`#hash` suffixes are
+ * preserved verbatim.
+ */
+export declare const canonicalPath: (target: string, config: LocalizedPathsConfig) => string;
+export interface UseLocalizedPathsReturn {
+    localizePath: (pathname: string, language: string) => string;
+    canonicalPath: (pathname: string) => string;
+}
+/**
+ * Context-bound versions of {@link localizePath} and {@link canonicalPath} —
+ * the plugin configuration (languages, localisedUrls) is read from the i18n
+ * provider, so apps never copy pattern-matching helpers again.
+ */
+export declare const useLocalizedPaths: () => UseLocalizedPathsReturn;
+export interface UseLocalizedLocationReturn {
+    language: string;
+    /** Canonical (language-agnostic) path of the current location. */
+    canonical: string;
+    /** Per-language hrefs for the current location, search+hash preserved. */
+    alternates: Record<string, string>;
+}
+/**
+ * Per-language hrefs for the current location — for hreflang `<link>` tags and
+ * language switchers. SSR-safe: the location comes from the router adapter.
+ */
+export declare const useLocalizedLocation: () => UseLocalizedLocationReturn;

package/dist/types/runtime/routerAdapter.d.ts

@@ -0,0 +1,26 @@
+import type React from 'react';
+export type I18nRouterFramework = 'react-router' | 'tanstack' | string;
+export interface I18nRouterLocation {
+    pathname: string;
+    search: string;
+    hash: string;
+}
+export interface I18nRouterNavigateOptions {
+    replace?: boolean;
+    state?: unknown;
+}
+export type I18nRouterNavigate = (href: string, options?: I18nRouterNavigateOptions) => void | Promise<void>;
+export type I18nRouterLink = React.ComponentType<{
+    to: string;
+    children?: React.ReactNode;
+    [key: string]: unknown;
+}>;
+export interface I18nRouterAdapter {
+    framework?: I18nRouterFramework;
+    hasRouter: boolean;
+    location: I18nRouterLocation | null;
+    navigate: I18nRouterNavigate | null;
+    Link: I18nRouterLink | null;
+    params: Record<string, string>;
+}
+export declare const useI18nRouterAdapter: () => I18nRouterAdapter;