@opentripplanner/core-utils 8.2.3 → 8.3.0

package/src/planQuery.graphql

@@ -1,4 +1,4 @@
-query PlanQuery(
+query Plan(
   $fromPlace: String!
   $toPlace: String!
   $modes: [TransportMode]
@@ -16,161 +16,168 @@ query PlanQuery(
   $numItineraries: Int
 ) {
   plan(
-    fromPlace: $fromPlace
-    toPlace: $toPlace
-    transportModes: $modes
-    # Currently only supporting EN locale, used for times and text
-    locale: "en"
-    time: $time
-    date: $date
-    wheelchair: $wheelchair
+    arriveBy: $arriveBy
+    banned: $banned
     bikeReluctance: $bikeReluctance
     carReluctance: $carReluctance
-    walkReluctance: $walkReluctance
-    arriveBy: $arriveBy
+    date: $date
+    fromPlace: $fromPlace
     intermediatePlaces: $intermediatePlaces
+    # Currently only supporting EN locale, used for times and text
+    locale: "en"
+    numItineraries: $numItineraries
     preferred: $preferred
+    time: $time
+    toPlace: $toPlace
+    transportModes: $modes
     unpreferred: $unpreferred
-    banned: $banned
-    numItineraries: $numItineraries
+    walkReluctance: $walkReluctance
+    wheelchair: $wheelchair
   ) {
-    routingErrors {
-      code
-      inputField
-      description
-    }
     itineraries {
+      accessibilityScore
       duration
       endTime
-      startTime
-      waitingTime
-      walkTime
-      accessibilityScore
-      legs {
-        pickupType
-        dropoffType
-        pickupBookingInfo {
-          earliestBookingTime {
-            daysPrior
-          }
-        }
-        rentedBike
-        interlineWithPreviousLeg
-        departureDelay
-        arrivalDelay
-        distance
-        duration
-        endTime
-        mode
-        realTime
-        realtimeState
-        startTime
-        transitLeg
+        legs {
         accessibilityScore
-        trip {
-          id
-          gtfsId
-          tripHeadsign
-        }
         agency {
-          name
-          id
-          timezone
-          url
           alerts {
-            alertHeaderText
             alertDescriptionText
+            alertHeaderText
             alertUrl
             effectiveStartDate
+            id
           }
+          id
+          name
+          timezone
+          url
         }
-        legGeometry {
-          length
-          points
+        arrivalDelay
+        departureDelay
+        distance
+        dropoffType
+        duration
+        endTime
+        from {
+          lat
+          lon
+          name
+          rentalVehicle {
+            id
+            network
+          }
+          stop {
+            alerts {
+              alertDescriptionText
+              alertHeaderText
+              alertUrl
+              effectiveStartDate
+              id
+            }
+            code
+            gtfsId
+            id
+          }
+          vertexType
         }
+        interlineWithPreviousLeg
         intermediateStops {
           lat
+          locationType
           lon
           name
           stopCode: code
           stopId: id
-          locationType
         }
+        legGeometry {
+          length
+          points
+        }
+        mode
+        pickupBookingInfo {
+          earliestBookingTime {
+            daysPrior
+          }
+        }
+        pickupType
+        realTime
+        realtimeState
+        rentedBike
         route {
-          shortName
-          longName
+          alerts {
+            alertDescriptionText
+            alertHeaderText
+            alertUrl
+            effectiveStartDate
+            id
+          }
           color
-          textColor
           id
+          longName
+          shortName
+          textColor
           type
+        }
+        startTime
+        steps {
+          absoluteDirection
           alerts {
-            alertHeaderText
             alertDescriptionText
+            alertHeaderText
             alertUrl
             effectiveStartDate
+            id
+          }
+          area
+          distance
+          elevationProfile {
+            distance
+            elevation
           }
-        }
-        from {
           lat
           lon
-          name
-          vertexType
-          rentalVehicle {
-            network
-          }
-          stop {
-            id
-            code
-            gtfsId
-            alerts {
-              alertHeaderText
-              alertDescriptionText
-              alertUrl
-              effectiveStartDate
-            }
-          }
+        relativeDirection
+          stayOn
+          streetName
         }
         to {
           lat
           lon
           name
-          vertexType
           rentalVehicle {
+            id
             network
           }
           stop {
-            id
-            code
-            gtfsId
             alerts {
-              alertHeaderText
               alertDescriptionText
+              alertHeaderText
               alertUrl
               effectiveStartDate
+              id
             }
+            code
+            gtfsId
+            id
           }
+          vertexType
         }
-        steps {
-          distance
-          lat
-          lon
-          relativeDirection
-          absoluteDirection
-          stayOn
-          streetName
-          area
-          alerts {
-            alertHeaderText
-            alertDescriptionText
-            alertUrl
-            effectiveStartDate
-          }
-          elevationProfile {
-            distance
-            elevation
-          }
+        transitLeg
+        trip {
+          gtfsId
+          id
+          tripHeadsign
         }
       }
+      startTime
+      waitingTime
+      walkTime
+    }
+    routingErrors {
+      code
+      description
+      inputField
     }
   }
 }

package/src/query-gen.ts

@@ -6,7 +6,7 @@ import {
   TransportMode
 } from "@opentripplanner/types";
 
-import PlanQuery from "./planQuery.graphql";
+import DefaultPlanQuery from "./planQuery.graphql";
 
 type InputBanned = {
   routes?: string;
@@ -127,7 +127,7 @@ const VALID_COMBOS = [
   ["TRANSIT", "CAR"]
 ];
 
-const BANNED_TOGETHER = ["SCOOTER", "BICYCLE"];
+const BANNED_TOGETHER = ["SCOOTER", "BICYCLE", "CAR"];
 
 export const TRANSIT_SUBMODES = Object.keys(SIMPLIFICATIONS).filter(
   mode => SIMPLIFICATIONS[mode] === "TRANSIT" && mode !== "TRANSIT"
@@ -168,7 +168,9 @@ function isCombinationValid(
   }
 
   // OTP doesn't support multiple non-walk modes
-  if (BANNED_TOGETHER.every(m => combo.find(c => c.mode === m))) return false;
+  if (BANNED_TOGETHER.filter(m => combo.find(c => c.mode === m)).length > 1) {
+    return false;
+  }
 
   return !!VALID_COMBOS.find(
     vc =>
@@ -199,18 +201,27 @@ export function generateCombinations(params: OTPQueryParams): OTPQueryParams[] {
     .map(combo => ({ ...params, modes: combo }));
 }
 
-export function generateOtp2Query({
-  arriveBy,
-  banned,
-  date,
-  from,
-  modes,
-  modeSettings,
-  numItineraries,
-  preferred,
-  time,
-  to
-}: OTPQueryParams): GraphQLQuery {
+/**
+ * Generates a query for OTP GraphQL API based on parameters.
+ * @param param0 OTP2 Parameters for the query
+ * @param planQuery Override the default query for OTP
+ * @returns A fully formed query+variables ready to be sent to GraphQL backend
+ */
+export function generateOtp2Query(
+  {
+    arriveBy,
+    banned,
+    date,
+    from,
+    modes,
+    modeSettings,
+    numItineraries,
+    preferred,
+    time,
+    to
+  }: OTPQueryParams,
+  planQuery = DefaultPlanQuery
+): GraphQLQuery {
   // This extracts the values from the mode settings to key value pairs
   const modeSettingValues = modeSettings.reduce((prev, cur) => {
     if (cur.type === "SLIDER" && cur.inverseKey) {
@@ -228,7 +239,7 @@ export function generateOtp2Query({
   } = modeSettingValues;
 
   return {
-    query: print(PlanQuery),
+    query: print(planQuery),
     variables: {
       arriveBy,
       banned,