expo-iap 2.0.0 → 2.2.0-rc.1

package/iap.md

@@ -0,0 +1,161 @@
+# Expo IAP Documentation
+
+## Installation in Managed Expo Projects
+
+For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If the link shows no documentation, this library isn't yet supported in managed workflows—it's likely awaiting inclusion in a future Expo SDK release.
+
+## Installation in Bare React Native Projects
+
+For bare React Native projects, ensure the [`expo` package is installed and configured](https://docs.expo.dev/bare/installing-expo-modules/) before proceeding.
+
+### Add the Package to Your npm Dependencies
+
+```bash
+npm install expo-iap
+```
+
+### Configure for iOS
+
+Run `npx pod-install` after installing the npm package. Since `expo-iap` uses `StoreKit2`, set the `deploymentTarget` to `15.0` or higher in your project configuration.
+
+```json
+"ios": {
+  "deploymentTarget": "15.0"
+}
+```
+
+### Configure for Android
+
+No additional configuration is required beyond installing the package, as `expo-iap` leverages Google Play Billing internally.
+
+## IAP Types
+
+`expo-iap` supports the following In-App Purchase types, aligned with platform-specific APIs (Google Play Billing for Android, StoreKit2 for iOS).
+
+### Consumable
+
+- **Description**: Items that are used up after purchase and can be bought again (e.g., in-game currency, consumable boosts).
+- **Behavior**: Requires consumption acknowledgment after purchase to allow repurchasing.
+- **Platforms**: Supported on both Android and iOS.
+
+### Non-Consumable
+
+- **Description**: One-time purchases that users own permanently (e.g., ad removal, premium features).
+- **Behavior**: Supports restoration of previous purchases; cannot be repurchased.
+- **Platforms**: Supported on both Android and iOS.
+
+### Subscription
+
+- **Description**: Recurring purchases for ongoing access to content or services (e.g., monthly premium membership).
+- **Behavior**: Includes auto-renewing options and restore functionality.
+- **Platforms**: Supported on both Android and iOS, with platform-specific subscription details.
+
+## Product Type
+
+This section outlines the properties of products supported by `expo-iap`, including common fields shared across platforms and platform-specific extensions.
+
+### Common Product Types
+
+These properties are shared between Android and iOS, defined in `BaseProduct`.
+
+| Property       | Type          | Description                       |
+| -------------- | ------------- | --------------------------------- |
+| `id`           | `string`      | Unique identifier for the product |
+| `title`        | `string`      | Title of the product              |
+| `description`  | `string`      | Description of the product        |
+| `type`         | `ProductType` | Product type (inapp or subs)      |
+| `displayName`  | `string?`     | Name for UI display (optional)    |
+| `displayPrice` | `string?`     | Display price (optional)          |
+| `price`        | `number?`     | Actual price (optional)           |
+| `currency`     | `string?`     | Currency code (optional)          |
+
+### Android-Only Product Types
+
+- **`ProductAndroid`**
+
+  - `name: string`: Product name (used instead of `displayName` on Android).
+  - `oneTimePurchaseOfferDetails?: OneTimePurchaseOfferDetails`: Details for one-time purchases (e.g., price, currency).
+  - `subscriptionOfferDetails?: SubscriptionOfferDetail[]`: Subscription offer details.
+
+- **`SubscriptionProductAndroid`**
+  - `subscriptionOfferDetails: SubscriptionOfferAndroid[]`: Subscription-specific offers, including base plan ID, offer token, and pricing phases.
+
+### iOS-Only Product Types
+
+- **`ProductIos`**
+
+  - `displayPrice: string`: Price formatted for display.
+  - `isFamilyShareable: boolean`: Indicates if the product supports family sharing.
+  - `jsonRepresentation: string`: JSON representation from StoreKit2.
+  - `subscription: SubscriptionInfo`: Subscription details (e.g., introductory offers, group ID).
+
+- **`SubscriptionProductIos`**
+  - `discounts?: Discount[]`: Discount details (e.g., identifier, price).
+  - `introductoryPrice?: string`: Introductory pricing details (with additional iOS-specific fields like `introductoryPricePaymentModeIos`).
+
+## Purchase Type
+
+This section describes the properties of purchases supported by `expo-iap`, covering common fields and platform-specific extensions.
+
+### Common Purchase Types
+
+These properties are shared between Android and iOS, defined in `ProductPurchase`.
+
+| Property             | Type      | Description                              |
+| -------------------- | --------- | ---------------------------------------- |
+| `id`                 | `string`  | ID of the purchased product              |
+| `transactionId`      | `string?` | Unique transaction identifier (optional) |
+| `transactionDate`    | `number`  | Purchase timestamp (Unix)                |
+| `transactionReceipt` | `string`  | Transaction receipt data                 |
+| `purchaseToken`      | `string?` | Purchase token (optional)                |
+
+### Android-Only Purchase Types
+
+- **`ProductPurchase` (Android Extensions)**
+
+  - `ids?: string[]`: List of purchased product IDs.
+  - `dataAndroid?: string`: Payment data.
+  - `signatureAndroid?: string`: Signature data.
+  - `autoRenewingAndroid?: boolean`: Auto-renewal status.
+  - `purchaseStateAndroid?: PurchaseStateAndroid`: Purchase state (e.g., PURCHASED, PENDING).
+
+- **`SubscriptionPurchase` (Android Extensions)**
+  - `autoRenewingAndroid?: boolean`: Subscription auto-renewal status.
+
+### iOS-Only Purchase Types
+
+- **`ProductPurchase` (iOS Extensions)**
+
+  - `quantityIos?: number`: Purchase quantity.
+  - `originalTransactionDateIos?: number`: Original transaction date.
+  - `originalTransactionIdentifierIos?: string`: Original transaction ID.
+  - `verificationResultIos?: string`: Verification result.
+  - `appAccountToken?: string`: App account token.
+  - `expirationDateIos?: number`: Expiration date for subscriptions.
+  - `webOrderLineItemIdIos?: number`: Web order line item ID.
+  - `environmentIos?: string`: App Store environment.
+  - `storefrontCountryCodeIos?: string`: App Store storefront country code.
+  - `appBundleIdIos?: string`: App bundle ID.
+  - `productTypeIos?: string`: Product type (e.g., "autoRenewable").
+  - `subscriptionGroupIdIos?: string`: Subscription group ID.
+  - `isUpgradedIos?: boolean`: Whether the subscription was upgraded.
+  - `ownershipTypeIos?: string`: Ownership type (e.g., individual, family sharing).
+  - `reasonIos?: string`: Transaction reason.
+  - `transactionReasonIos?: string`: Detailed transaction reason.
+  - `revocationDateIos?: number`: Date of revocation if refunded.
+  - `revocationReasonIos?: string`: Reason for revocation.
+
+- **`SubscriptionPurchase` (iOS Extensions)**
+  - All the iOS-specific fields from `ProductPurchase`
+  - Automatic subscription-specific handling based on product type
+
+## Implementation Notes
+
+### Platform-Uniform Purchase Handling
+
+`expo-iap` now processes transactions directly to `Purchase` or `SubscriptionPurchase` types on both platforms:
+
+- **iOS**: StoreKit 2 transactions are directly mapped to `Purchase`/`SubscriptionPurchase` objects with iOS-specific fields using camelCase naming convention (e.g., `expirationDateIos`).
+- **Android**: Google Play Billing purchases are similarly mapped to the same types with Android-specific fields.
+
+This approach eliminates intermediate conversion layers, making the code more maintainable while still providing access to platform-specific details when needed.

package/ios/ExpoIapModule.swift

@@ -15,6 +15,109 @@ struct IapEvent {
     static let TransactionIapUpdated = "iap-transaction-updated"
 }
 
+@available(iOS 15.0, *)
+func serializeTransaction(_ transaction: Transaction) -> [String: Any?] {
+    // Determine if this is a subscription by productType or expirationDate
+    let isSubscription = transaction.productType.rawValue.lowercased().contains("renewable") || transaction.expirationDate != nil
+    
+    // Parse transaction reason from jsonRepresentation if available
+    var transactionReasonIos: String? = nil
+    var webOrderLineItemId: Int? = nil
+    var jsonData: [String: Any]? = nil
+    
+    // JSON representation handling
+    do {
+        let jsonRep = transaction.jsonRepresentation
+        let jsonObj = try JSONSerialization.jsonObject(with: jsonRep) as! [String: Any]
+        jsonData = jsonObj
+        if let reason = jsonObj["transactionReason"] as? String {
+            transactionReasonIos = reason
+        }
+        if let webOrderId = jsonObj["webOrderLineItemID"] as? NSNumber {
+            webOrderLineItemId = webOrderId.intValue
+        }
+    } catch {
+        print("Error parsing JSON representation: \(error)")
+    }
+
+    // Create base purchase object that matches Purchase type in TypeScript
+    var purchaseMap: [String: Any?] = [
+        // Core purchase fields
+        "id": transaction.productID,
+        "ids": [transaction.productID],
+        "transactionId": String(transaction.id),
+        "transactionDate": transaction.purchaseDate.timeIntervalSince1970 * 1000,
+        "transactionReceipt": "", // Not available in StoreKit 2
+        "purchaseToken": "", // Not applicable on iOS
+        
+        // iOS specific fields - basic info
+        "quantityIos": transaction.purchasedQuantity,
+        "originalTransactionDateIos": transaction.originalPurchaseDate.timeIntervalSince1970 * 1000,
+        "originalTransactionIdentifierIos": transaction.originalID,
+        "appAccountToken": transaction.appAccountToken?.uuidString,
+        
+        // App and Product Identifiers
+        "appBundleIdIos": transaction.appBundleID,
+        "productTypeIos": transaction.productType.rawValue,
+        "subscriptionGroupIdIos": transaction.subscriptionGroupID,
+        
+        // Transaction Identifiers
+        "webOrderLineItemIdIos": webOrderLineItemId,
+        
+        // Purchase and Expiration Dates
+        "expirationDateIos": transaction.expirationDate.map { $0.timeIntervalSince1970 * 1000 },
+        
+        // Purchase Details
+        "isUpgradedIos": transaction.isUpgraded,
+        "ownershipTypeIos": transaction.ownershipType.rawValue,
+        
+        // Revocation Status
+        "revocationDateIos": transaction.revocationDate.map { $0.timeIntervalSince1970 * 1000 },
+        "revocationReasonIos": transaction.revocationReason?.rawValue
+    ]
+    
+    // Environment (iOS 16.0+)
+    if #available(iOS 16.0, *) {
+        purchaseMap["environmentIos"] = transaction.environment.rawValue
+    }
+    
+    // Storefront (iOS 17.0+)
+    if #available(iOS 17.0, *) {
+        purchaseMap["storefrontCountryCodeIos"] = transaction.storefront.countryCode
+    }
+    
+    // Transaction Reason (iOS 17.0+)
+    if #available(iOS 17.0, *) {
+        purchaseMap["reasonIos"] = transaction.reason.rawValue
+    }
+    
+    // reasonStringRepresentation과 transactionReasonIos는 명시적 타입 처리
+    purchaseMap["reasonStringRepresentationIos"] = transaction.reasonStringRepresentation
+    purchaseMap["transactionReasonIos"] = transactionReasonIos
+    
+    // Add offer information if available with proper availability check
+    if #available(iOS 17.2, *) {
+        if let offer = transaction.offer {
+            purchaseMap["offerIos"] = [
+                "id": offer.id as Any,
+                "type": offer.type.rawValue,
+                "paymentMode": offer.paymentMode?.rawValue ?? ""
+            ]
+        }
+    }
+    
+    // Add additional pricing info if available
+    if #available(iOS 15.4, *), let priceInfo = jsonData?["price"] as? NSNumber {
+        purchaseMap["priceIos"] = priceInfo.doubleValue
+    }
+    
+    if #available(iOS 15.4, *), let currencyInfo = jsonData?["currency"] as? String {
+        purchaseMap["currencyIos"] = currencyInfo
+    }
+    
+    return purchaseMap
+}
+
 @available(iOS 15.0, *)
 func serializeProduct(_ p: Product) -> [String: Any?] {
     return [
@@ -23,24 +126,26 @@ func serializeProduct(_ p: Product) -> [String: Any?] {
         "displayName": p.displayName,
         "displayPrice": p.displayPrice,
         "id": p.id,
+        "title": p.displayName,
         "isFamilyShareable": p.isFamilyShareable,
         "jsonRepresentation": serializeDebug(String(data: p.jsonRepresentation, encoding: .utf8) ?? ""),
         "price": p.price,
         "subscription": p.subscription,
         "type": p.type,
-        "currency": p.priceFormatStyle.currencyCode
+        "currency": p.priceFormatStyle.currencyCode,
+        "platform": "ios"  // Add platform identifier
     ]
 }
 
 @available(iOS 15.0, *)
-func serializeTransaction(_ transaction: Transaction) -> [String: Any?] {
-    return [
-        "id": transaction.id,
-        "productID": transaction.productID,
-        "purchaseDate": transaction.purchaseDate,
-        "expirationDate": transaction.expirationDate,
-        "originalID": transaction.originalID
-    ]
+@Sendable func serialize(_ rs: Transaction.RefundRequestStatus?) -> String? {
+    guard let rs = rs else { return nil }
+    switch rs {
+    case .success: return "success"
+    case .userCancelled: return "userCancelled"
+    default:
+        return nil
+    }
 }
 
 @available(iOS 15.0, *)
@@ -70,22 +175,6 @@ func serializeRenewalInfo(_ renewalInfo: VerificationResult<Product.Subscription
     }
 }
 
-@available(iOS 15.0, *)
-func serialize(_ transaction: Transaction, _ result: VerificationResult<Transaction>) -> [String: Any?] {
-    return serializeTransaction(transaction)
-}
-
-@available(iOS 15.0, *)
-@Sendable func serialize(_ rs: Transaction.RefundRequestStatus?) -> String? {
-    guard let rs = rs else { return nil }
-    switch rs {
-    case .success: return "success"
-    case .userCancelled: return "userCancelled"
-    default:
-        return nil
-    }
-}
-
 @available(iOS 15.0, *)
 public class ExpoIapModule: Module {
     private var transactions: [String: Transaction] = [:]
@@ -103,12 +192,12 @@ public class ExpoIapModule: Module {
         Events(IapEvent.PurchaseUpdated, IapEvent.PurchaseError, IapEvent.TransactionIapUpdated)
 
         OnStartObserving {
-            hasListeners = true
+            self.hasListeners = true
             self.addTransactionObserver()
         }
 
         OnStopObserving {
-            hasListeners = false
+            self.hasListeners = false
             self.removeTransactionObserver()
         }
 
@@ -241,11 +330,18 @@ public class ExpoIapModule: Module {
                         throw NSError(domain: "ExpoIapModule", code: 2, userInfo: [NSLocalizedDescriptionKey: "Could not find window scene"])
                     }
                     let result: Product.PurchaseResult
-                    if #available(iOS 17.0, *) {
+                    #if swift(>=5.9)
+                    if #available(iOS 17.0, tvOS 17.0, *) {
                         result = try await product.purchase(confirmIn: windowScene, options: options)
                     } else {
+                        #if !os(visionOS)
                         result = try await product.purchase(options: options)
+                        #endif
                     }
+                    #elseif !os(visionOS)
+                    result = try await product.purchase(options: options)
+                    #endif
+
                     switch result {
                     case .success(let verification):
                         let transaction = try self.checkVerified(verification)
@@ -303,7 +399,6 @@ public class ExpoIapModule: Module {
             if let product = await productStore.getProduct(productID: sku) {
                 if let result = await product.currentEntitlement {
                     do {
-                        // Check whether the transaction is verified. If it isn’t, catch `failedVerification` error.
                         let transaction = try self.checkVerified(result)
                         return serializeTransaction(transaction)
                     } catch StoreError.failedVerification {
@@ -327,7 +422,6 @@ public class ExpoIapModule: Module {
             if let product = await productStore.getProduct(productID: sku) {
                 if let result = await product.latestTransaction {
                     do {
-                        // Check whether the transaction is verified. If it isn’t, catch `failedVerification` error.
                         let transaction = try self.checkVerified(result)
                         return serializeTransaction(transaction)
                     } catch StoreError.failedVerification {
@@ -391,7 +485,6 @@ public class ExpoIapModule: Module {
             Task {
                 for await result in Transaction.unfinished {
                     do {
-                        // Check whether the transaction is verified. If it isn’t, catch `failedVerification` error.
                         let transaction = try self.checkVerified(result)
                         await transaction.finish()
                         self.transactions.removeValue(forKey: String(transaction.id))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-iap",
-  "version": "2.0.0",
+  "version": "2.2.0-rc.1",
   "description": "In App Purchase module in Expo",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -38,13 +38,13 @@
   "homepage": "https://github.com/hyochan#readme",
   "dependencies": {},
   "devDependencies": {
-    "@types/react": "^18.0.25",
-    "expo-module-scripts": "^3.5.2",
-    "expo-modules-core": "^1.12.19",
+    "@types/react": "~18.2.79",
     "eslint": "8.57.0",
     "eslint-config-expo": "^7.1.2",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3"
+    "eslint-plugin-prettier": "^5.1.3",
+    "expo-module-scripts": "^3.5.2",
+    "expo-modules-core": "~1.12.26"
   },
   "peerDependencies": {
     "expo": "*",

package/plugin/build/withIAP.d.ts

@@ -1,9 +1,6 @@
 import { ConfigPlugin } from 'expo/config-plugins';
-type PaymentProvider = 'Amazon AppStore' | 'both' | 'Play Store';
-export declare const modifyAppBuildGradle: (buildGradle: string, paymentProvider: PaymentProvider) => string;
 export declare const modifyProjectBuildGradle: (buildGradle: string) => string;
 interface Props {
-    paymentProvider?: PaymentProvider;
 }
 declare const _default: ConfigPlugin<Props | undefined>;
 export default _default;

package/plugin/build/withIAP.js

@@ -1,50 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.modifyProjectBuildGradle = exports.modifyAppBuildGradle = void 0;
+exports.modifyProjectBuildGradle = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const config_plugins_2 = require("expo/config-plugins");
 const pkg = require('../../package.json');
-const hasPaymentProviderProperValue = (paymentProvider) => {
-    return ['Amazon AppStore', 'Play Store', 'both'].includes(paymentProvider);
-};
-const linesToAdd = {
-    ['Amazon AppStore']: `missingDimensionStrategy "store", "amazon"`,
-    ['Play Store']: `missingDimensionStrategy "store", "play"`,
-    ['both']: `flavorDimensions "appstore"
-
-productFlavors {
-  googlePlay {
-    dimension "appstore"
-    missingDimensionStrategy "store", "play"
-  }
-
-  amazon {
-    dimension "appstore"
-    missingDimensionStrategy "store", "amazon"
-  }
-}`,
-};
 const addToBuildGradle = (newLine, anchor, offset, buildGradle) => {
     const lines = buildGradle.split('\n');
     const lineIndex = lines.findIndex((line) => line.match(anchor));
-    // add after given line
-    lines.splice(lineIndex + offset, 0, newLine);
-    return lines.join('\n');
-};
-const modifyAppBuildGradle = (buildGradle, paymentProvider) => {
-    if (paymentProvider === 'both') {
-        if (buildGradle.includes(`flavorDimensions "appstore"`)) {
-            return buildGradle;
-        }
-        return addToBuildGradle(linesToAdd[paymentProvider], 'defaultConfig', -1, buildGradle);
+    if (lineIndex === -1) {
+        console.warn('Anchor "ext" not found in build.gradle, appending to end');
+        lines.push(newLine);
     }
-    const missingDimensionStrategy = linesToAdd[paymentProvider];
-    if (buildGradle.includes(missingDimensionStrategy)) {
-        return buildGradle;
+    else {
+        lines.splice(lineIndex + offset, 0, newLine);
     }
-    return addToBuildGradle(missingDimensionStrategy, 'defaultConfig', 1, buildGradle);
+    return lines.join('\n');
 };
-exports.modifyAppBuildGradle = modifyAppBuildGradle;
 const modifyProjectBuildGradle = (buildGradle) => {
     const supportLibVersion = `supportLibVersion = "28.0.0"`;
     if (buildGradle.includes(supportLibVersion)) {
@@ -53,30 +24,41 @@ const modifyProjectBuildGradle = (buildGradle) => {
     return addToBuildGradle(supportLibVersion, 'ext', 1, buildGradle);
 };
 exports.modifyProjectBuildGradle = modifyProjectBuildGradle;
-const withIAPAndroid = (config, { paymentProvider }) => {
-    // eslint-disable-next-line @typescript-eslint/no-shadow
-    config = (0, config_plugins_1.withAppBuildGradle)(config, (config) => {
-        config.modResults.contents = (0, exports.modifyAppBuildGradle)(config.modResults.contents, paymentProvider);
-        return config;
-    });
-    // eslint-disable-next-line @typescript-eslint/no-shadow
+const withIAPAndroid = (config) => {
     config = (0, config_plugins_1.withProjectBuildGradle)(config, (config) => {
         config.modResults.contents = (0, exports.modifyProjectBuildGradle)(config.modResults.contents);
         return config;
     });
+    // Adding BILLING permission to AndroidManifest.xml
+    config = (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        console.log('Modifying AndroidManifest.xml...');
+        const manifest = config.modResults;
+        if (!manifest.manifest['uses-permission']) {
+            manifest.manifest['uses-permission'] = [];
+        }
+        const permissions = manifest.manifest['uses-permission'];
+        const billingPermission = {
+            $: { 'android:name': 'com.android.vending.BILLING' },
+        };
+        if (!permissions.some((perm) => perm.$['android:name'] === 'com.android.vending.BILLING')) {
+            permissions.push(billingPermission);
+            console.log('Added com.android.vending.BILLING to permissions');
+        }
+        else {
+            console.log('com.android.vending.BILLING already exists in manifest');
+        }
+        return config;
+    });
     return config;
 };
 const withIAP = (config, props) => {
-    const paymentProvider = props?.paymentProvider ?? 'Play Store';
-    if (!hasPaymentProviderProperValue(paymentProvider)) {
-        config_plugins_1.WarningAggregator.addWarningAndroid('expo-iap', `The payment provider '${paymentProvider}' is not supported. Please update your app.json file with one of the following supported values: 'Play Store', 'Amazon AppStore', or 'both'.`);
-        return config;
-    }
     try {
-        config = withIAPAndroid(config, { paymentProvider });
+        console.log('Applying expo-iap plugin...');
+        config = withIAPAndroid(config);
     }
     catch (error) {
         config_plugins_1.WarningAggregator.addWarningAndroid('expo-iap', `There was a problem configuring expo-iap in your native Android project: ${error}`);
+        console.error('Error in expo-iap plugin:', error);
     }
     return config;
 };