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

src/types/onyx/Login.ts

@@ -1,6 +1,6 @@
 import type * as OnyxCommon from './OnyxCommon';
 
-type Login = OnyxCommon.OfflineFeedback<'defaultLogin' | 'validateLogin' | 'addedLogin' | 'deletedLogin' | 'validateCodeSent'> & {
+type Login = {
     /** Phone/Email associated with user */
     partnerUserID?: string;
 
@@ -17,7 +17,9 @@ type Login = OnyxCommon.OfflineFeedback<'defaultLogin' | 'validateLogin' | 'adde
     errorFields?: OnyxCommon.ErrorFields;
 };
 
-type LoginList = Record<string, Login>;
+type LoginWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<Login, keyof Login | 'defaultLogin' | 'validateLogin' | 'addedLogin' | 'deletedLogin'>;
 
-export default Login;
+type LoginList = Record<string, LoginWithOfflineFeedback>;
+
+export default LoginWithOfflineFeedback;
 export type {LoginList};

src/types/onyx/OnyxCommon.ts

@@ -4,7 +4,7 @@ import type CONST from '@src/CONST';
 
 type PendingAction = ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION> | null;
 
-type PendingFields<TKey extends string> = {[key in TKey]?: PendingAction};
+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  */
@@ -14,6 +14,8 @@ type OfflineFeedback<TKey extends string = string> = {
     pendingFields?: PendingFields<TKey>;
 };
 
+type OnyxItemWithOfflineFeedback<TOnyx, TKey extends string = string> = TOnyx & OfflineFeedback<TKey>;
+
 type ErrorFields<TKey extends string = string> = Record<TKey, Errors | null | undefined>;
 
 type Errors = Record<string, string>;
@@ -37,4 +39,4 @@ type Icon = {
     fallbackIcon?: AvatarSource;
 };
 
-export type {Icon, PendingAction, ErrorFields, Errors, AvatarType, OfflineFeedback};
+export type {Icon, PendingAction, ErrorFields, Errors, AvatarType, OfflineFeedback, OnyxItemWithOfflineFeedback};

src/types/onyx/PersonalDetails.ts

@@ -23,7 +23,7 @@ type Status = {
     clearAfter: string; // ISO 8601 format;
 };
 
-type PersonalDetails = OnyxCommon.OfflineFeedback<'avatar' | 'originalFileName'> & {
+type PersonalDetails = {
     /** ID of the current user from their personal details */
     accountID: number;
 
@@ -81,8 +81,10 @@ type PersonalDetails = OnyxCommon.OfflineFeedback<'avatar' | 'originalFileName'>
     status?: Status;
 };
 
-type PersonalDetailsList = Record<string, PersonalDetails | null>;
+type PersonalDetailsWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<PersonalDetails, keyof PersonalDetails>;
 
-export default PersonalDetails;
+type PersonalDetailsList = Record<string, PersonalDetailsWithOfflineFeedback | null>;
+
+export default PersonalDetailsWithOfflineFeedback;
 
 export type {Timezone, Status, SelectedTimezone, PersonalDetailsList};

src/types/onyx/Policy.ts

@@ -26,7 +26,7 @@ type CustomUnit = OnyxCommon.OfflineFeedback & {
 
 type AutoReportingOffset = number | ValueOf<typeof CONST.POLICY.AUTO_REPORTING_OFFSET>;
 
-type Policy = OnyxCommon.OfflineFeedback<'generalSettings' | 'avatar' | 'addWorkspaceRoom'> & {
+type Policy = {
     /** The ID of the policy */
     id: string;
 
@@ -106,6 +106,8 @@ type Policy = OnyxCommon.OfflineFeedback<'generalSettings' | 'avatar' | 'addWork
     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/Transaction.ts

@@ -49,7 +49,7 @@ type Route = {
 
 type Routes = Record<string, Route>;
 
-type Transaction = OnyxCommon.OfflineFeedback<'comment' | 'created' | 'amount' | 'currency' | 'merchant' | 'waypoints' | 'billable' | 'category' | 'tag'> & {
+type Transaction = {
     amount: number;
     billable: boolean;
     category: string;
@@ -94,5 +94,7 @@ type Transaction = OnyxCommon.OfflineFeedback<'comment' | 'created' | 'amount' |
     originalCurrency?: string;
 };
 
-export default Transaction;
+type TransactionWithOfflineFeedback = OnyxCommon.OnyxItemWithOfflineFeedback<Transaction, keyof Transaction | keyof Comment>;
+
+export default TransactionWithOfflineFeedback;
 export type {WaypointCollection, Comment, Receipt, Waypoint};