expo-beacon 0.3.2 → 0.4.0

package/src/ExpoBeaconModule.ts

@@ -3,7 +3,9 @@ import { NativeModule, requireNativeModule } from "expo";
 import {
   ExpoBeaconModuleEvents,
   BeaconScanResult,
+  EddystoneScanResult,
   PairedBeacon,
+  PairedEddystone,
   NotificationConfig,
   MonitoringOptions,
 } from "./ExpoBeacon.types";
@@ -24,6 +26,16 @@ declare class ExpoBeaconModule extends NativeModule<ExpoBeaconModuleEvents> {
     scanDuration?: number,
   ): Promise<BeaconScanResult[]>;
 
+  /**
+   * Start a one-shot Eddystone beacon scan using BLE.
+   * Discovers Eddystone-UID and Eddystone-URL frames.
+   *
+   * @param scanDuration Duration in ms (default 5000)
+   */
+  scanForEddystonesAsync(
+    scanDuration?: number,
+  ): Promise<EddystoneScanResult[]>;
+
   /**
    * Register a beacon for persistent region monitoring.
    */
@@ -44,6 +56,25 @@ declare class ExpoBeaconModule extends NativeModule<ExpoBeaconModuleEvents> {
    */
   getPairedBeacons(): PairedBeacon[];
 
+  /**
+   * Register an Eddystone-UID beacon for persistent monitoring.
+   */
+  pairEddystone(
+    identifier: string,
+    namespace: string,
+    instance: string,
+  ): void;
+
+  /**
+   * Remove a previously paired Eddystone beacon.
+   */
+  unpairEddystone(identifier: string): void;
+
+  /**
+   * Return all currently paired Eddystone beacons.
+   */
+  getPairedEddystones(): PairedEddystone[];
+
   /**
    * Set persistent notification configuration. Settings are saved and applied to all
    * subsequent monitoring sessions until explicitly changed.
@@ -78,14 +109,4 @@ declare class ExpoBeaconModule extends NativeModule<ExpoBeaconModuleEvents> {
   requestPermissionsAsync(): Promise<boolean>;
 }
 
-try {
-  // eslint-disable-next-line import/no-mutable-exports
-  var module = requireNativeModule<ExpoBeaconModule>("ExpoBeacon");
-} catch {
-  throw new Error(
-    "expo-beacon: native module not found. Make sure you are using a development build " +
-      "(not Expo Go) and have run `npx expo prebuild` followed by a native rebuild.",
-  );
-}
-
-export default module;
+export default requireNativeModule<ExpoBeaconModule>("ExpoBeacon");

package/src/ExpoBeaconModule.web.ts

@@ -1,7 +1,9 @@
 import type {
   ExpoBeaconModuleEvents,
   BeaconScanResult,
+  EddystoneScanResult,
   PairedBeacon,
+  PairedEddystone,
 } from "./ExpoBeacon.types";
 
 const notSupported = (): never => {
@@ -13,6 +15,9 @@ const stub = {
     _uuids: string[],
     _scanDuration?: number,
   ): Promise<BeaconScanResult[]> => notSupported(),
+  scanForEddystonesAsync: (
+    _scanDuration?: number,
+  ): Promise<EddystoneScanResult[]> => notSupported(),
   pairBeacon: (
     _identifier: string,
     _uuid: string,
@@ -21,6 +26,13 @@ const stub = {
   ): void => notSupported(),
   unpairBeacon: (_identifier: string): void => notSupported(),
   getPairedBeacons: (): PairedBeacon[] => notSupported(),
+  pairEddystone: (
+    _identifier: string,
+    _namespace: string,
+    _instance: string,
+  ): void => notSupported(),
+  unpairEddystone: (_identifier: string): void => notSupported(),
+  getPairedEddystones: (): PairedEddystone[] => notSupported(),
   startMonitoring: (): Promise<void> => notSupported(),
   stopMonitoring: (): Promise<void> => notSupported(),
   requestPermissionsAsync: (): Promise<boolean> => notSupported(),

package/src/index.ts

@@ -13,4 +13,9 @@ export type {
   BeaconNotificationConfig,
   ForegroundServiceConfig,
   NotificationChannelConfig,
+  EddystoneFrameType,
+  EddystoneScanResult,
+  PairedEddystone,
+  EddystoneRegionEvent,
+  EddystoneDistanceEvent,
 } from "./ExpoBeacon.types";