Class JwtAuthStrategy<RoleType, UserType>

constructor

• new JwtAuthStrategy<
      RoleType extends string,
      UserType extends BaseUser<RoleType> = BaseUser<RoleType>,
  >(): JwtAuthStrategy<RoleType, UserType>

  Type Parameters

  • RoleType extends string
  • UserType extends BaseUser<RoleType> = BaseUser<RoleType>

  Returns JwtAuthStrategy<RoleType, UserType>

Readonlyname

ReadonlysecurityScheme

belongsTo

• belongsTo<TargetEntity extends Newable<BaseEntity>>(
      request: HttpRequest | WebsocketRequest,
      targetEntity: TargetEntity,
      targetUserIdKey: keyof InstanceType<TargetEntity>,
      targetIdParamKey: string,
  ): Promise<boolean>

  Checks whether a currently logged belongs to the requested resource.

  Type Parameters

  • TargetEntity extends Newable<BaseEntity>

  Parameters

  • request: HttpRequest | WebsocketRequest
  • targetEntity: TargetEntity
  • targetUserIdKey: keyof InstanceType<TargetEntity>
  • targetIdParamKey: string

  Returns Promise<boolean>

confirmPasswordReset

• confirmPasswordReset(data: JwtConfirmPasswordResetData): Promise<void>

  Confirms a new password for a user using the provided confirm password reset data.

  Parameters

  • data: JwtConfirmPasswordResetData

  Returns Promise<void>

hasRole

• hasRole(
      request: HttpRequest | WebsocketRequest,
      allowedRoles: RoleType[],
  ): Promise<boolean>

  Checks whether a currently logged in user has one of the provided roles.

  Parameters

  • request: HttpRequest | WebsocketRequest
  • allowedRoles: RoleType[]

  Returns Promise<boolean>

init

• init(): void

  Initializes the strategy.

  Returns void

isLoggedIn

• isLoggedIn(request: HttpRequest | WebsocketRequest): Promise<boolean>

  Checks whether a user is currently logged in.

  Parameters

  • request: HttpRequest | WebsocketRequest

  Returns Promise<boolean>

login

• login(credentials: JwtCredentialsDto): Promise<JwtAuthData<RoleType>>

  Logs in a user.

  Parameters

  • credentials: JwtCredentialsDto

  Returns Promise<JwtAuthData<RoleType>>

logout

• logout(data: JwtRefreshLoginData): Promise<void>

  Logs out the current user.

  Parameters

  • data: JwtRefreshLoginData

  Returns Promise<void>

refreshLogin

• refreshLogin(data: JwtRefreshLoginData): Promise<JwtAuthData<RoleType>>

  Refreshes the login of a user.

  Parameters

  • data: JwtRefreshLoginData

  Returns Promise<JwtAuthData<RoleType>>

requestPasswordReset

• requestPasswordReset(
      data: JwtRequestPasswordResetData<RoleType, UserType>,
  ): Promise<void>

  Request a new password for a user using the request password reset data.

  Parameters

  • data: JwtRequestPasswordResetData<RoleType, UserType>

  Returns Promise<void>

resolveUser

• resolveUser(
      request: HttpRequest | WebsocketRequest,
  ): Promise<undefined | UserType>

  Resolves the current user.

  Parameters

  • request: HttpRequest | WebsocketRequest

  Returns Promise<undefined | UserType>