@bleedingdev/modern-js-plugin-i18n 3.2.0-ultramodern.2 → 3.2.0-ultramodern.23

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 (85) 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 +4 -2
  8. package/dist/cjs/runtime/index.js +7 -6
  9. package/dist/cjs/runtime/routerAdapter.js +163 -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 +4 -2
  20. package/dist/esm/runtime/index.mjs +7 -6
  21. package/dist/esm/runtime/routerAdapter.mjs +129 -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 +4 -2
  32. package/dist/esm-node/runtime/index.mjs +7 -6
  33. package/dist/esm-node/runtime/routerAdapter.mjs +130 -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/cli/index.d.ts +21 -0
  38. package/dist/types/runtime/I18nLink.d.ts +23 -0
  39. package/dist/types/runtime/context.d.ts +41 -0
  40. package/dist/types/runtime/hooks.d.ts +30 -0
  41. package/dist/types/runtime/i18n/backend/config.d.ts +2 -0
  42. package/dist/types/runtime/i18n/backend/defaults.d.ts +13 -0
  43. package/dist/types/runtime/i18n/backend/defaults.node.d.ts +8 -0
  44. package/dist/types/runtime/i18n/backend/index.d.ts +3 -0
  45. package/dist/types/runtime/i18n/backend/middleware.common.d.ts +14 -0
  46. package/dist/types/runtime/i18n/backend/middleware.d.ts +12 -0
  47. package/dist/types/runtime/i18n/backend/middleware.node.d.ts +13 -0
  48. package/dist/types/runtime/i18n/backend/sdk-backend.d.ts +53 -0
  49. package/dist/types/runtime/i18n/backend/sdk-event.d.ts +9 -0
  50. package/dist/types/runtime/i18n/detection/config.d.ts +11 -0
  51. package/dist/types/runtime/i18n/detection/index.d.ts +50 -0
  52. package/dist/types/runtime/i18n/detection/middleware.d.ts +24 -0
  53. package/dist/types/runtime/i18n/detection/middleware.node.d.ts +17 -0
  54. package/dist/types/runtime/i18n/index.d.ts +3 -0
  55. package/dist/types/runtime/i18n/instance.d.ts +96 -0
  56. package/dist/types/runtime/i18n/utils.d.ts +29 -0
  57. package/dist/types/runtime/index.d.ts +21 -0
  58. package/dist/types/runtime/routerAdapter.d.ts +26 -0
  59. package/dist/types/runtime/types.d.ts +15 -0
  60. package/dist/types/runtime/utils.d.ts +28 -0
  61. package/dist/types/server/index.d.ts +14 -0
  62. package/dist/types/shared/deepMerge.d.ts +1 -0
  63. package/dist/types/shared/detection.d.ts +11 -0
  64. package/dist/types/shared/localisedUrls.d.ts +13 -0
  65. package/dist/types/shared/type.d.ts +168 -0
  66. package/dist/types/shared/utils.d.ts +5 -0
  67. package/package.json +15 -15
  68. package/rstest.config.mts +39 -0
  69. package/src/cli/index.ts +43 -1
  70. package/src/runtime/I18nLink.tsx +10 -16
  71. package/src/runtime/context.tsx +45 -7
  72. package/src/runtime/hooks.ts +13 -4
  73. package/src/runtime/i18n/backend/defaults.ts +3 -1
  74. package/src/runtime/i18n/backend/middleware.node.ts +1 -1
  75. package/src/runtime/i18n/instance.ts +14 -5
  76. package/src/runtime/index.tsx +10 -2
  77. package/src/runtime/routerAdapter.tsx +333 -0
  78. package/src/runtime/utils.ts +22 -34
  79. package/src/server/index.ts +135 -10
  80. package/src/shared/localisedUrls.ts +393 -0
  81. package/src/shared/type.ts +12 -0
  82. package/tests/localisedUrls.test.ts +278 -0
  83. package/tests/routerAdapter.test.tsx +278 -0
  84. package/dist/esm/rslib-runtime.mjs +0 -18
  85. package/dist/esm-node/rslib-runtime.mjs +0 -19
