@bleedingdev/modern-js-plugin-i18n 3.8.3-ultramodern.1 → 3.8.3-ultramodern.2

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 (97) hide show
  1. package/dist/cjs/cli/index.js +3 -3
  2. package/dist/cjs/runtime/context.js +19 -6
  3. package/dist/cjs/runtime/hooks.js +8 -11
  4. package/dist/cjs/runtime/localizedPaths.js +2 -2
  5. package/dist/cjs/runtime/providerComposition.js +3 -1
  6. package/dist/cjs/runtime/utils.js +3 -3
  7. package/dist/cjs/server/index.js +2 -2
  8. package/dist/cjs/server/redirectPolicy.js +6 -6
  9. package/dist/esm/cli/index.mjs +1 -1
  10. package/dist/esm/runtime/context.mjs +19 -6
  11. package/dist/esm/runtime/hooks.mjs +8 -11
  12. package/dist/esm/runtime/localizedPaths.mjs +1 -1
  13. package/dist/esm/runtime/providerComposition.mjs +3 -1
  14. package/dist/esm/runtime/utils.mjs +1 -1
  15. package/dist/esm/server/index.mjs +1 -1
  16. package/dist/esm/server/redirectPolicy.mjs +1 -1
  17. package/dist/esm-node/cli/index.mjs +1 -1
  18. package/dist/esm-node/runtime/context.mjs +19 -6
  19. package/dist/esm-node/runtime/hooks.mjs +8 -11
  20. package/dist/esm-node/runtime/localizedPaths.mjs +1 -1
  21. package/dist/esm-node/runtime/providerComposition.mjs +3 -1
  22. package/dist/esm-node/runtime/utils.mjs +1 -1
  23. package/dist/esm-node/server/index.mjs +1 -1
  24. package/dist/esm-node/server/redirectPolicy.mjs +1 -1
  25. package/dist/types/runtime/context.d.ts +3 -2
  26. package/dist/types/runtime/contextHelpers.d.ts +1 -1
  27. package/dist/types/runtime/hooks.d.ts +1 -1
  28. package/dist/types/runtime/localizedPaths.d.ts +1 -1
  29. package/dist/types/runtime/utils.d.ts +1 -1
  30. package/dist/types/shared/type.d.ts +1 -1
  31. package/package.json +32 -11
  32. package/src/cli/index.ts +4 -4
  33. package/src/runtime/context.tsx +38 -14
  34. package/src/runtime/contextHelpers.ts +1 -1
  35. package/src/runtime/hooks.ts +9 -10
  36. package/src/runtime/localizedPaths.ts +4 -2
  37. package/src/runtime/providerComposition.tsx +5 -2
  38. package/src/runtime/utils.ts +4 -4
  39. package/src/server/index.ts +1 -1
  40. package/src/server/redirectPolicy.ts +1 -1
  41. package/src/shared/type.ts +1 -1
  42. package/tests/federatedI18nBoundary.client.test.tsx +21 -4
  43. package/tests/federatedI18nBoundary.test.tsx +15 -3
  44. package/tests/linkTypes.test.ts +20 -0
  45. package/tests/localisedUrlRewriteMatrix.fork.test.ts +1 -1
  46. package/tests/localisedUrls.test.ts +0 -351
  47. package/tests/routerAdapter.test.tsx +5 -12
  48. package/dist/cjs/shared/localisedUrls/config.js +0 -49
  49. package/dist/cjs/shared/localisedUrls/index.js +0 -91
  50. package/dist/cjs/shared/localisedUrls/normalise.js +0 -87
  51. package/dist/cjs/shared/localisedUrls/pathname.js +0 -68
  52. package/dist/cjs/shared/localisedUrls/patterns.js +0 -130
  53. package/dist/cjs/shared/localisedUrls/redirect.js +0 -103
  54. package/dist/cjs/shared/localisedUrls/resolve.js +0 -88
  55. package/dist/cjs/shared/localisedUrls/routes.js +0 -130
  56. package/dist/cjs/shared/localisedUrls/types.js +0 -18
  57. package/dist/cjs/shared/localisedUrls.js +0 -85
  58. package/dist/esm/shared/localisedUrls/config.mjs +0 -11
  59. package/dist/esm/shared/localisedUrls/index.mjs +0 -7
  60. package/dist/esm/shared/localisedUrls/normalise.mjs +0 -37
  61. package/dist/esm/shared/localisedUrls/pathname.mjs +0 -24
  62. package/dist/esm/shared/localisedUrls/patterns.mjs +0 -86
  63. package/dist/esm/shared/localisedUrls/redirect.mjs +0 -56
  64. package/dist/esm/shared/localisedUrls/resolve.mjs +0 -47
  65. package/dist/esm/shared/localisedUrls/routes.mjs +0 -89
  66. package/dist/esm/shared/localisedUrls/types.mjs +0 -0
  67. package/dist/esm/shared/localisedUrls.mjs +0 -1
  68. package/dist/esm-node/shared/localisedUrls/config.mjs +0 -12
  69. package/dist/esm-node/shared/localisedUrls/index.mjs +0 -8
  70. package/dist/esm-node/shared/localisedUrls/normalise.mjs +0 -38
  71. package/dist/esm-node/shared/localisedUrls/pathname.mjs +0 -25
  72. package/dist/esm-node/shared/localisedUrls/patterns.mjs +0 -87
  73. package/dist/esm-node/shared/localisedUrls/redirect.mjs +0 -57
  74. package/dist/esm-node/shared/localisedUrls/resolve.mjs +0 -48
  75. package/dist/esm-node/shared/localisedUrls/routes.mjs +0 -90
  76. package/dist/esm-node/shared/localisedUrls/types.mjs +0 -1
  77. package/dist/esm-node/shared/localisedUrls.mjs +0 -2
  78. package/dist/types/shared/localisedUrls/config.d.ts +0 -9
  79. package/dist/types/shared/localisedUrls/index.d.ts +0 -9
  80. package/dist/types/shared/localisedUrls/normalise.d.ts +0 -10
  81. package/dist/types/shared/localisedUrls/pathname.d.ts +0 -4
  82. package/dist/types/shared/localisedUrls/patterns.d.ts +0 -5
  83. package/dist/types/shared/localisedUrls/redirect.d.ts +0 -11
  84. package/dist/types/shared/localisedUrls/resolve.d.ts +0 -7
  85. package/dist/types/shared/localisedUrls/routes.d.ts +0 -3
  86. package/dist/types/shared/localisedUrls/types.d.ts +0 -14
  87. package/dist/types/shared/localisedUrls.d.ts +0 -2
  88. package/src/shared/localisedUrls/config.ts +0 -18
  89. package/src/shared/localisedUrls/index.ts +0 -24
  90. package/src/shared/localisedUrls/normalise.ts +0 -67
  91. package/src/shared/localisedUrls/pathname.ts +0 -60
  92. package/src/shared/localisedUrls/patterns.ts +0 -160
  93. package/src/shared/localisedUrls/redirect.ts +0 -93
  94. package/src/shared/localisedUrls/resolve.ts +0 -135
  95. package/src/shared/localisedUrls/routes.ts +0 -234
  96. package/src/shared/localisedUrls/types.ts +0 -18
  97. package/src/shared/localisedUrls.ts +0 -26
