@revenuecat/purchases-capacitor 8.0.0-beta.4 → 9.0.0

package/dist/docs.json

@@ -49,31 +49,6 @@
         "complexTypes": [],
         "slug": "setmockwebresults"
       },
-      {
-        "name": "setFinishTransactions",
-        "signature": "(options: { finishTransactions: boolean; }) => Promise<void>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "Set finishTransactions to false if you aren't using Purchases SDK to\nmake the purchase",
-            "type": "{ finishTransactions: boolean; }"
-          }
-        ],
-        "returns": "Promise<void>",
-        "tags": [
-          {
-            "name": "param",
-            "text": "options Set finishTransactions to false if you aren't using Purchases SDK to\nmake the purchase"
-          },
-          {
-            "name": "returns",
-            "text": "The promise will be rejected if configure has not been called yet."
-          }
-        ],
-        "docs": "",
-        "complexTypes": [],
-        "slug": "setfinishtransactions"
-      },
       {
         "name": "setSimulatesAskToBuyInSandbox",
         "signature": "(options: { simulatesAskToBuyInSandbox: boolean; }) => Promise<void>",
@@ -368,6 +343,29 @@
         ],
         "slug": "restorepurchases"
       },
+      {
+        "name": "recordPurchase",
+        "signature": "(options: { productID: string; }) => Promise<{ transaction: PurchasesStoreTransaction; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The productID that was purchased that needs to be synced with RevenueCat's backend.",
+            "type": "{ productID: string; }"
+          }
+        ],
+        "returns": "Promise<{ transaction: PurchasesStoreTransaction; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The productID that was purchased that needs to be synced with RevenueCat's backend."
+          }
+        ],
+        "docs": "Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use\nRevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.\n\nYou only need to use this method with *new* purchases. Subscription updates are observed automatically.",
+        "complexTypes": [
+          "PurchasesStoreTransaction"
+        ],
+        "slug": "recordpurchase"
+      },
       {
         "name": "getAppUserID",
         "signature": "() => Promise<{ appUserID: string; }>",
@@ -516,22 +514,49 @@
           {
             "name": "options",
             "docs": "",
-            "type": "SyncObserverModeAmazonPurchaseOptions"
+            "type": "SyncAmazonPurchaseOptions"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
+          {
+            "name": "deprecated",
+            "text": "- Use syncAmazonPurchase instead\nThis method will send a purchase to the RevenueCat backend. This function should only be called if you are\nin Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n\nThe receipt IDs are cached if successfully posted, so they are not posted more than once."
+          },
           {
             "name": "returns",
             "text": "The promise will be rejected if configure has not been called yet or if there's an error\nsyncing purchases."
           }
         ],
-        "docs": "This method will send a purchase to the RevenueCat backend. This function should only be called if you are\nin Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n\nThe receipt IDs are cached if successfully posted, so they are not posted more than once.",
+        "docs": "",
         "complexTypes": [
           "SyncObserverModeAmazonPurchaseOptions"
         ],
         "slug": "syncobservermodeamazonpurchase"
       },
