@revenuecat/purchases-js 0.15.2 → 0.17.0

package/README.md

@@ -12,11 +12,11 @@ Login @ [app.revenuecat.com](https://app.revenuecat.com)
 
 - Connect your Stripe account if you haven't already (More payment gateways are coming soon)
 - Create a Project (if you haven't already)
-- Add a new RCBilling app
+- Add a new Web Billing app
 - Get the sandbox API key or production API key (depending on the environment)
-- Create some products for the RCBilling App
-- Create an offering and add packages with RCBilling products
-- Create the entitlements you need in your app and link them to the RCBilling products
+- Create some products for the Web Billing App
+- Create an offering and add packages with Web Billing products
+- Create the entitlements you need in your app and link them to the Web Billing products
 
 # Installation
 
@@ -32,7 +32,7 @@ Login @ [app.revenuecat.com](https://app.revenuecat.com)
 
 # Usage
 
-See the [RevenueCat docs](https://www.revenuecat.com/docs/web/revenuecat-billing) and the [SDK Reference](https://revenuecat.github.io/purchases-js-docs).
+See the [RevenueCat docs](https://www.revenuecat.com/docs/web/web-billing) and the [SDK Reference](https://revenuecat.github.io/purchases-js-docs).
 
 # Development
 
@@ -110,7 +110,7 @@ npm run lint
 
 ## Running E2E tests
 
-Please check the Demo app readme [here](./examples/rcbilling-demo/README.md#e2e-tests)
+Please check the Demo app readme [here](./examples/webbilling-demo/README.md#e2e-tests)
 
 ## Update API specs
 

package/dist/Purchases.es.d.ts

@@ -27,7 +27,7 @@ export declare interface CustomerInfo {
     readonly activeSubscriptions: Set<string>;
     /**
      * URL to manage the active subscription of the user.
-     * If this user has an active RC Billing subscription, a link to the management page.
+     * If this user has an active Web Billing subscription, a link to the management page.
      * If this user has an active iOS subscription, this will point to the App Store.
      * If the user has an active Play Store subscription it will point there.
      * If there are no active subscriptions it will be null.
@@ -172,6 +172,18 @@ export declare enum ErrorCode {
     InvalidEmailError = 38
 }
 
+/**
+ * Flags used to enable or disable certain features in the sdk.
+ * @public
+ */
+export declare interface FlagsConfig {
+    /**
+     * If set to true, the SDK will automatically collect UTM parameters and store them as at the time of purchase.
+     * @defaultValue true
+     */
+    autoCollectUTMAsMetadata?: boolean;
+}
+
 /**
  * Parameters for the {@link Purchases.getOfferings} method.
  * @public
@@ -352,8 +364,13 @@ export declare interface Package {
     readonly identifier: string;
     /**
      * The {@link Product} assigned to this package.
+     * @deprecated - Use {@link Package.webBillingProduct} instead.
      */
     readonly rcBillingProduct: Product;
+    /**
+     * The {@link Product} assigned to this package.
+     */
+    readonly webBillingProduct: Product;
     /**
      * The type of package.
      */
@@ -601,6 +618,13 @@ export declare enum ProductType {
     NonConsumable = "non_consumable"
 }
 
+/**
+ * Metadata that can be passed to the backend when making a purchase.
+ * They will propagate to the payment gateway (i.e. Stripe) and to RevenueCat.
+ * @public
+ */
+export declare type PurchaseMetadata = Record<string, string | null>;
+
 /**
  * Represents a possible option to purchase a product.
  * @public
@@ -646,6 +670,12 @@ export declare interface PurchaseParams {
      * Defaults to english.
      */
     defaultLocale?: string;
+    /**
+     * The purchase metadata to be passed to the backend.
+     * Any information provided here will be propagated to the payment gateway and
+     * to the RC transaction as metadata.
+     */
+    metadata?: PurchaseMetadata;
 }
 
 /**
@@ -694,9 +724,10 @@ export declare class Purchases {
       * @param apiKey - RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
       * @param appUserId - Your unique id for identifying the user.
       * @param httpConfig - Advanced http configuration to customise the SDK usage {@link HttpConfig}.
+      * @param flags - Advanced functionality configuration {@link FlagsConfig}.
       * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
-      static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig): Purchases;
+      static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig, flags?: FlagsConfig): Purchases;
       /**
        * Loads and caches some optional data in the Purchases SDK.
        * Currently only fetching branding information. You can call this method