feat: deprecate platform field and ios/android props by hyochan · Pull Request #49 · hyodotdev/openiap

hyochan · 2025-12-08T18:33:27Z

Add IapStore enum (Unknown, Apple, Google, Horizon)
Add store field to PurchaseCommon interface
Deprecate platform field in favor of store
Deprecate ios/android props in requestPurchase/requestSubscription
Add apple/google props as replacements
Update all example codes and documentation
Add v1.3.0 release notes with migration guide

Summary by CodeRabbit

New Features
- Added a unified store property (apple/google/horizon/unknown) on purchases and request payloads; request payloads now use apple/google keys.
Deprecated
- Legacy platform fields are deprecated — migrate to store.
Documentation
- Docs updated with migration guidance and examples for v1.3.0.
Tests
- Test fixtures updated to include the new store field.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

- Add IapStore enum (Unknown, Apple, Google, Horizon) - Add store field to PurchaseCommon interface - Deprecate platform field in favor of store - Deprecate ios/android props in requestPurchase/requestSubscription - Add apple/google props as replacements - Update all example codes and documentation - Add v1.3.0 release notes with migration guide

coderabbitai · 2025-12-08T18:33:48Z

Warning

Rate limit exceeded

@hyochan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 34871eb and 93e0bbb.

📒 Files selected for processing (3)

packages/docs/src/pages/docs/apis.tsx (5 hunks)
packages/docs/src/pages/docs/types.tsx (12 hunks)
packages/google/openiap/src/test/java/dev/hyo/openiap/PurchaseVerificationValidatorTest.kt (3 hunks)

Walkthrough

This pull request introduces IapStore (replacing IapkitStore) with unknown and horizon variants, adds a unified store: IapStore property across purchase models (deprecating platform), updates purchase construction to set store values, and renames platform-specific request fields from ios/android to apple/google across code, tests, GraphQL schema, and docs.

Changes

Cohort / File(s)	Summary
Core Store Type Definition `packages/apple/Sources/Models/Types.swift`, `packages/google/openiap/src/main/java/dev/hyo/openiap/Types.kt`, `packages/gql/src/type.graphql`	Replaced `IapkitStore` with `IapStore` (adds `unknown`, `horizon`). Updated (de)serialization to use `IapStore` and switched result types to `IapStore`.
Purchase Models — Store Property Addition `packages/apple/Sources/Models/Types.swift`, `packages/apple/Sources/Helpers/StoreKitTypesBridge.swift`, `packages/apple/Sources/OpenIapModule+ObjC.swift`, `packages/apple/Sources/OpenIapModule.swift`, `packages/google/openiap/src/main/java/dev/hyo/openiap/Types.kt`, `packages/google/openiap/src/play/java/dev/hyo/openiap/utils/BillingConverters.kt`, `packages/google/openiap/src/horizon/java/dev/hyo/openiap/utils/BillingConverters.kt`	Added `store: IapStore` to `PurchaseCommon`, `PurchaseIOS`, and `PurchaseAndroid`; marked `platform` as deprecated. Updated all purchase construction sites to set `store` (`.apple`, `.google`, `.horizon`) and added `transactionDate` in some Apple minimal constructions.
Platform → Store Request Structures `packages/apple/Sources/Models/Types.swift`, `packages/google/openiap/src/main/java/dev/hyo/openiap/Types.kt`, `packages/gql/src/type.graphql`	Added `apple` and `google` fields to `RequestPurchasePropsByPlatforms` and `RequestSubscriptionPropsByPlatforms`; deprecated `ios`/`android`. Updated JSON parsing/serializing to accept both old and new keys.
GraphQL Schema Updates `packages/gql/src/type-ios.graphql`, `packages/gql/src/type-android.graphql`, `packages/gql/src/type.graphql`	Added `store: IapStore!` to purchase types, deprecated `platform` with `@deprecated` annotations, expanded `IapStore` enum, and added `store` to relevant inputs/results.
Verification & Payload Building `packages/apple/Sources/OpenIapModule.swift`, `packages/google/openiap/src/main/java/dev/hyo/openiap/utils/PurchaseVerificationValidator.kt`	Switched verification/payload builders to use `IapStore`. Extended handling to include `.horizon` and error on `.unknown`. Adjusted payload building and parsing to work with `IapStore`.
Kotlin Codegen Update `packages/gql/scripts/generate-kotlin-types.mjs`	Added logic to detect interface-implemented fields and emit `override` for generated Kotlin data class fields (adds `needsOverride` tracking).
Tests `packages/apple/Tests/OpenIapTests/VerifyPurchaseWithProviderTests.swift`, `packages/apple/Tests/OpenIapTests/*.swift`	Updated tests and sample constructors to include new `store` argument (e.g., `.apple`) and adjusted assertions to use `IapStore`.
Docs & Examples `packages/docs/src/pages/docs/apis.tsx`, `packages/docs/src/pages/docs/features/*.tsx`, `packages/docs/src/pages/docs/types.tsx`, `packages/docs/src/pages/docs/updates/notes.tsx`	Replaced `ios`/`android` keys with `apple`/`google` in examples, renamed discriminator text to `store`, added migration notes and deprecation guidance for `platform`.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25–35 minutes

