@stadiamaps/ferrostar 0.46.1 → 0.47.1

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,101 +21,36 @@ export interface UserLocation {
 }
 
 /**
- * The direction in which the user/device is observed to be traveling.
- */
-export interface CourseOverGround {
-    /**
-     * The direction in which the user\'s device is traveling, measured in clockwise degrees from
-     * true north (N = 0, E = 90, S = 180, W = 270).
-     */
-    degrees: number;
-    /**
-     * The accuracy of the course value, measured in degrees.
-     */
-    accuracy: number | undefined;
-}
-
-/**
- * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
- *
- * Note that these do not have any locale information attached.
+ * The type of incident that has occurred.
  */
-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;
-}
+export type IncidentType = "accident" | "congestion" | "construction" | "disabled_vehicle" | "lane_restriction" | "mass_transit" | "miscellaneous" | "other_news" | "planned_event" | "road_closure" | "road_hazard" | "weather";
 
 /**
- * An instruction for visual display (usually as banners) at a specific point along a [`RouteStep`].
+ * A geographic coordinate in WGS84.
  */
-export interface VisualInstruction {
-    /**
-     * The primary instruction content.
-     *
-     * This is usually given more visual weight.
-     */
-    primaryContent: VisualInstructionContent;
-    /**
-     * Optional secondary instruction content.
-     */
-    secondaryContent: VisualInstructionContent | undefined;
+export interface GeographicCoordinate {
     /**
-     * Optional sub-maneuver instruction content.
+     * The latitude (in degrees).
      */
-    subContent: VisualInstructionContent | undefined;
+    lat: number;
     /**
-     * How far (in meters) from the upcoming maneuver the instruction should start being displayed
+     * The Longitude (in degrees).
      */
-    triggerDistanceBeforeManeuver: number;
-}
-
-/**
- * The content of a visual instruction.
- */
-export interface LaneInfo {
-    active: boolean;
-    directions: string[];
-    activeDirection: string | undefined;
+    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 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,33 +139,35 @@ export interface Incident {
 }
 
 /**
- * A geographic coordinate in WGS84.
+ * Which side of the road traffic drives on.
+ *
+ * This is needed by consumers like Android Auto to determine whether
+ * a roundabout should be rendered as clockwise (right-hand traffic)
+ * or counterclockwise (left-hand traffic).
  */
-export interface GeographicCoordinate {
+export type DrivingSide = "left" | "right";
+
+/**
+ * The direction in which the user/device is observed to be traveling.
+ */
+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.
+ * The broad class of maneuver to perform.
+ *
+ * This is usually combined with [`ManeuverModifier`] in [`VisualInstructionContent`].
  */
-export type Impact = "unknown" | "critical" | "major" | "minor" | "low";
+export type ManeuverType = "turn" | "new name" | "depart" | "arrive" | "merge" | "on ramp" | "off ramp" | "fork" | "end of road" | "continue" | "roundabout" | "rotary" | "roundabout turn" | "notification" | "exit roundabout" | "exit rotary";
 
 /**
  * A waypoint along a route.
@@ -288,6 +209,37 @@ export interface Waypoint {
     properties: number[] | undefined;
 }
 
+/**
+ * An instruction that can be synthesized using a TTS engine to announce an upcoming maneuver.
+ *
+ * Note that these do not have any locale information attached.
+ */
+export interface SpokenInstruction {
+    /**
+     * Plain-text instruction which can be synthesized with a TTS engine.
+     */
+    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;
+}
+
 /**
  * The content of a visual instruction.
  */
@@ -322,11 +274,6 @@ export interface VisualInstructionContent {
     exitNumbers: string[];
 }
 
-/**
- * Describes characteristics of the waypoint for routing purposes.
- */
-export type WaypointKind = "Break" | "Via";
-
 /**
  * A maneuver (such as a turn or merge) followed by travel of a certain distance until reaching
  * the next step.
@@ -376,14 +323,61 @@ 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`].
+ * The content of a visual instruction.
  */
-export type ManeuverType = "turn" | "new name" | "depart" | "arrive" | "merge" | "on ramp" | "off ramp" | "fork" | "end of road" | "continue" | "roundabout" | "rotary" | "roundabout turn" | "notification" | "exit roundabout" | "exit rotary";
+export interface LaneInfo {
+    active: boolean;
+    directions: string[];
+    activeDirection: string | undefined;
+}
+
+/**
+ * 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 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;
+}
+
+/**
+ * Additional information to further specify a [`ManeuverType`].
+ */
+export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
 
 /**
  * Information describing the series of steps needed to travel between two or more points.
@@ -408,98 +402,49 @@ export interface Route {
 }
 
 /**
- * A geographic bounding box defined by its corners.
- */
-export interface BoundingBox {
-    /**
-     * The southwest corner of the bounding box.
-     */
-    sw: GeographicCoordinate;
-    /**
-     * The northeast corner of the bounding box.
-     */
-    ne: GeographicCoordinate;
-}
-
-/**
- * The current state of the simulation.
- */
-export interface LocationSimulationState {
-    current_location: UserLocation;
-    remaining_locations: GeographicCoordinate[];
-    bias: LocationBias;
-}
-
-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.
+ * The lane type blocked by the incident.
  */
-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 BlockedLane = "left" | "left center" | "left turn lane" | "center" | "right" | "right center" | "right turn lane" | "hov";
 
 /**
- * An event that occurs during navigation.
- *
- * This is used for the optional session recording / telemetry.
+ * The speed of the user from the location provider.
  */
-export interface NavigationRecordingEvent {
+export interface Speed {
     /**
-     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
+     * The user\'s speed in meters per second.
      */
-    timestamp: number;
+    value: number;
     /**
-     * Data associated with the event.
+     * The accuracy of the speed value, measured in meters per second.
      */
-    event_data: NavigationRecordingEventData;
+    accuracy: number | undefined;
 }
 
 /**
- * The event type.
- *
- * For full replayability, we record things like rerouting, and not just location updates.
- */
-export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
-
-/**
- * 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.
+ * Details about congestion for an incident.
  */
-export interface OsrmWaypointProperties {
-    /**
-     * The name of the street that the waypoint snapped to.
-     */
-    name: string | undefined;
+export interface Congestion {
     /**
-     * The distance (in meters) between the snapped point and the input coordinate.
+     * The level of congestion caused by the incident.
+     *
+     * 0 = no congestion
+     *
+     * 100 = road closed
+     *
+     * Other values mean no congestion was calculated
      */
-    distance: number | undefined;
+    value: 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.
+ * Describes characteristics of the waypoint for routing purposes.
  */
-export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLine: number } };
+export type WaypointKind = "Break" | "Via";
 
 /**
- * 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";
 
@@ -533,26 +478,38 @@ export interface TripProgress {
 }
 
 /**
- * Information pertaining to the user\'s full navigation trip. This includes
- * simple stats like total duration and distance.
+ * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
-export interface TripSummary {
+export type CourseFiltering = "SnapToRoute" | "Raw";
+
+export interface SerializableNavigationControllerConfig {
     /**
-     * The total raw distance traveled in the trip, in meters.
+     * Configures when navigation advances to the next waypoint in the route.
      */
-    distanceTraveled: number;
+    waypointAdvance: WaypointAdvanceMode;
     /**
-     * The total snapped distance traveled in the trip, in meters.
+     * Configures when navigation advances to the next step in the route.
      */
-    snappedDistanceTraveled: number;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
     /**
-     * When the trip was started.
+     * A special advance condition used for the final 2 route steps (last and arrival).
+     *
+     * This exists because several of our step advance conditions require entry and
+     * exit from a step\'s geometry. The end of the route/arrival doesn\'t always accommodate
+     * the expected location updates for the core step advance condition.
      */
-    startedAt: Date;
+    arrivalStepAdvanceCondition: SerializableStepAdvanceCondition;
     /**
-     * When the trip was completed or canceled.
+     * Configures when the user is deemed to be off course.
+     *
+     * NOTE: This is distinct from the action that is taken.
+     * It is only the determination that the user has deviated from the expected route.
      */
-    endedAt: Date | null;
+    routeDeviationTracking: RouteDeviationTracking;
+    /**
+     * Configures how the heading component of the snapped location is reported in [`TripState`].
+     */
+    snappedLocationCourseFiltering: CourseFiltering;
 }
 
 /**
@@ -576,46 +533,62 @@ export interface TripSummary {
  */
 export type WaypointAdvanceMode = { WaypointWithinRange: number } | { WaypointAlongAdvancingStep: number };
 
-export interface SerializableNavigationControllerConfig {
-    /**
-     * Configures when navigation advances to the next waypoint in the route.
-     */
-    waypointAdvance: WaypointAdvanceMode;
+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.
+ */
+export interface TripSummary {
     /**
-     * Configures when navigation advances to the next step in the route.
+     * The total raw distance traveled in the trip, in meters.
      */
-    stepAdvanceCondition: SerializableStepAdvanceCondition;
+    distanceTraveled: number;
     /**
-     * A special advance condition used for the final 2 route steps (last and arrival).
-     *
-     * This exists because several of our step advance conditions require entry and
-     * exit from a step\'s geometry. The end of the route/arrival doesn\'t always accommodate
-     * the expected location updates for the core step advance condition.
+     * The total snapped distance traveled in the trip, in meters.
      */
-    arrivalStepAdvanceCondition: SerializableStepAdvanceCondition;
+    snappedDistanceTraveled: number;
     /**
-     * Configures when the user is deemed to be off course.
-     *
-     * NOTE: This is distinct from the action that is taken.
-     * It is only the determination that the user has deviated from the expected route.
+     * When the trip was started.
      */
-    routeDeviationTracking: RouteDeviationTracking;
+    startedAt: Date;
     /**
-     * Configures how the heading component of the snapped location is reported in [`TripState`].
+     * When the trip was completed or canceled.
      */
-    snappedLocationCourseFiltering: CourseFiltering;
+    endedAt: Date | null;
 }
 
 /**
- * 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;
+export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
+
+/**
+ * The current state of the simulation.
+ */
+export interface LocationSimulationState {
+    current_location: UserLocation;
+    remaining_locations: GeographicCoordinate[];
+    bias: LocationBias;
 }
 
+/**
+ * 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";
+
 /**
  * Waypoint properties supported by Valhalla servers.
  *
@@ -714,6 +687,13 @@ export interface ValhallaWaypointProperties {
     search_filter: ValhallaLocationSearchFilter | 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.
  */
@@ -759,22 +739,62 @@ export interface ValhallaLocationSearchFilter {
 }
 
 /**
- * Specifies a preferred side for departing from / arriving at a location.
+ * The event type.
  *
- * 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.
+ * For full replayability, we record things like rerouting, and not just location updates.
  */
-export type ValhallaWaypointPreferredSide = "same" | "opposite" | "either";
+export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } };
 
 /**
- * A road class in the Valhalla taxonomy.
+ * An event that occurs during navigation.
  *
- * These are ordered from highest (fastest travel speed) to lowest.
+ * This is used for the optional session recording / telemetry.
  */
-export type ValhallaRoadClass = "motorway" | "trunk" | "primary" | "secondary" | "tertiary" | "unclassified" | "residential" | "service_other";
+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;
+}
+
+/**
+ * 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 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;
+}
+
+/**
+ * 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 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.1",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",