@revenuecat/purchases-js 0.3.4 → 0.5.0

package/README.md

@@ -51,7 +51,7 @@ To avoid publishing the package you can set it up as a local dependency.
 In your testing project install the library as.
 
 ```bash
-npm i /path/to/rcbilling-js
+npm i /path/to/purchases-js
 ```
 
 ## Running tests

package/dist/Purchases.es.d.ts

@@ -170,6 +170,23 @@ export declare enum ErrorCode {
     InvalidEmailError = 38
 }
 
+/**
+ * Parameters used to customise the http requests executed by purchases-js.
+ * @public
+ */
+export declare interface HttpConfig {
+    /**
+     * Additional headers to include in all HTTP requests.
+     */
+    additionalHeaders?: Record<string, string>;
+    /**
+     * Set this property to your proxy URL *only* if you've received a proxy
+     * key value from your RevenueCat contact. This value should never end with
+     * a trailing slash.
+     */
+    proxyURL?: string;
+}
+
 /**
  * Possible levels to log in the console.
  * @public
@@ -377,6 +394,21 @@ export declare enum PeriodUnit {
     Day = "day"
 }
 
+/**
+ * Contains data about the context in which an offering was presented.
+ * @public
+ */
+export declare interface PresentedOfferingContext {
+    /**
+     * The identifier of the offering used to obtain this object.
+     */
+    readonly offeringIdentifier: string;
+    /**
+     * The targeting context used to obtain this object.
+     */
+    readonly targetingContext: TargetingContext | null;
+}
+
 /**
  * Price information for a product.
  * @public
@@ -458,8 +490,13 @@ export declare interface Product {
     readonly normalPeriodDuration: string | null;
     /**
      * The offering ID used to obtain this product.
+     * @deprecated - Use {@link Product.presentedOfferingContext} instead.
      */
     readonly presentedOfferingIdentifier: string;
+    /**
+     * The context from which this product was obtained.
+     */
+    readonly presentedOfferingContext: PresentedOfferingContext;
     /**
      * The default subscription option for this product. Null if no subscription
      * options are available like in the case of consumables and non-consumables.
@@ -541,9 +578,10 @@ export declare class Purchases {
       * keep the returned instance around for use throughout your application.
       * @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}.
       * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
-      static configure(apiKey: string, appUserId: string): Purchases;
+      static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig): Purchases;
       /**
        * Fetch the configured offerings for this user. You can configure these
        * in the RevenueCat dashboard.
@@ -668,6 +706,21 @@ export declare class Purchases {
              readonly trial: PricingPhase | null;
          }
 
+         /**
+          * Contains information about the targeting context used to obtain an object.
+          * @public
+          */
+         export declare interface TargetingContext {
+             /**
+              * The rule id from the targeting used to obtain this object.
+              */
+             readonly ruleId: string;
+             /**
+              * The revision of the targeting used to obtain this object.
+              */
+             readonly revision: number;
+         }
+
          /**
           * Error indicating that the SDK was accessed before it was initialized.
           * @public