feat: update GetConnectionsInfoByIds use case to return FoundConnectionInfoRO and add new data structure

Author: Artuomka

backend/src/microservices/saas-microservice/data-structures/found-connection-info.ro.ts

@@ -0,0 +1,58 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
+
+export class FoundConnectionInfoRO {
+	@ApiProperty()
+	id: string;
+
+	@ApiProperty()
+	title: string;
+
+	@ApiProperty({ enum: ConnectionTypesEnum })
+	type: ConnectionTypesEnum;
+
+	@ApiProperty()
+	host: string;
+
+	@ApiProperty()
+	port: number;
+
+	@ApiProperty()
+	database: string;
+
+	@ApiProperty()
+	schema: string;
+
+	@ApiProperty()
+	sid: string;
+
+	@ApiProperty()
+	ssh: boolean;
+
+	@ApiProperty()
+	ssl: boolean;
+
+	@ApiProperty()
+	createdAt: Date;
+
+	@ApiProperty()
+	updatedAt: Date;
+
+	@ApiProperty()
+	isTestConnection: boolean;
+
+	@ApiProperty()
+	is_frozen: boolean;
+
+	@ApiProperty()
+	masterEncryption: boolean;
+
+	@ApiProperty()
+	azure_encryption: boolean;
+
+	@ApiProperty()
+	authSource: string;
+
+	@ApiProperty()
+	dataCenter: string | null;
+}

backend/src/microservices/saas-microservice/saas.controller.ts

@@ -24,8 +24,8 @@ import { UserEntity } from '../../entities/user/user.entity.js';
 import { InTransactionEnum } from '../../enums/in-transaction.enum.js';
 import { Messages } from '../../exceptions/text/messages.js';
 import { SentryInterceptor } from '../../interceptors/sentry.interceptor.js';
-import { ConnectionEntity } from '../../entities/connection/connection.entity.js';
 import { CreatedConnectionResponse, SuccessResponse } from './data-structures/common-responce.ds.js';
+import { FoundConnectionInfoRO } from './data-structures/found-connection-info.ro.js';
 import { CreateConnectionForHostedDbDto } from './data-structures/create-connecttion-for-selfhosted-db.dto.js';
 import { DeleteConnectionForHostedDbDto } from './data-structures/delete-connection-for-hosted-db.dto.js';
 import { GetConnectionsInfoByIdsDS } from './data-structures/get-connections-info-by-ids.ds.js';
@@ -336,12 +336,12 @@ export class SaasController {
 	@ApiBody({ type: GetConnectionsInfoByIdsDS })
 	@ApiResponse({
 		status: 200,
-		type: [ConnectionEntity],
+		type: [FoundConnectionInfoRO],
 	})
 	@Post('/connections/info')
 	async getConnectionsInfoByIds(
 		@Body() connectionsData: GetConnectionsInfoByIdsDS,
-	): Promise<Array<ConnectionEntity>> {
+	): Promise<Array<FoundConnectionInfoRO>> {
 		return await this.getConnectionsInfoByIdsUseCase.execute(connectionsData);
 	}
 }

backend/src/microservices/saas-microservice/use-cases/get-connections-info-by-ids.use.case.ts

@@ -5,12 +5,13 @@ import { IGlobalDatabaseContext } from '../../../common/application/global-datab
 import { BaseType } from '../../../common/data-injection.tokens.js';
 import { ConnectionEntity } from '../../../entities/connection/connection.entity.js';
 import { Messages } from '../../../exceptions/text/messages.js';
+import { FoundConnectionInfoRO } from '../data-structures/found-connection-info.ro.js';
 import { GetConnectionsInfoByIdsDS } from '../data-structures/get-connections-info-by-ids.ds.js';
 import { IGetConnectionsInfoByIds } from './saas-use-cases.interface.js';
 
 @Injectable()
 export class GetConnectionsInfoByIdsUseCase
-	extends AbstractUseCase<GetConnectionsInfoByIdsDS, Array<ConnectionEntity>>
+	extends AbstractUseCase<GetConnectionsInfoByIdsDS, Array<FoundConnectionInfoRO>>
 	implements IGetConnectionsInfoByIds
 {
 	constructor(
@@ -20,7 +21,7 @@ export class GetConnectionsInfoByIdsUseCase
 		super();
 	}
 
-	protected async implementation(inputData: GetConnectionsInfoByIdsDS): Promise<Array<ConnectionEntity>> {
+	protected async implementation(inputData: GetConnectionsInfoByIdsDS): Promise<Array<FoundConnectionInfoRO>> {
 		const { connectionIds } = inputData;
 		if (!connectionIds || connectionIds.length === 0) {
 			throw new HttpException(
@@ -35,6 +36,29 @@ export class GetConnectionsInfoByIdsUseCase
 			id: In(connectionIds),
 		});
 
-		return connections;
+		return connections.map((connection) => this.buildConnectionInfoRO(connection));
+	}
+
+	private buildConnectionInfoRO(connection: ConnectionEntity): FoundConnectionInfoRO {
+		return {
+			id: connection.id,
+			title: connection.title,
+			type: connection.type,
+			host: connection.host,
+			port: connection.port,
+			database: connection.database,
+			schema: connection.schema,
+			sid: connection.sid,
+			ssh: connection.ssh,
+			ssl: connection.ssl,
+			createdAt: connection.createdAt,
+			updatedAt: connection.updatedAt,
+			isTestConnection: connection.isTestConnection,
+			is_frozen: connection.is_frozen,
+			masterEncryption: connection.masterEncryption,
+			azure_encryption: connection.azure_encryption,
+			authSource: connection.authSource,
+			dataCenter: connection.dataCenter,
+		};
 	}
 }

backend/src/microservices/saas-microservice/use-cases/saas-use-cases.interface.ts

@@ -1,6 +1,6 @@
 import { CompanyInfoEntity } from '../../../entities/company-info/company-info.entity.js';
 import { CreatedConnectionDTO } from '../../../entities/connection/application/dto/created-connection.dto.js';
-import { ConnectionEntity } from '../../../entities/connection/connection.entity.js';
+import { FoundConnectionInfoRO } from '../data-structures/found-connection-info.ro.js';
 import { SaaSRegisterDemoUserAccountDS } from '../../../entities/user/application/data-structures/demo-user-account-register.ds.js';
 import { SaasUsualUserRegisterDS } from '../../../entities/user/application/data-structures/usual-register-user.ds.js';
 import { FoundUserDto } from '../../../entities/user/dto/found-user.dto.js';
@@ -86,5 +86,5 @@ export interface IUpdateHostedConnectionPassword {
 }
 
 export interface IGetConnectionsInfoByIds {
-	execute(inputData: GetConnectionsInfoByIdsDS): Promise<Array<ConnectionEntity>>;
+	execute(inputData: GetConnectionsInfoByIdsDS): Promise<Array<FoundConnectionInfoRO>>;
 }