Class ForgotPasswordHandler

Handles the submission of the ForgotPassword form

Hierarchy

InteractionHandler
- ForgotPasswordHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ForgotPasswordHandler(args: ForgotPasswordHandlerArgs): ForgotPasswordHandler

Overrides InteractionHandler.constructor
- Defined in src/identity/interaction/email-password/handler/ForgotPasswordHandler.ts:31
Parameters
- args: ForgotPasswordHandlerArgs
Returns ForgotPasswordHandler

Properties

Private Readonly accountStore

accountStore: AccountStore

Private Readonly baseUrl

baseUrl: string

Private Readonly emailSender

emailSender: EmailSender

Private Readonly idpPath

idpPath: string

Protected Readonly logger

logger: Logger = ...

Private Readonly templateEngine

templateEngine: TemplateEngine<{ resetLink: string }>

Methods

canHandle

canHandle(__namedParameters: InteractionHandlerInput): Promise<void>

Inherited from InteractionHandler.canHandle
- Defined in src/identity/interaction/email-password/handler/InteractionHandler.ts:45
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- __namedParameters: InteractionHandlerInput
Returns Promise<void>

handle

handle(__namedParameters: InteractionHandlerInput): Promise<InteractionResponseResult<{ email: string }>>

Overrides InteractionHandler.handle
- Defined in src/identity/interaction/email-password/handler/ForgotPasswordHandler.ts:40
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- __namedParameters: InteractionHandlerInput
Returns Promise<InteractionResponseResult<{ email: string }>>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: InteractionHandlerInput): Promise<InteractionHandlerResult>

Inherited from InteractionHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: InteractionHandlerInput
  Input data that will be handled if it can be handled.
Returns Promise<InteractionHandlerResult>
A promise resolving if the input can be handled, rejecting with an Error if not.

Private resetPassword

resetPassword(email: string): Promise<void>

- Defined in src/identity/interaction/email-password/handler/ForgotPasswordHandler.ts:54
Generates a record to reset the password for the given email address and then mails it. In case there is no account, no error wil be thrown for privacy reasons. Instead nothing will happen instead.

Parameters
- email: string
Returns Promise<void>

Private sendResetMail

sendResetMail(recordId: string, email: string): Promise<void>

- Defined in src/identity/interaction/email-password/handler/ForgotPasswordHandler.ts:69
Generates the link necessary for resetting the password and mails it to the given email address.

Parameters
- recordId: string
- email: string
Returns Promise<void>