@opentripplanner/core-utils 12.0.0-alpha.1 → 12.0.0-alpha.10

package/src/itinerary.ts

@@ -3,6 +3,7 @@ import {
   Company,
   Config,
   ElevationProfile,
+  ElevationProfileComponent,
   FlexBookingInfo,
   ItineraryOnlyLegsRequired,
   LatLngArray,
@@ -19,6 +20,7 @@ import turfAlong from "@turf/along";
 // All OTP transit modes
 export const transitModes = [
   "TRAM",
+  "TROLLEYBUS",
   "BUS",
   "SUBWAY",
   "FERRY",
@@ -178,6 +180,7 @@ export function getMapColor(mode: string): string {
   if (mode === "SUBWAY") return "#e60000";
   if (mode === "RAIL") return "#b00";
   if (mode === "BUS") return "#080";
+  if (mode === "TROLLEYBUS") return "#080";
   if (mode === "TRAM") return "#800";
   if (mode === "FERRY") return "#008";
   if (mode === "CAR") return "#444";
@@ -294,7 +297,7 @@ export function legElevationAtDistance(
     const elevDistanceSpan = points[i][0] - start[0];
     if (distance >= traversed && distance <= traversed + elevDistanceSpan) {
       // Distance falls within this point and the previous one;
-      // compute & return iterpolated elevation value
+      // compute & return interpolated elevation value
       if (start[1] === null) {
         console.warn(
           "Elevation value does not exist for distance.",
@@ -317,6 +320,16 @@ export function legElevationAtDistance(
   return null;
 }
 
+export function mapOldElevationComponentToNew(oldElev: {
+  first: number;
+  second: number;
+}): ElevationProfileComponent {
+  return {
+    distance: oldElev.first,
+    elevation: oldElev.second
+  };
+}
+
 // Iterate through the steps, building the array of elevation points and
 // keeping track of the minimum and maximum elevations reached
 export function getElevationProfile(
@@ -328,30 +341,41 @@ export function getElevationProfile(
   let traversed = 0;
   let gain = 0;
   let loss = 0;
-  let previous = null;
+  let previous: ElevationProfileComponent | null = null;
   const points = [];
   steps.forEach(step => {
-    if (!step.elevation || step.elevation.length === 0) {
+    // Support for old REST response data (in step.elevation)
+    const stepElevationProfile =
+      step.elevationProfile ||
+      (Array.isArray(step.elevation) &&
+        step.elevation?.map<ElevationProfileComponent>(
+          mapOldElevationComponentToNew
+        ));
+
+    if (!stepElevationProfile || stepElevationProfile.length === 0) {
       traversed += step.distance;
       return;
     }
-    for (let i = 0; i < step.elevation.length; i++) {
-      const elev = step.elevation[i];
+    for (let i = 0; i < stepElevationProfile.length; i++) {
+      const elev = stepElevationProfile[i];
       if (previous) {
-        const diff = (elev.second - previous.second) * unitConversion;
+        const diff = (elev.elevation - previous.elevation) * unitConversion;
         if (diff > 0) gain += diff;
         else loss += diff;
       }
-      if (i === 0 && elev.first !== 0) {
+      if (i === 0 && elev.distance !== 0) {
         // console.warn(`No elevation data available for step ${stepIndex}-${i} at beginning of segment`, elev)
       }
-      const convertedElevation = elev.second * unitConversion;
+      const convertedElevation = elev.elevation * unitConversion;
       if (convertedElevation < minElev) minElev = convertedElevation;
       if (convertedElevation > maxElev) maxElev = convertedElevation;
-      points.push([traversed + elev.first, elev.second]);
+      points.push([traversed + elev.distance, elev.elevation]);
       // Insert "filler" point if the last point in elevation profile does not
       // reach the full distance of the step.
-      if (i === step.elevation.length - 1 && elev.first !== step.distance) {
+      if (
+        i === stepElevationProfile.length - 1 &&
+        elev.distance !== step.distance
+      ) {
         // points.push([traversed + step.distance, elev.second])
       }
       previous = elev;
@@ -370,10 +394,10 @@ export function getElevationProfile(
  * @see https://stackoverflow.com/questions/118241/calculate-text-width-with-javascript/21015393#21015393
  */
 export function getTextWidth(text: string, font = "22px Arial"): number {
-  // Create custom type for function including re-used canvas object
+  // Create custom type for function including reused canvas object
   type GetTextWidth = typeof getTextWidth & { canvas: HTMLCanvasElement };
 
-  // re-use canvas object for better performance
+  // reuse canvas object for better performance
   const canvas =
     (getTextWidth as GetTextWidth).canvas ||
     ((getTextWidth as GetTextWidth).canvas = document.createElement("canvas"));
@@ -409,13 +433,10 @@ export function getCompanyForNetwork(
  * @return {string}  A label for use in presentation on a website.
  */
 export function getCompaniesLabelFromNetworks(
-  networks: string | string[],
+  networks: string[] | string,
   companies: Company[] = []
 ): string {
-  let networksArray = networks;
-  if (typeof networks === "string") networksArray = [networks];
-
-  return (networksArray as string[])
+  return (Array.isArray(networks) ? networks : [networks])
     .map(network => getCompanyForNetwork(network, companies))
     .filter(co => !!co)
     .map(co => co.label)
@@ -489,6 +510,7 @@ const CARBON_INTENSITY_DEFAULTS = {
   bicycle: 0.017,
   car: 0.162,
   tram: 0.066,
+  trolleybus: 0.066,
   subway: 0.066,
   rail: 0.066,
   bus: 0.09,
@@ -659,6 +681,7 @@ const pickupDropoffTypeToOtp1 = otp2Type => {
 export const convertGraphQLResponseToLegacy = (leg: any): any => ({
   ...leg,
   agencyBrandingUrl: leg.agency?.url,
+  agencyId: leg.agency?.id,
   agencyName: leg.agency?.name,
   agencyUrl: leg.agency?.url,
   alightRule: pickupDropoffTypeToOtp1(leg.dropoffType),
@@ -673,7 +696,7 @@ export const convertGraphQLResponseToLegacy = (leg: any): any => ({
   },
   route: leg.route?.shortName,
   routeColor: leg.route?.color,
-  routeId: leg.route?.id,
+  routeId: leg.route?.gtfsId,
   routeLongName: leg.route?.longName,
   routeShortName: leg.route?.shortName,
   routeTextColor: leg.route?.textColor,
@@ -685,3 +708,33 @@ export const convertGraphQLResponseToLegacy = (leg: any): any => ({
   tripHeadsign: leg.trip?.tripHeadsign,
   tripId: leg.trip?.gtfsId
 });
+
+/** Extracts the route number for a leg returned from OTP1 or OTP2. */
+export const getLegRouteShortName = (
+  leg: Pick<Leg, "route" | "routeShortName">
+): string | null => {
+  const { route, routeShortName } = leg;
+  // typeof route === "object" denotes newer OTP2 responses. routeShortName and route as string is OTP1.
+  return typeof route === "object"
+    ? route?.shortName
+    : routeShortName || (route as string);
+};
+
+/** Extract the route long name for a leg returned from OTP1 or OTP2. */
+export const getLegRouteLongName = (
+  leg: Pick<Leg, "route" | "routeLongName">
+): string | null => {
+  const { route, routeLongName } = leg;
+  // typeof route === "object" denotes newer OTP2 responses. routeLongName is OTP1.
+  return typeof route === "object" ? route?.longName : routeLongName;
+};
+
+/**
+ * Returns the route short name, or the route long name if no short name is provided.
+ * This is happens with Seattle area streetcars and ferries.
+ */
+export const getLegRouteName = (
+  leg: Pick<Leg, "route" | "routeLongName" | "routeShortName">
+): string => {
+  return getLegRouteShortName(leg) || getLegRouteLongName(leg);
+};

package/src/otpSchema.json

@@ -2013,7 +2013,7 @@
         {
           "kind": "OBJECT",
           "name": "DepartureRow",
-          "description": "Departure row is a location, which lists departures of a certain pattern from a\nstop. Departure rows are identified with the pattern, so querying departure rows\nwill return only departures from one stop per pattern",
+          "description": "Departure row is a combination of a pattern and a stop of that pattern.\n\nThey are de-duplicated so for each pattern there will only be a single departure row.\n\nThis is useful if you want to show a list of stop/pattern combinations but want each pattern to be\nlisted only once.",
           "fields": [
             {
               "name": "id",
@@ -2173,6 +2173,29 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "Emissions",
+          "description": null,
+          "fields": [
+            {
+              "name": "co2",
+              "description": "CO₂ emissions in grams.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Grams",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "FareMedium",
@@ -2586,6 +2609,16 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "SCALAR",
+          "name": "Grams",
+          "description": "",
+          "fields": null,
+          "inputFields": null,
+          "interfaces": null,
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "SCALAR",
           "name": "ID",
@@ -3149,6 +3182,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "emissionsPerPerson",
+              "description": "Emissions of this itinerary per traveler.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "Emissions",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "legs",
               "description": "A list of Legs. Each Leg is either a walking (cycling, car) portion of the\nitinerary, or a transit leg on a particular vehicle. So a itinerary where the\nuser walks to the Q train, transfers to the 6, then walks to their\ndestination, has four legs.",
@@ -3237,6 +3282,22 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "numberOfTransfers",
+              "description": "How many transfers are part of this itinerary.\n\nNotes:\n - Interlined/stay-seated transfers do not increase this count.\n - Transferring from a flex to a fixed schedule trip and vice versa increases this count.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Int",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "fares",
               "description": "Information about the fares for this itinerary. This is primarily a GTFS Fares V1 interface\nwill be removed in the future.",
@@ -4201,6 +4262,65 @@
             }
           ]
         },
+        {
+          "kind": "ENUM",
+          "name": "OccupancyStatus",
+          "description": "Occupancy status of a vehicle.",
+          "fields": null,
+          "inputFields": null,
+          "interfaces": null,
+          "enumValues": [
+            {
+              "name": "NO_DATA_AVAILABLE",
+              "description": "Default. There is no occupancy-data on this departure.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "EMPTY",
+              "description": "The vehicle is considered empty by most measures, and has few or no passengers onboard, but is\nstill accepting passengers. There isn't a big difference between this and MANY_SEATS_AVAILABLE\nso it's possible to handle them as the same value, if one wants to limit the number of different\nvalues.\nSIRI nordic profile: merge these into `MANY_SEATS_AVAILABLE`.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "MANY_SEATS_AVAILABLE",
+              "description": "The vehicle or carriage has a large number of seats available. The amount of free seats out of\nthe total seats available to be considered large enough to fall into this category is\ndetermined at the discretion of the producer. There isn't a big difference between this and\nEMPTY so it's possible to handle them as the same value, if one wants to limit the number of\ndifferent values.\nSIRI nordic profile: more than ~50% of seats available.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "FEW_SEATS_AVAILABLE",
+              "description": "The vehicle or carriage has a small number of seats available. The amount of free seats out of\nthe total seats available to be considered small enough to fall into this category is\ndetermined at the discretion of the producer.\nSIRI nordic profile: less than ~50% of seats available.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "STANDING_ROOM_ONLY",
+              "description": "The vehicle or carriage can currently accommodate only standing passengers.\nSIRI nordic profile: less than ~10% of seats available.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "CRUSHED_STANDING_ROOM_ONLY",
+              "description": "The vehicle or carriage can currently accommodate only standing passengers and has limited\nspace for them. There isn't a big difference between this and FULL so it's possible to handle\nthem as the same value, if one wants to limit the number of different values.\nSIRI nordic profile: merge into `STANDING_ROOM_ONLY`.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "FULL",
+              "description": "The vehicle is considered full by most measures, but may still be allowing passengers to\nboard.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "NOT_ACCEPTING_PASSENGERS",
+              "description": "The vehicle or carriage is not accepting passengers.\nSIRI nordic profile: if vehicle/carriage is not in use / unavailable, or passengers are only allowed\nto alight due to e.g. crowding.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "OpeningHours",
@@ -5912,7 +6032,7 @@
                 },
                 {
                   "name": "filterByPlaceTypes",
-                  "description": "Only return places that are one of these types, e.g. `STOP` or `BICYCLE_RENT`",
+                  "description": "Only return places that are one of these types, e.g. `STOP` or `VEHICLE_RENT`",
                   "type": {
                     "kind": "LIST",
                     "name": null,
@@ -7684,6 +7804,24 @@
               "description": null,
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "ENTER_STATION",
+              "description": null,
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "EXIT_STATION",
+              "description": null,
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "FOLLOW_SIGNS",
+              "description": null,
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "possibleTypes": null
@@ -7838,6 +7976,57 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "RentalVehicleEntityCounts",
+          "description": null,
+          "fields": [
+            {
+              "name": "total",
+              "description": "The total number of entities (e.g. vehicles, spaces).",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Int",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "byType",
+              "description": "The number of entities by type",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "LIST",
+                  "name": null,
+                  "ofType": {
+                    "kind": "NON_NULL",
+                    "name": null,
+                    "ofType": {
+                      "kind": "OBJECT",
+                      "name": "RentalVehicleTypeCount",
+                      "ofType": null
+                    }
+                  }
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "RentalVehicleType",
@@ -7873,6 +8062,49 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "RentalVehicleTypeCount",
+          "description": null,
+          "fields": [
+            {
+              "name": "vehicleType",
+              "description": "The type of the rental vehicle (scooter, bicycle, car...)",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "RentalVehicleType",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "count",
+              "description": "The number of vehicles of this type",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Int",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "RideHailingEstimate",
@@ -10369,6 +10601,18 @@
               },
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "occupancy",
+              "description": "The latest realtime occupancy information for the latest occurance of this\ntrip.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "TripOccupancy",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "inputFields": null,
@@ -10429,6 +10673,29 @@
           ],
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "TripOccupancy",
+          "description": "Occupancy of a vehicle on a trip. This should include the most recent occupancy information\navailable for a trip. Historic data might not be available.",
+          "fields": [
+            {
+              "name": "occupancyStatus",
+              "description": "Occupancy information mapped to a limited set of descriptive states.",
+              "args": [],
+              "type": {
+                "kind": "ENUM",
+                "name": "OccupancyStatus",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "Unknown",
@@ -11030,8 +11297,8 @@
                 "name": "Int",
                 "ofType": null
               },
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use `availableVehicles` instead, which also contains vehicle types"
             },
             {
               "name": "spacesAvailable",
@@ -11042,6 +11309,30 @@
                 "name": "Int",
                 "ofType": null
               },
+              "isDeprecated": true,
+              "deprecationReason": "Use `availableSpaces` instead, which also contains the space vehicle types"
+            },
+            {
+              "name": "availableVehicles",
+              "description": "Number of vehicles currently available on the rental station, grouped by vehicle type.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "RentalVehicleEntityCounts",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "availableSpaces",
+              "description": "Number of free spaces currently available on the rental station, grouped by vehicle type.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "RentalVehicleEntityCounts",
+                "ofType": null
+              },
               "isDeprecated": false,
               "deprecationReason": null
             },
@@ -12168,6 +12459,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "isOneOf",
+              "description": "This field is considered experimental because it has not yet been ratified in the graphql specification",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "specifiedByURL",
               "description": null,
@@ -13069,6 +13372,12 @@
               "defaultValue": null
             }
           ]
+        },
+        {
+          "name": "oneOf",
+          "description": "Indicates an Input Object is a OneOf Input Object.",
+          "locations": ["INPUT_OBJECT"],
+          "args": []
         }
       ]
     }