@tokamakdev/plugin-location 0.1.0-beta.131 → 0.1.0-beta.133

package/android/Exports.generated.kt

@@ -7,6 +7,7 @@ import com.tokamak.runtime.TokamakHost
 import com.tokamak.runtime.TokamakPluginBytesReply
 import com.tokamak.runtime.TokamakPluginError
 import com.tokamak.runtime.TokamakValue
+import com.tokamak.runtime.jsonName
 import kotlin.reflect.KClass
 import org.json.JSONArray
 import org.json.JSONObject
@@ -142,9 +143,9 @@ class TokamakLocationPluginDispatch(host: TokamakHost) : TokamakDispatch<Tokamak
 
         private fun json(value: LocationPermission): JSONObject =
             JSONObject()
-                .put("inUse", value.inUse.name)
-                .put("background", value.background.name)
-                .put("precision", value.precision.name)
+                .put("inUse", jsonName(value.inUse.name))
+                .put("background", jsonName(value.background.name))
+                .put("precision", jsonName(value.precision.name))
 
         private fun TokamakValue.asLocationUpdate(): LocationUpdate =
             LocationUpdate(
@@ -183,7 +184,7 @@ class TokamakLocationPluginDispatch(host: TokamakHost) : TokamakDispatch<Tokamak
         private fun json(value: PermissionRequest): JSONObject =
             JSONObject()
                 .putOpt("background", value.background)
-                .putOpt("precision", value.precision?.name)
+                .putOpt("precision", value.precision?.let { jsonName(it.name) })
 
         private fun TokamakValue.asPosition(): Position =
             Position(
@@ -225,7 +226,7 @@ class TokamakLocationPluginDispatch(host: TokamakHost) : TokamakDispatch<Tokamak
         private fun json(value: RegionTransition): JSONObject =
             JSONObject()
                 .put("id", value.id)
-                .put("transition", value.transition.name)
+                .put("transition", jsonName(value.transition.name))
                 .put("timestamp", value.timestamp)
 
         private fun TokamakValue.asServiceNotification(): ServiceNotification =
@@ -260,7 +261,7 @@ class TokamakLocationPluginDispatch(host: TokamakHost) : TokamakDispatch<Tokamak
 
         private fun json(value: UpdateOptions): JSONObject =
             JSONObject()
-                .putOpt("accuracy", value.accuracy?.name)
+                .putOpt("accuracy", value.accuracy?.let { jsonName(it.name) })
                 .putOpt("distance", value.distance)
                 .putOpt("interval", value.interval)
                 .putOpt("foregroundService", value.foregroundService?.let { json(it) })

package/android/LocationEvents.kt

@@ -36,7 +36,7 @@ internal class LocationEvents(private val host: TokamakHost) {
     }
 
     fun transition(id: String, entered: Boolean, finish: () -> Unit) {
-        val transition = RegionTransition(id, if (entered) Transition.enter else Transition.exit, System.currentTimeMillis())
+        val transition = RegionTransition(id, if (entered) Transition.Enter else Transition.Exit, System.currentTimeMillis())
         transitions.send(transition)
         send("region", transition, finish)
     }

package/android/LocationPlugin.kt

@@ -41,9 +41,9 @@ class TokamakLocationPlugin(
     /** Foreground location permissions, which the `precision` build setting declares. */
     private val foreground: Set<String> by lazy { setOf(COARSE, FINE).filter(declared::contains).toSet() }
 
-    private val updates = LocationUpdates(context, LocationUpdates.UPDATES)
-    private val significantChanges = LocationUpdates(context, LocationUpdates.SIGNIFICANT_CHANGES)
-    private val regions = LocationRegions(context)
+    private val updates = LocationUpdates(host, LocationUpdates.UPDATES)
+    private val significantChanges = LocationUpdates(host, LocationUpdates.SIGNIFICANT_CHANGES)
+    private val regions = LocationRegions(host)
     private val events = LocationEvents(host)
     private val positions = LocationPositions(context, manager)
 
@@ -89,10 +89,10 @@ class TokamakLocationPlugin(
 
     /** The app's in-use and background permission, and the precision it gets, or would get once allowed. */
     fun permission(): LocationPermission {
-        val inUse = if (hasForegroundPermission()) Permission.granted else state(COARSE)
-        val background = if (BACKGROUND in declared) state(BACKGROUND) else Permission.denied
+        val inUse = if (hasForegroundPermission()) Permission.Granted else state(COARSE)
+        val background = if (BACKGROUND in declared) state(BACKGROUND) else Permission.Denied
         val precise = granted(FINE) || (!granted(COARSE) && FINE in declared)
-        return LocationPermission(inUse, background, if (precise) Precision.precise else Precision.approximate)
+        return LocationPermission(inUse, background, if (precise) Precision.Precise else Precision.Approximate)
     }
 
     /**
@@ -104,7 +104,7 @@ class TokamakLocationPlugin(
         if (background && BACKGROUND !in declared) {
             throw TokamakPluginError.notSupported("Background location needs the location plugin's background build setting")
         }
-        val asked = if (request?.precision == Precision.approximate) setOf(COARSE) else foreground
+        val asked = if (request?.precision == Precision.Approximate) setOf(COARSE) else foreground
         val allowed = ask(asked).containsValue(true)
         if (allowed) restore(updatesRemoved = false)
         if (background && allowed) ask(setOf(BACKGROUND))
@@ -121,10 +121,11 @@ class TokamakLocationPlugin(
     /** Starts updates in the foreground service when [options] name one, which stops otherwise. On failure, none run. */
     fun startUpdates(options: UpdateOptions?) {
         val running = options ?: UpdateOptions(null, null, null, null)
+        val notification = running.foregroundService
         requirePermission()
-        if (running.foregroundService != null) requireService()
+        if (notification != null) requireService()
         try {
-            if (running.foregroundService == null) TokamakLocationService.stop(context) else TokamakLocationService.start(context, running)
+            if (notification == null) TokamakLocationService.stop(context) else TokamakLocationService.start(context, notification)
             updates.start(running)
         } catch (error: Exception) {
             stopUpdates()
@@ -167,9 +168,9 @@ class TokamakLocationPlugin(
 
     private fun state(permission: String): Permission =
         when {
-            granted(permission) -> Permission.granted
-            host.wouldPrompt(permission) -> Permission.prompt
-            else -> Permission.denied
+            granted(permission) -> Permission.Granted
+            host.wouldPrompt(permission) -> Permission.Prompt
+            else -> Permission.Denied
         }
 
     private fun requirePermission() {
@@ -177,7 +178,7 @@ class TokamakLocationPlugin(
     }
 
     private fun startService() {
-        updates.options?.takeIf { it.foregroundService != null }?.let { TokamakLocationService.start(context, it) }
+        updates.options?.foregroundService?.let { TokamakLocationService.start(context, it) }
     }
 
     /**
@@ -260,6 +261,6 @@ class TokamakLocationPlugin(
         const val BACKGROUND = Manifest.permission.ACCESS_BACKGROUND_LOCATION
 
         /** Apple's significant-change service's thresholds: 500 metres or more, at most every 5 minutes, without GPS. */
-        val SIGNIFICANT_CHANGES = UpdateOptions(Accuracy.low, distance = 500.0, interval = 300_000, foregroundService = null)
+        val SIGNIFICANT_CHANGES = UpdateOptions(Accuracy.Low, distance = 500.0, interval = 300_000, foregroundService = null)
     }
 }

package/android/LocationRegions.kt

@@ -4,6 +4,8 @@ import android.app.PendingIntent
 import android.content.Context
 import android.content.Intent
 import android.location.LocationManager
+import com.tokamak.runtime.TokamakHost
+import org.json.JSONObject
 
 /** The JSON of each monitored region, by id. */
 private const val PREFERENCES = "tokamak.location.regions"
@@ -14,13 +16,14 @@ private const val PREFERENCES = "tokamak.location.regions"
  * persist until [remove], and [restore] adds them again where Android removed them. Use it on the
  * main thread.
  */
-internal class LocationRegions(private val context: Context) {
+internal class LocationRegions(private val host: TokamakHost) {
+    private val context = host.context
     private val manager = context.getSystemService(LocationManager::class.java)
     private val preferences = context.getSharedPreferences(PREFERENCES, Context.MODE_PRIVATE)
 
-    fun all(): List<Region> = preferences.all.values.map { Region.from(it as String) }
+    fun all(): List<Region> = preferences.all.values.map { region(it as String) }
 
-    fun get(id: String): Region? = preferences.getString(id, null)?.let(Region::from)
+    fun get(id: String): Region? = preferences.getString(id, null)?.let(::region)
 
     /**
      * Monitors [region], replacing one with the same id. It starts in an unknown state, so a device
@@ -30,7 +33,7 @@ internal class LocationRegions(private val context: Context) {
         val alert = checkNotNull(pendingIntent(region.id, PendingIntent.FLAG_UPDATE_CURRENT))
         manager.removeProximityAlert(alert)
         manager.addProximityAlert(region.latitude, region.longitude, region.radius.toFloat(), -1, alert)
-        preferences.edit().putString(region.id, region.json().toString()).apply()
+        preferences.edit().putString(region.id, host.json(region).toString()).apply()
     }
 
     fun remove(id: String) {
@@ -50,6 +53,8 @@ internal class LocationRegions(private val context: Context) {
         all().filter { pendingIntent(it.id, PendingIntent.FLAG_NO_CREATE) == null }.forEach(::add)
     }
 
+    private fun region(json: String): Region = host.fromJson(JSONObject(json), Region::class)
+
     /** The region [id]'s `PendingIntent`, mutable so `LocationManager` adds whether the device entered. */
     private fun pendingIntent(id: String, flags: Int): PendingIntent? =
         PendingIntent.getBroadcast(

package/android/LocationService.kt

@@ -9,6 +9,7 @@ import android.content.Context
 import android.content.Intent
 import android.content.pm.ServiceInfo
 import android.os.IBinder
+import com.tokamak.runtime.tokamakPlugin
 
 private const val CHANNEL = "tokamak.location"
 private const val NOTIFICATION_ID = 1
@@ -24,8 +25,8 @@ class TokamakLocationService : Service() {
     /** Shows the notification the start [intent] carries, or on a restart, the running updates'. */
     override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
         val content =
-            intent?.getStringExtra(NOTIFICATION_EXTRA)?.let { UpdateOptions.from(it).foregroundService }
-                ?: LocationUpdates(this, LocationUpdates.UPDATES).options?.foregroundService
+            intent?.getStringArrayExtra(NOTIFICATION_EXTRA)?.let { (title, body, channel) -> ServiceNotification(title, body, channel) }
+                ?: (tokamakPlugin("location") as? TokamakLocationPlugin)?.getUpdates()?.foregroundService
         if (content == null) {
             stopSelf()
             return START_NOT_STICKY
@@ -58,13 +59,13 @@ class TokamakLocationService : Service() {
             ?: android.R.drawable.sym_def_app_icon
 
     companion object {
-        /** The start intent's updates' options, as JSON. */
+        /** The start intent's notification: its title, body and channel. */
         private const val NOTIFICATION_EXTRA = "com.tokamak.plugins.location.NOTIFICATION"
 
-        /** Starts the service showing the notification of [options], or shows it in the running service. */
-        fun start(context: Context, options: UpdateOptions) {
-            val start = Intent(context, TokamakLocationService::class.java).putExtra(NOTIFICATION_EXTRA, options.json().toString())
-            context.startForegroundService(start)
+        /** Starts the service showing [notification], or shows it in the running service. */
+        fun start(context: Context, notification: ServiceNotification) {
+            val content = arrayOf(notification.title, notification.body, notification.channel)
+            context.startForegroundService(Intent(context, TokamakLocationService::class.java).putExtra(NOTIFICATION_EXTRA, content))
         }
 
         fun stop(context: Context) {

package/android/LocationTypes.kt

@@ -1,8 +1,6 @@
 package com.tokamak.plugins.location
 
 import android.location.Location
-import com.tokamak.runtime.TokamakValue
-import org.json.JSONObject
 
 data class Coordinates(
     val latitude: Double,
@@ -31,15 +29,15 @@ data class Position(val coords: Coordinates, val timestamp: Long) {
 
 data class LocationUpdate(val positions: List<Position>)
 
-enum class Transition { enter, exit }
+enum class Transition { Enter, Exit }
 
 data class RegionTransition(val id: String, val transition: Transition, val timestamp: Long)
 
 data class LocationErrorEvent(val name: String, val message: String)
 
-enum class Permission { granted, denied, prompt }
+enum class Permission { Granted, Denied, Prompt }
 
-enum class Precision { precise, approximate }
+enum class Precision { Precise, Approximate }
 
 data class LocationPermission(val inUse: Permission, val background: Permission, val precision: Precision)
 
@@ -48,7 +46,7 @@ data class PermissionRequest(val background: Boolean?, val precision: Precision?
 data class SetupConfig(val significantChanges: Boolean?)
 
 /** The request's quality, precision traded against battery use. */
-enum class Accuracy { high, balanced, low }
+enum class Accuracy { High, Balanced, Low }
 
 /** The foreground service's notification, set from JavaScript so apps can translate it. */
 data class ServiceNotification(val title: String, val body: String, val channel: String)
@@ -60,33 +58,7 @@ data class UpdateOptions(
     /** Milliseconds between updates. */
     val interval: Long?,
     val foregroundService: ServiceNotification?,
-) {
-    fun json(): JSONObject {
-        val notification =
-            foregroundService?.let { JSONObject().put("title", it.title).put("body", it.body).put("channel", it.channel) }
-        return JSONObject()
-            .putOpt("accuracy", accuracy?.name)
-            .putOpt("distance", distance)
-            .putOpt("interval", interval)
-            .putOpt("foregroundService", notification)
-    }
-
-    companion object {
-        /** The options [json] holds, as [json] wrote them. */
-        fun from(json: String): UpdateOptions {
-            val options = TokamakValue(JSONObject(json), "")
-            return UpdateOptions(
-                accuracy = options["accuracy"].nullable { it.enum(Accuracy.entries) },
-                distance = options["distance"].nullable { it.double() },
-                interval = options["interval"].nullable { it.long() },
-                foregroundService =
-                    options["foregroundService"].nullable {
-                        ServiceNotification(it["title"].string(), it["body"].string(), it["channel"].string())
-                    },
-            )
-        }
-    }
-}
+)
 
 data class Region(
     val id: String,
@@ -96,31 +68,7 @@ data class Region(
     val radius: Double,
     val onEntry: Boolean?,
     val onExit: Boolean?,
-) {
-    fun json(): JSONObject =
-        JSONObject()
-            .put("id", id)
-            .put("latitude", latitude)
-            .put("longitude", longitude)
-            .put("radius", radius)
-            .putOpt("onEntry", onEntry)
-            .putOpt("onExit", onExit)
-
-    companion object {
-        /** The region [json] holds, as [json] wrote it. */
-        fun from(json: String): Region {
-            val region = TokamakValue(JSONObject(json), "")
-            return Region(
-                id = region["id"].string(),
-                latitude = region["latitude"].double(),
-                longitude = region["longitude"].double(),
-                radius = region["radius"].double(),
-                onEntry = region["onEntry"].nullable { it.boolean() },
-                onExit = region["onExit"].nullable { it.boolean() },
-            )
-        }
-    }
-}
+)
 
 data class MonitoredRegion(
     val id: String,

package/android/LocationUpdates.kt

@@ -7,6 +7,8 @@ import android.content.Context
 import android.content.Intent
 import android.location.LocationManager
 import android.location.LocationRequest
+import com.tokamak.runtime.TokamakHost
+import org.json.JSONObject
 
 /** The JSON of each kind of updates' options, by name. */
 private const val PREFERENCES = "tokamak.location"
@@ -14,9 +16,9 @@ private const val DEFAULT_INTERVAL_MILLIS = 10_000L
 
 private val QUALITIES =
     mapOf(
-        Accuracy.high to LocationRequest.QUALITY_HIGH_ACCURACY,
-        Accuracy.balanced to LocationRequest.QUALITY_BALANCED_POWER_ACCURACY,
-        Accuracy.low to LocationRequest.QUALITY_LOW_POWER,
+        Accuracy.High to LocationRequest.QUALITY_HIGH_ACCURACY,
+        Accuracy.Balanced to LocationRequest.QUALITY_BALANCED_POWER_ACCURACY,
+        Accuracy.Low to LocationRequest.QUALITY_LOW_POWER,
     )
 
 /**
@@ -25,17 +27,18 @@ private val QUALITIES =
  * it has ended. Their options persist until [stop], and [restore] requests them where they are not
  * running. Use it on the main thread.
  */
-internal class LocationUpdates(private val context: Context, private val name: String) {
+internal class LocationUpdates(private val host: TokamakHost, private val name: String) {
+    private val context = host.context
     private val manager = context.getSystemService(LocationManager::class.java)
     private val preferences = context.getSharedPreferences(PREFERENCES, Context.MODE_PRIVATE)
 
     /** The options of the updates, or null. */
     val options: UpdateOptions?
-        get() = preferences.getString(name, null)?.let(UpdateOptions::from)
+        get() = preferences.getString(name, null)?.let { host.fromJson(JSONObject(it), UpdateOptions::class) }
 
     /** Keeps [options], which [restore] requests. */
     fun keep(options: UpdateOptions) {
-        preferences.edit().putString(name, options.json().toString()).apply()
+        preferences.edit().putString(name, host.json(options).toString()).apply()
     }
 
     /**
@@ -76,7 +79,7 @@ internal class LocationUpdates(private val context: Context, private val name: S
             ?.reason == ApplicationExitInfo.REASON_USER_REQUESTED
 
     private fun request(options: UpdateOptions) {
-        val accuracy = options.accuracy ?: Accuracy.high
+        val accuracy = options.accuracy ?: Accuracy.High
         val request =
             LocationRequest.Builder(options.interval ?: DEFAULT_INTERVAL_MILLIS)
                 .setQuality(QUALITIES.getValue(accuracy))
@@ -96,7 +99,7 @@ internal class LocationUpdates(private val context: Context, private val name: S
     private fun provider(accuracy: Accuracy): String =
         when {
             manager.hasProvider(LocationManager.FUSED_PROVIDER) -> LocationManager.FUSED_PROVIDER
-            accuracy == Accuracy.high -> LocationManager.GPS_PROVIDER
+            accuracy == Accuracy.High -> LocationManager.GPS_PROVIDER
             else -> LocationManager.NETWORK_PROVIDER
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokamakdev/plugin-location",
-  "version": "0.1.0-beta.131",
+  "version": "0.1.0-beta.133",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mantty/tokamak.git",
@@ -14,7 +14,7 @@
     "./events": "./src/events.ts"
   },
   "peerDependencies": {
-    "@tokamakdev/plugin": "0.1.0-beta.131"
+    "@tokamakdev/plugin": "0.1.0-beta.133"
   },
   "files": [
     "android",

package/src/android.generated.ts

@@ -124,7 +124,7 @@ export interface Android {
 
 /**
  * The location plugin's native methods. Off Android they reject with `NotSupportedError`.
- * Aborting `signal` cancels their calls.
+ * Aborting `signal` cancels their calls, streams and resource acquisitions.
  */
 export function android(ctx: TokamakContext, signal?: AbortSignal): Android {
   const endpoint = new NativeEndpoint(ctx, "location", ["android"], signal);

package/src/apple.generated.ts

@@ -132,7 +132,7 @@ export interface Apple {
 
 /**
  * The location plugin's native methods. Off iOS and macOS they reject with `NotSupportedError`.
- * Aborting `signal` cancels their calls.
+ * Aborting `signal` cancels their calls, streams and resource acquisitions.
  */
 export function apple(ctx: TokamakContext, signal?: AbortSignal): Apple {
   const endpoint = new NativeEndpoint(ctx, "location", ["ios", "macos"], signal);