Hackkit Basic Email Support

.env.example

@@ -1,15 +1,3 @@
-# AWS_ACCESS_KEY_ID="43242s387fg44638s244fh24"
-# AWS_REGION="us-east-2"
-# AWS_S3_BUCKET="hackathon-backups"
-# AWS_S3_ENDPOINT="https://dfh7346398578dhgsds.r2.cloudflarestorage.com"
-# AWS_S3_REGION="auto"
-# AWS_SECRET_ACCESS_KEY="4258722gyrgejw78gfg2u20974fhihdfs02"
-# AWS_SES_ACCESS_KEY="ADEIAFHJ3HKFU48FHJK"
-# AWS_SES_EMAIL_FROM="no-reply@[your_organization].org"
-# AWS_SES_SECRET_ACCESS_KEY="AfBHKrDFh/Q03u+37iyGrwjFJ"
-# BACKUP_CRON_SCHEDULE="0 */6 * * *"
-# BACKUP_DATABASE_URL="postgres://default:RtN4q5qefsTO@ui-painted-hills-e5ddlb.us-east-2.aws.neon.tech:4576/verceldb?sslmode=require"
-# BLOB_READ_WRITE_TOKEN="vercel_blob_rw_fhb9DH2kOEIO3EOI_3dBKKFHBGDLNSjnjDOIJHF"
 BOT_API_URL="https://hackkit-actions-bots.up.railway.app"
 CLERK_SECRET_KEY="sk_test_AFNJKABF2uhkbDBUKAFAKBAHBj3r"
 CLOUDFLARE_ACCOUNT_ID="cdcdJB3453KKJFBDSBHA54546UIBF"
@@ -24,20 +12,16 @@ INTERNAL_AUTH_KEY="bwgybgidbsi-4784gyfgs-475hhkdsbfs-bwgybgidbsi-4784gyfgs-475hh
 NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_YRGIBHSBIbabffjdhvbuYGI7BK"
 NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
 NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"
-# PLUNK_API_KEY="sk_279y482gibfai7g74gikbga345"
-# PLUNK_API_URL="https://plunk.[your_org_name].org/api/[version_number]"
-# POSTGRES_DATABASE="verceldb"
-# POSTGRES_HOST="ep-rising-sky-adbkfahbeke-spooler.us-east-2.aws.neon.tech"
-# POSTGRES_PASSWORD="dkhjbIYBFABUI"
-# POSTGRES_PRISMA_URL="postgres://default:dkhjbIYBFABUI@ep-rising-pfahbeke-spooler.us-east-2.aws.neon.tech/verceldb?pgbouncer=true&connect_timeout=15&sslmode=require"
-# POSTGRES_URL="postgres://default:dkhjbIYBFABUI@ep-rising-sky-adbkfahbeke-spooler.us-east-2.aws.neon.tech/verceldb?sslmode=require"
-# POSTGRES_URL_NO_SSL="postgres://default:dkhjbIYBFABUI@ep-rising-sky-adbkfahbeke-spooler.us-east-2.aws.neon.tech/verceldb"
-# POSTGRES_URL_NON_POOLING="postgres://default:dkhjbIYBFABUI@ep-rising-sky-adbkfahbeke-spooler.us-east-2.aws.neon.tech/verceldb?sslmode=require"
-# POSTGRES_USER="default"
 R2_ACCESS_KEY_ID="1bfkhbfyiayi38uhidfis"
 R2_BUCKET_NAME="your-org-name-userdata"
 R2_SECRET_ACCESS_KEY="279y45g79tgbjsbfhbsiufhbs89hg487hsiufs"
 TURSO_AUTH_TOKEN="dhbBDSUGFBSUYGBSIUGRBIGBSIYBS7495w8y97w.bivsb7478wGYIFGDSUGFS48y39975y3gtyugysjgs7ugu.BHFBSYUFBSV476guysfuw78gfuy3buybfshbfYUFSGVBYFIBVEIUSBVJSBANIBA74y597bvs6gfusg&gsyjgbfshgbyIGBYUS"
 TURSO_DATABASE_URL="libsql:hackkit-orgname.turso.io"
 UPSTASH_REDIS_REST_TOKEN="BKFSHBSIY7g9347385gBJFDBSJYFGBSIYFUSIBISUYHGOSHIYtusvufdbsfiubfsibYBG"
 UPSTASH_REDIS_REST_URL="https://giant-worm-78102.upstash.io"
