fix: Explicitly mark types in the assemblers files

BREAKING CHANGE: The methods convertToDTO, convertToEntity, convertToCreateEntity, and convertToUpdateEntity now require casting the return value.
TriPSs · Mar 29, 2024 · 58b94a9 · 58b94a9
1 parent b5c761b
commit 58b94a9
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/examples/auth/src/todo-item/todo-item.assembler.ts b/examples/auth/src/todo-item/todo-item.assembler.ts
@@ -6,7 +6,7 @@ import { TodoItemEntity } from './todo-item.entity'
 @Assembler(TodoItemDTO, TodoItemEntity)
 export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {
   convertToDTO(entity: TodoItemEntity): TodoItemDTO {
-    const dto = super.convertToDTO(entity)
+    const dto = super.convertToDTO(entity) as TodoItemDTO
     dto.age = Date.now() - entity.created.getMilliseconds()
     return dto
   }

diff --git a/examples/mongoose/src/todo-item/todo-item.assembler.ts b/examples/mongoose/src/todo-item/todo-item.assembler.ts
@@ -6,7 +6,7 @@ import { TodoItemEntity } from './todo-item.entity'
 @Assembler(TodoItemDTO, TodoItemEntity)
 export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {
   convertToDTO(entity: TodoItemEntity): TodoItemDTO {
-    const dto = super.convertToDTO(entity)
+    const dto = super.convertToDTO(entity) as TodoItemDTO
     dto.age = Date.now() - entity.createdAt.getMilliseconds()
     return dto
   }

diff --git a/examples/sequelize/src/todo-item/todo-item.assembler.ts b/examples/sequelize/src/todo-item/todo-item.assembler.ts
@@ -6,7 +6,7 @@ import { TodoItemEntity } from './entity/todo-item.entity'
 @Assembler(TodoItemDTO, TodoItemEntity)
 export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {
   convertToDTO(entity: TodoItemEntity): TodoItemDTO {
-    const dto = super.convertToDTO(entity)
+    const dto = super.convertToDTO(entity) as TodoItemDTO
     dto.age = Date.now() - entity.created.getMilliseconds()
     return dto
   }

diff --git a/examples/typegoose/src/todo-item/todo-item.assembler.ts b/examples/typegoose/src/todo-item/todo-item.assembler.ts
@@ -6,7 +6,7 @@ import { TodoItemEntity } from './todo-item.entity'
 @Assembler(TodoItemDTO, TodoItemEntity)
 export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {
   convertToDTO(entity: TodoItemEntity): TodoItemDTO {
-    const dto = super.convertToDTO(entity)
+    const dto = super.convertToDTO(entity) as TodoItemDTO
     dto.age = Date.now() - entity.createdAt.getMilliseconds()
     return dto
   }

diff --git a/examples/typeorm/src/todo-item/todo-item.assembler.ts b/examples/typeorm/src/todo-item/todo-item.assembler.ts
@@ -6,7 +6,7 @@ import { TodoItemEntity } from './todo-item.entity'
 @Assembler(TodoItemDTO, TodoItemEntity)
 export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {
   convertToDTO(entity: TodoItemEntity): TodoItemDTO {
-    const dto = super.convertToDTO(entity)
+    const dto = super.convertToDTO(entity) as TodoItemDTO
     dto.age = Date.now() - entity.created.getMilliseconds()
     return dto
   }

diff --git a/packages/core/src/assemblers/class-transformer.assembler.ts b/packages/core/src/assemblers/class-transformer.assembler.ts
@@ -17,11 +17,11 @@ export abstract class ClassTransformerAssembler<DTO, Entity extends DeepPartial<
   DeepPartial<DTO>,
   DeepPartial<Entity>
 > {
-  public convertToDTO(entity: Entity): DTO {
+  public convertToDTO(entity: Entity): DTO | Promise<DTO> {
     return this.convert(this.DTOClass, this.toPlain(entity))
   }
 
-  public convertToEntity(dto: DTO): Entity {
+  public convertToEntity(dto: DTO): Entity | Promise<Entity> {
     return this.convert(this.EntityClass, this.toPlain(dto))
   }
 
@@ -37,11 +37,11 @@ export abstract class ClassTransformerAssembler<DTO, Entity extends DeepPartial<
     return aggregate as unknown as AggregateResponse<DTO>
   }
 
-  public convertToCreateEntity(create: DeepPartial<DTO>): DeepPartial<Entity> {
+  public convertToCreateEntity(create: DeepPartial<DTO>): DeepPartial<Entity> | Promise<DeepPartial<Entity>> {
     return this.convert(this.EntityClass, create)
   }
 
-  public convertToUpdateEntity(create: DeepPartial<DTO>): DeepPartial<Entity> {
+  public convertToUpdateEntity(create: DeepPartial<DTO>): DeepPartial<Entity> | Promise<DeepPartial<Entity>> {
     return this.convert(this.EntityClass, create)
   }