Merge pull request #245 from superwall/feature/purchasing-api

Feature/purchasing-api

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
 

Examples/UIKit+RevenueCat/Superwall-UIKit+RevenueCat.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -6,8 +6,8 @@
         "repositoryURL": "https://github.com/RevenueCat/purchases-ios.git",
         "state": {
           "branch": null,
-          "revision": "0d2f1fa050acad0de99b9b0ce45d53c741c20629",
-          "version": "5.2.1"
+          "revision": "c7058bfd80d7f42ca6aa392bf1fab769d1158bf1",
+          "version": "5.5.0"
         }
       }
     ]

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/Logger/LogScope.swift

@@ -29,6 +29,8 @@ public enum LogScope: Int, Encodable, Sendable, CustomStringConvertible {
   case receipts
   case superwallCore
   case paywallPresentation
+
+  // TODO: In v4 rename to transactions
   case paywallTransactions
   case paywallViewController
   case cache

Sources/SuperwallKit/Misc/Constants.swift

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

Sources/SuperwallKit/Paywall/Presentation/PaywallCloseReason.swift

@@ -42,7 +42,7 @@ public enum PaywallCloseReason: Int, Codable, Equatable, Sendable, CustomStringC
     case .webViewFailedToLoad:
       return "webViewFailedToLoad"
     case .manualClose:
-      return "manualClsoe"
+      return "manualClose"
     case .none:
       return "none"
     }

Sources/SuperwallKit/Paywall/Presentation/PaywallInfo.swift

@@ -4,6 +4,7 @@
 //
 //  Created by Yusuf Tör on 28/02/2022.
 //
+// swiftlint:disable file_length
 
 import Foundation
 import StoreKit
@@ -332,12 +333,12 @@ public final class PaywallInfo: NSObject {
 extension PaywallInfo: Stubbable {
   static func stub() -> PaywallInfo {
     return PaywallInfo(
-      databaseId: "abc",
-      identifier: "1",
-      name: "Test",
-      cacheKey: "cacheKey",
-      buildId: "buildId",
-      url: URL(string: "https://www.google.com")!,
+      databaseId: "test",
+      identifier: "test",
+      name: "test",
+      cacheKey: "test",
+      buildId: "test",
+      url: URL(string: "https://superwall.com")!,
       products: [],
       productItems: [],
       productIds: [],
@@ -361,7 +362,54 @@ extension PaywallInfo: Stubbable {
       computedPropertyRequests: [],
       surveys: [],
       presentation: .init(
-        style: .fullscreen,
+        style: .none,
+        condition: .checkUserSubscription,
+        delay: 0
+      )
+    )
+  }
+
+  /// Used when purchasing internally.
+  static func empty() -> PaywallInfo {
+    return PaywallInfo(
+      databaseId: "",
+      identifier: "",
+      name: "",
+      cacheKey: "",
+      buildId: "",
+      url: URL(string: "https://superwall.com")!,
+      products: [],
+      productItems: [],
+      productIds: [],
+      fromEventData: nil,
+      responseLoadStartTime: nil,
+      responseLoadCompleteTime: nil,
+      responseLoadFailTime: nil,
+      webViewLoadStartTime: nil,
+      webViewLoadCompleteTime: nil,
+      webViewLoadFailTime: nil,
+      productsLoadStartTime: nil,
+      productsLoadFailTime: nil,
+      productsLoadCompleteTime: nil,
+      experiment: .init(
+        id: "0",
+        groupId: "0",
+        variant: .init(
+          id: "0",
+          type: .holdout,
+          paywallId: "0"
+        )
+      ),
+      paywalljsVersion: nil,
+      isFreeTrialAvailable: false,
+      presentationSourceType: "",
+      featureGatingBehavior: .nonGated,
+      closeReason: .none,
+      localNotifications: [],
+      computedPropertyRequests: [],
+      surveys: [],
+      presentation: .init(
+        style: .none,
         condition: .checkUserSubscription,
         delay: 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/PurchaseResult.swift

@@ -59,6 +59,16 @@ public enum PurchaseResult: Sendable, Equatable {
       return false
     }
   }
+
+  func toObjc() -> PurchaseResultObjc {
+    switch self {
+    case .cancelled: return .cancelled
+    case .purchased: return .purchased
+    case .restored: return .restored
+    case .pending: return .pending
+    case .failed: return .failed
+    }
+  }
 }
 
 // MARK: - Objective-C Only

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.