@studious-lms/server 1.23.0 → 1.25.0

package/prisma/schema.prisma

@@ -103,6 +103,10 @@ enum SchoolMembershipRole {
   ADMIN
   TEACHER
   STUDENT
+  /// Nepal-pilot: fee/payment operations (authz stubs until A2 fees land).
+  ACCOUNTANT
+  /// Nepal-pilot: guardian linked to one or more students via ParentStudentLink.
+  PARENT
 }
 
 enum SchoolMembershipStatus {
@@ -118,24 +122,99 @@ enum SchoolInviteStatus {
   EXPIRED
 }
 
+/// Marketplace listing resource kinds for B1 v1.
+/// Exercise/poll/kahoot types are reserved for a later milestone — do not add
+/// them here until that product surface ships.
+enum MarketplaceListingType {
+  MARKSCHEME
+  WORKSHEET
+  FILE
+}
+
+enum MarketplaceVisibility {
+  SCHOOL
+  PUBLIC
+}
+
 model School {
   id          String   @id @default(uuid())
   name        String
   description String?
   logo        File?    @relation("SchoolLogo", references: [id], fields: [logoId])
   logoId      String?
+  /// Optional PDF/image letterhead used when stamping branded PDFs
+  /// (fee invoices/receipts, transcripts).
+  letterhead       File?   @relation("SchoolLetterhead", references: [id], fields: [letterheadFileId])
+  letterheadFileId String?
   subdomain   String?  @unique
   createdAt   DateTime @default(now())
   updatedAt   DateTime @updatedAt
 
-  users       User[]
-  memberships SchoolMembership[]
-  invites     SchoolInvite[]
-  classes     Class[]
-  departments Department[]
-  tags        Tag[]
-  storageRoot Folder?            @relation("SchoolStorageRoot")
-  permissions Permission[]       @relation("SchoolPermissions")
+  users               User[]
+  memberships         SchoolMembership[]
+  invites             SchoolInvite[]
+  classes             Class[]
+  departments         Department[]
+  tags                Tag[]
+  storageRoot         Folder?              @relation("SchoolStorageRoot")
+  permissions         Permission[]         @relation("SchoolPermissions")
+  excusals            StudentExcusal[]
+  feePlans            FeePlan[]
+  feeInvoices         FeeInvoice[]
+  feePayments         FeePayment[]
+  marketplaceListings MarketplaceListing[]
+  academicYears       AcademicYear[]
+  parentLinks         ParentStudentLink[]
+}
+
+/// School academic calendar year (e.g. "2025-2026" or "2082"). No BS calendar logic.
+model AcademicYear {
+  id        String   @id @default(uuid())
+  schoolId  String
+  school    School   @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  name      String
+  startDate DateTime
+  endDate   DateTime
+  isCurrent Boolean  @default(false)
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  terms AcademicTerm[]
+
+  @@unique([schoolId, name])
+  @@index([schoolId, isCurrent])
+}
+
+model AcademicTerm {
+  id             String       @id @default(uuid())
+  academicYearId String
+  academicYear   AcademicYear @relation(fields: [academicYearId], references: [id], onDelete: Cascade)
+  name           String
+  startDate      DateTime
+  endDate        DateTime
+  isCurrent      Boolean      @default(false)
+  createdAt      DateTime     @default(now())
+  updatedAt      DateTime     @updatedAt
+
+  @@unique([academicYearId, name])
+  @@index([academicYearId, isCurrent])
+}
+
+/// Links a PARENT membership user to a STUDENT membership user within a school.
+model ParentStudentLink {
+  id             String   @id @default(uuid())
+  schoolId       String
+  school         School   @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  parentUserId   String
+  parent         User     @relation("ParentLinks", fields: [parentUserId], references: [id], onDelete: Cascade)
+  studentUserId  String
+  student        User     @relation("StudentParentLinks", fields: [studentUserId], references: [id], onDelete: Cascade)
+  createdAt      DateTime @default(now())
+  updatedAt      DateTime @updatedAt
+
+  @@unique([schoolId, parentUserId, studentUserId])
+  @@index([schoolId, parentUserId])
+  @@index([schoolId, studentUserId])
 }
 
 model Department {
@@ -218,10 +297,18 @@ model User {
   lateAttendance    Attendance[] @relation("LateAttendance")
   absentAttendance  Attendance[] @relation("AbsentAttendance")
 
+  attendanceRecords       AttendanceRecord[]      @relation("AttendanceRecordStudent")
+  updatedAttendanceRecords AttendanceRecord[]     @relation("AttendanceRecordUpdatedBy")
+  createdExcusals         StudentExcusal[]        @relation("StudentExcusalCreatedBy")
+  revokedExcusals         StudentExcusal[]        @relation("StudentExcusalRevokedBy")
+  studentExcusals         StudentExcusalStudent[]
+
   school            School?            @relation(fields: [schoolId], references: [id])
   schoolId          String?
   schoolMemberships SchoolMembership[]
   sentSchoolInvites SchoolInvite[]     @relation("SchoolInviteInvitedBy")
+  parentLinks       ParentStudentLink[] @relation("ParentLinks")
+  studentParentLinks ParentStudentLink[] @relation("StudentParentLinks")
 
   departments     Department[] @relation("UserDepartments")
   tags            Tag[]        @relation("UserTags")
@@ -243,6 +330,11 @@ model User {
   discussionReads         DiscussionRead[]
   customGradeEntries      CustomGradeEntry[]   @relation("UserCustomGradeEntries")
   fileAnnotations         FileAnnotation[]     @relation("AuthoredFileAnnotations")
+  marketplaceListings     MarketplaceListing[] @relation("MarketplaceListingAuthor")
+
+  feePlanEnrollments  FeePlanEnrollment[]
+  feeInvoices         FeeInvoice[]
+  feePaymentsRecorded FeePayment[]         @relation("FeePaymentRecordedBy")
 }
 
 model SchoolMembership {
@@ -336,6 +428,10 @@ model Class {
   studentsCanCreateDiscussions Boolean @default(true)
   studentsCanReply             Boolean @default(true)
 
+  /// Teacher-controlled ClassSidebar visibility. Keys match nav hrefs
+  /// without leading slash (e.g. "assignments", "quizzes"). Null = all defaults on.
+  sidebarFeatures Json?
+
   gradeCategories    GradeCategory[]
   customGradeColumns CustomGradeColumn[]
 
@@ -407,6 +503,7 @@ model MarkScheme {
   structured   String
   assignments  Assignment[]
   tags         Tag[]        @relation("MarkSchemeTags")
+  marketplaceListings MarketplaceListing[]
 
   @@index([classId])
   @@index([departmentId])
@@ -509,12 +606,17 @@ model File {
   discussionReply   DiscussionReply? @relation("DiscussionReplyFiles", fields: [discussionReplyId], references: [id], onDelete: Cascade)
   discussionReplyId String?
 
+  moduleItem   ModuleItem? @relation("ModuleItemFiles", fields: [moduleItemId], references: [id], onDelete: Cascade)
+  moduleItemId String?
+
   schools School[] @relation("SchoolLogo")
+  schoolLetterheads School[] @relation("SchoolLetterhead")
 
   schoolDevelopementProgram   SchoolDevelopementProgram? @relation("SchoolDevelopementProgramSupportingDocumentation", fields: [schoolDevelopementProgramId], references: [id], onDelete: Cascade)
   schoolDevelopementProgramId String?
 
   fileAnnotations FileAnnotation[] @relation("FileAnnotations")
+  marketplaceListings MarketplaceListing[]
 }
 
 enum FileAnnotationType {
@@ -585,6 +687,13 @@ model Assignment {
   gradeCategoryId       String?
   worksheets            Worksheet[]      @relation("AssignmentWorksheets")
   targetedBySubmissions Submission[]     @relation("SubmissionTargetedAssignment")
+
+  /// Optional timed window for QUIZ/TEST (minutes). Null = untimed.
+  timeLimitMinutes     Int?
+  /// When true, students cannot unsubmit after submitting (typical for quizzes).
+  singleAttempt        Boolean @default(false)
+  /// When false, file uploads and (re)submits after due date are rejected.
+  allowLateSubmissions Boolean @default(true)
 }
 
 model Announcement {
@@ -773,10 +882,35 @@ model Section {
   classId     String
   class       Class        @relation(fields: [classId], references: [id], onDelete: Cascade)
   assignments Assignment[]
+  moduleItems ModuleItem[]
   color       String?      @default("#3B82F6")
   order       Int?
 }
 
+/// Canvas-style module content: a rich page, a file collection, or a video item.
+enum ModuleItemType {
+  PAGE
+  FILES
+  VIDEO
+}
+
+model ModuleItem {
+  id        String         @id @default(uuid())
+  sectionId String
+  section   Section        @relation(fields: [sectionId], references: [id], onDelete: Cascade)
+  title     String
+  type      ModuleItemType
+  /// Rich HTML/markdown body for PAGE items.
+  body      String?
+  order     Int?
+  published Boolean        @default(true)
+  files     File[]         @relation("ModuleItemFiles")
+  createdAt DateTime       @default(now())
+  updatedAt DateTime       @updatedAt
+
+  @@index([sectionId])
+}
+
 enum SessionType {
   AUTH
   EMAIL_VERIFICATION
@@ -811,6 +945,13 @@ model Event {
   attendance          Attendance[]
 }
 
+enum AttendanceStatus {
+  PRESENT
+  LATE
+  ABSENT
+  EXCUSED
+}
+
 model Attendance {
   id   String   @id @default(uuid())
   date DateTime @default(now())
@@ -821,9 +962,68 @@ model Attendance {
   event   Event?  @relation(fields: [eventId], references: [id], onDelete: Cascade)
   eventId String?
 
-  present User[] @relation("PresentAttendance")
-  late    User[] @relation("LateAttendance")
-  absent  User[] @relation("AbsentAttendance")
+  present User[]             @relation("PresentAttendance")
+  late    User[]             @relation("LateAttendance")
+  absent  User[]             @relation("AbsentAttendance")
+  records AttendanceRecord[]
+}
+
+/// Per-student status for an attendance session (dual-written with legacy present/late/absent lists).
+model AttendanceRecord {
+  id                 String           @id @default(uuid())
+  attendanceId       String
+  studentId          String
+  status             AttendanceStatus
+  note               String?
+  excusedByExcusalId String?
+  updatedById        String?
+  createdAt          DateTime         @default(now())
+  updatedAt          DateTime         @updatedAt
+
+  attendance       Attendance     @relation(fields: [attendanceId], references: [id], onDelete: Cascade)
+  student          User           @relation("AttendanceRecordStudent", fields: [studentId], references: [id], onDelete: Cascade)
+  excusedByExcusal StudentExcusal? @relation(fields: [excusedByExcusalId], references: [id], onDelete: SetNull)
+  updatedBy        User?          @relation("AttendanceRecordUpdatedBy", fields: [updatedById], references: [id], onDelete: SetNull)
+
+  @@unique([attendanceId, studentId])
+  @@index([studentId, status])
+  @@index([excusedByExcusalId])
+  @@index([attendanceId])
+}
+
+/// School-admin excusal covering one or more students for a date range.
+model StudentExcusal {
+  id          String    @id @default(uuid())
+  schoolId    String
+  startDate   DateTime  @db.Date
+  endDate     DateTime  @db.Date
+  reason      String
+  note        String?
+  createdById String
+  createdAt   DateTime  @default(now())
+  updatedAt   DateTime  @updatedAt
+  revokedAt   DateTime?
+  revokedById String?
+
+  school            School                  @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  createdBy         User                    @relation("StudentExcusalCreatedBy", fields: [createdById], references: [id], onDelete: Cascade)
+  revokedBy         User?                   @relation("StudentExcusalRevokedBy", fields: [revokedById], references: [id], onDelete: SetNull)
+  students          StudentExcusalStudent[]
+  attendanceRecords AttendanceRecord[]
+
+  @@index([schoolId, startDate, endDate])
+  @@index([schoolId, revokedAt])
+}
+
+model StudentExcusalStudent {
+  excusalId String
+  studentId String
+
+  excusal StudentExcusal @relation(fields: [excusalId], references: [id], onDelete: Cascade)
+  student User           @relation(fields: [studentId], references: [id], onDelete: Cascade)
+
+  @@id([excusalId, studentId])
+  @@index([studentId])
 }
 
 enum NotificationType {
@@ -834,6 +1034,10 @@ enum NotificationType {
   DISCUSSION_MENTION
   ANNOUNCEMENT
   ATTENDANCE
+  /// Fee due / paid / reminder events (A2 fees will emit these).
+  FEES
+  /// Excusal request/decision hooks (A1 owns StudentExcusal; emitters call helpers).
+  EXCUSAL
   SYSTEM
 }
 
@@ -987,6 +1191,7 @@ model Worksheet {
 
   status JobStatus? @default(NOT_STARTED)
   tags   ClassTag[] @relation("WorksheetToTag")
+  marketplaceListings MarketplaceListing[]
 
   @@unique([classId, sourceUrl])
 }
@@ -1005,6 +1210,13 @@ model WorksheetQuestion {
   createdAt        DateTime                  @default(now())
   updatedAt        DateTime                  @updatedAt
   studentResponses StudentQuestionProgress[]
+
+  /// Parent/child subquestions (e.g. multi-part worksheet items).
+  parentQuestionId String?
+  parentQuestion   WorksheetQuestion?  @relation("WorksheetSubquestions", fields: [parentQuestionId], references: [id], onDelete: Cascade)
+  subquestions     WorksheetQuestion[] @relation("WorksheetSubquestions")
+
+  @@index([parentQuestionId])
 }
 
 model StudentWorksheetResponse {
@@ -1180,6 +1392,47 @@ enum PermissionLevel {
   WRITE
 }
 
+/// User-created shareable content listing (markschemes, worksheets, files).
+/// Isolated Marketplace* tables — must not share schema with Attendance/Fee.
+/// Exercise/poll types are intentionally omitted from MarketplaceListingType for v1.
+model MarketplaceListing {
+  id          String                 @id @default(uuid())
+  type        MarketplaceListingType
+  title       String
+  description String?
+  authorId    String
+  author      User                   @relation("MarketplaceListingAuthor", fields: [authorId], references: [id], onDelete: Cascade)
+  schoolId    String?
+  school      School?                @relation(fields: [schoolId], references: [id], onDelete: SetNull)
+  visibility  MarketplaceVisibility  @default(SCHOOL)
+
+  /// Live refs to the source resource (optional; source may later be deleted).
+  markSchemeId String?
+  markScheme   MarkScheme? @relation(fields: [markSchemeId], references: [id], onDelete: SetNull)
+  worksheetId  String?
+  worksheet    Worksheet?  @relation(fields: [worksheetId], references: [id], onDelete: SetNull)
+  fileId       String?
+  file         File?       @relation(fields: [fileId], references: [id], onDelete: SetNull)
+
+  /// Snapshot captured at publish time so import survives source deletion.
+  /// Shape varies by type — see marketplace service publish helpers.
+  payload Json
+
+  tags String[] @default([])
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  /// C10 moderation stubs — light reporting only; no full moderation queue yet.
+  reportCount Int     @default(0)
+  isHidden    Boolean @default(false)
+
+  @@index([type, visibility, createdAt])
+  @@index([schoolId, visibility, createdAt])
+  @@index([authorId])
+  @@index([isHidden])
+}
+
 /// Explicit ACL grant on a folder. Sits on top of (and is purely additive
 /// to) the scope-derived defaults computed from FolderScope. Files inherit
 /// from their parent folder — file-level overrides are deliberately deferred
@@ -1224,3 +1477,110 @@ model Permission {
   @@index([departmentId])
   @@index([schoolId])
 }
+
+// ---------------------------------------------------------------------------
+// A2 — Monthly student fees + manual payment ledger (Nepal pilot)
+// Billing period = FeeInvoice.year + FeeInvoice.month (no separate term table;
+// AcademicYear/Term from other pilots can attach later without conflict).
+// ---------------------------------------------------------------------------
+
+enum FeePaymentMethod {
+  CASH
+  BANK
+  ESEWA_REF
+}
+
+enum FeeInvoiceStatus {
+  UNPAID
+  PARTIAL
+  PAID
+  VOID
+}
+
+/// Recurring monthly fee definition (e.g. "Tuition", "Transport").
+model FeePlan {
+  id          String  @id @default(uuid())
+  schoolId    String
+  name        String
+  description String?
+  /// Whole NPR amount charged per billing month.
+  amountNpr   Int
+  currency    String  @default("NPR")
+  isActive    Boolean @default(true)
+  createdAt   DateTime @default(now())
+  updatedAt   DateTime @updatedAt
+
+  school      School              @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  enrollments FeePlanEnrollment[]
+  invoices    FeeInvoice[]
+
+  @@index([schoolId])
+  @@unique([schoolId, name])
+}
+
+/// Students enrolled on a fee plan. Empty enrollments = all ACTIVE STUDENT members at invoice generation.
+model FeePlanEnrollment {
+  id        String   @id @default(uuid())
+  feePlanId String
+  studentId String
+  createdAt DateTime @default(now())
+
+  feePlan FeePlan @relation(fields: [feePlanId], references: [id], onDelete: Cascade)
+  student User    @relation(fields: [studentId], references: [id], onDelete: Cascade)
+
+  @@unique([feePlanId, studentId])
+  @@index([studentId])
+}
+
+model FeeInvoice {
+  id        String           @id @default(uuid())
+  schoolId  String
+  feePlanId String
+  studentId String
+  /// Billing period (calendar month).
+  year      Int
+  month     Int
+  /// Snapshot of plan amount at generation time.
+  amountNpr Int
+  currency  String           @default("NPR")
+  status    FeeInvoiceStatus @default(UNPAID)
+  dueDate   DateTime?        @db.Date
+  issuedAt  DateTime         @default(now())
+  notes     String?
+  createdAt DateTime         @default(now())
+  updatedAt DateTime         @updatedAt
+
+  school   School       @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  feePlan  FeePlan      @relation(fields: [feePlanId], references: [id], onDelete: Restrict)
+  student  User         @relation(fields: [studentId], references: [id], onDelete: Cascade)
+  payments FeePayment[]
+
+  @@unique([schoolId, studentId, feePlanId, year, month])
+  @@index([schoolId, year, month])
+  @@index([studentId])
+  @@index([feePlanId])
+  @@index([status])
+}
+
+model FeePayment {
+  id           String           @id @default(uuid())
+  schoolId     String
+  invoiceId    String
+  amountNpr    Int
+  method       FeePaymentMethod
+  /// Required for BANK / ESEWA_REF (cheque no., eSewa txn id, etc.).
+  reference    String?
+  paidAt       DateTime         @default(now())
+  recordedById String
+  notes        String?
+  createdAt    DateTime         @default(now())
+  updatedAt    DateTime         @updatedAt
+
+  school     School     @relation(fields: [schoolId], references: [id], onDelete: Cascade)
+  invoice    FeeInvoice @relation(fields: [invoiceId], references: [id], onDelete: Cascade)
+  recordedBy User       @relation("FeePaymentRecordedBy", fields: [recordedById], references: [id], onDelete: Restrict)
+
+  @@index([invoiceId])
+  @@index([schoolId])
+  @@index([paidAt])
+}