Refactor store service

Author: danielsaidi

RELEASE_NOTES.md

@@ -9,6 +9,18 @@ Until then, deprecated features may be removed in any minor version, and breakin
 
 This version removes deprecated code and adjusts some service terminology.
 
+### ‼️ Breaking Changes
+
+This version updates `StoreService` by renaming `restorePurchases()` to `getValidProductTransations()`.
+
+This should have been done in 0.4. As the function only returned transactions, this was very confusing.
+
+By renaming it, we no longer risk calling it with the intention of restoring purchases, which it didn't do.
+
+We can now use `syncStoreData(to:)` and `restorePurchases(syncWith:)` to perform the exact operation we want.
+
+Since these changes involve protocol changes, the changes are breaking. They should hopefully be easy to fix.  
+
 
 
 ## 0.5

Sources/StoreKitPlus/Services/StandardStoreService.swift

@@ -88,8 +88,7 @@ open class StandardStoreService: StoreService {
         #endif
     }
 
-    @discardableResult
-    open func restorePurchases() async throws -> [Transaction] {
+    open func getValidProductTransations() async throws -> [Transaction] {
         var transactions: [Transaction] = []
         for id in productIds {
             if let transaction = try await getValidTransaction(for: id) {
@@ -104,7 +103,7 @@ open class StandardStoreService: StoreService {
     ) async throws {
         let products = try await getProducts()
         await context.updateProducts(products)
-        try await restorePurchases(syncWith: context)
+        try await restorePurchases(with: context)
     }
 
 
@@ -117,11 +116,8 @@ open class StandardStoreService: StoreService {
         let transaction = try result.verify()
         await transaction.finish()
     }
-
-    /// Try to resolve a valid transaction for a certain ID.
-    ///
-    /// This function will fetch and verify all transactions
-    /// before returning them.
+    
+    /// Get all valid transations for a certain product.
     open func getValidTransaction(
         for productId: ProductID
     ) async throws -> Transaction? {

Sources/StoreKitPlus/Services/StoreService.swift

@@ -19,17 +19,16 @@ public protocol StoreService {
 
     /// Get all available products.
     func getProducts() async throws -> [Product]
+    
+    /// Get all valid product transations.
+    func getValidProductTransations() async throws -> [Transaction]
 
     /// Purchase a certain product.
     @discardableResult
     func purchase(
         _ product: Product
     ) async throws -> (Product.PurchaseResult, Transaction?)
 
-    /// Restore previous purchases.
-    @discardableResult
-    func restorePurchases() async throws -> [Transaction]
-
     /// Sync StoreKit products and purchases to a context.
     func syncStoreData(
         to context: StoreContext
@@ -56,20 +55,10 @@ public extension StoreService {
     /// Restore previous purchases.
     ///
     /// This function will sync the result to the context.
-    @discardableResult
     func restorePurchases(
-        syncWith context: StoreContext
-    ) async throws -> [Transaction] {
-        let result = try await restorePurchases()
-        await context.updatePurchaseTransactions(result)
-        return result
-    }
-}
-
-public extension StoreService {
-
-    @available(*, deprecated, message: "You have to pass in a context now.")
-    func syncStoreData() async throws {
-        try await syncStoreData(to: .init())
+        with context: StoreContext
+    ) async throws {
+        let transactions = try await getValidProductTransations()
+        await context.updatePurchaseTransactions(transactions)
     }
 }

Sources/StoreKitPlus/StoreKitPlus.docc/Getting-Started.md

@@ -113,8 +113,9 @@ Since purchases involve a bunch of steps and can become complicated, you can als
 
 ```swift
 let ids = ["com.your-app.productid"]
+let context = StoreContext()
 let service = StandardStorePurchaseService(productIds: ids)
-let result = try await service.purchase(product)
+let result = try await service.purchase(product, syncWith: context)
 ```
 
 The ``StandardStoreService`` will automatically verify and finish the purchase transactions.
@@ -130,7 +131,7 @@ However, this involves many steps and can become complicated. To make things eas
 ```swift
 let ids = ["com.your-app.productid"]
 let service = StandardStorePurchaseService(productIds: ids)
-try await service.restorePurchases()
+try await service.restorePurchases(with: context)
 ```
 
 The standard service communicates with StoreKit and syncs the result with the provided context.