feat(itinerary): add ability to sort itineraries by fare

i18n/en-US.yml

@@ -372,6 +372,7 @@ components:
     selectCost: Cost
     selectDepartureTime: Departure time
     selectDuration: Duration
+    selectFare: Fare
     selectWalkTime: Walk time
     sortResults: Sort results
     viewAll: View all options

lib/components/util/sortOptions.ts

@@ -12,7 +12,8 @@ export const sortOptions = (
     'ARRIVALTIME',
     'WALKTIME',
     'COST',
-    'DEPARTURETIME'
+    'DEPARTURETIME',
+    'FARE'
   ]
 ): SortOptionEntry[] => {
   const sortOptionsArray: SortOptionEntry[] = [
@@ -51,6 +52,12 @@ export const sortOptions = (
         id: 'components.NarrativeItinerariesHeader.selectCost'
       }),
       value: 'COST'
+    },
+    {
+      text: intl.formatMessage({
+        id: 'components.NarrativeItinerariesHeader.selectFare'
+      }),
+      value: 'FARE'
     }
   ]
 

lib/util/config-types.ts

@@ -264,6 +264,7 @@ export type ItinerarySortOption =
   | 'WALKTIME'
   | 'COST'
   | 'DEPARTURETIME'
+  | 'FARE'
 
 export interface ItineraryCostWeights {
   driveReluctance: number

lib/util/itinerary.tsx

@@ -48,6 +48,7 @@ export interface ItineraryWithCO2Info extends Itinerary {
 export interface ItineraryWithSortingCosts extends Itinerary {
   rank: number
   totalFare: number
+  transitFare?: number
 }
 
 export interface ItineraryFareSummary {
@@ -453,10 +454,12 @@ export function addSortingCosts<T extends Itinerary>(
     totalFareResult === null ? Number.MAX_VALUE : totalFareResult
 
   const rank = calculateItineraryCost(itinerary, config)
+  const transitFare = getFare(itinerary).transitFare || 0
   return {
     ...itinerary,
     rank,
-    totalFare
+    totalFare,
+    transitFare
   }
 }
 

lib/util/state.js

@@ -50,6 +50,8 @@ export function sortItineraries(type, direction, a, b, config) {
       return dirFactor * (a.duration - b.duration)
     case 'COST':
       return dirFactor * (a.totalFare - b.totalFare)
+    case 'FARE':
+      return dirFactor * (a.transitFare - b.transitFare)
     default:
       if (type !== 'BEST')
         console.warn(`Sort (${type}) not supported. Defaulting to BEST.`)