codexmachina
registry/nuxt-mysql-clerk-newsletter

Newsletter platform on Nuxt 4, MySQL 8 and Clerk

verified 2026-07-15nuxt4.4.8mysql23.22.6postgres3.4.9@clerk/nuxt2.6.14@neondatabase/serverless1.1.0

Type-checked against the real SDKs, migration applied to a live MySQL 8, connection clients load-tested, then tracked for upstream drift and re-verified when it moves. How we verify

request path
Browserrequest
fetch
Nuxt 4routing + proxy
verify
Clerksession
query
MySQL 8pooled

session validation runs in server components and route handlers, not at the edge

What you're getting

Nuxt 4

Nuxt 4 (framework mode) — full-stack Vue SSR: client under app/ (Vite), server under server/ (Nitro), API as server/api/*.post.ts Nitro route handlers.

MySQL 8

MySQL 8 via Drizzle ORM and the mysql2 driver.

Clerk

Clerk — hosted identity (sign-in UI, sessions, user management) mounted via middleware + provider.

Newsletter platform

Audience-scoped newsletter platform — subscribers with deliverability status, named lists, list membership, campaigns scheduled against a list, and per-subscriber send tracking.

Setup

bun add nuxt vue drizzle-orm mysql2 @clerk/nextjs
DATABASE_URLMySQL connection string (mysql://…)
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
CLERK_SECRET_KEY
CLERK_WEBHOOK_SECRETsvix secret that verifies Clerk webhook signatures

Apply the schema with bunx drizzle-kit push

Initialization

Database client

server/lib/db.ts
import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

// ponytail: single module-level pool; the runtime + mysql2's pool handle concurrency,
// so no globalThis singleton dance needed.
const pool = mysql.createPool(process.env.DATABASE_URL!);

export const db = drizzle({ client: pool });
// Clerk on Nuxt 4 is a Nuxt MODULE: registering "@clerk/nuxt" auto-injects
// <ClerkProvider>, the Vue components (<SignIn/>, <UserButton/>), and a server plugin that
// attaches the Clerk Auth object to event.context.auth — no manual provider wiring.
// ponytail: Clerk is hosted — set NUXT_PUBLIC_CLERK_PUBLISHABLE_KEY (read client-side by the
// module) and NUXT_CLERK_SECRET_KEY (read server-side by clerkMiddleware) in the env; the
// module picks them up automatically, so nothing here references them.
// ponytail: Nuxt provides defineNuxtConfig as a global at runtime; import it explicitly from
// "nuxt/config" so this config type-checks under standalone tsc.
import { defineNuxtConfig } from "nuxt/config";

export default defineNuxtConfig({
  modules: ["@clerk/nuxt"],
});
// Clerk route protection as a Nitro server middleware — the Nuxt 4 analog of
// Next's clerkMiddleware proxy + auth.protect(). clerkMiddleware() wraps a handler that runs
// on every request with the Clerk Auth object on event.context.auth; here we guard the SaaS
// app surface and redirect signed-out users to the hosted sign-in.
// ponytail: Nuxt AUTO-IMPORTS the h3 helpers at runtime; we import getRequestURL + sendRedirect
// EXPLICITLY from h3 (Nitro's engine, a nuxt dep) so this type-checks under standalone tsc.
import { clerkMiddleware } from "@clerk/nuxt/server";
import { getRequestURL, sendRedirect, type H3Event } from "h3";

// ponytail: guard the SaaS app surface; widen the prefixes per app-type.
const PROTECTED_PREFIXES = ["/dashboard", "/settings"];

export default clerkMiddleware((event) => {
  // clerkMiddleware injects Clerk's Auth object on event.context.auth (see @clerk/nuxt module).
  const { isAuthenticated } = event.context.auth();
  // ponytail: @clerk/nuxt bundles its OWN h3 copy, so clerkMiddleware types `event` against that
  // copy; re-narrow to the top-level h3 H3Event (the SAME runtime object) so the explicitly
  // imported getRequestURL/sendRedirect type-check standalone — only the compiled d.ts differ.
  const h3Event = event as unknown as H3Event;
  const { pathname } = getRequestURL(h3Event);
  if (!isAuthenticated && PROTECTED_PREFIXES.some((prefix) => pathname.startsWith(prefix))) {
    return sendRedirect(h3Event, "/sign-in", 302);
  }
});

Newsletter schema: subscribers, lists, campaigns & per-subscriber sends

Subscribers & deliverability status

email addresses collected by an owner, with a status CHECK walking subscribed/unsubscribed/bounced

Lists & list_subscriptions membership

named audience segments and the join table that places a subscriber on a list at most once

Campaigns & scheduling

broadcasts targeting a list, with a status CHECK gating draft/scheduled/sent and a nullable scheduledAt timestamp

Campaign_sends & delivery tracking

one append-only row per (campaign, subscriber) tracking the queued→delivered→opened→bounced lifecycle

src/db/schema.ts
// === file: server/db/schema.ts ===
import { relations, sql } from "drizzle-orm";
import {
  check,
  index,
  mysqlTable,
  text,
  timestamp,
  unique,
  varchar,
} from "drizzle-orm/mysql-core";
// Better Auth owns identity; we only reference its `user` table by id.
import { user } from "./auth-schema";

export type SubscriberStatus = "subscribed" | "unsubscribed" | "bounced";
export type CampaignStatus = "draft" | "scheduled" | "sent";
export type CampaignSendStatus =
  | "queued"
  | "delivered"
  | "opened"
  | "bounced";

/** An email address on someone's audience. Owned by the user who collected it;
 *  status walks the deliverability lifecycle. The owner+email unique stops the
 *  same address landing on one owner's audience twice. */
