fix: throw redirect(/some-url/, 301) (fix #1104)

Author: brillout

docs/pages/redirect.page.server.mdx

@@ -20,7 +20,7 @@ function onSomeHook() {
 }
 ```
 
-> `throw redirect()` makes temporary redirections (HTTP status code `302`). For permanent redirections (HTTP status code `301`) use <Link href="/redirects" noBreadcrumb={true} /> instead.
+> `throw redirect()` makes temporary redirections (HTTP status code `302`). For permanent redirections (HTTP status code `301`), you can set <Link href="/redirects" noBreadcrumb={true} /> or pass a second argument `throw redirect('/some-url', 301)`.
 
 While it's most commonly used with [`guard()`](/guard) or [`onBeforeRender()`](/onBeforeRender) you can use it with any hook.
 

vite-plugin-ssr/shared/route/abort.ts

@@ -28,7 +28,9 @@ import {
 } from './utils.js'
 import pc from '@brillout/picocolors'
 
-type RedirectStatusCode = 301 | 302
+type RedirectStatusCode = number &
+  // For improved IntelliSense, we define the list of status code directly on redirect()'s argument type
+  Parameters<typeof redirect>[1]
 type AbortStatusCode = number &
   // For improved IntelliSense, we define the list of status code directly on render()'s argument type
   Parameters<typeof render>[0]
@@ -44,22 +46,15 @@ type AbortRedirect = Error
  *
  * https://vite-plugin-ssr.com/redirect
  *
- * @param statusCode `301` (permanent) or `302` (temporary) redirection.
  * @param url The URL to redirect to.
+ * @param statusCode By default a `302` (temporary) redirection is performed, but you can trigger a `301` (permanent) redirection instead. Alternatively, you can define permanent redirections by setting `config.redirects`, see https://vite-plugin-ssr.com/redirects.
  */
-function redirect(url: `/${string}` | `https://${string}` | `http://${string}`): AbortRedirect
 function redirect(
   url: `/${string}` | `https://${string}` | `http://${string}`,
-  statusCode?: RedirectStatusCode
+  statusCode: 301 | 302 = 302
 ): AbortRedirect {
-  const abortCaller = 'throw redirect()' as const
-  statusCode ??= 302
   assertStatusCode(statusCode, [301, 302], 'redirect')
-  assertWarning(
-    statusCode !== 301,
-    "Status code 301 for `throw redirect()' is experimental and may be removed at any point",
-    { onlyOnce: true }
-  )
+  const abortCaller = 'throw redirect()' as const
   const pageContextAbort = {}
   objectAssign(pageContextAbort, {
     _abortCaller: abortCaller,