@stadiamaps/ferrostar 0.37.0 → 0.39.0

package/ferrostar.d.ts

@@ -415,32 +415,23 @@ export interface GeographicCoordinate {
     lng: number;
 }
 
-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;
-}
-
-export interface NavigationControllerConfig {
+export interface JsNavigationControllerConfig {
     /**
-     * Configures when navigation advances to next waypoint in the route.
+     * Configures when navigation advances to the next waypoint in the route.
      */
     waypointAdvance: WaypointAdvanceMode;
     /**
      * Configures when navigation advances to the next step in the route.
      */
-    stepAdvance: StepAdvanceMode;
+    stepAdvanceCondition: JsStepAdvanceCondition;
+    /**
+     * 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.
+     */
+    arrivalStepAdvanceCondition: JsStepAdvanceCondition;
     /**
      * Configures when the user is deemed to be off course.
      *
@@ -475,17 +466,6 @@ export interface NavigationControllerConfig {
  */
 export type WaypointAdvanceMode = { WaypointWithinRange: number };
 
-/**
- * Special conditions which alter the normal step advance logic,
- */
-export type SpecialAdvanceConditions = { AdvanceAtDistanceFromEnd: number } | { MinimumDistanceFromCurrentStepLine: number };
-
-/**
- * The step advance mode describes when the current maneuver has been successfully completed,
- * and we should advance to the next step.
- */
-export type StepAdvanceMode = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { RelativeLineStringDistance: { minimumHorizontalAccuracy: number; specialAdvanceConditions: SpecialAdvanceConditions | undefined } };
-
 /**
  * Controls filtering/post-processing of user course by the [`NavigationController`].
  */
@@ -543,6 +523,11 @@ export interface TripProgress {
     durationRemaining: number;
 }
 
+export interface JsNavState {
+    tripState: TripState;
+    stepAdvanceCondition: JsStepAdvanceCondition;
+}
+
 /**
  * Status information that describes whether the user is proceeding according to the route or not.
  *
@@ -556,6 +541,25 @@ export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLin
  */
 export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
 
+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;
+}
+
+export type JsStepAdvanceCondition = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceFromStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceEntryExit: { minimumHorizontalAccuracy: number; distanceToEndOfStep: number; distanceAfterEndStep: number; hasReachedEndOfCurrentStep: boolean } } | { OrAdvanceConditions: { conditions: JsStepAdvanceCondition[] } } | { AndAdvanceConditions: { conditions: JsStepAdvanceCondition[] } };
+
 /**
  * JavaScript wrapper for `NavigationController`.
  */

package/ferrostar_bg.js

@@ -185,6 +185,13 @@ function takeFromExternrefTable0(idx) {
     wasm.__externref_table_dealloc(idx);
     return value;
 }
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
 /**
  * JavaScript wrapper for `location_simulation_from_coordinates`.
  * @param {any} coordinates
@@ -243,13 +250,6 @@ export function advanceLocationSimulation(state) {
     return ret;
 }
 
-function passArray8ToWasm0(arg, malloc) {
-    const ptr = malloc(arg.length * 1, 1) >>> 0;
-    getUint8ArrayMemory0().set(arg, ptr / 1);
-    WASM_VECTOR_LEN = arg.length;
-    return ptr;
-}
-
 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.37.0",
+  "version": "0.39.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",