@revenuecat/purchases-js 0.3.4 → 0.4.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
@@ -541,9 +558,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.