feat: add occupancy module with controller, service, and related DTOs for heat map data retrieval

src/app.module.ts

@@ -37,12 +37,13 @@ import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
 import { HealthModule } from './health/health.module';
 
 import { winstonLoggerOptions } from '../libs/common/src/logger/services/winston.logger';
+import { OccupancyModule } from './occupancy/occupancy.module';
 @Module({
   imports: [
     ConfigModule.forRoot({
       load: config,
     }),
-  /*   ThrottlerModule.forRoot({
+    /*   ThrottlerModule.forRoot({
       throttlers: [{ ttl: 100000, limit: 30 }],
     }), */
     WinstonModule.forRoot(winstonLoggerOptions),
@@ -77,13 +78,14 @@ import { winstonLoggerOptions } from '../libs/common/src/logger/services/winston
     DeviceCommissionModule,
     PowerClampModule,
     HealthModule,
+    OccupancyModule,
   ],
   providers: [
     {
       provide: APP_INTERCEPTOR,
       useClass: LoggingInterceptor,
     },
-   /*  {
+    /*  {
       provide: APP_GUARD,
       useClass: ThrottlerGuard,
     }, */

src/commission-device/commission-device.module.ts

@@ -28,6 +28,7 @@ import {
 } from '@app/common/modules/power-clamp/repositories';
 import { PowerClampService } from '@app/common/helper/services/power.clamp.service';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 @Module({
   imports: [ConfigModule, SpaceRepositoryModule],
@@ -55,6 +56,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [],
 })

src/community/community.module.ts

@@ -63,6 +63,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 @Module({
   imports: [ConfigModule, SpaceRepositoryModule, UserRepositoryModule],
@@ -114,6 +115,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [CommunityService, SpacePermissionService],
 })

src/door-lock/door.lock.module.ts

@@ -27,6 +27,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 @Module({
   imports: [ConfigModule, DeviceRepositoryModule],
   controllers: [DoorLockController],
@@ -52,6 +53,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [DoorLockService],
 })

src/group/group.module.ts

@@ -25,6 +25,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 @Module({
   imports: [ConfigModule, DeviceRepositoryModule],
   controllers: [GroupController],
@@ -49,6 +50,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [GroupService],
 })

src/invite-user/invite-user.module.ts

@@ -83,6 +83,7 @@ import {
 } from '@app/common/modules/power-clamp/repositories';
 import { PowerClampService } from '@app/common/helper/services/power.clamp.service';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 @Module({
   imports: [ConfigModule, InviteUserRepositoryModule, CommunityModule],
@@ -152,6 +153,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [InviteUserService],
 })

src/occupancy/controllers/index.ts

@@ -0,0 +1 @@
+export * from './occupancy.controller';

src/occupancy/controllers/occupancy.controller.ts

@@ -0,0 +1,46 @@
+import { Controller, Get, Param, Query, UseGuards } from '@nestjs/common';
+import {
+  ApiTags,
+  ApiBearerAuth,
+  ApiOperation,
+  ApiParam,
+} from '@nestjs/swagger';
+import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
+import { ControllerRoute } from '@app/common/constants/controller-route';
+import { JwtAuthGuard } from '@app/common/guards/jwt.auth.guard';
+import { OccupancyService } from '../services/occupancy.service';
+import { GetOccupancyHeatMapBySpaceDto } from '../dto/get-occupancy.dto';
+import { BaseResponseDto } from '@app/common/dto/base.response.dto';
+import { SpaceParamsDto } from '../dto/occupancy-params.dto';
+
+@ApiTags('Occupancy Module')
+@Controller({
+  version: EnableDisableStatusEnum.ENABLED,
+  path: ControllerRoute.Occupancy.ROUTE,
+})
+export class OccupancyController {
+  constructor(private readonly occupancyService: OccupancyService) {}
+
+  @ApiBearerAuth()
+  @UseGuards(JwtAuthGuard)
+  @Get('heat-map/space/:spaceUuid')
+  @ApiOperation({
+    summary: ControllerRoute.Occupancy.ACTIONS.GET_OCCUPANCY_HEAT_MAP_SUMMARY,
+    description:
+      ControllerRoute.Occupancy.ACTIONS.GET_OCCUPANCY_HEAT_MAP_DESCRIPTION,
+  })
+  @ApiParam({
+    name: 'spaceUuid',
+    description: 'UUID of the Space',
+    required: true,
+  })
+  async getOccupancyHeatMapDataBySpace(
+    @Param() params: SpaceParamsDto,
+    @Query() query: GetOccupancyHeatMapBySpaceDto,
+  ): Promise<BaseResponseDto> {
+    return await this.occupancyService.getOccupancyHeatMapDataBySpace(
+      params,
+      query,
+    );
+  }
+}

src/occupancy/dto/get-occupancy.dto.ts

@@ -0,0 +1,15 @@
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Matches, IsNotEmpty } from 'class-validator';
+
+export class GetOccupancyHeatMapBySpaceDto {
+  @ApiPropertyOptional({
+    description: 'Input year in YYYY format to filter the data',
+    example: '2025',
+    required: false,
+  })
+  @IsNotEmpty()
+  @Matches(/^\d{4}$/, {
+    message: 'Year must be in YYYY format',
+  })
+  year: string;
+}

src/occupancy/dto/occupancy-params.dto.ts

@@ -0,0 +1,7 @@
+import { IsNotEmpty, IsUUID } from 'class-validator';
+
+export class SpaceParamsDto {
+  @IsUUID('4', { message: 'Invalid UUID format' })
+  @IsNotEmpty()
+  spaceUuid: string;
+}

src/occupancy/occupancy.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { OccupancyController } from './controllers';
+import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from './services';
+@Module({
+  imports: [ConfigModule],
+  controllers: [OccupancyController],
+  providers: [OccupancyService, SqlLoaderService],
+})
+export class OccupancyModule {}

src/occupancy/services/index.ts

@@ -0,0 +1 @@
+export * from './occupancy.service';

src/occupancy/services/occupancy.service.ts

@@ -0,0 +1,69 @@
+import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
+import { GetOccupancyHeatMapBySpaceDto } from '../dto/get-occupancy.dto';
+import { SuccessResponseDto } from '@app/common/dto/success.response.dto';
+import { SpaceParamsDto } from '../dto/occupancy-params.dto';
+import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { DataSource } from 'typeorm';
+import { SQL_PROCEDURES_PATH } from '@app/common/constants/sql-query-path';
+import { BaseResponseDto } from '@app/common/dto/base.response.dto';
+
+@Injectable()
+export class OccupancyService {
+  constructor(
+    private readonly sqlLoader: SqlLoaderService,
+    private readonly dataSource: DataSource,
+  ) {}
+
+  async getOccupancyHeatMapDataBySpace(
+    params: SpaceParamsDto,
+    query: GetOccupancyHeatMapBySpaceDto,
+  ): Promise<BaseResponseDto> {
+    const { year } = query;
+    const { spaceUuid } = params;
+
+    try {
+      const data = await this.executeProcedure(
+        'proceduce_select_fact_space_occupancy',
+        [spaceUuid, year],
+      );
+      const formattedData = data.map((item) => ({
+        ...item,
+        event_date: new Date(item.event_date).toLocaleDateString('en-CA'), // YYYY-MM-DD
+      }));
+      return this.buildResponse(
+        `Occupancy heat map data fetched successfully for ${spaceUuid ? 'space' : 'community'}`,
+        formattedData,
+      );
+    } catch (error) {
+      console.error('Failed to fetch occupancy heat map data', {
+        error,
+        spaceUuid,
+      });
+      throw new HttpException(
+        error.response?.message || 'Failed to fetch occupancy heat map data',
+        error.status || HttpStatus.INTERNAL_SERVER_ERROR,
+      );
+    }
+  }
+
+  private buildResponse(message: string, data: any[]) {
+    return new SuccessResponseDto({
+      message,
+      data,
+      statusCode: HttpStatus.OK,
+    });
+  }
+  private async executeProcedure(
+    procedureFileName: string,
+    params: (string | number | null)[],
+  ): Promise<any[]> {
+    const query = this.loadQuery(
+      'fact_space_occupancy_count',
+      procedureFileName,
+    );
+    return await this.dataSource.query(query, params);
+  }
+  private loadQuery(folderName: string, fileName: string): string {
+    return this.sqlLoader.loadQuery(folderName, fileName, SQL_PROCEDURES_PATH);
+  }
+}

src/power-clamp/power-clamp.module.ts

@@ -60,6 +60,7 @@ import { SubspaceProductAllocationService } from 'src/space/services/subspace/su
 import { NewTagRepository } from '@app/common/modules/tag/repositories/tag-repository';
 import { SpaceModelProductAllocationService } from 'src/space-model/services/space-model-product-allocation.service';
 import { SubspaceModelProductAllocationService } from 'src/space-model/services/subspace/subspace-model-product-allocation.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 @Module({
   imports: [ConfigModule],
   controllers: [PowerClampController],
@@ -109,6 +110,7 @@ import { SubspaceModelProductAllocationService } from 'src/space-model/services/
     SubspaceModelProductAllocationService,
     SpaceModelProductAllocationRepoitory,
     SubspaceModelProductAllocationRepoitory,
+    OccupancyService,
   ],
   exports: [PowerClamp],
 })

