@tokamakdev/plugin-location 0.1.0-beta.128 → 0.1.0-beta.129

package/android/LocationUpdates.kt

@@ -7,7 +7,6 @@ import android.content.Context
 import android.content.Intent
 import android.location.LocationManager
 import android.location.LocationRequest
-import org.json.JSONObject
 
 /** The JSON of each kind of updates' options, by name. */
 private const val PREFERENCES = "tokamak.location"
@@ -15,9 +14,9 @@ private const val DEFAULT_INTERVAL_MILLIS = 10_000L
 
 private val QUALITIES =
     mapOf(
-        "high" to LocationRequest.QUALITY_HIGH_ACCURACY,
-        "balanced" to LocationRequest.QUALITY_BALANCED_POWER_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,
     )
 
 /**
@@ -31,20 +30,20 @@ internal class LocationUpdates(private val context: Context, private val name: S
     private val preferences = context.getSharedPreferences(PREFERENCES, Context.MODE_PRIVATE)
 
     /** The options of the updates, or null. */
-    val options: JSONObject?
-        get() = preferences.getString(name, null)?.let(::JSONObject)
+    val options: UpdateOptions?
+        get() = preferences.getString(name, null)?.let(UpdateOptions::from)
 
     /** Keeps [options], which [restore] requests. */
