@revenuecat/purchases-js 1.54.0 → 1.56.0

package/dist/Purchases.es.d.ts

@@ -134,6 +134,20 @@ export declare interface CustomerInfo {
     };
 }
 
+/**
+ * Parameters for tracking an impression of a custom paywall.
+ *
+ * Pass the offering used to render the paywall to include its offering,
+ * placement, and targeting attribution in the event.
+ * @public
+ */
+export declare interface CustomPaywallImpressionParams {
+    /** An optional identifier for the custom paywall shown to the customer. */
+    paywallId?: string;
+    /** The offering used to render the custom paywall. */
+    offering?: Offering;
+}
+
 /**
  * Custom translations to be used in the purchase flow.
  * This class allows you to override the default translations used in the purchase flow.
@@ -961,6 +975,10 @@ export declare interface PresentExpressPurchaseButtonParams {
      * The email of the user. If undefined, RevenueCat will ask the customer for their email.
      */
     customerEmail?: string;
+    /**
+     * The RevenueCat public identifier for an Apple external purchase token.
+     */
+    externalPurchaseTokenId?: string;
     /**
      * The locale to use for the purchase flow. If not specified, English will be used
      */
@@ -1018,6 +1036,10 @@ export declare interface PresentPaywallParams {
      * If passed the checkout flow will not ask for it to the customer.
      */
     readonly customerEmail?: string;
+    /**
+     * The RevenueCat public identifier for an Apple external purchase token.
+     */
+    readonly externalPurchaseTokenId?: string;
     /**
      * The purchase metadata to be passed to the backend when a purchase is started
      * from the paywall.
@@ -1394,6 +1416,10 @@ export declare interface PurchaseParams {
      * The email of the user. If undefined, RevenueCat will ask the customer for their email.
      */
     customerEmail?: string;
+    /**
+     * The RevenueCat public identifier for an Apple external purchase token.
+     */
+    externalPurchaseTokenId?: string;
     /* Excluded from this release type: workflowPurchaseContext */
     /* Excluded from this release type: attributionMetadata */
     /* Excluded from this release type: paywallId */
@@ -1426,7 +1452,9 @@ export declare interface PurchaseParams {
     showDiscountCodeField?: boolean;
     /**
      * @experimental
-     * Initial discount code to display as applied in the Web Billing checkout.
+     * Initial discount code to apply at checkout.
+     * For Web Billing this is displayed as applied in the checkout UI.
+     * For Paddle this is passed to Paddle Checkout as `discountCode`.
      * This is useful when the code originated outside of the checkout UI,
      * for example from a URL parameter.
      */
@@ -1503,6 +1531,7 @@ export declare class Purchases {
     /* Excluded from this release type: eventsTracker */
     /* Excluded from this release type: _platformInfo */
     /* Excluded from this release type: inMemoryCache */
+    /* Excluded from this release type: cachedCurrentOffering */
     /* Excluded from this release type: instance */
     /**
      * Set the log level. Logs of the given level and below will be printed
@@ -1578,6 +1607,20 @@ export declare class Purchases {
         * @param params - The parameters object to customise the offerings fetch. Check {@link GetOfferingsParams}
         */
        getOfferings(params?: GetOfferingsParams): Promise<Offerings>;
+       /**
+        * Tracks an impression for a custom paywall.
+        *
+        * Pass the offering used to render the paywall to preserve placement and
+        * targeting attribution. When no offering is passed, the most recently
+        * fetched current offering is used if available.
+        *
+        * Each call creates a separate impression event. Call this once per
+        * paywall presentation and avoid lifecycle callbacks that may run
+        * multiple times for the same display.
+        *
+        * @param params Parameters for the custom paywall impression event.
+        */
+       trackCustomPaywallImpression(params?: CustomPaywallImpressionParams): void;
        /**
         * Retrieves a specific offering by a placement identifier.
         * For more info see https://www.revenuecat.com/docs/tools/targeting
@@ -1693,7 +1736,8 @@ export declare class Purchases {
              /**
               * Resolves {@link PurchaseParams.productChangeInfo} into the product-change
               * context passed to the checkout UI, or undefined when the purchase should
-              * proceed as a normal purchase (no info, no token, or non-Web Billing key).
+              * proceed as a normal purchase (no info, no token, or an API key whose
+              * gateway doesn't support product change, e.g. Paddle).
               */
              private resolveProductChange;
              /**