Merge pull request #1683 from rocket-admin/backend_ceadr_refactoring

types refactoring

Author: Artuomka

backend/src/entities/company-info/application/data-structures/found-company-info.ds.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { FoundSipleConnectionInfoDS } from '../../../connection/application/data-structures/found-connections.ds.js';
+import { FoundSimpleConnectionInfoDS } from '../../../connection/application/data-structures/found-connections.ds.js';
 import { FoundCompanyImageInfo } from '../dto/found-company-logo.ro.js';
 import { FoundInvitationInCompanyDs } from './found-invitation-in-company.ds.js';
 
@@ -49,7 +49,7 @@ export class FoundUserCompanyInfoDs {
 
 export class FoundUserFullCompanyInfoDs extends FoundUserCompanyInfoDs {
 	@ApiProperty({ isArray: true })
-	connections: Array<FoundSipleConnectionInfoDS>;
+	connections: Array<FoundSimpleConnectionInfoDS>;
 
 	@ApiProperty({ isArray: true, type: FoundInvitationInCompanyDs })
 	invitations: Array<FoundInvitationInCompanyDs>;

backend/src/entities/company-info/utils/build-found-company-info-ds.ts

@@ -1,5 +1,5 @@
 import { FoundSassCompanyInfoDS } from '../../../microservices/gateways/saas-gateway.ts/data-structures/found-saas-company-info.ds.js';
-import { FoundSipleConnectionInfoDS } from '../../connection/application/data-structures/found-connections.ds.js';
+import { FoundSimpleConnectionInfoDS } from '../../connection/application/data-structures/found-connections.ds.js';
 import { UserRoleEnum } from '../../user/enums/user-role.enum.js';
 import { buildSimpleUserInfoDs } from '../../user/utils/build-created-user.ds.js';
 import {
@@ -26,7 +26,7 @@ export function buildFoundCompanyFullInfoDs(
 		companyCustomDomain,
 		userRole,
 	) as any;
-	const connectionsRO: Array<FoundSipleConnectionInfoDS> = companyInfoFromCore.connections.map((connection) => {
+	const connectionsRO: Array<FoundSimpleConnectionInfoDS> = companyInfoFromCore.connections.map((connection) => {
 		return {
 			id: connection.id,
 			createdAt: connection.createdAt,

backend/src/entities/connection/application/data-structures/connection-parameters.ds.ts

@@ -0,0 +1,24 @@
+import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
+
+export interface ConnectionParametersDs {
+	title?: string;
+	masterEncryption?: boolean;
+	type: ConnectionTypesEnum;
+	host?: string;
+	port?: number;
+	username?: string;
+	password?: string;
+	database?: string;
+	schema?: string;
+	sid?: string;
+	ssh?: boolean;
+	privateSSHKey?: string;
+	sshHost?: string;
+	sshPort?: number;
+	sshUsername?: string;
+	ssl?: boolean;
+	cert?: string;
+	azure_encryption?: boolean;
+	authSource?: string;
+	dataCenter?: string;
+}

backend/src/entities/connection/application/data-structures/create-connection.ds.ts

@@ -1,28 +1,7 @@
-import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
+import { ConnectionParametersDs } from './connection-parameters.ds.js';
 
 export class CreateConnectionDs {
-	connection_parameters: {
-		title: string;
-		masterEncryption: boolean;
-		type: ConnectionTypesEnum;
-		host: string;
-		port: number;
-		username: string;
-		password: string;
-		database: string;
-		schema: string;
-		sid: string;
-		ssh: boolean;
-		privateSSHKey: string;
-		sshHost: string;
-		sshPort: number;
-		sshUsername: string;
-		ssl: boolean;
-		cert: string;
-		azure_encryption: boolean;
-		authSource: string;
-		dataCenter: string;
-	};
+	connection_parameters: ConnectionParametersDs;
 	creation_info: {
 		authorId: string;
 		masterPwd: string;

backend/src/entities/connection/application/data-structures/found-connections.ds.ts

@@ -4,7 +4,6 @@ import { AccessLevelEnum } from '../../../../enums/index.js';
 import { ConnectionPropertiesEntity } from '../../../connection-properties/connection-properties.entity.js';
 import { FoundGroupDataWithUsersDs } from '../../../group/application/data-sctructures/found-user-groups.ds.js';
 import { SimpleFoundUserInfoDs } from '../../../user/dto/found-user.dto.js';
-import { UserEntity } from '../../../user/user.entity.js';
 
 export class FoundDirectConnectionsDs {
 	@ApiProperty()
@@ -17,7 +16,7 @@ export class FoundDirectConnectionsDs {
 	masterEncryption: boolean;
 
 	@ApiProperty({ enum: ConnectionTypesEnum })
-	type?: ConnectionTypesEnum | string;
+	type?: ConnectionTypesEnum;
 
 	@ApiProperty()
 	host?: string;
@@ -59,7 +58,7 @@ export class FoundDirectConnectionsDs {
 	cert?: string;
 
 	@ApiProperty({ required: false })
-	author?: UserEntity | string;
+	author?: string;
 
 	@ApiProperty({ required: false })
 	token?: string;
@@ -94,7 +93,7 @@ export class FoundDirectConnectionsNonePermissionDs {
 	title?: string;
 
 	@ApiProperty()
-	type?: ConnectionTypesEnum | string;
+	type?: ConnectionTypesEnum;
 
 	@ApiProperty()
 	database: string;
@@ -117,10 +116,10 @@ export class FoundAgentConnectionsDs {
 	title?: string;
 
 	@ApiProperty({ enum: ConnectionTypesEnum })
-	type?: ConnectionTypesEnum | string;
+	type?: ConnectionTypesEnum;
 
 	@ApiProperty({ required: false })
-	author: UserEntity | string;
+	author?: string;
 
 	@ApiProperty()
 	token: string;
@@ -135,15 +134,15 @@ export class FoundAgentConnectionsDs {
 	connection_properties: ConnectionPropertiesEntity;
 }
 
-export class FoundSipleConnectionInfoDS {
+export class FoundSimpleConnectionInfoDS {
 	@ApiProperty()
 	id: string;
 
 	@ApiProperty()
 	title?: string;
 
 	@ApiProperty({ enum: ConnectionTypesEnum })
-	type?: ConnectionTypesEnum | string;
+	type?: ConnectionTypesEnum;
 
 	@ApiProperty()
 	isTestConnection: boolean;

backend/src/entities/connection/application/data-structures/update-connection.ds.ts

@@ -1,28 +1,7 @@
-import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
+import { ConnectionParametersDs } from './connection-parameters.ds.js';
 
 export class UpdateConnectionDs {
-	connection_parameters: {
-		title: string;
-		masterEncryption: boolean;
-		type: ConnectionTypesEnum;
-		host: string;
-		port: number;
-		username: string;
-		password: string;
-		database: string;
-		schema: string;
-		sid: string;
-		ssh: boolean;
-		privateSSHKey: string;
-		sshHost: string;
-		sshPort: number;
-		sshUsername: string;
-		ssl: boolean;
-		cert: string;
-		azure_encryption: boolean;
-		authSource: string;
-		dataCenter: string;
-	};
+	connection_parameters: ConnectionParametersDs;
 	update_info: {
 		authorId: string;
 		connectionId: string;

backend/src/entities/connection/application/dto/created-connection.dto.ts

@@ -27,7 +27,7 @@ export class CreatedConnectionDTO {
 	masterEncryption: boolean;
 
 	@ApiProperty({ enum: ConnectionTypesEnum })
-	type: ConnectionTypesEnum | string;
+	type: ConnectionTypesEnum;
 
 	@ApiProperty()
 	host: string;

backend/src/entities/connection/application/dto/delete-connection.dto.ts

@@ -4,11 +4,11 @@ import { IsOptional, IsString } from 'class-validator';
 export class DeleteConnectionReasonDto {
 	@IsOptional()
 	@IsString()
-	@ApiProperty()
-	reason: string;
+	@ApiProperty({ required: false })
+	reason?: string;
 
 	@IsOptional()
 	@IsString()
-	@ApiProperty()
-	message: string;
+	@ApiProperty({ required: false })
+	message?: string;
 }

backend/src/entities/connection/connection.controller.ts

@@ -27,7 +27,6 @@ import { SentryInterceptor } from '../../interceptors/index.js';
 import { SuccessResponse } from '../../microservices/saas-microservice/data-structures/common-responce.ds.js';
 import { AmplitudeService } from '../amplitude/amplitude.service.js';
 import { FoundGroupResponseDto } from '../group/dto/found-group-response.dto.js';
-import { IComplexPermission } from '../permission/permission.interface.js';
 import { FindUserDs } from '../user/application/data-structures/find-user.ds.js';
 import { FoundUserDto } from '../user/dto/found-user.dto.js';
 import { CreateConnectionDs } from './application/data-structures/create-connection.ds.js';
@@ -291,7 +290,7 @@ export class ConnectionController {
 		@UserId() userId: string,
 		@MasterPassword() masterPwd: string,
 	): Promise<UpdatedConnectionResponseDTO> {
-		const errors = [];
+		const errors: string[] = [];
 		if (updateConnectionDto.masterEncryption && !masterPwd) {
 			errors.push(Messages.MASTER_PASSWORD_REQUIRED);
 		}
@@ -457,7 +456,7 @@ export class ConnectionController {
 		@QueryUuid('groupId') groupId: string,
 		@UserId() userId: string,
 		@MasterPassword() masterPwd: string,
-	): Promise<IComplexPermission> {
+	): Promise<FoundPermissionsInConnectionDs> {
 		if (!connectionId || !groupId) {
 			throw new BadRequestException(Messages.PARAMETER_MISSING);
 		}
@@ -481,7 +480,7 @@ export class ConnectionController {
 		@QueryUuid('groupId') groupId: string,
 		@UserId() userId: string,
 		@MasterPassword() masterPwd: string,
-	): Promise<IComplexPermission> {
+	): Promise<FoundPermissionsInConnectionDs> {
 		if (!connectionId || !groupId) {
 			throw new BadRequestException(Messages.PARAMETER_MISSING);
 		}
@@ -537,10 +536,11 @@ export class ConnectionController {
 		};
 		try {
 			await validateCreateConnectionData(inputData);
-		} catch (e) {
+		} catch (e: unknown) {
+			const err = e as { response?: { message?: string }; message?: string };
 			return {
 				result: false,
-				message: e?.response?.message || e?.message || Messages.CONNECTION_TYPE_INVALID,
+				message: err?.response?.message || err?.message || Messages.CONNECTION_TYPE_INVALID,
 			};
 		}
 		const result = await this.testConnectionUseCase.execute(inputData, InTransactionEnum.OFF);

backend/src/entities/connection/connection.entity.ts

@@ -13,6 +13,7 @@ import {
 	PrimaryColumn,
 	Relation,
 } from 'typeorm';
+import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
 import { Constants } from '../../helpers/constants/constants.js';
 import { Encryptor } from '../../helpers/encryption/encryptor.js';
 import { isConnectionTypeAgent } from '../../helpers/index.js';
@@ -43,7 +44,7 @@ export class ConnectionEntity {
 	masterEncryption: boolean;
 
 	@Column({ default: null })
-	type?: string | null;
+	type?: ConnectionTypesEnum | null;
 
 	@Column({ default: null })
 	host?: string | null;
@@ -106,7 +107,7 @@ export class ConnectionEntity {
 	saved_table_info: number;
 
 	@Column({ default: null })
-	signing_key: string;
+	signing_key: string | null;
 
 	@Column({ default: null })
 	authSource?: string | null;