N21-1319 schoolexternaltool metadata

apps/server/src/modules/tool/school-external-tool/controller/dto/school-external-tool-metadata.response.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ToolContextType } from '../../../common/enum';
+
+export class SchoolExternalToolMetadataResponse {
+	@ApiProperty()
+	contextExternalToolCountPerContext: Map<ToolContextType, number>;
+
+	constructor(schoolExternalToolMetadataResponse: SchoolExternalToolMetadataResponse) {
+		this.contextExternalToolCountPerContext = schoolExternalToolMetadataResponse.contextExternalToolCountPerContext;
+	}
+}

apps/server/src/modules/tool/school-external-tool/controller/tool-school.controller.ts

@@ -14,8 +14,10 @@ import { Body, Controller, Delete, Get, Param, Post, Query, Put, HttpCode, HttpS
 import { ValidationError } from '@shared/common';
 import { LegacyLogger } from '@src/core/logger';
 import { Authenticate, CurrentUser, ICurrentUser } from '@modules/authentication';
+import { SchoolExternalToolMetadata } from '../domain/school-external-tool-metadata';
 import { SchoolExternalToolRequestMapper, SchoolExternalToolResponseMapper } from '../mapper';
 import { ExternalToolSearchListResponse } from '../../external-tool/controller/dto';
+import { SchoolExternalToolMetadataMapper } from '../mapper/school-external-tool-metadata.mapper';
 import {
 	SchoolExternalToolIdParams,
 	SchoolExternalToolPostParams,
@@ -26,6 +28,7 @@ import {
 import { SchoolExternalToolDto } from '../uc/dto/school-external-tool.types';
 import { SchoolExternalToolUc } from '../uc';
 import { SchoolExternalTool } from '../domain';
+import { SchoolExternalToolMetadataResponse } from './dto/school-external-tool-metadata.response';
 
 @ApiTags('Tool')
 @Authenticate('jwt')
@@ -136,4 +139,23 @@ export class ToolSchoolController {
 
 		return response;
 	}
+
+	@Get('/:schoolExternalToolId/metadata')
+	@ApiOperation({ summary: 'Gets the metadata of an school external tool.' })
+	@ApiOkResponse({
+		description: 'Metadata of school external tool fetched successfully.',
+	})
+	@ApiUnauthorizedResponse({ description: 'User is not logged in.' })
+	async getMetaDataForExternalTool(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Param() params: SchoolExternalToolIdParams
+	): Promise<SchoolExternalToolMetadataResponse> {
+		const schoolExternalToolMetadata: SchoolExternalToolMetadata =
+			await this.schoolExternalToolUc.getMetadataForSchoolExternalTool(currentUser.userId, params.schoolExternalToolId);
+
+		const mapped: SchoolExternalToolMetadataResponse =
+			SchoolExternalToolMetadataMapper.mapToSchoolExternalToolMetadataResponse(schoolExternalToolMetadata);
+
+		return mapped;
+	}
 }

apps/server/src/modules/tool/school-external-tool/domain/school-external-tool-metadata.ts

@@ -0,0 +1,9 @@
+import { ToolContextType } from '../../common/enum';
+
+export class SchoolExternalToolMetadata {
+	contextExternalToolCountPerContext: Map<ToolContextType, number>;
+
+	constructor(schoolExternalToolMetadata: SchoolExternalToolMetadata) {
+		this.contextExternalToolCountPerContext = schoolExternalToolMetadata.contextExternalToolCountPerContext;
+	}
+}

apps/server/src/modules/tool/school-external-tool/mapper/school-external-tool-metadata.mapper.ts

@@ -0,0 +1,14 @@
+import { SchoolExternalToolMetadataResponse } from '../controller/dto/school-external-tool-metadata.response';
+import { SchoolExternalToolMetadata } from '../domain/school-external-tool-metadata';
+
+export class SchoolExternalToolMetadataMapper {
+	static mapToSchoolExternalToolMetadataResponse(
+		schoolExternalToolMetadata: SchoolExternalToolMetadata
+	): SchoolExternalToolMetadataResponse {
+		const externalToolMetadataResponse: SchoolExternalToolMetadataResponse = new SchoolExternalToolMetadataResponse({
+			contextExternalToolCountPerContext: schoolExternalToolMetadata.contextExternalToolCountPerContext,
+		});
+
+		return externalToolMetadataResponse;
+	}
+}

apps/server/src/modules/tool/school-external-tool/service/school-external-tool-metadata.service.ts

@@ -0,0 +1,78 @@
+import { Injectable } from '@nestjs/common';
+import { EntityId } from '@shared/domain';
+import { ContextExternalToolRepo, ExternalToolRepo, SchoolExternalToolRepo } from '@shared/repo';
+import { Logger } from '../../../../core/logger';
+import { ToolContextType } from '../../common/enum';
+import { SchoolExternalToolMetadata } from '../domain/school-external-tool-metadata';
+
+@Injectable()
+export class SchoolExternalToolMetadataService {
+	constructor(
+		private readonly logger: Logger,
+		private readonly externalToolRepo: ExternalToolRepo,
+		private readonly schoolToolRepo: SchoolExternalToolRepo,
+		private readonly contextToolRepo: ContextExternalToolRepo
+	) {}
+
+	async getMetadata(schoolExternalToolId: EntityId) {
+		const toolCountPerContext: { ToolContextType; number }[] = await Promise.all(
+			// Context Course
+			Object.values(ToolContextType).map(
+				async (
+					contextType: ToolContextType
+				): Promise<{
+					ToolContextType;
+					number;
+				}> => {
+					const countPerContext: number =
+						await this.contextToolRepo.countContextExternalToolsBySchoolToolIdAndContextType(
+							contextType,
+							schoolExternalToolId
+						);
+					return { ToolContextType: contextType, number: countPerContext };
+				}
+			)
+		);
+
+		const schoolExternaltoolMetadata = this.createSchoolExternalToolMetadata(toolCountPerContext);
+
+		/* const contextExternalToolMetadata: Map<ToolContextType, number> = new Map(
+			toolCountPerContext.map((contextExternalToolCountPerSchool: { ToolContextType; number }) => [
+				contextExternalToolCountPerSchool.ToolContextType,
+				contextExternalToolCountPerSchool.number,
+			])
+		);
+
+		const externaltoolMetadata: ExternalToolMetadata = new ExternalToolMetadata({
+			schoolExternalToolCount,
+			contextExternalToolCountPerContext: contextExternalToolMetadata,
+		});
+
+		 */
+
+		return schoolExternaltoolMetadata;
+	}
+
+	private createContextExternalToolMetaData(
+		toolCountPerContext: { ToolContextType; number }[]
+	): Map<ToolContextType, number> {
+		const contextExternalToolMetadata: Map<ToolContextType, number> = new Map(
+			toolCountPerContext.map((contextExternalToolCountPerSchool: { ToolContextType; number }) => [
+				contextExternalToolCountPerSchool.ToolContextType,
+				contextExternalToolCountPerSchool.number,
+			])
+		);
+
+		return contextExternalToolMetadata;
+	}
+
+	private createSchoolExternalToolMetadata(
+		contextExternalToolCountPerContext: { ToolContextType; number }[]
+	): SchoolExternalToolMetadata {
+		const schoolExternaltoolMetadata: SchoolExternalToolMetadata = new SchoolExternalToolMetadata({
+			contextExternalToolCountPerContext: this.createContextExternalToolMetaData(contextExternalToolCountPerContext),
+		});
+
+		return schoolExternaltoolMetadata;
+	}
+}

apps/server/src/modules/tool/school-external-tool/uc/school-external-tool.uc.ts

@@ -4,7 +4,9 @@ import { AuthorizationContext, AuthorizationContextBuilder } from '@modules/auth
 import { ToolPermissionHelper } from '../../common/uc/tool-permission-helper';
 import { ContextExternalToolService } from '../../context-external-tool/service';
 import { SchoolExternalTool } from '../domain';
+import { SchoolExternalToolMetadata } from '../domain/school-external-tool-metadata';
 import { SchoolExternalToolService, SchoolExternalToolValidationService } from '../service';
+import { SchoolExternalToolMetadataService } from '../service/school-external-tool-metadata.service';
 import { SchoolExternalToolDto, SchoolExternalToolQueryInput } from './dto/school-external-tool.types';
 
 @Injectable()
@@ -13,6 +15,7 @@ export class SchoolExternalToolUc {
 		private readonly schoolExternalToolService: SchoolExternalToolService,
 		private readonly contextExternalToolService: ContextExternalToolService,
 		private readonly schoolExternalToolValidationService: SchoolExternalToolValidationService,
+		private readonly schoolexternaltoolMetadataService: SchoolExternalToolMetadataService,
 		private readonly toolPermissionHelper: ToolPermissionHelper
 	) {}
 
@@ -95,4 +98,20 @@ export class SchoolExternalToolUc {
 		const saved = await this.schoolExternalToolService.saveSchoolExternalTool(updated);
 		return saved;
 	}
+
+	async getMetadataForSchoolExternalTool(
+		userId: EntityId,
+		schoolExternalToolId: EntityId
+	): Promise<SchoolExternalToolMetadata> {
+		const schoolExternalTool: SchoolExternalTool = await this.schoolExternalToolService.findById(schoolExternalToolId);
+
+		const context: AuthorizationContext = AuthorizationContextBuilder.read([Permission.SCHOOL_TOOL_ADMIN]);
+		await this.toolPermissionHelper.ensureSchoolPermissions(userId, schoolExternalTool, context);
+
+		const metadata: SchoolExternalToolMetadata = await this.schoolexternaltoolMetadataService.getMetadata(
+			schoolExternalToolId
+		);
+
+		return metadata;
+	}
 }

apps/server/src/shared/repo/schoolexternaltool/school-external-tool.repo.ts

@@ -38,6 +38,11 @@ export class SchoolExternalToolRepo extends BaseDORepo<
 		return domainObjects;
 	}
 
+	async countSchoolExternalToolsByExternalToolId(toolId: string): Promise<number> {
+		const schoolExternalToolCount: number = await this._em.count(this.entityName, { tool: toolId });
+		return schoolExternalToolCount;
+	}
+
 	async findBySchoolId(schoolId: string): Promise<SchoolExternalTool[]> {
 		const entities: SchoolExternalToolEntity[] = await this._em.find(this.entityName, { school: schoolId });
 		const domainObjects: SchoolExternalTool[] = entities.map((entity: SchoolExternalToolEntity): SchoolExternalTool => {