Spaces:
Sleeping
Sleeping
| import { | |
| Controller, | |
| Get, | |
| Post, | |
| Put, | |
| Delete, | |
| Param, | |
| Body, | |
| Query, | |
| UseGuards, | |
| HttpCode, | |
| ParseIntPipe, | |
| } from '@nestjs/common'; | |
| import { | |
| ApiTags, | |
| ApiOperation, | |
| ApiResponse, | |
| ApiBearerAuth, | |
| ApiParam, | |
| ApiQuery, | |
| ApiBody, | |
| } from '@nestjs/swagger'; | |
| import { SemesterService } from '../services/semester.service'; | |
| import { | |
| CreateSemesterDto, | |
| UpdateSemesterDto, | |
| SemesterDto, | |
| } from '../dtos/semester.dto'; | |
| import { SemesterStatus } from '../enums/semester-status.enum'; | |
| import { JwtAuthGuard } from '../../auth/guards/jwt-auth.guard'; | |
| import { RolesGuard } from '../../auth/guards/roles.guard'; | |
| import { Roles } from '../../auth/roles.decorator'; | |
| import { RoleName } from '../../auth/entities/role.entity'; | |
| ('📅 Semesters') | |
| ('api/semesters') | |
| (JwtAuthGuard, RolesGuard) | |
| ('JWT-auth') | |
| export class SemesterController { | |
| constructor(private readonly semesterService: SemesterService) {} | |
| () | |
| ( | |
| RoleName.IT_ADMIN, | |
| RoleName.ADMIN, | |
| RoleName.INSTRUCTOR, | |
| RoleName.TA, | |
| RoleName.STUDENT, | |
| ) | |
| ({ | |
| summary: 'List all semesters', | |
| description: ` | |
| ## List All Semesters | |
| Retrieves all semesters with optional filters. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: All roles (STUDENT, INSTRUCTOR, TA, ADMIN, IT_ADMIN) | |
| ### Filtering | |
| - \`status\`: Filter by semester status (upcoming, active, completed) | |
| - \`year\`: Filter by academic year | |
| `, | |
| }) | |
| ({ | |
| name: 'status', | |
| required: false, | |
| type: String, | |
| schema: { type: 'string', enum: Object.values(SemesterStatus) }, | |
| }) | |
| ({ name: 'year', required: false, type: String, example: '2024' }) | |
| ({ status: 200, description: 'List of semesters' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| async findAll( | |
| ('status') status?: SemesterStatus, | |
| ('year') year?: string, | |
| ): Promise<SemesterDto[]> { | |
| const yearNum = year ? parseInt(year, 10) : undefined; | |
| return this.semesterService.findAll(status, yearNum) as Promise< | |
| SemesterDto[] | |
| >; | |
| } | |
| ('current') | |
| ( | |
| RoleName.IT_ADMIN, | |
| RoleName.ADMIN, | |
| RoleName.INSTRUCTOR, | |
| RoleName.TA, | |
| RoleName.STUDENT, | |
| ) | |
| ({ | |
| summary: 'Get current semester', | |
| description: ` | |
| ## Get Current Active Semester | |
| Returns the currently active semester. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: All roles (STUDENT, INSTRUCTOR, TA, ADMIN, IT_ADMIN) | |
| ### Notes | |
| Only one semester can be active at a time. | |
| `, | |
| }) | |
| ({ status: 200, description: 'Current semester details' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 404, description: 'No active semester found' }) | |
| async getCurrentSemester(): Promise<SemesterDto> { | |
| return this.semesterService.findCurrentSemester() as Promise<SemesterDto>; | |
| } | |
| () | |
| (RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD) | |
| (201) | |
| ({ | |
| summary: 'Create new semester', | |
| description: ` | |
| ## Create New Semester | |
| Creates a new semester period. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| ### Semester Properties | |
| - Name (e.g., "Fall 2024", "Spring 2025") | |
| - Start and end dates | |
| - Registration period | |
| - Status (upcoming, active, completed) | |
| `, | |
| }) | |
| ({ type: CreateSemesterDto }) | |
| ({ status: 201, description: 'Semester created successfully' }) | |
| ({ status: 400, description: 'Invalid input or date conflicts' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| async create(() dto: CreateSemesterDto): Promise<SemesterDto> { | |
| return this.semesterService.create(dto) as Promise<SemesterDto>; | |
| } | |
| (':id') | |
| ( | |
| RoleName.IT_ADMIN, | |
| RoleName.ADMIN, | |
| RoleName.INSTRUCTOR, | |
| RoleName.TA, | |
| RoleName.STUDENT, | |
| ) | |
| ({ | |
| summary: 'Get semester by ID', | |
| description: ` | |
| ## Get Semester Details | |
| Retrieves details of a specific semester. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: All roles (STUDENT, INSTRUCTOR, TA, ADMIN, IT_ADMIN) | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Semester ID', type: Number }) | |
| ({ status: 200, description: 'Semester details' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 404, description: 'Semester not found' }) | |
| async findById(('id', ParseIntPipe) id: number): Promise<SemesterDto> { | |
| return this.semesterService.findById(id) as Promise<SemesterDto>; | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD) | |
| ({ | |
| summary: 'Update semester', | |
| description: ` | |
| ## Update Semester | |
| Updates an existing semester. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| ### Notes | |
| Be careful changing dates on active semesters. | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Semester ID', type: Number }) | |
| ({ type: UpdateSemesterDto }) | |
| ({ status: 200, description: 'Semester updated successfully' }) | |
| ({ status: 400, description: 'Invalid input data' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| ({ status: 404, description: 'Semester not found' }) | |
| async update( | |
| ('id', ParseIntPipe) id: number, | |
| () dto: UpdateSemesterDto, | |
| ): Promise<SemesterDto> { | |
| return this.semesterService.update(id, dto) as Promise<SemesterDto>; | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD) | |
| (204) | |
| ({ | |
| summary: 'Delete semester', | |
| description: ` | |
| ## Delete Semester | |
| Deletes a semester from the system. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| ### ⚠️ Warning | |
| - Active semesters cannot be deleted | |
| - Semesters with course sections cannot be deleted | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Semester ID', type: Number }) | |
| ({ status: 204, description: 'Semester deleted successfully' }) | |
| ({ status: 400, description: 'Cannot delete active semester' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| ({ status: 404, description: 'Semester not found' }) | |
| async delete(('id', ParseIntPipe) id: number): Promise<void> { | |
| return this.semesterService.delete(id); | |
| } | |
| } | |