+      {
+        "name": "syncAmazonPurchase",
+        "signature": "(options: SyncAmazonPurchaseOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SyncAmazonPurchaseOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The promise will be rejected if configure has not been called yet or if there's an error\nsyncing purchases."
+          }
+        ],
+        "docs": "This method will send a purchase to the RevenueCat backend. This function should only be called if you are\nin Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n\nThe receipt IDs are cached if successfully posted, so they are not posted more than once.",
+        "complexTypes": [
+          "SyncAmazonPurchaseOptions"
+        ],
+        "slug": "syncamazonpurchase"
+      },
       {
         "name": "enableAdServicesAttributionTokenCollection",
         "signature": "() => Promise<void>",
@@ -1380,11 +1405,13 @@
           "type": "string | null | undefined"
         },
         {
-          "name": "observerMode",
+          "name": "purchasesAreCompletedBy",
           "tags": [],
-          "docs": "An optional boolean. Set this to TRUE if you have your own IAP implementation and\nwant to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have\nto acknowledge the purchases yourself.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "docs": "Set this to MY_APP and provide a STOREKIT_VERSION if you have your own IAP implementation and\nwant to only use RevenueCat's backend. Defaults to PURCHASES_ARE_COMPLETED_BY_TYPE.REVENUECAT.\n\nIf you are on Android and setting this to MY_APP, will have to acknowledge the purchases yourself.\nIf your app is only on Android, you may specify any StoreKit version, as it is ignored by the\nAndroid SDK.",
+          "complexTypes": [
+            "PurchasesAreCompletedBy"
+          ],
+          "type": "PurchasesAreCompletedBy"
         },
         {
           "name": "userDefaultsSuiteName",
@@ -1394,16 +1421,13 @@
           "type": "string | undefined"
         },
         {
-          "name": "usesStoreKit2IfAvailable",
-          "tags": [
-            {
-              "text": "RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has\nproven to be more performant than StoreKit 2.\nWe're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail\nthat you shouldn't need to care about.\nWe recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.",
-              "name": "deprecated"
-            }
+          "name": "storeKitVersion",
+          "tags": [],
+          "docs": "iOS-only, will be ignored for Android.\n\nBy selecting the DEFAULT value, RevenueCat will automatically select the most appropriate StoreKit version\nfor the app's runtime environment.\n\n- Warning: Make sure you have an In-App Purchase Key configured in your app.\nPlease see https://rev.cat/in-app-purchase-key-configuration for more info.\n\n- Note: StoreKit 2 is only available on iOS 16+. StoreKit 1 will be used for previous iOS versions\nregardless of this setting.",
+          "complexTypes": [
+            "STOREKIT_VERSION"
           ],
-          "docs": "iOS-only, will be ignored for Android.\nSet this to TRUE to enable StoreKit2.\nDefault is FALSE.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "STOREKIT_VERSION"
         },
         {
           "name": "useAmazon",
@@ -1427,6 +1451,13 @@
             "ENTITLEMENT_VERIFICATION_MODE"
           ],
           "type": "ENTITLEMENT_VERIFICATION_MODE"
+        },
+        {
+          "name": "pendingTransactionsForPrepaidPlansEnabled",
+          "tags": [],
+          "docs": "Enable this setting if you want to allow pending purchases for prepaid subscriptions (only supported\nin Google Play). Note that entitlements are not granted until payment is done.\nDisabled by default.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -2009,6 +2040,48 @@
           "complexTypes": [],
           "type": "string"
         },
+        {
+          "name": "pricePerWeek",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct in a weekly recurrence.\nThis means that, for example, if the period is monthly, the price will be\ndivided by 4. Note that this value may be an approximation. For Google subscriptions,\nthis value will use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "pricePerMonth",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct in a monthly recurrence.\nThis means that, for example, if the period is annual, the price will be\ndivided by 12. Note that this value may be an approximation. For Google subscriptions,\nthis value will use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "pricePerYear",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct in a yearly recurrence.\nThis means that, for example, if the period is monthly, the price will be multiplied by\n12. Note that this value may be an approximation. For Google subscriptions, this value\nwill use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "pricePerWeekString",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current\nlocale in a weekly recurrence. This means that, for example, if the period is monthly,\nthe price will be divided by 4. It uses a currency formatter to format the price in the\ngiven locale. Note that this value may be an approximation. For Google subscriptions,\nthis value will use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "pricePerMonthString",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current\nlocale in a monthly recurrence. This means that, for example, if the period is annual,\nthe price will be divided by 12. It uses a currency formatter to format the price in the\ngiven locale. Note that this value may be an approximation. For Google subscriptions,\nthis value will use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "pricePerYearString",
+          "tags": [],
+          "docs": "Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current\nlocale in a yearly recurrence. This means that, for example, if the period is monthly,\nthe price will be multiplied by 12. It uses a currency formatter to format the price in the\ngiven locale. Note that this value may be an approximation. For Google subscriptions,\nthis value will use the basePlan to calculate the value.",
+          "complexTypes": [],
+          "type": "string"
+        },
         {
           "name": "currencyCode",
           "tags": [],
@@ -2335,6 +2408,15 @@
             "PresentedOfferingContext"
           ],
           "type": "PresentedOfferingContext | null"
+        },
+        {
+          "name": "installmentsInfo",
+          "tags": [],
+          "docs": "For installment subscriptions, the details of the installment plan the customer commits to.\nNull for non-installment subscriptions.\nInstallment plans are only available for Google Play subscriptions.",
+          "complexTypes": [
+            "InstallmentsInfo"
+          ],
+          "type": "InstallmentsInfo | null"
         }
       ]
     },
@@ -2527,6 +2609,33 @@
         }
       ]
     },
