@stadiamaps/ferrostar 0.44.0 → 0.46.0

package/ferrostar.d.ts

@@ -1,216 +1,138 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * JavaScript wrapper for `location_simulation_from_coordinates`.
+ * JavaScript wrapper for `location_simulation_from_polyline`.
  */
-export function locationSimulationFromCoordinates(coordinates: any, resample_distance: number | null | undefined, bias: LocationBias): any;
+export function locationSimulationFromPolyline(polyline: string, precision: number, resample_distance: number | null | undefined, bias: LocationBias): any;
+/**
+ * JavaScript wrapper for `advance_location_simulation`.
+ */
+export function advanceLocationSimulation(state: any): any;
 /**
  * JavaScript wrapper for `location_simulation_from_route`.
  */
 export function locationSimulationFromRoute(route: any, resample_distance: number | null | undefined, bias: LocationBias): any;
 /**
- * JavaScript wrapper for `location_simulation_from_polyline`.
+ * JavaScript wrapper for `location_simulation_from_coordinates`.
  */
-export function locationSimulationFromPolyline(polyline: string, precision: number, resample_distance: number | null | undefined, bias: LocationBias): any;
+export function locationSimulationFromCoordinates(coordinates: any, resample_distance: number | null | undefined, bias: LocationBias): any;
 /**
- * JavaScript wrapper for `advance_location_simulation`.
+ * The broad class of maneuver to perform.
+ *
+ * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
  */
-export function advanceLocationSimulation(state: any): any;
+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 for visual display (usually as banners) at a specific point along a [`RouteStep`].
+ * The lane type blocked by the incident.
  */
-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 BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
 
 /**
- * The content of a visual instruction.
+ * 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 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;
+export interface Waypoint {
+    coordinate: GeographicCoordinate;
+    kind: WaypointKind;
     /**
-     * If applicable, the number of degrees you need to go around the roundabout before exiting.
+     * Optional additional properties that will be passed on to the [`crate::routing_adapters::RouteRequestGenerator`].
      *
-     * 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\").
+     * 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.
      */
-    exitNumbers: string[];
-}
-
-/**
- * The content of a visual instruction.
- */
-export interface LaneInfo {
-    active: boolean;
-    directions: string[];
-    activeDirection: string | undefined;
+    properties: number[] | undefined;
 }
 
 /**
- * An incident affecting the free flow of traffic,
- * such as constructions, accidents, and congestion.
+ * A maneuver (such as a turn or merge) followed by travel of a certain distance until reaching
+ * the next step.
  */
-export interface Incident {
-    /**
-     * A unique identifier for the incident.
-     */
-    id: string;
-    /**
-     * 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.
-     *
-     * 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[];
+export interface RouteStep {
     /**
-     * Info about the amount of congestion on the road around the incident.
+     * The full route geometry for this step.
      */
-    congestion: Congestion | undefined;
+    geometry: GeographicCoordinate[];
     /**
-     * Is the road completely closed?
+     * The distance, in meters, to travel along the route after the maneuver to reach the next step.
      */
-    closed: boolean | undefined;
+    distance: number;
     /**
-     * The index into the [`RouteStep`] geometry where the incident starts.
+     * The estimated duration, in seconds, that it will take to complete this step.
      */
-    geometryIndexStart: number;
+    duration: number;
     /**
-     * The index into the [`RouteStep`] geometry where the incident ends.
+     * The name of the road being traveled on (useful for certain UI styles).
      */
-    geometryIndexEnd: number | undefined;
+    roadName: string | undefined;
     /**
-     * Optional additional information about the type of incident (free-form text).
+     * A list of exits (name or number).
      */
-    subType: string | undefined;
+    exits: string[];
     /**
-     * Optional descriptions about the type of incident (free-form text).
+     * A description of the maneuver (ex: \"Turn wright onto main street\").
+     *
+     * Note for UI implementers: the context this appears in (or doesn\'t)
+     * depends somewhat on your use case and routing engine.
+     * For example, this field is useful as a written instruction in Valhalla.
      */
-    subTypeDescription: string | undefined;
+    instruction: string;
     /**
-     * The ISO 3166-1 alpha-2 code of the country in which the incident occurs.
+     * A list of instructions for visual display (usually as banners) at specific points along the step.
      */
-    iso31661Alpha2: string | undefined;
+    visualInstructions: VisualInstruction[];
     /**
-     * The ISO 3166-1 alpha-3 code of the country in which the incident occurs.
+     * A list of prompts to announce (via speech synthesis) at specific points along the step.
      */
-    iso31661Alpha3: string | undefined;
+    spokenInstructions: SpokenInstruction[];
     /**
-     * A list of road names affected by the incident.
+     * A list of json encoded strings representing annotations between each coordinate along the step.
      */
-    affectedRoadNames: string[];
+    annotations: string[] | undefined;
     /**
-     * The bounding box over which the incident occurs.
+     * A list of incidents that occur along the step.
      */
-    bbox: BoundingBox | undefined;
+    incidents: Incident[];
 }
 
 /**
- * Details about congestion for an incident.
+ * A geographic coordinate in WGS84.
  */
