@revenuecat/purchases-js 1.36.0 → 1.37.0

package/README.md

@@ -63,6 +63,47 @@ pnpm link "@revenuecat/purchases-js"
 
 > **Note:** Any changes you make to the library will be automatically reflected in your testing project after running `pnpm run build:dev` or `pnpm run build`.
 
+### Using a local `@revenuecat/purchases-ui-js`
+
+When you need to iterate on both `purchases-js` and `purchases-ui-js` together, you can point this repo at a sibling checkout using a `pnpm-workspace.yaml` override (instead of manually editing `package.json`).
+
+1. Place the two repos side by side, for example:
+
+```
+Developer/
+  purchases-js/
+  purchases-ui-js/
+```
+
+2. In `purchases-js`, create or edit `pnpm-workspace.yaml` and add:
+
+```yaml
+overrides:
+  "@revenuecat/purchases-ui-js": "link:../purchases-ui-js"
+```
+
+Use the **scoped** package name (`@revenuecat/purchases-ui-js`). A key like `purchases-ui-js` will not apply the override.
+
+3. Reinstall dependencies from the `purchases-js` root:
+
+```bash
+pnpm install
+```
+
+4. Verify the override resolved:
+
+```bash
+pnpm why @revenuecat/purchases-ui-js
+```
+
+You should see `link:../purchases-ui-js`.
+
+5. Build the UI package when you change it (from `purchases-ui-js`), then rebuild or run dev builds in `purchases-js` as needed.
+
+#### Reverting
+
+Remove the override from `pnpm-workspace.yaml` and run `pnpm install` again to return to the published `@revenuecat/purchases-ui-js` version.
+
 ## Running Storybook
 
 ```bash

package/dist/Purchases.es.d.ts

@@ -4,6 +4,7 @@ import { CustomVariableValue } from '@revenuecat/purchases-ui-js';
 import { PaywallData } from '@revenuecat/purchases-ui-js';
 import { UIConfig } from '@revenuecat/purchases-ui-js';
 import { WalletButtonRender } from '@revenuecat/purchases-ui-js';
+import { WalletButtonTheme } from '@revenuecat/purchases-ui-js';
 
 declare enum BackendErrorCode {
     BackendInvalidPlatform = 7000,
@@ -477,6 +478,8 @@ declare enum LocalizationKeys {
     PaywallVariablesTotalPriceAndPerMonth = "paywall_variables.total_price_and_per_month",
     PricingDropdownShowDetails = "pricing_dropdown.show_details",
     PricingDropdownHideDetails = "pricing_dropdown.hide_details",
+    PricingDropdownAddPromoCode = "pricing_dropdown.add_promo_code",
+    DiscountInputLabel = "discount_input.label",
     PricingTotalExcludingTax = "pricing_table.total_excluding_tax",
     PricingTableTrialEnds = "pricing_table.trial_ends",
     PricingTableTotalDueToday = "pricing_table.total_due_today",
@@ -593,6 +596,10 @@ export declare interface Offering {
     readonly metadata: {
         [key: string]: unknown;
     } | null;
+    /**
+     * The default web checkout URL for this offering, if available.
+     */
+    readonly webCheckoutURL?: string | null;
     /**
      * A map of all the packages available for purchase keyed by package ID.
      */
@@ -696,6 +703,10 @@ export declare interface Package {
      * The {@link Product} assigned to this package.
      */
     readonly webBillingProduct: Product;
+    /**
+     * The web checkout URL for this package, if available.
+     */
+    readonly webCheckoutURL?: string | null;
     /**
      * The type of package.
      */
@@ -745,6 +756,26 @@ export declare enum PackageType {
     Weekly = "$rc_weekly"
 }
 
+/**
+ * Listener for paywall purchase lifecycle events.
+ * @public
+ */
+export declare interface PaywallListener {
+    /**
+     * Called when a purchase flow is about to start for the given package.
+     */
+    onPurchaseStarted?: (rcPackage: Package) => void;
+    /**
+     * Callback called when an error that won't close the paywall occurs.
+     * For example, a retryable error during the purchase process.
+     */
+    onPurchaseError?: (error: Error) => void;
+    /**
+     * Called when the user cancels the purchase flow.
+     */
+    onPurchaseCancelled?: () => void;
+}
+
 /**
  * Represents the result of a purchase operation initiated from a paywall.
  * @public
@@ -856,8 +887,29 @@ export declare interface PresentPaywallParams {
      * If passed the checkout flow will not ask for it to the customer.
      */
     readonly customerEmail?: string;
+    /**
+     * @experimental
+     * If set to true, the Web Billing checkout shown from the paywall
+     * will display a discount input code field.
+     */
+    readonly showDiscountCodeField?: boolean;
+    /**
+     * @experimental
+     * Initial discount code to apply to the checkout when one already exists
+     * outside of the paywall UI, for example in the hosting page's URL.
+     */
+    readonly discountCode?: string;
+    /**
+     * @experimental
+     * Called when the applied discount code changes in the checkout shown from
+     * the paywall. This can be used to sync host state such as URL parameters.
+     */
+    readonly onDiscountCodeChanged?: (discountCode: string | null) => void;
     /**
      * Callback to be called when the paywall tries to navigate to an external URL.
+     *
+     * Markdown text links keep their native browser navigation. Use this callback
+     * for side effects or to customize how button-driven URL actions are handled.
      */
     readonly onNavigateToUrl?: (url: string) => void;
     /* Excluded from this release type: onCompleteWorkflowNavigate */
@@ -883,8 +935,13 @@ export declare interface PresentPaywallParams {
     /**
      * Callback called when an error that won't close the paywall occurs.
      * For example, a retryable error during the purchase process.
+     * @deprecated Use `listener.onPurchaseError` instead.
      */
     readonly onPurchaseError?: (error: Error) => void;
+    /**
+     * Optional listener for paywall purchase lifecycle events.
+     */
+    readonly listener?: PaywallListener;
     /**
      * The locale to use for the paywall and the checkout flow.
      */
@@ -895,7 +952,7 @@ export declare interface PresentPaywallParams {
     readonly hideBackButtons?: boolean;
     /**
      * Custom variables to pass to the paywall at runtime, overriding defaults set
-     * in the RevenueCat dashboard.
+     * in the RevenueCat dashboard.f
      *
      * Variables must be defined in the dashboard first. Reference them in paywall
      * text using the `custom.` prefix (e.g. `{{ custom.player_name }}`).
@@ -1187,6 +1244,25 @@ export declare interface PurchaseParams {
      * Defaults to `false`.
      */
     skipSuccessPage?: boolean;
+    /**
+     * @experimental
+     * If set to true, the Web Billing checkout will show a discount input code field.
+     */
+    showDiscountCodeField?: boolean;
+    /**
+     * @experimental
+     * Initial discount code to display as applied in the Web Billing checkout.
+     * This is useful when the code originated outside of the checkout UI,
+     * for example from a URL parameter.
+     */
+    discountCode?: string;
+    /**
+     * @experimental
+     * Called when the applied discount code changes in the Web Billing checkout.
+     * This can be used by host applications to keep external state, such as the URL,
+     * in sync with the checkout.
+     */
+    onDiscountCodeChanged?: (discountCode: string | null) => void;
     /* Excluded from this release type: brandingAppearanceOverride */
     /* Excluded from this release type: labelsOverride */
     /* Excluded from this release type: termsAndConditionsUrl */
@@ -1315,6 +1391,7 @@ export declare class Purchases {
         */
        getCurrentOfferingForPlacement(placementIdentifier: string, params?: GetOfferingsParams): Promise<Offering | null>;
        private getAllOfferings;
+       /* Excluded from this release type: _getProductWithDiscountCode */
        /**
         * Convenience method to check whether a user is entitled to a specific
         * entitlement. This will use {@link Purchases.getCustomerInfo} under the hood.
@@ -1812,6 +1889,10 @@ export declare class Purchases {
                  * The product identifier.
                  */
                 readonly productIdentifier: string;
+                /**
+                 * The base plan identifier of the subscription (For Google Play subs only).
+                 */
+                readonly productPlanIdentifier: string | null;
                 /**
                  * Date when the last subscription period started.
                  */