@stadiamaps/ferrostar 0.38.0 → 0.40.0

package/ferrostar.d.ts

@@ -415,15 +415,51 @@ export interface GeographicCoordinate {
     lng: number;
 }
 
-export interface NavigationControllerConfig {
+/**
+ * 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 } } | { 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 } };
+
+export interface NavigationRecordingEvent {
     /**
-     * Configures when navigation advances to next waypoint in the route.
+     * The timestamp of the event in milliseconds since Jan 1, 1970 UTC.
+     */
+    timestamp: number;
+    /**
+     * Data associated with the event.
+     */
+    event_data: NavigationRecordingEventData;
+}
+
+export interface SerializableNavigationControllerConfig {
+    /**
+     * 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: SerializableStepAdvanceCondition;
+    /**
+     * 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: SerializableStepAdvanceCondition;
     /**
      * Configures when the user is deemed to be off course.
      *
@@ -458,17 +494,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`].
  */
@@ -526,18 +551,11 @@ export interface TripProgress {
     durationRemaining: 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 interface SerializableNavState {
+    tripState: TripState;
+    stepAdvanceCondition: SerializableStepAdvanceCondition;
+    recordingEvents: NavigationRecordingEvent[] | undefined;
+}
 
 export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
 
@@ -561,10 +579,18 @@ export interface LocationSimulationState {
  */
 export class NavigationController {
   free(): void;
-  constructor(route: any, config: any);
+  constructor(route: any, config: any, should_record: any);
   getInitialState(location: any): any;
-  advance_to_next_step(state: any): any;
+  advanceToNextStep(state: any): any;
   updateUserLocation(location: any, state: any): any;
+  getRecording(events: any): any;
+}
+export class NavigationReplay {
+  free(): void;
+  constructor(json: any);
+  getNextEvent(current_index: any): any;
+  getInitialTimestamp(): any;
+  getInitialRoute(): any;
 }
 /**
  * JavaScript wrapper for `RouteAdapter`.

package/ferrostar_bg.js

@@ -100,17 +100,6 @@ function getArrayU8FromWasm0(ptr, len) {
     return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
 }
 
-const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
-
-let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-
-cachedTextDecoder.decode();
-
-function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
-}
-
 function isLikeNone(x) {
     return x === undefined || x === null;
 }
@@ -180,11 +169,29 @@ function debugString(val) {
     return className;
 }
 
+const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
+
+let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
 function takeFromExternrefTable0(idx) {
     const value = wasm.__wbindgen_export_4.get(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));
@@ -272,9 +272,10 @@ export class NavigationController {
     /**
      * @param {any} route
      * @param {any} config
+     * @param {any} should_record
      */
-    constructor(route, config) {
-        const ret = wasm.navigationcontroller_new(route, config);
+    constructor(route, config, should_record) {
+        const ret = wasm.navigationcontroller_new(route, config, should_record);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
@@ -297,8 +298,8 @@ export class NavigationController {
      * @param {any} state
      * @returns {any}
      */
-    advance_to_next_step(state) {
-        const ret = wasm.navigationcontroller_advance_to_next_step(this.__wbg_ptr, state);
+    advanceToNextStep(state) {
+        const ret = wasm.navigationcontroller_advanceToNextStep(this.__wbg_ptr, state);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
@@ -316,6 +317,79 @@ 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')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_navigationreplay_free(ptr >>> 0, 1));
+
+export class NavigationReplay {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        NavigationReplayFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_navigationreplay_free(ptr, 0);
+    }
+    /**
+     * @param {any} json
+     */
+    constructor(json) {
+        const ret = wasm.navigationreplay_new(json);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
+        NavigationReplayFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {any} current_index
+     * @returns {any}
+     */
+    getNextEvent(current_index) {
+        const ret = wasm.navigationreplay_getNextEvent(this.__wbg_ptr, current_index);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getInitialTimestamp() {
+        const ret = wasm.navigationreplay_getInitialTimestamp(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {any}
+     */
+    getInitialRoute() {
+        const ret = wasm.navigationreplay_getInitialRoute(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
 }
 
 const RouteAdapterFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -404,16 +478,6 @@ export function __wbg_call_672a4d21634d4a24() { return handleError(function (arg
     return ret;
 }, arguments) };
 
-export function __wbg_call_7cccdd69e0791ae2() { return handleError(function (arg0, arg1, arg2) {
-    const ret = arg0.call(arg1, arg2);
-    return ret;
-}, arguments) };
-
-export function __wbg_crypto_ed58b8e10a292839(arg0) {
-    const ret = arg0.crypto;
-    return ret;
-};
-
 export function __wbg_done_769e5ede4b31c67b(arg0) {
     const ret = arg0.done;
     return ret;
@@ -428,8 +492,8 @@ export function __wbg_getRandomValues_38097e921c2494c3() { return handleError(fu
     globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
 }, arguments) };
 
-export function __wbg_getRandomValues_bcb4912f16000dc4() { return handleError(function (arg0, arg1) {
-    arg0.getRandomValues(arg1);
+export function __wbg_getRandomValues_3c9c0d586e575a16() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
 }, arguments) };
 
 export function __wbg_getTime_46267b1c24877e30(arg0) {
@@ -499,11 +563,6 @@ export function __wbg_length_e2d2a49132c1b256(arg0) {
     return ret;
 };
 
-export function __wbg_msCrypto_0a36e2ec3a343d26(arg0) {
-    const ret = arg0.msCrypto;
-    return ret;
-};
-
 export function __wbg_new0_f788a2397c7ca929() {
     const ret = new Date();
     return ret;
@@ -529,21 +588,6 @@ export function __wbg_new_a12002a7f91c75be(arg0) {
     return ret;
 };
 
-export function __wbg_newnoargs_105ed471475aaf50(arg0, arg1) {
-    const ret = new Function(getStringFromWasm0(arg0, arg1));
-    return ret;
-};
-
-export function __wbg_newwithbyteoffsetandlength_d97e637ebe145a9a(arg0, arg1, arg2) {
-    const ret = new Uint8Array(arg0, arg1 >>> 0, arg2 >>> 0);
-    return ret;
-};
-
-export function __wbg_newwithlength_a381634e90c276d4(arg0) {
-    const ret = new Uint8Array(arg0 >>> 0);
-    return ret;
-};
-
 export function __wbg_next_25feadfc0913fea9(arg0) {
     const ret = arg0.next;
     return ret;
@@ -554,30 +598,11 @@ export function __wbg_next_6574e1a8a62d1055() { return handleError(function (arg
     return ret;
 }, arguments) };
 
-export function __wbg_node_02999533c4ea02e3(arg0) {
-    const ret = arg0.node;
-    return ret;
-};
-
 export function __wbg_now_807e54c39636c349() {
     const ret = Date.now();
     return ret;
 };
 
-export function __wbg_process_5c1d670bc53614b8(arg0) {
-    const ret = arg0.process;
-    return ret;
-};
-
-export function __wbg_randomFillSync_ab2cfe79ebbf2740() { return handleError(function (arg0, arg1) {
-    arg0.randomFillSync(arg1);
-}, arguments) };
-
-export function __wbg_require_79b1e9274cde3c87() { return handleError(function () {
-    const ret = module.require;
-    return ret;
-}, arguments) };
-
 export function __wbg_set_37837023f3d740e8(arg0, arg1, arg2) {
     arg0[arg1 >>> 0] = arg2;
 };
@@ -595,41 +620,11 @@ export function __wbg_set_8fc6bf8a5b1071d1(arg0, arg1, arg2) {
     return ret;
 };
 
-export function __wbg_static_accessor_GLOBAL_88a902d13a557d07() {
-    const ret = typeof global === 'undefined' ? null : global;
-    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-};
-
-export function __wbg_static_accessor_GLOBAL_THIS_56578be7e9f832b0() {
-    const ret = typeof globalThis === 'undefined' ? null : globalThis;
-    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-};
-
-export function __wbg_static_accessor_SELF_37c5d418e4bf5819() {
-    const ret = typeof self === 'undefined' ? null : self;
-    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-};
-
-export function __wbg_static_accessor_WINDOW_5de37043a91a9c40() {
-    const ret = typeof window === 'undefined' ? null : window;
-    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-};
-
-export function __wbg_subarray_aa9065fa9dc5df96(arg0, arg1, arg2) {
-    const ret = arg0.subarray(arg1 >>> 0, arg2 >>> 0);
-    return ret;
-};
-
 export function __wbg_value_cd1ffa7b1ab794f1(arg0) {
     const ret = arg0.value;
     return ret;
 };
 
-export function __wbg_versions_c71aa1626a93e0a1(arg0) {
-    const ret = arg0.versions;
-    return ret;
-};
-
 export function __wbindgen_as_number(arg0) {
     const ret = +arg0;
     return ret;

package/package.json

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