schema.prisma

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL")
  relationMode = "prisma"
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextSearch", "fullTextIndex"]
}

model User {
  id            String    @id @default(cuid())
  name          String?
  email         String?   @unique
  emailVerified DateTime?
  image         String?

  accounts       Account[]
  sessions       Session[]
  projects       ProjectUsers[]
  links          Link[]
  createdAt      DateTime       @default(now())
}

model Account {
  id                String  @id @default(cuid())
  userId            String
  type              String
  provider          String
  providerAccountId String
  refresh_token     String? @db.Text
  access_token      String? @db.Text
  expires_at        Int?
  token_type        String?
  scope             String?
  id_token          String? @db.Text
  session_state     String?

  user User @relation(fields: [userId], references: [id], onDelete: Cascade)

  @@unique([provider, providerAccountId])
  @@index([userId])
}

model Session {
  id           String   @id @default(cuid())
  sessionToken String   @unique
  userId       String
  expires      DateTime
  user         User     @relation(fields: [userId], references: [id], onDelete: Cascade)

  @@index([userId])
}

model VerificationToken {
  identifier String
  token      String   @unique
  expires    DateTime

  @@unique([identifier, token])
}

model Project {
  id                 String          @id @default(cuid())
  name               String
  slug               String          @unique
  logo               String?

  users              ProjectUsers[]
  invites            ProjectInvite[]
  usage              Int             @default(0)
  usageLimit         Int             @default(1000)
  plan               String          @default("free")
  stripeId           String?         @unique // Stripe subscription ID
  billingCycleStart  Int?            // day of the month when the billing cycle starts
  
  sentEmails         SentEmail[]
  domains            Domain[]
  links              Link[]
  tags               Tag[]

  createdAt          DateTime        @default(now())
  updatedAt          DateTime        @updatedAt
}

model ProjectInvite {
  email     String
  expires   DateTime
  project   Project  @relation(fields: [projectId], references: [id], onDelete: Cascade)
  projectId String
  createdAt DateTime @default(now())

  @@unique([email, projectId])
  @@index([projectId])
}

enum Role {
  owner
  member
}

model ProjectUsers {
  id        String   @id @default(cuid())
  role      Role   @default(member)
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  user      User     @relation(fields: [userId], references: [id], onDelete: Cascade)
  userId    String
  project   Project  @relation(fields: [projectId], references: [id], onDelete: Cascade)
  projectId String

  @@unique([userId, projectId])
  @@index([projectId])
}

enum EmailType {
  firstDomainInvalidEmail
  secondDomainInvalidEmail
  firstUsageLimitEmail
  secondUsageLimitEmail
}

model SentEmail {
  id        String    @id @default(cuid())
  type      EmailType
  createdAt DateTime  @default(now())
  project   Project?  @relation(fields: [projectId], references: [id], onDelete: Cascade)
  projectId String?

  @@index([projectId])
}

model Domain {
  id          String   @id @default(cuid())
  slug        String   @unique
  verified    Boolean  @default(false)
  target      String?
  type        String   @default("redirect")
  description String?
  project     Project? @relation(fields: [projectId], references: [id], onDelete: Cascade)
  projectId   String?
  primary     Boolean  @default(false)
  links       Link[]
  lastChecked DateTime @default(now())
  createdAt   DateTime @default(now())
  updatedAt   DateTime @updatedAt

  @@index(projectId)
  @@index(lastChecked)
}

model Link {
  id        String    @id @default(cuid())
  domain    String // domain of the link (e.g. dub.sh) – also stored on Redis
  key       String // key of the link (e.g. /github) – also stored on Redis
  url       String    @db.LongText // target url (e.g. https://github.com/steven-tey/dub) – also stored on Redis
  archived  Boolean   @default(false) // whether the link is archived or not
  expiresAt DateTime? // when the link expires – stored on Redis via ttl
  password  String? // password to access the link – also stored on Redis

  proxy       Boolean @default(false) // Proxy to use custom OG tags (stored on redis) – if false, will use OG tags from target url
  title       String? // OG title for the link (e.g. Dub - Open-Source Bitly Alternative)
  description String? @db.VarChar(280) // OG description for the link (e.g. An open-source link management tool for modern marketing teams to create, share, and track short links.)
  image       String? @db.LongText // OG image for the link (e.g. https://dub.sh/og-image.png)

  // UTM parameters
  utm_source   String? // UTM source for the link (e.g. youtube.com)
  utm_medium   String? // UTM medium for the link (e.g. social)
  utm_campaign String? // UTM campaign for the link (e.g. summer-sale)
  utm_term     String? // UTM term for the link (e.g. dub)
  utm_content  String? // UTM content for the link (e.g. description)

  // Link cloaking/masking via rewrite
  rewrite      Boolean @default(false) // whether to rewrite the link or not

  // Custom device targeting
  ios     String? @db.LongText // custom link for iOS devices
  android String? @db.LongText // custom link for Android devices

  // User who created the link
  user   User?   @relation(fields: [userId], references: [id])
  userId String?

  // Project that the link belongs to
  project       Project? @relation(fields: [projectId], references: [id], onUpdate: Cascade, onDelete: Cascade)
  projectId     String?
  // Relational reference to the project domain
  projectDomain Domain?  @relation(fields: [domain], references: [slug], onUpdate: Cascade, onDelete: Cascade)

  // Link metadata
  clicks      Int      @default(0) // number of clicks
  publicStats Boolean  @default(false) // whether to show public stats or not
  createdAt   DateTime @default(now())
  updatedAt   DateTime @updatedAt

  // Link tags
  tag   Tag?    @relation(fields: [tagId], references: [id])
  tagId String?

  // TODO: might wanna add indices for utm_source, utm_medium, utm_campaign

  @@unique([domain, key])
  @@index(projectId)
  @@index(domain)
  @@index(tagId)
  @@index(proxy)
  @@index(password)
  @@index(createdAt(sort: Desc))
  @@index(clicks(sort: Desc))
  @@index(userId)
  @@fulltext([key, url])
}

model Tag {
  id        String   @id @default(cuid())
  name      String
  color     String   @default("blue")
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  project   Project  @relation(fields: [projectId], references: [id], onUpdate: Cascade, onDelete: Cascade)
  projectId String
  links     Link[]

  @@unique([name, projectId])
  @@index(projectId)
}