@capacitor/background-runner 1.0.6-dev-20240409T144959.0 → 1.0.6-dev-20240416T212318.0

package/README.md

@@ -157,7 +157,7 @@ Calling `resolve()` \ `reject()` is **required** within every event handler call
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
 On load, Background Runner will automatically register a
-background task that will be scheduled and ran once your app is
+background task that will be scheduled and run once your app is
 backgrounded.
 
 | Prop            | Type                 | Description                                                                                                                                                                                          | Since |

package/dist/docs-api.json

@@ -764,7 +764,7 @@
           "type": "boolean | undefined"
         }
       ],
-      "docs": "On load, Background Runner will automatically register a\nbackground task that will be scheduled and ran once your app is\nbackgrounded."
+      "docs": "On load, Background Runner will automatically register a\nbackground task that will be scheduled and run once your app is\nbackgrounded."
     }
   ]
 }

package/dist/docs.json

@@ -307,7 +307,7 @@
           "type": "boolean | undefined"
         }
       ],
-      "docs": "On load, Background Runner will automatically register a\nbackground task that will be scheduled and ran once your app is\nbackgrounded."
+      "docs": "On load, Background Runner will automatically register a\nbackground task that will be scheduled and run once your app is\nbackgrounded."
     }
   ]
 }

package/dist/esm/definitions.d.ts