+    {
+      "name": "InstallmentsInfo",
+      "slug": "installmentsinfo",
+      "docs": "Type containing information of installment subscriptions. Currently only supported in Google Play.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "commitmentPaymentsCount",
+          "tags": [],
+          "docs": "Number of payments the customer commits to in order to purchase the subscription.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "renewalCommitmentPaymentsCount",
+          "tags": [],
+          "docs": "After the commitment payments are complete, the number of payments the user commits to upon a renewal.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
     {
       "name": "GetProductOptions",
       "slug": "getproductoptions",
@@ -2815,8 +2924,8 @@
       ]
     },
     {
-      "name": "SyncObserverModeAmazonPurchaseOptions",
-      "slug": "syncobservermodeamazonpurchaseoptions",
+      "name": "SyncAmazonPurchaseOptions",
+      "slug": "syncamazonpurchaseoptions",
       "docs": "",
       "tags": [],
       "methods": [],
@@ -2916,6 +3025,48 @@
     }
   ],
   "enums": [
+    {
+      "name": "PURCHASES_ARE_COMPLETED_BY_TYPE",
+      "slug": "purchases_are_completed_by_type",
+      "members": [
+        {
+          "name": "MY_APP",
+          "value": "\"MY_APP\"",
+          "tags": [],
+          "docs": "RevenueCat will **not** automatically acknowledge any purchases. You will have to do so manually.\n\n**Note:** failing to acknowledge a purchase within 3 days will lead to Google Play automatically issuing a\nrefund to the user.\n\nFor more info, see [revenuecat.com](https://docs.revenuecat.com/docs/observer-mode#option-2-client-side)."
+        },
+        {
+          "name": "REVENUECAT",
+          "value": "\"REVENUECAT\"",
+          "tags": [],
+          "docs": "RevenueCat will automatically acknowledge verified purchases. No action is required by you."
+        }
+      ]
+    },
+    {
+      "name": "STOREKIT_VERSION",
+      "slug": "storekit_version",
+      "members": [
+        {
+          "name": "STOREKIT_1",
+          "value": "\"STOREKIT_1\"",
+          "tags": [],
+          "docs": "Always use StoreKit 1."
+        },
+        {
+          "name": "STOREKIT_2",
+          "value": "\"STOREKIT_2\"",
+          "tags": [],
+          "docs": "Always use StoreKit 2 (StoreKit 1 will be used if StoreKit 2 is not available in the current device.)\n- Warning: Make sure you have an In-App Purchase Key configured in your app.\nPlease see https://rev.cat/in-app-purchase-key-configuration for more info."
+        },
+        {
+          "name": "DEFAULT",
+          "value": "\"DEFAULT\"",
+          "tags": [],
+          "docs": "Let RevenueCat use the most appropiate version of StoreKit"
+        }
+      ]
+    },
     {
       "name": "ENTITLEMENT_VERIFICATION_MODE",
       "slug": "entitlement_verification_mode",
@@ -3202,6 +3353,12 @@
           "tags": [],
           "docs": "Replacement takes effect immediately, and the new price will be charged on\nnext recurrence time. The billing cycle stays the same."
         },
+        {
+          "name": "DEFERRED",
+          "value": "6",
+          "tags": [],
+          "docs": "Replacement takes effect when the old plan expires, and the new price will\nbe charged at the same time."
+        },
         {
           "name": "IMMEDIATE_AND_CHARGE_FULL_PRICE",
           "value": "5",
@@ -3362,6 +3519,39 @@
     }
   ],
   "typeAliases": [
+    {
+      "name": "PurchasesAreCompletedBy",
+      "slug": "purchasesarecompletedby",
+      "docs": "Allows you to specify whether you want RevenueCat to complete your app's purchases\nor if your app will do so.\n\nYou can configure RevenueCat to complete your purchases like so:\n```typescript\nPurchases.configure({\n apiKey: \"123\",\n purchasesAreCompletedBy: PURCHASES_ARE_COMPLETED_BY.REVENUECAT,\n});\n```\n\nYou can specify that purchase are completed by your app like so:\n```typescript\nPurchases.configure({\n apiKey: \"123\",\n purchasesAreCompletedBy: {\n   type: PURCHASES_ARE_COMPLETED_BY.MY_APP,\n   storeKitVersion: STOREKIT_VERSION.STOREKIT_1\n },\n});\n```",
+      "types": [
+        {
+          "text": "PURCHASES_ARE_COMPLETED_BY_TYPE.REVENUECAT",
+          "complexTypes": [
+            "PURCHASES_ARE_COMPLETED_BY_TYPE"
+          ]
+        },
+        {
+          "text": "PurchasesAreCompletedByMyApp",
+          "complexTypes": [
+            "PurchasesAreCompletedByMyApp"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "PurchasesAreCompletedByMyApp",
+      "slug": "purchasesarecompletedbymyapp",
+      "docs": "Configuration option that specifies that your app will complete purchases.",
+      "types": [
+        {
+          "text": "{\n    type: PURCHASES_ARE_COMPLETED_BY_TYPE.MY_APP;\n    /**\n     * The version of StoreKit that your app is using to make purchases. This value is ignored\n     * on Android, so if your app is Android-only, you may provide any value.\n     */\n    storeKitVersion: STOREKIT_VERSION;\n}",
+          "complexTypes": [
+            "PURCHASES_ARE_COMPLETED_BY_TYPE",
+            "STOREKIT_VERSION"
+          ]
+        }
+      ]
+    },
     {
       "name": "CustomerInfoUpdateListener",
       "slug": "customerinfoupdatelistener",
@@ -3412,6 +3602,19 @@
           ]
         }
       ]
+    },
+    {
+      "name": "SyncObserverModeAmazonPurchaseOptions",
+      "slug": "syncobservermodeamazonpurchaseoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "SyncAmazonPurchaseOptions",
+          "complexTypes": [
+            "SyncAmazonPurchaseOptions"
+          ]
+        }
+      ]
     }
   ],
   "pluginConfigs": []

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 } 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 } from '@revenuecat/purchases-typescript-internal-esm';
 export * from '@revenuecat/purchases-typescript-internal-esm';
 export declare type PurchasesCallbackId = string;
 export interface GetProductOptions {
@@ -82,7 +82,7 @@ export interface PurchaseDiscountedPackageOptions {
      */
     discount: PurchasesPromotionalOffer;
 }
-export interface SyncObserverModeAmazonPurchaseOptions {
+export interface SyncAmazonPurchaseOptions {
     /**
      * Product ID associated to the purchase.
      */
@@ -104,6 +104,10 @@ export interface SyncObserverModeAmazonPurchaseOptions {
      */
     price?: number | null;
 }
+/**
+ * @deprecated - Use SyncAmazonPurchaseOptions instead
+ */
+export declare type SyncObserverModeAmazonPurchaseOptions = SyncAmazonPurchaseOptions;
 export interface GetPromotionalOfferOptions {
     /**
      * The `PurchasesStoreProduct` the user intends to purchase.
@@ -129,14 +133,6 @@ export interface PurchasesPlugin {
     setMockWebResults(options: {
         shouldMockWebResults: boolean;
     }): Promise<void>;
-    /**
-     * @param options Set finishTransactions to false if you aren't using Purchases SDK to
-     * make the purchase
-     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
-     */
-    setFinishTransactions(options: {
-        finishTransactions: boolean;
-    }): Promise<void>;
     /**
      * iOS only.
      * @param options Set this property to true *only* when testing the ask-to-buy / SCA
@@ -245,6 +241,18 @@ export interface PurchasesPlugin {
     restorePurchases(): Promise<{
         customerInfo: CustomerInfo;
     }>;
+    /**
+     * Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use
+     * RevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.
+     *
+     * You only need to use this method with *new* purchases. Subscription updates are observed automatically.
+     * @param options The productID that was purchased that needs to be synced with RevenueCat's backend.
+     */
+    recordPurchase(options: {
+        productID: string;
+    }): Promise<{
+        transaction: PurchasesStoreTransaction;
+    }>;
     /**
      * Get the appUserID
      * @returns {Promise<string>} The app user id in a promise
@@ -307,6 +315,7 @@ export interface PurchasesPlugin {
      */
     syncPurchases(): Promise<void>;
     /**
+     * @deprecated - Use syncAmazonPurchase instead
      * This method will send a purchase to the RevenueCat backend. This function should only be called if you are
      * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.
      *
@@ -316,6 +325,16 @@ export interface PurchasesPlugin {
      * syncing purchases.
      */
     syncObserverModeAmazonPurchase(options: SyncObserverModeAmazonPurchaseOptions): Promise<void>;
+    /**
+     * This method will send a purchase to the RevenueCat backend. This function should only be called if you are
+     * in Amazon observer mode or performing a client side migration of your current users to RevenueCat.
+     *
+     * The receipt IDs are cached if successfully posted, so they are not posted more than once.
+     *
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
+     * syncing purchases.
+     */
+    syncAmazonPurchase(options: SyncAmazonPurchaseOptions): Promise<void>;
     /**
      * Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default. Supported in iOS 14.3+ only
      * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.