@brite-future-schools-contracts/contracts 1.0.0

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./schemas";
+export * from "./contracts";

package/src/schemas/index.ts

@@ -0,0 +1,476 @@
+import { z } from "zod";
+
+// ─── Primitives ──────────────────────────────────────────────────────────────
+
+export const uuidSchema = z.string().uuid();
+
+export const paginationSchema = z.object({
+  page: z.number().int().min(1).default(1),
+  limit: z.number().int().min(1).max(100).default(20),
+});
+
+export const dateRangeSchema = z.object({
+  from: z.string().datetime().optional(),
+  to: z.string().datetime().optional(),
+});
+
+// ─── Enums ───────────────────────────────────────────────────────────────────
+
+export const genderEnum = z.enum(["male", "female"]);
+
+export const userStatusEnum = z.enum(["active", "inactive", "suspended"]);
+
+export const systemRoleEnum = z.enum([
+  "DIRECTOR",
+  "PRINCIPAL",
+  "DEPUTY_PRINCIPAL",
+  "HOD",
+  "CLASS_TEACHER",
+  "SUBJECT_TEACHER",
+  "BURSAR",
+  "HR_ADMIN",
+  "SCHOOL_NURSE",
+  "LIBRARIAN",
+  "LAB_TECHNICIAN",
+  "SPORTS_COACH",
+  "COUNSELLOR",
+  "CARETAKER",
+  "SECURITY",
+  "KITCHEN_STAFF",
+  "DRIVER",
+  "IT_ADMIN",
+  "STUDENT",
+  "PARENT",
+  "ORG_SPONSOR",
+  "INDIVIDUAL_SPONSOR",
+]);
+
+export type SystemRole = z.infer<typeof systemRoleEnum>;
+
+// ─── Auth ─────────────────────────────────────────────────────────────────────
+
+export const loginInputSchema = z.object({
+  email: z.string().email(),
+  password: z.string().min(8),
+  deviceFingerprint: z.string().optional(),
+});
+
+export const loginOutputSchema = z.object({
+  accessToken: z.string(),
+  refreshToken: z.string().optional(),
+  user: z.object({
+    id: uuidSchema,
+    firstName: z.string(),
+    middleName: z.string().nullable(),
+    lastName: z.string(),
+    email: z.string().email(),
+    avatarUrl: z.string().nullable(),
+    roles: z.array(
+      z.object({
+        id: uuidSchema,
+        name: z.string(),
+        branchId: uuidSchema.nullable(),
+      }),
+    ),
+    activeBranchId: uuidSchema.nullable(),
+    isMfaEnabled: z.boolean(),
+  }),
+});
+
+export const refreshTokenOutputSchema = z.object({
+  accessToken: z.string(),
+});
+
+export const refreshInputSchema = z.object({
+  refreshToken: z.string().optional(),
+});
+
+export const mfaVerifyInputSchema = z.object({
+  totp: z.string().length(6),
+});
+
+export const changePasswordInputSchema = z.object({
+  currentPassword: z.string().min(8),
+  newPassword: z.string().min(8),
+});
+
+// ─── User / Profile ───────────────────────────────────────────────────────────
+
+export const userSchema = z.object({
+  id: uuidSchema,
+  firstName: z.string(),
+  middleName: z.string().nullable(),
+  lastName: z.string(),
+  email: z.string().email(),
+  phone: z.string().nullable(),
+  avatarUrl: z.string().nullable(),
+  isActive: z.boolean(),
+  isMfaEnabled: z.boolean(),
+  lastLoginAt: z.string().datetime().nullable(),
+  createdAt: z.string().datetime(),
+});
+
+// ─── Branches & Organisation ─────────────────────────────────────────────────
+
+export const branchSchema = z.object({
+  id: uuidSchema,
+  name: z.string(),
+  code: z.string(),
+  address: z.string(),
+  county: z.string(),
+  phone: z.string().nullable(),
+  email: z.string().email().nullable(),
+  logoUrl: z.string().nullable(),
+  motto: z.string().nullable(),
+  principalId: uuidSchema.nullable(),
+  mpesaPaybill: z.string().nullable(),
+  featureFlags: z.record(z.boolean()),
+  createdAt: z.string().datetime(),
+});
+
+export const createBranchInputSchema = z.object({
+  name: z.string().min(2).max(100),
+  code: z.string().min(2).max(20),
+  address: z.string(),
+  county: z.string(),
+  phone: z.string().optional(),
+  email: z.string().email().optional(),
+  motto: z.string().optional(),
+});
+
+// ─── Students ─────────────────────────────────────────────────────────────────
+
+export const studentStatusEnum = z.enum([
+  "active",
+  "transferred",
+  "graduated",
+  "suspended",
+  "withdrawn",
+]);
+
+export const studentSchema = z.object({
+  id: uuidSchema,
+  branchId: uuidSchema,
+  admissionNo: z.string(),
+  nemisNo: z.string().nullable(),
+  firstName: z.string(),
+  middleName: z.string().nullable(),
+  lastName: z.string(),
+  dateOfBirth: z.string(),
+  gender: genderEnum,
+  photoUrl: z.string().nullable(),
+  bloodGroup: z.string().nullable(),
+  admissionDate: z.string(),
+  status: studentStatusEnum,
+  currentClassId: uuidSchema.nullable(),
+  createdAt: z.string().datetime(),
+});
+
+export const createStudentInputSchema = z.object({
+  admissionNo: z.string().min(1),
+  nemisNo: z.string().optional(),
+  firstName: z.string().min(1).max(100),
+  middleName: z.string().max(100).optional(),
+  lastName: z.string().min(1).max(100),
+  dateOfBirth: z.string(),
+  gender: genderEnum,
+  admissionDate: z.string(),
+  guardianId: uuidSchema.optional(),
+});
+
+export const listStudentsInputSchema = paginationSchema.extend({
+  branchId: uuidSchema.optional(),
+  classId: uuidSchema.optional(),
+  search: z.string().optional(),
+  status: studentStatusEnum.optional(),
+  termId: uuidSchema.optional(),
+});
+
+// ─── Guardian / Sponsor ───────────────────────────────────────────────────────
+
+export const guardianSchema = z.object({
+  id: uuidSchema,
+  userId: uuidSchema,
+  firstName: z.string(),
+  middleName: z.string().nullable(),
+  lastName: z.string(),
+  relationship: z.string(),
+  phone: z.string(),
+  email: z.string().email().nullable(),
+  nationalId: z.string().nullable(),
+  occupation: z.string().nullable(),
+  address: z.string().nullable(),
+});
+
+export const sponsorTypeEnum = z.enum(["organisation", "individual"]);
+
+export const sponsorSchema = z.object({
+  id: uuidSchema,
+  branchId: uuidSchema,
+  type: sponsorTypeEnum,
+  organisationName: z.string().nullable(),
+  firstName: z.string().nullable(),
+  middleName: z.string().nullable(),
+  lastName: z.string().nullable(),
+  contactUserId: uuidSchema.nullable(),
+  phone: z.string(),
+  email: z.string().email().nullable(),
+  address: z.string().nullable(),
+});
+
+// ─── Academics ────────────────────────────────────────────────────────────────
+
+export const gradeLevelEnum = z.enum([
+  "PP1",
+  "PP2",
+  "G1",
+  "G2",
+  "G3",
+  "G4",
+  "G5",
+  "G6",
+  "G7",
+  "G8",
+  "G9",
+]);
+
+export const assessmentTypeEnum = z.enum([
+  "formative",
+  "summative",
+  "knec_national",
+  "informal",
+]);
+
+export const rubricBandEnum = z.enum(["EE", "ME", "AE", "BE"]);
+
+export const subjectSchema = z.object({
+  id: uuidSchema,
+  branchId: uuidSchema,
+  name: z.string(),
+  code: z.string(),
+  gradeLevel: gradeLevelEnum,
+  departmentId: uuidSchema.nullable(),
+});
+
+export const assessmentScoreInputSchema = z.object({
+  assessmentId: uuidSchema,
+  studentId: uuidSchema,
+  subStrandId: uuidSchema,
+  numericScore: z.number().min(0).max(100),
+  comments: z.string().optional(),
+});
+
+export const reportCardStatusEnum = z.enum([
+  "draft",
+  "hod_review",
+  "principal_review",
+  "released",
+  "blocked",
+]);
+
+// ─── Finance ──────────────────────────────────────────────────────────────────
+
+export const feeItemCategoryEnum = z.enum([
+  "compulsory",
+  "class_specific",
+  "additive",
+]);
+
+export const paymentMethodEnum = z.enum([
+  "mpesa",
+  "bank",
+  "card",
+  "cash",
+  "cheque",
+]);
+
+export const invoiceStatusEnum = z.enum([
+  "draft",
+  "sent",
+  "partial",
+  "paid",
+  "overdue",
+  "cancelled",
+]);
+
+export const feeItemSchema = z.object({
+  id: uuidSchema,
+  branchId: uuidSchema,
+  name: z.string(),
+  category: feeItemCategoryEnum,
+  defaultAmount: z.number(),
+  applicableGrades: z.array(gradeLevelEnum),
+  isActive: z.boolean(),
+});
+
+export const recordPaymentInputSchema = z.object({
+  studentId: uuidSchema,
+  invoiceId: uuidSchema,
+  amount: z.number().positive(),
+  method: paymentMethodEnum,
+  reference: z.string().optional(),
+  mpesaReceipt: z.string().optional(),
+  paymentDate: z.string(),
+});
+
+// ─── HR / Staff ───────────────────────────────────────────────────────────────
+
+export const employmentTypeEnum = z.enum([
+  "permanent",
+  "contract",
+  "temporary",
+  "intern",
+]);
+
+export const staffSchema = z.object({
+  id: uuidSchema,
+  branchId: uuidSchema,
+  userId: uuidSchema,
+  firstName: z.string(),
+  middleName: z.string().nullable(),
+  lastName: z.string(),
+  tscNumber: z.string().nullable(),
+  nationalId: z.string(),
+  kraPin: z.string().nullable(),
+  nhifNo: z.string().nullable(),
+  nssfNo: z.string().nullable(),
+  phone: z.string(),
+  departmentId: uuidSchema.nullable(),
+  designation: z.string(),
+  employmentType: employmentTypeEnum,
+  contractStart: z.string(),
+  contractEnd: z.string().nullable(),
+  basicSalary: z.number(),
+  houseAllowance: z.number().default(0),
+  transportAllowance: z.number().default(0),
+  bankName: z.string().nullable(),
+  bankAccount: z.string().nullable(),
+  status: userStatusEnum,
+});
+
+export const leaveStatusEnum = z.enum([
+  "pending",
+  "approved",
+  "rejected",
+  "cancelled",
+]);
+
+export const leaveRequestInputSchema = z.object({
+  leaveTypeId: uuidSchema,
+  startDate: z.string(),
+  endDate: z.string(),
+  reason: z.string().min(10),
+});
+
+// ─── Transport ────────────────────────────────────────────────────────────────
+
+export const vehicleOwnershipEnum = z.enum(["owned", "contracted"]);
+
+export const vehicleTypeEnum = z.enum(["bus", "van", "pickup", "other"]);
+
+export const busRegisterStatusEnum = z.enum(["boarded", "alighted", "absent"]);
+
+export const tripLogInputSchema = z.object({
+  vehicleId: uuidSchema,
+  routeId: uuidSchema,
+  departureTime: z.string().datetime(),
+  tripType: z.enum(["morning", "evening", "errand"]),
+});
+
+export const busRegisterEntrySchema = z.object({
+  studentId: uuidSchema,
+  status: busRegisterStatusEnum,
+});
+
+// ─── Assets ───────────────────────────────────────────────────────────────────
+
+export const assetCategoryEnum = z.enum([
+  "furniture",
+  "lab_equipment",
+  "ict_device",
+  "vehicle",
+  "sports_equipment",
+  "kitchen_equipment",
+  "musical_instrument",
+  "classroom_supply",
+  "library_book",
+  "other",
+]);
+
+export const assetConditionEnum = z.enum([
+  "excellent",
+  "good",
+  "fair",
+  "poor",
+  "condemned",
+]);
+
+export const maintenanceTicketStatusEnum = z.enum([
+  "open",
+  "in_progress",
+  "resolved",
+  "closed",
+]);
+
+// ─── Library ──────────────────────────────────────────────────────────────────
+
+export const borrowingStatusEnum = z.enum([
+  "active",
+  "returned",
+  "overdue",
+  "lost",
+]);
+
+// ─── Discipline ───────────────────────────────────────────────────────────────
+
+export const incidentSeverityEnum = z.enum([
+  "minor",
+  "moderate",
+  "serious",
+  "critical",
+]);
+
+export const incidentStatusEnum = z.enum([
+  "open",
+  "counsellor_review",
+  "hod_review",
+  "principal_ruling",
+  "resolved",
+]);
+
+export const disciplineRulingEnum = z.enum([
+  "verbal_warning",
+  "written_warning",
+  "suspension",
+  "expulsion",
+  "dismissed",
+]);
+
+// ─── Payroll ──────────────────────────────────────────────────────────────────
+
+export const payrollRunStatusEnum = z.enum(["draft", "approved", "paid"]);
+
+// ─── Communications ───────────────────────────────────────────────────────────
+
+export const notificationTypeEnum = z.enum([
+  "report_card",
+  "fee_invoice",
+  "fee_reminder",
+  "fee_block",
+  "attendance_absent",
+  "bus_departed",
+  "bus_arrived",
+  "discipline_incident",
+  "assignment",
+  "notice",
+  "leave",
+  "payslip",
+]);
+
+export const sendBulkSmsInputSchema = z.object({
+  branchId: uuidSchema,
+  message: z.string().min(1).max(160),
+  recipientType: z.enum(["class", "grade", "whole_school", "custom"]),
+  recipientIds: z.array(uuidSchema).optional(),
+  scheduleAt: z.string().datetime().optional(),
+});