Pay attention to JSON (de)serialization paths in Kotlin/Java/Swift to ensure store is persisted and backwards-compatible with old keys.
Verify generated Kotlin override usage to prevent compilation errors.
Confirm all purchase construction sites set the correct IapStore variant (.apple, .google, .horizon).
Check GraphQL schema deprecation annotations and that client code consuming schema handles both platform (deprecated) and store.

Possibly related issues

[TODO] v1.3.0 #48 — Implements the migration checklist to deprecate platform in favor of store and rename ios/android to apple/google.

Possibly related PRs

refactor: deprecate validateReceipt in favor of verifyPurchase #45 — Modifies StoreKitTypesBridge.swift and also touches PurchaseIOS construction with store/transactionDate.
feat(horizon): add horizon support with flavor #17 — Related work introducing/propagating unified IapStore across models.
feat: verify purchase with provider #46 — Related verification/payload changes that touch store enums and purchase serialization.

Suggested labels

❄️ types, ⬡ gql

Poem

🐰 I hopped in code with nimble paws,

Replaced old stores with newer laws.
Apple, Google, Horizon in view,
Platform retires — store sees us through.
Hooray — small hops, big change anew!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 5.71% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main objective of the PR: deprecating the platform field and ios/android props in favor of the new store field and apple/google props.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

packages/docs/src/pages/docs/types.tsx (1)

2719-2772: Update RequestVerifyPurchaseWithIapkitResult.store type from IapkitStore to IapStore

The generated types in packages/gql/src/generated/types.ts define RequestVerifyPurchaseWithIapkitResult.store as IapStore (which includes 'unknown' | 'apple' | 'google' | 'horizon'), but the documentation references IapkitStore with only 'apple' | 'google'. Update lines 2747 and the entire IapkitStore enum section (lines 2847-2872) to use IapStore instead to match the actual generated types.

🧹 Nitpick comments (5)

packages/google/openiap/src/play/java/dev/hyo/openiap/utils/BillingConverters.kt (1)

136-145: Consider using transactionId for ActiveSubscription.transactionId for clarity.

Now that PurchaseAndroid has an explicit transactionId field, toActiveSubscription() still maps transactionId = id. If id can ever diverge from the gateway transaction identifier (e.g., fallback to purchaseToken), consider switching this to use the new transactionId property instead so the semantics are explicit and consistent.

Based on learnings, keeping these mappings aligned with the schema/docs will reduce confusion later.

packages/docs/src/pages/docs/features/subscription.tsx (1)

356-367: Docs examples now match apple/google request payloads

The updated requestPurchase examples using apple and google under request look consistent with the new per‑store props and store discriminator. As a follow‑up, ensure any other docs still showing ios/android payload keys (e.g. type tables or older examples) are updated or explicitly marked deprecated so readers don’t mix the two shapes.

