Merge pull request #43499 from callstack-internal/pac-guerreiro/refac…

…tor/39129-add-comments-to-remaining-onyx-types

 [No QA][TS Migration] Follow up - Add comments for remaining properties in Onyx types

src/libs/TransactionUtils.ts

@@ -683,7 +683,7 @@ function hasViolation(transactionID: string, transactionViolations: OnyxCollecti
  * Checks if any violations for the provided transaction are of type 'notice'
  */
 function hasNoticeTypeViolation(transactionID: string, transactionViolations: OnyxCollection<TransactionViolation[]>): boolean {
-    return !!transactionViolations?.[ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS + transactionID]?.some((violation: TransactionViolation) => violation.type === 'notice');
+    return !!transactionViolations?.[ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS + transactionID]?.some((violation: TransactionViolation) => violation.type === CONST.VIOLATION_TYPES.NOTICE);
 }
 
 /**

src/types/onyx/OriginalMessage.ts

@@ -44,13 +44,13 @@ type OriginalMessageApproved = {
 
     /** Content of the original message */
     originalMessage: {
-        /** Approved expense amount */
+        /** Approved expense report amount */
         amount: number;
 
-        /** Currency of the approved expense amount */
+        /** Currency of the approved expense report amount */
         currency: string;
 
-        /** Report ID of the expense */
+        /** Report ID of the expense report */
         expenseReportID: string;
     };
 };
@@ -91,7 +91,7 @@ type IOUDetails = {
     amount: number;
 
     /** Optional comment */
-    comment?: string;
+    comment: string;
 
     /** Currency of the money sent */
     currency: string;
@@ -179,7 +179,7 @@ type Decision = {
     /** Name of the decision */
     decision: DecisionName;
 
-    /** When was the decision name */
+    /** When was the decision made */
     timestamp?: string;
 };
 
@@ -283,13 +283,13 @@ type OriginalMessageSubmitted = {
 
     /** Content of the original message */
     originalMessage: {
-        /** Approved expense amount */
+        /** Approved expense report amount */
         amount: number;
 
-        /** Currency of the approved expense amount */
+        /** Currency of the approved expense report amount */
         currency: string;
 
-        /** Report ID of the expense */
+        /** Report ID of the expense report */
         expenseReportID: string;
     };
 };

src/types/onyx/TransactionViolation.ts

@@ -66,8 +66,8 @@ type TransactionViolationData = {
 
 /** Model of a transaction violation */
 type TransactionViolation = {
-    /** Type of transaction violation ('violation', 'notice', 'warning', ...) */
-    type: string;
+    /** Type of transaction violation */
+    type: ValueOf<typeof CONST.VIOLATION_TYPES>;
 
     /** Name of the transaction violation */
     name: ViolationName;