Rename cleanUp to signOut

tryVital · Feb 23, 2024 · 0d6a967 · 0d6a967
1 parent 93ad906
commit 0d6a967
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/Examples/iOS/Settings/Settings.swift b/Examples/iOS/Settings/Settings.swift
@@ -227,7 +227,7 @@ let settingsReducer = Reducer<Settings.State, Settings.Action, Settings.Environm
 
     case .resetSDK:
       return .task {
-        await VitalHealthKitClient.shared.cleanUp()
+        await VitalClient.shared.signOut()
         return .didResetSDK
       }
 

diff --git a/Sources/VitalCore/Core/Client/VitalClient.swift b/Sources/VitalCore/Core/Client/VitalClient.swift
@@ -399,7 +399,7 @@ public let health_secureStorageKey: String = "health_secureStorageKey"
       .filter { $0 == .userNoLongerValid }
       .sink { _ in
         Task {
-          await client.cleanUp()
+          await client.signOut()
         }
       }
       .store(in: &client.cancellables)
@@ -563,8 +563,13 @@ public let health_secureStorageKey: String = "health_secureStorageKey"
 
     storage.storeConnectedSource(for: userId, with: provider)
   }
-
+
+  @available(*, deprecated, message:"Renamed to `signOut()`.", renamed: "signOut")
   public func cleanUp() async {
+    await signOut()
+  }
+
+  public func signOut() async {
     /// Here we remove the following:
     /// 1) Anchor values we are storing for each `HKSampleType`.
     /// 2) Stage for each `HKSampleType`.

diff --git a/Sources/VitalHealthKit/HealthKit/HealthKitReads.swift b/Sources/VitalHealthKit/HealthKit/HealthKitReads.swift
@@ -392,7 +392,7 @@ func handleBody(
     type: .quantityType(forIdentifier: .bodyMass)!
   )
 
-  var (bodyFatPercentage, bodyFatPercentageAnchor) = try await queryQuantities(
+  let (bodyFatPercentage, bodyFatPercentageAnchor) = try await queryQuantities(
     type: .quantityType(forIdentifier: .bodyFatPercentage)!
   )
 

diff --git a/Sources/VitalHealthKit/HealthKit/VitalHealthKitClient.swift b/Sources/VitalHealthKit/HealthKit/VitalHealthKitClient.swift
@@ -483,9 +483,10 @@ extension VitalHealthKitClient {
       _status.send(.syncingCompleted)
     }
   }
-
+
+  @available(*, deprecated, message: "Use `VitalClient.shared.signOut()`, which now resets both the Vital Core and Health SDKs.")
   public func cleanUp() async {
-    await VitalClient.shared.cleanUp()
+    await VitalClient.shared.signOut()
   }
 
   private func resetAutoSync() async {