feat: add get one host endpoint and related contract updates

- Implement GET_ONE route for hosts in contract routes
- Add new GET_ONE route constant in hosts routes
- Create get-one command and related DTOs/models
- Add new error constant for get one host error
- Implement getOneHost method in hosts service and controller

Author: kastov

libs/contract/api/controllers/hosts.ts

@@ -7,4 +7,5 @@ export const HOSTS_ROUTES = {
     UPDATE: 'update',
     UPDATE_MANY: 'many',
     REORDER: 'reorder',
+    GET_ONE: 'get-one',
 } as const;

libs/contract/api/routes.ts

@@ -90,6 +90,8 @@ export const REST_API = {
         REORDER: `${ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.REORDER}`,
         DELETE: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.DELETE}/${uuid}`,
+        GET_ONE: (uuid: string) =>
+            `${ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.GET_ONE}/${uuid}`,
     },
     SYSTEM: {
         STATS: `${ROOT}/${CONTROLLERS.SYSTEM_CONTROLLER}/${CONTROLLERS.SYSTEM_ROUTES.STATS}`,

libs/contract/commands/hosts/get-one.command.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+
+import { REST_API } from '../../api';
+import { HostsSchema } from '../..';
+
+export namespace GetOneHostCommand {
+    export const url = REST_API.HOSTS.GET_ONE;
+    export const TSQ_url = url(':uuid');
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: HostsSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

libs/contract/commands/hosts/index.ts

@@ -1,5 +1,6 @@
 export * from './create.command';
 export * from './delete.command';
 export * from './get-all.command';
+export * from './get-one.command';
 export * from './reorder.command';
 export * from './update.command';

libs/contract/constants/errors/errors.ts

@@ -338,4 +338,9 @@ export const ERRORS = {
         message: 'Disable node error',
         httpCode: 500,
     },
+    GET_ONE_HOST_ERROR: {
+        code: 'A070',
+        message: 'Get one host error',
+        httpCode: 500,
+    },
 } as const;

libs/contract/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",

src/modules/hosts/dtos/get-one.dto.ts

@@ -0,0 +1,6 @@
+import { createZodDto } from 'nestjs-zod';
+
+import { GetOneHostCommand } from '@libs/contracts/commands';
+
+export class GetOneHostRequestDto extends createZodDto(GetOneHostCommand.RequestSchema) {}
+export class GetOneHostResponseDto extends createZodDto(GetOneHostCommand.ResponseSchema) {}

src/modules/hosts/dtos/index.ts

@@ -1,5 +1,6 @@
 export * from './create-host.dto';
 export * from './delete-host.dto';
 export * from './get-all-hosts.dto';
+export * from './get-one.dto';
 export * from './reorder-hots.dto';
 export * from './update-host.dto';

src/modules/hosts/hosts.controller.ts

@@ -32,11 +32,14 @@ import { ReorderHostRequestDto, ReorderHostResponseDto } from './dtos/reorder-ho
 import { CreateHostRequestDto, CreateHostResponseDto } from './dtos/create-host.dto';
 import { DeleteHostRequestDto, DeleteHostResponseDto } from './dtos/delete-host.dto';
 import { GetAllHostsResponseModel } from './models/get-all-hosts.response.model';
+import { GetOneHostResponseModel } from './models/get-one-host.response.model';
 import { CreateHostResponseModel } from './models/create-host.response.model';
 import { UpdateHostResponseModel } from './models/update-host.response.model';
 import { GetAllHostsResponseDto } from './dtos/get-all-hosts.dto';
 import { UpdateHostResponseDto } from './dtos/update-host.dto';
 import { UpdateHostRequestDto } from './dtos/update-host.dto';
+import { GetOneHostResponseDto } from './dtos/get-one.dto';
+import { GetOneHostRequestDto } from './dtos/get-one.dto';
 import { HostsService } from './hosts.service';
 
 @ApiBearerAuth('Authorization')
@@ -98,6 +101,23 @@ export class HostsController {
         };
     }
 
+    @ApiOkResponse({
+        type: GetOneHostResponseDto,
+        description: 'Host fetched successfully',
+    })
+    @ApiOperation({ summary: 'Get One Host', description: 'Get one host by uuid' })
+    @ApiParam({ name: 'uuid', type: String, description: 'UUID of the host', required: true })
+    @HttpCode(HttpStatus.OK)
+    @Get(HOSTS_ROUTES.GET_ONE + '/:uuid')
+    async getOneHost(@Param() paramData: GetOneHostRequestDto): Promise<GetOneHostResponseDto> {
+        const result = await this.hostsService.getOneHost(paramData.uuid);
+
+        const data = errorHandler(result);
+        return {
+            response: new GetOneHostResponseModel(data),
+        };
+    }
+
     @ApiBody({ type: ReorderHostRequestDto })
     @ApiOkResponse({
         type: ReorderHostResponseDto,

src/modules/hosts/hosts.service.ts

@@ -122,6 +122,27 @@ export class HostsService {
         }
     }
 
+    public async getOneHost(hostUuid: string): Promise<ICommandResponse<HostsEntity>> {
+        try {
+            const result = await this.hostsRepository.findByUUID(hostUuid);
+
+            if (!result) {
+                return {
+                    isOk: false,
+                    ...ERRORS.HOST_NOT_FOUND,
+                };
+            }
+
+            return {
+                isOk: true,
+                response: result,
+            };
+        } catch (error) {
+            this.logger.error(error);
+            return { isOk: false, ...ERRORS.GET_ONE_HOST_ERROR };
+        }
+    }
+
     public async reorderHosts(dto: ReorderHostRequestDto): Promise<
         ICommandResponse<{
             isUpdated: boolean;