@mappedin/blue-dot 6.17.1-beta.0 → 6.19.0-beta.0

package/lib/esm/index.d.ts

@@ -1217,6 +1217,15 @@ type FollowCameraOptions = {
   easing?: 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear';
 };
 type BlueDotEventPayloads = {
+  /**
+   * Emitted on every animation frame while the Blue Dot model is moving.
+   * Unlike `position-update` (which fires only on raw sensor input, typically ~1Hz),
+   * this fires at the display refresh rate during tweened movement, making it
+   * suitable for smooth path-tracking visualizations.
+   */
+  'dot-position-update': {
+    position: Coordinate;
+  };
   /**
    * Emitted when the Blue Dot's position is updated either from the device's geolocation API or by calling {@link BlueDot.update}.
    * see {@link BlueDot.watchDevicePosition} for more details.
@@ -1291,6 +1300,12 @@ type BlueDotEventPayloads = {
 };
 type BlueDotEvents = keyof BlueDotEventPayloads;
 type BlueDotState = {
+  /**
+   * Whether the BlueDot core element is visible. When false, the dot is hidden but the accuracy ring
+   * and heading cone may still render based on their own visibility settings.
+   * @default true
+   */
+  visible: boolean;
   /**
    * The radius of the BlueDot in pixels. The BlueDot will maintain this size clamped to a minimum of 0.35 metres.
    * @default 10
@@ -1310,6 +1325,11 @@ type BlueDotState = {
    * Options for the accuracy ring around the BlueDot.
    */
   accuracyRing: {
+    /**
+     * Whether the accuracy ring is visible.
+     * @default true
+     */
+    visible: boolean;
     /**
      * The color of the accuracy ring.
      * @default #2266ff
@@ -1325,6 +1345,11 @@ type BlueDotState = {
    * Options for the heading directional indicator.
    */
   heading: {
+    /**
+     * Whether the heading cone is visible.
+     * @default true
+     */
+    visible: boolean;
     /**
      * The color of the heading cone.
      * @default #2266ff
@@ -1461,12 +1486,6 @@ declare class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EV
    * AbortController for managing lifecycle and cleanup
    */
   private _abortController;
-  /**
-   * @protected
-   * @internal
-   * Tracks all cleanup functions for subscriptions made via on()
-   */
-  protected _cleanupFunctions: Array<() => void>;
   /**
    * Returns the AbortSignal for this PubSub instance.
    * Use this signal with APIs that support cancellation (fetch, addEventListener, etc.)
@@ -2022,6 +2041,8 @@ interface HeadingFilterConfig {
   magneticGatingEnabled: boolean;
   /** Minimum heading delta to emit updates (degrees). */
   deltaThreshold: number;
+  /** Calibration offset applied to all compass readings (degrees). Set from VPS ground truth. */
+  calibrationOffset: number;
 }
 /**
  * Complementary filter for heading fusion.
@@ -2074,6 +2095,13 @@ declare class HeadingFusionFilter implements HeadingFusionAlgorithm {
    * @param confidence GPS confidence (0-1), affects how much GPS heading influences result
    */
   correctWithGps(gpsHeading: number, speed: number, confidence?: number): void;
+  /**
+   * Set a calibration offset derived from a known ground-truth heading (e.g. VPS).
+   * The offset is applied to all subsequent compass readings to correct systematic
+   * magnetic bias at the calibration location.
+   * @param offsetDegrees Offset in degrees (groundTruthHeading - deviceCompassHeading)
+   */
+  setCalibrationOffset(offsetDegrees: number): void;
   /**
    * Configure the filter parameters at runtime.
    * @param config Partial configuration to apply

package/lib/esm/index.js

@@ -1 +1 @@
-import{a as t,b as e,c as s,d as n}from"./chunk-NUHGT3O3.js";import{m as o}from"./chunk-UZOPCEME.js";o();export{t as BaseSensor,n as BlueDot,e as ManualSensor,s as SensorRegistry};
+import{a as t,b as e,c as s,d as n}from"./chunk-IJA5ETXF.js";import{j as o}from"./chunk-T4TSXXQK.js";o();export{t as BaseSensor,n as BlueDot,e as ManualSensor,s as SensorRegistry};

package/lib/esm/react/index.d.ts

@@ -1217,6 +1217,15 @@ type FollowCameraOptions = {
   easing?: 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear';
 };
 type BlueDotEventPayloads = {
+  /**
+   * Emitted on every animation frame while the Blue Dot model is moving.
+   * Unlike `position-update` (which fires only on raw sensor input, typically ~1Hz),
+   * this fires at the display refresh rate during tweened movement, making it
+   * suitable for smooth path-tracking visualizations.
+   */
+  'dot-position-update': {
+    position: Coordinate;
+  };
   /**
    * Emitted when the Blue Dot's position is updated either from the device's geolocation API or by calling {@link BlueDot.update}.
    * see {@link BlueDot.watchDevicePosition} for more details.
@@ -1291,6 +1300,12 @@ type BlueDotEventPayloads = {
 };
 type BlueDotEvents = keyof BlueDotEventPayloads;
 type BlueDotState = {
+  /**
+   * Whether the BlueDot core element is visible. When false, the dot is hidden but the accuracy ring
+   * and heading cone may still render based on their own visibility settings.
+   * @default true
+   */
+  visible: boolean;
   /**
    * The radius of the BlueDot in pixels. The BlueDot will maintain this size clamped to a minimum of 0.35 metres.
    * @default 10
@@ -1310,6 +1325,11 @@ type BlueDotState = {
    * Options for the accuracy ring around the BlueDot.
    */
   accuracyRing: {
+    /**
+     * Whether the accuracy ring is visible.
+     * @default true
+     */
+    visible: boolean;
     /**
      * The color of the accuracy ring.
      * @default #2266ff
@@ -1325,6 +1345,11 @@ type BlueDotState = {
    * Options for the heading directional indicator.
    */
   heading: {
+    /**
+     * Whether the heading cone is visible.
+     * @default true
+     */
+    visible: boolean;
     /**
      * The color of the heading cone.
      * @default #2266ff
@@ -1461,12 +1486,6 @@ declare class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EV
    * AbortController for managing lifecycle and cleanup
    */
   private _abortController;
-  /**
-   * @protected
-   * @internal
-   * Tracks all cleanup functions for subscriptions made via on()
-   */
-  protected _cleanupFunctions: Array<() => void>;
   /**
    * Returns the AbortSignal for this PubSub instance.
    * Use this signal with APIs that support cancellation (fetch, addEventListener, etc.)
@@ -2022,6 +2041,8 @@ interface HeadingFilterConfig {
   magneticGatingEnabled: boolean;
   /** Minimum heading delta to emit updates (degrees). */
   deltaThreshold: number;
+  /** Calibration offset applied to all compass readings (degrees). Set from VPS ground truth. */
+  calibrationOffset: number;
 }
 /**
  * Complementary filter for heading fusion.
@@ -2074,6 +2095,13 @@ declare class HeadingFusionFilter implements HeadingFusionAlgorithm {
    * @param confidence GPS confidence (0-1), affects how much GPS heading influences result
    */
   correctWithGps(gpsHeading: number, speed: number, confidence?: number): void;
+  /**
+   * Set a calibration offset derived from a known ground-truth heading (e.g. VPS).
+   * The offset is applied to all subsequent compass readings to correct systematic
+   * magnetic bias at the calibration location.
+   * @param offsetDegrees Offset in degrees (groundTruthHeading - deviceCompassHeading)
+   */
+  setCalibrationOffset(offsetDegrees: number): void;
   /**
    * Configure the filter parameters at runtime.
    * @param config Partial configuration to apply

package/lib/esm/react/index.js

@@ -1 +1 @@
-import{d as f}from"../chunk-NUHGT3O3.js";import{c as n,m as u}from"../chunk-UZOPCEME.js";u();u();import{useCallback as c,useState as p}from"react";import{useMap as D,useMapViewExtension as m}from"@mappedin/react-sdk";function B(){let[,t]=p({});return c(()=>t({}),[])}n(B,"useForceUpdate");function l(){let{mapView:t}=D(),o=B(),{register:r}=m("blue-dot",{onRegister:n(()=>{let e=new f(t);return e.on("position-update",o),e.on("status-change",o),e.on("follow-change",o),e.on("error",o),e},"onRegister"),onDeregister:n(e=>{e.off("position-update",o),e.off("status-change",o),e.off("follow-change",o),e.off("error",o),e.destroy()},"onDeregister")}),s=r();if(!s)throw new Error("BlueDot failed to initialize.");return s}n(l,"useBlueDot");u();import{useCallback as d,useEffect as E,useRef as g}from"react";function w(t,o){let r=l(),s=g(o);s.current=o;let e=d(i=>{s.current(i)},[]);E(()=>{if(r!=null)return r.on(t,e),()=>{r!=null&&r.off(t,e)}},[r,t,e])}n(w,"useBlueDotEvent");export{l as useBlueDot,w as useBlueDotEvent};
+import{d as f}from"../chunk-IJA5ETXF.js";import{a as n,j as u}from"../chunk-T4TSXXQK.js";u();u();import{useCallback as c,useState as p}from"react";import{useMap as D,useMapViewExtension as m}from"@mappedin/react-sdk";function B(){let[,t]=p({});return c(()=>t({}),[])}n(B,"useForceUpdate");function l(){let{mapView:t}=D(),o=B(),{register:r}=m("blue-dot",{onRegister:n(()=>{let e=new f(t);return e.on("position-update",o),e.on("status-change",o),e.on("follow-change",o),e.on("error",o),e},"onRegister"),onDeregister:n(e=>{e.off("position-update",o),e.off("status-change",o),e.off("follow-change",o),e.off("error",o),e.destroy()},"onDeregister")}),s=r();if(!s)throw new Error("BlueDot failed to initialize.");return s}n(l,"useBlueDot");u();import{useCallback as d,useEffect as E,useRef as g}from"react";function w(t,o){let r=l(),s=g(o);s.current=o;let e=d(i=>{s.current(i)},[]);E(()=>{if(r!=null)return r.on(t,e),()=>{r?.off(t,e)}},[r,t,e])}n(w,"useBlueDotEvent");export{l as useBlueDot,w as useBlueDotEvent};

package/lib/rn/fusion/algorithms/heading-filter.d.ts

@@ -13,6 +13,8 @@ export interface HeadingFilterConfig {
     magneticGatingEnabled: boolean;
     /** Minimum heading delta to emit updates (degrees). */
     deltaThreshold: number;
+    /** Calibration offset applied to all compass readings (degrees). Set from VPS ground truth. */
+    calibrationOffset: number;
 }
 /**
  * Complementary filter for heading fusion.
@@ -65,6 +67,13 @@ export declare class HeadingFusionFilter implements HeadingFusionAlgorithm {
      * @param confidence GPS confidence (0-1), affects how much GPS heading influences result
      */
     correctWithGps(gpsHeading: number, speed: number, confidence?: number): void;
+    /**
+     * Set a calibration offset derived from a known ground-truth heading (e.g. VPS).
+     * The offset is applied to all subsequent compass readings to correct systematic
+     * magnetic bias at the calibration location.
+     * @param offsetDegrees Offset in degrees (groundTruthHeading - deviceCompassHeading)
+     */
+    setCalibrationOffset(offsetDegrees: number): void;
     /**
      * Configure the filter parameters at runtime.
      * @param config Partial configuration to apply