Class BaseJwtService<U, RT>

JwtService is a service that provides functionality for generating, verifying, and refreshing JSON Web Tokens (JWTs) in a NestJS application.

It can be used to generate access and refresh tokens for users and then verify those tokens when they are presented to the application. In addition, the JwtService can refresh an expired access token with a valid refresh token, and it can delete a refresh token from the database when it is no longer needed.

The service uses a secret key to sign and verify the tokens, and it can be configured to expire the tokens after a certain period of time. With JwtService, NestJS applications can implement secure authentication and authorization for users.

Type Parameters

U extends BaseUser = BaseUser
RT extends BaseRefreshToken = BaseRefreshToken

Index

Constructors

constructor

new BaseJwtService<
U extends BaseUser = BaseUser,
RT extends BaseRefreshToken = BaseRefreshToken,
>(): BaseJwtService<U, RT>
Type Parameters
- U extends BaseUser = BaseUser
- RT extends BaseRefreshToken = BaseRefreshToken
Returns BaseJwtService<U, RT>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected` `Readonly`jwtConfig

jwtConfig: JwtConfigType

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

`Protected` `Readonly`usersService

usersService: BaseUsersService<U>

Accessors

repository

get repository(): Repository<RT>
Returns Repository<RT>
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:67

Methods

deleteRefreshToken

deleteRefreshToken(id: string): Promise<void>
Delete refresh token from database
Parameters
- id: string
  refresh token id
Returns Promise<void>
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:144

deleteUserRefreshTokens

deleteUserRefreshTokens(userId: string): Promise<void>
Delete refresh token from database
Parameters
- userId: string
  user id for which to delete refresh tokens
Returns Promise<void>
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:154

`Protected`generateRefreshTokenEntityId

generateRefreshTokenEntityId(): string
Returns string
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:160

generateTokens

generateTokens(
opts: GenerateTokensOptions,
ctx: BaseServiceMethodContext,
): Promise<UserTokens>
Generate new access and refresh tokens for user
Parameters
- opts: GenerateTokensOptions
  token generation options
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UserTokens>
- user tokens
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:170

onModuleInit

onModuleInit(): void
Returns void
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:61

refreshTokens

refreshTokens(
refreshToken: string,
ctx: BaseServiceMethodContext,
): Promise<UserTokens>
Generate new access and refresh tokens
Parameters
- refreshToken: string
  refresh token string
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UserTokens>
= user tokens
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:77

verifyRefreshToken

verifyRefreshToken(
refreshToken: string,
ctx: BaseServiceMethodContext,
): Promise<RT>
Check if refresh token is valid
Parameters
- refreshToken: string
  refresh token string
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<RT>
- refresh token
Throws
- UnauthorizedException if refresh token expired or invalid
- Defined in libs/core/src/modules/auth-n/jwt/jwt.service.ts:95

Class BaseJwtService<U, RT>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseJwtService<U, RT>

Properties

Protected ReadonlydataSource

Protected ReadonlyidService

Protected ReadonlyjwtConfig

Protectedlogger

Protected ReadonlyloggerFactory

Protected ReadonlyusersService

Accessors

repository

Returns Repository<RT>

Methods

deleteRefreshToken

Parameters

Returns Promise<void>

deleteUserRefreshTokens

Parameters

Returns Promise<void>

ProtectedgenerateRefreshTokenEntityId

Returns string

generateTokens

Parameters

Returns Promise<UserTokens>

onModuleInit

Returns void

refreshTokens

Parameters

Returns Promise<UserTokens>

verifyRefreshToken

Parameters

Returns Promise<RT>

Throws

Settings

On This Page

`Protected` `Readonly`dataSource

`Protected` `Readonly`idService

`Protected` `Readonly`jwtConfig

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected` `Readonly`usersService

`Protected`generateRefreshTokenEntityId