+
+SMTP_HOST="mailserver.hackkit.org"
+SMTP_PORT="25"
+SMTP_SECURE="true"
+SMTP_USER="user"
+SMTP_PASS="password"

apps/web/package.json

@@ -41,6 +41,7 @@
     "db": "workspace:*",
     "drizzle-orm": "^0.39.3",
     "drizzle-zod": "^0.7.0",
+    "email": "workspace:*",
     "embla-carousel": "8.1.7",
     "embla-carousel-react": "8.1.7",
     "lucide-react": "^0.411.0",

apps/web/src/actions/email.ts

@@ -0,0 +1,44 @@
+"use server";
+
+import { adminAction } from "@/lib/safe-action";
+import { z } from "zod";
+import { userHasPermission } from "@/lib/utils/server/admin";
+import { PermissionType } from "@/lib/constants/permission";
+import { db, sql } from "db";
+import { userCommonData } from "db/schema";
+import { sendExampleEmail } from "@/lib/utils/server/email";
+
+export const sendExampleEmailAction = adminAction
+	.schema(z.object({ sendTo: z.enum(["all", "rsvpdOnly", "notRsvpdOnly"]) }))
+	.outputSchema(
+		z.object({ success: z.boolean(), error: z.string().optional() }),
+	)
+	.action(async ({ parsedInput: { sendTo }, ctx: { user } }) => {
+		if (!userHasPermission(user, PermissionType.SEND_EMAILS)) {
+			return {
+				success: false,
+				error: "You do not have permission to send emails.",
+			};
+		}
+
+		let emails = await db
+			.select({ email: userCommonData.email })
+			.from(userCommonData)
+			.where(
+				sendTo == "rsvpdOnly"
+					? sql`${userCommonData.isRSVPed} = 1`
+					: sendTo == "notRsvpdOnly"
+						? sql`${userCommonData.isRSVPed} = 0`
+						: sql`${userCommonData.isRSVPed} = 1`,
+			);
+
+		try {
+			await Promise.all(
+				emails.map(({ email }) => sendExampleEmail(email)),
+			);
+		} catch (e) {
+			console.error(e);
+			return { success: false, error: e as string };
+		}
+		return { success: true };
+	});

apps/web/src/actions/registration.ts

@@ -13,6 +13,7 @@ import {
 	UNIQUE_KEY_CONSTRAINT_VIOLATION_CODE,
 	UNIQUE_KEY_MAPPER_DEFAULT_KEY,
 } from "@/lib/constants";
+import { sendRegistrationSuccessEmail } from "@/lib/utils/server/email";
 
 const registerUserSchema = hackerRegistrationFormValidator;
 
@@ -110,6 +111,19 @@ export const registerHacker = authenticatedAction
 			}
 		}
 
