-
-
Notifications
You must be signed in to change notification settings - Fork 478
/
utils.ts
519 lines (462 loc) · 17.7 KB
/
utils.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
/* eslint-disable @typescript-eslint/no-explicit-any */
import {
getLocale,
setLocale,
getLocaleCodes,
createLocaleFromRouteGetter,
getRouteBaseName,
localePath,
localeRoute,
switchLocalePath,
localeHead,
LocaleObject,
DefaultPrefixable,
DefaultSwitchLocalePathIntercepter,
getComposer,
useSwitchLocalePath
} from 'vue-i18n-routing'
import { navigateTo, useState } from '#imports'
import { isString, isFunction, isArray, isObject } from '@intlify/shared'
import { nuxtI18nInternalOptions, nuxtI18nOptionsDefault, NUXT_I18N_MODULE_ID, isSSG } from '#build/i18n.options.mjs'
import {
detectBrowserLanguage,
getLocaleCookie,
callVueI18nInterfaces,
getVueI18nPropertyValue,
loadLocale,
loadAdditionalLocale, // TODO: remove `i18n:extend-messages` before v8 official release
defineGetter,
getLocaleDomain,
getDomainFromLocale,
proxyNuxt,
DefaultDetectBrowserLanguageFromResult
} from '#build/i18n.internal.mjs'
import { joinURL } from 'ufo'
import type {
Route,
RouteLocationNormalized,
RouteLocationNormalizedLoaded,
BaseUrlResolveHandler,
PrefixableOptions,
SwitchLocalePathIntercepter
} from 'vue-i18n-routing'
import type { NuxtApp } from '#imports'
import type { I18n, Locale, FallbackLocale, LocaleMessages, DefineLocaleMessage } from 'vue-i18n'
import type { NuxtI18nOptions, DetectBrowserLanguageOptions, RootRedirectOptions } from '#build/i18n.options.mjs'
import type { DetectLocaleForSSGStatus } from '#build/i18n.internal.mjs'
import type { DeepRequired } from 'ts-essentials'
export function _setLocale(i18n: I18n, locale: Locale) {
return callVueI18nInterfaces(i18n, 'setLocale', locale)
}
export function setCookieLocale(i18n: I18n, locale: Locale) {
return callVueI18nInterfaces(i18n, 'setLocaleCookie', locale)
}
export function setLocaleMessage(i18n: I18n, locale: Locale, messages: Record<string, any>) {
return callVueI18nInterfaces(i18n, 'setLocaleMessage', locale, messages)
}
// TODO: remove `i18n:extend-messages` before v8 official release
export function mergeLocaleMessage(i18n: I18n, locale: Locale, messages: Record<string, any>) {
return callVueI18nInterfaces(i18n, 'mergeLocaleMessage', locale, messages)
}
function onBeforeLanguageSwitch(
i18n: I18n,
oldLocale: string,
newLocale: string,
initial: boolean,
context: NuxtApp
): string | void {
return callVueI18nInterfaces(i18n, 'onBeforeLanguageSwitch', oldLocale, newLocale, initial, context)
}
export function onLanguageSwitched(i18n: I18n, oldLocale: string, newLocale: string): void {
return callVueI18nInterfaces(i18n, 'onLanguageSwitched', oldLocale, newLocale)
}
export async function finalizePendingLocaleChange(i18n: I18n) {
return callVueI18nInterfaces(i18n, 'finalizePendingLocaleChange')
}
function makeFallbackLocaleCodes(fallback: FallbackLocale, locales: Locale[]): Locale[] {
let fallbackLocales: string[] = []
if (isArray(fallback)) {
fallbackLocales = fallback
} else if (isObject(fallback)) {
const targets = [...locales, 'default']
for (const locale of targets) {
if (fallback[locale]) {
fallbackLocales = [...fallbackLocales, ...fallback[locale].filter(Boolean)]
}
}
} else if (isString(fallback) && locales.every(locale => locale !== fallback)) {
fallbackLocales.push(fallback)
}
return fallbackLocales
}
export async function loadInitialMessages<Context extends NuxtApp = NuxtApp>(
context: Context,
messages: LocaleMessages<DefineLocaleMessage>,
options: DeepRequired<NuxtI18nOptions<Context>> & {
initialLocale: Locale
fallbackLocale: FallbackLocale
localeCodes: string[]
}
): Promise<Record<string, any>> {
const { defaultLocale, initialLocale, localeCodes, fallbackLocale, langDir, lazy } = options
const setter = (locale: Locale, message: Record<string, any>) => {
const base = messages[locale] || {}
messages[locale] = { ...base, ...message }
}
if (langDir) {
// load fallback messages
if (lazy && fallbackLocale) {
const fallbackLocales = makeFallbackLocaleCodes(fallbackLocale, [defaultLocale, initialLocale])
await Promise.all(fallbackLocales.map(locale => loadLocale(context, locale, setter)))
}
// load initial messages
const locales = lazy ? [...new Set<Locale>().add(defaultLocale).add(initialLocale)] : localeCodes
await Promise.all(locales.map(locale => loadLocale(context, locale, setter)))
}
return messages
}
// TODO: remove `i18n:extend-messages` before v8 official release
export async function mergeAdditionalMessages<Context extends NuxtApp = NuxtApp>(
context: Context,
i18n: I18n,
locale: Locale
) {
await loadAdditionalLocale(context, locale, (locale: Locale, message: Record<string, any>) =>
mergeLocaleMessage(i18n, locale, message)
)
}
export async function loadAndSetLocale<Context extends NuxtApp = NuxtApp>(
newLocale: string,
context: Context,
i18n: I18n,
{
useCookie = nuxtI18nOptionsDefault.detectBrowserLanguage.useCookie,
skipSettingLocaleOnNavigate = nuxtI18nOptionsDefault.skipSettingLocaleOnNavigate,
differentDomains = nuxtI18nOptionsDefault.differentDomains,
initial = false,
lazy = false,
langDir = null
}: Pick<DetectBrowserLanguageOptions, 'useCookie'> &
Pick<NuxtI18nOptions<Context>, 'lazy' | 'langDir' | 'skipSettingLocaleOnNavigate' | 'differentDomains'> & {
initial?: boolean
} = {}
): Promise<[boolean, string]> {
let ret = false
const oldLocale = getLocale(i18n)
__DEBUG__ && console.log('setLocale: new -> ', newLocale, ' old -> ', oldLocale, ' initial -> ', initial)
if (!newLocale) {
return [ret, oldLocale]
}
// abort if different domains option enabled
if (!initial && differentDomains) {
return [ret, oldLocale]
}
if (oldLocale === newLocale) {
return [ret, oldLocale]
}
// call onBeforeLanguageSwitch
const localeOverride = await onBeforeLanguageSwitch(i18n, oldLocale, newLocale, initial, context)
const localeCodes = getLocaleCodes(i18n)
if (localeOverride && localeCodes && localeCodes.includes(localeOverride)) {
if (localeOverride === oldLocale) {
return [ret, oldLocale]
}
newLocale = localeOverride
}
if (langDir) {
const i18nFallbackLocales = getVueI18nPropertyValue<FallbackLocale>(i18n, 'fallbackLocale')
if (lazy) {
const setter = (locale: Locale, message: Record<string, any>) => mergeLocaleMessage(i18n, locale, message)
if (i18nFallbackLocales) {
const fallbackLocales = makeFallbackLocaleCodes(i18nFallbackLocales, [newLocale])
await Promise.all(fallbackLocales.map(locale => loadLocale(context, locale, setter)))
}
await loadLocale(context, newLocale, setter)
}
}
// merge additional locale messages
await mergeAdditionalMessages(context, i18n, newLocale)
if (skipSettingLocaleOnNavigate) {
return [ret, oldLocale]
}
// set the locale
if (useCookie) {
setCookieLocale(i18n, newLocale)
}
setLocale(i18n, newLocale)
await onLanguageSwitched(i18n, oldLocale, newLocale)
ret = true
return [ret, oldLocale]
}
type LocaleLoader = () => Locale
export function detectLocale<Context extends NuxtApp = NuxtApp>(
route: string | Route | RouteLocationNormalized | RouteLocationNormalizedLoaded,
context: any,
routeLocaleGetter: ReturnType<typeof createLocaleFromRouteGetter>,
nuxtI18nOptions: DeepRequired<NuxtI18nOptions<Context>>,
initialLocaleLoader: Locale | LocaleLoader,
normalizedLocales: LocaleObject[],
localeCodes: string[] = [],
ssgStatus: DetectLocaleForSSGStatus = 'normal'
) {
const { strategy, defaultLocale, differentDomains } = nuxtI18nOptions
const initialLocale = isFunction(initialLocaleLoader) ? initialLocaleLoader() : initialLocaleLoader
__DEBUG__ && console.log('detectLocale: initialLocale -', initialLocale)
// prettier-ignore
const { locale: browserLocale, stat, reason, from } = nuxtI18nOptions.detectBrowserLanguage
? detectBrowserLanguage(route, context, nuxtI18nOptions, nuxtI18nInternalOptions, localeCodes, initialLocale, ssgStatus)
: DefaultDetectBrowserLanguageFromResult
__DEBUG__ &&
console.log(
'detectLocale: detectBrowserLanguage (browserLocale, stat, reason, from) -',
browserLocale,
stat,
reason,
from
)
if (reason === 'detect_ignore_on_ssg') {
return initialLocale
}
let finalLocale: string | undefined = browserLocale
__DEBUG__ && console.log('detectLocale: finaleLocale first (finaleLocale, strategy) -', finalLocale, strategy)
if (!finalLocale) {
if (differentDomains) {
finalLocale = getLocaleDomain(normalizedLocales)
} else if (strategy !== 'no_prefix') {
finalLocale = routeLocaleGetter(route)
} else {
if (!nuxtI18nOptions.detectBrowserLanguage) {
finalLocale = initialLocale
}
}
}
__DEBUG__ &&
console.log(
'detectLocale: finaleLocale second (finaleLocale, detectBrowserLanguage) -',
finalLocale,
nuxtI18nOptions.detectBrowserLanguage
)
if (!finalLocale && nuxtI18nOptions.detectBrowserLanguage && nuxtI18nOptions.detectBrowserLanguage.useCookie) {
finalLocale = getLocaleCookie(context, { ...nuxtI18nOptions.detectBrowserLanguage, localeCodes })
}
__DEBUG__ && console.log('detectLocale: finalLocale last (finalLocale, defaultLocale) -', finalLocale, defaultLocale)
if (!finalLocale) {
finalLocale = defaultLocale || ''
}
__DEBUG__ && console.log('detectLocale: finalLocale -', finalLocale)
return finalLocale
}
export function detectRedirect<Context extends NuxtApp = NuxtApp>(
route: Route | RouteLocationNormalized | RouteLocationNormalizedLoaded,
context: Context,
targetLocale: Locale,
routeLocaleGetter: ReturnType<typeof createLocaleFromRouteGetter>,
nuxtI18nOptions: DeepRequired<NuxtI18nOptions<Context>>
): string {
const { strategy, defaultLocale, differentDomains } = nuxtI18nOptions
__DEBUG__ && console.log('detectRedirect: targetLocale -> ', targetLocale)
__DEBUG__ && console.log('detectRedirect: route -> ', route)
let redirectPath = ''
const isStaticGenerate = isSSG && process.server
if (!isI18nRouteDefined(route)) {
return redirectPath
}
// decide whether we should redirect to a different route.
if (
!isStaticGenerate &&
!differentDomains &&
strategy !== 'no_prefix' &&
// skip if already on the new locale unless the strategy is "prefix_and_default" and this is the default
// locale, in which case we might still redirect as we prefer unprefixed route in this case.
(routeLocaleGetter(route) !== targetLocale || (strategy === 'prefix_and_default' && targetLocale === defaultLocale))
) {
// the current route could be 404 in which case attempt to find matching route using the full path since
// "switchLocalePath" can only find routes if the current route exists.
const { fullPath } = route
const decodedRoute = decodeURI(fullPath)
const routePath = context.$switchLocalePath(targetLocale) || context.$localePath(fullPath, targetLocale)
__DEBUG__ && console.log('detectRedirect: calculate routePath -> ', routePath, fullPath)
if (
isString(routePath) &&
routePath &&
routePath !== fullPath &&
routePath !== decodedRoute &&
!routePath.startsWith('//')
) {
redirectPath = routePath
}
}
if (differentDomains || (isSSG && process.client)) {
/**
* `$router.currentRoute` does not yet reflect the `to` value,
* when the Router middleware handler is executed.
* if `$switchLocalePath` is called, the intended path cannot be obtained,
* because it is processed by previso's route.
* so, we don't call that function, and instead, we call `useSwitchLocalePath`,
* let it be processed by the route of the router middleware.
*/
const switchLocalePath = useSwitchLocalePath({
i18n: getComposer(context.$i18n),
route,
router: context.$router
})
const routePath = switchLocalePath(targetLocale)
__DEBUG__ && console.log('detectRedirect: calculate domain or ssg routePath -> ', routePath)
if (isString(routePath)) {
redirectPath = routePath
}
}
return redirectPath
}
function isRootRedirectOptions(rootRedirect: unknown): rootRedirect is RootRedirectOptions {
return isObject(rootRedirect) && 'path' in rootRedirect && 'statusCode' in rootRedirect
}
// composable function for redirect loop avoiding
const useRedirectState = () => useState<string>(NUXT_I18N_MODULE_ID + ':redirect', () => '')
type NavigateArgs = {
i18n: I18n
redirectPath: string
locale: string
route: Route | RouteLocationNormalized | RouteLocationNormalizedLoaded
}
function _navigate(redirectPath: string, status: number) {
if (isSSG && process.client) {
/**
* When in the SSG, nuxt i18n module does not need to redirect in the route middleware (vue-router).
* If we overwrite them with `location.assign`, the route history will be broken.
*/
return
} else {
return navigateTo(redirectPath, { redirectCode: status })
}
}
export async function navigate<Context extends NuxtApp = NuxtApp>(
args: NavigateArgs,
{
status = 301,
rootRedirect = nuxtI18nOptionsDefault.rootRedirect,
differentDomains = nuxtI18nOptionsDefault.differentDomains,
skipSettingLocaleOnNavigate = nuxtI18nOptionsDefault.skipSettingLocaleOnNavigate
}: {
status?: number
} & Pick<NuxtI18nOptions<Context>, 'skipSettingLocaleOnNavigate' | 'differentDomains' | 'rootRedirect'> = {}
) {
const { i18n, locale, route } = args
let { redirectPath } = args
__DEBUG__ && console.log('navigate options ', status, rootRedirect, differentDomains, skipSettingLocaleOnNavigate)
__DEBUG__ && console.log('navigate isSSG', isSSG)
if (route.path === '/' && rootRedirect) {
if (isString(rootRedirect)) {
redirectPath = '/' + rootRedirect
} else if (isRootRedirectOptions(rootRedirect)) {
redirectPath = '/' + rootRedirect.path
status = rootRedirect.statusCode
}
__DEBUG__ && console.log('navigate: rootRedirect mode redirectPath -> ', redirectPath, ' status -> ', status)
return _navigate(redirectPath, status)
}
if (process.client && skipSettingLocaleOnNavigate) {
i18n.__pendingLocale = locale
i18n.__pendingLocalePromise = new Promise(resolve => {
i18n.__resolvePendingLocalePromise = resolve
})
return
}
if (!differentDomains) {
if (redirectPath) {
return _navigate(redirectPath, status)
}
} else {
const state = useRedirectState()
__DEBUG__ && console.log('redirect state ->', state.value, 'redirectPath -> ', redirectPath)
if (process.client) {
if (state.value !== redirectPath) {
state.value = '' // reset redirect path
window.location.assign(redirectPath)
}
} else if (process.server) {
__DEBUG__ && console.log('differentDomains servermode ', redirectPath)
state.value = redirectPath // set reidrct path
}
}
}
export function inejctNuxtHelpers(nuxt: NuxtApp, i18n: I18n) {
/**
* NOTE:
* we will inject `i18n.global` to **nuxt app instance only**
* because vue-i18n has already injected into vue,
* it's not necessary to do, so we borrow from nuxt inject implementation.
*/
defineGetter(nuxt as any, '$i18n', i18n.global)
for (const pair of [
['getRouteBaseName', getRouteBaseName],
['localePath', localePath],
['localeRoute', localeRoute],
['switchLocalePath', switchLocalePath],
['localeHead', localeHead]
]) {
defineGetter(nuxt as any, '$' + pair[0], proxyNuxt(nuxt, pair[1] as (...args: any) => any))
}
}
// override prefix for route path, support domain
export function extendPrefixable(differentDomains: boolean) {
return (opts: PrefixableOptions): boolean => {
return DefaultPrefixable(opts) && !differentDomains
}
}
// override switch locale path intercepter, support domain
export function extendSwitchLocalePathIntercepter(
differentDomains: boolean,
normalizedLocales: LocaleObject[],
nuxt?: NuxtApp
): SwitchLocalePathIntercepter {
return (path: string, locale: Locale): string => {
if (differentDomains) {
const domain = getDomainFromLocale(locale, normalizedLocales, nuxt)
__DEBUG__ && console.log('extendSwitchLocalePathIntercepter: domain -> ', domain, ' path -> ', path)
if (domain) {
return joinURL(domain, path)
} else {
return path
}
} else {
return DefaultSwitchLocalePathIntercepter(path, locale)
}
}
}
export function extendBaseUrl<Context extends NuxtApp = NuxtApp>(
baseUrl: string | BaseUrlResolveHandler<Context>,
options: Pick<Required<NuxtI18nOptions<Context>>, 'differentDomains'> & {
nuxt?: Context
localeCodeLoader: Locale | LocaleLoader
normalizedLocales: LocaleObject[]
}
): BaseUrlResolveHandler<Context> {
return (context: Context): string => {
if (isFunction(baseUrl)) {
const baseUrlResult = baseUrl(context)
__DEBUG__ && console.log('baseUrl: using localeLoader function -', baseUrlResult)
return baseUrlResult
}
const { differentDomains, localeCodeLoader, normalizedLocales } = options
const localeCode = isFunction(localeCodeLoader) ? localeCodeLoader() : localeCodeLoader
if (differentDomains && localeCode) {
const domain = getDomainFromLocale(localeCode, normalizedLocales, options.nuxt)
if (domain) {
__DEBUG__ && console.log('baseUrl: using differentDomains -', domain)
return domain
}
}
const config = context.$config?.public?.i18n
if (config?.baseUrl) {
__DEBUG__ && console.log('baseUrl: using runtimeConfig -', config.baseUrl)
return config.baseUrl
}
return baseUrl
}
}
function isI18nRouteDefined(route: Route | RouteLocationNormalized | RouteLocationNormalizedLoaded): boolean {
const i18nLocales = route.matched[0]?.meta.nuxtI18n
return i18nLocales ? Object.keys(i18nLocales).length > 0 : false
}
/* eslint-enable @typescript-eslint/no-explicit-any */