@@ -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 };
@@ -0,0 +1,21 @@
1
+ import type { AppTools, CliPlugin } from '@modern-js/app-tools';
2
+ import type { Entrypoint } from '@modern-js/types';
3
+ import type { BackendOptions, LocaleDetectionOptions } from '../shared/type';
4
+ export type TransformRuntimeConfigFn = (extendedConfig: Record<string, any>, entrypoint: Entrypoint) => Record<string, any>;
5
+ export interface I18nPluginOptions {
6
+ localeDetection?: LocaleDetectionOptions;
7
+ backend?: BackendOptions;
8
+ transformRuntimeConfig?: TransformRuntimeConfigFn;
9
+ customPlugin?: {
10
+ runtime?: {
11
+ name?: string;
12
+ path?: string;
13
+ };
14
+ server?: {
15
+ name?: string;
16
+ };
17
+ };
18
+ [key: string]: any;
19
+ }
20
+ export declare const i18nPlugin: (options?: I18nPluginOptions) => CliPlugin<AppTools>;
21
+ export default i18nPlugin;
@@ -0,0 +1,23 @@
1
+ import type React from 'react';
2
+ export interface I18nLinkProps {
3
+ to: string;
4
+ children: React.ReactNode;
5
+ [key: string]: any;
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
+ */
22
+ export declare const I18nLink: React.FC<I18nLinkProps>;
23
+ export default I18nLink;
@@ -0,0 +1,41 @@
1
+ import type { FC, ReactNode } from 'react';
2
+ import type { LocalisedUrlsOption } from '../shared/localisedUrls';
3
+ import type { I18nInstance } from './i18n';
4
+ export interface ModernI18nContextValue {
5
+ language: string;
6
+ i18nInstance: I18nInstance;
7
+ entryName?: string;
8
+ languages?: string[];
9
+ localePathRedirect?: boolean;
10
+ ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean);
11
+ localisedUrls?: LocalisedUrlsOption;
12
+ updateLanguage?: (newLang: string) => void;
13
+ }
14
+ export interface ModernI18nProviderProps {
15
+ children: ReactNode;
16
+ value: ModernI18nContextValue;
17
+ }
18
+ export declare const ModernI18nProvider: FC<ModernI18nProviderProps>;
19
+ export interface UseModernI18nReturn {
20
+ language: string;
21
+ changeLanguage: (newLang: string) => Promise<void>;
22
+ i18nInstance: I18nInstance;
23
+ supportedLanguages: string[];
24
+ localisedUrls?: LocalisedUrlsOption;
25
+ isLanguageSupported: (lang: string) => boolean;
26
+ isResourcesReady: boolean;
27
+ }
28
+ /**
29
+ * Hook for accessing i18n functionality in Modern.js applications.
30
+ *
31
+ * This hook provides:
32
+ * - Current language from URL params or i18n context
33
+ * - changeLanguage function that updates both i18n instance and URL
34
+ * - Direct access to the i18n instance
35
+ * - List of supported languages
36
+ * - Helper function to check if a language is supported
37
+ *
38
+ * @param options - Optional configuration to override context settings
39
+ * @returns Object containing i18n functionality and utilities
40
+ */
41
+ export declare const useModernI18n: () => UseModernI18nReturn;
@@ -0,0 +1,30 @@
1
+ import type { TRuntimeContext } from '@modern-js/runtime';
2
+ import type React from 'react';
3
+ import type { LocalisedUrlsOption } from '../shared/localisedUrls';
4
+ import type { I18nInstance } from './i18n';
5
+ interface RuntimeContextWithI18n extends TRuntimeContext {
6
+ i18nInstance?: I18nInstance;
7
+ }
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): {
9
+ language: string;
10
+ i18nInstance: I18nInstance;
11
+ entryName: string | undefined;
12
+ languages: string[];
13
+ localePathRedirect: boolean;
14
+ ignoreRedirectRoutes: string[] | ((pathname: string) => boolean) | undefined;
15
+ localisedUrls: LocalisedUrlsOption | undefined;
16
+ updateLanguage: (lang: string) => void;
17
+ };
18
+ export declare function useSdkResourcesLoader(i18nInstance: I18nInstance | undefined, setForceUpdate: React.Dispatch<React.SetStateAction<number>>): void;
19
+ /**
20
+ * Hook to handle client-side redirect for locale path redirect in static deployments
21
+ * This ensures that when users access paths without language prefix, they are redirected
22
+ * to the localized version of the path
23
+ *
24
+ * Note: This hook only runs in CSR (Client-Side Rendering) scenarios.
25
+ * In SSR/SSG scenarios, server-side middleware handles redirects, so this hook is skipped.
26
+ * We use process.env.MODERN_TARGET to ensure this code is only included in browser bundles.
27
+ */
28
+ export declare function useClientSideRedirect(i18nInstance: I18nInstance | undefined, localePathRedirect: boolean, languages: string[], fallbackLanguage: string, ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean), localisedUrls?: LocalisedUrlsOption): void;
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;
30
+ export {};
@@ -0,0 +1,2 @@
1
+ import type { BackendOptions } from '../instance';
2
+ export declare function mergeBackendOptions(defaultOptions: BackendOptions, cliOptions?: BackendOptions, userOptions?: BackendOptions): BackendOptions;
@@ -0,0 +1,13 @@
1
+ export declare const DEFAULT_I18NEXT_BACKEND_OPTIONS: {
2
+ loadPath: string;
3
+ addPath: string;
4
+ };
5
+ declare global {
6
+ interface Window {
7
+ __assetPrefix__?: string;
8
+ }
9
+ }
10
+ export declare function convertBackendOptions<T extends {
11
+ loadPath?: string;
12
+ addPath?: string;
13
+ }>(options: T): T;
@@ -0,0 +1,8 @@
1
+ export declare const DEFAULT_I18NEXT_BACKEND_OPTIONS: {
2
+ loadPath: string;
3
+ addPath: string;
4
+ };
5
+ export declare function convertBackendOptions<T extends {
6
+ loadPath?: string;
7
+ addPath?: string;
8
+ }>(options: T): T;
@@ -0,0 +1,3 @@
1
+ import type { BaseBackendOptions } from '../../../shared/type';
2
+ import type { BackendOptions, I18nInitOptions } from '../instance';
3
+ export declare const mergeBackendOptions: (backend?: BaseBackendOptions, userInitOptions?: I18nInitOptions) => BackendOptions | undefined;
@@ -0,0 +1,14 @@
1
+ import type { BaseBackendOptions, ChainedBackendConfig } from '../../../shared/type';
2
+ import type { I18nInstance } from '../instance';
3
+ type BackendConfigWithChained = BaseBackendOptions & Partial<ChainedBackendConfig>;
4
+ /**
5
+ * Common logic for using i18next backend
6
+ * This function handles the backend selection and chained backend configuration
7
+ *
8
+ * @param i18nInstance - The i18n instance to configure
9
+ * @param BackendWithSave - The wrapped backend class with save method (required for chained backend refresh logic)
10
+ * @param BackendBase - The base backend class (for non-chained use)
11
+ * @param backend - Optional backend configuration
12
+ */
13
+ export declare function useI18nextBackendCommon(i18nInstance: I18nInstance, BackendWithSave: new (...args: any[]) => any, BackendBase: new (...args: any[]) => any, backend?: BackendConfigWithChained): void;
14
+ export {};
@@ -0,0 +1,12 @@
1
+ import Backend from 'i18next-http-backend';
2
+ import type { ExtendedBackendOptions } from '../../../shared/type';
3
+ import type { I18nInstance } from '../instance';
4
+ /**
5
+ * Wrapper for HTTP backend to add a no-op save method
6
+ * This is required for i18next-chained-backend to trigger refresh logic
7
+ * when cacheHitMode is 'refresh' or 'refreshAndUpdateStore'
8
+ */
9
+ export declare class HttpBackendWithSave extends Backend {
10
+ save(_language: string, _namespace: string, _data: unknown): void;
11
+ }
12
+ export declare const useI18nextBackend: (i18nInstance: I18nInstance, backend?: ExtendedBackendOptions) => void;
@@ -0,0 +1,13 @@
1
+ import Backend from 'i18next-fs-backend/cjs';
2
+ import type { ExtendedBackendOptions } from '../../../shared/type';
3
+ import type { I18nInstance } from '../instance';
4
+ /**
5
+ * Wrapper for FS backend to add a no-op save method
6
+ * This is required for i18next-chained-backend to trigger refresh logic
7
+ * when cacheHitMode is 'refresh' or 'refreshAndUpdateStore'
8
+ */
9
+ export declare class FsBackendWithSave extends Backend {
10
+ save(_language: string, _namespace: string, _data: unknown): void;
11
+ }
12
+ export declare const HttpBackendWithSave: typeof FsBackendWithSave;
13
+ export declare const useI18nextBackend: (i18nInstance: I18nInstance, backend?: ExtendedBackendOptions) => void;
@@ -0,0 +1,53 @@
1
+ import type { I18nSdkLoader } from '../../../shared/type';
2
+ interface BackendOptions {
3
+ sdk?: I18nSdkLoader;
4
+ [key: string]: unknown;
5
+ }
6
+ interface I18nextServices {
7
+ resourceStore?: {
8
+ data?: {
9
+ [language: string]: {
10
+ [namespace: string]: Record<string, string>;
11
+ };
12
+ };
13
+ };
14
+ store?: {
15
+ data?: {
16
+ [language: string]: {
17
+ [namespace: string]: Record<string, string>;
18
+ };
19
+ };
20
+ };
21
+ [key: string]: any;
22
+ }
23
+ export declare class SdkBackend {
24
+ static type: string;
25
+ type: 'backend';
26
+ sdk?: I18nSdkLoader;
27
+ private allResourcesCache;
28
+ private backendId;
29
+ private loadingPromises;
30
+ private services?;
31
+ constructor(_services: unknown, _options: Record<string, unknown>);
32
+ init(services: I18nextServices, backendOptions: BackendOptions, _i18nextOptions: unknown): void;
33
+ read(language: string, namespace: string, callback: (error: Error | null, data: unknown) => void): void;
34
+ create(_languages: string[], _namespace: string, _key: string, _fallbackValue: string): void;
35
+ isLoading(language: string, namespace: string): boolean;
36
+ getLoadingResources(): Array<{
37
+ language: string;
38
+ namespace: string;
39
+ }>;
40
+ hasLoadingResources(): boolean;
41
+ private getCacheKey;
42
+ private loadResource;
43
+ private handlePromise;
44
+ private normalizeError;
45
+ private callSdk;
46
+ private extractFromCache;
47
+ private updateCache;
48
+ private formatResources;
49
+ private isObject;
50
+ private mergeWithExistingResources;
51
+ private triggerI18nextUpdate;
52
+ }
53
+ export {};
@@ -0,0 +1,9 @@
1
+ export declare const I18N_SDK_RESOURCES_LOADED_EVENT = "i18n-sdk-resources-loaded";
2
+ export interface I18nSdkResourcesLoadedEventDetail {
3
+ language: string;
4
+ namespace: string;
5
+ backendId?: string;
6
+ }
7
+ export declare function createI18nSdkBackendId(): string;
8
+ export declare function setI18nSdkBackendId(target: unknown, backendId: string): void;
9
+ export declare function getI18nSdkBackendId(target: unknown): string | undefined;
@@ -0,0 +1,11 @@
1
+ import type { LanguageDetectorOptions } from '../instance';
2
+ export declare const DEFAULT_I18NEXT_DETECTION_OPTIONS: {
3
+ caches: string[];
4
+ order: string[];
5
+ cookieMinutes: number;
6
+ lookupQuerystring: string;
7
+ lookupCookie: string;
8
+ lookupLocalStorage: string;
9
+ lookupHeader: string;
10
+ };
11
+ export declare function mergeDetectionOptions(cliOptions?: LanguageDetectorOptions, userOptions?: LanguageDetectorOptions, defaultOptions?: LanguageDetectorOptions): LanguageDetectorOptions;
@@ -0,0 +1,50 @@
1
+ import { type TRuntimeContext } from '@modern-js/runtime';
2
+ import type { I18nInitOptions, I18nInstance, LanguageDetectorOptions } from '../instance';
3
+ import { cacheUserLanguage } from './middleware';
4
+ export { cacheUserLanguage };
5
+ export declare function exportServerLngToWindow(context: TRuntimeContext, lng: string): void;
6
+ export declare const getLanguageFromSSRData: (window: Window) => string | undefined;
7
+ export interface BaseLanguageDetectionOptions {
8
+ languages: string[];
9
+ fallbackLanguage: string;
10
+ localePathRedirect: boolean;
11
+ i18nextDetector: boolean;
12
+ detection?: LanguageDetectorOptions;
13
+ userInitOptions?: I18nInitOptions;
14
+ mergedBackend?: any;
15
+ }
16
+ export interface LanguageDetectionOptions extends BaseLanguageDetectionOptions {
17
+ pathname: string;
18
+ ssrContext?: any;
19
+ }
20
+ export interface LanguageDetectionResult {
21
+ detectedLanguage?: string;
22
+ finalLanguage: string;
23
+ }
24
+ /**
25
+ * Detect language with priority:
26
+ * Priority 1: SSR data (try window._SSR_DATA first, works for both SSR and CSR)
27
+ * Priority 2: Path detection
28
+ * Priority 3: i18next detector (reads from cookie/localStorage)
29
+ * Priority 4: User config language or fallback
30
+ */
31
+ export declare const detectLanguageWithPriority: (i18nInstance: I18nInstance, options: LanguageDetectionOptions) => Promise<LanguageDetectionResult>;
32
+ /**
33
+ * Options for building i18n init options
34
+ */
35
+ export interface BuildInitOptionsParams {
36
+ finalLanguage: string;
37
+ fallbackLanguage: string;
38
+ languages: string[];
39
+ userInitOptions?: I18nInitOptions;
40
+ mergedDetection?: any;
41
+ mergeBackend?: any;
42
+ }
43
+ /**
44
+ * Build i18n initialization options
45
+ */
46
+ export declare const buildInitOptions: (params: BuildInitOptionsParams) => I18nInitOptions;
47
+ /**
48
+ * Merge detection and backend options
49
+ */
50
+ export declare const mergeDetectionOptions: (i18nextDetector: boolean, detection?: LanguageDetectorOptions, localePathRedirect?: boolean, userInitOptions?: I18nInitOptions) => LanguageDetectorOptions;
@@ -0,0 +1,24 @@
1
+ import type { I18nInstance } from '../instance';
2
+ /**
3
+ * Register LanguageDetector plugin to i18n instance
4
+ * Must be called before init() to properly register the detector
5
+ * For wrapper instances, ensure detector is registered on the underlying i18next instance
6
+ */
7
+ export declare const useI18nextLanguageDetector: (i18nInstance: I18nInstance) => void | I18nInstance;
8
+ /**
9
+ * Read language directly from localStorage/cookie
10
+ * Fallback when detector is not available in services
11
+ */
12
+ export declare const readLanguageFromStorage: (detectionOptions?: any) => string | undefined;
13
+ /**
14
+ * Detect language using i18next-browser-languagedetector
15
+ * For initialized instances without detector in services, manually create a detector instance
16
+ * For wrapper instances, access the underlying i18next instance's services
17
+ */
18
+ export declare const detectLanguage: (i18nInstance: I18nInstance, _request?: any, detectionOptions?: any) => string | undefined;
19
+ /**
20
+ * Cache user language to localStorage/cookie
21
+ * Uses LanguageDetector's cacheUserLanguage method when available
22
+ * For wrapper instances, access the underlying i18next instance's services
23
+ */
24
+ export declare const cacheUserLanguage: (i18nInstance: I18nInstance, language: string, detectionOptions?: any) => void;
@@ -0,0 +1,17 @@
1
+ import type { I18nInstance } from '../instance';
2
+ export declare const cacheUserLanguage: (_i18nInstance: I18nInstance, _language: string, _detectionOptions?: any) => void;
3
+ /**
4
+ * Read language directly from storage (localStorage/cookie)
5
+ * Not available in Node.js environment, returns undefined
6
+ */
7
+ export declare const readLanguageFromStorage: (_detectionOptions?: any) => string | undefined;
8
+ /**
9
+ * Register LanguageDetector plugin to i18n instance
10
+ * Must be called before init() to properly register the detector
11
+ */
12
+ export declare const useI18nextLanguageDetector: (i18nInstance: I18nInstance) => void | I18nInstance;
13
+ /**
14
+ * Detect language using i18next-http-middleware LanguageDetector
15
+ * For initialized instances without detector in services, manually create a detector instance
16
+ */
17
+ export declare const detectLanguage: (i18nInstance: I18nInstance, request?: any, detectionOptions?: any) => string | undefined;
@@ -0,0 +1,3 @@
1
+ export type { I18nInitOptions, I18nInstance, } from './instance';
2
+ export { getI18nInstance, isI18nInstance } from './instance';
3
+ export { assertI18nInstance } from './utils';
@@ -0,0 +1,96 @@
1
+ import type { BaseBackendOptions } from '../../shared/type';
2
+ type ReactI18nextModule = typeof import('react-i18next');
3
+ type InitReactI18next = ReactI18nextModule['initReactI18next'];
4
+ type I18nextProviderComponent = ReactI18nextModule['I18nextProvider'];
5
+ export interface I18nResourceStore {
6
+ data?: {
7
+ [language: string]: {
8
+ [namespace: string]: string | {
9
+ [key: string]: any;
10
+ };
11
+ };
12
+ };
13
+ addResourceBundle?: (language: string, namespace: string, resources: Record<string, string>, deep?: boolean, overwrite?: boolean) => void;
14
+ }
15
+ export declare function isI18nWrapperInstance(obj: any): boolean;
16
+ export declare function getI18nWrapperI18nextInstance(wrapperInstance: any): any;
17
+ export declare function getActualI18nextInstance(instance: I18nInstance | any): any;
18
+ export interface I18nInstance {
19
+ language: string;
20
+ isInitialized?: boolean;
21
+ init: {
22
+ (callback?: (error: any, t: any) => void): Promise<any>;
23
+ (options: I18nInitOptions, callback?: (error: any, t: any) => void): Promise<any>;
24
+ };
25
+ changeLanguage?: (lng?: string, callback?: (error: any, t: any) => void) => Promise<any>;
26
+ setLang?: (lang: string) => void | Promise<void>;
27
+ use: (plugin: any) => void;
28
+ createInstance?: (options?: I18nInitOptions) => I18nInstance;
29
+ cloneInstance?: () => I18nInstance;
30
+ store?: I18nResourceStore;
31
+ emit?: (event: string, ...args: any[]) => void;
32
+ reloadResources?: (language?: string, namespace?: string) => Promise<void>;
33
+ services?: {
34
+ languageDetector?: {
35
+ detect: (request?: any, options?: any) => string | string[] | undefined;
36
+ [key: string]: any;
37
+ };
38
+ resourceStore?: I18nResourceStore;
39
+ backend?: any;
40
+ [key: string]: any;
41
+ };
42
+ options?: {
43
+ backend?: BackendOptions;
44
+ [key: string]: any;
45
+ };
46
+ [key: string]: any;
47
+ }
48
+ type LanguageDetectorOrder = string[];
49
+ type LanguageDetectorCaches = boolean | string[];
50
+ export interface LanguageDetectorOptions {
51
+ order?: LanguageDetectorOrder;
52
+ lookupQuerystring?: string;
53
+ lookupCookie?: string;
54
+ lookupLocalStorage?: string;
55
+ lookupSession?: string;
56
+ lookupFromPathIndex?: number;
57
+ caches?: LanguageDetectorCaches;
58
+ cookieExpirationDate?: Date;
59
+ cookieDomain?: string;
60
+ lookupHeader?: string;
61
+ }
62
+ export interface BackendOptions extends Omit<BaseBackendOptions, 'enabled'> {
63
+ parse?: (data: string) => any;
64
+ stringify?: (data: any) => string;
65
+ [key: string]: any;
66
+ }
67
+ export interface Resources {
68
+ [lng: string]: {
69
+ [source: string]: string | Record<string, string>;
70
+ };
71
+ }
72
+ export type I18nInitOptions = {
73
+ lng?: string;
74
+ fallbackLng?: string;
75
+ supportedLngs?: string[];
76
+ initImmediate?: boolean;
77
+ detection?: LanguageDetectorOptions;
78
+ backend?: BackendOptions;
79
+ resources?: Resources;
80
+ ns?: string | string[];
81
+ defaultNS?: string | string[];
82
+ interpolation?: {
83
+ escapeValue?: boolean;
84
+ [key: string]: any;
85
+ };
86
+ react?: {
87
+ useSuspense?: boolean;
88
+ [key: string]: any;
89
+ };
90
+ };
91
+ export declare function isI18nInstance(obj: any): obj is I18nInstance;
92
+ export declare function getI18nextInstanceForProvider(instance: I18nInstance | any): any;
93
+ export declare function getI18nInstance(userInstance?: I18nInstance | any): Promise<I18nInstance>;
94
+ export declare function getInitReactI18next(): Promise<InitReactI18next | null>;
95
+ export declare function getI18nextProvider(): Promise<I18nextProviderComponent | null>;
96
+ export {};