export const subscribers = mysqlTable(
  "subscribers",
  {
    id: varchar("id", { length: 36 }).primaryKey(),
    // Better Auth's user.id is varchar(255) on MySQL — match it, don't recast.
    ownerId: varchar("owner_id", { length: 255 })
      .notNull()
      .references(() => user.id, { onDelete: "cascade" }),
    // Part of the owner+email unique below — MySQL can't index unbounded text.
    email: varchar("email", { length: 255 }).notNull(),
    status: varchar("status", { length: 32 })
      .$type<SubscriberStatus>()
      .notNull()
      .default("subscribed"),
    createdAt: timestamp("created_at").notNull().defaultNow(),
  },
  (t) => [
    unique("subscribers_owner_email_unique").on(t.ownerId, t.email),
    index("idx_subscriber_owner").on(t.ownerId),
    check(
      "subscribers_status_check",
      sql`${t.status} in ('subscribed','unsubscribed','bounced')`,
    ),
  ],
);

/** A named segment of an owner's audience (e.g. "Weekly digest"). */
export const lists = mysqlTable(
  "lists",
  {
    id: varchar("id", { length: 36 }).primaryKey(),
    ownerId: varchar("owner_id", { length: 255 })
      .notNull()
      .references(() => user.id, { onDelete: "cascade" }),
    name: text("name").notNull(),
    createdAt: timestamp("created_at").notNull().defaultNow(),
  },
  (t) => [index("idx_list_owner").on(t.ownerId)],
);

/** list <-> subscriber join. The composite unique is the membership identity —
 *  a subscriber is on a list at most once. */
export const listSubscriptions = mysqlTable(
  "list_subscriptions",
  {
    id: varchar("id", { length: 36 }).primaryKey(),
    listId: varchar("list_id", { length: 36 })
      .notNull()
      .references(() => lists.id, { onDelete: "cascade" }),
    subscriberId: varchar("subscriber_id", { length: 36 })
      .notNull()
      .references(() => subscribers.id, { onDelete: "cascade" }),
    createdAt: timestamp("created_at").notNull().defaultNow(),
  },
  (t) => [
    unique("list_subscriptions_list_subscriber_unique").on(
      t.listId,
      t.subscriberId,
    ),
    index("idx_list_subscription_subscriber").on(t.subscriberId),
  ],
);

