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

package/dist/contracts/index.js

@@ -1,24 +1,52 @@
 import {
   authContract,
+  bulkUploadStudentsContract,
   changePasswordContract,
+  createDepartmentContract,
+  createStaffContract,
+  createStudentContract,
   getMeContract,
+  getStaffByIdContract,
+  getStudentByIdContract,
+  hrContract,
+  linkGuardianContract,
+  listClassesContract,
+  listDepartmentsContract,
+  listStaffContract,
+  listStudentsContract,
   loginContract,
   logoutContract,
   refreshTokenContract,
   requestPasswordResetContract,
   resetPasswordContract,
-  switchBranchContract
-} from "../chunk-IR6JUP6L.js";
-import "../chunk-AEZO7MJD.js";
+  studentsContract,
+  switchBranchContract,
+  updateStaffStatusContract
+} from "../chunk-S3BK5YEH.js";
+import "../chunk-3OMU2YSE.js";
 export {
   authContract,
+  bulkUploadStudentsContract,
   changePasswordContract,
+  createDepartmentContract,
+  createStaffContract,
+  createStudentContract,
   getMeContract,
+  getStaffByIdContract,
+  getStudentByIdContract,
+  hrContract,
+  linkGuardianContract,
+  listClassesContract,
+  listDepartmentsContract,
+  listStaffContract,
+  listStudentsContract,
   loginContract,
   logoutContract,
   refreshTokenContract,
   requestPasswordResetContract,
   resetPasswordContract,
-  switchBranchContract
+  studentsContract,
+  switchBranchContract,
+  updateStaffStatusContract
 };
 //# sourceMappingURL=index.js.map

package/dist/index.cjs

@@ -31,8 +31,24 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   BranchRefSchema: () => BranchRefSchema,
+  BulkUploadStudentRowSchema: () => BulkUploadStudentRowSchema,
+  BulkUploadStudentsInputSchema: () => BulkUploadStudentsInputSchema,
+  BulkUploadStudentsOutputSchema: () => BulkUploadStudentsOutputSchema,
   ChangePasswordInputSchema: () => ChangePasswordInputSchema,
+  ClassSummarySchema: () => ClassSummarySchema,
+  CreateDepartmentInputSchema: () => CreateDepartmentInputSchema,
+  CreateStaffInputSchema: () => CreateStaffInputSchema,
+  CreateStaffOutputSchema: () => CreateStaffOutputSchema,
+  CreateStudentInputSchema: () => CreateStudentInputSchema,
+  CreateStudentOutputSchema: () => CreateStudentOutputSchema,
   CuidSchema: () => CuidSchema,
+  DepartmentSchema: () => DepartmentSchema,
+  EmploymentTypeSchema: () => EmploymentTypeSchema,
+  GenderSchema: () => GenderSchema,
+  GradeLevelSchema: () => GradeLevelSchema,
+  LinkGuardianInputSchema: () => LinkGuardianInputSchema,
+  ListStaffInputSchema: () => ListStaffInputSchema,
+  ListStudentsInputSchema: () => ListStudentsInputSchema,
   LoginInputSchema: () => LoginInputSchema,
   LoginOutputSchema: () => LoginOutputSchema,
   LogoutInputSchema: () => LogoutInputSchema,
