@revenuecat/purchases-typescript-internal-esm 11.1.1 → 12.0.0

package/dist/enums.d.ts

@@ -101,15 +101,15 @@ export declare enum ENTITLEMENT_VERIFICATION_MODE {
      */
     DISABLED = "DISABLED",
     /**
-       * Enable entitlement verification.
-       *
-       * If verification fails, this will be indicated with [VerificationResult.FAILED] in
-       * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
-       * (i.e. Entitlements will still be granted).
-       *
-       * This can be useful if you want to handle verification failures to display an error/warning to the user
-       * or to track this situation but still grant access.
-       */
+     * Enable entitlement verification.
+     *
+     * If verification fails, this will be indicated with [VerificationResult.FAILED] in
+     * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
+     * (i.e. Entitlements will still be granted).
+     *
+     * This can be useful if you want to handle verification failures to display an error/warning to the user
+     * or to track this situation but still grant access.
+     */
     INFORMATIONAL = "INFORMATIONAL"
 }
 /**
@@ -172,3 +172,42 @@ export declare enum PAYWALL_RESULT {
      */
     RESTORED = "RESTORED"
 }
+/**
+ * Defines which version of StoreKit may be used
+ * @public
+ */
+export declare enum STOREKIT_VERSION {
+    /**
+     * Always use StoreKit 1.
+     */
+    STOREKIT_1 = "STOREKIT_1",
+    /**
+     * Always use StoreKit 2 (StoreKit 1 will be used if StoreKit 2 is not available in the current device.)
+     * - Warning: Make sure you have an In-App Purchase Key configured in your app.
+     * Please see https://rev.cat/in-app-purchase-key-configuration for more info.
+     */
+    STOREKIT_2 = "STOREKIT_2",
+    /**
+     * Let RevenueCat use the most appropiate version of StoreKit
+     */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Modes for completing the purchase process.
+ * @public
+ */
+export declare enum PURCHASES_ARE_COMPLETED_BY {
+    /**
+     * RevenueCat will **not** automatically acknowledge any purchases. You will have to do so manually.
+     *
+     * **Note:** failing to acknowledge a purchase within 3 days will lead to Google Play automatically issuing a
+     * refund to the user.
+     *
+     * For more info, see [revenuecat.com](https://docs.revenuecat.com/docs/observer-mode#option-2-client-side).
+     */
+    MY_APP = "MY_APP",
+    /**
+     * RevenueCat will automatically acknowledge verified purchases. No action is required by you.
+     */
+    REVENUECAT = "REVENUECAT"
+}

package/dist/enums.js

@@ -108,15 +108,15 @@ export var ENTITLEMENT_VERIFICATION_MODE;
      */
     ENTITLEMENT_VERIFICATION_MODE["DISABLED"] = "DISABLED";
     /**
-       * Enable entitlement verification.
-       *
-       * If verification fails, this will be indicated with [VerificationResult.FAILED] in
-       * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
-       * (i.e. Entitlements will still be granted).
-       *
-       * This can be useful if you want to handle verification failures to display an error/warning to the user
-       * or to track this situation but still grant access.
-       */
+     * Enable entitlement verification.
+     *
+     * If verification fails, this will be indicated with [VerificationResult.FAILED] in
+     * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
+     * (i.e. Entitlements will still be granted).
+     *
+     * This can be useful if you want to handle verification failures to display an error/warning to the user
+     * or to track this situation but still grant access.
+     */
     ENTITLEMENT_VERIFICATION_MODE["INFORMATIONAL"] = "INFORMATIONAL";
     // Add ENFORCED mode once we're ready to ship it.
     // ENFORCED = "ENFORCED"
@@ -183,3 +183,44 @@ export var PAYWALL_RESULT;
      */
     PAYWALL_RESULT["RESTORED"] = "RESTORED";
 })(PAYWALL_RESULT || (PAYWALL_RESULT = {}));
