@stadiamaps/ferrostar 0.40.0 → 0.42.0

package/ferrostar.d.ts

@@ -430,8 +430,18 @@ export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizo
 
 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[] } };
 
-export type NavigationRecordingEventData = { StateUpdate: { trip_state: TripState; step_advance_condition: SerializableStepAdvanceCondition } } | { RouteUpdate: { route: Route } } | { Error: { error_message: string } };
+/**
+ * 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.
@@ -576,6 +586,8 @@ export interface LocationSimulationState {
 
 /**
  * JavaScript wrapper for `NavigationController`.
+ * This wrapper is required because `NavigationController` cannot be directly converted to a JavaScript object
+ * and requires serialization/deserialization of its methods' inputs and outputs.
  */
 export class NavigationController {
   free(): void;
@@ -585,10 +597,18 @@ export class NavigationController {
   updateUserLocation(location: any, state: any): any;
   getRecording(events: any): any;
 }
+/**
+ * A WebAssembly-compatible wrapper for `NavigationReplay` that exposes its functionality as a JavaScript object.
+ *
+ * This wrapper is required because `NavigationReplay` cannot be directly converted to a JavaScript object
+ * and requires serialization/deserialization of its methods' inputs and outputs.
+ */
 export class NavigationReplay {
   free(): void;
   constructor(json: any);
-  getNextEvent(current_index: any): any;
+  getEventByIndex(current_index: any): any;
+  getAllEvents(): any;
+  getTotalDuration(): any;
   getInitialTimestamp(): any;
   getInitialRoute(): any;
 }

package/ferrostar_bg.js

@@ -255,6 +255,8 @@ const NavigationControllerFinalization = (typeof FinalizationRegistry === 'undef
     : new FinalizationRegistry(ptr => wasm.__wbg_navigationcontroller_free(ptr >>> 0, 1));
 /**
  * JavaScript wrapper for `NavigationController`.
+ * This wrapper is required because `NavigationController` cannot be directly converted to a JavaScript object
+ * and requires serialization/deserialization of its methods' inputs and outputs.
  */
 export class NavigationController {
 
@@ -333,7 +335,12 @@ export class NavigationController {
 const NavigationReplayFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_navigationreplay_free(ptr >>> 0, 1));
-
+/**
+ * A WebAssembly-compatible wrapper for `NavigationReplay` that exposes its functionality as a JavaScript object.
+ *
+ * This wrapper is required because `NavigationReplay` cannot be directly converted to a JavaScript object
+ * and requires serialization/deserialization of its methods' inputs and outputs.
+ */
 export class NavigationReplay {
 
     __destroy_into_raw() {
@@ -363,8 +370,28 @@ export class NavigationReplay {
      * @param {any} current_index
      * @returns {any}
      */
-    getNextEvent(current_index) {
-        const ret = wasm.navigationreplay_getNextEvent(this.__wbg_ptr, current_index);
+    getEventByIndex(current_index) {
+        const ret = wasm.navigationreplay_getEventByIndex(this.__wbg_ptr, current_index);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getAllEvents() {
+        const ret = wasm.navigationreplay_getAllEvents(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getTotalDuration() {
+        const ret = wasm.navigationreplay_getTotalDuration(this.__wbg_ptr);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }

package/package.json

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