@capacitor/background-runner 2.1.0 → 2.3.0

package/ios/{Plugin → Sources/CapacitorBackgroundRunner}/BackgroundRunner.swift

@@ -1,8 +1,12 @@
-import Foundation
-import Capacitor
 import BackgroundTasks
+import Capacitor
+import Foundation
 import JavaScriptCore
 
+#if canImport(RunnerEngine)
+import RunnerEngine
+#endif
+
 public class BackgroundRunner {
     public static let shared = BackgroundRunner()
     public var config: RunnerConfig?
@@ -27,7 +31,8 @@ public class BackgroundRunner {
         }
 
         guard let interval = config.interval else {
-            throw BackgroundRunnerPluginError.invalidRunnerConfig(reason: "cannot register background task without a configured interval")
+            throw BackgroundRunnerPluginError.invalidRunnerConfig(
+                reason: "cannot register background task without a configured interval")
         }
 
         let request = BGAppRefreshTaskRequest(identifier: config.label)
@@ -64,7 +69,9 @@ public class BackgroundRunner {
     }
 
     // swiftlint:disable:next cyclomatic_complexity function_body_length
-    public func execute(config: RunnerConfig, inputArgs: [String: Any]? = nil, callbackId: String? = nil) throws -> [String: Any]? {
+    public func execute(
+        config: RunnerConfig, inputArgs: [String: Any]? = nil, callbackId: String? = nil
+    ) throws -> [String: Any]? {
         do {
             let context = try initContext(config: config, callbackId: callbackId)
 
@@ -73,7 +80,7 @@ public class BackgroundRunner {
             var result: [String: Any]?
             var rejectionErr: JSError?
 
-            let resolveFunc: @convention(block)(JavaScriptCore.JSValue) -> Void = { returnObj in
+            let resolveFunc: @convention(block) (JavaScriptCore.JSValue) -> Void = { returnObj in
                 if !returnObj.isUndefined && !returnObj.isNull {
                     var dict: [String: Any] = [:]
 
@@ -88,7 +95,7 @@ public class BackgroundRunner {
                 return
             }
 
-            let rejectFunc: @convention(block)(JavaScriptCore.JSValue) -> Void = { rejectObj in
+            let rejectFunc: @convention(block) (JavaScriptCore.JSValue) -> Void = { rejectObj in
                 var rejectionTitle = "Error"
                 var rejectionMessage = ""
 
@@ -136,7 +143,7 @@ public class BackgroundRunner {
             waitGroup.wait()
 
             if let rejection = rejectionErr {
-                throw EngineError.jsException(details: rejection.message)
+                throw EngineError.jsException(details: rejection.toString())
             }
 
             return result
@@ -146,7 +153,8 @@ public class BackgroundRunner {
         }
     }
 
-    public func dispatchEvent(event: String, inputArgs: [String: Any]?, callbackId: String? = nil) throws {
+    public func dispatchEvent(event: String, inputArgs: [String: Any]?, callbackId: String? = nil)
+    throws {
         if let config = config {
             let waitGroup = DispatchGroup()
             waitGroup.enter()
@@ -174,13 +182,17 @@ public class BackgroundRunner {
     }
 
     private func loadRunnerConfig() throws -> RunnerConfig? {
-        guard let capacitorConfigFileURL = Bundle.main.url(forResource: "capacitor.config.json", withExtension: nil) else {
+        guard
+            let capacitorConfigFileURL = Bundle.main.url(
+                forResource: "capacitor.config.json", withExtension: nil)
+        else {
             throw BackgroundRunnerPluginError.runnerError(reason: "capacitor.config.json file not found")
         }
 
         let capacitorConfigFileData = try Data(contentsOf: capacitorConfigFileURL)
 
-        if let capConfig = JSTypes.coerceDictionaryToJSObject(try JSONSerialization.jsonObject(with: capacitorConfigFileData) as? [String: Any]) {
+        if let capConfig = JSTypes.coerceDictionaryToJSObject(
+            try JSONSerialization.jsonObject(with: capacitorConfigFileData) as? [String: Any]) {
             if let jsonConfig = capConfig[keyPath: "plugins.BackgroundRunner"] as? JSObject {
                 return try RunnerConfig(from: jsonConfig)
             }
@@ -190,7 +202,10 @@ public class BackgroundRunner {
     }
 
     private func initContext(config: RunnerConfig, callbackId: String?) throws -> Context {
-        guard let srcFileURL = Bundle.main.url(forResource: config.src, withExtension: nil, subdirectory: "public") else {
+        guard
+            let srcFileURL = Bundle.main.url(
+                forResource: config.src, withExtension: nil, subdirectory: "public")
+        else {
             throw BackgroundRunnerPluginError.runnerError(reason: "source file not found")
         }
 

package/ios/{Plugin → Sources/CapacitorBackgroundRunner}/CapacitorAPI/Geolocation.swift

@@ -1,6 +1,10 @@
+import CoreLocation
 import Foundation
 import JavaScriptCore
-import CoreLocation
+
+#if canImport(RunnerEngine)
+import RunnerEngine
+#endif
 
 @objc protocol CapacitorGeolocationExports: JSExport {
     var isWatchingPosition: Bool { get }
@@ -32,9 +36,12 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
         self.context = context
         self.locationManager.delegate = self
 
-        self.locationManager.allowsBackgroundLocationUpdates = true
-        self.locationManager.desiredAccuracy = kCLLocationAccuracyKilometer
-        self.locationManager.pausesLocationUpdatesAutomatically = false
+        if CLLocationManager.authorizationStatus() == .authorizedAlways {
+            self.locationManager.allowsBackgroundLocationUpdates = true
+            self.locationManager.desiredAccuracy = kCLLocationAccuracyKilometer
+            self.locationManager.pausesLocationUpdatesAutomatically = false
+        }
+
     }
 
     static func getCurrentKnownLocation() -> CLLocation? {
@@ -71,7 +78,8 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
             return
         }
 
-        return try await withCheckedThrowingContinuation({ (continuation: CheckedContinuation<Void, Error>) in
+        return try await withCheckedThrowingContinuation({
+            (continuation: CheckedContinuation<Void, Error>) in
             permissionContinuation = continuation
 
             DispatchQueue.main.async {
@@ -96,7 +104,8 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
 
             self.isWatchingLocation = true
         } catch {
-            JSContext.current().exception = JSValue(newErrorFromMessage: "\(error)", in: JSContext.current())
+            JSContext.current().exception = JSValue(
+                newErrorFromMessage: "\(error)", in: JSContext.current())
         }
     }
 
@@ -121,7 +130,8 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
 
             return buildLocationDict(location: lastLocation)
         } catch {
-            JSContext.current().exception = JSValue(newErrorFromMessage: "\(error)", in: JSContext.current())
+            JSContext.current().exception = JSValue(
+                newErrorFromMessage: "\(error)", in: JSContext.current())
 
             return nil
         }
@@ -139,7 +149,8 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
             try? context.dispatchEvent(event: "currentLocation", details: details)
         }
 
-        pendingCurrentLocationCalls.forEach { (callId: Int, callback: (Result<CLLocation?, Error>) -> Void) in
+        pendingCurrentLocationCalls.forEach {
+            (callId: Int, callback: (Result<CLLocation?, Error>) -> Void) in
             pendingCurrentLocationCalls.removeValue(forKey: callId)
             callback(.success(locations.last))
         }
@@ -162,7 +173,8 @@ class CapacitorGeolocation: NSObject, CapacitorGeolocationExports, CLLocationMan
             try? context.dispatchEvent(event: "currentLocation", details: details)
         }
 
-        pendingCurrentLocationCalls.forEach { (callId: Int, callback: (Result<CLLocation?, Error>) -> Void) in
+        pendingCurrentLocationCalls.forEach {
+            (callId: Int, callback: (Result<CLLocation?, Error>) -> Void) in
             pendingCurrentLocationCalls.removeValue(forKey: callId)
             callback(.failure(error))
         }

package/ios/{Plugin → Sources/CapacitorBackgroundRunner}/CapacitorAPI/Notifications.swift

@@ -1,4 +1,5 @@
 import Foundation
+import UIKit
 import JavaScriptCore
 import UserNotifications
 
@@ -136,7 +137,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
                     let content = UNMutableNotificationContent()
                     content.title = NSString.localizedUserNotificationString(forKey: notificationOption.title, arguments: nil)
                     content.body = NSString.localizedUserNotificationString(forKey: notificationOption.body, arguments: nil)
-                    content.userInfo = [:]
+                    content.userInfo = ["source": "capacitor-background-runner"]
 
                     if let extra = notificationOption.extra {
                         content.userInfo["cap_extra"] = extra
@@ -195,7 +196,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
 
             let badgeOptions = SetBadgeOption(from: jsonDict)
 
-            DispatchQueue.main.sync {
+            DispatchQueue.main.async {
                 if #available(iOS 16.0, *) {
                     UNUserNotificationCenter.current().setBadgeCount(badgeOptions.count)
                 } else {
@@ -213,7 +214,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
                 throw CapacitorNotificationsErrors.permissionDenied
             }
 
-            DispatchQueue.main.sync {
+            DispatchQueue.main.async {
                 if #available(iOS 16.0, *) {
                     UNUserNotificationCenter.current().setBadgeCount(0)
                 } else {

package/ios/{Plugin → Sources/CapacitorBackgroundRunner}/CapacitorAPI/Reachability.swift

@@ -191,7 +191,7 @@ public extension Reachability {
                 _ = unmanagedWeakifiedReachability.retain()
                 return UnsafeRawPointer(unmanagedWeakifiedReachability.toOpaque())
             },
-            release: { (info: UnsafeRawPointer) -> Void in
+            release: { (info: UnsafeRawPointer) in
                 let unmanagedWeakifiedReachability = Unmanaged<ReachabilityWeakifier>.fromOpaque(info)
                 unmanagedWeakifiedReachability.release()
             },

package/ios/{Plugin/BackgroundRunnerPlugin.swift → Sources/CapacitorBackgroundRunner/CapacitorBackgroundRunner.swift}

@@ -1,10 +1,21 @@
 import Foundation
 import Capacitor
 import WatchConnectivity
+import UserNotifications
 
 @objc(BackgroundRunnerPlugin)
-public class BackgroundRunnerPlugin: CAPPlugin {
+public class BackgroundRunnerPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "CapacitorBackgroundRunnerPlugin"
+    public let jsName = "CapacitorBackgroundRunner"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "checkPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "requestPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "dispatchEvent", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "registerBackgroundTask", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "removeNotificationListeners", returnType: CAPPluginReturnPromise)
+    ]
     private let impl = BackgroundRunner()
+    private weak var originalDelegate: UNUserNotificationCenterDelegate?
 
     override public func load() {
         NotificationCenter.default.addObserver(
@@ -14,6 +25,9 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             object: nil
         )
 
+        // Register as notification delegate
+        registerNotificationCategories()
+
         initWatchConnectivity()
     }
 
@@ -95,6 +109,11 @@ public class BackgroundRunnerPlugin: CAPPlugin {
         call.resolve()
     }
 
+    @objc func removeNotificationListeners(_ call: CAPPluginCall) {
+        notifyListeners("backgroundRunnerNotificationReceived", data: nil)
+        call.resolve()
+    }
+
     @objc private func didEnterBackground() {
         do {
             try impl.scheduleBackgroundTasks()
@@ -175,4 +194,88 @@ public class BackgroundRunnerPlugin: CAPPlugin {
 
         print("Watch Connectivity Enabled")
     }
+
+    @objc func registerNotificationCategories() {
+        let notificationCenter = UNUserNotificationCenter.current()
+
+        // Capture the original delegate if it's not self
+        if notificationCenter.delegate !== self {
+            originalDelegate = notificationCenter.delegate
+        }
+
+        // Set the plugin as the notification delegate
+        notificationCenter.delegate = self
+    }
+}
+
+// MARK: - UNUserNotificationCenterDelegate
+extension BackgroundRunnerPlugin: UNUserNotificationCenterDelegate {
+    // This method will be called when a notification is tapped
+    public func userNotificationCenter(_ center: UNUserNotificationCenter,
+                                       didReceive response: UNNotificationResponse,
+                                       withCompletionHandler completionHandler: @escaping () -> Void) {
+        let userInfo = response.notification.request.content.userInfo
+
+        if isBackgroundRunnerNotification(userInfo) {
+            handleBackgroundRunnerNotification(response, completionHandler: completionHandler)
+        } else {
+            forwardToOriginalDelegate(center, didReceive: response, withCompletionHandler: completionHandler)
+        }
+    }
+
+    // This is needed to present notifications when the app is in the foreground
+    public func userNotificationCenter(_ center: UNUserNotificationCenter,
+                                       willPresent notification: UNNotification,
+                                       withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
+        let userInfo = notification.request.content.userInfo
+
+        if isBackgroundRunnerNotification(userInfo) {
+            handleBackgroundRunnerPresentation(completionHandler: completionHandler)
+        } else {
+            forwardToOriginalDelegate(center, willPresent: notification, withCompletionHandler: completionHandler)
+        }
+    }
+
+    // MARK: - Helper Methods
+
+    private func isBackgroundRunnerNotification(_ userInfo: [AnyHashable: Any]) -> Bool {
+        return (userInfo["source"] as? String) == "capacitor-background-runner"
+    }
+
+    private func handleBackgroundRunnerNotification(_ response: UNNotificationResponse, completionHandler: @escaping () -> Void) {
+        let actionTypeId = response.notification.request.content.categoryIdentifier
+        let notificationId = Int(response.notification.request.identifier) ?? -1
+
+        let eventData: [String: Any] = [
+            "actionTypeId": actionTypeId,
+            "notificationId": notificationId
+        ]
+
+        notifyListeners("backgroundRunnerNotificationReceived", data: eventData, retainUntilConsumed: true)
+        completionHandler()
+    }
+
+    private func forwardToOriginalDelegate(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
+        if let originalDelegate = originalDelegate, originalDelegate.responds(to: #selector(userNotificationCenter(_:didReceive:withCompletionHandler:))) {
+            originalDelegate.userNotificationCenter?(center, didReceive: response, withCompletionHandler: completionHandler)
+        } else {
+            completionHandler()
+        }
+    }
+
+    private func handleBackgroundRunnerPresentation(completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
+        if #available(iOS 14.0, *) {
+            completionHandler([.banner, .sound, .badge])
+        } else {
+            completionHandler([.alert, .sound, .badge])
+        }
+    }
+
+    private func forwardToOriginalDelegate(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
+        if let originalDelegate = originalDelegate, originalDelegate.responds(to: #selector(userNotificationCenter(_:willPresent:withCompletionHandler:))) {
+            originalDelegate.userNotificationCenter?(center, willPresent: notification, withCompletionHandler: completionHandler)
+        } else {
+            handleBackgroundRunnerPresentation(completionHandler: completionHandler)
+        }
+    }
 }

package/ios/{Plugin → Sources/CapacitorBackgroundRunner}/Context+CapacitorAPI.swift

@@ -1,11 +1,17 @@
 import Foundation
 
+#if canImport(RunnerEngine)
+import RunnerEngine
+#endif
+
 extension Context {
     public func setupCapacitorAPI() {
         jsContext.setObject(CapacitorKVStore.self, forKeyedSubscript: "CapacitorKV" as NSString)
-        jsContext.setObject(CapacitorGeolocation(context: self), forKeyedSubscript: "CapacitorGeolocation" as NSString)
+        jsContext.setObject(
+            CapacitorGeolocation(context: self), forKeyedSubscript: "CapacitorGeolocation" as NSString)
         jsContext.setObject(CapacitorWatch(), forKeyedSubscript: "CapacitorWatch" as NSString)
-        jsContext.setObject(CapacitorNotifications.self, forKeyedSubscript: "CapacitorNotifications" as NSString)
+        jsContext.setObject(
+            CapacitorNotifications.self, forKeyedSubscript: "CapacitorNotifications" as NSString)
         jsContext.setObject(CapacitorDevice(), forKeyedSubscript: "CapacitorDevice" as NSString)
         jsContext.setObject(CapacitorApp.self, forKeyedSubscript: "CapacitorApp" as NSString)
     }

package/ios/{Plugin → Sources}/RunnerEngine/Context.swift

@@ -3,7 +3,7 @@ import JavaScriptCore
 
 public class Context {
     let name: String
-    let jsContext: JSContext
+    public let jsContext: JSContext
 
     private var eventListeners = [String: JSValue]()
     private var timers = [Int: Timer]()

package/ios/{Plugin → Sources}/RunnerEngine/JSCrypto.swift

@@ -13,17 +13,17 @@ class JSCrypto: NSObject, JSCryptoExports {
         var rnd = [UInt8](repeating: 0, count: size)
         _ = SecRandomCopyBytes(kSecRandomDefault, size, &rnd)
 
-        if arr.toArray() as? [UInt8] != nil {
+        if arr.toArray() is [UInt8] {
             for i in 0...(size - 1) {
                 arr.setObject(rnd[i], atIndexedSubscript: i)
             }
         }
-        if arr.toArray() as? [UInt16] != nil {
+        if arr.toArray() is [UInt16] {
             for i in 0...(size - 1) {
                 arr.setObject(UInt16(rnd[i]), atIndexedSubscript: i)
             }
         }
-        if arr.toArray() as? [UInt32] != nil {
+        if arr.toArray() is [UInt32] {
             for i in 0...(size - 1) {
                 arr.setObject(UInt32(rnd[i]), forKeyedSubscript: i)
             }

package/ios/{Plugin → Sources}/RunnerEngine/JSError.swift

@@ -27,7 +27,7 @@ import JavaScriptCore
         self.cause = nil
     }
 
-    func toString() -> String {
+    public func toString() -> String {
         return message
     }
 }

package/ios/{Plugin → Sources}/RunnerEngine/Runner.swift

@@ -12,7 +12,7 @@ public class Runner {
         runLoop = RunLoop.current
     }
 
-    func createContext(name: String) throws -> Context {
+    public func createContext(name: String) throws -> Context {
         return try Context(vm: machine, contextName: name, runLoop: runLoop)
     }
 }

package/ios/Tests/CapacitorBackgroundRunnerTests/CapacitorBackgroundRunnerTests.swift

@@ -0,0 +1,21 @@
+import Testing
+@testable import CapacitorBackgroundRunner
+@testable import RunnerEngine
+
+@Test func testKeyValueAPI() async throws {
+    let runner = Runner()
+    let context = try runner.createContext(name: "io.backgroundrunner.testkv")
+    context.setupCapacitorAPI()
+
+    _ = try context.execute(code: "CapacitorKV.set('test', 'hello world');")
+
+    let value = try context.execute(code: "CapacitorKV.get('test');")
+
+    #expect(value?.toDictionary()?["value"] as? String == "hello world")
+
+    _ = try context.execute(code: "CapacitorKV.remove('test');")
+
+    let nullValue = try context.execute(code: "CapacitorKV.get('test');")
+
+    #expect(nullValue?.isNull ?? false)
+}