Merge pull request #27138 from kubabutkiewicz/ts-migration/Transactio…

…n-lib

[No QA] [TS Migration] Transaction lib

src/ONYXKEYS.ts

@@ -329,7 +329,7 @@ type OnyxValues = {
     [ONYXKEYS.NVP_BLOCKED_FROM_CONCIERGE]: OnyxTypes.BlockedFromConcierge;
     [ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID]: string;
     [ONYXKEYS.NVP_LAST_PAYMENT_METHOD]: Record<string, string>;
-    [ONYXKEYS.NVP_RECENT_WAYPOINTS]: OnyxTypes.RecentWaypoints[];
+    [ONYXKEYS.NVP_RECENT_WAYPOINTS]: OnyxTypes.RecentWaypoint[];
     [ONYXKEYS.PUSH_NOTIFICATIONS_ENABLED]: boolean;
     [ONYXKEYS.PLAID_DATA]: OnyxTypes.PlaidData;
     [ONYXKEYS.IS_PLAID_DISABLED]: boolean;

src/libs/actions/Transaction.js → src/libs/actions/Transaction.ts

@@ -1,19 +1,20 @@
-import _ from 'underscore';
 import Onyx from 'react-native-onyx';
-import lodashGet from 'lodash/get';
 import lodashHas from 'lodash/has';
+import lodashClone from 'lodash/clone';
 import ONYXKEYS from '../../ONYXKEYS';
 import * as CollectionUtils from '../CollectionUtils';
 import * as API from '../API';
+import {RecentWaypoint, Transaction} from '../../types/onyx';
+import {WaypointCollection} from '../../types/onyx/Transaction';
 import * as TransactionUtils from '../TransactionUtils';
 
-let recentWaypoints = [];
+let recentWaypoints: RecentWaypoint[] = [];
 Onyx.connect({
     key: ONYXKEYS.NVP_RECENT_WAYPOINTS,
-    callback: (val) => (recentWaypoints = val || []),
+    callback: (val) => (recentWaypoints = val ?? []),
 });
 
-const allTransactions = {};
+const allTransactions: Record<string, Transaction> = {};
 Onyx.connect({
     key: ONYXKEYS.COLLECTION.TRANSACTION,
     callback: (transaction, key) => {
@@ -25,10 +26,7 @@ Onyx.connect({
     },
 });
 
-/**
- * @param {String} transactionID
- */
-function createInitialWaypoints(transactionID) {
+function createInitialWaypoints(transactionID: string) {
     Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {
         comment: {
             waypoints: {
@@ -41,14 +39,11 @@ function createInitialWaypoints(transactionID) {
 
 /**
  * Add a stop to the transaction
- *
- * @param {String} transactionID
- * @param {Number} newLastIndex
  */
-function addStop(transactionID) {
-    const transaction = lodashGet(allTransactions, transactionID, {});
-    const existingWaypoints = lodashGet(transaction, 'comment.waypoints', {});
-    const newLastIndex = _.size(existingWaypoints);
+function addStop(transactionID: string) {
+    const transaction = allTransactions?.[transactionID] ?? {};
+    const existingWaypoints = transaction?.comment?.waypoints ?? {};
+    const newLastIndex = Object.keys(existingWaypoints).length;
 
     Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {
         comment: {
@@ -61,11 +56,8 @@ function addStop(transactionID) {
 
 /**
  * Saves the selected waypoint to the transaction
- * @param {String} transactionID
- * @param {String} index
- * @param {Object} waypoint
  */
-function saveWaypoint(transactionID, index, waypoint) {
+function saveWaypoint(transactionID: string, index: string, waypoint: RecentWaypoint | null) {
     Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {
         comment: {
             waypoints: {
@@ -93,41 +85,39 @@ function saveWaypoint(transactionID, index, waypoint) {
     if (!lodashHas(waypoint, 'lat') || !lodashHas(waypoint, 'lng')) {
         return;
     }
-
-    const recentWaypointAlreadyExists = _.find(recentWaypoints, (recentWaypoint) => recentWaypoint.address === waypoint.address);
-    if (!recentWaypointAlreadyExists) {
-        const clonedWaypoints = _.clone(recentWaypoints);
+    const recentWaypointAlreadyExists = recentWaypoints.find((recentWaypoint) => recentWaypoint?.address === waypoint?.address);
+    if (!recentWaypointAlreadyExists && waypoint !== null) {
+        const clonedWaypoints = lodashClone(recentWaypoints);
         clonedWaypoints.unshift(waypoint);
         Onyx.merge(ONYXKEYS.NVP_RECENT_WAYPOINTS, clonedWaypoints.slice(0, 5));
     }
 }
 
-function removeWaypoint(transactionID, currentIndex) {
+function removeWaypoint(transactionID: string, currentIndex: string) {
     // Index comes from the route params and is a string
     const index = Number(currentIndex);
-    const transaction = lodashGet(allTransactions, transactionID, {});
-    const existingWaypoints = lodashGet(transaction, 'comment.waypoints', {});
-    const totalWaypoints = _.size(existingWaypoints);
-
+    const transaction = allTransactions?.[transactionID] ?? {};
+    const existingWaypoints = transaction?.comment?.waypoints ?? {};
+    const totalWaypoints = Object.keys(existingWaypoints).length;
     // Prevents removing the starting or ending waypoint but clear the stored address only if there are only two waypoints
     if (totalWaypoints === 2 && (index === 0 || index === totalWaypoints - 1)) {
-        saveWaypoint(transactionID, index, null);
+        saveWaypoint(transactionID, index.toString(), null);
         return;
     }
 
-    const waypointValues = _.values(existingWaypoints);
+    const waypointValues = Object.values(existingWaypoints);
     const removed = waypointValues.splice(index, 1);
-    const isRemovedWaypointEmpty = removed.length > 0 && !TransactionUtils.waypointHasValidAddress(removed[0]);
+    const isRemovedWaypointEmpty = removed.length > 0 && !TransactionUtils.waypointHasValidAddress(removed[0] ?? {});
 
-    const reIndexedWaypoints = {};
+    const reIndexedWaypoints: WaypointCollection = {};
     waypointValues.forEach((waypoint, idx) => {
         reIndexedWaypoints[`waypoint${idx}`] = waypoint;
     });
 
     // Onyx.merge won't remove the null nested object values, this is a workaround
     // to remove nested keys while also preserving other object keys
     // Doing a deep clone of the transaction to avoid mutating the original object and running into a cache issue when using Onyx.set
-    let newTransaction = {
+    let newTransaction: Transaction = {
         ...transaction,
         comment: {
             ...transaction.comment,
@@ -145,6 +135,7 @@ function removeWaypoint(transactionID, currentIndex) {
             // Clear the existing route so that we don't show an old route
             routes: {
                 route0: {
+                    distance: null,
                     geometry: {
                         coordinates: null,
                     },
@@ -158,10 +149,8 @@ function removeWaypoint(transactionID, currentIndex) {
 /**
  * Gets the route for a set of waypoints
  * Used so we can generate a map view of the provided waypoints
- * @param {String} transactionID
- * @param {Object} waypoints
  */
-function getRoute(transactionID, waypoints) {
+function getRoute(transactionID: string, waypoints: WaypointCollection) {
     API.read(
         'GetRoute',
         {

src/types/onyx/OnyxCommon.ts

@@ -4,7 +4,7 @@ import CONST from '../../CONST';
 
 type PendingAction = ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION>;
 
-type ErrorFields = Record<string | number, Record<string, string>>;
+type ErrorFields = Record<string | number, Record<string, string> | null>;
 
 type Errors = Record<string, string>;
 

src/types/onyx/RecentWaypoints.ts → src/types/onyx/RecentWaypoint.ts

@@ -1,4 +1,4 @@
-type RecentWaypoints = {
+type RecentWaypoint = {
     /** The full address of the waypoint */
     address: string;
 
@@ -9,4 +9,4 @@ type RecentWaypoints = {
     lng: number;
 };
 
-export default RecentWaypoints;
+export default RecentWaypoint;

src/types/onyx/Transaction.ts

@@ -1,18 +1,23 @@
 import {ValueOf} from 'type-fest';
 import * as OnyxCommon from './OnyxCommon';
 import CONST from '../../CONST';
+import RecentWaypoint from './RecentWaypoint';
 
+type WaypointCollection = Record<string, RecentWaypoint | null>;
 type Comment = {
     comment?: string;
+    waypoints?: WaypointCollection;
 };
 
+type GeometryType = 'LineString';
+
 type Geometry = {
-    coordinates: number[][];
-    type: 'LineString';
+    coordinates: number[][] | null;
+    type?: GeometryType;
 };
 
 type Route = {
-    distance: number;
+    distance: number | null;
     geometry: Geometry;
 };
 
@@ -25,6 +30,7 @@ type Transaction = {
     created: string;
     currency: string;
     errors: OnyxCommon.Errors;
+    errorFields?: OnyxCommon.ErrorFields;
     // The name of the file used for a receipt (formerly receiptFilename)
     filename?: string;
     merchant: string;
@@ -44,3 +50,4 @@ type Transaction = {
 };
 
 export default Transaction;
+export type {WaypointCollection};

src/types/onyx/index.ts

@@ -41,7 +41,7 @@ import ReportActionReactions from './ReportActionReactions';
 import SecurityGroup from './SecurityGroup';
 import Transaction from './Transaction';
 import Form, {AddDebitCardForm} from './Form';
-import RecentWaypoints from './RecentWaypoints';
+import RecentWaypoint from './RecentWaypoint';
 import RecentlyUsedCategories from './RecentlyUsedCategories';
 import RecentlyUsedTags from './RecentlyUsedTags';
 import PolicyTag from './PolicyTag';
@@ -91,8 +91,8 @@ export type {
     Form,
     AddDebitCardForm,
     OnyxUpdatesFromServer,
+    RecentWaypoint,
     OnyxUpdateEvent,
-    RecentWaypoints,
     RecentlyUsedCategories,
     RecentlyUsedTags,
     PolicyTag,