N21-2031 Placeholder element for deleted tools in boards (#5182)

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

@@ -16,6 +16,7 @@ import {
 	BoardNodeAuthorizableService,
 	BoardNodeService,
 	ColumnBoardService,
+	ContextExternalToolDeletedEventHandlerService,
 	MediaBoardService,
 	UserDeletedEventHandlerService,
 } from './service';
@@ -60,6 +61,7 @@ import {
 		ColumnBoardReferenceService,
 		ColumnBoardTitleService,
 		UserDeletedEventHandlerService,
+		ContextExternalToolDeletedEventHandlerService,
 		// TODO replace by import of MediaBoardModule (fix dependency cycle)
 		MediaBoardService,
 	],

apps/server/src/modules/board/controller/card.controller.ts

@@ -22,6 +22,7 @@ import {
 	CardListResponse,
 	CardUrlParams,
 	CreateContentElementBodyParams,
+	DeletedElementResponse,
 	DrawingElementResponse,
 	ExternalToolElementResponse,
 	FileElementResponse,
@@ -121,7 +122,9 @@ export class CardController {
 		FileElementResponse,
 		LinkElementResponse,
 		RichTextElementResponse,
-		SubmissionContainerElementResponse
+		SubmissionContainerElementResponse,
+		DrawingElementResponse,
+		DeletedElementResponse
 	)
 	@ApiResponse({
 		status: 201,
@@ -133,6 +136,7 @@ export class CardController {
 				{ $ref: getSchemaPath(RichTextElementResponse) },
 				{ $ref: getSchemaPath(SubmissionContainerElementResponse) },
 				{ $ref: getSchemaPath(DrawingElementResponse) },
+				{ $ref: getSchemaPath(DeletedElementResponse) },
 			],
 		},
 	})

apps/server/src/modules/board/controller/dto/card/card.response.ts

@@ -3,6 +3,7 @@ import { DecodeHtmlEntities } from '@shared/controller';
 import {
 	AnyContentElementResponse,
 	CollaborativeTextEditorElementResponse,
+	DeletedElementResponse,
 	DrawingElementResponse,
 	ExternalToolElementResponse,
 	FileElementResponse,
@@ -20,7 +21,8 @@ import { VisibilitySettingsResponse } from './visibility-settings.response';
 	RichTextElementResponse,
 	DrawingElementResponse,
 	SubmissionContainerElementResponse,
-	CollaborativeTextEditorElementResponse
+	CollaborativeTextEditorElementResponse,
+	DeletedElementResponse
 )
 export class CardResponse {
 	constructor({ id, title, height, elements, visibilitySettings, timestamps }: CardResponse) {
@@ -55,6 +57,7 @@ export class CardResponse {
 				{ $ref: getSchemaPath(SubmissionContainerElementResponse) },
 				{ $ref: getSchemaPath(DrawingElementResponse) },
 				{ $ref: getSchemaPath(CollaborativeTextEditorElementResponse) },
+				{ $ref: getSchemaPath(DeletedElementResponse) },
 			],
 		},
 	})

apps/server/src/modules/board/controller/dto/element/any-content-element.response.ts

@@ -1,4 +1,5 @@
 import { CollaborativeTextEditorElementResponse } from './collaborative-text-editor-element.response';
+import { DeletedElementResponse } from './deleted-element.response';
 import { DrawingElementResponse } from './drawing-element.response';
 import { ExternalToolElementResponse } from './external-tool-element.response';
 import { FileElementResponse } from './file-element.response';
@@ -13,7 +14,8 @@ export type AnyContentElementResponse =
 	| SubmissionContainerElementResponse
 	| ExternalToolElementResponse
 	| DrawingElementResponse
-	| CollaborativeTextEditorElementResponse;
+	| CollaborativeTextEditorElementResponse
+	| DeletedElementResponse;
 
 export const isFileElementResponse = (element: AnyContentElementResponse): element is FileElementResponse =>
 	element instanceof FileElementResponse;

apps/server/src/modules/board/controller/dto/element/deleted-element.response.ts

