feat: add redirectStatusCode option (#3685)

Co-authored-by: Bobbie Goede <bobbiegoede@gmail.com>

Author: MarlonWiss2212

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

@@ -234,6 +234,13 @@ Set to a path to which you want to redirect users accessing the root URL (`'/'`{
 }
 ```
 
+## redirectStatusCode
+
+- type: `number`{lang="ts-type"}
+- default: `302`{lang="ts"}
+
+Specifies the HTTP status code to use when redirecting to a localized route from any URL except the root URL ('/').
+
 ## langDir
 
 - type: `string`{lang="ts-type"}
@@ -614,4 +621,4 @@ 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.
-::
+::

specs/routing_strategies/redirect_status_code.spec.ts

@@ -0,0 +1,33 @@
+import { test, expect, describe } from 'vitest'
+import { fileURLToPath } from 'node:url'
+import { setup, fetch } from '../utils'
+
+await setup({
+  rootDir: fileURLToPath(new URL(`../fixtures/basic`, import.meta.url)),
+  browser: true,
+  nuxtConfig: {
+    i18n: {
+      strategy: 'prefix',
+      defaultLocale: 'en',
+      detectBrowserLanguage: {
+        redirectOn: 'no prefix'
+      },
+      rootRedirect: { statusCode: 418, path: 'test-route' },
+      redirectStatusCode: 307
+    }
+  }
+})
+
+describe('redirectStatusCode', () => {
+  test('uses custom status code', async () => {
+    const res = await fetch('/about', { redirect: 'manual' })
+    expect(res.status).toBe(307)
+    expect(res.headers.get('location')).toEqual('/en/about')
+  })
+
+  test('does not affect root redirect option', async () => {
+    const rootRes = await fetch('/', { redirect: 'manual' })
+    expect(rootRes.status).toEqual(418)
+    expect(rootRes.headers.get('location')).toEqual('/en/test-route')
+  })
+})

src/constants.ts

@@ -62,7 +62,7 @@ export const DEFAULT_OPTIONS = {
   strategy: STRATEGY_PREFIX_EXCEPT_DEFAULT,
   langDir: 'locales',
   rootRedirect: undefined,
-
+  redirectStatusCode: 302,
   detectBrowserLanguage: {
     alwaysRedirect: false,
     cookieCrossOrigin: false,

src/prepare/runtime-config.ts

@@ -11,6 +11,7 @@ export function prepareRuntimeConfig(ctx: I18nNuxtContext, nuxt: Nuxt) {
     baseUrl: ctx.options.baseUrl,
     defaultLocale: ctx.options.defaultLocale,
     rootRedirect: ctx.options.rootRedirect,
+    redirectStatusCode: ctx.options.redirectStatusCode,
     skipSettingLocaleOnNavigate: ctx.options.skipSettingLocaleOnNavigate,
     locales: ctx.options.locales,
     detectBrowserLanguage: ctx.options.detectBrowserLanguage ?? DEFAULT_OPTIONS.detectBrowserLanguage,

src/runtime/context.ts

@@ -37,6 +37,7 @@ export interface NuxtI18nContext {
   /** SSG with dynamic locale resources */
   dynamicResourcesSSG: boolean
   rootRedirect: { path: string; code: number } | undefined
+  redirectStatusCode: number
   /** Get default locale */
   getDefaultLocale: () => string
   /** Get current locale */
@@ -109,6 +110,7 @@ export function createNuxtI18nContext(nuxt: NuxtApp, vueI18n: I18n, defaultLocal
     preloaded: false,
     config: runtimeI18n,
     rootRedirect: resolveRootRedirect(runtimeI18n.rootRedirect),
+    redirectStatusCode: runtimeI18n.redirectStatusCode ?? 302,
     dynamicResourcesSSG: !__IS_SSR__ || (!__I18N_FULL_STATIC__ && (import.meta.prerender || __IS_SSG__)),
     getDefaultLocale: () => defaultLocale,
     getLocale: () => unref(i18n.locale),

src/runtime/server/plugin.ts

@@ -38,6 +38,8 @@ function* detect(
   if (__I18N_ROUTING__) {
     yield { locale: detectors.route(path), source: 'route' }
   }
+
+  yield { locale: detection.fallbackLocale, source: 'fallback' }
 }
 
 export default defineNitroPlugin(async nitro => {
@@ -96,6 +98,7 @@ export default defineNitroPlugin(async nitro => {
         break
       }
     }
+    locale ||= defaultLocale
 
     function getLocalizedMatch(locale: string) {
       const res = matchLocalized(path || '/', locale, defaultLocale)
@@ -112,6 +115,8 @@ export default defineNitroPlugin(async nitro => {
         (isSupportedLocale(detector.route(rootRedirect.path)) && rootRedirect.path) ||
         matchLocalized(rootRedirect.path, locale, defaultLocale)
       redirectCode = rootRedirect.code
+    } else if (runtimeI18n.redirectStatusCode) {
+      redirectCode = runtimeI18n.redirectStatusCode
     }
 
     switch (detection.redirectOn) {

src/runtime/utils.ts

@@ -283,7 +283,7 @@ export function navigate(nuxtApp: NuxtApp, to: CompatRoute, locale: string) {
     return
   }
 
-  return navigateTo(destination)
+  return navigateTo(destination, { redirectCode: ctx.redirectStatusCode })
 }
 
 export function prefixable(currentLocale: string, defaultLocale: string): boolean {

src/types.ts

@@ -177,6 +177,11 @@ export type NuxtI18nOptions<
    */
   overrides?: Omit<NuxtI18nOptions<Context>, 'overrides'>
   rootRedirect?: string | RootRedirectOptions
+  /**
+   * Status code used for localized redirects
+   * @default 302
+   */
+  redirectStatusCode?: number
   skipSettingLocaleOnNavigate?: boolean
   /**
    * @deprecated This option is deprecated, only `'composition'` types will be supported in the future.
@@ -362,6 +367,7 @@ export interface I18nHeadMetaInfo {
 export interface I18nPublicRuntimeConfig {
   baseUrl: NuxtI18nOptions['baseUrl']
   rootRedirect: NuxtI18nOptions['rootRedirect']
+  redirectStatusCode?: NuxtI18nOptions['redirectStatusCode']
   domainLocales: { [key: Locale]: { domain: string | undefined } }
   /** @internal Overwritten at build time, used to pass generated options to runtime */
   locales: NonNullable<Required<NuxtI18nOptions<unknown>>['locales']>