Also applies to: 492-493, 761-766, 897-905

packages/gql/src/type-ios.graphql (1)

124-168: GraphQL: store field addition and platform deprecation look correct

Adding store: IapStore! on PurchaseIOS and deprecating platform matches the new store‑centric model while preserving backwards compatibility. Since store is non‑null, please ensure all resolvers always populate it (including legacy data paths), and rerun the GraphQL codegen so Swift/TS/Kotlin/Dart types stay in sync, as per the packages/gql guidelines.

packages/docs/src/pages/docs/types.tsx (1)

199-205: Align discriminator docs fully with the new store field

The additions of store to Product/Purchase common fields and the new “Store Discriminators” section clearly communicate the new apple/google/horizon/unknown enum and the deprecation of platform. That said, a few narrative bits still talk about platform as the primary discriminator:

Line 199–205: Product is described as “discriminated by the platform field”.

Line 681–689: Purchase likewise says it’s discriminated by platform.

Line 638–640: “Use the platform field to narrow the type…”

To avoid confusion, consider updating those sentences to say “discriminated by the store field” and recommend using store for narrowing, with platform called out only as a deprecated, backwards‑compat alias.

Also applies to: 272-289, 539-641, 681-689, 742-809
packages/docs/src/pages/docs/updates/notes.tsx (1)
79-81: Clarify all possible store values for completeness.

The comment shows purchase.store // 'apple' | 'google' but the IapStore enum includes four values: 'unknown', 'apple', 'google', and 'horizon'. Consider documenting all possible values or adding a note that 'apple' and 'google' are the common values users will encounter in typical usage.
 // Purchase store field
-purchase.store  // 'apple' | 'google'
+purchase.store  // 'apple' | 'google' | 'horizon' | 'unknown'
 purchase.platform  // deprecated

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b8cf46 and 9284b55.

⛔ Files ignored due to path filters (4)

