@revenuecat/purchases-capacitor 9.1.0 → 9.2.0

package/README.md

@@ -82,6 +82,10 @@ This plugin is based on [CapGo's Capacitor plugin](https://www.npmjs.com/package
 * [`isAnonymous()`](#isanonymous)
 * [`checkTrialOrIntroductoryPriceEligibility(...)`](#checktrialorintroductorypriceeligibility)
 * [`getPromotionalOffer(...)`](#getpromotionaloffer)
+* [`getEligibleWinBackOffersForProduct(...)`](#geteligiblewinbackoffersforproduct)
+* [`getEligibleWinBackOffersForPackage(...)`](#geteligiblewinbackoffersforpackage)
+* [`purchaseProductWithWinBackOffer(...)`](#purchaseproductwithwinbackoffer)
+* [`purchasePackageWithWinBackOffer(...)`](#purchasepackagewithwinbackoffer)
 * [`invalidateCustomerInfoCache()`](#invalidatecustomerinfocache)
 * [`presentCodeRedemptionSheet()`](#presentcoderedemptionsheet)
 * [`setAttributes(...)`](#setattributes)
@@ -575,6 +579,78 @@ iOS only. Use this function to retrieve the <a href="#purchasespromotionaloffer"
 --------------------
 
 
+### getEligibleWinBackOffersForProduct(...)
+
+```typescript
+getEligibleWinBackOffersForProduct(options: GetEligibleWinBackOffersForProductOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>
+```
+
+iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
+the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a
+given <a href="#purchasesstoreproduct">`PurchasesStoreProduct`</a>.
+
+| Param         | Type                                                                                                            |
+| ------------- | --------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#geteligiblewinbackoffersforproductoptions">GetEligibleWinBackOffersForProductOptions</a></code> |
+
+**Returns:** <code>Promise&lt;{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }&gt;</code>
+
+--------------------
+
+
+### getEligibleWinBackOffersForPackage(...)
+
+```typescript
+getEligibleWinBackOffersForPackage(options: GetEligibleWinBackOffersForPackageOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>
+```
+
+iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
+the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a
+given `PurchasesStorePackage`.
+
+| Param         | Type                                                                                                            |
+| ------------- | --------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#geteligiblewinbackoffersforpackageoptions">GetEligibleWinBackOffersForPackageOptions</a></code> |
+
+**Returns:** <code>Promise&lt;{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }&gt;</code>
+
+--------------------
+
+
+### purchaseProductWithWinBackOffer(...)
+
+```typescript
+purchaseProductWithWinBackOffer(options: PurchaseProductWithWinBackOfferOptions) => Promise<MakePurchaseResult | undefined>
+```
+
+iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.
+
+| Param         | Type                                                                                                      |
+| ------------- | --------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#purchaseproductwithwinbackofferoptions">PurchaseProductWithWinBackOfferOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#makepurchaseresult">MakePurchaseResult</a>&gt;</code>
+
+--------------------
+
+
+### purchasePackageWithWinBackOffer(...)
+
+```typescript
+purchasePackageWithWinBackOffer(options: PurchasePackageWithWinBackOfferOptions) => Promise<MakePurchaseResult | undefined>
+```
+
+iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.
+
+| Param         | Type                                                                                                      |
+| ------------- | --------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#purchasepackagewithwinbackofferoptions">PurchasePackageWithWinBackOfferOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#makepurchaseresult">MakePurchaseResult</a>&gt;</code>
+
+--------------------
+
+
 ### invalidateCustomerInfoCache()
 
 ```typescript
@@ -1479,6 +1555,41 @@ Holds the introductory price status
 | **`discount`** | <code><a href="#purchasesstoreproductdiscount">PurchasesStoreProductDiscount</a></code> | The <a href="#purchasesstoreproductdiscount">`PurchasesStoreProductDiscount`</a> to apply to the product. |
 
 
+#### PurchasesWinBackOffer
+
+Holds the information about a Win-Back Offer in Apple's App Store.
+
+
+#### GetEligibleWinBackOffersForProductOptions
+
+| Prop          | Type                                                                    | Description                                                |
+| ------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------- |
+| **`product`** | <code><a href="#purchasesstoreproduct">PurchasesStoreProduct</a></code> | The product you want to fetch eligible win-back offers for |
+
+
+#### GetEligibleWinBackOffersForPackageOptions
+
+| Prop           | Type                                                          | Description                                                |
+| -------------- | ------------------------------------------------------------- | ---------------------------------------------------------- |
+| **`aPackage`** | <code><a href="#purchasespackage">PurchasesPackage</a></code> | The package you want to fetch eligible win-back offers for |
+
+
+#### PurchaseProductWithWinBackOfferOptions
+
+| Prop               | Type                                                                    | Description                                                                                       |
+| ------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| **`product`**      | <code><a href="#purchasesstoreproduct">PurchasesStoreProduct</a></code> | The product you want to purchase                                                                  |
+| **`winBackOffer`** | <code><a href="#purchaseswinbackoffer">PurchasesWinBackOffer</a></code> | Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForProduct. |
+
+
+#### PurchasePackageWithWinBackOfferOptions
+
+| Prop               | Type                                                                    | Description                                                                                       |
+| ------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| **`aPackage`**     | <code><a href="#purchasespackage">PurchasesPackage</a></code>           | The package you want to purchase                                                                  |
+| **`winBackOffer`** | <code><a href="#purchaseswinbackoffer">PurchasesWinBackOffer</a></code> | Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForPackage. |
+
+
 ### Type Aliases
 
 

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

@@ -77,7 +77,7 @@ class PurchasesPlugin : Plugin() {
 
     companion object {
         private const val PLATFORM_NAME = "capacitor"
-        private const val PLUGIN_VERSION = "9.1.0"
+        private const val PLUGIN_VERSION = "9.2.0"
 
         private const val CUSTOMER_INFO_KEY = "customerInfo"
     }
@@ -367,6 +367,30 @@ class PurchasesPlugin : Plugin() {
         call.resolve()
     }
 
+    @PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
+    fun getEligibleWinBackOffersForProduct(call: PluginCall) {
+        logNotSupportedFunctionalityInAndroid("getEligibleWinBackOffersForProduct")
+        call.unavailable()
+    }
+
+    @PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
+    fun getEligibleWinBackOffersForPackage(call: PluginCall) {
+        logNotSupportedFunctionalityInAndroid("getEligibleWinBackOffersForPackage")
+        call.unavailable()
+    }
+
+    @PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
+    fun purchaseProductWithWinBackOffer(call: PluginCall) {
+        logNotSupportedFunctionalityInAndroid("purchaseProductWithWinBackOffer")
+        call.unavailable()
+    }
+
+    @PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
+    fun purchasePackageWithWinBackOffer(call: PluginCall) {
+        logNotSupportedFunctionalityInAndroid("purchasePackageWithWinBackOffer")
+        call.unavailable()
+    }
+
     @PluginMethod(returnType = PluginMethod.RETURN_NONE)
     fun invalidateCustomerInfoCache(call: PluginCall) {
         if (rejectIfNotConfigured(call)) return

package/dist/docs.json

@@ -642,6 +642,102 @@
         ],
         "slug": "getpromotionaloffer"
       },
+      {
+        "name": "getEligibleWinBackOffersForProduct",
+        "signature": "(options: GetEligibleWinBackOffersForProductOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetEligibleWinBackOffersForProductOptions"
+          }
+        ],
+        "returns": "Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A dictionary containing an array of `PurchasesWinBackOffer`s that\nthe subscriber is eligible for for the given `PurchasesStoreProduct`.\nThe promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\nThe promise will also be rejected if configure has not been called yet."
+          }
+        ],
+        "docs": "iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\nthe eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\ngiven `PurchasesStoreProduct`.",
+        "complexTypes": [
+          "PurchasesWinBackOffer",
+          "GetEligibleWinBackOffersForProductOptions"
+        ],
+        "slug": "geteligiblewinbackoffersforproduct"
+      },
+      {
+        "name": "getEligibleWinBackOffersForPackage",
+        "signature": "(options: GetEligibleWinBackOffersForPackageOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetEligibleWinBackOffersForPackageOptions"
+          }
+        ],
+        "returns": "Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "An array of `PurchasesWinBackOffer`s that\nthe subscriber is eligible for for the given `PurchasesStorePackage`.\nThe promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.\nThe promise will also be rejected if configure has not been called yet."
+          }
+        ],
+        "docs": "iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve\nthe eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a\ngiven `PurchasesStorePackage`.",
+        "complexTypes": [
+          "PurchasesWinBackOffer",
+          "GetEligibleWinBackOffersForPackageOptions"
+        ],
+        "slug": "geteligiblewinbackoffersforpackage"
+      },
+      {
+        "name": "purchaseProductWithWinBackOffer",
+        "signature": "(options: PurchaseProductWithWinBackOfferOptions) => Promise<MakePurchaseResult | undefined>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PurchaseProductWithWinBackOfferOptions"
+          }
+        ],
+        "returns": "Promise<MakePurchaseResult | undefined>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise of an object containing\na customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\nuser cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\nhas not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1."
+          }
+        ],
+        "docs": "iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.",
+        "complexTypes": [
+          "MakePurchaseResult",
+          "PurchaseProductWithWinBackOfferOptions"
+        ],
+        "slug": "purchaseproductwithwinbackoffer"
+      },
+      {
+        "name": "purchasePackageWithWinBackOffer",
+        "signature": "(options: PurchasePackageWithWinBackOfferOptions) => Promise<MakePurchaseResult | undefined>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PurchasePackageWithWinBackOfferOptions"
+          }
+        ],
+        "returns": "Promise<MakePurchaseResult | undefined>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise of an object containing\na customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the\nuser cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\nhas not been called yet or if called in an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1."
+          }
+        ],
+        "docs": "iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.",
+        "complexTypes": [
+          "MakePurchaseResult",
+          "PurchasePackageWithWinBackOfferOptions"
+        ],
+        "slug": "purchasepackagewithwinbackoffer"
+      },
       {
         "name": "invalidateCustomerInfoCache",
         "signature": "() => Promise<void>",
@@ -3029,6 +3125,108 @@
           "type": "PurchasesStoreProductDiscount"
         }
       ]
+    },
+    {
+      "name": "PurchasesWinBackOffer",
+      "slug": "purchaseswinbackoffer",
+      "docs": "Holds the information about a Win-Back Offer in Apple's App Store.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": []
+    },
+    {
+      "name": "GetEligibleWinBackOffersForProductOptions",
+      "slug": "geteligiblewinbackoffersforproductoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "product",
+          "tags": [],
+          "docs": "The product you want to fetch eligible win-back offers for",
+          "complexTypes": [
+            "PurchasesStoreProduct"
+          ],
+          "type": "PurchasesStoreProduct"
+        }
+      ]
+    },
+    {
+      "name": "GetEligibleWinBackOffersForPackageOptions",
+      "slug": "geteligiblewinbackoffersforpackageoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "aPackage",
+          "tags": [],
+          "docs": "The package you want to fetch eligible win-back offers for",
+          "complexTypes": [
+            "PurchasesPackage"
+          ],
+          "type": "PurchasesPackage"
+        }
+      ]
+    },
+    {
+      "name": "PurchaseProductWithWinBackOfferOptions",
+      "slug": "purchaseproductwithwinbackofferoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "product",
+          "tags": [],
+          "docs": "The product you want to purchase",
+          "complexTypes": [
+            "PurchasesStoreProduct"
+          ],
+          "type": "PurchasesStoreProduct"
+        },
+        {
+          "name": "winBackOffer",
+          "tags": [],
+          "docs": "Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForProduct.",
+          "complexTypes": [
+            "PurchasesWinBackOffer"
+          ],
+          "type": "PurchasesWinBackOffer"
+        }
+      ]
+    },
+    {
+      "name": "PurchasePackageWithWinBackOfferOptions",
+      "slug": "purchasepackagewithwinbackofferoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "aPackage",
+          "tags": [],
+          "docs": "The package you want to purchase",
+          "complexTypes": [
+            "PurchasesPackage"
+          ],
+          "type": "PurchasesPackage"
+        },
+        {
+          "name": "winBackOffer",
+          "tags": [],
+          "docs": "Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForPackage.",
+          "complexTypes": [
+            "PurchasesWinBackOffer"
+          ],
+          "type": "PurchasesWinBackOffer"
+        }
+      ]
     }
   ],
   "enums": [

package/dist/esm/definitions.d.ts

@@ -1,4 +1,4 @@
-import type { CustomerInfo, CustomerInfoUpdateListener, GoogleProductChangeInfo, IntroEligibility, LogHandler, LogInResult, MakePurchaseResult, PurchasesConfiguration, PurchasesEntitlementInfo, PurchasesOfferings, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesStoreProductDiscount, SubscriptionOption, BILLING_FEATURE, LOG_LEVEL, PRODUCT_CATEGORY, REFUND_REQUEST_STATUS, IN_APP_MESSAGE_TYPE, PurchasesOffering, PurchasesStoreTransaction } from '@revenuecat/purchases-typescript-internal-esm';
+import type { CustomerInfo, CustomerInfoUpdateListener, GoogleProductChangeInfo, IntroEligibility, LogHandler, LogInResult, MakePurchaseResult, PurchasesConfiguration, PurchasesEntitlementInfo, PurchasesOfferings, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesStoreProductDiscount, SubscriptionOption, BILLING_FEATURE, LOG_LEVEL, PRODUCT_CATEGORY, REFUND_REQUEST_STATUS, IN_APP_MESSAGE_TYPE, PurchasesOffering, PurchasesStoreTransaction, PurchasesWinBackOffer } from '@revenuecat/purchases-typescript-internal-esm';
 export * from '@revenuecat/purchases-typescript-internal-esm';
 export declare type PurchasesCallbackId = string;
 export interface GetProductOptions {
@@ -38,6 +38,38 @@ export interface PurchaseDiscountedProductOptions {
      */
     discount: PurchasesPromotionalOffer;
 }
+export interface GetEligibleWinBackOffersForProductOptions {
+    /**
+     * The product you want to fetch eligible win-back offers for
+     */
+    product: PurchasesStoreProduct;
+}
+export interface GetEligibleWinBackOffersForPackageOptions {
+    /**
+     * The package you want to fetch eligible win-back offers for
+     */
+    aPackage: PurchasesPackage;
+}
+export interface PurchaseProductWithWinBackOfferOptions {
+    /**
+     * The product you want to purchase
+     */
+    product: PurchasesStoreProduct;
+    /**
+     * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForProduct.
+     */
+    winBackOffer: PurchasesWinBackOffer;
+}
+export interface PurchasePackageWithWinBackOfferOptions {
+    /**
+     * The package you want to purchase
+     */
+    aPackage: PurchasesPackage;
+    /**
+     * Win-back offer to apply to this purchase. Retrieve this using getEligibleWinBackOffersForPackage.
+     */
+    winBackOffer: PurchasesWinBackOffer;
+}
 export interface PurchasePackageOptions {
     /**
      * The Package you wish to purchase. You can get the Packages by calling getOfferings
@@ -378,6 +410,50 @@ export interface PurchasesPlugin {
      * called yet or if there's an error getting the payment discount.
      */
     getPromotionalOffer(options: GetPromotionalOfferOptions): Promise<PurchasesPromotionalOffer | undefined>;
+    /**
+     * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
+     * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a
+     * given `PurchasesStoreProduct`.
+     *
+     * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } A dictionary containing an array of `PurchasesWinBackOffer`s that
+     * the subscriber is eligible for for the given `PurchasesStoreProduct`.
+     * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.
+     * The promise will also be rejected if configure has not been called yet.
+     */
+    getEligibleWinBackOffersForProduct(options: GetEligibleWinBackOffersForProductOptions): Promise<{
+        eligibleWinBackOffers: PurchasesWinBackOffer[];
+    }>;
+    /**
+     * iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
+     * the eligible `PurchasesWinBackOffer`s that a subscriber is eligible for for a
+     * given `PurchasesStorePackage`.
+     *
+     * @returns { Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[] }> } An array of `PurchasesWinBackOffer`s that
+     * the subscriber is eligible for for the given `PurchasesStorePackage`.
+     * The promise will be rejected if called on an unsupported platform (Android or iOS < 18), or if called on iOS 18+ with StoreKit 1.
+     * The promise will also be rejected if configure has not been called yet.
+     */
+    getEligibleWinBackOffersForPackage(options: GetEligibleWinBackOffersForPackageOptions): Promise<{
+        eligibleWinBackOffers: PurchasesWinBackOffer[];
+    }>;
+    /**
+     * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.
+     *
+     * @returns {Promise<MakePurchaseResult>} A promise of an object containing
+     * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the
+     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure
+     * 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.
+     */
+    purchaseProductWithWinBackOffer(options: PurchaseProductWithWinBackOfferOptions): Promise<MakePurchaseResult | undefined>;
+    /**
+     * iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.
+     *
+     * @returns {Promise<MakePurchaseResult>} A promise of an object containing
+     * a customer info object, a transaction, and a product identifier. Rejections return an error code, a boolean indicating if the
+     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure
+     * 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.
+     */
+    purchasePackageWithWinBackOffer(options: PurchasePackageWithWinBackOfferOptions): Promise<MakePurchaseResult | undefined>;
     /**
      * Invalidates the cache for customer information.
      *