N21-1626 ctl data sheet

apps/server/src/modules/tool/external-tool/controller/api-test/tool.api.spec.ts

@@ -723,4 +723,81 @@ describe('ToolController (API)', () => {
 			});
 		});
 	});
+
+	describe('[GET] tools/external-tools/:externalToolId/datasheet', () => {
+		describe('when user is not authenticated', () => {
+			const setup = () => {
+				const toolId: string = new ObjectId().toHexString();
+
+				return { toolId };
+			};
+
+			it('should return unauthorized', async () => {
+				const { toolId } = setup();
+
+				const response: Response = await testApiClient.get(`${toolId}/datasheet`);
+
+				expect(response.statusCode).toEqual(HttpStatus.UNAUTHORIZED);
+			});
+		});
+
+		describe('when externalToolId is given', () => {
+			const setup = async () => {
+				const toolId: string = new ObjectId().toHexString();
+				const externalToolEntity: ExternalToolEntity = externalToolEntityFactory.buildWithId(undefined, toolId);
+
+				const { adminUser, adminAccount } = UserAndAccountTestFactory.buildAdmin({}, [Permission.TOOL_ADMIN]);
+				await em.persistAndFlush([adminAccount, adminUser, externalToolEntity]);
+				em.clear();
+
+				const loggedInClient: TestApiClient = await testApiClient.login(adminAccount);
+
+				// this date will only have a daily precision, which should not impact successful tests
+				const date = new Date();
+				const year = date.getFullYear();
+				const month = date.getMonth() + 1;
+				const day = date.getDate();
+				const dateString = `${year}-${month}-${day}`;
+
+				return { loggedInClient, externalToolEntity, dateString };
+			};
+
+			it('should return the datasheet of the externalTool', async () => {
+				const { loggedInClient, externalToolEntity, dateString } = await setup();
+
+				const response: Response = await loggedInClient.get(`${externalToolEntity.id}/datasheet`);
+
+				expect(response.statusCode).toEqual(HttpStatus.OK);
+				expect(response.header).toEqual(
+					expect.objectContaining({
+						'content-type': 'application/pdf',
+						'content-disposition': `inline; filename=CTL-Datenblatt-${externalToolEntity.name}-${dateString}`,
+					})
+				);
+				expect(response.body).toEqual(expect.any(Buffer));
+			});
+		});
+
+		describe('when external tool cannot be found', () => {
+			const setup = async () => {
+				const toolId: string = new ObjectId().toHexString();
+
+				const { adminUser, adminAccount } = UserAndAccountTestFactory.buildAdmin({}, [Permission.TOOL_ADMIN]);
+				await em.persistAndFlush([adminAccount, adminUser]);
+				em.clear();
+
+				const loggedInClient: TestApiClient = await testApiClient.login(adminAccount);
+
+				return { loggedInClient, toolId };
+			};
+
+			it('should return a not found exception', async () => {
+				const { loggedInClient, toolId } = await setup();
+
+				const response: Response = await loggedInClient.get(`${toolId}/datasheet`);
+
+				expect(response.statusCode).toEqual(HttpStatus.NOT_FOUND);
+			});
+		});
+	});
 });

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

@@ -1,9 +1,22 @@
 import { Authenticate, CurrentUser, ICurrentUser } from '@modules/authentication';
-import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Query, Res } from '@nestjs/common';
+import {
+	Body,
+	Controller,
+	Delete,
+	Get,
+	HttpCode,
+	HttpStatus,
+	Param,
+	Post,
+	Query,
+	Res,
+	StreamableFile,
+} from '@nestjs/common';
 import {
 	ApiCreatedResponse,
 	ApiForbiddenResponse,
 	ApiFoundResponse,
+	ApiNotFoundResponse,
 	ApiOkResponse,
 	ApiOperation,
 	ApiResponse,
@@ -190,4 +203,24 @@ export class ToolController {
 
 		return mapped;
 	}
+
+	@Get(':externalToolId/datasheet')
+	@ApiOperation({ summary: 'Returns a pdf of the external tool information' })
+	@ApiUnauthorizedResponse({ description: 'User is not logged in.' })
+	@ApiNotFoundResponse({ description: 'The external tool has not been found' })
+	async getDatasheet(
+		@CurrentUser() currentUser: ICurrentUser,
+		@Param() params: ExternalToolIdParams,
+		@Res({ passthrough: true }) res: Response
+	): Promise<StreamableFile> {
+		const datasheetBuffer: Buffer = await this.externalToolUc.getDatasheet(currentUser.userId, params.externalToolId);
+
+		const myFilename = await this.externalToolUc.createDatasheetFilename(params.externalToolId);
+
+		res.setHeader('Content-Type', 'application/pdf');
+		res.setHeader('Content-Disposition', `inline; filename=${myFilename}`);
+
+		const streamableFile: StreamableFile = new StreamableFile(datasheetBuffer);
+		return streamableFile;
+	}
 }