@@ -43,7 +43,7 @@ declare module '@capacitor/cli' {
     interface PluginsConfig {
         /**
          * On load, Background Runner will automatically register a
-         * background task that will be scheduled and ran once your app is
+         * background task that will be scheduled and run once your app is
          * backgrounded.
          */
         BackgroundRunner?: {

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n  /**\n   * The name of the runner, used in logs.\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The path to the runner JavaScript file, relative to the app bundle.\n   *\n   * @since 1.0.0\n   */\n  src: string;\n  /**\n   * The name of the event that will be called when the OS executes the background task.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  /**\n   * If background task should repeat based on the interval set in `interval`.\n   *\n   * @since 1.0.0\n   */\n  repeat: boolean;\n  /**\n   * The number of minutes after the the app is put into the background in which the background task should begin.\n   *\n   * If `repeat` is true, this also specifies the number of minutes between each execution.\n   *\n   * @since 1.0.0\n   */\n  interval: number;\n  /**\n   * Automatically register and schedule background task on app load.\n   *\n   * @since 1.0.0\n   */\n  autoStart?: boolean;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * On load, Background Runner will automatically register a\n     * background task that will be scheduled and ran once your app is\n     * backgrounded.\n     */\n    BackgroundRunner?: {\n      /**\n       * The name of the runner, used in logs.\n       *\n       * @since 1.0.0\n       * @example \"com.example.background.task\"\n       */\n      label: string;\n      /**\n       * The path to the runner JavaScript file, relative to the app bundle.\n       *\n       * @since 1.0.0\n       * @example \"runners/background.js\"\n       */\n      src: string;\n      /**\n       * The name of the event that will be called when the OS executes the background task.\n       *\n       * @since 1.0.0\n       * @example \"myCustomEvent\"\n       */\n      event: string;\n      /**\n       * If background task should repeat based on the interval set in `interval`.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      repeat: boolean;\n      /**\n       * The number of minutes after the the app is put into the background in which the background task should begin.\n       *\n       * If `repeat` is true, this also specifies the number of minutes between each execution.\n       *\n       * @since 1.0.0\n       * @example 15\n       */\n      interval: number;\n      /**\n       * Automatically register and schedule background task on app load.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      autoStart?: boolean;\n    };\n  }\n}\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n  geolocation: PermissionState;\n  notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n  /**\n   * The runner label to dispatch the event to\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The name of the registered event listener.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n  apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n  runner: BackgroundRunnerConfig;\n}\n\nexport interface BackgroundRunnerPlugin {\n  /**\n   * Check permissions for the various Capacitor device APIs.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(\n    options: RequestPermissionOptions,\n  ): Promise<PermissionStatus>;\n  /**\n   * Dispatches an event to the configured runner.\n   * @param options\n   * @since 1.0.0\n   */\n  dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    BackgroundRunner?: BackgroundRunnerConfig;\n  }\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n  /**\n   * The name of the runner, used in logs.\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The path to the runner JavaScript file, relative to the app bundle.\n   *\n   * @since 1.0.0\n   */\n  src: string;\n  /**\n   * The name of the event that will be called when the OS executes the background task.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  /**\n   * If background task should repeat based on the interval set in `interval`.\n   *\n   * @since 1.0.0\n   */\n  repeat: boolean;\n  /**\n   * The number of minutes after the the app is put into the background in which the background task should begin.\n   *\n   * If `repeat` is true, this also specifies the number of minutes between each execution.\n   *\n   * @since 1.0.0\n   */\n  interval: number;\n  /**\n   * Automatically register and schedule background task on app load.\n   *\n   * @since 1.0.0\n   */\n  autoStart?: boolean;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * On load, Background Runner will automatically register a\n     * background task that will be scheduled and run once your app is\n     * backgrounded.\n     */\n    BackgroundRunner?: {\n      /**\n       * The name of the runner, used in logs.\n       *\n       * @since 1.0.0\n       * @example \"com.example.background.task\"\n       */\n      label: string;\n      /**\n       * The path to the runner JavaScript file, relative to the app bundle.\n       *\n       * @since 1.0.0\n       * @example \"runners/background.js\"\n       */\n      src: string;\n      /**\n       * The name of the event that will be called when the OS executes the background task.\n       *\n       * @since 1.0.0\n       * @example \"myCustomEvent\"\n       */\n      event: string;\n      /**\n       * If background task should repeat based on the interval set in `interval`.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      repeat: boolean;\n      /**\n       * The number of minutes after the the app is put into the background in which the background task should begin.\n       *\n       * If `repeat` is true, this also specifies the number of minutes between each execution.\n       *\n       * @since 1.0.0\n       * @example 15\n       */\n      interval: number;\n      /**\n       * Automatically register and schedule background task on app load.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      autoStart?: boolean;\n    };\n  }\n}\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n  geolocation: PermissionState;\n  notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n  /**\n   * The runner label to dispatch the event to\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The name of the registered event listener.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n  apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n  runner: BackgroundRunnerConfig;\n}\n\nexport interface BackgroundRunnerPlugin {\n  /**\n   * Check permissions for the various Capacitor device APIs.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(\n    options: RequestPermissionOptions,\n  ): Promise<PermissionStatus>;\n  /**\n   * Dispatches an event to the configured runner.\n   * @param options\n   * @since 1.0.0\n   */\n  dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    BackgroundRunner?: BackgroundRunnerConfig;\n  }\n}\n"]}

package/ios/Plugin/BackgroundRunner.swift

@@ -5,8 +5,8 @@ import JavaScriptCore
 
 public class BackgroundRunner {
     public static let shared = BackgroundRunner()
-
-    private var config: RunnerConfig?
+    public var config: RunnerConfig?
+    
     private var runner = Runner()
 
     public init() {
@@ -17,93 +17,51 @@ public class BackgroundRunner {
             print("could not initialize BackgroundRunner: \(error)")
         }
     }
-
-    public func registerBackgroundTask() {
+    
+    public func scheduleBackgroundTasks() throws {
         guard let config = config else {
-            print("no runner to register")
-            return
+            throw BackgroundRunnerPluginError.noRunnerConfig
         }
-
-        if config.event == nil {
-            print("cannot register background task without a event to call")
-            return
-        }
-
-        BGTaskScheduler.shared.register(forTaskWithIdentifier: config.label, using: nil) { task in
-            do {
-                task.expirationHandler = {
-                    print("task timed out")
-                }
-
-                guard let event = config.event else {
-                    throw BackgroundRunnerPluginError.invalidRunnerConfig(reason: "runner event is missing or invalid")
-                }
-
-                _ = try BackgroundRunner.shared.execute(config: config, event: event)
-
-                task.setTaskCompleted(success: true)
-            } catch {
-                print("background task error: \(error)")
-                task.setTaskCompleted(success: false)
-            }
-        }
-    }
-
-    public func scheduleBackgroundTasks() {
-        guard let config = config else {
+        
+        if !config.autoSchedule {
             return
         }
 
         guard let interval = config.interval else {
-            print("cannot register background task without a configured interval")
-            return
+            throw BackgroundRunnerPluginError.invalidRunnerConfig(reason: "cannot register background task without a configured interval")
         }
 
         let request = BGAppRefreshTaskRequest(identifier: config.label)
         request.earliestBeginDate = Date(timeIntervalSinceNow: Double(interval) * 60)
 
-        do {
-            print("Scheduling \(config.label)")
+        print("Scheduling \(config.label)")
 
-            try BGTaskScheduler.shared.submit(request)
-        } catch {
-            print("Could not schedule app refresh: \(error)")
-        }
-    }
-
-    public func getConfig() -> RunnerConfig? {
-        return config
+        try BGTaskScheduler.shared.submit(request)
     }
 
-    public func dispatchEvent(event: String, inputArgs: [String: Any]?, callbackId: String? = nil) throws {
-        if let config = config {
-            let waitGroup = DispatchGroup()
-            waitGroup.enter()
-
-            var err: Error?
+    public func registerBackgroundTask() throws {
+        guard let config = config else {
+            throw BackgroundRunnerPluginError.noRunnerConfig
+        }
 
-            // swiftlint:disable:next unowned_variable_capture
-            DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
-                do {
-                    _ = try self.execute(config: config, event: event, inputArgs: inputArgs, callbackId: callbackId)
-                } catch {
-                    err = error
-                    print("[\(config.label)]: \(error)")
+        BGTaskScheduler.shared.register(forTaskWithIdentifier: config.label, using: nil) { task in
+            do {
+                task.expirationHandler = {
+                    print("task timed out")
                 }
 
-                waitGroup.leave()
-            }
+                _ = try BackgroundRunner.shared.execute(config: config)
 
-            waitGroup.wait()
-
-            if let err = err {
-                throw err
+                task.setTaskCompleted(success: true)
+            } catch {
+                print("background task error: \(error)")
+                task.setTaskCompleted(success: false)
             }
         }
     }
-
+    
     // swiftlint:disable:next cyclomatic_complexity function_body_length
-    public func execute(config: RunnerConfig, event: String, 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)
 
@@ -170,9 +128,10 @@ public class BackgroundRunner {
 
             waitGroup.enter()
 
-            try context.dispatchEvent(event: event, details: args)
+            try context.dispatchEvent(event: config.event, details: args)
 
             waitGroup.wait()
+            
 
             if let rejection = rejectionErr {
                 throw EngineError.jsException(details: rejection.message)
@@ -185,6 +144,33 @@ public class BackgroundRunner {
         }
     }
 
+    public func dispatchEvent(event: String, inputArgs: [String: Any]?, callbackId: String? = nil) throws {
+        if let config = config {
+            let waitGroup = DispatchGroup()
+            waitGroup.enter()
+
+            var err: Error?
+
+            // swiftlint:disable:next unowned_variable_capture
+            DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
+                do {
+                    _ = try self.execute(config: config, inputArgs: inputArgs, callbackId: callbackId)
+                } catch {
+                    err = error
+                    print("[\(config.label)]: \(error)")
+                }
+
+                waitGroup.leave()
+            }
+
+            waitGroup.wait()
+
+            if let err = err {
+                throw err
+            }
+        }
+    }
+
     private func loadRunnerConfig() throws -> RunnerConfig? {
         guard let capacitorConfigFileURL = Bundle.main.url(forResource: "capacitor.config.json", withExtension: nil) else {
             throw BackgroundRunnerPluginError.runnerError(reason: "capacitor.config.json file not found")

package/ios/Plugin/BackgroundRunnerErrors.swift

@@ -1,6 +1,7 @@
 import Foundation
 
 public enum BackgroundRunnerPluginError: Error, Equatable {
+    case noRunnerConfig
     case invalidRunnerConfig(reason: String)
     case invalidArgument(reason: String)
     case runnerError(reason: String)

package/ios/Plugin/BackgroundRunnerPlugin.swift

@@ -13,6 +13,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             name: UIApplication.didEnterBackgroundNotification,
             object: nil
         )
+        
         initWatchConnectivity()
     }
 
@@ -54,22 +55,23 @@ public class BackgroundRunnerPlugin: CAPPlugin {
 
     @objc func dispatchEvent(_ call: CAPPluginCall) {
         do {
-            guard let runnerEvent = call.getString("event") else {
+            guard let runnerEvent = call.getString("event"), !runnerEvent.isEmpty else {
                 throw BackgroundRunnerPluginError.invalidArgument(reason: "event is missing or invalid")
             }
 
             let details = call.getObject("details", JSObject())
 
-            guard let config = impl.getConfig() else {
-                throw BackgroundRunnerPluginError.runnerError(reason: "no runner config loaded")
+            guard var config = impl.config else {
+                throw BackgroundRunnerPluginError.noRunnerConfig
             }
+            
+            config.event = runnerEvent
 
             // swiftlint:disable:next unowned_variable_capture
             DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
                 do {
                     let result = try self.impl.execute(
                         config: config,
-                        event: runnerEvent,
                         inputArgs: details as [String: Any],
                         callbackId: call.callbackId
                     )
@@ -94,14 +96,27 @@ public class BackgroundRunnerPlugin: CAPPlugin {
     }
 
     @objc private func didEnterBackground() {
-        impl.scheduleBackgroundTasks()
+        do {
+            try impl.scheduleBackgroundTasks()
+        } catch {
+            print("could not schedule background task: \(error)")
+        }
     }
 
     public static func registerBackgroundTask() {
-        BackgroundRunner.shared.registerBackgroundTask()
+        do {
+            try BackgroundRunner.shared.registerBackgroundTask()
+        } catch {
+            print("could not register background task: \(error)")
+        }
     }
 
     public static func dispatchEvent(event: String, eventArgs: [AnyHashable: Any], completionHandler: ((Result<Bool, Error>) -> Void)) {
+        if event.isEmpty {
+            completionHandler(.failure(BackgroundRunnerPluginError.invalidArgument(reason: "event is missing or invalid")))
+            return
+        }
+        
         var args: [String: Any] = [:]
 
         eventArgs.forEach { (key: AnyHashable, value: Any) in
@@ -147,7 +162,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             return
         }
 
-        guard let config = impl.getConfig() else {
+        guard let config = impl.config else {
             return
         }
 

package/ios/Plugin/CapacitorAPI/KV.swift

@@ -13,9 +13,11 @@ class CapacitorKVStore: NSObject, CapacitorKVStoreExports {
     }
 
     static func get(_ key: String) -> JSValue {
+        guard let value = UserDefaults.standard.string(forKey: key) else {
+            return JSValue(nullIn: JSContext.current())
+        }
+        
         var valueWrapper: [String: String] = [:]
-
-        let value = UserDefaults.standard.string(forKey: key)
         valueWrapper["value"] = value
 
         return JSValue(object: valueWrapper, in: JSContext.current())

package/ios/Plugin/RunnerConfig.swift

@@ -5,7 +5,7 @@ public struct RunnerConfig {
     let label: String
     let src: String
     var autoSchedule: Bool
-    let event: String?
+    var event: String
     let repeats: Bool?
     let enableWatchConnectivity: Bool
 
@@ -20,7 +20,7 @@ public struct RunnerConfig {
             throw BackgroundRunnerPluginError.invalidRunnerConfig(reason: "runner source file path is missing or invalid")
         }
 
-        let event = jsObject["event"] as? String
+        let event = jsObject["event"] as? String ?? ""
         let repeats = jsObject["repeat"] as? Bool
         let interval = jsObject["interval"] as? Int
         let autoStart = jsObject["autoStart"] as? Bool

package/ios/Plugin/RunnerEngine/Runner.swift

@@ -3,31 +3,17 @@ import JavaScriptCore
 
 public class Runner {
     var machine: JSVirtualMachine
-    var contexts: [String: Context]
 
     private let runLoop: RunLoop
     private var thread: Thread?
 
     public init() {
         machine = JSVirtualMachine()
-        contexts = [:]
         runLoop = RunLoop.current
     }
 
     func createContext(name: String) throws -> Context {
-        let context = try Context(vm: machine, contextName: name, runLoop: runLoop)
-
-        if contexts.keys.contains(name) {
-            throw EngineError.runnerError(details: "context with name \(name) already exists")
-        }
-
-        contexts[name] = context
-
-        return context
-    }
-
-    func destroyContext(name: String) {
-        contexts.removeValue(forKey: name)
+        return try Context(vm: machine, contextName: name, runLoop: runLoop)
     }
 
     func start() {
@@ -54,6 +40,7 @@ public class Runner {
         }
 
         thread.cancel()
+        
         while !thread.isFinished {
             Thread.sleep(forTimeInterval: 0.05)
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/background-runner",
-  "version": "1.0.6-dev-20240409T144959.0",
+  "version": "1.0.6-dev-20240416T212318.0",
   "description": "Capacitor Background Runner",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -81,5 +81,5 @@
       "src": "android"
     }
   },
-  "gitHead": "18f72b6c17bb83bb0e9dde3b0b4c1d3db5309b0d"
+  "gitHead": "bbb1e6ffec4fe612f069f39b3e4c1b4daed27210"
 }