@revenuecat/purchases-js 1.58.0 → 1.60.0

package/dist/Purchases.es.d.ts

@@ -566,7 +566,12 @@ declare enum LocalizationKeys {
     UpgradeConfirmPageOnFile = "upgrade_confirm_page.on_file",
     UpgradeConfirmPageEmail = "upgrade_confirm_page.email",
     UpgradeConfirmPagePaymentMethod = "upgrade_confirm_page.payment_method",
-    UpgradeConfirmPageBillingAddress = "upgrade_confirm_page.billing_address"
+    UpgradeConfirmPageBillingAddress = "upgrade_confirm_page.billing_address",
+    PaddleCheckoutReturnTo = "paddle_checkout.return_to",
+    PaddleOrderSummaryBilledFrequency = "paddle_order_summary.billed_frequency",
+    PaddleOrderSummaryIntroThenRecurring = "paddle_order_summary.intro_then_recurring",
+    PaddleOrderSummaryIncTax = "paddle_order_summary.inc_tax",
+    PaddleOrderSummaryDueOn = "paddle_order_summary.due_on"
 }
 
 /**
@@ -832,11 +837,67 @@ export declare enum PackageType {
     Weekly = "$rc_weekly"
 }
 
+/**
+ * Known values of `component_type` in {@link PaywallInteractionEvent}.
+ * @public
+ */
+export declare const PAYWALL_COMPONENT_TYPES: {
+    readonly TAB: "tab";
+    readonly SWITCH: "switch";
+    readonly CAROUSEL: "carousel";
+    readonly BUTTON: "button";
+    readonly TEXT: "text";
+    readonly PACKAGE: "package";
+    readonly PACKAGE_SELECTION_SHEET: "package_selection_sheet";
+    readonly PURCHASE_BUTTON: "purchase_button";
+};
+
+/**
+ * A paywall control interaction, as passed to `PaywallListener.onInteraction`. Keys that do not apply
+ * are omitted.
+ * @public
+ */
+export declare interface PaywallInteractionEvent {
+    readonly timestamp: number;
+    readonly session_id: string;
+    readonly offering_id: string;
+    readonly paywall_id?: string;
+    readonly paywall_revision: number;
+    readonly display_mode?: string;
+    readonly dark_mode?: boolean;
+    readonly locale?: string;
+    readonly component_type: string;
+    readonly component_value: string;
+    readonly component_name?: string;
+    readonly component_url?: string;
+    readonly origin_index?: number;
+    readonly destination_index?: number;
+    readonly origin_context_name?: string;
+    readonly destination_context_name?: string;
+    readonly default_index?: number;
+    readonly origin_package_id?: string;
+    readonly destination_package_id?: string;
+    readonly default_package_id?: string;
+    readonly current_package_id?: string;
+    readonly resulting_package_id?: string;
+    readonly origin_product_id?: string;
+    readonly destination_product_id?: string;
+    readonly default_product_id?: string;
+    readonly current_product_id?: string;
+    readonly resulting_product_id?: string;
+}
+
 /**
  * Listener for paywall purchase lifecycle events.
  * @public
  */
-export declare type PaywallListener = PurchaseListener;
+export declare type PaywallListener = PurchaseListener & {
+    /**
+     * Called when the user interacts with a paywall control.
+     * Exceptions thrown here are logged and do not affect the paywall.
+     */
+    onInteraction?: (event: PaywallInteractionEvent) => void;
+};
 
 /**
  * Represents the result of a purchase operation initiated from a paywall.