Class JwtAuthGuard

Guard that checks if user is authenticated Validate access token and resolve current user

Hierarchy (View Summary)

JwtAuthGuard
- GraphQLJwtAuthGuard

Implements

CanActivate

Index

Constructors

Methods

canActivate getRequest getRequestDetails getToken getUserFromContext setUserInContext

Constructors

constructor

new JwtAuthGuard(
    appConfig: AppConfigType,
    userManager: BaseUserManager<BaseUser>,
    loggerFactory: WinstonLoggerFactory,
    dataSource: DataSource,
    cacheManager: Cache,
): JwtAuthGuard
Parameters
- appConfig: AppConfigType
- userManager: BaseUserManager<BaseUser>
- loggerFactory: WinstonLoggerFactory
- dataSource: DataSource
- cacheManager: Cache
Returns JwtAuthGuard
- Defined in src/guards/jwt-auth.guard.ts:45

Methods

canActivate

canActivate(context: ExecutionContext): Promise<boolean>
Parameters
- context: ExecutionContext
  execution context
Returns Promise<boolean>
- true if access token is undefined or valid
Throws
- UnauthorizedException if access token is invalid
Implementation of CanActivate.canActivate
- Defined in src/guards/jwt-auth.guard.ts:59

getRequest

getRequest(
context: ExecutionContext,
): Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
user?: BaseUser;
}
Extracts request from execution context
Parameters
- context: ExecutionContext
  execution context
Returns Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
user?: BaseUser;
}
express request
- Defined in src/guards/jwt-auth.guard.ts:201

getRequestDetails

getRequestDetails(context: ExecutionContext): Record<string, unknown>
Extracts request details from execution context
Parameters
- context: ExecutionContext
  execution context
Returns Record<string, unknown>
request details
- Defined in src/guards/jwt-auth.guard.ts:210

getToken

getToken(context: ExecutionContext): Maybe<string>
Extracts access token from request
Parameters
- context: ExecutionContext
  execution context
Returns Maybe<string>
access token if exists
- Defined in src/guards/jwt-auth.guard.ts:225

getUserFromContext

getUserFromContext(context: ExecutionContext): null | BaseUser
Extracts current user from request object
Parameters
- context: ExecutionContext
  execution context
Returns null | BaseUser
current user if exists
- Defined in src/guards/jwt-auth.guard.ts:246

setUserInContext

setUserInContext(context: ExecutionContext, user: BaseUser): void
Inject current user to request object
Parameters
- context: ExecutionContext
  execution context
- user: BaseUser
  current user
Returns void
- Defined in src/guards/jwt-auth.guard.ts:236