Move GET admin/users api to nest

apps/server/doc/file-structure.md

@@ -198,4 +198,4 @@ The use of a mapper gives us the guarantee, that
 - no additional data beside the known properties is published.
   - A plain object might contain more properties than defined in TS-interfaces.
     Sample: All school properties are published while only name & id are intended to be published.
-- the API definition is complete
+- the API definition is complete

apps/server/src/modules/server/server.module.ts

@@ -37,6 +37,7 @@ import { ALL_ENTITIES } from '@shared/domain/entity';
 import { createConfigModuleOptions, DB_PASSWORD, DB_URL, DB_USERNAME } from '@src/config';
 import { CoreModule } from '@src/core';
 import { LoggerModule } from '@src/core/logger';
+import { UsersAdminApiModule } from '@modules/user/legacy/users-admin-api.module';
 import { ServerConfigController, ServerController, ServerUc } from './api';
 import { SERVER_CONFIG_TOKEN, serverConfig } from './server.config';
 
@@ -52,6 +53,7 @@ const serverModules = [
 	LessonApiModule,
 	NewsModule,
 	UserApiModule,
+	UsersAdminApiModule,
 	SchulconnexClientModule.register({
 		apiUrl: Configuration.get('SCHULCONNEX_CLIENT__API_URL') as string,
 		tokenEndpoint: Configuration.get('SCHULCONNEX_CLIENT__TOKEN_ENDPOINT') as string,

apps/server/src/modules/user/controller/admin-api-user.controller.ts

@@ -1,7 +1,7 @@
 import { Body, Controller, Post, UseGuards } from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { AdminApiUserUc } from '../uc/admin-api-user.uc';
+import { AdminApiUserUc } from '../uc';
 import { AdminApiUserCreateBodyParams } from './dto/admin-api-user-create.body.params';
 import { AdminApiUserCreateResponse } from './dto/admin-api-user-create.response.dto';
 

apps/server/src/modules/user/controller/dto/index.ts

@@ -1,3 +1,3 @@
 export * from './user.params';
-export * from './user.response';
 export * from './resolved-user.response';
+export * from './create-user.response';

apps/server/src/modules/user/controller/index.ts

@@ -1 +1,2 @@
 export * from './user.controller';
+export * from './admin-api-user.controller';

apps/server/src/modules/user/legacy/controller/admin-api-students.controller.ts

@@ -0,0 +1,41 @@
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { Controller, Get, Param, Query } from '@nestjs/common';
+import { EntityNotFoundError, ForbiddenOperationError, ValidationError } from '@shared/common';
+import { Authenticate, CurrentUser, ICurrentUser } from '../../../authentication';
+import { RequestedRoleEnum } from '../enum';
+import { UserByIdParams, UserListResponse, UserResponse, UsersSearchQueryParams } from './dto';
+import { UsersAdminApiUc } from '../uc';
+
+@ApiTags('AdminStudents')
+@Authenticate('jwt')
+@Controller('users/admin/students')
+export class AdminApiStudentsController {
+	constructor(private readonly uc: UsersAdminApiUc) {}
+
+	@Get()
+	@ApiOperation({
+		summary: 'Returns all students which satisfies the given criteria.',
+	})
+	@ApiResponse({ status: 200, type: UserListResponse, description: 'Returns a paged list of students.' })
+	@ApiResponse({ status: 400, type: ValidationError, description: 'Request data has invalid format.' })
+	@ApiResponse({ status: 403, type: ForbiddenOperationError, description: 'Not authorized.' })
+	async searchStudents(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Query() params: UsersSearchQueryParams
+	): Promise<UserListResponse> {
+		return this.uc.findUsersByParams(RequestedRoleEnum.STUDENTS, currentUser.userId, params);
+	}
+
+	@Get(':id')
+	@ApiOperation({ summary: 'Returns an student with given id.' })
+	@ApiResponse({ status: 200, type: UserResponse, description: 'Returns the student.' })
+	@ApiResponse({ status: 400, type: ValidationError, description: 'Request data has invalid format.' })
+	@ApiResponse({ status: 403, type: ForbiddenOperationError, description: 'Not authorized.' })
+	@ApiResponse({ status: 404, type: EntityNotFoundError, description: 'Student not found.' })
+	async findStudentById(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Param() params: UserByIdParams
+	): Promise<UserResponse> {
+		return this.uc.findUserById(RequestedRoleEnum.STUDENTS, currentUser.userId, params);
+	}
+}

apps/server/src/modules/user/legacy/controller/admin-api-teachers.controller.ts

@@ -0,0 +1,41 @@
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { Controller, Get, Param, Query } from '@nestjs/common';
+import { EntityNotFoundError, ForbiddenOperationError, ValidationError } from '@shared/common';
+import { Authenticate, CurrentUser, ICurrentUser } from '../../../authentication';
+import { RequestedRoleEnum } from '../enum';
+import { UserByIdParams, UserListResponse, UserResponse, UsersSearchQueryParams } from './dto';
+import { UsersAdminApiUc } from '../uc';
+
+@ApiTags('AdminTeachers')
+@Authenticate('jwt')
+@Controller('users/admin/teachers')
+export class AdminApiTeachersController {
+	constructor(private readonly uc: UsersAdminApiUc) {}
+
+	@Get()
+	@ApiOperation({
+		summary: 'Returns all teachers which satisfies the given criteria.',
+	})
+	@ApiResponse({ status: 200, type: UserListResponse, description: 'Returns a paged list of teachers.' })
+	@ApiResponse({ status: 400, type: ValidationError, description: 'Request data has invalid format.' })
+	@ApiResponse({ status: 403, type: ForbiddenOperationError, description: 'Not authorized.' })
+	async searchTeachers(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Query() params: UsersSearchQueryParams
+	): Promise<UserListResponse> {
+		return this.uc.findUsersByParams(RequestedRoleEnum.TEACHERS, currentUser.userId, params);
+	}
+
+	@Get(':id')
+	@ApiOperation({ summary: 'Returns a teacher with given id.' })
+	@ApiResponse({ status: 200, type: UserResponse, description: 'Returns the teacher.' })
+	@ApiResponse({ status: 400, type: ValidationError, description: 'Request data has invalid format.' })
+	@ApiResponse({ status: 403, type: ForbiddenOperationError, description: 'Not authorized.' })
+	@ApiResponse({ status: 404, type: EntityNotFoundError, description: 'Teacher not found.' })
+	async findTeacherById(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Param() params: UserByIdParams
+	): Promise<UserResponse> {
+		return this.uc.findUserById(RequestedRoleEnum.TEACHERS, currentUser.userId, params);
+	}
+}