react-native-iap 16.3.0 → 16.3.1

package/src/index.kepler.ts

@@ -1,4 +1,5 @@
 import {getVegaIapModule} from './vega';
+import {ErrorCode} from './types';
 import type {
   MutationField,
   Product,
@@ -27,6 +28,7 @@ import {
   validateNitroPurchase,
 } from './utils/type-bridge';
 import {convertAndroidPurchasesOrThrow} from './utils/available-purchases';
+import {createPurchaseError} from './utils/errorMapping';
 
 export * from './types';
 export * from './utils/error';
@@ -129,13 +131,19 @@ export const fetchProducts = async (
   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 (
   request,
 ) => {
+  const type = normalizeProductQueryType(request.type);
+  if (type === 'all') {
+    throw createPurchaseError({
+      code: ErrorCode.DeveloperError,
+      message: 'Product type all is only supported for product queries.',
+    });
+  }
   const perPlatformRequest = request.request as
     | RequestPurchasePropsByPlatforms
     | RequestSubscriptionPropsByPlatforms

package/src/index.ts

@@ -9,6 +9,7 @@ import type {
   NitroPurchaseVerificationParams,
   NitroPurchaseVerificationResultIOS,
   NitroPurchaseVerificationResultAndroid,
+  NitroPurchaseVerificationResultHorizon,
   NitroPurchaseUpdatedListenerOptions,
   NitroSubscriptionStatus,
   RnIap,
@@ -41,6 +42,7 @@ import type {
   PurchaseIOS,
   QueryField,
   VerifyPurchaseResultAndroid,
+  VerifyPurchaseResultHorizon,
   VerifyPurchaseResultIOS,
   RequestPurchaseAndroidProps,
   RequestPurchaseIosProps,
@@ -884,7 +886,10 @@ export const fetchProducts: QueryField<'fetchProducts'> = async (request) => {
 
   try {
     if (!skus?.length) {
-      throw new Error('No SKUs provided');
+      throw createPurchaseError({
+        message: 'No SKUs provided',
+        code: ErrorCode.EmptySkuList,
+      });
     }
 
     const normalizedType = normalizeProductQueryType(type);
@@ -1673,6 +1678,12 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
   try {
     const {request: platformRequest, type} = request;
     const normalizedType = normalizeProductQueryType(type ?? 'in-app');
+    if (normalizedType === 'all') {
+      throw createPurchaseError({
+        code: ErrorCode.DeveloperError,
+        message: 'Product type all is only supported for product queries.',
+      });
+    }
     const isSubs = isSubscriptionQuery(normalizedType);
     const perPlatformRequest = platformRequest as
       | RequestPurchasePropsByPlatforms
@@ -1691,15 +1702,23 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
 
     if (Platform.OS === 'ios') {
       if (!iosRequestSource?.sku) {
-        throw new Error(
-          'Invalid request for iOS. The `sku` property is required.',
-        );
+        throw createPurchaseError({
+          message: 'Invalid request for iOS. The `sku` property is required.',
+          code: ErrorCode.EmptySkuList,
+        });
       }
     } else if (isAndroidStoreRuntime()) {
-      if (!androidRequestSource?.skus?.length) {
-        throw new Error(
-          'Invalid request for Android. The `skus` property is required and must be a non-empty array.',
-        );
+      const skus = androidRequestSource?.skus as unknown;
+      if (
+        !Array.isArray(skus) ||
+        skus.length === 0 ||
+        skus.some((sku) => typeof sku !== 'string' || sku.trim() === '')
+      ) {
+        throw createPurchaseError({
+          message:
+            'Invalid request for Android. The `skus` property must contain only non-empty strings.',
+          code: ErrorCode.EmptySkuList,
+        });
       }
     } else {
       throw unsupportedPlatformError();
@@ -1756,6 +1775,29 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
     }
 
     if (isAndroidStoreRuntime() && androidRequestSource) {
+      const rawAndroidRequest = androidRequestSource as unknown as Record<
+        string,
+        unknown
+      >;
+      const subscriptionOnlyFields = [
+        'subscriptionOffers',
+        'subscriptionProductReplacementParams',
+        'purchaseToken',
+        'originalExternalTransactionId',
+      ];
+      if (
+        (!isSubs &&
+          subscriptionOnlyFields.some(
+            (field) => rawAndroidRequest[field] != null,
+          )) ||
+        (isSubs && rawAndroidRequest.offerToken != null)
+      ) {
+        throw createPurchaseError({
+          message:
+            'Invalid request for Android. Purchase options must match the selected product type.',
+          code: ErrorCode.DeveloperError,
+        });
+      }
       const androidRequest = isSubs
         ? (androidRequestSource as RequestSubscriptionAndroidProps)
         : (androidRequestSource as RequestPurchaseAndroidProps);
@@ -1788,6 +1830,29 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
 
       if (isSubs) {
         const subsRequest = androidRequest as RequestSubscriptionAndroidProps;
+        const subscriptionOffers = subsRequest.subscriptionOffers as unknown;
+        if (
+          subscriptionOffers != null &&
+          (!Array.isArray(subscriptionOffers) ||
+            subscriptionOffers.some((offer) => {
+              if (offer == null || typeof offer !== 'object') {
+                return true;
+              }
+              const candidate = offer as Record<string, unknown>;
+              return (
+                typeof candidate.sku !== 'string' ||
+                candidate.sku.trim() === '' ||
+                typeof candidate.offerToken !== 'string' ||
+                candidate.offerToken.trim() === ''
+              );
+            }))
+        ) {
+          throw createPurchaseError({
+            message:
+              'Invalid request for Android. Every subscription offer must include non-empty `sku` and `offerToken` strings.',
+            code: ErrorCode.DeveloperError,
+          });
+        }
         if (subsRequest.purchaseToken) {
           androidPayload.purchaseToken = subsRequest.purchaseToken;
         }
@@ -1800,15 +1865,11 @@ export const requestPurchase: MutationField<'requestPurchase'> = async (
             subsRequest.subscriptionProductReplacementParams;
         }
         androidPayload.subscriptionOffers = (
-          subsRequest.subscriptionOffers ?? []
-        )
-          .filter(
-            (offer): offer is AndroidSubscriptionOfferInput => offer != null,
-          )
-          .map((offer) => ({
-            sku: offer.sku,
-            offerToken: offer.offerToken,
-          }));
+          (subscriptionOffers ?? []) as AndroidSubscriptionOfferInput[]
+        ).map((offer) => ({
+          sku: offer.sku,
+          offerToken: offer.offerToken,
+        }));
       }
 
       unifiedRequest.google = androidPayload;
@@ -2135,11 +2196,20 @@ export const verifyPurchase: MutationField<'verifyPurchase'> = async (
           : undefined,
       };
       return result;
+    } else if (params.horizon !== null) {
+      const horizonResult =
+        nitroResult as NitroPurchaseVerificationResultHorizon;
+      const result: VerifyPurchaseResultHorizon = {
+        isValid: horizonResult.isValid,
+        grantTime: horizonResult.grantTime,
+        success: horizonResult.success,
+      };
+      return result;
     } else {
-      // Android
       const androidResult =
         nitroResult as NitroPurchaseVerificationResultAndroid;
       const result: VerifyPurchaseResultAndroid = {
+        isValid: androidResult.isValid,
         autoRenewing: androidResult.autoRenewing,
         betaProduct: androidResult.betaProduct,
         cancelDate: androidResult.cancelDate,

package/src/kit-api.ts

@@ -31,7 +31,15 @@ export type KitSubscription = {
   id: string;
   productId: string;
   platform: "IOS" | "Android";
-  state: string;
+  state:
+    | "Active"
+    | "InGracePeriod"
+    | "InBillingRetry"
+    | "Expired"
+    | "Revoked"
+    | "Refunded"
+    | "Paused"
+    | "Unknown";
   expiresAt?: number;
   renewsAt?: number;
   willRenew?: boolean;
@@ -41,6 +49,7 @@ export type KitSubscription = {
   startedAt: number;
   updatedAt: number;
   purchaseToken: string;
+  originalTransactionId?: string;
   userId?: string;
 };
 
@@ -58,7 +67,8 @@ export type StatusResponse = {
 export type KitProductPlatform = "IOS" | "Android";
 
 export type KitProductClientPayload = {
-  format: "toml" | "json" | "text";
+  /** Current values are toml, json, and text; preserve unknown values. */
+  format: string;
   body: string;
   version: number;
   updatedAt: number;
@@ -84,6 +94,13 @@ export type KitProduct = {
   type: "Subscription" | "NonConsumable" | "Consumable";
   title: string;
   description?: string;
+  baseLocale?: string;
+  localizations?: Array<{
+    locale: string;
+    title: string;
+    description?: string;
+  }>;
+  regions?: "all" | string[];
   priceAmountMicros?: number;
   currency?: string;
   state: "Draft" | "Ready" | "Active" | "Removed";
@@ -113,6 +130,108 @@ export type KitProductsResponse = {
   nextCursor?: string;
 };
 
+export type KitSubscriptionsResponse = {
+  items: KitSubscription[];
+  total: number;
+};
+
+export type KitMrrCurrencyEntry = {
+  currency: string;
+  mrrMicros: number;
+};
+
+export type KitMetricsResponse = {
+  activeSubs: number;
+  inGracePeriod: number;
+  inBillingRetry: number;
+  refunded30d: number;
+  canceled30d: number;
+  mrrMicros: number;
+  currency: string;
+  reportingCurrency: string;
+  mrrByCurrency: KitMrrCurrencyEntry[];
+  excludedMrrByCurrency: KitMrrCurrencyEntry[];
+};
+
+export type KitRevenueMetricsResponse = {
+  days: Array<{
+    day: string;
+    currency: string;
+    productId: string;
+    platform: KitProductPlatform;
+    activeSubs: number;
+    newSubs: number;
+    renewals: number;
+    cancellations: number;
+    refunds: number;
+    revenueMicros: number;
+  }>;
+  currencies: string[];
+  productIds: string[];
+  platforms: KitProductPlatform[];
+  truncated: boolean;
+};
+
+export type KitProductUpsertResponse = { id: string; created: boolean };
+export type KitProductStateResponse = {
+  id: string;
+  state: KitProduct["state"];
+};
+export type KitClientPayloadStateResponse = {
+  expectedVersion: number;
+  clientPayload?: KitProductClientPayload;
+};
+export type KitSetClientPayloadResponse = {
+  id: string;
+  created: boolean;
+  changed: boolean;
+  version: number;
+  updatedAt: number;
+};
+export type KitRemoveClientPayloadResponse = { ok: boolean };
+export type KitProductSyncResponse = { jobId: string; deduped: boolean };
+export type KitProductSyncJobResponse = {
+  _id: string;
+  _creationTime: number;
+  projectId: string;
+  platform: KitProductPlatform;
+  direction: "pull" | "push" | "both" | "purge-local";
+  dryRun: boolean;
+  status: "queued" | "running" | "succeeded" | "failed";
+  progress: {
+    phase: string;
+    current?: number;
+    total?: number;
+    failuresCount?: number;
+  };
+  result?: {
+    pulled: number;
+    pushed: number;
+    deleted?: number;
+    failures: Array<{ productId: string; reason: string }>;
+    failuresTruncated?: boolean;
+    plannedWrites?: Array<{
+      productId: string;
+      step: string;
+      detail?: string;
+    }>;
+    plannedWritesTruncated?: boolean;
+    manualActions?: Array<{
+      productId: string;
+      code: string;
+      message: string;
+    }>;
+    manualActionsTruncated?: boolean;
+  };
+  error?: string;
+  cancelRequested?: boolean;
+  expectedDeadline?: number;
+  createdBy?: string;
+  startedAt?: number;
+  completedAt?: number;
+  createdAt: number;
+};
+
 export type KitClientPayloadResponse = {
   clientPayload: KitProductClientPayload;
 };
@@ -135,7 +254,7 @@ const DEFAULT_BASE_URL = "https://kit.openiap.dev";
 function mergeHeaders(
   callerHeaders: Record<string, string> | undefined,
   hasBody: boolean,
-): HeadersInit {
+): RequestInit["headers"] {
   if (typeof Headers === "function") {
     const merged = new Headers(callerHeaders);
     if (!merged.has("accept")) merged.set("accept", "application/json");
@@ -283,9 +402,11 @@ export function kitApi(options: KitApiOptions) {
       if (!raw) return null;
       const candidate = JSON.parse(raw) as Partial<CachedClientPayload>;
       const payload = candidate.clientPayload;
+      // Only the invariants the cache depends on. `format` is opaque: evicting
+      // on an unknown one would kill ETag revalidation and offline reads.
       if (
         !payload ||
-        !["toml", "json", "text"].includes(payload.format) ||
+        typeof payload.format !== "string" ||
         typeof payload.body !== "string" ||
         !Number.isSafeInteger(payload.version) ||
         payload.version < 1 ||

package/src/specs/RnIap.nitro.ts

@@ -55,6 +55,7 @@ import type {
   VerifyPurchaseGoogleOptions,
   VerifyPurchaseHorizonOptions,
   VerifyPurchaseResultAndroid,
+  VerifyPurchaseResultHorizon,
   RequestPurchaseIosProps,
   RequestPurchaseResult,
   RequestSubscriptionAndroidProps,
@@ -408,6 +409,7 @@ export interface NitroPurchaseVerificationResultIOS {
 }
 
 export interface NitroPurchaseVerificationResultAndroid {
+  isValid: VerifyPurchaseResultAndroid['isValid'];
   autoRenewing: VerifyPurchaseResultAndroid['autoRenewing'];
   betaProduct: VerifyPurchaseResultAndroid['betaProduct'];
   cancelDate: VerifyPurchaseResultAndroid['cancelDate'];
@@ -428,6 +430,12 @@ export interface NitroPurchaseVerificationResultAndroid {
   testTransaction: VerifyPurchaseResultAndroid['testTransaction'];
 }
 
+export interface NitroPurchaseVerificationResultHorizon {
+  isValid: VerifyPurchaseResultHorizon['isValid'];
+  grantTime?: VerifyPurchaseResultHorizon['grantTime'];
+  success: VerifyPurchaseResultHorizon['success'];
+}
+
 // VerifyPurchaseWithProvider types
 
 export interface NitroVerifyPurchaseWithIapkitAppleProps {
@@ -994,12 +1002,14 @@ export interface RnIap extends HybridObject<{ios: 'swift'; android: 'kotlin'}> {
   /**
    * Verify a purchase on the appropriate platform.
    * @param params - Purchase verification parameters including platform-specific options
-   * @returns Promise<NitroPurchaseVerificationResultIOS | NitroPurchaseVerificationResultAndroid>
+   * @returns Promise with the platform-specific verification result
    */
   verifyPurchase(
     params: NitroPurchaseVerificationParams,
   ): Promise<
-    NitroPurchaseVerificationResultIOS | NitroPurchaseVerificationResultAndroid
+    | NitroPurchaseVerificationResultIOS
+    | NitroPurchaseVerificationResultAndroid
+    | NitroPurchaseVerificationResultHorizon
   >;
 
   /**

package/src/types.ts

@@ -885,11 +885,11 @@ export interface Mutation {
    */
   syncIOS: Promise<boolean>;
   /**
-   * Verify a purchase against your own backend. Returns a platform-specific
-   * variant of VerifyPurchaseResult — VerifyPurchaseResultIOS exposes isValid
-   * + receipt/JWS metadata, VerifyPurchaseResultAndroid carries Play Store
-   * receipt fields (no isValid), and VerifyPurchaseResultHorizon uses success.
-   * Inspect the concrete variant before reading fields.
+   * Verify a purchase against your own backend. Every VerifyPurchaseResult
+   * variant exposes isValid, so entitlement can be gated without inspecting the
+   * concrete type. Variants add their own metadata on top: IOS carries
+   * receipt/JWS fields, Android carries Play Store receipt fields, and Horizon
+   * carries grantTime.
    * See: https://openiap.dev/docs/features/validation#verify-purchase
    */
   verifyPurchase: Promise<VerifyPurchaseResult>;
@@ -1857,6 +1857,12 @@ export interface RequestVerifyPurchaseWithIapkitResult {
    * Available in OpenIAP Spec 3.2.0 / openiap-apple 3.2.0 / openiap-google 3.3.0.
    * Amazon RVS environment selected by IAPKit. Present as `Sandbox` or
    * `Production` on handled Amazon verification results.
+   *
+   * Deliberately String, not an enum: the value space belongs to IAPKit and the
+   * stores behind it, and Apple's App Store Server alone also names `Xcode` and
+   * `LocalTesting`. SDKs must forward this value opaquely. Never reject a
+   * verification because the environment is unrecognised — that fails a purchase
+   * the store already confirmed.
    */
   environment?: (string | null);
   /**
@@ -2187,7 +2193,7 @@ export interface VerifyPurchaseProps {
 
 export type VerifyPurchaseResult = VerifyPurchaseResultAndroid | VerifyPurchaseResultHorizon | VerifyPurchaseResultIOS;
 
-export interface VerifyPurchaseResultAndroid {
+export interface VerifyPurchaseResultAndroid extends VerifyPurchaseResultCommon {
   autoRenewing: boolean;
   betaProduct: boolean;
   cancelDate?: (number | null);
@@ -2196,6 +2202,11 @@ export interface VerifyPurchaseResultAndroid {
   deferredSku?: (string | null);
   freeTrialEndDate: number;
   gracePeriodEndDate: number;
+  /**
+   * Whether the purchase is valid. Uniform across every VerifyPurchaseResult
+   * variant so callers can gate entitlement without inspecting the concrete type.
+   */
+  isValid: boolean;
   parentProductId: string;
   productId: string;
   productType: string;
@@ -2208,18 +2219,32 @@ export interface VerifyPurchaseResultAndroid {
   testTransaction: boolean;
 }
 
+/** Validity shared by every store-specific purchase verification result. */
+export interface VerifyPurchaseResultCommon {
+  /** Whether the purchase is valid, without inspecting the concrete result variant. */
+  isValid: boolean;
+}
+
 /**
  * Result from Meta Horizon verify_entitlement API.
  * Returns verification status and grant time for the entitlement.
  */
-export interface VerifyPurchaseResultHorizon {
+export interface VerifyPurchaseResultHorizon extends VerifyPurchaseResultCommon {
   /** Unix timestamp (seconds) when the entitlement was granted. */
   grantTime?: (number | null);
-  /** Whether the entitlement verification succeeded. */
+  /**
+   * Whether the purchase is valid. Uniform across every VerifyPurchaseResult
+   * variant so callers can gate entitlement without inspecting the concrete type.
+   */
+  isValid: boolean;
+  /**
+   * Whether the entitlement verification succeeded.
+   * @deprecated Renamed to isValid so every VerifyPurchaseResult variant answers validity the same way. Scheduled for removal in OpenIAP 4.0.
+   */
   success: boolean;
 }
 
-export interface VerifyPurchaseResultIOS {
+export interface VerifyPurchaseResultIOS extends VerifyPurchaseResultCommon {
   /** Whether the receipt is valid */
   isValid: boolean;
   /** JWS representation */

package/src/vega-adapter.ts

@@ -1271,17 +1271,12 @@ export function createVegaIapModule(service: VegaPurchasingService): RnIap {
           `IAPKit returned malformed response (HTTP ${status}).`,
         );
       }
-      const environment = json.environment;
-      if (
-        environment != null &&
-        (typeof environment !== 'string' ||
-          (environment !== 'Sandbox' && environment !== 'Production'))
-      ) {
-        throw createVegaError(
-          ErrorCode.PurchaseVerificationFailed,
-          `IAPKit returned malformed response (HTTP ${status}).`,
-        );
-      }
+      // Forwarded opaquely: `environment` is String in the spec.
+      const rawEnvironment = json.environment;
+      const environment =
+        typeof rawEnvironment === 'string' && rawEnvironment.length > 0
+          ? rawEnvironment
+          : undefined;
 
       return {
         ...(environment == null ? {} : {environment}),

package/nitrogen/generated/android/c++/JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid.cpp

@@ -1,26 +0,0 @@
-///
-/// JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid.cpp
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © Marc Rousavy @ Margelo
-///
-
-#include "JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid.hpp"
-
-namespace margelo::nitro::iap {
-  /**
-   * Converts JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid to std::variant<NitroPurchaseVerificationResultIOS, NitroPurchaseVerificationResultAndroid>
-   */
-  std::variant<NitroPurchaseVerificationResultIOS, NitroPurchaseVerificationResultAndroid> JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid::toCpp() const {
-    if (isInstanceOf(JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid_impl::First::javaClassStatic())) {
-      // It's a `NitroPurchaseVerificationResultIOS`
-      auto jniValue = static_cast<const JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid_impl::First*>(this)->getValue();
-      return jniValue->toCpp();
-    } else if (isInstanceOf(JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid_impl::Second::javaClassStatic())) {
-      // It's a `NitroPurchaseVerificationResultAndroid`
-      auto jniValue = static_cast<const JVariant_NitroPurchaseVerificationResultIOS_NitroPurchaseVerificationResultAndroid_impl::Second*>(this)->getValue();
-      return jniValue->toCpp();
-    }
-    throw std::invalid_argument("Variant is unknown Kotlin instance!");
-  }
-} // namespace margelo::nitro::iap