feat(fares-v2): add support for editing feeds with fares v2 data

gtfs.yml

@@ -233,7 +233,12 @@
       text: Not possible (2)
     columnWidth: 12
     helpContent: "The wheelchair_boarding field identifies whether wheelchair boardings are possible from the specified stop or station. The field can have the following values:"
-
+  - name: "stop_area_ids"
+    required: false
+    inputType: GTFS_STOP_AREA
+    bulkEditEnabled: true
+    columnWidth: 12
+    helpContent: "The area_id field defines the area that this stop belongs to. This is used to group stops together in a logical way, such as all stops in a particular neighborhood or district. If this stop is not part of an area, leave this field blank."
 
 - id: route
   name: routes.txt
@@ -549,6 +554,18 @@
     inputType: URL
     columnWidth: 12
     helpContent:
+  - name: network_id
+    required: false
+    inputType: GTFS_NETWORK
+    bulkEditEnabled: true
+    columnWidth: 12
+    helpContent: "The network_id field defines the network that this route belongs to. This is used to group routes together in a logical way, such as all routes in a particular region or operated by a particular brand. If this route is not part of a network, leave this field blank."
+  - name: route_network_ids
+    required: false
+    inputType: GTFS_ROUTE_NETWORK
+    bulkEditEnabled: true
+    columnWidth: 12
+    helpContent: "The network_id field defines the network that this route belongs to. This is used to group routes together in a logical way, such as all routes in a particular region or operated by a particular brand. If this route is not part of a network, leave this field blank."
 
 - id: trip
   name: trips.txt
@@ -1017,3 +1034,153 @@
     required: false
   - name: added_service
     required: false
+
+# Fares v2
+
+- id: fareproduct
+  name: fare_products.txt
+  helpContent: Used to describe the range of fares available for purchase by riders or taken into account when computing the total fare for journeys with multiple legs, such as transfer costs.
+  fields:
+    - name: fare_product_id
+      required: true
+      inputType: GTFS_ID
+    - name: fare_product_name
+      required: false
+      inputType: TEXT
+    # FARE-TODO: Add rider_category_id?
+    - name: fare_media_id
+      required: false
+      inputType: GTFS_FARE_MEDIA
+    - name: amount
+      inputType: NUMBER
+      required: true
+    - name: currency
+      required: true
+      inputType: DROPDOWN
+      bulkEditEnabled: true
+      options:
+      - value: USD
+        text: US dollar (USD)
+      - value: AUD
+        text: Australian dollar (AUD)
+      - value: CAD
+        text: Canadian dollar (CAD)
+      - value: CHF
+        text: Swiss franc (CHF)
+      - value: CNH
+        text: Chinese renminbi (CNH)
+      - value: EUR
+        text: Euro (EUR)
+      - value: GBP
+        text: Pound sterling (GBP)
+      - value: JPY
+        text: Japanese yen (JPY)
+      - value: MXN
+        text: Mexican peso (MXN)
+      - value: NZD
+        text: New Zealand dollar (NZD)
+      - value: SEK
+        text: Swedish krona (SEK)
+- id: faremedia
+  name: fare_media.txt
+  helpContent: To describe the different fare media that can be employed to use fare products. Fare media are physical or virtual holders used for the representation and/or validation of a fare product.
+  fields:
+  - name: fare_media_id
+    required: true
+    inputType: GTFS_ID
+  - name: fare_media_name
+    inputType: TEXT
+  - name: fare_media_type
+    required: true
+    inputType: DROPDOWN
+    options:
+      - value: '0'
+        text: None (0)
+      - value: '1'
+        text: Physical paper ticket (1)
+      - value: '2'
+        text: Physical transit card (2)
+      - value: '3'
+        text: cEMV (3)
+      - value: '4'
+        text: Mobile app (4)
+- id: faretransferrule
+  name: fare_transfer_rules.txt
+  helpContent: Fare rules for transfers between legs of travel defined in fare_leg_rules.txt.
+  fields:
+    - name: from_leg_group_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference fare_leg_rules
+    - name: to_leg_group_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference fare_leg_rules
+    - name: transfer_count
+      inputType: NUMBER # FARE-TODO: NON-ZERO INT
+    - name: duration_limit
+      inputType: POSITIVE_INT
+    - name: duration_limit_type
+      inputType: DROPDOWN
+      # FARE-TODO: Some help content?
+      options:
+        - value: '0'
+        - value: '1'
+        - value: '2'
+        - value: '3'
+    - name: fare_transfer_type
+      inputType: DROPDOWN
+      # FARE-TODO: Some help content?
+      options:
+        - value: '0'
+        - value: '1'
+        - value: '2'
+    - name: fare_product_id
+      required: false
+      inputType: GTFS_FARE_PRODUCT
+- id: farelegrule
+  name: fare_leg_rules.txt
+  # FARE-TODO: Some help content?
+  fields:
+    - name: leg_group_id
+      required: false
+      inputType: TEXT # FARE-TODO: should this be text or id?
+    - name: network_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference networks.network_id or routes.network_id
+    - name: from_area_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference areas.area_id
+    - name: to_area_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference areas.area_id
+    - name: from_timeframe_group_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference timeframes.timeframe_group_id
+    - name: to_timeframe_group_id
+      required: false
+      inputType: TEXT # FARE-TODO: Needs to reference timeframes.timeframe_group_id
+    - name: fare_product_id
+      required: true
+      inputType: TEXT # FARE-TODO: Needs to reference fare_products.fare_product_id
+    - name: rule_priority
+      required: false
+      inputType: POSITIVE_INT
+- id: area
+  name: areas.txt
+  helpContent: Areas that can be used to define fare zones.
+  fields:
+    - name: area_id
+      required: true
+      inputType: GTFS_ID
+    - name: area_name
+      required: false
+      inputType: TEXT
+- id: network
+  name: networks.txt
+  helpContent: Networks that can be used to group routes and fare legs.
+  fields:
+    - name: network_id
+      required: true
+      inputType: GTFS_ID
+    - name: network_name
+      required: false
+      inputType: TEXT