-export interface Congestion {
+export interface GeographicCoordinate {
     /**
-     * The level of congestion caused by the incident.
-     *
-     * 0 = no congestion
-     *
-     * 100 = road closed
-     *
-     * Other values mean no congestion was calculated
+     * The latitude (in degrees).
      */
-    value: number;
+    lat: number;
+    /**
+     * The Longitude (in degrees).
+     */
+    lng: 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";
-
-/**
- * The impact of the incident that has occurred.
- */
-export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
-
-/**
- * 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 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.
  *
@@ -226,7 +148,7 @@ export interface SpokenInstruction {
      */
     ssml: string | undefined;
     /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
+     * How far (in meters) from the upcoming maneuver the instruction should start being spoken.
      */
     triggerDistanceBeforeManeuver: number;
     /**
@@ -243,54 +165,100 @@ export interface SpokenInstruction {
 }
 
 /**
- * A maneuver (such as a turn or merge) followed by travel of a certain distance until reaching
- * the next step.
+ * The direction in which the user/device is observed to be traveling.
  */
-export interface RouteStep {
+export interface CourseOverGround {
     /**
-     * The full route geometry for this step.
+     * 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).
      */
-    geometry: GeographicCoordinate[];
+    degrees: number;
     /**
-     * The distance, in meters, to travel along the route after the maneuver to reach the next step.
+     * The accuracy of the course value, measured in degrees.
      */
-    distance: number;
+    accuracy: number | undefined;
+}
+
+/**
+ * A geographic bounding box defined by its corners.
+ */
+export interface BoundingBox {
     /**
-     * The estimated duration, in seconds, that it will take to complete this step.
+     * The southwest corner of the bounding box.
      */
-    duration: number;
+    sw: GeographicCoordinate;
     /**
-     * The name of the road being traveled on (useful for certain UI styles).
+     * The northeast corner of the bounding box.
      */
-    roadName: string | undefined;
+    ne: GeographicCoordinate;
+}
+
+/**
+ * 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;
     /**
-     * A list of exits (name or number).
+     * The estimated accuracy of the coordinate (in meters)
      */
-    exits: string[];
+    horizontalAccuracy: number;
+    courseOverGround: CourseOverGround | undefined;
+    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
+    speed: Speed | undefined;
+}
+
+/**
+ * The content of a visual instruction.
+ */
+export interface VisualInstructionContent {
     /**
-     * A description of the maneuver (ex: \"Turn wright onto main street\").
-     *
-     * Note for UI implementers: the context this appears in (or doesn\'t)
-     * depends somewhat on your use case and routing engine.
-     * For example, this field is useful as a written instruction in Valhalla.
+     * The text to display.
      */
-    instruction: string;
+    text: string;
     /**
-     * A list of instructions for visual display (usually as banners) at specific points along the step.
+     * A standardized maneuver type (if any).
      */
-    visualInstructions: VisualInstruction[];
+    maneuverType: ManeuverType | undefined;
     /**
-     * A list of prompts to announce (via speech synthesis) at specific points along the step.
+     * A standardized maneuver modifier (if any).
      */
-    spokenInstructions: SpokenInstruction[];
+    maneuverModifier: ManeuverModifier | undefined;
     /**
-     * A list of json encoded strings representing annotations between each coordinate along the step.
+     * 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.
      */
-    annotations: string[] | undefined;
+    roundaboutExitDegrees: number | undefined;
     /**
-     * A list of incidents that occur along the step.
+     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
      */
-    incidents: Incident[];
+    laneInfo: LaneInfo[] | undefined;
+    /**
+     * The exit number (or similar identifier like \"8B\").
+     */
+    exitNumbers: string[];
+}
+
+/**
+ * Describes characteristics of the waypoint for routing purposes.
+ */
+export type WaypointKind = "Break" | "Via";
+
+/**
+ * The content of a visual instruction.
+ */
+export interface LaneInfo {
+    active: boolean;
+    directions: string[];
+    activeDirection: string | undefined;
 }
 
 /**
@@ -316,23 +284,24 @@ export interface Route {
 }
 
 /**
- * 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.
+ * Additional information to further specify a [`ManeuverType`].
  */
-export interface UserLocation {
-    coordinates: GeographicCoordinate;
+export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
+
+/**
+ * Details about congestion for an incident.
+ */
+export interface Congestion {
     /**
-     * The estimated accuracy of the coordinate (in meters)
+     * The level of congestion caused by the incident.
+     *
+     * 0 = no congestion
+     *
+     * 100 = road closed
+     *
+     * Other values mean no congestion was calculated
      */
-    horizontalAccuracy: number;
-    courseOverGround: CourseOverGround | undefined;
-    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
-    speed: Speed | undefined;
+    value: number;
 }
 
 /**
@@ -350,93 +319,151 @@ export interface Speed {
 }
 
 /**
- * The direction in which the user/device is observed to be traveling.
+ * The type of incident that has occurred.
  */
-export interface CourseOverGround {
+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";
+
+/**
+ * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
+ */
+export interface VisualInstruction {
     /**
-     * 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 primary instruction content.
+     *
+     * This is usually given more visual weight.
      */
-    degrees: number;
+    primaryContent: VisualInstructionContent;
     /**
-     * The accuracy of the course value, measured in degrees.
+     * Optional secondary instruction content.
      */
-    accuracy: number | undefined;
-}
-
-/**
- * A geographic bounding box defined by its corners.
- */
-export interface BoundingBox {
+    secondaryContent: VisualInstructionContent | undefined;
     /**
-     * The southwest corner of the bounding box.
+     * Optional sub-maneuver instruction content.
      */
-    sw: GeographicCoordinate;
+    subContent: VisualInstructionContent | undefined;
     /**
-     * The northeast corner of the bounding box.
+     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
      */
-    ne: GeographicCoordinate;
+    triggerDistanceBeforeManeuver: number;
 }
 
 /**
- * Describes characteristics of the waypoint for the routing backend.
- */
-export type WaypointKind = "Break" | "Via";
-
-/**
- * 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.
+ * An incident affecting the free flow of traffic,
+ * such as constructions, accidents, and congestion.
  */
-export interface Waypoint {
-    coordinate: GeographicCoordinate;
-    kind: WaypointKind;
+export interface Incident {
+    /**
+     * A unique identifier for the incident.
+     */
+    id: string;
+    /**
+     * 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.
+     *
+     * 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[];
     /**
-     * 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 bounding box over which the incident occurs.
      */
-    properties: number[] | undefined;
+    bbox: BoundingBox | undefined;
 }
 
 /**
- * A geographic coordinate in WGS84.
+ * 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 GeographicCoordinate {
+export interface OsrmWaypointProperties {
     /**
-     * The latitude (in degrees).
+     * The name of the street that the waypoint snapped to.
      */
-    lat: number;
+    name: string | undefined;
     /**
-     * The Longitude (in degrees).
+     * The distance (in meters) between the snapped point and the input coordinate.
      */
-    lng: number;
+    distance: number | 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";
+
 /**
  * A set of optional filters to exclude candidate edges based on their attributes.
  */
@@ -481,13 +508,6 @@ 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";
-
 /**
  * Specifies a preferred side for departing from / arriving at a location.
  *
@@ -514,6 +534,10 @@ export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
 export interface ValhallaWaypointProperties {
     /**
      * Preferred direction of travel for the start from the location.
+     *
+     * The heading is indicated in degrees from north in a clockwise direction, where north is 0°, east is 90°, south is 180°, and west is 270°.
+     * Avoid specifying this unless you really know what you\'re doing.
+     * Most use cases for this are better served by `preferred_side`.
      */
     heading: number | undefined;
     /**
@@ -532,6 +556,13 @@ export interface ValhallaWaypointProperties {
      * will be considered as candidates for said location.
      * If there are no candidates within this distance,
      * it will return the closest candidate within reason.
+     *
+     * This allows the routing engine to match another edge which is NOT
+     * the closest to your location, but in within this range.
+     * This can be useful if you have other constraints and want to disambiguate,
+     * but beware that this can lead to very strange results,
+     * particularly if you have specified other parameters like `heading`.
+     * This is an advanced feature and should only be used with extreme care.
      */
     radius: number | undefined;
     /**
@@ -586,51 +617,82 @@ export interface ValhallaWaypointProperties {
     search_filter: ValhallaLocationSearchFilter | undefined;
 }
 
+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[] } };
+
 /**
- * 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.
+ * Information pertaining to the user\'s full navigation trip. This includes
+ * simple stats like total duration and distance.
  */
-export interface OsrmWaypointProperties {
+export interface TripSummary {
     /**
-     * The name of the street that the waypoint snapped to.
+     * The total raw distance traveled in the trip, in meters.
      */
-    name: string | undefined;
+    distanceTraveled: number;
     /**
-     * The distance (in meters) between the snapped point and the input coordinate.
+     * The total snapped distance traveled in the trip, in meters.
      */
-    distance: number | undefined;
+    snappedDistanceTraveled: number;
+    /**
+     * When the trip was started.
+     */
+    startedAt: Date;
+    /**
+     * When the trip was completed or canceled.
+     */
+    endedAt: Date | null;
 }
 
 /**
- * The event type.
+ * Controls when a waypoint should be marked as complete.
  *
- * For full replayability, we record things like rerouting, and not just location updates.
+ * 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 NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
 
 /**
- * An event that occurs during navigation.
- *
- * This is used for the optional session recording / telemetry.
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
-export interface NavigationRecordingEvent {
+export type CourseFiltering = "SnapToRoute" | "Raw";
+
+export interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
+}
+
+/**
+ * High-level state describing progress through a route.
+ */
+export interface TripProgress {
     /**
-     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
+     * The distance to the next maneuver, in meters.
      */
-    timestamp: number;
+    distanceToNextManeuver: number;
     /**
-     * Data associated with the event.
+     * 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.
      */
-    event_data: NavigationRecordingEventData;
+    distanceRemaining: number;
+    /**
+     * The total duration remaining in the trip, in seconds.
+     */
+    durationRemaining: 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 interface SerializableNavigationControllerConfig {
     /**
      * Configures when navigation advances to the next waypoint in the route.
@@ -661,32 +723,6 @@ export interface SerializableNavigationControllerConfig {
     snappedLocationCourseFiltering: CourseFiltering;
 }
 
-/**
- * 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 };
-
-/**
- * Controls filtering/post-processing of user course by the [`NavigationController`].
- */
-export type CourseFiltering = "SnapToRoute" | "Raw";
-
 /**
  * The state of a navigation session.
  *
@@ -697,65 +733,32 @@ export type CourseFiltering = "SnapToRoute" | "Raw";
 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.
+ * The event type.
+ *
+ * For full replayability, we record things like rerouting, and not just location updates.
  */
-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;
-    /**
-     * When the trip was started.
-     */
-    startedAt: Date;
-    /**
-     * When the trip was completed or canceled.
-     */
-    endedAt: Date | null;
-}
+export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
 
 /**
- * High-level state describing progress through a route.
+ * An event that occurs during navigation.
+ *
+ * This is used for the optional session recording / telemetry.
  */
-export interface TripProgress {
-    /**
-     * The distance to the next maneuver, in meters.
-     */
-    distanceToNextManeuver: number;
+export interface NavigationRecordingEvent {
     /**
-     * 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 timestamp of the event in milliseconds since Jan 1, 1970 UTC.
      */
-    distanceRemaining: number;
+    timestamp: number;
     /**
-     * The total duration remaining in the trip, in seconds.
+     * Data associated with the event.
      */
-    durationRemaining: number;
-}
-
-export interface SerializableNavState {
-    tripState: TripState;
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
+    event_data: NavigationRecordingEventData;
 }
 
 /**
- * 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.
+ * Configurations for built-in route providers.
  */
-export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
+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 SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
 
@@ -774,6 +777,21 @@ export interface LocationSimulationState {
     bias: LocationBias;
 }
 
+/**
+ * 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.
+ */
+export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
+
+export type GraphHopperVoiceUnits = "metric" | "imperial";
+
 /**
  * JavaScript wrapper for `NavigationController`.
  * This wrapper is required because `NavigationController` cannot be directly converted to a JavaScript object
@@ -781,10 +799,11 @@ export interface LocationSimulationState {
  */
 export class NavigationController {
   free(): void;
-  constructor(route: any, config: any, should_record: any);
+  [Symbol.dispose](): void;
   getInitialState(location: any): any;
   advanceToNextStep(state: any): any;
   updateUserLocation(location: any, state: any): any;
+  constructor(route: any, config: any, should_record: any);
 }
 /**
  * A WebAssembly-compatible wrapper for `NavigationReplay` that exposes its functionality as a JavaScript object.
@@ -794,47 +813,51 @@ export class NavigationController {
  */
 export class NavigationReplay {
   free(): void;
-  constructor(json: any);
-  getEventByIndex(current_index: any): any;
+  [Symbol.dispose](): void;
   getAllEvents(): any;
+  getInitialRoute(): any;
+  getEventByIndex(current_index: any): any;
   getTotalDuration(): any;
   getInitialTimestamp(): any;
-  getInitialRoute(): any;
+  constructor(json: any);
 }
 /**
- * JavaScript wrapper for `NavigationSession` (simple version).
+ * JavaScript wrapper for [`NavigationSession`] (simple version).
  * This wrapper provides basic navigation functionality without observers.
  */
 export class NavigationSession {
   free(): void;
-  constructor(route: any, config: any);
+  [Symbol.dispose](): void;
   getInitialState(location: any): any;
   advanceToNextStep(state: any): any;
   updateUserLocation(location: any, state: any): any;
+  constructor(route: any, config: any);
 }
 /**
- * JavaScript wrapper for `NavigationSession` with recording capabilities.
+ * JavaScript wrapper for [`NavigationSession`] with recording capabilities.
  * This version includes a NavigationRecorder observer and provides direct access to recording functionality.
  */
 export class NavigationSessionRecording {
   free(): void;
-  constructor(route: any, config: any);
+  [Symbol.dispose](): void;
+  getEvents(): any;
+  getRecording(): any;
   getInitialState(location: any): any;
   advanceToNextStep(state: any): any;
   updateUserLocation(location: any, state: any): any;
-  getRecording(): any;
-  getEvents(): any;
+  constructor(route: any, config: any);
 }
 /**
  * JavaScript wrapper for `RouteAdapter`.
  */
 export class RouteAdapter {
   free(): void;
+  [Symbol.dispose](): void;
+  parseResponse(response: Uint8Array): any;
+  generateRequest(user_location: any, waypoints: any): any;
   /**
    * Creates a new RouteAdapter with a Valhalla HTTP request generator and an OSRM response parser.
    * At the moment, this is the only supported combination.
    */
-  constructor(endpoint_url: string, profile: string, costing_options_json?: string | null);
-  generateRequest(user_location: any, waypoints: any): any;
-  parseResponse(response: Uint8Array): any;
+  constructor(well_known_route_provider: WellKnownRouteProvider);
 }