Updated types, introduces Waypoints type

Expensify · Oct 17, 2023 · 01016dc · 01016dc
1 parent 61574b7
commit 01016dc
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/src/libs/TransactionUtils.ts b/src/libs/TransactionUtils.ts
@@ -6,7 +6,7 @@ import DateUtils from './DateUtils';
 import {isExpensifyCard} from './CardUtils';
 import * as NumberUtils from './NumberUtils';
 import {RecentWaypoint, ReportAction, Transaction} from '../types/onyx';
-import {Receipt, Comment, WaypointCollection} from '../types/onyx/Transaction';
+import {Receipt, Comment, WaypointCollection, Waypoint} from '../types/onyx/Transaction';
 
 type AdditionalTransactionChanges = {comment?: string; waypoints?: WaypointCollection};
 
@@ -399,7 +399,7 @@ function getAllReportTransactions(reportID?: string): Transaction[] {
 /**
  * Checks if a waypoint has a valid address
  */
-function waypointHasValidAddress(waypoint: RecentWaypoint | Record<string, never>): boolean {
+function waypointHasValidAddress(waypoint: RecentWaypoint | Waypoint): boolean {
     return !!waypoint?.address?.trim();
 }
 

diff --git a/src/libs/actions/Transaction.ts b/src/libs/actions/Transaction.ts
@@ -110,14 +110,13 @@ function removeWaypoint(transactionID: string, currentIndex: string) {
 
     const waypointValues = Object.values(existingWaypoints);
     const removed = waypointValues.splice(index, 1);
+    const isRemovedWaypointEmpty = removed.length > 0 && !TransactionUtils.waypointHasValidAddress(removed[0] ?? {});
 
     // When there are only two waypoints we are adding empty waypoint back
     if (totalWaypoints === 2 && (index === 0 || index === totalWaypoints - 1)) {
         waypointValues.splice(index, 0, {});
     }
 
-    const isRemovedWaypointEmpty = removed.length > 0 && !TransactionUtils.waypointHasValidAddress(removed[0] ?? {});
-
     const reIndexedWaypoints: WaypointCollection = {};
     waypointValues.forEach((waypoint, idx) => {
         reIndexedWaypoints[`waypoint${idx}`] = waypoint;

diff --git a/src/types/onyx/Transaction.ts b/src/types/onyx/Transaction.ts
@@ -3,8 +3,18 @@ import * as OnyxCommon from './OnyxCommon';
 import CONST from '../../CONST';
 import RecentWaypoint from './RecentWaypoint';
 
-// Default waypoint will be `{}`(empty object), that is why we are using Record<string, never>
-type WaypointCollection = Record<string, RecentWaypoint | Record<string, never>>;
+type Waypoint = {
+    /** The full address of the waypoint */
+    address?: string;
+
+    /** The lattitude of the waypoint */
+    lat?: number;
+
+    /** The longitude of the waypoint */
+    lng?: number;
+};
+
+type WaypointCollection = Record<string, RecentWaypoint | Waypoint>;
 type Comment = {
     comment?: string;
     waypoints?: WaypointCollection;
@@ -78,4 +88,4 @@ type Transaction = {
 };
 
 export default Transaction;
-export type {WaypointCollection, Comment, Receipt};
+export type {WaypointCollection, Comment, Receipt, Waypoint};