@stadiamaps/ferrostar 0.47.1 → 0.48.0

package/ferrostar.d.ts

@@ -1,30 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * The location of the user that is navigating.
- *
- * In addition to coordinates, this includes estimated accuracy and course information,
- * which can influence navigation logic and UI.
- *
- * NOTE: Heading is absent on purpose.
- * Heading updates are not related to a change in the user\'s location.
- */
-export interface UserLocation {
-    coordinates: GeographicCoordinate;
-    /**
-     * The estimated accuracy of the coordinate (in meters)
-     */
-    horizontalAccuracy: number;
-    courseOverGround: CourseOverGround | undefined;
-    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
-    speed: Speed | 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";
-
 /**
  * A geographic coordinate in WGS84.
  */
@@ -40,173 +15,60 @@ export interface GeographicCoordinate {
 }
 
 /**
- * A geographic bounding box defined by its corners.
+ * The speed of the user from the location provider.
  */
-export interface BoundingBox {
+export interface Speed {
     /**
-     * The southwest corner of the bounding box.
+     * The user\'s speed in meters per second.
      */
-    sw: GeographicCoordinate;
+    value: number;
     /**
-     * The northeast corner of the bounding box.
+     * The accuracy of the speed value, measured in meters per second.
      */
-    ne: GeographicCoordinate;
+    accuracy: number | undefined;
 }
 
 /**
- * An incident affecting the free flow of traffic,
- * such as constructions, accidents, and congestion.
+ * The content of a visual instruction.
  */
-export interface Incident {
-    /**
-     * A unique identifier for the incident.
-     */
-    id: string;
+export interface LaneInfo {
+    active: boolean;
+    directions: string[];
+    activeDirection: string | undefined;
+}
+
+/**
+ * The content of a visual instruction.
+ */
+export interface VisualInstructionContent {
     /**
-     * The type of incident.
+     * The text to display.
      */
-    incidentType: IncidentType;
+    text: string;
     /**
-     * A short description of the incident.
+     * A standardized maneuver type (if any).
      */
-    description: string | undefined;
+    maneuverType: ManeuverType | undefined;
     /**
-     * A longer description of the incident.
+     * A standardized maneuver modifier (if any).
      */
-    longDescription: string | undefined;
+    maneuverModifier: ManeuverModifier | undefined;
     /**
-     * The time at which the incident was *last* created.
+     * If applicable, the number of degrees you need to go around the roundabout before exiting.
      *
-     * NB: This can change throughout the life of the incident.
-     */
-    creationTime: Date | null;
-    /**
-     * The time at which the incident started or is expected to start (ex: planned closure).
-     */
-    startTime: Date | null;
-    /**
-     * The time at which the incident ended or is expected to end.
-     */
-    endTime: Date | null;
-    /**
-     * The level of impact to traffic.
-     */
-    impact: Impact | undefined;
-    /**
-     * Lanes which are blocked by the incident.
-     */
-    lanesBlocked: BlockedLane[];
-    /**
-     * Info about the amount of congestion on the road around the incident.
-     */
-    congestion: Congestion | undefined;
-    /**
-     * Is the road completely closed?
-     */
-    closed: boolean | undefined;
-    /**
-     * 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;
-}
-
-/**
- * Which side of the road traffic drives on.
- *
- * This is needed by consumers like Android Auto to determine whether
- * a roundabout should be rendered as clockwise (right-hand traffic)
- * or counterclockwise (left-hand traffic).
- */
-export type DrivingSide = "left" | "right";
-
-/**
- * The direction in which the user/device is observed to be traveling.
- */
-export interface CourseOverGround {
-    /**
-     * 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).
+     * 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.
      */
-    degrees: number;
+    roundaboutExitDegrees: number | undefined;
     /**
-     * The accuracy of the course value, measured in degrees.
+     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
      */
-    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";
-
-/**
- * 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;
+    laneInfo: LaneInfo[] | 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.
+     * The exit number (or similar identifier like \"8B\").
      */
-    properties: number[] | undefined;
+    exitNumbers: string[];
 }
 
 /**
@@ -241,39 +103,34 @@ export interface SpokenInstruction {
 }
 
 /**
- * The content of a visual instruction.
+ * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
  */
-export interface VisualInstructionContent {
-    /**
-     * The text to display.
-     */
-    text: string;
-    /**
-     * A standardized maneuver type (if any).
-     */
-    maneuverType: ManeuverType | undefined;
+export interface VisualInstruction {
     /**
-     * A standardized maneuver modifier (if any).
+     * The primary instruction content.
+     *
+     * This is usually given more visual weight.
      */
-    maneuverModifier: ManeuverModifier | undefined;
+    primaryContent: VisualInstructionContent;
     /**
-     * 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.
+     * Optional secondary instruction content.
      */
-    roundaboutExitDegrees: number | undefined;
+    secondaryContent: VisualInstructionContent | undefined;
     /**
-     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
+     * Optional sub-maneuver instruction content.
      */
-    laneInfo: LaneInfo[] | undefined;
+    subContent: VisualInstructionContent | undefined;
     /**
-     * The exit number (or similar identifier like \"8B\").
+     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
      */
-    exitNumbers: string[];
+    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.
@@ -337,13 +194,9 @@ export interface RouteStep {
 }
 
 /**
- * The content of a visual instruction.
+ * The type of incident that has occurred.
  */
-export interface LaneInfo {
-    active: boolean;
-    directions: string[];
-    activeDirection: string | undefined;
-}
+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.
@@ -351,28 +204,9 @@ export interface LaneInfo {
 export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
 
 /**
- * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
+ * Describes characteristics of the waypoint for routing purposes.
  */
-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;
-}
+export type WaypointKind = "Break" | "Via";
 
 /**
  * Additional information to further specify a [`ManeuverType`].
@@ -380,44 +214,23 @@ export interface VisualInstruction {
 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.
+ * The location of the user that is navigating.
  *
- * NOTE: This type is unstable and is still under active development and should be
- * considered unstable.
- */
-export interface Route {
-    geometry: GeographicCoordinate[];
-    bbox: BoundingBox;
-    /**
-     * The total route distance, in meters.
-     */
-    distance: number;
-    /**
-     * 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.
-     */
-    waypoints: Waypoint[];
-    steps: RouteStep[];
-}
-
-/**
- * The lane type blocked by the incident.
- */
-export type BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
-
-/**
- * The speed of the user from the location provider.
+ * In addition to coordinates, this includes estimated accuracy and course information,
+ * which can influence navigation logic and UI.
+ *
+ * NOTE: Heading is absent on purpose.
+ * Heading updates are not related to a change in the user\'s location.
  */
-export interface Speed {
-    /**
-     * The user\'s speed in meters per second.
-     */
-    value: number;
+export interface UserLocation {
+    coordinates: GeographicCoordinate;
     /**
-     * The accuracy of the speed value, measured in meters per second.
+     * The estimated accuracy of the coordinate (in meters)
      */
-    accuracy: number | undefined;
+    horizontalAccuracy: number;
+    courseOverGround: CourseOverGround | undefined;
+    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
+    speed: Speed | undefined;
 }
 
 /**
@@ -437,128 +250,223 @@ export interface Congestion {
 }
 
 /**
- * Describes characteristics of the waypoint for routing purposes.
- */
-export type WaypointKind = "Break" | "Via";
-
-/**
- * Configurations for built-in route providers.
+ * A geographic bounding box defined by its corners.
  */
-export type WellKnownRouteProvider = { Valhalla: { endpointUrl: string; profile: string; optionsJson?: string | undefined } } | { GraphHopper: { endpointUrl: string; profile: string; locale: string; voiceUnits: GraphHopperVoiceUnits; optionsJson?: string | undefined } };
-
-export type GraphHopperVoiceUnits = "metric" | "imperial";
+export interface BoundingBox {
+    /**
+     * The southwest corner of the bounding box.
+     */
+    sw: GeographicCoordinate;
+    /**
+     * The northeast corner of the bounding box.
+     */
+    ne: GeographicCoordinate;
+}
 
 /**
- * The state of a navigation session.
+ * A waypoint along a route.
  *
- * 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).
+ * 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 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 } };
+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;
+}
 
 /**
- * High-level state describing progress through a route.
+ * An incident affecting the free flow of traffic,
+ * such as constructions, accidents, and congestion.
  */
-export interface TripProgress {
+export interface Incident {
     /**
-     * The distance to the next maneuver, in meters.
+     * A unique identifier for the incident.
      */
-    distanceToNextManeuver: number;
+    id: string;
     /**
-     * The total distance remaining in the trip, in meters.
+     * The type of incident.
+     */
+    incidentType: IncidentType;
+    /**
+     * A short description of the incident.
+     */
+    description: string | undefined;
+    /**
+     * A longer description of the incident.
+     */
+    longDescription: string | undefined;
+    /**
+     * The time at which the incident was *last* created.
      *
-     * This is the sum of the distance remaining in the current step and the distance remaining in all subsequent steps.
+     * NB: This can change throughout the life of the incident.
      */
-    distanceRemaining: number;
+    creationTime: Date | null;
     /**
-     * The total duration remaining in the trip, in seconds.
+     * The time at which the incident started or is expected to start (ex: planned closure).
      */
-    durationRemaining: number;
+    startTime: Date | null;
+    /**
+     * The time at which the incident ended or is expected to end.
+     */
+    endTime: Date | null;
+    /**
+     * The level of impact to traffic.
+     */
+    impact: Impact | undefined;
+    /**
+     * Lanes which are blocked by the incident.
+     */
+    lanesBlocked: BlockedLane[];
+    /**
+     * Info about the amount of congestion on the road around the incident.
+     */
+    congestion: Congestion | undefined;
+    /**
+     * Is the road completely closed?
+     */
+    closed: boolean | undefined;
+    /**
+     * 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;
 }
 
 /**
- * Controls filtering/post-processing of user course by the [`NavigationController`].
+ * 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 type CourseFiltering = "SnapToRoute" | "Raw";
-
-export interface SerializableNavigationControllerConfig {
-    /**
-     * Configures when navigation advances to the next waypoint in the route.
-     */
-    waypointAdvance: WaypointAdvanceMode;
+export interface Route {
+    geometry: GeographicCoordinate[];
+    bbox: BoundingBox;
     /**
-     * Configures when navigation advances to the next step in the route.
+     * The total route distance, in meters.
      */
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
+    distance: number;
     /**
-     * A special advance condition used for the final 2 route steps (last and arrival).
-     *
-     * This exists because several of our step advance conditions require entry and
-     * exit from a step\'s geometry. The end of the route/arrival doesn\'t always accommodate
-     * the expected location updates for the core step advance condition.
+     * 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.
      */
-    arrivalStepAdvanceCondition: SerializableStepAdvanceCondition;
+    waypoints: Waypoint[];
+    steps: RouteStep[];
+}
+
+/**
+ * The direction in which the user/device is observed to be traveling.
+ */
+export interface CourseOverGround {
     /**
-     * Configures when the user is deemed to be off course.
-     *
-     * NOTE: This is distinct from the action that is taken.
-     * It is only the determination that the user has deviated from the expected route.
+     * 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).
      */
-    routeDeviationTracking: RouteDeviationTracking;
+    degrees: number;
     /**
-     * Configures how the heading component of the snapped location is reported in [`TripState`].
+     * The accuracy of the course value, measured in degrees.
      */
-    snappedLocationCourseFiltering: CourseFiltering;
+    accuracy: number | undefined;
 }
 
 /**
- * Controls when a waypoint should be marked as complete.
- *
- * While a route may consist of thousands of points, waypoints are special.
- * A simple trip will have only one waypoint: the final destination.
- * A more complex trip may have several intermediate stops.
- * Just as the navigation state keeps track of which steps remain in the route,
- * it also tracks which waypoints are still remaining.
+ * Which side of the road traffic drives on.
  *
- * Tracking waypoints enables Ferrostar to reroute users when they stray off the route line.
- * The waypoint advance mode specifies how the framework decides
- * that a waypoint has been visited (and is removed from the list).
+ * This is needed by consumers like Android Auto to determine whether
+ * a roundabout should be rendered as clockwise (right-hand traffic)
+ * or counterclockwise (left-hand traffic).
+ */
+export type DrivingSide = "left" | "right";
+
+/**
+ * The broad class of maneuver to perform.
  *
- * NOTE: Advancing to the next *step* and advancing to the next *waypoint*
- * are separate processes.
- * This will not normally cause any issues, but keep in mind that
- * manually advancing to the next step does not *necessarily* imply
- * that the waypoint will be marked as complete!
+ * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
  */
-export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
+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";
 
-export interface SerializableNavState {
-    tripState: TripState;
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
-}
+/**
+ * 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 } };
 
 /**
- * Information pertaining to the user\'s full navigation trip. This includes
- * simple stats like total duration and distance.
+ * An event that occurs during navigation.
+ *
+ * This is used for the optional session recording / telemetry.
  */
-export interface TripSummary {
-    /**
-     * The total raw distance traveled in the trip, in meters.
-     */
-    distanceTraveled: number;
-    /**
-     * The total snapped distance traveled in the trip, in meters.
-     */
-    snappedDistanceTraveled: number;
+export interface NavigationRecordingEvent {
     /**
-     * When the trip was started.
+     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
      */
-    startedAt: Date;
+    timestamp: number;
     /**
-     * When the trip was completed or canceled.
+     * Data associated with the event.
      */
-    endedAt: Date | null;
+    event_data: NavigationRecordingEventData;
 }
 
 /**
@@ -579,15 +487,48 @@ export interface LocationSimulationState {
 }
 
 /**
- * Specifies a preferred side for departing from / arriving at a location.
- *
- * Examples:
- * - Germany drives on the right side of the road. A value of `same` will only allow leaving
- *   or arriving at a location such that it is on your right.
- * - Australia drives on the left side of the road. Passing a value of `same` will only allow
- *   leaving or arriving at a location such that it is on your left.
+ * A set of optional filters to exclude candidate edges based on their attributes.
  */
-export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
+export interface ValhallaLocationSearchFilter {
+    /**
+     * Whether to exclude roads marked as tunnels.
+     */
+    exclude_tunnel?: boolean;
+    /**
+     * Whether to exclude roads marked as bridges.
+     */
+    exclude_bridge?: boolean;
+    /**
+     * Whether to exclude roads with tolls.
+     */
+    exclude_tolls?: boolean;
+    /**
+     * Whether to exclude ferries.
+     */
+    exclude_ferry?: boolean;
+    /**
+     * Whether to exclude roads marked as ramps.
+     */
+    exclude_ramp?: boolean;
+    /**
+     * Whether to exclude roads marked as closed due to a live traffic closure.
+     */
+    exclude_closures?: boolean;
+    /**
+     * The lowest road class allowed.
+     */
+    min_road_class?: ValhallaRoadClass;
+    /**
+     * The highest road class allowed.
+     */
+    max_road_class?: ValhallaRoadClass;
+    /**
+     * If specified, will only consider edges that are on or traverse the passed floor level.
+     * It will set `search_cutoff` to a default value of 300 meters if no cutoff value is passed.
+     * Additionally, if a `search_cutoff` is passed, it will be clamped to 1000 meters.
+     */
+    level?: number;
+}
 
 /**
  * Waypoint properties supported by Valhalla servers.
@@ -685,6 +626,14 @@ export interface ValhallaWaypointProperties {
      * A set of optional filters to exclude candidate edges based on their attributes.
      */
     search_filter: ValhallaLocationSearchFilter | undefined;
+    /**
+     * Determines whether U-Turns are allowed at the waypoint
+     * (if it is an intermediate waypoint, not the first or last).
+     *
+     * Defaults to `true`. This has the effect of converting a [`WaypointKind::Break`]
+     * into a Valhalla `break_through`, and a [`WaypointKind::Via`] into a `through`.
+     */
+    allow_uturns: boolean | undefined;
 }
 
 /**
@@ -695,106 +644,165 @@ export interface ValhallaWaypointProperties {
 export type ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
 
 /**
- * A set of optional filters to exclude candidate edges based on their attributes.
+ * Specifies a preferred side for departing from / arriving at a location.
+ *
+ * Examples:
+ * - Germany drives on the right side of the road. A value of `same` will only allow leaving
+ *   or arriving at a location such that it is on your right.
+ * - Australia drives on the left side of the road. Passing a value of `same` will only allow
+ *   leaving or arriving at a location such that it is on your left.
  */
-export interface ValhallaLocationSearchFilter {
+export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
+
+/**
+ * Waypoint properties parsed from an OSRM-compatible server response.
+ *
+ * NOTE: Some servers (such as Valhalla) may support additional parameters at request time
+ * which are _not_ echoed back in the response time.
+ * This is unfortunate; PRs upstream would likely be welcomed!
+ * Similarly, if your server is OSRM-compatible and returns additional attributes,
+ * feel free to open a PR to include these as optional properties.
+ */
+export interface OsrmWaypointProperties {
     /**
-     * Whether to exclude roads marked as tunnels.
+     * The name of the street that the waypoint snapped to.
      */
-    exclude_tunnel?: boolean;
+    name: string | undefined;
     /**
-     * Whether to exclude roads marked as bridges.
+     * The distance (in meters) between the snapped point and the input coordinate.
      */
-    exclude_bridge?: boolean;
+    distance: number | undefined;
+}
+
+/**
+ * Determines if the user has deviated from the expected route.
+ */
+export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
+
+/**
+ * Status information that describes whether the user is proceeding according to the route or not.
+ *
+ * Note that the name is intentionally a bit generic to allow for expansion of other states.
+ * For example, we could conceivably add a \"wrong way\" status in the future.
+ */
+export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLine: number } };
+
+export type SerializableStepAdvanceCondition = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceFromStep: { distance: number; minimumHorizontalAccuracy: number; calculateWhileOffRoute: boolean } } | { DistanceEntryExit: { distanceToEndOfStep: number; distanceAfterEndStep: number; minimumHorizontalAccuracy: number; hasReachedEndOfCurrentStep: boolean } } | { DistanceEntryAndSnappedExit: { distanceToEndOfStep: number; distanceAfterEndStep: number; minimumHorizontalAccuracy: number; hasReachedEndOfCurrentStep: boolean } } | { OrAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } } | { AndAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } };
+
+export type GraphHopperVoiceUnits = "metric" | "imperial";
+
+/**
+ * High-level state describing progress through a route.
+ */
+export interface TripProgress {
     /**
-     * Whether to exclude roads with tolls.
+     * The distance to the next maneuver, in meters.
      */
-    exclude_tolls?: boolean;
+    distanceToNextManeuver: number;
     /**
-     * Whether to exclude ferries.
+     * 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.
      */
-    exclude_ferry?: boolean;
+    distanceRemaining: number;
     /**
-     * Whether to exclude roads marked as ramps.
+     * The total duration remaining in the trip, in seconds.
      */
-    exclude_ramp?: boolean;
+    durationRemaining: number;
+}
+
+export interface SerializableNavigationControllerConfig {
     /**
-     * Whether to exclude roads marked as closed due to a live traffic closure.
+     * Configures when navigation advances to the next waypoint in the route.
      */
-    exclude_closures?: boolean;
+    waypointAdvance: WaypointAdvanceMode;
     /**
-     * The lowest road class allowed.
+     * Configures when navigation advances to the next step in the route.
      */
-    min_road_class?: ValhallaRoadClass;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
     /**
-     * The highest road class allowed.
+     * A special advance condition used for the final 2 route steps (last and arrival).
+     *
+     * This exists because several of our step advance conditions require entry and
+     * exit from a step\'s geometry. The end of the route/arrival doesn\'t always accommodate
+     * the expected location updates for the core step advance condition.
      */
-    max_road_class?: ValhallaRoadClass;
+    arrivalStepAdvanceCondition: SerializableStepAdvanceCondition;
     /**
-     * If specified, will only consider edges that are on or traverse the passed floor level.
-     * It will set `search_cutoff` to a default value of 300 meters if no cutoff value is passed.
-     * Additionally, if a `search_cutoff` is passed, it will be clamped to 1000 meters.
+     * Configures when the user is deemed to be off course.
+     *
+     * NOTE: This is distinct from the action that is taken.
+     * It is only the determination that the user has deviated from the expected route.
      */
-    level?: number;
+    routeDeviationTracking: RouteDeviationTracking;
+    /**
+     * Configures how the heading component of the snapped location is reported in [`TripState`].
+     */
+    snappedLocationCourseFiltering: CourseFiltering;
 }
 
 /**
- * The event type.
+ * The state of a navigation session.
  *
- * For full replayability, we record things like rerouting, and not just location updates.
+ * 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 NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+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 } };
 
 /**
- * An event that occurs during navigation.
+ * Controls when a waypoint should be marked as complete.
  *
- * This is used for the optional session recording / telemetry.
+ * While a route may consist of thousands of points, waypoints are special.
+ * A simple trip will have only one waypoint: the final destination.
+ * A more complex trip may have several intermediate stops.
+ * Just as the navigation state keeps track of which steps remain in the route,
+ * it also tracks which waypoints are still remaining.
+ *
+ * Tracking waypoints enables Ferrostar to reroute users when they stray off the route line.
+ * The waypoint advance mode specifies how the framework decides
+ * that a waypoint has been visited (and is removed from the list).
+ *
+ * NOTE: Advancing to the next *step* and advancing to the next *waypoint*
+ * are separate processes.
+ * This will not normally cause any issues, but keep in mind that
+ * manually advancing to the next step does not *necessarily* imply
+ * that the waypoint will be marked as complete!
  */
-export interface NavigationRecordingEvent {
+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.
+ */
+export interface TripSummary {
     /**
-     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
+     * The total raw distance traveled in the trip, in meters.
      */
-    timestamp: number;
+    distanceTraveled: number;
     /**
-     * Data associated with the event.
+     * The total snapped distance traveled in the trip, in meters.
      */
-    event_data: NavigationRecordingEventData;
-}
-
-/**
- * Waypoint properties parsed from an OSRM-compatible server response.
- *
- * NOTE: Some servers (such as Valhalla) may support additional parameters at request time
- * which are _not_ echoed back in the response time.
- * This is unfortunate; PRs upstream would likely be welcomed!
- * Similarly, if your server is OSRM-compatible and returns additional attributes,
- * feel free to open a PR to include these as optional properties.
- */
-export interface OsrmWaypointProperties {
+    snappedDistanceTraveled: number;
     /**
-     * The name of the street that the waypoint snapped to.
+     * When the trip was started.
      */
-    name: string | undefined;
+    startedAt: Date;
     /**
-     * The distance (in meters) between the snapped point and the input coordinate.
+     * When the trip was completed or canceled.
      */
-    distance: number | undefined;
+    endedAt: Date | null;
 }
 
 /**
- * Status information that describes whether the user is proceeding according to the route or not.
- *
- * Note that the name is intentionally a bit generic to allow for expansion of other states.
- * For example, we could conceivably add a \"wrong way\" status in the future.
- */
-export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLine: number } };
-
-/**
- * Determines if the user has deviated from the expected route.
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
-export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
+export type CourseFiltering = "SnapToRoute" | "Raw";
 
-export type SerializableStepAdvanceCondition = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceFromStep: { distance: number; minimumHorizontalAccuracy: number; calculateWhileOffRoute: boolean } } | { DistanceEntryExit: { distanceToEndOfStep: number; distanceAfterEndStep: number; minimumHorizontalAccuracy: number; hasReachedEndOfCurrentStep: boolean } } | { DistanceEntryAndSnappedExit: { distanceToEndOfStep: number; distanceAfterEndStep: number; minimumHorizontalAccuracy: number; hasReachedEndOfCurrentStep: boolean } } | { OrAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } } | { AndAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } };
+export interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
+}
 
 
 export class NavigationController {

package/package.json

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