Class CookieAuthStrategy<RoleType, UserType>

constructor

• new CookieAuthStrategy<
      RoleType extends string,
      UserType extends BaseUser<RoleType> = BaseUser<RoleType>,
  >(
      sessionRepository: Repository<
          CookieAuthSession,
          CookieAuthSessionCreateData,
      >,
      refreshSessionRepository: Repository<
          CookieAuthRefreshSession,
          CookieAuthRefreshSessionCreateData,
      >,
      userService: UserServiceInterface,
      csrfTokenHeader: string,
      sessionOptions: OmitStrict<CookieOptions, "maxAge" | "expires">,
      refreshSessionOptions: OmitStrict<CookieOptions, "maxAge" | "expires">,
      sessionExpiresInMs: number,
      refreshSessionExpiresInMs: number,
      passwordResetTokenExpiresInMs: number,
      passwordResetTokenRepository: Repository<PasswordResetToken>,
      credentialsRepository: Repository<CookieAuthCredentials>,
      emailService: EmailServiceInterface,
      hashService: HashServiceInterface,
      secret: string | undefined,
  ): CookieAuthStrategy<RoleType, UserType>

  Type Parameters

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

  Parameters

  • sessionRepository: Repository<CookieAuthSession, CookieAuthSessionCreateData>
  • refreshSessionRepository: Repository<CookieAuthRefreshSession, CookieAuthRefreshSessionCreateData>
  • userService: UserServiceInterface
  • csrfTokenHeader: string
  • sessionOptions: OmitStrict<CookieOptions, "maxAge" | "expires">
  • refreshSessionOptions: OmitStrict<CookieOptions, "maxAge" | "expires">
  • sessionExpiresInMs: number
  • refreshSessionExpiresInMs: number
  • passwordResetTokenExpiresInMs: number
  • passwordResetTokenRepository: Repository<PasswordResetToken>
  • credentialsRepository: Repository<CookieAuthCredentials>
  • emailService: EmailServiceInterface
  • hashService: HashServiceInterface
  • secret: string | undefined

  Returns CookieAuthStrategy<RoleType, UserType>

Readonlyname

ReadonlysecurityScheme

belongsTo

• belongsTo<TargetEntity extends Newable<BaseEntity>>(
      context: HttpRequestContext | WebsocketRequestContext,
      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

  • context: HttpRequestContext | WebsocketRequestContext
  • targetEntity: TargetEntity
  • targetUserIdKey: keyof InstanceType<TargetEntity>
  • targetIdParamKey: string

  Returns Promise<boolean>

confirmPasswordReset

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

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

  Parameters

  • data: CookieAuthConfirmPasswordResetData

  Returns Promise<void>

hasRole

• hasRole(
      context: HttpRequestContext | WebsocketRequestContext,
      allowedRoles: RoleType[],
  ): Promise<boolean>

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

  Parameters

  • context: HttpRequestContext | WebsocketRequestContext
  • allowedRoles: RoleType[]

  Returns Promise<boolean>

init

• init(app: ZibriApplication): void

  Initializes the auth strategy.

  Parameters

  • app: ZibriApplication

  Returns void

isLoggedIn

• isLoggedIn(
      context: HttpRequestContext | WebsocketRequestContext,
  ): Promise<boolean>

  Checks whether a user is currently logged in.

  Parameters

  • context: HttpRequestContext | WebsocketRequestContext

  Returns Promise<boolean>

login

• login(credentials: CookieAuthCredentialsData): Promise<CookieAuthData<RoleType>>

  Logs in a user.

  Parameters

  • credentials: CookieAuthCredentialsData

  Returns Promise<CookieAuthData<RoleType>>

logout

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

  Logs out the current user.

  Parameters

  • data: CookieAuthLogoutData

  Returns Promise<void>

refreshLogin

• refreshLogin(
      data: CookieAuthRefreshLoginData,
  ): Promise<CookieAuthData<RoleType>>

  Refreshes the login of a user.

  Parameters

  • data: CookieAuthRefreshLoginData

  Returns Promise<CookieAuthData<RoleType>>

requestPasswordReset

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

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

  Parameters

  • data: CookieAuthRequestPasswordResetData<RoleType, UserType>

  Returns Promise<void>

resolveUser

• resolveUser(
      context: HttpRequestContext | WebsocketRequestContext,
  ): Promise<UserType | undefined>

  Resolves the current user.

  Parameters

  • context: HttpRequestContext | WebsocketRequestContext

  Returns Promise<UserType | undefined>