@brite-future-schools-contracts/contracts 1.0.0

package/dist/chunk-TV57ZLZQ.mjs

@@ -0,0 +1,733 @@
+import {
+  assessmentScoreInputSchema,
+  assessmentTypeEnum,
+  assetCategoryEnum,
+  assetConditionEnum,
+  branchSchema,
+  busRegisterEntrySchema,
+  changePasswordInputSchema,
+  createBranchInputSchema,
+  createStudentInputSchema,
+  disciplineRulingEnum,
+  feeItemSchema,
+  gradeLevelEnum,
+  guardianSchema,
+  incidentSeverityEnum,
+  incidentStatusEnum,
+  invoiceStatusEnum,
+  leaveRequestInputSchema,
+  leaveStatusEnum,
+  listStudentsInputSchema,
+  loginInputSchema,
+  loginOutputSchema,
+  maintenanceTicketStatusEnum,
+  mfaVerifyInputSchema,
+  paginationSchema,
+  payrollRunStatusEnum,
+  recordPaymentInputSchema,
+  refreshInputSchema,
+  refreshTokenOutputSchema,
+  reportCardStatusEnum,
+  sendBulkSmsInputSchema,
+  sponsorSchema,
+  staffSchema,
+  studentSchema,
+  subjectSchema,
+  tripLogInputSchema,
+  userSchema,
+  uuidSchema
+} from "./chunk-AECTWOHQ.mjs";
+
+// src/contracts/index.ts
+import { oc } from "@orpc/contract";
+import { z } from "zod";
+var authContract = {
+  login: oc.input(loginInputSchema).output(loginOutputSchema),
+  refresh: oc.input(refreshInputSchema).output(refreshTokenOutputSchema),
+  logout: oc.output(z.object({ success: z.boolean() })),
+  me: oc.output(
+    userSchema.extend({
+      roles: z.array(
+        z.object({
+          id: uuidSchema,
+          name: z.string(),
+          branchId: uuidSchema.nullable()
+        })
+      )
+    })
+  ),
+  verifyMfa: oc.input(mfaVerifyInputSchema).output(z.object({ verified: z.boolean() })),
+  changePassword: oc.input(changePasswordInputSchema).output(z.object({ success: z.boolean() })),
+  switchBranch: oc.input(z.object({ branchId: uuidSchema })).output(z.object({ accessToken: z.string() }))
+};
+var branchesContract = {
+  list: oc.output(z.array(branchSchema)),
+  get: oc.input(z.object({ id: uuidSchema })).output(branchSchema),
+  create: oc.input(createBranchInputSchema).output(branchSchema),
+  update: oc.input(createBranchInputSchema.partial().extend({ id: uuidSchema })).output(branchSchema),
+  updateFeatureFlags: oc.input(z.object({ branchId: uuidSchema, flags: z.record(z.boolean()) })).output(branchSchema)
+};
+var studentWithGuardians = studentSchema.extend({
+  guardians: z.array(guardianSchema),
+  sponsors: z.array(sponsorSchema),
+  currentClass: z.object({ id: uuidSchema, name: z.string(), grade: z.string() }).nullable()
+});
+var studentsContract = {
+  list: oc.input(listStudentsInputSchema).output(
+    z.object({
+      data: z.array(studentSchema),
+      total: z.number(),
+      page: z.number(),
+      limit: z.number()
+    })
+  ),
+  get: oc.input(z.object({ id: uuidSchema })).output(studentWithGuardians),
+  create: oc.input(createStudentInputSchema).output(studentSchema),
+  update: oc.input(createStudentInputSchema.partial().extend({ id: uuidSchema })).output(studentSchema),
+  enroll: oc.input(
+    z.object({
+      studentId: uuidSchema,
+      classId: uuidSchema,
+      termId: uuidSchema
+    })
+  ).output(z.object({ success: z.boolean() })),
+  transfer: oc.input(
+    z.object({
+      studentId: uuidSchema,
+      toBranchId: uuidSchema,
+      reason: z.string()
+    })
+  ).output(z.object({ success: z.boolean() })),
+  linkGuardian: oc.input(
+    z.object({
+      studentId: uuidSchema,
+      guardianId: uuidSchema,
+      isPrimary: z.boolean()
+    })
+  ).output(z.object({ success: z.boolean() })),
+  linkSponsor: oc.input(
+    z.object({
+      studentId: uuidSchema,
+      sponsorId: uuidSchema,
+      termId: uuidSchema,
+      feeItemIds: z.array(uuidSchema)
+    })
+  ).output(z.object({ success: z.boolean() }))
+};
+var academicsContract = {
+  subjects: {
+    list: oc.input(
+      z.object({
+        branchId: uuidSchema,
+        gradeLevel: gradeLevelEnum.optional()
+      })
+    ).output(z.array(subjectSchema)),
+    create: oc.input(
+      z.object({
+        name: z.string(),
+        code: z.string(),
+        gradeLevel: gradeLevelEnum,
+        departmentId: uuidSchema.optional()
+      })
+    ).output(subjectSchema)
+  },
+  timetable: {
+    get: oc.input(z.object({ classId: uuidSchema, termId: uuidSchema })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          dayOfWeek: z.number().min(1).max(5),
+          periodNo: z.number(),
+          subject: subjectSchema,
+          teacherName: z.string(),
+          room: z.string().nullable(),
+          startTime: z.string(),
+          endTime: z.string()
+        })
+      )
+    ),
+    upsert: oc.input(
+      z.object({
+        classId: uuidSchema,
+        termId: uuidSchema,
+        slots: z.array(
+          z.object({
+            dayOfWeek: z.number().min(1).max(5),
+            periodNo: z.number(),
+            subjectId: uuidSchema,
+            teacherId: uuidSchema,
+            room: z.string().optional(),
+            startTime: z.string(),
+            endTime: z.string()
+          })
+        )
+      })
+    ).output(z.object({ success: z.boolean() }))
+  },
+  assessments: {
+    list: oc.input(
+      z.object({
+        classId: uuidSchema,
+        termId: uuidSchema,
+        type: assessmentTypeEnum.optional()
+      })
+    ).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          title: z.string(),
+          type: assessmentTypeEnum,
+          date: z.string(),
+          maxScore: z.number(),
+          subjectId: uuidSchema
+        })
+      )
+    ),
+    create: oc.input(
+      z.object({
+        title: z.string(),
+        type: assessmentTypeEnum,
+        classId: uuidSchema,
+        subjectId: uuidSchema,
+        termId: uuidSchema,
+        date: z.string(),
+        maxScore: z.number()
+      })
+    ).output(z.object({ id: uuidSchema })),
+    enterScores: oc.input(z.object({ scores: z.array(assessmentScoreInputSchema) })).output(z.object({ saved: z.number() }))
+  },
+  reportCards: {
+    list: oc.input(
+      z.object({
+        branchId: uuidSchema,
+        termId: uuidSchema,
+        classId: uuidSchema.optional(),
+        status: reportCardStatusEnum.optional()
+      })
+    ).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          studentId: uuidSchema,
+          studentName: z.string(),
+          status: reportCardStatusEnum,
+          generatedAt: z.string().datetime().nullable()
+        })
+      )
+    ),
+    get: oc.input(z.object({ studentId: uuidSchema, termId: uuidSchema })).output(
+      z.object({
+        id: uuidSchema,
+        studentId: uuidSchema,
+        termId: uuidSchema,
+        status: reportCardStatusEnum,
+        scores: z.array(z.any()),
+        teacherComments: z.string().nullable(),
+        generatedAt: z.string().datetime().nullable()
+      })
+    ),
+    updateStatus: oc.input(
+      z.object({
+        id: uuidSchema,
+        status: reportCardStatusEnum,
+        comments: z.string().optional()
+      })
+    ).output(z.object({ success: z.boolean() }))
+  },
+  attendance: {
+    markClass: oc.input(
+      z.object({
+        classId: uuidSchema,
+        date: z.string(),
+        subjectId: uuidSchema,
+        records: z.array(
+          z.object({
+            studentId: uuidSchema,
+            present: z.boolean(),
+            note: z.string().optional()
+          })
+        )
+      })
+    ).output(z.object({ saved: z.number() })),
+    getClassAttendance: oc.input(
+      z.object({ classId: uuidSchema, from: z.string(), to: z.string() })
+    ).output(
+      z.array(
+        z.object({
+          studentId: uuidSchema,
+          studentName: z.string(),
+          presentDays: z.number(),
+          absentDays: z.number(),
+          percentage: z.number()
+        })
+      )
+    )
+  }
+};
+var financeContract = {
+  feeItems: {
+    list: oc.input(z.object({ branchId: uuidSchema })).output(z.array(feeItemSchema)),
+    create: oc.input(
+      z.object({
+        name: z.string(),
+        category: z.any(),
+        defaultAmount: z.number(),
+        applicableGrades: z.array(gradeLevelEnum)
+      })
+    ).output(feeItemSchema)
+  },
+  invoices: {
+    listForStudent: oc.input(z.object({ studentId: uuidSchema, termId: uuidSchema.optional() })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          termId: uuidSchema,
+          payerType: z.string(),
+          totalAmount: z.number(),
+          paidAmount: z.number(),
+          balance: z.number(),
+          status: invoiceStatusEnum,
+          dueDate: z.string().nullable()
+        })
+      )
+    ),
+    generate: oc.input(
+      z.object({
+        branchId: uuidSchema,
+        termId: uuidSchema,
+        studentIds: z.array(uuidSchema).optional()
+      })
+    ).output(z.object({ generated: z.number() }))
+  },
+  payments: {
+    record: oc.input(recordPaymentInputSchema).output(z.object({ id: uuidSchema, receipt: z.string() })),
+    listForStudent: oc.input(z.object({ studentId: uuidSchema })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          amount: z.number(),
+          method: z.string(),
+          reference: z.string().nullable(),
+          paymentDate: z.string(),
+          createdAt: z.string()
+        })
+      )
+    )
+  },
+  blocks: {
+    list: oc.input(
+      z.object({
+        branchId: uuidSchema,
+        termId: uuidSchema,
+        active: z.boolean().optional()
+      })
+    ).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          studentId: uuidSchema,
+          studentName: z.string(),
+          blockType: z.string(),
+          isActive: z.boolean(),
+          balanceAtBlock: z.number()
+        })
+      )
+    ),
+    lift: oc.input(z.object({ blockId: uuidSchema, reason: z.string() })).output(z.object({ success: z.boolean() }))
+  },
+  reports: {
+    termCollection: oc.input(z.object({ branchId: uuidSchema, termId: uuidSchema })).output(
+      z.object({
+        totalExpected: z.number(),
+        totalCollected: z.number(),
+        totalOutstanding: z.number(),
+        collectionRate: z.number(),
+        byPaymentMethod: z.record(z.number())
+      })
+    )
+  }
+};
+var hrContract = {
+  staff: {
+    list: oc.input(
+      paginationSchema.extend({
+        branchId: uuidSchema,
+        search: z.string().optional(),
+        departmentId: uuidSchema.optional()
+      })
+    ).output(z.object({ data: z.array(staffSchema), total: z.number() })),
+    get: oc.input(z.object({ id: uuidSchema })).output(staffSchema),
+    create: oc.input(
+      staffSchema.omit({ id: true }).partial({
+        contractEnd: true,
+        tscNumber: true,
+        kraPin: true,
+        nhifNo: true,
+        nssfNo: true,
+        bankName: true,
+        bankAccount: true,
+        departmentId: true
+      })
+    ).output(staffSchema)
+  },
+  leave: {
+    request: oc.input(leaveRequestInputSchema).output(z.object({ id: uuidSchema })),
+    list: oc.input(
+      z.object({
+        branchId: uuidSchema,
+        staffId: uuidSchema.optional(),
+        status: leaveStatusEnum.optional()
+      })
+    ).output(z.array(z.any())),
+    approve: oc.input(
+      z.object({
+        id: uuidSchema,
+        approved: z.boolean(),
+        comment: z.string().optional()
+      })
+    ).output(z.object({ success: z.boolean() }))
+  },
+  attendance: {
+    mark: oc.input(
+      z.object({
+        staffId: uuidSchema,
+        date: z.string(),
+        checkIn: z.string().optional(),
+        checkOut: z.string().optional(),
+        status: z.enum(["present", "absent", "late", "half_day"])
+      })
+    ).output(z.object({ success: z.boolean() })),
+    getSummary: oc.input(
+      z.object({ staffId: uuidSchema, month: z.number(), year: z.number() })
+    ).output(
+      z.object({
+        presentDays: z.number(),
+        absentDays: z.number(),
+        lateDays: z.number()
+      })
+    )
+  }
+};
+var payrollContract = {
+  runs: {
+    list: oc.input(z.object({ branchId: uuidSchema, year: z.number().optional() })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          month: z.number(),
+          year: z.number(),
+          status: payrollRunStatusEnum,
+          netTotal: z.number()
+        })
+      )
+    ),
+    initiate: oc.input(
+      z.object({ branchId: uuidSchema, month: z.number(), year: z.number() })
+    ).output(z.object({ id: uuidSchema, preview: z.array(z.any()) })),
+    approve: oc.input(z.object({ id: uuidSchema })).output(z.object({ success: z.boolean() })),
+    getPayslip: oc.input(z.object({ payrollRunId: uuidSchema, staffId: uuidSchema })).output(z.object({ url: z.string() }))
+  }
+};
+var transportContract = {
+  vehicles: {
+    list: oc.input(z.object({ branchId: uuidSchema })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          plateNo: z.string(),
+          type: z.string(),
+          status: z.string(),
+          currentTrip: z.any().nullable()
+        })
+      )
+    )
+  },
+  trips: {
+    start: oc.input(tripLogInputSchema).output(z.object({ id: uuidSchema })),
+    recordBoardings: oc.input(
+      z.object({
+        tripId: uuidSchema,
+        entries: z.array(busRegisterEntrySchema)
+      })
+    ).output(z.object({ saved: z.number() })),
+    complete: oc.input(
+      z.object({ tripId: uuidSchema, arrivalTime: z.string().datetime() })
+    ).output(z.object({ success: z.boolean() })),
+    reportIncident: oc.input(
+      z.object({
+        tripId: uuidSchema,
+        description: z.string(),
+        severity: incidentSeverityEnum,
+        location: z.string().optional()
+      })
+    ).output(z.object({ id: uuidSchema }))
+  },
+  maintenance: {
+    log: oc.input(
+      z.object({
+        vehicleId: uuidSchema,
+        issue: z.string(),
+        severity: z.enum(["routine", "urgent", "critical"])
+      })
+    ).output(z.object({ id: uuidSchema })),
+    list: oc.input(z.object({ vehicleId: uuidSchema })).output(z.array(z.any()))
+  }
+};
+var assetsContract = {
+  list: oc.input(
+    paginationSchema.extend({
+      branchId: uuidSchema,
+      category: assetCategoryEnum.optional(),
+      search: z.string().optional()
+    })
+  ).output(z.object({ data: z.array(z.any()), total: z.number() })),
+  create: oc.input(
+    z.object({
+      name: z.string(),
+      category: assetCategoryEnum,
+      serialNo: z.string().optional(),
+      purchaseDate: z.string(),
+      purchaseCost: z.number(),
+      supplier: z.string().optional(),
+      warrantyExpiry: z.string().optional(),
+      condition: assetConditionEnum,
+      depreciationRate: z.number().min(0).max(100)
+    })
+  ).output(z.object({ id: uuidSchema })),
+  assign: oc.input(
+    z.object({
+      assetId: uuidSchema,
+      staffId: uuidSchema.optional(),
+      room: z.string().optional()
+    })
+  ).output(z.object({ success: z.boolean() })),
+  ticket: {
+    create: oc.input(
+      z.object({
+        assetId: uuidSchema,
+        description: z.string(),
+        severity: z.string()
+      })
+    ).output(z.object({ id: uuidSchema })),
+    update: oc.input(
+      z.object({
+        ticketId: uuidSchema,
+        status: maintenanceTicketStatusEnum,
+        notes: z.string().optional(),
+        cost: z.number().optional()
+      })
+    ).output(z.object({ success: z.boolean() }))
+  }
+};
+var libraryContract = {
+  books: {
+    list: oc.input(
+      paginationSchema.extend({
+        branchId: uuidSchema,
+        search: z.string().optional(),
+        available: z.boolean().optional()
+      })
+    ).output(z.object({ data: z.array(z.any()), total: z.number() })),
+    create: oc.input(
+      z.object({
+        isbn: z.string(),
+        title: z.string(),
+        author: z.string(),
+        publisher: z.string().optional(),
+        year: z.number().optional(),
+        subjectArea: z.string().optional(),
+        copiesTotal: z.number().min(1),
+        shelfLocation: z.string().optional()
+      })
+    ).output(z.object({ id: uuidSchema }))
+  },
+  borrowings: {
+    checkout: oc.input(
+      z.object({
+        bookId: uuidSchema,
+        borrowerType: z.enum(["student", "staff"]),
+        borrowerId: uuidSchema,
+        dueDate: z.string()
+      })
+    ).output(z.object({ id: uuidSchema })),
+    return: oc.input(
+      z.object({ borrowingId: uuidSchema, condition: z.string().optional() })
+    ).output(z.object({ fine: z.number() })),
+    listOverdue: oc.input(z.object({ branchId: uuidSchema })).output(z.array(z.any()))
+  }
+};
+var disciplineContract = {
+  incidents: {
+    log: oc.input(
+      z.object({
+        studentId: uuidSchema,
+        incidentType: z.string(),
+        description: z.string(),
+        severity: incidentSeverityEnum,
+        incidentDate: z.string(),
+        requiresCounsellor: z.boolean().default(false)
+      })
+    ).output(z.object({ id: uuidSchema })),
+    list: oc.input(
+      paginationSchema.extend({
+        branchId: uuidSchema,
+        studentId: uuidSchema.optional(),
+        status: incidentStatusEnum.optional()
+      })
+    ).output(z.object({ data: z.array(z.any()), total: z.number() })),
+    rule: oc.input(
+      z.object({
+        incidentId: uuidSchema,
+        ruling: disciplineRulingEnum,
+        suspensionDays: z.number().optional(),
+        notes: z.string()
+      })
+    ).output(z.object({ success: z.boolean() }))
+  }
+};
+var commsContract = {
+  notifications: {
+    list: oc.input(paginationSchema.extend({ unreadOnly: z.boolean().optional() })).output(z.object({ data: z.array(z.any()), unreadCount: z.number() })),
+    markRead: oc.input(z.object({ ids: z.array(uuidSchema) })).output(z.object({ updated: z.number() }))
+  },
+  messages: {
+    list: oc.input(paginationSchema).output(z.array(z.any())),
+    send: oc.input(
+      z.object({
+        recipientId: uuidSchema,
+        subject: z.string(),
+        body: z.string(),
+        parentId: uuidSchema.optional()
+      })
+    ).output(z.object({ id: uuidSchema }))
+  },
+  sms: {
+    send: oc.input(sendBulkSmsInputSchema).output(z.object({ queued: z.number() }))
+  },
+  notices: {
+    list: oc.input(z.object({ branchId: uuidSchema, active: z.boolean().optional() })).output(z.array(z.any())),
+    create: oc.input(
+      z.object({
+        title: z.string(),
+        body: z.string(),
+        audienceType: z.string(),
+        audienceIds: z.array(uuidSchema).optional(),
+        publishAt: z.string().optional(),
+        expiresAt: z.string().optional()
+      })
+    ).output(z.object({ id: uuidSchema }))
+  }
+};
+var adminContract = {
+  auditLogs: {
+    list: oc.input(
+      paginationSchema.extend({
+        branchId: uuidSchema.optional(),
+        userId: uuidSchema.optional(),
+        action: z.string().optional(),
+        from: z.string().optional(),
+        to: z.string().optional()
+      })
+    ).output(z.object({ data: z.array(z.any()), total: z.number() }))
+  },
+  users: {
+    create: oc.input(
+      z.object({
+        firstName: z.string(),
+        middleName: z.string().optional(),
+        lastName: z.string(),
+        email: z.string().email(),
+        phone: z.string().optional(),
+        roleId: uuidSchema,
+        branchId: uuidSchema,
+        temporaryPassword: z.string().min(8)
+      })
+    ).output(z.object({ id: uuidSchema })),
+    suspend: oc.input(z.object({ userId: uuidSchema, reason: z.string() })).output(z.object({ success: z.boolean() }))
+  },
+  roles: {
+    list: oc.input(z.object({ branchId: uuidSchema })).output(
+      z.array(
+        z.object({
+          id: uuidSchema,
+          name: z.string(),
+          isSystem: z.boolean(),
+          permissionCount: z.number()
+        })
+      )
+    ),
+    create: oc.input(
+      z.object({
+        name: z.string(),
+        description: z.string().optional(),
+        permissionIds: z.array(uuidSchema)
+      })
+    ).output(z.object({ id: uuidSchema }))
+  }
+};
+var storageContract = {
+  presignUpload: oc.input(
+    z.object({
+      fileName: z.string(),
+      mimeType: z.string(),
+      category: z.enum([
+        "student_photo",
+        "staff_photo",
+        "document",
+        "payslip",
+        "report_card",
+        "asset_photo",
+        "notice_attachment"
+      ]),
+      resourceId: uuidSchema.optional()
+    })
+  ).output(
+    z.object({
+      uploadUrl: z.string(),
+      fileKey: z.string(),
+      expiresIn: z.number()
+    })
+  ),
+  confirmUpload: oc.input(
+    z.object({
+      fileKey: z.string(),
+      resourceId: uuidSchema,
+      resourceType: z.string()
+    })
+  ).output(z.object({ publicUrl: z.string() }))
+};
+var appContract = {
+  auth: authContract,
+  branches: branchesContract,
+  students: studentsContract,
+  academics: academicsContract,
+  finance: financeContract,
+  hr: hrContract,
+  payroll: payrollContract,
+  transport: transportContract,
+  assets: assetsContract,
+  library: libraryContract,
+  discipline: disciplineContract,
+  comms: commsContract,
+  admin: adminContract,
+  storage: storageContract
+};
+
+export {
+  authContract,
+  branchesContract,
+  studentsContract,
+  academicsContract,
+  financeContract,
+  hrContract,
+  payrollContract,
+  transportContract,
+  assetsContract,
+  libraryContract,
+  disciplineContract,
+  commsContract,
+  adminContract,
+  storageContract,
+  appContract
+};
+//# sourceMappingURL=chunk-TV57ZLZQ.mjs.map