WIP Preferences DTO

Author: RICHARD-Quentin

service/src/core/preferences/_dto/preferences.dto.ts

@@ -1,7 +1,28 @@
-import { PartialType } from "@nestjs/swagger"
+import { ApiProperty, PartialType } from '@nestjs/swagger'
+import { IsString, IsNotEmpty, IsObject, IsOptional, ValidateNested, IsMongoId } from 'class-validator'
 
 export class PreferencesCreateDto {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty()
+  public name: string
 
+  @IsMongoId()
+  @IsOptional()
+  @ApiProperty()
+  public entityId?: string
+
+  @IsObject()
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @ApiProperty()
+  public data?: { [key: string]: any }
+}
+
+export class PreferencesDto extends PreferencesCreateDto {
+  @IsMongoId()
+  @ApiProperty()
+  public _id: string
 }
 
-export class PreferencesUpdateDto extends PartialType(PreferencesCreateDto) {}
+export class PreferencesUpdateDto extends PartialType(PreferencesCreateDto) {}

service/src/core/preferences/preferences.controller.ts

@@ -1,27 +1,35 @@
 import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Req, Res } from '@nestjs/common'
-import { PreferencesCreateDto, PreferencesUpdateDto } from './_dto/preferences.dto'
+import { PreferencesCreateDto, PreferencesDto, PreferencesUpdateDto } from './_dto/preferences.dto'
 import { PreferencesService } from './preferences.service'
 import { AbstractController } from '~/_common/abstracts/abstract.controller'
 import { ApiParam, ApiTags } from '@nestjs/swagger'
 import { SearchFilterSchema, FilterSchema, SearchFilterOptions, FilterOptions, ObjectIdValidationPipe } from '@streamkits/nestjs_module_scrud'
 import { Types } from 'mongoose'
 import { Request, Response } from 'express'
+import { PartialProjectionType } from '~/_common/types/partial-projection.type'
+import { ApiCreateDecorator } from '~/_common/decorators/api-create.decorator'
+import { ApiPaginatedDecorator } from '~/_common/decorators/api-paginated.decorator'
+import { PickProjectionHelper } from '~/_common/helpers/pick-projection.helper'
+import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response.decorator'
+import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator'
+import { ApiDeletedResponseDecorator } from '~/_common/decorators/api-deleted-response.decorator'
 
 @ApiTags('core')
 @Controller('preferences')
 export class PreferencesController extends AbstractController {
-  public readonly projection = {
+  public static readonly projection: PartialProjectionType<PreferencesDto> = {
     name: 1,
     data: 1,
-    personId: 1,
+    entityId: 1,
   }
 
   constructor(private readonly _service: PreferencesService) {
     super()
   }
 
   @Post()
-  public async create(@Req() req: Request, @Res() res: Response, @Body() body: PreferencesCreateDto) {
+  @ApiCreateDecorator(PreferencesCreateDto, PreferencesDto)
+  public async create(@Req() req: Request, @Res() res: Response, @Body() body: PreferencesCreateDto): Promise<Response> {
     const data = await this._service.create(body)
     return res.status(HttpStatus.CREATED).json({
       statusCode: HttpStatus.CREATED,
@@ -30,8 +38,9 @@ export class PreferencesController extends AbstractController {
   }
 
   @Get()
-  public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions) {
-    const [data, total] = await this._service.findAndCount(searchFilterSchema, this.projection, searchFilterOptions)
+  @ApiPaginatedDecorator(PickProjectionHelper(PreferencesDto, PreferencesController.projection))
+  public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions): Promise<Response> {
+    const [data, total] = await this._service.findAndCount(searchFilterSchema, PreferencesController.projection, searchFilterOptions)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
       total,
@@ -41,7 +50,8 @@ export class PreferencesController extends AbstractController {
 
   @Get(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async read(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
+  @ApiReadResponseDecorator(PreferencesDto)
+  public async read(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response): Promise<Response> {
     const data = await this._service.findById(_id)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
@@ -51,7 +61,8 @@ export class PreferencesController extends AbstractController {
 
   @Patch(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async update(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Body() body: PreferencesUpdateDto, @Res() res: Response) {
+  @ApiUpdateDecorator(PreferencesUpdateDto, PreferencesDto)
+  public async update(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Body() body: PreferencesUpdateDto, @Res() res: Response): Promise<Response> {
     const data = await this._service.update(_id, body)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
@@ -61,7 +72,8 @@ export class PreferencesController extends AbstractController {
 
   @Delete(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async remove(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
+  @ApiDeletedResponseDecorator(PreferencesDto)
+  public async remove(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response): Promise<Response> {
     const data = await this._service.delete(_id)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,