@stadiamaps/ferrostar 0.41.0 → 0.43.0

package/ferrostar.d.ts

@@ -415,8 +415,38 @@ 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 type SerializableStepAdvanceCondition = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceFromStep: { distance: number; minimumHorizontalAccuracy: number } } | { DistanceEntryExit: { distanceToEndOfStep: number; distanceAfterEndStep: number; minimumHorizontalAccuracy: number; hasReachedEndOfCurrentStep: boolean } } | { OrAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } } | { AndAdvanceConditions: { conditions: SerializableStepAdvanceCondition[] } };
 
+/**
+ * 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 } };
+
 /**
  * The event type.
  *
@@ -551,39 +581,8 @@ export interface TripProgress {
 export interface SerializableNavState {
     tripState: TripState;
     stepAdvanceCondition: SerializableStepAdvanceCondition;
-    recordingEvents: NavigationRecordingEvent[] | 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 } };
-
 /**
  * JavaScript wrapper for `NavigationController`.
  * This wrapper is required because `NavigationController` cannot be directly converted to a JavaScript object
@@ -595,7 +594,6 @@ export class NavigationController {
   getInitialState(location: any): any;
   advanceToNextStep(state: any): any;
   updateUserLocation(location: any, state: any): any;
-  getRecording(events: any): any;
 }
 /**
  * A WebAssembly-compatible wrapper for `NavigationReplay` that exposes its functionality as a JavaScript object.
@@ -612,6 +610,30 @@ export class NavigationReplay {
   getInitialTimestamp(): any;
   getInitialRoute(): any;
 }
+/**
+ * JavaScript wrapper for `NavigationSession` (simple version).
+ * This wrapper provides basic navigation functionality without observers.
+ */
+export class NavigationSession {
+  free(): void;
+  constructor(route: any, config: any);
+  getInitialState(location: any): any;
+  advanceToNextStep(state: any): any;
+  updateUserLocation(location: any, state: any): any;
+}
+/**
+ * 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);
+  getInitialState(location: any): any;
+  advanceToNextStep(state: any): any;
+  updateUserLocation(location: any, state: any): any;
+  getRecording(): any;
+  getEvents(): any;
+}
 /**
  * JavaScript wrapper for `RouteAdapter`.
  */

package/ferrostar_bg.js

@@ -319,17 +319,6 @@ export class NavigationController {
         }
         return takeFromExternrefTable0(ret[0]);
     }
-    /**
-     * @param {any} events
-     * @returns {any}
-     */
-    getRecording(events) {
-        const ret = wasm.navigationcontroller_getRecording(this.__wbg_ptr, events);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
-        }
-        return takeFromExternrefTable0(ret[0]);
-    }
 }
 
 const NavigationReplayFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -419,6 +408,164 @@ export class NavigationReplay {
     }
 }
 
+const NavigationSessionFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_navigationsession_free(ptr >>> 0, 1));
+/**
+ * JavaScript wrapper for `NavigationSession` (simple version).
+ * This wrapper provides basic navigation functionality without observers.
+ */
+export class NavigationSession {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        NavigationSessionFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_navigationsession_free(ptr, 0);
+    }
+    /**
+     * @param {any} route
+     * @param {any} config
+     */
+    constructor(route, config) {
+        const ret = wasm.navigationsession_new(route, config);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
+        NavigationSessionFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {any} location
+     * @returns {any}
+     */
+    getInitialState(location) {
+        const ret = wasm.navigationsession_getInitialState(this.__wbg_ptr, location);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @param {any} state
+     * @returns {any}
+     */
+    advanceToNextStep(state) {
+        const ret = wasm.navigationsession_advanceToNextStep(this.__wbg_ptr, state);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @param {any} location
+     * @param {any} state
+     * @returns {any}
+     */
+    updateUserLocation(location, state) {
+        const ret = wasm.navigationsession_updateUserLocation(this.__wbg_ptr, location, state);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+}
+
+const NavigationSessionRecordingFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_navigationsessionrecording_free(ptr >>> 0, 1));
+/**
+ * JavaScript wrapper for `NavigationSession` with recording capabilities.
+ * This version includes a NavigationRecorder observer and provides direct access to recording functionality.
+ */
+export class NavigationSessionRecording {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        NavigationSessionRecordingFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_navigationsessionrecording_free(ptr, 0);
+    }
+    /**
+     * @param {any} route
+     * @param {any} config
+     */
+    constructor(route, config) {
+        const ret = wasm.navigationsessionrecording_new(route, config);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
+        NavigationSessionRecordingFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {any} location
+     * @returns {any}
+     */
+    getInitialState(location) {
+        const ret = wasm.navigationsessionrecording_getInitialState(this.__wbg_ptr, location);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @param {any} state
+     * @returns {any}
+     */
+    advanceToNextStep(state) {
+        const ret = wasm.navigationsessionrecording_advanceToNextStep(this.__wbg_ptr, state);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @param {any} location
+     * @param {any} state
+     * @returns {any}
+     */
+    updateUserLocation(location, state) {
+        const ret = wasm.navigationsessionrecording_updateUserLocation(this.__wbg_ptr, location, state);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getRecording() {
+        const ret = wasm.navigationsessionrecording_getRecording(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getEvents() {
+        const ret = wasm.navigationsessionrecording_getEvents(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+}
+
 const RouteAdapterFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_routeadapter_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.41.0",
+  "version": "0.43.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",