WIP api decorators system

tacxou · tacxou · commit 5c871ff1b93f · 2023-09-04T22:57:32.000+02:00
diff --git a/service/src/_common/abstracts/abstract.controller.ts b/service/src/_common/abstracts/abstract.controller.ts
@@ -1,14 +1,14 @@
 import { ModuleRef } from '@nestjs/core'
 import { ApiExtraModels } from '@nestjs/swagger'
-import { PaginatedDto } from '~/_common/dto/paginated.dto'
+import { PaginatedResponseDto } from '~/_common/dto/paginated-response.dto'
 
 export interface AbstractControllerContext {
   [key: string | number]: any
 
   moduleRef?: ModuleRef
 }
 
-@ApiExtraModels(PaginatedDto)
+@ApiExtraModels(PaginatedResponseDto)
 export abstract class AbstractController {
   protected moduleRef?: ModuleRef
 
diff --git a/service/src/_common/abstracts/abstract.service.schema.ts b/service/src/_common/abstracts/abstract.service.schema.ts
@@ -68,9 +68,9 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     const document: Document<T, any, T> = new this._model({
       ...data,
       metadata: {
-        createdBy: this.request.user || 'anonymous',
+        createdBy: this.request?.user || 'anonymous',
         createdAt: new Date(),
-        lastUpdatedBy: this.request.user || 'anonymous',
+        lastUpdatedBy: this.request?.user || 'anonymous',
         lastUpdatedAt: new Date(),
       }
     })
diff --git a/service/src/_common/abstracts/dto/abstract.custom-fields.dto.ts b/service/src/_common/abstracts/dto/abstract.custom-fields.dto.ts
@@ -0,0 +1,8 @@
+import { IsObject, IsOptional, ValidateNested } from 'class-validator'
+
+export abstract class AbstractCustomFieldsDto {
+  @IsObject()
+  @IsOptional()
+  @ValidateNested()
+  public customFields?: { [key: string]: any }[]
+}
diff --git a/service/src/_common/decorators/api-body.decorator.ts b/service/src/_common/decorators/api-body.decorator.ts
@@ -0,0 +1,17 @@
+import { applyDecorators, Type } from '@nestjs/common'
+import { ApiBody, ApiBodyOptions, ApiExtraModels, getSchemaPath } from '@nestjs/swagger'
+
+export const ApiBodyDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  options?: ApiBodyOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiBody({
+      schema: {
+        $ref: getSchemaPath(model),
+      },
+      ...options,
+    }),
+  )
+}
diff --git a/service/src/_common/decorators/api-create.decorator.ts b/service/src/_common/decorators/api-create.decorator.ts
@@ -0,0 +1,17 @@
+import { applyDecorators, Type } from '@nestjs/common'
+import { ApiBodyOptions } from '@nestjs/swagger'
+import { ApiBodyDecorator } from '~/_common/decorators/api-body.decorator'
+import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { ApiCreatedResponseDecorator } from '~/_common/decorators/api-created-response.decorator'
+
+export const ApiCreateDecorator = <TModel extends Type<any>>(
+  bodyModel: TModel,
+  responseModel: TModel,
+  bodyOptions?: ApiBodyOptions | null | undefined,
+  responseOptions?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiBodyDecorator(bodyModel, bodyOptions),
+    ApiCreatedResponseDecorator(responseModel, responseOptions),
+  )
+}
diff --git a/service/src/_common/decorators/api-created-response.decorator.ts b/service/src/_common/decorators/api-created-response.decorator.ts
@@ -0,0 +1,34 @@
+import { applyDecorators, HttpStatus, Type } from '@nestjs/common'
+import { ApiBadRequestResponse, ApiCreatedResponse, ApiExtraModels, getSchemaPath } from '@nestjs/swagger'
+import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { ErrorSchemaDto } from '~/_common/dto/error-schema.dto'
+
+export const ApiCreatedResponseDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  options?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiExtraModels(ErrorSchemaDto),
+    ApiCreatedResponse({
+      schema: {
+        properties: {
+          statusCode: {
+            type: 'number',
+            enum: [HttpStatus.CREATED],
+          },
+          data: {
+            $ref: getSchemaPath(model),
+          }
+        }
+      },
+      ...options,
+    }),
+    ApiBadRequestResponse({
+      description: 'Schema validation failed',
+      schema: {
+        $ref: getSchemaPath(ErrorSchemaDto),
+      },
+    }),
+  )
+}
diff --git a/service/src/_common/decorators/api-deleted-response.decorator.ts b/service/src/_common/decorators/api-deleted-response.decorator.ts
@@ -0,0 +1,36 @@
+import { applyDecorators, HttpStatus, Type } from '@nestjs/common'
+import { ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger'
+import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { NotFoundDto } from '~/_common/dto/not-found.dto'
+
+export const ApiDeletedResponseDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  responseOptions?: ApiResponseOptions | null | undefined,
+  notFoundOptions?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiExtraModels(NotFoundDto),
+    ApiOkResponse({
+      schema: {
+        properties: {
+          statusCode: {
+            type: 'number',
+            enum: [HttpStatus.OK],
+          },
+          data: {
+            $ref: getSchemaPath(model),
+          }
+        }
+      },
+      ...responseOptions,
+    }),
+    ApiNotFoundResponse({
+      description: 'Item not found',
+      schema: {
+        $ref: getSchemaPath(NotFoundDto),
+      },
+      ...notFoundOptions,
+    })
+  )
+}
diff --git a/service/src/_common/decorators/api-paginated-response.decorator.ts b/service/src/_common/decorators/api-paginated-response.decorator.ts
@@ -1,34 +1,18 @@
 import { applyDecorators, Type } from '@nestjs/common'
