Adds purchase(_:) and restorePurchases()

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 The changelog for `SuperwallKit`. Also see the [releases](https://github.com/superwall/Superwall-iOS/releases) on GitHub.
 
-## 3.9.2
+## 3.10.0
+
+### Enhancements
+
+- Adds `purchase(_:)` to initiate a purchase of an `SKProduct` via Superwall regardless of whether you are using paywalls or not.
+- Adds `restorePurchases()` to restore purchases via Superwall.
 
 ### Fixes
 

Sources/SuperwallKit/Dependencies/DependencyContainer.swift

@@ -139,6 +139,7 @@ final class DependencyContainer {
       receiptManager: receiptManager,
       sessionEventsManager: sessionEventsManager,
       identityManager: identityManager,
+      storage: storage,
       factory: self
     )
   }
@@ -468,8 +469,14 @@ extension DependencyContainer: PurchasedTransactionsFactory {
     return productPurchaser.coordinator
   }
 
-  func purchase(product: SKProduct) async -> PurchaseResult {
-    return await productPurchaser.purchase(product: product)
+  func purchase(
+    product: SKProduct,
+    isExternal: Bool
+  ) async -> PurchaseResult {
+    return await productPurchaser.purchase(
+      product: product,
+      isExternal: isExternal
+    )
   }
 
   func restorePurchases() async -> RestorationResult {

Sources/SuperwallKit/Dependencies/FactoryProtocols.swift

@@ -140,7 +140,10 @@ protocol TriggerFactory: AnyObject {
 
 protocol PurchasedTransactionsFactory {
   func makePurchasingCoordinator() -> PurchasingCoordinator
-  func purchase(product: SKProduct) async -> PurchaseResult
+  func purchase(
+    product: SKProduct,
+    isExternal: Bool
+  ) async -> PurchaseResult
   func restorePurchases() async -> RestorationResult
 }
 

Sources/SuperwallKit/Documentation.docc/Extensions/SuperwallExtension.md

@@ -56,6 +56,15 @@ The ``Superwall`` class is used to access all the features of the SDK. Before us
 - ``PaywallSkippedReason``
 - ``PaywallSkippedReasonObjc``
 
+### Handling Purchases
+
+- ``purchase(_:)``
+- ``purchase(_:completion:)-6oyxm``
+- ``purchase(_:completion:)-4rj6r``
+- ``restorePurchases()``
+- ``restorePurchases(completion:)-4fx45``
+- ``restorePurchases(completion:)-4cxt5``
+
 ### In-App Previews
 
 - ``handleDeepLink(_:)``

Sources/SuperwallKit/Misc/Constants.swift

@@ -18,5 +18,5 @@ let sdkVersion = """
 */
 
 let sdkVersion = """
-3.9.1
+3.10.0
 """

Sources/SuperwallKit/Storage/Cache/CacheKeys.swift

@@ -176,3 +176,11 @@ enum AdServicesTokenStorage: Storable {
   static var directory: SearchPathDirectory = .userSpecificDocuments
   typealias Value = String
 }
+
+enum SavedTransactions: Storable {
+  static var key: String {
+    "store.savedTransactions"
+  }
+  static var directory: SearchPathDirectory = .appSpecificDocuments
+  typealias Value = Set<SavedTransaction>
+}

Sources/SuperwallKit/StoreKit/Purchase Controller/AutomaticPurchaseController.swift

@@ -32,7 +32,10 @@ final class AutomaticPurchaseController {
 extension AutomaticPurchaseController: PurchaseController {
   @MainActor
   func purchase(product: SKProduct) async -> PurchaseResult {
-    return await factory.purchase(product: product)
+    return await factory.purchase(
+      product: product,
+      isExternal: false
+    )
   }
 
   @MainActor

Sources/SuperwallKit/StoreKit/Purchase Controller/RestorationResult.swift

@@ -14,9 +14,11 @@ import StoreKit
 /// When implementing the ``PurchaseController/restorePurchases()`` delegate
 /// method, all cases should be considered.
 public enum RestorationResult: Sendable, Equatable {
-  /// The restore was successful – this does not mean the user is subscribed, it just means your restore
-  /// logic did not fail due to some error. User will see an alert if `Superwall.shared.subscriptionStatus` is
-  /// not `.active` after returning this value.
+  /// The restore was successful
+  ///
+  /// - Warning: This does not mean the user is subscribed, it just means your restore
+  /// logic did not fail due to some error. User will see an alert if ``Superwall/subscriptionStatus`` is
+  /// not ``SubscriptionStatus/active`` after returning this value.
   case restored
 
   /// The restore failed for some reason (i.e. you were not able to determine if the user has an active subscription.
@@ -31,6 +33,15 @@ public enum RestorationResult: Sendable, Equatable {
       return false
     }
   }
+
+  func toObjc() -> RestorationResultObjc {
+    switch self {
+    case .restored:
+      return .restored
+    case .failed:
+      return .failed
+    }
+  }
 }
 
 /// An enum that defines the possible outcomes of attempting to restore a product.

Sources/SuperwallKit/StoreKit/Transactions/Purchasing/ProductPurchaserSK1.swift

@@ -30,6 +30,7 @@ final class ProductPurchaserSK1: NSObject {
   private let receiptManager: ReceiptManager
   private let sessionEventsManager: SessionEventsManager
   private let identityManager: IdentityManager
+  private let storage: Storage
   private let factory: HasExternalPurchaseControllerFactory & StoreTransactionFactory
 
   deinit {
@@ -41,21 +42,26 @@ final class ProductPurchaserSK1: NSObject {
     receiptManager: ReceiptManager,
     sessionEventsManager: SessionEventsManager,
     identityManager: IdentityManager,
+    storage: Storage,
     factory: HasExternalPurchaseControllerFactory & StoreTransactionFactory
   ) {
     self.storeKitManager = storeKitManager
     self.receiptManager = receiptManager
     self.sessionEventsManager = sessionEventsManager
     self.identityManager = identityManager
     self.factory = factory
+    self.storage = storage
 
     super.init()
     SKPaymentQueue.default().add(self)
   }
 
   /// Purchases a product, waiting for the completion block to be fired and
   /// returning a purchase result.
-  func purchase(product: SKProduct) async -> PurchaseResult {
+  func purchase(
+    product: SKProduct,
+    isExternal: Bool
+  ) async -> PurchaseResult {
     let task = Task {
       return await withCheckedContinuation { continuation in
         Task {
@@ -124,6 +130,7 @@ extension ProductPurchaserSK1: SKPaymentTransactionObserver {
       let paywallViewController = Superwall.shared.paywallViewController
       let purchaseDate = await coordinator.purchaseDate
       for transaction in transactions {
+        await savePurchasedTransaction(transaction)
         await coordinator.storeIfPurchased(transaction)
         await checkForTimeout(of: transaction, in: paywallViewController)
         await updatePurchaseCompletionBlock(for: transaction, purchaseDate: purchaseDate)
@@ -166,15 +173,63 @@ extension ProductPurchaserSK1: SKPaymentTransactionObserver {
     }
   }
 
+  private func savePurchasedTransaction(
+    _ transaction: SKPaymentTransaction
+  ) async {
+    guard transaction.transactionState == .purchased else {
+      return
+    }
+    guard let id = transaction.transactionIdentifier else {
+      return
+    }
+    var savedTransactions = storage.get(SavedTransactions.self) ?? []
+    guard savedTransactions.filter({ $0.id == id }).isEmpty else {
+      return
+    }
+    let isExternal = await coordinator.isExternalPurchase
+    let transaction = SavedTransaction(
+      id: id,
+      date: Date(),
+      hasExternalPurchaseController: factory.makeHasExternalPurchaseController(),
+      isExternal: isExternal
+    )
+    savedTransactions.insert(transaction)
+    storage.save(savedTransactions, forType: SavedTransactions.self)
+  }
+
+  func paymentQueue(_ queue: SKPaymentQueue, removedTransactions transactions: [SKPaymentTransaction]) {
+    // Retrieve saved transactions from storage
+    var savedTransactions = storage.get(SavedTransactions.self) ?? []
+
+    // Filter out the transactions that have been removed
+    let removedTransactionIDs = Set(transactions.compactMap { $0.transactionIdentifier })
+
+    savedTransactions = savedTransactions.filter { savedTransaction in
+      // Keep only transactions that are not in the removedTransactionIDs
+      !removedTransactionIDs.contains(savedTransaction.id)
+    }
+
+    // Save the updated savedTransactions back to storage
+    storage.save(savedTransactions, forType: SavedTransactions.self)
+  }
+
   /// Sends a `PurchaseResult` to the completion block and stores the latest purchased transaction.
   private func updatePurchaseCompletionBlock(
     for skTransaction: SKPaymentTransaction,
     purchaseDate: Date?
   ) async {
-    // Only continue if using internal purchase controller. The transaction may be
+    // Doesn't continue if the purchase was initiated internally and an
+    // external purchase controller is being used. The transaction may be
     // readded to the queue if finishing fails so we need to make sure
     // we can re-finish the transaction.
-    if factory.makeHasExternalPurchaseController() {
+    let savedTransactions = storage.get(SavedTransactions.self) ?? []
+    guard let savedTransaction = savedTransactions.first(
+      where: { $0.id == skTransaction.transactionIdentifier }
+    ) else {
+      return
+    }
+    if !savedTransaction.isExternal,
+      savedTransaction.hasExternalPurchaseController {
       return
     }
 

Sources/SuperwallKit/StoreKit/Transactions/Purchasing/PurchaseSource.swift

@@ -0,0 +1,15 @@
+//
+//  PurchaseSource.swift
+//  SuperwallKit
+//
+//  Created by Yusuf Tör on 01/10/2024.
+//
+
+/// The source of the purchase initiation.
+enum PurchaseSource {
+  /// The purchase was initiated internally by the SDK.
+  case `internal`(String, PaywallViewController)
+
+  /// The purchae was initiated externally by the user calling ``Superwall/purchase(_:)-7gwwe``.
+  case external(StoreProduct)
+}

Sources/SuperwallKit/StoreKit/Transactions/Purchasing/PurchasingCoordinator.swift

@@ -12,6 +12,7 @@ import StoreKit
 actor PurchasingCoordinator {
   private var completion: ((PurchaseResult) -> Void)?
   var productId: String?
+  var isExternalPurchase = false
   var lastInternalTransaction: SKPaymentTransaction?
   var purchaseDate: Date?
   var transactions: [String: SKPaymentTransaction] = [:]
@@ -31,9 +32,13 @@ actor PurchasingCoordinator {
     self.completion = completion
   }
 
-  func beginPurchase(of productId: String) {
+  func beginPurchase(
+    of productId: String,
+    isExternal: Bool
+  ) {
     self.purchaseDate = Date()
     self.productId = productId
+    self.isExternalPurchase = isExternal
   }
 
   /// Gets the latest transaction of a specified product ID. Used with purchases, including when a purchase has

Sources/SuperwallKit/StoreKit/Transactions/Purchasing/SavedTransaction.swift

@@ -0,0 +1,24 @@
+//
+//  SavedTransaction.swift
+//  SuperwallKit
+//
+//  Created by Yusuf Tör on 01/10/2024.
+//
+
+import Foundation
+
+/// The transaction to save to storage.
+struct SavedTransaction: Codable, Hashable {
+  /// The transaction id.
+  let id: String
+
+  /// The date the transaction was created.
+  let date: Date
+
+  /// Whether or not the developer is using a purchase controller.
+  let hasExternalPurchaseController: Bool
+
+  /// Indicates whether the purchase was initiated externally via the
+  /// developer rather than internally via the SDK.
+  let isExternal: Bool
+}