munim-bluetooth 0.3.24 → 0.3.26

package/nitrogen/generated/ios/swift/HybridMunimBluetoothSpec_cxx.swift

@@ -84,7 +84,7 @@ open class HybridMunimBluetoothSpec_cxx {
     }
   }
 
-  
+
 
   /**
    * Get the memory size of the Swift class (plus size of any other allocations)
@@ -121,7 +121,7 @@ open class HybridMunimBluetoothSpec_cxx {
   }
 
   // Properties
-  
+
 
   // Methods
   @inline(__always)
@@ -134,7 +134,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func updateAdvertisingData(advertisingData: AdvertisingDataTypes) -> bridge.Result_void_ {
     do {
@@ -145,7 +145,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func getAdvertisingData() -> bridge.Result_std__shared_ptr_Promise_AdvertisingDataTypes___ {
     do {
@@ -164,7 +164,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_AdvertisingDataTypes___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func stopAdvertising() -> bridge.Result_void_ {
     do {
@@ -175,7 +175,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func setServices(services: bridge.std__vector_GATTService_) -> bridge.Result_void_ {
     do {
@@ -186,7 +186,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func isBluetoothEnabled() -> bridge.Result_std__shared_ptr_Promise_bool___ {
     do {
@@ -205,7 +205,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_bool___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func requestBluetoothPermission() -> bridge.Result_std__shared_ptr_Promise_bool___ {
     do {
@@ -224,7 +224,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_bool___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func startScan(options: bridge.std__optional_ScanOptions_) -> bridge.Result_void_ {
     do {
@@ -235,7 +235,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func stopScan() -> bridge.Result_void_ {
     do {
@@ -246,7 +246,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func connect(deviceId: std.string) -> bridge.Result_std__shared_ptr_Promise_void___ {
     do {
@@ -265,7 +265,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func disconnect(deviceId: std.string) -> bridge.Result_void_ {
     do {
@@ -276,7 +276,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func discoverServices(deviceId: std.string) -> bridge.Result_std__shared_ptr_Promise_std__vector_GATTService____ {
     do {
@@ -301,7 +301,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_std__vector_GATTService____(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func readCharacteristic(deviceId: std.string, serviceUUID: std.string, characteristicUUID: std.string) -> bridge.Result_std__shared_ptr_Promise_CharacteristicValue___ {
     do {
@@ -320,7 +320,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_CharacteristicValue___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func writeCharacteristic(deviceId: std.string, serviceUUID: std.string, characteristicUUID: std.string, value: std.string, writeType: bridge.std__optional_WriteType_) -> bridge.Result_std__shared_ptr_Promise_void___ {
     do {
@@ -339,7 +339,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func subscribeToCharacteristic(deviceId: std.string, serviceUUID: std.string, characteristicUUID: std.string) -> bridge.Result_void_ {
     do {
@@ -350,7 +350,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func unsubscribeFromCharacteristic(deviceId: std.string, serviceUUID: std.string, characteristicUUID: std.string) -> bridge.Result_void_ {
     do {
@@ -361,7 +361,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func getConnectedDevices() -> bridge.Result_std__shared_ptr_Promise_std__vector_std__string____ {
     do {
@@ -386,7 +386,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_std__vector_std__string____(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func readRSSI(deviceId: std.string) -> bridge.Result_std__shared_ptr_Promise_double___ {
     do {
@@ -405,7 +405,29 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_std__shared_ptr_Promise_double___(__exceptionPtr)
     }
   }
-  
+
+  @inline(__always)
+  public final func startBackgroundSession(options: BackgroundSessionOptions) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.startBackgroundSession(options: options)
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+
+  @inline(__always)
+  public final func stopBackgroundSession() -> bridge.Result_void_ {
+    do {
+      try self.__implementation.stopBackgroundSession()
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+
   @inline(__always)
   public final func addListener(eventName: std.string) -> bridge.Result_void_ {
     do {
@@ -416,7 +438,7 @@ open class HybridMunimBluetoothSpec_cxx {
       return bridge.create_Result_void_(__exceptionPtr)
     }
   }
-  
+
   @inline(__always)
   public final func removeListeners(count: Double) -> bridge.Result_void_ {
     do {

package/nitrogen/generated/shared/c++/BackgroundSessionOptions.hpp

@@ -0,0 +1,115 @@
+///
+/// BackgroundSessionOptions.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `ScanMode` to properly resolve imports.
+namespace margelo::nitro::munimbluetooth { enum class ScanMode; }
+
+#include <string>
+#include <vector>
+#include <optional>
+#include "ScanMode.hpp"
+
+namespace margelo::nitro::munimbluetooth {
+
+  /**
+   * A struct which can be represented as a JavaScript object (BackgroundSessionOptions).
+   */
+  struct BackgroundSessionOptions final {
+  public:
+    std::vector<std::string> serviceUUIDs     SWIFT_PRIVATE;
+    std::optional<std::string> localName     SWIFT_PRIVATE;
+    std::optional<bool> allowDuplicates     SWIFT_PRIVATE;
+    std::optional<ScanMode> scanMode     SWIFT_PRIVATE;
+    std::optional<std::string> androidNotificationChannelId     SWIFT_PRIVATE;
+    std::optional<std::string> androidNotificationChannelName     SWIFT_PRIVATE;
+    std::optional<std::string> androidNotificationTitle     SWIFT_PRIVATE;
+    std::optional<std::string> androidNotificationText     SWIFT_PRIVATE;
+
+  public:
+    BackgroundSessionOptions() = default;
+    explicit BackgroundSessionOptions(std::vector<std::string> serviceUUIDs, std::optional<std::string> localName, std::optional<bool> allowDuplicates, std::optional<ScanMode> scanMode, std::optional<std::string> androidNotificationChannelId, std::optional<std::string> androidNotificationChannelName, std::optional<std::string> androidNotificationTitle, std::optional<std::string> androidNotificationText): serviceUUIDs(serviceUUIDs), localName(localName), allowDuplicates(allowDuplicates), scanMode(scanMode), androidNotificationChannelId(androidNotificationChannelId), androidNotificationChannelName(androidNotificationChannelName), androidNotificationTitle(androidNotificationTitle), androidNotificationText(androidNotificationText) {}
+
+  public:
+    friend bool operator==(const BackgroundSessionOptions& lhs, const BackgroundSessionOptions& rhs) = default;
+  };
+
+} // namespace margelo::nitro::munimbluetooth
+
+namespace margelo::nitro {
+
+  // C++ BackgroundSessionOptions <> JS BackgroundSessionOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::munimbluetooth::BackgroundSessionOptions> final {
+    static inline margelo::nitro::munimbluetooth::BackgroundSessionOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::munimbluetooth::BackgroundSessionOptions(
+        JSIConverter<std::vector<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "serviceUUIDs"))),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "localName"))),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "allowDuplicates"))),
+        JSIConverter<std::optional<margelo::nitro::munimbluetooth::ScanMode>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "scanMode"))),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelId"))),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelName"))),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationTitle"))),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationText")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::munimbluetooth::BackgroundSessionOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "serviceUUIDs"), JSIConverter<std::vector<std::string>>::toJSI(runtime, arg.serviceUUIDs));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "localName"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.localName));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "allowDuplicates"), JSIConverter<std::optional<bool>>::toJSI(runtime, arg.allowDuplicates));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "scanMode"), JSIConverter<std::optional<margelo::nitro::munimbluetooth::ScanMode>>::toJSI(runtime, arg.scanMode));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelId"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.androidNotificationChannelId));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelName"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.androidNotificationChannelName));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationTitle"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.androidNotificationTitle));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationText"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.androidNotificationText));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::vector<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "serviceUUIDs")))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "localName")))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "allowDuplicates")))) return false;
+      if (!JSIConverter<std::optional<margelo::nitro::munimbluetooth::ScanMode>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "scanMode")))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelId")))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationChannelName")))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationTitle")))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationText")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/nitrogen/generated/shared/c++/HybridMunimBluetoothSpec.cpp

