@opentripplanner/core-utils 11.4.3 → 11.4.5

package/lib/planQuery.graphql

@@ -0,0 +1,281 @@
+query Plan(
+  $arriveBy: Boolean
+  $banned: InputBanned
+  $bikeReluctance: Float
+  $carReluctance: Float
+  $date: String
+  $fromPlace: String!
+  $modes: [TransportMode]
+  $numItineraries: Int
+  $preferred: InputPreferred
+  $time: String
+  $toPlace: String!
+  $unpreferred: InputUnpreferred
+  $walkReluctance: Float
+  $walkSpeed: Float
+  $wheelchair: Boolean
+) {
+  plan(
+    arriveBy: $arriveBy
+    banned: $banned
+    bikeReluctance: $bikeReluctance
+    carReluctance: $carReluctance
+    date: $date
+    fromPlace: $fromPlace
+    # Currently only supporting EN locale, used for times and text
+    locale: "en"
+    numItineraries: $numItineraries
+    preferred: $preferred
+    time: $time
+    toPlace: $toPlace
+    transportModes: $modes
+    unpreferred: $unpreferred
+    walkReluctance: $walkReluctance
+    walkSpeed: $walkSpeed
+    wheelchair: $wheelchair
+  ) {
+    itineraries {
+      accessibilityScore
+      duration
+      endTime
+      legs {
+        accessibilityScore
+        agency {
+          alerts {
+            alertDescriptionText
+            alertHeaderText
+            alertUrl
+            effectiveStartDate
+            id
+          }
+          gtfsId
+          id: gtfsId
+          name
+          timezone
+          url
+        }
+        alerts {
+          alertDescriptionText
+          alertHeaderText
+          alertUrl
+          effectiveStartDate
+          id
+        }
+        arrivalDelay
+        departureDelay
+        distance
+        dropOffBookingInfo {
+          contactInfo {
+            bookingUrl
+            infoUrl
+            phoneNumber
+          }
+          earliestBookingTime {
+            daysPrior
+            time
+          }
+          latestBookingTime {
+            daysPrior
+            time
+          }
+          message
+        }
+        dropoffType
+        duration
+        endTime
+        fareProducts {
+          id
+          product {
+            __typename
+            id
+            medium {
+              id
+              name
+            }
+            name
+            riderCategory {
+              id
+              name
+            }
+            ... on DefaultFareProduct {
+              price {
+                amount
+                currency {
+                  code
+                  digits
+                }
+              }
+            }
+          }
+        }
+        from {
+          lat
+          lon
+          name
+          rentalVehicle {
+            id
+            network
+          }
+          stop {
+            alerts {
+              alertDescriptionText
+              alertHeaderText
+              alertUrl
+              effectiveStartDate
+              id
+            }
+            code
+            gtfsId
+            id
+            lat
+            lon
+          }
+          vertexType
+        }
+        headsign
+        interlineWithPreviousLeg
+        intermediateStops {
+          lat
+          locationType
+          lon
+          name
+          stopCode: code
+          stopId: id
+        }
+        legGeometry {
+          length
+          points
+        }
+        mode
+        pickupBookingInfo {
+          contactInfo {
+            bookingUrl
+            infoUrl
+            phoneNumber
+          }
+          earliestBookingTime {
+            daysPrior
+            time
+          }
+          latestBookingTime {
+            daysPrior
+            time
+          }
+          message
+        }
+        pickupType
+        realTime
+        realtimeState
+        rentedBike
+        rideHailingEstimate {
+          arrival
+          maxPrice {
+            amount
+            currency {
+              code
+            }
+          }
+          minPrice {
+            amount
+            currency {
+              code
+            }
+          }
+          provider {
+            id
+          }
+        }
+        route {
+          alerts {
+            alertDescriptionText
+            alertHeaderText
+            alertUrl
+            effectiveStartDate
+            id
+          }
+          color
+          gtfsId
+          id: gtfsId
+          longName
+          shortName
+          textColor
+          type
+        }
+        startTime
+        steps {
+          absoluteDirection
+          alerts {
+            alertDescriptionText
+            alertHeaderText
+            alertUrl
+            effectiveStartDate
+            id
+          }
+          area
+          distance
+          elevationProfile {
+            distance
+            elevation
+          }
+          lat
+          lon
+          relativeDirection
+          stayOn
+          streetName
+        }
+        to {
+          lat
+          lon
+          name
+          rentalVehicle {
+            id
+            network
+          }
+          stop {
+            alerts {
+              alertDescriptionText
+              alertHeaderText
+              alertUrl
+              effectiveStartDate
+              id
+            }
+            code
+            gtfsId
+            id
+            lat
+            lon
+          }
+          vertexType
+        }
+        transitLeg
+        trip {
+          arrivalStoptime {
+            stop {
+              gtfsId
+              id
+            }
+            stopPosition
+          }
+          departureStoptime {
+            stop {
+              gtfsId
+              id
+            }
+            stopPosition
+          }
+          gtfsId
+          id
+        }
+      }
+      startTime
+      transfers: numberOfTransfers
+      waitingTime
+      walkTime
+    }
+    routingErrors {
+      code
+      description
+      inputField
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentripplanner/core-utils",
-  "version": "11.4.3",
+  "version": "11.4.5",
   "description": "Core functionality that is shared among numerous UI components",
   "engines": {
     "node": ">=13"
@@ -14,7 +14,7 @@
   "dependencies": {
     "@conveyal/lonlat": "^1.4.1",
     "@mapbox/polyline": "^1.1.0",
-    "@opentripplanner/geocoder": "^3.0.0",
+    "@opentripplanner/geocoder": "^3.0.2",
     "@styled-icons/foundation": "^10.34.0",
     "@turf/along": "^6.0.1",
     "chroma-js": "^2.4.2",
@@ -30,7 +30,7 @@
     "tsc": "tsc"
   },
   "devDependencies": {
-    "@opentripplanner/types": "^6.5.0",
+    "@opentripplanner/types": "^6.5.2",
     "@types/chroma-js": "^2.1.4"
   }
 }

package/src/__tests__/itinerary.ts

@@ -9,6 +9,7 @@ import {
   getLegRouteLongName,
   getLegRouteName,
   getLegRouteShortName,
+  isFlex,
   isTransit,
   mapOldElevationComponentToNew
 } from "../itinerary";
@@ -16,6 +17,7 @@ import {
 const bikeRentalItinerary = require("./__mocks__/bike-rental-itinerary.json");
 const tncItinerary = require("./__mocks__/tnc-itinerary.json");
 const fareProductItinerary = require("./__mocks__/fare-products-itinerary.json");
+const flexItinerary = require("../../../itinerary-body/src/__mocks__/itineraries/flex-itinerary.json");
 
 const basePlace = {
   lat: 0,
@@ -40,6 +42,20 @@ describe("util > itinerary", () => {
     });
   });
 
+  describe("isFlex", () => {
+    it("should detect flex if present", () => {
+      fareProductItinerary.legs.forEach(leg => expect(isFlex(leg)).toBe(false));
+      tncItinerary.legs.forEach(leg => expect(isFlex(leg)).toBe(false));
+      expect(isFlex(flexItinerary.legs[0])).toBe(false);
+      expect(isFlex(flexItinerary.legs[1])).toBe(false);
+      expect(isFlex(flexItinerary.legs[2])).toBe(false);
+      expect(isFlex(flexItinerary.legs[3])).toBe(false);
+      expect(isFlex(flexItinerary.legs[4])).toBe(false);
+      expect(isFlex(flexItinerary.legs[5])).toBe(true);
+      expect(isFlex(flexItinerary.legs[6])).toBe(false); // Does not exist
+      expect(isFlex(flexItinerary.legs[7])).toBe(false); // Does not exist
+    });
+  });
   describe("isTransit", () => {
     it("should work", () => {
       expect(isTransit("CAR")).toBeFalsy();

package/src/itinerary.ts

@@ -52,7 +52,7 @@ export function isTransit(mode: string): boolean {
  * property which encodes this info.
  */
 export function isReservationRequired(leg: Leg): boolean {
-  return leg.boardRule === "mustPhone" || leg.alightRule === "mustPhone";
+  return leg?.boardRule === "mustPhone" || leg?.alightRule === "mustPhone";
 }
 /**
  * Returns true if a user must ask the driver to let the user off
@@ -61,25 +61,45 @@ export function isReservationRequired(leg: Leg): boolean {
  */
 export function isCoordinationRequired(leg: Leg): boolean {
   return (
-    leg.boardRule === "coordinateWithDriver" ||
-    leg.alightRule === "coordinateWithDriver"
+    leg?.boardRule === "coordinateWithDriver" ||
+    leg?.alightRule === "coordinateWithDriver"
   );
 }
-/**
- * The two rules checked by the above two functions are the only values
- * returned by OTP when a leg is a flex leg.
- */
-export function isFlex(leg: Leg): boolean {
-  return isReservationRequired(leg) || isCoordinationRequired(leg);
-}
 
+export function containsGeometry(place: Place): boolean {
+  return (
+    place?.stop?.geometries !== null && place?.stop?.geometries !== undefined
+  );
+}
+export function endsWithGeometry(leg: Leg): boolean {
+  return containsGeometry(leg?.to);
+}
+export function startsWithGeometry(leg: Leg): boolean {
+  return containsGeometry(leg?.from);
+}
+export function legContainsGeometry(leg: Leg): boolean {
+  return endsWithGeometry(leg) || startsWithGeometry(leg);
+}
 export function isAdvanceBookingRequired(info: FlexBookingInfo): boolean {
   return info?.latestBookingTime?.daysPrior > 0;
 }
 export function legDropoffRequiresAdvanceBooking(leg: Leg): boolean {
-  return isAdvanceBookingRequired(leg.dropOffBookingInfo);
+  return isAdvanceBookingRequired(leg?.dropOffBookingInfo);
 }
 
+/**
+ * The two rules checked by the above two functions are the only values
+ * returned by OTP when a leg is a flex leg.
+ */
+export function isFlex(leg: Leg): boolean {
+  return (
+    isReservationRequired(leg) ||
+    isCoordinationRequired(leg) ||
+    legDropoffRequiresAdvanceBooking(leg) ||
+    isAdvanceBookingRequired(leg?.pickupBookingInfo) ||
+    legContainsGeometry(leg)
+  );
+}
 export function isRideshareLeg(leg: Leg): boolean {
   return !!leg.rideHailingEstimate?.provider?.id;
 }