expo-iap 3.0.4 → 3.0.5

package/src/index.ts

@@ -22,6 +22,7 @@ import {
   Purchase,
   ErrorCode,
   RequestPurchaseProps,
+  RequestPurchasePropsByPlatforms,
   RequestSubscriptionPropsByPlatforms,
   ProductSubscription,
   PurchaseAndroid,
@@ -68,6 +69,58 @@ export const emitter = (ExpoIapModule || NativeModulesProxy.ExpoIap) as {
   ) => void;
 };
 
+/**
+ * TODO(v3.1.0): Remove legacy 'inapp' alias once downstream apps migrate to 'in-app'.
+ */
+export type ProductTypeInput = 'inapp' | 'in-app' | 'subs';
+export type InAppTypeInput = Exclude<ProductTypeInput, 'subs'>;
+
+type PurchaseRequestInApp = {
+  request: RequestPurchasePropsByPlatforms;
+  type?: InAppTypeInput;
+};
+
+type PurchaseRequestSubscription = {
+  request: RequestSubscriptionPropsByPlatforms;
+  type: 'subs';
+};
+
+export type PurchaseRequestInput =
+  | PurchaseRequestInApp
+  | PurchaseRequestSubscription;
+
+export type PurchaseRequest =
+  | {
+      request: RequestPurchaseProps;
+      type?: InAppTypeInput;
+    }
+  | {
+      request: RequestSubscriptionPropsByPlatforms;
+      type: 'subs';
+    };
+
+const normalizeProductType = (type?: ProductTypeInput) => {
+  if (type === 'inapp') {
+    console.warn(
+      "expo-iap: 'inapp' product type is deprecated and will be removed in v3.1.0. Use 'in-app' instead.",
+    );
+  }
+
+  if (!type || type === 'inapp' || type === 'in-app') {
+    return {
+      canonical: 'in-app' as const,
+      native: 'inapp' as const,
+    };
+  }
+  if (type === 'subs') {
+    return {
+      canonical: 'subs' as const,
+      native: 'subs' as const,
+    };
+  }
+  throw new Error(`Unsupported product type: ${type}`);
+};
+
 export const purchaseUpdatedListener = (
   listener: (event: Purchase) => void,
 ) => {
@@ -146,14 +199,14 @@ export async function endConnection(): Promise<boolean> {
  *
  * @param params - Product fetch configuration
  * @param params.skus - Array of product SKUs to fetch
- * @param params.type - Type of products: 'inapp' for regular products (default) or 'subs' for subscriptions
+ * @param params.type - Type of products: 'in-app' for regular products (default) or 'subs' for subscriptions
  *
  * @example
  * ```typescript
  * // Regular products
  * const products = await fetchProducts({
  *   skus: ['product1', 'product2'],
- *   type: 'inapp'
+ *   type: 'in-app'
  * });
  *
  * // Subscriptions
@@ -165,10 +218,10 @@ export async function endConnection(): Promise<boolean> {
  */
 export const fetchProducts = async ({
   skus,
-  type = 'inapp',
+  type,
 }: {
   skus: string[];
-  type?: 'inapp' | 'subs';
+  type?: ProductTypeInput;
 }): Promise<Product[] | ProductSubscription[]> => {
   if (!skus?.length) {
     throw new PurchaseError({
@@ -177,8 +230,10 @@ export const fetchProducts = async ({
     });
   }
 
+  const {canonical, native} = normalizeProductType(type);
+
   if (Platform.OS === 'ios') {
-    const rawItems = await ExpoIapModule.fetchProducts({skus, type});
+    const rawItems = await ExpoIapModule.fetchProducts({skus, type: native});
 
     const filteredItems = rawItems.filter((item: unknown) => {
       if (!isProductIOS(item)) {
@@ -193,13 +248,13 @@ export const fetchProducts = async ({
       return isValid;
     });
 
-    return type === 'inapp'
+    return canonical === 'in-app'
       ? (filteredItems as Product[])
       : (filteredItems as ProductSubscription[]);
   }
 
   if (Platform.OS === 'android') {
-    const items = await ExpoIapModule.fetchProducts(type, skus);
+    const items = await ExpoIapModule.fetchProducts(native, skus);
     const filteredItems = items.filter((item: unknown) => {
       if (!isProductAndroid(item)) return false;
       return (
@@ -211,7 +266,7 @@ export const fetchProducts = async ({
       );
     });
 
-    return type === 'inapp'
+    return canonical === 'in-app'
       ? (filteredItems as Product[])
       : (filteredItems as ProductSubscription[]);
   }
@@ -284,22 +339,13 @@ const offerToRecordIOS = (
   };
 };
 
-// Define discriminated union with explicit type parameter
-type PurchaseRequest =
-  | {
-      request: RequestPurchaseProps;
-      type?: 'inapp';
-    }
-  | {
-      request: RequestSubscriptionPropsByPlatforms;
-      type: 'subs';
-    };
-
 /**
  * Helper to normalize request props to platform-specific format
  */
 const normalizeRequestProps = (
-  request: RequestPurchaseProps | RequestSubscriptionPropsByPlatforms,
+  request:
+    | RequestPurchasePropsByPlatforms
+    | RequestSubscriptionPropsByPlatforms,
   platform: 'ios' | 'android',
 ): any => {
   // Platform-specific format - directly return the appropriate platform data
@@ -311,7 +357,7 @@ const normalizeRequestProps = (
  *
  * @param requestObj - Purchase request configuration
  * @param requestObj.request - Platform-specific purchase parameters
- * @param requestObj.type - Type of purchase: 'inapp' for products (default) or 'subs' for subscriptions
+ * @param requestObj.type - Type of purchase: 'in-app' for products (default) or 'subs' for subscriptions
  *
  * @example
  * ```typescript
@@ -321,7 +367,7 @@ const normalizeRequestProps = (
  *     ios: { sku: productId },
  *     android: { skus: [productId] }
  *   },
- *   type: 'inapp'
+ *   type: 'in-app'
  * });
  *
  * // Subscription purchase