-import { ApiExtraModels, ApiQuery, getSchemaPath } from '@nestjs/swagger'
-import { ApiOkResponse } from '@nestjs/swagger/dist/decorators/api-response.decorator'
-import { PaginatedDto } from '~/_common/dto/paginated.dto'
+import { ApiExtraModels, getSchemaPath } from '@nestjs/swagger'
+import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { PaginatedResponseDto } from '~/_common/dto/paginated-response.dto'
 
-const DEFAULT_OPTIONS = {
-  queryPagination: true,
-}
-
-export interface ApiPaginatedResponseOptions {
-  queryPagination?: boolean
-}
-
-export const ApiPaginatedResponse = <TModel extends Type<any>>(
+export const ApiPaginatedResponseDecorator = <TModel extends Type<any>>(
   model: TModel,
-  options?: ApiPaginatedResponseOptions | null | undefined,
+  options?: ApiResponseOptions | null | undefined,
 ) => {
-  options = { ...DEFAULT_OPTIONS, ...options }
-  const extraDecorators = []
-  if (options?.queryPagination) {
-    extraDecorators.push(
-      ApiQuery({ name: 'limit', type: Number, required: false }),
-      ApiQuery({ name: 'skip', type: Number, required: false }),
-    )
-  }
   return applyDecorators(
     ApiExtraModels(model),
     ApiOkResponse({
       schema: {
         allOf: [
-          { $ref: getSchemaPath(PaginatedDto) },
+          { $ref: getSchemaPath(PaginatedResponseDto) },
           {
             properties: {
               data: {
@@ -39,7 +23,7 @@ export const ApiPaginatedResponse = <TModel extends Type<any>>(
           },
         ],
       },
+      ...options,
     }),
-    ...extraDecorators,
   )
 }
diff --git a/service/src/_common/decorators/api-paginated.decorator.ts b/service/src/_common/decorators/api-paginated.decorator.ts
@@ -0,0 +1,27 @@
+import { applyDecorators, Type } from '@nestjs/common'
+import { ApiExtraModels, ApiQuery, getSchemaPath } from '@nestjs/swagger'
+import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { ApiPaginatedResponseDecorator } from '~/_common/decorators/api-paginated-response.decorator'
+import { PaginatedFilterDto } from '~/_common/dto/paginated-filter.dto'
+
+export const ApiPaginatedDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  options?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiQuery({ name: 'limit', type: Number, required: false }),
+    ApiQuery({ name: 'skip', type: Number, required: false }),
+    ApiExtraModels(PaginatedFilterDto),
+    ApiQuery({
+      required: false,
+      name: 'filters',
+      style: 'deepObject',
+      explode: true,
+      type: 'object',
+      schema: {
+        $ref: getSchemaPath(PaginatedFilterDto),
+      }
+    }),
+    ApiPaginatedResponseDecorator(model, options),
+  )
+}
diff --git a/service/src/_common/decorators/api-read-response.decorator.ts b/service/src/_common/decorators/api-read-response.decorator.ts
@@ -0,0 +1,36 @@
+import { applyDecorators, HttpStatus, Type } from '@nestjs/common'
+import { ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger'
+import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { NotFoundDto } from '~/_common/dto/not-found.dto'
+
+export const ApiReadResponseDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  responseOptions?: ApiResponseOptions | null | undefined,
+  notFoundOptions?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiExtraModels(NotFoundDto),
+    ApiOkResponse({
+      schema: {
+        properties: {
+          statusCode: {
+            type: 'number',
+            enum: [HttpStatus.OK],
+          },
+          data: {
+            $ref: getSchemaPath(model),
+          }
+        }
+      },
+      ...responseOptions,
+    }),
+    ApiNotFoundResponse({
+      description: 'Item not found',
+      schema: {
+        $ref: getSchemaPath(NotFoundDto),
+      },
+      ...notFoundOptions,
+    })
+  )
+}
diff --git a/service/src/_common/decorators/api-update.decorator.ts b/service/src/_common/decorators/api-update.decorator.ts
@@ -0,0 +1,17 @@
+import { applyDecorators, Type } from '@nestjs/common'
+import { ApiBodyOptions } from '@nestjs/swagger'
+import { ApiBodyDecorator } from '~/_common/decorators/api-body.decorator'
+import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { ApiUpdatedResponseDecorator } from '~/_common/decorators/api-updated-response.decorator'
+
+export const ApiUpdateDecorator = <TModel extends Type<any>>(
+  bodyModel: TModel,
+  responseModel: TModel,
+  bodyOptions?: ApiBodyOptions | null | undefined,
+  responseOptions?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiBodyDecorator(bodyModel, bodyOptions),
+    ApiUpdatedResponseDecorator(responseModel, responseOptions),
+  )
+}
diff --git a/service/src/_common/decorators/api-updated-response.decorator.ts b/service/src/_common/decorators/api-updated-response.decorator.ts
@@ -0,0 +1,46 @@
+import { applyDecorators, HttpStatus, Type } from '@nestjs/common'
+import { ApiBadRequestResponse, ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger'
+import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator'
+import { ErrorSchemaDto } from '~/_common/dto/error-schema.dto'
+import { NotFoundDto } from '~/_common/dto/not-found.dto'
+
+export const ApiUpdatedResponseDecorator = <TModel extends Type<any>>(
+  model: TModel,
+  responseOptions?: ApiResponseOptions | null | undefined,
+  badRequestOptions?: ApiResponseOptions | null | undefined,
+  notFoundOptions?: ApiResponseOptions | null | undefined,
+) => {
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiExtraModels(ErrorSchemaDto),
+    ApiExtraModels(NotFoundDto),
+    ApiOkResponse({
+      schema: {
+        properties: {
+          statusCode: {
+            type: 'number',
+            enum: [HttpStatus.OK],
+          },
+          data: {
+            $ref: getSchemaPath(model),
+          }
+        }
+      },
+      ...responseOptions,
+    }),
+    ApiBadRequestResponse({
+      description: 'Schema validation failed',
+      schema: {
+        $ref: getSchemaPath(ErrorSchemaDto),
+      },
+      ...badRequestOptions,
+    }),
+    ApiNotFoundResponse({
+      description: 'Item not found',
+      schema: {
+        $ref: getSchemaPath(NotFoundDto),
+      },
+      ...notFoundOptions,
+    })
+  )
+}
diff --git a/service/src/_common/dto/error-schema.dto.ts b/service/src/_common/dto/error-schema.dto.ts
@@ -0,0 +1,16 @@
+import { ApiProperty } from '@nestjs/swagger'
+import { HttpStatus } from '@nestjs/common'
+
+export class ErrorSchemaDto {
+  @ApiProperty({ enum: [HttpStatus.BAD_REQUEST] })
+  public statusCode: HttpStatus
+
+  @ApiProperty()
+  public message: string
+
+  @ApiProperty()
+  public validations?: { [key: string]: string }[]
+
+  @ApiProperty()
+  public _exception?: { [key: string]: any }
+}
diff --git a/service/src/_common/dto/not-found.dto.ts b/service/src/_common/dto/not-found.dto.ts
@@ -0,0 +1,10 @@
+import { ApiProperty } from '@nestjs/swagger'
+import { HttpStatus } from '@nestjs/common'
+
+export class NotFoundDto {
+  @ApiProperty({ enum: [HttpStatus.NOT_FOUND] })
+  public statusCode: HttpStatus
+
+  @ApiProperty()
+  public message: string
+}
diff --git a/service/src/_common/dto/paginated-filter.dto.ts b/service/src/_common/dto/paginated-filter.dto.ts
@@ -0,0 +1,5 @@
+import { IsObject, IsOptional, ValidateNested } from 'class-validator'
+
+export class PaginatedFilterDto {
+  [key: string]: any
+}
diff --git a/service/src/_common/dto/paginated-response.dto.ts b/service/src/_common/dto/paginated-response.dto.ts
@@ -1,12 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger'
 import { HttpStatus } from '@nestjs/common'
 
