blitz-auth: useAuthenticatedBlitzContext returns AuthenticatedCtx (…

…#4198) Co-authored-by: Brandon Bayer <[email protected]>
blitz-js · Aug 17, 2023 · 8b01175 · 8b01175
1 parent 0f1beb5
commit 8b01175
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 6 deletions.
diff --git a/.changeset/fresh-camels-return.md b/.changeset/fresh-camels-return.md
@@ -0,0 +1,5 @@
+---
+"@blitzjs/auth": patch
+---
+
+Updated `useAuthenticatedBlitzContext` to now return `AuthenticatedCtx`
diff --git a/packages/blitz-auth/src/server/auth-sessions.ts b/packages/blitz-auth/src/server/auth-sessions.ts
@@ -15,6 +15,7 @@ import {
   log,
   baseLogger,
   chalk,
+  AuthenticatedCtx,
 } from "blitz"
 import {
   EmptyPublicData,
@@ -219,7 +220,7 @@ export async function useAuthenticatedBlitzContext({
   redirectTo?: string | RouteUrlObject
   redirectAuthenticatedTo?: string | RouteUrlObject | ((ctx: Ctx) => string | RouteUrlObject)
   role?: string | string[]
-}): Promise<void> {
+}): Promise<AuthenticatedCtx> {
   const log = baseLogger().getSubLogger({name: "useAuthenticatedBlitzContext"})
   const customChalk = new chalk.Instance({
     level: log.settings.type === "json" ? 0 : chalk.level,
@@ -268,6 +269,7 @@ export async function useAuthenticatedBlitzContext({
       redirect(redirectTo)
     }
   }
+  return ctx as AuthenticatedCtx
 }
 
 const makeProxyToPublicData = <T extends SessionContextClass>(ctxClass: T): T => {

diff --git a/packages/blitz-auth/src/shared/types.ts b/packages/blitz-auth/src/shared/types.ts
@@ -82,7 +82,7 @@ declare module "blitz" {
   export interface Ctx {
     session: SessionContext
   }
-  export interface AuthenticatedMiddlewareCtx extends Omit<Ctx, "session"> {
+  export interface AuthenticatedCtx extends Omit<Ctx, "session"> {
     session: AuthenticatedSessionContext
   }
 }

diff --git a/packages/blitz-rpc/src/server/resolvers/resolver.ts b/packages/blitz-rpc/src/server/resolvers/resolver.ts
@@ -1,5 +1,5 @@
 import type {SessionContext, SessionContextBase} from "@blitzjs/auth"
-import {Await, Ctx, EnsurePromise, AuthenticatedMiddlewareCtx} from "blitz"
+import {Await, Ctx, EnsurePromise, AuthenticatedCtx} from "blitz"
 import type {input as zInput, output as zOutput, ZodTypeAny} from "zod"
 
 export type ParserType = "sync" | "async"
@@ -271,7 +271,7 @@ interface ResolverAuthorize {
   <T, C = Ctx>(...args: Parameters<SessionContextBase["$authorize"]>): (
     input: T,
     ctx: C,
-  ) => ResultWithContext<T, AuthenticatedMiddlewareCtx>
+  ) => ResultWithContext<T, AuthenticatedCtx>
 }
 
 const authorize: ResolverAuthorize = (...args) => {

diff --git a/packages/blitz/src/types.ts b/packages/blitz/src/types.ts
@@ -2,7 +2,7 @@ import {UrlObject} from "url"
 // Context for plugins to declaration merge stuff into
 export interface Ctx {}
 
-export interface AuthenticatedMiddlewareCtx {}
+export interface AuthenticatedCtx {}
 
 export type CodegenField = {
   component: string
@@ -17,7 +17,7 @@ export interface RouteUrlObject extends Pick<UrlObject, "pathname" | "query" | "
   href: string
 }
 
-export interface AuthenticatedMiddlewareCtx {}
+export interface AuthenticatedCtx {}
 
 export type EventHooks = {
   onSessionCreated?: OnSessionCreated