Module recipe/emailpassword

emailExistsGET: undefined | ((input: { email: string; options: APIOptions; userContext: any }) => Promise<{ exists: boolean; status: "OK" } | GeneralErrorResponse>)

generatePasswordResetTokenPOST: undefined | ((input: { formFields: { id: string; value: string }[]; options: APIOptions; userContext: any }) => Promise<{ status: "OK" } | GeneralErrorResponse>)

passwordResetPOST: undefined | ((input: { formFields: { id: string; value: string }[]; options: APIOptions; token: string; userContext: any }) => Promise<{ status: "OK"; userId?: string } | { status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | GeneralErrorResponse>)

signInPOST: undefined | ((input: { formFields: { id: string; value: string }[]; options: APIOptions; userContext: any }) => Promise<{ session: SessionContainer; status: "OK"; user: User } | { status: "WRONG_CREDENTIALS_ERROR" } | GeneralErrorResponse>)

signUpPOST: undefined | ((input: { formFields: { id: string; value: string }[]; options: APIOptions; userContext: any }) => Promise<{ session: SessionContainer; status: "OK"; user: User } | { status: "EMAIL_ALREADY_EXISTS_ERROR" } | GeneralErrorResponse>)

appInfo: NormalisedAppinfo

config: TypeNormalisedInput

emailDelivery: default<TypeEmailPasswordEmailDeliveryInput>

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

createResetPasswordToken:function

• createResetPasswordToken(input: { userContext: any; userId: string }): Promise<{ status: "OK"; token: string } | { status: "UNKNOWN_USER_ID_ERROR" }>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<{ status: "OK"; token: string } | { status: "UNKNOWN_USER_ID_ERROR" }>

getUserByEmail:function

• getUserByEmail(input: { email: string; userContext: any }): Promise<undefined | User>

• Parameters

  • input: { email: string; userContext: any }

    • email: string

    • userContext: any

  Returns Promise<undefined | User>

getUserById:function

• getUserById(input: { userContext: any; userId: string }): Promise<undefined | User>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<undefined | User>

resetPasswordUsingToken:function

• resetPasswordUsingToken(input: { newPassword: string; token: string; userContext: any }): Promise<{ status: "OK"; userId?: string } | { status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" }>

• Parameters

  • input: { newPassword: string; token: string; userContext: any }

    • newPassword: string

    • token: string

    • userContext: any

  Returns Promise<{ status: "OK"; userId?: string } | { status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" }>

signIn:function

• signIn(input: { email: string; password: string; userContext: any }): Promise<{ status: "OK"; user: User } | { status: "WRONG_CREDENTIALS_ERROR" }>

• Parameters

  • input: { email: string; password: string; userContext: any }

    • email: string

    • password: string

    • userContext: any

  Returns Promise<{ status: "OK"; user: User } | { status: "WRONG_CREDENTIALS_ERROR" }>

signUp:function

• signUp(input: { email: string; password: string; userContext: any }): Promise<{ status: "OK"; user: User } | { status: "EMAIL_ALREADY_EXISTS_ERROR" }>

• Parameters

  • input: { email: string; password: string; userContext: any }

    • email: string

    • password: string

    • userContext: any

  Returns Promise<{ status: "OK"; user: User } | { status: "EMAIL_ALREADY_EXISTS_ERROR" }>

updateEmailOrPassword:function

• updateEmailOrPassword(input: { email?: string; password?: string; userContext: any; userId: string }): Promise<{ status: "OK" | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR" }>

• Parameters

  • input: { email?: string; password?: string; userContext: any; userId: string }

    • Optional email?: string

    • Optional password?: string

    • userContext: any

    • userId: string

  Returns Promise<{ status: "OK" | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR" }>

email: string

id: string

timeJoined: number