@bleedingdev/modern-js-plugin-i18n 3.2.0-ultramodern.5 → 3.2.0-ultramodern.51

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 (90) 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 +0 -24
  8. package/dist/cjs/runtime/i18n/react-i18next.js +52 -0
  9. package/dist/cjs/runtime/index.js +13 -7
  10. package/dist/cjs/runtime/routerAdapter.js +163 -0
  11. package/dist/cjs/runtime/utils.js +63 -94
  12. package/dist/cjs/server/index.js +60 -8
  13. package/dist/cjs/shared/localisedUrls.js +237 -0
  14. package/dist/esm/cli/index.mjs +22 -0
  15. package/dist/esm/runtime/I18nLink.mjs +4 -12
  16. package/dist/esm/runtime/context.mjs +34 -7
  17. package/dist/esm/runtime/hooks.mjs +9 -6
  18. package/dist/esm/runtime/i18n/backend/defaults.mjs +1 -1
  19. package/dist/esm/runtime/i18n/backend/middleware.node.mjs +3 -3
  20. package/dist/esm/runtime/i18n/instance.mjs +1 -19
  21. package/dist/esm/runtime/i18n/react-i18next.mjs +18 -0
  22. package/dist/esm/runtime/index.mjs +14 -8
  23. package/dist/esm/runtime/routerAdapter.mjs +129 -0
  24. package/dist/esm/runtime/utils.mjs +11 -30
  25. package/dist/esm/server/index.mjs +53 -7
  26. package/dist/esm/shared/localisedUrls.mjs +191 -0
  27. package/dist/esm-node/cli/index.mjs +22 -0
  28. package/dist/esm-node/runtime/I18nLink.mjs +4 -12
  29. package/dist/esm-node/runtime/context.mjs +34 -7
  30. package/dist/esm-node/runtime/hooks.mjs +9 -6
  31. package/dist/esm-node/runtime/i18n/backend/defaults.mjs +1 -1
  32. package/dist/esm-node/runtime/i18n/backend/middleware.node.mjs +3 -3
  33. package/dist/esm-node/runtime/i18n/instance.mjs +1 -19
  34. package/dist/esm-node/runtime/i18n/react-i18next.mjs +19 -0
  35. package/dist/esm-node/runtime/index.mjs +14 -8
  36. package/dist/esm-node/runtime/routerAdapter.mjs +130 -0
  37. package/dist/esm-node/runtime/utils.mjs +11 -30
  38. package/dist/esm-node/server/index.mjs +53 -7
  39. package/dist/esm-node/shared/localisedUrls.mjs +192 -0
  40. package/dist/types/cli/index.d.ts +21 -0
  41. package/dist/types/runtime/I18nLink.d.ts +23 -0
  42. package/dist/types/runtime/context.d.ts +41 -0
  43. package/dist/types/runtime/hooks.d.ts +30 -0
  44. package/dist/types/runtime/i18n/backend/config.d.ts +2 -0
  45. package/dist/types/runtime/i18n/backend/defaults.d.ts +13 -0
  46. package/dist/types/runtime/i18n/backend/defaults.node.d.ts +8 -0
  47. package/dist/types/runtime/i18n/backend/index.d.ts +3 -0
  48. package/dist/types/runtime/i18n/backend/middleware.common.d.ts +14 -0
  49. package/dist/types/runtime/i18n/backend/middleware.d.ts +12 -0
  50. package/dist/types/runtime/i18n/backend/middleware.node.d.ts +13 -0
  51. package/dist/types/runtime/i18n/backend/sdk-backend.d.ts +53 -0
  52. package/dist/types/runtime/i18n/backend/sdk-event.d.ts +9 -0
  53. package/dist/types/runtime/i18n/detection/config.d.ts +11 -0
  54. package/dist/types/runtime/i18n/detection/index.d.ts +50 -0
  55. package/dist/types/runtime/i18n/detection/middleware.d.ts +24 -0
  56. package/dist/types/runtime/i18n/detection/middleware.node.d.ts +17 -0
  57. package/dist/types/runtime/i18n/index.d.ts +3 -0
  58. package/dist/types/runtime/i18n/instance.d.ts +91 -0
  59. package/dist/types/runtime/i18n/react-i18next.d.ts +7 -0
  60. package/dist/types/runtime/i18n/utils.d.ts +29 -0
  61. package/dist/types/runtime/index.d.ts +21 -0
  62. package/dist/types/runtime/routerAdapter.d.ts +26 -0
  63. package/dist/types/runtime/types.d.ts +15 -0
  64. package/dist/types/runtime/utils.d.ts +28 -0
  65. package/dist/types/server/index.d.ts +14 -0
  66. package/dist/types/shared/deepMerge.d.ts +1 -0
  67. package/dist/types/shared/detection.d.ts +11 -0
  68. package/dist/types/shared/localisedUrls.d.ts +13 -0
  69. package/dist/types/shared/type.d.ts +168 -0
  70. package/dist/types/shared/utils.d.ts +5 -0
  71. package/package.json +15 -15
  72. package/rstest.config.mts +39 -0
  73. package/src/cli/index.ts +43 -1
  74. package/src/runtime/I18nLink.tsx +10 -16
  75. package/src/runtime/context.tsx +45 -7
  76. package/src/runtime/hooks.ts +13 -4
  77. package/src/runtime/i18n/backend/defaults.ts +3 -1
  78. package/src/runtime/i18n/backend/middleware.node.ts +1 -1
  79. package/src/runtime/i18n/instance.ts +0 -25
  80. package/src/runtime/i18n/react-i18next.ts +31 -0
  81. package/src/runtime/index.tsx +21 -9
  82. package/src/runtime/routerAdapter.tsx +333 -0
  83. package/src/runtime/utils.ts +22 -34
  84. package/src/server/index.ts +117 -10
  85. package/src/shared/localisedUrls.ts +393 -0
  86. package/src/shared/type.ts +12 -0
  87. package/tests/localisedUrls.test.ts +312 -0
  88. package/tests/routerAdapter.test.tsx +278 -0
  89. package/dist/esm/rslib-runtime.mjs +0 -18
  90. package/dist/esm-node/rslib-runtime.mjs +0 -19
