RocketChat/Rocket.Chat

import type { IUser } from '@rocket.chat/core-typings';

export interface IProcessInvalidCodeResult {
    codeGenerated: boolean;
    codeExpires?: Date;
    emailOrUsername?: string;
}

export interface ICodeCheck {
    readonly name: string;

    isEnabled(user: IUser, force?: boolean): boolean;

    verify(user: IUser, code: string, force?: boolean): Promise<boolean>;

    processInvalidCode(user: IUser): Promise<IProcessInvalidCodeResult>;

    maxFaildedAttemtpsReached(user: IUser): Promise<boolean>;
}