@bleedingdev/modern-js-plugin-i18n 3.2.0-ultramodern.17 → 3.2.0-ultramodern.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/dist/cjs/cli/index.js +22 -0
  2. package/dist/cjs/runtime/I18nLink.js +4 -12
  3. package/dist/cjs/runtime/context.js +32 -5
  4. package/dist/cjs/runtime/hooks.js +8 -5
  5. package/dist/cjs/runtime/i18n/backend/defaults.js +1 -1
  6. package/dist/cjs/runtime/i18n/backend/middleware.node.js +4 -4
  7. package/dist/cjs/runtime/i18n/instance.js +95 -80
  8. package/dist/cjs/runtime/index.js +7 -6
  9. package/dist/cjs/runtime/routerAdapter.js +164 -0
  10. package/dist/cjs/runtime/utils.js +63 -94
  11. package/dist/cjs/server/index.js +64 -8
  12. package/dist/cjs/shared/localisedUrls.js +237 -0
  13. package/dist/esm/cli/index.mjs +22 -0
  14. package/dist/esm/runtime/I18nLink.mjs +4 -12
  15. package/dist/esm/runtime/context.mjs +34 -7
  16. package/dist/esm/runtime/hooks.mjs +9 -6
  17. package/dist/esm/runtime/i18n/backend/defaults.mjs +1 -1
  18. package/dist/esm/runtime/i18n/backend/middleware.node.mjs +3 -3
  19. package/dist/esm/runtime/i18n/instance.mjs +8 -2
  20. package/dist/esm/runtime/index.mjs +7 -6
  21. package/dist/esm/runtime/routerAdapter.mjs +130 -0
  22. package/dist/esm/runtime/utils.mjs +11 -30
  23. package/dist/esm/server/index.mjs +57 -7
  24. package/dist/esm/shared/localisedUrls.mjs +191 -0
  25. package/dist/esm-node/cli/index.mjs +22 -0
  26. package/dist/esm-node/runtime/I18nLink.mjs +4 -12
  27. package/dist/esm-node/runtime/context.mjs +34 -7
  28. package/dist/esm-node/runtime/hooks.mjs +9 -6
  29. package/dist/esm-node/runtime/i18n/backend/defaults.mjs +1 -1
  30. package/dist/esm-node/runtime/i18n/backend/middleware.node.mjs +3 -3
  31. package/dist/esm-node/runtime/i18n/instance.mjs +8 -2
  32. package/dist/esm-node/runtime/index.mjs +7 -6
  33. package/dist/esm-node/runtime/routerAdapter.mjs +131 -0
  34. package/dist/esm-node/runtime/utils.mjs +11 -30
  35. package/dist/esm-node/server/index.mjs +57 -7
  36. package/dist/esm-node/shared/localisedUrls.mjs +192 -0
  37. package/dist/types/runtime/I18nLink.d.ts +15 -0
  38. package/dist/types/runtime/context.d.ts +3 -0
  39. package/dist/types/runtime/hooks.d.ts +4 -2
  40. package/dist/types/runtime/i18n/backend/middleware.node.d.ts +1 -1
  41. package/dist/types/runtime/index.d.ts +1 -0
  42. package/dist/types/runtime/routerAdapter.d.ts +26 -0
  43. package/dist/types/runtime/utils.d.ts +2 -7
  44. package/dist/types/server/index.d.ts +6 -0
  45. package/dist/types/shared/localisedUrls.d.ts +13 -0
  46. package/dist/types/shared/type.d.ts +12 -0
  47. package/package.json +15 -15
  48. package/rstest.config.mts +39 -0
  49. package/src/cli/index.ts +43 -1
  50. package/src/runtime/I18nLink.tsx +10 -16
  51. package/src/runtime/context.tsx +45 -7
  52. package/src/runtime/hooks.ts +13 -4
  53. package/src/runtime/i18n/backend/defaults.ts +3 -1
  54. package/src/runtime/i18n/backend/middleware.node.ts +1 -1
  55. package/src/runtime/i18n/instance.ts +1 -2
  56. package/src/runtime/index.tsx +10 -2
  57. package/src/runtime/routerAdapter.tsx +333 -0
  58. package/src/runtime/utils.ts +22 -34
  59. package/src/server/index.ts +135 -10
  60. package/src/shared/localisedUrls.ts +393 -0
  61. package/src/shared/type.ts +12 -0
  62. package/tests/localisedUrls.test.ts +278 -0
  63. package/tests/routerAdapter.test.tsx +278 -0
@@ -1,13 +1,7 @@
1
1
  import "node:module";
2
2
  import { isBrowser } from "@modern-js/runtime";
3
3
  import { getGlobalBasename } from "@modern-js/runtime/context";
