@revenuecat/purchases-capacitor 13.0.0 → 13.1.0

package/Package.swift

@@ -11,7 +11,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/RevenueCat/purchases-hybrid-common.git", exact: "18.0.0")
+        .package(url: "https://github.com/RevenueCat/purchases-hybrid-common.git", exact: "18.4.0")
     ],
     targets: [
         .target(

package/README.md

@@ -1663,7 +1663,8 @@ Type containing information of installment subscriptions. Currently only support
 | Prop                            | Type                                                                                | Description                                                                                                                                                                                                                                                                                                                                           |
 | ------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`product`**                   | <code><a href="#purchasesstoreproduct">PurchasesStoreProduct</a></code>             | The product you want to purchase                                                                                                                                                                                                                                                                                                                      |
-| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.                                                                                                                                                                    |
+| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode. If both googleProductChangeInfo and storeProductChangeInfo are provided, storeProductChangeInfo is used and googleProductChangeInfo is ignored.                    |
+| **`storeProductChangeInfo`**    | <code><a href="#storeproductchangeinfo">StoreProductChangeInfo</a> \| null</code>   | Android only. Optional <a href="#storeproductchangeinfo">StoreProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.                                                                                                                                                                    |
 | **`googleIsPersonalizedPrice`** | <code>boolean \| null</code>                                                        | Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true. See https://developer.android.com/google/play/billing/integrate#personalized-price for more info. |
 
 
@@ -1677,6 +1678,16 @@ Holds the information used when upgrading from another sku. For Android use only
 | **`prorationMode`**        | <code><a href="#proration_mode">PRORATION_MODE</a></code> | The [PRORATION_MODE] to use when upgrading the given oldSKU. |
 
 
+#### StoreProductChangeInfo
+
+Holds the information used when upgrading from another sku. For use on the Play <a href="#store">Store</a> and Galaxy <a href="#store">Store</a> on Android only.
+
+| Prop                       | Type                                                                      | Description                                                          |
+| -------------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| **`oldProductIdentifier`** | <code>string</code>                                                       | The old product identifier to upgrade from.                          |
+| **`replacementMode`**      | <code><a href="#store_replacement_mode">STORE_REPLACEMENT_MODE</a></code> | The [STORE_REPLACEMENT_MODE] to use when upgrading the given oldSKU. |
+
+
 #### PurchaseDiscountedProductOptions
 
 | Prop           | Type                                                                            | Description                                                                          |
@@ -1703,7 +1714,8 @@ Holds the information about a PromotionalOffer in Apple's App <a href="#store">S
 | Prop                            | Type                                                                                | Description                                                                                                                                                                                                                                                                                                                                           |
 | ------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`aPackage`**                  | <code><a href="#purchasespackage">PurchasesPackage</a></code>                       | The Package you wish to purchase. You can get the Packages by calling getOfferings                                                                                                                                                                                                                                                                    |
-| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.                                                                                                                                                                    |
+| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode. If both googleProductChangeInfo and storeProductChangeInfo are provided, storeProductChangeInfo is used and googleProductChangeInfo is ignored.                    |
+| **`storeProductChangeInfo`**    | <code><a href="#storeproductchangeinfo">StoreProductChangeInfo</a> \| null</code>   | Android only. Optional <a href="#storeproductchangeinfo">StoreProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.                                                                                                                                                                    |
 | **`googleIsPersonalizedPrice`** | <code>boolean \| null</code>                                                        | Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true. See https://developer.android.com/google/play/billing/integrate#personalized-price for more info. |
 
 
@@ -1712,7 +1724,8 @@ Holds the information about a PromotionalOffer in Apple's App <a href="#store">S
 | Prop                            | Type                                                                                | Description                                                                                                                                                                                                                                                                                                                                           |
 | ------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`subscriptionOption`**        | <code><a href="#subscriptionoption">SubscriptionOption</a></code>                   | The <a href="#subscriptionoption">SubscriptionOption</a> you wish to purchase. You can get the <a href="#subscriptionoption">SubscriptionOption</a> from StoreProducts by calling getOfferings                                                                                                                                                        |
-| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.                                                                                                                                                                    |
+| **`googleProductChangeInfo`**   | <code><a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> \| null</code> | Android only. Optional <a href="#googleproductchangeinfo">GoogleProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional prorationMode. If both googleProductChangeInfo and storeProductChangeInfo are provided, storeProductChangeInfo is used and googleProductChangeInfo is ignored.                    |
+| **`storeProductChangeInfo`**    | <code><a href="#storeproductchangeinfo">StoreProductChangeInfo</a> \| null</code>   | Android only. Optional <a href="#storeproductchangeinfo">StoreProductChangeInfo</a> you wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.                                                                                                                                                                    |
 | **`googleIsPersonalizedPrice`** | <code>boolean \| null</code>                                                        | Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true. See https://developer.android.com/google/play/billing/integrate#personalized-price for more info. |
 
 
@@ -2081,13 +2094,24 @@ Listener used to receive log messages from the SDK.
 | Members                                             | Value          | Description                                                                                                                                                                               |
 | --------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY`** | <code>0</code> |                                                                                                                                                                                           |
-| **`IMMEDIATE_WITH_TIME_PRORATION`**                 | <code>1</code> | Replacement takes effect immediately, and the remaining time will be prorated and credited to the user. This is the current default behavior.                                             |
+| **`IMMEDIATE_WITH_TIME_PRORATION`**                 | <code>1</code> | Replacement takes effect immediately, and the remaining time will be prorated and credited to the user.                                                                                   |
 | **`IMMEDIATE_AND_CHARGE_PRORATED_PRICE`**           | <code>2</code> | Replacement takes effect immediately, and the billing cycle remains the same. The price for the remaining period will be charged. This option is only available for subscription upgrade. |
-| **`IMMEDIATE_WITHOUT_PRORATION`**                   | <code>3</code> | Replacement takes effect immediately, and the new price will be charged on next recurrence time. The billing cycle stays the same.                                                        |
+| **`IMMEDIATE_WITHOUT_PRORATION`**                   | <code>3</code> | Replacement takes effect immediately, and the new price will be charged on next recurrence time. The billing cycle stays the same. This is the current default behavior.                  |
 | **`DEFERRED`**                                      | <code>6</code> | Replacement takes effect when the old plan expires, and the new price will be charged at the same time.                                                                                   |
 | **`IMMEDIATE_AND_CHARGE_FULL_PRICE`**               | <code>5</code> | Replacement takes effect immediately, and the user is charged full price of new plan and is given a full billing cycle of subscription, plus remaining prorated time from the old plan.   |
 
 
+#### STORE_REPLACEMENT_MODE
+
+| Members                     | Value                                | Description                                                                                                                                                                                                                                                                                                                                     |
+| --------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`WITHOUT_PRORATION`**     | <code>"WITHOUT_PRORATION"</code>     | Old subscription is cancelled, and new subscription takes effect immediately. User is charged for the full price of the new subscription on the old subscription's expiration date. This is the default behavior for the Galaxy and Play stores.                                                                                                |
+| **`WITH_TIME_PRORATION`**   | <code>"WITH_TIME_PRORATION"</code>   | Replacement takes effect immediately, and the remaining time will be prorated and credited to the user. This is the current default behavior.                                                                                                                                                                                                   |
+| **`CHARGE_FULL_PRICE`**     | <code>"CHARGE_FULL_PRICE"</code>     | Replacement takes effect immediately, and the user is charged full price of new plan and is given a full billing cycle of subscription, plus remaining prorated time from the old plan. This mode is not supported by the Galaxy <a href="#store">Store</a>. If it is passed to the Galaxy <a href="#store">Store</a>, an error will be thrown. |
+| **`CHARGE_PRORATED_PRICE`** | <code>"CHARGE_PRORATED_PRICE"</code> | Replacement takes effect immediately, and the billing cycle remains the same. The price for the remaining period will be charged. This option is only available for subscription upgrade.                                                                                                                                                       |
+| **`DEFERRED`**              | <code>"DEFERRED"</code>              | Replacement takes effect when the old plan expires, and the new price will be charged at the same time.                                                                                                                                                                                                                                         |
+
+
 #### LOG_LEVEL
 
 | Members       | Value                  |

package/RevenuecatPurchasesCapacitor.podspec

@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
-  s.dependency 'PurchasesHybridCommon', '18.0.0'
+  s.dependency 'PurchasesHybridCommon', '18.4.0'
   s.swift_version = '5.1'
 end

package/android/build.gradle

@@ -61,7 +61,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
-    implementation 'com.revenuecat.purchases:purchases-hybrid-common:18.0.0'
+    implementation 'com.revenuecat.purchases:purchases-hybrid-common:18.4.0'
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

package/android/src/main/java/com/revenuecat/purchases/capacitor/PurchasesPlugin.kt

@@ -85,7 +85,7 @@ class PurchasesPlugin : Plugin() {
 
     companion object {
         private const val PLATFORM_NAME = "capacitor"
-        private const val PLUGIN_VERSION = "13.0.0"
+        private const val PLUGIN_VERSION = "13.1.0"
 
         private const val CUSTOMER_INFO_KEY = "customerInfo"
     }
@@ -254,10 +254,11 @@ class PurchasesPlugin : Plugin() {
             type,
             googleBasePlanId = null,
             optionalPurchaseParams.oldProductIdentifier,
-            optionalPurchaseParams.prorationMode,
+            googleReplacementModeInt = null,
             optionalPurchaseParams.isPersonalizedPrice,
             presentedOfferingContext?.convertToAnyMap(),
             getOnResult(call),
+            storeReplacementModeString = optionalPurchaseParams.replacementMode,
         )
     }
 
@@ -284,9 +285,10 @@ class PurchasesPlugin : Plugin() {
             packageIdentifier,
             presentedOfferingContext.convertToAnyMap(),
             optionalPurchaseParams.oldProductIdentifier,
-            optionalPurchaseParams.prorationMode,
+            googleReplacementModeInt = null,
             optionalPurchaseParams.isPersonalizedPrice,
             getOnResult(call),
+            storeReplacementModeString = optionalPurchaseParams.replacementMode,
         )
     }
 
@@ -304,10 +306,11 @@ class PurchasesPlugin : Plugin() {
             productId,
             subscriptionOptionId,
             optionalPurchaseParams.oldProductIdentifier,
-            optionalPurchaseParams.prorationMode,
+            googleReplacementModeInt = null,
             optionalPurchaseParams.isPersonalizedPrice,
             presentedOfferingContext?.convertToAnyMap(),
             getOnResult(call),
+            storeReplacementModeString = optionalPurchaseParams.replacementMode,
         )
     }
 
@@ -870,16 +873,22 @@ class PurchasesPlugin : Plugin() {
 
     private data class PurchaseOptionalInfoParams(
         val oldProductIdentifier: String?,
-        val prorationMode: Int?,
+        val replacementMode: String?,
         val isPersonalizedPrice: Boolean?,
     ) {
         companion object {
             fun fromCall(call: PluginCall): PurchaseOptionalInfoParams {
                 val googleProductChangeInfo = call.getObject("googleProductChangeInfo")
+                val storeProductChangeInfo = call.getObject("storeProductChangeInfo")
+                val productChangeInfo = storeProductChangeInfo ?: googleProductChangeInfo
                 val googleIsPersonalizedPrice = call.getBoolean("googleIsPersonalizedPrice")
                 return PurchaseOptionalInfoParams(
-                    oldProductIdentifier = googleProductChangeInfo?.getString("oldProductIdentifier"),
-                    prorationMode = googleProductChangeInfo?.getInteger("prorationMode"),
+                    oldProductIdentifier = productChangeInfo?.getString("oldProductIdentifier"),
+                    replacementMode = if (storeProductChangeInfo != null) {
+                        storeProductChangeInfo.getString("replacementMode")
+                    } else {
+                        googleProductChangeInfo?.getInteger("prorationMode")?.toStoreReplacementMode()
+                    },
                     isPersonalizedPrice = googleIsPersonalizedPrice,
                 )
             }
@@ -887,6 +896,16 @@ class PurchasesPlugin : Plugin() {
     }
 }
 
+private fun Int.toStoreReplacementMode(): String? =
+    when (this) {
+        1 -> "WITH_TIME_PRORATION"
+        2 -> "CHARGE_PRORATED_PRICE"
+        3 -> "WITHOUT_PRORATION"
+        5 -> "CHARGE_FULL_PRICE"
+        6 -> "DEFERRED"
+        else -> null
+    }
+
 private fun JSONObject.convertToAnyMap(): Map<String, Any?> =
     this.keys().asSequence<String>().associate { key ->
         when (val value = this[key]) {

package/dist/docs.json

@@ -3279,13 +3279,27 @@
         },
         {
           "name": "googleProductChangeInfo",
-          "tags": [],
-          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
+          "tags": [
+            {
+              "text": "Use storeProductChangeInfo instead.",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\nIf both googleProductChangeInfo and storeProductChangeInfo are provided,\nstoreProductChangeInfo is used and googleProductChangeInfo is ignored.",
           "complexTypes": [
             "GoogleProductChangeInfo"
           ],
           "type": "GoogleProductChangeInfo | null | undefined"
         },
+        {
+          "name": "storeProductChangeInfo",
+          "tags": [],
+          "docs": "Android only. Optional StoreProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional replacementMode.",
+          "complexTypes": [
+            "StoreProductChangeInfo"
+          ],
+          "type": "StoreProductChangeInfo | null | undefined"
+        },
         {
           "name": "googleIsPersonalizedPrice",
           "tags": [],
@@ -3300,6 +3314,10 @@
       "slug": "googleproductchangeinfo",
       "docs": "Holds the information used when upgrading from another sku. For Android use only.",
       "tags": [
+        {
+          "text": "Use StoreProductChangeInfo",
+          "name": "deprecated"
+        },
         {
           "name": "public"
         }
@@ -3324,6 +3342,35 @@
         }
       ]
     },
+    {
+      "name": "StoreProductChangeInfo",
+      "slug": "storeproductchangeinfo",
+      "docs": "Holds the information used when upgrading from another sku. For use on the Play Store and Galaxy Store on Android only.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "oldProductIdentifier",
+          "tags": [],
+          "docs": "The old product identifier to upgrade from.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "replacementMode",
+          "tags": [],
+          "docs": "The [STORE_REPLACEMENT_MODE] to use when upgrading the given oldSKU.",
+          "complexTypes": [
+            "STORE_REPLACEMENT_MODE"
+          ],
+          "type": "STORE_REPLACEMENT_MODE"
+        }
+      ]
+    },
     {
       "name": "PurchaseDiscountedProductOptions",
       "slug": "purchasediscountedproductoptions",
@@ -3417,13 +3464,27 @@
         },
         {
           "name": "googleProductChangeInfo",
-          "tags": [],
-          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
+          "tags": [
+            {
+              "text": "Use storeProductChangeInfo instead.",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\nIf both googleProductChangeInfo and storeProductChangeInfo are provided,\nstoreProductChangeInfo is used and googleProductChangeInfo is ignored.",
           "complexTypes": [
             "GoogleProductChangeInfo"
           ],
           "type": "GoogleProductChangeInfo | null | undefined"
         },
+        {
+          "name": "storeProductChangeInfo",
+          "tags": [],
+          "docs": "Android only. Optional StoreProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional replacementMode.",
+          "complexTypes": [
+            "StoreProductChangeInfo"
+          ],
+          "type": "StoreProductChangeInfo | null | undefined"
+        },
         {
           "name": "googleIsPersonalizedPrice",
           "tags": [],
@@ -3451,13 +3512,27 @@
         },
         {
           "name": "googleProductChangeInfo",
-          "tags": [],
-          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
+          "tags": [
+            {
+              "text": "Use storeProductChangeInfo instead.",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\nIf both googleProductChangeInfo and storeProductChangeInfo are provided,\nstoreProductChangeInfo is used and googleProductChangeInfo is ignored.",
           "complexTypes": [
             "GoogleProductChangeInfo"
           ],
           "type": "GoogleProductChangeInfo | null | undefined"
         },
+        {
+          "name": "storeProductChangeInfo",
+          "tags": [],
+          "docs": "Android only. Optional StoreProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional replacementMode.",
+          "complexTypes": [
+            "StoreProductChangeInfo"
+          ],
+          "type": "StoreProductChangeInfo | null | undefined"
+        },
         {
           "name": "googleIsPersonalizedPrice",
           "tags": [],
@@ -4342,7 +4417,7 @@
           "name": "IMMEDIATE_WITH_TIME_PRORATION",
           "value": "1",
           "tags": [],
-          "docs": "Replacement takes effect immediately, and the remaining time will be\nprorated and credited to the user. This is the current default behavior."
+          "docs": "Replacement takes effect immediately, and the remaining time will be\nprorated and credited to the user."
         },
         {
           "name": "IMMEDIATE_AND_CHARGE_PRORATED_PRICE",
@@ -4354,7 +4429,7 @@
           "name": "IMMEDIATE_WITHOUT_PRORATION",
           "value": "3",
           "tags": [],
-          "docs": "Replacement takes effect immediately, and the new price will be charged on\nnext recurrence time. The billing cycle stays the same."
+          "docs": "Replacement takes effect immediately, and the new price will be charged on\nnext recurrence time. The billing cycle stays the same.\n\nThis is the current default behavior."
         },
         {
           "name": "DEFERRED",
@@ -4370,6 +4445,42 @@
         }
       ]
     },
+    {
+      "name": "STORE_REPLACEMENT_MODE",
+      "slug": "store_replacement_mode",
+      "members": [
+        {
+          "name": "WITHOUT_PRORATION",
+          "value": "\"WITHOUT_PRORATION\"",
+          "tags": [],
+          "docs": "Old subscription is cancelled, and new subscription takes effect immediately.\nUser is charged for the full price of the new subscription on the old subscription's expiration date.\n\nThis is the default behavior for the Galaxy and Play stores."
+        },
+        {
+          "name": "WITH_TIME_PRORATION",
+          "value": "\"WITH_TIME_PRORATION\"",
+          "tags": [],
+          "docs": "Replacement takes effect immediately, and the remaining time will be\nprorated and credited to the user. This is the current default behavior."
+        },
+        {
+          "name": "CHARGE_FULL_PRICE",
+          "value": "\"CHARGE_FULL_PRICE\"",
+          "tags": [],
+          "docs": "Replacement takes effect immediately, and the user is charged full price of new plan and is\ngiven a full billing cycle of subscription, plus remaining prorated time from the old plan.\n\nThis mode is not supported by the Galaxy Store. If it is passed to the Galaxy Store, an error will be thrown."
+        },
+        {
+          "name": "CHARGE_PRORATED_PRICE",
+          "value": "\"CHARGE_PRORATED_PRICE\"",
+          "tags": [],
+          "docs": "Replacement takes effect immediately, and the billing cycle remains the\nsame. The price for the remaining period will be charged. This option is\nonly available for subscription upgrade."
+        },
+        {
+          "name": "DEFERRED",
+          "value": "\"DEFERRED\"",
+          "tags": [],
+          "docs": "Replacement takes effect when the old plan expires, and the new price will be charged at the same time."
+        }
+      ]
+    },
     {
       "name": "LOG_LEVEL",
       "slug": "log_level",

package/dist/esm/definitions.d.ts

@@ -1,4 +1,4 @@
-import type { BILLING_FEATURE, CustomerInfo, CustomerInfoUpdateListener, GoogleProductChangeInfo, IN_APP_MESSAGE_TYPE, IntroEligibility, LOG_LEVEL, LogHandler, LogInResult, MakePurchaseResult, PRODUCT_CATEGORY, PurchasesConfiguration, PurchasesEntitlementInfo, PurchasesOffering, PurchasesOfferings, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesStoreProductDiscount, PurchasesStoreTransaction, PurchasesVirtualCurrencies, PurchasesWinBackOffer, REFUND_REQUEST_STATUS, Storefront, SubscriptionOption, WebPurchaseRedemption, WebPurchaseRedemptionResult } from '@revenuecat/purchases-typescript-internal-esm';
+import type { BILLING_FEATURE, CustomerInfo, CustomerInfoUpdateListener, GoogleProductChangeInfo, IN_APP_MESSAGE_TYPE, IntroEligibility, LOG_LEVEL, LogHandler, LogInResult, MakePurchaseResult, PRODUCT_CATEGORY, PurchasesConfiguration, PurchasesEntitlementInfo, PurchasesOffering, PurchasesOfferings, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesStoreProductDiscount, PurchasesStoreTransaction, PurchasesVirtualCurrencies, PurchasesWinBackOffer, REFUND_REQUEST_STATUS, StoreProductChangeInfo, Storefront, SubscriptionOption, WebPurchaseRedemption, WebPurchaseRedemptionResult } from '@revenuecat/purchases-typescript-internal-esm';
 export * from '@revenuecat/purchases-typescript-internal-esm';
 export type PurchasesCallbackId = string;
 export interface GetProductOptions {
@@ -19,8 +19,16 @@ export interface PurchaseStoreProductOptions {
     /**
      * Android only. Optional GoogleProductChangeInfo you
      * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+     * If both googleProductChangeInfo and storeProductChangeInfo are provided,
+     * storeProductChangeInfo is used and googleProductChangeInfo is ignored.
+     * @deprecated Use storeProductChangeInfo instead.
      */
     googleProductChangeInfo?: GoogleProductChangeInfo | null;
+    /**
+     * Android only. Optional StoreProductChangeInfo you
+     * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.
+     */
+    storeProductChangeInfo?: StoreProductChangeInfo | null;
     /**
      * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.
      * For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true.
@@ -78,8 +86,16 @@ export interface PurchasePackageOptions {
     /**
      * Android only. Optional GoogleProductChangeInfo you
      * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+     * If both googleProductChangeInfo and storeProductChangeInfo are provided,
+     * storeProductChangeInfo is used and googleProductChangeInfo is ignored.
+     * @deprecated Use storeProductChangeInfo instead.
      */
     googleProductChangeInfo?: GoogleProductChangeInfo | null;
+    /**
+     * Android only. Optional StoreProductChangeInfo you
+     * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.
+     */
+    storeProductChangeInfo?: StoreProductChangeInfo | null;
     /**
      * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.
      * For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true.
@@ -95,8 +111,16 @@ export interface PurchaseSubscriptionOptionOptions {
     /**
      * Android only. Optional GoogleProductChangeInfo you
      * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+     * If both googleProductChangeInfo and storeProductChangeInfo are provided,
+     * storeProductChangeInfo is used and googleProductChangeInfo is ignored.
+     * @deprecated Use storeProductChangeInfo instead.
      */
     googleProductChangeInfo?: GoogleProductChangeInfo | null;
+    /**
+     * Android only. Optional StoreProductChangeInfo you
+     * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.
+     */
+    storeProductChangeInfo?: StoreProductChangeInfo | null;
     /**
      * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.
      * For compliance with EU regulations. User will see "This price has been customized for you" in the purchase dialog when true.

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA8BA,cAAc,+CAA+C,CAAC","sourcesContent":["import type {\n  BILLING_FEATURE,\n  CustomerInfo,\n  CustomerInfoUpdateListener,\n  GoogleProductChangeInfo,\n  IN_APP_MESSAGE_TYPE,\n  IntroEligibility,\n  LOG_LEVEL,\n  LogHandler,\n  LogInResult,\n  MakePurchaseResult,\n  PRODUCT_CATEGORY,\n  PurchasesConfiguration,\n  PurchasesEntitlementInfo,\n  PurchasesOffering,\n  PurchasesOfferings,\n  PurchasesPackage,\n  PurchasesPromotionalOffer,\n  PurchasesStoreProduct,\n  PurchasesStoreProductDiscount,\n  PurchasesStoreTransaction,\n  PurchasesVirtualCurrencies,\n  PurchasesWinBackOffer,\n  REFUND_REQUEST_STATUS,\n  Storefront,\n  SubscriptionOption,\n  WebPurchaseRedemption,\n  WebPurchaseRedemptionResult,\n} from '@revenuecat/purchases-typescript-internal-esm';\n\nexport * from '@revenuecat/purchases-typescript-internal-esm';\n\nexport type PurchasesCallbackId = string;\n\nexport interface GetProductOptions {\n  /**\n   * Array of product identifiers to obtain\n   */\n  productIdentifiers: string[];\n  /**\n   * Optional type of products to fetch, can be SUBSCRIPTION or NON_SUBSCRIPTION. SUBSCRIPTION by default. Ignored in iOS.\n   */\n  type?: PRODUCT_CATEGORY;\n}\n\nexport interface PurchaseStoreProductOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseDiscountedProductOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Discount to apply to this package. Retrieve this discount using getPromotionalOffer.\n   */\n  discount: PurchasesPromotionalOffer;\n}\n\nexport interface GetEligibleWinBackOffersForProductOptions {\n  /**\n   * The product you want to fetch eligible win-back offers for\n   */\n  product: PurchasesStoreProduct;\n}\n\nexport interface GetEligibleWinBackOffersForPackageOptions {\n  /**\n   * The package you want to fetch eligible win-back offers for\n   */\n  aPackage: PurchasesPackage;\n}\n\nexport interface PurchaseProductWithWinBackOfferOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForProduct.\n   */\n  winBackOffer: PurchasesWinBackOffer;\n}\n\nexport interface PurchasePackageWithWinBackOfferOptions {\n  /**\n   * The package you want to purchase\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForPackage.\n   */\n  winBackOffer: PurchasesWinBackOffer;\n}\n\nexport interface PurchasePackageOptions {\n  /**\n   * The Package you wish to purchase. You can get the Packages by calling getOfferings\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseSubscriptionOptionOptions {\n  /**\n   * The SubscriptionOption you wish to purchase. You can get the SubscriptionOption from StoreProducts by calling getOfferings\n   */\n  subscriptionOption: SubscriptionOption;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseDiscountedPackageOptions {\n  /**\n   * The Package you wish to purchase. You can get the Packages by calling getOfferings\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Discount to apply to this package. Retrieve this discount using getPromotionalOffer.\n   */\n  discount: PurchasesPromotionalOffer;\n}\n\nexport interface SyncAmazonPurchaseOptions {\n  /**\n   * Product ID associated to the purchase.\n   */\n  productID: string;\n  /**\n   * ReceiptId that represents the Amazon purchase.\n   */\n  receiptID: string;\n  /**\n   * Amazon's userID. This parameter will be ignored when syncing a Google purchase.\n   */\n  amazonUserID: string;\n  /**\n   * Product's currency code in ISO 4217 format.\n   */\n  isoCurrencyCode?: string | null;\n  /**\n   * Product's price.\n   */\n  price?: number | null;\n}\n\n/**\n * @deprecated - Use SyncAmazonPurchaseOptions instead\n */\nexport type SyncObserverModeAmazonPurchaseOptions = SyncAmazonPurchaseOptions;\n\nexport interface GetPromotionalOfferOptions {\n  /**\n   * The `PurchasesStoreProduct` the user intends to purchase.\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * The `PurchasesStoreProductDiscount` to apply to the product.\n   */\n  discount: PurchasesStoreProductDiscount;\n}\n\nexport interface PurchasesPlugin {\n  /**\n   * Sets up Purchases with your API key and an app user id.\n   * @param {PurchasesConfiguration} configuration RevenueCat configuration object including the API key and other optional parameters. See {@link PurchasesConfiguration}\n   */\n  configure(configuration: PurchasesConfiguration): Promise<void>;\n\n  /**\n   * Fetches the virtual currencies for the current subscriber.\n   *\n   * @returns {Promise<{ virtualCurrencies: PurchasesVirtualCurrencies }>} A promise of a {@link PurchasesVirtualCurrencies} object.\n   * The promise will be rejected if configure has not been called yet or if an error occurs while getting the virtual currencies.\n   */\n  getVirtualCurrencies(): Promise<{ virtualCurrencies: PurchasesVirtualCurrencies }>;\n\n  /**\n   * Invalidates the cache for virtual currencies.\n   *\n   * This is useful for cases where a virtual currency's balance might have been updated\n   * outside of the app, like if you decreased a user's balance from the user spending a virtual currency,\n   * or if you increased the balance from your backend using the server APIs.\n   */\n  invalidateVirtualCurrenciesCache(): Promise<void>;\n\n  /**\n   * The currently cached {@link PurchasesVirtualCurrencies} if one is available.\n   * This value will remain null until virtual currencies have been fetched at\n   * least once with {@link getVirtualCurrencies} or an equivalent function.\n   *\n   * @returns {Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null }>} The currently cached virtual currencies for the current subscriber.\n   * The promise will be rejected if configure has not been called yet or there's an error.\n   */\n  getCachedVirtualCurrencies(): Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null }>;\n\n  /**\n   * Parses the given URL string into a [WebPurchaseRedemption] object that can be used to redeem web purchases.\n   * @param options Set the urlString used to open the App.\n   * @returns {Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null}>} A promise of a WebPurchaseRedemption\n   * object that can be redeemed using {@link redeemWebPurchase} or null if the link is invalid.\n   */\n  parseAsWebPurchaseRedemption(options: {\n    urlString: string;\n  }): Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null }>;\n\n  /**\n   * Redeems the web purchase associated with the Redemption Link obtained with [parseAsWebPurchaseRedemption].\n   * @param options The WebPurchaseRedemption object obtained from {@link parseAsWebPurchaseRedemption}.\n   * @returns {Promise<WebPurchaseRedemptionResult>} The result of the redemption process.\n   * Can throw if an invalid WebPurchaseRedemption parameter is passed or Purchases is not configured.\n   */\n  redeemWebPurchase(options: { webPurchaseRedemption: WebPurchaseRedemption }): Promise<WebPurchaseRedemptionResult>;\n\n  /**\n   * Sets whether the SDK should return mocked results in the web version.\n   * This won't affect the iOS and Android versions of the implementation.\n   * Default is false\n   * @param options Set shouldMockWebResults to true if you want the plugin methods to return mocked values\n   */\n  setMockWebResults(options: { shouldMockWebResults: boolean }): Promise<void>;\n\n  /**\n   * iOS only.\n   * @param options Set this property to true *only* when testing the ask-to-buy / SCA\n   * purchases flow. More information: http://errors.rev.cat/ask-to-buy\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  setSimulatesAskToBuyInSandbox(options: { simulatesAskToBuyInSandbox: boolean }): Promise<void>;\n\n  /**\n   * Sets a function to be called on updated customer info\n   * @param {CustomerInfoUpdateListener} customerInfoUpdateListener CustomerInfo update listener\n   */\n  addCustomerInfoUpdateListener(customerInfoUpdateListener: CustomerInfoUpdateListener): Promise<PurchasesCallbackId>;\n\n  /**\n   * Removes a given CustomerInfoUpdateListener\n   * @param {CustomerInfoUpdateListener} options Include listenerToRemove, which is a CustomerInfoUpdateListener\n   * reference of the listener to remove\n   * @returns Promise with boolean. True if listener was removed, false otherwise\n   */\n  removeCustomerInfoUpdateListener(options: {\n    listenerToRemove: PurchasesCallbackId;\n  }): Promise<{ wasRemoved: boolean }>;\n\n  // TODO: Support addShouldPurchasePromoProductListener functionality\n  // /**\n  //  * Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS.\n  //  * @param {ShouldPurchasePromoProductListener} shouldPurchasePromoProductListener Called when a user initiates a\n  //  * promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run\n  //  * the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then\n  //  * call the deferredPurchase when the app is ready to make the promotional purchase.\n  //  * If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not\n  //  * proceed with promotional purchases.\n  //  */\n  // addShouldPurchasePromoProductListener(\n  //   shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener,\n  // ): Promise<PurchasesCallbackId>;\n  //\n  // /**\n  //  * Removes a given ShouldPurchasePromoProductListener\n  //  * @param {ShouldPurchasePromoProductListener} listenerToRemove ShouldPurchasePromoProductListener reference of\n  //  * the listener to remove\n  //  * @returns Promise with boolean. True if listener was removed, false otherwise\n  //  */\n  // removeShouldPurchasePromoProductListener(\n  //   listenerToRemove: PurchasesCallbackId,\n  // ): Promise<{ wasRemoved: boolean }>;\n\n  /**\n   * Gets the map of entitlements -> offerings -> products\n   * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  getOfferings(): Promise<PurchasesOfferings>;\n\n  /**\n   * Retrieves a current offering for a placement identifier, use this to access offerings defined by targeting\n   * placements configured in the RevenueCat dashboard.\n   * @returns {Promise<PurchasesOffering | null>} Promise of optional offering. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  getCurrentOfferingForPlacement(options: { placementIdentifier: string }): Promise<PurchasesOffering | null>;\n\n  /**\n   * Syncs subscriber attributes and then fetches the configured offerings for this user. This method is intended to\n   * be called when using Targeting Rules with Custom Attributes. Any subscriber attributes should be set before\n   * calling this method to ensure the returned offerings are applied with the latest subscriber attributes.\n   * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  syncAttributesAndOfferingsIfNeeded(): Promise<PurchasesOfferings>;\n\n  /**\n   * Fetch the product info\n   * @returns {Promise<PurchasesStoreProduct[]>} A promise containing an array of products. The promise will be rejected\n   * if the products are not properly configured in RevenueCat or if there is another error retrieving them.\n   * Rejections return an error code, and a userInfo object with more information. The promise will also be rejected\n   * if configure has not been called yet.\n   */\n  getProducts(options: GetProductOptions): Promise<{ products: PurchasesStoreProduct[] }>;\n\n  /**\n   * Make a purchase\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code,\n   * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will\n   * also be rejected if configure has not been called yet.\n   */\n  purchaseStoreProduct(options: PurchaseStoreProductOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * iOS only. Purchase a product applying a given discount.\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code,\n   * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be\n   * rejected if configure has not been called yet.\n   */\n  purchaseDiscountedProduct(options: PurchaseDiscountedProductOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Make a purchase\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchasePackage(options: PurchasePackageOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Google only. Make a purchase of a subscriptionOption\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchaseSubscriptionOption(options: PurchaseSubscriptionOptionOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * iOS only. Purchase a package applying a given discount.\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchaseDiscountedPackage(options: PurchaseDiscountedPackageOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code, and an\n   * userInfo object with more information. The promise will be also be rejected if configure has not been called yet.\n   */\n  restorePurchases(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use\n   * RevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.\n   *\n   * You only need to use this method with *new* purchases. Subscription updates are observed automatically.\n   * @param options The productID that was purchased that needs to be synced with RevenueCat's backend.\n   */\n  recordPurchase(options: { productID: string }): Promise<{ transaction: PurchasesStoreTransaction }>;\n\n  /**\n   * Get the appUserID\n   * @returns {Promise<string>} The app user id in a promise\n   */\n  getAppUserID(): Promise<{ appUserID: string }>;\n\n  /**\n   * Gets the storefront for the current store account.\n   * @return {Promise<Storefront>} A promise of a Storefront object.\n   * The promise will be rejected if configure has not been called yet or if storefront could\n   * not be obtained for account.\n   */\n  getStorefront(): Promise<Storefront>;\n\n  /**\n   * This function will log in the current user with an appUserID. Typically, this would be used after a log in\n   * to identify a user without calling configure.\n   * @param options The appUserID that should be linked to the current user\n   * @returns {Promise<LogInResult>} A promise of an object that contains the customerInfo after logging in, as well\n   * as a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The\n   * promise will be rejected if configure has not been called yet or if there's an issue logging in.\n   */\n  logIn(options: { appUserID: string }): Promise<LogInResult>;\n\n  /**\n   * Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code,\n   * and a userInfo object with more information. The promise will be rejected if configure has not been called yet or if\n   * there's an issue logging out.\n   */\n  logOut(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.\n   * The default is {LOG_LEVEL.INFO} in release builds and {LOG_LEVEL.DEBUG} in debug builds.\n   * @param options Log level to use to display logs.\n   */\n  setLogLevel(options: { level: LOG_LEVEL }): Promise<void>;\n\n  /**\n   * Set a custom log handler for redirecting logs to your own logging system.\n   * By default, this sends info, warning, and error messages.\n   * If you wish to receive Debug level messages, see [setLogLevel].\n   * @param {LogHandler} logHandler It will get called for each log event.\n   * Use this function to redirect the log to your own logging system\n   */\n  setLogHandler(logHandler: LogHandler): Promise<void>;\n\n  /**\n   * Gets current customer info\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code, and an\n   * userInfo object with more information. The promise will be rejected if configure has not been called yet or if\n   * there's an issue getting the customer information.\n   */\n  getCustomerInfo(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation\n   * for subscriptions anytime a sync is needed, like after a successful purchase.\n   *\n   * @warning This function should only be called if you're not calling purchaseProduct/purchaseStoreProduct/purchasePackage/purchaseSubscriptionOption.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncPurchases(): Promise<void>;\n\n  /**\n   * @deprecated - Use syncAmazonPurchase instead\n   * This method will send a purchase to the RevenueCat backend. This function should only be called if you are\n   * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n   *\n   * The receipt IDs are cached if successfully posted, so they are not posted more than once.\n   *\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncObserverModeAmazonPurchase(options: SyncObserverModeAmazonPurchaseOptions): Promise<void>;\n\n  /**\n   * This method will send a purchase to the RevenueCat backend. This function should only be called if you are\n   * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n   *\n   * The receipt IDs are cached if successfully posted, so they are not posted more than once.\n   *\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncAmazonPurchase(options: SyncAmazonPurchaseOptions): Promise<void>;\n\n  /**\n   * Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default. Supported in iOS 14.3+ only\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  enableAdServicesAttributionTokenCollection(): Promise<void>;\n\n  /**\n   * @returns { Promise<boolean> } If the `appUserID` has been generated by RevenueCat or not.\n   * The promise will be rejected if configure has not been called yet.\n   */\n  isAnonymous(): Promise<{ isAnonymous: boolean }>;\n\n  /**\n   * iOS only. Computes whether a user is eligible for the introductory pricing period of a given product.\n   * You should use this method to determine whether you show the user the normal product price or the\n   * introductory price. This also applies to trials (trials are considered a type of introductory pricing).\n   *\n   * @note Subscription groups are automatically collected for determining eligibility. If RevenueCat can't\n   * definitively compute the eligibility, most likely because of missing group information, it will return\n   * `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro\n   * pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of\n   * iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.\n   *\n   * @param options Array of product identifiers for which you want to compute eligibility\n   * @returns { Promise<[productId: string]: IntroEligibility> } A map of IntroEligility per productId. The promise\n   * will be rejected if configure has not been called yet or if there's in an error checking eligibility.\n   */\n  checkTrialOrIntroductoryPriceEligibility(options: {\n    productIdentifiers: string[];\n  }): Promise<{ [productId: string]: IntroEligibility }>;\n\n  /**\n   * iOS only. Use this function to retrieve the `PurchasesPromotionalOffer` for a given `PurchasesPackage`.\n   *\n   * @returns { Promise<PurchasesPromotionalOffer | undefined> } Returns when the `PurchasesPaymentDiscount` is returned.\n   * Null is returned for Android and incompatible iOS versions. The promise will be rejected if configure has not been\n   * called yet or if there's an error getting the payment discount.\n   */\n  getPromotionalOffer(options: GetPromotionalOfferOptions): Promise<PurchasesPromotionalOffer | undefined>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\n   * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\n   * given `PurchasesStoreProduct`.\n   *\n   * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } A dictionary containing an array of `PurchasesWinBackOffer`s that\n   * the subscriber is eligible for for the given `PurchasesStoreProduct`.\n   * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   * The promise will also be rejected if configure has not been called yet.\n   */\n  getEligibleWinBackOffersForProduct(options: GetEligibleWinBackOffersForProductOptions): Promise<{\n    eligibleWinBackOffers: PurchasesWinBackOffer[];\n  }>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\n   * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\n   * given `PurchasesStorePackage`.\n   *\n   * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } An array of `PurchasesWinBackOffer`s that\n   * the subscriber is eligible for for the given `PurchasesStorePackage`.\n   * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   * The promise will also be rejected if configure has not been called yet.\n   */\n  getEligibleWinBackOffersForPackage(options: GetEligibleWinBackOffersForPackageOptions): Promise<{\n    eligibleWinBackOffers: PurchasesWinBackOffer[];\n  }>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.\n   *\n   * @returns {Promise<MakePurchaseResult>} A promise of an object containing\n   * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   */\n  purchaseProductWithWinBackOffer(\n    options: PurchaseProductWithWinBackOfferOptions,\n  ): Promise<MakePurchaseResult | undefined>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.\n   *\n   * @returns {Promise<MakePurchaseResult>} A promise of an object containing\n   * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   */\n  purchasePackageWithWinBackOffer(\n    options: PurchasePackageWithWinBackOfferOptions,\n  ): Promise<MakePurchaseResult | undefined>;\n\n  /**\n   * Invalidates the cache for customer information.\n   *\n   * Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state.\n   * Refer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on\n   * using the cache properly.\n   *\n   * This is useful for cases where customer information might have been updated outside the app, like if a\n   * promotional subscription is granted through the RevenueCat dashboard.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * invalidating the customer info cache.\n   */\n  invalidateCustomerInfoCache(): Promise<void>;\n\n  /** iOS 14.0+ only. Presents a code redemption sheet, useful for redeeming offer codes\n   * Refer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how\n   * to configure and use offer codes\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * presenting the code redemption sheet.\n   */\n  presentCodeRedemptionSheet(): Promise<void>;\n\n  /**\n   * Subscriber attributes are useful for storing additional, structured information on a user.\n   * Since attributes are writable using a public key they should not be used for\n   * managing secure or sensitive information such as subscription status, coins, etc.\n   *\n   * Key names starting with \"$\" are reserved names used by RevenueCat. For a full list of key\n   * restrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes\n   *\n   * @param attributes Map of attributes by key. Set the value as an empty string to delete an attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * setting the subscriber attributes.\n   */\n  setAttributes(attributes: { [key: string]: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the email address for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the email.\n   */\n  setEmail(options: { email: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the phone number for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the phone number.\n   */\n  setPhoneNumber(options: { phoneNumber: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the display name for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the display name.\n   */\n  setDisplayName(options: { displayName: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the push token for the user\n   *\n   * @param options null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the push token.\n   */\n  setPushToken(options: { pushToken: string | null }): Promise<void>;\n\n  /**\n   * Set this property to your proxy URL before configuring Purchases *only* if you've received a proxy key value\n   * from your RevenueCat contact.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the proxy url.\n   */\n  setProxyURL(options: { url: string }): Promise<void>;\n\n  /**\n   * Automatically collect subscriber attributes associated with the device identifiers.\n   * $idfa, $idfv, $ip on iOS\n   * $gpsAdId, $androidId, $ip on Android\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting collecting the device identifiers.\n   */\n  collectDeviceIdentifiers(): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Adjust ID for the user\n   * Required for the RevenueCat Adjust integration\n   *\n   * @param options Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting Adjust ID.\n   */\n  setAdjustID(options: { adjustID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the AppsFlyer ID for the user\n   * Required for the RevenueCat AppsFlyer integration\n   * @param options Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Appsflyer ID.\n   */\n  setAppsflyerID(options: { appsflyerID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Facebook SDK Anonymous ID for the user\n   * Recommended for the RevenueCat Facebook integration\n   *\n   * @param options Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Facebook Anonymous ID.\n   */\n  setFBAnonymousID(options: { fbAnonymousID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the mParticle ID for the user\n   * Recommended for the RevenueCat mParticle integration\n   *\n   * @param options Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Mparticle ID.\n   */\n  setMparticleID(options: { mparticleID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the CleverTap ID for the user\n   * Required for the RevenueCat CleverTap integration\n   *\n   * @param options CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the CleverTap ID.\n   */\n  setCleverTapID(options: { cleverTapID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Mixpanel Distinct ID for the user\n   * Required for the RevenueCat Mixpanel integration\n   *\n   * @param options Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Mixpanel Distinct ID.\n   */\n  setMixpanelDistinctID(options: { mixpanelDistinctID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Firebase App Instance ID for the user\n   * Required for the RevenueCat Firebase integration\n   *\n   * @param options Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Firebase App Instance ID.\n   */\n  setFirebaseAppInstanceID(options: { firebaseAppInstanceID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the OneSignal Player ID for the user\n   * Required for the RevenueCat OneSignal integration. Deprecated for OneSignal versions above v9.0.\n   *\n   * @param options OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the OneSignal ID.\n   */\n  setOnesignalID(options: { onesignalID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the OneSignal User ID for the user\n   * Required for the RevenueCat OneSignal integration with versions v11.0 and above.\n   *\n   * @param options OneSignal UserId to use in OneSignal integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the OneSignal user ID.\n   */\n  setOnesignalUserID(options: { onesignalUserID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Airship Channel ID for the user\n   * Required for the RevenueCat Airship integration\n   *\n   * @param options Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Airship Channel ID.\n   */\n  setAirshipChannelID(options: { airshipChannelID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install media source for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the media source.\n   */\n  setMediaSource(options: { mediaSource: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install campaign for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the campaign.\n   */\n  setCampaign(options: { campaign: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad group for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting ad group.\n   */\n  setAdGroup(options: { adGroup: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the ad subscriber attribute.\n   */\n  setAd(options: { ad: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install keyword for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the keyword.\n   */\n  setKeyword(options: { keyword: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad creative for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the creative subscriber attribute.\n   */\n  setCreative(options: { creative: string | null }): Promise<void>;\n\n  /**\n   * Check if billing is supported for the current user (meaning IN-APP purchases are supported)\n   * and optionally, whether a list of specified feature types are supported.\n   *\n   * Note: Billing features are only relevant to Google Play Android users.\n   * For other stores and platforms, billing features won't be checked.\n   *\n   * @param options An array of feature types to check for support. Feature types must be one of\n   *       [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked.\n   * @returns promise with boolean response. True if billing is supported, false otherwise.\n   */\n  canMakePayments(options?: { features?: BILLING_FEATURE[] }): Promise<{ canMakePayments: boolean }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the active entitlement.\n   *\n   * If the request was unsuccessful, no active entitlements could be found for\n   * the user, or multiple active entitlements were found for the user,\n   * the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * Important: This method should only be used if your user can only have a single active entitlement at a given time.\n   * If a user could have more than one entitlement at a time, use `beginRefundRequestForEntitlement` instead.\n   *\n   * @returns Returns refundRequestStatus: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForActiveEntitlement(): Promise<{\n    refundRequestStatus: REFUND_REQUEST_STATUS;\n  }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the `entitlement`.\n   *\n   * If the request was unsuccessful, the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * @param options The entitlement to begin a refund request for.\n   * @returns Returns refundRequestStatus: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForEntitlement(options: {\n    entitlementInfo: PurchasesEntitlementInfo;\n  }): Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the `product`.\n   *\n   * If the request was unsuccessful, the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * @param options The StoreProduct to begin a refund request for.\n   * @returns {Promise<REFUND_REQUEST_STATUS>} Returns a REFUND_REQUEST_STATUS: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForProduct(options: {\n    storeProduct: PurchasesStoreProduct;\n  }): Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS }>;\n\n  /**\n   * Shows in-app messages available from the App Store or Google Play. You need to disable messages from showing\n   * automatically using [PurchasesConfiguration.shouldShowInAppMessagesAutomatically].\n   *\n   * Note: In iOS, this requires version 16+. In older versions the promise will be resolved successfully\n   * immediately.\n   *\n   * @param options An array of message types that the stores can display inside your app. Values must be one of\n   *       [IN_APP_MESSAGE_TYPE]. By default, is undefined and all message types will be shown.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  showInAppMessages(options?: { messageTypes?: IN_APP_MESSAGE_TYPE[] }): Promise<void>;\n\n  /**\n   * Check if configure has finished and Purchases has been configured.\n   *\n   * @returns promise with boolean response\n   */\n  isConfigured(): Promise<{ isConfigured: boolean }>;\n\n  /**\n   * Override the preferred UI locale for RevenueCat UI components at runtime. This affects both API requests\n   * and UI rendering. If the locale changes, this will automatically clear the offerings cache and trigger\n   * a background refetch to get paywall templates with the correct localizations.\n   *\n   * @param options The locale string (e.g., \"es-ES\", \"en-US\") or null to use system default.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  overridePreferredUILocale(options: { locale: string | null }): Promise<void>;\n\n  /**\n   * Tracks an impression of a custom paywall. Use this to record when a user views your custom paywall\n   * so that RevenueCat can track paywall analytics.\n   *\n   * Call this method once per paywall display, ideally when the paywall first becomes visible to the user,\n   * not in callbacks that may fire multiple times for the same display.\n   *\n   * @param options Optional parameters for the impression. Include `paywallId` to identify which paywall was shown.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  trackCustomPaywallImpression(options?: TrackCustomPaywallImpressionOptions): Promise<void>;\n}\n\n/**\n * Options for tracking a custom paywall impression.\n */\nexport interface TrackCustomPaywallImpressionOptions {\n  /** The identifier of the paywall that was shown. */\n  paywallId?: string | null;\n  /**\n   * An optional identifier for the offering associated with the custom paywall.\n   * If not provided, the SDK will use the current offering identifier from the cache.\n   */\n  offeringId?: string | null;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA+BA,cAAc,+CAA+C,CAAC","sourcesContent":["import type {\n  BILLING_FEATURE,\n  CustomerInfo,\n  CustomerInfoUpdateListener,\n  GoogleProductChangeInfo,\n  IN_APP_MESSAGE_TYPE,\n  IntroEligibility,\n  LOG_LEVEL,\n  LogHandler,\n  LogInResult,\n  MakePurchaseResult,\n  PRODUCT_CATEGORY,\n  PurchasesConfiguration,\n  PurchasesEntitlementInfo,\n  PurchasesOffering,\n  PurchasesOfferings,\n  PurchasesPackage,\n  PurchasesPromotionalOffer,\n  PurchasesStoreProduct,\n  PurchasesStoreProductDiscount,\n  PurchasesStoreTransaction,\n  PurchasesVirtualCurrencies,\n  PurchasesWinBackOffer,\n  REFUND_REQUEST_STATUS,\n  StoreProductChangeInfo,\n  Storefront,\n  SubscriptionOption,\n  WebPurchaseRedemption,\n  WebPurchaseRedemptionResult,\n} from '@revenuecat/purchases-typescript-internal-esm';\n\nexport * from '@revenuecat/purchases-typescript-internal-esm';\n\nexport type PurchasesCallbackId = string;\n\nexport interface GetProductOptions {\n  /**\n   * Array of product identifiers to obtain\n   */\n  productIdentifiers: string[];\n  /**\n   * Optional type of products to fetch, can be SUBSCRIPTION or NON_SUBSCRIPTION. SUBSCRIPTION by default. Ignored in iOS.\n   */\n  type?: PRODUCT_CATEGORY;\n}\n\nexport interface PurchaseStoreProductOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   * If both googleProductChangeInfo and storeProductChangeInfo are provided,\n   * storeProductChangeInfo is used and googleProductChangeInfo is ignored.\n   * @deprecated Use storeProductChangeInfo instead.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android only. Optional StoreProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.\n   */\n  storeProductChangeInfo?: StoreProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseDiscountedProductOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Discount to apply to this package. Retrieve this discount using getPromotionalOffer.\n   */\n  discount: PurchasesPromotionalOffer;\n}\n\nexport interface GetEligibleWinBackOffersForProductOptions {\n  /**\n   * The product you want to fetch eligible win-back offers for\n   */\n  product: PurchasesStoreProduct;\n}\n\nexport interface GetEligibleWinBackOffersForPackageOptions {\n  /**\n   * The package you want to fetch eligible win-back offers for\n   */\n  aPackage: PurchasesPackage;\n}\n\nexport interface PurchaseProductWithWinBackOfferOptions {\n  /**\n   * The product you want to purchase\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForProduct.\n   */\n  winBackOffer: PurchasesWinBackOffer;\n}\n\nexport interface PurchasePackageWithWinBackOfferOptions {\n  /**\n   * The package you want to purchase\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForPackage.\n   */\n  winBackOffer: PurchasesWinBackOffer;\n}\n\nexport interface PurchasePackageOptions {\n  /**\n   * The Package you wish to purchase. You can get the Packages by calling getOfferings\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   * If both googleProductChangeInfo and storeProductChangeInfo are provided,\n   * storeProductChangeInfo is used and googleProductChangeInfo is ignored.\n   * @deprecated Use storeProductChangeInfo instead.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android only. Optional StoreProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.\n   */\n  storeProductChangeInfo?: StoreProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseSubscriptionOptionOptions {\n  /**\n   * The SubscriptionOption you wish to purchase. You can get the SubscriptionOption from StoreProducts by calling getOfferings\n   */\n  subscriptionOption: SubscriptionOption;\n  /**\n   * Android only. Optional GoogleProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.\n   * If both googleProductChangeInfo and storeProductChangeInfo are provided,\n   * storeProductChangeInfo is used and googleProductChangeInfo is ignored.\n   * @deprecated Use storeProductChangeInfo instead.\n   */\n  googleProductChangeInfo?: GoogleProductChangeInfo | null;\n  /**\n   * Android only. Optional StoreProductChangeInfo you\n   * wish to upgrade from containing the oldProductIdentifier and the optional replacementMode.\n   */\n  storeProductChangeInfo?: StoreProductChangeInfo | null;\n  /**\n   * Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\n   * For compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\n   * See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.\n   */\n  googleIsPersonalizedPrice?: boolean | null;\n}\n\nexport interface PurchaseDiscountedPackageOptions {\n  /**\n   * The Package you wish to purchase. You can get the Packages by calling getOfferings\n   */\n  aPackage: PurchasesPackage;\n  /**\n   * Discount to apply to this package. Retrieve this discount using getPromotionalOffer.\n   */\n  discount: PurchasesPromotionalOffer;\n}\n\nexport interface SyncAmazonPurchaseOptions {\n  /**\n   * Product ID associated to the purchase.\n   */\n  productID: string;\n  /**\n   * ReceiptId that represents the Amazon purchase.\n   */\n  receiptID: string;\n  /**\n   * Amazon's userID. This parameter will be ignored when syncing a Google purchase.\n   */\n  amazonUserID: string;\n  /**\n   * Product's currency code in ISO 4217 format.\n   */\n  isoCurrencyCode?: string | null;\n  /**\n   * Product's price.\n   */\n  price?: number | null;\n}\n\n/**\n * @deprecated - Use SyncAmazonPurchaseOptions instead\n */\nexport type SyncObserverModeAmazonPurchaseOptions = SyncAmazonPurchaseOptions;\n\nexport interface GetPromotionalOfferOptions {\n  /**\n   * The `PurchasesStoreProduct` the user intends to purchase.\n   */\n  product: PurchasesStoreProduct;\n  /**\n   * The `PurchasesStoreProductDiscount` to apply to the product.\n   */\n  discount: PurchasesStoreProductDiscount;\n}\n\nexport interface PurchasesPlugin {\n  /**\n   * Sets up Purchases with your API key and an app user id.\n   * @param {PurchasesConfiguration} configuration RevenueCat configuration object including the API key and other optional parameters. See {@link PurchasesConfiguration}\n   */\n  configure(configuration: PurchasesConfiguration): Promise<void>;\n\n  /**\n   * Fetches the virtual currencies for the current subscriber.\n   *\n   * @returns {Promise<{ virtualCurrencies: PurchasesVirtualCurrencies }>} A promise of a {@link PurchasesVirtualCurrencies} object.\n   * The promise will be rejected if configure has not been called yet or if an error occurs while getting the virtual currencies.\n   */\n  getVirtualCurrencies(): Promise<{ virtualCurrencies: PurchasesVirtualCurrencies }>;\n\n  /**\n   * Invalidates the cache for virtual currencies.\n   *\n   * This is useful for cases where a virtual currency's balance might have been updated\n   * outside of the app, like if you decreased a user's balance from the user spending a virtual currency,\n   * or if you increased the balance from your backend using the server APIs.\n   */\n  invalidateVirtualCurrenciesCache(): Promise<void>;\n\n  /**\n   * The currently cached {@link PurchasesVirtualCurrencies} if one is available.\n   * This value will remain null until virtual currencies have been fetched at\n   * least once with {@link getVirtualCurrencies} or an equivalent function.\n   *\n   * @returns {Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null }>} The currently cached virtual currencies for the current subscriber.\n   * The promise will be rejected if configure has not been called yet or there's an error.\n   */\n  getCachedVirtualCurrencies(): Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null }>;\n\n  /**\n   * Parses the given URL string into a [WebPurchaseRedemption] object that can be used to redeem web purchases.\n   * @param options Set the urlString used to open the App.\n   * @returns {Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null}>} A promise of a WebPurchaseRedemption\n   * object that can be redeemed using {@link redeemWebPurchase} or null if the link is invalid.\n   */\n  parseAsWebPurchaseRedemption(options: {\n    urlString: string;\n  }): Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null }>;\n\n  /**\n   * Redeems the web purchase associated with the Redemption Link obtained with [parseAsWebPurchaseRedemption].\n   * @param options The WebPurchaseRedemption object obtained from {@link parseAsWebPurchaseRedemption}.\n   * @returns {Promise<WebPurchaseRedemptionResult>} The result of the redemption process.\n   * Can throw if an invalid WebPurchaseRedemption parameter is passed or Purchases is not configured.\n   */\n  redeemWebPurchase(options: { webPurchaseRedemption: WebPurchaseRedemption }): Promise<WebPurchaseRedemptionResult>;\n\n  /**\n   * Sets whether the SDK should return mocked results in the web version.\n   * This won't affect the iOS and Android versions of the implementation.\n   * Default is false\n   * @param options Set shouldMockWebResults to true if you want the plugin methods to return mocked values\n   */\n  setMockWebResults(options: { shouldMockWebResults: boolean }): Promise<void>;\n\n  /**\n   * iOS only.\n   * @param options Set this property to true *only* when testing the ask-to-buy / SCA\n   * purchases flow. More information: http://errors.rev.cat/ask-to-buy\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  setSimulatesAskToBuyInSandbox(options: { simulatesAskToBuyInSandbox: boolean }): Promise<void>;\n\n  /**\n   * Sets a function to be called on updated customer info\n   * @param {CustomerInfoUpdateListener} customerInfoUpdateListener CustomerInfo update listener\n   */\n  addCustomerInfoUpdateListener(customerInfoUpdateListener: CustomerInfoUpdateListener): Promise<PurchasesCallbackId>;\n\n  /**\n   * Removes a given CustomerInfoUpdateListener\n   * @param {CustomerInfoUpdateListener} options Include listenerToRemove, which is a CustomerInfoUpdateListener\n   * reference of the listener to remove\n   * @returns Promise with boolean. True if listener was removed, false otherwise\n   */\n  removeCustomerInfoUpdateListener(options: {\n    listenerToRemove: PurchasesCallbackId;\n  }): Promise<{ wasRemoved: boolean }>;\n\n  // TODO: Support addShouldPurchasePromoProductListener functionality\n  // /**\n  //  * Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS.\n  //  * @param {ShouldPurchasePromoProductListener} shouldPurchasePromoProductListener Called when a user initiates a\n  //  * promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run\n  //  * the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then\n  //  * call the deferredPurchase when the app is ready to make the promotional purchase.\n  //  * If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not\n  //  * proceed with promotional purchases.\n  //  */\n  // addShouldPurchasePromoProductListener(\n  //   shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener,\n  // ): Promise<PurchasesCallbackId>;\n  //\n  // /**\n  //  * Removes a given ShouldPurchasePromoProductListener\n  //  * @param {ShouldPurchasePromoProductListener} listenerToRemove ShouldPurchasePromoProductListener reference of\n  //  * the listener to remove\n  //  * @returns Promise with boolean. True if listener was removed, false otherwise\n  //  */\n  // removeShouldPurchasePromoProductListener(\n  //   listenerToRemove: PurchasesCallbackId,\n  // ): Promise<{ wasRemoved: boolean }>;\n\n  /**\n   * Gets the map of entitlements -> offerings -> products\n   * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  getOfferings(): Promise<PurchasesOfferings>;\n\n  /**\n   * Retrieves a current offering for a placement identifier, use this to access offerings defined by targeting\n   * placements configured in the RevenueCat dashboard.\n   * @returns {Promise<PurchasesOffering | null>} Promise of optional offering. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  getCurrentOfferingForPlacement(options: { placementIdentifier: string }): Promise<PurchasesOffering | null>;\n\n  /**\n   * Syncs subscriber attributes and then fetches the configured offerings for this user. This method is intended to\n   * be called when using Targeting Rules with Custom Attributes. Any subscriber attributes should be set before\n   * calling this method to ensure the returned offerings are applied with the latest subscriber attributes.\n   * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if configure\n   * has not been called yet.\n   */\n  syncAttributesAndOfferingsIfNeeded(): Promise<PurchasesOfferings>;\n\n  /**\n   * Fetch the product info\n   * @returns {Promise<PurchasesStoreProduct[]>} A promise containing an array of products. The promise will be rejected\n   * if the products are not properly configured in RevenueCat or if there is another error retrieving them.\n   * Rejections return an error code, and a userInfo object with more information. The promise will also be rejected\n   * if configure has not been called yet.\n   */\n  getProducts(options: GetProductOptions): Promise<{ products: PurchasesStoreProduct[] }>;\n\n  /**\n   * Make a purchase\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code,\n   * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will\n   * also be rejected if configure has not been called yet.\n   */\n  purchaseStoreProduct(options: PurchaseStoreProductOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * iOS only. Purchase a product applying a given discount.\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code,\n   * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be\n   * rejected if configure has not been called yet.\n   */\n  purchaseDiscountedProduct(options: PurchaseDiscountedProductOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Make a purchase\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchasePackage(options: PurchasePackageOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Google only. Make a purchase of a subscriptionOption\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchaseSubscriptionOption(options: PurchaseSubscriptionOptionOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * iOS only. Purchase a package applying a given discount.\n   *\n   * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing\n   * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet.\n   */\n  purchaseDiscountedPackage(options: PurchaseDiscountedPackageOptions): Promise<MakePurchaseResult>;\n\n  /**\n   * Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code, and an\n   * userInfo object with more information. The promise will be also be rejected if configure has not been called yet.\n   */\n  restorePurchases(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use\n   * RevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.\n   *\n   * You only need to use this method with *new* purchases. Subscription updates are observed automatically.\n   * @param options The productID that was purchased that needs to be synced with RevenueCat's backend.\n   */\n  recordPurchase(options: { productID: string }): Promise<{ transaction: PurchasesStoreTransaction }>;\n\n  /**\n   * Get the appUserID\n   * @returns {Promise<string>} The app user id in a promise\n   */\n  getAppUserID(): Promise<{ appUserID: string }>;\n\n  /**\n   * Gets the storefront for the current store account.\n   * @return {Promise<Storefront>} A promise of a Storefront object.\n   * The promise will be rejected if configure has not been called yet or if storefront could\n   * not be obtained for account.\n   */\n  getStorefront(): Promise<Storefront>;\n\n  /**\n   * This function will log in the current user with an appUserID. Typically, this would be used after a log in\n   * to identify a user without calling configure.\n   * @param options The appUserID that should be linked to the current user\n   * @returns {Promise<LogInResult>} A promise of an object that contains the customerInfo after logging in, as well\n   * as a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The\n   * promise will be rejected if configure has not been called yet or if there's an issue logging in.\n   */\n  logIn(options: { appUserID: string }): Promise<LogInResult>;\n\n  /**\n   * Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code,\n   * and a userInfo object with more information. The promise will be rejected if configure has not been called yet or if\n   * there's an issue logging out.\n   */\n  logOut(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.\n   * The default is {LOG_LEVEL.INFO} in release builds and {LOG_LEVEL.DEBUG} in debug builds.\n   * @param options Log level to use to display logs.\n   */\n  setLogLevel(options: { level: LOG_LEVEL }): Promise<void>;\n\n  /**\n   * Set a custom log handler for redirecting logs to your own logging system.\n   * By default, this sends info, warning, and error messages.\n   * If you wish to receive Debug level messages, see [setLogLevel].\n   * @param {LogHandler} logHandler It will get called for each log event.\n   * Use this function to redirect the log to your own logging system\n   */\n  setLogHandler(logHandler: LogHandler): Promise<void>;\n\n  /**\n   * Gets current customer info\n   * @returns {Promise<{ customerInfo: CustomerInfo }>} A promise of a customer info object. Rejections return an error code, and an\n   * userInfo object with more information. The promise will be rejected if configure has not been called yet or if\n   * there's an issue getting the customer information.\n   */\n  getCustomerInfo(): Promise<{ customerInfo: CustomerInfo }>;\n\n  /**\n   * This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation\n   * for subscriptions anytime a sync is needed, like after a successful purchase.\n   *\n   * @warning This function should only be called if you're not calling purchaseProduct/purchaseStoreProduct/purchasePackage/purchaseSubscriptionOption.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncPurchases(): Promise<void>;\n\n  /**\n   * @deprecated - Use syncAmazonPurchase instead\n   * This method will send a purchase to the RevenueCat backend. This function should only be called if you are\n   * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n   *\n   * The receipt IDs are cached if successfully posted, so they are not posted more than once.\n   *\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncObserverModeAmazonPurchase(options: SyncObserverModeAmazonPurchaseOptions): Promise<void>;\n\n  /**\n   * This method will send a purchase to the RevenueCat backend. This function should only be called if you are\n   * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n   *\n   * The receipt IDs are cached if successfully posted, so they are not posted more than once.\n   *\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * syncing purchases.\n   */\n  syncAmazonPurchase(options: SyncAmazonPurchaseOptions): Promise<void>;\n\n  /**\n   * Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default. Supported in iOS 14.3+ only\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  enableAdServicesAttributionTokenCollection(): Promise<void>;\n\n  /**\n   * @returns { Promise<boolean> } If the `appUserID` has been generated by RevenueCat or not.\n   * The promise will be rejected if configure has not been called yet.\n   */\n  isAnonymous(): Promise<{ isAnonymous: boolean }>;\n\n  /**\n   * iOS only. Computes whether a user is eligible for the introductory pricing period of a given product.\n   * You should use this method to determine whether you show the user the normal product price or the\n   * introductory price. This also applies to trials (trials are considered a type of introductory pricing).\n   *\n   * @note Subscription groups are automatically collected for determining eligibility. If RevenueCat can't\n   * definitively compute the eligibility, most likely because of missing group information, it will return\n   * `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro\n   * pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of\n   * iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.\n   *\n   * @param options Array of product identifiers for which you want to compute eligibility\n   * @returns { Promise<[productId: string]: IntroEligibility> } A map of IntroEligility per productId. The promise\n   * will be rejected if configure has not been called yet or if there's in an error checking eligibility.\n   */\n  checkTrialOrIntroductoryPriceEligibility(options: {\n    productIdentifiers: string[];\n  }): Promise<{ [productId: string]: IntroEligibility }>;\n\n  /**\n   * iOS only. Use this function to retrieve the `PurchasesPromotionalOffer` for a given `PurchasesPackage`.\n   *\n   * @returns { Promise<PurchasesPromotionalOffer | undefined> } Returns when the `PurchasesPaymentDiscount` is returned.\n   * Null is returned for Android and incompatible iOS versions. The promise will be rejected if configure has not been\n   * called yet or if there's an error getting the payment discount.\n   */\n  getPromotionalOffer(options: GetPromotionalOfferOptions): Promise<PurchasesPromotionalOffer | undefined>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\n   * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\n   * given `PurchasesStoreProduct`.\n   *\n   * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } A dictionary containing an array of `PurchasesWinBackOffer`s that\n   * the subscriber is eligible for for the given `PurchasesStoreProduct`.\n   * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   * The promise will also be rejected if configure has not been called yet.\n   */\n  getEligibleWinBackOffersForProduct(options: GetEligibleWinBackOffersForProductOptions): Promise<{\n    eligibleWinBackOffers: PurchasesWinBackOffer[];\n  }>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\n   * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\n   * given `PurchasesStorePackage`.\n   *\n   * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } An array of `PurchasesWinBackOffer`s that\n   * the subscriber is eligible for for the given `PurchasesStorePackage`.\n   * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   * The promise will also be rejected if configure has not been called yet.\n   */\n  getEligibleWinBackOffersForPackage(options: GetEligibleWinBackOffersForPackageOptions): Promise<{\n    eligibleWinBackOffers: PurchasesWinBackOffer[];\n  }>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.\n   *\n   * @returns {Promise<MakePurchaseResult>} A promise of an object containing\n   * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   */\n  purchaseProductWithWinBackOffer(\n    options: PurchaseProductWithWinBackOfferOptions,\n  ): Promise<MakePurchaseResult | undefined>;\n\n  /**\n   * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.\n   *\n   * @returns {Promise<MakePurchaseResult>} A promise of an object containing\n   * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\n   * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\n   * has not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\n   */\n  purchasePackageWithWinBackOffer(\n    options: PurchasePackageWithWinBackOfferOptions,\n  ): Promise<MakePurchaseResult | undefined>;\n\n  /**\n   * Invalidates the cache for customer information.\n   *\n   * Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state.\n   * Refer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on\n   * using the cache properly.\n   *\n   * This is useful for cases where customer information might have been updated outside the app, like if a\n   * promotional subscription is granted through the RevenueCat dashboard.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * invalidating the customer info cache.\n   */\n  invalidateCustomerInfoCache(): Promise<void>;\n\n  /** iOS 14.0+ only. Presents a code redemption sheet, useful for redeeming offer codes\n   * Refer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how\n   * to configure and use offer codes\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * presenting the code redemption sheet.\n   */\n  presentCodeRedemptionSheet(): Promise<void>;\n\n  /**\n   * Subscriber attributes are useful for storing additional, structured information on a user.\n   * Since attributes are writable using a public key they should not be used for\n   * managing secure or sensitive information such as subscription status, coins, etc.\n   *\n   * Key names starting with \"$\" are reserved names used by RevenueCat. For a full list of key\n   * restrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes\n   *\n   * @param attributes Map of attributes by key. Set the value as an empty string to delete an attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error\n   * setting the subscriber attributes.\n   */\n  setAttributes(attributes: { [key: string]: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the email address for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the email.\n   */\n  setEmail(options: { email: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the phone number for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the phone number.\n   */\n  setPhoneNumber(options: { phoneNumber: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the display name for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the display name.\n   */\n  setDisplayName(options: { displayName: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the push token for the user\n   *\n   * @param options null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the push token.\n   */\n  setPushToken(options: { pushToken: string | null }): Promise<void>;\n\n  /**\n   * Set this property to your proxy URL before configuring Purchases *only* if you've received a proxy key value\n   * from your RevenueCat contact.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the proxy url.\n   */\n  setProxyURL(options: { url: string }): Promise<void>;\n\n  /**\n   * Automatically collect subscriber attributes associated with the device identifiers.\n   * $idfa, $idfv, $ip on iOS\n   * $gpsAdId, $androidId, $ip on Android\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting collecting the device identifiers.\n   */\n  collectDeviceIdentifiers(): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Adjust ID for the user\n   * Required for the RevenueCat Adjust integration\n   *\n   * @param options Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting Adjust ID.\n   */\n  setAdjustID(options: { adjustID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the AppsFlyer ID for the user\n   * Required for the RevenueCat AppsFlyer integration\n   * @param options Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Appsflyer ID.\n   */\n  setAppsflyerID(options: { appsflyerID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Facebook SDK Anonymous ID for the user\n   * Recommended for the RevenueCat Facebook integration\n   *\n   * @param options Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Facebook Anonymous ID.\n   */\n  setFBAnonymousID(options: { fbAnonymousID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the mParticle ID for the user\n   * Recommended for the RevenueCat mParticle integration\n   *\n   * @param options Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Mparticle ID.\n   */\n  setMparticleID(options: { mparticleID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the CleverTap ID for the user\n   * Required for the RevenueCat CleverTap integration\n   *\n   * @param options CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the CleverTap ID.\n   */\n  setCleverTapID(options: { cleverTapID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Mixpanel Distinct ID for the user\n   * Required for the RevenueCat Mixpanel integration\n   *\n   * @param options Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Mixpanel Distinct ID.\n   */\n  setMixpanelDistinctID(options: { mixpanelDistinctID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Firebase App Instance ID for the user\n   * Required for the RevenueCat Firebase integration\n   *\n   * @param options Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Firebase App Instance ID.\n   */\n  setFirebaseAppInstanceID(options: { firebaseAppInstanceID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the OneSignal Player ID for the user\n   * Required for the RevenueCat OneSignal integration. Deprecated for OneSignal versions above v9.0.\n   *\n   * @param options OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the OneSignal ID.\n   */\n  setOnesignalID(options: { onesignalID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the OneSignal User ID for the user\n   * Required for the RevenueCat OneSignal integration with versions v11.0 and above.\n   *\n   * @param options OneSignal UserId to use in OneSignal integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the OneSignal user ID.\n   */\n  setOnesignalUserID(options: { onesignalUserID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the Airship Channel ID for the user\n   * Required for the RevenueCat Airship integration\n   *\n   * @param options Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the Airship Channel ID.\n   */\n  setAirshipChannelID(options: { airshipChannelID: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install media source for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the media source.\n   */\n  setMediaSource(options: { mediaSource: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install campaign for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the campaign.\n   */\n  setCampaign(options: { campaign: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad group for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting ad group.\n   */\n  setAdGroup(options: { adGroup: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the ad subscriber attribute.\n   */\n  setAd(options: { ad: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install keyword for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the keyword.\n   */\n  setKeyword(options: { keyword: string | null }): Promise<void>;\n\n  /**\n   * Subscriber attribute associated with the install ad creative for the user\n   *\n   * @param options Empty String or null will delete the subscriber attribute.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error\n   * setting the creative subscriber attribute.\n   */\n  setCreative(options: { creative: string | null }): Promise<void>;\n\n  /**\n   * Check if billing is supported for the current user (meaning IN-APP purchases are supported)\n   * and optionally, whether a list of specified feature types are supported.\n   *\n   * Note: Billing features are only relevant to Google Play Android users.\n   * For other stores and platforms, billing features won't be checked.\n   *\n   * @param options An array of feature types to check for support. Feature types must be one of\n   *       [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked.\n   * @returns promise with boolean response. True if billing is supported, false otherwise.\n   */\n  canMakePayments(options?: { features?: BILLING_FEATURE[] }): Promise<{ canMakePayments: boolean }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the active entitlement.\n   *\n   * If the request was unsuccessful, no active entitlements could be found for\n   * the user, or multiple active entitlements were found for the user,\n   * the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * Important: This method should only be used if your user can only have a single active entitlement at a given time.\n   * If a user could have more than one entitlement at a time, use `beginRefundRequestForEntitlement` instead.\n   *\n   * @returns Returns refundRequestStatus: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForActiveEntitlement(): Promise<{\n    refundRequestStatus: REFUND_REQUEST_STATUS;\n  }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the `entitlement`.\n   *\n   * If the request was unsuccessful, the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * @param options The entitlement to begin a refund request for.\n   * @returns Returns refundRequestStatus: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForEntitlement(options: {\n    entitlementInfo: PurchasesEntitlementInfo;\n  }): Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS }>;\n\n  /**\n   * iOS 15+ only. Presents a refund request sheet in the current window scene for\n   * the latest transaction associated with the `product`.\n   *\n   * If the request was unsuccessful, the promise will return an error.\n   * If called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n   *\n   * @param options The StoreProduct to begin a refund request for.\n   * @returns {Promise<REFUND_REQUEST_STATUS>} Returns a REFUND_REQUEST_STATUS: The status of the\n   *  refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED\n   */\n  beginRefundRequestForProduct(options: {\n    storeProduct: PurchasesStoreProduct;\n  }): Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS }>;\n\n  /**\n   * Shows in-app messages available from the App Store or Google Play. You need to disable messages from showing\n   * automatically using [PurchasesConfiguration.shouldShowInAppMessagesAutomatically].\n   *\n   * Note: In iOS, this requires version 16+. In older versions the promise will be resolved successfully\n   * immediately.\n   *\n   * @param options An array of message types that the stores can display inside your app. Values must be one of\n   *       [IN_APP_MESSAGE_TYPE]. By default, is undefined and all message types will be shown.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  showInAppMessages(options?: { messageTypes?: IN_APP_MESSAGE_TYPE[] }): Promise<void>;\n\n  /**\n   * Check if configure has finished and Purchases has been configured.\n   *\n   * @returns promise with boolean response\n   */\n  isConfigured(): Promise<{ isConfigured: boolean }>;\n\n  /**\n   * Override the preferred UI locale for RevenueCat UI components at runtime. This affects both API requests\n   * and UI rendering. If the locale changes, this will automatically clear the offerings cache and trigger\n   * a background refetch to get paywall templates with the correct localizations.\n   *\n   * @param options The locale string (e.g., \"es-ES\", \"en-US\") or null to use system default.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  overridePreferredUILocale(options: { locale: string | null }): Promise<void>;\n\n  /**\n   * Tracks an impression of a custom paywall. Use this to record when a user views your custom paywall\n   * so that RevenueCat can track paywall analytics.\n   *\n   * Call this method once per paywall display, ideally when the paywall first becomes visible to the user,\n   * not in callbacks that may fire multiple times for the same display.\n   *\n   * @param options Optional parameters for the impression. Include `paywallId` to identify which paywall was shown.\n   * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.\n   */\n  trackCustomPaywallImpression(options?: TrackCustomPaywallImpressionOptions): Promise<void>;\n}\n\n/**\n * Options for tracking a custom paywall impression.\n */\nexport interface TrackCustomPaywallImpressionOptions {\n  /** The identifier of the paywall that was shown. */\n  paywallId?: string | null;\n  /**\n   * An optional identifier for the offering associated with the custom paywall.\n   * If not provided, the SDK will use the current offering identifier from the cache.\n   */\n  offeringId?: string | null;\n}\n"]}

package/ios/Sources/RevenuecatPurchasesCapacitor/PurchasesPlugin.swift

@@ -90,7 +90,7 @@ public class PurchasesPlugin: CAPPlugin, PurchasesDelegate, CAPBridgedPlugin {
         CAPPluginMethod(name: "trackCustomPaywallImpression", returnType: CAPPluginReturnNone),
     ]
     private let platformFlavor = "capacitor"
-    private let platformVersion = "13.0.0"
+    private let platformVersion = "13.1.0"
 
     private let customerInfoKey = "customerInfo"
     private let transactionKey = "transaction"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenuecat/purchases-capacitor",
-  "version": "13.0.0",
+  "version": "13.1.0",
   "description": "Capacitor in-app purchases and subscriptions made easy. Support for iOS and Android.",
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",
@@ -88,6 +88,6 @@
     }
   },
   "dependencies": {
-    "@revenuecat/purchases-typescript-internal-esm": "18.0.0"
+    "@revenuecat/purchases-typescript-internal-esm": "18.4.0"
   }
 }