+/**
+ * Defines which version of StoreKit may be used
+ * @public
+ */
+export var STOREKIT_VERSION;
+(function (STOREKIT_VERSION) {
+    /**
+     * Always use StoreKit 1.
+     */
+    STOREKIT_VERSION["STOREKIT_1"] = "STOREKIT_1";
+    /**
+     * Always use StoreKit 2 (StoreKit 1 will be used if StoreKit 2 is not available in the current device.)
+     * - Warning: Make sure you have an In-App Purchase Key configured in your app.
+     * Please see https://rev.cat/in-app-purchase-key-configuration for more info.
+     */
+    STOREKIT_VERSION["STOREKIT_2"] = "STOREKIT_2";
+    /**
+     * Let RevenueCat use the most appropiate version of StoreKit
+     */
+    STOREKIT_VERSION["DEFAULT"] = "DEFAULT";
+})(STOREKIT_VERSION || (STOREKIT_VERSION = {}));
+/**
+ * Modes for completing the purchase process.
+ * @public
+ */
+export var PURCHASES_ARE_COMPLETED_BY;
+(function (PURCHASES_ARE_COMPLETED_BY) {
+    /**
+     * RevenueCat will **not** automatically acknowledge any purchases. You will have to do so manually.
+     *
+     * **Note:** failing to acknowledge a purchase within 3 days will lead to Google Play automatically issuing a
+     * refund to the user.
+     *
+     * For more info, see [revenuecat.com](https://docs.revenuecat.com/docs/observer-mode#option-2-client-side).
+     */
+    PURCHASES_ARE_COMPLETED_BY["MY_APP"] = "MY_APP";
+    /**
+     * RevenueCat will automatically acknowledge verified purchases. No action is required by you.
+     */
+    PURCHASES_ARE_COMPLETED_BY["REVENUECAT"] = "REVENUECAT";
+})(PURCHASES_ARE_COMPLETED_BY || (PURCHASES_ARE_COMPLETED_BY = {}));

package/dist/offerings.d.ts

@@ -89,6 +89,51 @@ export interface PurchasesStoreProduct {
      * Contains the formatted price value of defaultOption for Google Play.
      */
     readonly priceString: string;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct in a weekly recurrence.
+     * This means that, for example, if the period is monthly, the price will be
+     * divided by 4. Note that this value may be an approximation. For Google subscriptions,
+     * this value will use the basePlan to calculate the value.
+     */
+    readonly pricePerWeek: number;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct in a monthly recurrence.
+     * This means that, for example, if the period is annual, the price will be
+     * divided by 12. Note that this value may be an approximation. For Google subscriptions,
+     * this value will use the basePlan to calculate the value.
+     */
+    readonly pricePerMonth: number;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct in a yearly recurrence.
+     * This means that, for example, if the period is monthly, the price will be multiplied by
+     * 12. Note that this value may be an approximation. For Google subscriptions, this value
+     * will use the basePlan to calculate the value.
+     */
+    readonly pricePerYear: number;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current
+     * locale in a weekly recurrence. This means that, for example, if the period is monthly,
+     * the price will be divided by 4. It uses a currency formatter to format the price in the
+     * given locale. Note that this value may be an approximation. For Google subscriptions,
+     * this value will use the basePlan to calculate the value.
+     */
+    readonly pricePerWeekString: string;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current
+     * locale in a monthly recurrence. This means that, for example, if the period is annual,
+     * the price will be divided by 12. It uses a currency formatter to format the price in the
+     * given locale. Note that this value may be an approximation. For Google subscriptions,
+     * this value will use the basePlan to calculate the value.
+     */
+    readonly pricePerMonthString: string;
+    /**
+     * Null for INAPP products. The price of the PurchasesStoreProduct formatted for the current
+     * locale in a yearly recurrence. This means that, for example, if the period is monthly,
+     * the price will be multiplied by 12. It uses a currency formatter to format the price in the
+     * given locale. Note that this value may be an approximation. For Google subscriptions,
+     * this value will use the basePlan to calculate the value.
+     */
+    readonly pricePerYearString: string;
     /**
      * Currency code for price and original price.
      * Contains the currency code value of defaultOption for Google Play.
@@ -465,7 +510,7 @@ export declare enum PRORATION_MODE {
      * Replacement takes effect when the old plan expires, and the new price will
      * be charged at the same time.
      */
-    DEFERRED = 4,
+    DEFERRED = 6,
     /**
      * Replacement takes effect immediately, and the user is charged full price
      * of new plan and is given a full billing cycle of subscription,
@@ -542,6 +587,26 @@ export interface SubscriptionOption {
      * Null if not using offerings or if fetched directly from store via getProducts.
      */
     readonly presentedOfferingContext: PresentedOfferingContext | null;
+    /**
+     * For installment subscriptions, the details of the installment plan the customer commits to.
+     * Null for non-installment subscriptions.
+     * Installment plans are only available for Google Play subscriptions.
+     */
+    readonly installmentsInfo: InstallmentsInfo | null;
+}
+/**
+ * Type containing information of installment subscriptions. Currently only supported in Google Play.
+ * @public
+ */
+export interface InstallmentsInfo {
+    /**
+     * Number of payments the customer commits to in order to purchase the subscription.
+     */
+    readonly commitmentPaymentsCount: number;
+    /**
+     * After the commitment payments are complete, the number of payments the user commits to upon a renewal.
+     */
+    readonly renewalCommitmentPaymentsCount: number;
 }
 /**
  * Contains all the details associated with a PricingPhase

package/dist/offerings.js

@@ -141,7 +141,7 @@ export var PRORATION_MODE;
      * Replacement takes effect when the old plan expires, and the new price will
      * be charged at the same time.
      */
