@eeplatform/basic-edu 1.7.0 → 1.8.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/basic-edu
 
+## 1.8.1
+
+### Patch Changes
+
+- 9168d90: Enrollment management - Revise add applicant
+
+## 1.8.0
+
+### Minor Changes
+
+- f4d7c07: Program management initial release
+
 ## 1.7.0
 
 ### Minor Changes

package/SCHOOL_MGMT.md

@@ -0,0 +1,600 @@
+# School Management System — Module Details
+
+## Building Management
+
+Manages all school buildings and serves as a foundational dependency for room and facility management.
+
+### Purpose
+
+Provide a centralized module to define, update, and manage school buildings. Acts as the primary reference for assigning rooms and facilities.
+
+### Functional Details
+
+- Add new building with name, number of floors, and description.
+- Retrieve all buildings.
+- View specific building details.
+- Update building details.
+- Delete a building.
+
+### Business Logic
+
+- Updating building name: rooms and facilities linked to the building must reflect the new name.
+- Updating number of floors:
+
+  - If floor count is reduced, check if any room/facility exists on floors that would become invalid.
+  - Notify the user and prevent update until rooms/facilities are corrected.
+
+- Deleting a building:
+
+  - A building cannot be deleted if any room or facility is still linked to it.
+  - Require the user to reassign or remove dependent rooms/facilities first.
+
+### Dependencies
+
+- **Building Management is a dependency of Room & Facility Management** (not the other way around)
+
+### Data managed
+
+- Building ID (`_id`)
+- School ID (`school`)
+- Serial Number (`serial`)
+- Name (`name`)
+- Levels/Floors (`levels`)
+- Status (`status`)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)
+
+**Building Unit (Room/Facility) Fields:**
+
+- Building Unit ID (`_id`)
+- School ID (`school`)
+- Building ID (`building`)
+- Building Name (`buildingName`)
+- Name (`name`)
+- Level/Floor (`level`)
+- Category (`category`)
+- Type (`type`)
+- Seating Capacity (`seating_capacity`)
+- Standing Capacity (`standing_capacity`)
+- Description (`description`)
+- Unit of Measurement (`unit_of_measurement`)
+- Area (`area`)
+- Status (`status`)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)
+
+---
+
+## Room & Facility Management
+
+Handles all rooms, laboratories, and facilities inside each building. This module depends on Building Management and is used by Section Management and Section Schedule Management.
+
+### Purpose
+
+Provide a structured way for schools to create and manage rooms and facilities by linking them to buildings.
+
+### Functional Details
+
+- Add new room or facility.
+- Retrieve all rooms and facilities.
+- View specific room or facility details.
+- Update room or facility details.
+- Delete a room or facility.
+
+### Business Logic
+
+- Updating room/facility name:
+
+  - Update the linked section’s subject room/classroom name.
+  - Update the linked section schedule classroom name.
+
+- Changing assigned building or floor:
+
+  - Validate that the assigned floor exists in the target building.
+
+- Deleting a room or facility:
+
+  - Prevent deletion if used by any section or section schedule.
+  - User must update or remove dependencies first.
+
+### Dependencies
+
+- Requires: Building Management
+- Required by: Section Management, Section Schedule Management
+
+### Data managed
+
+_Note: Room & Facility Management is handled by Building Unit model (see Building Management section above)_
+
+- Building Unit ID (`_id`)
+- School ID (`school`)
+- Building ID (`building`)
+- Building Name (`buildingName`)
+- Name (`name`)
+- Level/Floor (`level`)
+- Category (`category`)
+- Type (`type`)
+- Seating Capacity (`seating_capacity`)
+- Standing Capacity (`standing_capacity`)
+- Description (`description`)
+- Unit of Measurement (`unit_of_measurement`)
+- Area (`area`)
+- Status (`status`)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)
+
+---
+
+## Curriculum Management
+
+Allows DepEd or schools to manage multiple curriculums and define their structures. This module is required by Subject Management and Section Schedule Management (for teaching load parameters).
+
+### Purpose
+
+Provide a centralized way to create and maintain curriculums, enabling consistency across subjects, grade levels, and schedules.
+
+### Functional Details
+
+- Add new curriculum (e.g., MATATAG, K-12, special curriculums).
+- Retrieve all curriculums.
+- View specific curriculum details.
+- Update curriculum details.
+- Delete a curriculum.
+
+### Business Logic
+
+- Updating curriculum name:
+
+  - All subjects linked to this curriculum must also update their stored curriculum name.
+
+- Deleting a curriculum:
+
+  - Cannot be deleted if used by any subject.
+  - Subjects must be updated to a different curriculum or deleted first.
+
+- Teaching Load Parameters:
+
+  - Store session duration, frequency, or special load rules used by Section Schedule Management.
+
+### Dependencies
+
+- Required by: Subject Management
+- Required by: Section Schedule Management (teaching load rules)
+
+### Data managed
+
+- Curriculum ID (`_id`)
+- Name (`name`)
+- Effective School Year (`effectiveSchoolYear`)
+- Max Teaching Hours Per Day (`maxTeachingHoursPerDay`)
+- Curriculum Memo Reference (`curriculumMemoRef`)
+- Status (`status`: active, pilot, inactive, deprecated)
+- Whitelist (`whitelist`)
+- Audit Fields (`createdAt`, `updatedAt`, `deletedAt`, `createdBy`, `updatedBy`, `deletedBy`)
+
+---
+
+## Subject Management
+
+Centralizes all subjects offered by the school. This module depends on Curriculum Management and is required by Section Management and Section Schedule Management.
+
+### Purpose
+
+Provide a standardized source of subjects used in creating sections and building schedules.
+
+### Functional Details
+
+- Add new subject.
+- Retrieve list of all subjects.
+- View specific subject details.
+- Update subject details.
+- Delete a subject.
+
+### Business Logic
+
+- Updating subject name:
+
+  - All section subjects that use this subject must automatically update.
+
+- Deleting a subject:
+
+  - Cannot be deleted if any section is currently using it.
+  - User must reassign or remove dependent sections first.
+
+### Dependencies
+
+- Requires: Curriculum Management
+- Required by: Section Management
+- Required by: Section Schedule Management
+
+### Data managed
+
+_Note: Subject Management is handled by Curriculum Subject model_
+
+- Curriculum Subject ID (`_id`)
+- Curriculum ID (`curriculum`)
+- Curriculum Name (`curriculumName`)
+- Effective School Year (`effectiveSchoolYear`)
+- Education Level (`educationLevel`)
+- Grade Level (`gradeLevel`)
+- Subject Code (`subjectCode`)
+- Subject Name (`subjectName`)
+- Subject Type (`subjectType`)
+- Session Frequency (`sessionFrequency`)
+- Session Duration (`sessionDuration`)
+- Total Minutes Per Week (`totalMinutesPerWeek`)
+- Status (`status`)
+- Audit Fields (`createdAt`, `updatedAt`, `deletedAt`, `createdBy`, `updatedBy`, `deletedBy`)
+
+---
+
+## Grade Level Management
+
+Handles the centralized list of grade levels offered by the school. This module is a dependency of Enrollment Management and Section Management.
+
+### Purpose
+
+Provide a consistent and controlled list of grade levels that other modules can reference to avoid mismatches and ensure data uniformity.
+
+### Functional Details
+
+- Add new grade level.
+- Retrieve all grade levels.
+- View specific grade level details.
+- Update grade level information.
+- Delete a grade level.
+
+### Business Logic
+
+- Updating grade level name or code:
+
+  - All modules that reference this grade level (Enrollment, Sections, Subjects linked to grade levels) must stay in sync.
+
+- Deleting a grade level:
+
+  - Not allowed if used by any learner enrollment or existing section.
+  - User must update or remove dependencies before deletion.
+
+### Dependencies
+
+- Required by: Enrollment Management
+- Required by: Section Management
+
+### Data managed
+
+- Grade Level ID (`_id`)
+- School ID (`school`)
+- Education Level (`educationLevel`)
+- Grade Level (`gradeLevel`)
+- Tracks (`tracks`)
+- Track Strands (`trackStrands`)
+- Teaching Style (`teachingStyle`)
+- Max Number of Learners (`maxNumberOfLearners`)
+- Min Number of Learners (`minNumberOfLearners`)
+- Default Start Time (`defaultStartTime`)
+- Default End Time (`defaultEndTime`)
+- Status (`status`)
+- Audit Fields (`createdAt`, `updatedAt`, `deletedAt`, `createdBy`, `updatedBy`, `deletedBy`)
+
+---
+
+## Enrollment Management
+
+Handles learner enrollment, including online enrollment. This module depends on Grade Level Management and integrates with Learner Management.
+
+### Purpose
+
+Provide a unified process for managing enrollment applications and officially registering learners into the school system.
+
+### Functional Details
+
+- Add new enrollment record.
+- Retrieve list of all enrollments.
+- View specific enrollment application.
+- Update enrollment details.
+- Delete an enrollment record.
+- Online enrollment submission.
+
+### Business Logic
+
+- When an applicant is accepted:
+
+  - Automatically create a learner profile in Learner Management.
+  - Automatically generate an LRN (Learner Reference Number).
+
+- Grade level assignment must match an existing grade level from Grade Level Management.
+- Enrollment record cannot be deleted if already converted into a learner unless the learner is deactivated or removed.
+
+### Dependencies
+
+- Requires: Grade Level Management
+- Required by: Learner Management (accepted enrollments become learners)
+
+### Data managed
+
+_Note: Enrollment Management uses TLearner model (comprehensive learner enrollment data)_
+
+- Learner ID (`_id`)
+- Region (`region`, `regionName`)
+- Province (`province`)
+- City/Municipality (`cityMunicipality`)
+- Division (`division`, `divisionName`)
+- School Information (`schoolId`, `school`, `schoolName`)
+- School Year (`schoolYear`)
+- Grade Level (`gradeLevel`)
+- Returning Learner (`returningLearner`)
+- Learner Information (`learnerInfo`: PSA birth cert, LRN, names, birth details, etc.)
+- Parent/Guardian Information (`parentGuardianInfo`)
+- Address Information (`address`)
+- Returning Learner Information (`returningLearnerInfo`)
+- Senior High Information (`seniorHighInfo`)
+- Alternative Learning Options (`alternativeLearningOptions`)
+- Certification and Consent (`isCertifiedAndConsented`)
+- Status (`status`)
+- Remarks (`remarks`)
+- Audit Fields (`createdAt`, `updatedAt`, `deletedAt`, `createdBy`, `updatedBy`, `deletedBy`)
+
+---
+
+## Learner Management
+
+Manages all officially enrolled learners. This module is required by Section Management for assigning learners to sections.
+
+### Purpose
+
+Serve as the centralized record-keeping module for all learner profiles created through enrollment acceptance.
+
+### Functional Details
+
+- Add learner record.
+- Retrieve list of all learners.
+- View specific learner profile.
+- Update learner information.
+- Delete or deactivate learner records.
+
+### Business Logic
+
+- No business logic defined as of now. Pure record keeping.
+
+### Dependencies
+
+- Required by: Section Management
+- Feeds data from: Enrollment Management (accepted applicants become learners)
+
+### Data managed
+
+_Note: Learner Management uses the same TLearner model as Enrollment Management (accepted enrollments become learners)_
+
+- Learner ID (`_id`)
+- Region (`region`, `regionName`)
+- Province (`province`)
+- City/Municipality (`cityMunicipality`)
+- Division (`division`, `divisionName`)
+- School Information (`schoolId`, `school`, `schoolName`)
+- School Year (`schoolYear`)
+- Grade Level (`gradeLevel`)
+- Returning Learner (`returningLearner`)
+- Learner Information (`learnerInfo`: PSA birth cert, LRN, names, birth details, etc.)
+- Parent/Guardian Information (`parentGuardianInfo`)
+- Address Information (`address`)
+- Returning Learner Information (`returningLearnerInfo`)
+- Senior High Information (`seniorHighInfo`)
+- Alternative Learning Options (`alternativeLearningOptions`)
+- Certification and Consent (`isCertifiedAndConsented`)
+- Status (`status`)
+- Remarks (`remarks`)
+- Audit Fields (`createdAt`, `updatedAt`, `deletedAt`, `createdBy`, `updatedBy`, `deletedBy`)
+
+---
+
+## Section Management
+
+Handles the creation, assignment, and overall management of class sections. This module is required by Section Schedule Management, Section Student Management, and Section Subject Management.
+
+### Purpose
+
+Provide an automated and centralized process for generating class sections per grade level and managing their structure for each school year.
+
+### Functional Details
+
+- Add a new section.
+- Retrieve list of all sections.
+- View specific section details.
+- Update section information.
+- Delete a section.
+- Generate sections automatically by grade level.
+
+### Business Logic
+
+- Section generation:
+
+  - Generate sections by grade level for a specified school year.
+  - Automatically divide learners into sections based on preset section names.
+  - Follow capacity rules:
+
+    - Distribute learners based on maximum capacity.
+    - If there is a remainder, use minimum capacity.
+    - If still uneven, distribute learners as evenly as possible.
+
+- Upon section generation:
+
+  - Automatically add required subjects for each section.
+  - Automatically create the list of students assigned to the section with all required section details.
+
+### Dependencies
+
+- Requires: Learner Management, Subject Management, Grade Level Management
+- Required by: Section Schedule Management, Section Student Management, Section Subject Management
+
+### Data managed
+
+- Section ID (`_id`)
+- School ID (`school`)
+- Name (`name`)
+- School Year (`schoolYear`)
+- Grade Level (`gradeLevel`)
+- Adviser (`adviser`, `adviserName`)
+- Students Count (`students`)
+- Status (`status`)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)
+
+---
+
+## Section Schedule Management
+
+Manages the scheduling of subjects for each section. Focuses on assigning teachers, classrooms, and time blocks to every subject automatically generated during section creation.
+
+### Purpose
+
+Provide a structured way to build class schedules per section while ensuring teacher load compliance and avoiding conflicts.
+
+### Functional Details
+
+- Add a schedule entry for a section.
+- Retrieve all schedules for a section.
+- View specific schedule details.
+- Update assigned teacher, classroom, or time.
+- Delete a schedule entry.
+- Auto-generate schedules based on subjects of the same grade level during section generation.
+
+### Business Logic
+
+- No direct business logic beyond validation.
+- Schedule must not have conflicts:
+
+  - No overlapping subjects within a section.
+  - A teacher cannot be double-booked.
+  - A classroom cannot be double-booked.
+
+- Teacher’s total teaching load must not exceed the curriculum’s maximum teaching hours.
+
+### Dependencies
+
+- Requires: Section Management, Subject Management, Curriculum Management, Room & Facility Management
+- Required by: None
+
+### Data managed
+
+_Note: Section Schedule Management is handled by Section Subject model (scheduling is integrated with subject assignment)_
+
+- Section Subject ID (`_id`)
+- School Information (`school`, `schoolName`)
+- Section Information (`section`, `sectionName`)
+- Grade Level (`gradeLevel`)
+- Education Level (`educationLevel`)
+- School Year (`schoolYear`)
+- Subject Information (`subjectCode`, `subjectName`)
+- Teacher Information (`teacher`, `teacherName`)
+- Classroom Information (`classroom`, `classroomName`)
+- Schedule Details (`daysOfWeek`, `schedule`)
+- Session Information (`sessionDuration`, `sessionFrequency`)
+- Status (`status`)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)
+
+---
+
+## Section Student Management
+
+Manages the assignment of learners to specific sections. This module handles the many-to-many relationship between learners and sections, including student transfers and status tracking.
+
+### Purpose
+
+Provide a centralized way to assign learners to sections, track their enrollment status within sections, and manage student transfers between sections.
+
+### Functional Details
+
+- Assign learner to a section.
+- Retrieve list of students in a section.
+- View specific student-section assignment details.
+- Update student assignment information.
+- Transfer student to another section.
+- Remove student from section (drop).
+
+### Business Logic
+
+- Student assignment validation:
+
+  - Ensure student's grade level matches section's grade level.
+  - Validate school year consistency.
+  - Check section capacity limits.
+
+- Status transitions:
+  - Active: Student is currently enrolled in the section.
+  - Dropped: Student has been removed from the section.
+  - Section-transferred: Student has been moved to another section.
+  - School-transferred: Student has been moved to another school.
+
+### Dependencies
+
+- Requires: Section Management, Learner Management
+- Required by: Section Schedule Management (for attendance tracking)
+
+### Data managed
+
+- Section Student ID (`_id`)
+- Learner Reference Number (`lrn`)
+- School Information (`school`, `schoolName`)
+- Section Information (`section`)
+- Student Information (`student`, `studentName`)
+- Grade Level (`gradeLevel`)
+- Education Level (`educationLevel`)
+- School Year (`schoolYear`)
+- Status (`status`: active, dropped, section-transferred, school-transferred)
+- Assignment Date (`assignedAt`)
+- Last Update (`updatedAt`)
+
+---
+
+## Section Subject Management
+
+Manages the assignment of subjects to sections with teacher and schedule information. This module handles the relationship between sections and their required subjects, including teacher assignments and scheduling.
+
+### Purpose
+
+Provide a structured way to assign curriculum subjects to sections, manage teacher assignments, and coordinate class schedules.
+
+### Functional Details
+
+- Assign subject to a section.
+- Retrieve all subjects for a section.
+- View specific section-subject assignment.
+- Update teacher assignment.
+- Update classroom assignment.
+- Update schedule details.
+- Remove subject from section.
+
+### Business Logic
+
+- Subject assignment validation:
+
+  - Ensure subject's grade level matches section's grade level.
+  - Validate curriculum compatibility.
+  - Check teacher availability and qualification.
+
+- Schedule conflict prevention:
+
+  - No overlapping subjects within a section.
+  - Teacher cannot be double-booked.
+  - Classroom cannot be double-booked.
+
+- Teacher load management:
+  - Track total teaching hours per teacher.
+  - Enforce maximum teaching load limits from curriculum.
+
+### Dependencies
+
+- Requires: Section Management, Curriculum Subject Management, Personnel Management, Building Management
+- Required by: None (end module)
+
+### Data managed
+
+- Section Subject ID (`_id`)
+- School Information (`school`, `schoolName`)
+- Section Information (`section`, `sectionName`)
+- Grade Level (`gradeLevel`)
+- Education Level (`educationLevel`)
+- School Year (`schoolYear`)
+- Subject Information (`subjectCode`, `subjectName`)
+- Teacher Information (`teacher`, `teacherName`)
+- Classroom Information (`classroom`, `classroomName`)
+- Schedule Details (`daysOfWeek`, `schedule`)
+- Session Information (`sessionDuration`, `sessionFrequency`)
+- Status (`status`: active, draft)
+- Timestamps (`createdAt`, `updatedAt`, `deletedAt`)