/** A broadcast targeting a list. status walks the lifecycle; scheduledAt is the
 *  send time once status is 'scheduled'. */
export const campaigns = mysqlTable(
  "campaigns",
  {
    id: varchar("id", { length: 36 }).primaryKey(),
    listId: varchar("list_id", { length: 36 })
      .notNull()
      .references(() => lists.id, { onDelete: "cascade" }),
    subject: text("subject").notNull(),
    status: varchar("status", { length: 32 })
      .$type<CampaignStatus>()
      .notNull()
      .default("draft"),
    scheduledAt: timestamp("scheduled_at"),
    createdAt: timestamp("created_at").notNull().defaultNow(),
  },
  (t) => [
    index("idx_campaign_list").on(t.listId),
    check(
      "campaigns_status_check",
      sql`${t.status} in ('draft','scheduled','sent')`,
    ),
  ],
);

/** One row per (campaign, subscriber) send attempt. status walks delivery; the
 *  campaign index drives the per-campaign delivery/open rollup. */
export const campaignSends = mysqlTable(
  "campaign_sends",
  {
    id: varchar("id", { length: 36 }).primaryKey(),
    campaignId: varchar("campaign_id", { length: 36 })
      .notNull()
      .references(() => campaigns.id, { onDelete: "cascade" }),
    subscriberId: varchar("subscriber_id", { length: 36 })
      .notNull()
      .references(() => subscribers.id, { onDelete: "cascade" }),
    status: varchar("status", { length: 32 })
      .$type<CampaignSendStatus>()
      .notNull()
      .default("queued"),
    sentAt: timestamp("sent_at"),
  },
  (t) => [
    // Drives the "delivery/open stats for this campaign" rollup query.
    index("idx_send_campaign").on(t.campaignId),
    check(
      "campaign_sends_status_check",
      sql`${t.status} in ('queued','delivered','opened','bounced')`,
    ),
  ],
);

export const subscribersRelations = relations(subscribers, ({ one, many }) => ({
  owner: one(user, { fields: [subscribers.ownerId], references: [user.id] }),
  listSubscriptions: many(listSubscriptions),
  sends: many(campaignSends),
}));

export const listsRelations = relations(lists, ({ one, many }) => ({
  owner: one(user, { fields: [lists.ownerId], references: [user.id] }),
  listSubscriptions: many(listSubscriptions),
  campaigns: many(campaigns),
}));

export const listSubscriptionsRelations = relations(
  listSubscriptions,
  ({ one }) => ({
    list: one(lists, {
      fields: [listSubscriptions.listId],
      references: [lists.id],
    }),
    subscriber: one(subscribers, {
      fields: [listSubscriptions.subscriberId],
      references: [subscribers.id],
    }),
  }),
);

export const campaignsRelations = relations(campaigns, ({ one, many }) => ({
  list: one(lists, {
    fields: [campaigns.listId],
    references: [lists.id],
  }),
  sends: many(campaignSends),
}));

export const campaignSendsRelations = relations(campaignSends, ({ one }) => ({
  campaign: one(campaigns, {
    fields: [campaignSends.campaignId],
    references: [campaigns.id],
  }),
  subscriber: one(subscribers, {
    fields: [campaignSends.subscriberId],
    references: [subscribers.id],
  }),
}));

Verified identity sync (Clerk)

Clerk users sync into a local user table idempotently: duplicate, out-of-order, and concurrent webhooks converge to one correct row. Replayed against a live database.
src/db/auth-schema.ts
// === file: server/db/auth-schema.ts ===
import { mysqlTable, text, timestamp, varchar } from "drizzle-orm/mysql-core";