@@ -32,6 +32,8 @@ namespace margelo::nitro::munimbluetooth {
       prototype.registerHybridMethod("unsubscribeFromCharacteristic", &HybridMunimBluetoothSpec::unsubscribeFromCharacteristic);
       prototype.registerHybridMethod("getConnectedDevices", &HybridMunimBluetoothSpec::getConnectedDevices);
       prototype.registerHybridMethod("readRSSI", &HybridMunimBluetoothSpec::readRSSI);
+      prototype.registerHybridMethod("startBackgroundSession", &HybridMunimBluetoothSpec::startBackgroundSession);
+      prototype.registerHybridMethod("stopBackgroundSession", &HybridMunimBluetoothSpec::stopBackgroundSession);
       prototype.registerHybridMethod("addListener", &HybridMunimBluetoothSpec::addListener);
       prototype.registerHybridMethod("removeListeners", &HybridMunimBluetoothSpec::removeListeners);
     });

package/nitrogen/generated/shared/c++/HybridMunimBluetoothSpec.hpp

@@ -25,6 +25,8 @@ namespace margelo::nitro::munimbluetooth { struct ScanOptions; }
 namespace margelo::nitro::munimbluetooth { struct CharacteristicValue; }
 // Forward declaration of `WriteType` to properly resolve imports.
 namespace margelo::nitro::munimbluetooth { enum class WriteType; }
