react-native-iap 15.2.3 → 15.3.0

package/src/specs/RnIap.nitro.ts

@@ -35,11 +35,13 @@ import type {
   ExternalPurchaseCustomLinkTokenTypeIOS,
   ExternalPurchaseLinkResultIOS,
   ExternalPurchaseNoticeResultIOS,
+  DeveloperProvidedBillingDetailsAndroid,
   MutationFinishTransactionArgs,
   ProductCommon,
   PromotionalOfferJwsInputIOS,
   PurchaseCommon,
   PurchaseOptions,
+  PurchaseUpdatedListenerOptions,
   VerifyPurchaseAppleOptions,
   VerifyPurchaseGoogleOptions,
   VerifyPurchaseHorizonOptions,
@@ -146,6 +148,8 @@ export interface NitroReceiptValidationHorizonOptions {
   userId: VerifyPurchaseHorizonOptions['userId'];
 }
 
+export type NitroPurchaseUpdatedListenerOptions = PurchaseUpdatedListenerOptions;
+
 export interface NitroReceiptValidationParams {
   apple?: NitroReceiptValidationAppleOptions | null;
   google?: NitroReceiptValidationGoogleOptions | null;
@@ -422,19 +426,6 @@ export interface NitroBillingProgramReportingDetailsAndroid {
   externalTransactionToken: string;
 }
 
-/**
- * Details provided when user selects developer billing option (Android 8.3.0+)
- * Received via DeveloperProvidedBillingListener callback in External Payments flow
- */
-export interface DeveloperProvidedBillingDetailsAndroid {
-  /**
-   * External transaction token used to report transactions made through developer billing.
-   * This token must be used when reporting the external transaction to Google Play.
-   * Must be reported within 24 hours of the transaction.
-   */
-  externalTransactionToken: string;
-}
-
 /**
  * Discount amount details for one-time purchase offers (Android)
  */
@@ -725,7 +716,10 @@ export interface RnIap extends HybridObject<{ios: 'swift'; android: 'kotlin'}> {
    * Add a listener for purchase updates
    * @param listener - Function to call when a purchase is updated
    */
-  addPurchaseUpdatedListener(listener: (purchase: NitroPurchase) => void): void;
+  addPurchaseUpdatedListener(
+    listener: (purchase: NitroPurchase) => void,
+    options?: NitroPurchaseUpdatedListenerOptions,
+  ): number;
 
   /**
    * Add a listener for purchase errors
@@ -737,11 +731,9 @@ export interface RnIap extends HybridObject<{ios: 'swift'; android: 'kotlin'}> {
 
   /**
    * Remove a purchase updated listener
-   * @param listener - Function to remove from listeners
+   * @param token - Token returned from addPurchaseUpdatedListener
    */
-  removePurchaseUpdatedListener(
-    listener: (purchase: NitroPurchase) => void,
-  ): void;
+  removePurchaseUpdatedListener(token: number): void;
 
   /**
    * Remove a purchase error listener

package/src/types.ts

@@ -587,12 +587,12 @@ export interface LimitedQuantityInfoAndroid {
 export interface Mutation {
   /**
    * Acknowledge a non-consumable purchase. Required within 3 days or Google auto-refunds.
-   * See: https://www.openiap.dev/docs/apis/android/acknowledge-purchase-android
+   * See: https://openiap.dev/docs/apis/android/acknowledge-purchase-android
    */
   acknowledgePurchaseAndroid: Promise<boolean>;
   /**
    * Present the refund request sheet (iOS 15+). See also Features → Refund.
-   * See: https://www.openiap.dev/docs/apis/ios/begin-refund-request-ios
+   * See: https://openiap.dev/docs/apis/ios/begin-refund-request-ios
    */
   beginRefundRequestIOS?: Promise<(string | null)>;
   /**
@@ -600,17 +600,17 @@ export interface Mutation {
    *
    * Returns true if available, false otherwise.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/check-alternative-billing-availability-android
+   * See: https://openiap.dev/docs/apis/android/check-alternative-billing-availability-android
    */
   checkAlternativeBillingAvailabilityAndroid: Promise<boolean>;
   /**
    * Clear pending transactions in the queue (sandbox helper).
-   * See: https://www.openiap.dev/docs/apis/ios/clear-transaction-ios
+   * See: https://openiap.dev/docs/apis/ios/clear-transaction-ios
    */
   clearTransactionIOS: Promise<boolean>;
   /**
    * Consume a consumable purchase so it can be re-bought.
-   * See: https://www.openiap.dev/docs/apis/android/consume-purchase-android
+   * See: https://openiap.dev/docs/apis/android/consume-purchase-android
    */
   consumePurchaseAndroid: Promise<boolean>;
   /**
@@ -620,7 +620,7 @@ export interface Mutation {
    *
    * Returns token string, or null if creation failed.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/create-alternative-billing-token-android
+   * See: https://openiap.dev/docs/apis/android/create-alternative-billing-token-android
    */
   createAlternativeBillingTokenAndroid?: Promise<(string | null)>;
   /**
@@ -629,27 +629,27 @@ export interface Mutation {
    *
    * Returns external transaction token needed for reporting external transactions.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/create-billing-program-reporting-details-android
+   * See: https://openiap.dev/docs/apis/android/create-billing-program-reporting-details-android
    */
   createBillingProgramReportingDetailsAndroid: Promise<BillingProgramReportingDetailsAndroid>;
   /**
    * Open the platform's subscription management UI.
-   * See: https://www.openiap.dev/docs/apis/deep-link-to-subscriptions
+   * See: https://openiap.dev/docs/apis/deep-link-to-subscriptions
    */
   deepLinkToSubscriptions: Promise<void>;
   /**
    * Close the store connection and release resources.
-   * See: https://www.openiap.dev/docs/apis/end-connection
+   * See: https://openiap.dev/docs/apis/end-connection
    */
   endConnection: Promise<boolean>;
   /**
    * Complete a transaction after server-side verification. Required on Android within 3 days.
-   * See: https://www.openiap.dev/docs/apis/finish-transaction
+   * See: https://openiap.dev/docs/apis/finish-transaction
    */
   finishTransaction: Promise<void>;
   /**
    * Initialize the store connection. Call before any IAP API.
-   * See: https://www.openiap.dev/docs/apis/init-connection
+   * See: https://openiap.dev/docs/apis/init-connection
    */
   initConnection: Promise<boolean>;
   /**
@@ -659,7 +659,7 @@ export interface Mutation {
    * Available in Google Play Billing Library 8.2.0+.
    * Returns availability result with isAvailable flag.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/is-billing-program-available-android
+   * See: https://openiap.dev/docs/apis/android/is-billing-program-available-android
    */
   isBillingProgramAvailableAndroid: Promise<BillingProgramAvailabilityResultAndroid>;
   /**
@@ -668,29 +668,29 @@ export interface Mutation {
    *
    * Shows Play Store dialog and optionally launches external URL.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/launch-external-link-android
+   * See: https://openiap.dev/docs/apis/android/launch-external-link-android
    */
   launchExternalLinkAndroid: Promise<boolean>;
   /**
    * Show the App Store offer code redemption sheet.
-   * See: https://www.openiap.dev/docs/apis/ios/present-code-redemption-sheet-ios
+   * See: https://openiap.dev/docs/apis/ios/present-code-redemption-sheet-ios
    */
   presentCodeRedemptionSheetIOS: Promise<boolean>;
   /**
    * Present an external purchase link, StoreKit External (iOS 16+).
-   * See: https://www.openiap.dev/docs/apis/ios/present-external-purchase-link-ios
+   * See: https://openiap.dev/docs/apis/ios/present-external-purchase-link-ios
    */
   presentExternalPurchaseLinkIOS: Promise<ExternalPurchaseLinkResultIOS>;
   /**
    * Present the external purchase notice sheet (iOS 17.4+).
    * Uses ExternalPurchase.presentNoticeSheet() which returns a token when the user continues.
    * Reference: https://developer.apple.com/documentation/storekit/externalpurchase/presentnoticesheet()
-   * See: https://www.openiap.dev/docs/apis/ios/present-external-purchase-notice-sheet-ios
+   * See: https://openiap.dev/docs/apis/ios/present-external-purchase-notice-sheet-ios
    */
   presentExternalPurchaseNoticeSheetIOS: Promise<ExternalPurchaseNoticeResultIOS>;
   /**
    * Initiate a purchase or subscription flow; rely on events for final state.
-   * See: https://www.openiap.dev/docs/apis/request-purchase
+   * See: https://openiap.dev/docs/apis/request-purchase
    */
   requestPurchase?: Promise<(Purchase | Purchase[] | null)>;
   /**
@@ -699,13 +699,13 @@ export interface Mutation {
    * @deprecated Use promotedProductListenerIOS to receive the productId,
    * then call requestPurchase with that SKU instead. In StoreKit 2,
    * promoted products can be purchased directly via the standard purchase flow.
-   * See: https://www.openiap.dev/docs/apis/ios/request-purchase-on-promoted-product-ios
+   * See: https://openiap.dev/docs/apis/ios/request-purchase-on-promoted-product-ios
    * @deprecated Use promotedProductListenerIOS + requestPurchase instead
    */
   requestPurchaseOnPromotedProductIOS: Promise<boolean>;
   /**
    * Restore non-consumable and active subscription purchases.
-   * See: https://www.openiap.dev/docs/apis/restore-purchases
+   * See: https://openiap.dev/docs/apis/restore-purchases
    */
   restorePurchases: Promise<void>;
   /**
@@ -714,29 +714,29 @@ export interface Mutation {
    *
    * Returns true if user accepted, false if user canceled.
    * Throws OpenIapError.NotPrepared if billing client not ready.
-   * See: https://www.openiap.dev/docs/apis/android/show-alternative-billing-dialog-android
+   * See: https://openiap.dev/docs/apis/android/show-alternative-billing-dialog-android
    */
   showAlternativeBillingDialogAndroid: Promise<boolean>;
   /**
    * Present the disclosure sheet required before linking out via ExternalPurchaseCustomLink (iOS 18.1+).
    * Call this after a deliberate customer interaction before linking out to external purchases.
    * Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/shownotice(type:)
-   * See: https://www.openiap.dev/docs/apis/ios/show-external-purchase-custom-link-notice-ios
+   * See: https://openiap.dev/docs/apis/ios/show-external-purchase-custom-link-notice-ios
    */
   showExternalPurchaseCustomLinkNoticeIOS: Promise<ExternalPurchaseCustomLinkNoticeResultIOS>;
   /**
    * Present the manage-subscriptions sheet and return changed purchases (iOS 15+).
-   * See: https://www.openiap.dev/docs/apis/ios/show-manage-subscriptions-ios
+   * See: https://openiap.dev/docs/apis/ios/show-manage-subscriptions-ios
    */
   showManageSubscriptionsIOS: Promise<PurchaseIOS[]>;
   /**
    * Force sync transactions with the App Store (iOS 15+).
-   * See: https://www.openiap.dev/docs/apis/ios/sync-ios
+   * See: https://openiap.dev/docs/apis/ios/sync-ios
    */
   syncIOS: Promise<boolean>;
   /**
    * Deprecated. Validate purchase receipts with the configured providers — use verifyPurchase instead.
-   * See: https://www.openiap.dev/docs/features/validation#verify-purchase
+   * See: https://openiap.dev/docs/features/validation#verify-purchase
    * @deprecated Use verifyPurchase
    */
   validateReceipt: Promise<VerifyPurchaseResult>;
@@ -746,14 +746,14 @@ export interface Mutation {
    * + receipt/JWS metadata, VerifyPurchaseResultAndroid carries Play Store
    * receipt fields (no isValid), and VerifyPurchaseResultHorizon uses success.
    * Inspect the concrete variant before reading fields.
-   * See: https://www.openiap.dev/docs/features/validation#verify-purchase
+   * See: https://openiap.dev/docs/features/validation#verify-purchase
    */
   verifyPurchase: Promise<VerifyPurchaseResult>;
   /**
    * Verify via a managed provider without standing up your own server. The
    * PurchaseVerificationProvider enum currently exposes only IAPKit; platform
    * availability may differ by implementation.
-   * See: https://www.openiap.dev/docs/features/validation#verify-purchase-with-provider
+   * See: https://openiap.dev/docs/features/validation#verify-purchase-with-provider
    */
   verifyPurchaseWithProvider: Promise<VerifyPurchaseWithProviderResult>;
 }
@@ -1292,28 +1292,37 @@ export interface PurchaseOptions {
 
 export type PurchaseState = 'pending' | 'purchased' | 'unknown';
 
+export interface PurchaseUpdatedListenerOptions {
+  /**
+   * iOS only. Defaults to true. When false, listener callbacks also receive
+   * StoreKit replay events for a transaction ID that was already emitted during
+   * the current connection session. Android ignores this option.
+   */
+  dedupeTransactionIOS?: (boolean | null);
+}
+
 export type PurchaseVerificationProvider = 'iapkit';
 
 export interface Query {
   /**
    * Check eligibility for the external purchase notice sheet (iOS 17.4+).
    * Uses ExternalPurchase.canPresent.
-   * See: https://www.openiap.dev/docs/apis/ios/can-present-external-purchase-notice-ios
+   * See: https://openiap.dev/docs/apis/ios/can-present-external-purchase-notice-ios
    */
   canPresentExternalPurchaseNoticeIOS: Promise<boolean>;
   /**
    * Get the user's current entitlement for a product, using StoreKit 2 (iOS 15+).
-   * See: https://www.openiap.dev/docs/apis/ios/current-entitlement-ios
+   * See: https://openiap.dev/docs/apis/ios/current-entitlement-ios
    */
   currentEntitlementIOS?: Promise<(PurchaseIOS | null)>;
   /**
    * Fetch products or subscriptions from the store.
-   * See: https://www.openiap.dev/docs/apis/fetch-products
+   * See: https://openiap.dev/docs/apis/fetch-products
    */
   fetchProducts: Promise<(ProductOrSubscription[] | Product[] | ProductSubscription[] | null)>;
   /**
    * Get details of all currently active subscriptions (filters by subscriptionIds when provided).
-   * See: https://www.openiap.dev/docs/apis/get-active-subscriptions
+   * See: https://openiap.dev/docs/apis/get-active-subscriptions
    */
   getActiveSubscriptions: Promise<ActiveSubscription[]>;
   /**
@@ -1321,92 +1330,92 @@ export interface Query {
    * Requires the SK2ConsumableTransactionHistory Info.plist key in the host app
    * for finished consumables to be included (iOS 18+).
    * Unlike getAvailablePurchases, always returns the iOS-specific PurchaseIOS shape.
-   * See: https://www.openiap.dev/docs/apis/ios/get-all-transactions-ios
+   * See: https://openiap.dev/docs/apis/ios/get-all-transactions-ios
    */
   getAllTransactionsIOS: Promise<PurchaseIOS[]>;
   /**
    * Fetch the app transaction (iOS 16+).
-   * See: https://www.openiap.dev/docs/apis/ios/get-app-transaction-ios
+   * See: https://openiap.dev/docs/apis/ios/get-app-transaction-ios
    */
   getAppTransactionIOS?: Promise<(AppTransaction | null)>;
   /**
    * List active purchases for the current user.
-   * See: https://www.openiap.dev/docs/apis/get-available-purchases
+   * See: https://openiap.dev/docs/apis/get-available-purchases
    */
   getAvailablePurchases: Promise<Purchase[]>;
   /**
    * Fetch a token for Apple's External Purchase Server reporting API (iOS 18.1+).
    * Use this token to report transactions made through ExternalPurchaseCustomLink.
    * Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/token(for:)
-   * See: https://www.openiap.dev/docs/apis/ios/get-external-purchase-custom-link-token-ios
+   * See: https://openiap.dev/docs/apis/ios/get-external-purchase-custom-link-token-ios
    */
   getExternalPurchaseCustomLinkTokenIOS: Promise<ExternalPurchaseCustomLinkTokenResultIOS>;
   /**
    * List unfinished StoreKit transactions in the queue.
-   * See: https://www.openiap.dev/docs/apis/ios/get-pending-transactions-ios
+   * See: https://openiap.dev/docs/apis/ios/get-pending-transactions-ios
    */
   getPendingTransactionsIOS: Promise<PurchaseIOS[]>;
   /**
    * Read the App Store-promoted product, if any (iOS 11+).
-   * See: https://www.openiap.dev/docs/apis/ios/get-promoted-product-ios
+   * See: https://openiap.dev/docs/apis/ios/get-promoted-product-ios
    */
   getPromotedProductIOS?: Promise<(ProductIOS | null)>;
   /**
    * Get base64-encoded receipt data (legacy validation).
-   * See: https://www.openiap.dev/docs/apis/ios/get-receipt-data-ios
+   * See: https://openiap.dev/docs/apis/ios/get-receipt-data-ios
    */
   getReceiptDataIOS?: Promise<(string | null)>;
   /**
    * Return the user's storefront country code.
-   * See: https://www.openiap.dev/docs/apis/get-storefront
+   * See: https://openiap.dev/docs/apis/get-storefront
    */
   getStorefront: Promise<string>;
   /**
    * Deprecated. Get the current App Store storefront country code — use cross-platform getStorefront instead.
-   * See: https://www.openiap.dev/docs/apis/ios/get-storefront-ios
+   * See: https://openiap.dev/docs/apis/ios/get-storefront-ios
    * @deprecated Use getStorefront
    */
   getStorefrontIOS: Promise<string>;
   /**
    * Return the JWS string for a transaction (StoreKit 2).
-   * See: https://www.openiap.dev/docs/apis/ios/get-transaction-jws-ios
+   * See: https://openiap.dev/docs/apis/ios/get-transaction-jws-ios
    */
   getTransactionJwsIOS?: Promise<(string | null)>;
   /**
    * Check whether the user has any active subscription.
-   * See: https://www.openiap.dev/docs/apis/has-active-subscriptions
+   * See: https://openiap.dev/docs/apis/has-active-subscriptions
    */
   hasActiveSubscriptions: Promise<boolean>;
   /**
    * Check eligibility for the custom-link variant of external purchase (iOS 18.1+).
    * Returns true if the app can use custom external purchase links.
    * Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/iseligible
-   * See: https://www.openiap.dev/docs/apis/ios/is-eligible-for-external-purchase-custom-link-ios
+   * See: https://openiap.dev/docs/apis/ios/is-eligible-for-external-purchase-custom-link-ios
    */
   isEligibleForExternalPurchaseCustomLinkIOS: Promise<boolean>;
   /**
    * Check intro-offer eligibility for a subscription group.
-   * See: https://www.openiap.dev/docs/apis/ios/is-eligible-for-intro-offer-ios
+   * See: https://openiap.dev/docs/apis/ios/is-eligible-for-intro-offer-ios
    */
   isEligibleForIntroOfferIOS: Promise<boolean>;
   /**
    * Check whether a transaction's JWS verification passed (StoreKit 2).
-   * See: https://www.openiap.dev/docs/apis/ios/is-transaction-verified-ios
+   * See: https://openiap.dev/docs/apis/ios/is-transaction-verified-ios
    */
   isTransactionVerifiedIOS: Promise<boolean>;
   /**
    * Get the latest verified transaction for a product, using StoreKit 2.
-   * See: https://www.openiap.dev/docs/apis/ios/latest-transaction-ios
+   * See: https://openiap.dev/docs/apis/ios/latest-transaction-ios
    */
   latestTransactionIOS?: Promise<(PurchaseIOS | null)>;
   /**
    * Get subscription status objects from StoreKit 2 (iOS 15+).
-   * See: https://www.openiap.dev/docs/apis/ios/subscription-status-ios
+   * See: https://openiap.dev/docs/apis/ios/subscription-status-ios
    */
   subscriptionStatusIOS: Promise<SubscriptionStatusIOS[]>;
   /**
    * Deprecated. Legacy App Store receipt validation — use verifyPurchase instead.
-   * See: https://www.openiap.dev/docs/apis/ios/validate-receipt-ios
+   * See: https://openiap.dev/docs/apis/ios/validate-receipt-ios
    * @deprecated Use verifyPurchase
    */
   validateReceiptIOS: Promise<VerifyPurchaseResultIOS>;
@@ -1734,7 +1743,12 @@ export interface Subscription {
   promotedProductIOS: string;
   /** Fires when a purchase fails or is cancelled */
   purchaseError: PurchaseError;
-  /** Fires when a purchase completes successfully or a pending purchase resolves */
+  /**
+   * Fires when a purchase completes successfully or a pending purchase resolves
+   * Options can opt iOS listeners into duplicate StoreKit transaction replays
+   * for diagnostics; default listeners receive one event per transaction ID
+   * during a single connection session.
+   */
   purchaseUpdated: Purchase;
   /**
    * Fires when an active subscription enters a billing-issue state that needs user action
@@ -1758,6 +1772,9 @@ export interface Subscription {
 }
 
 
+
+export type SubscriptionPurchaseUpdatedArgs = (PurchaseUpdatedListenerOptions | null) | undefined;
+
 export interface SubscriptionInfoIOS {
   introductoryOffer?: (SubscriptionOfferIOS | null);
   promotionalOffers?: (SubscriptionOfferIOS[] | null);
@@ -2218,7 +2235,7 @@ export type SubscriptionArgsMap = {
   developerProvidedBillingAndroid: never;
   promotedProductIOS: never;
   purchaseError: never;
-  purchaseUpdated: never;
+  purchaseUpdated: SubscriptionPurchaseUpdatedArgs;
   subscriptionBillingIssue: never;
   userChoiceBillingAndroid: never;
 };