-export class PaginatedDto<TData = {}> {
-  @ApiProperty()
+export class PaginatedResponseDto<TData = {}> {
+  @ApiProperty({ enum: [HttpStatus.OK] })
   public statusCode: HttpStatus
 
   @ApiProperty()
   public total: number
 
+  @ApiProperty()
   public data: TData[]
 }
diff --git a/service/src/_common/filters/mongoose-validation.filter.ts b/service/src/_common/filters/mongoose-validation.filter.ts
@@ -9,12 +9,17 @@ export class MongooseValidationFilter implements ExceptionFilter {
     const ctx = host.switchToHttp()
     const response = ctx.getResponse<Response>()
     Logger.debug(exception['message'], 'MongooseValidationFilter')
+    let debug = {}
+    if (process.env.NODE_ENV !== 'production') {
+      debug['_exception'] = exception
+    }
     response.status(HttpStatus.BAD_REQUEST).json(
       HttpException.createBody(
         {
           statusCode: HttpStatus.BAD_REQUEST,
           message: exception['message'],
           validations: this.getValidationErrors(exception),
+          ...debug,
         },
         exception.constructor.name,
         HttpStatus.BAD_REQUEST,
diff --git a/service/src/_common/helpers/pick-projection.helper.ts b/service/src/_common/helpers/pick-projection.helper.ts
diff --git a/service/src/core/categories/_dto/categories.dto.ts b/service/src/core/categories/_dto/categories.dto.ts
diff --git a/service/src/core/categories/_schemas/categories.schema.ts b/service/src/core/categories/_schemas/categories.schema.ts
diff --git a/service/src/core/categories/categories.controller.ts b/service/src/core/categories/categories.controller.ts
diff --git a/service/src/tickets/ticket/_schemas/ticket.schema.ts b/service/src/tickets/ticket/_schemas/ticket.schema.ts
diff --git a/service/src/tickets/ticket/ticket.controller.ts b/service/src/tickets/ticket/ticket.controller.ts