@@ -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,91 @@
1
+ import type { BaseBackendOptions } from '../../shared/type';
2
+ export interface I18nResourceStore {
3
+ data?: {
4
+ [language: string]: {
5
+ [namespace: string]: string | {
6
+ [key: string]: any;
7
+ };
8
+ };
9
+ };
10
+ addResourceBundle?: (language: string, namespace: string, resources: Record<string, string>, deep?: boolean, overwrite?: boolean) => void;
11
+ }
12
+ export declare function isI18nWrapperInstance(obj: any): boolean;
13
+ export declare function getI18nWrapperI18nextInstance(wrapperInstance: any): any;
14
+ export declare function getActualI18nextInstance(instance: I18nInstance | any): any;
15
+ export interface I18nInstance {
16
+ language: string;
17
+ isInitialized?: boolean;
18
+ init: {
19
+ (callback?: (error: any, t: any) => void): Promise<any>;
20
+ (options: I18nInitOptions, callback?: (error: any, t: any) => void): Promise<any>;
21
+ };
22
+ changeLanguage?: (lng?: string, callback?: (error: any, t: any) => void) => Promise<any>;
23
+ setLang?: (lang: string) => void | Promise<void>;
24
+ use: (plugin: any) => void;
25
+ createInstance?: (options?: I18nInitOptions) => I18nInstance;
26
+ cloneInstance?: () => I18nInstance;
27
+ store?: I18nResourceStore;
28
+ emit?: (event: string, ...args: any[]) => void;
29
+ reloadResources?: (language?: string, namespace?: string) => Promise<void>;
30
+ services?: {
31
+ languageDetector?: {
32
+ detect: (request?: any, options?: any) => string | string[] | undefined;
33
+ [key: string]: any;
34
+ };
35
+ resourceStore?: I18nResourceStore;
36
+ backend?: any;
37
+ [key: string]: any;
38
+ };
39
+ options?: {
40
+ backend?: BackendOptions;
41
+ [key: string]: any;
42
+ };
43
+ [key: string]: any;
44
+ }
45
+ type LanguageDetectorOrder = string[];
46
+ type LanguageDetectorCaches = boolean | string[];
47
+ export interface LanguageDetectorOptions {
48
+ order?: LanguageDetectorOrder;
49
+ lookupQuerystring?: string;
50
+ lookupCookie?: string;
51
+ lookupLocalStorage?: string;
52
+ lookupSession?: string;
53
+ lookupFromPathIndex?: number;
54
+ caches?: LanguageDetectorCaches;
55
+ cookieExpirationDate?: Date;
56
+ cookieDomain?: string;
57
+ lookupHeader?: string;
58
+ }
59
+ export interface BackendOptions extends Omit<BaseBackendOptions, 'enabled'> {
60
+ parse?: (data: string) => any;
61
+ stringify?: (data: any) => string;
62
+ [key: string]: any;
63
+ }
64
+ export interface Resources {
65
+ [lng: string]: {
66
+ [source: string]: string | Record<string, string>;
67
+ };
68
+ }
69
+ export type I18nInitOptions = {
70
+ lng?: string;
71
+ fallbackLng?: string;
72
+ supportedLngs?: string[];
73
+ initImmediate?: boolean;
74
+ detection?: LanguageDetectorOptions;
75
+ backend?: BackendOptions;
76
+ resources?: Resources;
77
+ ns?: string | string[];
78
+ defaultNS?: string | string[];
79
+ interpolation?: {
80
+ escapeValue?: boolean;
81
+ [key: string]: any;
82
+ };
83
+ react?: {
84
+ useSuspense?: boolean;
85
+ [key: string]: any;
86
+ };
87
+ };
88
+ export declare function isI18nInstance(obj: any): obj is I18nInstance;
89
+ export declare function getI18nextInstanceForProvider(instance: I18nInstance | any): any;
90
+ export declare function getI18nInstance(userInstance?: I18nInstance | any): Promise<I18nInstance>;
91
+ export {};
@@ -0,0 +1,7 @@
1
+ import type React from 'react';
2
+ interface ReactI18nextIntegration {
3
+ I18nextProvider: React.ComponentType<any> | null;
4
+ initReactI18next: any | null;
5
+ }
6
+ export declare function getReactI18nextIntegration(): Promise<ReactI18nextIntegration>;
7
+ export {};
@@ -0,0 +1,29 @@
1
+ import type { BaseBackendOptions } from '../../shared/type';
2
+ import type { I18nInitOptions, I18nInstance } from './instance';
3
+ export declare function assertI18nInstance(obj: any): asserts obj is I18nInstance;
4
+ /**
5
+ * Build initialization options for i18n instance
6
+ */
7
+ export declare const buildInitOptions: (finalLanguage: string, fallbackLanguage: string, languages: string[], mergedDetection: any, mergedBackend: any, userInitOptions?: I18nInitOptions, useSuspense?: boolean, i18nInstance?: I18nInstance) => Promise<I18nInitOptions>;
8
+ /**
9
+ * Ensure i18n instance language matches the final detected language
10
+ */
11
+ export declare const ensureLanguageMatch: (i18nInstance: I18nInstance, finalLanguage: string) => Promise<void>;
12
+ /**
13
+ * Change language for i18n instance in onBeforeRender hook
14
+ * This function can be used by other runtime plugins to change language
15
+ * @param i18nInstance - The i18n instance
16
+ * @param newLang - The new language code to switch to
17
+ * @param options - Optional configuration
18
+ */
19
+ export declare const changeI18nLanguage: (i18nInstance: I18nInstance, newLang: string, options?: {
20
+ detectionOptions?: any;
21
+ }) => Promise<void>;
22
+ /**
23
+ * Initialize i18n instance if not already initialized
24
+ */
25
+ export declare const initializeI18nInstance: (i18nInstance: I18nInstance, finalLanguage: string, fallbackLanguage: string, languages: string[], mergedDetection: any, mergedBackend: any, userInitOptions?: I18nInitOptions, useSuspense?: boolean) => Promise<void>;
26
+ /**
27
+ * Setup cloned instance for SSR with backend support
28
+ */
29
+ export declare const setupClonedInstance: (i18nInstance: I18nInstance, finalLanguage: string, fallbackLanguage: string, languages: string[], backendEnabled: boolean, backend: BaseBackendOptions | undefined, i18nextDetector: boolean, detection: any, localePathRedirect: boolean, userInitOptions: I18nInitOptions | undefined) => Promise<void>;
@@ -0,0 +1,21 @@
1
+ import { type RuntimePlugin } from '@modern-js/runtime';
2
+ import type { BaseBackendOptions, BaseLocaleDetectionOptions } from '../shared/type';
3
+ import type { I18nInitOptions, I18nInstance } from './i18n';
4
+ import './types';
5
+ export type { I18nSdkLoader, I18nSdkLoadOptions } from '../shared/type';
6
+ export type { Resources } from './i18n/instance';
7
+ export interface I18nPluginOptions {
8
+ entryName?: string;
9
+ localeDetection?: BaseLocaleDetectionOptions;
10
+ backend?: BaseBackendOptions;
11
+ i18nInstance?: I18nInstance;
12
+ changeLanguage?: (lang: string) => void;
13
+ initOptions?: I18nInitOptions;
14
+ htmlLangAttr?: boolean;
15
+ reactI18next?: boolean;
16
+ [key: string]: any;
17
+ }
18
+ export declare const i18nPlugin: (options: I18nPluginOptions) => RuntimePlugin;
19
+ export { useModernI18n } from './context';
20
+ export { I18nLink } from './I18nLink';
21
+ export default i18nPlugin;
@@ -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;
@@ -0,0 +1,15 @@
1
+ import type { I18nInitOptions, I18nInstance } from './i18n';
2
+ declare module '@modern-js/runtime' {
3
+ interface RuntimeConfig {
4
+ i18n?: {
5
+ i18nInstance?: I18nInstance;
6
+ changeLanguage?: (lang: string) => void;
7
+ setLang?: (lang: string) => void;
8
+ initOptions?: I18nInitOptions;
9
+ };
10
+ }
11
+ interface TInternalRuntimeContext {
12
+ i18nInstance?: I18nInstance;
13
+ changeLanguage?: (lang: string) => Promise<void>;
14
+ }
15
+ }
@@ -0,0 +1,28 @@
1
+ import { type TInternalRuntimeContext } from '@modern-js/runtime/context';
2
+ import type { LocalisedUrlsMap } from '../shared/localisedUrls';
3
+ export declare const getPathname: (context: TInternalRuntimeContext) => string;
4
+ export declare const getEntryPath: () => string;
5
+ /**
6
+ * Helper function to get language from current pathname
7
+ * @param pathname - The current pathname
8
+ * @param languages - Array of supported languages
9
+ * @param fallbackLanguage - Fallback language when no language is detected
10
+ * @returns The detected language or fallback language
11
+ */
12
+ export declare const getLanguageFromPath: (pathname: string, languages: string[], fallbackLanguage: string) => string;
13
+ /**
14
+ * Helper function to build localized URL
15
+ * @param pathname - The current pathname
16
+ * @param language - The target language
17
+ * @param languages - Array of supported languages
18
+ * @returns The localized URL path
19
+ */
20
+ export declare const buildLocalizedUrl: (pathname: string, language: string, languages: string[], localisedUrls?: boolean | LocalisedUrlsMap) => string;
21
+ export declare const detectLanguageFromPath: (pathname: string, languages: string[], localePathRedirect: boolean) => {
22
+ detected: boolean;
23
+ language?: string;
24
+ };
25
+ /**
26
+ * Check if the given pathname should ignore automatic locale redirect
27
+ */
28
+ export declare const shouldIgnoreRedirect: (pathname: string, languages: string[], ignoreRedirectRoutes?: string[] | ((pathname: string) => boolean)) => boolean;
@@ -0,0 +1,14 @@
1
+ import type { ServerPlugin } from '@modern-js/server-runtime';
2
+ import type { LocaleDetectionOptions } from '../shared/type';
3
+ export interface I18nPluginOptions {
4
+ localeDetection: LocaleDetectionOptions;
5
+ staticRoutePrefixes: string[];
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;
13
+ export declare const i18nServerPlugin: (options: I18nPluginOptions) => ServerPlugin;
14
+ export default i18nServerPlugin;
@@ -0,0 +1 @@
1
+ export declare function deepMerge<T extends Record<string, any>>(defaultOptions: T, userOptions?: Partial<T>): T;
@@ -0,0 +1,11 @@
1
+ import type { LanguageDetectorOptions } from '../runtime/i18n/instance';
2
+ /**
3
+ * Detect language from request using the same detection logic as i18next
4
+ * This ensures consistency between server-side and client-side detection
5
+ */
6
+ export declare function detectLanguageFromRequest(req: {
7
+ url: string;
8
+ headers: {
9
+ get: (name: string) => string | null;
10
+ } | Headers;
11
+ }, languages: string[], detectionOptions?: LanguageDetectorOptions): string | null;
@@ -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;
@@ -0,0 +1,168 @@
1
+ import type { LanguageDetectorOptions, Resources } from '../runtime/i18n/instance';
2
+ import type { LocalisedUrlsOption } from './localisedUrls';
3
+ export interface BaseLocaleDetectionOptions {
4
+ localePathRedirect?: boolean;
5
+ i18nextDetector?: boolean;
6
+ languages?: string[];
7
+ fallbackLanguage?: string;
8
+ detection?: LanguageDetectorOptions;
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;
21
+ }
22
+ export interface LocaleDetectionOptions extends BaseLocaleDetectionOptions {
23
+ localeDetectionByEntry?: Record<string, BaseLocaleDetectionOptions>;
24
+ }
25
+ /**
26
+ * Options for loading i18n resources via SDK
27
+ */
28
+ export interface I18nSdkLoadOptions {
29
+ /** Single language code to load (e.g., 'en', 'zh') */
30
+ lng?: string;
31
+ /** Single namespace to load (e.g., 'translation', 'common') */
32
+ ns?: string;
33
+ /** Multiple language codes to load */
34
+ lngs?: string[];
35
+ /** Multiple namespaces to load */
36
+ nss?: string[];
37
+ /** Load all available languages and namespaces */
38
+ all?: boolean;
39
+ }
40
+ /**
41
+ * SDK function to load i18n resources
42
+ * Supports multiple loading modes:
43
+ * 1. Single resource: sdk({ lng: 'en', ns: 'translation' })
44
+ * 2. Batch by languages: sdk({ lngs: ['en', 'zh'], ns: 'translation' })
45
+ * 3. Batch by namespaces: sdk({ lng: 'en', nss: ['translation', 'common'] })
46
+ * 4. Batch by both: sdk({ lngs: ['en', 'zh'], nss: ['translation', 'common'] })
47
+ * 5. Load all: sdk({ all: true }) or sdk()
48
+ *
49
+ * @param options - Loading options
50
+ * @returns Promise that resolves to resources object or the resources object directly
51
+ * Resources format: { [lng]: { [ns]: { [key]: value } } }
52
+ */
53
+ export type I18nSdkLoader = (options: I18nSdkLoadOptions) => Promise<Resources> | Resources;
54
+ /**
55
+ * Chained backend configuration
56
+ * Used internally when both loadPath and sdk are provided
57
+ */
58
+ export interface ChainedBackendConfig {
59
+ _useChainedBackend: boolean;
60
+ _chainedBackendConfig: {
61
+ backendOptions: Array<Record<string, unknown>>;
62
+ };
63
+ cacheHitMode?: 'none' | 'refresh' | 'refreshAndUpdateStore';
64
+ }
65
+ /**
66
+ * Extended backend options that may include chained backend configuration
67
+ */
68
+ export type ExtendedBackendOptions = BaseBackendOptions & Partial<ChainedBackendConfig>;
69
+ export interface BaseBackendOptions {
70
+ enabled?: boolean;
71
+ loadPath?: string;
72
+ addPath?: string;
73
+ /**
74
+ * Cache hit mode for chained backend (only effective when both `loadPath` and `sdk` are provided)
75
+ *
76
+ * - `'none'` (default): If the first backend returns resources, stop and don't try the next backend
77
+ * - `'refresh'`: Try to refresh the cache by loading from the next backend and update the cache
78
+ * - `'refreshAndUpdateStore'`: Try to refresh the cache by loading from the next backend,
79
+ * update the cache and also update the i18next resource store. This allows FS/HTTP resources
80
+ * to be displayed first, then SDK resources will update them asynchronously.
81
+ *
82
+ * @default 'refreshAndUpdateStore' when both loadPath and sdk are provided
83
+ */
84
+ cacheHitMode?: 'none' | 'refresh' | 'refreshAndUpdateStore';
85
+ /**
86
+ * SDK function to load i18n resources dynamically
87
+ *
88
+ * **Important**: In `modern.config.ts`, you can only set this to `true` or any identifier
89
+ * to enable SDK mode. The actual SDK function must be provided in `modern.runtime.ts`
90
+ * via `initOptions.backend.sdk`.
91
+ *
92
+ * When both `loadPath` (or FS backend) and `sdk` are provided, the plugin will automatically
93
+ * use `i18next-chained-backend` to chain multiple backends. The order will be:
94
+ * 1. HTTP/FS backend (primary) - loads from `loadPath` or file system first for quick initial display
95
+ * 2. SDK backend (fallback/update) - loads from the SDK function to update/refresh translations
96
+ *
97
+ * With `cacheHitMode: 'refreshAndUpdateStore'` (default), FS/HTTP resources will be displayed
98
+ * immediately, then SDK resources will be loaded asynchronously to update the translations.
99
+ *
100
+ * If only `sdk` is provided, it will be used instead of the default HTTP/FS backend
101
+ *
102
+ * @example In modern.config.ts - enable SDK mode
103
+ * ```ts
104
+ * backend: {
105
+ * enabled: true,
106
+ * sdk: true, // or any identifier, just to enable SDK mode
107
+ * }
108
+ * ```
109
+ *
110
+ * @example In modern.runtime.ts - provide the actual SDK function
111
+ * ```ts
112
+ * export default defineRuntimeConfig({
113
+ * i18n: {
114
+ * initOptions: {
115
+ * backend: {
116
+ * sdk: async (options) => {
117
+ * // Your SDK implementation
118
+ * if (options.all) {
119
+ * return await mySdk.getAllResources();
120
+ * }
121
+ * if (options.lng && options.ns) {
122
+ * return await mySdk.getResource(options.lng, options.ns);
123
+ * }
124
+ * // Handle other cases...
125
+ * }
126
+ * }
127
+ * }
128
+ * }
129
+ * });
130
+ * ```
131
+ *
132
+ * @example Single resource loading
133
+ * ```ts
134
+ * sdk: async (options) => {
135
+ * if (options.lng && options.ns) {
136
+ * const response = await fetch(`/api/i18n/${options.lng}/${options.ns}`);
137
+ * return response.json();
138
+ * }
139
+ * }
140
+ * ```
141
+ *
142
+ * @example Load all resources at once
143
+ * ```ts
144
+ * sdk: async (options) => {
145
+ * if (options?.all) {
146
+ * // Load all languages and namespaces
147
+ * return await mySdk.getAllResources();
148
+ * }
149
+ * // Handle other cases...
150
+ * }
151
+ * ```
152
+ *
153
+ * @example Batch loading
154
+ * ```ts
155
+ * sdk: async (options) => {
156
+ * if (options?.lngs && options?.nss) {
157
+ * // Load multiple languages and namespaces
158
+ * return await mySdk.getBatchResources(options.lngs, options.nss);
159
+ * }
160
+ * // Handle single or other cases...
161
+ * }
162
+ * ```
163
+ */
164
+ sdk?: I18nSdkLoader | boolean | string;
165
+ }
166
+ export interface BackendOptions extends BaseBackendOptions {
167
+ backendOptionsByEntry?: Record<string, BaseBackendOptions>;
168
+ }
@@ -0,0 +1,5 @@
1
+ import type { BaseBackendOptions, BaseLocaleDetectionOptions } from './type';
2
+ export declare function getEntryConfig<T extends Record<string, any>>(entryName: string, config: T, entryKey: string): T | undefined;
3
+ export declare function removeEntryConfigKey<T extends Record<string, any>>(config: T, entryKey: string): Omit<T, typeof entryKey>;
4
+ export declare function getLocaleDetectionOptions(entryName: string, localeDetection: BaseLocaleDetectionOptions): BaseLocaleDetectionOptions;
5
+ export declare function getBackendOptions(entryName: string, backend: BaseBackendOptions): BaseBackendOptions;
package/package.json CHANGED
@@ -17,7 +17,7 @@
17
17
  "modern",
18
18
  "modern.js"
19
19
  ],
