Query Property Wrappers, HealthChart, and Other Refactoring

Package.swift

@@ -22,9 +22,9 @@ let package = Package(
         .library(name: "SpeziHealthKit", targets: ["SpeziHealthKit"])
     ],
     dependencies: [
-        .package(path: "../Spezi"),
-        .package(path: "../SpeziFoundation"),
-        .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.17.7")
+        .package(url: "https://github.com/StanfordSpezi/Spezi.git", from: "1.8.0"),
+        .package(url: "https://github.com/StanfordSpezi/SpeziFoundation.git", from: "2.1.0"),
+        .package(url: "https://github.com/pointfreeco/swift-snapshot-testing.git", from: "1.17.7")
     ] + swiftLintPackage(),
     targets: [
         .target(

Sources/SpeziHealthKit/CollectSample/CollectSample.swift

@@ -10,9 +10,9 @@ import HealthKit
 import Spezi
 
 
-/// Collects a specified ``HealthKitSampleType``  via the ``HealthKit`` module.
+/// Collects a specified ``SampleType``  via the ``HealthKit`` module.
 ///
-/// This structure define what and how the ``HealthKit`` samples are collected. By default, all samples of the provided ``HealthKitSampleType`` will be collected.
+/// This structure define what and how the ``HealthKit`` samples are collected. By default, all samples of the provided ``SampleType`` will be collected.
 /// The collection starts on calling ``HealthKit/triggerDataSourceCollection()`` if you configure the `deliverySetting` as    ``HealthKitDeliverySetting/manual(saveAnchor:)`` or automatic once the application is launched when you configure anything else than manual, i.e.  ``HealthKitDeliverySetting/anchorQuery(_:saveAnchor:)`` or ``HealthKitDeliverySetting/background(_:saveAnchor:)``.
 ///
 /// Your can filter the HealthKit samples to collect via an `NSPredicate`.
@@ -51,19 +51,19 @@ public struct CollectSample: HealthKitConfigurationComponent {
     private let predicate: NSPredicate?
     private let deliverySetting: HealthKitDeliverySetting
 
-    public var dataAccessRequirements: HealthKitDataAccessRequirements {
+    public var dataAccessRequirements: HealthKit.DataAccessRequirements {
         .init(read: [sampleType])
     }
 
 
     /// - Parameters:
-    ///   - sampleType: The ``HealthKitSampleType`` that should be collected
+    ///   - sampleType: The ``SampleType`` that should be collected
     ///   - predicate: A custom predicate that should be passed to the HealthKit query.
     ///                The default predicate collects all samples that have been collected from the first time that the user
     ///                provided the application authorization to collect the samples.
     ///   - deliverySetting: The ``HealthKitDeliverySetting`` that should be used to collect the sample type. `.manual` is the default argument used.
     public init(
-        _ sampleType: HealthKitSampleType<some Any>,
+        _ sampleType: SampleType<some Any>,
         predicate: NSPredicate? = nil,
         delivery: HealthKitDeliverySetting = .manual() // TODO Question @Paul : why does it default to manual?
     ) {
@@ -74,7 +74,7 @@ public struct CollectSample: HealthKitConfigurationComponent {
 
     @available(*, deprecated, renamed: "init(_:predicate:delivery:)")
     public init(
-        _ sampleType: HealthKitSampleType<some Any>,
+        _ sampleType: SampleType<some Any>,
         predicate: NSPredicate? = nil,
         deliverySetting: HealthKitDeliverySetting = .manual()
     ) {

Sources/SpeziHealthKit/Configuration/HealthKitConfiguration.swift

@@ -17,7 +17,7 @@ import Spezi
 /// to perform custom configuration actions.
 public protocol HealthKitConfigurationComponent {
     /// The HealthKit data types this component needs read and/or write access to.
-    var dataAccessRequirements: HealthKitDataAccessRequirements { get }
+    var dataAccessRequirements: HealthKit.DataAccessRequirements { get }
 
     /// Called when the component is addedd to the ``HealthKit-swift.class`` module.
     /// Components can use this function to register their respective custom functionalities with the module.
@@ -26,34 +26,35 @@ public protocol HealthKitConfigurationComponent {
 }
 
 
-
-/// Defines the object and sample types the ``HealthKit-swift.class`` module requires read and/or write access to.
-public struct HealthKitDataAccessRequirements {
-    /// The object types a component needs read access to.
-    /// The ``HealthKit-swift.class`` module will include these object types in the
-    /// request when the app calls ``HealthKit-swift.class/askForAuthorization()``
-    public let read: Set<HKObjectType>
-    /// The object types a component needs write access to.
-    /// The ``HealthKit-swift.class`` module will include these object types in the
-    /// request when the app calls ``HealthKit-swift.class/askForAuthorization()``
-    public let write: Set<HKSampleType>
-
-    /// Creates a new instance, with the specified read and write sample types.
-    public init(read: some Sequence<HKObjectType> = [], write: some Sequence<HKSampleType> = []) {
-        self.read = Set(read)
-        self.write = Set(write)
-    }
-
-    /// Creates a new instance, containing the union of the read and write requirements of `self` and `other`.
-    public func merging(with other: Self) -> Self {
-        Self(
-            read: read.union(other.read),
-            write: write.union(other.write)
-        )
-    }
-
-    /// Merges another set of data access requirements into the current one.
-    public mutating func merge(with other: Self) {
-        self = self.merging(with: other)
+extension HealthKit {
+    /// Defines the object and sample types the ``HealthKit-swift.class`` module requires read and/or write access to.
+    public struct DataAccessRequirements {
+        /// The object types a component needs read access to.
+        /// The ``HealthKit-swift.class`` module will include these object types in the
+        /// request when the app calls ``HealthKit-swift.class/askForAuthorization()``
+        public let read: Set<HKObjectType>
+        /// The object types a component needs write access to.
+        /// The ``HealthKit-swift.class`` module will include these object types in the
+        /// request when the app calls ``HealthKit-swift.class/askForAuthorization()``
+        public let write: Set<HKSampleType>
+
+        /// Creates a new instance, with the specified read and write sample types.
+        public init(read: some Sequence<HKObjectType> = [], write: some Sequence<HKSampleType> = []) {
+            self.read = Set(read)
+            self.write = Set(write)
+        }
+
+        /// Creates a new instance, containing the union of the read and write requirements of `self` and `other`.
+        public func merging(with other: Self) -> Self {
+            Self(
+                read: read.union(other.read),
+                write: write.union(other.write)
+            )
+        }
+
+        /// Merges another set of data access requirements into the current one.
+        public mutating func merge(with other: Self) {
+            self = self.merging(with: other)
+        }
     }
 }

Sources/SpeziHealthKit/Configuration/RequestReadAccess.swift

@@ -11,7 +11,7 @@ import HealthKit
 
 /// A ``HealthKit`` configuration component that requests read acess to HealthKit sample types.
 public struct RequestReadAccess: HealthKitConfigurationComponent {
-    public let dataAccessRequirements: HealthKitDataAccessRequirements
+    public let dataAccessRequirements: HealthKit.DataAccessRequirements
 
     /// Creates a HealthKit configuration component that requests read access to the specified `HKObjectType`s.
     public init(_ objectTypes: some Sequence<HKObjectType>) {

Sources/SpeziHealthKit/Configuration/RequestWriteAccess.swift

@@ -14,7 +14,7 @@ import HealthKit
 /// - Warning: Only request write access to HealthKit data if your app's `Info.plist` file
 ///     contains an entry for the `NSHealthUpdateUsageDescription` key.
 public struct RequestWriteAccess: HealthKitConfigurationComponent {
-    public let dataAccessRequirements: HealthKitDataAccessRequirements
+    public let dataAccessRequirements: HealthKit.DataAccessRequirements
 
     /// Creates a HealthKit configuration component that requests write access to the specified `HKObjectType`s.
     public init(_ objectTypes: some Sequence<HKSampleType>) {

Sources/SpeziHealthKit/HealthChart/HealthChart.swift

@@ -10,7 +10,7 @@
 import SwiftUI
 import HealthKit
 import Charts
 import SpeziHealthKit
 import SpeziFoundation
 
 
@@ -49,7 +49,7 @@
 public enum StatisticsAggregationOption: Sendable {
     case sum, avg, min, max
 
-    public init(_ sampleType: HealthKitSampleType<HKQuantitySample>) {
+    public init(_ sampleType: SampleType<HKQuantitySample>) {
         switch sampleType.hkSampleType.aggregationStyle {
         case .cumulative:
             self = .sum
@@ -404,7 +404,7 @@
             let valuesRange = { () -> ClosedRange<Double>? in
                 var range: ClosedRange<Double>?
                 func imp(_ entry: HealthChartEntry<some Any>) {
-                    guard let expectedRange = (entry.results.sampleType as? HealthKitSampleType<HKQuantitySample>)?.expectedValuesRange else {
+                    guard let expectedRange = (entry.results.sampleType as? SampleType<HKQuantitySample>)?.expectedValuesRange else {
                         return
                     }
                     if let _range = range {
@@ -484,7 +484,7 @@
             if let dataPoint = entry.makeDataPoint(for: element) {
                 let x: PlottableValue = .value("Date", dataPoint.date)
                 let y: PlottableValue = .value(name, dataPoint.value * (entry.results.sampleType == .bloodOxygen ? 100 : 1))
                 let s: PlottableValue = .value("Series", name)
                 SomeChartContent {
                     switch entry.drawingConfig.mode {
                     case .line:
@@ -498,7 +498,7 @@
                 .annotation { // TODO?
 //                    let date = dataPoint.date.ISO8601Format(Date.ISO8601FormatStyle())
 //                    Text("\(dataPoint.stringValue)\n\(date)")
-                    Text("\(dataPoint.stringValue)")
+                    Text(dataPoint.stringValue)
                         .font(.caption)
                 }
             }

Sources/SpeziHealthKit/HealthKit.swift

@@ -34,7 +34,7 @@ import SwiftUI
 /// 
 /// Then, you can configure the ``HealthKit`` module in the configuration section of your `SpeziAppDelegate`.
 /// Provide ``HealthKitDataSourceDescription`` to define the data collection.
-/// You can, e.g., use ``CollectSample`` to collect a wide variety of ``HealthKitSampleType``s:
+/// You can, e.g., use ``CollectSample`` to collect a wide variety of ``SampleType``s:
 /// ```swift
 /// class ExampleAppDelegate: SpeziAppDelegate {
 ///     override var configuration: Configuration {
@@ -81,10 +81,10 @@ public final class HealthKit: Module, EnvironmentAccessible, DefaultInitializabl
 
     // TODO why doesn't importing SpeziHealthKit as @testable work in the TestApp????(!)
     /// (for testing purposes only) The data access requirements that resulted form the initial configuration passed to the ``HealthKit-swift.class`` module.
-    public let _initialConfigHealthKitDataAccessRequirements: HealthKitDataAccessRequirements
+    public let _initialConfigDataAccessRequirements: DataAccessRequirements
 
     /// Which HealthKit data we need to be able to access, for read and/or write operations.
-    private var healthKitDataAccessRequirements: HealthKitDataAccessRequirements
+    private var dataAccessRequirements: DataAccessRequirements
 
     /// Configurations which were supplied to the initializer, but have not yet been applied.
     /// - Note: This property is intended only to store the configuration until `configure()` has been called. It is not used afterwards.
@@ -103,10 +103,10 @@ public final class HealthKit: Module, EnvironmentAccessible, DefaultInitializabl
     ) {
         healthStore = HKHealthStore()
         pendingConfiguration = config()
-        _initialConfigHealthKitDataAccessRequirements = pendingConfiguration.reduce(.init()) { dataReqs, component in
+        _initialConfigDataAccessRequirements = pendingConfiguration.reduce(.init()) { dataReqs, component in
             dataReqs.merging(with: component.dataAccessRequirements)
         }
-        healthKitDataAccessRequirements = _initialConfigHealthKitDataAccessRequirements
+        dataAccessRequirements = _initialConfigDataAccessRequirements
         if !HKHealthStore.isHealthDataAvailable() {
             // If HealthKit is not available, we still initialise the module and the health store as normal.
             // Queries and sample collection, in this case, will simply not return any results.
@@ -147,7 +147,7 @@ public final class HealthKit: Module, EnvironmentAccessible, DefaultInitializabl
     /// - Important: You need to call this function at some point during your app's lifecycle, ideally soon after the app was launched.
     @MainActor
     public func askForAuthorization() async throws {
-        try await askForAuthorization(for: healthKitDataAccessRequirements)
+        try await askForAuthorization(for: dataAccessRequirements)
     }
 
 
@@ -164,8 +164,8 @@ public final class HealthKit: Module, EnvironmentAccessible, DefaultInitializabl
     /// - Warning: Only request write access to HealthKit data if your app's `Info.plist` file
     ///     contains an entry for the `NSHealthUpdateUsageDescription` key.
     @MainActor
-    public func askForAuthorization(for accessRequirements: HealthKitDataAccessRequirements) async throws {
-        self.healthKitDataAccessRequirements.merge(with: accessRequirements)
+    public func askForAuthorization(for accessRequirements: DataAccessRequirements) async throws {
+        self.dataAccessRequirements.merge(with: accessRequirements)
         try await healthStore.requestAuthorization(
             toShare: accessRequirements.write,
             read: accessRequirements.read
@@ -262,22 +262,3 @@ public final class HealthKit: Module, EnvironmentAccessible, DefaultInitializabl
         }
     }
 }
-
-
-
-
-
-extension HKHealthStore {
-    // TODO remove?!
-    func spezi_requestPerObjectReadAuthorization(for type: HKObjectType, predicate: NSPredicate?) async throws -> Bool {
-        try await withCheckedThrowingContinuation { continuation in
-            self.requestPerObjectReadAuthorization(for: type, predicate: predicate) { success, error in
-                if let error {
-                    continuation.resume(throwing: error)
-                } else {
-                    continuation.resume(returning: success)
-                }
-            }
-        }
-    }
-}