@@ -0,0 +1,37 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ContentElementType } from '../../../domain';
+import { TimestampsResponse } from '../timestamps.response';
+
+export class DeletedElementContent {
+	constructor(props: DeletedElementContent) {
+		this.title = props.title;
+		this.deletedElementType = props.deletedElementType;
+	}
+
+	@ApiProperty()
+	title: string;
+
+	@ApiProperty({ enum: ContentElementType, enumName: 'ContentElementType' })
+	deletedElementType: ContentElementType;
+}
+
+export class DeletedElementResponse {
+	constructor(props: DeletedElementResponse) {
+		this.id = props.id;
+		this.type = props.type;
+		this.content = props.content;
+		this.timestamps = props.timestamps;
+	}
+
+	@ApiProperty({ pattern: '[a-f0-9]{24}' })
+	id: string;
+
+	@ApiProperty({ enum: ContentElementType, enumName: 'ContentElementType' })
+	type: ContentElementType.DELETED;
+
+	@ApiProperty()
+	content: DeletedElementContent;
+
+	@ApiProperty()
+	timestamps: TimestampsResponse;
+}

apps/server/src/modules/board/controller/dto/element/index.ts

@@ -8,3 +8,4 @@ export * from './link-element.response';
 export * from './rich-text-element.response';
 export * from './submission-container-element.response';
 export * from './update-element-content.body.params';
+export * from './deleted-element.response';

apps/server/src/modules/board/controller/mapper/content-element-response.factory.spec.ts

@@ -1,15 +1,17 @@
 import { NotImplementedException } from '@nestjs/common';
 import {
-	fileElementFactory,
+	deletedElementFactory,
 	drawingElementFactory,
+	fileElementFactory,
 	linkElementFactory,
 	richTextElementFactory,
 	submissionContainerElementFactory,
 } from '../../testing';
 import {
+	DeletedElementResponse,
+	DrawingElementResponse,
 	FileElementResponse,
 	LinkElementResponse,
-	DrawingElementResponse,
 	RichTextElementResponse,
 	SubmissionContainerElementResponse,
 } from '../dto';
@@ -55,6 +57,14 @@ describe(ContentElementResponseFactory.name, () => {
 		expect(result).toBeInstanceOf(SubmissionContainerElementResponse);
 	});
 
