Implement auto-detection of active subscriptions

Sources/Flare/Classes/Extensions/Product.SubscriptionInfo.Status+ISubscriptionInfoStatus.swift

@@ -0,0 +1,24 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import struct StoreKit.Product
+
+// MARK: - ISubscriptionInfoStatus
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+extension Product.SubscriptionInfo.Status: ISubscriptionInfoStatus {
+    var renewalState: RenewalState {
+        RenewalState(self.state)
+    }
+
+    var subscriptionRenewalInfo: VerificationResult<RenewalInfo> {
+        switch self.renewalInfo {
+        case let .verified(renewalInfo):
+            return .verified(.init(renewalInfo: renewalInfo))
+        case let .unverified(renewalInfo, error):
+            return .unverified(.init(renewalInfo: renewalInfo), error)
+        }
+    }
+}

Sources/Flare/Classes/Flare.swift

@@ -140,7 +140,7 @@ extension Flare: IFlare {
         await iapProvider.finish(transaction: transaction)
     }
 
-    public func addTransactionObserver(fallbackHandler: Closure<Result<PaymentTransaction, IAPError>>?) {
+    public func addTransactionObserver(fallbackHandler: Closure<Result<StoreTransaction, IAPError>>?) {
         iapProvider.addTransactionObserver(fallbackHandler: fallbackHandler)
     }
 

Sources/Flare/Classes/IFlare.swift

@@ -135,7 +135,7 @@ public protocol IFlare {
     /// The transactions array will only be synchronized with the server while the queue has observers.
     ///
     /// - Note: This may require that the user authenticate.
-    func addTransactionObserver(fallbackHandler: Closure<Result<PaymentTransaction, IAPError>>?)
+    func addTransactionObserver(fallbackHandler: Closure<Result<StoreTransaction, IAPError>>?)
 
     /// Removes transaction observer from the payment queue.
     /// The transactions array will only be synchronized with the server while the queue has observers.

Sources/Flare/Classes/Listeners/TransactionListener/ITransactionListener.swift

@@ -20,4 +20,6 @@ protocol ITransactionListener: Sendable {
     /// - Note: Available on iOS 15.0+, tvOS 15.0+, macOS 12.0+, watchOS 8.0+.
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func handle(purchaseResult: StoreKit.Product.PurchaseResult) async throws -> StoreTransaction?
+
+    func set(delegate: TransactionListenerDelegate) async
 }

Sources/Flare/Classes/Listeners/TransactionListener/TransactionListener.swift

@@ -19,24 +19,33 @@ actor TransactionListener {
     private let updates: AsyncStream<TransactionResult>
     private var task: Task<Void, Never>?
 
+    private weak var delegate: TransactionListenerDelegate?
+
     // MARK: Initialization
 
-    init<S: AsyncSequence>(updates: S) where S.Element == TransactionResult {
+    init<S: AsyncSequence>(delegate: TransactionListenerDelegate? = nil, updates: S) where S.Element == TransactionResult {
+        self.delegate = delegate
         self.updates = updates.toAsyncStream()
     }
 
     // MARK: Private
 
     private func handle(
         transactionResult: TransactionResult,
-        fromTransactionUpdate _: Bool
+        fromTransactionUpdate: Bool
     ) async throws -> StoreTransaction {
         switch transactionResult {
         case let .verified(transaction):
-            return StoreTransaction(
+            let transaction = StoreTransaction(
                 transaction: transaction,
                 jwtRepresentation: transactionResult.jwsRepresentation
             )
+
+            if fromTransactionUpdate {
+                delegate?.transactionListener(self, transactionDidUpdate: .success(transaction))
+            }
+
+            return transaction
         case let .unverified(transaction, verificationError):
             Logger.info(
                 message: L10n.Purchase.transactionUnverified(
@@ -45,9 +54,15 @@ actor TransactionListener {
                 )
             )
 
-            throw IAPError.verification(
-                error: .unverified(productID: transaction.productID, error: verificationError)
+            let error = IAPError.verification(
+                error: .init(verificationError)
             )
+
+            if fromTransactionUpdate {
+                delegate?.transactionListener(self, transactionDidUpdate: .failure(error))
+            }
+
+            throw error
         }
     }
 }
@@ -56,6 +71,10 @@ actor TransactionListener {
 
 @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
 extension TransactionListener: ITransactionListener {
+    func set(delegate: TransactionListenerDelegate) {
+        self.delegate = delegate
+    }
+
     func listenForTransaction() async {
         task?.cancel()
         task = Task(priority: .utility) { [weak self] in

Sources/Flare/Classes/Listeners/TransactionListener/TransactionListenerDelegate.swift

@@ -0,0 +1,13 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+
+protocol TransactionListenerDelegate: AnyObject {
+    func transactionListener(
+        _ transactionListener: ITransactionListener,
+        transactionDidUpdate result: Result<StoreTransaction, IAPError>
+    )
+}

Sources/Flare/Classes/Models/ExpirationReason.swift

@@ -0,0 +1,37 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+import StoreKit
+
+// MARK: - ExpirationReason
+
+public enum ExpirationReason {
+    case autoRenewDisabled
+    case billingError
+    case didNotConsentToPriceIncrease
+    case productUnavailable
+    case unknown
+}
+
+extension ExpirationReason {
+    @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+    init(expirationReason: Product.SubscriptionInfo.RenewalInfo.ExpirationReason) {
+        switch expirationReason {
+        case .autoRenewDisabled:
+            self = .autoRenewDisabled
+        case .billingError:
+            self = .billingError
+        case .didNotConsentToPriceIncrease:
+            self = .didNotConsentToPriceIncrease
+        case .productUnavailable:
+            self = .productUnavailable
+        case .unknown:
+            self = .unknown
+        default:
+            self = .unknown
+        }
+    }
+}

Sources/Flare/Classes/Models/Internal/Protocols/IRenewalInfo.swift

@@ -0,0 +1,46 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+import StoreKit
+
+public protocol IRenewalInfo {
+    /// The JSON representation of the renewal information.
+    var jsonRepresentation: Data { get }
+
+    /// The original transaction identifier for the subscription group.
+    var originalTransactionID: UInt64 { get }
+
+    /// The currently active product identifier, or the most recently active product identifier if the
+    /// subscription is expired.
+    var currentProductID: String { get }
+
+    /// Whether the subscription will auto renew at the end of the current billing period.
+    var willAutoRenew: Bool { get }
+
+    /// The product identifier the subscription will auto renew to at the end of the current billing period.
+    ///
+    /// If the user disabled auto renewing, this property will be `nil`.
+    var autoRenewPreference: String? { get }
+
+    /// The reason the subscription expired.
+    var expirationReason: ExpirationReason? { get }
+
+    /// The status of a price increase for the user.
+    var priceIncreaseStatus: PriceIncreaseStatus { get }
+
+    /// Whether the subscription is in a billing retry period.
+    var isInBillingRetry: Bool { get }
+
+    /// The date the billing grace period will expire.
+    var gracePeriodExpirationDate: Date? { get }
+
+    /// Identifies the offer that will be applied to the next billing period.
+    ///
+    /// If `offerType` is `promotional`, this will be the offer identifier. If `offerType` is
+    /// `code`, this will be the offer code reference name. This will be `nil` for `introductory`
+    /// offers and if there will be no offer applied for the next billing period.
+    var offerID: String? { get }
+}

Sources/Flare/Classes/Models/Internal/Protocols/ISKProduct.swift

@@ -42,4 +42,7 @@ protocol ISKProduct {
 
     /// The subscription group identifier.
     var subscriptionGroupIdentifier: String? { get }
+
+    /// The subscription info.
+    var subscription: SubscriptionInfo? { get }
 }

Sources/Flare/Classes/Models/Internal/Protocols/ISubscriptionInfo.swift

@@ -0,0 +1,10 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+
+protocol ISubscriptionInfo {
+    var subscriptionStatus: [SubscriptionInfoStatus] { get async throws }
+}

Sources/Flare/Classes/Models/Internal/Protocols/ISubscriptionInfoStatus.swift

@@ -0,0 +1,11 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+
+protocol ISubscriptionInfoStatus {
+    var renewalState: RenewalState { get }
+    var subscriptionRenewalInfo: VerificationResult<RenewalInfo> { get }
+}

Sources/Flare/Classes/Models/Internal/SK1StoreProduct.swift

@@ -77,4 +77,8 @@ extension SK1StoreProduct: ISKProduct {
     var subscriptionGroupIdentifier: String? {
         product.subscriptionGroupIdentifier
     }
+
+    var subscription: SubscriptionInfo? {
+        nil
+    }
 }

Sources/Flare/Classes/Models/Internal/SK2RenewalInfo.swift

@@ -0,0 +1,69 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import StoreKit
+
+// MARK: - SK2RenewalInfo
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+struct SK2RenewalInfo {
+    // MARK: Properties
+
+    let underlyingRenewalInfo: Product.SubscriptionInfo.RenewalInfo
+
+    // MARK: Initialization
+
+    init(underlyingRenewalInfo: Product.SubscriptionInfo.RenewalInfo) {
+        self.underlyingRenewalInfo = underlyingRenewalInfo
+    }
+}
+
+// MARK: IRenewalInfo
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+extension SK2RenewalInfo: IRenewalInfo {
+    var jsonRepresentation: Data {
+        underlyingRenewalInfo.jsonRepresentation
+    }
+
+    var originalTransactionID: UInt64 {
+        underlyingRenewalInfo.originalTransactionID
+    }
+
+    var willAutoRenew: Bool {
+        underlyingRenewalInfo.willAutoRenew
+    }
+
+    var autoRenewPreference: String? {
+        underlyingRenewalInfo.autoRenewPreference
+    }
+
+    var isInBillingRetry: Bool {
+        underlyingRenewalInfo.isInBillingRetry
+    }
+
+    var gracePeriodExpirationDate: Date? {
+        underlyingRenewalInfo.gracePeriodExpirationDate
+    }
+
+    var offerID: String? {
+        underlyingRenewalInfo.offerID
+    }
+
+    var currentProductID: String {
+        underlyingRenewalInfo.currentProductID
+    }
+
+    var expirationReason: ExpirationReason? {
+        guard let expirationReason = self.underlyingRenewalInfo.expirationReason else {
+            return nil
+        }
+        return ExpirationReason(expirationReason: expirationReason)
+    }
+
+    var priceIncreaseStatus: PriceIncreaseStatus {
+        PriceIncreaseStatus(underlyingRenewalInfo.priceIncreaseStatus)
+    }
+}

Sources/Flare/Classes/Models/Internal/SK2StoreProduct.swift

@@ -85,4 +85,11 @@ extension SK2StoreProduct: ISKProduct {
     var subscriptionGroupIdentifier: String? {
         product.subscription?.subscriptionGroupID
     }
+
+    var subscription: SubscriptionInfo? {
+        guard let subscription = product.subscription else {
+            return nil
+        }
+        return SubscriptionInfo(subscriptionInfo: subscription)
+    }
 }

Sources/Flare/Classes/Models/Internal/SK2SubscriptionInfo.swift

@@ -0,0 +1,32 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import StoreKit
+
+// MARK: - SK2SubscriptionInfo
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+struct SK2SubscriptionInfo {
+    // MARK: Properties
+
+    private let underlyingInfo: Product.SubscriptionInfo
+
+    // MARK: Initialization
+
+    init(underlyingInfo: Product.SubscriptionInfo) {
+        self.underlyingInfo = underlyingInfo
+    }
+}
+
+// MARK: ISubscriptionInfo
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+extension SK2SubscriptionInfo: ISubscriptionInfo {
+    var subscriptionStatus: [SubscriptionInfoStatus] {
+        get async throws {
+            try await self.underlyingInfo.status.map { SubscriptionInfoStatus(underlyingStatus: $0) }
+        }
+    }
+}