spotny-sdk 0.5.2 → 0.5.4

package/README.md

@@ -1,6 +1,6 @@
 # spotny-sdk
 
-A React Native SDK for real-time proximity experiences. Detects nearby points of interest and fires location events on iOS and Android.
+A React Native SDK for real-time iBeacon proximity experiences. Detects nearby beacons, fetches campaigns, and fires tracking events automatically on iOS and Android.
 
 > Requires **React Native 0.73+** with the New Architecture (Turbo Modules) enabled.
 
@@ -31,13 +31,11 @@ Add the following keys to your `Info.plist`:
 <string>We use Bluetooth to detect nearby points of interest.</string>
 ```
 
-Enable **Background Modes** in Xcode → your app target → **Signing & Capabilities** → **+ Capability** → Background Modes:
+Enable **Background Modes** in Xcode → your app target → **Signing & Capabilities** → Background Modes:
 
 - ✅ Location updates
 - ✅ Uses Bluetooth LE accessories
 
-> **Note:** Background scanning requires the _Location updates_ background mode. The SDK works without it for foreground-only use.
-
 ### Android
 
 Add to `AndroidManifest.xml`:
@@ -57,31 +55,37 @@ Add to `AndroidManifest.xml`:
 ```tsx
 import { useEffect } from 'react';
 import {
-  configure,
+  initialize,
   startScanner,
   stopScanner,
-  addProximityListener,
-  addLocationEventListener,
+  addBeaconsRangedListener,
+  addBeaconRegionListener,
 } from 'spotny-sdk';
 
 export default function App() {
   useEffect(() => {
-    configure({ source: 'nike', maxDetectionDistance: 10 });
-    startScanner('device-uuid-here', /* userId */ null);
-
-    const proxSub = addProximityListener((items) => {
-      console.log('Nearby:', items);
+    // 1. Initialize once before anything else
+    initialize({ source: 'nike', maxDetectionDistance: 10 });
+
+    // 2. Listen for nearby beacons
+    const beaconSub = addBeaconsRangedListener(({ beacons, region }) => {
+      beacons.forEach((b) =>
+        console.log(`${b.major}/${b.minor} — ${b.distance.toFixed(1)}m (${b.proximity})`)
+      );
     });
 
-    const locationSub = addLocationEventListener(({ event, zone }) => {
-      if (event === 'enter') console.log('Entered zone', zone);
-      if (event === 'exit') console.log('Left zone', zone);
+    // 3. Listen for region enter/exit
+    const regionSub = addBeaconRegionListener(({ event, region }) => {
+      console.log(`${event.toUpperCase()}: ${region}`);
     });
 
+    // 4. Start scanning
+    startScanner();
+
     return () => {
       stopScanner();
-      proxSub.remove();
-      locationSub.remove();
+      beaconSub.remove();
+      regionSub.remove();
     };
   }, []);
 
@@ -93,53 +97,55 @@ export default function App() {
 
 ## API Reference
 
-### Core
+### Initialization
 
-#### `startScanner(userUUID, userId?)`
+#### `initialize(config)`
 
-Starts proximity scanning.
+**Must be called before any other SDK function.** Configures the SDK with your brand settings.
 
-| Parameter  | Type             | Required | Description                               |
-| ---------- | ---------------- | -------- | ----------------------------------------- |
-| `userUUID` | `string`         | Yes      | Unique identifier for this device/session |
-| `userId`   | `number \| null` | No       | Authenticated user ID                     |
+| Option                    | Type     | Default | Description                                                    |
+| ------------------------- | -------- | ------- | -------------------------------------------------------------- |
+| `source`                  | `string` | –       | Your brand or app identifier (e.g. `'nike'`). Sent with every tracking event. |
+| `maxDetectionDistance`    | `number` | `8.0`   | Maximum detection radius in metres. Beacons beyond this are ignored. |
+| `distanceCorrectionFactor`| `number` | `0.5`   | Multiplier applied to raw RSSI distance. Tune for your beacon TX power. |
 
 Returns `Promise<string>`.
 
 ```ts
-await startScanner('550e8400-e29b-41d4-a716-446655440000', 42);
+await initialize({
+  source: 'nike',
+  maxDetectionDistance: 10,
+  distanceCorrectionFactor: 0.5,
+});
 ```
 
 ---
 
-#### `stopScanner()`
-
-Stops scanning and clears all state.
+### Core Scanning
 
-Returns `Promise<string>`.
+#### `startScanner()`
 
----
+Starts iBeacon scanning. The SDK manages a fully anonymous `device_id` internally (stored in Keychain on iOS, SharedPreferences on Android — persists across launches).
 
-#### `isScanning()`
+Returns `Promise<string>`.
 
-Returns `Promise<boolean>`.
+```ts
+await startScanner();
+```
 
 ---
 
-### Configuration
+#### `stopScanner()`
 
-#### `configure(config)`
+Stops scanning and cleans up all per-beacon state (sends `PROXIMITY_EXIT` events for any active beacons).
+
+Returns `Promise<string>`.
 
-Call **before** `startScanner`.
+---
 
-| Option                 | Type     | Default | Description                                  |
-| ---------------------- | -------- | ------- | -------------------------------------------- |
-| `source`               | `string` | –       | Your brand or app identifier (e.g. `'nike'`) |
-| `maxDetectionDistance` | `number` | `8.0`   | Detection radius in metres                   |
+#### `isScanning()`
 
-```ts
-await configure({ source: 'nike', maxDetectionDistance: 10 });
-```
+Returns `Promise<boolean>` — `true` if the scanner is currently active.
 
 ---
 
@@ -147,9 +153,9 @@ await configure({ source: 'nike', maxDetectionDistance: 10 });
 
 #### `requestNotificationPermissions()` _(iOS only)_
 
-Requests local notification permissions.
+Prompts the user for local notification permission (`alert`, `sound`, `badge`).
 
-Returns `Promise<string>`.
+Returns `Promise<'granted' | 'denied'>`.
 
 ---
 
@@ -157,44 +163,52 @@ Returns `Promise<string>`.
 
 #### `addBeaconsRangedListener(callback)`
 
-Fires when nearby items are detected (approximately every second).
+Fires when the set of nearby beacons changes, or every `debounceInterval` seconds (default 5 s) if nothing changed. The event is **deduplicated** — it does not fire every ranging cycle if proximity is unchanged.
 
 ```ts
-const sub = addBeaconsRangedListener(({ beacons }) => {
-  beacons.forEach((item) => {
-    console.log(`${item.distance.toFixed(1)} m — ${item.proximity}`);
+const sub = addBeaconsRangedListener(({ beacons, region }) => {
+  beacons.forEach((b) => {
+    console.log(`Major ${b.major} / Minor ${b.minor}`);
+    console.log(`Distance: ${b.distance.toFixed(2)}m — ${b.proximity}`);
+    console.log(`RSSI: ${b.rssi} dBm`);
   });
 });
 
-sub.remove(); // when done
+sub.remove(); // call on cleanup
 ```
 
-Each item contains:
+Each beacon in the array:
 
-| Field       | Type     | Description                                         |
-| ----------- | -------- | --------------------------------------------------- |
-| `distance`  | `number` | Estimated distance in metres                        |
-| `proximity` | `string` | `'immediate'` \| `'near'` \| `'far'` \| `'unknown'` |
+| Field       | Type     | Description                                                     |
+| ----------- | -------- | --------------------------------------------------------------- |
+| `uuid`      | `string` | Beacon proximity UUID                                           |
+| `major`     | `number` | Beacon major value                                              |
+| `minor`     | `number` | Beacon minor value                                              |
+| `distance`  | `number` | Estimated distance in metres (after correction factor applied)   |
+| `rssi`      | `number` | Raw signal strength in dBm                                      |
+| `proximity` | `string` | `'immediate'` \| `'near'` \| `'far'` \| `'unknown'`            |
 
 ---
 
 #### `addBeaconRegionListener(callback)`
 
-Fires when the user enters or exits a zone. Works in foreground, background, and terminated state (iOS).
+Fires when the user enters or exits a beacon region. Works in foreground, background, and terminated state (iOS).
 
 ```ts
 const sub = addBeaconRegionListener(({ event, region, state }) => {
-  console.log(event, region); // 'enter' | 'exit' | 'determined'
+  if (event === 'enter')      console.log('Entered region', region);
+  if (event === 'exit')       console.log('Left region', region);
+  if (event === 'determined') console.log('State for', region, '→', state);
 });
 
-sub.remove(); // when done
+sub.remove(); // call on cleanup
 ```
 
-| Field    | Type     | Description                                                |
-| -------- | -------- | ---------------------------------------------------------- |
-| `event`  | `string` | `'enter'` \| `'exit'` \| `'determined'`                    |
-| `region` | `string` | Zone identifier                                            |
-| `state`  | `string` | `'inside'` \| `'outside'` \| `'unknown'` (determined only) |
+| Field    | Type     | Description                                                        |
+| -------- | -------- | ------------------------------------------------------------------ |
+| `event`  | `string` | `'enter'` \| `'exit'` \| `'determined'`                            |
+| `region` | `string` | Region identifier                                                  |
+| `state`  | `string` | `'inside'` \| `'outside'` \| `'unknown'` (`determined` event only) |
 
 ---
 
@@ -202,21 +216,58 @@ sub.remove(); // when done
 
 #### `getDebugLogs()`
 
-Returns on-device debug logs as a string.
+Returns the on-device debug log file as a string. Includes campaign fetch results and proximity events sent.
+
+Returns `Promise<string>`.
 
 #### `clearDebugLogs()`
 
-Clears on-device debug logs.
+Clears the on-device debug log file.
+
+Returns `Promise<string>`.
+
+#### `setDebounceInterval(seconds)`
+
+Sets how often the `onBeaconsRanged` event is force-emitted even if proximity hasn't changed (default: `5`).
+
+```ts
+await setDebounceInterval(10); // emit at most every 10 s
+```
+
+#### `clearDebounceCache()`
+
+Resets internal campaign-fetch cooldown state. Useful during testing.
+
+#### `getDebounceStatus()`
+
+Returns internal per-beacon timing state. Useful for debugging stuck campaigns.
+
+Returns `Promise<Object>`.
+
+---
+
+## How It Works
+
+1. `initialize()` sets your brand config.
+2. `startScanner()` begins monitoring for iBeacons with the Spotny UUID.
+3. When a beacon is detected, the SDK fetches the associated campaign from the Spotny backend.
+4. `NEARBY` events are sent automatically as the user moves closer or further.
+5. `IMPRESSION_HEARTBEAT` events are sent every 10 s when the user is within 2 m of an active campaign.
+6. On exit, `PROXIMITY_EXIT` is sent and all state is cleaned up.
+
+The SDK is **fully anonymous** — it generates a persistent `device_id` (Keychain on iOS, SharedPreferences on Android) that survives app reinstalls. No user identity is collected or sent.
 
 ---
 
-## Platform Notes
+## Platform Support
 
 | Feature                  | iOS | Android |
 | ------------------------ | --- | ------- |
-| Zone monitoring          | ✅  | ✅      |
+| iBeacon ranging          | ✅  | ✅      |
+| Region enter/exit        | ✅  | ✅      |
 | Background scanning      | ✅  | ✅      |
 | Terminated-state wakeup  | ✅  | ✅      |
+| Keychain device ID       | ✅  | –       |
 | Notification permissions | ✅  | –       |
 
 ---

package/android/src/main/java/com/spotnysdk/SpotnySdkModule.kt

@@ -130,14 +130,15 @@ class SpotnySdkModule(private val reactContext: ReactApplicationContext) :
 
   override fun isScanning(promise: Promise) = promise.resolve(scanning)
 
-  override fun configure(config: ReadableMap?, promise: Promise) {
+  override fun initialize(config: ReadableMap?, promise: Promise) {
     config?.getDouble("maxDetectionDistance").takeIf { config?.hasKey("maxDetectionDistance") == true }
       ?.let { maxDetectionDistance = it; Log.d(TAG, "maxDetectionDistance = $it m") }
     config?.getString("source")?.let { source = it; Log.d(TAG, "source = $it") }
     config?.getDouble("distanceCorrectionFactor")
       .takeIf { config?.hasKey("distanceCorrectionFactor") == true && it > 0 }
       ?.let { distanceCorrectionFactor = it; Log.d(TAG, "distanceCorrectionFactor = $it") }
-    promise.resolve("Configuration updated")
+    Log.d(TAG, "SDK initialized")
+    promise.resolve("SDK initialized")
   }
 
   override fun requestNotificationPermissions(promise: Promise) {

package/ios/SpotnyBeaconScanner.swift

@@ -189,7 +189,7 @@ public class SpotnyBeaconScanner: NSObject {
   }
 
   @objc
-  public func configure(
+  public func initialize(
     with config: NSDictionary,
     resolve: @escaping (Any?) -> Void,
     reject: @escaping (String?, String?, Error?) -> Void
@@ -206,7 +206,8 @@ public class SpotnyBeaconScanner: NSObject {
       distanceCorrectionFactor = factor
       print("⚙️ SpotnySDK: distanceCorrectionFactor = \(factor)")
     }
-    resolve("Configuration updated")
+    print("✅ SpotnySDK: Initialized")
+    resolve("SDK initialized")
   }
 
   @objc

package/ios/SpotnySdk.mm

@@ -79,10 +79,10 @@ RCT_EXPORT_MODULE()
   [_scanner isScanningWithResolve:resolve reject:reject];
 }
 
-- (void)configure:(NSDictionary *)config
-          resolve:(RCTPromiseResolveBlock)resolve
-           reject:(RCTPromiseRejectBlock)reject {
-  [_scanner configureWith:config resolve:resolve reject:reject];
+- (void)initialize:(NSDictionary *)config
+           resolve:(RCTPromiseResolveBlock)resolve
+            reject:(RCTPromiseRejectBlock)reject {
+  [_scanner initializeWith:config resolve:resolve reject:reject];
 }
 
 - (void)requestNotificationPermissions:(RCTPromiseResolveBlock)resolve

package/lib/module/index.js

@@ -31,14 +31,13 @@ export function isScanning() {
   return NativeSpotnySdk.isScanning();
 }
 
-// ── Configuration ────────────────────────────────────────────────────────────
+// ── Initialization ──────────────────────────────────────────────────────────────
 
 /**
- * Override SDK configuration at runtime.
- * Must be called **before** `startScanner`.
+ * Initialize the SDK. Must be called **before** any other SDK function.
  */
-export function configure(config) {
-  return NativeSpotnySdk.configure(config);
+export function initialize(config) {
+  return NativeSpotnySdk.initialize(config);
 }
 
 // ── Permissions ──────────────────────────────────────────────────────────────

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeEventEmitter","NativeModules","NativeSpotnySdk","SpotnyEvents","ON_BEACONS_RANGED","ON_BEACON_REGION_EVENT","eventEmitter","SpotnySdk","startScanner","stopScanner","isScanning","configure","config","requestNotificationPermissions","getDebugLogs","clearDebugLogs","setDebounceInterval","interval","clearDebounceCache","getDebounceStatus","addBeaconsRangedListener","callback","addListener","addBeaconRegionListener"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,kBAAkB,EAAEC,aAAa,QAAQ,cAAc;AAChE,OAAOC,eAAe,MAAM,sBAAmB;;AAE/C;AACA,OAAO,MAAMC,YAAY,GAAG;EAC1BC,iBAAiB,EAAE,iBAAiB;EACpCC,sBAAsB,EAAE;AAC1B,CAAU;;AAEV;;AAqCA;AACA,MAAMC,YAAY,GAAG,IAAIN,kBAAkB,CAACC,aAAa,CAACM,SAAS,CAAC;;AAEpE;;AAEA;AACA,OAAO,SAASC,YAAYA,CAAA,EAAoB;EAC9C,OAAON,eAAe,CAACM,YAAY,CAAC,CAAC;AACvC;;AAEA;AACA,OAAO,SAASC,WAAWA,CAAA,EAAoB;EAC7C,OAAOP,eAAe,CAACO,WAAW,CAAC,CAAC;AACtC;;AAEA;AACA,OAAO,SAASC,UAAUA,CAAA,EAAqB;EAC7C,OAAOR,eAAe,CAACQ,UAAU,CAAC,CAAC;AACrC;;AAEA;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,MAAuB,EAAmB;EAClE,OAAOV,eAAe,CAACS,SAAS,CAACC,MAAgB,CAAC;AACpD;;AAEA;;AAEA;AACA,OAAO,SAASC,8BAA8BA,CAAA,EAAoB;EAChE,OAAOX,eAAe,CAACW,8BAA8B,CAAC,CAAC;AACzD;;AAEA;;AAEA;AACA,OAAO,SAASC,YAAYA,CAAA,EAAoB;EAC9C,OAAOZ,eAAe,CAACY,YAAY,CAAC,CAAC;AACvC;;AAEA;AACA,OAAO,SAASC,cAAcA,CAAA,EAAoB;EAChD,OAAOb,eAAe,CAACa,cAAc,CAAC,CAAC;AACzC;;AAEA;;AAEA;AACA,OAAO,SAASC,mBAAmBA,CAACC,QAAgB,EAAmB;EACrE,OAAOf,eAAe,CAACc,mBAAmB,CAACC,QAAQ,CAAC;AACtD;;AAEA;AACA,OAAO,SAASC,kBAAkBA,CAAA,EAAoB;EACpD,OAAOhB,eAAe,CAACgB,kBAAkB,CAAC,CAAC;AAC7C;;AAEA;AACA,OAAO,SAASC,iBAAiBA,CAAA,EAAoB;EACnD,OAAOjB,eAAe,CAACiB,iBAAiB,CAAC,CAAC;AAC5C;;AAEA;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CACtCC,QAA4C,EAC5C;EACA,OAAOf,YAAY,CAACgB,WAAW,CAC7BnB,YAAY,CAACC,iBAAiB,EAC9BiB,QACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASE,uBAAuBA,CACrCF,QAA4C,EAC5C;EACA,OAAOf,YAAY,CAACgB,WAAW,CAC7BnB,YAAY,CAACE,sBAAsB,EACnCgB,QACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"names":["NativeEventEmitter","NativeModules","NativeSpotnySdk","SpotnyEvents","ON_BEACONS_RANGED","ON_BEACON_REGION_EVENT","eventEmitter","SpotnySdk","startScanner","stopScanner","isScanning","initialize","config","requestNotificationPermissions","getDebugLogs","clearDebugLogs","setDebounceInterval","interval","clearDebounceCache","getDebounceStatus","addBeaconsRangedListener","callback","addListener","addBeaconRegionListener"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,kBAAkB,EAAEC,aAAa,QAAQ,cAAc;AAChE,OAAOC,eAAe,MAAM,sBAAmB;;AAE/C;AACA,OAAO,MAAMC,YAAY,GAAG;EAC1BC,iBAAiB,EAAE,iBAAiB;EACpCC,sBAAsB,EAAE;AAC1B,CAAU;;AAEV;;AAqCA;AACA,MAAMC,YAAY,GAAG,IAAIN,kBAAkB,CAACC,aAAa,CAACM,SAAS,CAAC;;AAEpE;;AAEA;AACA,OAAO,SAASC,YAAYA,CAAA,EAAoB;EAC9C,OAAON,eAAe,CAACM,YAAY,CAAC,CAAC;AACvC;;AAEA;AACA,OAAO,SAASC,WAAWA,CAAA,EAAoB;EAC7C,OAAOP,eAAe,CAACO,WAAW,CAAC,CAAC;AACtC;;AAEA;AACA,OAAO,SAASC,UAAUA,CAAA,EAAqB;EAC7C,OAAOR,eAAe,CAACQ,UAAU,CAAC,CAAC;AACrC;;AAEA;;AAEA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,MAAuB,EAAmB;EACnE,OAAOV,eAAe,CAACS,UAAU,CAACC,MAAgB,CAAC;AACrD;;AAEA;;AAEA;AACA,OAAO,SAASC,8BAA8BA,CAAA,EAAoB;EAChE,OAAOX,eAAe,CAACW,8BAA8B,CAAC,CAAC;AACzD;;AAEA;;AAEA;AACA,OAAO,SAASC,YAAYA,CAAA,EAAoB;EAC9C,OAAOZ,eAAe,CAACY,YAAY,CAAC,CAAC;AACvC;;AAEA;AACA,OAAO,SAASC,cAAcA,CAAA,EAAoB;EAChD,OAAOb,eAAe,CAACa,cAAc,CAAC,CAAC;AACzC;;AAEA;;AAEA;AACA,OAAO,SAASC,mBAAmBA,CAACC,QAAgB,EAAmB;EACrE,OAAOf,eAAe,CAACc,mBAAmB,CAACC,QAAQ,CAAC;AACtD;;AAEA;AACA,OAAO,SAASC,kBAAkBA,CAAA,EAAoB;EACpD,OAAOhB,eAAe,CAACgB,kBAAkB,CAAC,CAAC;AAC7C;;AAEA;AACA,OAAO,SAASC,iBAAiBA,CAAA,EAAoB;EACnD,OAAOjB,eAAe,CAACiB,iBAAiB,CAAC,CAAC;AAC5C;;AAEA;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CACtCC,QAA4C,EAC5C;EACA,OAAOf,YAAY,CAACgB,WAAW,CAC7BnB,YAAY,CAACC,iBAAiB,EAC9BiB,QACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASE,uBAAuBA,CACrCF,QAA4C,EAC5C;EACA,OAAOf,YAAY,CAACgB,WAAW,CAC7BnB,YAAY,CAACE,sBAAsB,EACnCgB,QACF,CAAC;AACH","ignoreList":[]}

package/lib/typescript/src/NativeSpotnySdk.d.ts

@@ -3,7 +3,7 @@ export interface Spec extends TurboModule {
     startScanner(): Promise<string>;
     stopScanner(): Promise<string>;
     isScanning(): Promise<boolean>;
-    configure(config: Object): Promise<string>;
+    initialize(config: Object): Promise<string>;
     requestNotificationPermissions(): Promise<string>;
     getDebugLogs(): Promise<string>;
     clearDebugLogs(): Promise<string>;

package/lib/typescript/src/NativeSpotnySdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeSpotnySdk.d.ts","sourceRoot":"","sources":["../../../src/NativeSpotnySdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IAEvC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAG/B,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAG3C,8BAA8B,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGlD,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGlC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGrC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;;AAED,wBAAmE"}
+{"version":3,"file":"NativeSpotnySdk.d.ts","sourceRoot":"","sources":["../../../src/NativeSpotnySdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IAEvC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAG/B,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAG5C,8BAA8B,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGlD,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGlC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAGrC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;;AAED,wBAAmE"}

package/lib/typescript/src/index.d.ts

@@ -40,10 +40,9 @@ export declare function stopScanner(): Promise<string>;
 /** Returns `true` if the SDK is currently scanning. */
 export declare function isScanning(): Promise<boolean>;
 /**
- * Override SDK configuration at runtime.
- * Must be called **before** `startScanner`.
+ * Initialize the SDK. Must be called **before** any other SDK function.
  */
-export declare function configure(config: SpotnySdkConfig): Promise<string>;
+export declare function initialize(config: SpotnySdkConfig): Promise<string>;
 /** (iOS) Prompt the user for local-notification permissions. */
 export declare function requestNotificationPermissions(): Promise<string>;
 /** Read the on-device debug log file. */

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAIA,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAIX,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC;IACvC,KAAK,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,8DAA8D;IAC9D,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAOF,6BAA6B;AAC7B,wBAAgB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9C;AAED,mDAAmD;AACnD,wBAAgB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAE7C;AAED,uDAAuD;AACvD,wBAAgB,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAE7C;AAID;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAElE;AAID,gEAAgE;AAChE,wBAAgB,8BAA8B,IAAI,OAAO,CAAC,MAAM,CAAC,CAEhE;AAID,yCAAyC;AACzC,wBAAgB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9C;AAED,2CAA2C;AAC3C,wBAAgB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAEhD;AAID,gEAAgE;AAChE,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAErE;AAED,2DAA2D;AAC3D,wBAAgB,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEpD;AAED,kEAAkE;AAClE,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnD;AAID;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,4CAM7C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,4CAM7C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAIA,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAIX,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC;IACvC,KAAK,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,8DAA8D;IAC9D,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAOF,6BAA6B;AAC7B,wBAAgB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9C;AAED,mDAAmD;AACnD,wBAAgB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAE7C;AAED,uDAAuD;AACvD,wBAAgB,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAE7C;AAID;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAEnE;AAID,gEAAgE;AAChE,wBAAgB,8BAA8B,IAAI,OAAO,CAAC,MAAM,CAAC,CAEhE;AAID,yCAAyC;AACzC,wBAAgB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9C;AAED,2CAA2C;AAC3C,wBAAgB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAEhD;AAID,gEAAgE;AAChE,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAErE;AAED,2DAA2D;AAC3D,wBAAgB,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEpD;AAED,kEAAkE;AAClE,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnD;AAID;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,4CAM7C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,4CAM7C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spotny-sdk",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Beacon Scanner",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",

package/src/NativeSpotnySdk.ts

@@ -6,8 +6,8 @@ export interface Spec extends TurboModule {
   stopScanner(): Promise<string>;
   isScanning(): Promise<boolean>;
 
-  // ── Configuration ──────────────────────────────────────────────────────────
-  configure(config: Object): Promise<string>;
+  // ── Initialization ───────────────────────────────────────────────────────
+  initialize(config: Object): Promise<string>;
 
   // ── Permissions ────────────────────────────────────────────────────────────
   requestNotificationPermissions(): Promise<string>;

package/src/index.tsx

@@ -64,14 +64,13 @@ export function isScanning(): Promise<boolean> {
   return NativeSpotnySdk.isScanning();
 }
 
-// ── Configuration ────────────────────────────────────────────────────────────
+// ── Initialization ──────────────────────────────────────────────────────────────
 
 /**
- * Override SDK configuration at runtime.
- * Must be called **before** `startScanner`.
+ * Initialize the SDK. Must be called **before** any other SDK function.
  */
-export function configure(config: SpotnySdkConfig): Promise<string> {
-  return NativeSpotnySdk.configure(config as Object);
+export function initialize(config: SpotnySdkConfig): Promise<string> {
+  return NativeSpotnySdk.initialize(config as Object);
 }
 
 // ── Permissions ──────────────────────────────────────────────────────────────