mirror of
https://github.com/jaywcjlove/StoreKitHelper
synced 2026-04-21 13:37:20 +00:00
202 lines
12 KiB
Markdown
Executable file
202 lines
12 KiB
Markdown
Executable file
<div markdown="1">
|
|
<sup>Using <a href="https://wangchujiang.com/#/app" target="_blank">my apps</a> is also a way to <a href="https://wangchujiang.com/#/sponsor" target="_blank">support</a> me:</sup>
|
|
<br>
|
|
<a target="_blank" href="https://apps.apple.com/app/Deskmark/6755948110" title="Deskmark for macOS"><img alt="Deskmark" height="52" width="52" src="https://wangchujiang.com/appicon/deskmark.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/Keyzer/6500434773" title="Keyzer for macOS"><img alt="Keyzer" height="52" width="52" src="https://wangchujiang.com/appicon/keyzer.png"></a>
|
|
<a target="_blank" href="https://github.com/jaywcjlove/vidwall-hub" title="Vidwall Hub for macOS"><img alt="Vidwall Hub" height="52" width="52" src="https://wangchujiang.com/appicon/vidwall-hub.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/VidCrop/6752624705" title="VidCrop for macOS"><img alt="VidCrop" height="52" width="52" src="https://wangchujiang.com/appicon/vidcrop.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/Vidwall/6747587746" title="Vidwall for macOS"><img alt="Vidwall" height="52" width="52" src="https://wangchujiang.com/appicon/vidwall.png"></a>
|
|
<a target="_blank" href="https://wangchujiang.com/mousio-hint/" title="Mousio Hint for macOS"><img alt="Mousio Hint" height="52" width="52" src="https://wangchujiang.com/appicon/mousio-hint.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6746747327" title="Mousio for macOS"><img alt="Mousio" height="52" width="52" src="https://wangchujiang.com/appicon/mousio.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6745227444" title="Musicer for macOS"><img alt="Musicer" height="52" width="52" src="https://wangchujiang.com/appicon/musicer.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6743841447" title="Audioer for macOS"><img alt="Audioer" height="52" width="52" src="https://wangchujiang.com/appicon/audioer.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6744690194" title="FileSentinel for macOS"><img alt="FileSentinel" height="52" width="52" src="https://wangchujiang.com/appicon/file-sentinel.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6743495172" title="FocusCursor for macOS"><img alt="FocusCursor" height="52" width="52" src="https://wangchujiang.com/appicon/focus-cursor.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6742680573" title="Videoer for macOS"><img alt="Videoer" height="52" width="52" src="https://wangchujiang.com/appicon/videoer.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6740425504" title="KeyClicker for macOS"><img alt="KeyClicker" height="52" width="52" src="https://wangchujiang.com/appicon/key-clicker.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6739052447" title="DayBar for macOS"><img alt="DayBar" height="52" width="52" src="https://wangchujiang.com/appicon/daybar.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6739444407" title="Iconed for macOS"><img alt="Iconed" height="52" width="52" src="https://wangchujiang.com/appicon/iconed.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6737160756" title="Mousio for macOS"><img alt="Mousio" height="52" width="52" src="https://wangchujiang.com/appicon/rightmenu-master.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6723903021" title="Paste Quick for macOS"><img alt="Quick RSS" height="52" width="52" src="https://wangchujiang.com/appicon/paste-quick.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6670696072" title="Quick RSS for macOS/iOS"><img alt="Quick RSS" height="52" width="52" src="https://wangchujiang.com/appicon/quick-rss.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6670167443" title="Web Serve for macOS"><img alt="Web Serve" height="52" width="52" src="https://wangchujiang.com/appicon/web-serve.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6503953628" title="Copybook Generator for macOS/iOS"><img alt="Copybook Generator" height="52" width="52" src="https://wangchujiang.com/appicon/copybook-generator.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6471227008" title="DevTutor for macOS/iOS"><img alt="DevTutor for SwiftUI" height="52" width="52" src="https://wangchujiang.com/appicon/devtutor.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6479819388" title="RegexMate for macOS/iOS"><img alt="RegexMate" height="52" width="52" src="https://wangchujiang.com/appicon/regex-mate.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6479194014" title="Time Passage for macOS/iOS"><img alt="Time Passage" height="52" width="52" src="https://wangchujiang.com/appicon/time-passage.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6478772538" title="IconizeFolder for macOS"><img alt="Iconize Folder" height="52" width="52" src="https://wangchujiang.com/appicon/iconize-folder.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6478511402" title="Textsound Saver for macOS/iOS"><img alt="Textsound Saver" height="52" width="52" src="https://wangchujiang.com/appicon/textsound-saver.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6476924627" title="Create Custom Symbols for macOS"><img alt="Create Custom Symbols" height="52" width="52" src="https://wangchujiang.com/appicon/create-custom-symbols.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6476452351" title="DevHub for macOS"><img alt="DevHub" height="52" width="52" src="https://wangchujiang.com/appicon/devhub.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6476400184" title="Resume Revise for macOS"><img alt="Resume Revise" height="52" width="52" src="https://wangchujiang.com/appicon/resume-revise.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6472593276" title="Palette Genius for macOS"><img alt="Palette Genius" height="52" width="52" src="https://wangchujiang.com/appicon/palette-genius.png"></a>
|
|
<a target="_blank" href="https://apps.apple.com/app/6470879005" title="Symbol Scribe for macOS"><img alt="Symbol Scribe" height="52" width="52" src="https://wangchujiang.com/appicon/symbol-scribe.png"></a>
|
|
</div>
|
|
<hr>
|
|
|
|
StoreKit Helper
|
|
===
|
|
|
|
[中文](./README.zh.md)
|
|
|
|
A lightweight StoreKit2 wrapper designed specifically for SwiftUI, making in-app purchases implementation simpler and more intuitive.
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
Please refer to the detailed `StoreKitHelper` [documentation](https://github.com/jaywcjlove/devtutor) in [DevTutor](https://github.com/jaywcjlove/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
|
|
|
|
## 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.
|
|
|
|
```swift
|
|
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)
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
You can use the `hasNotPurchased` or `hasPurchased` properties in `StoreContext` to check if the user has made a purchase, then dynamically display different interface content. For example:
|
|
|
|
```swift
|
|
@EnvironmentObject var store: StoreContext
|
|
|
|
var body: some View {
|
|
if store.hasNotPurchased == true {
|
|
// 🧾 User hasn't purchased - show limited content or purchase prompt
|
|
} else {
|
|
// ✅ User has purchased - show full functionality
|
|
}
|
|
if store.hasPurchased == true {
|
|
// ✅ User has purchased - show full functionality
|
|
} else {
|
|
// 🧾 User hasn't purchased - show limited content or purchase prompt
|
|
}
|
|
}
|
|
```
|
|
|
|
## StoreKitHelperView
|
|
|
|
Use `StoreKitHelperView` to directly display in-app purchase popup views and configure various parameters through a chainable API.
|
|
|
|
```swift
|
|
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.
|
|
|
|
```swift
|
|
struct ContentView: View {
|
|
@EnvironmentObject var store: StoreContext
|
|
var body: some View {
|
|
if store.hasNotPurchased == true {
|
|
PurchasePopupButton()
|
|
.sheet(isPresented: $store.isShowingPurchasePopup) {
|
|
PurchaseContent()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## StoreKitHelperSelectionView
|
|
|
|
Similar to `StoreKitHelperView`, but for selecting purchase items to make payments.
|
|
|
|
```swift
|
|
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
|
|
|
|
```swift
|
|
protocol InAppProduct: CaseIterable {
|
|
var id: String { get }
|
|
}
|
|
```
|
|
|
|
### StoreContext Properties
|
|
|
|
- `products: [Product]` - Available products from the App Store
|
|
- `purchasedProductIDs: Set<String>` - Set of purchased product identifiers
|
|
- `hasNotPurchased: Bool` - Whether the user hasn't purchased any products
|
|
- `hasPurchased: Bool` - Whether the user has purchased any products
|
|
- `isLoading: Bool` - Whether products are currently loading
|
|
- `errorMessage: String?` - Current error message, if any
|
|
|
|
### StoreContext Methods
|
|
|
|
- `purchase(_ product: Product)` - Purchase a specific product
|
|
- `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.
|