+	it('should return instance of DeletedElementResponse', () => {
+		const drawingElement = deletedElementFactory.build();
+
+		const result = ContentElementResponseFactory.mapToResponse(drawingElement);
+
+		expect(result).toBeInstanceOf(DeletedElementResponse);
+	});
+
 	it('should throw NotImplementedException', () => {
 		// @ts-expect-error check unknown type
 		expect(() => ContentElementResponseFactory.mapToResponse('UNKNOWN')).toThrow(NotImplementedException);

apps/server/src/modules/board/controller/mapper/content-element-response.factory.ts

@@ -3,12 +3,13 @@ import { AnyBoardNode, FileElement, RichTextElement } from '../../domain';
 import {
 	AnyContentElementResponse,
 	FileElementResponse,
-	RichTextElementResponse,
 	isFileElementResponse,
 	isRichTextElementResponse,
+	RichTextElementResponse,
 } from '../dto';
 import { BaseResponseMapper } from './base-mapper.interface';
 import { CollaborativeTextEditorElementResponseMapper } from './collaborative-text-editor-element-response.mapper';
+import { DeletedElementResponseMapper } from './deleted-element-response.mapper';
 import { DrawingElementResponseMapper } from './drawing-element-response.mapper';
 import { ExternalToolElementResponseMapper } from './external-tool-element-response.mapper';
 import { FileElementResponseMapper } from './file-element-response.mapper';
@@ -25,6 +26,7 @@ export class ContentElementResponseFactory {
 		SubmissionContainerElementResponseMapper.getInstance(),
 		ExternalToolElementResponseMapper.getInstance(),
 		CollaborativeTextEditorElementResponseMapper.getInstance(),
+		DeletedElementResponseMapper.getInstance(),
 	];
 
 	static mapToResponse(element: AnyBoardNode): AnyContentElementResponse {

apps/server/src/modules/board/controller/mapper/deleted-element-response.mapper.ts

@@ -0,0 +1,30 @@
+import { ContentElementType, DeletedElement } from '../../domain';
+import { DeletedElementContent, DeletedElementResponse, TimestampsResponse } from '../dto';
+import { BaseResponseMapper } from './base-mapper.interface';
+
+export class DeletedElementResponseMapper implements BaseResponseMapper {
+	private static instance: DeletedElementResponseMapper;
+
+	public static getInstance(): DeletedElementResponseMapper {
+		if (!DeletedElementResponseMapper.instance) {
+			DeletedElementResponseMapper.instance = new DeletedElementResponseMapper();
+		}
+
+		return DeletedElementResponseMapper.instance;
+	}
+
+	mapToResponse(element: DeletedElement): DeletedElementResponse {
+		const result = new DeletedElementResponse({
+			id: element.id,
+			timestamps: new TimestampsResponse({ lastUpdatedAt: element.updatedAt, createdAt: element.createdAt }),
+			type: ContentElementType.DELETED,
+			content: new DeletedElementContent({ title: element.title, deletedElementType: element.deletedElementType }),
+		});
+
+		return result;
+	}
+
+	canMap(element: unknown): boolean {
+		return element instanceof DeletedElement;
+	}
+}

apps/server/src/modules/board/controller/mapper/index.ts

@@ -10,3 +10,4 @@ export * from './link-element-response.mapper';
 export * from './rich-text-element-response.mapper';
 export * from './submission-container-element-response.mapper';
 export * from './submission-item-response.mapper';
+export * from './deleted-element-response.mapper';

apps/server/src/modules/board/domain/board-node.do.ts

@@ -28,6 +28,10 @@ export abstract class BoardNode<T extends BoardNodeProps> extends DomainObject<T
 		return copyProps;
 	}
 
+	public getTrueProps(): T {
+		return this.props;
+	}
+
 	get level(): number {
 		return this.ancestorIds.length;
 	}

apps/server/src/modules/board/domain/board-node.factory.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from '@mikro-orm/mongodb';
-import { Injectable, NotImplementedException } from '@nestjs/common';
+import { Injectable, NotImplementedException, UnprocessableEntityException } from '@nestjs/common';
 import { EntityId, InputFormat } from '@shared/domain/types';
 import { Card } from './card.do';
 import { CollaborativeTextEditorElement } from './collaborative-text-editor.do';
@@ -79,6 +79,8 @@ export class BoardNodeFactory {
 					...this.getBaseProps(),
 				});
 				break;
+			case ContentElementType.DELETED:
+				throw new UnprocessableEntityException('Deleted elements cannot be created from the outside');
 			case ContentElementType.COLLABORATIVE_TEXT_EDITOR:
 				element = new CollaborativeTextEditorElement({
 					...this.getBaseProps(),

apps/server/src/modules/board/domain/deleted-element.do.spec.ts

@@ -0,0 +1,53 @@
+import { ObjectId } from '@mikro-orm/mongodb';
+import { DeletedElement } from './deleted-element.do';
+import { BoardNodeProps, ContentElementType } from './types';
+
+describe(DeletedElement.name, () => {
+	let element: DeletedElement;
+
+	const boardNodeProps: BoardNodeProps = {
+		id: new ObjectId().toHexString(),
+		path: '',
+		level: 1,
+		position: 1,
+		children: [],
+		createdAt: new Date(),
+		updatedAt: new Date(),
+	};
+
+	beforeEach(() => {
+		element = new DeletedElement({
+			...boardNodeProps,
+			deletedElementType: ContentElementType.EXTERNAL_TOOL,
+			title: 'Old Tool',
+		});
+	});
+
+	it('should return title', () => {
+		expect(element.title).toEqual('Old Tool');
+	});
+
+	it('should set title', () => {
+		const title = 'Title';
+
+		element.title = title;
+
+		expect(element.title).toEqual(title);
+	});
+
+	it('should return deletedElementType', () => {
+		expect(element.deletedElementType).toEqual(ContentElementType.EXTERNAL_TOOL);
+	});
+
+	it('should set deletedElementType', () => {
+		const deletedElementType = ContentElementType.FILE;
+
+		element.deletedElementType = deletedElementType;
+
+		expect(element.deletedElementType).toEqual(deletedElementType);
+	});
+
+	it('should not have child', () => {
+		expect(element.canHaveChild()).toEqual(false);
+	});
+});

apps/server/src/modules/board/domain/deleted-element.do.ts

@@ -0,0 +1,27 @@
+import { BoardNode } from './board-node.do';
+import type { ContentElementType, DeletedElementProps } from './types';
+
+export class DeletedElement extends BoardNode<DeletedElementProps> {
+	get title(): string {
+		return this.props.title;
+	}
+
+	set title(value: string) {
+		this.props.title = value;
+	}
+
+	get deletedElementType(): ContentElementType {
+		return this.props.deletedElementType;
+	}
+
+	set deletedElementType(value: ContentElementType) {
+		this.props.deletedElementType = value;
+	}
+
+	canHaveChild(): boolean {
+		return false;
+	}
+}
+
+export const isDeletedElement = (reference: unknown): reference is DeletedElement =>
+	reference instanceof DeletedElement;

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

@@ -16,3 +16,4 @@ export * from './submission-item.do';
 export * from './path-utils';
 export * from './types';
 export * from './type-mapping';
+export * from './deleted-element.do';

apps/server/src/modules/board/domain/media-board/types/any-media-board-node.ts

@@ -3,13 +3,3 @@ import type { MediaExternalToolElement } from '../media-external-tool-element.do
 import type { MediaLine } from '../media-line.do';
 
 export type AnyMediaBoardNode = MediaBoard | MediaLine | MediaExternalToolElement;
-
-// TODO remove if not needed
-// export type AnyMediaBoardNode = MediaExternalToolElement;
-/*
-export const isAnyMediaContentElement = (element: AnyMediaBoardNode): element is AnyMediaBoardNode => {
-	const result: boolean = element instanceof MediaExternalToolElement;
-
-	return result;
-};
-*/

apps/server/src/modules/board/domain/type-mapping.ts

@@ -3,6 +3,7 @@ import { Card } from './card.do';
 import { CollaborativeTextEditorElement } from './collaborative-text-editor.do';
 import { ColumnBoard } from './colum-board.do';
 import { Column } from './column.do';
+import { DeletedElement } from './deleted-element.do';
 import { DrawingElement } from './drawing-element.do';
 import { ExternalToolElement } from './external-tool-element.do';
 import { FileElement } from './file-element.do';
@@ -30,6 +31,7 @@ const BoardNodeTypeToConstructor = {
 	[BoardNodeType.RICH_TEXT_ELEMENT]: RichTextElement,
 	[BoardNodeType.SUBMISSION_CONTAINER_ELEMENT]: SubmissionContainerElement,
 	[BoardNodeType.SUBMISSION_ITEM]: SubmissionItem,
+	[BoardNodeType.DELETED_ELEMENT]: DeletedElement,
 } as const;
 
 export const getBoardNodeConstructor = <T extends BoardNodeType>(type: T): typeof BoardNodeTypeToConstructor[T] =>

apps/server/src/modules/board/domain/types/any-content-element.ts

@@ -1,4 +1,5 @@
 import { type CollaborativeTextEditorElement, isCollaborativeTextEditorElement } from '../collaborative-text-editor.do';
+import { type DeletedElement, isDeletedElement } from '../deleted-element.do';
 import { type DrawingElement, isDrawingElement } from '../drawing-element.do';
 import { type ExternalToolElement, isExternalToolElement } from '../external-tool-element.do';
 import { type FileElement, isFileElement } from '../file-element.do';
@@ -14,7 +15,8 @@ export type AnyContentElement =
 	| FileElement
 	| LinkElement
 	| RichTextElement
-	| SubmissionContainerElement;
+	| SubmissionContainerElement
+	| DeletedElement;
 
 export const isContentElement = (boardNode: AnyBoardNode): boardNode is AnyContentElement => {
 	const result =
@@ -24,7 +26,8 @@ export const isContentElement = (boardNode: AnyBoardNode): boardNode is AnyConte
 		isFileElement(boardNode) ||
 		isLinkElement(boardNode) ||
 		isRichTextElement(boardNode) ||
-		isSubmissionContainerElement(boardNode);
+		isSubmissionContainerElement(boardNode) ||
+		isDeletedElement(boardNode);
 
 	return result;
 };