lib/editor/actions/editor.js

@@ -489,6 +489,11 @@ export function fetchBaseGtfs ({
             agency_id
             agency_name
           }
+          area (limit: -1) {
+            id
+            area_id
+            area_name
+          }
           calendar (limit: -1) {
             id
             service_id
@@ -498,6 +503,31 @@ export function fetchBaseGtfs ({
             id
             fare_id
           }
+          fare_product (limit: -1) {
+            id
+            fare_product_id
+            fare_media_id
+          }
+          fare_media (limit: -1) {
+            id
+            fare_media_id
+          }
+          fare_transfer_rule (limit: -1) {
+            id
+            from_leg_group_id
+            to_leg_group_id
+            fare_product_id
+          }
+          fare_leg_rule (limit: -1) {
+            fare_product_id
+            leg_group_id
+            id
+          }
+          network (limit: -1) {
+            id
+            network_id
+            network_name
+          }
           routes (limit: -1) {
             id
             route_id

lib/editor/components/EditorInput.js

@@ -20,6 +20,8 @@ import type {Entity, Feed, GtfsSpecField, GtfsAgency, GtfsStop} from '../../type
 import type {EditorTables} from '../../types/reducers'
 
 import ColorField from './ColorField'
+import FareProductSelect from './FareProductSelect'
+import StopAreasSelector from './StopAreasSelector'
 import RouteTypeSelect from './RouteTypeSelect'
 import VirtualizedEntitySelect from './VirtualizedEntitySelect'
 import ZoneSelect from './ZoneSelect'
@@ -68,7 +70,15 @@ export default class EditorInput extends React.Component<Props> {
       onChange,
       updateActiveGtfsEntity
     } = this.props
+    console.log('processing field change::::', field.name, val, activeComponent, activeEntity)
     onChange && onChange(val)
+    // FARE_TODO::: HANDLE CONDITIONAL FORBIDDEN FIELDS (network_id on route when route_network_ids is populated)
+    let props = {[field.name]: val}
+    console.log('props::::', props)
+    if (activeEntity === 'route' && field.name !== 'network_id') {
+      props = {...props, network_id: ''}
+    }
+    console.log('props after network_id check::::', props)
     updateActiveGtfsEntity && activeEntity && updateActiveGtfsEntity({
       component: activeComponent,
       entity: activeEntity,
@@ -109,6 +119,7 @@ export default class EditorInput extends React.Component<Props> {
     }
   }
 
+  /* eslint-disable complexity */
   render () {
     const {
       activeEntity,
@@ -386,6 +397,77 @@ export default class EditorInput extends React.Component<Props> {
           </FormGroup>
         )
       }
+      case 'GTFS_FARE_PRODUCT':
+        const fareProducts = getTableById(tableData, 'fareproduct').map(fareProduct => ({
+          value: fareProduct.fare_product_id,
+          label: `${fareProduct.fare_product_id} (${fareProduct.fare_media_id})`
+        }))
+        return (
+          <FormGroup {...formProps}>
+            {basicLabel}
+            <FareProductSelect
+              addCreateOption
+              onChange={this._onSelectChange}
+              value={currentValue}
+              options={fareProducts} />
+          </FormGroup>
+        )
+      case 'GTFS_FARE_MEDIA':
+        // FARE-TODO: media entities are not loaded in the editor until each fare_media entity is opened in the fare media tab.
+        // ex. go to products tab, select fare media, they will be undefined.
+        const fareMedia = getTableById(tableData, 'faremedia').map(fareMedia => ({
+          value: fareMedia.fare_media_id,
+          label: `${fareMedia.fare_media_name} (${fareMedia.fare_media_id})`
+        }))
+        return (
+          <FormGroup {...formProps}>
+            {basicLabel}
+            <Select
+              clearable
+              onChange={this._onSelectChange}
+              value={currentValue}
+              options={fareMedia} />
+          </FormGroup>
+        )
+      case 'GTFS_STOP_AREA':
+        const areas = getTableById(tableData, 'area')
+        let stopAreaIds: Array<string> = []
+        if (activeComponent === 'stop' &&
+            activeEntity &&
+            activeEntity.stop_area_ids &&
+            typeof activeEntity.stop_area_ids === 'string') {
+          stopAreaIds = activeEntity.stop_area_ids.split('§').filter(Boolean)
+        }
+        return (
+          <FormGroup {...formProps}>
+            {basicLabel}
+            <StopAreasSelector
+              currentValue={stopAreaIds}
+              areas={areas}
+              processFieldChange={this._processFieldChange}
+            />
+          </FormGroup>
+        )
+      case 'GTFS_ROUTE_NETWORK':
+        // FARE-TODO: network_id is conditinoally forbidden, need to send empty value for netowrk_id on save when updating route_network_ids.
+        const networks = getTableById(tableData, 'network')
+        let routeNetworkIds: Array<string> = []
+        if (activeComponent === 'route' &&
+            activeEntity &&
+            activeEntity.route_network_ids &&
+            typeof activeEntity.route_network_ids === 'string') {
+          routeNetworkIds = activeEntity.route_network_ids.split('§').filter(Boolean)
+        }
+        return (
+          <FormGroup {...formProps}>
+            {basicLabel}
+            <StopAreasSelector
+              currentValue={routeNetworkIds}
+              areas={networks}
+              processFieldChange={this._processFieldChange}
+            />
+          </FormGroup>
+        )
       default:
         return null
     }