packages/gql/src/generated/Types.kt is excluded by !**/generated/**
packages/gql/src/generated/Types.swift is excluded by !**/generated/**
packages/gql/src/generated/types.dart is excluded by !**/generated/**
packages/gql/src/generated/types.ts is excluded by !**/generated/**

📒 Files selected for processing (20)

packages/apple/Sources/Helpers/StoreKitTypesBridge.swift (1 hunks)
packages/apple/Sources/Models/Types.swift (10 hunks)
packages/apple/Sources/OpenIapModule+ObjC.swift (1 hunks)
packages/apple/Sources/OpenIapModule.swift (4 hunks)
packages/apple/Tests/OpenIapTests/VerifyPurchaseWithProviderTests.swift (1 hunks)
packages/docs/src/pages/docs/apis.tsx (5 hunks)
packages/docs/src/pages/docs/features/external-purchase.tsx (2 hunks)
packages/docs/src/pages/docs/features/purchase.tsx (1 hunks)
packages/docs/src/pages/docs/features/subscription-upgrade-downgrade.tsx (3 hunks)
packages/docs/src/pages/docs/features/subscription.tsx (5 hunks)
packages/docs/src/pages/docs/types.tsx (10 hunks)
packages/docs/src/pages/docs/updates/notes.tsx (1 hunks)
packages/google/openiap/src/horizon/java/dev/hyo/openiap/utils/BillingConverters.kt (2 hunks)
packages/google/openiap/src/main/java/dev/hyo/openiap/Types.kt (13 hunks)
packages/google/openiap/src/main/java/dev/hyo/openiap/utils/PurchaseVerificationValidator.kt (4 hunks)
packages/google/openiap/src/play/java/dev/hyo/openiap/utils/BillingConverters.kt (2 hunks)
packages/gql/scripts/generate-kotlin-types.mjs (1 hunks)
packages/gql/src/type-android.graphql (1 hunks)
packages/gql/src/type-ios.graphql (1 hunks)
packages/gql/src/type.graphql (5 hunks)

🧰 Additional context used

📓 Path-based instructions (11)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx}: iOS-specific functions must end with IOS suffix (e.g., clearTransactionIOS, getAppTransactionIOS)
Android-specific functions must end with Android suffix (e.g., acknowledgePurchaseAndroid, consumePurchaseAndroid)
Use action prefixes for function naming: get for retrieval, request for async operations, clear for removal, is/has for boolean checks, show/present for UI display, begin/finish/end for process control

Prefer interface for defining object shapes in TypeScript

Files:

packages/docs/src/pages/docs/features/purchase.tsx
packages/docs/src/pages/docs/updates/notes.tsx
packages/docs/src/pages/docs/apis.tsx
packages/docs/src/pages/docs/features/subscription.tsx
packages/docs/src/pages/docs/features/external-purchase.tsx
packages/docs/src/pages/docs/features/subscription-upgrade-downgrade.tsx
packages/docs/src/pages/docs/types.tsx

packages/docs/**/*.{ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

packages/docs/**/*.{ts,tsx}: Use kebab-case for search modal IDs (e.g., id: 'request-products')
Modal state should be defined once at the app root level using Preact Signals (signal from '@preact/signals-react'), not instantiated multiple times
ALL components must fit within parent boundaries and never overflow outside parent containers; use overflow-hidden, break-words, and whitespace-nowrap as needed
Delete unused components, functions, and imports immediately; do not keep commented-out code or unused variables
ANY function that returns a Promise must be wrapped with void operator when used where a void return is expected (e.g., event handlers)

Files:

packages/docs/src/pages/docs/features/purchase.tsx
packages/docs/src/pages/docs/updates/notes.tsx
packages/docs/src/pages/docs/apis.tsx
packages/docs/src/pages/docs/features/subscription.tsx
packages/docs/src/pages/docs/features/external-purchase.tsx
packages/docs/src/pages/docs/features/subscription-upgrade-downgrade.tsx
packages/docs/src/pages/docs/types.tsx

packages/docs/**/*

📄 CodeRabbit inference engine (CLAUDE.md)

packages/docs/**/*: Before committing, run npx prettier --write, npm run lint, bun run tsc or npm run typecheck, and npm run build to verify formatting, linting, types, and build success
Use conventional commit format with lowercase type prefix and lowercase description (e.g., feat: add user authentication)

Files:

packages/docs/src/pages/docs/features/purchase.tsx
packages/docs/src/pages/docs/updates/notes.tsx
packages/docs/src/pages/docs/apis.tsx
packages/docs/src/pages/docs/features/subscription.tsx
packages/docs/src/pages/docs/features/external-purchase.tsx
packages/docs/src/pages/docs/features/subscription-upgrade-downgrade.tsx
packages/docs/src/pages/docs/types.tsx

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (GEMINI.md)

**/*.{ts,tsx,js,jsx}: Use camelCase for variable and function names
Use PascalCase for class and component names
Always use async/await for handling promises instead of .then() chains
Add JSDoc comments for public functions and exported APIs
Use const by default, let if reassignment is needed, avoid var

Files:

packages/docs/src/pages/docs/features/purchase.tsx
packages/docs/src/pages/docs/updates/notes.tsx
packages/docs/src/pages/docs/apis.tsx
packages/docs/src/pages/docs/features/subscription.tsx
packages/docs/src/pages/docs/features/external-purchase.tsx
packages/docs/src/pages/docs/features/subscription-upgrade-downgrade.tsx
packages/docs/src/pages/docs/types.tsx

packages/apple/**/*.swift

📄 CodeRabbit inference engine (CLAUDE.md)

packages/apple/**/*.swift: iOS-specific functions MUST have IOS suffix (e.g., presentCodeRedemptionSheetIOS(), showManageSubscriptionsIOS())
Use Pascal case for acronyms at the beginning or middle of names (e.g., IapManager, IapPurchase), but ALL CAPS only when appearing as a suffix (e.g., ProductIAP, OpenIAP)

Files:

packages/apple/Tests/OpenIapTests/VerifyPurchaseWithProviderTests.swift
packages/apple/Sources/Helpers/StoreKitTypesBridge.swift
packages/apple/Sources/OpenIapModule.swift
packages/apple/Sources/Models/Types.swift
packages/apple/Sources/OpenIapModule+ObjC.swift

packages/apple/Sources/Helpers/**/*.swift

📄 CodeRabbit inference engine (CLAUDE.md)

Place internal helper classes in Sources/Helpers/ (e.g., ProductManager.swift for thread-safe caching, IapStatus.swift for UI status); these are NOT official OpenIAP types

Files:

packages/apple/Sources/Helpers/StoreKitTypesBridge.swift

packages/google/**/*.kt

📄 CodeRabbit inference engine (CLAUDE.md)

DO NOT add Android suffix to function names in the Android-only package, even for Android-specific APIs (e.g., use acknowledgePurchase() not acknowledgePurchaseAndroid())

Files:

packages/google/openiap/src/play/java/dev/hyo/openiap/utils/BillingConverters.kt
packages/google/openiap/src/main/java/dev/hyo/openiap/utils/PurchaseVerificationValidator.kt
packages/google/openiap/src/horizon/java/dev/hyo/openiap/utils/BillingConverters.kt
packages/google/openiap/src/main/java/dev/hyo/openiap/Types.kt

packages/google/openiap/src/main/java/dev/hyo/openiap/utils/**/*.kt

📄 CodeRabbit inference engine (CLAUDE.md)

Place reusable Kotlin helper functions in openiap/src/main/java/dev/hyo/openiap/utils/

Files:

packages/google/openiap/src/main/java/dev/hyo/openiap/utils/PurchaseVerificationValidator.kt

packages/gql/**/*

📄 CodeRabbit inference engine (CLAUDE.md)

Run bun run generate to regenerate types for all platforms (TypeScript, Swift, Kotlin, Dart) from the GraphQL schema

Files:

packages/gql/src/type-android.graphql
packages/gql/scripts/generate-kotlin-types.mjs
packages/gql/src/type-ios.graphql
packages/gql/src/type.graphql

packages/apple/Sources/Models/Types.swift

📄 CodeRabbit inference engine (CLAUDE.md)

DO NOT edit Types.swift in Sources/Models/ as it is auto-generated from the OpenIAP GraphQL schema; regenerate using ./scripts/generate-types.sh

Files:

packages/apple/Sources/Models/Types.swift

packages/apple/Sources/Models/**/*.swift

📄 CodeRabbit inference engine (CLAUDE.md)

OpenIAP official types in Sources/Models/ must match types defined at openiap.dev/docs/types

Files:

packages/apple/Sources/Models/Types.swift

🧠 Learnings (15)

📓 Common learnings

Learnt from: CR
Repo: hyodotdev/openiap PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T20:15:59.223Z
Learning: Applies to packages/apple/openiap-versions.json : To update OpenIAP GraphQL types in the iOS/macOS library, edit the `gql` field in `openiap-versions.json`, run `./scripts/generate-types.sh`, and run `swift test` to verify compatibility

Learnt from: CR
Repo: hyodotdev/openiap PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T20:15:59.223Z
Learning: Applies to packages/apple/Sources/Models/**/*.swift : OpenIAP official types in `Sources/Models/` must match types defined at [openiap.dev/docs/types](https://www.openiap.dev/docs/types)

Learnt from: CR
Repo: hyodotdev/openiap PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T20:15:59.223Z
Learning: Applies to packages/apple/Sources/Models/Types.swift : DO NOT edit `Types.swift` in `Sources/Models/` as it is auto-generated from the OpenIAP GraphQL schema; regenerate using `./scripts/generate-types.sh`

Learnt from: CR
Repo: hyodotdev/openiap PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T20:15:59.223Z
Learning: Applies to packages/apple/**/*.swift : Use Pascal case for acronyms at the beginning or middle of names (e.g., `IapManager`, `IapPurchase`), but ALL CAPS only when appearing as a suffix (e.g., `ProductIAP`, `OpenIAP`)