feat: add workout types

Author: Ivan Mikhailovskii

ios/FitnessDataType.swift

@@ -22,6 +22,7 @@ enum FitnessDataType: String {
     case stepCount = "HKQuantityTypeIdentifierStepCount"
     case swimmingStrokeCount = "HKQuantityTypeIdentifierSwimmingStrokeCount"
     case underwaterDepth = "HKQuantityTypeIdentifieUnderwaterDepth"
+    case heartRate = "HKQuantityTypeIdentifierHeartRate"
 
     func defaultUnit() -> String {
         if self == .distanceWalkingRunning {

ios/HKSample+Extensions.swift

@@ -2,7 +2,9 @@ import HealthKit
 
 extension HKSample {
 
-    func convertToDictionary() -> [String: Any]? {
+    func convertToDictionary(
+      healthStore: HKHealthStore
+    ) async -> [String: Any]? {
         guard let workout: HKWorkout = self as? HKWorkout else {
             return nil
         }
@@ -13,6 +15,11 @@ extension HKSample {
         let isoStartDate = self.formatUtcIsoDateTimeString(workout.startDate)
         let isoEndDate = self.formatUtcIsoDateTimeString(workout.endDate)
 
+        let analysisHeartRate = try? await analyzeWorkoutHeartRate(
+          workout: workout,
+          healthStore: healthStore
+        )
+
         var dataRecords = [
             "uuid": workout.uuid.uuidString as Any,
             "duration": workout.duration as Any,
@@ -21,6 +28,9 @@ extension HKSample {
             "distance": distance as Any,
             "type": workout.workoutActivityType.rawValue as Any,
             "metadata": workout.metadata as Any,
+            "heartRateAverage": analysisHeartRate?.averageBPM as Any,
+            "heartRateMin": analysisHeartRate?.minBPM as Any,
+            "heartRateMax": analysisHeartRate?.maxBPM as Any,
             "source": [
                 "name": workout.sourceRevision.source.name as Any,
                 "device": sourceDevice as Any,
@@ -40,3 +50,145 @@ extension HKSample {
     }
 }
 
+@available(iOS 15.0, *)
+func analyzeWorkoutHeartRate(
+    workout: HKWorkout,
+    healthStore: HKHealthStore
+) async throws -> WorkoutHeartRateAnalysis {
+    async let average = workout.averageHeartRate(healthStore: healthStore)
+    async let max = workout.maxHeartRate(healthStore: healthStore)
+    async let min = workout.minHeartRate(healthStore: healthStore)
+    async let samples = workout.heartRateSamples(healthStore: healthStore)
+
+    return try await WorkoutHeartRateAnalysis(
+        averageBPM: average,
+        maxBPM: max,
+        minBPM: min,
+        samples: samples
+    )
+}
+
+// MARK: - Data Model
+
+struct WorkoutHeartRateAnalysis {
+    let averageBPM: Double?
+    let maxBPM: Double?
+    let minBPM: Double?
+    let samples: [HeartRateSample]
+
+    struct HeartRateSample {
+        let value: Double
+        let timestamp: Date
+    }
+}
+
+@available(iOS 15.0, *)
+extension HKWorkout {
+
+  func averageHeartRate(
+    healthStore: HKHealthStore
+  ) async throws -> Double? {
+    try await getHeartRateStatistic(
+      healthStore: healthStore,
+      options: .discreteAverage
+    )
+  }
+
+  func maxHeartRate(
+    healthStore: HKHealthStore
+  ) async throws -> Double? {
+    try await getHeartRateStatistic(
+      healthStore: healthStore,
+      options: .discreteMax
+    )
+  }
+
+  func minHeartRate(
+    healthStore: HKHealthStore
+  ) async throws -> Double? {
+    try await getHeartRateStatistic(
+      healthStore: healthStore,
+      options: .discreteMin
+    )
+  }
+
+  func heartRateSamples(
+    healthStore: HKHealthStore
+  ) async throws -> [WorkoutHeartRateAnalysis.HeartRateSample] {
+    guard let heartRateType = HKQuantityType.quantityType(forIdentifier: .heartRate) else {
+      throw HKError(.errorInvalidArgument)
+    }
+
+    let predicate = HKQuery.predicateForSamples(
+      withStart: startDate,
+      end: endDate,
+      options: .strictStartDate
+    )
+
+    let samples: [HKQuantitySample] = try await withCheckedThrowingContinuation { continuation in
+      let query = HKSampleQuery(
+        sampleType: heartRateType,
+        predicate: predicate,
+        limit: HKObjectQueryNoLimit,
+        sortDescriptors: [.init(key: HKSampleSortIdentifierStartDate, ascending: true)]
+      ) { _, samples, error in
+        if let error = error {
+          continuation.resume(throwing: error)
+        } else {
+          continuation.resume(returning: (samples as? [HKQuantitySample]) ?? [])
+        }
+      }
+      healthStore.execute(query)
+    }
+
+    return samples.map {
+      WorkoutHeartRateAnalysis.HeartRateSample(
+        value: $0.quantity.doubleValue(for: .heartRateUnit),
+        timestamp: $0.startDate
+      )
+    }
+  }
+
+  private func getHeartRateStatistic(
+      healthStore: HKHealthStore,
+      options: HKStatisticsOptions
+  ) async throws -> Double? {
+      guard let heartRateType = HKQuantityType.quantityType(forIdentifier: .heartRate) else {
+        throw HKError(.errorInvalidArgument)
+      }
+
+      let stats: HKStatistics = try await withCheckedThrowingContinuation { continuation in
+          let query = HKStatisticsQuery(
+              quantityType: heartRateType,
+              quantitySamplePredicate: HKQuery.predicateForSamples(
+                  withStart: startDate,
+                  end: endDate,
+                  options: .strictStartDate
+              ),
+              options: options
+          ) { _, statistics, error in
+              if let error = error {
+                  continuation.resume(throwing: error)
+              } else if let stats = statistics {
+                  continuation.resume(returning: stats)
+              } else {
+                continuation.resume(throwing: HKError(.errorNoData))
+              }
+          }
+          healthStore.execute(query)
+      }
+
+      switch options {
+      case .discreteAverage: return stats.averageQuantity()?.doubleValue(for: .heartRateUnit)
+      case .discreteMax: return stats.maximumQuantity()?.doubleValue(for: .heartRateUnit)
+      case .discreteMin: return stats.minimumQuantity()?.doubleValue(for: .heartRateUnit)
+      default: return nil
+      }
+  }
+}
+
+extension HKUnit {
+    static var heartRateUnit: HKUnit {
+        HKUnit(from: "count/min")
+    }
+}

ios/HKTypeData.swift

@@ -23,4 +23,5 @@ enum HKTypeData: String {
     case appleStandTime = "HKQuantityTypeIdentifierAppleStandTime"
     case VO2Max = "HKQuantityTypeIdentifierVO2Max"
     case lowCardioFitnessEvent = "HKCategoryTypeIdentifierLowCardioFitnessEvent"
+    case heartRate = "HKQuantityTypeIdentifierHeartRate"
 }

ios/SQFitnessStatistic.swift

@@ -21,7 +21,8 @@ public class SQFitnessStatistic: NSObject {
                 .workout,
                 .stepCount,
                 .distanceCycling,
-                .distanceWalkingRunning
+                .distanceWalkingRunning,
+                .heartRate
             ],
             complete: { resolve(true) },
             handleError: { error in

ios/SQHealthKitManager.swift

@@ -77,11 +77,19 @@ class SQHealthKitManager {
                 return
             }
 
-            let dataRecords: [Dictionary] = samples?.compactMap {
-                $0.convertToDictionary()
-            } ?? []
+          Task {
+            var dataRecords = [Dictionary<String, Any>]()
+
+            for sample in samples ?? [] {
+              guard let workout = await sample.convertToDictionary(
+                healthStore: self.healthStore
+              ) else { continue }
+
+              dataRecords.append(workout)
+            }
 
             complete(dataRecords)
+          }
         }
 
         self.healthStore.execute(query)