Add comment about refactor in the future DiseaseOutbreakEventAttrs to…

… use DiseaseOutbreakEventAggregateRoot
EyeSeeTea · Nov 7, 2024 · 325c262 · 325c262
1 parent 783d6c8
commit 325c262
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/data/repositories/test/DiseaseOutbreakEventTestRepository.ts b/src/data/repositories/test/DiseaseOutbreakEventTestRepository.ts
@@ -1,6 +1,5 @@
 import {
     DataSource,
-    DiseaseOutbreakEvent,
     DiseaseOutbreakEventBaseAttrs,
     NationalIncidentStatus,
 } from "../../../domain/entities/disease-outbreak-event/DiseaseOutbreakEvent";
@@ -120,7 +119,7 @@ export class DiseaseOutbreakEventTestRepository implements DiseaseOutbreakEventR
         ]);
     }
 
-    save(_diseaseOutbreak: DiseaseOutbreakEvent): FutureData<Id> {
+    save(_diseaseOutbreak: DiseaseOutbreakEventBaseAttrs): FutureData<Id> {
         return Future.success("");
     }
 

diff --git a/src/domain/entities/disease-outbreak-event/DiseaseOutbreakEvent.ts b/src/domain/entities/disease-outbreak-event/DiseaseOutbreakEvent.ts
@@ -71,7 +71,6 @@ export type DiseaseOutbreakEventBaseAttrs = NamedRef & {
     notes: Maybe<string>;
 };
 
-// NOTICE: in the future, refactor to use DiseaseOutbreakEventAggregateRoot instead of this entity
 export type DiseaseOutbreakEventAttrs = DiseaseOutbreakEventBaseAttrs & {
     createdBy: Maybe<TeamMember>;
     mainSyndrome: Maybe<NamedRef>;
@@ -88,6 +87,9 @@ export type DiseaseOutbreakEventAttrs = DiseaseOutbreakEventBaseAttrs & {
  * Not using event as it is a keyword and can also be confused with dhis event
  **/
 
+/**
+ * @deprecated In the future, refactor to use `DiseaseOutbreakEventAggregateRoot` entity instead
+ */
 export class DiseaseOutbreakEvent extends Struct<DiseaseOutbreakEventAttrs>() {
     //TODO: Add required validations if exists:
     static validate(_data: DiseaseOutbreakEventBaseAttrs): ValidationError[] {