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

src/libs/ReportUtils.ts

@@ -86,6 +86,7 @@ type AvatarRange = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
 
 type WelcomeMessage = {showReportName: boolean; phrase1?: string; phrase2?: string};
 
+/** TODO: I'd move this to `OriginalMessage.ts` and add it to `OriginalMessageModifiedExpense` type */
 type ExpenseOriginalMessage = {
     oldComment?: string;
     newComment?: string;

src/pages/settings/Wallet/ExpensifyCardPage.tsx

@@ -116,6 +116,8 @@ function ExpensifyCardPage({
         // eslint-disable-next-line rulesdir/no-thenable-actions-in-views
         Card.revealVirtualCardDetails(revealedCardID)
             .then((value) => {
+                // TODO: Card.revealVirtualCardDetails return type doesn't include TCardDetails, forcing us to type cast it here.
+                // The return type could be rewritten like Promise<Response & TCardDetails>
                 setCardsDetails((prevState: Record<number, TCardDetails | null>) => ({...prevState, [revealedCardID]: value as TCardDetails}));
                 setCardsDetailsErrors((prevState) => ({
                     ...prevState,

src/types/onyx/Account.ts

@@ -4,8 +4,10 @@ import type DismissedReferralBanners from './DismissedReferralBanners';
 import type * as OnyxCommon from './OnyxCommon';
 import type {TravelSettings} from './TravelSettings';
 
+/** Two factor authentication steps */
 type TwoFactorAuthStep = ValueOf<typeof CONST.TWO_FACTOR_AUTH_STEPS> | '';
 
+/** Model of user account */
 type Account = {
     /** Whether SAML is enabled for the current account */
     isSAMLEnabled?: boolean;
@@ -55,10 +57,19 @@ type Account = {
     /** Whether a sign is loading */
     isLoading?: boolean;
 
+    /** Authentication failure errors */
     errors?: OnyxCommon.Errors | null;
+
+    /** Authentication success message */
     success?: string;
+
+    /** Whether the two factor authentication codes were copied */
     codesAreCopied?: boolean;
+
+    /** Current two factor authentication step */
     twoFactorAuthStep?: TwoFactorAuthStep;
+
+    /** Referral banners that the user dismissed */
     dismissedReferralBanners?: DismissedReferralBanners;
 
     /** Object containing all account information necessary to connect with Spontana */

src/types/onyx/AccountData.ts

@@ -1,15 +1,29 @@
 import type {BankName} from './Bank';
 import type * as OnyxCommon from './OnyxCommon';
 
+/** Model of additional bank account data */
 type AdditionalData = {
+    /** Is a Peer-To-Peer debit card */
     isP2PDebitCard?: boolean;
+
+    /** Owners that can benefit from this bank account */
     beneficialOwners?: string[];
+
+    /** In which currency is the bank account */
     currency?: string;
+
+    /** In which bank is the bank account */
     bankName?: BankName;
+
+    // TODO: Confirm this
+    /** Whether the bank account is local or international */
     fieldsType?: string;
+
+    /** In which country is the bank account */
     country?: string;
 };
 
+/** Model of bank account data */
 type AccountData = {
     /** The masked bank account number */
     accountNumber?: string;
@@ -38,6 +52,7 @@ type AccountData = {
     /** All user emails that have access to this bank account */
     sharees?: string[];
 
+    /** Institution that processes the account payments */
     processor?: string;
 
     /** The bankAccountID in the bankAccounts db */
@@ -52,6 +67,7 @@ type AccountData = {
     /** Any error message to show */
     errors?: OnyxCommon.Errors;
 
+    /** The debit card ID */
     fundID?: number;
 };
 

src/types/onyx/Bank.ts

@@ -3,15 +3,28 @@ import type {ValueOf} from 'type-fest';
 import type CONST from '@src/CONST';
 import type IconAsset from '@src/types/utils/IconAsset';
 
+/** Bank icon configurations */
 type BankIcon = {
+    /** Source of the icon, can be a component or an image */
     icon: IconAsset;
+
+    /** Size of the icon */
     iconSize?: number;
+
+    /** Height of the icon */
     iconHeight?: number;
+
+    /** Width of the icon */
     iconWidth?: number;
+
+    /** Icon wrapper styles */
     iconStyles?: ViewStyle[];
 };
 
+/** Bank names */
 type BankName = ValueOf<typeof CONST.BANK_NAMES>;
+
+/** Bank name keys */
 type BankNameKey = keyof typeof CONST.BANK_NAMES;
 
 export type {BankIcon, BankName, BankNameKey};

src/types/onyx/BankAccount.ts

@@ -2,31 +2,47 @@ import type CONST from '@src/CONST';
 import type AccountData from './AccountData';
 import type * as OnyxCommon from './OnyxCommon';
 
+// TODO: This type is a duplicate of the one present in AccountData.ts
+/** Model of additional bank account data */
 type AdditionalData = {
+    /** Is a Peer-To-Peer Debit Card */
     isP2PDebitCard?: boolean;
+
+    /** Owners that can benefit from this bank account */
     beneficialOwners?: string[];
+
+    /** In which currency is the bank account */
     currency?: string;
+
+    /** In which bank is the bank account */
     bankName?: string;
+
+    // TODO: Confirm this
+    /** Whether the bank account is local or international */
     fieldsType?: string;
+
+    /** In which country is the bank account */
     country?: string;
 };
 
+/** Model of bank account */
 type BankAccount = OnyxCommon.OnyxValueWithOfflineFeedback<{
     /** The bank account type */
     accountType?: typeof CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT;
 
     /** string like 'Account ending in XXXX' */
     description?: string;
 
+    /** Determines if the bank account is a default payment method */
     isDefault?: boolean;
 
     /* Determines if the bank account is a savings account */
     isSavings?: boolean;
 
-    /** Date when the 3 micro amounts for validation were supposed to reach the bank account. */
+    /** Date when the 3 micro amounts for validation were supposed to reach the bank account */
     validateCodeExpectedDate?: string;
 
-    /** string like 'bankAccount-{<bankAccountID>}' where <bankAccountID> is the bankAccountID */
+    /** string like `bankAccount-<bankAccountID>` */
     key?: string;
 
     /** Alias for bankAccountID */
@@ -42,6 +58,7 @@ type BankAccount = OnyxCommon.OnyxValueWithOfflineFeedback<{
     errors?: OnyxCommon.Errors;
 }>;
 
+/** Record of bank accounts, indexed by bankAccountID */
 type BankAccountList = Record<string, BankAccount>;
 
 export default BankAccount;

src/types/onyx/Beta.ts

@@ -1,6 +1,7 @@
 import type {ValueOf} from 'type-fest';
 import type CONST from '@src/CONST';
 
+/** New Dot Beta features */
 type Beta = ValueOf<typeof CONST.BETAS>;
 
 export default Beta;

src/types/onyx/BlockedFromConcierge.ts

@@ -1,3 +1,4 @@
+/** Model of blocked user from concierge */
 type BlockedFromConcierge = {
     /** The date that the user will be unblocked */
     expiresAt: string;

src/types/onyx/Card.ts

@@ -2,43 +2,103 @@ import type {ValueOf} from 'type-fest';
 import type CONST from '@src/CONST';
 import type * as OnyxCommon from './OnyxCommon';
 
+/** Model of Expensify card */
 type Card = {
+    /** Card ID number */
     cardID: number;
+
+    /** Current card state */
     state: ValueOf<typeof CONST.EXPENSIFY_CARD.STATE>;
+
+    /** Bank name */
     bank: string;
+
+    /** Available amount to spend */
     availableSpend: number;
+
+    /** Domain name */
     domainName: string;
+
+    /** Last four Primary Account Number digits */
     lastFourPAN?: string;
+
+    /** Current fraud state of the card */
     fraud: ValueOf<typeof CONST.EXPENSIFY_CARD.FRAUD_TYPES>;
+
+    /** Card related error messages */
     errors?: OnyxCommon.Errors;
+
+    /** Is card data loading */
     isLoading?: boolean;
+
+    /** Additional card data */
     nameValuePairs?: {
+        // TODO: Doesn't seem to be used in app
+        /** Type of spending limits  */
         limitType?: ValueOf<typeof CONST.EXPENSIFY_CARD.LIMIT_TYPES>;
+
+        // TODO: Doesn't seem to be used in app
         cardTitle?: string; // Used only for admin-issued virtual cards
+
+        // TODO: Doesn't seem to be used in app
         issuedBy?: number;
+
+        // TODO: Doesn't seem to be used in app
         hasCustomUnapprovedExpenseLimit?: boolean;
+
+        // TODO: Doesn't seem to be used in app
         unapprovedExpenseLimit?: number;
+
+        // TODO: Doesn't seem to be used in app
         feedCountry?: string;
+
+        /** Is a virtual card */
         isVirtual?: boolean;
+
+        // TODO: Doesn't seem to be used in app
         previousState?: number;
+
+        // TODO: Doesn't seem to be used in app
+        /** Card expiration date */
         expirationDate?: string;
     };
 };
 
+/** Model of Expensify card details */
 type TCardDetails = {
+    /** Card Primary Account Number */
     pan: string;
+
+    /** Card expiration date */
     expiration: string;
+
+    /** Card Verification Value number */
     cvv: string;
+
+    // TODO: Doesn't seem to be used in app
+    /** Card owner address */
     address: {
+        /** Address line 1 */
         street: string;
+
+        /** Address line 2 */
         street2: string;
+
+        /** City */
         city: string;
+
+        /** State */
         state: string;
+
+        /** Zip code */
         zip: string;
+
+        /** Country */
         country: string;
     };
 };
 
+/** Record of Expensify cards, indexed by cardID */
 type CardList = Record<string, Card>;
 
 export default Card;

src/types/onyx/Console.ts

@@ -1,11 +1,18 @@
 import type CONST from '@src/CONST';
 
+/** Model of a log */
 type Log = {
+    /** Log time */
     time: Date;
+
+    /** Log level */
     level: keyof typeof CONST.DEBUG_CONSOLE.LEVELS;
+
+    /** Log message */
     message: string;
 };
 
+/** Record of captured logs */
 type CapturedLogs = Record<number, Log>;
 
 export type {Log, CapturedLogs};

src/types/onyx/Credentials.ts

@@ -1,3 +1,4 @@
+/** Model of user credentials */
 type Credentials = {
     /** The email/phone the user logged in with */
     login?: string;

src/types/onyx/Currency.ts

@@ -1,3 +1,4 @@
+/** Model of currency */
 type Currency = {
     /** Symbol for the currency */
     symbol: string;
@@ -21,6 +22,7 @@ type Currency = {
     cacheBurst?: number;
 };
 
+/** Record of currencies, index by currency code */
 type CurrencyList = Record<string, Currency | null>;
 
 export default Currency;

src/types/onyx/CustomStatusDraft.ts

@@ -1,3 +1,4 @@
+/** Model of custom status draft */
 type CustomStatusDraft = {
     /** The emoji code of the draft status */
     emojiCode?: string;

src/types/onyx/DismissedReferralBanners.ts

@@ -1,10 +1,20 @@
 import type CONST from '@src/CONST';
 
+/** Model of dismissed referral banners */
 type DismissedReferralBanners = {
+    /** Is 'Submit expense' referral dismissed */
     [CONST.REFERRAL_PROGRAM.CONTENT_TYPES.SUBMIT_EXPENSE]?: boolean;
+
+    /** Is 'Start chat' referral dismissed */
     [CONST.REFERRAL_PROGRAM.CONTENT_TYPES.START_CHAT]?: boolean;
+
+    /** Is 'Pay someone' referral dismissed */
     [CONST.REFERRAL_PROGRAM.CONTENT_TYPES.PAY_SOMEONE]?: boolean;
+
+    /** Is 'Refer friend' referral dismissed */
     [CONST.REFERRAL_PROGRAM.CONTENT_TYPES.REFER_FRIEND]?: boolean;
+
+    /** Is 'Share code' referral dismissed */
     [CONST.REFERRAL_PROGRAM.CONTENT_TYPES.SHARE_CODE]?: boolean;
 };
 

src/types/onyx/Download.ts

@@ -1,3 +1,4 @@
+/** Model of file download */
 type Download = {
     /** If a file download is happening */
     isDownloading: boolean;

src/types/onyx/FrequentlyUsedEmoji.ts

@@ -1,3 +1,4 @@
+/** Model of frequently used emoji */
 type FrequentlyUsedEmoji = {
     /** The emoji code */
     code: string;