react-native-purchases 5.0.0-beta.5 → 5.0.1

package/README.md

@@ -16,7 +16,7 @@ React Native Purchases is a client for the [RevenueCat](https://www.revenuecat.c
 ➡️ | [Webhooks](https://docs.revenuecat.com/docs/webhooks) - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more   
 🎯 | Subscription status tracking - know whether a user is subscribed whether they're on iOS, Android or web  
 📊 | Analytics - automatic calculation of metrics like conversion, mrr, and churn  
-📝 | [Online documentation](https://docs.revenuecat.com/docs) up to date  
+📝 | [Online documentation](https://docs.revenuecat.com/docs) and [SDK reference](https://revenuecat.github.io/react-native-purchases-docs/) up to date  
 🔀 | [Integrations](https://www.revenuecat.com/integrations) - over a dozen integrations to easily send purchase data where you need it  
 💯 | Well maintained - [frequent releases](https://github.com/RevenueCat/purchases-ios/releases)  
 📮 | Great support - [Help Center](https://revenuecat.zendesk.com) 

package/RNPurchases.podspec

@@ -24,6 +24,6 @@ Pod::Spec.new do |spec|
   ]
 
   spec.dependency   "React-Core"
-  spec.dependency   "PurchasesHybridCommon", '4.1.1'
+  spec.dependency   "PurchasesHybridCommon", '4.2.1'
   spec.swift_version    = '5.0'
 end

package/android/build.gradle

@@ -29,7 +29,7 @@ android {
         minSdkVersion getExtOrIntegerDefault('minSdkVersion')
         targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
         versionCode 1
-        versionName '5.0.0-beta.5'
+        versionName '5.0.1'
     }
 
     buildTypes {
@@ -121,6 +121,6 @@ def kotlin_version = getExtOrDefault('kotlinVersion')
 dependencies {
     //noinspection GradleDynamicVersion
     api 'com.facebook.react:react-native:+'
-    implementation 'com.revenuecat.purchases:purchases-hybrid-common:4.1.1'
+    implementation 'com.revenuecat.purchases:purchases-hybrid-common:4.2.1'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 }

package/dist/customerInfo.d.ts

@@ -144,13 +144,13 @@ export interface CustomerInfo {
  */
 export interface PurchasesStoreTransaction {
     /**
-     * RevenueCat Id associated to the transaction.
+     * Id of the transaction.
      */
-    revenueCatId: string;
+    transactionIdentifier: string;
     /**
      * Product Id associated with the transaction.
      */
-    productId: string;
+    productIdentifier: string;
     /**
      * Purchase date of the transaction in ISO 8601 format.
      */

package/dist/purchases.d.ts

@@ -134,20 +134,20 @@ export default class Purchases {
      * we will treat it as a restore and alias the new ID with the previous id.
      * @param {boolean} allowSharing Set this to true if you are passing in an appUserID but it is anonymous,
      * this is true by default if you didn't pass an appUserID
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static setAllowSharingStoreAccount(allowSharing: boolean): Promise<void>;
     /**
      * @param {boolean} finishTransactions Set finishTransactions to false if you aren't using Purchases SDK to
      * make the purchase
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static setFinishTransactions(finishTransactions: boolean): Promise<void>;
     /**
      * iOS only.
      * @param {boolean} simulatesAskToBuyInSandbox Set this property to true *only* when testing the ask-to-buy / SCA
      * purchases flow. More information: http://errors.rev.cat/ask-to-buy
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static setSimulatesAskToBuyInSandbox(simulatesAskToBuyInSandbox: boolean): Promise<void>;
     /**
@@ -180,7 +180,7 @@ export default class Purchases {
     static removeShouldPurchasePromoProductListener(listenerToRemove: ShouldPurchasePromoProductListener): boolean;
     /**
      * Gets the map of entitlements -> offerings -> products
-     * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if setup
+     * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if configure
      * has not been called yet.
      */
     static getOfferings(): Promise<PurchasesOfferings>;
@@ -191,7 +191,7 @@ export default class Purchases {
      * @returns {Promise<PurchasesStoreProduct[]>} A promise containing an array of products. The promise will be rejected
      * if the products are not properly configured in RevenueCat or if there is another error retrieving them.
      * Rejections return an error code, and a userInfo object with more information. The promise will also be rejected
-     * if setup has not been called yet.
+     * if configure has not been called yet.
      */
     static getProducts(productIdentifiers: string[], type?: PURCHASE_TYPE): Promise<PurchasesStoreProduct[]>;
     /**
@@ -204,7 +204,7 @@ export default class Purchases {
      * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing
      * a customer info object and a product identifier. Rejections return an error code,
      * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will
-     * also be rejected if setup has not been called yet.
+     * also be rejected if configure has not been called yet.
      */
     static purchaseProduct(productIdentifier: string, upgradeInfo?: UpgradeInfo | null, type?: PURCHASE_TYPE): Promise<MakePurchaseResult>;
     /**
@@ -215,7 +215,7 @@ export default class Purchases {
      * @returns {Promise<{ productIdentifier: string, customerInfo:CustomerInfo }>} A promise of an object containing
      * a customer info object and a product identifier. Rejections return an error code,
      * a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be
-     * rejected if setup has not been called yet.
+     * rejected if configure has not been called yet.
      */
     static purchaseDiscountedProduct(product: PurchasesStoreProduct, discount: PurchasesPromotionalOffer): Promise<MakePurchaseResult>;
     /**
@@ -226,7 +226,7 @@ export default class Purchases {
      * and the optional prorationMode.
      * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing
      * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the
-     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if setup
+     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure
      * has not been called yet.
      */
     static purchasePackage(aPackage: PurchasesPackage, upgradeInfo?: UpgradeInfo | null): Promise<MakePurchaseResult>;
@@ -237,14 +237,14 @@ export default class Purchases {
      * @param {PurchasesPromotionalOffer} discount Discount to apply to this package. Retrieve this discount using getPromotionalOffer.
      * @returns {Promise<{ productIdentifier: string, customerInfo: CustomerInfo }>} A promise of an object containing
      * a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the
-     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if setup
+     * user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure
      * has not been called yet.
      */
     static purchaseDiscountedPackage(aPackage: PurchasesPackage, discount: PurchasesPromotionalOffer): Promise<MakePurchaseResult>;
     /**
      * Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.
      * @returns {Promise<CustomerInfo>} A promise of a customer info object. Rejections return an error code, and an
-     * userInfo object with more information. The promise will be also be rejected if setup has not been called yet.
+     * userInfo object with more information. The promise will be also be rejected if configure has not been called yet.
      */
     static restorePurchases(): Promise<CustomerInfo>;
     /**
@@ -258,13 +258,13 @@ export default class Purchases {
      * @param {String} appUserID The appUserID that should be linked to the currently user
      * @returns {Promise<LogInResult>} A promise of an object that contains the customerInfo after logging in, as well
      * as a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The
-     * promise will be rejected if setup has not been called yet or if there's an issue logging in.
+     * promise will be rejected if configure has not been called yet or if there's an issue logging in.
      */
     static logIn(appUserID: string): Promise<LogInResult>;
     /**
      * Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.
      * @returns {Promise<CustomerInfo>} A promise of a customer info object. Rejections return an error code,
-     * and a userInfo object with more information. The promise will be rejected if setup has not been called yet or if
+     * and a userInfo object with more information. The promise will be rejected if configure has not been called yet or if
      * there's an issue logging out.
      */
     static logOut(): Promise<CustomerInfo>;
@@ -276,7 +276,7 @@ export default class Purchases {
     /**
      * Gets current customer info
      * @returns {Promise<CustomerInfo>} A promise of a customer info object. Rejections return an error code, and an
-     * userInfo object with more information. The promise will be rejected if setup has not been called yet or if
+     * userInfo object with more information. The promise will be rejected if configure has not been called yet or if
      * there's an issue getting the customer information.
      */
     static getCustomerInfo(): Promise<CustomerInfo>;
@@ -285,7 +285,7 @@ export default class Purchases {
      * for subscriptions anytime a sync is needed, like after a successful purchase.
      *
      * @warning This function should only be called if you're not calling purchaseProduct/purchasePackage.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * syncing purchases.
      */
     static syncPurchases(): Promise<void>;
@@ -293,17 +293,17 @@ export default class Purchases {
      * @deprecated, use enableAdServicesAttributionTokenCollection instead.
      * Enable automatic collection of Apple Search Ad attribution. Disabled by default
      * @param {boolean} enabled Enable or not automatic apple search ads attribution collection
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static setAutomaticAppleSearchAdsAttributionCollection(enabled: boolean): Promise<void>;
     /**
      * Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static enableAdServicesAttributionTokenCollection(): Promise<void>;
     /**
      * @returns { Promise<boolean> } If the `appUserID` has been generated by RevenueCat or not.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet.
      */
     static isAnonymous(): Promise<boolean>;
     /**
@@ -319,7 +319,7 @@ export default class Purchases {
      *
      * @param productIdentifiers Array of product identifiers for which you want to compute eligibility
      * @returns { Promise<[productId: string]: IntroEligibility> } A map of IntroEligility per productId. The promise
-     * will be rejected if setup has not been called yet or if there's in an error checking eligibility.
+     * will be rejected if configure has not been called yet or if there's in an error checking eligibility.
      */
     static checkTrialOrIntroductoryPriceEligibility(productIdentifiers: string[]): Promise<{
         [productId: string]: IntroEligibility;
@@ -327,10 +327,10 @@ export default class Purchases {
     /**
      * iOS only. Use this function to retrieve the `PurchasesPromotionalOffer` for a given `PurchasesPackage`.
      *
-     * @param product The `PurchasesProduct` the user intends to purchase.
-     * @param discount The `PurchasesDiscount` to apply to the product.
+     * @param product The `PurchasesStoreProduct` the user intends to purchase.
+     * @param discount The `PurchasesStoreProductDiscount` to apply to the product.
      * @returns { Promise<PurchasesPromotionalOffer> } Returns when the `PurchasesPaymentDiscount` is returned.
-     * Null is returned for Android and incompatible iOS versions. The promise will be rejected if setup has not been
+     * Null is returned for Android and incompatible iOS versions. The promise will be rejected if configure has not been
      * called yet or if there's an error getting the payment discount.
      */
     static getPromotionalOffer(product: PurchasesStoreProduct, discount: PurchasesStoreProductDiscount): Promise<PurchasesPromotionalOffer | undefined>;
@@ -343,14 +343,14 @@ export default class Purchases {
      *
      * This is useful for cases where customer information might have been updated outside of the app, like if a
      * promotional subscription is granted through the RevenueCat dashboard.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error
      * invalidating the customer info cache.
      */
     static invalidateCustomerInfoCache(): Promise<void>;
     /** iOS only. Presents a code redemption sheet, useful for redeeming offer codes
      * Refer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how
      * to configure and use offer codes
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error
      * presenting the code redemption sheet.
      */
     static presentCodeRedemptionSheet(): Promise<void>;
@@ -363,7 +363,7 @@ export default class Purchases {
      * restrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes
      *
      * @param attributes Map of attributes by key. Set the value as an empty string to delete an attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or there's an error
      * setting the subscriber attributes.
      */
     static setAttributes(attributes: {
@@ -373,7 +373,7 @@ export default class Purchases {
      * Subscriber attribute associated with the email address for the user
      *
      * @param email Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the email.
      */
     static setEmail(email: string | null): Promise<void>;
@@ -381,7 +381,7 @@ export default class Purchases {
      * Subscriber attribute associated with the phone number for the user
      *
      * @param phoneNumber Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the phone number.
      */
     static setPhoneNumber(phoneNumber: string | null): Promise<void>;
@@ -389,7 +389,7 @@ export default class Purchases {
      * Subscriber attribute associated with the display name for the user
      *
      * @param displayName Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the display name.
      */
     static setDisplayName(displayName: string | null): Promise<void>;
@@ -397,14 +397,14 @@ export default class Purchases {
      * Subscriber attribute associated with the push token for the user
      *
      * @param pushToken null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the push token.
      */
     static setPushToken(pushToken: string | null): Promise<void>;
     /**
      * Set this property to your proxy URL before configuring Purchases *only* if you've received a proxy key value
      * from your RevenueCat contact.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the proxy url.
      */
     static setProxyURL(url: string): Promise<void>;
@@ -412,7 +412,7 @@ export default class Purchases {
      * Automatically collect subscriber attributes associated with the device identifiers.
      * $idfa, $idfv, $ip on iOS
      * $gpsAdId, $androidId, $ip on Android
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting collecting the device identifiers.
      */
     static collectDeviceIdentifiers(): Promise<void>;
@@ -421,7 +421,7 @@ export default class Purchases {
      * Required for the RevenueCat Adjust integration
      *
      * @param adjustID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting Adjust ID.
      */
     static setAdjustID(adjustID: string | null): Promise<void>;
@@ -429,7 +429,7 @@ export default class Purchases {
      * Subscriber attribute associated with the AppsFlyer Id for the user
      * Required for the RevenueCat AppsFlyer integration
      * @param appsflyerID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the Appsflyer ID.
      */
     static setAppsflyerID(appsflyerID: string | null): Promise<void>;
@@ -438,7 +438,7 @@ export default class Purchases {
      * Recommended for the RevenueCat Facebook integration
      *
      * @param fbAnonymousID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the Facebook Anonymous ID.
      */
     static setFBAnonymousID(fbAnonymousID: string | null): Promise<void>;
@@ -447,7 +447,7 @@ export default class Purchases {
      * Recommended for the RevenueCat mParticle integration
      *
      * @param mparticleID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the Mparticle ID.
      */
     static setMparticleID(mparticleID: string | null): Promise<void>;
@@ -456,7 +456,7 @@ export default class Purchases {
      * Required for the RevenueCat OneSignal integration
      *
      * @param onesignalID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the Onesignal ID.
      */
     static setOnesignalID(onesignalID: string | null): Promise<void>;
@@ -465,7 +465,7 @@ export default class Purchases {
      * Required for the RevenueCat Airship integration
      *
      * @param airshipChannelID Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the Airship Channel ID.
      */
     static setAirshipChannelID(airshipChannelID: string | null): Promise<void>;
@@ -473,7 +473,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install media source for the user
      *
      * @param mediaSource Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the media source.
      */
     static setMediaSource(mediaSource: string | null): Promise<void>;
@@ -481,7 +481,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install campaign for the user
      *
      * @param campaign Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the campaign.
      */
     static setCampaign(campaign: string | null): Promise<void>;
@@ -489,7 +489,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install ad group for the user
      *
      * @param adGroup Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting ad group.
      */
     static setAdGroup(adGroup: string | null): Promise<void>;
@@ -497,7 +497,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install ad for the user
      *
      * @param ad Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the ad subscriber attribute.
      */
     static setAd(ad: string | null): Promise<void>;
@@ -505,7 +505,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install keyword for the user
      *
      * @param keyword Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the keyword.
      */
     static setKeyword(keyword: string | null): Promise<void>;
@@ -513,7 +513,7 @@ export default class Purchases {
      * Subscriber attribute associated with the install ad creative for the user
      *
      * @param creative Empty String or null will delete the subscriber attribute.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet or if there's an error
+     * @returns {Promise<void>} The promise will be rejected if configure has not been called yet or if there's an error
      * setting the creative subscriber attribute.
      */
     static setCreative(creative: string | null): Promise<void>;
@@ -530,7 +530,7 @@ export default class Purchases {
      */
     static canMakePayments(features?: BILLING_FEATURE[]): Promise<boolean>;
     /**
-     * Check if setup has finished and Purchases has been configured.
+     * Check if configure has finished and Purchases has been configured.
      *
      * @returns {Promise<Boolean>} promise with boolean response
      */