-    fun keep(options: JSONObject) {
-        preferences.edit().putString(name, options.toString()).apply()
+    fun keep(options: UpdateOptions) {
+        preferences.edit().putString(name, options.json().toString()).apply()
     }
 
     /**
      * Keeps [options] and requests updates with them, replacing others; the same options running
      * change nothing. Throws `SecurityException` without permission.
      */
-    fun start(options: JSONObject) {
-        if (options.toString() == preferences.getString(name, null) && isRequested()) return
+    fun start(options: UpdateOptions) {
+        if (options == this.options && isRequested()) return
         keep(options)
         request(options)
     }
@@ -76,12 +75,12 @@ internal class LocationUpdates(private val context: Context, private val name: S
             .firstOrNull()
             ?.reason == ApplicationExitInfo.REASON_USER_REQUESTED
 
-    private fun request(options: JSONObject) {
-        val accuracy = options.optString("accuracy", "high")
+    private fun request(options: UpdateOptions) {
+        val accuracy = options.accuracy ?: Accuracy.high
         val request =
-            LocationRequest.Builder(options.optLong("interval", DEFAULT_INTERVAL_MILLIS))
-                .setQuality(QUALITIES[accuracy] ?: LocationRequest.QUALITY_HIGH_ACCURACY)
-                .setMinUpdateDistanceMeters(options.optDouble("distance", 0.0).toFloat())
+            LocationRequest.Builder(options.interval ?: DEFAULT_INTERVAL_MILLIS)
+                .setQuality(QUALITIES.getValue(accuracy))
+                .setMinUpdateDistanceMeters((options.distance ?: 0.0).toFloat())
                 .build()
         val updates = checkNotNull(pendingIntent(PendingIntent.FLAG_UPDATE_CURRENT))
         try {
@@ -94,10 +93,10 @@ internal class LocationUpdates(private val context: Context, private val name: S
     }
 
     /** The fused provider when the device has one, and otherwise GPS for high accuracy and the network for less. */
-    private fun provider(accuracy: String): String =
+    private fun provider(accuracy: Accuracy): String =
         when {
             manager.hasProvider(LocationManager.FUSED_PROVIDER) -> LocationManager.FUSED_PROVIDER
-            accuracy == "high" -> LocationManager.GPS_PROVIDER
+            accuracy == Accuracy.high -> LocationManager.GPS_PROVIDER
             else -> LocationManager.NETWORK_PROVIDER
         }
 

package/apple/Exports.generated.swift

@@ -0,0 +1,134 @@
+// Generated by `tok plugin generate apple`. Do not edit.
+
+import Foundation
+
+extension TokamakLocationPlugin {
+  func callBytes(method: String, payload: Data, reply: @escaping TokamakPluginBytesReply)
+    throws(TokamakPluginError) -> (() -> Void)?
+  {
+    switch method {
+    case "setup":
+      struct Arguments: Decodable {
+        let config: SetupConfig
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        try self.setup(arguments.config)
+      }
+    case "recentPosition":
+      struct Arguments: Decodable {
+        let maximumAge: Double
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        self.recentPosition(maximumAge: arguments.maximumAge)
+      }
+    case "currentPosition":
+      return tokamakCall(reply) {
+        try await self.currentPosition()
+      }
+    case "permission":
+      return tokamakCall(reply) {
+        self.permission()
+      }
+    case "requestPermission":
+      struct Arguments: Decodable {
+        let request: PermissionRequest?
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        try await self.requestPermission(arguments.request)
+      }
+    case "servicesEnabled":
+      return tokamakCall(reply) {
+        await self.servicesEnabled()
+      }
+    case "openSettings":
+      return tokamakCall(reply) {
+        try await self.openSettings()
+      }
+    case "startUpdates":
+      struct Arguments: Decodable {
+        let options: UpdateOptions?
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        try self.startUpdates(arguments.options)
+      }
+    case "stopUpdates":
+      return tokamakCall(reply) {
+        self.stopUpdates()
+      }
+    case "getUpdates":
+      return tokamakCall(reply) {
+        self.getUpdates()
+      }
+    case "addRegion":
+      struct Arguments: Decodable {
+        let region: Region
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        try await self.addRegion(arguments.region)
+      }
+    case "getRegions":
+      return tokamakCall(reply) {
+        await self.getRegions()
+      }
+    case "removeRegion":
+      struct Arguments: Decodable {
+        let id: String
+      }
+      let arguments = try tokamakDecode(Arguments.self, from: payload)
+      return tokamakCall(reply) {
+        await self.removeRegion(arguments.id)
+      }
+    default:
+      throw .notSupported("\(id).\(method) is not supported")
+    }
+  }
+
+  func subscribeBytes(method: String, payload: Data, reply: @escaping TokamakPluginBytesReply)
+    throws(TokamakPluginError) -> (() -> Void)
+  {
+    switch method {
+    case "watchPosition":
+      return try tokamakStream(reply) {
+        self.watchPosition()
+      }
+    case "onLocationUpdate":
+      return try tokamakStream(reply) {
+        self.onLocationUpdate()
+      }
+    case "onRegionTransition":
+      return try tokamakStream(reply) {
+        self.onRegionTransition()
+      }
+    case "onVisit":
+      return try tokamakStream(reply) {
+        self.onVisit()
+      }
+    case "onLocationError":
+      return try tokamakStream(reply) {
+        self.onLocationError()
+      }
+    default:
+      throw .notSupported("\(id).\(method) is not supported")
+    }
+  }
+
+  func eventPayload(_ name: String, _ event: Any) throws(TokamakPluginError) -> Data {
+    switch name {
+    case "update":
+      return try tokamakEvent(name, event, as: LocationUpdate.self)
+    case "region":
+      return try tokamakEvent(name, event, as: RegionTransition.self)
+    case "visit":
+      return try tokamakEvent(name, event, as: Visit.self)
+    case "error":
+      return try tokamakEvent(name, event, as: LocationErrorEvent.self)
+    default:
+      throw .unlistedEvent(name)
+    }
+  }
+}

package/apple/Exports.swift

@@ -0,0 +1,48 @@
+extension TokamakLocationPlugin: TokamakExports {
+  static func exports(_ e: inout TokamakExporter<TokamakLocationPlugin>) {
+    e.call(
+      setup, doc: "Applies long-term location awareness, replacing the previous configuration.")
+    e.call(
+      recentPosition, doc: "Core Location's latest position, when it is no older than `maximumAge`."
+    )
+    e.call(currentPosition, doc: "A new fix. Cancelling the call stops locating.")
+    e.stream(watchPosition, overflow: .dropOldest, doc: "Positions as the device moves.")
+    e.call(
+      permission, doc: "The app's in-use and background permission, and the precision it gets.")
+    e.call(
+      requestPermission,
+      doc: "Asks for the permission `request` names where the user has not answered.")
+    e.call(servicesEnabled, doc: "Whether location services are on for the device.")
+    e.call(openSettings, doc: "Opens the app's page in the system settings.")
+    e.call(
+      startUpdates, doc: "Starts continuous updates, replacing any running, until `stopUpdates`.")
+    e.call(stopUpdates)
+    e.call(getUpdates, doc: "The options of the running updates, or null when none are running.")
+    e.call(addRegion, doc: "Monitors a circular region, replacing one with the same `id`.")
+    e.call(getRegions, doc: "The monitored regions.")
+    e.call(removeRegion)
+    e.stream(
+      onLocationUpdate, overflow: .dropOldest, doc: "The updates the Worker's listeners receive.")
+    e.stream(onRegionTransition, doc: "The transitions the Worker's listeners receive.")
+    e.stream(onVisit, doc: "The visits the Worker's listeners receive.")
+    e.stream(onLocationError, doc: "The failures the Worker's listeners receive.")
+    e.event(
+      "update", LocationUpdate.self,
+      doc:
+        "Receives continuous updates and significant changes, including those that launch the app."
+    )
+    e.event(
+      "region", RegionTransition.self,
+      doc: "Receives each region entry or exit, including one that launches the app.")
+    e.event(
+      "visit", Visit.self,
+      doc:
+        "Receives each arrival at or departure from a place, including one that launches the app."
+    )
+    e.event(
+      "error", LocationErrorEvent.self,
+      doc:
+        "Receives failures of background services, such as a region Core Location cannot monitor."
+    )
+  }
+}

package/apple/LocationEvents.swift

@@ -5,18 +5,17 @@ import Foundation
 /// the system gives an app it launches for one.
 private let eventDeadline: TimeInterval = 8
 
-/// The listener methods, which receive the Worker's events.
-private let listenerMethods: Set = [
-  "onLocationUpdate", "onRegionTransition", "onVisit", "onLocationError",
-]
-
 /// Delivers the plugin's events to the Worker's listeners and the page's. Use
 /// it on the main thread.
 final class TokamakLocationEvents {
+  let updates = TokamakListeners<TokamakLocationPlugin.LocationUpdate>()
+  let transitions = TokamakListeners<TokamakLocationPlugin.RegionTransition>()
+  let visits = TokamakListeners<TokamakLocationPlugin.Visit>()
+  let errors = TokamakListeners<TokamakLocationPlugin.LocationErrorEvent>()
+
   private let host: TokamakHost
-  private var listeners: [String: [UUID: TokamakPluginReply]] = [:]
   /// Positions that arrived while the Worker handled the previous update.
-  private var positions: [[String: Any]] = []
+  private var positions: [TokamakLocationPlugin.Position] = []
   private var stationary: Bool?
   private var updating = false
   /// The time of the newest position delivered, as services that run together
@@ -30,23 +29,13 @@ final class TokamakLocationEvents {
     self.host = host
   }
 
-  /// Adds a page's or Worker's listener of `method`, returning its removal.
-  func listen(_ method: String, _ reply: @escaping TokamakPluginReply) -> (() -> Void)? {
-    guard listenerMethods.contains(method) else { return nil }
-    let key = UUID()
-    listeners[method, default: [:]][key] = reply
-    return { [weak self] in
-      self?.listeners[method]?.removeValue(forKey: key)
-    }
-  }
-
   /// Delivers `location` when it is newer than the positions delivered, with
   /// Apple's `stationary` flag when the system reports it. Positions that
   /// arrive while the Worker handles an update reach it together as the next.
   func update(_ location: CLLocation?, stationary: Bool? = nil) {
     if let location, location.timestamp > latest {
       latest = location.timestamp
-      positions.append(Self.position(location))
+      positions.append(TokamakLocationPlugin.Position(location))
     }
     if let stationary {
       self.stationary = stationary
@@ -61,32 +50,21 @@ final class TokamakLocationEvents {
       updating = false
       return
     }
-    var event: [String: Any] = ["positions": positions]
-    event["stationary"] = stationary
+    let update = TokamakLocationPlugin.LocationUpdate(positions: positions, stationary: stationary)
     positions = []
     stationary = nil
     updating = true
-    send("onLocationUpdate", "update", event) { self.sendUpdate() }
+    send(update, to: updates, as: "update") { self.sendUpdate() }
   }
 
   func transition(_ id: String, entered: Bool, at date: Date) {
-    let event: [String: Any] = [
-      "id": id, "transition": entered ? "enter" : "exit", "timestamp": Self.milliseconds(date),
-    ]
-    send("onRegionTransition", "region", event)
+    send(
+      TokamakLocationPlugin.RegionTransition(id: id, entered: entered, at: date), to: transitions,
+      as: "region")
   }
 
   func visit(_ visit: CLVisit) {
-    let event: [String: Any] = [
-      "latitude": visit.coordinate.latitude,
-      "longitude": visit.coordinate.longitude,
-      "accuracy": visit.horizontalAccuracy,
-      "arrival": visit.arrivalDate == .distantPast
-        ? NSNull() : Self.milliseconds(visit.arrivalDate),
-      "departure": visit.departureDate == .distantFuture
-        ? NSNull() : Self.milliseconds(visit.departureDate),
-    ]
-    send("onVisit", "visit", event)
+    send(TokamakLocationPlugin.Visit(visit), to: visits, as: "visit")
   }
 
   /// Reports each of `problems` that updates, or the region `id`, did not
@@ -99,20 +77,35 @@ final class TokamakLocationEvents {
     self.problems[id] = Set(problems.map(\.message))
   }
 
+  /// A main-actor task that runs `body`, reporting the failure that ends it
+  /// unless the task was cancelled.
+  @discardableResult
+  func task(_ body: @escaping @MainActor () async throws -> Void) -> Task<Void, Never> {
+    Task { @MainActor in
+      do {
+        try await body()
+      } catch {
+        guard !Task.isCancelled else { return }
+        self.fail(.locationUnavailable(error.localizedDescription))
+      }
+    }
+  }
+
   /// Reports a background service's failure, which concerns the region `id`
   /// when given.
   func fail(_ error: TokamakPluginError, region id: String? = nil) {
-    var event: [String: Any] = ["name": error.name, "message": error.message]
-    event["id"] = id
-    send("onLocationError", "error", event)
+    send(
+      TokamakLocationPlugin.LocationErrorEvent(name: error.name, message: error.message, id: id),
+      to: errors, as: "error")
   }
 
-  private func send(
-    _ method: String, _ name: String, _ event: [String: Any], completion: @escaping () -> Void = {}
+  /// Delivers `event` to the page's `listeners` and the Worker's listeners of
+  /// `name`, then calls `completion`.
+  private func send<Event: Encodable>(
+    _ event: Event, to listeners: TokamakListeners<Event>, as name: String,
+    completion: @escaping () -> Void = {}
   ) {
-    for reply in (listeners[method] ?? [:]).values {
-      reply(.success(event))
-    }
+    listeners.send(event)
     host.emit(name, event: event, timeout: eventDeadline) { result in
       if case .failure(let error) = result {
         print("location \(name) failed: \(error)")
@@ -120,31 +113,6 @@ final class TokamakLocationEvents {
       completion()
     }
   }
-
-  /// `location` as the page's `Position`.
-  static func position(_ location: CLLocation) -> [String: Any] {
-    let coordinates = location.coordinate
-    return [
-      "coords": [
-        "latitude": coordinates.latitude,
-        "longitude": coordinates.longitude,
-        "accuracy": location.horizontalAccuracy,
-        "altitude": nullable(location.verticalAccuracy >= 0, location.altitude),
-        "altitudeAccuracy": nullable(location.verticalAccuracy >= 0, location.verticalAccuracy),
-        "heading": nullable(location.course >= 0, location.course),
-        "speed": nullable(location.speed >= 0, location.speed),
-      ],
-      "timestamp": milliseconds(location.timestamp),
-    ]
-  }
-
-  private static func nullable(_ available: Bool, _ value: Double) -> Any {
-    available ? value : NSNull()
-  }
-
-  private static func milliseconds(_ date: Date) -> Double {
-    date.timeIntervalSince1970 * 1000
-  }
 }
 
 extension TokamakPluginError {