@brite-future-schools-contracts/contracts 2.0.3 → 2.0.5

package/dist/index.cjs

@@ -30,11 +30,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  AttendanceRecordInputSchema: () => AttendanceRecordInputSchema,
+  AttendanceStatusSchema: () => AttendanceStatusSchema,
   BranchRefSchema: () => BranchRefSchema,
   BulkUploadStudentRowSchema: () => BulkUploadStudentRowSchema,
   BulkUploadStudentsInputSchema: () => BulkUploadStudentsInputSchema,
   BulkUploadStudentsOutputSchema: () => BulkUploadStudentsOutputSchema,
   ChangePasswordInputSchema: () => ChangePasswordInputSchema,
+  ClassAttendanceRowSchema: () => ClassAttendanceRowSchema,
   ClassSummarySchema: () => ClassSummarySchema,
   CreateDepartmentInputSchema: () => CreateDepartmentInputSchema,
   CreateStaffInputSchema: () => CreateStaffInputSchema,
@@ -45,6 +48,8 @@ __export(src_exports, {
   DepartmentSchema: () => DepartmentSchema,
   EmploymentTypeSchema: () => EmploymentTypeSchema,
   GenderSchema: () => GenderSchema,
+  GetByClassInputSchema: () => GetByClassInputSchema,
+  GetByStudentInputSchema: () => GetByStudentInputSchema,
   GradeLevelSchema: () => GradeLevelSchema,
   LinkGuardianInputSchema: () => LinkGuardianInputSchema,
   ListStaffInputSchema: () => ListStaffInputSchema,
@@ -52,6 +57,8 @@ __export(src_exports, {
   LoginInputSchema: () => LoginInputSchema,
   LoginOutputSchema: () => LoginOutputSchema,
   LogoutInputSchema: () => LogoutInputSchema,
+  MarkAttendanceInputSchema: () => MarkAttendanceInputSchema,
+  MarkAttendanceOutputSchema: () => MarkAttendanceOutputSchema,
   PaginationInputSchema: () => PaginationInputSchema,
   RefreshTokenInputSchema: () => RefreshTokenInputSchema,
   RefreshTokenOutputSchema: () => RefreshTokenOutputSchema,
@@ -64,29 +71,74 @@ __export(src_exports, {
   SoftDeleteSchema: () => SoftDeleteSchema,
   StaffListItemSchema: () => StaffListItemSchema,
   StaffProfileSchema: () => StaffProfileSchema,
+  StudentAttendanceRowSchema: () => StudentAttendanceRowSchema,
   StudentListItemSchema: () => StudentListItemSchema,
   StudentProfileSchema: () => StudentProfileSchema,
   StudentStatusSchema: () => StudentStatusSchema,
   SwitchBranchInputSchema: () => SwitchBranchInputSchema,
+  TermSchema: () => TermSchema,
   TimestampsSchema: () => TimestampsSchema,
   UuidSchema: () => UuidSchema,
+  attendanceContract: () => attendanceContract,
   authContract: () => authContract,
   bulkUploadStudentsContract: () => bulkUploadStudentsContract,
+  canAccessAdminDashboard: () => canAccessAdminDashboard,
+  canManageStaff: () => canManageStaff,
+  canManageStudents: () => canManageStudents,
+  canMarkClassAttendance: () => canMarkClassAttendance,
+  canMarkStaffAttendance: () => canMarkStaffAttendance,
+  canViewClassAttendance: () => canViewClassAttendance,
+  canViewStaffAttendance: () => canViewStaffAttendance,
+  canViewStaffList: () => canViewStaffList,
+  canViewStudentList: () => canViewStudentList,
   changePasswordContract: () => changePasswordContract,
   createDepartmentContract: () => createDepartmentContract,
   createStaffContract: () => createStaffContract,
   createStudentContract: () => createStudentContract,
+  getByClassContract: () => getByClassContract,
+  getByStudentContract: () => getByStudentContract,
   getMeContract: () => getMeContract,
   getStaffByIdContract: () => getStaffByIdContract,
   getStudentByIdContract: () => getStudentByIdContract,
   hrContract: () => hrContract,
+  isBoardingMaster: () => isBoardingMaster,
+  isBursar: () => isBursar,
+  isCaretaker: () => isCaretaker,
+  isClassTeacher: () => isClassTeacher,
+  isCounsellor: () => isCounsellor,
+  isDeputyPrincipal: () => isDeputyPrincipal,
+  isDirector: () => isDirector,
+  isDriver: () => isDriver,
+  isHOD: () => isHOD,
+  isHrAdmin: () => isHrAdmin,
+  isIndividualSponsor: () => isIndividualSponsor,
+  isItAdmin: () => isItAdmin,
+  isKitchenManager: () => isKitchenManager,
+  isKitchenStaff: () => isKitchenStaff,
+  isLabTechnician: () => isLabTechnician,
+  isLibrarian: () => isLibrarian,
+  isOrgSponsor: () => isOrgSponsor,
+  isParent: () => isParent,
+  isPrefect: () => isPrefect,
+  isPrincipal: () => isPrincipal,
+  isProprietor: () => isProprietor,
+  isSchoolNurse: () => isSchoolNurse,
+  isSecurity: () => isSecurity,
+  isSeniorLeadership: () => isSeniorLeadership,
+  isSportsCoach: () => isSportsCoach,
+  isStaff: () => isStaff,
+  isStudent: () => isStudent,
+  isSubjectTeacher: () => isSubjectTeacher,
+  isSystemAdmin: () => isSystemAdmin,
   linkGuardianContract: () => linkGuardianContract,
   listClassesContract: () => listClassesContract,
   listDepartmentsContract: () => listDepartmentsContract,
   listStaffContract: () => listStaffContract,
   listStudentsContract: () => listStudentsContract,
+  listTermsContract: () => listTermsContract,
   loginContract: () => loginContract,
   logoutContract: () => logoutContract,
+  markAttendanceContract: () => markAttendanceContract,
   paginatedOutputSchema: () => paginatedOutputSchema,
   refreshTokenContract: () => refreshTokenContract,
   requestPasswordResetContract: () => requestPasswordResetContract,
@@ -531,10 +583,72 @@ var ClassSummarySchema = z4.object({
   classTeacherId: UuidSchema.nullable()
 });
 
+// src/schemas/attendance.ts
+var z5 = __toESM(require("zod"), 1);
+var AttendanceStatusSchema = z5.enum([
+  "present",
+  "absent",
+  "late",
+  "excused"
+]);
+var TermSchema = z5.object({
+  id: UuidSchema,
+  branchId: UuidSchema,
+  academicYearId: UuidSchema,
+  name: z5.string(),
+  startDate: z5.string(),
+  endDate: z5.string(),
+  isCurrent: z5.boolean()
+});
+var AttendanceRecordInputSchema = z5.object({
+  studentId: UuidSchema,
+  status: AttendanceStatusSchema,
+  notes: z5.string().max(500).optional()
+});
+var MarkAttendanceInputSchema = z5.object({
+  classId: UuidSchema,
+  termId: UuidSchema,
+  date: z5.iso.date(),
+  records: z5.array(AttendanceRecordInputSchema).min(1)
+});
+var MarkAttendanceOutputSchema = z5.object({
+  count: z5.number(),
+  date: z5.string(),
+  classId: UuidSchema
+});
+var GetByClassInputSchema = z5.object({
+  classId: UuidSchema,
+  date: z5.iso.date()
+});
+var ClassAttendanceRowSchema = z5.object({
+  id: UuidSchema,
+  studentId: UuidSchema,
+  firstName: z5.string(),
+  middleName: z5.string().nullable(),
+  lastName: z5.string(),
+  admissionNo: z5.string(),
+  status: AttendanceStatusSchema,
+  notes: z5.string().nullable(),
+  markedBy: UuidSchema,
+  updatedAt: z5.string()
+});
+var GetByStudentInputSchema = z5.object({
+  studentId: UuidSchema,
+  termId: UuidSchema
+});
+var StudentAttendanceRowSchema = z5.object({
+  id: UuidSchema,
+  date: z5.string(),
+  status: AttendanceStatusSchema,
+  notes: z5.string().nullable(),
+  classId: UuidSchema,
+  className: z5.string()
+});
+
 // src/contracts/auth.ts
 var import_contract = require("@orpc/contract");
-var z5 = __toESM(require("zod"), 1);
-var EmptyOutputSchema = z5.object({}).meta({ description: "Empty success response" });
+var z6 = __toESM(require("zod"), 1);
+var EmptyOutputSchema = z6.object({}).meta({ description: "Empty success response" });
 var loginContract = import_contract.oc.route({ method: "POST", path: "/auth/login" }).input(LoginInputSchema).output(LoginOutputSchema);
 var refreshTokenContract = import_contract.oc.route({ method: "POST", path: "/auth/refresh" }).input(RefreshTokenInputSchema).output(RefreshTokenOutputSchema);
 var logoutContract = import_contract.oc.route({ method: "POST", path: "/auth/logout" }).input(LogoutInputSchema).output(EmptyOutputSchema);
@@ -556,20 +670,20 @@ var authContract = {
 
 // src/contracts/hr.ts
 var import_contract2 = require("@orpc/contract");
-var z6 = __toESM(require("zod"), 1);
-var EmptyOutput = z6.object({});
+var z7 = __toESM(require("zod"), 1);
+var EmptyOutput = z7.object({});
 var createStaffContract = import_contract2.oc.route({ method: "POST", path: "/hr/staff" }).input(CreateStaffInputSchema).output(CreateStaffOutputSchema);
-var listStaffContract = import_contract2.oc.route({ method: "GET", path: "/hr/staff" }).input(ListStaffInputSchema).output(z6.object({
-  items: z6.array(StaffListItemSchema),
-  total: z6.number(),
+var listStaffContract = import_contract2.oc.route({ method: "GET", path: "/hr/staff" }).input(ListStaffInputSchema).output(z7.object({
+  items: z7.array(StaffListItemSchema),
+  total: z7.number(),
   nextCursor: UuidSchema.nullable()
 }));
-var getStaffByIdContract = import_contract2.oc.route({ method: "GET", path: "/hr/staff/{id}" }).input(z6.object({ id: UuidSchema })).output(StaffProfileSchema);
-var updateStaffStatusContract = import_contract2.oc.route({ method: "PATCH", path: "/hr/staff/{id}/status" }).input(z6.object({
+var getStaffByIdContract = import_contract2.oc.route({ method: "GET", path: "/hr/staff/{id}" }).input(z7.object({ id: UuidSchema })).output(StaffProfileSchema);
+var updateStaffStatusContract = import_contract2.oc.route({ method: "PATCH", path: "/hr/staff/{id}/status" }).input(z7.object({
   id: UuidSchema,
-  status: z6.enum(["active", "inactive", "suspended"])
+  status: z7.enum(["active", "inactive", "suspended"])
 })).output(EmptyOutput);
-var listDepartmentsContract = import_contract2.oc.route({ method: "GET", path: "/hr/departments" }).input(z6.object({ branchId: UuidSchema.optional() })).output(z6.array(DepartmentSchema));
+var listDepartmentsContract = import_contract2.oc.route({ method: "GET", path: "/hr/departments" }).input(z7.object({ branchId: UuidSchema.optional() })).output(z7.array(DepartmentSchema));
 var createDepartmentContract = import_contract2.oc.route({ method: "POST", path: "/hr/departments" }).input(CreateDepartmentInputSchema).output(DepartmentSchema);
 var hrContract = {
   createStaff: createStaffContract,
@@ -582,21 +696,21 @@ var hrContract = {
 
 // src/contracts/students.ts
 var import_contract3 = require("@orpc/contract");
-var z7 = __toESM(require("zod"), 1);
-var EmptyOutput2 = z7.object({});
+var z8 = __toESM(require("zod"), 1);
+var EmptyOutput2 = z8.object({});
 var createStudentContract = import_contract3.oc.route({ method: "POST", path: "/students" }).input(CreateStudentInputSchema).output(CreateStudentOutputSchema);
 var bulkUploadStudentsContract = import_contract3.oc.route({ method: "POST", path: "/students/bulk" }).input(BulkUploadStudentsInputSchema).output(BulkUploadStudentsOutputSchema);
-var listStudentsContract = import_contract3.oc.route({ method: "GET", path: "/students" }).input(ListStudentsInputSchema).output(z7.object({
-  items: z7.array(StudentListItemSchema),
-  total: z7.number(),
+var listStudentsContract = import_contract3.oc.route({ method: "GET", path: "/students" }).input(ListStudentsInputSchema).output(z8.object({
+  items: z8.array(StudentListItemSchema),
+  total: z8.number(),
   nextCursor: UuidSchema.nullable()
 }));
-var getStudentByIdContract = import_contract3.oc.route({ method: "GET", path: "/students/{id}" }).input(z7.object({ id: UuidSchema })).output(StudentProfileSchema);
-var linkGuardianContract = import_contract3.oc.route({ method: "POST", path: "/students/guardians" }).input(LinkGuardianInputSchema).output(z7.object({ guardianId: UuidSchema }));
-var listClassesContract = import_contract3.oc.route({ method: "GET", path: "/students/classes" }).input(z7.object({
+var getStudentByIdContract = import_contract3.oc.route({ method: "GET", path: "/students/{id}" }).input(z8.object({ id: UuidSchema })).output(StudentProfileSchema);
+var linkGuardianContract = import_contract3.oc.route({ method: "POST", path: "/students/guardians" }).input(LinkGuardianInputSchema).output(z8.object({ guardianId: UuidSchema }));
+var listClassesContract = import_contract3.oc.route({ method: "GET", path: "/students/classes" }).input(z8.object({
   termId: UuidSchema.optional(),
-  gradeLevel: z7.string().optional()
-})).output(z7.array(ClassSummarySchema));
+  gradeLevel: z8.string().optional()
+})).output(z8.array(ClassSummarySchema));
 var studentsContract = {
   create: createStudentContract,
   bulkUpload: bulkUploadStudentsContract,
@@ -605,13 +719,180 @@ var studentsContract = {
   linkGuardian: linkGuardianContract,
   listClasses: listClassesContract
 };
+
+// src/contracts/attendance.ts
+var import_contract4 = require("@orpc/contract");
+var z9 = __toESM(require("zod"), 1);
+var markAttendanceContract = import_contract4.oc.route({ method: "POST", path: "/attendance/class/mark" }).input(MarkAttendanceInputSchema).output(MarkAttendanceOutputSchema);
+var getByClassContract = import_contract4.oc.route({ method: "GET", path: "/attendance/class" }).input(GetByClassInputSchema).output(z9.array(ClassAttendanceRowSchema));
+var getByStudentContract = import_contract4.oc.route({ method: "GET", path: "/attendance/student" }).input(GetByStudentInputSchema).output(z9.array(StudentAttendanceRowSchema));
+var listTermsContract = import_contract4.oc.route({ method: "GET", path: "/terms" }).input(z9.object({})).output(z9.array(TermSchema));
+var attendanceContract = {
+  mark: markAttendanceContract,
+  getByClass: getByClassContract,
+  getByStudent: getByStudentContract,
+  listTerms: listTermsContract
+};
+
+// src/roles/helpers.ts
+function hasRole(user, role) {
+  return user.roles.some(
+    (r) => r.name === role && r.branchId === user.activeBranchId
+  );
+}
+function isProprietor(user) {
+  return hasRole(user, "PROPRIETOR");
+}
+function isDirector(user) {
+  return hasRole(user, "DIRECTOR");
+}
+function isSystemAdmin(user) {
+  return hasRole(user, "SYSTEM_ADMIN");
+}
+function isPrincipal(user) {
+  return hasRole(user, "PRINCIPAL");
+}
+function isDeputyPrincipal(user) {
+  return hasRole(user, "DEPUTY_PRINCIPAL");
+}
+function isSeniorLeadership(user) {
+  return isProprietor(user) || isDirector(user) || isPrincipal(user) || isDeputyPrincipal(user);
+}
+function isHOD(user) {
+  return hasRole(user, "HOD");
+}
+function isClassTeacher(user) {
+  return hasRole(user, "CLASS_TEACHER");
+}
+function isSubjectTeacher(user) {
+  return hasRole(user, "SUBJECT_TEACHER");
+}
+function isSchoolNurse(user) {
+  return hasRole(user, "SCHOOL_NURSE");
+}
+function isLibrarian(user) {
+  return hasRole(user, "LIBRARIAN");
+}
+function isLabTechnician(user) {
+  return hasRole(user, "LAB_TECHNICIAN");
+}
+function isSportsCoach(user) {
+  return hasRole(user, "SPORTS_COACH");
+}
+function isCounsellor(user) {
+  return hasRole(user, "COUNSELLOR");
+}
+function isCaretaker(user) {
+  return hasRole(user, "CARETAKER");
+}
+function isSecurity(user) {
+  return hasRole(user, "SECURITY");
+}
+function isBoardingMaster(user) {
+  return hasRole(user, "BOARDING_MASTER");
+}
+function isBursar(user) {
+  return hasRole(user, "BURSAR");
+}
+function isHrAdmin(user) {
+  return hasRole(user, "HR_ADMIN");
+}
+function isDriver(user) {
+  return hasRole(user, "DRIVER");
+}
+function isKitchenStaff(user) {
+  return hasRole(user, "KITCHEN_STAFF");
+}
+function isKitchenManager(user) {
+  return hasRole(user, "KITCHEN_MANAGER");
+}
+function isItAdmin(user) {
+  return hasRole(user, "IT_ADMIN");
+}
+function isPrefect(user) {
+  return hasRole(user, "PREFECT");
+}
+function isStudent(user) {
+  return hasRole(user, "STUDENT");
+}
+function isParent(user) {
+  return hasRole(user, "PARENT");
+}
+function isOrgSponsor(user) {
+  return hasRole(user, "ORG_SPONSOR");
+}
+function isIndividualSponsor(user) {
+  return hasRole(user, "INDIVIDUAL_SPONSOR");
+}
+function isStaff(user) {
+  const staffRoles = [
+    "PROPRIETOR",
+    "DIRECTOR",
+    "SYSTEM_ADMIN",
+    "PRINCIPAL",
+    "DEPUTY_PRINCIPAL",
+    "HOD",
+    "CLASS_TEACHER",
+    "SUBJECT_TEACHER",
+    "BURSAR",
+    "HR_ADMIN",
+    "SCHOOL_NURSE",
+    "LIBRARIAN",
+    "LAB_TECHNICIAN",
+    "SPORTS_COACH",
+    "COUNSELLOR",
+    "CARETAKER",
+    "SECURITY",
+    "KITCHEN_STAFF",
+    "KITCHEN_MANAGER",
+    "DRIVER",
+    "IT_ADMIN",
+    "BOARDING_MASTER",
+    "PREFECT"
+  ];
+  return user.roles.some(
+    (r) => staffRoles.includes(r.name) && r.branchId === user.activeBranchId
+  );
+}
+
+// src/permissions/index.ts
+function canMarkClassAttendance(user) {
+  return isClassTeacher(user) || isHOD(user) || isPrincipal(user) || isDeputyPrincipal(user) || isSystemAdmin(user);
+}
+function canViewClassAttendance(user) {
+  return canMarkClassAttendance(user) || isDirector(user) || isProprietor(user);
+}
+function canMarkStaffAttendance(user) {
+  return isHrAdmin(user) || isPrincipal(user) || isDeputyPrincipal(user) || isSystemAdmin(user);
+}
+function canViewStaffAttendance(user) {
+  return canMarkStaffAttendance(user) || isDirector(user) || isProprietor(user);
+}
+function canViewStaffList(user) {
+  return isHrAdmin(user) || isPrincipal(user) || isDeputyPrincipal(user) || isSystemAdmin(user) || isDirector(user) || isProprietor(user);
+}
+function canManageStaff(user) {
+  return isHrAdmin(user) || isPrincipal(user) || isSystemAdmin(user) || isDirector(user) || isProprietor(user);
+}
+function canViewStudentList(user) {
+  return isClassTeacher(user) || isHOD(user) || isPrincipal(user) || isDeputyPrincipal(user) || isHrAdmin(user) || isSystemAdmin(user) || isDirector(user) || isProprietor(user);
+}
+function canManageStudents(user) {
+  return isPrincipal(user) || isDeputyPrincipal(user) || isHrAdmin(user) || isSystemAdmin(user) || isDirector(user) || isProprietor(user);
+}
+function canAccessAdminDashboard(user) {
+  return !isStudent(user) && !isParent(user) && !isPrefect(user) && !isOrgSponsor(user) && !isIndividualSponsor(user);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AttendanceRecordInputSchema,
+  AttendanceStatusSchema,
   BranchRefSchema,
   BulkUploadStudentRowSchema,
   BulkUploadStudentsInputSchema,
   BulkUploadStudentsOutputSchema,
   ChangePasswordInputSchema,
+  ClassAttendanceRowSchema,
   ClassSummarySchema,
   CreateDepartmentInputSchema,
   CreateStaffInputSchema,
@@ -622,6 +903,8 @@ var studentsContract = {
   DepartmentSchema,
   EmploymentTypeSchema,
   GenderSchema,
+  GetByClassInputSchema,
+  GetByStudentInputSchema,
   GradeLevelSchema,
   LinkGuardianInputSchema,
   ListStaffInputSchema,
@@ -629,6 +912,8 @@ var studentsContract = {
   LoginInputSchema,
   LoginOutputSchema,
   LogoutInputSchema,
+  MarkAttendanceInputSchema,
+  MarkAttendanceOutputSchema,
   PaginationInputSchema,
   RefreshTokenInputSchema,
   RefreshTokenOutputSchema,
@@ -641,29 +926,74 @@ var studentsContract = {
   SoftDeleteSchema,
   StaffListItemSchema,
   StaffProfileSchema,
+  StudentAttendanceRowSchema,
   StudentListItemSchema,
   StudentProfileSchema,
   StudentStatusSchema,
   SwitchBranchInputSchema,
+  TermSchema,
   TimestampsSchema,
   UuidSchema,
+  attendanceContract,
   authContract,
   bulkUploadStudentsContract,
+  canAccessAdminDashboard,
+  canManageStaff,
+  canManageStudents,
+  canMarkClassAttendance,
+  canMarkStaffAttendance,
+  canViewClassAttendance,
+  canViewStaffAttendance,
+  canViewStaffList,
+  canViewStudentList,
   changePasswordContract,
   createDepartmentContract,
   createStaffContract,
   createStudentContract,
+  getByClassContract,
+  getByStudentContract,
   getMeContract,
   getStaffByIdContract,
   getStudentByIdContract,
   hrContract,
+  isBoardingMaster,
+  isBursar,
+  isCaretaker,
+  isClassTeacher,
+  isCounsellor,
+  isDeputyPrincipal,
+  isDirector,
+  isDriver,
+  isHOD,
+  isHrAdmin,
+  isIndividualSponsor,
+  isItAdmin,
+  isKitchenManager,
+  isKitchenStaff,
+  isLabTechnician,
+  isLibrarian,
+  isOrgSponsor,
+  isParent,
+  isPrefect,
+  isPrincipal,
+  isProprietor,
+  isSchoolNurse,
+  isSecurity,
+  isSeniorLeadership,
+  isSportsCoach,
+  isStaff,
+  isStudent,
+  isSubjectTeacher,
+  isSystemAdmin,
   linkGuardianContract,
   listClassesContract,
   listDepartmentsContract,
   listStaffContract,
   listStudentsContract,
+  listTermsContract,
   loginContract,
   logoutContract,
+  markAttendanceContract,
   paginatedOutputSchema,
   refreshTokenContract,
   requestPasswordResetContract,