@opentripplanner/core-utils 10.0.0-alpha.4 → 10.0.0

package/src/itinerary.ts

@@ -78,7 +78,6 @@ export function legDropoffRequiresAdvanceBooking(leg: Leg): boolean {
   return isAdvanceBookingRequired(leg.dropOffBookingInfo);
 }
 
-// alpha-only comment
 export function isRideshareLeg(leg: Leg): boolean {
   return !!leg.rideHailingEstimate?.provider?.id;
 }
@@ -409,13 +408,10 @@ export function getCompanyForNetwork(
  * @return {string}  A label for use in presentation on a website.
  */
 export function getCompaniesLabelFromNetworks(
-  networks: string | string[],
+  networks: string[],
   companies: Company[] = []
 ): string {
-  let networksArray = networks;
-  if (typeof networks === "string") networksArray = [networks];
-
-  return (networksArray as string[])
+  return networks
     .map(network => getCompanyForNetwork(network, companies))
     .filter(co => !!co)
     .map(co => co.label)
@@ -570,7 +566,11 @@ export function getLegCost(
   leg: Leg,
   mediumId: string | null,
   riderCategoryId: string | null
-): { price?: Money; transferAmount?: Money | undefined; useId?: string } {
+): {
+  price?: Money;
+  transferAmount?: Money | undefined;
+  productUseId?: string;
+} {
   if (!leg.fareProducts) return { price: undefined };
   const relevantFareProducts = leg.fareProducts.filter(({ product }) => {
     // riderCategory and medium can be specifically defined as null to handle
@@ -593,7 +593,7 @@ export function getLegCost(
   return {
     price: totalCostProduct?.product.price,
     transferAmount: transferFareProduct?.product.price,
-    useId: totalCostProduct?.id
+    productUseId: totalCostProduct?.id
   };
 }
 
@@ -618,13 +618,13 @@ export function getItineraryCost(
     // Filter out duplicate use IDs
     // One fare product can be used on multiple legs,
     // and we don't want to count it more than once.
-    .reduce<{ useId: string; price: Money }[]>((prev, cur) => {
-      if (!prev.some(p => p.useId === cur.useId)) {
-        prev.push({ useId: cur.useId, price: cur.price });
+    .reduce<{ productUseId: string; price: Money }[]>((prev, cur) => {
+      if (!prev.some(p => p.productUseId === cur.productUseId)) {
+        prev.push({ productUseId: cur.productUseId, price: cur.price });
       }
       return prev;
     }, [])
-    .map(prodUse => prodUse.price);
+    .map(productUse => productUse.price);
 
   if (legCosts.length === 0) return undefined;
   // Calculate the total

package/src/otpSchema.json

@@ -2292,7 +2292,7 @@
           "fields": [
             {
               "name": "id",
-              "description": "Identifier local to the itinerary that allows to cross-reference and deduplicate\nfare products that span more than one leg.\n\nIf you want to uniquely identify the fare product itself (not its use) use the product's `id`.\n\n### Example: Day pass\n\nWhen a day pass is valid for all three legs in the itinerary it will appear\nfor each leg but with the same use-`id`.\n\n*It is the responsibility of the API consumers to display the day pass as a product for the\nentire itinerary rather than three day passes!*\n\n### Example: Several single tickets\n\nIf you have two legs and need to buy two single tickets they will appear in each leg with the\nsame `product.id` but different use-`id`.",
+              "description": "Represents the use of a single instance of a fare product throughout the itinerary. It can\nbe used to cross-reference and de-duplicate fare products that are applicable for more than one\nleg.\n\nIf you want to uniquely identify the fare product itself (not its use) use the product's `id`.\n\n### Example: Day pass\n\nThe day pass is valid for both legs in the itinerary. It is listed as the applicable `product` for each leg,\nand the same FareProductUse id is shown, indicating that only one pass was used/bought.\n\n**Illustration**\n```yaml\nitinerary:\n  leg1:\n    fareProducts:\n      id: \"AAA\" // id of a FareProductUse instance\n      product:\n        id: \"day-pass\" // product id\n        name: \"Day Pass\"\n  leg2:\n    fareProducts:\n      id: \"AAA\" // identical to leg1. the passenger needs to buy ONE pass, not two.\n      product:\n        id: \"day-pass\"  // product id\n        name: \"Day Pass\"\n```\n\n**It is the responsibility of the API consumers to display the day pass as a product for the\nentire itinerary rather than two day passes!**\n\n### Example: Several single tickets\n\nIf you have two legs and need to buy two single tickets they will appear in each leg with the\nsame `FareProduct.id` but different `FareProductUse.id`.\n\n**Illustration**\n```yaml\nitinerary:\n  leg1:\n    fareProducts:\n      id: \"AAA\" // id of a FareProductUse instance, not product id\n      product:\n        id: \"single-ticket\" // product id\n        name: \"Single Ticket\"\n  leg2:\n    fareProducts:\n      id: \"BBB\" // different to leg1. the passenger needs to buy two single tickets.\n      product:\n        id: \"single-ticket\"  // product id\n        name: \"Single Ticket\"\n```",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -3558,7 +3558,7 @@
             },
             {
               "name": "steps",
-              "description": null,
+              "description": "The turn-by-turn navigation instructions.",
               "args": [],
               "type": {
                 "kind": "LIST",
@@ -3572,6 +3572,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "headsign",
+              "description": "For transit legs, the headsign that the vehicle shows at the stop where the passenger boards.\nFor non-transit legs, null.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "pickupType",
               "description": "This is used to indicate if boarding this leg is possible only with special arrangements.",
@@ -8446,49 +8458,43 @@
           "enumValues": [
             {
               "name": "NO_TRANSIT_CONNECTION",
-              "description": "No transit connection was found between the origin and destination withing the operating day or the next day",
+              "description": "No transit connection was found between the origin and destination within the operating day or\nthe next day, not even sub-optimal ones.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "NO_TRANSIT_CONNECTION_IN_SEARCH_WINDOW",
-              "description": "Transit connection was found, but it was outside the search window, see metadata for the next search window",
+              "description": "A transit connection was found, but it was outside the search window. See the metadata for a token\nfor retrieving the result outside the search window.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "OUTSIDE_SERVICE_PERIOD",
-              "description": "The date specified is outside the range of data currently loaded into the system",
+              "description": "The date specified is outside the range of data currently loaded into the system as it is too\nfar into the future or the past.\n\nThe specific date range of the system is configurable by an administrator and also depends on\nthe input data provided.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "OUTSIDE_BOUNDS",
-              "description": "The coordinates are outside the bounds of the data currently loaded into the system",
+              "description": "The coordinates are outside the geographic bounds of the transit and street data currently loaded\ninto the system and therefore cannot return any results.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "LOCATION_NOT_FOUND",
-              "description": "The specified location is not close to any streets or transit stops",
+              "description": "The specified location is not close to any streets or transit stops currently loaded into the\nsystem, even though it is generally within its bounds.\n\nThis can happen when there is only transit but no street data coverage at the location in\nquestion.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "NO_STOPS_IN_RANGE",
-              "description": "No stops are reachable from the location specified. You can try searching using a different access or egress mode",
+              "description": "No stops are reachable from the start or end locations specified.\n\nYou can try searching using a different access or egress mode, for example cycling instead of walking,\nincrease the walking/cycling/driving speed or have an administrator change the system's configuration\nso that stops further away are considered.",
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
               "name": "WALKING_BETTER_THAN_TRANSIT",
-              "description": "The origin and destination are so close to each other, that walking is always better, but no direct mode was specified for the search",
-              "isDeprecated": false,
-              "deprecationReason": null
-            },
-            {
-              "name": "SYSTEM_ERROR",
-              "description": "An unknown error happened during the search. The details have been logged to the server logs",
+              "description": "Transit connections were requested and found but because it is easier to just walk all the way\nto the destination they were removed.\n\nIf you want to still show the transit results, you need to make walking less desirable by\nincreasing the walk reluctance.",
               "isDeprecated": false,
               "deprecationReason": null
             }
@@ -9433,18 +9439,6 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
-            {
-              "name": "stopPosition",
-              "description": "The sequence of the stop in the pattern. This is not required to start from 0 or be consecutive - any\nincreasing integer sequence along the stops is valid.\n\nThe purpose of this field is to identify the stop within the pattern so it can be cross-referenced\nbetween it and the itinerary. It is safe to cross-reference when done quickly, i.e. within seconds.\nHowever, it should be noted that realtime updates can change the values, so don't store it for\nlonger amounts of time.\n\nDepending on the source data, this might not be the GTFS `stop_sequence` but another value, perhaps\neven generated.",
-              "args": [],
-              "type": {
-                "kind": "SCALAR",
-                "name": "Int",
-                "ofType": null
-              },
-              "isDeprecated": false,
-              "deprecationReason": null
-            },
             {
               "name": "scheduledArrival",
               "description": "Scheduled arrival time. Format: seconds since midnight of the departure date",
@@ -10071,7 +10065,7 @@
               "args": [
                 {
                   "name": "language",
-                  "description": "If translated headsign is found from gtfs translation.txt and wanted language is not same as\nfeed's language then returns wanted translation. Otherwise uses name from trip_headsign.txt.",
+                  "description": "If a translated headsign is found from GTFS translation.txt and wanted language is not same as\nfeed's language then returns wanted translation. Otherwise uses name from trip_headsign.txt.",
                   "type": {
                     "kind": "SCALAR",
                     "name": "String",

package/src/planQuery.graphql

@@ -1,18 +1,19 @@
 query Plan(
-  $fromPlace: String!
-  $toPlace: String!
-  $modes: [TransportMode]
-  $time: String
-  $date: String
-  $wheelchair: Boolean
+  $arriveBy: Boolean
+  $banned: InputBanned
   $bikeReluctance: Float
   $carReluctance: Float
-  $walkReluctance: Float
-  $arriveBy: Boolean
+  $date: String
+  $fromPlace: String!
+  $modes: [TransportMode]
+  $numItineraries: Int
   $preferred: InputPreferred
+  $time: String
+  $toPlace: String!
   $unpreferred: InputUnpreferred
-  $banned: InputBanned
-  $numItineraries: Int
+  $walkReluctance: Float
+  $walkSpeed: Float
+  $wheelchair: Boolean
 ) {
   plan(
     arriveBy: $arriveBy
@@ -30,6 +31,7 @@ query Plan(
     transportModes: $modes
     unpreferred: $unpreferred
     walkReluctance: $walkReluctance
+    walkSpeed: $walkSpeed
     wheelchair: $wheelchair
   ) {
     itineraries {
@@ -104,6 +106,7 @@ query Plan(
           }
           vertexType
         }
+        headsign
         interlineWithPreviousLeg
         intermediateStops {
           lat
@@ -222,7 +225,6 @@ query Plan(
           }
           gtfsId
           id
-          tripHeadsign
         }
       }
       startTime

package/src/profile.js

@@ -1,5 +1,5 @@
 export function filterProfileOptions(response) {
-  // Filter out similar options. TODO: handle on server??
+  // Filter out similar options. TODO: handle on server?
   const optStrs = [];
   const filteredIndices = [];
 

package/src/query-gen.ts

@@ -57,7 +57,7 @@ export function extractAdditionalModes(
       return prev;
     }
 
-    // In checkboxes (or submode checkboxes), mode must be enabled and have a transport mode in it
+    // In checkboxes, mode must be enabled and have a transport mode in it
     if (
       (cur.type === "CHECKBOX" || cur.type === "SUBMODE") &&
       cur.addTransportMode &&
@@ -67,7 +67,7 @@ export function extractAdditionalModes(
     }
     if (cur.type === "DROPDOWN") {
       const transportMode = cur.options.find(o => o.value === cur.value)
-        .addTransportMode;
+        ?.addTransportMode;
       if (transportMode) {
         return [...prev, transportMode];
       }
@@ -228,12 +228,18 @@ export function generateOtp2Query(
       prev[cur.inverseKey] = cur.high - cur.value + cur.low;
     }
     prev[cur.key] = cur.value;
+
+    // If we assign a value on true, return the value (or null) instead of a boolean.
+    if (cur.type === "CHECKBOX" && cur.truthValue) {
+      prev[cur.key] = cur.value === true ? cur.truthValue : null;
+    }
     return prev;
   }, {}) as ModeSettingValues;
 
   const {
     bikeReluctance,
     carReluctance,
+    walkSpeed,
     walkReluctance,
     wheelchair
   } = modeSettingValues;
@@ -253,6 +259,7 @@ export function generateOtp2Query(
       time,
       toPlace: `${to.name}::${to.lat},${to.lon}}`,
       walkReluctance,
+      walkSpeed,
       wheelchair
     }
   };

package/src/query-params.js

@@ -365,31 +365,6 @@ const queryParams = [
       }
     ]
   },
-
-  {
-    /* walkSpeed -- the user's walking speed in m/s */
-    name: "walkSpeed",
-    routingTypes: ["ITINERARY", "PROFILE"],
-    default: 1.34,
-    selector: "DROPDOWN",
-    label: "Walk Speed",
-    applicable: query => query.mode && query.mode.indexOf("WALK") !== -1,
-    options: [
-      {
-        text: "2 MPH",
-        value: 0.89
-      },
-      {
-        text: "3 MPH",
-        value: 1.34
-      },
-      {
-        text: "4 MPH",
-        value: 1.79
-      }
-    ]
-  },
-
   {
     name: "walkReluctance",
     routingTypes: ["ITINERARY", "PROFILE"],

package/src/query.js

@@ -19,7 +19,6 @@ export const defaultParams = [
   "maxWalkDistance",
   "walkReluctance",
   "maxWalkTime",
-  "walkSpeed",
   "maxBikeDistance",
   "maxBikeTime",
   "bikeSpeed",