expo-iap 2.8.6 → 2.9.0-rc.1

package/src/index.ts

@@ -45,7 +45,7 @@ export {
 // Get the native constant value
 export const PI = ExpoIapModule.PI;
 
-export enum IapEvent {
+export enum OpenIapEvent {
   PurchaseUpdated = 'purchase-updated',
   PurchaseError = 'purchase-error',
   /** @deprecated Use PurchaseUpdated instead. This will be removed in a future version. */
@@ -73,7 +73,7 @@ export const purchaseUpdatedListener = (
   listener: (event: Purchase) => void,
 ) => {
   const emitterSubscription = emitter.addListener(
-    IapEvent.PurchaseUpdated,
+    OpenIapEvent.PurchaseUpdated,
     listener,
   );
   return emitterSubscription;
@@ -82,7 +82,7 @@ export const purchaseUpdatedListener = (
 export const purchaseErrorListener = (
   listener: (error: PurchaseError) => void,
 ) => {
-  return emitter.addListener(IapEvent.PurchaseError, listener);
+  return emitter.addListener(OpenIapEvent.PurchaseError, listener);
 };
 
 /**
@@ -114,7 +114,7 @@ export const promotedProductListenerIOS = (
     );
     return {remove: () => {}};
   }
-  return emitter.addListener(IapEvent.PromotedProductIOS, listener);
+  return emitter.addListener(OpenIapEvent.PromotedProductIOS, listener);
 };
 
 export function initConnection(): Promise<boolean> {
@@ -124,7 +124,7 @@ export function initConnection(): Promise<boolean> {
 
 export const getProducts = async (skus: string[]): Promise<Product[]> => {
   console.warn(
-    "`getProducts` is deprecated. Use `requestProducts({ skus, type: 'inapp' })` instead. This function will be removed in version 3.0.0.",
+    "`getProducts` is deprecated. Use `fetchProducts({ skus, type: 'inapp' })` instead. This function will be removed in version 3.0.0.",
   );
   if (!skus?.length) {
     return Promise.reject(new Error('"skus" is required'));
@@ -132,7 +132,7 @@ export const getProducts = async (skus: string[]): Promise<Product[]> => {
 
   return Platform.select({
     ios: async () => {
-      const rawItems = await ExpoIapModule.requestProducts(skus);
+      const rawItems = await ExpoIapModule.fetchProducts(skus);
       return rawItems.filter((item: unknown) => {
         if (!isProductIOS(item)) return false;
         return (
@@ -145,7 +145,7 @@ export const getProducts = async (skus: string[]): Promise<Product[]> => {
       }) as Product[];
     },
     android: async () => {
-      const products = await ExpoIapModule.requestProducts('inapp', skus);
+      const products = await ExpoIapModule.fetchProducts('inapp', skus);
       return products.filter((product: unknown) =>
         isProductAndroid<Product>(product),
       );
@@ -158,7 +158,7 @@ export const getSubscriptions = async (
   skus: string[],
 ): Promise<SubscriptionProduct[]> => {
   console.warn(
-    "`getSubscriptions` is deprecated. Use `requestProducts({ skus, type: 'subs' })` instead. This function will be removed in version 3.0.0.",
+    "`getSubscriptions` is deprecated. Use `fetchProducts({ skus, type: 'subs' })` instead. This function will be removed in version 3.0.0.",
   );
   if (!skus?.length) {
     return Promise.reject(new Error('"skus" is required'));
@@ -166,7 +166,7 @@ export const getSubscriptions = async (
 
   return Platform.select({
     ios: async () => {
-      const rawItems = await ExpoIapModule.requestProducts(skus);
+      const rawItems = await ExpoIapModule.fetchProducts(skus);
       return rawItems.filter((item: unknown) => {
         if (!isProductIOS(item)) return false;
         return (
@@ -179,7 +179,7 @@ export const getSubscriptions = async (
       }) as SubscriptionProduct[];
     },
     android: async () => {
-      const rawItems = await ExpoIapModule.requestProducts('subs', skus);
+      const rawItems = await ExpoIapModule.fetchProducts('subs', skus);
       return rawItems.filter((item: unknown) => {
         if (!isProductAndroid(item)) return false;
         return (
@@ -200,28 +200,28 @@ export async function endConnection(): Promise<boolean> {
 }
 
 /**
- * Request products with unified API (v2.7.0+)
+ * Fetch products with unified API (v2.7.0+)
  *
- * @param params - Product request configuration
+ * @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
  *
  * @example
  * ```typescript
  * // Regular products
- * const products = await requestProducts({
+ * const products = await fetchProducts({
  *   skus: ['product1', 'product2'],
  *   type: 'inapp'
  * });
  *
  * // Subscriptions
- * const subscriptions = await requestProducts({
+ * const subscriptions = await fetchProducts({
  *   skus: ['sub1', 'sub2'],
  *   type: 'subs'
  * });
  * ```
  */
-export const requestProducts = async ({
+export const fetchProducts = async ({
   skus,
   type = 'inapp',
 }: {
@@ -233,7 +233,7 @@ export const requestProducts = async ({
   }
 
   if (Platform.OS === 'ios') {
-    const rawItems = await ExpoIapModule.requestProducts(skus);
+    const rawItems = await ExpoIapModule.fetchProducts(skus);
     const filteredItems = rawItems.filter((item: unknown) => {
       if (!isProductIOS(item)) return false;
       return (
@@ -251,7 +251,7 @@ export const requestProducts = async ({
   }
 
   if (Platform.OS === 'android') {
-    const items = await ExpoIapModule.requestProducts(type, skus);
+    const items = await ExpoIapModule.fetchProducts(type, skus);
     const filteredItems = items.filter((item: unknown) => {
       if (!isProductAndroid(item)) return false;
       return (
@@ -271,6 +271,41 @@ export const requestProducts = async ({
   throw new Error('Unsupported platform');
 };
 
+/**
+ * @deprecated Use `fetchProducts` instead. This method will be removed in version 3.0.0.
+ * 
+ * The 'request' prefix should only be used for event-based operations that trigger
+ * purchase flows. Since this function simply fetches product information, it has been
+ * renamed to `fetchProducts` to follow OpenIAP terminology guidelines.
+ * 
+ * @example
+ * ```typescript
+ * // Old way (deprecated)
+ * const products = await requestProducts({
+ *   skus: ['com.example.product1'],
+ *   type: 'inapp'
+ * });
+ * 
+ * // New way (recommended)
+ * const products = await fetchProducts({
+ *   skus: ['com.example.product1'],
+ *   type: 'inapp'
+ * });
+ * ```
+ */
+export const requestProducts = async ({
+  skus,
+  type = 'inapp',
+}: {
+  skus: string[];
+  type?: 'inapp' | 'subs';
+}): Promise<Product[] | SubscriptionProduct[]> => {
+  console.warn(
+    "`requestProducts` is deprecated. Use `fetchProducts` instead. The 'request' prefix should only be used for event-based operations. This method will be removed in version 3.0.0."
+  );
+  return fetchProducts({ skus, type });
+};
+
 /**
  * @deprecated Use `getPurchaseHistories` instead. This function will be removed in version 3.0.0.
  */
@@ -291,10 +326,8 @@ export const getPurchaseHistory = ({
     '`getPurchaseHistory` is deprecated. Use `getPurchaseHistories` instead. This function will be removed in version 3.0.0.',
   );
   return getPurchaseHistories({
-    alsoPublishToEventListenerIOS:
-      alsoPublishToEventListenerIOS ?? alsoPublishToEventListener,
-    onlyIncludeActiveItemsIOS:
-      onlyIncludeActiveItemsIOS ?? onlyIncludeActiveItems,
+    alsoPublishToEventListenerIOS: alsoPublishToEventListenerIOS ?? alsoPublishToEventListener,
+    onlyIncludeActiveItemsIOS: onlyIncludeActiveItemsIOS ?? onlyIncludeActiveItems,
   });
 };
 
@@ -357,9 +390,8 @@ export const getAvailablePurchases = ({
         ),
       android: async () => {
         const products = await ExpoIapModule.getAvailableItemsByType('inapp');
-        const subscriptions = await ExpoIapModule.getAvailableItemsByType(
-          'subs',
-        );
+        const subscriptions =
+          await ExpoIapModule.getAvailableItemsByType('subs');
         return products.concat(subscriptions);
       },
     }) || (() => Promise.resolve([]))
@@ -433,7 +465,11 @@ const normalizeRequestProps = (
  */
 export const requestPurchase = (
   requestObj: PurchaseRequest,
-): Promise<Purchase | Purchase[] | void> => {
+): Promise<
+  | Purchase
+  | Purchase[]
+  | void
+> => {
   const {request, type = 'inapp'} = requestObj;
 
   if (Platform.OS === 'ios') {
@@ -463,7 +499,9 @@ export const requestPurchase = (
         offer,
       );
 
-      return type === 'inapp' ? (purchase as Purchase) : (purchase as Purchase);
+      return type === 'inapp'
+        ? (purchase as Purchase)
+        : (purchase as Purchase);
     })();
   }
 
@@ -591,11 +629,10 @@ export const finishTransaction = ({
       },
       android: async () => {
         const androidPurchase = purchase as PurchaseAndroid;
-
+        
         // Use purchaseToken if available, fallback to purchaseTokenAndroid for backward compatibility
-        const token =
-          androidPurchase.purchaseToken || androidPurchase.purchaseTokenAndroid;
-
+        const token = androidPurchase.purchaseToken || androidPurchase.purchaseTokenAndroid;
+        
         if (!token) {
           return Promise.reject(
             new PurchaseError(
@@ -605,8 +642,8 @@ export const finishTransaction = ({
               undefined,
               'E_DEVELOPER_ERROR' as ErrorCode,
               androidPurchase.productId,
-              'android',
-            ),
+              'android'
+            )
           );
         }
 
@@ -639,7 +676,7 @@ export const getStorefrontIOS = (): Promise<string> => {
     console.warn('getStorefrontIOS: This method is only available on iOS');
     return Promise.resolve('');
   }
-  return ExpoIapModule.getStorefront();
+  return ExpoIapModule.getStorefrontIOS();
 };
 
 /**

package/src/modules/android.ts

@@ -26,7 +26,7 @@ export function isProductAndroid<T extends {platform?: string}>(
  * @param {string} params.sku - The product's SKU (on Android)
  * @param {string} params.packageName - The package name of your Android app (e.g., 'com.example.app')
  * @returns {Promise<void>}
- *
+ * 
  * @example
  * ```typescript
  * await deepLinkToSubscriptionsAndroid({
@@ -43,11 +43,9 @@ export const deepLinkToSubscriptionsAndroid = async ({
   packageName: string;
 }): Promise<void> => {
   if (!packageName) {
-    throw new Error(
-      'packageName is required for deepLinkToSubscriptionsAndroid',
-    );
+    throw new Error('packageName is required for deepLinkToSubscriptionsAndroid');
   }
-
+  
   return Linking.openURL(
     `https://play.google.com/store/account/subscriptions?package=${packageName}&sku=${sku}`,
   );
@@ -120,9 +118,11 @@ export const acknowledgePurchaseAndroid = ({
  * Open the Google Play Store to redeem offer codes (Android only).
  * Note: Google Play does not provide a direct API to redeem codes within the app.
  * This function opens the Play Store where users can manually enter their codes.
- *
+ * 
  * @returns {Promise<void>}
  */
 export const openRedeemOfferCodeAndroid = async (): Promise<void> => {
-  return Linking.openURL(`https://play.google.com/redeem?code=`);
+  return Linking.openURL(
+    `https://play.google.com/redeem?code=`
+  );
 };

package/src/modules/ios.ts

@@ -5,7 +5,11 @@ import {purchaseUpdatedListener} from '..';
 import ExpoIapModule from '../ExpoIapModule';
 
 // Types
-import {Product, Purchase, PurchaseError} from '../ExpoIap.types';
+import {
+  Product,
+  Purchase,
+  PurchaseError,
+} from '../ExpoIap.types';
 import type {
   ProductStatusIOS,
   AppTransactionIOS,
@@ -133,7 +137,9 @@ export const subscriptionStatusIOS = (
  *
  * @platform iOS
  */
-export const currentEntitlementIOS = (sku: string): Promise<Purchase> => {
+export const currentEntitlementIOS = (
+  sku: string,
+): Promise<Purchase> => {
   return ExpoIapModule.currentEntitlementIOS(sku);
 };
 
@@ -318,7 +324,7 @@ export const buyPromotedProductIOS = (): Promise<void> => {
 
 /**
  * Get pending transactions that haven't been finished yet (iOS only).
- *
+ * 
  * @returns Promise resolving to array of pending transactions
  * @platform iOS
  */
@@ -328,9 +334,9 @@ export const getPendingTransactionsIOS = (): Promise<any[]> => {
 
 /**
  * Clear a specific transaction (iOS only).
- *
+ * 
  * @returns Promise resolving when transaction is cleared
- * @platform iOS
+ * @platform iOS  
  */
 export const clearTransactionIOS = (): Promise<void> => {
   return ExpoIapModule.clearTransactionIOS();

package/src/types/ExpoIapAndroid.types.ts

@@ -31,7 +31,7 @@ type ProductSubscriptionAndroidOfferDetail = {
 export type ProductAndroid = ProductCommon & {
   nameAndroid: string;
   oneTimePurchaseOfferDetailsAndroid?: ProductAndroidOneTimePurchaseOfferDetail;
-  platform: 'android';
+  platform: "android";
   subscriptionOfferDetailsAndroid?: ProductSubscriptionAndroidOfferDetail[];
   /**
    * @deprecated Use `nameAndroid` instead. This field will be removed in v2.9.0.
@@ -144,7 +144,7 @@ export const PurchaseStateAndroid = PurchaseAndroidState;
 
 // Legacy naming for backward compatibility
 export type ProductPurchaseAndroid = PurchaseCommon & {
-  platform: 'android';
+  platform: "android";
   /**
    * @deprecated Use `purchaseToken` instead. This field will be removed in a future version.
    */
@@ -167,8 +167,7 @@ export type PurchaseAndroid = ProductPurchaseAndroid;
 /**
  * @deprecated Use `ProductAndroidOneTimePurchaseOfferDetail` instead. This type will be removed in v2.9.0.
  */
-export type OneTimePurchaseOfferDetails =
-  ProductAndroidOneTimePurchaseOfferDetail;
+export type OneTimePurchaseOfferDetails = ProductAndroidOneTimePurchaseOfferDetail;
 
 /**
  * @deprecated Use `ProductSubscriptionAndroidOfferDetail` instead. This type will be removed in v2.9.0.

package/src/types/ExpoIapIOS.types.ts

@@ -30,7 +30,7 @@ export type ProductIOS = ProductCommon & {
   displayNameIOS: string;
   isFamilyShareableIOS: boolean;
   jsonRepresentationIOS: string;
-  platform: 'ios';
+  platform: "ios";
   subscriptionInfoIOS?: SubscriptionInfo;
   /**
    * @deprecated Use `displayNameIOS` instead. This field will be removed in v2.9.0.
@@ -69,7 +69,7 @@ export type ProductSubscriptionIOS = ProductIOS & {
   introductoryPricePaymentModeIOS?: PaymentMode;
   introductoryPriceNumberOfPeriodsIOS?: string;
   introductoryPriceSubscriptionPeriodIOS?: SubscriptionIosPeriod;
-  platform: 'ios';
+  platform: "ios";
   subscriptionPeriodNumberIOS?: string;
   subscriptionPeriodUnitIOS?: SubscriptionIosPeriod;
   /**
@@ -140,7 +140,7 @@ export type ProductStatusIOS = {
 // Legacy naming for backward compatibility
 export type ProductPurchaseIOS = PurchaseCommon & {
   // iOS basic fields
-  platform: 'ios';
+  platform: "ios";
   quantityIOS?: number;
   originalTransactionDateIOS?: number;
   originalTransactionIdentifierIOS?: string;
@@ -179,6 +179,7 @@ export type ProductPurchaseIOS = PurchaseCommon & {
 // Preferred naming
 export type PurchaseIOS = ProductPurchaseIOS;
 
+
 export type AppTransactionIOS = {
   appTransactionId?: string; // Only available in iOS 18.4+
   originalPlatform?: string; // Only available in iOS 18.4+

package/src/useIAP.ts

@@ -14,7 +14,7 @@ import {
   getPurchaseHistories,
   finishTransaction as finishTransactionInternal,
   requestPurchase as requestPurchaseInternal,
-  requestProducts,
+  fetchProducts,
   validateReceipt as validateReceiptInternal,
   getActiveSubscriptions,
   hasActiveSubscriptions,
@@ -60,18 +60,26 @@ type UseIap = {
   }) => Promise<PurchaseResult | boolean>;
   getAvailablePurchases: (skus: string[]) => Promise<void>;
   getPurchaseHistories: (skus: string[]) => Promise<void>;
+  fetchProducts: (params: {
+    skus: string[];
+    type?: 'inapp' | 'subs';
+  }) => Promise<void>;
+  /**
+   * @deprecated Use fetchProducts({ skus, type: 'inapp' | 'subs' }) instead. This method will be removed in version 3.0.0.
+   * The 'request' prefix should only be used for event-based operations.
+   */
   requestProducts: (params: {
     skus: string[];
     type?: 'inapp' | 'subs';
   }) => Promise<void>;
   /**
-   * @deprecated Use requestProducts({ skus, type: 'inapp' }) instead. This method will be removed in version 3.0.0.
-   * Note: This method internally uses requestProducts, so no deprecation warning is shown.
+   * @deprecated Use fetchProducts({ skus, type: 'inapp' }) instead. This method will be removed in version 3.0.0.
+   * Note: This method internally uses fetchProducts, so no deprecation warning is shown.
    */
   getProducts: (skus: string[]) => Promise<void>;
   /**
-   * @deprecated Use requestProducts({ skus, type: 'subs' }) instead. This method will be removed in version 3.0.0.
-   * Note: This method internally uses requestProducts, so no deprecation warning is shown.
+   * @deprecated Use fetchProducts({ skus, type: 'subs' }) instead. This method will be removed in version 3.0.0.
+   * Note: This method internally uses fetchProducts, so no deprecation warning is shown.
    */
   getSubscriptions: (skus: string[]) => Promise<void>;
   requestPurchase: (params: {
@@ -99,7 +107,9 @@ type UseIap = {
 };
 
 export interface UseIAPOptions {
-  onPurchaseSuccess?: (purchase: Purchase) => void;
+  onPurchaseSuccess?: (
+    purchase: Purchase,
+  ) => void;
   onPurchaseError?: (error: PurchaseError) => void;
   onSyncError?: (error: Error) => void;
   shouldAutoSyncPurchases?: boolean; // New option to control auto-syncing
@@ -115,8 +125,12 @@ export function useIAP(options?: UseIAPOptions): UseIap {
   const [products, setProducts] = useState<Product[]>([]);
   const [promotedProductsIOS] = useState<Purchase[]>([]);
   const [subscriptions, setSubscriptions] = useState<SubscriptionProduct[]>([]);
-  const [purchaseHistories, setPurchaseHistories] = useState<Purchase[]>([]);
-  const [availablePurchases, setAvailablePurchases] = useState<Purchase[]>([]);
+  const [purchaseHistories, setPurchaseHistories] = useState<Purchase[]>(
+    [],
+  );
+  const [availablePurchases, setAvailablePurchases] = useState<
+    Purchase[]
+  >([]);
   const [currentPurchase, setCurrentPurchase] = useState<Purchase>();
   const [promotedProductIOS, setPromotedProductIOS] = useState<Product>();
   const [currentPurchaseError, setCurrentPurchaseError] =
@@ -177,7 +191,7 @@ export function useIAP(options?: UseIAPOptions): UseIap {
   const getProductsInternal = useCallback(
     async (skus: string[]): Promise<void> => {
       try {
-        const result = await requestProducts({skus, type: 'inapp'});
+        const result = await fetchProducts({skus, type: 'inapp'});
         setProducts((prevProducts) =>
           mergeWithDuplicateCheck(
             prevProducts,
@@ -195,7 +209,7 @@ export function useIAP(options?: UseIAPOptions): UseIap {
   const getSubscriptionsInternal = useCallback(
     async (skus: string[]): Promise<void> => {
       try {
-        const result = await requestProducts({skus, type: 'subs'});
+        const result = await fetchProducts({skus, type: 'subs'});
         setSubscriptions((prevSubscriptions) =>
           mergeWithDuplicateCheck(
             prevSubscriptions,
@@ -210,13 +224,13 @@ export function useIAP(options?: UseIAPOptions): UseIap {
     [mergeWithDuplicateCheck],
   );
 
-  const requestProductsInternal = useCallback(
+  const fetchProductsInternal = useCallback(
     async (params: {
       skus: string[];
       type?: 'inapp' | 'subs';
     }): Promise<void> => {
       try {
-        const result = await requestProducts(params);
+        const result = await fetchProducts(params);
         if (params.type === 'subs') {
           setSubscriptions((prevSubscriptions) =>
             mergeWithDuplicateCheck(
@@ -241,6 +255,19 @@ export function useIAP(options?: UseIAPOptions): UseIap {
     [mergeWithDuplicateCheck],
   );
 
+  const requestProductsInternal = useCallback(
+    async (params: {
+      skus: string[];
+      type?: 'inapp' | 'subs';
+    }): Promise<void> => {
+      console.warn(
+        "`requestProducts` is deprecated in useIAP hook. Use the new `fetchProducts` method instead. The 'request' prefix should only be used for event-based operations."
+      );
+      return fetchProductsInternal(params);
+    },
+    [fetchProductsInternal],
+  );
+
   const getAvailablePurchasesInternal = useCallback(async (): Promise<void> => {
     try {
       const result = await getAvailablePurchases();
@@ -454,6 +481,7 @@ export function useIAP(options?: UseIAPOptions): UseIap {
     clearCurrentPurchaseError,
     getAvailablePurchases: getAvailablePurchasesInternal,
     getPurchaseHistories: getPurchaseHistoriesInternal,
+    fetchProducts: fetchProductsInternal,
     requestProducts: requestProductsInternal,
     requestPurchase: requestPurchaseWithReset,
     validateReceipt,