Merge pull request #2 from AplinkosMinisterija/forest-data-integration

Update endpoints to allow forest data posting and fetching

src/admin/admin.controller.ts

@@ -5,6 +5,7 @@ import {
   NotFoundException,
   Param,
   ParseBoolPipe,
+  ParseEnumPipe,
   ParseIntPipe,
   Post,
   Put,
@@ -20,6 +21,7 @@ import {
   ApiConsumes,
   ApiNotFoundResponse,
   ApiOkResponse,
+  ApiQuery,
   ApiTags,
 } from '@nestjs/swagger';
 import {
@@ -32,6 +34,7 @@ import {
 import { FilesInterceptor } from '@nestjs/platform-express';
 import { JwtAuthGuard } from '../auth/jwt-auth.guard';
 import { Request } from 'express';
+import { ReportCategory } from '../common/dto/report-category';
 
 @Controller('admin')
 @ApiTags('admin')
@@ -44,13 +47,14 @@ export class AdminController {
     description: 'All reports have been successfully found',
     type: [FullReportDto],
   })
+  @ApiQuery({ name: 'category', enum: ReportCategory, required: false })
   @Get('/reports')
   async getAllReports(
     @Query('isDeleted', ParseBoolPipe) isDeleted: boolean,
+    @Query('category', new ParseEnumPipe(ReportCategory, { optional: true }))
+    category?: ReportCategory,
   ): Promise<FullReportDto[]> {
-    return isDeleted
-      ? await this.adminService.getAllDeletedReports()
-      : await this.adminService.getAllReports();
+    return this.adminService.getAllReports(isDeleted, category);
   }
 
   @ApiOkResponse({

src/admin/admin.service.ts

@@ -14,6 +14,7 @@ import { HistoryEditsDto } from './dto/history-edits.dto';
 import { StatusRecordsDto } from '../report/dto';
 import { UpdateReportDto } from './dto';
 import { Dump } from '../repositories/dumps/schemas';
+import { ReportCategory } from '../common/dto/report-category';
 
 @Injectable()
 export class AdminService {
@@ -22,8 +23,14 @@ export class AdminService {
     private readonly reportRepository: ReportRepository,
   ) {}
 
-  async getAllReports(): Promise<FullReportDto[]> {
-    const reports = await this.reportRepository.getAllReports();
+  async getAllReports(
+    isDeleted: boolean,
+    category?: ReportCategory,
+  ): Promise<FullReportDto[]> {
+    const reports = await this.reportRepository.getAllReports(
+      isDeleted,
+      category,
+    );
     return reports.map(AdminService.docToFullReport);
   }
 
@@ -39,11 +46,6 @@ export class AdminService {
     return AdminService.docToFullDump(dump);
   }
 
-  async getAllDeletedReports(): Promise<FullReportDto[]> {
-    const reports = await this.reportRepository.getDeletedReports();
-    return reports.map(AdminService.docToFullReport);
-  }
-
   async updateReport(
     updateReport: UpdateReportDto,
     images: Array<Express.Multer.File>,
@@ -78,7 +80,6 @@ export class AdminService {
     return new FullDumpDto(
       dump._id.toString(),
       dump.name,
-      dump.type,
       dump.reportLong,
       dump.reportLat,
       dump.isVisible,
@@ -93,7 +94,7 @@ export class AdminService {
     return new FullReportDto(
       report.refId,
       report.name,
-      report.type,
+      AdminService.parseReportCategory(report.type),
       report.refId,
       report.reportLong,
       report.reportLat,
@@ -127,4 +128,12 @@ export class AdminService {
   private static docToStatusRecords(records: StatusRecords): StatusRecordsDto {
     return new StatusRecordsDto(records.status, new Date(records.date));
   }
+
+  private static parseReportCategory(value: string): ReportCategory {
+    if (Object.values(ReportCategory).includes(value as ReportCategory)) {
+      return value as ReportCategory;
+    } else {
+      throw new Error(`Invalid report category: ${value}`);
+    }
+  }
 }

src/admin/dto/full-dump.dto.ts

@@ -8,9 +8,6 @@ export class FullDumpDto {
   @ApiProperty()
   name: string;
 
-  @ApiProperty()
-  type: string;
-
   @ApiProperty({ format: 'double' })
   longitude: number;
 
@@ -36,7 +33,6 @@ export class FullDumpDto {
   constructor(
     refId: string,
     name: string,
-    type: string,
     longitude: number,
     latitude: number,
     isVisible: boolean,
@@ -47,7 +43,6 @@ export class FullDumpDto {
   ) {
     this.refId = refId;
     this.name = name;
-    this.type = type;
     this.longitude = longitude;
     this.latitude = latitude;
     this.isVisible = isVisible;

src/admin/dto/full-report.dto.ts

@@ -2,6 +2,7 @@ import { ApiProperty } from '@nestjs/swagger';
 import { HistoryDataDto } from './history-data.dto';
 import { StatusRecordsDto } from './status-records.dto';
 import { ToBoolean } from '../../common/transform/boolean.transform';
+import { ReportCategory } from '../../common/dto/report-category';
 
 export class FullReportDto {
   @ApiProperty()
@@ -11,7 +12,7 @@ export class FullReportDto {
   name: string;
 
   @ApiProperty()
-  type: string;
+  category: ReportCategory;
 
   @ApiProperty()
   refId: string;
@@ -57,7 +58,7 @@ export class FullReportDto {
   constructor(
     _id: string,
     name: string,
-    type: string,
+    category: ReportCategory,
     refId: string,
     longitude: number,
     latitude: number,
@@ -74,7 +75,7 @@ export class FullReportDto {
   ) {
     this._id = _id;
     this.name = name;
-    this.type = type;
+    this.category = category;
     this.refId = refId;
     this.longitude = longitude;
     this.latitude = latitude;

src/common/dto/report-category.ts

@@ -0,0 +1,4 @@
+export enum ReportCategory {
+  trash = 'trash',
+  forest = 'forest',
+}

src/dumps/dto/dump.dto.ts

@@ -4,9 +4,6 @@ export class DumpDto {
   @ApiProperty()
   name: string;
 
-  @ApiProperty()
-  type: string;
-
   @ApiProperty({ format: 'double' })
   reportLong: number;
 
@@ -27,7 +24,6 @@ export class DumpDto {
 
   constructor(
     name: string,
-    type: string,
     reportLong: number,
     reportLat: number,
     address: string,
@@ -36,7 +32,6 @@ export class DumpDto {
     moreInformation: string,
   ) {
     this.name = name;
-    this.type = type;
     this.reportLong = reportLong;
     this.reportLat = reportLat;
     this.address = address;

src/dumps/dump.service.ts

@@ -11,10 +11,10 @@ export class DumpService {
     const dumps = await this.dumpRepository.getVisibleDumps();
     return dumps.map(this.docToPublicDump);
   }
+
   private docToPublicDump(e: Dump): DumpDto {
     return new DumpDto(
       e.name,
-      e.type,
       e.reportLong,
       e.reportLat,
       e.address,

src/report/dto/create-report.dto.ts

@@ -1,5 +1,6 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsEmail, IsLatitude, IsLongitude, IsNotEmpty } from 'class-validator';
+import { IsEmail, IsEnum, IsLatitude, IsLongitude, IsNotEmpty } from 'class-validator';
+import { ReportCategory } from '../../common/dto/report-category';
 
 export class CreateReportDto {
   @IsNotEmpty()
@@ -11,6 +12,9 @@ export class CreateReportDto {
   @IsLatitude()
   latitude: number;
 
+  @IsEnum(ReportCategory)
+  category: ReportCategory;
+
   @IsEmail()
   email: string;
 

src/report/dto/public-report.dto.ts

@@ -1,12 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { StatusRecordsDto } from './status-records.dto';
+import { ReportCategory } from '../../common/dto/report-category';
 
 export class PublicReportDto {
   @ApiProperty()
   name: string;
 
   @ApiProperty()
-  type: string;
+  category: ReportCategory;
 
   @ApiProperty()
   refId: string;
@@ -37,7 +38,7 @@ export class PublicReportDto {
 
   constructor(
     name: string,
-    type: string,
+    category: ReportCategory,
     refId: string,
     longitude: number,
     latitude: number,
@@ -49,7 +50,7 @@ export class PublicReportDto {
     statusRecords: StatusRecordsDto[],
   ) {
     this.name = name;
-    this.type = type;
+    this.category = category;
     this.refId = refId;
     this.longitude = longitude;
     this.latitude = latitude;

src/report/dto/report-statistics.dto.ts

@@ -8,21 +8,17 @@ export class ReportStatisticsDto {
   @ApiProperty({ type: 'integer' })
   totalInvestigatedReports: number;
   @ApiProperty({ type: 'integer' })
-  totalCleanedReports: number;
-  @ApiProperty({ type: 'integer' })
   totalFalseReports: number;
 
   constructor(
     totalSentReports: number,
     totalInInvestigationReports: number,
     totalInvestigatedReports: number,
-    totalCleanedReports: number,
     totalFalseReports: number,
   ) {
     this.totalSentReports = totalSentReports;
     this.totalInInvestigationReports = totalInInvestigationReports;
     this.totalInvestigatedReports = totalInvestigatedReports;
-    this.totalCleanedReports = totalCleanedReports;
     this.totalFalseReports = totalFalseReports;
   }
 }

src/report/report.controller.ts

@@ -4,8 +4,10 @@ import {
   Get,
   NotFoundException,
   Param,
+  ParseEnumPipe,
   ParseIntPipe,
   Post,
+  Query,
   UploadedFiles,
   UseInterceptors,
 } from '@nestjs/common';
@@ -15,12 +17,14 @@ import {
   ApiCreatedResponse,
   ApiNotFoundResponse,
   ApiOkResponse,
+  ApiQuery,
   ApiTags,
 } from '@nestjs/swagger';
 import { PublicReportDto } from './dto';
 import { CreateReportDto } from './dto';
 import { FilesInterceptor } from '@nestjs/platform-express';
 import { ReportStatisticsDto } from './dto/report-statistics.dto';
+import { ReportCategory } from '../common/dto/report-category';
 
 @Controller('reports')
 @ApiTags('reports')
@@ -45,18 +49,26 @@ export class ReportController {
     description: 'All visible reports have been successfully found',
     type: [PublicReportDto],
   })
+  @ApiQuery({ name: 'category', enum: ReportCategory, required: false })
   @Get()
-  getAllPublicReports(): Promise<PublicReportDto[]> {
-    return this.reportService.getAllVisibleReports();
+  getAllPublicReports(
+    @Query('category', new ParseEnumPipe(ReportCategory, { optional: true }))
+    category?: ReportCategory,
+  ): Promise<PublicReportDto[]> {
+    return this.reportService.getAllVisibleReports(category);
   }
 
   @ApiOkResponse({
     description: 'Report statistics have been successfully fetched',
     type: ReportStatisticsDto,
   })
+  @ApiQuery({ name: 'category', enum: ReportCategory, required: false })
   @Get('/statistics')
-  getReportStatistics(): Promise<ReportStatisticsDto> {
-    return this.reportService.getReportStatistics();
+  getReportStatistics(
+    @Query('category', new ParseEnumPipe(ReportCategory, { optional: true }))
+    category?: ReportCategory,
+  ): Promise<ReportStatisticsDto> {
+    return this.reportService.getReportStatistics(category);
   }
 
   @Get('/:refId')