@@ -1,135 +0,0 @@
1
- import { normalisePathname } from './normalise';
2
-
3
- import {
4
- buildPathFromPattern,
5
- matchPathPattern,
6
- sortPatternsBySpecificity,
7
- } from './patterns';
8
-
9
- import type { LocalisedUrlsMap } from './types';
10
-
11
- type CanonicalCandidate = {
12
- pattern: string;
13
- canonicalPattern: string;
14
- localisedUrlEntry: LocalisedUrlsMap[string];
15
- };
16
-
17
- type ResolveLocalisedUrlPathOptions =
18
- | {
19
- mode: 'localised';
20
- targetLanguage: string;
21
- }
22
- | {
23
- mode: 'canonical';
24
- };
25
-
26
- const getCanonicalCandidates = (
27
- localisedUrls: LocalisedUrlsMap,
28
- ): CanonicalCandidate[] =>
29
- sortPatternsBySpecificity(
30
- Object.entries(localisedUrls).map(
31
- ([canonicalPattern, localisedUrlEntry]) => ({
32
- pattern: canonicalPattern,
33
- canonicalPattern,
34
- localisedUrlEntry,
35
- }),
36
- ),
37
- );
38
-
39
- const resolveLocalisedUrlPath = (
40
- pathname: string,
41
- languages: string[],
42
- localisedUrls: LocalisedUrlsMap,
43
- options: ResolveLocalisedUrlPathOptions,
44
- ): string => {
45
- const normalizedPathname = normalisePathname(pathname);
46
- const canonicalCandidates = getCanonicalCandidates(localisedUrls);
47
-
48
- for (const { canonicalPattern, localisedUrlEntry } of canonicalCandidates) {
49
- const targetPattern =
50
- options.mode === 'localised'
51
- ? localisedUrlEntry[options.targetLanguage]
52
- : canonicalPattern;
53
-
54
- if (!targetPattern) {
55
- continue;
56
- }
57
-
58
- const canonicalParams = matchPathPattern(
59
- normalizedPathname,
60
- canonicalPattern,
61
- );
62
- if (canonicalParams) {
63
- return buildPathFromPattern(targetPattern, canonicalParams);
64
- }
65
-
66
- if (options.mode === 'canonical') {
67
- for (const language of languages) {
68
- const sourcePattern = localisedUrlEntry[language];
69
- if (!sourcePattern) {
70
- continue;
71
- }
72
-
73
- const params = matchPathPattern(normalizedPathname, sourcePattern);
74
- if (params) {
75
- return buildPathFromPattern(canonicalPattern, params);
76
- }
77
- }
78
- }
79
- }
80
-
81
- if (options.mode === 'localised') {
82
- const localisedCandidates = sortPatternsBySpecificity(
83
- Object.values(localisedUrls).flatMap(localisedUrlEntry => {
84
- const targetPattern = localisedUrlEntry[options.targetLanguage];
85
- if (!targetPattern) {
86
- return [];
87
- }
88
-
89
- return languages
90
- .map(language => localisedUrlEntry[language])
91
- .filter((sourcePattern): sourcePattern is string =>
92
- Boolean(sourcePattern),
93
- )
94
- .map(sourcePattern => ({
95
- pattern: sourcePattern,
96
- sourcePattern,
97
- targetPattern,
98
- }));
99
- }),
100
- );
101
-
102
- for (const { sourcePattern, targetPattern } of localisedCandidates) {
103
- const params = matchPathPattern(normalizedPathname, sourcePattern);
104
- if (params) {
105
- return buildPathFromPattern(targetPattern, params);
106
- }
107
- }
108
- }
109
-
110
- return normalizedPathname;
111
- };
112
-
113
- export const resolveLocalisedPath = (
114
- pathname: string,
115
- targetLanguage: string,
116
- languages: string[],
117
- localisedUrls: LocalisedUrlsMap,
118
- ): string =>
119
- resolveLocalisedUrlPath(pathname, languages, localisedUrls, {
120
- mode: 'localised',
121
- targetLanguage,
122
- });
123
-
124
- /**
125
- * Reverse-map language-specific pathnames back to language-agnostic
126
- * LocalisedUrlsMap keys.
127
- */
128
- export const resolveCanonicalLocalisedPath = (
129
- pathname: string,
130
- languages: string[],
131
- localisedUrls: LocalisedUrlsMap,
132
- ): string =>
133
- resolveLocalisedUrlPath(pathname, languages, localisedUrls, {
134
- mode: 'canonical',
135
- });
@@ -1,234 +0,0 @@
1
- import {
2
- getLeadingLocaleParam,
3
- normalisePathPattern,
4
- normaliseRoutePath,
5
- stripLeadingLocaleParam,
6
- } from './normalise';
7
- import type {
8
- LocalisedRoute,
9
- LocalisedUrlPathMap,
10
- LocalisedUrlsMap,
11
- } from './types';
12
-
13
- const isLocalisableRoutePath = (path?: string): path is string => {
14
- const pathWithoutLocale = stripLeadingLocaleParam(path);
15
-
16
- if (
17
- !pathWithoutLocale ||
18
- pathWithoutLocale === '/' ||
19
- pathWithoutLocale === '*'
20
- ) {
21
- return false;
22
- }
23
-
24
- return true;
25
- };
26
-
27
- const joinPath = (parentPath: string, routePath?: string): string => {
28
- if (!isLocalisableRoutePath(routePath)) {
29
- return parentPath;
30
- }
31
-
32
- const segment = normaliseRoutePath(stripLeadingLocaleParam(routePath) || '');
33
- return normalisePathPattern(`${parentPath}/${segment}`);
34
- };
35
-
36
- const isFrameworkInternalRoutePath = (canonicalPath: string) =>
37
- canonicalPath === '/_mf' || canonicalPath.startsWith('/_mf/');
38
-
39
- const ensureLocalisedUrlsForPath = (
40
- canonicalPath: string,
41
- languages: string[],
42
- localisedUrls: LocalisedUrlsMap,
43
- ): LocalisedUrlPathMap => {
44
- const entry = localisedUrls[canonicalPath];
45
- if (!entry) {
46
- throw new Error(
47
- `localisedUrls is enabled, but route "${canonicalPath}" does not define localised URLs for languages: ${languages.join(
48
- ', ',
49
- )}. Add localisedUrls["${canonicalPath}"] or set localeDetection.localisedUrls to false.`,
50
- );
51
- }
52
-
53
- const missingLanguages = languages.filter(language => !entry[language]);
54
- if (missingLanguages.length > 0) {
55
- throw new Error(
56
- `localisedUrls["${canonicalPath}"] is missing languages: ${missingLanguages.join(
57
- ', ',
58
- )}. Every configured language must have a localised URL.`,
59
- );
60
- }
61
-
62
- return entry;
63
- };
64
-
65
- export const validateLocalisedUrls = (
66
- routes: LocalisedRoute[],
67
- languages: string[],
68
- localisedUrls: LocalisedUrlsMap,
69
- ) => {
70
- const visit = (route: LocalisedRoute, parentPath: string) => {
71
- const canonicalPath = joinPath(parentPath, route.path);
72
- if (
73
- isLocalisableRoutePath(route.path) &&
74
- !isFrameworkInternalRoutePath(canonicalPath)
75
- ) {
76
- ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls);
77
- }
78
-
79
- if ('children' in route && route.children) {
80
- route.children.forEach(child => visit(child, canonicalPath));
81
- }
82
- };
83
-
84
- routes.forEach(route => visit(route, ''));
85
- };
86
-
87
- const getLocalisedRoutePaths = (
88
- canonicalPath: string,
89
- parentLocalisedPaths: Record<string, string>,
90
- languages: string[],
91
- entry: LocalisedUrlPathMap,
92
- ): string[] => {
93
- const paths = languages.map(language => {
94
- const fullPath = normalisePathPattern(entry[language]);
95
- const parentPath = normalisePathPattern(
96
- parentLocalisedPaths[language] || '/',
97
- );
98
- if (parentPath === '/') {
99
- return normaliseRoutePath(fullPath) || undefined;
100
- }
101
-
102
- const parentPrefix = `${parentPath}/`;
103
- if (!fullPath.startsWith(parentPrefix)) {
104
- throw new Error(
105
- `localisedUrls["${canonicalPath}"].${language} must be nested under "${parentPath}" because its parent route is localised there.`,
106
- );
107
- }
108
-
109
- return normaliseRoutePath(fullPath.slice(parentPath.length));
110
- });
111
-
112
- return Array.from(new Set(paths.filter(Boolean) as string[]));
113
- };
114
-
115
- const transformLocalisedRoute = (
116
- route: LocalisedRoute,
117
- parentCanonicalPath: string,
118
- parentLocalisedPaths: Record<string, string>,
119
- languages: string[],
120
- localisedUrls: LocalisedUrlsMap,
121
- ): LocalisedRoute[] => {
122
- const canonicalPath = joinPath(parentCanonicalPath, route.path);
123
- const localisedUrlEntry =
124
- isLocalisableRoutePath(route.path) &&
125
- !isFrameworkInternalRoutePath(canonicalPath)
126
- ? ensureLocalisedUrlsForPath(canonicalPath, languages, localisedUrls)
127
- : undefined;
128
- const routeLocalisedPaths = localisedUrlEntry
129
- ? languages.reduce<Record<string, string>>((acc, language) => {
130
- acc[language] = normalisePathPattern(localisedUrlEntry[language]);
131
- return acc;
132
- }, {})
133
- : parentLocalisedPaths;
134
-
135
- const children =
136
- 'children' in route && route.children
137
- ? route.children.flatMap(child =>
138
- transformLocalisedRoute(
139
- child,
140
- canonicalPath,
141
- routeLocalisedPaths,
142
- languages,
143
- localisedUrls,
144
- ),
145
- )
146
- : undefined;
147
-
148
- const baseRoute = {
149
- ...route,
150
- ...(children ? { children } : {}),
151
- } as LocalisedRoute;
152
-
153
- if (!localisedUrlEntry) {
154
- return [baseRoute];
155
- }
156
-
157
- return getLocalisedRoutePaths(
158
- canonicalPath,
159
- parentLocalisedPaths,
160
- languages,
161
- localisedUrlEntry,
162
- ).map((localisedPath, index) =>
163
- cloneRouteWithLocalisedPath(baseRoute, localisedPath, index, canonicalPath),
164
- );
165
- };
166
-
167
- const legalRouteIdPart = (value: string): string =>
168
- value.replace(/[^a-zA-Z0-9_$-]+/g, '_').replace(/^_+|_+$/g, '') || 'index';
169
-
170
- const suffixRouteIds = <T extends LocalisedRoute>(
171
- route: T,
172
- suffix: string,
173
- ): T => {
174
- const children =
175
- 'children' in route && route.children
176
- ? route.children.map(child => suffixRouteIds(child, suffix))
177
- : undefined;
178
-
179
- return {
180
- ...route,
181
- ...(route.id ? { id: `${route.id}__localised_${suffix}` } : {}),
182
- ...(children ? { children } : {}),
183
- };
184
- };
185
-
186
- const cloneRouteWithLocalisedPath = (
187
- route: LocalisedRoute,
188
- path: string,
189
- index: number,
190
- canonicalPath: string,
191
- ): LocalisedRoute => {
192
- const leadingLocaleParam = getLeadingLocaleParam(route.path);
193
- const localisedPath = leadingLocaleParam
194
- ? normaliseRoutePath(`${leadingLocaleParam}/${path}`)
195
- : path;
196
- const routeWithPath = {
197
- ...route,
198
- path: localisedPath,
199
- } as LocalisedRoute;
200
- // Language-agnostic source pattern; lets downstream codegen collapse the
201
- // localized physical variants back to one canonical route.
202
- (routeWithPath as { modernCanonicalPath?: string }).modernCanonicalPath =
203
- canonicalPath;
204
-
205
- return index === 0
206
- ? routeWithPath
207
- : suffixRouteIds(routeWithPath, legalRouteIdPart(localisedPath));
208
- };
209
-
210
- export const applyLocalisedUrlsToRoutes = (
211
- routes: LocalisedRoute[],
212
- languages: string[],
213
- localisedUrls: LocalisedUrlsMap,
214
- ): LocalisedRoute[] => {
215
- const rootLocalisedPaths = languages.reduce<Record<string, string>>(
216
- (acc, language) => {
217
- acc[language] = '/';
218
- return acc;
219
- },
220
- {},
221
- );
222
-
223
- validateLocalisedUrls(routes, languages, localisedUrls);
224
-
225
- return routes.flatMap(route =>
226
- transformLocalisedRoute(
227
- route,
228
- '',
229
- rootLocalisedPaths,
230
- languages,
231
- localisedUrls,
232
- ),
233
- );
234
- };
@@ -1,18 +0,0 @@
1
- export type LocalisedRoute = {
2
- type: 'nested' | 'page';
3
- path?: string;
4
- id?: string;
5
- children?: LocalisedRoute[];
6
- [key: string]: any;
7
- };
8
-
9
- export type LocalisedUrlPathMap = Record<string, string>;
10
-
11
- export type LocalisedUrlsMap = Record<string, LocalisedUrlPathMap>;
12
-
13
- export type LocalisedUrlsOption = boolean | LocalisedUrlsMap;
14
-
15
- export interface ResolvedLocalisedUrlsConfig {
16
- enabled: boolean;
17
- map: LocalisedUrlsMap;
18
- }
@@ -1,26 +0,0 @@
1
- export type {
2
- LocaleRedirectSkipRule,
3
- LocalisedRoute,
4
- LocalisedUrlPathMap,
5
- LocalisedUrlsMap,
6
- LocalisedUrlsOption,
7
- ResolvedLocalisedUrlsConfig,
8
- } from './localisedUrls/index';
9
- export {
10
- applyLocalisedUrlsToRoutes,
11
- buildPathFromPattern,
12
- canonicalTargetPathname,
13
- DEFAULT_LOCALE_REDIRECT_SKIP_RULES,
14
- isDefaultLocaleRedirectSkipPath,
15
- localiseTargetPathname,
16
- matchesPathPrefix,
17
- matchPathPattern,
18
- normalisePathname,
19
- normalisePathPattern,
20
- resolveCanonicalLocalisedPath,
21
- resolveLocalisedPath,
22
- resolveLocalisedUrlsConfig,
23
- shouldSkipLocaleRedirect,
24
- stripLanguagePrefix,
25
- validateLocalisedUrls,
26
- } from './localisedUrls/index';