feat: configurable message server route prefix (#3853)

Author: BobbieGoede

docs/content/docs/04.api/00.options.md

@@ -624,3 +624,10 @@ Used to configure the directory used to resolve i18n files.
 ::callout{icon="i-heroicons-exclamation-triangle" color="warning"}
 This feature relies on [Nuxt's Auto-imports](https://nuxt.com/docs/guide/concepts/auto-imports) and will not work if this has been disabled.
 ::
+
+## serverRoutePrefix
+
+- type `string`{lang="ts-type"}
+- default: `'/_i18n'`{lang="ts"}
+
+Sets the prefix for the server route used for loading locale messages.

src/bundler.ts

@@ -103,8 +103,8 @@ export function getDefineConfig(
 
     __I18N_ROUTING__: JSON.stringify(nuxt.options.pages.toString() && options.strategy !== 'no_prefix'),
     __I18N_STRICT_SEO__: JSON.stringify(!!options.experimental.strictSeo),
+    __I18N_SERVER_ROUTE__: JSON.stringify([options.serverRoutePrefix, deploymentHash].join('/')),
     __I18N_SERVER_REDIRECT__: JSON.stringify(!!options.experimental.nitroContextDetection),
-    __I18N_HASH__: JSON.stringify(deploymentHash),
   }
 
   if (nuxt.options.ssr || !server) {

src/constants.ts

@@ -83,6 +83,7 @@ export const DEFAULT_OPTIONS = {
   multiDomainLocales: false,
   hmr: true,
   autoDeclare: true,
+  serverRoutePrefix: '/_i18n',
 } as const
 
 export const DEFINE_I18N_ROUTE_FN = 'defineI18nRoute'

src/env.d.ts

@@ -29,5 +29,5 @@ declare let __I18N_PRELOAD__: boolean
 declare let __I18N_ROUTING__: boolean
 declare let __I18N_STRICT_SEO__: boolean
 declare let __I18N_SERVER_REDIRECT__: boolean
-/** Hashed deployment timestamp */
-declare let __I18N_HASH__: string
+/** Includes hashed deployment timestamp */
+declare let __I18N_SERVER_ROUTE__: string

src/nitro.ts

@@ -105,7 +105,7 @@ export { localeDetector }`
   addServerPlugin(ctx.resolver.resolve('runtime/server/plugin'))
 
   addServerHandler({
-    route: `/_i18n/:hash/:locale/messages.json`,
+    route: `${ctx.options.serverRoutePrefix}/:hash/:locale/messages.json`,
     handler: ctx.resolver.resolve('./runtime/server/routes/messages'),
   })
 }

src/runtime/context.ts

@@ -99,7 +99,7 @@ export function createNuxtI18nContext(nuxt: NuxtApp, vueI18n: I18n, defaultLocal
   const loadMessagesFromServer = async (locale: string) => {
     if (locale in localeLoaders === false) { return }
     const headers: HeadersInit = getLocaleConfig(locale)?.cacheable ? {} : { 'Cache-Control': 'no-cache' }
-    const messages = await $fetch(`/_i18n/${__I18N_HASH__}/${locale}/messages.json`, { headers })
+    const messages = await $fetch(`${__I18N_SERVER_ROUTE__}/${locale}/messages.json`, { headers })
     for (const k of Object.keys(messages)) {
       i18n.mergeLocaleMessage(k, messages[k])
     }

src/runtime/plugins/i18n.ts

@@ -43,7 +43,7 @@ export default defineNuxtPlugin({
       setupMultiDomainLocales(optionsI18n.defaultLocale)
     }
 
-    prerenderRoutes(localeCodes.map(locale => `/_i18n/${__I18N_HASH__}/${locale}/messages.json`))
+    prerenderRoutes(localeCodes.map(locale => `${__I18N_SERVER_ROUTE__}/${locale}/messages.json`))
 
     // create i18n instance
     const i18n = createI18n(optionsI18n)

src/runtime/plugins/preload.ts

@@ -19,7 +19,7 @@ export default defineNuxtPlugin({
     if (import.meta.server) {
       for (const locale of localeCodes) {
         try {
-          const messages = await $fetch(`/_i18n/${__I18N_HASH__}/${locale}/messages.json`)
+          const messages = await $fetch(`${__I18N_SERVER_ROUTE__}/${locale}/messages.json`)
           for (const locale of Object.keys(messages)) {
             nuxt.$i18n.mergeLocaleMessage(locale, messages[locale])
           }

src/runtime/server/context.ts

@@ -23,7 +23,7 @@ if (import.meta.dev) {
  * @internal
  */
 export const fetchMessages = async (locale: string) =>
-  await $fetch<LocaleMessages<DefineLocaleMessage>>(`/_i18n/${__I18N_HASH__}/${locale}/messages.json`, {
+  await $fetch<LocaleMessages<DefineLocaleMessage>>(`${__I18N_SERVER_ROUTE__}/${locale}/messages.json`, {
     headers,
   })
 

src/runtime/server/plugin.ts

@@ -172,7 +172,7 @@ export default defineNitroPlugin(async (nitro) => {
     const path = (pathLocale && url.pathname.slice(pathLocale.length + 1)) || url.pathname
 
     // attempt to only run i18n detection for nuxt pages and i18n server routes
-    if (!url.pathname.includes('/_i18n/') && !isExistingNuxtRoute(path)) {
+    if (!url.pathname.includes(__I18N_SERVER_ROUTE__) && !isExistingNuxtRoute(path)) {
       return
     }