@@ -41,23 +57,43 @@ __export(src_exports, {
   RefreshTokenOutputSchema: () => RefreshTokenOutputSchema,
   RequestPasswordResetInputSchema: () => RequestPasswordResetInputSchema,
   ResetPasswordInputSchema: () => ResetPasswordInputSchema,
+  RoleNameSchema: () => RoleNameSchema,
   SessionUserOutputSchema: () => SessionUserOutputSchema,
   SessionUserRoleSchema: () => SessionUserRoleSchema,
   SessionUserSubRoleSchema: () => SessionUserSubRoleSchema,
   SoftDeleteSchema: () => SoftDeleteSchema,
+  StaffListItemSchema: () => StaffListItemSchema,
+  StaffProfileSchema: () => StaffProfileSchema,
+  StudentListItemSchema: () => StudentListItemSchema,
+  StudentProfileSchema: () => StudentProfileSchema,
+  StudentStatusSchema: () => StudentStatusSchema,
   SwitchBranchInputSchema: () => SwitchBranchInputSchema,
   TimestampsSchema: () => TimestampsSchema,
   UuidSchema: () => UuidSchema,
   authContract: () => authContract,
+  bulkUploadStudentsContract: () => bulkUploadStudentsContract,
   changePasswordContract: () => changePasswordContract,
+  createDepartmentContract: () => createDepartmentContract,
+  createStaffContract: () => createStaffContract,
+  createStudentContract: () => createStudentContract,
   getMeContract: () => getMeContract,
+  getStaffByIdContract: () => getStaffByIdContract,
+  getStudentByIdContract: () => getStudentByIdContract,
+  hrContract: () => hrContract,
+  linkGuardianContract: () => linkGuardianContract,
+  listClassesContract: () => listClassesContract,
+  listDepartmentsContract: () => listDepartmentsContract,
+  listStaffContract: () => listStaffContract,
+  listStudentsContract: () => listStudentsContract,
   loginContract: () => loginContract,
   logoutContract: () => logoutContract,
   paginatedOutputSchema: () => paginatedOutputSchema,
   refreshTokenContract: () => refreshTokenContract,
   requestPasswordResetContract: () => requestPasswordResetContract,
   resetPasswordContract: () => resetPasswordContract,
-  switchBranchContract: () => switchBranchContract
+  studentsContract: () => studentsContract,
+  switchBranchContract: () => switchBranchContract,
+  updateStaffStatusContract: () => updateStaffStatusContract
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -166,10 +202,339 @@ var SwitchBranchInputSchema = z2.object({
   branchId: CuidSchema.meta({ description: "Branch to switch the active session to" })
 });
 
+// src/schemas/hr.ts
+var z3 = __toESM(require("zod"), 1);
+var EmploymentTypeSchema = z3.enum([
+  "permanent",
+  "contract",
+  "temporary",
+  "intern"
+]);
+var RoleNameSchema = z3.enum([
+  "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",
+  "STUDENT",
+  "PARENT",
+  "ORG_SPONSOR",
+  "INDIVIDUAL_SPONSOR"
+]);
+var CreateStaffInputSchema = z3.object({
+  // Personal details
+  firstName: z3.string().min(1).max(100),
+  middleName: z3.string().max(100).optional(),
+  lastName: z3.string().min(1).max(100),
+  email: z3.email(),
+  phone: z3.string().min(9).max(30),
+  nationalId: z3.string().min(1).max(20),
+  // Role assignment
+  roleName: RoleNameSchema.meta({
+    description: "System role to assign \u2014 determines dashboard access and permissions"
+  }),
+  isPrimaryRole: z3.boolean().default(true),
+  // Employment details
+  departmentId: UuidSchema.optional(),
+  designation: z3.string().min(1).max(100).meta({
+    description: 'Job title, e.g. "Mathematics Teacher", "Head of Finance"'
+  }),
+  employmentType: EmploymentTypeSchema,
+  contractStart: z3.iso.date().meta({ description: "ISO date, e.g. 2026-01-15" }),
+  contractEnd: z3.iso.date().optional(),
+  // Payroll
+  basicSalary: z3.number().positive(),
+  houseAllowance: z3.number().nonnegative().default(0),
+  transportAllowance: z3.number().nonnegative().default(0),
+  helbDeduction: z3.number().nonnegative().default(0),
+  saccoDeduction: z3.number().nonnegative().default(0),
+  // Banking
+  bankName: z3.string().max(100).optional(),
+  bankAccount: z3.string().max(30).optional(),
+  bankBranch: z3.string().max(100).optional(),
+  // Statutory
+  tscNumber: z3.string().max(30).optional(),
+  kraPin: z3.string().max(20).optional(),
+  nhifNo: z3.string().max(20).optional(),
+  nssfNo: z3.string().max(20).optional()
+});
+var StaffProfileSchema = z3.object({
+  // Staff record
+  id: UuidSchema,
+  userId: UuidSchema,
+  branchId: UuidSchema,
+  firstName: z3.string(),
+  middleName: z3.string().nullable(),
+  lastName: z3.string(),
+  phone: z3.string(),
+  nationalId: z3.string(),
+  tscNumber: z3.string().nullable(),
+  kraPin: z3.string().nullable(),
+  nhifNo: z3.string().nullable(),
+  nssfNo: z3.string().nullable(),
+  designation: z3.string(),
+  employmentType: EmploymentTypeSchema,
+  contractStart: z3.string(),
+  contractEnd: z3.string().nullable(),
+  basicSalary: z3.string(),
+  houseAllowance: z3.string(),
+  transportAllowance: z3.string(),
+  helbDeduction: z3.string().nullable(),
+  saccoDeduction: z3.string().nullable(),
+  bankName: z3.string().nullable(),
+  bankAccount: z3.string().nullable(),
+  bankBranch: z3.string().nullable(),
+  status: z3.string(),
+  createdAt: z3.string(),
+  // From users join
+  email: z3.string(),
+  mustChangePassword: z3.boolean(),
+  // Department (nullable — not all staff are in a department)
+  departmentId: UuidSchema.nullable(),
+  departmentName: z3.string().nullable(),
+  // Primary role
+  roleName: RoleNameSchema.nullable(),
+  roleId: UuidSchema.nullable()
+});
+var StaffListItemSchema = z3.object({
+  id: UuidSchema,
+  userId: UuidSchema,
+  firstName: z3.string(),
+  middleName: z3.string().nullable(),
+  lastName: z3.string(),
+  email: z3.string(),
+  phone: z3.string(),
+  designation: z3.string(),
+  employmentType: EmploymentTypeSchema,
+  status: z3.string(),
+  departmentName: z3.string().nullable(),
+  roleName: RoleNameSchema.nullable(),
+  createdAt: z3.string()
+});
+var ListStaffInputSchema = PaginationInputSchema.extend({
+  search: z3.string().optional().meta({
+    description: "Search by name or email"
+  }),
+  departmentId: UuidSchema.optional(),
+  roleName: RoleNameSchema.optional(),
+  status: z3.enum(["active", "inactive"]).optional()
+});
+var CreateStaffOutputSchema = z3.object({
+  staffId: UuidSchema,
+  userId: UuidSchema,
+  email: z3.string(),
+  /** Temp password was emailed — not returned in response for security */
+  emailSent: z3.boolean()
+});
+var DepartmentSchema = z3.object({
+  id: UuidSchema,
+  branchId: UuidSchema,
+  name: z3.string(),
+  hodId: UuidSchema.nullable()
+});
+var CreateDepartmentInputSchema = z3.object({
+  name: z3.string().min(1).max(100),
+  hodId: UuidSchema.optional()
+});
+
+// src/schemas/students.ts
+var z4 = __toESM(require("zod"), 1);
+var GenderSchema = z4.enum(["male", "female"]);
+var StudentStatusSchema = z4.enum([
+  "active",
+  "transferred",
+  "graduated",
+  "suspended",
+  "withdrawn"
+]);
+var GradeLevelSchema = z4.enum([
+  "PP1",
+  "PP2",
+  "G1",
+  "G2",
+  "G3",
+  "G4",
+  "G5",
+  "G6",
+  "G7",
+  "G8",
+  "G9"
+]);
+var CreateStudentInputSchema = z4.object({
+  // Identity
+  firstName: z4.string().min(1).max(100),
+  middleName: z4.string().max(100).optional(),
+  lastName: z4.string().min(1).max(100),
+  dateOfBirth: z4.iso.date().meta({ description: "ISO date, e.g. 2015-03-22" }),
+  gender: GenderSchema,
+  admissionNo: z4.string().min(1).max(50).meta({
+    description: "School-assigned admission number \u2014 must be unique per branch"
+  }),
+  nemisNo: z4.string().max(50).optional(),
+  admissionDate: z4.iso.date(),
+  bloodGroup: z4.string().max(10).optional(),
+  medicalNotes: z4.string().optional(),
+  // Class placement (optional at creation — can be enrolled later)
+  classId: UuidSchema.optional().meta({
+    description: "Class to enrol student in for the current term"
+  }),
+  termId: UuidSchema.optional().meta({
+    description: "Term for class enrolment \u2014 required if classId is provided"
+  }),
+  // Guardian (optional at creation — can be linked later)
+  guardian: z4.object({
+    firstName: z4.string().min(1).max(100),
+    middleName: z4.string().max(100).optional(),
+    lastName: z4.string().min(1).max(100),
+    relationship: z4.string().min(1).max(50).meta({
+      description: "e.g. mother, father, uncle, guardian"
+    }),
+    phone: z4.string().min(9).max(30),
+    email: z4.email().optional(),
+    nationalId: z4.string().max(20).optional(),
+    occupation: z4.string().max(100).optional()
+  }).optional()
+});
+var StudentProfileSchema = z4.object({
+  id: UuidSchema,
+  branchId: UuidSchema,
+  admissionNo: z4.string(),
+  nemisNo: z4.string().nullable(),
+  firstName: z4.string(),
+  middleName: z4.string().nullable(),
+  lastName: z4.string(),
+  dateOfBirth: z4.string(),
+  gender: GenderSchema,
+  photoUrl: z4.string().nullable(),
+  bloodGroup: z4.string().nullable(),
+  medicalNotes: z4.string().nullable(),
+  admissionDate: z4.string(),
+  status: StudentStatusSchema,
+  createdAt: z4.string(),
+  // Current class (from latest enrollment)
+  currentClass: z4.object({
+    classId: UuidSchema,
+    className: z4.string(),
+    gradeLevel: GradeLevelSchema,
+    termId: UuidSchema,
+    termName: z4.string()
+  }).nullable(),
+  // Guardians
+  guardians: z4.array(z4.object({
+    id: UuidSchema,
+    firstName: z4.string(),
+    middleName: z4.string().nullable(),
+    lastName: z4.string(),
+    relationship: z4.string(),
+    phone: z4.string(),
+    email: z4.string().nullable(),
+    isPrimary: z4.boolean()
+  }))
+});
+var StudentListItemSchema = z4.object({
+  id: UuidSchema,
+  admissionNo: z4.string(),
+  firstName: z4.string(),
+  middleName: z4.string().nullable(),
+  lastName: z4.string(),
+  gender: GenderSchema,
+  status: StudentStatusSchema,
+  className: z4.string().nullable(),
+  gradeLevel: GradeLevelSchema.nullable(),
+  primaryGuardianName: z4.string().nullable(),
+  primaryGuardianPhone: z4.string().nullable(),
+  createdAt: z4.string()
+});
+var ListStudentsInputSchema = PaginationInputSchema.extend({
+  search: z4.string().optional().meta({
+    description: "Search by name or admission number"
+  }),
+  classId: UuidSchema.optional(),
+  gradeLevel: GradeLevelSchema.optional(),
+  status: StudentStatusSchema.optional(),
+  termId: UuidSchema.optional()
+});
+var BulkUploadStudentRowSchema = z4.object({
+  firstName: z4.string().min(1),
+  middleName: z4.string().optional(),
+  lastName: z4.string().min(1),
+  dateOfBirth: z4.string().min(1).meta({ description: "Any parseable date string" }),
+  gender: z4.string().min(1).meta({ description: "male | female (case-insensitive)" }),
+  admissionNo: z4.string().min(1),
+  nemisNo: z4.string().optional(),
+  admissionDate: z4.string().optional(),
+  bloodGroup: z4.string().optional(),
+  // Guardian columns (all optional in CSV)
+  guardianFirstName: z4.string().optional(),
+  guardianLastName: z4.string().optional(),
+  guardianRelationship: z4.string().optional(),
+  guardianPhone: z4.string().optional(),
+  guardianEmail: z4.string().optional()
+});
+var BulkUploadStudentsInputSchema = z4.object({
+  classId: UuidSchema.meta({
+    description: "Class to enrol all uploaded students into"
+  }),
+  termId: UuidSchema,
+  rows: z4.array(BulkUploadStudentRowSchema).min(1).max(500)
+});
+var BulkUploadStudentsOutputSchema = z4.object({
+  created: z4.int().nonnegative(),
+  skipped: z4.int().nonnegative(),
+  errors: z4.array(z4.object({
+    row: z4.int().positive(),
+    admissionNo: z4.string().optional(),
+    reason: z4.string()
+  }))
+});
+var CreateStudentOutputSchema = z4.object({
+  studentId: UuidSchema,
+  admissionNo: z4.string()
+});
+var LinkGuardianInputSchema = z4.object({
+  studentId: UuidSchema,
+  firstName: z4.string().min(1).max(100),
+  middleName: z4.string().max(100).optional(),
+  lastName: z4.string().min(1).max(100),
+  relationship: z4.string().min(1).max(50),
+  phone: z4.string().min(9).max(30),
+  email: z4.email().optional(),
+  nationalId: z4.string().max(20).optional(),
+  occupation: z4.string().max(100).optional(),
+  isPrimary: z4.boolean().default(false)
+});
+var ClassSummarySchema = z4.object({
+  id: UuidSchema,
+  name: z4.string(),
+  gradeLevel: GradeLevelSchema,
+  gradeName: z4.string(),
+  capacity: z4.number().nullable(),
+  enrolledCount: z4.number(),
+  classTeacherId: UuidSchema.nullable()
+});
+
 // src/contracts/auth.ts
 var import_contract = require("@orpc/contract");
-var z3 = __toESM(require("zod"), 1);
-var EmptyOutputSchema = z3.object({}).meta({ description: "Empty success response" });
+var z5 = __toESM(require("zod"), 1);
+var EmptyOutputSchema = z5.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);
@@ -188,11 +553,79 @@ var authContract = {
   resetPassword: resetPasswordContract,
   switchBranch: switchBranchContract
 };
+
+// src/contracts/hr.ts
+var import_contract2 = require("@orpc/contract");
+var z6 = __toESM(require("zod"), 1);
+var EmptyOutput = z6.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(),
+  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({
+  id: UuidSchema,
+  status: z6.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 createDepartmentContract = import_contract2.oc.route({ method: "POST", path: "/hr/departments" }).input(CreateDepartmentInputSchema).output(DepartmentSchema);
+var hrContract = {
+  createStaff: createStaffContract,
+  listStaff: listStaffContract,
+  getStaffById: getStaffByIdContract,
+  updateStaffStatus: updateStaffStatusContract,
+  listDepartments: listDepartmentsContract,
+  createDepartment: createDepartmentContract
+};
+
+// src/contracts/students.ts
+var import_contract3 = require("@orpc/contract");
+var z7 = __toESM(require("zod"), 1);
+var EmptyOutput2 = z7.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(),
+  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({
+  termId: UuidSchema.optional(),
+  gradeLevel: z7.string().optional()
+})).output(z7.array(ClassSummarySchema));
+var studentsContract = {
+  create: createStudentContract,
+  bulkUpload: bulkUploadStudentsContract,
+  list: listStudentsContract,
+  getById: getStudentByIdContract,
+  linkGuardian: linkGuardianContract,
+  listClasses: listClassesContract
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BranchRefSchema,
+  BulkUploadStudentRowSchema,
+  BulkUploadStudentsInputSchema,
+  BulkUploadStudentsOutputSchema,
   ChangePasswordInputSchema,
+  ClassSummarySchema,
+  CreateDepartmentInputSchema,
+  CreateStaffInputSchema,
+  CreateStaffOutputSchema,
+  CreateStudentInputSchema,
+  CreateStudentOutputSchema,
   CuidSchema,
+  DepartmentSchema,
+  EmploymentTypeSchema,
+  GenderSchema,
+  GradeLevelSchema,
+  LinkGuardianInputSchema,
+  ListStaffInputSchema,
+  ListStudentsInputSchema,
   LoginInputSchema,
   LoginOutputSchema,
   LogoutInputSchema,
@@ -201,22 +634,42 @@ var authContract = {
   RefreshTokenOutputSchema,
   RequestPasswordResetInputSchema,
   ResetPasswordInputSchema,
+  RoleNameSchema,
   SessionUserOutputSchema,
   SessionUserRoleSchema,
   SessionUserSubRoleSchema,
   SoftDeleteSchema,
+  StaffListItemSchema,
+  StaffProfileSchema,
+  StudentListItemSchema,
+  StudentProfileSchema,
+  StudentStatusSchema,
   SwitchBranchInputSchema,
   TimestampsSchema,
   UuidSchema,
   authContract,
+  bulkUploadStudentsContract,
   changePasswordContract,
+  createDepartmentContract,
+  createStaffContract,
+  createStudentContract,
   getMeContract,
+  getStaffByIdContract,
+  getStudentByIdContract,
+  hrContract,
+  linkGuardianContract,
+  listClassesContract,
+  listDepartmentsContract,
+  listStaffContract,
+  listStudentsContract,
   loginContract,
   logoutContract,
   paginatedOutputSchema,
   refreshTokenContract,
   requestPasswordResetContract,
   resetPasswordContract,
-  switchBranchContract
+  studentsContract,
+  switchBranchContract,
+  updateStaffStatusContract
 });
 //# sourceMappingURL=index.cjs.map