feat(user): add email verification recipe (#482)

packages/multi-tenant/src/supertokens/recipes/third-party-email-password/emailPasswordSignUpPost.ts

@@ -15,7 +15,7 @@ const emailPasswordSignUpPOST = (
       throw new Error("Should never come here");
     }
 
-    if (fastify.config.user.features?.signUp === false) {
+    if (fastify.config.user.features?.signUp?.enabled === false) {
       throw {
         name: "SIGN_UP_DISABLED",
         message: "SignUp feature is currently disabled",

packages/multi-tenant/src/supertokens/recipes/third-party-email-password/thirdPartySignInUp.ts

@@ -31,7 +31,7 @@ const thirdPartySignInUp = (
       input.userContext
     );
 
-    if (!thirdPartyUser && config.user.features?.signUp === false) {
+    if (!thirdPartyUser && config.user.features?.signUp?.enabled === false) {
       throw {
         name: "SIGN_UP_DISABLED",
         message: "SignUp feature is currently disabled",

packages/user/src/constants.ts

@@ -19,7 +19,11 @@ const ROUTE_ME = "/me";
 const ROUTE_USERS = "/users";
 const TABLE_USERS = "users";
 
+// Email verification
+const EMAIL_VERIFICATION_MODE = "REQUIRED";
+
 export {
+  EMAIL_VERIFICATION_MODE,
   INVITATION_ACCEPT_PATH,
   INVITATION_EXPIRE_AFTER_IN_DAYS,
   RESET_PASSWORD_PATH,

packages/user/src/index.ts

@@ -34,7 +34,16 @@ declare module "@dzangolab/fastify-config" {
         name?: string;
       };
       features?: {
-        signUp?: boolean;
+        signUp?: {
+          /**
+           * @default true
+           */
+          enabled?: boolean;
+          /**
+           * @default false
+           */
+          emailVerification?: boolean;
+        };
       };
       role?: string;
     };
@@ -60,7 +69,10 @@ export { default as validatePassword } from "./validator/password";
 
 export * from "./constants";
 
-export type { ThirdPartyEmailPasswordRecipe } from "./supertokens/types";
+export type {
+  EmailVerificationRecipe,
+  ThirdPartyEmailPasswordRecipe,
+} from "./supertokens/types";
 export type {
   AuthUser,
   ChangePasswordInput,

packages/user/src/supertokens/recipes/config/email-verification/sendEmailVerificationEmail.ts

@@ -0,0 +1,41 @@
+import emailVerification from "supertokens-node/recipe/emailverification";
+
+import getOrigin from "../../../../lib/getOrigin";
+import sendEmail from "../../../../lib/sendEmail";
+
+import type { FastifyInstance, FastifyRequest } from "fastify";
+import type { EmailDeliveryInterface } from "supertokens-node/lib/build/ingredients/emaildelivery/types";
+import type { TypeEmailVerificationEmailDeliveryInput } from "supertokens-node/recipe/emailverification/types";
+
+const sendEmailVerificationEmail = (
+  originalImplementation: EmailDeliveryInterface<TypeEmailVerificationEmailDeliveryInput>,
+  fastify: FastifyInstance
+): typeof emailVerification.sendEmail => {
+  const websiteDomain = fastify.config.appOrigin[0] as string;
+
+  return async (input) => {
+    const request: FastifyRequest = input.userContext._default.request.request;
+
+    const url =
+      request.headers.referer || request.headers.origin || request.hostname;
+
+    const origin = getOrigin(url) || websiteDomain;
+
+    const emailVerifyLink = input.emailVerifyLink.replace(
+      websiteDomain,
+      origin
+    );
+
+    sendEmail({
+      fastify,
+      subject: "Email Verification",
+      templateName: "email-verification",
+      to: input.user.email,
+      templateData: {
+        emailVerifyLink,
+      },
+    });
+  };
+};
+
+export default sendEmailVerificationEmail;

packages/user/src/supertokens/recipes/config/emailVerificationRecipeConfig.ts

@@ -0,0 +1,43 @@
+import sendEmailVerificationEmail from "./email-verification/sendEmailVerificationEmail";
+import { EMAIL_VERIFICATION_MODE } from "../../../constants";
+
+import type {
+  EmailVerificationSendEmailWrapper as SendEmailWrapper,
+  EmailVerificationRecipe,
+} from "../../types";
+import type { FastifyInstance } from "fastify";
+import type { TypeInput as EmailVerificationRecipeConfig } from "supertokens-node/recipe/emailverification/types";
+
+const getEmailVerificationRecipeConfig = (
+  fastify: FastifyInstance
+): EmailVerificationRecipeConfig => {
+  const { config } = fastify;
+
+  let emailVerification: EmailVerificationRecipe = {};
+
+  if (typeof config.user.supertokens.recipes?.emailVerification === "object") {
+    emailVerification = config.user.supertokens.recipes.emailVerification;
+  }
+
+  return {
+    mode: emailVerification?.mode || EMAIL_VERIFICATION_MODE,
+    emailDelivery: {
+      override: (originalImplementation) => {
+        let sendEmailConfig: SendEmailWrapper | undefined;
+
+        if (emailVerification?.sendEmail) {
+          sendEmailConfig = emailVerification.sendEmail;
+        }
+
+        return {
+          ...originalImplementation,
+          sendEmail: sendEmailConfig
+            ? sendEmailConfig(originalImplementation, fastify)
+            : sendEmailVerificationEmail(originalImplementation, fastify),
+        };
+      },
+    },
+  };
+};
+
+export default getEmailVerificationRecipeConfig;

packages/user/src/supertokens/recipes/config/third-party-email-password/emailPasswordSignUpPost.ts

@@ -14,7 +14,7 @@ const emailPasswordSignUpPOST = (
       throw new Error("Should never come here");
     }
 
-    if (fastify.config.user.features?.signUp === false) {
+    if (fastify.config.user.features?.signUp?.enabled === false) {
       throw {
         name: "SIGN_UP_DISABLED",
         message: "SignUp feature is currently disabled",

packages/user/src/supertokens/recipes/config/third-party-email-password/thirdPartySignInUp.ts

@@ -22,7 +22,7 @@ const thirdPartySignInUp = (
       input.userContext
     );
 
-    if (!thirdPartyUser && config.user.features?.signUp === false) {
+    if (!thirdPartyUser && config.user.features?.signUp?.enabled === false) {
       throw {
         name: "SIGN_UP_DISABLED",
         message: "SignUp feature is currently disabled",

packages/user/src/supertokens/recipes/index.ts

@@ -1,3 +1,4 @@
+import initEmailVerificationRecipe from "./initEmailVerificationRecipe";
 import initSessionRecipe from "./initSessionRecipe";
 import initThirdPartyEmailPassword from "./initThirdPartyEmailPasswordRecipe";
 import initUserRolesRecipe from "./initUserRolesRecipe";
@@ -12,6 +13,10 @@ const getRecipeList = (fastify: FastifyInstance): RecipeListFunction[] => {
     initUserRolesRecipe(fastify),
   ];
 
+  if (fastify.config.user.features?.signUp?.emailVerification) {
+    recipeList.push(initEmailVerificationRecipe(fastify));
+  }
+
   return recipeList;
 };
 

packages/user/src/supertokens/recipes/initEmailVerificationRecipe.ts

@@ -0,0 +1,19 @@
+import EmailVerification from "supertokens-node/recipe/emailverification";
+
+import getEmailVerificationRecipeConfig from "./config/emailVerificationRecipeConfig";
+
+import type { SupertokensRecipes } from "../types";
+import type { FastifyInstance } from "fastify";
+
+const init = (fastify: FastifyInstance) => {
+  const emailVerification: SupertokensRecipes["emailVerification"] =
+    fastify.config.user.supertokens.recipes?.emailVerification;
+
+  if (typeof emailVerification === "function") {
+    return EmailVerification.init(emailVerification(fastify));
+  }
+
+  return EmailVerification.init(getEmailVerificationRecipeConfig(fastify));
+};
+
+export default init;

packages/user/src/supertokens/types.ts

@@ -1,8 +1,13 @@
+import EmailVerification from "supertokens-node/recipe/emailverification";
 import ThirdPartyEmailPassword from "supertokens-node/recipe/thirdpartyemailpassword";
 
 import type { FastifyInstance } from "fastify";
 import type { EmailDeliveryInterface } from "supertokens-node/lib/build/ingredients/emaildelivery/types";
 import type { TypeEmailPasswordPasswordResetEmailDeliveryInput } from "supertokens-node/lib/build/recipe/emailpassword/types";
+import type {
+  TypeInput as EmailVerificationRecipeConfig,
+  TypeEmailVerificationEmailDeliveryInput,
+} from "supertokens-node/recipe/emailverification/types";
 import type { TypeInput as SessionRecipeConfig } from "supertokens-node/recipe/session/types";
 import type {
   TypeInput as ThirdPartyEmailPasswordRecipeConfig,
@@ -26,6 +31,11 @@ type SendEmailWrapper = (
   fastify: FastifyInstance
 ) => typeof ThirdPartyEmailPassword.sendEmail;
 
+type EmailVerificationSendEmailWrapper = (
+  originalImplementation: EmailDeliveryInterface<TypeEmailVerificationEmailDeliveryInput>,
+  fastify: FastifyInstance
+) => typeof EmailVerification.sendEmail;
+
 type RecipeInterfaceWrapper = {
   [key in keyof RecipeInterface]?: (
     originalImplementation: RecipeInterface,
@@ -34,6 +44,9 @@ type RecipeInterfaceWrapper = {
 };
 
 interface SupertokensRecipes {
+  emailVerification?:
+    | EmailVerificationRecipe
+    | ((fastify: FastifyInstance) => EmailVerificationRecipeConfig);
   session?: (fastify: FastifyInstance) => SessionRecipeConfig;
   userRoles?: (fastify: FastifyInstance) => UserRolesRecipeConfig;
   thirdPartyEmailPassword?:
@@ -48,6 +61,11 @@ interface SupertokensThirdPartyProvider {
   google?: Parameters<typeof Google>[0];
 }
 
+interface EmailVerificationRecipe {
+  mode?: "REQUIRED" | "OPTIONAL";
+  sendEmail?: EmailVerificationSendEmailWrapper;
+}
+
 interface ThirdPartyEmailPasswordRecipe {
   override?: {
     apis?: APIInterfaceWrapper;
@@ -67,6 +85,8 @@ interface SupertokensConfig {
 
 export type {
   APIInterfaceWrapper,
+  EmailVerificationRecipe,
+  EmailVerificationSendEmailWrapper,
   RecipeInterfaceWrapper,
   SendEmailWrapper,
   SupertokensConfig,

packages/user/vite.config.ts

@@ -39,6 +39,7 @@ export default defineConfig(({ mode }) => {
             slonik: "Slonik",
             "supertokens-node": "SupertokensNode",
             "supertokens-node/framework/fastify": "SupertokensFastify",
+            "supertokens-node/recipe/emailverification": "EmailVerification",
             "supertokens-node/recipe/session/framework/fastify":
               "SupertokensSessionFastify",
             "supertokens-node/recipe/session": "SupertokensSession",