@revenuecat/purchases-js 1.17.0 → 1.18.0

package/dist/Purchases.es.d.ts

@@ -593,6 +593,49 @@ export declare interface PresentedOfferingContext {
     readonly placementIdentifier: string | null;
 }
 
+/**
+ * Parameters for the {@link Purchases.presentPaywall} method.
+ * @public
+ */
+export declare interface PresentPaywallParams {
+    /**
+     * The identifier of the offering to fetch the paywall for.
+     * Can be a string identifier or one of the predefined keywords.
+     */
+    readonly offering?: Offering;
+    /**
+     * The target element where the paywall will be rendered.
+     * The paywall will create a full-screen overlay if null.
+     */
+    readonly htmlTarget?: HTMLElement;
+    /**
+     * The target element where the checkout flow will be rendered.
+     * The checkout flow will create a full-screen overlay if null.
+     */
+    readonly purchaseHtmlTarget?: HTMLElement;
+    /**
+     * The email of the customer starting the purchase.
+     * If passed the checkout flow will not ask for it to the customer.
+     */
+    readonly customerEmail?: string;
+    /**
+     * Callback to be called when the paywall tries to navigate to an external URL.
+     */
+    readonly onNavigateToUrl?: (url: string) => void;
+    /**
+     * Callback to be called when the paywall tries to navigate back.
+     */
+    readonly onBack?: () => void;
+    /**
+     * Callback to be called when the paywall tries to visit the customer center.
+     */
+    readonly onVisitCustomerCenter?: () => void;
+    /**
+     * The locale to use for the paywall and the checkout flow.
+     */
+    readonly selectedLocale?: string;
+}
+
 /**
  * Price information for a product.
  * @public
@@ -925,6 +968,12 @@ export declare class Purchases {
         * up the first call to {@link Purchases.purchase}.
         */
        preload(): Promise<void>;
+       /**
+        * Renders an RC Paywall and allows the user to purchase from it using Web Billing.
+        * @param paywallParams - The parameters object to customise the paywall render. Check {@link PresentPaywallParams}
+        * @returns Promise<PurchaseResult>
+        */
+       presentPaywall(paywallParams: PresentPaywallParams): Promise<PurchaseResult>;
        /**
         * Fetch the configured offerings for this user. You can configure these
         * in the RevenueCat dashboard.