From ad9a518b97eb6debbbe80d34bd7703419457024c Mon Sep 17 00:00:00 2001
From: Matthew <matthew@staff.libraryofcode.org>
Date: Mon, 25 Mar 2024 15:12:11 -0400
Subject: [PATCH] comments for CommunityReport.ts

---
 database/CommunityReport.ts | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/database/CommunityReport.ts b/database/CommunityReport.ts
index 52727fe..0b4588f 100644
--- a/database/CommunityReport.ts
+++ b/database/CommunityReport.ts
@@ -1,7 +1,13 @@
 import { prop, getModelForClass, Ref } from "@typegoose/typegoose"
 import Member, { MemberAdditionalAcknowledgement, MemberUsedLanguages, MemberUsedOperatingSystems } from "./Member";
 
-interface AddtlScoreData {
+export enum GenerationMethod {
+    TIMER_INTERNAL, // generated by the internal cron-job timer automatically
+    INQUIRY_INTERNAL, // internal inquiry generated internally directly through the system. user checks their own inquiry, hard inquiry is performed by a staff member, etc.
+    INQUIRY_EXTERNAL, // external inquiry generated externally through the system via an external authorized request, such as via EDS
+}
+
+export interface AddtlScoreData {
     activity: number;
     roles: number;
     moderation: number;
@@ -16,14 +22,21 @@ interface AddtlScoreData {
 
 export default class CommunityReport {
     @prop({ required: true, index: true, ref: () => Member })
+    // the member on which this report was generated for
     public member: Ref<Member> | undefined;
 
-    @prop()
-    public lastUpdated: Date | undefined;
+    @prop({ required: true })
+    // the date in which this report was generated on
+    public date: Date | undefined;
 
-    @prop()
+    @prop({ required: true })
+    // the CommScore of the member specified
     public score: number | undefined;
 
-    @prop()
+    @prop({ required: true })
+    // the method in which this report was generated under
+    public generationMethod: GenerationMethod | undefined;
+
+    @prop({ required: true })
     public additionalScoreData: AddtlScoreData | undefined;
 }