-    PRORATION_MODE[PRORATION_MODE["DEFERRED"] = 4] = "DEFERRED";
+    PRORATION_MODE[PRORATION_MODE["DEFERRED"] = 6] = "DEFERRED";
     /**
      * Replacement takes effect immediately, and the user is charged full price
      * of new plan and is given a full billing cycle of subscription,

package/dist/purchasesConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { ENTITLEMENT_VERIFICATION_MODE } from "./enums";
+import { ENTITLEMENT_VERIFICATION_MODE, STOREKIT_VERSION, PURCHASES_ARE_COMPLETED_BY } from "./enums";
 /**
  * Holds parameters to initialize the SDK.
  * @public
@@ -16,8 +16,15 @@ export interface PurchasesConfiguration {
      * An optional boolean. Set this to TRUE if you have your own IAP implementation and
      * want to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have
      * to acknowledge the purchases yourself.
+     * @deprecated Use purchasesAreCompletedBy instead.
      */
     observerMode?: boolean;
+    /**
+     * Set this to MY_APP if you have your own IAP implementation and
+     * want to use only RevenueCat's backend. Default is REVENUECAT. If you are on Android and setting this to MY_APP, you will have
+     * to acknowledge the purchases yourself.
+     */
+    purchasesAreCompletedBy?: PURCHASES_ARE_COMPLETED_BY;
     /**
      * An optional string. iOS-only, will be ignored for Android.
      * Set this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults
@@ -26,16 +33,17 @@ export interface PurchasesConfiguration {
     userDefaultsSuiteName?: string;
     /**
      * iOS-only, will be ignored for Android.
-     * Set this to TRUE to enable StoreKit2.
-     * Default is FALSE.
      *
-     * @deprecated RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has
-     * proven to be more performant than StoreKit 2.
-     * We're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail
-     * that you shouldn't need to care about.
-     * We recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.
+     * By selecting the DEFAULT value, RevenueCat will automatically select the most appropriate StoreKit version
+     * for the app's runtime environment.
+     *
+     * - Warning: Make sure you have an In-App Purchase Key configured in your app.
+     * Please see https://rev.cat/in-app-purchase-key-configuration for more info.
+     *
+     * - Note: StoreKit 2 is only available on iOS 16+. StoreKit 1 will be used for previous iOS versions
+     * regardless of this setting.
      */
-    usesStoreKit2IfAvailable?: boolean;
+    storeKitVersion?: STOREKIT_VERSION;
     /**
      * An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.
      */
@@ -52,4 +60,10 @@ export interface PurchasesConfiguration {
      * See https://rev.cat/trusted-entitlements for more info.
      */
     entitlementVerificationMode?: ENTITLEMENT_VERIFICATION_MODE;
+    /**
+     * Enable this setting if you want to allow pending purchases for prepaid subscriptions (only supported
+     * in Google Play). Note that entitlements are not granted until payment is done.
+     * Disabled by default.
+     */
+    pendingTransactionsForPrepaidPlansEnabled?: boolean;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revenuecat/purchases-typescript-internal-esm",
   "title": "Purchases typescript internal shared code",
-  "version": "11.1.1",
+  "version": "12.0.0",
   "description": "Typescript code to be used by RevenueCat's hybrid SDKs. Not meant for external usage.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",