@capacitor/background-runner 1.0.6-dev-20230831T174057.0 → 1.0.6-dev-20240409T144959.0

package/README.md

@@ -314,7 +314,7 @@ Request permission to display local notifications.
 ### dispatchEvent(...)
 
 ```typescript
-dispatchEvent(options: DispatchEventOptions) => any
+dispatchEvent<T = void>(options: DispatchEventOptions) => any
 ```
 
 Dispatches an event to the configured runner.
@@ -456,7 +456,7 @@ Get access to device location information.
 
 | Prop                     | Type                                                                                   | Description                          | Since |
 | ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------ | ----- |
-| **`getCurrentLocation`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
+| **`getCurrentPosition`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
 
 
 #### GetCurrentPositionResult
@@ -488,4 +488,5 @@ They could be used if a native watch app is developed as a companion app to a Ca
 | **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                           |
 | **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                          |
 
+
 </capacitor-api-docs>

package/android/build.gradle

@@ -52,7 +52,10 @@ android {
 repositories {
     google()
     mavenCentral()
-    flatDir { dirs "./src/main/libs" }
+    flatDir {
+        dirs "./src/main/libs", "libs"
+        dirs "$rootDir/../node_modules/@capacitor/background-runner/android/src/main/libs", "libs"
+    }
 }
 
 dependencies {

package/android/src/main/AndroidManifest.xml

@@ -3,7 +3,9 @@
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
 
     <application>
         <receiver android:name="io.ionic.backgroundrunner.plugin.api.TimedNotificationPublisher" />

package/android/src/main/java/io/ionic/backgroundrunner/plugin/BackgroundRunner.kt

@@ -1,16 +1,18 @@
 package io.ionic.backgroundrunner.plugin
 
 import android.content.res.AssetManager
+import androidx.work.Constraints
 import androidx.work.Data
 import androidx.work.ExistingPeriodicWorkPolicy
 import androidx.work.ExistingWorkPolicy
+import androidx.work.NetworkType
 import androidx.work.OneTimeWorkRequest
 import androidx.work.PeriodicWorkRequest
 import androidx.work.WorkManager
 import io.ionic.android_js_engine.Context
-import io.ionic.android_js_engine.JSFunction
+import io.ionic.android_js_engine.NativeCapacitorAPI
+import io.ionic.android_js_engine.NativeJSFunction
 import io.ionic.android_js_engine.Runner
-import io.ionic.android_js_engine.api.CapacitorAPI
 import io.ionic.backgroundrunner.plugin.api.Device
 import io.ionic.backgroundrunner.plugin.api.Geolocation
 import io.ionic.backgroundrunner.plugin.api.KV
@@ -24,33 +26,23 @@ import java.util.concurrent.TimeUnit
 
 
 class BackgroundRunner(context: android.content.Context) {
-    public val config: RunnerConfig?
-    private var runner: Runner? = null
-    private var context: Context? = null
-
-    companion object {
-        @Volatile private var instance: BackgroundRunner? = null
-
-        fun getInstance(context: android.content.Context): BackgroundRunner = instance ?: synchronized(this) {
-            instance ?: BackgroundRunner(context).also { instance = it }
-        }
-    }
-
-    private val started: Boolean
-        get() {
-            return runner != null && context != null
-        }
+    private var runner: Runner?
+    val config: RunnerConfig?
 
     init {
         config = loadRunnerConfig(context.assets)
+        runner = null
+    }
+
+    fun start() {
+        this.runner = Runner()
     }
 
-    fun start(androidContext: android.content.Context) {
-        config ?: throw Exception("...no runner config to start")
+    fun shutdown() {
+        val runner = runner ?: return
 
-        runner = Runner()
-        context = initContext(config, androidContext)
-        context?.start()
+        runner.destroy()
+        this.runner = null
     }
 
     fun scheduleBackgroundTask(androidContext: android.content.Context) {
@@ -68,11 +60,16 @@ class BackgroundRunner(context: android.content.Context) {
             .putString("event", config.event)
             .build()
 
+        val constraints = Constraints.Builder()
+            .setRequiredNetworkType(NetworkType.CONNECTED)
+            .build()
+
         if (!config.repeats) {
             val work = OneTimeWorkRequest.Builder(RunnerWorker::class.java)
                 .setInitialDelay(interval.toLong(), TimeUnit.MINUTES)
                 .setInputData(data)
                 .addTag(config.label)
+                .setConstraints(constraints)
                 .build()
             WorkManager.getInstance(androidContext).enqueueUniqueWork(config.label, ExistingWorkPolicy.REPLACE, work)
         } else {
@@ -80,42 +77,53 @@ class BackgroundRunner(context: android.content.Context) {
                 .setInitialDelay(interval.toLong(), TimeUnit.MINUTES)
                 .setInputData(data)
                 .addTag(config.label)
+                .setConstraints(constraints)
                 .build()
             WorkManager.getInstance(androidContext).enqueueUniquePeriodicWork(config.label, ExistingPeriodicWorkPolicy.UPDATE, work)
         }
     }
 
-    suspend fun execute(androidContext: android.content.Context, config: RunnerConfig, dataArgs: JSONObject = JSONObject()): JSONObject? {
-        if (!started) {
-            start(androidContext)
-        }
+    suspend fun execute(androidContext: android.content.Context, config: RunnerConfig, dataArgs: JSONObject = JSONObject(), callbackId: String? = null): JSONObject? {
+        val runner = runner ?: throw Exception("runner is not started")
 
-        context ?: throw Exception("no loaded context for config")
+        val context = initContext(config, androidContext, callbackId)
 
-        val future = MutableStateFlow<Result<JSONObject?>?>(null)
+        class ResolveCallback(future: MutableStateFlow<Result<JSONObject?>?>) : NativeJSFunction(jsFunctionName = "resolve") {
+            var future: MutableStateFlow<Result<JSONObject?>?>
+
+            init {
+                this.future = future
+            }
 
-        class ResolveCallback : JSFunction(jsName = "resolve") {
             override fun run() {
                 super.run()
-                future.value = Result.success(this.args)
+                future.value = Result.success(this.jsFunctionArgs)
             }
         }
 
-        class RejectCallback : JSFunction(jsName = "reject") {
+        class RejectCallback(future: MutableStateFlow<Result<JSONObject?>?>) : NativeJSFunction(jsFunctionName = "reject") {
+            var future: MutableStateFlow<Result<JSONObject?>?>
+
+            init {
+                this.future = future
+            }
+
             override fun run() {
                 super.run()
-                val rejectionTitle = this.args?.optString("name", "Error") ?: "Error"
-                val rejectionMessage = this.args?.optString("message") ?: ""
+                val rejectionTitle = this.jsFunctionArgs?.optString("name", "Error") ?: "Error"
+                val rejectionMessage = this.jsFunctionArgs?.optString("message") ?: ""
                 val error = Exception("$rejectionTitle: $rejectionMessage")
 
                 future.value = Result.failure(error)
             }
         }
 
-        val resolve = ResolveCallback()
-        val reject = RejectCallback()
-        context!!.registerFunction("_resolveCallback", resolve)
-        context!!.registerFunction("_rejectCallback", reject)
+        val future = MutableStateFlow<Result<JSONObject?>?>(null)
+
+        val resolve = ResolveCallback(future)
+        val reject = RejectCallback(future)
+        context.registerFunction("_resolveCallback", resolve)
+        context.registerFunction("_rejectCallback", reject)
 
         val args = JSONObject()
 
@@ -126,15 +134,15 @@ class BackgroundRunner(context: android.content.Context) {
         args.put("callbacks", callbacks)
         args.put("dataArgs", dataArgs)
 
-        context!!.dispatchEvent(config.event, args)
+        context.dispatchEvent(config.event, args)
+
+        runner.waitForJobs()
 
         val finished = future.conditionalAwait {
             it != null
         }
 
-        runner?.destroy()
-
-        runner = null
+        destroyContext(context)
 
         if (finished!!.isSuccess) {
             return finished.getOrNull()
@@ -158,29 +166,37 @@ class BackgroundRunner(context: android.content.Context) {
             val plugins = configObject.getJSONObject("plugins") ?: throw Exception("could not read config file")
             val runnerConfigObj = plugins.getJSONObject("BackgroundRunner") ?: throw Exception("could not read config file")
 
-            return  RunnerConfig(runnerConfigObj)
+            return  RunnerConfig.fromJSON(runnerConfigObj)
         }
     }
 
-    private fun initContext(config: RunnerConfig, context: android.content.Context): Context {
-        runner ?: throw Exception("runner is not initialized")
+    private fun initContext(config: RunnerConfig, context: android.content.Context, callbackId: String?): Context {
+        val runner = runner ?: throw Exception("runner is not started")
 
         val srcFile = context.assets.open("public/${config.src}").bufferedReader().use {
             it.readText()
         }
 
-        val newContext  = runner!!.createContext(config.label)
+        var contextName = config.label
+        if (callbackId != null) {
+            contextName += "-$callbackId"
+        }
 
-        val api = CapacitorAPI(config.label)
-        api.initNotificationsAPI(Notifications(context))
+        val api = NativeCapacitorAPI()
         api.initDeviceAPI(Device(context))
-        api.initGeolocationAPI(Geolocation(context))
         api.initKVAPI(KV(context, config.label))
+        api.initGeolocationAPI(Geolocation(context))
+        api.initNotificationsAPI(Notifications(context))
 
-        newContext.setCapacitorAPI(api)
-
+        val newContext  = runner.createContext(contextName, api)
         newContext.execute(srcFile, false)
 
         return newContext
     }
+
+    private fun destroyContext(context: Context) {
+        val runner = this.runner ?: throw Exception("runner is not started")
+
+        runner.destroyContext(context.name)
+    }
 }

package/android/src/main/java/io/ionic/backgroundrunner/plugin/BackgroundRunnerPlugin.kt

@@ -12,13 +12,14 @@ import com.getcapacitor.annotation.PermissionCallback
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
 
 
 @CapacitorPlugin(
     name = "BackgroundRunner",
     permissions = [
         Permission(
-            strings = [Manifest.permission.ACCESS_COARSE_LOCATION],
+            strings = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION],
             alias = BackgroundRunnerPlugin.GEOLOCATION
         ),
         Permission(
@@ -35,16 +36,28 @@ class BackgroundRunnerPlugin: Plugin() {
         const val NOTIFICATIONS = "notifications"
     }
 
+    override fun handleOnPause() {
+        super.handleOnPause()
+        Log.d("Background Runner", "registering runner workers")
+        impl?.scheduleBackgroundTask(this.context)
+    }
+
+    override fun handleOnStop() {
+        super.handleOnStop()
+        Log.d("Background Runner", "shutting down foreground runner")
+        impl?.shutdown()
+    }
+
+    override fun handleOnResume() {
+        super.handleOnResume()
+        Log.d("Background Runner", "starting foreground runner")
+        impl?.start()
+    }
+
     override fun load() {
         super.load()
-        impl = BackgroundRunner.getInstance(this.context)
-
-        bridge.app.setStatusChangeListener {
-            if (!it) {
-                Log.d("Background Runner", "registering runner workers")
-                impl?.scheduleBackgroundTask(this.context)
-            }
-        }
+        impl = BackgroundRunner(this.context)
+        impl?.start()
     }
 
     @PluginMethod
@@ -66,19 +79,22 @@ class BackgroundRunnerPlugin: Plugin() {
     @PluginMethod
     fun dispatchEvent(call: PluginCall) {
         try {
-            val impl = BackgroundRunner.getInstance(this.context)
+            val impl = this.impl ?: throw Exception("background runner not initialized")
 
             val runnerEvent = call.getString("event") ?: throw Exception("event is missing or invalid")
             val details = call.getObject("details")
             val config = impl.config ?: throw Exception("no runner config loaded")
-            config.event = runnerEvent
 
-            GlobalScope.launch(Dispatchers.Default) {
+            val runningConfig = config.copy()
+            runningConfig.event = runnerEvent
+
+            runBlocking(Dispatchers.IO) {
                 try {
                     val returnData = impl.execute(
                         this@BackgroundRunnerPlugin.context,
-                        config,
-                        details
+                        runningConfig,
+                        details,
+                        call.callbackId
                     )
 
                     if (returnData != null) {

package/android/src/main/java/io/ionic/backgroundrunner/plugin/RunnerConfig.kt

@@ -3,31 +3,36 @@ package io.ionic.backgroundrunner.plugin;
 import org.json.JSONObject
 import java.lang.Exception
 
-class RunnerConfig(configObject: JSONObject) {
-    val label: String
-    val src: String
-    val autoSchedule: Boolean
-    val repeats: Boolean
-    var event: String
-    val interval: Int?
-
-    init {
-        val labelStr = configObject.getString("label")
-        if (labelStr.isNullOrEmpty()) {
-            throw Exception("runner label is missing or invalid")
-        }
+data class RunnerConfig( val label: String,
+                         val src: String,
+                         val autoSchedule: Boolean,
+                         val repeats: Boolean,
+                         var event: String,
+                         val interval: Int?) {
 
-        val srcStr = configObject.getString("src")
-        if (srcStr.isNullOrEmpty()) {
-            throw Exception("runner source file path is missing or invalid")
-        }
 
-        label = labelStr
-        src = srcStr
-        autoSchedule = configObject.optBoolean("autoStart", false)
-        event = configObject.optString("event")
-        repeats = configObject.optBoolean("repeat")
-        interval = configObject.optInt("interval", 0)
+    companion object {
+        fun fromJSON(configObject: JSONObject): RunnerConfig {
+            val labelStr = configObject.getString("label")
+            if (labelStr.isNullOrEmpty()) {
+                throw Exception("runner label is missing or invalid")
+            }
+
+            val srcStr = configObject.getString("src")
+            if (srcStr.isNullOrEmpty()) {
+                throw Exception("runner source file path is missing or invalid")
+            }
+
+            return RunnerConfig(
+                labelStr,
+                srcStr,
+                configObject.optBoolean("autoStart", false),
+                configObject.optBoolean("repeat"),
+                configObject.optString("event"),
+                configObject.optInt("interval", 0)
+            )
+        }
     }
+
 }
 

package/android/src/main/java/io/ionic/backgroundrunner/plugin/RunnerWorker.kt

@@ -1,6 +1,7 @@
 package io.ionic.backgroundrunner.plugin;
 
 import android.content.Context
+import android.util.Log
 import androidx.work.Data
 import androidx.work.Worker
 import androidx.work.WorkerParameters
@@ -27,15 +28,20 @@ class RunnerWorker(context: Context, workerParams: WorkerParameters) : Worker(co
             runnerConfigObj.put("repeats", false)
             runnerConfigObj.put("interval", 0)
 
-            val config = RunnerConfig(runnerConfigObj)
+            val config = RunnerConfig.fromJSON(runnerConfigObj)
 
             runBlocking {
-                val impl = BackgroundRunner.getInstance(this@RunnerWorker.applicationContext)
+                val impl = BackgroundRunner(this@RunnerWorker.applicationContext)
+                impl.start()
                 impl.execute(this@RunnerWorker.applicationContext, config, JSONObject())
+                impl.shutdown()
             }
 
             return Result.success()
         } catch (ex: Exception) {
+            val label = this.inputData.getString("label") ?: ""
+            Log.e("[RUNNER WORKER for $label]", ex.toString())
+            ex.printStackTrace()
             val data = Data.Builder()
                 .putString("error", ex.toString())
                 .build()

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Device.kt

@@ -8,10 +8,9 @@ import android.net.Network
 import android.net.NetworkCapabilities
 import android.os.BatteryManager
 import android.os.Build
-import io.ionic.android_js_engine.api.DeviceAPI
+import io.ionic.android_js_engine.capacitor_api.DeviceAPI
 import org.json.JSONObject
 
-
 class Device (context: android.content.Context) : DeviceAPI {
     private val context: android.content.Context
     private val connectivityManager: ConnectivityManager

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Geolocation.kt

@@ -4,7 +4,7 @@ import android.content.Context
 import android.location.Location
 import android.location.LocationManager
 import androidx.core.location.LocationManagerCompat
-import io.ionic.android_js_engine.api.GeolocationAPI
+import io.ionic.android_js_engine.capacitor_api.GeolocationAPI
 import org.json.JSONObject
 import java.lang.Exception
 

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/KV.kt

@@ -2,7 +2,7 @@ package io.ionic.backgroundrunner.plugin.api
 
 import android.content.Context
 import android.content.SharedPreferences
-import io.ionic.android_js_engine.api.KVAPI
+import io.ionic.android_js_engine.capacitor_api.KVAPI
 
 class KV (context: android.content.Context, label: String) : KVAPI {
     private val prefs: SharedPreferences

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Notifications.kt

@@ -13,14 +13,15 @@ import android.net.Uri
 import android.os.Build
 import androidx.core.app.NotificationCompat
 import androidx.core.app.NotificationManagerCompat
-import com.getcapacitor.Logger.config
+import com.getcapacitor.CapConfig
 import com.getcapacitor.plugin.util.AssetUtil
-import io.ionic.android_js_engine.api.NotificationsAPI
+import io.ionic.android_js_engine.capacitor_api.NotificationsAPI
 import org.json.JSONArray
 
 class Notifications(context: Context) : NotificationsAPI {
     private val manager: NotificationManagerCompat
     private val context: Context
+    private val config: CapConfig
 
     var defaultSmallIconID = AssetUtil.RESOURCE_ID_ZERO_VALUE
     var defaultSoundID = AssetUtil.RESOURCE_ID_ZERO_VALUE
@@ -28,6 +29,7 @@ class Notifications(context: Context) : NotificationsAPI {
     init {
         this.context = context
         this.manager = NotificationManagerCompat.from(context)
+        this.config = CapConfig.loadDefault(context)
 
         this.createNotificationChannel()
     }

package/dist/docs-api.json

@@ -482,7 +482,7 @@
       "methods": [],
       "properties": [
         {
-          "name": "getCurrentLocation",
+          "name": "getCurrentPosition",
           "tags": [
             {
               "text": "1.0.0",

package/dist/docs.json

@@ -48,7 +48,7 @@
       },
       {
         "name": "dispatchEvent",
-        "signature": "(options: DispatchEventOptions) => any",
+        "signature": "<T = void>(options: DispatchEventOptions) => any",
         "parameters": [
           {
             "name": "options",
@@ -69,7 +69,8 @@
         ],
         "docs": "Dispatches an event to the configured runner.",
         "complexTypes": [
-          "DispatchEventOptions"
+          "DispatchEventOptions",
+          "T"
         ],
         "slug": "dispatchevent"
       }

package/dist/esm/apis.d.ts

@@ -249,7 +249,7 @@ export interface CapacitorGeolocation {
      * Get the device's last known location
      * @since 1.0.0
      */
-    getCurrentLocation: () => GetCurrentPositionResult;
+    getCurrentPosition: () => GetCurrentPositionResult;
 }
 /**
  * A simple string key / value store backed by UserDefaults on iOS and Shared Preferences on Android.

package/dist/esm/apis.js.map

@@ -1 +1 @@
-{"version":3,"file":"apis.js","sourceRoot":"","sources":["../../src/apis.ts"],"names":[],"mappings":"","sourcesContent":["export interface GetCurrentPositionResult {\n  /**\n   * Latitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  latitude: number;\n  /**\n   * longitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  longitude: number;\n  /**\n   * Accuracy level of the latitude and longitude coordinates in meters\n   *\n   * @since 1.0.0\n   */\n  accuracy: number;\n  /**\n   * The altitude the user is at (if available)\n   *\n   * @since 1.0.0\n   */\n  altitude: number | null;\n  /**\n   * Accuracy level of the altitude coordinate in meters, if available.\n   *\n   * Available on all iOS versions and on Android 8.0+.\n   *\n   * @since 1.0.0\n   */\n  altitudeAccuracy?: number | null | undefined;\n  /**\n   * The speed the user is traveling (if available)\n   *\n   * @since 1.0.0\n   */\n  speed: number | null;\n  /**\n   * The heading the user is facing (if available)\n   *\n   * @since 1.0.0\n   */\n  heading: number | null;\n}\n\nexport interface BatteryStatus {\n  batteryLevel: number;\n  isCharging: boolean;\n}\n\nexport interface NetworkStatus {\n  connected: boolean;\n  connectionType: string;\n}\n\nexport interface NotificationScheduleOptions {\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n  /**\n   * Date to send this notification.\n   *\n   * @since 1.0.0\n   */\n  scheduleAt: Date;\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android < 26.\n   * For Android 26+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  summaryArgument?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: string;\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 26+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n}\n\n/**\n * Get access to device location information.\n *\n * @since 1.0.0\n */\nexport interface CapacitorGeolocation {\n  /**\n   * Get the device's last known location\n   * @since 1.0.0\n   */\n  getCurrentLocation: () => GetCurrentPositionResult;\n}\n\n/**\n * A simple string key / value store backed by UserDefaults on iOS and Shared Preferences on Android.\n */\nexport interface CapacitorKV {\n  /**\n   * Set a string value with the given key.\n   *\n   * @param key\n   * @param value\n   * @returns\n   * @since 1.0.0\n   */\n  set: (key: string, value: string) => void;\n  /**\n   * Get a string value for the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  get: (key: string) => { value: string };\n  /**\n   * Remove a value with the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  remove: (key: string) => void;\n}\n\n/**\n * Get information on the device, such as network connectivity and battery status.\n */\nexport interface CapacitorDevice {\n  /**\n   * Get the current battery status for the device.\n   *\n   * @since 1.0.0\n   */\n  getBatteryStatus: () => BatteryStatus;\n  /**\n   * Get the current network status for the device.\n   *\n   * @since 1.0.0\n   */\n  getNetworkStatus: () => NetworkStatus;\n}\n\n/**\n * Send basic local notifications.\n */\nexport interface CapacitorNotifications {\n  /**\n   * Schedule a local notification\n   * @example `CapacitorNotifications.schedule()`\n   * @param options\n   * @returns void\n   * @since 1.0.0\n   */\n  schedule: (options: NotificationScheduleOptions[]) => void;\n}\n\n/**\n * Interact with a watch paired with this app\n *\n * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.\n * They could be used if a native watch app is developed as a companion app to a Capacitor app\n */\nexport interface CapcacitorWatch {\n  /**\n   * Sends a message to the watch with the sendMessage() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  sendMessage: (options: []) => void;\n  /**\n   * Sends information to the watch with the transferUserInfo() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  transferUserInfo: (options: []) => void;\n  /**\n   * Updates the application context on the watch with the updateApplicationContext() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  updateApplicationContext: (options: []) => void;\n  /**\n   * Checks to see if the compaion watch is reachable\n   */\n  isReachable: boolean;\n  /**\n   * Replaces the current UI on the watch with what is specified here.\n   * @param options the new WatchUI you want to show on the watch\n   * @returns void\n   */\n  updateWatchUI: (options: { watchUI: string }) => void;\n  /**\n   * Updates the data the watch is using to display variables in text and button fields\n   * @param options the new data to send to the watch\n   * @returns void\n   */\n  updateWatchData: (options: { data: { [key: string]: string } }) => void;\n}\n\nexport interface CapacitorAPI {\n  CapacitorDevice: CapacitorDevice;\n  CapacitorKV: CapacitorKV;\n  CapacitorNotifications: CapacitorNotifications;\n  CapacitorGeolocation: CapacitorGeolocation;\n  CapacitorWatch: CapcacitorWatch;\n}\n"]}
+{"version":3,"file":"apis.js","sourceRoot":"","sources":["../../src/apis.ts"],"names":[],"mappings":"","sourcesContent":["export interface GetCurrentPositionResult {\n  /**\n   * Latitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  latitude: number;\n  /**\n   * longitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  longitude: number;\n  /**\n   * Accuracy level of the latitude and longitude coordinates in meters\n   *\n   * @since 1.0.0\n   */\n  accuracy: number;\n  /**\n   * The altitude the user is at (if available)\n   *\n   * @since 1.0.0\n   */\n  altitude: number | null;\n  /**\n   * Accuracy level of the altitude coordinate in meters, if available.\n   *\n   * Available on all iOS versions and on Android 8.0+.\n   *\n   * @since 1.0.0\n   */\n  altitudeAccuracy?: number | null | undefined;\n  /**\n   * The speed the user is traveling (if available)\n   *\n   * @since 1.0.0\n   */\n  speed: number | null;\n  /**\n   * The heading the user is facing (if available)\n   *\n   * @since 1.0.0\n   */\n  heading: number | null;\n}\n\nexport interface BatteryStatus {\n  batteryLevel: number;\n  isCharging: boolean;\n}\n\nexport interface NetworkStatus {\n  connected: boolean;\n  connectionType: string;\n}\n\nexport interface NotificationScheduleOptions {\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n  /**\n   * Date to send this notification.\n   *\n   * @since 1.0.0\n   */\n  scheduleAt: Date;\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android < 26.\n   * For Android 26+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  summaryArgument?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: string;\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 26+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n}\n\n/**\n * Get access to device location information.\n *\n * @since 1.0.0\n */\nexport interface CapacitorGeolocation {\n  /**\n   * Get the device's last known location\n   * @since 1.0.0\n   */\n  getCurrentPosition: () => GetCurrentPositionResult;\n}\n\n/**\n * A simple string key / value store backed by UserDefaults on iOS and Shared Preferences on Android.\n */\nexport interface CapacitorKV {\n  /**\n   * Set a string value with the given key.\n   *\n   * @param key\n   * @param value\n   * @returns\n   * @since 1.0.0\n   */\n  set: (key: string, value: string) => void;\n  /**\n   * Get a string value for the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  get: (key: string) => { value: string };\n  /**\n   * Remove a value with the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  remove: (key: string) => void;\n}\n\n/**\n * Get information on the device, such as network connectivity and battery status.\n */\nexport interface CapacitorDevice {\n  /**\n   * Get the current battery status for the device.\n   *\n   * @since 1.0.0\n   */\n  getBatteryStatus: () => BatteryStatus;\n  /**\n   * Get the current network status for the device.\n   *\n   * @since 1.0.0\n   */\n  getNetworkStatus: () => NetworkStatus;\n}\n\n/**\n * Send basic local notifications.\n */\nexport interface CapacitorNotifications {\n  /**\n   * Schedule a local notification\n   * @example `CapacitorNotifications.schedule()`\n   * @param options\n   * @returns void\n   * @since 1.0.0\n   */\n  schedule: (options: NotificationScheduleOptions[]) => void;\n}\n\n/**\n * Interact with a watch paired with this app\n *\n * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.\n * They could be used if a native watch app is developed as a companion app to a Capacitor app\n */\nexport interface CapcacitorWatch {\n  /**\n   * Sends a message to the watch with the sendMessage() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  sendMessage: (options: []) => void;\n  /**\n   * Sends information to the watch with the transferUserInfo() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  transferUserInfo: (options: []) => void;\n  /**\n   * Updates the application context on the watch with the updateApplicationContext() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  updateApplicationContext: (options: []) => void;\n  /**\n   * Checks to see if the compaion watch is reachable\n   */\n  isReachable: boolean;\n  /**\n   * Replaces the current UI on the watch with what is specified here.\n   * @param options the new WatchUI you want to show on the watch\n   * @returns void\n   */\n  updateWatchUI: (options: { watchUI: string }) => void;\n  /**\n   * Updates the data the watch is using to display variables in text and button fields\n   * @param options the new data to send to the watch\n   * @returns void\n   */\n  updateWatchData: (options: { data: { [key: string]: string } }) => void;\n}\n\nexport interface CapacitorAPI {\n  CapacitorDevice: CapacitorDevice;\n  CapacitorKV: CapacitorKV;\n  CapacitorNotifications: CapacitorNotifications;\n  CapacitorGeolocation: CapacitorGeolocation;\n  CapacitorWatch: CapcacitorWatch;\n}\n"]}

package/dist/esm/definitions.d.ts

@@ -140,7 +140,7 @@ export interface BackgroundRunnerPlugin {
      * @param options
      * @since 1.0.0
      */
-    dispatchEvent(options: DispatchEventOptions): Promise<void>;
+    dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;
 }
 declare module '@capacitor/cli' {
     interface PluginsConfig {

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(options: DispatchEventOptions): Promise<void>;\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 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"]}

package/dist/esm/web.d.ts

@@ -1,8 +1,8 @@
 import { WebPlugin } from '@capacitor/core';
-import type { BackgroundRunnerPlugin, PermissionStatus } from './definitions';
+import type { BackgroundRunnerPlugin, DispatchEventOptions, PermissionStatus } from './definitions';
 export declare class BackgroundRunnerWeb extends WebPlugin implements BackgroundRunnerPlugin {
     checkPermissions(): Promise<PermissionStatus>;
     requestPermissions(): Promise<PermissionStatus>;
     registerBackgroundTask(): Promise<void>;
-    dispatchEvent(): Promise<void>;
+    dispatchEvent<T = void>(_options: DispatchEventOptions): Promise<T>;
 }

package/dist/esm/web.js

@@ -9,7 +9,7 @@ export class BackgroundRunnerWeb extends WebPlugin {
     registerBackgroundTask() {
         throw new Error('not available on web');
     }
-    dispatchEvent() {
+    dispatchEvent(_options) {
         throw new Error('not available on web');
     }
 }

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,mBACX,SAAQ,SAAS;IAGjB,gBAAgB;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,sBAAsB;QACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa;QACX,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { BackgroundRunnerPlugin, PermissionStatus } from './definitions';\n\nexport class BackgroundRunnerWeb\n  extends WebPlugin\n  implements BackgroundRunnerPlugin\n{\n  checkPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  requestPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  registerBackgroundTask(): Promise<void> {\n    throw new Error('not available on web');\n  }\n\n  dispatchEvent(): Promise<void> {\n    throw new Error('not available on web');\n  }\n}\n"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ5C,MAAM,OAAO,mBACX,SAAQ,SAAS;IAGjB,gBAAgB;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,sBAAsB;QACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa,CAAW,QAA8B;QACpD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  BackgroundRunnerPlugin,\n  DispatchEventOptions,\n  PermissionStatus,\n} from './definitions';\n\nexport class BackgroundRunnerWeb\n  extends WebPlugin\n  implements BackgroundRunnerPlugin\n{\n  checkPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  requestPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  registerBackgroundTask(): Promise<void> {\n    throw new Error('not available on web');\n  }\n\n  dispatchEvent<T = void>(_options: DispatchEventOptions): Promise<T> {\n    throw new Error('not available on web');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -18,7 +18,7 @@ class BackgroundRunnerWeb extends core.WebPlugin {
     registerBackgroundTask() {
         throw new Error('not available on web');
     }
-    dispatchEvent() {
+    dispatchEvent(_options) {
         throw new Error('not available on web');
     }
 }

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;AAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;AACnD,IAAI,gBAAgB,GAAG;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,kBAAkB,GAAG;AACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,sBAAsB,GAAG;AAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,aAAa,GAAG;AACpB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL;;;;;;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;AAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;AACnD,IAAI,gBAAgB,GAAG;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,kBAAkB,GAAG;AACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,sBAAsB,GAAG;AAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,aAAa,CAAC,QAAQ,EAAE;AAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL;;;;;;;;;"}

package/dist/plugin.js

@@ -15,7 +15,7 @@ var capacitorBackgroundRunner = (function (exports, core) {
         registerBackgroundTask() {
             throw new Error('not available on web');
         }
-        dispatchEvent() {
+        dispatchEvent(_options) {
             throw new Error('not available on web');
         }
     }

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;IAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;IACnD,IAAI,gBAAgB,GAAG;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,kBAAkB,GAAG;IACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,sBAAsB,GAAG;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,aAAa,GAAG;IACpB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;IAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;IACnD,IAAI,gBAAgB,GAAG;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,kBAAkB,GAAG;IACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,sBAAsB,GAAG;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,aAAa,CAAC,QAAQ,EAAE;IAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL;;;;;;;;;;;;;;;;;"}

package/ios/Plugin/BackgroundRunner.swift

@@ -6,18 +6,13 @@ import JavaScriptCore
 public class BackgroundRunner {
     public static let shared = BackgroundRunner()
 
-    private var runner: Runner?
     private var config: RunnerConfig?
-
-    private var context: Context?
-
-    private var started: Bool {
-        return runner != nil && context != nil
-    }
+    private var runner = Runner()
 
     public init() {
         do {
             config = try self.loadRunnerConfig()
+            runner.start()
         } catch {
             print("could not initialize BackgroundRunner: \(error)")
         }
@@ -76,40 +71,11 @@ public class BackgroundRunner {
         }
     }
 
-    public func start() throws {
-        print("starting runner and loading contexts...")
-
-        guard let config = config else {
-            print("...no runner config to start")
-            return
-        }
-
-        self.runner = Runner()
-        context = try initContext(config: config)
-
-    }
-
-    public func stop() {
-        print("...stopping runner and removing all contexts")
-        guard let runner = runner, let config = config else {
-            return
-        }
-
-        runner.destroyContext(name: config.label)
-
-        context = nil
-        self.runner = nil
-    }
-
     public func getConfig() -> RunnerConfig? {
         return config
     }
 
-    public func dispatchEvent(event: String, inputArgs: [String: Any]?) throws {
-        if !started {
-            try start()
-        }
-
+    public func dispatchEvent(event: String, inputArgs: [String: Any]?, callbackId: String? = nil) throws {
         if let config = config {
             let waitGroup = DispatchGroup()
             waitGroup.enter()
@@ -119,7 +85,7 @@ public class BackgroundRunner {
             // swiftlint:disable:next unowned_variable_capture
             DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
                 do {
-                    _ = try self.execute(config: config, event: event, inputArgs: inputArgs)
+                    _ = try self.execute(config: config, event: event, inputArgs: inputArgs, callbackId: callbackId)
                 } catch {
                     err = error
                     print("[\(config.label)]: \(error)")
@@ -137,15 +103,9 @@ public class BackgroundRunner {
     }
 
     // swiftlint:disable:next cyclomatic_complexity function_body_length
-    public func execute(config: RunnerConfig, event: String, inputArgs: [String: Any]? = nil) throws -> [String: Any]? {
+    public func execute(config: RunnerConfig, event: String, inputArgs: [String: Any]? = nil, callbackId: String? = nil) throws -> [String: Any]? {
         do {
-            if !started {
-                try self.start()
-            }
-
-            guard let context = context else {
-                throw BackgroundRunnerPluginError.runnerError(reason: "no loaded context for config")
-            }
+            let context = try initContext(config: config, callbackId: callbackId)
 
             let waitGroup = DispatchGroup()
 
@@ -241,18 +201,19 @@ public class BackgroundRunner {
         return nil
     }
 
-    private func initContext(config: RunnerConfig) throws -> Context {
-        guard let runner = runner else {
-            throw BackgroundRunnerPluginError.runnerError(reason: "runner is not initialized")
-        }
-
+    private func initContext(config: RunnerConfig, callbackId: String?) throws -> Context {
         guard let srcFileURL = Bundle.main.url(forResource: config.src, withExtension: nil, subdirectory: "public") else {
             throw BackgroundRunnerPluginError.runnerError(reason: "source file not found")
         }
 
+        var contextName = config.label
+        if let callbackId = callbackId {
+            contextName = "\(contextName)-\(callbackId)"
+        }
+
         let srcFile = try String(contentsOf: srcFileURL)
 
-        let context = try runner.createContext(name: config.label)
+        let context = try runner.createContext(name: contextName)
 
         context.setupCapacitorAPI()
 

package/ios/Plugin/BackgroundRunnerPlugin.swift

@@ -70,7 +70,8 @@ public class BackgroundRunnerPlugin: CAPPlugin {
                     let result = try self.impl.execute(
                         config: config,
                         event: runnerEvent,
-                        inputArgs: details as [String: Any]
+                        inputArgs: details as [String: Any],
+                        callbackId: call.callbackId
                     )
 
                     if let result = result {

package/ios/Plugin/Context+CapacitorAPI.swift

@@ -2,10 +2,10 @@ import Foundation
 
 extension Context {
     public func setupCapacitorAPI() {
-        ctx.setObject(CapacitorKVStore.self, forKeyedSubscript: "CapacitorKV" as NSString)
-        ctx.setObject(CapacitorGeolocation(context: self), forKeyedSubscript: "CapacitorGeolocation" as NSString)
-        ctx.setObject(CapacitorWatch(), forKeyedSubscript: "CapacitorWatch" as NSString)
-        ctx.setObject(CapacitorNotifications.self, forKeyedSubscript: "CapacitorNotifications" as NSString)
-        ctx.setObject(CapacitorDevice(), forKeyedSubscript: "CapacitorDevice" as NSString)
+        jsContext.setObject(CapacitorKVStore.self, forKeyedSubscript: "CapacitorKV" 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(CapacitorDevice(), forKeyedSubscript: "CapacitorDevice" as NSString)
     }
 }

package/ios/Plugin/RunnerEngine/Context.swift

@@ -3,37 +3,21 @@ import JavaScriptCore
 
 public class Context {
     let name: String
-    let ctx: JSContext
+    let jsContext: JSContext
 
-    private var timers = [Int: Timer]()
     private var eventListeners = [String: JSValue]()
-    private var thread: Thread!
-    private var runLoop: RunLoop?
+    private var timers = [Int: Timer]()
+    private weak var runLoop: RunLoop?
 
     // swiftlint:disable:next identifier_name
-    public init(vm: JSVirtualMachine, ctxName: String) throws {
-        guard let newCtx = JSContext(virtualMachine: vm) else {
+    public init(vm: JSVirtualMachine, contextName: String, runLoop: RunLoop) throws {
+        guard let jsContext = JSContext(virtualMachine: vm) else {
             throw EngineError.jsCoreError
         }
 
-        newCtx.name = ctxName
-
-        name = ctxName
-        ctx = newCtx
-
-        thread = Thread { [weak self] in
-            self?.runLoop = RunLoop.current
-
-            while self != nil && !self!.thread.isCancelled && self!.runLoop != nil {
-                self?.runLoop?.run(mode: .default, before: .distantFuture)
-            }
-
-            Thread.exit()
-        }
-
-        thread.name = "[\(name)] context thread"
-        thread.qualityOfService = .userInitiated
-        thread.start()
+        self.name = contextName
+        self.jsContext = jsContext
+        self.runLoop = runLoop
 
         try setupWebAPI()
     }
@@ -41,11 +25,11 @@ public class Context {
     public func execute(code: String) throws -> JSValue? {
         var thrownException: JSValue?
 
-        ctx.exceptionHandler = { _, exception in
+        jsContext.exceptionHandler = { _, exception in
             thrownException = exception
         }
 
-        let value = ctx.evaluateScript(code)
+        let value = jsContext.evaluateScript(code)
 
         if let exception = thrownException {
             throw EngineError.jsException(details: String(describing: exception))
@@ -67,14 +51,14 @@ public class Context {
                 callbacks.keys.forEach { key in
                     if key.hasPrefix("__cbr::") {
                         let funcName = key.replacingOccurrences(of: "__cbr::", with: "")
-                        callbackFunctions[funcName] = JSValue.init(object: callbacks[key], in: self.ctx)
+                        callbackFunctions[funcName] = JSValue.init(object: callbacks[key], in: self.jsContext)
                     }
                 }
             }
 
             var thrownException: JSValue?
 
-            self.ctx.exceptionHandler = { _, exception in
+            self.jsContext.exceptionHandler = { _, exception in
                 thrownException = exception
             }
 
@@ -87,7 +71,7 @@ public class Context {
             }
 
             if let dataArgs = dataArgs {
-                guard let jsDataArgs = JSValue(object: dataArgs, in: self.ctx) else {
+                guard let jsDataArgs = JSValue(object: dataArgs, in: self.jsContext) else {
                     throw EngineError.jsValueError
                 }
 
@@ -99,9 +83,9 @@ public class Context {
             if let exception = thrownException {
                 throw EngineError.jsException(details: String(describing: exception))
             }
-
         }
     }
+
     private func setupWebAPI() throws {
         let consoleObj = JSConsole(name: name)
         let addEventListenerFunc: @convention(block)(String, JSValue) -> Void = { type, listener in
@@ -123,16 +107,16 @@ public class Context {
         let newTextEncoderConst: @convention(block) () -> JSTextEncoder = JSTextEncoder.init
         let newTextDecoderConst: @convention(block) (String?, [AnyHashable: Any]?) -> JSTextDecoder = JSTextDecoder.init
 
-        ctx.setObject(consoleObj, forKeyedSubscript: "console" as NSString)
-        ctx.setObject(fetchFunc, forKeyedSubscript: "fetch" as NSString)
-        ctx.setObject(JSCrypto.self, forKeyedSubscript: "crypto" as NSString)
-        ctx.setObject(addEventListenerFunc, forKeyedSubscript: "addEventListener" as NSString)
-        ctx.setObject(setTimeoutFunc, forKeyedSubscript: "setTimeout" as NSString)
-        ctx.setObject(setIntervalFunc, forKeyedSubscript: "setInterval" as NSString)
-        ctx.setObject(clearTimeoutFunc, forKeyedSubscript: "clearTimeout" as NSString)
-        ctx.setObject(clearTimeoutFunc, forKeyedSubscript: "clearInterval" as NSString)
-        ctx.setObject(newTextEncoderConst, forKeyedSubscript: "TextEncoder" as NSString)
-        ctx.setObject(newTextDecoderConst, forKeyedSubscript: "TextDecoder" as NSString)
+        jsContext.setObject(consoleObj, forKeyedSubscript: "console" as NSString)
+        jsContext.setObject(fetchFunc, forKeyedSubscript: "fetch" as NSString)
+        jsContext.setObject(JSCrypto.self, forKeyedSubscript: "crypto" as NSString)
+        jsContext.setObject(addEventListenerFunc, forKeyedSubscript: "addEventListener" as NSString)
+        jsContext.setObject(setTimeoutFunc, forKeyedSubscript: "setTimeout" as NSString)
+        jsContext.setObject(setIntervalFunc, forKeyedSubscript: "setInterval" as NSString)
+        jsContext.setObject(clearTimeoutFunc, forKeyedSubscript: "clearTimeout" as NSString)
+        jsContext.setObject(clearTimeoutFunc, forKeyedSubscript: "clearInterval" as NSString)
+        jsContext.setObject(newTextEncoderConst, forKeyedSubscript: "TextEncoder" as NSString)
+        jsContext.setObject(newTextDecoderConst, forKeyedSubscript: "TextDecoder" as NSString)
 
     }
 
@@ -141,7 +125,9 @@ public class Context {
     }
 
     private func initTimer(callback: JSValue, timeout: Int, isInterval: Bool) -> Int {
-        let timer = Timer(timeInterval: TimeInterval(timeout / 1000), repeats: isInterval) { t in
+        let timer = Timer(timeInterval: TimeInterval(timeout / 1000), repeats: isInterval) { [weak self] t in
+            guard let self = self else { return }
+
             callback.call(withArguments: [])
             if !isInterval {
                 let timerId = Int(Int32.init(truncatingIfNeeded: t.hashValue))
@@ -155,9 +141,6 @@ public class Context {
         if let runLoop = self.runLoop {
             runLoop.add(timer, forMode: .default)
             runLoop.add(timer, forMode: .common)
-        } else {
-            RunLoop.current.add(timer, forMode: .default)
-            RunLoop.current.add(timer, forMode: .common)
         }
 
         return timerId

package/ios/Plugin/RunnerEngine/Errors.swift

@@ -5,4 +5,5 @@ public enum EngineError: Error {
     case jsValueError
     case sourceNotFound
     case jsException(details: String)
+    case runnerError(details: String)
 }

package/ios/Plugin/RunnerEngine/Runner.swift

@@ -4,20 +4,60 @@ 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 ctx = try Context(vm: machine, ctxName: name)
+        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] = ctx
+        contexts[name] = context
 
-        return ctx
+        return context
     }
 
     func destroyContext(name: String) {
         contexts.removeValue(forKey: name)
     }
+
+    func start() {
+        thread = Thread { [weak self] in
+            defer {
+                Thread.exit()
+            }
+
+            guard let self = self else { return }
+            guard let thread = self.thread else { return }
+
+            while !thread.isCancelled {
+                self.runLoop.run(mode: .default, before: .distantFuture)
+            }
+        }
+
+        thread?.qualityOfService = .userInitiated
+        thread?.start()
+    }
+
+    func stop() {
+        guard let thread = self.thread else {
+            return
+        }
+
+        thread.cancel()
+        while !thread.isFinished {
+            Thread.sleep(forTimeInterval: 0.05)
+        }
+
+        self.thread = nil
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/background-runner",
-  "version": "1.0.6-dev-20230831T174057.0",
+  "version": "1.0.6-dev-20240409T144959.0",
   "description": "Capacitor Background Runner",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -42,7 +42,7 @@
     "docgen-api": "docgen --api CapacitorAPI --output-readme API.md --output-json dist/docs-api.json && node ./scripts/combine_docs.js",
     "build-sdk": "./scripts/build-native-sdks.sh",
     "build": "npm run clean && npm run docgen && npm run docgen-api && tsc && rollup -c rollup.config.js && npm run build-sdk && ./scripts/copy-native-sdks.sh && npm pack && mv ./capacitor-background-runner-*.tgz ../../ && ./scripts/copy-readme.sh",
-    "pack": "npm run build && && ./scripts/copy-native-sdks.sh && npm pack && mv ./capacitor-background-runner-*.tgz ../../",
+    "pack": "npm run build && ./scripts/copy-native-sdks.sh && npm pack && mv ./capacitor-background-runner-*.tgz ../../",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build",
@@ -81,5 +81,5 @@
       "src": "android"
     }
   },
-  "gitHead": "1f8633987278f10280966ca7a560211973d4104d"
+  "gitHead": "18f72b6c17bb83bb0e9dde3b0b4c1d3db5309b0d"
 }

package/scripts/install_libs.js

@@ -1,6 +1,8 @@
 const fs = require('fs');
 const path = require('path');
 
+const msgPrefix = '[@capacitor/background-runner]';
+
 let workingDir = process.env.INIT_CWD;
 if (!workingDir) {
   workingDir = '.';
@@ -8,23 +10,43 @@ if (!workingDir) {
 
 if (!fs.existsSync(path.join(workingDir, 'android'))) {
   console.warn(
-    'cannot install android-js-engine library: @capacitor/android not installed, or in wrong parent directory.',
+    `${msgPrefix} cannot install android-js-engine library: @capacitor/android not installed, or in wrong parent directory.`,
   );
   return;
 }
 
-const releaseAARPath = path.join(
-  'android/src/main/libs/android-js-engine-release.aar',
-);
+const androidGradlePath = path.join(workingDir, 'android/app/build.gradle');
+
+if (!fs.existsSync(androidGradlePath)) {
+  console.warn(`${msgPrefix} android build.gradle file not found`);
+  return;
+}
 
-const fullPath = path.join(workingDir, 'android/app/libs');
-if (!fs.existsSync(fullPath)) {
-  fs.mkdirSync(fullPath);
+const searchText =
+  "dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'";
+const insertText =
+  "\n\t\tdirs '../../node_modules/@capacitor/background-runner/android/src/main/libs', 'libs'";
+
+let gradleFile = fs.readFileSync(androidGradlePath).toString('utf-8');
+if (gradleFile.indexOf(insertText) != -1) {
+  return;
 }
 
-fs.copyFileSync(
-  releaseAARPath,
-  path.join(fullPath, 'android-js-engine-release.aar'),
+let insertIndex = gradleFile.indexOf(searchText) + searchText.length;
+gradleFile =
+  gradleFile.substring(0, insertIndex) +
+  insertText +
+  gradleFile.substring(insertIndex);
+
+fs.writeFileSync(androidGradlePath, gradleFile);
+
+// remove old version of aar
+const oldReleaseAARPath = path.join(
+  workingDir,
+  'android/src/main/libs/android-js-engine-release.aar',
 );
+if (fs.existsSync(oldReleaseAARPath)) {
+  fs.rmSync(oldReleaseAARPath);
+}
 
-console.log(`copied android-js-engine-release.aar to ${fullPath}`);
+console.log(`${msgPrefix} installed lib path to gradle repositories`);