20
- "version": "3.2.0-ultramodern.5",
20
+ "version": "3.2.0-ultramodern.51",
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/runtime-utils": "npm:@bleedingdev/modern-js-runtime-utils@3.2.0-ultramodern.5",
91
- "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.2.0-ultramodern.5",
92
- "@modern-js/server-runtime": "npm:@bleedingdev/modern-js-server-runtime@3.2.0-ultramodern.5",
93
- "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.2.0-ultramodern.5",
94
- "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.5",
95
- "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.5"
89
+ "i18next-http-middleware": "^3.9.7",
90
+ "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.2.0-ultramodern.51",
91
+ "@modern-js/runtime-utils": "npm:@bleedingdev/modern-js-runtime-utils@3.2.0-ultramodern.51",
92
+ "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.51",
93
+ "@modern-js/server-runtime": "npm:@bleedingdev/modern-js-server-runtime@3.2.0-ultramodern.51",
94
+ "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.2.0-ultramodern.51",
95
+ "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.51"
96
96
  },
97
97
  "peerDependencies": {
98
- "@modern-js/runtime": "3.2.0-ultramodern.5",
98
+ "@modern-js/runtime": "3.2.0-ultramodern.51",
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.20260527.2",
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.5",
124
- "@modern-js/runtime": "npm:@bleedingdev/modern-js-runtime@3.2.0-ultramodern.5"
122
+ "ts-jest": "^29.4.11",
123
+ "@modern-js/app-tools": "npm:@bleedingdev/modern-js-app-tools@3.2.0-ultramodern.51",
124
+ "@modern-js/runtime": "npm:@bleedingdev/modern-js-runtime@3.2.0-ultramodern.51"
125
125
  },
