BC-4100 - Create Demo School Endpoint

apps/server/src/modules/demo/controller/demo-school.controller.ts

@@ -0,0 +1,24 @@
+import { Controller, ForbiddenException, Post } from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { ICurrentUser } from '@src/modules/authentication';
+import { Authenticate, CurrentUser } from '@src/modules/authentication/decorator/auth.decorator';
+import { DemoSchoolUc } from '../uc';
+import { DemoSchoolResponse } from './dto';
+
+@ApiTags('Demo School')
+@Authenticate('jwt')
+@Controller('demo-schools')
+export class DemoSchoolController {
+	constructor(private readonly demoSchoolUc: DemoSchoolUc) {}
+
+	@ApiOperation({ summary: 'Create a demo school.' })
+	@ApiResponse({ status: 200, type: DemoSchoolResponse })
+	@ApiResponse({ status: 403, type: ForbiddenException })
+	@Post()
+	async createDemoSchool(@CurrentUser() currentUser: ICurrentUser): Promise<DemoSchoolResponse> {
+		const school = await this.demoSchoolUc.createSchool(currentUser.userId);
+		const response = new DemoSchoolResponse(school);
+
+		return response;
+	}
+}

apps/server/src/modules/demo/controller/dto/demo-school.response.ts

@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class DemoSchoolResponse {
+	constructor({ id }: DemoSchoolResponse) {
+		this.id = id;
+	}
+
+	@ApiProperty({
+		pattern: '[a-f0-9]{24}',
+	})
+	id: string;
+}

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

@@ -0,0 +1 @@
+export * from './demo-school.response';

apps/server/src/modules/demo/demo-api.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { LoggerModule } from '@src/core/logger';
+import { AuthorizationModule } from '..';
+import { DemoSchoolController } from './controller/demo-school.controller';
+import { DemoModule } from './demo.module';
+import { DemoSchoolUc } from './uc';
+
+@Module({
+	imports: [DemoModule, LoggerModule, AuthorizationModule],
+	controllers: [DemoSchoolController],
+	providers: [DemoSchoolUc],
+})
+export class DemoApiModule {}

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

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { LoggerModule } from '@src/core/logger';
+import { DemoSchoolRepo } from './repo/demo-school.repo';
+import { DemoSchoolService } from './service/demo-school.service';
+
+@Module({
+	imports: [LoggerModule],
+	providers: [DemoSchoolService, DemoSchoolRepo],
+	exports: [DemoSchoolService],
+})
+export class DemoModule {}

apps/server/src/modules/demo/domain/demo-school.do.ts

@@ -0,0 +1,18 @@
+import { EntityId } from '@shared/domain';
+import { DomainObject } from '@shared/domain/domain-object'; // fix import if it is avaible
+
+export class DemoSchool extends DomainObject<DemoSchoolProps> {
+	get createdAt(): Date {
+		return this.props.createdAt;
+	}
+
+	get updatedAt(): Date {
+		return this.props.updatedAt;
+	}
+}
+
+export interface DemoSchoolProps {
+	id: EntityId;
+	createdAt: Date;
+	updatedAt: Date;
+}

apps/server/src/modules/demo/domain/demo-school.entity.ts

@@ -0,0 +1,5 @@
+import { BaseEntityWithTimestamps } from '@shared/domain';
+
+export class DemoSchoolEntity extends BaseEntityWithTimestamps {
+	// maybe we should even use the regular School entity
+}

apps/server/src/modules/demo/domain/index.ts

@@ -0,0 +1,2 @@
+export * from './demo-school.do';
+export * from './demo-school.entity';

apps/server/src/modules/demo/index.ts

@@ -0,0 +1,2 @@
+export * from './demo.module';
+export * from './service/demo-school.service';

apps/server/src/modules/demo/loggable/demo-school-create.loggable.ts

@@ -0,0 +1,17 @@
+import { EntityId } from '@shared/domain';
+import { CrudOperation } from '@shared/types';
+import { LogMessage, Loggable } from '@src/core/logger';
+
+export class DemoSchoolCreateLoggable implements Loggable {
+	constructor(private readonly userId: EntityId) {}
+
+	getLogMessage(): LogMessage {
+		return {
+			message: 'Creating demo school',
+			data: {
+				operation: CrudOperation.CREATE,
+				userId: this.userId,
+			},
+		};
+	}
+}

apps/server/src/modules/demo/loggable/index.ts

@@ -0,0 +1 @@
+export * from './demo-school-create.loggable';

apps/server/src/modules/demo/repo/demo-school.repo.ts

@@ -0,0 +1,13 @@
+import { EntityManager } from '@mikro-orm/mongodb';
+import { Injectable } from '@nestjs/common';
+import { DemoSchool } from '../domain';
+
+@Injectable()
+export class DemoSchoolRepo {
+	constructor(private readonly em: EntityManager) {}
+
+	async save(school: DemoSchool): Promise<void> {
+		// TODO map to entity and actually persist
+		return Promise.resolve();
+	}
+}

apps/server/src/modules/demo/service/demo-school.service.ts

@@ -0,0 +1,21 @@
+import { Injectable } from '@nestjs/common';
+import { ObjectId } from 'bson';
+import { DemoSchool } from '../domain';
+import { DemoSchoolRepo } from '../repo/demo-school.repo';
+
+@Injectable()
+export class DemoSchoolService {
+	constructor(private readonly repo: DemoSchoolRepo) {}
+
+	async createSchool(): Promise<DemoSchool> {
+		const school = new DemoSchool({
+			id: new ObjectId().toHexString(),
+			createdAt: new Date(),
+			updatedAt: new Date(),
+		});
+
+		await this.repo.save(school);
+
+		return school;
+	}
+}

apps/server/src/modules/demo/uc/demo-school.uc.ts

@@ -0,0 +1,28 @@
+import { Injectable } from '@nestjs/common';
+import { EntityId } from '@shared/domain';
+import { Logger } from '@src/core/logger';
+import { AuthorizationService } from '@src/modules/authorization';
+import { DemoSchool } from '../domain';
+import { DemoSchoolCreateLoggable } from '../loggable';
+import { DemoSchoolService } from '../service/demo-school.service';
+
+@Injectable()
+export class DemoSchoolUc {
+	constructor(
+		private readonly logger: Logger,
+		private readonly demoSchoolService: DemoSchoolService,
+		private readonly authorizationService: AuthorizationService
+	) {
+		this.logger.setContext(DemoSchoolUc.name);
+	}
+
+	async createSchool(userId: EntityId): Promise<DemoSchool> {
+		this.logger.debug(new DemoSchoolCreateLoggable(userId));
+
+		// TODO check permission
+
+		const school = await this.demoSchoolService.createSchool();
+
+		return school;
+	}
+}

apps/server/src/modules/demo/uc/index.ts

@@ -0,0 +1 @@
+export * from './demo-school.uc';

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

@@ -34,6 +34,7 @@ import { VideoConferenceApiModule } from '@src/modules/video-conference/video-co
 import connectRedis from 'connect-redis';
 import session from 'express-session';
 import { RedisClient } from 'redis';
+import { DemoApiModule } from '../demo/demo-api.module';
 import { ServerController } from './controller/server.controller';
 import { serverConfig } from './server.config';
 
@@ -70,6 +71,7 @@ const serverModules = [
 	ToolApiModule,
 	UserLoginMigrationApiModule,
 	BoardApiModule,
+	DemoApiModule,
 ];
 
 export const defaultMikroOrmOptions: MikroOrmModuleSyncOptions = {