Update email address

This page uses the JavaScript SDK.

Create a new email update request, send the verification code to the user's inbox, and link the update request to the current session.

// Everything not imported is something you need to define yourself.
import { verifyEmailInput, FaroeError } from "@faroe/sdk";

import type { FaroeEmailUpdateRequest } from "@faroe/sdk";

async function handleSendEmailUpdateVerificationCodeRequest(
    request: HTTPRequest,
    response: HTTPResponse
): Promise<void> {
    const clientIP = request.headers.get("X-Forwarded-For");

    const { session, user } = await validateRequest(request);
    if (session === null) {
        response.writeHeader(401);
        response.write("Not authenticated.");
        return;
    }

    let email: string;

    // ...

    // Normalize input.
	email = email.toLowerCase();

    if (!verifyEmailInput(email)) {
        response.writeHeader(400);
        response.write("Please enter a valid email address.");
        return;
    }

    const user = await getUserFromEmail(email);
    if (user !== null) {
        response.writeHeader(400);
        response.write("This email address is already used.");
        return;
    }

    let emailUpdateRequest: FaroeEmailUpdateRequest;
    try {
        emailUpdateRequest = await faroe.createUserEmailUpdateRequest(
            user.faroeId,
            faroeUser.email
        );
    } catch (e) {
        if (e instanceof FaroeError && e.code === "TOO_MANY_REQUESTS") {
            response.writeHeader(429);
            response.write("Please try again later.");
            return;
        }
        response.writeHeader(500);
        response.write("An unknown error occurred. Please try again later.");
        return;
    }

    // Send verification code to user's inbox.
    const emailContent = `Your verification code is ${emailUpdateRequest.code}.`;
    await sendEmail(faroeUser.email, emailContent);

    // Link the verification request to the current session.
    await setSessionEmailUpdateRequestId(session.id, emailUpdateRequest.id);

    // ...

}

Verify the code with Faroe.verifyNewUserEmail() and update your application's user's email address.

// Everything not imported is something you need to define yourself.
import { FaroeError } from "@faroe/sdk";

async function handleUpdateEmailRequest(
    request: HTTPRequest,
    response: HTTPResponse
): Promise<void> {
    const clientIP = request.headers.get("X-Forwarded-For");

    const { session, user } = await validateRequest(request);
    if (session === null) {
        response.writeHeader(401);
        response.write("Not authenticated.");
        return;
    }

    if (session.faroeEmailUpdateRequestId === null) {
        response.writeHeader(403);
        response.write("Not allowed.");
        return;
    }

    let code: string;

    // ...

    let newEmail: string
    try {
        newEmail = await faroe.verifyNewUserEmail(
            session.faroeEmailUpdateRequestId,
            code
        );
    } catch (e) {
        if (e instanceof FaroeError && e.code === "INVALID_REQUEST") {
            response.writeHeader(400);
            response.write("Please restart the process.");
            return;
        }
        if (e instanceof FaroeError && e.code === "INCORRECT_CODE") {
            response.writeHeader(400);
            response.write("Incorrect code.");
            return;
        }
        if (e instanceof FaroeError && e.code === "TOO_MANY_REQUESTS") {
            response.writeHeader(400);
            response.write("Please try again later.");
            return;
        }
        response.writeHeader(500);
        response.write("An unknown error occurred. Please try again later.");
        return;
    }

    await updateUserEmailAndSetEmailAsVerified(session.userId, newEmail);

    await deleteSessionEmailUpdateRequestId(session.id);

    // ...

}