@@ -338,9 +384,11 @@ const normalizeRequestProps = (
  * ```
  */
 export const requestPurchase = (
-  requestObj: PurchaseRequest,
+  requestObj: PurchaseRequestInput,
 ): Promise<Purchase | Purchase[] | void> => {
-  const {request, type = 'inapp'} = requestObj;
+  const {request, type} = requestObj;
+  const {canonical, native} = normalizeProductType(type);
+  const isInAppPurchase = canonical === 'in-app';
 
   if (Platform.OS === 'ios') {
     const normalizedRequest = normalizeRequestProps(request, 'ios');
@@ -369,7 +417,7 @@ export const requestPurchase = (
         withOffer: offer,
       });
 
-      return type === 'inapp' ? (purchase as Purchase) : (purchase as Purchase);
+      return purchase as Purchase;
     })();
   }
 
@@ -382,7 +430,7 @@ export const requestPurchase = (
       );
     }
 
-    if (type === 'inapp') {
+    if (isInAppPurchase) {
       const {
         skus,
         obfuscatedAccountIdAndroid,
@@ -392,7 +440,7 @@ export const requestPurchase = (
 
       return (async () => {
         return ExpoIapModule.requestPurchase({
-          type: 'inapp',
+          type: native,
           skuArr: skus,
           purchaseToken: undefined,
           replacementMode: -1,
@@ -404,7 +452,7 @@ export const requestPurchase = (
       })();
     }
 
-    if (type === 'subs') {
+    if (canonical === 'subs') {
       const {
         skus,
         obfuscatedAccountIdAndroid,
@@ -417,7 +465,7 @@ export const requestPurchase = (
 
       return (async () => {
         return ExpoIapModule.requestPurchase({
-          type: 'subs',
+          type: native,
           skuArr: skus,
           purchaseToken,
           replacementMode: replacementModeAndroid,

package/src/modules/android.ts

@@ -6,18 +6,16 @@ import ExpoIapModule from '../ExpoIapModule';
 
 // Types
 import type {ReceiptValidationResultAndroid, VoidResult} from '../types';
-import {Platform as PurchasePlatform} from '../types';
 
 // Type guards
-export function isProductAndroid<
-  T extends {platform?: string | PurchasePlatform},
->(item: unknown): item is T & {platform: PurchasePlatform.Android | 'android'} {
+export function isProductAndroid<T extends {platform?: string}>(
+  item: unknown,
+): item is T & {platform: 'android'} {
   return (
     item != null &&
     typeof item === 'object' &&
     'platform' in item &&
-    ((item as any).platform === 'android' ||
-      (item as any).platform === PurchasePlatform.Android)
+    (item as any).platform === 'android'
   );
 }
 
@@ -73,7 +71,7 @@ export const deepLinkToSubscriptionsAndroid = async ({
  * @param {string} params.productId - product id for your in app product.
  * @param {string} params.productToken - token for your purchase (called 'token' in the API documentation).
  * @param {string} params.accessToken - OAuth access token with androidpublisher scope. Required for authentication.
- * @param {boolean} params.isSub - whether this is subscription or inapp. `true` for subscription.
+ * @param {boolean} params.isSub - whether this is subscription or in-app. `true` for subscription.
  * @returns {Promise<ReceiptAndroid>}
  */
 export const validateReceiptAndroid = async ({

package/src/modules/ios.ts

@@ -13,7 +13,6 @@ import type {
   ReceiptValidationResultIOS,
 } from '../types';
 import type {PurchaseError} from '../purchase-error';
-import {Platform as PurchasePlatform} from '../types';
 import {Linking} from 'react-native';
 
 export type TransactionEvent = {
@@ -24,15 +23,14 @@ export type TransactionEvent = {
 // Listeners
 
 // Type guards
-export function isProductIOS<T extends {platform?: string | PurchasePlatform}>(
+export function isProductIOS<T extends {platform?: string}>(
   item: unknown,
-): item is T & {platform: PurchasePlatform.Ios | 'ios'} {
+): item is T & {platform: 'ios'} {
   return (
     item != null &&
     typeof item === 'object' &&
     'platform' in item &&
-    ((item as any).platform === 'ios' ||
-      (item as any).platform === PurchasePlatform.Ios)
+    (item as any).platform === 'ios'
   );
 }
 

package/src/purchase-error.ts

@@ -1,8 +1,5 @@
 import {NATIVE_ERROR_CODES} from './ExpoIapModule';
-import {ErrorCode, Platform} from './types';
-
-/** Platform identifiers supported by {@link PurchaseError}. */
-export type PurchaseErrorPlatform = Platform | 'ios' | 'android';
+import {ErrorCode, IapPlatform} from './types';
 
 /** Properties used to construct a {@link PurchaseError}. */
 export interface PurchaseErrorProps {
@@ -11,7 +8,7 @@ export interface PurchaseErrorProps {
   debugMessage?: string;
   code?: ErrorCode;
   productId?: string;
-  platform?: PurchaseErrorPlatform;
+  platform?: IapPlatform;
 }
 
 /** Shape of raw platform error objects coming from native modules. */
@@ -26,10 +23,10 @@ type PlatformErrorData = {
 const toStandardizedCode = (errorCode: ErrorCode): string =>
   errorCode.startsWith('E_') ? errorCode : `E_${errorCode}`;
 
-const normalizePlatform = (
-  platform: PurchaseErrorPlatform,
-): 'ios' | 'android' =>
-  platform === Platform.Ios || platform === 'ios' ? 'ios' : 'android';
+const normalizePlatform = (platform: IapPlatform): 'ios' | 'android' =>
+  typeof platform === 'string' && platform.toLowerCase() === 'ios'
+    ? 'ios'
+    : 'android';
 
 const OPENIAP_ERROR_CODE_SET: Set<string> = new Set(
   Object.values(ErrorCode).map((code) => toStandardizedCode(code)),
@@ -103,7 +100,7 @@ export class PurchaseError extends Error {
   public debugMessage?: string;
   public code?: ErrorCode;
   public productId?: string;
-  public platform?: PurchaseErrorPlatform;
+  public platform?: IapPlatform;
 
   constructor(
     message: string,
@@ -111,7 +108,7 @@ export class PurchaseError extends Error {
     debugMessage?: string,
     code?: ErrorCode,
     productId?: string,
-    platform?: PurchaseErrorPlatform,
+    platform?: IapPlatform,
   );
   constructor(props: PurchaseErrorProps);
   constructor(
@@ -120,7 +117,7 @@ export class PurchaseError extends Error {
     debugMessage?: string,
     code?: ErrorCode,
     productId?: string,
-    platform?: PurchaseErrorPlatform,
+    platform?: IapPlatform,
   ) {
     super(
       typeof messageOrProps === 'string'
@@ -150,7 +147,7 @@ export class PurchaseError extends Error {
    */
   static fromPlatformError(
     errorData: PlatformErrorData,
-    platform: PurchaseErrorPlatform,
+    platform: IapPlatform,
   ): PurchaseError {
     const normalizedPlatform = normalizePlatform(platform);
 
@@ -197,7 +194,7 @@ export const ErrorCodeUtils = {
    */
   fromPlatformCode: (
     platformCode: string | number,
-    _platform: PurchaseErrorPlatform,
+    _platform: IapPlatform,
   ): ErrorCode => {
     if (typeof platformCode === 'string' && platformCode.startsWith('E_')) {
       if (OPENIAP_ERROR_CODE_SET.has(platformCode)) {
@@ -241,7 +238,7 @@ export const ErrorCodeUtils = {
    */
   toPlatformCode: (
     errorCode: ErrorCode,
-    _platform: PurchaseErrorPlatform,
+    _platform: IapPlatform,
   ): string | number => {
     const standardized = toStandardizedCode(errorCode);
     const native = (NATIVE_ERROR_CODES as Record<string, string | number>)[
@@ -254,7 +251,7 @@ export const ErrorCodeUtils = {
    */
   isValidForPlatform: (
     errorCode: ErrorCode,
-    platform: PurchaseErrorPlatform,
+    platform: IapPlatform,
   ): boolean => {
     const standardized = toStandardizedCode(errorCode);
     if (