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

src/libs/ModifiedExpenseMessage.ts

@@ -3,12 +3,12 @@ import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import type {PolicyTagList, ReportAction} from '@src/types/onyx';
+import type {ModifiedExpense} from '@src/types/onyx/OriginalMessage';
 import * as CurrencyUtils from './CurrencyUtils';
 import DateUtils from './DateUtils';
 import getReportPolicyID from './getReportPolicyID';
 import * as Localize from './Localize';
 import * as PolicyUtils from './PolicyUtils';
-import type {ExpenseOriginalMessage} from './ReportUtils';
 import * as TransactionUtils from './TransactionUtils';
 
 let allPolicyTags: OnyxCollection<PolicyTagList> = {};
@@ -109,7 +109,7 @@ function getForReportAction(reportID: string | undefined, reportAction: OnyxEntr
     if (reportAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.MODIFIED_EXPENSE) {
         return '';
     }
-    const reportActionOriginalMessage = reportAction?.originalMessage as ExpenseOriginalMessage | undefined;
+    const reportActionOriginalMessage = reportAction?.originalMessage as ModifiedExpense | undefined;
     const policyID = getReportPolicyID(reportID) ?? '';
 
     const removalFragments: string[] = [];

src/libs/ReportUtils.ts

@@ -41,6 +41,7 @@ import type {Errors, Icon, PendingAction} from '@src/types/onyx/OnyxCommon';
 import type {
     ChangeLog,
     IOUMessage,
+    ModifiedExpense,
     OriginalMessageActionName,
     OriginalMessageCreated,
     OriginalMessageDismissedViolation,
@@ -87,30 +88,6 @@ type AvatarRange = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
 
 type WelcomeMessage = {showReportName: boolean; phrase1?: string; phrase2?: string};
 
-type ExpenseOriginalMessage = {
-    oldComment?: string;
-    newComment?: string;
-    comment?: string;
-    merchant?: string;
-    oldCreated?: string;
-    created?: string;
-    oldMerchant?: string;
-    oldAmount?: number;
-    amount?: number;
-    oldCurrency?: string;
-    currency?: string;
-    category?: string;
-    oldCategory?: string;
-    tag?: string;
-    oldTag?: string;
-    billable?: string;
-    oldBillable?: string;
-    oldTaxAmount?: number;
-    taxAmount?: number;
-    taxRate?: string;
-    oldTaxRate?: string;
-};
-
 type SpendBreakdown = {
     nonReimbursableSpend: number;
     reimbursableSpend: number;
@@ -2971,8 +2948,8 @@ function getModifiedExpenseOriginalMessage(
     transactionChanges: TransactionChanges,
     isFromExpenseReport: boolean,
     policy: OnyxEntry<Policy>,
-): ExpenseOriginalMessage {
-    const originalMessage: ExpenseOriginalMessage = {};
+): ModifiedExpense {
+    const originalMessage: ModifiedExpense = {};
     // Remark: Comment field is the only one which has new/old prefixes for the keys (newComment/ oldComment),
     // all others have old/- pattern such as oldCreated/created
     if ('comment' in transactionChanges) {
@@ -6942,7 +6919,6 @@ export {
 export type {
     Ancestor,
     DisplayNameWithTooltips,
-    ExpenseOriginalMessage,
     OptimisticAddCommentReportAction,
     OptimisticChatReport,
     OptimisticClosedReportAction,

src/libs/actions/Card.ts

@@ -5,7 +5,7 @@ import type {ActivatePhysicalExpensifyCardParams, ReportVirtualExpensifyCardFrau
 import {SIDE_EFFECT_REQUEST_COMMANDS, WRITE_COMMANDS} from '@libs/API/types';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {Response} from '@src/types/onyx';
+import type {ExpensifyCardDetails} from '@src/types/onyx/Card';
 
 type ReplacementReason = 'damaged' | 'stolen';
 
@@ -158,7 +158,7 @@ function clearCardListErrors(cardID: number) {
  *
  * @returns promise with card details object
  */
-function revealVirtualCardDetails(cardID: number): Promise<Response> {
+function revealVirtualCardDetails(cardID: number): Promise<ExpensifyCardDetails> {
     return new Promise((resolve, reject) => {
         const parameters: RevealExpensifyCardDetailsParams = {cardID};
 
@@ -170,7 +170,7 @@ function revealVirtualCardDetails(cardID: number): Promise<Response> {
                     reject('cardPage.cardDetailsLoadingFailure');
                     return;
                 }
-                resolve(response);
+                resolve(response as ExpensifyCardDetails);
             })
             // eslint-disable-next-line prefer-promise-reject-errors
             .catch(() => reject('cardPage.cardDetailsLoadingFailure'));

src/libs/actions/Wallet.ts

@@ -61,10 +61,6 @@ function setAdditionalDetailsErrors(errorFields: OnyxCommon.ErrorFields) {
     Onyx.merge(ONYXKEYS.WALLET_ADDITIONAL_DETAILS, {errorFields});
 }
 
-function setAdditionalDetailsErrorMessage(additionalErrorMessage: string) {
-    Onyx.merge(ONYXKEYS.WALLET_ADDITIONAL_DETAILS, {additionalErrorMessage});
-}
-
 /**
  * Save the source that triggered the KYC wall and optionally the chat report ID associated with the IOU
  */
@@ -304,7 +300,6 @@ export {
     openInitialSettingsPage,
     openEnablePaymentsPage,
     setAdditionalDetailsErrors,
-    setAdditionalDetailsErrorMessage,
     setAdditionalDetailsQuestions,
     updateCurrentStep,
     answerQuestionsForWallet,

src/libs/models/BankAccount.ts

@@ -1,7 +1,7 @@
 import Str from 'expensify-common/lib/str';
 import type {ValueOf} from 'type-fest';
 import CONST from '@src/CONST';
-import type {AdditionalData} from '@src/types/onyx/BankAccount';
+import type {BankAccountAdditionalData} from '@src/types/onyx/BankAccount';
 import type BankAccountJSON from '@src/types/onyx/BankAccount';
 
 type State = ValueOf<typeof BankAccount.STATE>;
@@ -194,7 +194,7 @@ class BankAccount {
     /**
      * Get the additional data of a bankAccount
      */
-    getAdditionalData(): Partial<AdditionalData> {
+    getAdditionalData(): Partial<BankAccountAdditionalData> {
         return this.json.accountData?.additionalData ?? {};
     }
 

src/pages/settings/Wallet/ExpensifyCardPage.tsx

@@ -32,7 +32,7 @@ import ROUTES from '@src/ROUTES';
 import type SCREENS from '@src/SCREENS';
 import type {GetPhysicalCardForm} from '@src/types/form';
 import type {LoginList, Card as OnyxCard, PrivatePersonalDetails} from '@src/types/onyx';
-import type {TCardDetails} from '@src/types/onyx/Card';
+import type {ExpensifyCardDetails} from '@src/types/onyx/Card';
 import RedDotCardSection from './RedDotCardSection';
 import CardDetails from './WalletPage/CardDetails';
 
@@ -101,7 +101,7 @@ function ExpensifyCardPage({
 
     const virtualCards = useMemo(() => cardsToShow?.filter((card) => card?.nameValuePairs?.isVirtual), [cardsToShow]);
     const physicalCards = useMemo(() => cardsToShow?.filter((card) => !card?.nameValuePairs?.isVirtual), [cardsToShow]);
-    const [cardsDetails, setCardsDetails] = useState<Record<number, TCardDetails | null>>({});
+    const [cardsDetails, setCardsDetails] = useState<Record<number, ExpensifyCardDetails | null>>({});
     const [isCardDetailsLoading, setIsCardDetailsLoading] = useState<Record<number, boolean>>({});
     const [cardsDetailsErrors, setCardsDetailsErrors] = useState<Record<number, string>>({});
 
@@ -116,7 +116,7 @@ function ExpensifyCardPage({
         // eslint-disable-next-line rulesdir/no-thenable-actions-in-views
         Card.revealVirtualCardDetails(revealedCardID)
             .then((value) => {
-                setCardsDetails((prevState: Record<number, TCardDetails | null>) => ({...prevState, [revealedCardID]: value as TCardDetails}));
+                setCardsDetails((prevState: Record<number, ExpensifyCardDetails | null>) => ({...prevState, [revealedCardID]: value}));
                 setCardsDetailsErrors((prevState) => ({
                     ...prevState,
                     [revealedCardID]: '',

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,7 @@
-import type {BankName} from './Bank';
+import type {BankAccountAdditionalData} from './BankAccount';
 import type * as OnyxCommon from './OnyxCommon';
 
-type AdditionalData = {
-    isP2PDebitCard?: boolean;
-    beneficialOwners?: string[];
-    currency?: string;
-    bankName?: BankName;
-    fieldsType?: string;
-    country?: string;
-};
-
+/** Model of bank account data */
 type AccountData = {
     /** The masked bank account number */
     accountNumber?: string;
@@ -38,20 +30,22 @@ 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 */
     bankAccountID?: number;
 
     /** All data related to the bank account */
-    additionalData?: AdditionalData;
+    additionalData?: BankAccountAdditionalData;
 
     /** The bank account type */
     type?: string;
 
     /** 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,45 @@ import type CONST from '@src/CONST';
 import type AccountData from './AccountData';
 import type * as OnyxCommon from './OnyxCommon';
 
-type AdditionalData = {
+/** Model of additional bank account data */
+type BankAccountAdditionalData = {
+    /** 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;
+
+    /** Whether the bank account details were obtained for local transfer or international wire */
     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,7 +56,8 @@ type BankAccount = OnyxCommon.OnyxValueWithOfflineFeedback<{
     errors?: OnyxCommon.Errors;
 }>;
 
+/** Record of bank accounts, indexed by bankAccountID */
 type BankAccountList = Record<string, BankAccount>;
 
 export default BankAccount;
-export type {AccountData, AdditionalData, BankAccountList};
+export type {AccountData, BankAccountAdditionalData, BankAccountList};

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;