Skip to content

jaywcjlove/StoreKitHelper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

91 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Using my apps is also a way to support me:
Scap: Screenshot & Markup Edit Screen Test Deskmark Keyzer Vidwall Hub VidCrop Vidwall Mousio Hint Mousio Musicer Audioer FileSentinel FocusCursor Videoer KeyClicker DayBar Iconed Menuist Quick RSS Quick RSS Web Serve Copybook Generator DevTutor for SwiftUI RegexMate Time Passage Iconize Folder Textsound Saver Create Custom Symbols DevHub Resume Revise Palette Genius Symbol Scribe

StoreKit Helper

δΈ­ζ–‡

A lightweight StoreKit2 wrapper designed specifically for SwiftUI, making in-app purchases implementation simpler and more intuitive.

StoreKit Helper

Documentation

Please refer to the detailed StoreKitHelper documentation in DevTutor, which includes multiple quick start examples, custom payment interface examples, and API references, providing comprehensive examples and guidance.

Features

  • πŸš€ SwiftUI Native: Designed specifically for SwiftUI with @ObservableObject and @EnvironmentObject support
  • πŸ’‘ Simple API: Clean and intuitive interface for managing in-app purchases
  • πŸ”„ Automatic Updates: Real-time transaction monitoring and status updates
  • βœ… Type Safe: Protocol-based product definitions with compile-time safety
  • πŸ§ͺ Testable: Fully testable architecture with comprehensive test case coverage ExampleTests.swift/StoreKitHelperTests.swift

Usage

Create and inject a StoreContext instance at your SwiftUI app's entry point, which is responsible for loading the product list and tracking purchase status.

import StoreKitHelper

enum AppProduct: String, InAppProduct {
    case lifetime = "focuscursor.lifetime"
    case monthly = "focuscursor.monthly"
    var id: String { rawValue }
}

@main struct DevTutorApp: App {
    @StateObject var store = StoreContext(products: AppProduct.allCases)
    var body: some Scene {
        WindowGroup {
            ContentView().environmentObject(store)
        }
    }
}

StoreContext exposes a tri-state purchase status. At app launch, purchaseStatus starts as .loading until Transaction.currentEntitlements finishes its first sync. During this stage, hasPurchased and hasNotPurchased both return false, so startup code will not accidentally treat the user as "not purchased".

switch store.purchaseStatus {
case .loading:
    // Purchase state is still being resolved
case .purchased:
    // βœ… User has active purchases
case .notPurchased:
    // 🧾 User has no active purchases
}

Recommended usage:

@EnvironmentObject var store: StoreContext

var body: some View {
    switch store.purchaseStatus {
    case .loading:
        ProgressView("Checking purchases...")
    case .purchased:
        // βœ… User has purchased - show full functionality
    case .notPurchased:
        // 🧾 User hasn't purchased - show limited content or purchase prompt
    }
}

The default purchase call remains unchanged:

await store.purchase(product)

If you need StoreKit purchase options, you can now pass them through directly:

await store.purchase(product, options: [
    .appAccountToken(appAccountToken)
])

Compatible legacy usage:

@EnvironmentObject var store: StoreContext

var body: some View {
    if store.hasResolvedPurchaseStatus == false {
        ProgressView("Checking purchases...")
    } else if store.hasNotPurchased == true {
        // 🧾 User hasn't purchased - show limited content or purchase prompt
    } else if store.hasPurchased == true {
        // βœ… User has purchased - show full functionality
    }
}

StoreKitHelperView

Use StoreKitHelperView to directly display in-app purchase popup views and configure various parameters through a chainable API.

struct PurchaseContent: View {
    @EnvironmentObject var store: StoreContext
    var body: some View {
        let locale: Locale = Locale(identifier: Locale.preferredLanguages.first ?? "en")
        StoreKitHelperView()
            .environment(\.locale, .init(identifier: locale.identifier))
            .environment(\.pricingContent, { AnyView(PricingContent()) })
            .environment(\.popupDismissHandle, {
                // Triggered when the popup is dismissed 
                // (e.g., user clicks the close button)
                store.isShowingPurchasePopup = false
            })
            .environment(\.termsOfServiceHandle, {
                // Action triggered when the [Terms of Service] button is clicked
            })
            .environment(\.privacyPolicyHandle, {
                // Action triggered when the [Privacy Policy] button is clicked
            })
            .frame(maxWidth: 300)
            .frame(minWidth: 260)
    }
}

Click to open the paid product list interface.

struct ContentView: View {
    @EnvironmentObject var store: StoreContext
    var body: some View {
        if store.hasNotPurchased == true, store.isLoading == false {
            PurchasePopupButton()
                .sheet(isPresented: $store.isShowingPurchasePopup) {
                    PurchaseContent()
                }
        }
    }
}

StoreKitHelperSelectionView

Similar to StoreKitHelperView, but for selecting purchase items to make payments.

struct PurchaseContent: View {
    @EnvironmentObject var store: StoreContext
    var body: some View {
        let locale: Locale = Locale(identifier: Locale.preferredLanguages.first ?? "en")
        StoreKitHelperSelectionView()
            .environment(\.locale, .init(identifier: locale.identifier))
            .environment(\.pricingContent, { AnyView(PricingContent()) })
            .environment(\.popupDismissHandle, {
                // Triggered when the popup is dismissed 
                // (e.g., user clicks the close button)
                store.isShowingPurchasePopup = false
            })
            .environment(\.termsOfServiceHandle, {
                // Action triggered when the [Terms of Service] button is clicked
            })
            .environment(\.privacyPolicyHandle, {
                // Action triggered when the [Privacy Policy] button is clicked
            })
            .frame(maxWidth: 300)
            .frame(minWidth: 260)
    }
}

API Reference

InAppProduct Protocol

protocol InAppProduct: CaseIterable {
    var id: String { get }
}

PurchaseStatus

enum PurchaseStatus {
    case loading
    case purchased
    case notPurchased
}

StoreContext Properties

  • products: [Product] - Available products from the App Store
  • purchasedProductIDs: Set<String> - Set of purchased product identifiers
  • purchaseStatus: PurchaseStatus - Current purchase state: .loading, .purchased, or .notPurchased
  • hasResolvedPurchaseStatus: Bool - Whether the initial purchase state sync has completed
  • hasNotPurchased: Bool - Whether the user hasn't purchased any products after purchase state resolution
  • hasPurchased: Bool - Whether the user has purchased any products after purchase state resolution
  • isLoading: Bool - Whether products are currently loading
  • errorMessage: String? - Current error message, if any

StoreContext Methods

  • purchase(_ product: Product, options: Set<Product.PurchaseOption> = []) - Purchase a specific product, optionally forwarding StoreKit purchase options
  • restorePurchases() - Restore previous purchases
  • isPurchased(_ productID: ProductID) -> Bool - Check if a product is purchased by ID
  • isPurchased(_ product: InAppProduct) -> Bool - Check if a product is purchased
  • product(for productID: ProductID) -> Product? - Get product by ID
  • product(for product: InAppProduct) -> Product? - Get product by InAppProduct

License

Licensed under the MIT License.

Sponsor this project

 

Packages

 
 
 

Contributors

Languages