feat: add pagination (search, take, sort, skip)

package.json

@@ -37,7 +37,7 @@
     "@nestjs/passport": "^8.0.1",
     "@nestjs/platform-express": "^8.2.4",
     "@nestjs/swagger": "^5.1.5",
-    "@prisma/client": "^3.6.0",
+    "@prisma/client": "^3.8.0",
     "@types/faker": "^5.5.9",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
@@ -83,7 +83,7 @@
     "husky": "^7.0.4",
     "jest": "^27.2.5",
     "prettier": "^2.3.2",
-    "prisma": "^3.6.0",
+    "prisma": "^3.8.0",
     "source-map-support": "^0.5.20",
     "supertest": "^6.1.3",
     "ts-jest": "^27.0.3",

prisma/schema.prisma

@@ -17,21 +17,21 @@ model City {
   name       String
   postalCode String
   id         String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
-  users       User[]
+  users      User[]
 }
 
 model User {
-  id   String  @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+  id        String    @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
   firstName String
   lastName  String
-  avatar    String
+  avatar    String?
   username  String    @unique
   birthDate DateTime? @db.Timestamptz(6)
   email     String    @unique
   sex       Int       @default(0)
-  latitude Float
-  longitude Float
-  cityId    String @db.Uuid()
+  latitude  Float?
+  longitude Float?
+  cityId    String    @db.Uuid
   city      City      @relation(fields: [cityId], references: [id])
   animals   Animal[]
 }

src/animal/animal.controller.ts

