Merge pull request #26 from AndrewDodd42/main

WatchOS Support

Author: gre4ixin

AsyncLocationKit.podspec

@@ -9,6 +9,7 @@ Pod::Spec.new do |s|
  s.source = { :git => 'https://github.com/AsyncSwift/AsyncLocationKit.git', :tag => s.version }
  s.ios.deployment_target = '13.0'
  s.tvos.deployment_target = '13.0'
+ s.watchos.deployment_target = '6.0'
  s.requires_arc = true
  s.swift_version = '5.5'
  s.source_files = 'Sources/AsyncLocationKit/**/*.{swift}'

Package.swift

@@ -7,7 +7,8 @@ let package = Package(
  name: "AsyncLocationKit",
  platforms: [
  .iOS("13.0"),
- .macOS(.v12)
+ .macOS(.v12),
+ .watchOS(.v6)
  ],
 
  products: [

README.md

@@ -2,7 +2,7 @@
 
 [![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat)](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat)
 [![Swift](https://img.shields.io/badge/Swift-5.5-orange?style=flat)](https://img.shields.io/badge/Swift-5.5-Orange?style=flat)
-[![Platforms](https://img.shields.io/badge/platforms-iOS--13%20|%20macOS(beta)-orange?style=flat)](https://img.shields.io/badge/platforms-iOS--13%20|%20macOS(beta)-orange?style=flat)
+[![Platforms](https://img.shields.io/badge/platforms-iOS--13%20|%20macOS(beta)%20|%20watchOS--6(beta)-orange?style=flat)](https://img.shields.io/badge/platforms-iOS--13%20|%20macOS(beta)-orange?style=flat)
 
 Wrapper for Apple `CoreLocation` framework with new Concurency Model. No more `delegate` pattern or `completion blocks`.
 

Sources/AsyncLocationKit/AsyncLocationManager.swift

@@ -24,44 +24,114 @@ import Foundation
 import CoreLocation
 
 public typealias AuthotizationContinuation = CheckedContinuation<CLAuthorizationStatus, Never>
+public typealias AccuracyAuthorizationContinuation = CheckedContinuation<CLAccuracyAuthorization?, Never>
 public typealias LocationOnceContinuation = CheckedContinuation<LocationUpdateEvent?, Error>
+public typealias LocationEnabledStream = AsyncStream<LocationEnabledEvent>
 public typealias LocationStream = AsyncStream<LocationUpdateEvent>
 public typealias RegionMonitoringStream = AsyncStream<RegionMonitoringEvent>
 public typealias VisitMonitoringStream = AsyncStream<VisitMonitoringEvent>
 public typealias HeadingMonitorStream = AsyncStream<HeadingMonitorEvent>
+public typealias AuthorizationStream = AsyncStream<AuthorizationEvent>
+public typealias AccuracyAuthorizationStream = AsyncStream<AccuracyAuthorizationEvent>
+@available(watchOS, unavailable)
 public typealias BeaconsRangingStream = AsyncStream<BeaconRangeEvent>
 
 public final class AsyncLocationManager {
  private var locationManager: CLLocationManager
  private var proxyDelegate: AsyncDelegateProxyInterface
  private var locationDelegate: CLLocationManagerDelegate
 
- public convenience init(desiredAccuracy: LocationAccuracy = .bestAccuracy) {
+ public convenience init(desiredAccuracy: LocationAccuracy = .bestAccuracy, allowsBackgroundLocationUpdates: Bool = false) {
  self.init(locationManager: CLLocationManager(), desiredAccuracy: desiredAccuracy)
  }
 
- public init(locationManager: CLLocationManager, desiredAccuracy: LocationAccuracy = .bestAccuracy) {
+ public init(locationManager: CLLocationManager, desiredAccuracy: LocationAccuracy = .bestAccuracy, allowsBackgroundLocationUpdates: Bool = false) {
  self.locationManager = locationManager
  proxyDelegate = AsyncDelegateProxy()
  locationDelegate = LocationDelegate(delegateProxy: proxyDelegate)
  self.locationManager.delegate = locationDelegate
  self.locationManager.desiredAccuracy = desiredAccuracy.convertingAccuracy
+ self.locationManager.allowsBackgroundLocationUpdates = allowsBackgroundLocationUpdates
  }
 
 
+ public func getLocationEnabled() async -> Bool {
+ // Though undocumented, `locationServicesEnabled()` must not be called from the main thread. Otherwise,
+ // we get a runtime warning "This method can cause UI unresponsiveness if invoked on the main thread"
+ // Therefore, we use `Task.detached` to ensure we're off the main thread.
+ // Also, we force `try` as we expect no exceptions to be thrown from `locationServicesEnabled()`
+ try! await Task.detached { CLLocationManager.locationServicesEnabled() }.value
+ }
+
+ @available(watchOS 6.0, *)
  public func getAuthorizationStatus() -> CLAuthorizationStatus {
- if #available(iOS 14, *) {
+ if #available(iOS 14, watchOS 7, *) {
  return locationManager.authorizationStatus
  } else {
  return CLLocationManager.authorizationStatus()
  }
  }
- 
+
+ public func startMonitoringLocationEnabled() async -> LocationEnabledStream {
+ let performer = LocationEnabledMonitoringPerformer()
+ return LocationEnabledStream { stream in
+ performer.linkContinuation(stream)
+ proxyDelegate.addPerformer(performer)
+ stream.onTermination = { @Sendable _ in
+ self.stopMonitoringLocationEnabled()
+ }
+ }
+ }
+
+ public func stopMonitoringLocationEnabled() {
+ proxyDelegate.cancel(for: LocationEnabledMonitoringPerformer.self)
+ }
+
+ public func startMonitoringAuthorization() async -> AuthorizationStream {
+ let performer = AuthorizationMonitoringPerformer()
+ return AuthorizationStream { stream in
+ performer.linkContinuation(stream)
+ proxyDelegate.addPerformer(performer)
+ stream.onTermination = { @Sendable _ in
+ self.stopMonitoringAuthorization()
+ }
+ }
+ }
+
+ public func stopMonitoringAuthorization() {
+ proxyDelegate.cancel(for: AuthorizationMonitoringPerformer.self)
+ }
+
+ public func startMonitoringAccuracyAuthorization() async -> AccuracyAuthorizationStream {
+ let performer = AccuracyAuthorizationMonitoringPerformer()
+ return AccuracyAuthorizationStream { stream in
+ performer.linkContinuation(stream)
+ proxyDelegate.addPerformer(performer)
+ stream.onTermination = { @Sendable _ in
+ self.stopMonitoringAccuracyAuthorization()
+ }
+ }
+ }
+
+ public func stopMonitoringAccuracyAuthorization() {
+ proxyDelegate.cancel(for: AccuracyAuthorizationMonitoringPerformer.self)
+ }
+
+ @available(iOS 14, watchOS 7, *)
+ public func getAccuracyAuthorization() -> CLAccuracyAuthorization {
+ locationManager.accuracyAuthorization
+ }
+
  public func updateAccuracy(with newAccuracy: LocationAccuracy) {
  locationManager.desiredAccuracy = newAccuracy.convertingAccuracy
  }
- 
+
+ public func updateAllowsBackgroundLocationUpdates(with newAllows: Bool) {
+ locationManager.allowsBackgroundLocationUpdates = newAllows
+ }
+
  @available(*, deprecated, message: "Use new function requestPermission(with:)")
+ @available(watchOS 7.0, *)
  public func requestAuthorizationWhenInUse() async -> CLAuthorizationStatus {
  let authorizationPerformer = RequestAuthorizationPerformer()
  return await withTaskCancellationHandler(operation: {
@@ -82,24 +152,37 @@ public final class AsyncLocationManager {
 
 #if !APPCLIP
  @available(*, deprecated, message: "Use new function requestPermission(with:)")
+ @available(watchOS 7.0, *)
+ @available(iOS 14, *)
  public func requestAuthorizationAlways() async -> CLAuthorizationStatus {
  let authorizationPerformer = RequestAuthorizationPerformer()
  return await withTaskCancellationHandler(operation: {
  await withCheckedContinuation { continuation in
+#if os(macOS)
  if #available(iOS 14, *), locationManager.authorizationStatus != .notDetermined {
  continuation.resume(with: .success(locationManager.authorizationStatus))
  } else {
  authorizationPerformer.linkContinuation(continuation)
  proxyDelegate.addPerformer(authorizationPerformer)
  locationManager.requestAlwaysAuthorization()
  }
+#else
+ if #available(iOS 14, *), locationManager.authorizationStatus != .notDetermined && locationManager.authorizationStatus != .authorizedWhenInUse {
+ continuation.resume(with: .success(locationManager.authorizationStatus))
+ } else {
+ authorizationPerformer.linkContinuation(continuation)
+ proxyDelegate.addPerformer(authorizationPerformer)
+ locationManager.requestAlwaysAuthorization()
+ }
+#endif
  }
  }, onCancel: {
  proxyDelegate.cancel(for: authorizationPerformer.uniqueIdentifier)
  })
  }
 #endif
 
+ @available(watchOS 7.0, *)
  public func requestPermission(with permissionType: LocationPermission) async -> CLAuthorizationStatus {
  switch permissionType {
  case .always:
@@ -112,7 +195,12 @@ public final class AsyncLocationManager {
  return await locationPermissionWhenInUse()
  }
  }
- 
+
+ @available(iOS 14, watchOS 7, *)
+ public func requestTemporaryFullAccuracyAuthorization(purposeKey: String) async -> CLAccuracyAuthorization? {
+ await locationPermissionTemporaryFullAccuracy(purposeKey: purposeKey)
+ }
+
  public func startUpdatingLocation() async -> LocationStream {
  let monitoringPerformer = MonitoringUpdateLocationPerformer()
  return LocationStream { streamContinuation in
@@ -143,6 +231,7 @@ public final class AsyncLocationManager {
  })
  }
 
+ @available(watchOS, unavailable)
  public func startMonitoring(for region: CLRegion) async -> RegionMonitoringStream {
  let performer = RegionMonitoringPerformer(region: region)
  return RegionMonitoringStream { streamContinuation in
@@ -154,6 +243,7 @@ public final class AsyncLocationManager {
  }
  }
 
+ @available(watchOS, unavailable)
  public func stopMonitoring(for region: CLRegion) {
  proxyDelegate.cancel(for: RegionMonitoringPerformer.self) { regionMonitoring in
  guard let regionPerformer = regionMonitoring as? RegionMonitoringPerformer else { return false }
@@ -162,6 +252,7 @@ public final class AsyncLocationManager {
  locationManager.stopMonitoring(for: region)
  }
 
+ @available(watchOS, unavailable)
  public func startMonitoringVisit() async -> VisitMonitoringStream {
  let performer = VisitMonitoringPerformer()
  return VisitMonitoringStream { stream in
@@ -174,6 +265,7 @@ public final class AsyncLocationManager {
  }
  }
 
+ @available(watchOS, unavailable)
  public func stopMonitoringVisit() {
  proxyDelegate.cancel(for: VisitMonitoringPerformer.self)
  locationManager.stopMonitoringVisits()
@@ -199,6 +291,7 @@ public final class AsyncLocationManager {
  }
 #endif
 
+ @available(watchOS, unavailable)
  public func startRangingBeacons(satisfying: CLBeaconIdentityConstraint) async -> BeaconsRangingStream {
  let performer = BeaconsRangePerformer(satisfying: satisfying)
  return BeaconsRangingStream { stream in
@@ -211,6 +304,7 @@ public final class AsyncLocationManager {
  }
  }
 
+ @available(watchOS, unavailable)
  public func stopRangingBeacons(satisfying: CLBeaconIdentityConstraint) {
  proxyDelegate.cancel(for: BeaconsRangePerformer.self) { beaconsMonitoring in
  guard let beaconsPerformer = beaconsMonitoring as? BeaconsRangePerformer else { return false }
@@ -243,13 +337,45 @@ extension AsyncLocationManager {
  let authorizationPerformer = RequestAuthorizationPerformer()
  return await withTaskCancellationHandler(operation: {
  await withCheckedContinuation { continuation in
- if #available(iOS 14, *), locationManager.authorizationStatus != .notDetermined {
+#if os(macOS)
+ if #available(iOS 14, watchOS 7, *), locationManager.authorizationStatus != .notDetermined {
+ continuation.resume(with: .success(locationManager.authorizationStatus))
+ } else {
+ authorizationPerformer.linkContinuation(continuation)
+ proxyDelegate.addPerformer(authorizationPerformer)
+ locationManager.requestAlwaysAuthorization()
+ }
+#else
+ if #available(iOS 14, watchOS 7, *), locationManager.authorizationStatus != .notDetermined && locationManager.authorizationStatus != .authorizedWhenInUse {
  continuation.resume(with: .success(locationManager.authorizationStatus))
  } else {
  authorizationPerformer.linkContinuation(continuation)
  proxyDelegate.addPerformer(authorizationPerformer)
  locationManager.requestAlwaysAuthorization()
  }
+#endif
+ }
+ }, onCancel: {
+ proxyDelegate.cancel(for: authorizationPerformer.uniqueIdentifier)
+ })
+ }
+
+ @available(iOS 14, watchOS 7, *)
+ private func locationPermissionTemporaryFullAccuracy(purposeKey: String) async -> CLAccuracyAuthorization? {
+ let authorizationPerformer = RequestAccuracyAuthorizationPerformer()
+ return await withTaskCancellationHandler(operation: {
+ await withCheckedContinuation { continuation in
+ if locationManager.authorizationStatus != .notDetermined && locationManager.accuracyAuthorization == .fullAccuracy {
+ continuation.resume(with: .success(locationManager.accuracyAuthorization))
+ } else if locationManager.authorizationStatus == .notDetermined {
+ continuation.resume(with: .success(nil))
+ } else if !CLLocationManager.locationServicesEnabled() {
+ continuation.resume(with: .success(nil))
+ } else {
+ authorizationPerformer.linkContinuation(continuation)
+ proxyDelegate.addPerformer(authorizationPerformer)
+ locationManager.requestTemporaryFullAccuracyAuthorization(withPurposeKey: purposeKey)
+ }
  }
  }, onCancel: {
  proxyDelegate.cancel(for: authorizationPerformer.uniqueIdentifier)

Sources/AsyncLocationKit/CoreLocationEvents.swift

@@ -26,13 +26,20 @@ import CoreLocation
 
 enum CoreLocationDelegateEvent {
 // MARK: - Authorization event
+ case didChangeLocationEnabled(enabled: Bool)
  case didChangeAuthorization(status: CLAuthorizationStatus)
+ case didChangeAccuracyAuthorization(authorization: CLAccuracyAuthorization)
 // MARK: - Location events
  case didUpdate(locations: [CLLocation])
  case didUpdateHeading(heading: CLHeading)
+ 
+ @available(watchOS, unavailable)
  case didDetermine(state: CLRegionState, forRegion: CLRegion)
+ 
 // MARK: - Beacons events
+ @available(watchOS, unavailable)
  case didRange(beacons: [CLBeacon], beaconConstraint: CLBeaconIdentityConstraint)
+ @available(watchOS, unavailable)
  case didFailRanginFor(beaconConstraint: CLBeaconIdentityConstraint, error: Error)
 // MARK: - Region events
  case didEnterRegion(region: CLRegion)
@@ -42,15 +49,20 @@ enum CoreLocationDelegateEvent {
  case didFailWithError(error: Error)
  case monitoringDidFailFor(region: CLRegion?, error: Error)
 // MARK: - Visit event
+ @available(watchOS, unavailable)
  case didVisit(visit: CLVisit)
 // MARK: - Pause and resume events
  case locationUpdatesPaused
  case locationUpdatesResume
 
  func rawEvent() -> CoreLocationEventSupport {
  switch self {
+ case .didChangeLocationEnabled(_):
+ return .didChangeLocationEnabled
  case .didChangeAuthorization(_):
  return .didChangeAuthorization
+ case .didChangeAccuracyAuthorization(_):
+ return .didChangeAccuracyAuthorization
  case .didUpdate(_):
  return .didUpdateLocations
  case .didUpdateHeading(_):
@@ -83,7 +95,9 @@ enum CoreLocationDelegateEvent {
 
 /// Event for mark what support current delegate
 enum CoreLocationEventSupport {
+ case didChangeLocationEnabled
  case didChangeAuthorization
+ case didChangeAccuracyAuthorization
  case didUpdateLocations
  case didUpdateHeading
  case didDetermineState