File size: 6,920 Bytes
d0c3eef
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
 
 
 
 
 
 
 
 
e6677f0
d0c3eef
 
e6677f0
d0c3eef
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
aa3bec5
 
 
 
 
 
e6677f0
 
 
d0c3eef
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
 
2494e74
d0c3eef
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
 
2494e74
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
 
 
 
 
2494e74
d0c3eef
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0c3eef
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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';

@ApiTags('πŸ“… Semesters')
@Controller('api/semesters')
@UseGuards(JwtAuthGuard, RolesGuard)
@ApiBearerAuth('JWT-auth')
export class SemesterController {
  constructor(private readonly semesterService: SemesterService) {}

  @Get()
  @Roles(
    RoleName.IT_ADMIN,
    RoleName.ADMIN,
    RoleName.INSTRUCTOR,
    RoleName.TA,
    RoleName.STUDENT,
  )
  @ApiOperation({
    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
    `,
  })
  @ApiQuery({
    name: 'status',
    required: false,
    type: String,
    schema: { type: 'string', enum: Object.values(SemesterStatus) },
  })
  @ApiQuery({ name: 'year', required: false, type: String, example: '2024' })
  @ApiResponse({ status: 200, description: 'List of semesters' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  async findAll(
    @Query('status') status?: SemesterStatus,
    @Query('year') year?: string,
  ): Promise<SemesterDto[]> {
    const yearNum = year ? parseInt(year, 10) : undefined;
    return this.semesterService.findAll(status, yearNum) as Promise<
      SemesterDto[]
    >;
  }

  @Get('current')
  @Roles(
    RoleName.IT_ADMIN,
    RoleName.ADMIN,
    RoleName.INSTRUCTOR,
    RoleName.TA,
    RoleName.STUDENT,
  )
  @ApiOperation({
    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.
    `,
  })
  @ApiResponse({ status: 200, description: 'Current semester details' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 404, description: 'No active semester found' })
  async getCurrentSemester(): Promise<SemesterDto> {
    return this.semesterService.findCurrentSemester() as Promise<SemesterDto>;
  }

  @Post()
  @Roles(RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD)
  @HttpCode(201)
  @ApiOperation({
    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)
    `,
  })
  @ApiBody({ type: CreateSemesterDto })
  @ApiResponse({ status: 201, description: 'Semester created successfully' })
  @ApiResponse({ status: 400, description: 'Invalid input or date conflicts' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - Admin access required' })
  async create(@Body() dto: CreateSemesterDto): Promise<SemesterDto> {
    return this.semesterService.create(dto) as Promise<SemesterDto>;
  }

  @Get(':id')
  @Roles(
    RoleName.IT_ADMIN,
    RoleName.ADMIN,
    RoleName.INSTRUCTOR,
    RoleName.TA,
    RoleName.STUDENT,
  )
  @ApiOperation({
    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)
    `,
  })
  @ApiParam({ name: 'id', description: 'Semester ID', type: Number })
  @ApiResponse({ status: 200, description: 'Semester details' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 404, description: 'Semester not found' })
  async findById(@Param('id', ParseIntPipe) id: number): Promise<SemesterDto> {
    return this.semesterService.findById(id) as Promise<SemesterDto>;
  }

  @Put(':id')
  @Roles(RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD)
  @ApiOperation({
    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.
    `,
  })
  @ApiParam({ name: 'id', description: 'Semester ID', type: Number })
  @ApiBody({ type: UpdateSemesterDto })
  @ApiResponse({ status: 200, description: 'Semester updated successfully' })
  @ApiResponse({ status: 400, description: 'Invalid input data' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - Admin access required' })
  @ApiResponse({ status: 404, description: 'Semester not found' })
  async update(
    @Param('id', ParseIntPipe) id: number,
    @Body() dto: UpdateSemesterDto,
  ): Promise<SemesterDto> {
    return this.semesterService.update(id, dto) as Promise<SemesterDto>;
  }

  @Delete(':id')
  @Roles(RoleName.IT_ADMIN, RoleName.ADMIN, RoleName.DEPARTMENT_HEAD)
  @HttpCode(204)
  @ApiOperation({
    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
    `,
  })
  @ApiParam({ name: 'id', description: 'Semester ID', type: Number })
  @ApiResponse({ status: 204, description: 'Semester deleted successfully' })
  @ApiResponse({ status: 400, description: 'Cannot delete active semester' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - Admin access required' })
  @ApiResponse({ status: 404, description: 'Semester not found' })
  async delete(@Param('id', ParseIntPipe) id: number): Promise<void> {
    return this.semesterService.delete(id);
  }
}