WIP schemas + dto (core)

tacxou · tacxou · commit 22fa29308a48 · 2023-09-05T14:10:07.000+02:00
diff --git a/service/src/core/categories/_schemas/categories.schema.ts b/service/src/core/categories/_schemas/categories.schema.ts
@@ -29,14 +29,12 @@ export class Categories extends AbstractSchema {
   public order: number
 
   @Prop({
-    required: true,
     type: Boolean,
     default: true,
   })
   public selectable: boolean
 
   @Prop({
-    required: true,
     type: Boolean,
     default: false,
   })
diff --git a/service/src/core/categories/categories.controller.ts b/service/src/core/categories/categories.controller.ts
@@ -28,7 +28,7 @@ export class CategoriesController extends AbstractController {
     parentId: 1,
     description: 1,
     color: 1,
-    icon: 0,
+    icon: 1,
   }
 
   constructor(private readonly _service: CategoriesService) {
diff --git a/service/src/core/entities/_dto/entites.dto.ts b/service/src/core/entities/_dto/entites.dto.ts
@@ -1,7 +1,33 @@
-import { PartialType } from '@nestjs/swagger'
+import { ApiProperty, PartialType } from '@nestjs/swagger'
+import { AbstractCustomFieldsDto } from '~/_common/abstracts/dto/abstract.custom-fields.dto'
+import { Type } from 'class-transformer'
+import { IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from 'class-validator'
+import { ProfilePartDto } from '~/core/entities/_dto/parts/profile.part.dto'
+import { StatePartDto } from '~/core/entities/_dto/parts/state.part.dto'
 
-export class EntitiesCreateDto {
+export class EntitiesCreateDto extends AbstractCustomFieldsDto {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty()
+  public publicEmail: string
 
+  @ValidateNested()
+  @Type(() => ProfilePartDto)
+  @IsNotEmpty()
+  @ApiProperty()
+  public profile: ProfilePartDto
+
+  @ValidateNested()
+  @Type(() => StatePartDto)
+  @IsOptional()
+  @ApiProperty()
+  public state?: StatePartDto
+}
+
+export class EntitiesDto extends EntitiesCreateDto {
+  @IsMongoId()
+  @ApiProperty()
+  public _id: string
 }
 
 export class EntitiesUpdateDto extends PartialType(EntitiesCreateDto) {
diff --git a/service/src/core/entities/_dto/parts/phone.part.dto.ts b/service/src/core/entities/_dto/parts/phone.part.dto.ts
@@ -0,0 +1,21 @@
+import { PhoneType, PhoneTypeList } from '~/core/entities/_enum/phone-type.enum'
+import { IsEnum, IsNotEmpty, IsOptional, IsString, IsPhoneNumber } from 'class-validator'
+import { ApiProperty } from '@nestjs/swagger'
+
+export class PhonePartDto {
+  @IsEnum(PhoneTypeList)
+  @IsNotEmpty()
+  @ApiProperty({ enum: PhoneTypeList })
+  public type: PhoneType
+
+  @IsString()
+  @IsPhoneNumber()
+  @IsNotEmpty()
+  @ApiProperty()
+  public phoneNumber: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public description?: string
+}
diff --git a/service/src/core/entities/_dto/parts/profile.part.dto.ts b/service/src/core/entities/_dto/parts/profile.part.dto.ts
@@ -0,0 +1,37 @@
+import { IsNotEmpty, IsOptional, IsString, ValidateNested } from 'class-validator'
+import { PhonePartDto } from '~/core/entities/_dto/parts/phone.part.dto'
+import { Type } from 'class-transformer'
+import { ApiProperty } from '@nestjs/swagger'
+
+export class ProfilePartDto {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty()
+  public commonName: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public firstName?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public lastName?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public thirdName?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public avatar?: string
+
+  @ValidateNested({ each: true })
+  @Type(() => PhonePartDto)
+  @IsOptional()
+  @ApiProperty({ type: [PhonePartDto] })
+  public phones?: PhonePartDto[]
+}
diff --git a/service/src/core/entities/_dto/parts/state.part.dto.ts b/service/src/core/entities/_dto/parts/state.part.dto.ts
@@ -0,0 +1,15 @@
+import { IsEnum, IsNotEmpty, IsOptional, IsDate } from 'class-validator'
+import { EntityState, EntityStateList } from '~/core/entities/_enum/entity-state.enum'
+import { ApiProperty } from '@nestjs/swagger'
+
+export class StatePartDto {
+  @IsEnum(EntityStateList)
+  @IsNotEmpty()
+  @ApiProperty({ enum: EntityStateList })
+  public current: EntityState
+
+  @IsDate()
+  @IsOptional()
+  @ApiProperty()
+  public lastChangedAt?: Date
+}
diff --git a/service/src/core/entities/_enum/entity-type.enum.ts b/service/src/core/entities/_enum/entity-type.enum.ts
@@ -0,0 +1,10 @@
+export enum EntityType {
+  AGENT = 1,
+  CONTACT = 2,
+  CLIENT = 3,
+  COMPANY = 4,
+}
+
+export const EntityTypeList: number[] = Object.keys(EntityType)
+  .filter((k) => typeof EntityType[k as any] === 'number')
+  .map((k) => parseInt(EntityType[k as any], 10))
diff --git a/service/src/core/entities/_enum/phone-type.enum.ts b/service/src/core/entities/_enum/phone-type.enum.ts
@@ -0,0 +1,11 @@
+export enum PhoneType {
+  OTHER = 1,
+  HOME = 2,
+  PROFESSIONAL = 3,
+  PERSONAL = 4,
+  FAX = 5,
+}
+
+export const PhoneTypeList: number[] = Object.keys(PhoneType)
+  .filter((k) => typeof PhoneType[k as any] === 'number')
+  .map((k) => parseInt(PhoneType[k as any], 10))
diff --git a/service/src/core/entities/_schemas/entities.schema.ts b/service/src/core/entities/_schemas/entities.schema.ts
@@ -11,6 +11,7 @@ export class Entity extends AbstractSchema {
   @Prop({
     type: String,
     required: true,
+    unique: true,
   })
   public publicEmail: string
 
@@ -22,7 +23,7 @@ export class Entity extends AbstractSchema {
 
   @Prop({
     type: StatePartSchema,
-    required: true,
+    default: {},
   })
   public state: StatePart
 
diff --git a/service/src/core/entities/_schemas/parts/phone.part.schema.ts b/service/src/core/entities/_schemas/parts/phone.part.schema.ts
@@ -0,0 +1,28 @@
+import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose'
+import { Document } from 'mongoose'
+import { EntityState, EntityStateList } from '~/core/entities/_enum/entity-state.enum'
+import { ProfilePart } from '~/core/entities/_schemas/parts/profile.part.schema'
+import { PhoneType, PhoneTypeList } from '~/core/entities/_enum/phone-type.enum'
+
+@Schema({ _id: false })
+export class PhonePart extends Document {
+  @Prop({
+    type: Number,
+    enum: PhoneTypeList,
+    required: true,
+  })
+  public type: PhoneType
+
+  @Prop({
+    type: String,
+    required: true,
+  })
+  public phoneNumber: string
+
+  @Prop({
+    type: String,
+  })
+  public description: string
+}
+
+export const PhonePartSchema = SchemaFactory.createForClass(PhonePart)
diff --git a/service/src/core/entities/_schemas/parts/profile.part.schema.ts b/service/src/core/entities/_schemas/parts/profile.part.schema.ts
@@ -1,17 +1,22 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose'
 import { Document } from 'mongoose'
+import { PhonePart, PhonePartSchema } from '~/core/entities/_schemas/parts/phone.part.schema'
 
 @Schema({ _id: false })
 export class ProfilePart extends Document {
   @Prop({
     type: String,
     required: true,
   })
+  public commonName: string
+
+  @Prop({
+    type: String,
+  })
   public firstName: string
 
   @Prop({
     type: String,
-    required: true,
   })
   public lastName: string
 
@@ -24,12 +29,11 @@ export class ProfilePart extends Document {
     type: String,
   })
   public avatar?: string
+
+  @Prop({
+    type: [PhonePartSchema],
+  })
+  public phones?: PhonePart[]
 }
 
 export const ProfilePartSchema = SchemaFactory.createForClass(ProfilePart)
-ProfilePartSchema.virtual('commonName').get(function (this: ProfilePart): string {
-  const commonNamePart = [this.firstName]
-  if (this.thirdName) commonNamePart.push(this.thirdName)
-  commonNamePart.push(this.lastName)
-  return commonNamePart.join(' ')
-})
diff --git a/service/src/core/entities/_schemas/parts/state.part.schema.ts b/service/src/core/entities/_schemas/parts/state.part.schema.ts
@@ -1,6 +1,7 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose'
 import { Document } from 'mongoose'
 import { EntityState, EntityStateList } from '~/core/entities/_enum/entity-state.enum'
+import { ProfilePart } from '~/core/entities/_schemas/parts/profile.part.schema'
 
 @Schema({ _id: false })
 export class StatePart extends Document {
@@ -20,3 +21,7 @@ export class StatePart extends Document {
 }
 
 export const StatePartSchema = SchemaFactory.createForClass(StatePart)
+StatePartSchema.virtual('isActive').get(function (this: StatePart): boolean {
+  return this.current > EntityState.INACTIVE
+})
+
diff --git a/service/src/core/entities/entities.controller.ts b/service/src/core/entities/entities.controller.ts
@@ -6,21 +6,28 @@ import { FilterOptions, FilterSchema, SearchFilterOptions, SearchFilterSchema }
 import { ApiParam } from '@nestjs/swagger'
 import { ObjectIdValidationPipe } from '~/_common/pipes/object-id-validation.pipe'
 import { Types } from 'mongoose'
-import { EntitiesCreateDto, EntitiesUpdateDto } from '~/core/entities/_dto/entites.dto'
+import { EntitiesCreateDto, EntitiesDto, EntitiesUpdateDto } from '~/core/entities/_dto/entites.dto'
+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 { PartialProjectionType } from '~/_common/types/partial-projection.type'
+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'
 
 @Controller('entities')
 export class EntitiesController extends AbstractController {
-  protected readonly projection = {
-    name: 1,
-    color: 1,
-    icon: 1,
+  protected static readonly projection: PartialProjectionType<EntitiesDto> = {
+    profile: 1,
+    state: 1,
   }
 
   public constructor(private readonly _service: EntitiesService) {
     super()
   }
 
   @Post()
+  @ApiCreateDecorator(EntitiesCreateDto, EntitiesDto)
   public async create(@Req() req: Request, @Res() res: Response, @Body() body: EntitiesCreateDto) {
     const data = await this._service.create(body)
     return res.status(HttpStatus.CREATED).json({
@@ -30,8 +37,9 @@ export class EntitiesController extends AbstractController {
   }
 
   @Get()
+  @ApiPaginatedDecorator(PickProjectionHelper(EntitiesDto, EntitiesController.projection))
   public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions) {
-    const [data, total] = await this._service.findAndCount(searchFilterSchema, this.projection, searchFilterOptions)
+    const [data, total] = await this._service.findAndCount(searchFilterSchema, EntitiesController.projection, searchFilterOptions)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
       total,
@@ -41,6 +49,7 @@ export class EntitiesController extends AbstractController {
 
   @Get(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
+  @ApiReadResponseDecorator(EntitiesDto)
   public async read(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
     const data = await this._service.findById(_id)
     return res.status(HttpStatus.OK).json({
@@ -51,6 +60,7 @@ export class EntitiesController extends AbstractController {
 
   @Patch(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
+  @ApiUpdateDecorator(EntitiesUpdateDto, EntitiesDto)
   public async update(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Body() body: EntitiesUpdateDto, @Res() res: Response) {
     const data = await this._service.update(_id, body)
     return res.status(HttpStatus.OK).json({
@@ -61,6 +71,7 @@ export class EntitiesController extends AbstractController {
 
   @Delete(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
+  @ApiDeletedResponseDecorator(EntitiesDto)
   public async remove(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
     const data = await this._service.delete(_id)
     return res.status(HttpStatus.OK).json({
diff --git a/service/src/core/filestorage/_dto/filestorage.dto.ts b/service/src/core/filestorage/_dto/filestorage.dto.ts
@@ -1,7 +1,47 @@
-import { PartialType } from "@nestjs/swagger"
+import { ApiProperty, PartialType } from '@nestjs/swagger'
+import { AbstractCustomFieldsDto } from '~/_common/abstracts/dto/abstract.custom-fields.dto'
+import { IsMongoId, IsString, IsEnum, IsOptional, IsObject, IsBoolean } from 'class-validator'
+import { FsType, FsTypeList } from '~/core/filestorage/_enum/fs-type.enum'
 
-export class FilestorageCreateDto {
+export class FilestorageCreateDto extends AbstractCustomFieldsDto {
+  @IsEnum(FsTypeList)
+  @ApiProperty({ enum: FsTypeList })
+  type: FsType
 
+  @IsString()
+  @ApiProperty()
+  namespace: string
+
+  @IsString()
+  @ApiProperty()
+  path: string
+
+  @IsOptional()
+  @IsString()
+  @ApiProperty()
+  comments?: string
+
+  @IsOptional()
+  @IsBoolean()
+  @ApiProperty()
+  hidden?: boolean
+
+  @IsOptional()
+  @IsObject()
+  @ApiProperty()
+  tags?: { [key: string]: any }
+
+  @IsOptional()
+  @IsObject()
+  @ApiProperty()
+  acls?: { [key: string]: any }
+}
+
+export class FilestorageDto extends FilestorageCreateDto {
+  @IsMongoId()
+  @ApiProperty()
+  public _id: string
 }
 
-export class FilestorageUpdateDto extends PartialType(FilestorageCreateDto) {}
+export class FilestorageUpdateDto extends PartialType(FilestorageCreateDto) {
+}
diff --git a/service/src/core/filestorage/_enum/fs-type.enum.ts b/service/src/core/filestorage/_enum/fs-type.enum.ts
@@ -0,0 +1,9 @@
+export enum FsType {
+  DIRECTORY = 'd',
+  FILE = 'f',
+  SYMLINK = 'l',
+}
+
+export const FsTypeList: number[] = Object.keys(FsType)
+  .filter((k) => typeof FsType[k as any] === 'string')
+  .map((k) => FsType[k as any])
diff --git a/service/src/core/filestorage/_schemas/filestorage.schema.ts b/service/src/core/filestorage/_schemas/filestorage.schema.ts
diff --git a/service/src/core/identities/_schemas/identities.schema.ts b/service/src/core/identities/_schemas/identities.schema.ts
diff --git a/service/src/core/identities/_schemas/parts/security.part.schema.ts b/service/src/core/identities/_schemas/parts/security.part.schema.ts
diff --git a/service/src/core/identities/_schemas/parts/state.part.schema.ts b/service/src/core/identities/_schemas/parts/state.part.schema.ts
diff --git a/service/src/core/preferences/_schemas/preferences.schema.ts b/service/src/core/preferences/_schemas/preferences.schema.ts
diff --git a/service/src/core/projects/_schemas/project.schema.ts b/service/src/core/projects/_schemas/project.schema.ts
diff --git a/service/src/core/triggers/_schemas/triggers.schema.ts b/service/src/core/triggers/_schemas/triggers.schema.ts

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export class CategoriesController extends AbstractController {`
`28`	`28`	`parentId: 1,`
`29`	`29`	`description: 1,`
`30`	`30`	`color: 1,`
`31`		`- icon: 0,`
	`31`	`+ icon: 1,`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`constructor(private readonly _service: CategoriesService) {`