+		if (c.featureFlags.extra.emailService) {
+			await sendRegistrationSuccessEmail(email, {
+				firstName: userData.firstName,
+				lastName: userData.lastName,
+				hackerTag: userCommonData.hackerTag,
+				email,
+			});
+		} else {
+			console.log(
+				"Registration successful! Email service not enabled, so no confirmation email was sent.",
+			);
+		}
+
 		return {
 			success: true,
 			message: "Registration created successfully",

apps/web/src/actions/rsvp.ts

@@ -7,17 +7,21 @@ import { eq } from "db/drizzle";
 import { userCommonData } from "db/schema";
 import { getUser } from "db/functions";
 import { returnValidationErrors } from "next-safe-action";
+import { sendRSVPConfirmationEmail } from "@/lib/utils/server/email";
 
 export const rsvpMyself = authenticatedAction.action(
 	async ({ ctx: { userId } }) => {
 		const user = await getUser(userId);
 		if (!user)
 			returnValidationErrors(z.null(), { _errors: ["User not found"] });
 
-		await db
+		const [{ email }] = await db
 			.update(userCommonData)
 			.set({ isRSVPed: true })
-			.where(eq(userCommonData.clerkID, userId));
+			.where(eq(userCommonData.clerkID, userId))
+			.returning({ email: userCommonData.email });
+
+		await sendRSVPConfirmationEmail(email);
 		return { success: true };
 	},
 );

apps/web/src/app/admin/emails/SendExampleEmailForm.tsx

@@ -0,0 +1,61 @@
+"use client";
+
+import {
+	Select,
+	SelectContent,
+	SelectGroup,
+	SelectItem,
+	SelectTrigger,
+	SelectValue,
+	SelectLabel,
+} from "@/components/shadcn/ui/select";
+import { Label } from "@/components/shadcn/ui/label";
+import { Button } from "@/components/shadcn/ui/button";
+import { useAction } from "next-safe-action/hooks";
+import { sendExampleEmailAction } from "@/actions/email";
+import { toast } from "sonner";
+
+export default function SendExampleEmailForm() {
+	const { executeAsync } = useAction(sendExampleEmailAction);
+	async function handleSend() {
+		const res = await executeAsync({ sendTo: "all" });
+		if (res?.data?.success) {
+			toast.success("Emails sent successfully", {
+				position: "bottom-right",
+			});
+		} else {
+			toast.error(res?.data?.error ?? "Emails failed to send.", {
+				position: "bottom-right",
+			});
+		}
+	}
+	return (
+		<div className="flex w-full items-end justify-between">
+			<h3 className="text-xl font-bold">
+				Send Example Email (Don't use in production)
+			</h3>
+			<div className="flex items-end gap-2">
+				<div>
+					<Label className="text-nowrap">Send to</Label>
+					<Select defaultValue="all">
+						<SelectTrigger>
+							<SelectValue />
+						</SelectTrigger>
+						<SelectContent>
+							<SelectGroup>
+								<SelectItem value="all">All</SelectItem>
+								<SelectItem value="rsvpedOnly">
+									RSVP'd Users Only
+								</SelectItem>
+								<SelectItem value="notRsvpedOnly">
+									un-RSVP'd Users Only
+								</SelectItem>
+							</SelectGroup>
+						</SelectContent>
+					</Select>
+				</div>
+				<Button onClick={handleSend}>Send</Button>
+			</div>
+		</div>
+	);
+}

apps/web/src/app/admin/emails/page.tsx

@@ -0,0 +1,30 @@
+import { PermissionType } from "@/lib/constants/permission";
+import { userHasPermission } from "@/lib/utils/server/admin";
+import { getCurrentUser } from "@/lib/utils/server/user";
+import { notFound } from "next/navigation";
+
+import SendExampleEmailForm from "./SendExampleEmailForm";
+
+export default async function Page() {
+	const user = await getCurrentUser();
+
+	if (!userHasPermission(user, PermissionType.VIEW_EVENTS)) {
+		return notFound();
+	}
+
+	const isUserAuthorized = userHasPermission(
+		user,
+		PermissionType.SEND_EMAILS,
+	);
+
+	if (!isUserAuthorized) {
+		return notFound();
+	}
+
+	return (
+		<div className="mx-auto max-w-7xl px-5 pt-40">
+			<h2 className="text-3xl font-bold tracking-tight">Emails</h2>
+			<SendExampleEmailForm />
+		</div>
+	);
+}

apps/web/src/app/admin/layout.tsx

@@ -96,6 +96,11 @@ export default async function AdminLayout({ children }: AdminLayoutProps) {
 						!userHasPermission(user, PermissionType.MANAGE_NAVLINKS)
 					)
 						return null;
+					if (
+						name === "Emails" &&
+						!userHasPermission(user, PermissionType.SEND_EMAILS)
+					)
+						return null;
 					// Keep other configured admin paths visible by default
 					return <DashNavItem key={name} name={name} path={path} />;
 				})}

apps/web/src/env.ts

@@ -1,4 +1,5 @@
 import { createEnv } from "@t3-oss/env-nextjs";