// Local mirror of Clerk identity — the FK target app-type schemas reference as user.
// id = Clerk's user id (varchar(255), matching the app-type user_id FKs), so existing
// user_id foreign keys resolve once the sync runs. This IS the auth-schema slot for Clerk cells.
export const user = mysqlTable("user", {
  id: varchar("id", { length: 255 }).primaryKey(), // = Clerk user id
  email: text("email"),
  firstName: text("first_name"),
  lastName: text("last_name"),
  imageUrl: text("image_url"),
  updatedAt: timestamp("updated_at"), // staleness key (Clerk updated_at)
  createdAt: timestamp("created_at").notNull().defaultNow(),
});
import { and, eq, isNull, lt, or } from "drizzle-orm";
import { user } from "~~/server/db/auth-schema";

export type ClerkUserEvent = {
  type: string;
  data: {
    id: string;
    email_addresses?: { email_address: string }[];
    first_name?: string | null;
    last_name?: string | null;
    image_url?: string | null;
    updated_at?: number;
  };
};

// Idempotent + concurrency-safe sync of a Clerk user into the local user table (MySQL).
// Keyed on id (= Clerk id, the PK); the staleness guard lives in the UPDATE WHERE. MySQL has no
// RETURNING — affectedRows tells us what happened. The insert path catches the unique-key race (a
// concurrent delivery of the same NEW user) as an idempotent no-op, rethrowing every other error.
// user.deleted removes the row.
export async function recordClerkEvent(
  // ponytail: loosely typed Drizzle client so the emitted core stays portable.
  db: any,
  event: ClerkUserEvent,
): Promise<{ changed: boolean }> {
  const d = event.data;
  if (event.type === "user.deleted") {
    const deleted = await db.delete(user).where(eq(user.id, d.id));
    return { changed: deleted[0].affectedRows > 0 };
  }

  const email = d.email_addresses?.[0]?.email_address ?? null;
  const eventAt = new Date(d.updated_at ?? 0);
  const fields = {
    email,
    firstName: d.first_name ?? null,
    lastName: d.last_name ?? null,
    imageUrl: d.image_url ?? null,
    updatedAt: eventAt,
  };

  const updated = await db
    .update(user)
    .set(fields)
    .where(and(eq(user.id, d.id), or(isNull(user.updatedAt), lt(user.updatedAt, eventAt))));
  if (updated[0].affectedRows > 0) return { changed: true };

  const [existing] = await db.select({ id: user.id }).from(user).where(eq(user.id, d.id)).limit(1);
  if (existing) return { changed: false };

  // The row doesn't exist yet — insert it. A concurrent delivery of the SAME new user can win the
  // race between our SELECT and this INSERT; the PK then rejects ours (ER_DUP_ENTRY) — an idempotent
  // no-op, NOT a change. Any other error is real: rethrow so the webhook fails loud and Clerk retries.
  try {
    await db.insert(user).values({ id: d.id, ...fields });
    return { changed: true };
  } catch (err: any) {
    if ((err?.cause?.code ?? err?.code) === "ER_DUP_ENTRY") return { changed: false };
    throw err;
  }
}
// Clerk identity webhook for Nuxt 4 (Nitro server route). The .post.ts
// suffix binds this handler to POST /api/webhooks/clerk. Clerk webhooks are svix: verify
// the signature, then hand the event to the idempotent recordClerkEvent.
// ponytail: Nuxt AUTO-IMPORTS the h3 helpers at runtime; we import defineEventHandler /
// readRawBody / getHeaders / createError EXPLICITLY from h3 (Nitro's engine, a nuxt dep) so
// this handler type-checks under standalone tsc — the one idiom trade for verifiability.
import { createError, defineEventHandler, getHeaders, readRawBody } from "h3";
import { Webhook } from "svix";
import { db } from "~~/server/lib/db";
import { recordClerkEvent, type ClerkUserEvent } from "~~/server/lib/identity/record";

const USER_EVENTS = new Set(["user.created", "user.updated", "user.deleted"]);

