Added pagination

Author: WISNIOM

apps/car-rental-backend/src/common/constants/index.ts

@@ -0,0 +1,4 @@
+export enum Order {
+    ASC = 'ASC',
+    DESC = 'DESC',
+}

apps/car-rental-backend/src/common/decorators/api-paginated-response.decorator.ts

@@ -0,0 +1,27 @@
+import { applyDecorators, Type } from '@nestjs/common';
+import { ApiExtraModels, ApiOkResponse, getSchemaPath } from '@nestjs/swagger';
+import { PageDto } from '../pages/dto/page.dto';
+
+export const ApiPaginatedResponse = <TModel extends Type<unknown>>(
+  model: TModel
+) => {
+  return applyDecorators(
+    ApiExtraModels(PageDto, model),
+    ApiOkResponse({
+      description: 'Successful operation',
+      schema: {
+        allOf: [
+          { $ref: getSchemaPath(PageDto) },
+          {
+            properties: {
+              results: {
+                type: 'array',
+                items: { $ref: getSchemaPath(model) },
+              },
+            },
+          },
+        ],
+      },
+    })
+  );
+};

apps/car-rental-backend/src/abstract/abstract.entity.ts apps/car-rental-backend/src/common/entity/abstract.entity.ts

@@ -0,0 +1,31 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { PageMetaDtoParams } from '../interfaces';
+
+export class PageMetaDto {
+  @ApiProperty()
+  readonly page: number;
+
+  @ApiProperty()
+  readonly take: number;
+
+  @ApiProperty()
+  readonly itemCount: number;
+
+  @ApiProperty()
+  readonly pageCount: number;
+
+  @ApiProperty()
+  readonly hasPreviousPage: boolean;
+
+  @ApiProperty()
+  readonly hasNextPage: boolean;
+
+  constructor({ pageOptionsDto, itemCount }: PageMetaDtoParams) {
+    this.page = pageOptionsDto.page;
+    this.take = pageOptionsDto.take;
+    this.itemCount = itemCount;
+    this.pageCount = Math.ceil(this.itemCount / this.take);
+    this.hasPreviousPage = this.page > 1;
+    this.hasNextPage = this.page < this.pageCount;
+  }
+}

apps/car-rental-backend/src/common/pages/dto/page-meta.dto.ts

@@ -0,0 +1,27 @@
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { Order } from '../../constants';
+import { IsEnum, IsInt, IsOptional, Max, Min } from 'class-validator';
+
+export class PageOptionsDto {
+  @ApiPropertyOptional({ enum: Order, default: Order.ASC })
+  @IsEnum(Order)
+  @IsOptional()
+  readonly order?: Order = Order.ASC;
+  @ApiPropertyOptional({ default: 1, minimum: 1 })
+  @Type(() => Number)
+  @IsInt()
+  @Min(1)
+  @IsOptional()
+  readonly page?: number = 1;
+  @ApiPropertyOptional({ default: 10, minimum: 1, maximum: 200 })
+  @Type(() => Number)
+  @IsInt()
+  @Min(1)
+  @Max(200)
+  @IsOptional()
+  readonly take?: number = 10;
+  get skip(): number {
+    return (this.page - 1) * this.take;
+  }
+}

apps/car-rental-backend/src/common/pages/dto/page-options.dto.ts

@@ -0,0 +1,17 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsArray } from "class-validator";
+import { PageMetaDto } from "./page-meta.dto";
+
+export class PageDto<T> {
+    @IsArray()
+    @ApiProperty({ isArray: true })
+    readonly data: T[];
+
+    @ApiProperty({ type: () => PageMetaDto })
+    readonly meta: PageMetaDto;
+
+    constructor(data: T[], meta: PageMetaDto) {
+        this.data = data;
+        this.meta = meta;
+    }
+}

apps/car-rental-backend/src/common/pages/dto/page.dto.ts

@@ -0,0 +1,6 @@
+import { PageOptionsDto } from "../dto/page-options.dto";
+
+export interface PageMetaDtoParams {
+    pageOptionsDto: PageOptionsDto;
+    itemCount: number;
+}

apps/car-rental-backend/src/common/pages/interfaces/index.ts

