add pagination to device API

This commit is contained in:
Mhd Zayd Skaff
2025-07-21 14:10:07 +03:00
parent 212d0d1974
commit 4b9127676e
11 changed files with 111 additions and 57 deletions

View File

@ -1,24 +1,9 @@
import { ApiProperty } from '@nestjs/swagger'; import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer'; import { IsOptional } from 'class-validator';
import { IsBoolean, IsOptional } from 'class-validator';
import { BooleanValues } from '../constants/boolean-values.enum';
import { IsPageRequestParam } from '../validators/is-page-request-param.validator'; import { IsPageRequestParam } from '../validators/is-page-request-param.validator';
import { IsSizeRequestParam } from '../validators/is-size-request-param.validator'; import { IsSizeRequestParam } from '../validators/is-size-request-param.validator';
export class PaginationRequestGetListDto { export class PaginationRequestGetListDto {
@ApiProperty({
example: true,
description: 'include spaces',
required: false,
default: false,
})
@IsOptional()
@IsBoolean()
@Transform((value) => {
return value.obj.includeSpaces === BooleanValues.TRUE;
})
public includeSpaces?: boolean = false;
@IsOptional() @IsOptional()
@IsPageRequestParam({ @IsPageRequestParam({
message: 'Page must be bigger than 0', message: 'Page must be bigger than 0',

View File

@ -1,13 +1,10 @@
import { BooleanValues } from '@app/common/constants/boolean-values.enum'; import { BooleanValues } from '@app/common/constants/boolean-values.enum';
import { PaginationRequestWithSearchGetListDto } from '@app/common/dto/pagination-with-search.request.dto'; import { PaginationRequestWithSearchGetListDto } from '@app/common/dto/pagination-with-search.request.dto';
import { ApiProperty, OmitType } from '@nestjs/swagger'; import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer'; import { Transform } from 'class-transformer';
import { IsBoolean, IsNotEmpty, IsOptional } from 'class-validator'; import { IsBoolean, IsNotEmpty, IsOptional } from 'class-validator';
export class BookableSpaceRequestDto extends OmitType( export class BookableSpaceRequestDto extends PaginationRequestWithSearchGetListDto {
PaginationRequestWithSearchGetListDto,
['includeSpaces'],
) {
@ApiProperty({ @ApiProperty({
type: Boolean, type: Boolean,
required: false, required: false,

View File

@ -17,10 +17,10 @@ import { CommunityService } from '../services/community.service';
// import { CheckUserCommunityGuard } from 'src/guards/user.community.guard'; // import { CheckUserCommunityGuard } from 'src/guards/user.community.guard';
import { ControllerRoute } from '@app/common/constants/controller-route'; import { ControllerRoute } from '@app/common/constants/controller-route';
import { BaseResponseDto } from '@app/common/dto/base.response.dto'; import { BaseResponseDto } from '@app/common/dto/base.response.dto';
import { PaginationRequestWithSearchGetListDto } from '@app/common/dto/pagination-with-search.request.dto';
import { Permissions } from 'src/decorators/permissions.decorator'; import { Permissions } from 'src/decorators/permissions.decorator';
import { PermissionsGuard } from 'src/guards/permissions.guard'; import { PermissionsGuard } from 'src/guards/permissions.guard';
import { ProjectParam } from '../dtos'; import { ProjectParam } from '../dtos';
import { CommunityFilterDto } from '../dtos/community-filter.dto';
@ApiTags('Community Module') @ApiTags('Community Module')
@Controller({ @Controller({
@ -55,7 +55,7 @@ export class CommunityController {
@Get('v2') @Get('v2')
async getCommunitiesV2( async getCommunitiesV2(
@Param() param: ProjectParam, @Param() param: ProjectParam,
@Query() query: PaginationRequestWithSearchGetListDto, @Query() query: CommunityFilterDto,
): Promise<any> { ): Promise<any> {
return this.communityService.getCommunitiesV2(param, query); return this.communityService.getCommunitiesV2(param, query);
} }
@ -85,7 +85,7 @@ export class CommunityController {
@Get() @Get()
async getCommunities( async getCommunities(
@Param() param: ProjectParam, @Param() param: ProjectParam,
@Query() query: PaginationRequestWithSearchGetListDto, @Query() query: CommunityFilterDto,
): Promise<BaseResponseDto> { ): Promise<BaseResponseDto> {
return this.communityService.getCommunities(param, query); return this.communityService.getCommunities(param, query);
} }

View File

@ -0,0 +1,20 @@
import { BooleanValues } from '@app/common/constants/boolean-values.enum';
import { PaginationRequestWithSearchGetListDto } from '@app/common/dto/pagination-with-search.request.dto';
import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer';
import { IsBoolean, IsOptional } from 'class-validator';
export class CommunityFilterDto extends PaginationRequestWithSearchGetListDto {
@ApiProperty({
example: true,
description: 'include spaces',
required: false,
default: false,
})
@IsOptional()
@IsBoolean()
@Transform((value) => {
return value.obj.includeSpaces === BooleanValues.TRUE;
})
public includeSpaces?: boolean = false;
}

View File

@ -1,4 +1,5 @@
import { DeviceTypeEnum } from '@app/common/constants/device-type.enum'; import { DeviceTypeEnum } from '@app/common/constants/device-type.enum';
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
import { ApiProperty } from '@nestjs/swagger'; import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer'; import { Transform } from 'class-transformer';
import { import {
@ -65,7 +66,7 @@ export class GetDevicesBySpaceOrCommunityDto {
requireEither?: never; // This ensures at least one of them is provided requireEither?: never; // This ensures at least one of them is provided
} }
export class GetDevicesFilterDto { export class GetDevicesFilterDto extends PaginationRequestGetListDto {
@ApiProperty({ @ApiProperty({
description: 'Device Type', description: 'Device Type',
enum: DeviceTypeEnum, enum: DeviceTypeEnum,

View File

@ -7,6 +7,7 @@ import { CommonErrorCodes } from '@app/common/constants/error-codes.enum';
import { ProductType } from '@app/common/constants/product-type.enum'; import { ProductType } from '@app/common/constants/product-type.enum';
import { SceneSwitchesTypeEnum } from '@app/common/constants/scene-switch-type.enum'; import { SceneSwitchesTypeEnum } from '@app/common/constants/scene-switch-type.enum';
import { BaseResponseDto } from '@app/common/dto/base.response.dto'; import { BaseResponseDto } from '@app/common/dto/base.response.dto';
import { PageResponse } from '@app/common/dto/pagination.response.dto';
import { SuccessResponseDto } from '@app/common/dto/success.response.dto'; import { SuccessResponseDto } from '@app/common/dto/success.response.dto';
import { DeviceStatusFirebaseService } from '@app/common/firebase/devices-status/services/devices-status.service'; import { DeviceStatusFirebaseService } from '@app/common/firebase/devices-status/services/devices-status.service';
import { convertKeysToCamelCase } from '@app/common/helper/camelCaseConverter'; import { convertKeysToCamelCase } from '@app/common/helper/camelCaseConverter';
@ -20,6 +21,7 @@ import { SceneDeviceRepository } from '@app/common/modules/scene-device/reposito
import { SpaceEntity } from '@app/common/modules/space/entities/space.entity'; import { SpaceEntity } from '@app/common/modules/space/entities/space.entity';
import { SpaceRepository } from '@app/common/modules/space/repositories'; import { SpaceRepository } from '@app/common/modules/space/repositories';
import { addSpaceUuidToDevices } from '@app/common/util/device-utils'; import { addSpaceUuidToDevices } from '@app/common/util/device-utils';
import { getPaginationResponseDto } from '@app/common/util/getPaginationResponseDto';
import { import {
BadRequestException, BadRequestException,
forwardRef, forwardRef,
@ -100,7 +102,7 @@ export class DeviceService {
async getAllDevices( async getAllDevices(
param: ProjectParam, param: ProjectParam,
{ deviceType, spaces, communities }: GetDevicesFilterDto, { deviceType, spaces, communities, page, size }: GetDevicesFilterDto,
): Promise<BaseResponseDto> { ): Promise<BaseResponseDto> {
try { try {
await this.validateProject(param.projectUuid); await this.validateProject(param.projectUuid);
@ -108,9 +110,12 @@ export class DeviceService {
return await this.getDoorLockDevices(param.projectUuid, { return await this.getDoorLockDevices(param.projectUuid, {
spaces, spaces,
communities, communities,
deviceType,
page,
size,
}); });
} else if (!deviceType) { } else if (!deviceType) {
const devices = await this.deviceRepository.find({ const [devices, count] = await this.deviceRepository.findAndCount({
where: { where: {
isActive: true, isActive: true,
spaceDevice: { spaceDevice: {
@ -133,6 +138,8 @@ export class DeviceService {
'permission.permissionType', 'permission.permissionType',
'subspace', 'subspace',
], ],
take: size ?? 10,
skip: (page ? page - 1 : 0) * (size ?? 10),
}); });
const devicesData = await Promise.allSettled( const devicesData = await Promise.allSettled(
@ -234,11 +241,14 @@ export class DeviceService {
.value, .value,
); );
return new SuccessResponseDto({ return new PageResponse(
{
message: `Devices fetched successfully`, message: `Devices fetched successfully`,
data: fulfilledDevices, data: fulfilledDevices,
statusCode: HttpStatus.OK, statusCode: HttpStatus.OK,
}); },
getPaginationResponseDto(count, page ?? 1, size ?? 10),
);
} }
} catch (error) { } catch (error) {
if (error instanceof HttpException) { if (error instanceof HttpException) {
@ -1301,11 +1311,11 @@ export class DeviceService {
private async getDoorLockDevices( private async getDoorLockDevices(
projectUuid: string, projectUuid: string,
{ communities, spaces }: { spaces?: string[]; communities?: string[] }, { communities, spaces, page, size }: GetDevicesFilterDto,
) { ) {
await this.validateProject(projectUuid); await this.validateProject(projectUuid);
const devices = await this.deviceRepository.find({ const [devices, count] = await this.deviceRepository.findAndCount({
where: { where: {
productDevice: { productDevice: {
prodType: ProductType.DL, prodType: ProductType.DL,
@ -1324,6 +1334,8 @@ export class DeviceService {
isActive: true, isActive: true,
}, },
relations: ['productDevice', 'spaceDevice'], relations: ['productDevice', 'spaceDevice'],
take: size ?? 10,
skip: (page ? page - 1 : 0) * (size ?? 10),
}); });
const devicesData = await Promise.all( const devicesData = await Promise.all(
@ -1355,11 +1367,14 @@ export class DeviceService {
(deviceData) => deviceData !== null, (deviceData) => deviceData !== null,
); );
return new SuccessResponseDto({ return new PageResponse(
{
message: 'Successfully retrieved all pass devices', message: 'Successfully retrieved all pass devices',
data: filteredDevicesData, data: filteredDevicesData,
statusCode: HttpStatus.OK, statusCode: HttpStatus.OK,
}); },
getPaginationResponseDto(count, page ?? 1, size ?? 10),
);
} }
private async controlDeviceTuya( private async controlDeviceTuya(

View File

@ -1,7 +1,3 @@
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto'; import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
import { PickType } from '@nestjs/swagger';
export class ListProjectsDto extends PickType(PaginationRequestGetListDto, [ export class ListProjectsDto extends PaginationRequestGetListDto {}
'page',
'size',
]) {}

View File

@ -1,4 +1,5 @@
import { ControllerRoute } from '@app/common/constants/controller-route'; import { ControllerRoute } from '@app/common/constants/controller-route';
import { BaseResponseDto } from '@app/common/dto/base.response.dto';
import { import {
Body, Body,
Controller, Controller,
@ -11,18 +12,17 @@ import {
UseGuards, UseGuards,
} from '@nestjs/common'; } from '@nestjs/common';
import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger'; import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
import { SpaceModelService } from '../services'; import { ProjectParam } from 'src/community/dtos';
import { Permissions } from 'src/decorators/permissions.decorator';
import { PermissionsGuard } from 'src/guards/permissions.guard';
import { import {
CreateSpaceModelDto, CreateSpaceModelDto,
LinkSpacesToModelDto, LinkSpacesToModelDto,
SpaceModelParam, SpaceModelParam,
UpdateSpaceModelDto, UpdateSpaceModelDto,
} from '../dtos'; } from '../dtos';
import { ProjectParam } from 'src/community/dtos'; import { SpaceModelFilterDto } from '../dtos/space-model-filter.dto';
import { BaseResponseDto } from '@app/common/dto/base.response.dto'; import { SpaceModelService } from '../services';
import { PermissionsGuard } from 'src/guards/permissions.guard';
import { Permissions } from 'src/decorators/permissions.decorator';
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
@ApiTags('Space Model Module') @ApiTags('Space Model Module')
@Controller({ @Controller({
@ -62,7 +62,7 @@ export class SpaceModelController {
@Get() @Get()
async listSpaceModel( async listSpaceModel(
@Param() projectParam: ProjectParam, @Param() projectParam: ProjectParam,
@Query() query: PaginationRequestGetListDto, @Query() query: SpaceModelFilterDto,
): Promise<BaseResponseDto> { ): Promise<BaseResponseDto> {
return await this.spaceModelService.list(projectParam, query); return await this.spaceModelService.list(projectParam, query);
} }

View File

@ -0,0 +1,20 @@
import { BooleanValues } from '@app/common/constants/boolean-values.enum';
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer';
import { IsBoolean, IsOptional } from 'class-validator';
export class SpaceModelFilterDto extends PaginationRequestGetListDto {
@ApiProperty({
example: true,
description: 'include spaces',
required: false,
default: false,
})
@IsOptional()
@IsBoolean()
@Transform((value) => {
return value.obj.includeSpaces === BooleanValues.TRUE;
})
public includeSpaces?: boolean = false;
}

View File

@ -1,4 +1,5 @@
import { ControllerRoute } from '@app/common/constants/controller-route'; import { ControllerRoute } from '@app/common/constants/controller-route';
import { BaseResponseDto } from '@app/common/dto/base.response.dto';
import { import {
Body, Body,
Controller, Controller,
@ -10,13 +11,12 @@ import {
Query, Query,
UseGuards, UseGuards,
} from '@nestjs/common'; } from '@nestjs/common';
import { SubSpaceService } from '../../services';
import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger'; import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
import { AddSubspaceDto, GetSpaceParam, GetSubSpaceParam } from '../../dtos';
import { BaseResponseDto } from '@app/common/dto/base.response.dto';
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
import { PermissionsGuard } from 'src/guards/permissions.guard';
import { Permissions } from 'src/decorators/permissions.decorator'; import { Permissions } from 'src/decorators/permissions.decorator';
import { PermissionsGuard } from 'src/guards/permissions.guard';
import { SubspaceFilterDto } from 'src/space/dtos/subspace-filter.dto';
import { AddSubspaceDto, GetSpaceParam, GetSubSpaceParam } from '../../dtos';
import { SubSpaceService } from '../../services';
@ApiTags('Space Module') @ApiTags('Space Module')
@Controller({ @Controller({
@ -51,7 +51,7 @@ export class SubSpaceController {
@Get() @Get()
async list( async list(
@Param() params: GetSpaceParam, @Param() params: GetSpaceParam,
@Query() query: PaginationRequestGetListDto, @Query() query: SubspaceFilterDto,
): Promise<BaseResponseDto> { ): Promise<BaseResponseDto> {
return this.subSpaceService.list(params, query); return this.subSpaceService.list(params, query);
} }

View File

@ -0,0 +1,20 @@
import { BooleanValues } from '@app/common/constants/boolean-values.enum';
import { PaginationRequestGetListDto } from '@app/common/dto/pagination.request.dto';
import { ApiProperty } from '@nestjs/swagger';
import { Transform } from 'class-transformer';
import { IsBoolean, IsOptional } from 'class-validator';
export class SubspaceFilterDto extends PaginationRequestGetListDto {
@ApiProperty({
example: true,
description: 'include spaces',
required: false,
default: false,
})
@IsOptional()
@IsBoolean()
@Transform((value) => {
return value.obj.includeSpaces === BooleanValues.TRUE;
})
public includeSpaces?: boolean = false;
}