apps/server/src/modules/tool/external-tool/domain/datasheet/external-tool-datasheet-template-data.ts

@@ -0,0 +1,42 @@
+import { ExternalToolParameterDatasheetTemplateData } from './external-tool-parameter-datasheet-template-data';
+
+export class ExternalToolDatasheetTemplateData {
+	createdAt: string;
+
+	creatorName: string;
+
+	instance: string;
+
+	toolName: string;
+
+	toolUrl: string;
+
+	isDeactivated?: string;
+
+	restrictToContexts?: string;
+
+	toolType: string;
+
+	skipConsent?: string;
+
+	messageType?: string;
+
+	privacy?: string;
+
+	parameters?: ExternalToolParameterDatasheetTemplateData[];
+
+	constructor(externalToolData: ExternalToolDatasheetTemplateData) {
+		this.createdAt = externalToolData.createdAt;
+		this.creatorName = externalToolData.creatorName;
+		this.instance = externalToolData.instance;
+		this.toolName = externalToolData.toolName;
+		this.toolUrl = externalToolData.toolUrl;
+		this.isDeactivated = externalToolData.isDeactivated;
+		this.restrictToContexts = externalToolData.restrictToContexts;
+		this.toolType = externalToolData.toolType;
+		this.skipConsent = externalToolData.skipConsent;
+		this.messageType = externalToolData.messageType;
+		this.privacy = externalToolData.privacy;
+		this.parameters = externalToolData.parameters;
+	}
+}

apps/server/src/modules/tool/external-tool/domain/datasheet/external-tool-parameter-datasheet-template-data.ts

@@ -0,0 +1,21 @@
+import { CustomParameterLocation } from '../../../common/enum';
+
+export class ExternalToolParameterDatasheetTemplateData {
+	name: string;
+
+	properties: string;
+
+	scope: string;
+
+	type: string;
+
+	location: CustomParameterLocation;
+
+	constructor(parameterData: ExternalToolParameterDatasheetTemplateData) {
+		this.name = parameterData.name;
+		this.properties = parameterData.properties;
+		this.scope = parameterData.scope;
+		this.type = parameterData.type;
+		this.location = parameterData.location;
+	}
+}

apps/server/src/modules/tool/external-tool/domain/datasheet/external-tool-parameter-datasheet-template-property.ts

@@ -0,0 +1,8 @@
+export enum ExternalToolParameterDatasheetTemplateProperty {
+	HIDDEN = 'versteckt',
+	DEACTIVATED = 'deaktiviert',
+	OPTIONAL = 'optional',
+	PROTECTED = 'geschützt',
+	SKIP_CONSENT = 'Zustimmung überspringen',
+	MANDATORY = 'Pflicht',
+}

apps/server/src/modules/tool/external-tool/domain/datasheet/index.ts

@@ -0,0 +1,3 @@
+export { ExternalToolDatasheetTemplateData } from './external-tool-datasheet-template-data';
+export { ExternalToolParameterDatasheetTemplateData } from './external-tool-parameter-datasheet-template-data';
+export { ExternalToolParameterDatasheetTemplateProperty } from './external-tool-parameter-datasheet-template-property';

apps/server/src/modules/tool/external-tool/domain/index.ts

@@ -1,3 +1,8 @@
 export * from './external-tool.do';
 export * from './config';
 export * from './external-tool-metadata';
+export {
+	ExternalToolParameterDatasheetTemplateProperty,
+	ExternalToolDatasheetTemplateData,
+	ExternalToolParameterDatasheetTemplateData,
+} from './datasheet';

apps/server/src/modules/tool/external-tool/external-tool.module.ts

@@ -9,6 +9,7 @@ import { ToolContextMapper } from '../common/mapper/tool-context.mapper';
 import { ToolConfigModule } from '../tool-config.module';
 import { ExternalToolMetadataMapper } from './mapper';
 import {
+	DatasheetPdfService,
 	ExternalToolConfigurationService,
 	ExternalToolLogoService,
 	ExternalToolParameterValidationService,
@@ -31,13 +32,15 @@ import {
 		ExternalToolRepo,
 		ExternalToolMetadataMapper,
 		ToolContextMapper,
+		DatasheetPdfService,
 	],
 	exports: [
 		ExternalToolService,
 		ExternalToolValidationService,
 		ExternalToolVersionIncrementService,
 		ExternalToolConfigurationService,
 		ExternalToolLogoService,
+		DatasheetPdfService,
 	],
 })
 export class ExternalToolModule {}