[No QA] [TS Migration] Standardize approach to Onyx pendingFields

src/libs/SidebarUtils.ts

@@ -234,7 +234,7 @@ function getOptionData({
     result.isExpenseRequest = ReportUtils.isExpenseRequest(report);
     result.isMoneyRequestReport = ReportUtils.isMoneyRequestReport(report);
     result.shouldShowSubscript = ReportUtils.shouldReportShowSubscript(report);
-    result.pendingAction = report.pendingFields ? report.pendingFields.addWorkspaceRoom || report.pendingFields.createChat : undefined;
+    result.pendingAction = report.pendingFields?.addWorkspaceRoom ?? report.pendingFields?.createChat;
     result.brickRoadIndicator = hasErrors || hasViolations ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';
     result.ownerAccountID = report.ownerAccountID;
     result.managerID = report.managerID;

src/libs/actions/IOU.ts

@@ -50,7 +50,7 @@ import ROUTES from '@src/ROUTES';
 import type SCREENS from '@src/SCREENS';
 import type * as OnyxTypes from '@src/types/onyx';
 import type {Participant, Split} from '@src/types/onyx/IOU';
-import type {ErrorFields, Errors, PendingFields} from '@src/types/onyx/OnyxCommon';
+import type {ErrorFields, Errors} from '@src/types/onyx/OnyxCommon';
 import type {PaymentMethodType} from '@src/types/onyx/OriginalMessage';
 import type ReportAction from '@src/types/onyx/ReportAction';
 import type {OnyxData} from '@src/types/onyx/Request';
@@ -302,7 +302,7 @@ function setMoneyRequestMerchant(transactionID: string, merchant: string, isDraf
     Onyx.merge(`${isDraft ? ONYXKEYS.COLLECTION.TRANSACTION_DRAFT : ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {merchant});
 }
 
-function setMoneyRequestPendingFields(transactionID: string, pendingFields: PendingFields) {
+function setMoneyRequestPendingFields(transactionID: string, pendingFields: OnyxTypes.Transaction['pendingFields']) {
     Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION_DRAFT}${transactionID}`, {pendingFields});
 }
 

src/types/onyx/BankAccount.ts

@@ -11,7 +11,7 @@ type AdditionalData = {
     country?: string;
 };
 
-type BankAccount = {
+type BankAccount = OnyxCommon.OnyxValueWithOfflineFeedback<{
     /** The bank account type */
     accountType?: typeof CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT;
 
@@ -40,10 +40,7 @@ type BankAccount = {
 
     /** Any additional error message to show */
     errors?: OnyxCommon.Errors;
-
-    /** Indicates the type of change made to the bank account that hasn't been synced with the server yet  */
-    pendingAction?: OnyxCommon.PendingAction;
-};
+}>;
 
 type BankAccountList = Record<string, BankAccount>;
 

src/types/onyx/Fund.ts

@@ -25,7 +25,7 @@ type AccountData = {
     bank?: BankName;
 };
 
-type Fund = {
+type Fund = OnyxCommon.OnyxValueWithOfflineFeedback<{
     accountData?: AccountData;
     accountType?: typeof CONST.PAYMENT_METHODS.DEBIT_CARD;
     description?: string;
@@ -34,8 +34,7 @@ type Fund = {
     title?: string;
     isDefault?: boolean;
     errors?: OnyxCommon.Errors;
-    pendingAction?: OnyxCommon.PendingAction;
-};
+}>;
 
 type FundList = Record<string, Fund>;
 

src/types/onyx/Login.ts

@@ -1,24 +1,24 @@
 import type * as OnyxCommon from './OnyxCommon';
 
-type Login = {
-    /** Phone/Email associated with user */
-    partnerUserID?: string;
+type Login = OnyxCommon.OnyxValueWithOfflineFeedback<
+    {
+        /** Phone/Email associated with user */
+        partnerUserID?: string;
 
-    /** Value of partner name */
-    partnerName?: string;
+        /** Value of partner name */
+        partnerName?: string;
 
-    /** Date login was validated, used to show info indicator status */
-    validatedDate?: string;
+        /** Date login was validated, used to show info indicator status */
+        validatedDate?: string;
 
-    /** Whether the user validation code was sent */
-    validateCodeSent?: boolean;
+        /** Whether the user validation code was sent */
+        validateCodeSent?: boolean;
 
-    /** Field-specific server side errors keyed by microtime */
-    errorFields?: OnyxCommon.ErrorFields;
-
-    /** Field-specific pending states for offline UI status */
-    pendingFields?: OnyxCommon.PendingFields;
-};
+        /** Field-specific server side errors keyed by microtime */
+        errorFields?: OnyxCommon.ErrorFields;
+    },
+    'defaultLogin' | 'validateLogin' | 'addedLogin' | 'deletedLogin'
+>;
 
 type LoginList = Record<string, Login>;
 

src/types/onyx/OnyxCommon.ts

@@ -3,9 +3,19 @@ import type {MaybePhraseKey} from '@libs/Localize';
 import type {AvatarSource} from '@libs/UserUtils';
 import type CONST from '@src/CONST';
 
-type PendingAction = ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION>;
+type PendingAction = ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION> | null;
 
-type PendingFields<TKey extends string = string> = Record<TKey, PendingAction | null | undefined>;
+type PendingFields<TKey extends string> = {[key in Exclude<TKey, 'pendingAction' | 'pendingFields' | 'errorFields'>]?: PendingAction};
+
+type OfflineFeedback<TKey extends string> = {
+    /** The type of action that's pending  */
+    pendingAction?: PendingAction;
+
+    /** Field-specific pending states for offline updates */
+    pendingFields?: PendingFields<TKey>;
+};
+
+type OnyxValueWithOfflineFeedback<TOnyx, TKey extends string = never> = keyof TOnyx extends string ? TOnyx & OfflineFeedback<keyof TOnyx | TKey> : never;
 
 type ErrorFields<TKey extends string = string> = Record<TKey, Errors | null | undefined>;
 
@@ -33,4 +43,4 @@ type Icon = {
     fill?: string;
 };
 
-export type {Icon, PendingAction, PendingFields, ErrorFields, Errors, AvatarType};
+export type {Icon, PendingAction, ErrorFields, Errors, AvatarType, OnyxValueWithOfflineFeedback};

src/types/onyx/PersonalDetails.ts

@@ -23,7 +23,7 @@ type Status = {
     clearAfter: string; // ISO 8601 format;
 };
 
-type PersonalDetails = {
+type PersonalDetails = OnyxCommon.OnyxValueWithOfflineFeedback<{
     /** ID of the current user from their personal details */
     accountID: number;
 
@@ -74,15 +74,12 @@ type PersonalDetails = {
     /** Field-specific server side errors keyed by microtime */
     errorFields?: OnyxCommon.ErrorFields<'avatar'>;
 
-    /** Field-specific pending states for offline UI status */
-    pendingFields?: OnyxCommon.PendingFields<'avatar' | 'originalFileName'>;
-
     /** A fallback avatar icon to display when there is an error on loading avatar from remote URL. */
     fallbackIcon?: string;
 
     /** Status of the current user from their personal details */
     status?: Status;
-};
+}>;
 
 type PersonalDetailsList = Record<string, PersonalDetails | null>;