4
- import { __webpack_require__ } from "../rslib-runtime.mjs";
5
- import * as __rspack_external__modern_js_runtime_router_2dfd0c78 from "@modern-js/runtime/router";
6
- __webpack_require__.add({
7
- "@modern-js/runtime/router?f1fa" (module) {
8
- module.exports = __rspack_external__modern_js_runtime_router_2dfd0c78;
9
- }
10
- });
4
+ import { resolveLocalisedPath, resolveLocalisedUrlsConfig } from "../shared/localisedUrls.mjs";
11
5
  const getPathname = (context)=>{
12
6
  if (isBrowser()) return window.location.pathname;
13
7
  return context.ssrContext?.request?.pathname || '/';
@@ -23,11 +17,16 @@ const getLanguageFromPath = (pathname, languages, fallbackLanguage)=>{
23
17
  if (languages.includes(firstSegment)) return firstSegment;
24
18
  return fallbackLanguage;
25
19
  };
26
- const buildLocalizedUrl = (pathname, language, languages)=>{
20
+ const buildLocalizedUrl = (pathname, language, languages, localisedUrls)=>{
27
21
  const segments = pathname.split('/').filter(Boolean);
28
- if (segments.length > 0 && languages.includes(segments[0])) segments[0] = language;
29
- else segments.unshift(language);
30
- return `/${segments.join('/')}`;
22
+ const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
23
+ const pathWithoutLanguage = segments.length > 0 && languages.includes(segments[0]) ? `/${segments.slice(1).join('/')}` : pathname;
24
+ const resolvedPath = localisedUrlsConfig.enabled ? resolveLocalisedPath(pathWithoutLanguage, language, languages, localisedUrlsConfig.map) : pathWithoutLanguage;
25
+ const resolvedSegments = resolvedPath.split('/').filter(Boolean);
26
+ return `/${[
27
+ language,
28
+ ...resolvedSegments
29
+ ].join('/')}`;
31
30
  };
32
31
  const detectLanguageFromPath = (pathname, languages, localePathRedirect)=>{
33
32
  if (!localePathRedirect) return {
@@ -55,22 +54,4 @@ const shouldIgnoreRedirect = (pathname, languages, ignoreRedirectRoutes)=>{
55
54
  if ('function' == typeof ignoreRedirectRoutes) return ignoreRedirectRoutes(normalizedPath);
56
55
  return ignoreRedirectRoutes.some((pattern)=>normalizedPath === pattern || normalizedPath.startsWith(`${pattern}/`));
57
56
  };
58
- const useRouterHooks = ()=>{
59
- try {
60
- const { useLocation, useNavigate, useParams } = __webpack_require__("@modern-js/runtime/router?f1fa");
61
- return {
62
- navigate: useNavigate(),
63
- location: useLocation(),
64
- params: useParams(),
65
- hasRouter: true
66
- };
67
- } catch (error) {
68
- return {
69
- navigate: null,
70
- location: null,
71
- params: {},
72
- hasRouter: false
73
- };
74
- }
75
- };
76
- export { buildLocalizedUrl, detectLanguageFromPath, getEntryPath, getLanguageFromPath, getPathname, shouldIgnoreRedirect, useRouterHooks };
57
+ export { buildLocalizedUrl, detectLanguageFromPath, getEntryPath, getLanguageFromPath, getPathname, shouldIgnoreRedirect };
@@ -1,8 +1,39 @@
1
1
  import "node:module";
2
2
  import { DEFAULT_I18NEXT_DETECTION_OPTIONS, mergeDetectionOptions } from "../runtime/i18n/detection/config.mjs";
3
+ import { resolveLocalisedPath, resolveLocalisedUrlsConfig } from "../shared/localisedUrls.mjs";
3
4
  import { getLocaleDetectionOptions } from "../shared/utils.mjs";
4
5
  import * as __rspack_external__modern_js_server_core_hono_a76ca254 from "@modern-js/server-core/hono";
5
6
  const { languageDetector: languageDetector } = __rspack_external__modern_js_server_core_hono_a76ca254;
7
+ const normalizeApiPrefix = (prefix)=>{
8
+ const trimmedPrefix = prefix.trim();
9
+ if (!trimmedPrefix) return null;
10
+ const prefixedPath = trimmedPrefix.startsWith('/') ? trimmedPrefix : `/${trimmedPrefix}`;
11
+ const withoutWildcard = prefixedPath.replace(/\/\*$/, '');
12
+ const normalizedPrefix = withoutWildcard.length > 1 ? withoutWildcard.replace(/\/+$/, '') : withoutWildcard;
13
+ return '/' === normalizedPrefix ? null : normalizedPrefix;
14
+ };
15
+ const collectApiPrefixes = (routes, bffPrefix)=>{
16
+ const prefixes = new Set();
17
+ for (const route of routes){
18
+ if (!route.isApi || !route.urlPath) continue;
19
+ const normalizedPrefix = normalizeApiPrefix(route.urlPath);
20
+ if (normalizedPrefix) prefixes.add(normalizedPrefix);
21
+ }
22
+ const bffPrefixes = Array.isArray(bffPrefix) ? bffPrefix : bffPrefix ? [
23
+ bffPrefix
24
+ ] : [];
25
+ for (const prefix of bffPrefixes){
26
+ const normalizedPrefix = normalizeApiPrefix(prefix);
27
+ if (normalizedPrefix) prefixes.add(normalizedPrefix);
28
+ }
29
+ return [
30
+ ...prefixes
31
+ ];
32
+ };
33
+ const matchesApiPrefix = (pathname, apiPrefixes)=>{
34
+ const normalizedPathname = pathname.startsWith('/') ? pathname : `/${pathname}`;
35
+ return apiPrefixes.some((prefix)=>normalizedPathname === prefix || normalizedPathname.startsWith(`${prefix}/`));
36
+ };
6
37
  const convertToHonoLanguageDetectorOptions = (languages, fallbackLanguage, detectionOptions)=>{
7
38
  const mergedDetection = detectionOptions ? mergeDetectionOptions(detectionOptions) : DEFAULT_I18NEXT_DETECTION_OPTIONS;
8
39
  const order = (mergedDetection.order || []).filter((item)=>![
@@ -92,15 +123,20 @@ const getLanguageFromPath = (req, urlPath, languages)=>{
92
123
  if (languages.includes(firstSegment)) return firstSegment;
93
124
  return null;
94
125
  };
95
- const buildLocalizedUrl = (req, urlPath, language, languages)=>{
126
+ const buildLocalizedUrl = (req, urlPath, language, languages, localisedUrls)=>{
96
127
  const url = new URL(req.url);
97
128
  const pathname = url.pathname;
98
129
  const basePath = urlPath.replace('/*', '');
99
130
  const remainingPath = pathname.startsWith(basePath) ? pathname.slice(basePath.length) : pathname;
100
131
  const segments = remainingPath.split('/').filter(Boolean);
101
- if (segments.length > 0 && languages.includes(segments[0])) segments[0] = language;
102
- else segments.unshift(language);
103
- const newPathname = `/${segments.join('/')}`;
132
+ const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
133
+ const pathWithoutLanguage = segments.length > 0 && languages.includes(segments[0]) ? `/${segments.slice(1).join('/')}` : remainingPath;
134
+ const resolvedPath = localisedUrlsConfig.enabled ? resolveLocalisedPath(pathWithoutLanguage, language, languages, localisedUrlsConfig.map) : pathWithoutLanguage;
135
+ const resolvedSegments = resolvedPath.split('/').filter(Boolean);
136
+ const newPathname = `/${[
137
+ language,
138
+ ...resolvedSegments
139
+ ].join('/')}`;
104
140
  const suffix = `${url.search}${url.hash}`;
105
141
  const localizedUrl = '/' === basePath ? newPathname + suffix : basePath + newPathname + suffix;
106
142
  return localizedUrl;
@@ -110,6 +146,9 @@ const i18nServerPlugin = (options)=>({
110
146
  setup: (api)=>{
111
147
  api.onPrepare(()=>{
112
148
  const { middlewares, routes } = api.getServerContext();
149
+ const serverConfig = api.getServerConfig();
150
+ const bffPrefix = serverConfig?.bff ? serverConfig.bff.prefix ?? '/api' : void 0;
151
+ const apiPrefixes = collectApiPrefixes(routes, bffPrefix);
113
152
  const entryPaths = new Set();
114
153
  routes.forEach((route)=>{
115
154
  if (route.entryName && route.urlPath && '/' !== route.urlPath) {
@@ -121,7 +160,7 @@ const i18nServerPlugin = (options)=>({
121
160
  const { entryName } = route;
122
161
  if (!entryName) return;
123
162
  if (!options.localeDetection) return;
124
- const { localePathRedirect, i18nextDetector = true, languages = [], fallbackLanguage = 'en', detection, ignoreRedirectRoutes } = getLocaleDetectionOptions(entryName, options.localeDetection);
163
+ const { localePathRedirect, i18nextDetector = true, languages = [], fallbackLanguage = 'en', detection, ignoreRedirectRoutes, localisedUrls } = getLocaleDetectionOptions(entryName, options.localeDetection);
125
164
  const staticRoutePrefixes = options.staticRoutePrefixes;
126
165
  const originUrlPath = route.urlPath;
127
166
  const urlPath = originUrlPath.endsWith('/') ? `${originUrlPath}*` : `${originUrlPath}/*`;
@@ -135,6 +174,7 @@ const i18nServerPlugin = (options)=>({
135
174
  handler: async (c, next)=>{
136
175
  const url = new URL(c.req.url);
137
176
  const pathname = url.pathname;
177
+ if (matchesApiPrefix(pathname, apiPrefixes)) return await next();
138
178
  if (isStaticResourceRequest(pathname, staticRoutePrefixes, languages)) return await next();
139
179
  if ('/' === originUrlPath) {
140
180
  const pathSegments = pathname.split('/').filter(Boolean);
@@ -153,6 +193,7 @@ const i18nServerPlugin = (options)=>({
153
193
  handler: async (c, next)=>{
154
194
  const url = new URL(c.req.url);
155
195
  const pathname = url.pathname;
196
+ if (matchesApiPrefix(pathname, apiPrefixes)) return await next();
156
197
  if (isStaticResourceRequest(pathname, staticRoutePrefixes, languages)) return await next();
157
198
  if (shouldIgnoreRedirect(pathname, urlPath, ignoreRedirectRoutes)) return await next();
158
199
  if ('/' === originUrlPath) {
@@ -167,9 +208,18 @@ const i18nServerPlugin = (options)=>({
167
208
  let detectedLanguage = null;
168
209
  if (i18nextDetector) detectedLanguage = c.get('language') || null;
169
210
  const targetLanguage = detectedLanguage || fallbackLanguage;
170
- const localizedUrl = buildLocalizedUrl(c.req, originUrlPath, targetLanguage, languages);
211
+ const localizedUrl = buildLocalizedUrl(c.req, originUrlPath, targetLanguage, languages, localisedUrls);
171
212
  return c.redirect(localizedUrl);
172
213
  }
214
+ const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
215
+ if (localisedUrlsConfig.enabled) {
216
+ const basePath = originUrlPath.replace('/*', '');
217
+ const remainingPath = pathname.startsWith(basePath) ? pathname.slice(basePath.length) : pathname;
218
+ const pathWithoutLanguage = remainingPath.split('/').filter(Boolean).slice(1).join('/');
219
+ const canonicalLocalizedPath = resolveLocalisedPath(`/${pathWithoutLanguage}`, language, languages, localisedUrlsConfig.map);
220
+ const expectedPathname = '/' === basePath ? `/${language}${'/' === canonicalLocalizedPath ? '' : canonicalLocalizedPath}` : `${basePath}/${language}${'/' === canonicalLocalizedPath ? '' : canonicalLocalizedPath}`;
221
+ if (expectedPathname !== pathname) return c.redirect(`${expectedPathname}${url.search}${url.hash}`);
222
+ }
173
223
  await next();
174
224
  }
175
225
  });
@@ -180,4 +230,4 @@ const i18nServerPlugin = (options)=>({
180
230
  });
181
231
  const server = i18nServerPlugin;
182
232
  export default server;
183
- export { i18nServerPlugin };
233
+ export { collectApiPrefixes, i18nServerPlugin, matchesApiPrefix };
@@ -0,0 +1,192 @@
1
+ import "node:module";
2
+ const LOCALE_PARAM_NAMES = new Set([
3
+ 'lang',
4
+ 'locale',
5
+ 'language'
6
+ ]);
7
+ const normalisePathPattern = (path)=>{
8
+ const withoutDuplicateSlashes = path.replace(/\/+/g, '/');
9
+ const withLeadingSlash = withoutDuplicateSlashes.startsWith('/') ? withoutDuplicateSlashes : `/${withoutDuplicateSlashes}`;
10
+ const withoutTrailingSlash = withLeadingSlash.length > 1 ? withLeadingSlash.replace(/\/+$/, '') : withLeadingSlash;
11
+ return withoutTrailingSlash.replace(/\[(.+?)\]/g, ':$1');
12
+ };
13
+ const normaliseRoutePath = (path)=>{
14
+ const normalized = normalisePathPattern(path);
15
+ return '/' === normalized ? '' : normalized.slice(1);
16
+ };
17
+ const getLocaleParamSegment = (segment)=>{
18
+ if (!segment.startsWith(':')) return null;
19
+ const paramName = segment.slice(1).replace(/\?$/, '');
20
+ return LOCALE_PARAM_NAMES.has(paramName) ? segment : null;
21
+ };
22
+ const splitPathSegments = (path)=>{
23
+ if (!path) return [];
24
+ return normalisePathPattern(path).split('/').filter(Boolean);
25
+ };
26
+ const stripLeadingLocaleParam = (path)=>{
27
+ const segments = splitPathSegments(path);
28
+ const leadingLocaleParam = getLocaleParamSegment(segments[0] || '');
29
+ if (!leadingLocaleParam) return path;
30
+ const remainingPath = segments.slice(1).join('/');
31
+ return remainingPath ? `/${remainingPath}` : void 0;
32
+ };
33
+ const getLeadingLocaleParam = (path)=>{
34
+ const segments = splitPathSegments(path);
35
+ return getLocaleParamSegment(segments[0] || '');
36
+ };
37
+ const resolveLocalisedUrlsConfig = (option)=>{
38
+ if (false === option) return {
39
+ enabled: false,
40
+ map: {}
41
+ };
42
+ if (option && 'object' == typeof option) return {
43
+ enabled: true,
44
+ map: option
45
+ };
46
+ return {
47
+ enabled: true,
48
+ map: {}
49
+ };
50
+ };
51
+ const isLocalisableRoutePath = (path)=>{
52
+ const pathWithoutLocale = stripLeadingLocaleParam(path);
53
+ if (!pathWithoutLocale || '/' === pathWithoutLocale || '*' === pathWithoutLocale) return false;
54
+ return true;
55
+ };
56
+ const joinPath = (parentPath, routePath)=>{
57
+ if (!isLocalisableRoutePath(routePath)) return parentPath;
58
+ const segment = normaliseRoutePath(stripLeadingLocaleParam(routePath) || '');
59
+ return normalisePathPattern(`${parentPath}/${segment}`);
60
+ };
61
+ const ensureLocalisedUrlsForPath = (canonicalPath, languages, localisedUrls)=>{
62
+ const entry = localisedUrls[canonicalPath];
63
+ 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.`);
64
+ const missingLanguages = languages.filter((language)=>!entry[language]);
65
+ if (missingLanguages.length > 0) throw new Error(`localisedUrls["${canonicalPath}"] is missing languages: ${missingLanguages.join(', ')}. Every configured language must have a localised URL.`);
66
+ return entry;
67
+ };
68
+ const validateLocalisedUrls = (routes, languages, localisedUrls)=>{
69
+ const visit = (route, parentPath)=>{
70
+ const canonicalPath = joinPath(parentPath, route.path);
71
+ if (isLocalisableRoutePath(route.path)) ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls);
72
+ if ('children' in route && route.children) route.children.forEach((child)=>visit(child, canonicalPath));
73
+ };
74
+ routes.forEach((route)=>visit(route, ''));
75
+ };
76
+ const getLocalisedRoutePaths = (canonicalPath, parentLocalisedPaths, languages, entry)=>{
77
+ const paths = languages.map((language)=>{
78
+ const fullPath = normalisePathPattern(entry[language]);
79
+ const parentPath = normalisePathPattern(parentLocalisedPaths[language] || '/');
80
+ if ('/' === parentPath) return normaliseRoutePath(fullPath) || void 0;
81
+ const parentPrefix = `${parentPath}/`;
82
+ if (!fullPath.startsWith(parentPrefix)) throw new Error(`localisedUrls["${canonicalPath}"].${language} must be nested under "${parentPath}" because its parent route is localised there.`);
83
+ return normaliseRoutePath(fullPath.slice(parentPath.length));
84
+ });
85
+ return Array.from(new Set(paths.filter(Boolean)));
86
+ };
87
+ const transformLocalisedRoute = (route, parentCanonicalPath, parentLocalisedPaths, languages, localisedUrls)=>{
88
+ const canonicalPath = joinPath(parentCanonicalPath, route.path);
89
+ const localisedUrlEntry = isLocalisableRoutePath(route.path) ? ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls) : void 0;
90
+ const routeLocalisedPaths = localisedUrlEntry ? languages.reduce((acc, language)=>{
91
+ acc[language] = normalisePathPattern(localisedUrlEntry[language]);
92
+ return acc;
93
+ }, {}) : parentLocalisedPaths;
94
+ const children = 'children' in route && route.children ? route.children.flatMap((child)=>transformLocalisedRoute(child, canonicalPath, routeLocalisedPaths, languages, localisedUrls)) : void 0;
95
+ const baseRoute = {
96
+ ...route,
97
+ ...children ? {
98
+ children
99
+ } : {}
100
+ };
101
+ if (!localisedUrlEntry) return [
102
+ baseRoute
103
+ ];
104
+ return getLocalisedRoutePaths(canonicalPath, parentLocalisedPaths, languages, localisedUrlEntry).map((localisedPath, index)=>cloneRouteWithLocalisedPath(baseRoute, localisedPath, index));
105
+ };
106
+ const legalRouteIdPart = (value)=>value.replace(/[^a-zA-Z0-9_$-]+/g, '_').replace(/^_+|_+$/g, '') || 'index';
107
+ const suffixRouteIds = (route, suffix)=>{
108
+ const children = 'children' in route && route.children ? route.children.map((child)=>suffixRouteIds(child, suffix)) : void 0;
109
+ return {
110
+ ...route,
111
+ ...route.id ? {
112
+ id: `${route.id}__localised_${suffix}`
113
+ } : {},
114
+ ...children ? {
115
+ children
116
+ } : {}
117
+ };
118
+ };
119
+ const cloneRouteWithLocalisedPath = (route, path, index)=>{
120
+ const leadingLocaleParam = getLeadingLocaleParam(route.path);
121
+ const localisedPath = leadingLocaleParam ? normaliseRoutePath(`${leadingLocaleParam}/${path}`) : path;
122
+ const routeWithPath = {
123
+ ...route,
124
+ path: localisedPath
125
+ };
126
+ return 0 === index ? routeWithPath : suffixRouteIds(routeWithPath, legalRouteIdPart(localisedPath));
127
+ };
128
+ const applyLocalisedUrlsToRoutes = (routes, languages, localisedUrls)=>{
129
+ const rootLocalisedPaths = languages.reduce((acc, language)=>{
130
+ acc[language] = '/';
131
+ return acc;
132
+ }, {});
133
+ validateLocalisedUrls(routes, languages, localisedUrls);
134
+ return routes.flatMap((route)=>transformLocalisedRoute(route, '', rootLocalisedPaths, languages, localisedUrls));
135
+ };
136
+ const escapeRegExp = (value)=>value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
137
+ const getParamName = (segment)=>segment.slice(1).replace(/\?$/, '');
138
+ const compilePathPattern = (pattern)=>{
139
+ const names = [];
140
+ const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
141
+ const source = segments.map((segment)=>{
142
+ if (segment.startsWith(':')) {
143
+ names.push(getParamName(segment));
144
+ const paramPattern = '([^/]+)';
145
+ return segment.endsWith('?') ? `(?:/${paramPattern})?` : `/${paramPattern}`;
146
+ }
147
+ if ('*' === segment) {
148
+ names.push('*');
149
+ return '/(.*)';
150
+ }
151
+ return `/${escapeRegExp(segment)}`;
152
+ }).join('');
153
+ return {
154
+ names,
155
+ regexp: new RegExp(`^${source || '/'}$`)
156
+ };
157
+ };
158
+ const matchPathPattern = (pathname, pattern)=>{
159
+ const { names, regexp } = compilePathPattern(pattern);
160
+ const match = regexp.exec(normalisePathPattern(pathname));
161
+ if (!match) return null;
162
+ return names.reduce((params, name, index)=>{
163
+ params[name] = decodeURIComponent(match[index + 1] || '');
164
+ return params;
165
+ }, {});
166
+ };
167
+ const buildPathFromPattern = (pattern, params)=>{
168
+ const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
169
+ const path = segments.map((segment)=>{
170
+ if (segment.startsWith(':')) {
171
+ const param = params[getParamName(segment)];
172
+ return param ? encodeURIComponent(param) : '';
173
+ }
174
+ if ('*' === segment) return params['*'] || '';
175
+ return segment;
176
+ }).filter(Boolean).join('/');
177
+ return `/${path}`;
178
+ };
179
+ const resolveLocalisedPath = (pathname, targetLanguage, languages, localisedUrls)=>{
180
+ const normalizedPathname = normalisePathPattern(pathname);
181
+ for (const localisedUrlEntry of Object.values(localisedUrls)){
182
+ const targetPattern = localisedUrlEntry[targetLanguage];
183
+ if (targetPattern) for (const language of languages){
184
+ const sourcePattern = localisedUrlEntry[language];
185
+ if (!sourcePattern) continue;
186
+ const params = matchPathPattern(normalizedPathname, sourcePattern);
187
+ if (params) return buildPathFromPattern(targetPattern, params);
188
+ }
189
+ }
190
+ return normalizedPathname;
191
+ };
192
+ export { applyLocalisedUrlsToRoutes, normalisePathPattern, resolveLocalisedPath, resolveLocalisedUrlsConfig, validateLocalisedUrls };
@@ -4,5 +4,20 @@ export interface I18nLinkProps {
4
4
  children: React.ReactNode;
5
5
  [key: string]: any;
6
6
  }
7
+ /**
8
+ * I18nLink component that automatically adds language prefix to navigation links.
9
+ * This component should be used within a :lang dynamic route context.
10
+ *
11
+ * @example
12
+ * ```tsx
13
+ * // When current language is 'en' and to="/about"
14
+ * // The actual link will be "/en/about"
15
+ * <I18nLink to="/about">About</I18nLink>
16
+ *
17
+ * // When current language is 'zh' and to="/"
18
+ * // The actual link will be "/zh"
19
+ * <I18nLink to="/">Home</I18nLink>
20
+ * ```
21
+ */
7
22
  export declare const I18nLink: React.FC<I18nLinkProps>;
8
23
  export default I18nLink;
@@ -1,4 +1,5 @@
1
1
  import type { FC, ReactNode } from 'react';
2
+ import type { LocalisedUrlsOption } from '../shared/localisedUrls';
2
3
  import type { I18nInstance } from './i18n';
3
4
  export interface ModernI18nContextValue {
4
5
  language: string;
@@ -7,6 +8,7 @@ export interface ModernI18nContextValue {
7
8
  languages?: string[];
8
9
  localePathRedirect?: boolean;
9
10
  ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean);
11
+ localisedUrls?: LocalisedUrlsOption;
10
12
  updateLanguage?: (newLang: string) => void;
11
13
  }
12
14
  export interface ModernI18nProviderProps {
@@ -19,6 +21,7 @@ export interface UseModernI18nReturn {
19
21
  changeLanguage: (newLang: string) => Promise<void>;
20
22
  i18nInstance: I18nInstance;
21
23
  supportedLanguages: string[];
24
+ localisedUrls?: LocalisedUrlsOption;
22
25
  isLanguageSupported: (lang: string) => boolean;
23
26
  isResourcesReady: boolean;
24
27
  }
@@ -1,16 +1,18 @@
1
1
  import type { TRuntimeContext } from '@modern-js/runtime';
2
2
  import type React from 'react';
3
+ import type { LocalisedUrlsOption } from '../shared/localisedUrls';
3
4
  import type { I18nInstance } from './i18n';
4
5
  interface RuntimeContextWithI18n extends TRuntimeContext {
5
6
  i18nInstance?: I18nInstance;
6
7
  }
7
- 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): {
8
+ 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): {
8
9
  language: string;
9
10
  i18nInstance: I18nInstance;
10
11
  entryName: string | undefined;
11
12
  languages: string[];
12
13
  localePathRedirect: boolean;
13
14
  ignoreRedirectRoutes: string[] | ((pathname: string) => boolean) | undefined;
15
+ localisedUrls: LocalisedUrlsOption | undefined;
14
16
  updateLanguage: (lang: string) => void;
15
17
  };
16
18
  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
23
25
  * In SSR/SSG scenarios, server-side middleware handles redirects, so this hook is skipped.
24
26
  * We use process.env.MODERN_TARGET to ensure this code is only included in browser bundles.
25
27
  */
26
- export declare function useClientSideRedirect(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], fallbackLanguage: string, ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean)): void;
28
+ export declare function useClientSideRedirect(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], fallbackLanguage: string, ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean), localisedUrls?: LocalisedUrlsOption): void;
27
29
  export declare function useLanguageSync(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], runtimeContextRef: React.MutableRefObject<RuntimeContextWithI18n>, prevLangRef: React.MutableRefObject<string>, setLang: (lang: string) => void): void;
28
30
  export {};
@@ -1,4 +1,4 @@
1
- import Backend from 'i18next-fs-backend';
1
+ import Backend from 'i18next-fs-backend/cjs';
2
2
  import type { ExtendedBackendOptions } from '../../../shared/type';
3
3
  import type { I18nInstance } from '../instance';
4
4
  /**
@@ -12,6 +12,7 @@ export interface I18nPluginOptions {
12
12
  changeLanguage?: (lang: string) => void;
13
13
  initOptions?: I18nInitOptions;
14
14
  htmlLangAttr?: boolean;
15
+ reactI18next?: boolean;
15
16
  [key: string]: any;
16
17
  }
17
18
  export declare const i18nPlugin: (options: I18nPluginOptions) => RuntimePlugin;
@@ -0,0 +1,26 @@
1
+ import type React from 'react';
2
+ export type I18nRouterFramework = 'react-router' | 'tanstack' | string;
3
+ export interface I18nRouterLocation {
4
+ pathname: string;
5
+ search: string;
6
+ hash: string;
7
+ }
8
+ export interface I18nRouterNavigateOptions {
9
+ replace?: boolean;
10
+ state?: unknown;
11
+ }
12
+ export type I18nRouterNavigate = (href: string, options?: I18nRouterNavigateOptions) => void | Promise<void>;
13
+ export type I18nRouterLink = React.ComponentType<{
14
+ to: string;
15
+ children?: React.ReactNode;
16
+ [key: string]: unknown;
17
+ }>;
18
+ export interface I18nRouterAdapter {
19
+ framework?: I18nRouterFramework;
20
+ hasRouter: boolean;
21
+ location: I18nRouterLocation | null;
22
+ navigate: I18nRouterNavigate | null;
23
+ Link: I18nRouterLink | null;
24
+ params: Record<string, string>;
25
+ }
26
+ export declare const useI18nRouterAdapter: () => I18nRouterAdapter;
@@ -1,4 +1,5 @@
1
1
  import { type TInternalRuntimeContext } from '@modern-js/runtime/context';
2
+ import type { LocalisedUrlsMap } from '../shared/localisedUrls';
2
3
  export declare const getPathname: (context: TInternalRuntimeContext) => string;
3
4
  export declare const getEntryPath: () => string;
4
5
  /**
@@ -16,7 +17,7 @@ export declare const getLanguageFromPath: (pathname: string, languages: string[]
16
17
  * @param languages - Array of supported languages
17
18
  * @returns The localized URL path
18
19
  */
19
- export declare const buildLocalizedUrl: (pathname: string, language: string, languages: string[]) => string;
20
+ export declare const buildLocalizedUrl: (pathname: string, language: string, languages: string[], localisedUrls?: boolean | LocalisedUrlsMap) => string;
20
21
  export declare const detectLanguageFromPath: (pathname: string, languages: string[], localePathRedirect: boolean) => {
21
22
  detected: boolean;
22
23
  language?: string;
@@ -25,9 +26,3 @@ export declare const detectLanguageFromPath: (pathname: string, languages: strin
25
26
  * Check if the given pathname should ignore automatic locale redirect
26
27
  */
27
28
  export declare const shouldIgnoreRedirect: (pathname: string, languages: string[], ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean)) => boolean;
28
- export declare const useRouterHooks: () => {
29
- navigate: any;
30
- location: any;
31
- params: any;
32
- hasRouter: boolean;
33
- };
@@ -4,5 +4,11 @@ export interface I18nPluginOptions {
4
4
  localeDetection: LocaleDetectionOptions;
5
5
  staticRoutePrefixes: string[];
6
6
  }
7
+ type ApiPrefixInput = string | string[] | undefined;
8
+ export declare const collectApiPrefixes: (routes: Array<{
9
+ isApi?: boolean;
10
+ urlPath?: string;
11
+ }>, bffPrefix?: ApiPrefixInput) => string[];
12
+ export declare const matchesApiPrefix: (pathname: string, apiPrefixes: string[]) => boolean;
7
13
  export declare const i18nServerPlugin: (options: I18nPluginOptions) => ServerPlugin;
8
14
  export default i18nServerPlugin;
@@ -0,0 +1,13 @@
1
+ import type { NestedRouteForCli, PageRoute } from '@modern-js/types';
2
+ export type LocalisedUrlPathMap = Record<string, string>;
3
+ export type LocalisedUrlsMap = Record<string, LocalisedUrlPathMap>;
4
+ export type LocalisedUrlsOption = boolean | LocalisedUrlsMap;
5
+ export interface ResolvedLocalisedUrlsConfig {
6
+ enabled: boolean;
7
+ map: LocalisedUrlsMap;
8
+ }
9
+ export declare const normalisePathPattern: (path: string) => string;
10
+ export declare const resolveLocalisedUrlsConfig: (option: LocalisedUrlsOption | undefined) => ResolvedLocalisedUrlsConfig;
11
+ export declare const validateLocalisedUrls: (routes: (NestedRouteForCli | PageRoute)[], languages: string[], localisedUrls: LocalisedUrlsMap) => void;
12
+ export declare const applyLocalisedUrlsToRoutes: (routes: (NestedRouteForCli | PageRoute)[], languages: string[], localisedUrls: LocalisedUrlsMap) => (NestedRouteForCli | PageRoute)[];
13
+ export declare const resolveLocalisedPath: (pathname: string, targetLanguage: string, languages: string[], localisedUrls: LocalisedUrlsMap) => string;
@@ -1,4 +1,5 @@
1
1
  import type { LanguageDetectorOptions, Resources } from '../runtime/i18n/instance';
2
+ import type { LocalisedUrlsOption } from './localisedUrls';
2
3
  export interface BaseLocaleDetectionOptions {
3
4
  localePathRedirect?: boolean;
4
5
  i18nextDetector?: boolean;
@@ -6,6 +7,17 @@ export interface BaseLocaleDetectionOptions {
6
7
  fallbackLanguage?: string;
7
8
  detection?: LanguageDetectorOptions;
8
9
  ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean);
10
+ /**
11
+ * Enables localised pathnames in addition to the locale prefix.
12
+ *
13
+ * - `false`: keep only locale-prefix behavior (`/en/about`).
14
+ * - object: map canonical route paths to every configured language.
15
+ *
16
+ * Defaults to `true` when `localePathRedirect` is enabled, so route
17
+ * generation validates that every localisable route path has entries for all
18
+ * configured languages.
19
+ */
20
+ localisedUrls?: LocalisedUrlsOption;
9
21
  }
10
22
  export interface LocaleDetectionOptions extends BaseLocaleDetectionOptions {
11
23
  localeDetectionByEntry?: Record<string, BaseLocaleDetectionOptions>;
package/package.json CHANGED
@@ -17,7 +17,7 @@
17
17
  "modern",
18
18
  "modern.js"
19
19
  ],
20
- "version": "3.2.0-ultramodern.17",
20
+ "version": "3.2.0-ultramodern.22",
21
21
  "engines": {
22
22
  "node": ">=20"
23
23
  },
@@ -84,18 +84,18 @@
84
84
  "@swc/helpers": "^0.5.21",
85
85
  "i18next-browser-languagedetector": "^8.2.1",
86
86
  "i18next-chained-backend": "^5.0.4",
87
- "i18next-fs-backend": "^2.6.5",
87
+ "i18next-fs-backend": "^2.6.6",
88
88
  "i18next-http-backend": "^4.0.0",
89
- "i18next-http-middleware": "^3.9.6",
90
- "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.2.0-ultramodern.17",
91
- "@modern-js/runtime-utils": "npm:@bleedingdev/modern-js-runtime-utils@3.2.0-ultramodern.17",
92
- "@modern-js/server-runtime": "npm:@bleedingdev/modern-js-server-runtime@3.2.0-ultramodern.17",
93
- "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.2.0-ultramodern.17",
94
- "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.17",
95
- "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.17"
89
+ "i18next-http-middleware": "^3.9.7",
90
+ "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.2.0-ultramodern.22",
91
+ "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.2.0-ultramodern.22",
92
+ "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.22",
93
+ "@modern-js/server-runtime": "npm:@bleedingdev/modern-js-server-runtime@3.2.0-ultramodern.22",
94
+ "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.22",
95
+ "@modern-js/runtime-utils": "npm:@bleedingdev/modern-js-runtime-utils@3.2.0-ultramodern.22"
96
96
  },
97
97
  "peerDependencies": {
98
- "@modern-js/runtime": "3.2.0-ultramodern.17",
98
+ "@modern-js/runtime": "3.2.0-ultramodern.22",
99
99
  "i18next": ">=25.7.4",
100
100
  "react": "^19.2.6",
101
101
  "react-dom": "^19.2.6",
@@ -112,16 +112,16 @@
112
112
  "devDependencies": {
113
113
  "@rslib/core": "0.21.5",
114
114
  "@types/jest": "^30.0.0",
115
- "@types/node": "^25.8.0",
116
- "@typescript/native-preview": "7.0.0-dev.20260516.1",
115
+ "@types/node": "^25.9.1",
116
+ "@typescript/native-preview": "7.0.0-dev.20260526.1",
117
117
  "i18next": "26.2.0",
118
118
  "jest": "^30.4.2",
119
119
  "react": "^19.2.6",
120
120
  "react-dom": "^19.2.6",
121
121
  "react-i18next": "17.0.8",
122
- "ts-jest": "^29.4.9",
123
- "@modern-js/app-tools": "npm:@bleedingdev/modern-js-app-tools@3.2.0-ultramodern.17",
124
- "@modern-js/runtime": "npm:@bleedingdev/modern-js-runtime@3.2.0-ultramodern.17"
122
+ "ts-jest": "^29.4.11",
123
+ "@modern-js/app-tools": "npm:@bleedingdev/modern-js-app-tools@3.2.0-ultramodern.22",
124
+ "@modern-js/runtime": "npm:@bleedingdev/modern-js-runtime@3.2.0-ultramodern.22"
125
125
  },
126
126
  "sideEffects": false,
127
127
  "publishConfig": {