export default defineEventHandler(async (event) => {
  const secret = process.env.CLERK_WEBHOOK_SECRET;
  if (!secret) throw createError({ statusCode: 500, statusMessage: "Server misconfigured" });

  const raw = await readRawBody(event);
  if (!raw) throw createError({ statusCode: 400, statusMessage: "Missing body" });
  // getHeaders → Partial<Record<…, string | undefined>>; svix reads only the svix-* string
  // headers, so widen to the Record<string, string> its verify() signature expects.
  const headers = getHeaders(event) as Record<string, string>;

  let clerkEvent: ClerkUserEvent;
  try {
    clerkEvent = new Webhook(secret).verify(raw, headers) as ClerkUserEvent;
  } catch {
    throw createError({ statusCode: 403, statusMessage: "Invalid signature" });
  }

  if (USER_EVENTS.has(clerkEvent.type)) await recordClerkEvent(db, clerkEvent);
  return { ok: true };
});

Deploy targets

✓ The right DB client for where you deploy: load-tested with concurrent queries against a live database. Edge needs the HTTP driver (no TCP); serverless needs a tiny pool.
src/lib/db.ts
import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

// Serverless: a small pool per short-lived instance — many instances × a big pool exhausts MySQL.
export const pool = mysql.createPool({ uri: process.env.DATABASE_URL!, connectionLimit: 2 });
export const db = drizzle({ client: pool });
import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

// Long-running process: a real, reused pool (mysql2 manages idle recycling).
export const pool = mysql.createPool({ uri: process.env.DATABASE_URL!, connectionLimit: 10 });
export const db = drizzle({ client: pool });
import { drizzle } from "drizzle-orm/planetscale-serverless";
import { Client } from "@planetscale/database";

// Edge/Workers have NO TCP sockets, so mysql2 cannot run here. PlanetScale's HTTP driver
// speaks MySQL over fetch — the client that works on Workers (the MySQL analog of Neon's HTTP driver).
const client = new Client({ url: process.env.DATABASE_URL! });
export const db = drizzle({ client });

Decisions and compatibility

note

Client/server split: the DB client, Drizzle schema, records, and webhooks are server-side (server/). The `@/` alias is the client root (app/); server code reaches shared modules via Nuxt's `~~` rootDir alias (e.g. `~~/server/db/schema`).

note

mysql2's pool multiplexes connections; drizzle-orm/mysql2 wraps it. One module-level pool is right for a serverless/edge app — the runtime and the pool handle concurrency.

note

MySQL has no row-level security: multi-tenant isolation is enforced in application code via the forOrg helper (src/lib/tenant.ts), not by the database. See the tenant-scoping section on SaaS pages.

note

Hosted: Clerk owns identity and does NOT create a local `user` table. Store `clerk_user_id` as text without a foreign key, or sync Clerk users into a local table via webhook before relying on FKs to `user`.

note

The (ownerId, email) unique constraint on subscribers prevents the same address appearing twice on one owner's audience — deduplication is enforced at the DB level, not application code.

note

campaign_sends is append-only per (campaign, subscriber): each row walks queued → delivered → opened → bounced via a text CHECK, making delivery/open rollups a straight aggregate over the idx_send_campaign index rather than a mutable counter.

caveat

Clerk is a hosted identity provider and does not create a local `user` table. This schema's foreign keys to `user` assume a local identity table (as Better Auth provides). With Clerk, store `clerk_user_id` as a text column without a foreign key, or sync Clerk users into a local `users` table via webhook before relying on these FKs.

caveat

MySQL provides no row-level security. On MySQL, multi-tenant isolation is APP-ENFORCED via the forOrg helper (src/lib/tenant.ts), not database-enforced like Postgres RLS. Every org-scoped query MUST go through forOrg — a missed query leaks across tenants. Postgres cells enforce this in the database itself (RLS), so it holds even for a query that forgets to scope.