+// Forward declaration of `BackgroundSessionOptions` to properly resolve imports.
+namespace margelo::nitro::munimbluetooth { struct BackgroundSessionOptions; }
 
 #include "AdvertisingOptions.hpp"
 #include "AdvertisingDataTypes.hpp"
@@ -36,6 +38,7 @@ namespace margelo::nitro::munimbluetooth { enum class WriteType; }
 #include <string>
 #include "CharacteristicValue.hpp"
 #include "WriteType.hpp"
+#include "BackgroundSessionOptions.hpp"
 
 namespace margelo::nitro::munimbluetooth {
 
@@ -86,6 +89,8 @@ namespace margelo::nitro::munimbluetooth {
       virtual void unsubscribeFromCharacteristic(const std::string& deviceId, const std::string& serviceUUID, const std::string& characteristicUUID) = 0;
       virtual std::shared_ptr<Promise<std::vector<std::string>>> getConnectedDevices() = 0;
       virtual std::shared_ptr<Promise<double>> readRSSI(const std::string& deviceId) = 0;
+      virtual void startBackgroundSession(const BackgroundSessionOptions& options) = 0;
+      virtual void stopBackgroundSession() = 0;
       virtual void addListener(const std::string& eventName) = 0;
       virtual void removeListeners(double count) = 0;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "munim-bluetooth",
-  "version": "0.3.24",
+  "version": "0.3.26",
   "description": "A comprehensive React Native library for all your Bluetooth Low Energy (BLE) needs, supporting both peripheral and central roles with Expo support",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",

package/src/index.ts

@@ -9,6 +9,7 @@ import type {
   MunimBluetooth as MunimBluetoothSpec,
   AdvertisingDataTypes,
   BLEDevice,
+  BackgroundSessionOptions,
   ScanOptions,
   GATTService,
   CharacteristicValue,
@@ -281,6 +282,25 @@ export function readRSSI(deviceId: string): Promise<number> {
   return MunimBluetooth.readRSSI(deviceId)
 }
 
+/**
+ * Start a best-effort background BLE session.
+ *
+ * Android uses a foreground service. iOS relies on the host app's Bluetooth
+ * background modes and state restoration.
+ */
+export function startBackgroundSession(
+  options: BackgroundSessionOptions
+): void {
+  return MunimBluetooth.startBackgroundSession(options)
+}
+
+/**
+ * Stop the active background BLE session.
+ */
+export function stopBackgroundSession(): void {
+  return MunimBluetooth.stopBackgroundSession()
+}
+
 // ========== Event Management ==========
 
 /**
@@ -348,6 +368,7 @@ export function removeListeners(count: number): void {
 export type {
   AdvertisingDataTypes,
   BLEDevice,
+  BackgroundSessionOptions,
   ScanOptions,
   GATTService,
   CharacteristicValue,
@@ -375,6 +396,8 @@ export default {
   unsubscribeFromCharacteristic,
   getConnectedDevices,
   readRSSI,
+  startBackgroundSession,
+  stopBackgroundSession,
   // Events
   addDeviceFoundListener,
   addEventListener,

package/src/specs/munim-bluetooth.nitro.ts

@@ -96,6 +96,17 @@ export interface AdvertisingOptions {
   advertisingData?: AdvertisingDataTypes
 }
 
+export interface BackgroundSessionOptions {
+  serviceUUIDs: string[]
+  localName?: string
+  allowDuplicates?: boolean
+  scanMode?: ScanMode
+  androidNotificationChannelId?: string
+  androidNotificationChannelName?: string
+  androidNotificationTitle?: string
+  androidNotificationText?: string
+}
+
 export interface MunimBluetooth
   extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
   // ========== Peripheral Features ==========
@@ -254,11 +265,25 @@ export interface MunimBluetooth
   /**
    * Read RSSI (signal strength) for a connected device.
    *
-   * @param deviceId - The unique identifier of the connected device.
-   * @returns Promise resolving to RSSI value in dBm.
-   */
+  * @param deviceId - The unique identifier of the connected device.
+  * @returns Promise resolving to RSSI value in dBm.
+  */
   readRSSI(deviceId: string): Promise<number>
 
+  /**
+   * Start a best-effort background BLE session.
+   *
+   * Android uses a foreground service so BLE can continue after the app leaves the foreground.
+   * iOS keeps the central/peripheral managers running and relies on the host app's Bluetooth
+   * background modes for best-effort background operation.
+   */
+  startBackgroundSession(options: BackgroundSessionOptions): void
+
+  /**
+   * Stop the active background BLE session.
+   */
+  stopBackgroundSession(): void
+
   // ========== Event Management ==========
 
   /**