src/project/project.module.ts

@@ -67,6 +67,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 const CommandHandlers = [CreateOrphanSpaceHandler];
 
@@ -124,6 +125,7 @@ const CommandHandlers = [CreateOrphanSpaceHandler];
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [ProjectService, CqrsModule],
 })

src/space-model/space-model.module.ts

@@ -65,6 +65,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 const CommandHandlers = [
   PropogateUpdateSpaceModelHandler,
@@ -124,6 +125,7 @@ const CommandHandlers = [
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [CqrsModule, SpaceModelService],
 })

src/space/space.module.ts

@@ -90,6 +90,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 
 export const CommandHandlers = [DisableSpaceHandler];
 
@@ -166,6 +167,7 @@ export const CommandHandlers = [DisableSpaceHandler];
     PowerClampMonthlyRepository,
     PowerClampService,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [SpaceService],
 })

src/vistor-password/visitor-password.module.ts

@@ -29,6 +29,7 @@ import {
   PowerClampMonthlyRepository,
 } from '@app/common/modules/power-clamp/repositories';
 import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service';
+import { OccupancyService } from '@app/common/helper/services/occupancy.service';
 @Module({
   imports: [ConfigModule, DeviceRepositoryModule, DoorLockModule],
   controllers: [VisitorPasswordController],
@@ -55,6 +56,7 @@ import { SqlLoaderService } from '@app/common/helper/services/sql-loader.service
     PowerClampDailyRepository,
     PowerClampMonthlyRepository,
     SqlLoaderService,
+    OccupancyService,
   ],
   exports: [VisitorPasswordService],
 })