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

src/libs/SidebarUtils.ts

@@ -316,7 +316,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 ? report.pendingFields.addWorkspaceRoom ?? report.pendingFields.createChat : undefined;
     result.allReportErrors = OptionsListUtils.getAllReportErrors(report, reportActions) as OnyxCommon.Errors;
     result.brickRoadIndicator = hasErrors || hasViolations ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';
     result.ownerAccountID = report.ownerAccountID;

src/types/onyx/BankAccount.ts

@@ -11,7 +11,7 @@ type AdditionalData = {
     country?: string;
 };
 
-type BankAccount = {
+type BankAccount = OnyxCommon.OfflineFeedback & {
     /** The bank account type */
     accountType?: typeof CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT;
 
@@ -40,9 +40,6 @@ 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.OfflineFeedback & {
     accountData?: AccountData;
     accountType?: typeof CONST.PAYMENT_METHODS.DEBIT_CARD;
     description?: string;
@@ -34,7 +34,6 @@ type Fund = {
     title?: string;
     isDefault?: boolean;
     errors?: OnyxCommon.Errors;
-    pendingAction?: OnyxCommon.PendingAction;
 };
 
 type FundList = Record<string, Fund>;

src/types/onyx/Login.ts

@@ -15,12 +15,11 @@ type Login = {
 
     /** Field-specific server side errors keyed by microtime */
     errorFields?: OnyxCommon.ErrorFields;
-
-    /** Field-specific pending states for offline UI status */
-    pendingFields?: OnyxCommon.PendingFields;
 };
 
-type LoginList = Record<string, Login>;
+type LoginWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<Login, keyof Login | 'defaultLogin' | 'validateLogin' | 'addedLogin' | 'deletedLogin'>;
+
+type LoginList = Record<string, LoginWithOfflineFeedback>;
 
-export default Login;
+export default LoginWithOfflineFeedback;
 export type {LoginList};

src/types/onyx/OnyxCommon.ts

@@ -2,9 +2,19 @@ import type {ValueOf} from 'type-fest';
 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'>]?: PendingAction};
+
+type OfflineFeedback<TKey extends string = string> = {
+    /** The type of action that's pending  */
+    pendingAction?: PendingAction;
+
+    /** Field-specific pending states for offline updates */
+    pendingFields?: PendingFields<TKey>;
+};
+
+type OnyxItemWithOfflineFeedback<TOnyx, TKey extends string = string> = TOnyx & OfflineFeedback<TKey>;
 
 type ErrorFields<TKey extends string = string> = Record<TKey, Errors | null | undefined>;
 
@@ -29,4 +39,4 @@ type Icon = {
     fallbackIcon?: AvatarSource;
 };
 
-export type {Icon, PendingAction, PendingFields, ErrorFields, Errors, AvatarType};
+export type {Icon, PendingAction, ErrorFields, Errors, AvatarType, OfflineFeedback, OnyxItemWithOfflineFeedback};

src/types/onyx/PersonalDetails.ts

@@ -74,18 +74,17 @@ 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>;
+type PersonalDetailsWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<PersonalDetails, keyof PersonalDetails>;
+
+type PersonalDetailsList = Record<string, PersonalDetailsWithOfflineFeedback | null>;
 
-export default PersonalDetails;
+export default PersonalDetailsWithOfflineFeedback;
 
 export type {Timezone, Status, SelectedTimezone, PersonalDetailsList};

src/types/onyx/Policy.ts

@@ -4,25 +4,23 @@ import type * as OnyxCommon from './OnyxCommon';
 
 type Unit = 'mi' | 'km';
 
-type Rate = {
+type Rate = OnyxCommon.OfflineFeedback & {
     name?: string;
     rate?: number;
     currency?: string;
     customUnitRateID?: string;
     errors?: OnyxCommon.Errors;
-    pendingAction?: string;
 };
 
 type Attributes = {
     unit: Unit;
 };
 
-type CustomUnit = {
+type CustomUnit = OnyxCommon.OfflineFeedback & {
     name: string;
     customUnitID: string;
     attributes: Attributes;
     rates: Record<string, Rate>;
-    pendingAction?: string;
     errors?: OnyxCommon.Errors;
 };
 
@@ -56,9 +54,6 @@ type Policy = {
     /** Error objects keyed by field name containing errors keyed by microtime */
     errorFields?: OnyxCommon.ErrorFields;
 
-    /** Indicates the type of change made to the policy that hasn't been synced with the server yet  */
-    pendingAction?: OnyxCommon.PendingAction;
-
     /** A list of errors keyed by microtime */
     errors?: OnyxCommon.Errors;
 
@@ -101,9 +96,6 @@ type Policy = {
     /** Whether to leave the calling account as an admin on the policy */
     makeMeAdmin?: boolean;
 
-    /** Pending fields for the policy */
-    pendingFields?: Record<string, unknown>;
-
     /** Original file name which is used for the policy avatar */
     originalFileName?: string;
 
@@ -114,6 +106,8 @@ type Policy = {
     primaryLoginsInvited?: Record<string, string>;
 };
 
-export default Policy;
+type PolicyWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<Policy, keyof Policy | 'generalSettings' | 'addWorkspaceRoom'>;
+
+export default PolicyWithOfflineFeedback;
 
 export type {Unit, CustomUnit};

src/types/onyx/PolicyMember.ts

@@ -1,6 +1,6 @@
 import type * as OnyxCommon from './OnyxCommon';
 
-type PolicyMember = {
+type PolicyMember = OnyxCommon.OfflineFeedback & {
     /** Role of the user in the policy */
     role?: string;
 
@@ -9,9 +9,6 @@ type PolicyMember = {
      * {<timestamp>: 'error message', <timestamp2>: 'error message 2'}
      */
     errors?: OnyxCommon.Errors;
-
-    /** Is this action pending? */
-    pendingAction?: OnyxCommon.PendingAction;
 };
 
 type PolicyMembers = Record<string, PolicyMember>;

src/types/onyx/ReimbursementAccount.ts

@@ -20,7 +20,7 @@ type ACHData = {
     bankAccountID?: number;
 };
 
-type ReimbursementAccount = {
+type ReimbursementAccount = OnyxCommon.OfflineFeedback & {
     /** Whether we are loading the data via the API */
     isLoading?: boolean;
 
@@ -44,8 +44,6 @@ type ReimbursementAccount = {
 
     /** Draft step of the setup flow from Onyx */
     draftStep?: BankAccountStep;
-
-    pendingAction?: OnyxCommon.PendingAction;
 };
 
 export default ReimbursementAccount;

src/types/onyx/Report.ts

@@ -2,18 +2,18 @@ import type {ValueOf} from 'type-fest';
 import type CONST from '@src/CONST';
 import type * as OnyxCommon from './OnyxCommon';
 import type PersonalDetails from './PersonalDetails';
+import type PolicyReportField from './PolicyReportField';
 
 type NotificationPreference = ValueOf<typeof CONST.REPORT.NOTIFICATION_PREFERENCE>;
 
 type WriteCapability = ValueOf<typeof CONST.REPORT.WRITE_CAPABILITIES>;
 
-type Note = {
+type Note = OnyxCommon.OfflineFeedback & {
     note: string;
     errors?: OnyxCommon.Errors;
-    pendingAction?: OnyxCommon.PendingAction;
 };
 
-type Report = {
+type Report = OnyxCommon.OfflineFeedback<PolicyReportField['fieldID']> & {
     /** The specific type of chat */
     chatType?: ValueOf<typeof CONST.REPORT.CHAT_TYPE>;
 
@@ -140,12 +140,6 @@ type Report = {
     /** Total amount of money owed for IOU report */
     iouReportAmount?: number;
 
-    /** Is this action pending? */
-    pendingAction?: OnyxCommon.PendingAction;
-
-    /** Pending fields for the report */
-    pendingFields?: Record<string, OnyxCommon.PendingAction>;
-
     /** The ID of the preexisting report (it is possible that we optimistically created a Report for which a report already exists) */
     preexistingReportID?: string;
 

src/types/onyx/ReportAction.ts

@@ -98,7 +98,7 @@ type Person = {
     text?: string;
 };
 
-type ReportActionBase = {
+type ReportActionBase = OnyxCommon.OfflineFeedback & {
     /** The ID of the reportAction. It is the string representation of the a 64-bit integer. */
     reportActionID: string;
 
@@ -173,8 +173,6 @@ type ReportActionBase = {
     /** ISO-formatted datetime */
     lastModified?: string;
 
-    /** Is this action pending? */
-    pendingAction?: OnyxCommon.PendingAction;
     delegateAccountID?: string;
 
     /** Server side errors keyed by microtime */

src/types/onyx/ReportActionReactions.ts

@@ -13,7 +13,7 @@ type UserReaction = {
 
 type UsersReactions = Record<string, UserReaction>;
 
-type ReportActionReaction = {
+type ReportActionReaction = OnyxCommon.OfflineFeedback & {
     /** The time the emoji was added */
     createdAt: string;
 
@@ -22,9 +22,6 @@ type ReportActionReaction = {
 
     /** All the users who have added this emoji */
     users: UsersReactions;
-
-    /** Is this action pending? */
-    pendingAction?: OnyxCommon.PendingAction;
 };
 
 type ReportActionReactions = Record<string, ReportActionReaction>;

src/types/onyx/Transaction.ts

@@ -70,13 +70,11 @@ type Transaction = {
     modifiedWaypoints?: WaypointCollection;
     // Used during the creation flow before the transaction is saved to the server and helps dictate where the user is navigated to when pressing the back button on the confirmation step
     participantsAutoAssigned?: boolean;
-    pendingAction: OnyxCommon.PendingAction;
     receipt?: Receipt;
     reportID: string;
     routes?: Routes;
     transactionID: string;
     tag: string;
-    pendingFields?: Partial<{[K in keyof Transaction | keyof Comment]: ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION>}>;
 
     /** Card Transactions */
 
@@ -96,5 +94,7 @@ type Transaction = {
     originalCurrency?: string;
 };
 
-export default Transaction;
+type TransactionWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<Transaction, keyof Transaction | keyof Comment>;
+
+export default TransactionWithOfflineFeedback;
 export type {WaypointCollection, Comment, Receipt, Waypoint};