@@ -18,8 +18,13 @@ export class AnimalController {
   constructor(private readonly animalService: AnimalService) {}
 
   @Get('/')
-  async list(@Query() query: FilterDto | undefined): Promise<Animal[]> {
-    return await this.animalService.list({ where: { name: query.search } });
+  async list(@Query() query: FilterDto<Animal> | undefined): Promise<Animal[]> {
+    return await this.animalService.list({
+      skip: parseInt(query.skip) || 0,
+      take: parseInt(query.take) || 20,
+      orderBy: { name: query.order },
+      where: { name: query.search },
+    });
   }
 
   @Get('/:id')

src/animal/breed.controller.ts

@@ -18,8 +18,13 @@ export class BreedController {
   constructor(private readonly breedService: BreedService) {}
 
   @Get('/')
-  async list(@Query() query: FilterDto | undefined): Promise<Breed[]> {
-    return await this.breedService.list({ where: { name: query.search } });
+  async list(@Query() query: FilterDto<Breed> | undefined): Promise<Breed[]> {
+    return await this.breedService.list({
+      skip: parseInt(query.skip) || 0,
+      take: parseInt(query.take) || 20,
+      orderBy: { name: query.order },
+      where: { name: query.search },
+    });
   }
 
   @Get('/:id')

src/app.module.ts

@@ -12,8 +12,8 @@ import { UserModule } from './user/user.module';
     PrismaService,
     AuthModule,
     ConfigModule,
-    UserModule,
     CityModule,
+    UserModule,
     AnimalModule,
     BreedModule,
   ],

src/dtos/users/user.ts

@@ -30,8 +30,9 @@ export class CreateUserDto {
   public username: string;
 
   @ApiProperty()
+  @IsOptional()
   @IsString()
-  public avatar: string;
+  public avatar?: string | null;
 
   @ApiProperty()
   @IsISO8601()

src/dtos/utils/filter.ts

@@ -1,13 +1,46 @@
-export class FilterDto {
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { IsEnum, IsInt, IsOptional, Max, Min } from 'class-validator';
+
+export enum Order {
+  ASC = 'asc',
+  DESC = 'desc',
+}
+export class FilterDto<T> {
+  @ApiPropertyOptional()
   public search?: string | null;
 
+  @ApiPropertyOptional()
   public disablePagination?: true | null;
 
-  public skip?: number | null;
+  @ApiPropertyOptional({
+    minimum: 1,
+    default: 1,
+  })
+  @Type(() => String)
+  @IsInt()
+  @Min(1)
+  @IsOptional()
+  public page?: string;
 
-  public take?: number | null;
+  @ApiPropertyOptional({
+    minimum: 1,
+    maximum: 50,
+    default: 10,
+  })
+  @Type(() => Number)
+  @IsInt()
+  @Min(1)
+  @Max(50)
+  @IsOptional()
+  public take?: string | null;
 
-  public sort?: 'ASC' | 'DESC';
+  @ApiPropertyOptional({ enum: Order, default: Order.ASC })
+  @IsEnum(Order)
+  @IsOptional()
+  public order?: Order;
 
-  public orderBy?: string;
+  get skip(): string {
+    return ((parseInt(this.page) - 1) * parseInt(this.take)).toString();
+  }
 }

src/user/city/city.controller.ts

@@ -18,8 +18,14 @@ export class CityController {
   constructor(private readonly cityService: CityService) {}
 
   @Get('/')
-  async list(@Query() query: FilterDto | undefined): Promise<City[]> {
-    return await this.cityService.list({});
+  async list(@Query() query: FilterDto<City> | undefined): Promise<City[]> {
+    console.log(query.order);
+    return await this.cityService.list({
+      skip: parseInt(query.skip) || 0,
+      take: parseInt(query.take) || 20,
+      orderBy: { name: query.order },
+      where: { name: query.search },
+    });
   }
 
   @Get('/:id')

src/user/city/city.service.ts

@@ -11,15 +11,18 @@ export class CityService {
   ): Promise<City | null> {
     return this.prisma.city.findUnique({
       where: cityWhereUniqueInput,
+      include: {
+        users: true,
+      },
     });
   }
 
   async list(params: {
     skip?: number;
     take?: number;
     cursor?: Prisma.CityWhereUniqueInput;
-    where?: Prisma.UserWhereInput;
-    orderBy?: Prisma.UserOrderByWithRelationInput;
+    where?: Prisma.CityWhereInput;
+    orderBy?: Prisma.CityOrderByWithAggregationInput;
   }): Promise<City[]> {
     const { skip, take, cursor, where, orderBy } = params;
     return this.prisma.city.findMany({

src/user/user.controller.ts

@@ -34,20 +34,27 @@ export class UserController {
   constructor(private readonly userService: UserService) {}
 
   @Get('/')
-  async list(@Query() query: FilterDto | undefined): Promise<User[]> {
-    return await this.userService.list({ where: { username: query.search } });
-  }
-
-  @Get('/city/:id')
-  async listCity(@Param('id') id: string): Promise<User[]> {
-    return await this.userService.getCity({
-      cityWhereUniqueInput: {
-        id,
-      },
+  async list(@Query() query: FilterDto<User> | undefined): Promise<User[]> {
+    return await this.userService.list({
+      skip: parseInt(query.skip) || 0,
+      take: parseInt(query.take) || 20,
+      orderBy: { username: query.order },
+      where: { username: query.search },
     });
   }
 
-  @UseGuards(AuthGuard)
+  // Ludo: Pas nécessaire (duplication), nous avons déjà l'ensemble des users en relation dans /cities/:id
+
+  // @Get('/city/:id')
+  // async listCity(@Param('id') id: string): Promise<User[]> {
+  //   return await this.userService.getCity({
+  //     cityWhereUniqueInput: {
+  //       id,
+  //     },
+  //   });
+  // }
+
+  // @UseGuards(AuthGuard)
   @Get('/proximity')
   async getUsersInRadius(
     @Query('radius') radius: string,
@@ -60,13 +67,11 @@ export class UserController {
     return await this.userService.getUsersInRadius(radius, currentUser);
   }
 
-  @UseGuards(AuthGuard)
   @Get('/:id')
   async get(@Param('id') id: string): Promise<User> {
     return await this.userService.get({ id: id });
   }
 
-  @UseGuards(AuthGuard)
   @Post('upload')
   @UseInterceptors(
     FileInterceptor('file', {