@revenuecat/purchases-js 1.66.0 → 1.67.0

package/README.md

@@ -47,6 +47,16 @@ pnpm install
 pnpm run build:dev
 ```
 
+For automatic rebuilds of the web entry point during development, run:
+
+```bash
+pnpm run build:dev-watch
+```
+
+`build:dev-watch` is web-only. It preserves the Vega artifacts produced by
+`build:dev`, but does not rebuild them; rerun `pnpm run build:dev` after
+changing code used by the Vega entry point.
+
 To avoid publishing the package you can use pnpm's link feature:
 
 1. In the purchases-js directory, register the package:
@@ -155,7 +165,7 @@ Please check the Demo app readme [here](./examples/webbilling-demo/README.md#e2e
 pnpm run extract-api
 ```
 
-This will update the files in `api-report` with the latest public API.
+This will update the files in `api-report` and `vega/api-report` with the latest public API for both packages.
 If it has uncommitted changes, CI tests will fail. Run this command and commit the changes if
 they are expected.
 

package/dist/Purchases.es.d.ts

@@ -51,6 +51,8 @@ declare enum BackendErrorCode {
     BackendGatewaySetupErrorInvalidTaxOriginAddressDuringCheckout = 8174
 }
 
+/* Excluded from this release type: BillingWrapper */
+
 /**
  * @public
  * `BrandingAppearance` defines the appearance settings
@@ -179,6 +181,15 @@ export { CustomVariableValue }
 
 /* Excluded from this release type: DiscountPhase */
 
+declare interface DiscountResponse extends PriceResponse {
+    name: string | null;
+    duration_mode: "one_time" | "time_window" | "forever";
+    time_window: string | null;
+    discount_type: "percentage" | "fixed_amount";
+    percentage?: number | null;
+    fixed_amount_micros?: number | null;
+}
+
 declare type EmptyString = "";
 
 /**
@@ -640,6 +651,10 @@ export declare interface NonSubscriptionOption extends PurchaseOption {
     /* Excluded from this release type: discount */
 }
 
+declare interface NonSubscriptionOptionResponse extends PurchaseOptionResponse {
+    base_price: PriceResponse;
+}
+
 /**
  * Information that represents a non-subscription purchase made by a user.
  * @public
@@ -1251,6 +1266,11 @@ export declare interface Price {
     readonly formattedPrice: string;
 }
 
+declare interface PriceResponse {
+    amount_micros: number;
+    currency: string;
+}
+
 /**
  * Represents the price and duration information for a phase of the purchase option.
  * @public
@@ -1291,6 +1311,12 @@ export declare interface PricingPhase {
     readonly pricePerYear: Price | null;
 }
 
+declare interface PricingPhaseResponse {
+    period_duration: string | null;
+    price: PriceResponse | null;
+    cycle_count: number;
+}
+
 /**
  * Represents product's listing details.
  * @public
@@ -1391,6 +1417,21 @@ export declare interface Product {
 
 /* Excluded from this release type: ProductChangeResult */
 
+declare interface ProductResponse {
+    identifier: string;
+    product_type: string;
+    title: string;
+    description: string | null;
+    default_purchase_option_id: string | null;
+    purchase_options: {
+        [key: string]: NonSubscriptionOptionResponse | SubscriptionOptionResponse;
+    };
+}
+
+declare interface ProductsResponse {
+    product_details: ProductResponse[];
+}
+
 /**
  * Possible product types
  * @public
@@ -1478,6 +1519,12 @@ export declare interface PurchaseOption {
     readonly priceId: string;
 }
 
+declare interface PurchaseOptionResponse {
+    id: string;
+    price_id: string;
+    discount: DiscountResponse | null;
+}
+
 /**
  * Parameters used to customise the purchase flow when invoking the `.purchase` method.
  * @public
@@ -1586,6 +1633,8 @@ export declare interface PurchaseResult {
     readonly redemptionInfo: RedemptionInfo | null;
     /**
      * The operation session id of the purchase.
+     *
+     * For Amazon Store purchases, this will contain the Amazon Store's receipt ID from the purchase.
      */
     readonly operationSessionId: string;
     /**
@@ -1621,6 +1670,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: billingWrapper */
     /* Excluded from this release type: offeringsRequests */
     /* Excluded from this release type: cachedCurrentOffering */
     /* Excluded from this release type: customWebCheckoutEnabled */
@@ -1693,6 +1743,9 @@ export declare class Purchases {
        /* Excluded from this release type: __constructor */
        /**
         * Renders an RC Paywall and allows the user to purchase from it using Web Billing.
+        *
+        * Unsupported for Amazon apps.
+        *
         * @param paywallParams - The parameters object to customise the paywall render. Check {@link PresentPaywallParams}
         * @returns Promise<PurchaseResult>
         */
@@ -1767,6 +1820,9 @@ export declare class Purchases {
           * Renders an Express Purchase button for the supported wallets (Apple Pay/Google Pay).
           * When clicked it uses the wallet UI to execute the purchase instead of
           * the checkout flow that would be shown with `.purchase`.
+          *
+          * Unsupported for Amazon apps.
+          *
           * @param params - The parameters object to customise the purchase flow. Check {@link PresentExpressPurchaseButtonParams}
           * @returns Promise<PurchaseResult>
           */
@@ -1908,6 +1964,7 @@ export declare class Purchases {
              static generateRevenueCatAnonymousAppUserId(): string;
              /* Excluded from this release type: _trackEvent */
              /* Excluded from this release type: _flushAllEvents */
+             /* Excluded from this release type: unwrappedBillingWrapper */
             }
 
             /**
@@ -2248,6 +2305,14 @@ export declare class Purchases {
                 SingularDeviceId = "$singularDeviceId"
             }
 
+            /**
+             * The result of restoring purchases.
+             * @public
+             */
+            declare interface RestorePurchasesResult {
+                customerInfo: CustomerInfo;
+            }
+
             declare type SDKEventContextSource = "sdk" | "wpl" | string;
 
             /**
@@ -2407,6 +2472,20 @@ export declare class Purchases {
                 /* Excluded from this release type: discount */
             }
 
+            declare interface SubscriptionOptionResponse extends PurchaseOptionResponse {
+                base: PricingPhaseResponse | null;
+                trial: PricingPhaseResponse | null;
+                intro_price: PricingPhaseResponse | null;
+            }
+
+            /**
+             * The result of syncing purchases.
+             * @public
+             */
+            declare interface SyncPurchasesResult {
+                customerInfo: CustomerInfo;
+            }
+
             /**
              * Contains information about the targeting context used to obtain an object.
              * @public