@stadiamaps/ferrostar 0.48.0 → 0.48.1

package/ferrostar.d.ts

@@ -1,31 +1,35 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * A geographic coordinate in WGS84.
+ * The type of incident that has occurred.
  */
-export interface GeographicCoordinate {
-    /**
-     * The latitude (in degrees).
-     */
-    lat: number;
-    /**
-     * The Longitude (in degrees).
-     */
-    lng: number;
-}
+export type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
 
 /**
- * The speed of the user from the location provider.
+ * Additional information to further specify a [`ManeuverType`].
  */
-export interface Speed {
+export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
+
+/**
+ * Information describing the series of steps needed to travel between two or more points.
+ *
+ * NOTE: This type is unstable and is still under active development and should be
+ * considered unstable.
+ */
+export interface Route {
+    geometry: GeographicCoordinate[];
+    bbox: BoundingBox;
     /**
-     * The user\'s speed in meters per second.
+     * The total route distance, in meters.
      */
-    value: number;
+    distance: number;
     /**
-     * The accuracy of the speed value, measured in meters per second.
+     * The ordered list of waypoints to visit, including the starting point.
+     * Note that this is distinct from the *geometry* which includes all points visited.
+     * A waypoint represents a start/end point for a route leg.
      */
-    accuracy: number | undefined;
+    waypoints: Waypoint[];
+    steps: RouteStep[];
 }
 
 /**
@@ -37,100 +41,6 @@ export interface LaneInfo {
     activeDirection: string | undefined;
 }
 
-/**
- * The content of a visual instruction.
- */
-export interface VisualInstructionContent {
-    /**
-     * The text to display.
-     */
-    text: string;
-    /**
-     * A standardized maneuver type (if any).
-     */
-    maneuverType: ManeuverType | undefined;
-    /**
-     * A standardized maneuver modifier (if any).
-     */
-    maneuverModifier: ManeuverModifier | undefined;
-    /**
-     * If applicable, the number of degrees you need to go around the roundabout before exiting.
-     *
-     * For example, entering and exiting the roundabout in the same direction of travel
-     * (as if you had gone straight, apart from the detour)
-     * would be an exit angle of 180 degrees.
-     */
-    roundaboutExitDegrees: number | undefined;
-    /**
-     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
-     */
-    laneInfo: LaneInfo[] | undefined;
-    /**
-     * The exit number (or similar identifier like \"8B\").
-     */
-    exitNumbers: string[];
-}
-
-/**
- * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
- *
- * Note that these do not have any locale information attached.
- */
-export interface SpokenInstruction {
-    /**
-     * Plain-text instruction which can be synthesized with a TTS engine.
-     */
-    text: string;
-    /**
-     * Speech Synthesis Markup Language, which should be preferred by clients capable of understanding it.
-     */
-    ssml: string | undefined;
-    /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being spoken.
-     */
-    triggerDistanceBeforeManeuver: number;
-    /**
-     * A unique identifier for this instruction.
-     *
-     * This is provided so that platform-layer integrations can easily disambiguate between distinct utterances,
-     * which may have the same textual content.
-     * UUIDs conveniently fill this purpose.
-     *
-     * NOTE: While it is possible to deterministically create UUIDs, we do not do so at this time.
-     * This should be theoretically possible though if someone cares to write up a proposal and a PR.
-     */
-    utteranceId: string;
-}
-
-/**
- * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
- */
-export interface VisualInstruction {
-    /**
-     * The primary instruction content.
-     *
-     * This is usually given more visual weight.
-     */
-    primaryContent: VisualInstructionContent;
-    /**
-     * Optional secondary instruction content.
-     */
-    secondaryContent: VisualInstructionContent | undefined;
-    /**
-     * Optional sub-maneuver instruction content.
-     */
-    subContent: VisualInstructionContent | undefined;
-    /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
-     */
-    triggerDistanceBeforeManeuver: number;
-}
-
-/**
- * The lane type blocked by the incident.
- */
-export type BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
-
 /**
  * A maneuver (such as a turn or merge) followed by travel of a certain distance until reaching
  * the next step.
@@ -193,26 +103,6 @@ export interface RouteStep {
     roundaboutExitNumber: number | undefined;
 }
 
-/**
- * The type of incident that has occurred.
- */
-export type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
-
-/**
- * The impact of the incident that has occurred.
- */
-export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
-
-/**
- * Describes characteristics of the waypoint for routing purposes.
- */
-export type WaypointKind = "Break" | "Via";
-
-/**
- * Additional information to further specify a [`ManeuverType`].
- */
-export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
-
 /**
  * The location of the user that is navigating.
  *
@@ -234,73 +124,27 @@ export interface UserLocation {
 }
 
 /**
- * Details about congestion for an incident.
+ * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
  */
-export interface Congestion {
+export interface VisualInstruction {
     /**
-     * The level of congestion caused by the incident.
-     *
-     * 0 = no congestion
-     *
-     * 100 = road closed
+     * The primary instruction content.
      *
-     * Other values mean no congestion was calculated
+     * This is usually given more visual weight.
      */
-    value: number;
-}
-
-/**
- * A geographic bounding box defined by its corners.
- */
-export interface BoundingBox {
+    primaryContent: VisualInstructionContent;
     /**
-     * The southwest corner of the bounding box.
+     * Optional secondary instruction content.
      */
-    sw: GeographicCoordinate;
+    secondaryContent: VisualInstructionContent | undefined;
     /**
-     * The northeast corner of the bounding box.
+     * Optional sub-maneuver instruction content.
      */
-    ne: GeographicCoordinate;
-}
-
-/**
- * A waypoint along a route.
- *
- * Within the context of Ferrostar, a route request consists of exactly one [`UserLocation`]
- * and at least one [`Waypoint`]. The route starts from the user\'s location (which may
- * contain other useful information like their current course for the [`crate::routing_adapters::RouteRequestGenerator`]
- * to use) and proceeds through one or more waypoints.
- *
- * Waypoints are used during route calculation, are tracked throughout the lifecycle of a trip,
- * and are used for recalculating when the user deviates from the expected route.
- *
- * Note that support for properties beyond basic geographic coordinates varies by routing engine.
- */
-export interface Waypoint {
-    coordinate: GeographicCoordinate;
-    kind: WaypointKind;
+    subContent: VisualInstructionContent | undefined;
     /**
-     * Optional additional properties that will be passed on to the [`crate::routing_adapters::RouteRequestGenerator`].
-     *
-     * Most users should prefer convenience functions like [`Waypoint::new_with_valhalla_properties`]
-     * (or, on platforms like iOS and Android with `UniFFI` bindings, [`crate::routing_adapters::valhalla::create_waypoint_with_valhalla_properties`]).
-     *
-     * # Format guidelines
-     *
-     * This MAY be any format agreed upon by both the request generator and response parser.
-     * However, to promote interoperability, all implementations in the Ferrostar codebase
-     * MUST use JSON.
-     *
-     * We selected JSON is selected not because it is good,
-     * but because generics (i.e., becoming `Waypoint<T>`, where an example `T` is `ValhallaProperties`)
-     * would be way too painful, particularly for foreign code.
-     * Especially JavaScript.
-     *
-     * In any case, [`crate::routing_adapters::RouteRequestGenerator`] and [`crate::routing_adapters::RouteResponseParser`]
-     * implementations SHOULD document their level support for this,
-     * ideally with an exportable record type.
+     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
      */
-    properties: number[] | undefined;
+    triggerDistanceBeforeManeuver: number;
 }
 
 /**
@@ -355,74 +199,237 @@ export interface Incident {
      */
     closed: boolean | undefined;
     /**
-     * The index into the [`RouteStep`] geometry where the incident starts.
+     * The index into the [`RouteStep`] geometry where the incident starts.
+     */
+    geometryIndexStart: number;
+    /**
+     * The index into the [`RouteStep`] geometry where the incident ends.
+     */
+    geometryIndexEnd: number | undefined;
+    /**
+     * Optional additional information about the type of incident (free-form text).
+     */
+    subType: string | undefined;
+    /**
+     * Optional descriptions about the type of incident (free-form text).
+     */
+    subTypeDescription: string | undefined;
+    /**
+     * The ISO 3166-1 alpha-2 code of the country in which the incident occurs.
+     */
+    iso31661Alpha2: string | undefined;
+    /**
+     * The ISO 3166-1 alpha-3 code of the country in which the incident occurs.
+     */
+    iso31661Alpha3: string | undefined;
+    /**
+     * A list of road names affected by the incident.
+     */
+    affectedRoadNames: string[];
+    /**
+     * The bounding box over which the incident occurs.
+     */
+    bbox: BoundingBox | undefined;
+}
+
+/**
+ * A geographic bounding box defined by its corners.
+ */
+export interface BoundingBox {
+    /**
+     * The southwest corner of the bounding box.
+     */
+    sw: GeographicCoordinate;
+    /**
+     * The northeast corner of the bounding box.
+     */
+    ne: GeographicCoordinate;
+}
+
+/**
+ * A geographic coordinate in WGS84.
+ */
+export interface GeographicCoordinate {
+    /**
+     * The latitude (in degrees).
+     */
+    lat: number;
+    /**
+     * The Longitude (in degrees).
+     */
+    lng: number;
+}
+
+/**
+ * A waypoint along a route.
+ *
+ * Within the context of Ferrostar, a route request consists of exactly one [`UserLocation`]
+ * and at least one [`Waypoint`]. The route starts from the user\'s location (which may
+ * contain other useful information like their current course for the [`crate::routing_adapters::RouteRequestGenerator`]
+ * to use) and proceeds through one or more waypoints.
+ *
+ * Waypoints are used during route calculation, are tracked throughout the lifecycle of a trip,
+ * and are used for recalculating when the user deviates from the expected route.
+ *
+ * Note that support for properties beyond basic geographic coordinates varies by routing engine.
+ */
+export interface Waypoint {
+    coordinate: GeographicCoordinate;
+    kind: WaypointKind;
+    /**
+     * Optional additional properties that will be passed on to the [`crate::routing_adapters::RouteRequestGenerator`].
+     *
+     * Most users should prefer convenience functions like [`Waypoint::new_with_valhalla_properties`]
+     * (or, on platforms like iOS and Android with `UniFFI` bindings, [`crate::routing_adapters::valhalla::create_waypoint_with_valhalla_properties`]).
+     *
+     * # Format guidelines
+     *
+     * This MAY be any format agreed upon by both the request generator and response parser.
+     * However, to promote interoperability, all implementations in the Ferrostar codebase
+     * MUST use JSON.
+     *
+     * We selected JSON is selected not because it is good,
+     * but because generics (i.e., becoming `Waypoint<T>`, where an example `T` is `ValhallaProperties`)
+     * would be way too painful, particularly for foreign code.
+     * Especially JavaScript.
+     *
+     * In any case, [`crate::routing_adapters::RouteRequestGenerator`] and [`crate::routing_adapters::RouteResponseParser`]
+     * implementations SHOULD document their level support for this,
+     * ideally with an exportable record type.
+     */
+    properties: number[] | undefined;
+}
+
+/**
+ * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
+ *
+ * Note that these do not have any locale information attached.
+ */
+export interface SpokenInstruction {
+    /**
+     * Plain-text instruction which can be synthesized with a TTS engine.
      */
-    geometryIndexStart: number;
+    text: string;
     /**
-     * The index into the [`RouteStep`] geometry where the incident ends.
+     * Speech Synthesis Markup Language, which should be preferred by clients capable of understanding it.
      */
-    geometryIndexEnd: number | undefined;
+    ssml: string | undefined;
     /**
-     * Optional additional information about the type of incident (free-form text).
+     * How far (in meters) from the upcoming maneuver the instruction should start being spoken.
      */
-    subType: string | undefined;
+    triggerDistanceBeforeManeuver: number;
     /**
-     * Optional descriptions about the type of incident (free-form text).
+     * A unique identifier for this instruction.
+     *
+     * This is provided so that platform-layer integrations can easily disambiguate between distinct utterances,
+     * which may have the same textual content.
+     * UUIDs conveniently fill this purpose.
+     *
+     * NOTE: While it is possible to deterministically create UUIDs, we do not do so at this time.
+     * This should be theoretically possible though if someone cares to write up a proposal and a PR.
      */
-    subTypeDescription: string | undefined;
+    utteranceId: string;
+}
+
+/**
+ * The direction in which the user/device is observed to be traveling.
+ */
+export interface CourseOverGround {
     /**
-     * The ISO 3166-1 alpha-2 code of the country in which the incident occurs.
+     * The direction in which the user\'s device is traveling, measured in clockwise degrees from
+     * true north (N = 0, E = 90, S = 180, W = 270).
      */
-    iso31661Alpha2: string | undefined;
+    degrees: number;
     /**
-     * The ISO 3166-1 alpha-3 code of the country in which the incident occurs.
+     * The accuracy of the course value, measured in degrees.
      */
-    iso31661Alpha3: string | undefined;
+    accuracy: number | undefined;
+}
+
+/**
+ * The broad class of maneuver to perform.
+ *
+ * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
+ */
+export type ManeuverType = "turn" | "new name" | "depart" | "arrive" | "merge" | "on ramp" | "off ramp" | "fork" | "end of road" | "continue" | "roundabout" | "rotary" | "roundabout turn" | "notification" | "exit roundabout" | "exit rotary";
+
+/**
+ * The speed of the user from the location provider.
+ */
+export interface Speed {
     /**
-     * A list of road names affected by the incident.
+     * The user\'s speed in meters per second.
      */
-    affectedRoadNames: string[];
+    value: number;
     /**
-     * The bounding box over which the incident occurs.
+     * The accuracy of the speed value, measured in meters per second.
      */
-    bbox: BoundingBox | undefined;
+    accuracy: number | undefined;
 }
 
 /**
- * Information describing the series of steps needed to travel between two or more points.
- *
- * NOTE: This type is unstable and is still under active development and should be
- * considered unstable.
+ * The impact of the incident that has occurred.
  */
-export interface Route {
-    geometry: GeographicCoordinate[];
-    bbox: BoundingBox;
-    /**
-     * The total route distance, in meters.
-     */
-    distance: number;
+export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
+
+/**
+ * Details about congestion for an incident.
+ */
+export interface Congestion {
     /**
-     * The ordered list of waypoints to visit, including the starting point.
-     * Note that this is distinct from the *geometry* which includes all points visited.
-     * A waypoint represents a start/end point for a route leg.
+     * The level of congestion caused by the incident.
+     *
+     * 0 = no congestion
+     *
+     * 100 = road closed
+     *
+     * Other values mean no congestion was calculated
      */
-    waypoints: Waypoint[];
-    steps: RouteStep[];
+    value: number;
 }
 
 /**
- * The direction in which the user/device is observed to be traveling.
+ * The lane type blocked by the incident.
  */
-export interface CourseOverGround {
+export type BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
+
+/**
+ * Describes characteristics of the waypoint for routing purposes.
+ */
+export type WaypointKind = "Break" | "Via";
+
+/**
+ * The content of a visual instruction.
+ */
+export interface VisualInstructionContent {
     /**
-     * The direction in which the user\'s device is traveling, measured in clockwise degrees from
-     * true north (N = 0, E = 90, S = 180, W = 270).
+     * The text to display.
      */
-    degrees: number;
+    text: string;
     /**
-     * The accuracy of the course value, measured in degrees.
+     * A standardized maneuver type (if any).
      */
-    accuracy: number | undefined;
+    maneuverType: ManeuverType | undefined;
+    /**
+     * A standardized maneuver modifier (if any).
+     */
+    maneuverModifier: ManeuverModifier | undefined;
+    /**
+     * If applicable, the number of degrees you need to go around the roundabout before exiting.
+     *
+     * For example, entering and exiting the roundabout in the same direction of travel
+     * (as if you had gone straight, apart from the detour)
+     * would be an exit angle of 180 degrees.
+     */
+    roundaboutExitDegrees: number | undefined;
+    /**
+     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
+     */
+    laneInfo: LaneInfo[] | undefined;
+    /**
+     * The exit number (or similar identifier like \"8B\").
+     */
+    exitNumbers: string[];
 }
 
 /**
@@ -434,25 +441,11 @@ export interface CourseOverGround {
  */
 export type DrivingSide = "left" | "right";
 
-/**
- * The broad class of maneuver to perform.
- *
- * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
- */
-export type ManeuverType = "turn" | "new name" | "depart" | "arrive" | "merge" | "on ramp" | "off ramp" | "fork" | "end of road" | "continue" | "roundabout" | "rotary" | "roundabout turn" | "notification" | "exit roundabout" | "exit rotary";
-
 /**
  * Configurations for built-in route providers.
  */
 export type WellKnownRouteProvider = { Valhalla: { endpointUrl: string; profile: string; optionsJson?: string | undefined } } | { GraphHopper: { endpointUrl: string; profile: string; locale: string; voiceUnits: GraphHopperVoiceUnits; optionsJson?: string | undefined } };
 
-/**
- * The event type.
- *
- * For full replayability, we record things like rerouting, and not just location updates.
- */
-export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
-
 /**
  * An event that occurs during navigation.
  *
@@ -469,14 +462,19 @@ export interface NavigationRecordingEvent {
     event_data: NavigationRecordingEventData;
 }
 
+/**
+ * The event type.
+ *
+ * For full replayability, we record things like rerouting, and not just location updates.
+ */
+export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+
 /**
  * Controls how simulated locations deviate from the actual route line.
  * This simulates real-world GPS behavior where readings often have systematic bias.
  */
 export type LocationBias = { Left: number } | { Right: number } | { Random: number } | "None";
 
-export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
-
 /**
  * The current state of the simulation.
  */
@@ -486,6 +484,8 @@ export interface LocationSimulationState {
     bias: LocationBias;
 }
 
+export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
+
 /**
  * A set of optional filters to exclude candidate edges based on their attributes.
  */
@@ -530,6 +530,13 @@ export interface ValhallaLocationSearchFilter {
     level?: number;
 }
 
+/**
+ * A road class in the Valhalla taxonomy.
+ *
+ * These are ordered from highest (fastest travel speed) to lowest.
+ */
+export type ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
+
 /**
  * Waypoint properties supported by Valhalla servers.
  *
@@ -636,13 +643,6 @@ export interface ValhallaWaypointProperties {
     allow_uturns: boolean | undefined;
 }
 
-/**
- * A road class in the Valhalla taxonomy.
- *
- * These are ordered from highest (fastest travel speed) to lowest.
- */
-export type ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
-
 /**
  * Specifies a preferred side for departing from / arriving at a location.
  *
@@ -692,25 +692,47 @@ export type SerializableStepAdvanceCondition = "Manual" | { DistanceToEndOfStep:
 export type GraphHopperVoiceUnits = "metric" | "imperial";
 
 /**
- * High-level state describing progress through a route.
+ * The state of a navigation session.
+ *
+ * This is produced by [`NavigationController`](super::NavigationController) methods
+ * including [`get_initial_state`](super::NavigationController::get_initial_state)
+ * and [`update_user_location`](super::NavigationController::update_user_location).
  */
-export interface TripProgress {
+export type TripState = { Idle: { user_location: UserLocation | undefined } } | { Navigating: { currentStepGeometryIndex: number | undefined; userLocation: UserLocation; snappedUserLocation: UserLocation; remainingSteps: RouteStep[]; remainingWaypoints: Waypoint[]; progress: TripProgress; summary: TripSummary; deviation: RouteDeviation; visualInstruction: VisualInstruction | undefined; spokenInstruction: SpokenInstruction | undefined; annotationJson: string | undefined } } | { Complete: { user_location: UserLocation; summary: TripSummary } };
+
+/**
+ * Information pertaining to the user\'s full navigation trip. This includes
+ * simple stats like total duration and distance.
+ */
+export interface TripSummary {
     /**
-     * The distance to the next maneuver, in meters.
+     * The total raw distance traveled in the trip, in meters.
      */
-    distanceToNextManeuver: number;
+    distanceTraveled: number;
     /**
-     * The total distance remaining in the trip, in meters.
-     *
-     * This is the sum of the distance remaining in the current step and the distance remaining in all subsequent steps.
+     * The total snapped distance traveled in the trip, in meters.
      */
-    distanceRemaining: number;
+    snappedDistanceTraveled: number;
     /**
-     * The total duration remaining in the trip, in seconds.
+     * When the trip was started.
      */
-    durationRemaining: number;
+    startedAt: Date;
+    /**
+     * When the trip was completed or canceled.
+     */
+    endedAt: Date | null;
+}
+
+export interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
 }
 
+/**
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
+ */
+export type CourseFiltering = "SnapToRoute" | "Raw";
+
 export interface SerializableNavigationControllerConfig {
     /**
      * Configures when navigation advances to the next waypoint in the route.
@@ -741,15 +763,6 @@ export interface SerializableNavigationControllerConfig {
     snappedLocationCourseFiltering: CourseFiltering;
 }
 
-/**
- * The state of a navigation session.
- *
- * This is produced by [`NavigationController`](super::NavigationController) methods
- * including [`get_initial_state`](super::NavigationController::get_initial_state)
- * and [`update_user_location`](super::NavigationController::update_user_location).
- */
-export type TripState = { Idle: { user_location: UserLocation | undefined } } | { Navigating: { currentStepGeometryIndex: number | undefined; userLocation: UserLocation; snappedUserLocation: UserLocation; remainingSteps: RouteStep[]; remainingWaypoints: Waypoint[]; progress: TripProgress; summary: TripSummary; deviation: RouteDeviation; visualInstruction: VisualInstruction | undefined; spokenInstruction: SpokenInstruction | undefined; annotationJson: string | undefined } } | { Complete: { user_location: UserLocation; summary: TripSummary } };
-
 /**
  * Controls when a waypoint should be marked as complete.
  *
@@ -772,36 +785,23 @@ export type TripState = { Idle: { user_location: UserLocation | undefined } } |
 export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
 
 /**
- * Information pertaining to the user\'s full navigation trip. This includes
- * simple stats like total duration and distance.
+ * High-level state describing progress through a route.
  */
-export interface TripSummary {
-    /**
-     * The total raw distance traveled in the trip, in meters.
-     */
-    distanceTraveled: number;
+export interface TripProgress {
     /**
-     * The total snapped distance traveled in the trip, in meters.
+     * The distance to the next maneuver, in meters.
      */
-    snappedDistanceTraveled: number;
+    distanceToNextManeuver: number;
     /**
-     * When the trip was started.
+     * The total distance remaining in the trip, in meters.
+     *
+     * This is the sum of the distance remaining in the current step and the distance remaining in all subsequent steps.
      */
-    startedAt: Date;
+    distanceRemaining: number;
     /**
-     * When the trip was completed or canceled.
+     * The total duration remaining in the trip, in seconds.
      */
-    endedAt: Date | null;
-}
-
-/**
- * Controls filtering/post-processing of user course by the [`NavigationController`].
- */
-export type CourseFiltering = "SnapToRoute" | "Raw";
-
-export interface SerializableNavState {
-    tripState: TripState;
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
+    durationRemaining: number;
 }
 
 

package/package.json

@@ -7,7 +7,7 @@
     "Luke Seelenbinder <luke@stadiamaps.com>"
   ],
   "description": "The core of modern turn-by-turn navigation.",
-  "version": "0.48.0",
+  "version": "0.48.1",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",