Refactor dashboard widget structure

Artuomka · Artuomka · commit c2520a0948f2 · 2026-01-14T16:43:52.000Z
diff --git a/backend/src/app.module.ts b/backend/src/app.module.ts
@@ -44,6 +44,7 @@ import { GetHelloUseCase } from './use-cases-app/get-hello.use.case.js';
 import { PersonalTableSettingsModule } from './entities/table-settings/personal-table-settings/personal-table-settings.module.js';
 import { SavedDbQueryModule } from './entities/visualizations/saved-db-query/saved-db-query.module.js';
 import { DashboardModule } from './entities/visualizations/dashboard/dashboards.module.js';
+import { DashboardWidgetModule } from './entities/visualizations/dashboard-widget/dashboard-widget.module.js';
 
 @Module({
 	imports: [
@@ -92,6 +93,7 @@ import { DashboardModule } from './entities/visualizations/dashboard/dashboards.
 		S3WidgetModule,
 		SavedDbQueryModule,
 		DashboardModule,
+		DashboardWidgetModule,
 	],
 	controllers: [AppController],
 	providers: [
diff --git a/backend/src/common/application/global-database-context.interface.ts b/backend/src/common/application/global-database-context.interface.ts
@@ -59,11 +59,9 @@ import { PersonalTableSettingsEntity } from '../../entities/table-settings/perso
 import { SavedDbQueryEntity } from '../../entities/visualizations/saved-db-query/saved-db-query.entity.js';
 import { ISavedDbQueryRepository } from '../../entities/visualizations/saved-db-query/repository/saved-db-query.repository.interface.js';
 import { DashboardEntity } from '../../entities/visualizations/dashboard/dashboard.entity.js';
-import { DashboardWidgetEntity } from '../../entities/visualizations/dashboard/dashboard-widget.entity.js';
-import {
-	IDashboardRepository,
-	IDashboardWidgetRepository,
-} from '../../entities/visualizations/dashboard/repository/dashboard.repository.interface.js';
+import { DashboardWidgetEntity } from '../../entities/visualizations/dashboard-widget/dashboard-widget.entity.js';
+import { IDashboardRepository } from '../../entities/visualizations/dashboard/repository/dashboard.repository.interface.js';
+import { IDashboardWidgetRepository } from '../../entities/visualizations/dashboard-widget/repository/dashboard-widget.repository.interface.js';
 
 export interface IGlobalDatabaseContext extends IDatabaseContext {
 	userRepository: Repository<UserEntity> & IUserRepository;
diff --git a/backend/src/common/application/global-database-context.ts b/backend/src/common/application/global-database-context.ts
@@ -106,13 +106,11 @@ import { SavedDbQueryEntity } from '../../entities/visualizations/saved-db-query
 import { ISavedDbQueryRepository } from '../../entities/visualizations/saved-db-query/repository/saved-db-query.repository.interface.js';
 import { savedDbQueryCustomRepositoryExtension } from '../../entities/visualizations/saved-db-query/repository/saved-db-query-custom-repository-extension.js';
 import { DashboardEntity } from '../../entities/visualizations/dashboard/dashboard.entity.js';
-import { DashboardWidgetEntity } from '../../entities/visualizations/dashboard/dashboard-widget.entity.js';
-import {
-	IDashboardRepository,
-	IDashboardWidgetRepository,
-} from '../../entities/visualizations/dashboard/repository/dashboard.repository.interface.js';
+import { DashboardWidgetEntity } from '../../entities/visualizations/dashboard-widget/dashboard-widget.entity.js';
+import { IDashboardRepository } from '../../entities/visualizations/dashboard/repository/dashboard.repository.interface.js';
+import { IDashboardWidgetRepository } from '../../entities/visualizations/dashboard-widget/repository/dashboard-widget.repository.interface.js';
 import { dashboardCustomRepositoryExtension } from '../../entities/visualizations/dashboard/repository/dashboard-custom-repository-extension.js';
-import { dashboardWidgetCustomRepositoryExtension } from '../../entities/visualizations/dashboard/repository/dashboard-widget-custom-repository-extension.js';
+import { dashboardWidgetCustomRepositoryExtension } from '../../entities/visualizations/dashboard-widget/repository/dashboard-widget-custom-repository-extension.js';
 
 @Injectable({ scope: Scope.REQUEST })
 export class GlobalDatabaseContext implements IGlobalDatabaseContext {
diff --git a/backend/src/entities/visualizations/dashboard-widget/dashboard-widget.entity.ts b/backend/src/entities/visualizations/dashboard-widget/dashboard-widget.entity.ts
@@ -11,7 +11,7 @@ import {
 	Relation,
 } from 'typeorm';
 import { DashboardWidgetTypeEnum } from '../../../enums/dashboard-widget-type.enum.js';
-import { DashboardEntity } from './dashboard.entity.js';
+import { DashboardEntity } from '../dashboard/dashboard.entity.js';
 import { SavedDbQueryEntity } from '../saved-db-query/saved-db-query.entity.js';
 
 @Entity('dashboard_widget')
diff --git a/backend/src/entities/visualizations/dashboard-widget/dashboard-widget.module.ts b/backend/src/entities/visualizations/dashboard-widget/dashboard-widget.module.ts
@@ -0,0 +1,46 @@
+import { MiddlewareConsumer, Module, RequestMethod } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { GlobalDatabaseContext } from '../../../common/application/global-database-context.js';
+import { BaseType, UseCaseType } from '../../../common/data-injection.tokens.js';
+import { AuthMiddleware } from '../../../authorization/auth.middleware.js';
+import { UserEntity } from '../../user/user.entity.js';
+import { LogOutEntity } from '../../log-out/log-out.entity.js';
+import { DashboardWidgetController } from './dashboard-widgets.controller.js';
+import { CreateDashboardWidgetUseCase } from './use-cases/create-dashboard-widget.use.case.js';
+import { UpdateDashboardWidgetUseCase } from './use-cases/update-dashboard-widget.use.case.js';
+import { DeleteDashboardWidgetUseCase } from './use-cases/delete-dashboard-widget.use.case.js';
+
+@Module({
+	imports: [TypeOrmModule.forFeature([UserEntity, LogOutEntity])],
+	providers: [
+		{
+			provide: BaseType.GLOBAL_DB_CONTEXT,
+			useClass: GlobalDatabaseContext,
+		},
+		{
+			provide: UseCaseType.CREATE_DASHBOARD_WIDGET,
+			useClass: CreateDashboardWidgetUseCase,
+		},
+		{
+			provide: UseCaseType.UPDATE_DASHBOARD_WIDGET,
+			useClass: UpdateDashboardWidgetUseCase,
+		},
+		{
+			provide: UseCaseType.DELETE_DASHBOARD_WIDGET,
+			useClass: DeleteDashboardWidgetUseCase,
+		},
+	],
+	controllers: [DashboardWidgetController],
+	exports: [],
+})
+export class DashboardWidgetModule {
+	public configure(consumer: MiddlewareConsumer): void {
+		consumer
+			.apply(AuthMiddleware)
+			.forRoutes(
+				{ path: '/dashboard/:dashboardId/widget/:connectionId', method: RequestMethod.POST },
+				{ path: '/dashboard/:dashboardId/widget/:widgetId/:connectionId', method: RequestMethod.PUT },
+				{ path: '/dashboard/:dashboardId/widget/:widgetId/:connectionId', method: RequestMethod.DELETE },
+			);
+	}
+}
diff --git a/backend/src/entities/visualizations/dashboard-widget/dashboard-widgets.controller.ts b/backend/src/entities/visualizations/dashboard-widget/dashboard-widgets.controller.ts
@@ -28,7 +28,7 @@ import {
 	ICreateDashboardWidget,
 	IDeleteDashboardWidget,
 	IUpdateDashboardWidget,
-} from './use-cases/dashboard-use-cases.interface.js';
+} from './use-cases/dashboard-widget-use-cases.interface.js';
 
 @UseInterceptors(SentryInterceptor)
 @Controller()
diff --git a/backend/src/entities/visualizations/dashboard-widget/data-structures/create-dashboard-widget.ds.ts b/backend/src/entities/visualizations/dashboard-widget/data-structures/create-dashboard-widget.ds.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/data-structures/delete-dashboard-widget.ds.ts b/backend/src/entities/visualizations/dashboard-widget/data-structures/delete-dashboard-widget.ds.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/data-structures/update-dashboard-widget.ds.ts b/backend/src/entities/visualizations/dashboard-widget/data-structures/update-dashboard-widget.ds.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/dto/create-dashboard-widget.dto.ts b/backend/src/entities/visualizations/dashboard-widget/dto/create-dashboard-widget.dto.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/dto/found-dashboard-widget.dto.ts b/backend/src/entities/visualizations/dashboard-widget/dto/found-dashboard-widget.dto.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/dto/update-dashboard-widget.dto.ts b/backend/src/entities/visualizations/dashboard-widget/dto/update-dashboard-widget.dto.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/repository/dashboard-widget-custom-repository-extension.ts b/backend/src/entities/visualizations/dashboard-widget/repository/dashboard-widget-custom-repository-extension.ts
diff --git a/backend/src/entities/visualizations/dashboard-widget/repository/dashboard-widget.repository.interface.ts b/backend/src/entities/visualizations/dashboard-widget/repository/dashboard-widget.repository.interface.ts
@@ -0,0 +1,9 @@
+import { DashboardWidgetEntity } from '../dashboard-widget.entity.js';
+
+export interface IDashboardWidgetRepository {
+	findWidgetById(widgetId: string): Promise<DashboardWidgetEntity | null>;
+	findWidgetByIdAndDashboardId(widgetId: string, dashboardId: string): Promise<DashboardWidgetEntity | null>;
+	findAllWidgetsByDashboardId(dashboardId: string): Promise<DashboardWidgetEntity[]>;
+	saveWidget(widget: DashboardWidgetEntity): Promise<DashboardWidgetEntity>;
+	removeWidget(widget: DashboardWidgetEntity): Promise<DashboardWidgetEntity>;
+}
diff --git a/backend/src/entities/visualizations/dashboard-widget/use-cases/create-dashboard-widget.use.case.ts b/backend/src/entities/visualizations/dashboard-widget/use-cases/create-dashboard-widget.use.case.ts
@@ -7,7 +7,7 @@ import { CreateDashboardWidgetDs } from '../data-structures/create-dashboard-wid
 import { DashboardWidgetEntity } from '../dashboard-widget.entity.js';
 import { FoundDashboardWidgetDto } from '../dto/found-dashboard-widget.dto.js';
 import { buildFoundDashboardWidgetDto } from '../utils/build-found-dashboard-widget-dto.util.js';
-import { ICreateDashboardWidget } from './dashboard-use-cases.interface.js';
+import { ICreateDashboardWidget } from './dashboard-widget-use-cases.interface.js';
 
 @Injectable({ scope: Scope.REQUEST })
 export class CreateDashboardWidgetUseCase
diff --git a/backend/src/entities/visualizations/dashboard-widget/use-cases/dashboard-widget-use-cases.interface.ts b/backend/src/entities/visualizations/dashboard-widget/use-cases/dashboard-widget-use-cases.interface.ts
@@ -0,0 +1,17 @@
+import { InTransactionEnum } from '../../../../enums/in-transaction.enum.js';
+import { CreateDashboardWidgetDs } from '../data-structures/create-dashboard-widget.ds.js';
+import { UpdateDashboardWidgetDs } from '../data-structures/update-dashboard-widget.ds.js';
+import { DeleteDashboardWidgetDs } from '../data-structures/delete-dashboard-widget.ds.js';
+import { FoundDashboardWidgetDto } from '../dto/found-dashboard-widget.dto.js';
+
+export interface ICreateDashboardWidget {
+	execute(inputData: CreateDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
+}
+
+export interface IUpdateDashboardWidget {
+	execute(inputData: UpdateDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
+}
+
+export interface IDeleteDashboardWidget {
+	execute(inputData: DeleteDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
+}
diff --git a/backend/src/entities/visualizations/dashboard-widget/use-cases/delete-dashboard-widget.use.case.ts b/backend/src/entities/visualizations/dashboard-widget/use-cases/delete-dashboard-widget.use.case.ts
@@ -6,7 +6,7 @@ import { Messages } from '../../../../exceptions/text/messages.js';
 import { DeleteDashboardWidgetDs } from '../data-structures/delete-dashboard-widget.ds.js';
 import { FoundDashboardWidgetDto } from '../dto/found-dashboard-widget.dto.js';
 import { buildFoundDashboardWidgetDto } from '../utils/build-found-dashboard-widget-dto.util.js';
-import { IDeleteDashboardWidget } from './dashboard-use-cases.interface.js';
+import { IDeleteDashboardWidget } from './dashboard-widget-use-cases.interface.js';
 
 @Injectable({ scope: Scope.REQUEST })
 export class DeleteDashboardWidgetUseCase
diff --git a/backend/src/entities/visualizations/dashboard-widget/use-cases/update-dashboard-widget.use.case.ts b/backend/src/entities/visualizations/dashboard-widget/use-cases/update-dashboard-widget.use.case.ts
@@ -6,7 +6,7 @@ import { Messages } from '../../../../exceptions/text/messages.js';
 import { UpdateDashboardWidgetDs } from '../data-structures/update-dashboard-widget.ds.js';
 import { FoundDashboardWidgetDto } from '../dto/found-dashboard-widget.dto.js';
 import { buildFoundDashboardWidgetDto } from '../utils/build-found-dashboard-widget-dto.util.js';
-import { IUpdateDashboardWidget } from './dashboard-use-cases.interface.js';
+import { IUpdateDashboardWidget } from './dashboard-widget-use-cases.interface.js';
 
 @Injectable({ scope: Scope.REQUEST })
 export class UpdateDashboardWidgetUseCase
diff --git a/backend/src/entities/visualizations/dashboard-widget/utils/build-found-dashboard-widget-dto.util.ts b/backend/src/entities/visualizations/dashboard-widget/utils/build-found-dashboard-widget-dto.util.ts
diff --git a/backend/src/entities/visualizations/dashboard/dashboard.entity.ts b/backend/src/entities/visualizations/dashboard/dashboard.entity.ts
@@ -1,6 +1,6 @@
 import { Column, Entity, JoinColumn, ManyToOne, OneToMany, PrimaryGeneratedColumn, Relation } from 'typeorm';
 import { ConnectionEntity } from '../../connection/connection.entity.js';
-import { DashboardWidgetEntity } from './dashboard-widget.entity.js';
+import { DashboardWidgetEntity } from '../dashboard-widget/dashboard-widget.entity.js';
 
 @Entity('dashboard')
 export class DashboardEntity {
diff --git a/backend/src/entities/visualizations/dashboard/dashboards.module.ts b/backend/src/entities/visualizations/dashboard/dashboards.module.ts
@@ -6,15 +6,11 @@ import { AuthMiddleware } from '../../../authorization/auth.middleware.js';
 import { UserEntity } from '../../user/user.entity.js';
 import { LogOutEntity } from '../../log-out/log-out.entity.js';
 import { DashboardController } from './dashboards.controller.js';
-import { DashboardWidgetController } from './dashboard-widgets.controller.js';
 import { CreateDashboardUseCase } from './use-cases/create-dashboard.use.case.js';
 import { UpdateDashboardUseCase } from './use-cases/update-dashboard.use.case.js';
 import { FindDashboardUseCase } from './use-cases/find-dashboard.use.case.js';
 import { FindAllDashboardsUseCase } from './use-cases/find-all-dashboards.use.case.js';
 import { DeleteDashboardUseCase } from './use-cases/delete-dashboard.use.case.js';
-import { CreateDashboardWidgetUseCase } from './use-cases/create-dashboard-widget.use.case.js';
-import { UpdateDashboardWidgetUseCase } from './use-cases/update-dashboard-widget.use.case.js';
-import { DeleteDashboardWidgetUseCase } from './use-cases/delete-dashboard-widget.use.case.js';
 
 @Module({
 	imports: [TypeOrmModule.forFeature([UserEntity, LogOutEntity])],
@@ -43,20 +39,8 @@ import { DeleteDashboardWidgetUseCase } from './use-cases/delete-dashboard-widge
 			provide: UseCaseType.DELETE_DASHBOARD,
 			useClass: DeleteDashboardUseCase,
 		},
-		{
-			provide: UseCaseType.CREATE_DASHBOARD_WIDGET,
-			useClass: CreateDashboardWidgetUseCase,
-		},
-		{
-			provide: UseCaseType.UPDATE_DASHBOARD_WIDGET,
-			useClass: UpdateDashboardWidgetUseCase,
-		},
-		{
-			provide: UseCaseType.DELETE_DASHBOARD_WIDGET,
-			useClass: DeleteDashboardWidgetUseCase,
-		},
 	],
-	controllers: [DashboardController, DashboardWidgetController],
+	controllers: [DashboardController],
 	exports: [],
 })
 export class DashboardModule {
@@ -69,9 +53,6 @@ export class DashboardModule {
 				{ path: '/dashboard/:dashboardId/:connectionId', method: RequestMethod.GET },
 				{ path: '/dashboard/:dashboardId/:connectionId', method: RequestMethod.PUT },
 				{ path: '/dashboard/:dashboardId/:connectionId', method: RequestMethod.DELETE },
-				{ path: '/dashboard/:dashboardId/widget/:connectionId', method: RequestMethod.POST },
-				{ path: '/dashboard/:dashboardId/widget/:widgetId/:connectionId', method: RequestMethod.PUT },
-				{ path: '/dashboard/:dashboardId/widget/:widgetId/:connectionId', method: RequestMethod.DELETE },
 			);
 	}
 }
diff --git a/backend/src/entities/visualizations/dashboard/dto/found-dashboard.dto.ts b/backend/src/entities/visualizations/dashboard/dto/found-dashboard.dto.ts
@@ -1,5 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { FoundDashboardWidgetDto } from './found-dashboard-widget.dto.js';
+import { FoundDashboardWidgetDto } from '../../dashboard-widget/dto/found-dashboard-widget.dto.js';
 
 export class FoundDashboardDto {
 	@ApiProperty({ description: 'Dashboard ID' })
diff --git a/backend/src/entities/visualizations/dashboard/repository/dashboard.repository.interface.ts b/backend/src/entities/visualizations/dashboard/repository/dashboard.repository.interface.ts
@@ -1,5 +1,4 @@
 import { DashboardEntity } from '../dashboard.entity.js';
-import { DashboardWidgetEntity } from '../dashboard-widget.entity.js';
 
 export interface IDashboardRepository {
 	findDashboardById(dashboardId: string): Promise<DashboardEntity | null>;
@@ -9,11 +8,3 @@ export interface IDashboardRepository {
 	saveDashboard(dashboard: DashboardEntity): Promise<DashboardEntity>;
 	removeDashboard(dashboard: DashboardEntity): Promise<DashboardEntity>;
 }
-
-export interface IDashboardWidgetRepository {
-	findWidgetById(widgetId: string): Promise<DashboardWidgetEntity | null>;
-	findWidgetByIdAndDashboardId(widgetId: string, dashboardId: string): Promise<DashboardWidgetEntity | null>;
-	findAllWidgetsByDashboardId(dashboardId: string): Promise<DashboardWidgetEntity[]>;
-	saveWidget(widget: DashboardWidgetEntity): Promise<DashboardWidgetEntity>;
-	removeWidget(widget: DashboardWidgetEntity): Promise<DashboardWidgetEntity>;
-}
diff --git a/backend/src/entities/visualizations/dashboard/use-cases/dashboard-use-cases.interface.ts b/backend/src/entities/visualizations/dashboard/use-cases/dashboard-use-cases.interface.ts
@@ -3,11 +3,7 @@ import { CreateDashboardDs } from '../data-structures/create-dashboard.ds.js';
 import { UpdateDashboardDs } from '../data-structures/update-dashboard.ds.js';
 import { FindDashboardDs } from '../data-structures/find-dashboard.ds.js';
 import { FindAllDashboardsDs } from '../data-structures/find-all-dashboards.ds.js';
-import { CreateDashboardWidgetDs } from '../data-structures/create-dashboard-widget.ds.js';
-import { UpdateDashboardWidgetDs } from '../data-structures/update-dashboard-widget.ds.js';
-import { DeleteDashboardWidgetDs } from '../data-structures/delete-dashboard-widget.ds.js';
 import { FoundDashboardDto } from '../dto/found-dashboard.dto.js';
-import { FoundDashboardWidgetDto } from '../dto/found-dashboard-widget.dto.js';
 
 export interface ICreateDashboard {
 	execute(inputData: CreateDashboardDs, inTransaction: InTransactionEnum): Promise<FoundDashboardDto>;
@@ -28,15 +24,3 @@ export interface IFindAllDashboards {
 export interface IDeleteDashboard {
 	execute(inputData: FindDashboardDs, inTransaction: InTransactionEnum): Promise<FoundDashboardDto>;
 }
-
-export interface ICreateDashboardWidget {
-	execute(inputData: CreateDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
-}
-
-export interface IUpdateDashboardWidget {
-	execute(inputData: UpdateDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
-}
-
-export interface IDeleteDashboardWidget {
-	execute(inputData: DeleteDashboardWidgetDs, inTransaction: InTransactionEnum): Promise<FoundDashboardWidgetDto>;
-}
diff --git a/backend/src/entities/visualizations/dashboard/utils/build-found-dashboard-dto.util.ts b/backend/src/entities/visualizations/dashboard/utils/build-found-dashboard-dto.util.ts
@@ -1,6 +1,6 @@
 import { DashboardEntity } from '../dashboard.entity.js';
 import { FoundDashboardDto } from '../dto/found-dashboard.dto.js';
-import { buildFoundDashboardWidgetDto } from './build-found-dashboard-widget-dto.util.js';
+import { buildFoundDashboardWidgetDto } from '../../dashboard-widget/utils/build-found-dashboard-widget-dto.util.js';
 
 export function buildFoundDashboardDto(dashboard: DashboardEntity): FoundDashboardDto {
 	return {
diff --git a/backend/src/entities/visualizations/saved-db-query/saved-db-query.entity.ts b/backend/src/entities/visualizations/saved-db-query/saved-db-query.entity.ts
@@ -12,7 +12,7 @@ import {
 } from 'typeorm';
 import { Encryptor } from '../../../helpers/encryption/encryptor.js';
 import { ConnectionEntity } from '../../connection/connection.entity.js';
-import { DashboardWidgetEntity } from '../dashboard/dashboard-widget.entity.js';
+import { DashboardWidgetEntity } from '../dashboard-widget/dashboard-widget.entity.js';
 
 @Entity('saved_db_query')
 export class SavedDbQueryEntity {
