react-native-iap 15.6.0 → 15.6.2

package/src/index.kepler.ts

@@ -3,6 +3,7 @@ import type {
   MutationField,
   Product,
   ProductQueryType,
+  ProductRequest,
   ProductSubscription,
   Purchase,
   PurchaseError,
@@ -25,16 +26,19 @@ import {
   validateNitroProduct,
   validateNitroPurchase,
 } from './utils/type-bridge';
+import {warnLegacyOnce} from './utils/deprecation';
+import {selectCanonicalPlatformRequest} from './utils/platform-request';
 
 export * from './types';
 export * from './utils/error';
 export * from './vega';
 export {useIAP, type UseIapOptions} from './hooks/useIAP';
-export {connectWebhookStream, parseWebhookEventData} from './webhook-client';
 export {kitApi, KitApiError} from './kit-api';
 export type {
   EntitlementsResponse,
   KitApiOptions,
+  KitClientPayloadCache,
+  KitClientPayloadOptions,
   KitClientPayloadResponse,
   KitProduct,
   KitProductClientPayload,
@@ -46,8 +50,17 @@ export type {
   StatusResponse,
 } from './kit-api';
 
+/**
+ * Product type accepted by the Amazon Vega entry point.
+ *
+ * Compatibility note: the `'inapp'` member is deprecated. Use `'in-app'`
+ * instead; the alias will be removed in react-native-iap 16.0.0.
+ */
 export type ProductTypeInput = 'inapp' | 'in-app' | 'subs';
 
+const LEGACY_INAPP_WARNING =
+  "[react-native-iap] `type: 'inapp'` is deprecated and will be removed in react-native-iap 16.0.0. Use 'in-app' instead.";
+
 export interface EventSubscription {
   remove(): void;
 }
@@ -80,7 +93,10 @@ const normalizeProductQueryType = (
 ): ProductTypeInput | 'all' => {
   if (type === 'subs') return 'subs';
   if (type === 'all') return 'all';
-  return 'inapp';
+  if (type === 'inapp') {
+    warnLegacyOnce('product-type.inapp', LEGACY_INAPP_WARNING);
+  }
+  return 'in-app';
 };
 
 const mapProducts = (
@@ -113,13 +129,16 @@ export const endConnection: MutationField<'endConnection'> = async () => {
   return getModule().endConnection();
 };
 
-export const fetchProducts: QueryField<'fetchProducts'> = async (request) => {
+export const fetchProducts = async (
+  request: Omit<ProductRequest, 'type'> & {
+    type?: ProductQueryType | ProductTypeInput | null;
+  },
+): ReturnType<QueryField<'fetchProducts'>> => {
   const {skus, type} = request;
   const normalizedType = normalizeProductQueryType(type);
   const nitroProducts = await getModule().fetchProducts(skus, normalizedType);
   return mapProducts(nitroProducts, normalizedType) as
-    | Product[]
-    | ProductSubscription[];
+    Product[] | ProductSubscription[];
 };
 
 export const requestPurchase: MutationField<'requestPurchase'> = async (
@@ -129,8 +148,19 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
     | RequestPurchasePropsByPlatforms
     | RequestSubscriptionPropsByPlatforms
     | undefined;
-  const androidRequest =
-    perPlatformRequest?.google ?? perPlatformRequest?.android;
+  const selection = perPlatformRequest
+    ? selectCanonicalPlatformRequest<
+        | RequestPurchasePropsByPlatforms['google']
+        | RequestSubscriptionPropsByPlatforms['google']
+      >(perPlatformRequest, 'google', 'android')
+    : {usesLegacyKey: false, value: undefined};
+  if (selection.usesLegacyKey && selection.value != null) {
+    warnLegacyOnce(
+      'request-purchase.android',
+      '[react-native-iap] `request.android` is deprecated and will be removed in react-native-iap 16.0.0. Use `request.google` instead.',
+    );
+  }
+  const androidRequest = selection.value;
 
   if (!androidRequest?.skus?.length) {
     throw new Error(
@@ -140,7 +170,6 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
 
   const nitroRequest: NitroPurchaseRequest = {
     google: androidRequest,
-    android: androidRequest,
   };
   const result = await getModule().requestPurchase(nitroRequest);
   if (!Array.isArray(result)) return null;
@@ -247,11 +276,20 @@ export const verifyPurchaseWithProvider: MutationField<
   >;
 };
 
+/**
+ * @deprecated Use `verifyPurchase` instead. This compatibility operation will
+ * be removed in react-native-iap 16.0.0.
+ */
 export const validateReceipt: MutationField<'validateReceipt'> = async () => {
   return unsupported('validateReceipt');
 };
 
 export const verifyPurchase: MutationField<'verifyPurchase'> = validateReceipt;
+
+/**
+ * @deprecated Use `verifyPurchase` instead. This iOS compatibility operation
+ * will be removed in react-native-iap 16.0.0.
+ */
 export const validateReceiptIOS: QueryField<'validateReceiptIOS'> = async () =>
   unsupported('validateReceiptIOS');
 export const syncIOS: MutationField<'syncIOS'> = async () =>
@@ -262,7 +300,18 @@ export const getAppTransactionIOS: QueryField<
 export const getPromotedProductIOS: QueryField<
   'getPromotedProductIOS'
 > = async () => null;
+
+/**
+ * @deprecated Use `getPromotedProductIOS` instead. This compatibility alias
+ * will be removed in react-native-iap 16.0.0.
+ */
 export const requestPromotedProductIOS = getPromotedProductIOS;
+
+/**
+ * @deprecated Use `promotedProductListenerIOS` followed by `requestPurchase`
+ * instead. This compatibility operation will be removed in react-native-iap
+ * 16.0.0.
+ */
 export const requestPurchaseOnPromotedProductIOS = async (): Promise<void> =>
   unsupported('requestPurchaseOnPromotedProductIOS');
 export const showManageSubscriptionsIOS: MutationField<
@@ -291,19 +340,44 @@ export const consumePurchaseAndroid: MutationField<
 > = async (purchaseToken) => {
   return getVegaModule().consumePurchaseAndroid(purchaseToken);
 };
+
+/**
+ * @deprecated Use `acknowledgePurchaseAndroid` instead. This alias will be
+ * removed in react-native-iap 16.0.0.
+ */
 export const acknowledgePurchase = acknowledgePurchaseAndroid;
+
+/**
+ * @deprecated Use `consumePurchaseAndroid` instead. This alias will be removed
+ * in react-native-iap 16.0.0.
+ */
 export const consumePurchase = consumePurchaseAndroid;
 
 export const openRedeemOfferCodeAndroid: MutationField<
   'openRedeemOfferCodeAndroid'
 > = async () => false;
 
+/**
+ * @deprecated Use `isBillingProgramAvailableAndroid('external-offer')`
+ * instead. Scheduled for removal in react-native-iap 16.0.0.
+ */
 export const checkAlternativeBillingAvailabilityAndroid: MutationField<
   'checkAlternativeBillingAvailabilityAndroid'
 > = async () => unsupported('checkAlternativeBillingAvailabilityAndroid');
+
+/**
+ * @deprecated Use `launchExternalLinkAndroid` instead. Scheduled for removal
+ * in react-native-iap 16.0.0.
+ */
 export const showAlternativeBillingDialogAndroid: MutationField<
   'showAlternativeBillingDialogAndroid'
 > = async () => unsupported('showAlternativeBillingDialogAndroid');
+
+/**
+ * @deprecated Use `createBillingProgramReportingDetailsAndroid` with the
+ * external-offer program instead. Scheduled for removal in react-native-iap
+ * 16.0.0.
+ */
 export const createAlternativeBillingTokenAndroid: MutationField<
   'createAlternativeBillingTokenAndroid'
 > = async () => unsupported('createAlternativeBillingTokenAndroid');

package/src/index.ts

@@ -57,6 +57,8 @@ import {
   DUPLICATE_PURCHASE_CODE,
 } from './utils/errorMapping';
 import {RnIapConsole} from './utils/debug';
+import {warnLegacyOnce} from './utils/deprecation';
+import {selectCanonicalPlatformRequest} from './utils/platform-request';
 import {getSuccessFromPurchaseVariant} from './utils/purchase';
 import {parseAppTransactionPayload} from './utils';
 import {getVegaIapModule, isVegaOS} from './vega';
@@ -91,10 +93,16 @@ export * from './types';
 export * from './utils/error';
 export * from './vega';
 
+/**
+ * Product type accepted by public query and purchase helpers.
+ *
+ * Compatibility note: the `'inapp'` member is deprecated. Use `'in-app'`
+ * instead; the alias will be removed in react-native-iap 16.0.0.
+ */
 export type ProductTypeInput = 'inapp' | 'in-app' | 'subs';
 
 const LEGACY_INAPP_WARNING =
-  "[react-native-iap] `type: 'inapp'` is deprecated and will be removed in a future major version. Use 'in-app' instead.";
+  "[react-native-iap] `type: 'inapp'` is deprecated and will be removed in react-native-iap 16.0.0. Use 'in-app' instead.";
 
 type NitroPurchaseRequest = Parameters<RnIap['requestPurchase']>[0];
 type NitroAvailablePurchasesOptions = NonNullable<
@@ -148,23 +156,11 @@ export interface EventSubscription {
 
 // Export hooks
 export {useIAP} from './hooks/useIAP';
-export {useWebhookEvents} from './hooks/useWebhookEvents';
-export type {
-  UseWebhookEventsOptions,
-  UseWebhookEventsResult,
-} from './hooks/useWebhookEvents';
-export {connectWebhookStream, parseWebhookEventData} from './webhook-client';
-export type {
-  WebhookEventPayload,
-  WebhookEventStream,
-  WebhookEventType as WebhookEventTypeName,
-  WebhookListener,
-  WebhookListenerError,
-  WebhookListenerOptions,
-} from './webhook-client';
 export {kitApi, KitApiError} from './kit-api';
 export type {
   KitApiOptions,
+  KitClientPayloadCache,
+  KitClientPayloadOptions,
   KitClientPayloadResponse,
   KitProduct,
   KitProductClientPayload,
@@ -879,8 +875,7 @@ export const fetchProducts: QueryField<'fetchProducts'> = async (request) => {
 
     if (normalizedType === 'all') {
       const converted = (await fetchAndConvert('all')) as (
-        | Product
-        | ProductSubscription
+        Product | ProductSubscription
       )[];
 
       RnIapConsole.debug(
@@ -1112,6 +1107,10 @@ export const getPromotedProductIOS: QueryField<
   }
 };
 
+/**
+ * @deprecated Use `getPromotedProductIOS` instead. This compatibility alias
+ * will be removed in react-native-iap 16.0.0.
+ */
 export const requestPromotedProductIOS = getPromotedProductIOS;
 
 /**
@@ -1126,6 +1125,8 @@ export const requestPromotedProductIOS = getPromotedProductIOS;
  * ```
  *
  * @see {@link https://openiap.dev/docs/apis/ios/get-storefront-ios}
+ * @deprecated Use `getStorefront` instead. Scheduled for removal in
+ * react-native-iap 16.0.0.
  */
 export const getStorefrontIOS: QueryField<'getStorefrontIOS'> = async () => {
   if (Platform.OS !== 'ios') {
@@ -1529,13 +1530,21 @@ export const getReceiptDataIOS: QueryField<'getReceiptDataIOS'> = async () => {
   }
 };
 
+/**
+ * Legacy alias for `getReceiptDataIOS`.
+ *
+ * @deprecated Use `getReceiptDataIOS` for the cumulative App Store receipt or
+ * `getTransactionJwsIOS(productId)` for one transaction. This alias will be
+ * removed in react-native-iap 16.0.0.
+ */
 export const getReceiptIOS = async (): Promise<string> => {
   if (Platform.OS !== 'ios') {
     throw new Error('getReceiptIOS is only available on iOS');
   }
 
   RnIapConsole.warn(
-    '[getReceiptIOS] ⚠️ iOS receipts contain ALL transactions, not just the latest one. ' +
+    '[getReceiptIOS] is deprecated and will be removed in react-native-iap 16.0.0. ' +
+      'Use getReceiptDataIOS() for the cumulative receipt. iOS receipts contain ALL transactions, not just the latest one. ' +
       'For individual purchase validation, use getTransactionJwsIOS(productId) instead. ' +
       'See: https://react-native-iap.hyo.dev/docs/guides/receipt-validation',
   );
@@ -1799,19 +1808,22 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
       throw new Error('Missing purchase request configuration');
     }
 
+    const iosRequestSource =
+      Platform.OS === 'ios'
+        ? selectApplePurchaseRequest(perPlatformRequest)
+        : undefined;
+    const androidRequestSource = isAndroidStoreRuntime()
+      ? selectGooglePurchaseRequest(perPlatformRequest)
+      : undefined;
+
     if (Platform.OS === 'ios') {
-      // Support both 'apple' (recommended) and 'ios' (deprecated) fields
-      const iosRequest = perPlatformRequest.apple ?? perPlatformRequest.ios;
-      if (!iosRequest?.sku) {
+      if (!iosRequestSource?.sku) {
         throw new Error(
           'Invalid request for iOS. The `sku` property is required.',
         );
       }
     } else if (isAndroidStoreRuntime()) {
-      // Support both 'google' (recommended) and 'android' (deprecated) fields
-      const androidRequest =
-        perPlatformRequest.google ?? perPlatformRequest.android;
-      if (!androidRequest?.skus?.length) {
+      if (!androidRequestSource?.skus?.length) {
         throw new Error(
           'Invalid request for Android. The `skus` property is required and must be a non-empty array.',
         );
@@ -1822,14 +1834,12 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
 
     const unifiedRequest: NitroPurchaseRequest = {};
 
-    // Support both 'apple' (recommended) and 'ios' (deprecated) fields
-    const iosRequestSource = perPlatformRequest.apple ?? perPlatformRequest.ios;
     if (Platform.OS === 'ios' && iosRequestSource) {
       const iosRequest = isSubs
         ? (iosRequestSource as RequestSubscriptionIosProps)
         : (iosRequestSource as RequestPurchaseIosProps);
 
-      const iosPayload: NonNullable<NitroPurchaseRequest['ios']> = {
+      const iosPayload: NonNullable<NitroPurchaseRequest['apple']> = {
         sku: iosRequest.sku,
       };
 
@@ -1869,18 +1879,15 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
         }
       }
 
-      unifiedRequest.ios = iosPayload;
+      unifiedRequest.apple = iosPayload;
     }
 
-    // Support both 'google' (recommended) and 'android' (deprecated) fields
-    const androidRequestSource =
-      perPlatformRequest.google ?? perPlatformRequest.android;
     if (isAndroidStoreRuntime() && androidRequestSource) {
       const androidRequest = isSubs
         ? (androidRequestSource as RequestSubscriptionAndroidProps)
         : (androidRequestSource as RequestPurchaseAndroidProps);
 
-      const androidPayload: NonNullable<NitroPurchaseRequest['android']> = {
+      const androidPayload: NonNullable<NitroPurchaseRequest['google']> = {
         skus: androidRequest.skus,
       };
 
@@ -1934,7 +1941,7 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
           }));
       }
 
-      unifiedRequest.android = androidPayload;
+      unifiedRequest.google = androidPayload;
     }
 
     return await IAP.instance.requestPurchase(unifiedRequest);
@@ -2153,7 +2160,7 @@ export const openRedeemOfferCodeAndroid: MutationField<
 
 /**
  * Validate receipt on both iOS and Android platforms
- * @deprecated Use `verifyPurchase` instead. This function will be removed in a future version.
+ * @deprecated Use `verifyPurchase` instead. This function will be removed in react-native-iap 16.0.0.
  * @param options - Platform-specific verification options
  * @param options.apple - Apple App Store verification options (iOS)
  * @param options.google - Google Play verification options (Android)
@@ -2315,9 +2322,8 @@ export const verifyPurchase: MutationField<'verifyPurchase'> = validateReceipt;
 /**
  * iOS-only receipt validation alias.
  *
- * @deprecated Use `verifyPurchase` (or `validateReceipt`) instead. Kept so
- * consumers who imported `validateReceiptIOS` — which is still declared on the
- * OpenIAP Query interface — keep working. Throws on non-iOS platforms.
+ * @deprecated Use `verifyPurchase` instead. This compatibility alias will be
+ * removed in react-native-iap 16.0.0. Throws on non-iOS platforms.
  *
  * @see {@link https://openiap.dev/docs/apis/ios/validate-receipt-ios}
  */
@@ -2465,7 +2471,9 @@ export const presentCodeRedemptionSheetIOS: MutationField<
 
 /**
  * Buy promoted product on iOS
- * @deprecated In StoreKit 2, promoted products can be purchased directly via the standard `requestPurchase()` flow.
+ * @deprecated In StoreKit 2, promoted products can be purchased directly via
+ * the standard `requestPurchase()` flow. This alias will be removed in
+ * react-native-iap 16.0.0.
  * Use `promotedProductListenerIOS` to receive the product ID when a user taps a promoted product,
  * then call `requestPurchase()` with the received SKU directly.
  *
@@ -2673,6 +2681,7 @@ export const getActiveSubscriptions: QueryField<
               willAutoRenew: sub.renewalInfoIOS.willAutoRenew ?? false,
               autoRenewPreference:
                 sub.renewalInfoIOS.autoRenewPreference ?? null,
+              commitmentInfo: sub.renewalInfoIOS.commitmentInfo ?? null,
               pendingUpgradeProductId:
                 sub.renewalInfoIOS.pendingUpgradeProductId ?? null,
               renewalDate: sub.renewalInfoIOS.renewalDate ?? null,
@@ -2682,8 +2691,11 @@ export const getActiveSubscriptions: QueryField<
                 sub.renewalInfoIOS.gracePeriodExpirationDate ?? null,
               priceIncreaseStatus:
                 sub.renewalInfoIOS.priceIncreaseStatus ?? null,
+              renewalBillingPlanType:
+                sub.renewalInfoIOS.renewalBillingPlanType ?? null,
               renewalOfferType: sub.renewalInfoIOS.renewalOfferType ?? null,
               renewalOfferId: sub.renewalInfoIOS.renewalOfferId ?? null,
+              jsonRepresentation: sub.renewalInfoIOS.jsonRepresentation ?? null,
             }
           : null,
         // Android specific fields
@@ -2747,12 +2759,14 @@ export {
 
 // Deprecated exports for backward compatibility
 /**
- * @deprecated Use acknowledgePurchaseAndroid instead
+ * @deprecated Use acknowledgePurchaseAndroid instead. This alias will be
+ * removed in react-native-iap 16.0.0.
  */
 export const acknowledgePurchase = acknowledgePurchaseAndroid;
 
 /**
- * @deprecated Use consumePurchaseAndroid instead
+ * @deprecated Use consumePurchaseAndroid instead. This alias will be removed
+ * in react-native-iap 16.0.0.
  */
 export const consumePurchase = consumePurchaseAndroid;
 
@@ -2761,9 +2775,45 @@ export const consumePurchase = consumePurchaseAndroid;
 // ============================================================================
 
 type NitroDiscountOfferRecord = NonNullable<
-  NonNullable<NitroPurchaseRequest['ios']>['withOffer']
+  NonNullable<NitroPurchaseRequest['apple']>['withOffer']
 >;
 
+const selectApplePurchaseRequest = (
+  request:
+    RequestPurchasePropsByPlatforms | RequestSubscriptionPropsByPlatforms,
+): RequestPurchaseIosProps | RequestSubscriptionIosProps | null | undefined => {
+  const selection = selectCanonicalPlatformRequest<
+    RequestPurchaseIosProps | RequestSubscriptionIosProps
+  >(request, 'apple', 'ios');
+  if (selection.usesLegacyKey && selection.value != null) {
+    warnLegacyOnce(
+      'request-purchase.ios',
+      '[react-native-iap] `request.ios` is deprecated and will be removed in react-native-iap 16.0.0. Use `request.apple` instead.',
+    );
+  }
+  return selection.value;
+};
+
+const selectGooglePurchaseRequest = (
+  request:
+    RequestPurchasePropsByPlatforms | RequestSubscriptionPropsByPlatforms,
+):
+  | RequestPurchaseAndroidProps
+  | RequestSubscriptionAndroidProps
+  | null
+  | undefined => {
+  const selection = selectCanonicalPlatformRequest<
+    RequestPurchaseAndroidProps | RequestSubscriptionAndroidProps
+  >(request, 'google', 'android');
+  if (selection.usesLegacyKey && selection.value != null) {
+    warnLegacyOnce(
+      'request-purchase.android',
+      '[react-native-iap] `request.android` is deprecated and will be removed in react-native-iap 16.0.0. Use `request.google` instead.',
+    );
+  }
+  return selection.value;
+};
+
 const toDiscountOfferRecordIOS = (
   offer: DiscountOfferInputIOS | null | undefined,
 ): NitroDiscountOfferRecord | undefined => {
@@ -2781,7 +2831,7 @@ const toDiscountOfferRecordIOS = (
 
 const toNitroProductType = (
   type?: ProductTypeInput | ProductQueryType | null,
-): 'inapp' | 'subs' | 'all' => {
+): 'in-app' | 'subs' | 'all' => {
   if (type === 'subs') {
     return 'subs';
   }
@@ -2789,10 +2839,10 @@ const toNitroProductType = (
     return 'all';
   }
   if (type === 'inapp') {
-    RnIapConsole.warn(LEGACY_INAPP_WARNING);
-    return 'inapp';
+    warnLegacyOnce('product-type.inapp', LEGACY_INAPP_WARNING);
+    return 'in-app';
   }
-  return 'inapp';
+  return 'in-app';
 };
 
 const isSubscriptionQuery = (type?: ProductQueryType | null): boolean =>
@@ -2815,7 +2865,7 @@ const normalizeProductQueryType = (
       return 'subs';
     }
     if (normalized === 'inapp') {
-      RnIapConsole.warn(LEGACY_INAPP_WARNING);
+      warnLegacyOnce('product-type.inapp', LEGACY_INAPP_WARNING);
       return 'in-app';
     }
     if (normalized === 'in-app') {
@@ -2850,6 +2900,8 @@ const normalizeProductQueryType = (
  * ```
  *
  * @see {@link https://openiap.dev/docs/apis/android/check-alternative-billing-availability-android}
+ * @deprecated Use `isBillingProgramAvailableAndroid('external-offer')`
+ * instead. Scheduled for removal in react-native-iap 16.0.0.
  */
 export const checkAlternativeBillingAvailabilityAndroid: MutationField<
   'checkAlternativeBillingAvailabilityAndroid'
@@ -2892,6 +2944,8 @@ export const checkAlternativeBillingAvailabilityAndroid: MutationField<
  * ```
  *
  * @see {@link https://openiap.dev/docs/apis/android/show-alternative-billing-dialog-android}
+ * @deprecated Use `launchExternalLinkAndroid` instead. Scheduled for removal in
+ * react-native-iap 16.0.0.
  */
 export const showAlternativeBillingDialogAndroid: MutationField<
   'showAlternativeBillingDialogAndroid'
@@ -2931,6 +2985,9 @@ export const showAlternativeBillingDialogAndroid: MutationField<
  * ```
  *
  * @see {@link https://openiap.dev/docs/apis/android/create-alternative-billing-token-android}
+ * @deprecated Use
+ * `createBillingProgramReportingDetailsAndroid('external-offer')` instead.
+ * Scheduled for removal in react-native-iap 16.0.0.
  */
 export const createAlternativeBillingTokenAndroid: MutationField<
   'createAlternativeBillingTokenAndroid'