@stadiamaps/ferrostar 0.46.1 → 0.47.2

package/ferrostar.d.ts

@@ -1,21 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Details about congestion for an incident.
- */
-export interface Congestion {
-    /**
-     * The level of congestion caused by the incident.
-     *
-     * 0 = no congestion
-     *
-     * 100 = road closed
-     *
-     * Other values mean no congestion was calculated
-     */
-    value: number;
-}
-
 /**
  * The location of the user that is navigating.
  *
@@ -37,19 +21,16 @@ export interface UserLocation {
 }
 
 /**
- * The direction in which the user/device is observed to be traveling.
+ * The type of incident that has occurred.
  */
-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).
-     */
-    degrees: number;
-    /**
-     * The accuracy of the course value, measured in degrees.
-     */
-    accuracy: number | undefined;
-}
+export type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
+
+/**
+ * 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";
 
 /**
  * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
@@ -83,55 +64,17 @@ export interface SpokenInstruction {
 }
 
 /**
- * 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 content of a visual instruction.
- */
-export interface LaneInfo {
-    active: boolean;
-    directions: string[];
-    activeDirection: string | undefined;
-}
-
-/**
- * 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.
+ * A geographic bounding box defined by its corners.
  */
-export interface Speed {
+export interface BoundingBox {
     /**
-     * The user\'s speed in meters per second.
+     * The southwest corner of the bounding box.
      */
-    value: number;
+    sw: GeographicCoordinate;
     /**
-     * The accuracy of the speed value, measured in meters per second.
+     * The northeast corner of the bounding box.
      */
-    accuracy: number | undefined;
+    ne: GeographicCoordinate;
 }
 
 /**
@@ -220,72 +163,48 @@ export interface Incident {
 }
 
 /**
- * A geographic coordinate in WGS84.
+ * The direction in which the user/device is observed to be traveling.
  */
-export interface GeographicCoordinate {
+export interface CourseOverGround {
     /**
-     * The latitude (in degrees).
+     * 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).
      */
-    lat: number;
+    degrees: number;
     /**
-     * The Longitude (in degrees).
+     * The accuracy of the course value, measured in degrees.
      */
-    lng: number;
+    accuracy: 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";
-
-/**
- * Additional information to further specify a [`ManeuverType`].
- */
-export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
-
-/**
- * The impact of the incident that has occurred.
- */
-export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
-
-/**
- * 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.
+ * Details about congestion for an incident.
  */
-export interface Waypoint {
-    coordinate: GeographicCoordinate;
-    kind: WaypointKind;
+export interface Congestion {
     /**
-     * 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
+     * The level of congestion caused by the incident.
      *
-     * 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.
+     * 0 = no congestion
      *
-     * 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.
+     * 100 = road closed
      *
-     * 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.
+     * Other values mean no congestion was calculated
      */
-    properties: number[] | undefined;
+    value: number;
+}
+
+/**
+ * A geographic coordinate in WGS84.
+ */
+export interface GeographicCoordinate {
+    /**
+     * The latitude (in degrees).
+     */
+    lat: number;
+    /**
+     * The Longitude (in degrees).
+     */
+    lng: number;
 }
 
 /**
@@ -323,9 +242,78 @@ export interface VisualInstructionContent {
 }
 
 /**
- * Describes characteristics of the waypoint for routing purposes.
+ * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
  */
-export type WaypointKind = "Break" | "Via";
+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 speed of the user from the location provider.
+ */
+export interface Speed {
+    /**
+     * The user\'s speed in meters per second.
+     */
+    value: number;
+    /**
+     * The accuracy of the speed value, measured in meters per second.
+     */
+    accuracy: number | undefined;
+}
+
+/**
+ * The content of a visual instruction.
+ */
+export interface LaneInfo {
+    active: boolean;
+    directions: string[];
+    activeDirection: string | undefined;
+}
+
+/**
+ * The impact of the incident that has occurred.
+ */
+export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
+
+/**
+ * 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 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[];
+}
 
 /**
  * A maneuver (such as a turn or merge) followed by travel of a certain distance until reaching
@@ -376,130 +364,87 @@ export interface RouteStep {
      * A list of incidents that occur along the step.
      */
     incidents: Incident[];
+    /**
+     * Which side of the road traffic drives on for this step.
+     *
+     * This is relevant for roundabouts: left-hand traffic (e.g. UK) uses clockwise roundabouts,
+     * while right-hand traffic uses counterclockwise roundabouts.
+     */
+    drivingSide: DrivingSide | undefined;
+    /**
+     * The exit number when entering a roundabout (1 = first exit, 2 = second, etc.).
+     */
+    roundaboutExitNumber: 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";
-
-/**
- * Information describing the series of steps needed to travel between two or more points.
+ * A waypoint along a route.
  *
- * 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[];
-}
-
-/**
- * A geographic bounding box defined by its corners.
+ * 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 BoundingBox {
-    /**
-     * The southwest corner of the bounding box.
-     */
-    sw: GeographicCoordinate;
+export interface Waypoint {
+    coordinate: GeographicCoordinate;
+    kind: WaypointKind;
     /**
-     * The northeast corner of the bounding box.
+     * 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.
      */
-    ne: GeographicCoordinate;
-}
-
-/**
- * The current state of the simulation.
- */
-export interface LocationSimulationState {
-    current_location: UserLocation;
-    remaining_locations: GeographicCoordinate[];
-    bias: LocationBias;
+    properties: number[] | undefined;
 }
 
-export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
-
-/**
- * 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";
-
 /**
- * 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 } };
-
-/**
- * An event that occurs during navigation.
- *
- * This is used for the optional session recording / telemetry.
+ * Additional information to further specify a [`ManeuverType`].
  */
-export interface NavigationRecordingEvent {
-    /**
-     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
-     */
-    timestamp: number;
-    /**
-     * Data associated with the event.
-     */
-    event_data: NavigationRecordingEventData;
-}
+export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
 
 /**
- * The event type.
- *
- * For full replayability, we record things like rerouting, and not just location updates.
+ * Describes characteristics of the waypoint for routing purposes.
  */
-export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+export type WaypointKind = "Break" | "Via";
 
 /**
- * Waypoint properties parsed from an OSRM-compatible server response.
+ * Which side of the road traffic drives on.
  *
- * 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.
+ * 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 interface OsrmWaypointProperties {
-    /**
-     * The name of the street that the waypoint snapped to.
-     */
-    name: string | undefined;
-    /**
-     * The distance (in meters) between the snapped point and the input coordinate.
-     */
-    distance: number | undefined;
-}
+export type DrivingSide = "left" | "right";
 
 /**
- * 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.
+ * The lane type blocked by the incident.
  */
-export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLine: number } };
+export type BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
 
 /**
- * Determines if the user has deviated from the expected route.
+ * Configurations for built-in route providers.
  */
-export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: 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 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";
 
@@ -532,6 +477,32 @@ export interface TripProgress {
     durationRemaining: number;
 }
 
+/**
+ * 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.
+ *
+ * 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 type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
+
+export interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
+}
+
 /**
  * Information pertaining to the user\'s full navigation trip. This includes
  * simple stats like total duration and distance.
@@ -556,25 +527,9 @@ export interface TripSummary {
 }
 
 /**
- * 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.
- *
- * 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!
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
-export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
+export type CourseFiltering = "SnapToRoute" | "Raw";
 
 export interface SerializableNavigationControllerConfig {
     /**
@@ -607,15 +562,84 @@ export interface SerializableNavigationControllerConfig {
 }
 
 /**
- * Controls filtering/post-processing of user course by the [`NavigationController`].
+ * Controls how simulated locations deviate from the actual route line.
+ * This simulates real-world GPS behavior where readings often have systematic bias.
  */
-export type CourseFiltering = "SnapToRoute" | "Raw";
+export type LocationBias = { Left: number } | { Right: number } | { Random: number } | "None";
 
-export interface SerializableNavState {
-    tripState: TripState;
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
+/**
+ * The current state of the simulation.
+ */
+export interface LocationSimulationState {
+    current_location: UserLocation;
+    remaining_locations: GeographicCoordinate[];
+    bias: LocationBias;
+}
+
+export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
+
+/**
+ * A set of optional filters to exclude candidate edges based on their attributes.
+ */
+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;
 }
 
+/**
+ * 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 type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
+
+/**
+ * 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.
  *
@@ -715,66 +739,62 @@ export interface ValhallaWaypointProperties {
 }
 
 /**
- * A set of optional filters to exclude candidate edges based on their attributes.
+ * The event type.
+ *
+ * For full replayability, we record things like rerouting, and not just location updates.
  */
-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;
+export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+
+/**
+ * An event that occurs during navigation.
+ *
+ * This is used for the optional session recording / telemetry.
+ */
+export interface NavigationRecordingEvent {
     /**
-     * Whether to exclude roads marked as closed due to a live traffic closure.
+     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
      */
-    exclude_closures?: boolean;
+    timestamp: number;
     /**
-     * The lowest road class allowed.
+     * Data associated with the event.
      */
-    min_road_class?: ValhallaRoadClass;
+    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 {
     /**
-     * The highest road class allowed.
+     * The name of the street that the waypoint snapped to.
      */
-    max_road_class?: ValhallaRoadClass;
+    name: string | undefined;
     /**
-     * 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.
+     * The distance (in meters) between the snapped point and the input coordinate.
      */
-    level?: number;
+    distance: number | undefined;
 }
 
 /**
- * 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.
+ * Determines if the user has deviated from the expected route.
  */
-export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
+export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
 
 /**
- * A road class in the Valhalla taxonomy.
+ * Status information that describes whether the user is proceeding according to the route or not.
  *
- * These are ordered from highest (fastest travel speed) to lowest.
+ * 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 ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
+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 class NavigationController {

package/ferrostar_bg.js

@@ -745,7 +745,7 @@ export function __wbg_getRandomValues_1c61fac11405ffdc() { return handleError(fu
     globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
 }, arguments) };
 
-export function __wbg_getRandomValues_38a1ff1ea09f6cc7() { return handleError(function (arg0, arg1) {
+export function __wbg_getRandomValues_9c5c1b115e142bb8() { return handleError(function (arg0, arg1) {
     globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
 }, arguments) };
 

package/package.json

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