+import c from "config";
 import { z } from "zod";
 
 export const env = createEnv({
@@ -18,6 +19,15 @@ export const env = createEnv({
 		TURSO_DATABASE_URL: z.string(),
 		UPSTASH_REDIS_REST_TOKEN: z.string(),
 		UPSTASH_REDIS_REST_URL: z.string(),
+		...(c.featureFlags.extra.emailService === "smtp" // makes smtp vars optional
+			? {
+					SMTP_HOST: z.string(),
+					SMTP_PORT: z.string(),
+					SMTP_SECURE: z.string(),
+					SMTP_USER: z.string(),
+					SMTP_PASS: z.string(),
+				}
+			: {}),
 	},
 	client: {
 		NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: z.string(),

apps/web/src/lib/constants/permission.ts

@@ -22,6 +22,8 @@ export enum PermissionType {
 	MANAGE_NAVLINKS = 1 << 14,
 	MANAGE_REGISTRATION = 1 << 15,
 
+	SEND_EMAILS = 1 << 16,
+
 	/* You can add new permissions following the pattern:
 		NEW_PERMISSION = 1 << n,
 	*/

apps/web/src/lib/utils/server/email.ts

@@ -0,0 +1,56 @@
+import c from "config";
+import { smtpSender, etherealSender } from "email";
+import RSVPConfirmationEmail from "email/templates/rsvp-confirmation";
+import RegistrationSuccessEmail from "email/templates/registration-confirmation";
+
+// const mailer = smtpSender({
+// 	host: process.env.SMTP_HOST,
+// 	port: Number(process.env.SMTP_PORT),
+// 	secure: process.env.SMTP_SECURE === "true",
+// 	auth: {
+// 		user: process.env.SMTP_USER,
+// 		pass: process.env.SMTP_PASS,
+// 	},
+// });
+
+// Testing mailer
+const mailer = etherealSender();
+
+export const sendRSVPConfirmationEmail = async (email: string, props?: any) => {
+	if (c.featureFlags.extra.emailService) {
+		await mailer.send({
+			from: "<[EMAIL_ADDRESS]>",
+			to: email,
+			subject: "RSVP Confirmation",
+			text: "You have been successfully RSVPed to the event!",
+			body: RSVPConfirmationEmail(props),
+		});
+	}
+};
+
+export const sendRegistrationSuccessEmail = async (
+	email: string,
+	props?: any,
+) => {
+	if (c.featureFlags.extra.emailService) {
+		await mailer.send({
+			from: "<[EMAIL_ADDRESS]>",
+			to: email,
+			subject: "Registration Confirmation",
+			text: "You have been successfully registered!",
+			body: RegistrationSuccessEmail(props),
+		});
+	}
+};
+
+export const sendExampleEmail = async (email: string) => {
+	if (c.featureFlags.extra.emailService) {
+		await mailer.send({
+			from: "<[EMAIL_ADDRESS]>",
+			to: email,
+			subject: "Example Email",
+			text: "This is an example email.",
+			body: "This is an example email.",
+		});
+	}
+};

packages/config/hackkit.config.ts

@@ -121,6 +121,7 @@ const c = {
 			Events: "/admin/events",
 			Roles: "/admin/roles",
 			Toggles: "/admin/toggles",
+			Emails: "/admin/emails",
 			"Hackathon Check-in": "/admin/check-in",
 		},
 	},
@@ -148,6 +149,9 @@ const c = {
 		core: {
 			requireUsersApproval: false,
 		},
+		extra: {
+			emailService: "ethereal" as "ethereal" | "smtp",
+		},
 	},
 } as const;
 

packages/email/index.ts

@@ -0,0 +1,4 @@
+import { smtpSender } from "./senders/smtp";
+import { etherealSender } from "./senders/ethereal";
+
+export { smtpSender, etherealSender };

packages/email/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "email",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "dev": "email dev --dir=templates",
+    "send-test": "ts-node ./send_test.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "main": "./index.ts",
+  "types": "./index.ts",
+  "private": true,
+  "devDependencies": {
+    "@react-email/preview-server": "5.2.9",
+    "@types/nodemailer": "^7.0.11",
+    "@types/react": "18.3.3",
+    "@types/react-dom": "18.3.0",
+    "react-email": "5.2.9",
+    "ts-node": "^10.9.2",
+    "typescript": "5.5.3"
+  },
+  "dependencies": {
+    "@react-email/components": "1.0.8",
+    "@react-email/render": "^2.0.4",
+    "nodemailer": "^8.0.2",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "config": "workspace:*"
+  }
+}