feat: add review request model & new query builder to find many review

src/person/dto/v1.4/person-request.dto.ts

@@ -193,80 +193,75 @@ export class PersonRequestDtoV1_4 implements IRequestModel {
   @NumberParam()
   'movies.id'?: string[];
 
-  // sex
-  @ApiNullableProperty({ isArray: true, description: 'Поиск по гендеру (пример: `Женский, Мужской`)' })
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по гендеру (пример: `Женский, Мужской`)', enum: PersonSexV1_4 })
   @IsOptional()
   @ToArray()
   @Validate(IsEnumParam, [PersonSexV1_4])
   @EnumParam()
   sex?: string[];
 
-  // growth
   @ApiNullableProperty({ isArray: true, description: 'Поиск по росту (пример: `170-180, 180`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsValueInRange, [1, 300])
   @NumberParam()
   growth?: string[];
 
-  // birthday
   @ApiNullableProperty({ isArray: true, description: 'Поиск по дате рождения (пример: `01.01.2000-01.01.2001, 01.01.2000`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsDateParam)
   @DateParam()
   birthday?: string[];
-  // death
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по дате смерти (пример: `01.01.2000-01.01.2001, 01.01.2000`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsDateParam)
   @DateParam()
   death?: string[];
 
-  // age
   @ApiNullableProperty({ isArray: true, description: 'Поиск по возрасту (пример: `18-25, 25`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsValueInRange, [0, 300])
   @NumberParam()
   age?: string[];
 
-  // birthPlace.value
   @ApiNullableProperty({ isArray: true, description: 'Поиск по месту рождения (пример: `Москва, Санкт-Петербург`)' })
   @IsOptional()
   @ToArray()
   @StringParam()
   'birthPlace.value'?: string[];
-  // deathPlace.value
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по месту смерти (пример: `Москва, Санкт-Петербург`)' })
   @IsOptional()
   @ToArray()
   @StringParam()
   'deathPlace.value'?: string[];
-  // spouses.id
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по ID супруги(супруга) (пример: `111, 222`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsValueInRange, [1, 9000000])
   @Validate(IsNumberParam)
   @NumberParam()
   'spouses.id'?: string[];
-  // spouses.divorced
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по статусу развода (пример: `true, false`)' })
   @IsOptional()
   @ToArray()
   @Validate(IsBooleanParam)
   @BooleanParam()
   'spouses.divorced'?: string[];
-  // spouses.sex
-  @ApiNullableProperty({ isArray: true, description: 'Поиск по гендеру супруги(супруга) (пример: `Женский, Мужской`)' })
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по гендеру супруги(супруга) (пример: `Женский, Мужской`)', enum: PersonSexV1_4 })
   @IsOptional()
   @ToArray()
   @Validate(IsEnumParam, [PersonSexV1_4])
   @EnumParam()
   'spouses.sex'?: string[];
-  // countAwards
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по количеству наград (пример: `1-10, 10`)' })
   @IsOptional()
   @ToArray()
@@ -275,14 +270,13 @@ export class PersonRequestDtoV1_4 implements IRequestModel {
   @NumberParam()
   countAwards?: string[];
 
-  // profession.value
-  @ApiNullableProperty({ isArray: true, description: 'Поиск по профессии (пример: `Актер, Режиссер`)' })
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по профессии (пример: `Актер, Режиссер`)', enum: PersonProfessionV1_4 })
   @IsOptional()
   @ToArray()
   @Validate(IsEnumParam, [PersonProfessionV1_4])
   @EnumParam()
   'profession.value'?: string[];
-  // movies.rating
+
   @ApiNullableProperty({ isArray: true, description: 'Поиск по рейтингу фильма (пример: `1-10, 10`)' })
   @IsOptional()
   @ToArray()
@@ -291,8 +285,11 @@ export class PersonRequestDtoV1_4 implements IRequestModel {
   @NumberParam()
   'movies.rating'?: string[];
 
-  // movies.enProfession
-  @ApiNullableProperty({ isArray: true, description: 'Поиск по профессии в фильмах на английском (пример: `actor, director`)' })
+  @ApiNullableProperty({
+    isArray: true,
+    description: 'Поиск по профессии в фильмах на английском (пример: `actor, director`)',
+    enum: PersonEnProfessionV1_4,
+  })
   @IsOptional()
   @ToArray()
   @Validate(IsEnumParam, [PersonEnProfessionV1_4])

src/person/person.controller.ts

@@ -28,7 +28,7 @@ export class PersonController extends BaseControllerWithFindById(Person, PersonD
     description: `Этот метод предназначен для поиска персон по фильтрам. Он принимает множество параметров, которые можно комбинировать между собой. Если вам нужен только поиск по имени, используйте метод \`Полнотекстовый поиск\` (search). В этом методе также доступен выбор полей. А в ответ приходит полная модель персоны.`,
   })
   async findManyV1_4(@Query() request: PersonRequestDtoV1_4): Promise<PersonDocsResponseDto> {
-    return this.service.findManyV1_4(request);
+    return this.personService.findManyV1_4(request);
   }
 
   @Version('1.4')

src/review/dto/v1.4/review-docs.response.ts

@@ -0,0 +1,8 @@
+import { ReviewDocsResponseDto } from '../review-docs-response.dto';
+
+export class ReviewDocsResponseDtoV1_4 extends ReviewDocsResponseDto {
+  constructor(partial: Partial<ReviewDocsResponseDtoV1_4>) {
+    super(partial);
+    Object.assign(this, partial);
+  }
+}

src/review/dto/v1.4/review-request.dto.ts

@@ -0,0 +1,206 @@
+import { FilterBuilder } from '../../../common/query-builder/filter-builder';
+import { SelectBuilder } from '../../../common/query-builder/select-builder';
+import { SortOrder } from 'mongoose';
+import { SortBuilder } from '../../../common/query-builder/sort-builder';
+import { PaginationBuilder } from '../../../common/query-builder/pagination-builder';
+import { IRequestModel } from '../../../common/interfaces/request-model.interface';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsNumber, IsOptional, IsString, Min, Validate } from 'class-validator';
+import { ParseNumber } from '../../../common/decorators/transform/parse-number.decorator';
+import { SetDefaultValue } from '../../../common/decorators/transform/set-default-value.decorator';
+import { Expose } from 'class-transformer';
+import { IsValueInRange } from '../../../common/validation/is-value-in-range';
+import { ToArray } from '../../../common/decorators/transform/to-array.decorator';
+import { IsEnumParam } from '../../../common/validation/is-enum-param';
+import { AreArrayLengthsEqual } from '../../../common/validation/are-array-lengths-equal';
+import { IsValues } from '../../../common/validation/is-values';
+import { ApiNullableProperty } from '../../../common/decorators/api-nullable-property.decorator';
+import { IsNumberParam } from '../../../common/validation/is-number-param';
+import { NumberParam } from '../../../common/decorators/types/number-param';
+import { IsDateParam } from '../../../common/validation/is-date-param';
+import { DateParam } from '../../../common/decorators/types/date-param';
+import { EnumParam } from '../../../common/decorators/types/enum-param';
+
+export enum ReviewFieldV1_4 {
+  'id' = 'id',
+  'movieId' = 'movieId',
+  'title' = 'title',
+  'type' = 'type',
+  'review' = 'review',
+  'date' = 'date',
+  'author' = 'author',
+  'authorId' = 'authorId',
+}
+
+export enum ReviewSelectFieldV1_4 {
+  'id' = 'id',
+  'movieId' = 'movieId',
+  'title' = 'title',
+  'type' = 'type',
+  'review' = 'review',
+  'date' = 'date',
+  'author' = 'author',
+  'authorId' = 'authorId',
+}
+
+enum ReviewTypeV1_4 {
+  'Негативный' = 'Негативный',
+  'Нейтральный' = 'Нейтральный',
+  'Позитивный' = 'Позитивный',
+}
+
+export class ReviewRequestDtoV1_4 implements IRequestModel {
+  @ApiPropertyOptional({ description: 'Номер страницы', minimum: 1, default: 1 })
+  @IsOptional()
+  @IsNumber()
+  @Min(1)
+  @ParseNumber()
+  @SetDefaultValue(1)
+  @Expose()
+  page: number;
+
+  @ApiPropertyOptional({ description: 'Количество элементов на странице', minimum: 1, maximum: 250, default: 10 })
+  @IsOptional()
+  @Validate(IsValueInRange, [1, 250])
+  @ParseNumber()
+  @SetDefaultValue(10)
+  @Expose()
+  limit: number;
+
+  @ApiPropertyOptional({
+    description: 'Список полей требуемых в ответе из модели',
+    isArray: true,
+    enum: ReviewSelectFieldV1_4,
+  })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsEnumParam, [ReviewSelectFieldV1_4])
+  @Expose()
+  selectFields?: string[];
+
+  @ApiPropertyOptional({
+    isArray: true,
+    description: 'Список полей которые не должны быть null или пусты',
+    enum: ReviewFieldV1_4,
+  })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsEnumParam, [ReviewFieldV1_4])
+  @Expose()
+  notNullFields?: string[];
+
+  @ApiPropertyOptional({ description: 'Сортировка по полям из модели', isArray: true, enum: ReviewFieldV1_4 })
+  @IsOptional()
+  @Validate(IsEnumParam, [ReviewFieldV1_4])
+  @Validate(AreArrayLengthsEqual, ['sortType'])
+  @ToArray()
+  @Expose()
+  sortField?: string[];
+
+  @ApiPropertyOptional({ description: 'Тип сортировки применительно к полям из sortField (пример: `"1", "-1"`)' })
+  @IsOptional()
+  @Validate(IsValues, ['1', '-1'])
+  @Validate(AreArrayLengthsEqual, ['sortField'])
+  @ToArray()
+  @Expose()
+  sortType?: string[];
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по ID отзыва (пример: `"111", "222", "!666"`)' })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsValueInRange, [4000, 5000000])
+  @Validate(IsNumberParam)
+  @NumberParam()
+  id?: string[];
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по ID фильма (пример: `"666", "555", "!666"`)' })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsValueInRange, [1, 7000000])
+  @Validate(IsNumberParam)
+  @NumberParam()
+  'movies.id'?: string[];
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск отзывов по ID автора (пример: `"666", "555", "!666"`)' })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsValueInRange, [1, 200000000])
+  @Validate(IsNumberParam)
+  @NumberParam()
+  'authorId'?: string[];
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по имени автора отзыва (пример: `"КиноПоиск", "!КиноПоиск"`)' })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsString)
+  author?: string[];
+
+  @ApiNullableProperty({
+    isArray: true,
+    description: 'Поиск по типу отзыва (пример: `"!Негативный", "Нейтральный", "Позитивный"`)',
+    enum: ReviewTypeV1_4,
+  })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsEnumParam, [ReviewTypeV1_4])
+  @EnumParam()
+  type?: string[];
+
+  @ApiNullableProperty({ isArray: true, description: 'Поиск по дате создания отзыва (пример: `"01.01.2021-01.01.2022", "01.01.2021"`)' })
+  @IsOptional()
+  @ToArray()
+  @Validate(IsDateParam)
+  @DateParam()
+  date?: string[];
+
+  public model2Where() {
+    const filter = new FilterBuilder();
+    for (const key of Object.keys(this)) {
+      const type = Reflect.getMetadata('type', this, key);
+
+      switch (type) {
+        case 'string':
+          filter.setString(key, this[key]);
+          break;
+        case 'number':
+          filter.setNumber(key, this[key]);
+          break;
+        case 'boolean':
+          filter.setBoolean(key, this[key]);
+          break;
+        case 'date':
+          filter.setDate(key, this[key]);
+          break;
+        case 'enum':
+          filter.setEnum(key, this[key]);
+          break;
+        default:
+          break;
+      }
+    }
+
+    if (this.notNullFields?.length) {
+      filter.setNotNull(this.notNullFields);
+    }
+
+    return filter.build();
+  }
+
+  public model2Select() {
+    const select = new SelectBuilder();
+
+    return select.build(this.selectFields);
+  }
+
+  public model2Sort(): { [key: string]: SortOrder } {
+    const sort = new SortBuilder().build(this.sortField, this.sortType);
+
+    return Object.keys(sort)?.length ? { ...sort, _id: -1 } : { 'votes.kp': -1, _id: -1 };
+  }
+
+  public model2Pagination() {
+    const pagination = new PaginationBuilder();
+
+    return pagination.build(this.page, this.limit);
+  }
+}

src/review/review.controller.ts

@@ -4,10 +4,25 @@ import { ReviewDocsResponseDto } from './dto/review-docs-response.dto';
 
 import { BaseController } from 'src/common/base/base.controller';
 import { Controller } from 'src/common/decorators/controller.decorator';
+import { CacheInterceptor, Get, Query, UseInterceptors, Version } from '@nestjs/common';
+import { ApiOperation } from '@nestjs/swagger';
+import { ReviewRequestDtoV1_4 } from './dto/v1.4/review-request.dto';
+import { ReviewDocsResponseDtoV1_4 } from './dto/v1.4/review-docs.response';
 
 @Controller('review', 'Отзывы пользователей')
 export class ReviewController extends BaseController(Review, ReviewDocsResponseDto, 'Поиск отзывов') {
   constructor(private readonly reviewService: ReviewService) {
     super(reviewService);
   }
+
+  @Version('1.4')
+  @Get()
+  @UseInterceptors(CacheInterceptor)
+  @ApiOperation({
+    summary: 'Универсальный поиск с фильтрами',
+    description: `Этот метод предназначен для поиска персон по фильтрам. Он принимает множество параметров, которые можно комбинировать между собой. Если вам нужен только поиск по имени, используйте метод \`Полнотекстовый поиск\` (search). В этом методе также доступен выбор полей. А в ответ приходит полная модель персоны.`,
+  })
+  async findManyV1_4(@Query() request: ReviewRequestDtoV1_4): Promise<ReviewDocsResponseDtoV1_4> {
+    return this.reviewService.findManyV1_4(request);
+  }
 }