Class AuthService

constructor

• new AuthService(): AuthService

  Returns AuthService

Readonlystrategies

belongsTo

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

  Checks whether the currently logged in user belongs to the target entity.

  Type Parameters

  • TargetEntity extends Newable<BaseEntity>

  Parameters

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

  Returns Promise<boolean>

checkAccess

• checkAccess(
      controllerClass: Newable<unknown>,
      controllerMethod: string,
      request: HttpRequest | WebsocketRequest,
  ): Promise<void>

  Checks if the provided method on the provided controller can be accessed by the current user.

  Parameters

  • controllerClass: Newable<unknown>
  • controllerMethod: string
  • request: HttpRequest | WebsocketRequest

  Returns Promise<void>

confirmPasswordReset

• confirmPasswordReset<
      Role extends string,
      UserType extends BaseUser<Role>,
      AuthDataType,
      CredentialsType,
      RequestPasswordResetDataType,
      ConfirmPasswordResetDataType,
      RefreshLoginDataType,
      LogoutDataType,
  >(
      strategy: Newable<
          AuthStrategyInterface<
              Role,
              UserType,
              AuthDataType,
              CredentialsType,
              RequestPasswordResetDataType,
              ConfirmPasswordResetDataType,
              RefreshLoginDataType,
              LogoutDataType,
          >,
      >,
      data: ConfirmPasswordResetDataType,
  ): Promise<void>

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

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • AuthDataType
  • CredentialsType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • RefreshLoginDataType
  • LogoutDataType

  Parameters

  • strategy: Newable<
        AuthStrategyInterface<
            Role,
            UserType,
            AuthDataType,
            CredentialsType,
            RequestPasswordResetDataType,
            ConfirmPasswordResetDataType,
            RefreshLoginDataType,
            LogoutDataType,
        >,
    >
  • data: ConfirmPasswordResetDataType

  Returns Promise<void>

getCurrentUser

• getCurrentUser<
      Role extends string,
      UserType extends BaseUser<Role>,
      B extends boolean = true,
  >(
      request: HttpRequest | WebsocketRequest,
      allowedStrategies: AuthStrategies,
      required: B,
  ): Promise<B extends false ? undefined | UserType : UserType>

  Get's the currently logged in user. When required is set to false this can return undefined.

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • B extends boolean = true

  Parameters

  • request: HttpRequest | WebsocketRequest
  • allowedStrategies: AuthStrategies
  • required: B

  Returns Promise<B extends false ? undefined | UserType : UserType>

hasRole

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

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

  Parameters

  • request: HttpRequest | WebsocketRequest
  • allowedStrategies: AuthStrategies
  • allowedRoles: string[]

  Returns Promise<boolean>

init

• init(authStrategies: AuthStrategies): Promise<void>

  Initializes the service.

  Parameters

  • authStrategies: AuthStrategies

  Returns Promise<void>

isLoggedIn

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

  Checks whether there is a currently logged in user.

  Parameters

  • request: HttpRequest | WebsocketRequest
  • allowedStrategies: AuthStrategies

  Returns Promise<boolean>

login

• login<
      Role extends string,
      UserType extends BaseUser<Role>,
      AuthDataType,
      CredentialsType,
      RequestPasswordResetDataType,
      ConfirmPasswordResetDataType,
      RefreshLoginDataType,
      LogoutDataType,
  >(
      strategy: Newable<
          AuthStrategyInterface<
              Role,
              UserType,
              AuthDataType,
              CredentialsType,
              RequestPasswordResetDataType,
              ConfirmPasswordResetDataType,
              RefreshLoginDataType,
              LogoutDataType,
          >,
      >,
      credentials: CredentialsType,
  ): Promise<AuthDataType>

  Logs in a user using the provided auth strategy and credentials.

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • AuthDataType
  • CredentialsType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • RefreshLoginDataType
  • LogoutDataType

  Parameters

  • strategy: Newable<
        AuthStrategyInterface<
            Role,
            UserType,
            AuthDataType,
            CredentialsType,
            RequestPasswordResetDataType,
            ConfirmPasswordResetDataType,
            RefreshLoginDataType,
            LogoutDataType,
        >,
    >
  • credentials: CredentialsType

  Returns Promise<AuthDataType>

logout

• logout<
      Role extends string,
      UserType extends BaseUser<Role>,
      RefreshLoginDataType,
      AuthDataType,
      CredentialsType,
      RequestPasswordResetDataType,
      ConfirmPasswordResetDataType,
      LogoutDataType,
  >(
      strategy: Newable<
          AuthStrategyInterface<
              Role,
              UserType,
              AuthDataType,
              CredentialsType,
              RequestPasswordResetDataType,
              ConfirmPasswordResetDataType,
              RefreshLoginDataType,
              LogoutDataType,
          >,
      >,
      data: LogoutDataType,
  ): Promise<void>

  Logs out the current user.

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • RefreshLoginDataType
  • AuthDataType
  • CredentialsType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • LogoutDataType

  Parameters

  • strategy: Newable<
        AuthStrategyInterface<
            Role,
            UserType,
            AuthDataType,
            CredentialsType,
            RequestPasswordResetDataType,
            ConfirmPasswordResetDataType,
            RefreshLoginDataType,
            LogoutDataType,
        >,
    >
  • data: LogoutDataType

  Returns Promise<void>

