expo-iap 2.1.0 → 2.2.0-rc.2

package/src/index.ts

@@ -2,7 +2,6 @@
 // and on native platforms to ExpoIap.ts
 import {NativeModulesProxy, EventEmitter} from 'expo-modules-core';
 import {Platform} from 'react-native';
-
 import {
   Product,
   ProductPurchase,
@@ -21,13 +20,14 @@ import {
 } from './types/ExpoIapAndroid.types';
 import {
   PaymentDiscount,
-  ProductIos,
   RequestPurchaseIosProps,
   RequestSubscriptionIosProps,
-  SubscriptionProductIos,
-  TransactionSk2,
 } from './types/ExpoIapIos.types';
-import {isProductIos} from './modules/ios';
+import {isProductIos, isSubscriptionProductIos} from './modules/ios';
+import {
+  isProductAndroid,
+  isSubscriptionProductAndroid,
+} from './modules/android';
 
 export * from './modules/android';
 export * from './modules/ios';
@@ -70,22 +70,25 @@ export function initConnection() {
 }
 
 export const getProducts = async (skus: string[]): Promise<Product[]> => {
+  console.log('getProducts', skus);
   if (!skus?.length) {
     return Promise.reject(new Error('"skus" is required'));
   }
 
   return Platform.select({
     ios: async () => {
-      const items = (await ExpoIapModule.getItems(skus)) as ProductIos[];
-      return items.filter((item: ProductIos) => isProductIos(item));
+      const items = await ExpoIapModule.getItems(skus);
+      console.log('items', items);
+      return items.filter((item: unknown) => isProductIos<Product>(item));
     },
     android: async () => {
       const products = await ExpoIapModule.getItemsByType(
         ProductType.InAppPurchase,
         skus,
       );
-
-      return products;
+      return products.filter((product: unknown) =>
+        isProductAndroid<Product>(product),
+      );
     },
     default: () => Promise.reject(new Error('Unsupported Platform')),
   })();
@@ -99,15 +102,33 @@ export const getSubscriptions = async (
   }
 
   return Platform.select({
-    ios: async (): Promise<SubscriptionProductIos[]> => {
-      const items: SubscriptionProductIos[] = (
-        (await ExpoIapModule.getItems(skus)) as SubscriptionProductIos[]
-      ).filter((item: SubscriptionProductIos) => skus.includes(item.id));
-
-      return items;
+    ios: async () => {
+      const rawItems = await ExpoIapModule.getItems(skus);
+
+      return rawItems.filter((item: unknown) => {
+        if (!isSubscriptionProductIos(item)) return false;
+        return (
+          typeof item === 'object' &&
+          item !== null &&
+          'id' in item &&
+          typeof item.id === 'string' &&
+          skus.includes(item.id)
+        );
+      }) as SubscriptionProduct[];
     },
     android: async () => {
-      return ExpoIapModule.getItemsByType('subs', skus);
+      const rawItems = await ExpoIapModule.getItemsByType('subs', skus);
+
+      return rawItems.filter((item: unknown) => {
+        if (!isSubscriptionProductAndroid(item)) return false;
+        return (
+          typeof item === 'object' &&
+          item !== null &&
+          'id' in item &&
+          typeof item.id === 'string' &&
+          skus.includes(item.id)
+        );
+      }) as SubscriptionProduct[];
     },
     default: () => Promise.reject(new Error('Unsupported Platform')),
   })();
@@ -119,11 +140,9 @@ export async function endConnection(): Promise<boolean> {
 
 export const getPurchaseHistory = ({
   alsoPublishToEventListener = false,
-  automaticallyFinishRestoredTransactions = true,
   onlyIncludeActiveItems = false,
 }: {
   alsoPublishToEventListener?: boolean;
-  automaticallyFinishRestoredTransactions?: boolean;
   onlyIncludeActiveItems?: boolean;
 } = {}): Promise<ProductPurchase[]> =>
   (
@@ -150,11 +169,9 @@ export const getPurchaseHistory = ({
 
 export const getAvailablePurchases = ({
   alsoPublishToEventListener = false,
-  automaticallyFinishRestoredTransactions = false,
   onlyIncludeActiveItems = true,
 }: {
   alsoPublishToEventListener?: boolean;
-  automaticallyFinishRestoredTransactions?: boolean;
   onlyIncludeActiveItems?: boolean;
 } = {}): Promise<ProductPurchase[]> =>
   (
@@ -193,43 +210,6 @@ const offerToRecordIos = (
   };
 };
 
-const iosTransactionToPurchaseMap = ({
-  id,
-  originalPurchaseDate,
-  productID,
-  purchaseDate,
-  purchasedQuantity,
-  originalID,
-  verificationResult,
-  appAccountToken,
-  jsonRepresentation,
-}: TransactionSk2): Purchase => {
-  let transactionReasonIOS;
-
-  try {
-    if (jsonRepresentation) {
-      const transactionData = JSON.parse(jsonRepresentation);
-      transactionReasonIOS = transactionData.transactionReason;
-    }
-  } catch (e) {
-    console.log('SK2 Error parsing jsonRepresentation', e);
-  }
-  const purchase: Purchase = {
-    productId: productID,
-    transactionId: String(id),
-    transactionDate: purchaseDate, //??
-    transactionReceipt: '', // Not available
-    purchaseToken: '', //Not available
-    quantityIOS: purchasedQuantity,
-    originalTransactionDateIOS: originalPurchaseDate,
-    originalTransactionIdentifierIOS: originalID,
-    verificationResultIOS: verificationResult ?? '',
-    appAccountToken: appAccountToken ?? '',
-    transactionReasonIOS: transactionReasonIOS ?? '',
-  };
-  return purchase;
-};
-
 export const requestPurchase = (
   request: RequestPurchaseIosProps | RequestPurchaseAndroidProps,
 ): Promise<ProductPurchase | ProductPurchase[] | void> =>
@@ -240,31 +220,17 @@ export const requestPurchase = (
           throw new Error('sku is required for iOS purchase');
         }
 
-        const {
-          sku,
-          andDangerouslyFinishTransactionAutomaticallyIOS = false,
-          appAccountToken,
-          quantity,
-          withOffer,
-        } = request;
-
-        if (andDangerouslyFinishTransactionAutomaticallyIOS) {
-          console.warn(
-            'You are dangerously allowing expo-iap to finish your transaction automatically. You should set andDangerouslyFinishTransactionAutomatically to false when calling requestPurchase and call finishTransaction manually when you have delivered the purchased goods to the user. It defaults to true to provide backwards compatibility. Will default to false in version 4.0.0.',
-          );
-        }
+        const {sku, appAccountToken, quantity, withOffer} = request;
 
         const offer = offerToRecordIos(withOffer);
 
-        const result = await ExpoIapModule.buyProduct(
+        const purchase = await ExpoIapModule.buyProduct(
           sku,
-          andDangerouslyFinishTransactionAutomaticallyIOS,
           appAccountToken,
           quantity ?? -1,
           offer,
         );
 
-        const purchase = iosTransactionToPurchaseMap(result);
         return Promise.resolve(purchase);
       },
       android: async () => {
@@ -303,35 +269,21 @@ export const requestSubscription = (
           throw new Error('sku is required for iOS subscriptions');
         }
 
-        const {
-          sku,
-          andDangerouslyFinishTransactionAutomaticallyIOS = false,
-          appAccountToken,
-          quantity,
-          withOffer,
-        } = request as RequestSubscriptionIosProps;
-
-        if (andDangerouslyFinishTransactionAutomaticallyIOS) {
-          console.warn(
-            'You are dangerously allowing expo-iap to finish your transaction automatically. You should set andDangerouslyFinishTransactionAutomatically to false when calling requestPurchase and call finishTransaction manually when you have delivered the purchased goods to the user. It defaults to true to provide backwards compatibility. Will default to false in version 4.0.0.',
-          );
-        }
+        const {sku, appAccountToken, quantity, withOffer} =
+          request as RequestSubscriptionIosProps;
 
         const offer = offerToRecordIos(withOffer);
 
-        const purchase = iosTransactionToPurchaseMap(
-          await ExpoIapModule.buyProduct(
-            sku,
-            andDangerouslyFinishTransactionAutomaticallyIOS,
-            appAccountToken,
-            quantity ?? -1,
-            offer,
-          ),
+        const purchase = await ExpoIapModule.buyProduct(
+          sku,
+          appAccountToken,
+          quantity ?? -1,
+          offer,
         );
-        return Promise.resolve(purchase);
+
+        return Promise.resolve(purchase as SubscriptionPurchase);
       },
       android: async () => {
-        console.log('requestSubscription', request);
         const {
           skus,
           isOfferPersonalized,

package/src/modules/android.ts

@@ -1,20 +1,24 @@
 import {Linking} from 'react-native';
-import {Product, PurchaseResult, SubscriptionProduct} from '../ExpoIap.types';
-import {
-  ProductAndroid,
-  ReceiptAndroid,
-  SubscriptionProductAndroid,
-} from '../types/ExpoIapAndroid.types';
+import {PurchaseResult} from '../ExpoIap.types';
+import {ReceiptAndroid} from '../types/ExpoIapAndroid.types';
 import ExpoIapModule from '../ExpoIapModule';
 
-export function isProductAndroid(product: Product): product is ProductAndroid {
-  return (product as ProductAndroid)?.title !== undefined;
+// Type guards
+export function isProductAndroid<T extends {platform?: string}>(
+  item: unknown,
+): item is T & {platform: 'android'} {
+  return (
+    item != null &&
+    typeof item === 'object' &&
+    'platform' in item &&
+    item.platform === 'android'
+  );
 }
 
-export function isSubscriptionProductAndroid(
-  product: SubscriptionProduct,
-): product is SubscriptionProductAndroid {
-  return (product as SubscriptionProductAndroid)?.title !== undefined;
+export function isSubscriptionProductAndroid<T extends {platform?: string}>(
+  item: unknown,
+): item is T & {platform: 'android'} {
+  return isProductAndroid(item);
 }
 
 /**

package/src/modules/ios.ts

@@ -1,16 +1,11 @@
 import {Platform} from 'react-native';
 import {emitter, IapEvent} from '..';
-import {Product, PurchaseError, SubscriptionProduct} from '../ExpoIap.types';
-import type {
-  ProductIos,
-  ProductStatusIos,
-  SubscriptionProductIos,
-  TransactionSk2,
-} from '../types/ExpoIapIos.types';
+import {ProductPurchase, PurchaseError} from '../ExpoIap.types';
+import type {ProductStatusIos} from '../types/ExpoIapIos.types';
 import ExpoIapModule from '../ExpoIapModule';
 
 export type TransactionEvent = {
-  transaction?: TransactionSk2;
+  transaction?: ProductPurchase;
   error?: PurchaseError;
 };
 
@@ -25,17 +20,25 @@ export const transactionUpdatedIos = (
   return emitter.addListener(IapEvent.TransactionIapUpdated, listener);
 };
 
-// Functions
-export function isProductIos(product: Product): product is ProductIos {
-  return (product as ProductIos)?.displayName !== undefined;
+// Type guards
+export function isProductIos<T extends {platform?: string}>(
+  item: unknown,
+): item is T & {platform: 'ios'} {
+  return (
+    item != null &&
+    typeof item === 'object' &&
+    'platform' in item &&
+    item.platform === 'ios'
+  );
 }
 
-export function isSubscriptionProductIos(
-  product: SubscriptionProduct,
-): product is SubscriptionProductIos {
-  return (product as SubscriptionProductIos)?.displayName !== undefined;
+export function isSubscriptionProductIos<T extends {platform?: string}>(
+  item: unknown,
+): item is T & {platform: 'ios'} {
+  return isProductIos(item);
 }
 
+// Functions
 /**
  * Sync state with Appstore (iOS only)
  * https://developer.apple.com/documentation/storekit/appstore/3791906-sync
@@ -58,13 +61,13 @@ export const subscriptionStatus = (sku: string): Promise<ProductStatusIos[]> =>
 /**
  *
  */
-export const currentEntitlement = (sku: string): Promise<TransactionSk2> =>
+export const currentEntitlement = (sku: string): Promise<ProductPurchase> =>
   ExpoIapModule.currentEntitlement(sku);
 
 /**
  *
  */
-export const latestTransaction = (sku: string): Promise<TransactionSk2> =>
+export const latestTransaction = (sku: string): Promise<ProductPurchase> =>
   ExpoIapModule.latestTransaction(sku);
 
 /**

package/src/types/ExpoIapAndroid.types.ts

@@ -1,63 +1,48 @@
+import {PurchaseBase, ProductBase} from '../ExpoIap.types';
+
 type OneTimePurchaseOfferDetails = {
   priceCurrencyCode: string;
   formattedPrice: string;
   priceAmountMicros: string;
 };
 
-type SubscriptionOfferDetail = {
-  basePlanId: string;
-  offerId: string;
-  offerToken: string;
-  offerTags: string[];
-  pricingPhases: PricingPhases;
-};
-
-type PricingPhases = {
-  pricingPhaseList: PricingPhase[];
-};
-
-type PricingPhase = {
+type PricingPhaseAndroid = {
   formattedPrice: string;
   priceCurrencyCode: string;
+  // P1W, P1M, P1Y
   billingPeriod: string;
   billingCycleCount: number;
   priceAmountMicros: string;
   recurrenceMode: number;
 };
 
-export type ProductAndroid = {
-  productId: string;
-  title: string;
-  description: string;
-  productType: string;
+type PricingPhasesAndroid = {
+  pricingPhaseList: PricingPhaseAndroid[];
+};
+
+type SubscriptionOfferDetail = {
+  basePlanId: string;
+  offerId: string;
+  offerToken: string;
+  offerTags: string[];
+  pricingPhases: PricingPhasesAndroid;
+};
+
+export type ProductAndroid = ProductBase & {
   name: string;
   oneTimePurchaseOfferDetails?: OneTimePurchaseOfferDetails;
   subscriptionOfferDetails?: SubscriptionOfferDetail[];
 };
 
-type PricingPhaseAndroid = {
-  formattedPrice: string;
-  priceCurrencyCode: string;
-  // P1W, P1M, P1Y
-  billingPeriod: string;
-  billingCycleCount: number;
-  priceAmountMicros: string;
-  recurrenceMode: number;
-};
-
 type SubscriptionOfferAndroid = {
   basePlanId: string;
   offerId: string | null;
   offerToken: string;
-  pricingPhases: {pricingPhaseList: PricingPhaseAndroid[]};
+  pricingPhases: PricingPhasesAndroid;
   offerTags: string[];
 };
 
 export type SubscriptionProductAndroid = ProductAndroid & {
-  name: string;
-  title: string;
-  description: string;
-  productId: string;
   subscriptionOfferDetails: SubscriptionOfferAndroid[];
 };
 
@@ -121,3 +106,22 @@ export enum FeatureTypeAndroid {
   /** Subscriptions update/replace. */
   SUBSCRIPTIONS_UPDATE = 'SUBSCRIPTIONS_UPDATE',
 }
+
+export enum PurchaseStateAndroid {
+  UNSPECIFIED_STATE = 0,
+  PURCHASED = 1,
+  PENDING = 2,
+}
+
+export type ProductPurchaseAndroid = PurchaseBase & {
+  ids?: string[];
+  dataAndroid?: string;
+  signatureAndroid?: string;
+  autoRenewingAndroid?: boolean;
+  purchaseStateAndroid?: PurchaseStateAndroid;
+  isAcknowledgedAndroid?: boolean;
+  packageNameAndroid?: string;
+  developerPayloadAndroid?: string;
+  obfuscatedAccountIdAndroid?: string;
+  obfuscatedProfileIdAndroid?: string;
+};

package/src/types/ExpoIapIos.types.ts

@@ -1,3 +1,5 @@
+import {PurchaseBase, ProductBase} from '../ExpoIap.types';
+
 type SubscriptionIosPeriod = 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | '';
 type PaymentMode = '' | 'FREETRIAL' | 'PAYASYOUGO' | 'PAYUPFRONT';
 
@@ -18,22 +20,18 @@ type SubscriptionInfo = {
   subscriptionPeriod: SubscriptionIosPeriod;
 };
 
-export type ProductIos = {
-  currency: string;
-  description: string;
+export type ProductIos = ProductBase & {
   displayName: string;
   displayPrice: string;
-  id: string;
-  type: 'autoRenewable' | 'consumable' | 'nonConsumable' | 'nonRenewable';
+  type: 'autoRenewable' | 'consumable' | 'nonConsumable' | 'nonRenewable'; // Maps to 'type' in base Product
   isFamilyShareable: boolean;
   jsonRepresentation: string;
-  price: number;
   subscription: SubscriptionInfo;
   introductoryPriceNumberOfPeriodsIOS?: string;
   introductoryPriceSubscriptionPeriodIOS?: SubscriptionIosPeriod;
 };
 
-type Discount = {
+export type Discount = {
   identifier: string;
   type: string;
   numberOfPeriods: string;
@@ -59,22 +57,18 @@ export type PaymentDiscount = {
    * A string used to uniquely identify a discount offer for a product.
    */
   identifier: string;
-
   /**
    * A string that identifies the key used to generate the signature.
    */
   keyIdentifier: string;
-
   /**
    * A universally unique ID (UUID) value that you define.
    */
   nonce: string;
-
   /**
    * A UTF-8 string representing the properties of a specific discount offer, cryptographically signed.
    */
   signature: string;
-
   /**
    * The date and time of the signature's creation in milliseconds, formatted in Unix epoch time.
    */
@@ -83,7 +77,6 @@ export type PaymentDiscount = {
 
 export type RequestPurchaseIosProps = {
   sku: string;
-  andDangerouslyFinishTransactionAutomaticallyIOS?: boolean;
   /**
    * UUID representing user account
    */
@@ -94,34 +87,6 @@ export type RequestPurchaseIosProps = {
 
 export type RequestSubscriptionIosProps = RequestPurchaseIosProps;
 
-export type TransactionSk2 = {
-  appAccountToken: string;
-  appBundleID: string;
-  debugDescription: string;
-  deviceVerification: string;
-  deviceVerificationNonce: string;
-  expirationDate: number;
-  environment?: 'Production' | 'Sandbox' | 'Xcode'; // Could be undefined in some cases on iOS 15, but it's stable since iOS 16
-  id: number;
-  isUpgraded: boolean;
-  jsonRepresentation: string;
-  offerID: string;
-  offerType: string;
-  originalID: string;
-  originalPurchaseDate: number;
-  ownershipType: string;
-  productID: string;
-  productType: string;
-  purchaseDate: number;
-  purchasedQuantity: number;
-  revocationDate: number;
-  revocationReason: string;
-  signedDate: number;
-  subscriptionGroupID: number;
-  webOrderLineItemID: number;
-  verificationResult?: string;
-};
-
 type SubscriptionStatus =
   | 'expired'
   | 'inBillingRetryPeriod'
@@ -139,3 +104,34 @@ export type ProductStatusIos = {
   state: SubscriptionStatus;
   renewalInfo?: RenewalInfo;
 };
+
+export type ProductPurchaseIos = PurchaseBase & {
+  // iOS basic fields
+  quantityIos?: number;
+  originalTransactionDateIos?: number;
+  originalTransactionIdentifierIos?: string;
+  verificationResultIos?: string;
+  appAccountToken?: string;
+  // iOS additional fields from StoreKit 2
+  expirationDateIos?: number;
+  webOrderLineItemIdIos?: number;
+  environmentIos?: string;
+  storefrontCountryCodeIos?: string;
+  appBundleIdIos?: string;
+  productTypeIos?: string;
+  subscriptionGroupIdIos?: string;
+  isUpgradedIos?: boolean;
+  ownershipTypeIos?: string;
+  reasonIos?: string;
+  reasonStringRepresentationIos?: string;
+  transactionReasonIos?: 'PURCHASE' | 'RENEWAL' | string;
+  revocationDateIos?: number;
+  revocationReasonIos?: string;
+  offerIos?: {
+    id: string;
+    type: string;
+    paymentMode: string;
+  };
+  priceIos?: number;
+  currencyIos?: string;
+};

package/src/useIap.ts

@@ -9,7 +9,6 @@ import {
   getPurchaseHistory,
   getSubscriptions,
 } from './';
-
 import {useCallback, useEffect, useState} from 'react';
 import {
   Product,
@@ -21,13 +20,12 @@ import {
   SubscriptionPurchase,
 } from './ExpoIap.types';
 import {TransactionEvent} from './modules/ios';
-import {TransactionSk2} from './types/ExpoIapIos.types';
 import {Subscription} from 'expo-modules-core';
 
 type IAP_STATUS = {
   connected: boolean;
   products: Product[];
-  promotedProductsIOS: TransactionSk2[];
+  promotedProductsIOS: ProductPurchase[];
   subscriptions: SubscriptionProduct[];
   purchaseHistories: ProductPurchase[];
   availablePurchases: ProductPurchase[];
@@ -56,7 +54,7 @@ export function useIAP(): IAP_STATUS {
   const [connected, setConnected] = useState<boolean>(false);
   const [products, setProducts] = useState<Product[]>([]);
   const [promotedProductsIOS, setPromotedProductsIOS] = useState<
-    TransactionSk2[]
+    ProductPurchase[]
   >([]);
   const [subscriptions, setSubscriptions] = useState<SubscriptionProduct[]>([]);
   const [purchaseHistories, setPurchaseHistories] = useState<ProductPurchase[]>(
@@ -66,7 +64,6 @@ export function useIAP(): IAP_STATUS {
     ProductPurchase[]
   >([]);
   const [currentPurchase, setCurrentPurchase] = useState<ProductPurchase>();
-
   const [currentPurchaseError, setCurrentPurchaseError] =
     useState<PurchaseError>();
 
@@ -108,17 +105,17 @@ export function useIAP(): IAP_STATUS {
       } catch (err) {
         throw err;
       } finally {
-        if (purchase.productId === currentPurchase?.productId) {
+        if (purchase.id === currentPurchase?.id) {
           setCurrentPurchase(undefined);
         }
 
-        if (purchase.productId === currentPurchaseError?.productId) {
+        if (purchase.id === currentPurchaseError?.productId) {  // Note that PurchaseError still uses productId
           setCurrentPurchaseError(undefined);
         }
       }
     },
     [
-      currentPurchase?.productId,
+      currentPurchase?.id,
       currentPurchaseError?.productId,
       setCurrentPurchase,
       setCurrentPurchaseError,