@stadiamaps/ferrostar 0.45.0 → 0.46.0

package/ferrostar.d.ts

@@ -1,44 +1,71 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * JavaScript wrapper for `location_simulation_from_polyline`.
+ */
+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_coordinates`.
+ * JavaScript wrapper for `location_simulation_from_route`.
  */
-export function locationSimulationFromCoordinates(coordinates: any, resample_distance: number | null | undefined, bias: LocationBias): any;
+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 `location_simulation_from_route`.
+ * The broad class of maneuver to perform.
+ *
+ * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
  */
-export function locationSimulationFromRoute(route: any, resample_distance: number | null | undefined, bias: LocationBias): 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";
+
 /**
  * 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 location of the user that is navigating.
+ * A waypoint along a route.
  *
- * In addition to coordinates, this includes estimated accuracy and course information,
- * which can influence navigation logic and UI.
+ * 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.
  *
- * NOTE: Heading is absent on purpose.
- * Heading updates are not related to a change in the user\'s location.
+ * 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 UserLocation {
-    coordinates: GeographicCoordinate;
+export interface Waypoint {
+    coordinate: GeographicCoordinate;
+    kind: WaypointKind;
     /**
-     * The estimated accuracy of the coordinate (in meters)
+     * 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.
      */
-    horizontalAccuracy: number;
-    courseOverGround: CourseOverGround | undefined;
-    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
-    speed: Speed | undefined;
+    properties: number[] | undefined;
 }
 
 /**
@@ -93,181 +120,145 @@ export interface RouteStep {
 }
 
 /**
- * The direction in which the user/device is observed to be traveling.
+ * A geographic coordinate in WGS84.
  */
-export interface CourseOverGround {
+export interface GeographicCoordinate {
     /**
-     * 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 latitude (in degrees).
      */
-    degrees: number;
+    lat: number;
     /**
-     * The accuracy of the course value, measured in degrees.
+     * The Longitude (in degrees).
      */
-    accuracy: number | undefined;
+    lng: number;
 }
 
 /**
- * An incident affecting the free flow of traffic,
- * such as constructions, accidents, and congestion.
+ * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
+ *
+ * Note that these do not have any locale information attached.
  */
-export interface Incident {
-    /**
-     * A unique identifier for the incident.
-     */
-    id: string;
+export interface SpokenInstruction {
     /**
-     * The type of incident.
+     * Plain-text instruction which can be synthesized with a TTS engine.
      */
-    incidentType: IncidentType;
+    text: string;
     /**
-     * A short description of the incident.
+     * Speech Synthesis Markup Language, which should be preferred by clients capable of understanding it.
      */
-    description: string | undefined;
+    ssml: string | undefined;
     /**
-     * A longer description of the incident.
+     * How far (in meters) from the upcoming maneuver the instruction should start being spoken.
      */
-    longDescription: string | undefined;
+    triggerDistanceBeforeManeuver: number;
     /**
-     * The time at which the incident was *last* created.
+     * A unique identifier for this instruction.
      *
-     * 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.
+     * This is provided so that platform-layer integrations can easily disambiguate between distinct utterances,
+     * which may have the same textual content.
+     * UUIDs conveniently fill this purpose.
+     *
+     * NOTE: While it is possible to deterministically create UUIDs, we do not do so at this time.
+     * This should be theoretically possible though if someone cares to write up a proposal and a PR.
      */
-    bbox: BoundingBox | undefined;
+    utteranceId: string;
 }
 
 /**
- * The speed of the user from the location provider.
+ * The direction in which the user/device is observed to be traveling.
  */
-export interface Speed {
+export interface CourseOverGround {
     /**
-     * The user\'s speed in meters per second.
+     * 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).
      */
-    value: number;
+    degrees: number;
     /**
-     * The accuracy of the speed value, measured in meters per second.
+     * The accuracy of the course value, measured in degrees.
      */
     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 geographic coordinate in WGS84.
+ * A geographic bounding box defined by its corners.
  */
-export interface GeographicCoordinate {
+export interface BoundingBox {
     /**
-     * The latitude (in degrees).
+     * The southwest corner of the bounding box.
      */
-    lat: number;
+    sw: GeographicCoordinate;
     /**
-     * The Longitude (in degrees).
+     * The northeast corner of the bounding box.
      */
-    lng: number;
+    ne: GeographicCoordinate;
 }
 
 /**
- * The type of incident that has occurred.
+ * 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 type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
+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;
+}
 
 /**
- * A geographic bounding box defined by its corners.
+ * The content of a visual instruction.
  */
-export interface BoundingBox {
+export interface VisualInstructionContent {
     /**
-     * The southwest corner of the bounding box.
+     * The text to display.
      */
-    sw: GeographicCoordinate;
+    text: string;
     /**
-     * The northeast corner of the bounding box.
+     * A standardized maneuver type (if any).
      */
-    ne: GeographicCoordinate;
-}
-
-/**
- * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
- */
-export interface VisualInstruction {
+    maneuverType: ManeuverType | undefined;
     /**
-     * The primary instruction content.
-     *
-     * This is usually given more visual weight.
+     * A standardized maneuver modifier (if any).
      */
-    primaryContent: VisualInstructionContent;
+    maneuverModifier: ManeuverModifier | undefined;
     /**
-     * Optional secondary instruction content.
+     * 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.
      */
-    secondaryContent: VisualInstructionContent | undefined;
+    roundaboutExitDegrees: number | undefined;
     /**
-     * Optional sub-maneuver instruction content.
+     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
      */
-    subContent: VisualInstructionContent | undefined;
+    laneInfo: LaneInfo[] | undefined;
     /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
+     * The exit number (or similar identifier like \"8B\").
      */
-    triggerDistanceBeforeManeuver: number;
+    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;
 }
 
 /**
@@ -297,46 +288,6 @@ export interface Route {
  */
 export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
 
-/**
- * The content of a visual instruction.
- */
-export interface LaneInfo {
-    active: boolean;
-    directions: string[];
-    activeDirection: string | undefined;
-}
-
-/**
- * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
- *
- * Note that these do not have any locale information attached.
- */
-export interface SpokenInstruction {
-    /**
-     * Plain-text instruction which can be synthesized with a TTS engine.
-     */
-    text: string;
-    /**
-     * Speech Synthesis Markup Language, which should be preferred by clients capable of understanding it.
-     */
-    ssml: string | undefined;
-    /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being spoken.
-     */
-    triggerDistanceBeforeManeuver: number;
-    /**
-     * A unique identifier for this instruction.
-     *
-     * This is provided so that platform-layer integrations can easily disambiguate between distinct utterances,
-     * which may have the same textual content.
-     * UUIDs conveniently fill this purpose.
-     *
-     * NOTE: While it is possible to deterministically create UUIDs, we do not do so at this time.
-     * This should be theoretically possible though if someone cares to write up a proposal and a PR.
-     */
-    utteranceId: string;
-}
-
 /**
  * Details about congestion for an incident.
  */
@@ -354,9 +305,23 @@ export interface Congestion {
 }
 
 /**
- * Describes characteristics of the waypoint for routing purposes.
+ * The speed of the user from the location provider.
  */
-export type WaypointKind = "Break" | "Via";
+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 type of incident that has occurred.
+ */
+export type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
 
 /**
  * The impact of the incident that has occurred.
@@ -364,77 +329,112 @@ export type WaypointKind = "Break" | "Via";
 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.
+ * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
  */
-export interface Waypoint {
-    coordinate: GeographicCoordinate;
-    kind: WaypointKind;
+export interface VisualInstruction {
     /**
-     * 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.
+     * The primary instruction content.
      *
-     * 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.
+     * This is usually given more visual weight.
      */
-    properties: number[] | undefined;
+    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.
+ * An incident affecting the free flow of traffic,
+ * such as constructions, accidents, and congestion.
  */
-export interface VisualInstructionContent {
+export interface Incident {
     /**
-     * The text to display.
+     * A unique identifier for the incident.
      */
-    text: string;
+    id: string;
     /**
-     * A standardized maneuver type (if any).
+     * The type of incident.
      */
-    maneuverType: ManeuverType | undefined;
+    incidentType: IncidentType;
     /**
-     * A standardized maneuver modifier (if any).
+     * A short description of the incident.
      */
-    maneuverModifier: ManeuverModifier | undefined;
+    description: string | undefined;
     /**
-     * If applicable, the number of degrees you need to go around the roundabout before exiting.
+     * A longer description of the incident.
+     */
+    longDescription: string | undefined;
+    /**
+     * The time at which the incident was *last* created.
      *
-     * 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.
+     * NB: This can change throughout the life of the incident.
      */
-    roundaboutExitDegrees: number | undefined;
+    creationTime: Date | null;
     /**
-     * Detailed information about the lanes. This is typically only present in sub-maneuver instructions.
+     * The time at which the incident started or is expected to start (ex: planned closure).
      */
-    laneInfo: LaneInfo[] | undefined;
+    startTime: Date | null;
     /**
-     * The exit number (or similar identifier like \"8B\").
+     * The time at which the incident ended or is expected to end.
      */
-    exitNumbers: string[];
+    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;
 }
 
 /**
@@ -458,51 +458,66 @@ export interface OsrmWaypointProperties {
 }
 
 /**
- * The event type.
+ * A road class in the Valhalla taxonomy.
  *
- * For full replayability, we record things like rerouting, and not just location updates.
+ * These are ordered from highest (fastest travel speed) to lowest.
  */
-export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+export type ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
 
 /**
- * An event that occurs during navigation.
- *
- * This is used for the optional session recording / telemetry.
+ * A set of optional filters to exclude candidate edges based on their attributes.
  */
-export interface NavigationRecordingEvent {
+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;
     /**
-     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
+     * Whether to exclude roads marked as closed due to a live traffic closure.
      */
-    timestamp: number;
+    exclude_closures?: boolean;
     /**
-     * Data associated with the event.
+     * The lowest road class allowed.
      */
-    event_data: NavigationRecordingEventData;
+    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;
 }
 
 /**
- * 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 } };
-
-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";
-
-/**
- * The current state of the simulation.
+ * 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 LocationSimulationState {
-    current_location: UserLocation;
-    remaining_locations: GeographicCoordinate[];
-    bias: LocationBias;
-}
-
-export type GraphHopperVoiceUnits = "metric" | "imperial";
+export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
 
 /**
  * Waypoint properties supported by Valhalla servers.
@@ -602,93 +617,8 @@ export interface ValhallaWaypointProperties {
     search_filter: ValhallaLocationSearchFilter | 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.
- */
-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";
-
-/**
- * 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;
-}
-
-/**
- * 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 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;
-}
-
-/**
- * Controls filtering/post-processing of user course by the [`NavigationController`].
- */
-export type CourseFiltering = "SnapToRoute" | "Raw";
-
 /**
  * Information pertaining to the user\'s full navigation trip. This includes
  * simple stats like total duration and distance.
@@ -712,26 +642,6 @@ export interface TripSummary {
     endedAt: Date | null;
 }
 
-/**
- * High-level state describing progress through a route.
- */
-export interface TripProgress {
-    /**
-     * The distance to the next maneuver, in meters.
-     */
-    distanceToNextManeuver: number;
-    /**
-     * The total distance remaining in the trip, in meters.
-     *
-     * This is the sum of the distance remaining in the current step and the distance remaining in all subsequent steps.
-     */
-    distanceRemaining: number;
-    /**
-     * The total duration remaining in the trip, in seconds.
-     */
-    durationRemaining: number;
-}
-
 /**
  * Controls when a waypoint should be marked as complete.
  *
@@ -754,13 +664,34 @@ export interface TripProgress {
 export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
 
 /**
- * The state of a navigation session.
- *
- * This is produced by [`NavigationController`](super::NavigationController) methods
- * including [`get_initial_state`](super::NavigationController::get_initial_state)
- * and [`update_user_location`](super::NavigationController::update_user_location).
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
-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 type CourseFiltering = "SnapToRoute" | "Raw";
+
+export interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
+}
+
+/**
+ * High-level state describing progress through a route.
+ */
+export interface TripProgress {
+    /**
+     * The distance to the next maneuver, in meters.
+     */
+    distanceToNextManeuver: number;
+    /**
+     * The total distance remaining in the trip, in meters.
+     *
+     * This is the sum of the distance remaining in the current step and the distance remaining in all subsequent steps.
+     */
+    distanceRemaining: number;
+    /**
+     * The total duration remaining in the trip, in seconds.
+     */
+    durationRemaining: number;
+}
 
 export interface SerializableNavigationControllerConfig {
     /**
@@ -792,6 +723,75 @@ export interface SerializableNavigationControllerConfig {
     snappedLocationCourseFiltering: CourseFiltering;
 }
 
+/**
+ * The state of a navigation session.
+ *
+ * This is produced by [`NavigationController`](super::NavigationController) methods
+ * including [`get_initial_state`](super::NavigationController::get_initial_state)
+ * and [`update_user_location`](super::NavigationController::update_user_location).
+ */
+export type TripState = { Idle: { user_location: UserLocation | undefined } } | { Navigating: { currentStepGeometryIndex: number | undefined; userLocation: UserLocation; snappedUserLocation: UserLocation; remainingSteps: RouteStep[]; remainingWaypoints: Waypoint[]; progress: TripProgress; summary: TripSummary; deviation: RouteDeviation; visualInstruction: VisualInstruction | undefined; spokenInstruction: SpokenInstruction | undefined; annotationJson: string | undefined } } | { Complete: { user_location: UserLocation; summary: TripSummary } };
+
+/**
+ * The event type.
+ *
+ * For full replayability, we record things like rerouting, and not just location updates.
+ */
+export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
+
+/**
+ * An event that occurs during navigation.
+ *
+ * This is used for the optional session recording / telemetry.
+ */
+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;
+}
+
+/**
+ * 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 } };
+
+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";
+
+/**
+ * The current state of the simulation.
+ */
+export interface LocationSimulationState {
+    current_location: UserLocation;
+    remaining_locations: GeographicCoordinate[];
+    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

package/ferrostar_bg.js

@@ -198,31 +198,6 @@ function takeFromExternrefTable0(idx) {
     wasm.__externref_table_dealloc(idx);
     return value;
 }
-/**
- * JavaScript wrapper for `advance_location_simulation`.
- * @param {any} state
- * @returns {any}
- */
-export function advanceLocationSimulation(state) {
-    const ret = wasm.advanceLocationSimulation(state);
-    return ret;
-}
-
-/**
- * JavaScript wrapper for `location_simulation_from_coordinates`.
- * @param {any} coordinates
- * @param {number | null | undefined} resample_distance
- * @param {LocationBias} bias
- * @returns {any}
- */
-export function locationSimulationFromCoordinates(coordinates, resample_distance, bias) {
-    const ret = wasm.locationSimulationFromCoordinates(coordinates, !isLikeNone(resample_distance), isLikeNone(resample_distance) ? 0 : resample_distance, bias);
-    if (ret[2]) {
-        throw takeFromExternrefTable0(ret[1]);
-    }
-    return takeFromExternrefTable0(ret[0]);
-}
-
 /**
  * JavaScript wrapper for `location_simulation_from_polyline`.
  * @param {string} polyline
@@ -241,6 +216,16 @@ export function locationSimulationFromPolyline(polyline, precision, resample_dis
     return takeFromExternrefTable0(ret[0]);
 }
 
+/**
+ * JavaScript wrapper for `advance_location_simulation`.
+ * @param {any} state
+ * @returns {any}
+ */
+export function advanceLocationSimulation(state) {
+    const ret = wasm.advanceLocationSimulation(state);
+    return ret;
+}
+
 /**
  * JavaScript wrapper for `location_simulation_from_route`.
  * @param {any} route
@@ -256,6 +241,21 @@ export function locationSimulationFromRoute(route, resample_distance, bias) {
     return takeFromExternrefTable0(ret[0]);
 }
 
+/**
+ * JavaScript wrapper for `location_simulation_from_coordinates`.
+ * @param {any} coordinates
+ * @param {number | null | undefined} resample_distance
+ * @param {LocationBias} bias
+ * @returns {any}
+ */
+export function locationSimulationFromCoordinates(coordinates, resample_distance, bias) {
+    const ret = wasm.locationSimulationFromCoordinates(coordinates, !isLikeNone(resample_distance), isLikeNone(resample_distance) ? 0 : resample_distance, bias);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 const NavigationControllerFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_navigationcontroller_free(ptr >>> 0, 1));

package/package.json

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