Add support for Page.redirectAuthenticatedTo to be a function with …

…access to `session` (#2634)

(minor)

packages/core/src/blitz-app-root.tsx

@@ -51,18 +51,22 @@ export function withBlitzInnerWrapper(Page: BlitzPage) {
     useAuthorizeIf(Page.authenticate === true)
 
     if (typeof window !== "undefined") {
-      // We read directly from publicDataStore.getData().userId instead of useSession
+      const publicData = publicDataStore.getData()
+      // We read directly from publicData.userId instead of useSession
       // so we can access userId on first render. useSession is always empty on first render
-      if (publicDataStore.getData().userId) {
+      if (publicData.userId) {
         clientDebug("[BlitzInnerRoot] logged in")
-        let {redirectAuthenticatedTo} = Page
+        const redirectAuthenticatedTo =
+          typeof Page.redirectAuthenticatedTo === "function"
+            ? Page.redirectAuthenticatedTo({session: publicData})
+            : Page.redirectAuthenticatedTo
         if (redirectAuthenticatedTo) {
-          if (typeof redirectAuthenticatedTo !== "string") {
-            redirectAuthenticatedTo = formatWithValidation(redirectAuthenticatedTo)
-          }
-
-          clientDebug("[BlitzInnerRoot] redirecting to", redirectAuthenticatedTo)
-          const error = new RedirectError(redirectAuthenticatedTo)
+          const redirectUrl =
+            typeof redirectAuthenticatedTo === "string"
+              ? redirectAuthenticatedTo
+              : formatWithValidation(redirectAuthenticatedTo)
+          clientDebug("[BlitzInnerRoot] redirecting to", redirectUrl)
+          const error = new RedirectError(redirectUrl)
           error.stack = null!
           throw error
         }

packages/core/src/types.ts

@@ -9,6 +9,7 @@ import {
   NextPageContext,
 } from "next/types"
 import type {UrlObject} from "url"
+import {PublicData} from "./auth/auth-types"
 import {BlitzRuntimeData} from "./blitz-data"
 
 export type {BlitzConfig} from "@blitzjs/config"
@@ -37,11 +38,20 @@ export type BlitzComponentType<C = NextPageContext, IP = {}, P = {}> = NextCompo
 export interface AppProps<P = {}> extends NextAppProps<P> {
   Component: BlitzComponentType<NextPageContext, any, P> & BlitzPage
 }
+
+export type RedirectAuthenticatedTo = string | RouteUrlObject | false
+export type RedirectAuthenticatedToFnCtx = {
+  session: PublicData
+}
+export type RedirectAuthenticatedToFn = (
+  args: RedirectAuthenticatedToFnCtx,
+) => RedirectAuthenticatedTo
+
 export type BlitzPage<P = {}, IP = P> = NextPage<P, IP> & {
   getLayout?: (component: JSX.Element) => JSX.Element
   authenticate?: boolean | {redirectTo?: string | RouteUrlObject}
   suppressFirstRenderFlicker?: boolean
-  redirectAuthenticatedTo?: string | RouteUrlObject
+  redirectAuthenticatedTo?: RedirectAuthenticatedTo | RedirectAuthenticatedToFn
 }
 
 export interface RouteUrlObject extends Pick<UrlObject, "pathname" | "query"> {