feat: Add dashboard endpoints

package.json

@@ -31,6 +31,7 @@
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/platform-fastify": "^10.3.8",
+    "@nestjs/schedule": "^4.0.2",
     "@nestjs/swagger": "^7.3.1",
     "@prisma/client": "^5.13.0",
     "bcrypt": "^5.1.1",

src/app.module.ts

@@ -12,6 +12,7 @@ import { SupplyCategoriesModule } from './supply-categories/supply-categories.mo
 import { ShelterManagersModule } from './shelter-managers/shelter-managers.module';
 import { ShelterSupplyModule } from './shelter-supply/shelter-supply.module';
 import { PartnersModule } from './partners/partners.module';
+import { DashboardModule } from './modules/dashboard/dashboard.module';
 import { SupportersModule } from './supporters/supporters.module';
 
 @Module({
@@ -25,6 +26,7 @@ import { SupportersModule } from './supporters/supporters.module';
     ShelterManagersModule,
     ShelterSupplyModule,
     PartnersModule,
+    DashboardModule,
     SupportersModule,
   ],
   controllers: [],

src/modules/dashboard/dashboard.controller.spec.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { DashboardController } from './dashboard.controller';
+import { DashboardService } from './dashboard.service';
+
+describe('DashboardController', () => {
+  let controller: DashboardController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [DashboardController],
+      providers: [DashboardService],
+    }).compile();
+
+    controller = module.get<DashboardController>(DashboardController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/modules/dashboard/dashboard.controller.ts

@@ -0,0 +1,22 @@
+import { Controller, Get, HttpException, Logger, Query } from '@nestjs/common';
+import { DashboardService } from './dashboard.service';
+import { ServerResponse } from '@/utils/utils';
+import { ApiTags } from '@nestjs/swagger';
+
+@ApiTags('Dashboard')
+@Controller('dashboard')
+export class DashboardController {
+  private logger = new Logger();
+  constructor(private readonly dashboardService: DashboardService) {}
+
+  @Get('')
+  async index(@Query() query) {
+    try {
+      const data = await this.dashboardService.index(query);
+      return new ServerResponse(200, 'Successfully get dashboard', data);
+    } catch (err: any) {
+      this.logger.error(`Failed to get shelters: ${err}`);
+      throw new HttpException(err?.code ?? err?.name ?? `${err}`, 400);
+    }
+  }
+}

src/modules/dashboard/dashboard.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { DashboardService } from './dashboard.service';
+import { DashboardController } from './dashboard.controller';
+import { PrismaModule } from 'src/prisma/prisma.module';
+
+@Module({
+  imports: [PrismaModule],
+  controllers: [DashboardController],
+  providers: [DashboardService],
+})
+export class DashboardModule {}

src/modules/dashboard/dashboard.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { DashboardService } from './dashboard.service';
+
+describe('DashboardService', () => {
+  let service: DashboardService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [DashboardService],
+    }).compile();
+
+    service = module.get<DashboardService>(DashboardService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

src/modules/dashboard/dashboard.service.ts

@@ -0,0 +1,67 @@
+import * as qs from 'qs';
+import { Injectable } from '@nestjs/common';
+import { PrismaService } from 'src/prisma/prisma.service';
+import { ShelterSearchPropsSchema } from 'src/shelter/types/search.types';
+import { SearchSchema } from 'src/types';
+import { ShelterSearch } from 'src/shelter/ShelterSearch';
+
+@Injectable()
+export class DashboardService {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async index(query: any) {
+    const {
+      order,
+      orderBy,
+      page,
+      perPage,
+      search: searchQuery,
+    } = SearchSchema.parse(query);
+
+    const queryData = ShelterSearchPropsSchema.parse(qs.parse(searchQuery));
+    const { query: where } = new ShelterSearch(this.prismaService, queryData);
+
+    const take = perPage;
+    const skip = perPage * (page - 1);
+
+    const whereData = {
+      take,
+      skip,
+      orderBy: { [orderBy]: order },
+      where,
+    };
+
+    const allShelters = await this.prismaService.shelter.findMany({
+      ...whereData,
+      include: { shelterSupplies: true },
+    });
+
+    const allPeopleSheltered = allShelters.reduce((accumulator, current) => {
+      return accumulator + (current.shelteredPeople ?? 0);
+    }, 0);
+
+    let shelterAvailable = 0;
+    let shelterFull = 0;
+    let shelterWithoutInformation = 0;
+
+    allShelters.forEach((shelter) => {
+      if (shelter.shelteredPeople !== null && shelter.capacity !== null) {
+        if (shelter.shelteredPeople < shelter.capacity) {
+          shelterAvailable++;
+        } else if (shelter.shelteredPeople >= shelter.capacity) {
+          shelterFull++;
+        }
+      } else {
+        shelterWithoutInformation++;
+      }
+    });
+
+    return {
+      allShelters: allShelters.length,
+      allPeopleSheltered: allPeopleSheltered,
+      shelterAvailable: shelterAvailable,
+      shelterFull: shelterFull,
+      shelterWithoutInformation: shelterWithoutInformation,
+    };
+  }
+}

src/modules/dashboard/entities/dashboard.entity.ts

@@ -0,0 +1 @@
+export class Dashboard {}

src/partners/partners.controller.ts

@@ -9,8 +9,10 @@ import {
 } from '@nestjs/common';
 import { PartnersService } from './partners.service';
 import { ServerResponse } from '../utils';
+import { ApiTags } from '@nestjs/swagger';
 import { AdminGuard } from '@/guards/admin.guard';
 
+@ApiTags('Parceiros')
 @Controller('partners')
 export class PartnersController {
   private logger = new Logger(PartnersController.name);