Replace address with addresses for private personal details

src/libs/GetPhysicalCardUtils.ts

@@ -9,7 +9,8 @@ import * as PersonalDetailsUtils from './PersonalDetailsUtils';
 import * as UserUtils from './UserUtils';
 
 function getCurrentRoute(domain: string, privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>): Route {
-    const {address, legalFirstName, legalLastName, phoneNumber} = privatePersonalDetails ?? {};
+    const {legalFirstName, legalLastName, phoneNumber} = privatePersonalDetails ?? {};
+    const address = PersonalDetailsUtils.getAddress(privatePersonalDetails);
 
     if (!legalFirstName && !legalLastName) {
         return ROUTES.SETTINGS_WALLET_CARD_GET_PHYSICAL_NAME.getRoute(domain);
@@ -55,7 +56,8 @@ function setCurrentRoute(currentRoute: string, domain: string, privatePersonalDe
  * @returns
  */
 function getUpdatedDraftValues(draftValues: OnyxEntry<GetPhysicalCardForm>, privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>, loginList: OnyxEntry<LoginList>): GetPhysicalCardForm {
-    const {address, legalFirstName, legalLastName, phoneNumber} = privatePersonalDetails ?? {};
+    const {legalFirstName, legalLastName, phoneNumber} = privatePersonalDetails ?? {};
+    const address = PersonalDetailsUtils.getAddress(privatePersonalDetails);
 
     return {
         /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
@@ -78,13 +80,13 @@ function getUpdatedDraftValues(draftValues: OnyxEntry<GetPhysicalCardForm>, priv
  * @param draftValues
  * @returns
  */
-function getUpdatedPrivatePersonalDetails(draftValues: OnyxEntry<GetPhysicalCardForm>): PrivatePersonalDetails {
+function getUpdatedPrivatePersonalDetails(draftValues: OnyxEntry<GetPhysicalCardForm>, privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>): PrivatePersonalDetails {
     const {addressLine1, addressLine2, city = '', country = '', legalFirstName, legalLastName, phoneNumber, state = '', zipPostCode = ''} = draftValues ?? {};
     return {
         legalFirstName,
         legalLastName,
         phoneNumber,
-        address: {street: PersonalDetailsUtils.getFormattedStreet(addressLine1, addressLine2), city, country, state, zip: zipPostCode},
+        addresses: [...(privatePersonalDetails?.addresses ?? []), {street: PersonalDetailsUtils.getFormattedStreet(addressLine1, addressLine2), city, country, state, zip: zipPostCode}],
     };
 }
 

src/libs/PersonalDetailsUtils.ts

@@ -4,6 +4,7 @@ import Onyx from 'react-native-onyx';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import type {OnyxInputOrEntry, PersonalDetails, PersonalDetailsList, PrivatePersonalDetails} from '@src/types/onyx';
+import type {Address} from '@src/types/onyx/PrivatePersonalDetails';
 import type {OnyxData} from '@src/types/onyx/Request';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';
 import * as LocalePhoneNumber from './LocalePhoneNumber';
@@ -224,14 +225,25 @@ function getStreetLines(street = '') {
     return [streets[0], streets[1]];
 }
 
+/**
+ * Get the current address from addresses array
+ *
+ * @param privatePersonalDetails - details object
+ * @returns - current address object
+ */
+function getAddress(privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>): Address | undefined {
+    const {addresses} = privatePersonalDetails ?? {};
+    return addresses?.[addresses.length - 1];
+}
+
 /**
  * Formats an address object into an easily readable string
  *
  * @param privatePersonalDetails - details object
  * @returns - formatted address
  */
 function getFormattedAddress(privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>): string {
-    const {address} = privatePersonalDetails ?? {};
+    const address = getAddress(privatePersonalDetails);
     const [street1, street2] = getStreetLines(address?.street);
     const formattedAddress =
         formatPiece(street1) + formatPiece(street2) + formatPiece(address?.city) + formatPiece(address?.state) + formatPiece(address?.zip) + formatPiece(address?.country);
@@ -318,6 +330,7 @@ export {
     getAccountIDsByLogins,
     getLoginsByAccountIDs,
     getPersonalDetailsOnyxDataForOptimisticUsers,
+    getAddress,
     getFormattedAddress,
     getFormattedStreet,
     getStreetLines,

src/libs/actions/PersonalDetails.ts

@@ -23,7 +23,7 @@ import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import ROUTES from '@src/ROUTES';
 import type {DateOfBirthForm} from '@src/types/form';
-import type {PersonalDetails, PersonalDetailsList} from '@src/types/onyx';
+import type {PersonalDetails, PersonalDetailsList, PrivatePersonalDetails} from '@src/types/onyx';
 import type {SelectedTimezone, Timezone} from '@src/types/onyx/PersonalDetails';
 
 let currentUserEmail = '';
@@ -42,6 +42,12 @@ Onyx.connect({
     callback: (val) => (allPersonalDetails = val),
 });
 
+let privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>;
+Onyx.connect({
+    key: ONYXKEYS.PRIVATE_PERSONAL_DETAILS,
+    callback: (val) => (privatePersonalDetails = val),
+});
+
 function updatePronouns(pronouns: string) {
     if (!currentUserAccountID) {
         return;
@@ -170,13 +176,16 @@ function updateAddress(street: string, street2: string, city: string, state: str
                 onyxMethod: Onyx.METHOD.MERGE,
                 key: ONYXKEYS.PRIVATE_PERSONAL_DETAILS,
                 value: {
-                    address: {
-                        street: PersonalDetailsUtils.getFormattedStreet(street, street2),
-                        city,
-                        state,
-                        zip,
-                        country,
-                    },
+                    addresses: [
+                        ...(privatePersonalDetails?.addresses ?? []),
+                        {
+                            street: PersonalDetailsUtils.getFormattedStreet(street, street2),
+                            city,
+                            state,
+                            zip,
+                            country,
+                        },
+                    ],
                 },
             },
         ],

src/libs/actions/Wallet.ts

@@ -11,6 +11,7 @@ import type {
 } from '@libs/API/parameters';
 import {READ_COMMANDS, WRITE_COMMANDS} from '@libs/API/types';
 import type {PrivatePersonalDetails} from '@libs/GetPhysicalCardUtils';
+import * as PersonalDetailsUtils from '@libs/PersonalDetailsUtils';
 import type CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import type {WalletAdditionalQuestionDetails} from '@src/types/onyx';
@@ -257,7 +258,8 @@ function answerQuestionsForWallet(answers: WalletQuestionAnswer[], idNumber: str
 }
 
 function requestPhysicalExpensifyCard(cardID: number, authToken: string, privatePersonalDetails: PrivatePersonalDetails) {
-    const {legalFirstName = '', legalLastName = '', phoneNumber = '', address: {city = '', country = '', state = '', street = '', zip = ''} = {}} = privatePersonalDetails;
+    const {legalFirstName = '', legalLastName = '', phoneNumber = ''} = privatePersonalDetails;
+    const {city = '', country = '', state = '', street = '', zip = ''} = PersonalDetailsUtils.getAddress(privatePersonalDetails) ?? {};
 
     const requestParams: RequestPhysicalExpensifyCardParams = {
         authToken,

src/pages/settings/Profile/PersonalDetails/PersonalAddressPage.tsx

@@ -4,6 +4,7 @@ import type {OnyxEntry} from 'react-native-onyx';
 import {withOnyx} from 'react-native-onyx';
 import useLocalize from '@hooks/useLocalize';
 import type {SettingsNavigatorParamList} from '@libs/Navigation/types';
+import * as PersonalDetailsUtils from '@libs/PersonalDetailsUtils';
 import AddressPage from '@pages/AddressPage';
 import * as PersonalDetails from '@userActions/PersonalDetails';
 import type {FormOnyxValues} from '@src/components/Form/types';
@@ -37,7 +38,7 @@ function updateAddress(values: FormOnyxValues<typeof ONYXKEYS.FORMS.HOME_ADDRESS
 
 function PersonalAddressPage({privatePersonalDetails, isLoadingApp = true}: PersonalAddressPageProps) {
     const {translate} = useLocalize();
-    const address = useMemo(() => privatePersonalDetails?.address, [privatePersonalDetails]);
+    const address = useMemo(() => PersonalDetailsUtils.getAddress(privatePersonalDetails), [privatePersonalDetails]);
 
     return (
         <AddressPage

src/pages/settings/Profile/ProfilePage.tsx

@@ -43,14 +43,16 @@ function ProfilePage({
         legalFirstName: '',
         legalLastName: '',
         dob: '',
-        address: {
-            street: '',
-            street2: '',
-            city: '',
-            state: '',
-            zip: '',
-            country: '',
-        },
+        addresses: [
+            {
+                street: '',
+                street2: '',
+                city: '',
+                state: '',
+                zip: '',
+                country: '',
+            },
+        ],
     },
     currentUserPersonalDetails,
     isLoadingApp,

src/pages/settings/Wallet/Card/BaseGetPhysicalCard.tsx

@@ -140,12 +140,12 @@ function BaseGetPhysicalCard({
         }
 
         // Redirect user to previous steps of the flow if he hasn't finished them yet
-        GetPhysicalCardUtils.setCurrentRoute(currentRoute, domain, GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(draftValues));
+        GetPhysicalCardUtils.setCurrentRoute(currentRoute, domain, GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(draftValues, privatePersonalDetails));
         isRouteSet.current = true;
     }, [cardList, currentRoute, domain, domainCards.length, draftValues, loginList, cardToBeIssued, privatePersonalDetails]);
 
     const onSubmit = useCallback(() => {
-        const updatedPrivatePersonalDetails = GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(draftValues);
+        const updatedPrivatePersonalDetails = GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(draftValues, privatePersonalDetails);
         // If the current step of the get physical card flow is the confirmation page
         if (isConfirmation) {
             Wallet.requestPhysicalExpensifyCard(cardToBeIssued?.cardID ?? -1, session?.authToken ?? '', updatedPrivatePersonalDetails);
@@ -156,7 +156,7 @@ function BaseGetPhysicalCard({
             return;
         }
         GetPhysicalCardUtils.goToNextPhysicalCardRoute(domain, updatedPrivatePersonalDetails);
-    }, [cardID, cardToBeIssued?.cardID, domain, draftValues, isConfirmation, session?.authToken]);
+    }, [cardID, cardToBeIssued?.cardID, domain, draftValues, isConfirmation, session?.authToken, privatePersonalDetails]);
     return (
         <ScreenWrapper
             shouldEnablePickerAvoiding={false}

src/pages/settings/Wallet/Card/GetPhysicalCardConfirm.tsx

@@ -77,13 +77,15 @@ function GetPhysicalCardConfirm({
                 onPress={() => goToGetPhysicalCardAddress(domain)}
                 shouldShowRightIcon
                 title={PersonalDetailsUtils.getFormattedAddress({
-                    address: {
-                        street: PersonalDetailsUtils.getFormattedStreet(addressLine1, addressLine2),
-                        city,
-                        state,
-                        zip: zipPostCode,
-                        country,
-                    },
+                    addresses: [
+                        {
+                            street: PersonalDetailsUtils.getFormattedStreet(addressLine1, addressLine2),
+                            city,
+                            state,
+                            zip: zipPostCode,
+                            country,
+                        },
+                    ],
                 })}
             />
         </BaseGetPhysicalCard>

src/pages/settings/Wallet/ExpensifyCardPage.tsx

@@ -146,7 +146,7 @@ function ExpensifyCardPage({
             FormActions.setDraftValues(ONYXKEYS.FORMS.GET_PHYSICAL_CARD_FORM, updatedDraftValues);
         }
 
-        GetPhysicalCardUtils.goToNextPhysicalCardRoute(domain, GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(updatedDraftValues));
+        GetPhysicalCardUtils.goToNextPhysicalCardRoute(domain, GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(updatedDraftValues, privatePersonalDetails));
     };
 
     if (isNotFound) {

src/pages/settings/Wallet/ReportCardLostPage.tsx

@@ -65,14 +65,16 @@ type ReportCardLostPageProps = ReportCardLostPageOnyxProps & StackScreenProps<Se
 
 function ReportCardLostPage({
     privatePersonalDetails = {
-        address: {
-            street: '',
-            street2: '',
-            city: '',
-            state: '',
-            zip: '',
-            country: '',
-        },
+        addresses: [
+            {
+                street: '',
+                street2: '',
+                city: '',
+                state: '',
+                zip: '',
+                country: '',
+            },
+        ],
     },
     cardList = {},
     route: {

src/pages/settings/Wallet/WalletPage/CardDetails.tsx

@@ -16,13 +16,15 @@ import ROUTES from '@src/ROUTES';
 import type {PrivatePersonalDetails} from '@src/types/onyx';
 
 const defaultPrivatePersonalDetails: PrivatePersonalDetails = {
-    address: {
-        street: '',
-        city: '',
-        state: '',
-        zip: '',
-        country: '',
-    },
+    addresses: [
+        {
+            street: '',
+            city: '',
+            state: '',
+            zip: '',
+            country: '',
+        },
+    ],
 };
 
 type CardDetailsOnyxProps = {

src/types/onyx/PrivatePersonalDetails.ts

@@ -56,8 +56,11 @@ type PrivatePersonalDetails = {
     /** User's phone number */
     phoneNumber?: string;
 
-    /** User's home address */
+    /** @deprecated User's home address */
     address?: Address;
+
+    /** User's home address history. The most recent address is the last item in the array */
+    addresses?: Address[];
 };
 
 export default PrivatePersonalDetails;