expo-beacon 0.5.0 → 0.5.2

package/README.md

@@ -832,6 +832,7 @@ Accepts a `MonitoringOptions` object, a plain `number` (shorthand for `maxDistan
 | Property | Type | Default | Description |
 |---|---|---|---|
 | `maxDistance` | `number` | `undefined` | Distance threshold in metres. `onBeaconEnter` / `onEddystoneEnter` only fires when measured distance ≤ this value. `onBeaconExit` / `onEddystoneExit` always fires. Omit to disable filtering. |
+| `exitDistance` | `number` | `maxDistance + min(maxDistance × 0.5, 2.5)` | Distance in metres at which exit events fire. Must be ≥ `maxDistance`. Creates a hysteresis band between enter and exit thresholds to prevent rapid toggling near the boundary. Only used when `maxDistance` is set. |
 | `notifications` | `NotificationConfig` | `undefined` | Notification overrides for this session (persisted). |
 
 **What happens on each platform**:
@@ -847,9 +848,10 @@ Accepts a `MonitoringOptions` object, a plain `number` (shorthand for `maxDistan
 // Shorthand — just a distance threshold
 await ExpoBeacon.startMonitoring(5);
 
-// Full options
+// Full options with custom exit threshold
 await ExpoBeacon.startMonitoring({
   maxDistance: 10,
+  exitDistance: 15, // Exit fires when distance exceeds 15m
   notifications: {
     beaconEvents: {
       enterTitle: "Welcome!",
@@ -1181,6 +1183,7 @@ Passed to `startMonitoring()`.
 ```ts
 type MonitoringOptions = {
   maxDistance?: number;
+  exitDistance?: number;
   notifications?: NotificationConfig;
 };
 ```

package/android/src/main/java/expo/modules/beacon/BeaconForegroundService.kt

@@ -31,6 +31,7 @@ class BeaconForegroundService : Service(), BeaconConsumer {
 
     // Distance filtering
     @Volatile private var maxDistance: Double? = null
+    @Volatile private var exitDistance: Double? = null
     private val rangingRegions = java.util.concurrent.CopyOnWriteArraySet<Region>()
     private val enteredRegions = java.util.concurrent.CopyOnWriteArraySet<String>()
 
@@ -101,9 +102,10 @@ class BeaconForegroundService : Service(), BeaconConsumer {
     }
 
     override fun onBeaconServiceConnect() {
-        // Read max distance from options prefs
+        // Read max distance and exit distance from options prefs
         val optPrefs = getSharedPreferences(MONITORING_OPTIONS_PREFS, Context.MODE_PRIVATE)
         maxDistance = optPrefs.getString("max_distance", null)?.toDoubleOrNull()
+        exitDistance = optPrefs.getString("exit_distance", null)?.toDoubleOrNull()
 
         beaconManager.addMonitorNotifier(monitorNotifier)
         beaconManager.addRangeNotifier(rangeNotifier)
@@ -296,6 +298,15 @@ class BeaconForegroundService : Service(), BeaconConsumer {
 
     private enum class HysteresisAction { NONE, ENTER, EXIT }
 
+    /**
+     * Computes the effective exit distance from maxDistance and an optional explicit exitDistance.
+     * Default: maxDistance + min(maxDistance × 0.5, 2.5).
+     */
+    private fun effectiveExitDistance(maxDist: Double): Double {
+        exitDistance?.let { return it }
+        return maxDist + minOf(maxDist * 0.5, 2.5)
+    }
+
     /**
      * Evaluate distance-based enter/exit with hysteresis counters.
      * Must be called within synchronized(distanceLock).
@@ -306,8 +317,9 @@ class BeaconForegroundService : Service(), BeaconConsumer {
         distance: Double,
         maxDist: Double
     ): HysteresisAction {
+        val exitDist = effectiveExitDistance(maxDist)
         if (distance <= maxDist) {
-            // Inside threshold
+            // Inside enter threshold
             exitCounters[regionId] = 0
             val count = (enterCounters[regionId] ?: 0) + 1
             enterCounters[regionId] = count
@@ -315,8 +327,8 @@ class BeaconForegroundService : Service(), BeaconConsumer {
                 enterCounters[regionId] = 0
                 return HysteresisAction.ENTER
             }
-        } else {
-            // Outside threshold
+        } else if (distance > exitDist) {
+            // Outside exit threshold
             enterCounters[regionId] = 0
             val count = (exitCounters[regionId] ?: 0) + 1
             exitCounters[regionId] = count
@@ -324,6 +336,10 @@ class BeaconForegroundService : Service(), BeaconConsumer {
                 exitCounters[regionId] = 0
                 return HysteresisAction.EXIT
             }
+        } else {
+            // In the hysteresis band (maxDist < distance <= exitDist) — do nothing
+            enterCounters[regionId] = 0
+            exitCounters[regionId] = 0
         }
         return HysteresisAction.NONE
     }

package/android/src/main/java/expo/modules/beacon/ExpoBeaconModule.kt

@@ -264,12 +264,14 @@ class ExpoBeaconModule : Module(), BeaconConsumer {
                 return@AsyncFunction
             }
             var maxDistance: Double? = null
+            var exitDistance: Double? = null
             when (options) {
                 is Double -> maxDistance = options
                 is Map<*, *> -> {
                     @Suppress("UNCHECKED_CAST")
                     val map = options as Map<String, Any?>
                     maxDistance = (map["maxDistance"] as? Number)?.toDouble()
+                    exitDistance = (map["exitDistance"] as? Number)?.toDouble()
                     val notifications = map["notifications"]
                     if (notifications is Map<*, *>) {
                         @Suppress("UNCHECKED_CAST")
@@ -282,6 +284,8 @@ class ExpoBeaconModule : Module(), BeaconConsumer {
                 .edit().apply {
                     if (maxDistance != null) putString("max_distance", maxDistance.toString())
                     else remove("max_distance")
+                    if (exitDistance != null) putString("exit_distance", exitDistance.toString())
+                    else remove("exit_distance")
                 }.apply()
             // Verify we have the permissions needed for background monitoring
             val hasLocation = ContextCompat.checkSelfPermission(ctx, Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED

package/build/ExpoBeacon.types.d.ts

@@ -92,6 +92,15 @@ export type MonitoringOptions = {
      * Exit events are always emitted when the region is lost.
      */
     maxDistance?: number;
+    /**
+     * Distance in metres at which exit events fire (must be ≥ maxDistance).
+     * Creates a hysteresis band between enter and exit thresholds to prevent
+     * rapid toggling near the boundary.
+     *
+     * Default when omitted: `maxDistance + min(maxDistance × 0.5, 2.5)`.
+     * Only used when `maxDistance` is set.
+     */
+    exitDistance?: number;
     /** Notification configuration overrides to apply for this monitoring session. */
     notifications?: NotificationConfig;
 };

package/build/ExpoBeacon.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoBeacon.types.d.ts","sourceRoot":"","sources":["../src/ExpoBeacon.types.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,mGAAmG;AACnG,MAAM,MAAM,uBAAuB,GAAG;IACpC,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,yBAAyB,GAAG;IACtC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8GAA8G;IAC9G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;CACzC,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0DAA0D;IAC1D,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kFAAkF;IAClF,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;IAC5C,oEAAoE;IACpE,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,6CAA6C;AAC7C,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,4BAA4B;AAC5B,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE/C,qDAAqD;AACrD,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,+EAA+E;AAC/E,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAwB;AACxB,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACnD,YAAY,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAClD,gBAAgB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,yEAAyE;IACzE,aAAa,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAClD,kFAAkF;IAClF,gBAAgB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,gBAAgB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACzD,eAAe,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI,CAAC;CAC/D,CAAC"}
+{"version":3,"file":"ExpoBeacon.types.d.ts","sourceRoot":"","sources":["../src/ExpoBeacon.types.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,mGAAmG;AACnG,MAAM,MAAM,uBAAuB,GAAG;IACpC,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,yBAAyB,GAAG;IACtC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8GAA8G;IAC9G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;CACzC,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0DAA0D;IAC1D,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kFAAkF;IAClF,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;IAC5C,oEAAoE;IACpE,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,6CAA6C;AAC7C,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iFAAiF;IACjF,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,4BAA4B;AAC5B,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE/C,qDAAqD;AACrD,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,+EAA+E;AAC/E,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAwB;AACxB,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACnD,YAAY,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAClD,gBAAgB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,yEAAyE;IACzE,aAAa,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAClD,kFAAkF;IAClF,gBAAgB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,gBAAgB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACzD,eAAe,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI,CAAC;CAC/D,CAAC"}

package/build/ExpoBeacon.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoBeacon.types.js","sourceRoot":"","sources":["../src/ExpoBeacon.types.ts"],"names":[],"mappings":"","sourcesContent":["/** Raw beacon discovered during a scan. */\r\nexport type BeaconScanResult = {\r\n  uuid: string; // iBeacon proximity UUID (uppercase, formatted)\r\n  major: number; // iBeacon major value (0–65535)\r\n  minor: number; // iBeacon minor value (0–65535)\r\n  rssi: number; // Signal strength in dBm (negative number)\r\n  distance: number; // Estimated distance in meters\r\n  txPower: number; // Calibrated TX power\r\n};\r\n\r\n/**\r\n * A beacon that has been paired/registered for monitoring.\r\n *\r\n * Note: Paired beacon data is stored unencrypted in UserDefaults (iOS) /\r\n * SharedPreferences (Android) and may be included in device backups.\r\n */\r\nexport type PairedBeacon = {\r\n  identifier: string; // User-defined label (e.g. \"lobby-door\")\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n};\r\n\r\n/** Payload for enter/exit region events. */\r\nexport type BeaconRegionEvent = {\r\n  identifier: string; // Matches PairedBeacon.identifier\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n  event: \"enter\" | \"exit\";\r\n  /** Measured distance in metres at the time of the event (–1 if unavailable). */\r\n  distance: number;\r\n};\r\n\r\n/** Payload for periodic distance update events during monitoring. */\r\nexport type BeaconDistanceEvent = {\r\n  identifier: string;\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n  distance: number;\r\n};\r\n\r\n/** Configuration for beacon enter/exit event notifications. */\r\nexport type BeaconNotificationConfig = {\r\n  /** Whether to show enter/exit notifications. Default: true. */\r\n  enabled?: boolean;\r\n  /** Notification title on beacon enter. Default: \"Beacon Entered\". */\r\n  enterTitle?: string;\r\n  /** Notification title on beacon exit. Default: \"Beacon Exited\". */\r\n  exitTitle?: string;\r\n  /**\r\n   * Notification body template. Supports {identifier} and {event} placeholders.\r\n   * Default: \"{identifier} region {event}ed\".\r\n   */\r\n  body?: string;\r\n  /** Play a sound with the notification (iOS only). Default: true. */\r\n  sound?: boolean;\r\n  /** Android drawable resource name for the notification icon (e.g. \"ic_notification\"). */\r\n  icon?: string;\r\n};\r\n\r\n/** Configuration for the Android foreground service notification (persistent status bar entry). */\r\nexport type ForegroundServiceConfig = {\r\n  /** Title of the persistent notification. Default: \"Beacon Monitoring Active\". */\r\n  title?: string;\r\n  /** Body text of the persistent notification. Default: \"Monitoring for iBeacons in the background\". */\r\n  text?: string;\r\n  /** Android drawable resource name for the notification icon. */\r\n  icon?: string;\r\n};\r\n\r\n/** Configuration for the Android notification channel. */\r\nexport type NotificationChannelConfig = {\r\n  /** Channel display name shown in system settings. Default: \"Beacon Monitoring\". */\r\n  name?: string;\r\n  /** Channel description shown in system settings. Default: \"Used for background iBeacon region monitoring\". */\r\n  description?: string;\r\n  /**\r\n   * Channel importance level. Default: 'low'.\r\n   * Note: Android may ignore decreases in importance after first channel creation until the app is reinstalled.\r\n   */\r\n  importance?: \"low\" | \"default\" | \"high\";\r\n};\r\n\r\n/** Combined notification configuration for all notification types. */\r\nexport type NotificationConfig = {\r\n  /** Settings for beacon enter/exit event notifications. */\r\n  beaconEvents?: BeaconNotificationConfig;\r\n  /** Settings for the persistent foreground service notification (Android only). */\r\n  foregroundService?: ForegroundServiceConfig;\r\n  /** Settings for the Android notification channel (Android only). */\r\n  channel?: NotificationChannelConfig;\r\n};\r\n\r\n/** Options accepted by startMonitoring(). */\r\nexport type MonitoringOptions = {\r\n  /**\r\n   * Maximum distance in metres for distance-based enter events.\r\n   * Exit events are always emitted when the region is lost.\r\n   */\r\n  maxDistance?: number;\r\n  /** Notification configuration overrides to apply for this monitoring session. */\r\n  notifications?: NotificationConfig;\r\n};\r\n\r\n/** Eddystone frame type. */\r\nexport type EddystoneFrameType = \"uid\" | \"url\";\r\n\r\n/** Raw Eddystone beacon discovered during a scan. */\r\nexport type EddystoneScanResult = {\r\n  frameType: EddystoneFrameType;\r\n  /** 10-byte namespace ID as hex string (20 chars). Present for UID frames. */\r\n  namespace?: string;\r\n  /** 6-byte instance ID as hex string (12 chars). Present for UID frames. */\r\n  instance?: string;\r\n  /** Decoded URL. Present for URL frames. */\r\n  url?: string;\r\n  rssi: number;\r\n  distance: number;\r\n  txPower: number;\r\n};\r\n\r\n/**\r\n * An Eddystone-UID beacon that has been paired/registered for monitoring.\r\n *\r\n * Note: Paired beacon data is stored unencrypted in UserDefaults (iOS) /\r\n * SharedPreferences (Android) and may be included in device backups.\r\n */\r\nexport type PairedEddystone = {\r\n  identifier: string;\r\n  /** 10-byte namespace ID as hex string (20 chars). */\r\n  namespace: string;\r\n  /** 6-byte instance ID as hex string (12 chars). */\r\n  instance: string;\r\n};\r\n\r\n/** Payload for Eddystone enter/exit region events. */\r\nexport type EddystoneRegionEvent = {\r\n  identifier: string;\r\n  namespace: string;\r\n  instance: string;\r\n  event: \"enter\" | \"exit\";\r\n  /** Measured distance in metres at the time of the event (–1 if unavailable). */\r\n  distance: number;\r\n};\r\n\r\n/** Payload for periodic Eddystone distance update events during monitoring. */\r\nexport type EddystoneDistanceEvent = {\r\n  identifier: string;\r\n  namespace: string;\r\n  instance: string;\r\n  distance: number;\r\n};\r\n\r\n/** Module event map. */\r\nexport type ExpoBeaconModuleEvents = {\r\n  onBeaconEnter: (params: BeaconRegionEvent) => void;\r\n  onBeaconExit: (params: BeaconRegionEvent) => void;\r\n  onBeaconDistance: (params: BeaconDistanceEvent) => void;\r\n  /** Fired continuously during a live scan as each iBeacon is detected. */\r\n  onBeaconFound: (params: BeaconScanResult) => void;\r\n  /** Fired continuously during a live scan as each Eddystone beacon is detected. */\r\n  onEddystoneFound: (params: EddystoneScanResult) => void;\r\n  onEddystoneEnter: (params: EddystoneRegionEvent) => void;\r\n  onEddystoneExit: (params: EddystoneRegionEvent) => void;\r\n  onEddystoneDistance: (params: EddystoneDistanceEvent) => void;\r\n};\r\n"]}
+{"version":3,"file":"ExpoBeacon.types.js","sourceRoot":"","sources":["../src/ExpoBeacon.types.ts"],"names":[],"mappings":"","sourcesContent":["/** Raw beacon discovered during a scan. */\r\nexport type BeaconScanResult = {\r\n  uuid: string; // iBeacon proximity UUID (uppercase, formatted)\r\n  major: number; // iBeacon major value (0–65535)\r\n  minor: number; // iBeacon minor value (0–65535)\r\n  rssi: number; // Signal strength in dBm (negative number)\r\n  distance: number; // Estimated distance in meters\r\n  txPower: number; // Calibrated TX power\r\n};\r\n\r\n/**\r\n * A beacon that has been paired/registered for monitoring.\r\n *\r\n * Note: Paired beacon data is stored unencrypted in UserDefaults (iOS) /\r\n * SharedPreferences (Android) and may be included in device backups.\r\n */\r\nexport type PairedBeacon = {\r\n  identifier: string; // User-defined label (e.g. \"lobby-door\")\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n};\r\n\r\n/** Payload for enter/exit region events. */\r\nexport type BeaconRegionEvent = {\r\n  identifier: string; // Matches PairedBeacon.identifier\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n  event: \"enter\" | \"exit\";\r\n  /** Measured distance in metres at the time of the event (–1 if unavailable). */\r\n  distance: number;\r\n};\r\n\r\n/** Payload for periodic distance update events during monitoring. */\r\nexport type BeaconDistanceEvent = {\r\n  identifier: string;\r\n  uuid: string;\r\n  major: number;\r\n  minor: number;\r\n  distance: number;\r\n};\r\n\r\n/** Configuration for beacon enter/exit event notifications. */\r\nexport type BeaconNotificationConfig = {\r\n  /** Whether to show enter/exit notifications. Default: true. */\r\n  enabled?: boolean;\r\n  /** Notification title on beacon enter. Default: \"Beacon Entered\". */\r\n  enterTitle?: string;\r\n  /** Notification title on beacon exit. Default: \"Beacon Exited\". */\r\n  exitTitle?: string;\r\n  /**\r\n   * Notification body template. Supports {identifier} and {event} placeholders.\r\n   * Default: \"{identifier} region {event}ed\".\r\n   */\r\n  body?: string;\r\n  /** Play a sound with the notification (iOS only). Default: true. */\r\n  sound?: boolean;\r\n  /** Android drawable resource name for the notification icon (e.g. \"ic_notification\"). */\r\n  icon?: string;\r\n};\r\n\r\n/** Configuration for the Android foreground service notification (persistent status bar entry). */\r\nexport type ForegroundServiceConfig = {\r\n  /** Title of the persistent notification. Default: \"Beacon Monitoring Active\". */\r\n  title?: string;\r\n  /** Body text of the persistent notification. Default: \"Monitoring for iBeacons in the background\". */\r\n  text?: string;\r\n  /** Android drawable resource name for the notification icon. */\r\n  icon?: string;\r\n};\r\n\r\n/** Configuration for the Android notification channel. */\r\nexport type NotificationChannelConfig = {\r\n  /** Channel display name shown in system settings. Default: \"Beacon Monitoring\". */\r\n  name?: string;\r\n  /** Channel description shown in system settings. Default: \"Used for background iBeacon region monitoring\". */\r\n  description?: string;\r\n  /**\r\n   * Channel importance level. Default: 'low'.\r\n   * Note: Android may ignore decreases in importance after first channel creation until the app is reinstalled.\r\n   */\r\n  importance?: \"low\" | \"default\" | \"high\";\r\n};\r\n\r\n/** Combined notification configuration for all notification types. */\r\nexport type NotificationConfig = {\r\n  /** Settings for beacon enter/exit event notifications. */\r\n  beaconEvents?: BeaconNotificationConfig;\r\n  /** Settings for the persistent foreground service notification (Android only). */\r\n  foregroundService?: ForegroundServiceConfig;\r\n  /** Settings for the Android notification channel (Android only). */\r\n  channel?: NotificationChannelConfig;\r\n};\r\n\r\n/** Options accepted by startMonitoring(). */\r\nexport type MonitoringOptions = {\r\n  /**\r\n   * Maximum distance in metres for distance-based enter events.\r\n   * Exit events are always emitted when the region is lost.\r\n   */\r\n  maxDistance?: number;\r\n  /**\r\n   * Distance in metres at which exit events fire (must be ≥ maxDistance).\r\n   * Creates a hysteresis band between enter and exit thresholds to prevent\r\n   * rapid toggling near the boundary.\r\n   *\r\n   * Default when omitted: `maxDistance + min(maxDistance × 0.5, 2.5)`.\r\n   * Only used when `maxDistance` is set.\r\n   */\r\n  exitDistance?: number;\r\n  /** Notification configuration overrides to apply for this monitoring session. */\r\n  notifications?: NotificationConfig;\r\n};\r\n\r\n/** Eddystone frame type. */\r\nexport type EddystoneFrameType = \"uid\" | \"url\";\r\n\r\n/** Raw Eddystone beacon discovered during a scan. */\r\nexport type EddystoneScanResult = {\r\n  frameType: EddystoneFrameType;\r\n  /** 10-byte namespace ID as hex string (20 chars). Present for UID frames. */\r\n  namespace?: string;\r\n  /** 6-byte instance ID as hex string (12 chars). Present for UID frames. */\r\n  instance?: string;\r\n  /** Decoded URL. Present for URL frames. */\r\n  url?: string;\r\n  rssi: number;\r\n  distance: number;\r\n  txPower: number;\r\n};\r\n\r\n/**\r\n * An Eddystone-UID beacon that has been paired/registered for monitoring.\r\n *\r\n * Note: Paired beacon data is stored unencrypted in UserDefaults (iOS) /\r\n * SharedPreferences (Android) and may be included in device backups.\r\n */\r\nexport type PairedEddystone = {\r\n  identifier: string;\r\n  /** 10-byte namespace ID as hex string (20 chars). */\r\n  namespace: string;\r\n  /** 6-byte instance ID as hex string (12 chars). */\r\n  instance: string;\r\n};\r\n\r\n/** Payload for Eddystone enter/exit region events. */\r\nexport type EddystoneRegionEvent = {\r\n  identifier: string;\r\n  namespace: string;\r\n  instance: string;\r\n  event: \"enter\" | \"exit\";\r\n  /** Measured distance in metres at the time of the event (–1 if unavailable). */\r\n  distance: number;\r\n};\r\n\r\n/** Payload for periodic Eddystone distance update events during monitoring. */\r\nexport type EddystoneDistanceEvent = {\r\n  identifier: string;\r\n  namespace: string;\r\n  instance: string;\r\n  distance: number;\r\n};\r\n\r\n/** Module event map. */\r\nexport type ExpoBeaconModuleEvents = {\r\n  onBeaconEnter: (params: BeaconRegionEvent) => void;\r\n  onBeaconExit: (params: BeaconRegionEvent) => void;\r\n  onBeaconDistance: (params: BeaconDistanceEvent) => void;\r\n  /** Fired continuously during a live scan as each iBeacon is detected. */\r\n  onBeaconFound: (params: BeaconScanResult) => void;\r\n  /** Fired continuously during a live scan as each Eddystone beacon is detected. */\r\n  onEddystoneFound: (params: EddystoneScanResult) => void;\r\n  onEddystoneEnter: (params: EddystoneRegionEvent) => void;\r\n  onEddystoneExit: (params: EddystoneRegionEvent) => void;\r\n  onEddystoneDistance: (params: EddystoneDistanceEvent) => void;\r\n};\r\n"]}

package/ios/ExpoBeaconModule.swift

@@ -8,6 +8,7 @@ private let PAIRED_BEACONS_KEY = "expo.beacon.paired"
 private let PAIRED_EDDYSTONES_KEY = "expo.beacon.paired_eddystones"
 private let IS_MONITORING_KEY = "expo.beacon.is_monitoring"
 private let MAX_DISTANCE_KEY = "expo.beacon.max_distance"
+private let EXIT_DISTANCE_KEY = "expo.beacon.exit_distance"
 private let NOTIFICATION_CONFIG_KEY = "expo.beacon.notification_config"
 
 /// Number of consecutive ranging misses before emitting a distance-based exit event.
@@ -97,10 +98,12 @@ public class ExpoBeaconModule: Module {
     }()
 
     public func definition() -> ModuleDefinition {
-        migrateUserDefaultsIfNeeded()
-
         Name("ExpoBeacon")
 
+        OnCreate {
+            self.migrateUserDefaultsIfNeeded()
+        }
+
         Events("onBeaconEnter", "onBeaconExit", "onBeaconDistance", "onBeaconFound", "onEddystoneFound", "onEddystoneEnter", "onEddystoneExit", "onEddystoneDistance")
 
         // MARK: - Scan
@@ -282,10 +285,12 @@ public class ExpoBeaconModule: Module {
 
         AsyncFunction("startMonitoring") { (options: Either<Double, [String: Any]>?, promise: Promise) in
             var maxDistance: Double? = nil
+            var exitDistance: Double? = nil
             if let dist: Double = options?.get() {
                 maxDistance = dist
             } else if let map: [String: Any] = options?.get() {
                 maxDistance = map["maxDistance"] as? Double
+                exitDistance = map["exitDistance"] as? Double
                 if let notifications = map["notifications"] as? [String: Any],
                    let data = try? JSONSerialization.data(withJSONObject: notifications),
                    let json = String(data: data, encoding: .utf8) {
@@ -297,6 +302,11 @@ public class ExpoBeaconModule: Module {
             } else {
                 self.defaults.removeObject(forKey: MAX_DISTANCE_KEY)
             }
+            if let exitDist = exitDistance {
+                self.defaults.set(exitDist, forKey: EXIT_DISTANCE_KEY)
+            } else {
+                self.defaults.removeObject(forKey: EXIT_DISTANCE_KEY)
+            }
             self.defaults.set(true, forKey: IS_MONITORING_KEY)
             self.requestLocationPermission(requireAlways: true) { granted in
                 guard granted else {
@@ -312,6 +322,7 @@ public class ExpoBeaconModule: Module {
         AsyncFunction("stopMonitoring") { (promise: Promise) in
             self.defaults.set(false, forKey: IS_MONITORING_KEY)
             self.defaults.removeObject(forKey: MAX_DISTANCE_KEY)
+            self.defaults.removeObject(forKey: EXIT_DISTANCE_KEY)
             self.stopRegionMonitoring()
             promise.resolve(nil)
         }
@@ -674,10 +685,12 @@ public class ExpoBeaconModule: Module {
 
             // Distance-driven enter/exit with hysteresis
             let maxDist = self.defaults.object(forKey: MAX_DISTANCE_KEY) as? Double
+            let exitDist = self.defaults.object(forKey: EXIT_DISTANCE_KEY) as? Double
             let action = evaluateDistanceHysteresis(
                 identifier: identifier,
                 distance: distance,
                 maxDistance: maxDist,
+                exitDistance: exitDist,
                 entered: &eddystoneEnteredRegions,
                 enterCtrs: &eddystoneEnterCounters,
                 exitCtrs: &eddystoneExitCounters
@@ -921,17 +934,26 @@ public class ExpoBeaconModule: Module {
         case none, enter, exit
     }
 
+    /// Computes the effective exit distance from maxDistance and an optional explicit exitDistance.
+    /// Default: maxDistance + min(maxDistance × 0.5, 2.5).
+    private static func effectiveExitDistance(maxDistance: Double, exitDistance: Double?) -> Double {
+        if let explicit = exitDistance { return explicit }
+        return maxDistance + min(maxDistance * 0.5, 2.5)
+    }
+
     /// Shared distance-based enter/exit evaluation with hysteresis.
     /// Used by both iBeacon (handleDidRange) and Eddystone (handleEddystoneDiscovery) paths.
     private func evaluateDistanceHysteresis(
         identifier: String,
         distance: Double,
         maxDistance: Double?,
+        exitDistance: Double?,
         entered: inout Set<String>,
         enterCtrs: inout [String: Int],
         exitCtrs: inout [String: Int]
     ) -> HysteresisAction {
         if let maxDist = maxDistance {
+            let exitDist = Self.effectiveExitDistance(maxDistance: maxDist, exitDistance: exitDistance)
             if distance <= maxDist {
                 exitCtrs[identifier] = 0
                 enterCtrs[identifier] = (enterCtrs[identifier] ?? 0) + 1
@@ -940,7 +962,7 @@ public class ExpoBeaconModule: Module {
                     enterCtrs[identifier] = 0
                     return .enter
                 }
-            } else {
+            } else if distance > exitDist {
                 enterCtrs[identifier] = 0
                 exitCtrs[identifier] = (exitCtrs[identifier] ?? 0) + 1
                 if entered.contains(identifier) && (exitCtrs[identifier] ?? 0) >= HYSTERESIS_COUNT {
@@ -948,6 +970,10 @@ public class ExpoBeaconModule: Module {
                     exitCtrs[identifier] = 0
                     return .exit
                 }
+            } else {
+                // In the hysteresis band (maxDist < distance <= exitDist) — do nothing
+                enterCtrs[identifier] = 0
+                exitCtrs[identifier] = 0
             }
         } else {
             enterCtrs[identifier] = (enterCtrs[identifier] ?? 0) + 1
@@ -1020,10 +1046,12 @@ public class ExpoBeaconModule: Module {
 
                 // Distance-driven enter/exit synthesis with hysteresis
                 if let maxDist = self.defaults.object(forKey: MAX_DISTANCE_KEY) as? Double {
+                    let exitDist = self.defaults.object(forKey: EXIT_DISTANCE_KEY) as? Double
                     let action = evaluateDistanceHysteresis(
                         identifier: identifier,
                         distance: beacon.accuracy,
                         maxDistance: maxDist,
+                        exitDistance: exitDist,
                         entered: &enteredRegions,
                         enterCtrs: &enterCounters,
                         exitCtrs: &exitCounters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-beacon",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Expo module for scanning, pairing, and monitoring iBeacons on Android and iOS",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/src/ExpoBeacon.types.ts

@@ -100,6 +100,15 @@ export type MonitoringOptions = {
    * Exit events are always emitted when the region is lost.
    */
   maxDistance?: number;
+  /**
+   * Distance in metres at which exit events fire (must be ≥ maxDistance).
+   * Creates a hysteresis band between enter and exit thresholds to prevent
+   * rapid toggling near the boundary.
+   *
+   * Default when omitted: `maxDistance + min(maxDistance × 0.5, 2.5)`.
+   * Only used when `maxDistance` is set.
+   */
+  exitDistance?: number;
   /** Notification configuration overrides to apply for this monitoring session. */
   notifications?: NotificationConfig;
 };