@mappedin/blue-dot 6.21.1-beta.0 → 6.23.0-beta.0

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

@@ -1178,7 +1178,18 @@ interface MapViewExtension<T> {
 //#endregion
 //#region src/status/types.d.ts
 type BlueDotStatus = 'hidden' | 'active' | 'inactive' | 'disabled';
-type BlueDotAction = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * State-machine input alphabet — the only values `StatusManager.transitionTo()`
+ * accepts and the only keys the transition table is defined over.
+ */
+type BlueDotTransition = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * Reason a `status-change` event fired. Either a state-machine {@link BlueDotTransition}
+ * or `'visibility-change'`, emitted when a visibility overlay flips the exposed status
+ * without a state-machine transition (e.g. floor visibility when `multiFloorView` is
+ * disabled). Read the event's `status` for the resulting value/direction.
+ */
+type BlueDotAction = BlueDotTransition | 'visibility-change';
 //#endregion
 //#region src/follow/types.d.ts
 type FollowMode = /** Camera position follows the Blue Dot's position. */
@@ -1431,9 +1442,18 @@ type BlueDotPositionUpdate = {
    */
   heading?: GeolocationPosition['coords']['heading'] | 'device' | undefined;
   /**
-   * Floor or floorId to override.
-   * Set to `'device'` to reset to the device's floor level.
-   * Set to `undefined` to disable floor level and show the BlueDot on all floors.
+   * Floor or floorId the Blue Dot is on.
+   *
+   * Set to `'device'` to reset to the device's floor level. Set to `undefined` to
+   * clear the floor so the Blue Dot is not associated with any floor.
+   *
+   * Floor visibility behavior depends on the map's `multiFloorView` option:
+   * - When `multiFloorView` is disabled, the Blue Dot is only shown while its floor
+   *   is the visible floor. Changing the map to a different floor hides the Blue Dot
+   *   (its `status` becomes `'hidden'`); returning to its floor shows it again. If no
+   *   floor is set, the Blue Dot is shown on all floors.
+   * - When `multiFloorView` is enabled (the default), the Blue Dot is always shown
+   *   regardless of the floor value.
    */
   floorOrFloorId?: Floor | string | 'device' | undefined;
   /**
@@ -2389,6 +2409,10 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    * The current state of the BlueDot. Can be 'hidden', 'active', 'inactive', or 'disabled'.
    * Listen for state changes using the 'status-change' event.
    *
+   * @remarks When `multiFloorView` is disabled, the status is `'hidden'` whenever the
+   * Blue Dot's floor is not the visible floor, and returns to its previous value
+   * (`'active'` or `'inactive'`) when that floor becomes visible again.
+   *
    * @example
    * mapView.BlueDot.on('status-change', ({ status }) => {
    *   if (status === 'active') {
@@ -2419,7 +2443,11 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    */
   getState(): ReadonlyDeep<BlueDotState>;
   /**
-   * The floor the Blue Dot is currently on. If undefined, the Blue Dot will appear on every floor.
+   * The floor the Blue Dot is currently on.
+   *
+   * When `multiFloorView` is disabled, the Blue Dot is only shown while this floor
+   * is the visible floor; if it is `undefined`, the Blue Dot appears on every floor.
+   * When `multiFloorView` is enabled, the Blue Dot appears on every floor regardless.
    */
   get floor(): Floor | undefined;
   /**

package/lib/esm/debug/index.js

@@ -1,4 +1,4 @@
-import{a,d as w,e,f as h,g as u,h as i,j as N,k as T}from"../chunk-Q6T2WYNW.js";N();N();N();function Je(d){let t={};for(let[l,m]of d.Sensors.getAll())t[l]={enabled:m.isEnabled};let n={timestamp:Date.now(),state:d.getState(),position:d.coordinate?{lat:d.coordinate.latitude,lon:d.coordinate.longitude,floor:d.floor?.name}:null,accuracy:d.accuracy,heading:d.heading,sensors:t,anchor:d.anchor,displacement:d.displacement},s=new Blob([JSON.stringify(n,null,2)],{type:"application/json"}),r=new File([s],`bluedot-debug-${Date.now()}.json`,{type:"application/json"});navigator.canShare?.({files:[r]})?navigator.share({files:[r]}).catch(()=>{qe(s,r.name)}):qe(s,r.name)}a(Je,"exportDebugData");function qe(d,t){let n=URL.createObjectURL(d),s=document.createElement("a");s.href=n,s.download=t,s.click(),URL.revokeObjectURL(n)}a(qe,"downloadFile");N();var B={heading:{headingResponsiveness:40,compassNoiseTolerance:30,headingSnapThreshold:10,magneticDisturbanceGating:!0,headingChangeThreshold:2},motion:{stepSensitivity:50,averageStepLength:.7,strideVariability:0,motionResponsiveness:50,pdrEnabled:!0}};function De(d){return{complementaryAlpha:.99-d.headingResponsiveness/100*.79,gyroNoiseThreshold:.1+d.compassNoiseTolerance/100*4.9,maxHeadingError:d.headingSnapThreshold,magneticGatingEnabled:d.magneticDisturbanceGating,deltaThreshold:d.headingChangeThreshold}}a(De,"headingConfigToFilterParams");function Fe(d){return{stepDetectionThreshold:2-d.stepSensitivity/100*1.5,stepLength:d.averageStepLength,strideAdaptation:d.strideVariability/100*.3,motionThreshold:1-d.motionResponsiveness/100*.8,pdrEnabled:d.pdrEnabled}}a(Fe,"motionConfigToSensorParams");function R(d,t,n){return Math.min(Math.max(d,t),n)}a(R,"clamp");function rt(d){let t={...B};return d.heading&&(t.heading={headingResponsiveness:R(d.heading.headingResponsiveness??30,0,100),compassNoiseTolerance:R(d.heading.compassNoiseTolerance??50,0,100),headingSnapThreshold:R(d.heading.headingSnapThreshold??30,10,90),magneticDisturbanceGating:d.heading.magneticDisturbanceGating??!0,headingChangeThreshold:R(d.heading.headingChangeThreshold??2,1,10)}),d.motion&&(t.motion={stepSensitivity:R(d.motion.stepSensitivity??50,0,100),averageStepLength:R(d.motion.averageStepLength??.7,.4,1.2),strideVariability:R(d.motion.strideVariability??0,0,100),motionResponsiveness:R(d.motion.motionResponsiveness??50,0,100),pdrEnabled:d.motion.pdrEnabled??!0}),t}a(rt,"normalizeTuningConfig");var Ke=`.bluedot-hud {
+import{a,d as w,e,f as h,g as u,h as i,j as N,k as T}from"../chunk-L57APJ3L.js";N();N();N();function Je(d){let t={};for(let[l,m]of d.Sensors.getAll())t[l]={enabled:m.isEnabled};let n={timestamp:Date.now(),state:d.getState(),position:d.coordinate?{lat:d.coordinate.latitude,lon:d.coordinate.longitude,floor:d.floor?.name}:null,accuracy:d.accuracy,heading:d.heading,sensors:t,anchor:d.anchor,displacement:d.displacement},s=new Blob([JSON.stringify(n,null,2)],{type:"application/json"}),r=new File([s],`bluedot-debug-${Date.now()}.json`,{type:"application/json"});navigator.canShare?.({files:[r]})?navigator.share({files:[r]}).catch(()=>{qe(s,r.name)}):qe(s,r.name)}a(Je,"exportDebugData");function qe(d,t){let n=URL.createObjectURL(d),s=document.createElement("a");s.href=n,s.download=t,s.click(),URL.revokeObjectURL(n)}a(qe,"downloadFile");N();var B={heading:{headingResponsiveness:40,compassNoiseTolerance:30,headingSnapThreshold:10,magneticDisturbanceGating:!0,headingChangeThreshold:2},motion:{stepSensitivity:50,averageStepLength:.7,strideVariability:0,motionResponsiveness:50,pdrEnabled:!0}};function De(d){return{complementaryAlpha:.99-d.headingResponsiveness/100*.79,gyroNoiseThreshold:.1+d.compassNoiseTolerance/100*4.9,maxHeadingError:d.headingSnapThreshold,magneticGatingEnabled:d.magneticDisturbanceGating,deltaThreshold:d.headingChangeThreshold}}a(De,"headingConfigToFilterParams");function Fe(d){return{stepDetectionThreshold:2-d.stepSensitivity/100*1.5,stepLength:d.averageStepLength,strideAdaptation:d.strideVariability/100*.3,motionThreshold:1-d.motionResponsiveness/100*.8,pdrEnabled:d.pdrEnabled}}a(Fe,"motionConfigToSensorParams");function R(d,t,n){return Math.min(Math.max(d,t),n)}a(R,"clamp");function rt(d){let t={...B};return d.heading&&(t.heading={headingResponsiveness:R(d.heading.headingResponsiveness??30,0,100),compassNoiseTolerance:R(d.heading.compassNoiseTolerance??50,0,100),headingSnapThreshold:R(d.heading.headingSnapThreshold??30,10,90),magneticDisturbanceGating:d.heading.magneticDisturbanceGating??!0,headingChangeThreshold:R(d.heading.headingChangeThreshold??2,1,10)}),d.motion&&(t.motion={stepSensitivity:R(d.motion.stepSensitivity??50,0,100),averageStepLength:R(d.motion.averageStepLength??.7,.4,1.2),strideVariability:R(d.motion.strideVariability??0,0,100),motionResponsiveness:R(d.motion.motionResponsiveness??50,0,100),pdrEnabled:d.motion.pdrEnabled??!0}),t}a(rt,"normalizeTuningConfig");var Ke=`.bluedot-hud {
 	position: fixed;
 	bottom: 0;
 	left: 0;

package/lib/esm/index.d.ts

@@ -1178,7 +1178,18 @@ interface MapViewExtension<T> {
 //#endregion
 //#region src/status/types.d.ts
 type BlueDotStatus = 'hidden' | 'active' | 'inactive' | 'disabled';
-type BlueDotAction = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * State-machine input alphabet — the only values `StatusManager.transitionTo()`
+ * accepts and the only keys the transition table is defined over.
+ */
+type BlueDotTransition = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * Reason a `status-change` event fired. Either a state-machine {@link BlueDotTransition}
+ * or `'visibility-change'`, emitted when a visibility overlay flips the exposed status
+ * without a state-machine transition (e.g. floor visibility when `multiFloorView` is
+ * disabled). Read the event's `status` for the resulting value/direction.
+ */
+type BlueDotAction = BlueDotTransition | 'visibility-change';
 //#endregion
 //#region src/follow/types.d.ts
 type FollowMode = /** Camera position follows the Blue Dot's position. */
@@ -1432,9 +1443,18 @@ type BlueDotPositionUpdate = {
    */
   heading?: GeolocationPosition['coords']['heading'] | 'device' | undefined;
   /**
-   * Floor or floorId to override.
-   * Set to `'device'` to reset to the device's floor level.
-   * Set to `undefined` to disable floor level and show the BlueDot on all floors.
+   * Floor or floorId the Blue Dot is on.
+   *
+   * Set to `'device'` to reset to the device's floor level. Set to `undefined` to
+   * clear the floor so the Blue Dot is not associated with any floor.
+   *
+   * Floor visibility behavior depends on the map's `multiFloorView` option:
+   * - When `multiFloorView` is disabled, the Blue Dot is only shown while its floor
+   *   is the visible floor. Changing the map to a different floor hides the Blue Dot
+   *   (its `status` becomes `'hidden'`); returning to its floor shows it again. If no
+   *   floor is set, the Blue Dot is shown on all floors.
+   * - When `multiFloorView` is enabled (the default), the Blue Dot is always shown
+   *   regardless of the floor value.
    */
   floorOrFloorId?: Floor | string | 'device' | undefined;
   /**
@@ -2390,6 +2410,10 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    * The current state of the BlueDot. Can be 'hidden', 'active', 'inactive', or 'disabled'.
    * Listen for state changes using the 'status-change' event.
    *
+   * @remarks When `multiFloorView` is disabled, the status is `'hidden'` whenever the
+   * Blue Dot's floor is not the visible floor, and returns to its previous value
+   * (`'active'` or `'inactive'`) when that floor becomes visible again.
+   *
    * @example
    * mapView.BlueDot.on('status-change', ({ status }) => {
    *   if (status === 'active') {
@@ -2420,7 +2444,11 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    */
   getState(): ReadonlyDeep<BlueDotState>;
   /**
-   * The floor the Blue Dot is currently on. If undefined, the Blue Dot will appear on every floor.
+   * The floor the Blue Dot is currently on.
+   *
+   * When `multiFloorView` is disabled, the Blue Dot is only shown while this floor
+   * is the visible floor; if it is `undefined`, the Blue Dot appears on every floor.
+   * When `multiFloorView` is enabled, the Blue Dot appears on every floor regardless.
    */
   get floor(): Floor | undefined;
   /**
@@ -2682,4 +2710,4 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
   destroy: () => void;
 }
 //#endregion
-export { BaseSensor, BlueDot, type BlueDotAction, type BlueDotEventPayloads, type BlueDotEvents, type BlueDotPositionProcessor, type BlueDotPositionUpdate, type BlueDotPositionUpdateWithFloor, type BlueDotState, type BlueDotStatus, type BlueDotUpdateOptions, type BlueDotUpdateState, type BuiltInSensorId, type CustomSensorId, type DisplacementVector, type FollowCameraOptions, type FollowMode, type FusedPosition, type GeolocationPositionExtended, type ManualDisplacementOptions, type ManualPositionOptions, ManualSensor, type PartialPositionUpdate, type PositionAnchor, type PositionMetadata, type PositionUpdate, type SensorEventPayloads, type SensorId, SensorRegistry, type SetAnchorOptions };
+export { BaseSensor, BlueDot, type BlueDotAction, type BlueDotEventPayloads, type BlueDotEvents, type BlueDotPositionProcessor, type BlueDotPositionUpdate, type BlueDotPositionUpdateWithFloor, type BlueDotState, type BlueDotStatus, type BlueDotTransition, type BlueDotUpdateOptions, type BlueDotUpdateState, type BuiltInSensorId, type CustomSensorId, type DisplacementVector, type FollowCameraOptions, type FollowMode, type FusedPosition, type GeolocationPositionExtended, type ManualDisplacementOptions, type ManualPositionOptions, ManualSensor, type PartialPositionUpdate, type PositionAnchor, type PositionMetadata, type PositionUpdate, type SensorEventPayloads, type SensorId, SensorRegistry, type SetAnchorOptions };

package/lib/esm/index.js

@@ -1 +1 @@
-import{a as t,b as e,c as s,d as n}from"./chunk-Z7JSDF6R.js";import{j as o}from"./chunk-Q6T2WYNW.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-SM3VIXP7.js";import{j as o}from"./chunk-L57APJ3L.js";o();export{t as BaseSensor,n as BlueDot,e as ManualSensor,s as SensorRegistry};

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

@@ -1178,7 +1178,18 @@ interface MapViewExtension<T> {
 //#endregion
 //#region src/status/types.d.ts
 type BlueDotStatus = 'hidden' | 'active' | 'inactive' | 'disabled';
-type BlueDotAction = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * State-machine input alphabet — the only values `StatusManager.transitionTo()`
+ * accepts and the only keys the transition table is defined over.
+ */
+type BlueDotTransition = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+/**
+ * Reason a `status-change` event fired. Either a state-machine {@link BlueDotTransition}
+ * or `'visibility-change'`, emitted when a visibility overlay flips the exposed status
+ * without a state-machine transition (e.g. floor visibility when `multiFloorView` is
+ * disabled). Read the event's `status` for the resulting value/direction.
+ */
+type BlueDotAction = BlueDotTransition | 'visibility-change';
 //#endregion
 //#region src/follow/types.d.ts
 type FollowMode = /** Camera position follows the Blue Dot's position. */
@@ -1432,9 +1443,18 @@ type BlueDotPositionUpdate = {
    */
   heading?: GeolocationPosition['coords']['heading'] | 'device' | undefined;
   /**
-   * Floor or floorId to override.
-   * Set to `'device'` to reset to the device's floor level.
-   * Set to `undefined` to disable floor level and show the BlueDot on all floors.
+   * Floor or floorId the Blue Dot is on.
+   *
+   * Set to `'device'` to reset to the device's floor level. Set to `undefined` to
+   * clear the floor so the Blue Dot is not associated with any floor.
+   *
+   * Floor visibility behavior depends on the map's `multiFloorView` option:
+   * - When `multiFloorView` is disabled, the Blue Dot is only shown while its floor
+   *   is the visible floor. Changing the map to a different floor hides the Blue Dot
+   *   (its `status` becomes `'hidden'`); returning to its floor shows it again. If no
+   *   floor is set, the Blue Dot is shown on all floors.
+   * - When `multiFloorView` is enabled (the default), the Blue Dot is always shown
+   *   regardless of the floor value.
    */
   floorOrFloorId?: Floor | string | 'device' | undefined;
   /**
@@ -2390,6 +2410,10 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    * The current state of the BlueDot. Can be 'hidden', 'active', 'inactive', or 'disabled'.
    * Listen for state changes using the 'status-change' event.
    *
+   * @remarks When `multiFloorView` is disabled, the status is `'hidden'` whenever the
+   * Blue Dot's floor is not the visible floor, and returns to its previous value
+   * (`'active'` or `'inactive'`) when that floor becomes visible again.
+   *
    * @example
    * mapView.BlueDot.on('status-change', ({ status }) => {
    *   if (status === 'active') {
@@ -2420,7 +2444,11 @@ declare class BlueDot implements MapViewExtension<BlueDotState> {
    */
   getState(): ReadonlyDeep<BlueDotState>;
   /**
-   * The floor the Blue Dot is currently on. If undefined, the Blue Dot will appear on every floor.
+   * The floor the Blue Dot is currently on.
+   *
+   * When `multiFloorView` is disabled, the Blue Dot is only shown while this floor
+   * is the visible floor; if it is `undefined`, the Blue Dot appears on every floor.
+   * When `multiFloorView` is enabled, the Blue Dot appears on every floor regardless.
    */
   get floor(): Floor | undefined;
   /**

package/lib/esm/react/index.js

@@ -1 +1 @@
-import{d as f}from"../chunk-Z7JSDF6R.js";import{a as n,j as u}from"../chunk-Q6T2WYNW.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};
+import{d as f}from"../chunk-SM3VIXP7.js";import{a as n,j as u}from"../chunk-L57APJ3L.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/blue-dot.d.ts

@@ -75,6 +75,10 @@ export declare class BlueDot implements MapViewExtension<BlueDotState> {
      * The current state of the BlueDot. Can be 'hidden', 'active', 'inactive', or 'disabled'.
      * Listen for state changes using the 'status-change' event.
      *
+     * @remarks When `multiFloorView` is disabled, the status is `'hidden'` whenever the
+     * Blue Dot's floor is not the visible floor, and returns to its previous value
+     * (`'active'` or `'inactive'`) when that floor becomes visible again.
+     *
      * @example
      * mapView.BlueDot.on('status-change', ({ status }) => {
      *   if (status === 'active') {
@@ -105,7 +109,11 @@ export declare class BlueDot implements MapViewExtension<BlueDotState> {
      */
     getState(): ReadonlyDeep<BlueDotState>;
     /**
-     * The floor the Blue Dot is currently on. If undefined, the Blue Dot will appear on every floor.
+     * The floor the Blue Dot is currently on.
+     *
+     * When `multiFloorView` is disabled, the Blue Dot is only shown while this floor
+     * is the visible floor; if it is `undefined`, the Blue Dot appears on every floor.
+     * When `multiFloorView` is enabled, the Blue Dot appears on every floor regardless.
      */
     get floor(): Floor | undefined;
     /**