refreshLogin

• refreshLogin<
      Role extends string,
      UserType extends BaseUser<Role>,
      RefreshLoginDataType,
      AuthDataType,
      CredentialsType,
      RequestPasswordResetDataType,
      ConfirmPasswordResetDataType,
      LogoutDataType,
  >(
      strategy: Newable<
          AuthStrategyInterface<
              Role,
              UserType,
              AuthDataType,
              CredentialsType,
              RequestPasswordResetDataType,
              ConfirmPasswordResetDataType,
              RefreshLoginDataType,
              LogoutDataType,
          >,
      >,
      data: RefreshLoginDataType,
  ): Promise<AuthDataType>

  Refreshes the login of a user using the provided auth strategy and refresh login data.

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • RefreshLoginDataType
  • AuthDataType
  • CredentialsType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • LogoutDataType

  Parameters

  • strategy: Newable<
        AuthStrategyInterface<
            Role,
            UserType,
            AuthDataType,
            CredentialsType,
            RequestPasswordResetDataType,
            ConfirmPasswordResetDataType,
            RefreshLoginDataType,
            LogoutDataType,
        >,
    >
  • data: RefreshLoginDataType

  Returns Promise<AuthDataType>

requestPasswordReset

• requestPasswordReset<
      Role extends string,
      UserType extends BaseUser<Role>,
      AuthDataType,
      CredentialsType,
      RequestPasswordResetDataType,
      ConfirmPasswordResetDataType,
      RefreshLoginDataType,
      LogoutDataType,
  >(
      strategy: Newable<
          AuthStrategyInterface<
              Role,
              UserType,
              AuthDataType,
              CredentialsType,
              RequestPasswordResetDataType,
              ConfirmPasswordResetDataType,
              RefreshLoginDataType,
              LogoutDataType,
          >,
      >,
      data: RequestPasswordResetDataType,
  ): Promise<void>

  Request a new password for a user using the provided auth strategy and request password reset data.

  Type Parameters

  • Role extends string
  • UserType extends BaseUser<Role>
  • AuthDataType
  • CredentialsType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • RefreshLoginDataType
  • LogoutDataType

  Parameters

  • strategy: Newable<
        AuthStrategyInterface<
            Role,
            UserType,
            AuthDataType,
            CredentialsType,
            RequestPasswordResetDataType,
            ConfirmPasswordResetDataType,
            RefreshLoginDataType,
            LogoutDataType,
        >,
    >
  • data: RequestPasswordResetDataType

  Returns Promise<void>

resolveBelongsToMetadata

• resolveBelongsToMetadata(
      controllerClass: Newable<unknown>,
      controllerMethod: string,
  ): Promise<undefined | BelongsToMetadata<Newable<BaseEntity>>>

  Resolves the belongs to metadata for the provided controller method. (Whether it's required for the user to somehow belong to the requested entity, etc.).

  Parameters

  • controllerClass: Newable<unknown>
  • controllerMethod: string

  Returns Promise<undefined | BelongsToMetadata<Newable<BaseEntity>>>

resolveHasRoleMetadata

• resolveHasRoleMetadata(
      controllerClass: Newable<unknown>,
      controllerMethod: string,
  ): Promise<undefined | HasRoleMetadata>

  Resolves the has role metadata for the provided controller method. (Whether it's required for the user to have a certain role etc.).

  Parameters

  • controllerClass: Newable<unknown>
  • controllerMethod: string

  Returns Promise<undefined | HasRoleMetadata>

resolveIsLoggedInMetadata

• resolveIsLoggedInMetadata(
      controllerClass: Newable<unknown>,
      controllerMethod: string,
  ): Promise<undefined | IsLoggedInMetadata>

  Resolves the is logged in metadata for the provided controller method. (Whether it's required to be logged in, etc.).

  Parameters

  • controllerClass: Newable<unknown>
  • controllerMethod: string

  Returns Promise<undefined | IsLoggedInMetadata>

resolveIsNotLoggedInMetadata

• resolveIsNotLoggedInMetadata(
      controllerClass: Newable<unknown>,
      controllerMethod: string,
  ): Promise<undefined | IsNotLoggedInMetadata>

  Resolves the is not logged in metadata for the provided controller method. (Whether it's required to be logged out, etc.).

  Parameters

  • controllerClass: Newable<unknown>
  • controllerMethod: string

  Returns Promise<undefined | IsNotLoggedInMetadata>