126
126
  "sideEffects": false,
127
127
  "publishConfig": {
@@ -0,0 +1,39 @@
1
+ import { dirname, resolve } from 'node:path';
2
+ import { fileURLToPath } from 'node:url';
3
+ import type { ProjectConfig } from '@rstest/core';
4
+ import { withTestPreset } from '@scripts/rstest-config';
5
+
6
+ const __dirname = dirname(fileURLToPath(import.meta.url));
7
+
8
+ const commonConfig: ProjectConfig = {
9
+ setupFiles: [resolve(__dirname, '../../../scripts/rstest-config/setup.ts')],
10
+ globals: true,
11
+ tools: {
12
+ swc: {
13
+ jsc: {
14
+ transform: {
15
+ react: {
16
+ runtime: 'automatic',
17
+ },
18
+ },
19
+ },
20
+ },
21
+ },
22
+ };
23
+
24
+ export default {
25
+ projects: [
26
+ withTestPreset({
27
+ name: 'plugin-i18n-node',
28
+ testEnvironment: 'node',
29
+ include: ['tests/localisedUrls.test.ts'],
30
+ extends: commonConfig,
31
+ }),
32
+ withTestPreset({
33
+ name: 'plugin-i18n-client',
34
+ testEnvironment: 'happy-dom',
35
+ include: ['tests/routerAdapter.test.tsx'],
36
+ extends: commonConfig,
37
+ }),
38
+ ],
39
+ };