@@ -8,7 +8,7 @@ async function bootstrap() {
   const config = new DocumentBuilder().setTitle('Car Rental API').build();
   const documentFactory = () => SwaggerModule.createDocument(app, config);
   const globalPrefix = 'api';
-  app.useGlobalPipes(new ValidationPipe());
+  app.useGlobalPipes(new ValidationPipe({ transform: true }));
   app.setGlobalPrefix(globalPrefix);
   const port = process.env.PORT || 3000;
   SwaggerModule.setup('api', app, documentFactory);

apps/car-rental-backend/src/validators/is-first-letter-uppercase.decorator.ts apps/car-rental-backend/src/common/validators/is-first-letter-uppercase.decorator.ts

@@ -1,6 +1,6 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { IsString, Length } from 'class-validator';
-import { IsFirstLetterUppercase } from '../../validators/is-first-letter-uppercase.decorator';
+import { IsFirstLetterUppercase } from '../../common/validators/is-first-letter-uppercase.decorator';
 export class CreateVehicleBrandDto {
   @IsString()
   @Length(1, 50)

apps/car-rental-backend/src/main.ts

@@ -0,0 +1,6 @@
+import { PickType } from '@nestjs/swagger';
+import { CreateVehicleBrandDto } from './create-vehicle-brand.dto';
+
+export class VehicleBrandDto extends PickType(CreateVehicleBrandDto, [
+  'name',
+] as const) {}

apps/car-rental-backend/src/vehicle-brands/dto/create-vehicle-brand.dto.ts

@@ -1,5 +1,5 @@
 import { Column, Entity } from 'typeorm';
-import { AbstractEntity } from '../../abstract/abstract.entity';
+import { AbstractEntity } from '../../common/entity/abstract.entity';
 
 @Entity()
 export class VehicleBrand extends AbstractEntity {

apps/car-rental-backend/src/vehicle-brands/dto/vehicle-brand.dto.ts

@@ -1,7 +1,21 @@
-import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
+import {
+  Controller,
+  Get,
+  Post,
+  Body,
+  Patch,
+  Param,
+  Delete,
+  HttpCode,
+  HttpStatus,
+  Query,
+} from '@nestjs/common';
 import { VehicleBrandsService } from './vehicle-brands.service';
 import { CreateVehicleBrandDto } from './dto/create-vehicle-brand.dto';
 import { UpdateVehicleBrandDto } from './dto/update-vehicle-brand.dto';
+import { PageOptionsDto } from '../common/pages/dto/page-options.dto';
+import { ApiPaginatedResponse } from '../common/decorators/api-paginated-response.decorator';
+import { VehicleBrandDto } from './dto/vehicle-brand.dto';
 
 @Controller('vehicle-brands')
 export class VehicleBrandsController {
@@ -13,8 +27,10 @@ export class VehicleBrandsController {
   }
 
   @Get()
-  findAll() {
-    return this.vehicleBrandsService.findAll();
+  @HttpCode(HttpStatus.OK)
+  @ApiPaginatedResponse(VehicleBrandDto)
+  findVehicleBrands(@Query() pageOptionsDto: PageOptionsDto) {
+    return this.vehicleBrandsService.findVehicleBrands(pageOptionsDto);
   }
 
   @Get(':id')
@@ -23,7 +39,10 @@ export class VehicleBrandsController {
   }
 
   @Patch(':id')
-  update(@Param('id') id: string, @Body() updateVehicleBrandDto: UpdateVehicleBrandDto) {
+  update(
+    @Param('id') id: string,
+    @Body() updateVehicleBrandDto: UpdateVehicleBrandDto
+  ) {
     return this.vehicleBrandsService.update(+id, updateVehicleBrandDto);
   }
 

apps/car-rental-backend/src/vehicle-brands/entities/vehicle-brand.entity.ts

@@ -4,6 +4,9 @@ import { UpdateVehicleBrandDto } from './dto/update-vehicle-brand.dto';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 import { VehicleBrand } from './entities/vehicle-brand.entity';
+import { PageOptionsDto } from '../common/pages/dto/page-options.dto';
+import { PageMetaDto } from '../common/pages/dto/page-meta.dto';
+import { PageDto } from '../common/pages/dto/page.dto';
 
 @Injectable()
 export class VehicleBrandsService {
@@ -24,8 +27,15 @@ export class VehicleBrandsService {
     return this.vehicleBrandsRepository.save(createVehicleBrandDto);
   }
 
-  findAll() {
-    return this.vehicleBrandsRepository.find();
+  async findVehicleBrands(pageOptionsDto: PageOptionsDto) {
+    const { order, take, skip } = pageOptionsDto;
+    const queryBuilder =
+      this.vehicleBrandsRepository.createQueryBuilder('vehicleBrand');
+    queryBuilder.orderBy('vehicleBrand.name', order).skip(skip).take(take);
+    const itemCount = await queryBuilder.getCount();
+    const { entities } = await queryBuilder.getRawAndEntities();
+    const pageMetaDto = new PageMetaDto({ itemCount, pageOptionsDto });
+    return new PageDto(entities, pageMetaDto);
   }
 
   findOne(id: number) {

apps/car-rental-backend/src/vehicle-brands/vehicle-brands.controller.ts

@@ -5,7 +5,7 @@ import {
   ManyToOne,
 } from 'typeorm';
 import { VehicleBrand } from '../../vehicle-brands/entities/vehicle-brand.entity';
-import { AbstractEntity } from '../../abstract/abstract.entity';
+import { AbstractEntity } from '../../common/entity/abstract.entity';
 
 @Entity()
 export class Vehicle extends AbstractEntity {