@revenuecat/purchases-typescript-internal-esm 18.1.0 → 18.2.0

package/dist/offerings.d.ts

@@ -467,6 +467,20 @@ export interface GoogleProductChangeInfo {
      */
     readonly prorationMode?: PRORATION_MODE;
 }
+/**
+ * Holds the information used when upgrading from another sku. For use on the Play Store and Galaxy Store on Android only.
+ * @public
+ */
+export interface StoreProductChangeInfo {
+    /**
+     * The old product identifier to upgrade from.
+     */
+    readonly oldProductIdentifier: string;
+    /**
+     * The [STORE_REPLACEMENT_MODE] to use when upgrading the given oldSKU.
+     */
+    readonly replacementMode?: STORE_REPLACEMENT_MODE;
+}
 /**
  * Holds the introductory price status
  * @public
@@ -506,7 +520,7 @@ export declare enum PRORATION_MODE {
     UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY = 0,
     /**
      * Replacement takes effect immediately, and the remaining time will be
-     * prorated and credited to the user. This is the current default behavior.
+     * prorated and credited to the user.
      */
     IMMEDIATE_WITH_TIME_PRORATION = 1,
     /**
@@ -518,6 +532,8 @@ export declare enum PRORATION_MODE {
     /**
      * 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.
      */
     IMMEDIATE_WITHOUT_PRORATION = 3,
     /**
@@ -532,6 +548,41 @@ export declare enum PRORATION_MODE {
      */
     IMMEDIATE_AND_CHARGE_FULL_PRICE = 5
 }
+/**
+ * Enum with possible proration modes in a subscription upgrade or downgrade in the Play Store or Galaxy Store. Used only on Android.
+ * @public
+ */
+export declare enum STORE_REPLACEMENT_MODE {
+    /**
+     * 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.
+     */
+    WITHOUT_PRORATION = "WITHOUT_PRORATION",
+    /**
+     * Replacement takes effect immediately, and the remaining time will be
+     * prorated and credited to the user. This is the current default behavior.
+     */
+    WITH_TIME_PRORATION = "WITH_TIME_PRORATION",
+    /**
+     * 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 Store. If it is passed to the Galaxy Store, an error will be thrown.
+     */
+    CHARGE_FULL_PRICE = "CHARGE_FULL_PRICE",
+    /**
+     * 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.
+     */
+    CHARGE_PRORATED_PRICE = "CHARGE_PRORATED_PRICE",
+    /**
+     * Replacement takes effect when the old plan expires, and the new price will be charged at the same time.
+     */
+    DEFERRED = "DEFERRED"
+}
 /**
  * Contains all details associated with a SubscriptionOption
  * Used only for Google

package/dist/offerings.js

@@ -123,7 +123,7 @@ export var PRORATION_MODE;
     PRORATION_MODE[PRORATION_MODE["UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY"] = 0] = "UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY";
     /**
      * Replacement takes effect immediately, and the remaining time will be
-     * prorated and credited to the user. This is the current default behavior.
+     * prorated and credited to the user.
      */
     PRORATION_MODE[PRORATION_MODE["IMMEDIATE_WITH_TIME_PRORATION"] = 1] = "IMMEDIATE_WITH_TIME_PRORATION";
     /**
@@ -135,6 +135,8 @@ export var PRORATION_MODE;
     /**
      * 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.
      */
     PRORATION_MODE[PRORATION_MODE["IMMEDIATE_WITHOUT_PRORATION"] = 3] = "IMMEDIATE_WITHOUT_PRORATION";
     /**
@@ -149,6 +151,42 @@ export var PRORATION_MODE;
      */
     PRORATION_MODE[PRORATION_MODE["IMMEDIATE_AND_CHARGE_FULL_PRICE"] = 5] = "IMMEDIATE_AND_CHARGE_FULL_PRICE";
 })(PRORATION_MODE || (PRORATION_MODE = {}));
+/**
+ * Enum with possible proration modes in a subscription upgrade or downgrade in the Play Store or Galaxy Store. Used only on Android.
+ * @public
+ */
+export var STORE_REPLACEMENT_MODE;
+(function (STORE_REPLACEMENT_MODE) {
+    /**
+     * 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.
+     */
+    STORE_REPLACEMENT_MODE["WITHOUT_PRORATION"] = "WITHOUT_PRORATION";
+    /**
+     * Replacement takes effect immediately, and the remaining time will be
+     * prorated and credited to the user. This is the current default behavior.
+     */
+    STORE_REPLACEMENT_MODE["WITH_TIME_PRORATION"] = "WITH_TIME_PRORATION";
+    /**
+     * 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 Store. If it is passed to the Galaxy Store, an error will be thrown.
+     */
+    STORE_REPLACEMENT_MODE["CHARGE_FULL_PRICE"] = "CHARGE_FULL_PRICE";
+    /**
+     * 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.
+     */
+    STORE_REPLACEMENT_MODE["CHARGE_PRORATED_PRICE"] = "CHARGE_PRORATED_PRICE";
+    /**
+     * Replacement takes effect when the old plan expires, and the new price will be charged at the same time.
+     */
+    STORE_REPLACEMENT_MODE["DEFERRED"] = "DEFERRED";
+})(STORE_REPLACEMENT_MODE || (STORE_REPLACEMENT_MODE = {}));
 /**
  * Recurrence mode for a pricing phase
  * @public

package/dist/purchaseParams.d.ts

@@ -1,4 +1,4 @@
-import { GoogleProductChangeInfo, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesWinBackOffer, SubscriptionOption } from "./offerings";
+import { GoogleProductChangeInfo, PurchasesPackage, PurchasesPromotionalOffer, PurchasesStoreProduct, PurchasesWinBackOffer, StoreProductChangeInfo, SubscriptionOption } from "./offerings";
 /**
  * Holds parameters to initialize a purchase in our SDK.
  * @public
@@ -11,8 +11,17 @@ export interface PurchaseParams {
     /**
      * Google Play only. Optional {@link GoogleProductChangeInfo} you
      * wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+     *
+     * If both googleProductChangeInfo and productChangeInfo are provided, then productChangeInfo is used and googleProductChangeInfo is ignored.
      */
     googleProductChangeInfo?: GoogleProductChangeInfo | null;
+    /**
+     * Google Play and Galaxy Store only. Optional {@link StoreProductChangeInfo} that allows you
+     * to make a product change with the oldProductIdentifier and the optional replacementMode.
+     *
+     * If both googleProductChangeInfo and productChangeInfo are provided, then productChangeInfo is used and googleProductChangeInfo is ignored.
+     */
+    productChangeInfo?: StoreProductChangeInfo | null;
     /**
      * Google Play only. Optional boolean that 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revenuecat/purchases-typescript-internal-esm",
   "title": "Purchases typescript internal shared code",
-  "version": "18.1.0",
+  "version": "18.2.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",