react-native-purchases 4.6.1 → 5.0.0-beta.1

package/dist/purchases.d.ts

@@ -1,25 +1,17 @@
 import { PURCHASES_ERROR_CODE, UninitializedPurchasesError } from "./errors";
-import { PurchaserInfo } from "./purchaserInfo";
-import { PRORATION_MODE, PACKAGE_TYPE, INTRO_ELIGIBILITY_STATUS, PurchasesOfferings, PurchasesProduct, UpgradeInfo, PurchasesPaymentDiscount, PurchasesPackage, IntroEligibility, PurchasesDiscount } from "./offerings";
+import { CustomerInfo } from "./customerInfo";
+import { PRORATION_MODE, PACKAGE_TYPE, INTRO_ELIGIBILITY_STATUS, PurchasesOfferings, PurchasesStoreProduct, UpgradeInfo, PurchasesPromotionalOffer, PurchasesPackage, IntroEligibility, PurchasesStoreProductDiscount } from "./offerings";
 /**
- * Listener used on updated purchaser info
- * @callback PurchaserInfoUpdateListener
- * @param {Object} purchaserInfo Object containing info for the purchaser
+ * Listener used on updated customer info
+ * @callback CustomerInfoUpdateListener
+ * @param {Object} customerInfo Object containing info for the customer
  */
-export declare type PurchaserInfoUpdateListener = (purchaserInfo: PurchaserInfo) => void;
+export declare type CustomerInfoUpdateListener = (customerInfo: CustomerInfo) => void;
 export declare type ShouldPurchasePromoProductListener = (deferredPurchase: () => Promise<MakePurchaseResult>) => void;
 export declare type MakePurchaseResult = {
     productIdentifier: string;
-    purchaserInfo: PurchaserInfo;
+    customerInfo: CustomerInfo;
 };
-export declare enum ATTRIBUTION_NETWORK {
-    APPLE_SEARCH_ADS = 0,
-    ADJUST = 1,
-    APPSFLYER = 2,
-    BRANCH = 3,
-    TENJIN = 4,
-    FACEBOOK = 5
-}
 export declare enum PURCHASE_TYPE {
     /**
      * A type of SKU for in-app products.
@@ -62,29 +54,15 @@ export declare enum BILLING_FEATURE {
  */
 export interface LogInResult {
     /**
-     * The Purchaser Info for the user.
+     * The Customer Info for the user.
      */
-    readonly purchaserInfo: PurchaserInfo;
+    readonly customerInfo: CustomerInfo;
     /**
      * True if the call resulted in a new user getting created in the RevenueCat backend.
      */
     readonly created: boolean;
 }
 export default class Purchases {
-    /**
-     * Enum for attribution networks
-     * @readonly
-     * @enum {number}
-     */
-    static ATTRIBUTION_NETWORK: typeof ATTRIBUTION_NETWORK;
-    /**
-     * @deprecated use ATTRIBUTION_NETWORK instead
-     *
-     * Enum for attribution networks
-     * @readonly
-     * @enum {number}
-     */
-    static ATTRIBUTION_NETWORKS: typeof ATTRIBUTION_NETWORK;
     /**
      * Supported SKU types.
      * @readonly
@@ -128,12 +106,13 @@ export default class Purchases {
      * Sets up Purchases with your API key and an app user id.
      * @param {String} apiKey RevenueCat API Key. Needs to be a String
      * @param {String?} appUserID An optional unique id for identifying the user. Needs to be a string.
-     * @param {boolean?} observerMode An optional boolean. Set this to TRUE if you have your own IAP implementation and want to use only RevenueCat's backend. Default is FALSE.
+     * @param {boolean} [observerMode=false] An optional boolean. Set this to TRUE if you have your own IAP implementation and want to use only RevenueCat's backend. Default is FALSE.
+     * @param {boolean} [usesStoreKit2IfAvailable=false] An optional boolean. iOS-only. Set this to TRUE to enable StoreKit2 on compatible devices.
      * @param {String?} userDefaultsSuiteName An optional string. iOS-only, will be ignored for Android.
      * Set this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults suite, otherwise it will use standardUserDefaults.
      * Default is null, which will make the SDK use standardUserDefaults.
      */
-    static setup(apiKey: string, appUserID?: string | null, observerMode?: boolean, userDefaultsSuiteName?: string): void;
+    static configure(apiKey: string, appUserID?: string | null, observerMode?: boolean, userDefaultsSuiteName?: string, usesStoreKit2IfAvailable?: boolean): void;
     /**
      * @deprecated, configure behavior through the RevenueCat dashboard instead.
      * If an user tries to purchase a product that is active on the current app store account,
@@ -157,16 +136,16 @@ export default class Purchases {
      */
     static setSimulatesAskToBuyInSandbox(simulatesAskToBuyInSandbox: boolean): Promise<void>;
     /**
-     * Sets a function to be called on updated purchaser info
-     * @param {PurchaserInfoUpdateListener} purchaserInfoUpdateListener PurchaserInfo update listener
+     * Sets a function to be called on updated customer info
+     * @param {CustomerInfoUpdateListener} customerInfoUpdateListener CustomerInfo update listener
      */
-    static addPurchaserInfoUpdateListener(purchaserInfoUpdateListener: PurchaserInfoUpdateListener): void;
+    static addCustomerInfoUpdateListener(customerInfoUpdateListener: CustomerInfoUpdateListener): void;
     /**
-     * Removes a given PurchaserInfoUpdateListener
-     * @param {PurchaserInfoUpdateListener} listenerToRemove PurchaserInfoUpdateListener reference of the listener to remove
+     * Removes a given CustomerInfoUpdateListener
+     * @param {CustomerInfoUpdateListener} listenerToRemove CustomerInfoUpdateListener reference of the listener to remove
      * @returns {boolean} True if listener was removed, false otherwise
      */
-    static removePurchaserInfoUpdateListener(listenerToRemove: PurchaserInfoUpdateListener): boolean;
+    static removeCustomerInfoUpdateListener(listenerToRemove: CustomerInfoUpdateListener): boolean;
     /**
      * Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS.
      * @param {ShouldPurchasePromoProductListener} shouldPurchasePromoProductListener Called when a user initiates a
@@ -184,18 +163,6 @@ export default class Purchases {
      * @returns {boolean} True if listener was removed, false otherwise
      */
     static removeShouldPurchasePromoProductListener(listenerToRemove: ShouldPurchasePromoProductListener): boolean;
-    /**
-     * @deprecated, use set<NetworkId> methods instead.
-     *
-     * Add a dict of attribution information
-     * @param {Dict} data Attribution data from AppsFlyer, Adjust, or Branch
-     * @param {ATTRIBUTION_NETWORKS} network Which network, see Purchases.ATTRIBUTION_NETWORKS
-     * @param {String?} networkUserId An optional unique id for identifying the user. Needs to be a string.
-     * @returns {Promise<void>} The promise will be rejected if setup has not been called yet.
-     */
-    static addAttributionData(data: {
-        [key: string]: any;
-    }, network: ATTRIBUTION_NETWORK, networkUserId?: string): Promise<void>;
     /**
      * Gets the map of entitlements -> offerings -> products
      * @returns {Promise<PurchasesOfferings>} Promise of entitlements structure. The promise will be rejected if setup
@@ -206,12 +173,12 @@ export default class Purchases {
      * Fetch the product info
      * @param {String[]} productIdentifiers Array of product identifiers
      * @param {String} type Optional type of products to fetch, can be inapp or subs. Subs by default
-     * @returns {Promise<PurchasesProduct[]>} A promise containing an array of products. The promise will be rejected
+     * @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.
      */
-    static getProducts(productIdentifiers: string[], type?: PURCHASE_TYPE): Promise<PurchasesProduct[]>;
+    static getProducts(productIdentifiers: string[], type?: PURCHASE_TYPE): Promise<PurchasesStoreProduct[]>;
     /**
      * Make a purchase
      *
@@ -219,8 +186,8 @@ export default class Purchases {
      * @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU
      * and the optional prorationMode.
      * @param {String} type Optional type of product, can be inapp or subs. Subs by default
-     * @returns {Promise<{ productIdentifier: string, purchaserInfo:PurchaserInfo }>} A promise of an object containing
-     * a purchaser info object and a product identifier. Rejections return an error code,
+     * @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.
      */
@@ -228,22 +195,22 @@ export default class Purchases {
     /**
      * iOS only. Purchase a product applying a given discount.
      *
-     * @param {PurchasesProduct} product The product you want to purchase
-     * @param {PurchasesPaymentDiscount} discount Discount to apply to this package. Retrieve this discount using getPaymentDiscount.
-     * @returns {Promise<{ productIdentifier: string, purchaserInfo:PurchaserInfo }>} A promise of an object containing
-     * a purchaser info object and a product identifier. Rejections return an error code,
+     * @param {PurchasesStoreProduct} product The product you want to purchase
+     * @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
      * rejected if setup has not been called yet.
      */
-    static purchaseDiscountedProduct(product: PurchasesProduct, discount: PurchasesPaymentDiscount): Promise<MakePurchaseResult>;
+    static purchaseDiscountedProduct(product: PurchasesStoreProduct, discount: PurchasesPromotionalOffer): Promise<MakePurchaseResult>;
     /**
      * Make a purchase
      *
      * @param {PurchasesPackage} aPackage The Package you wish to purchase. You can get the Packages by calling getOfferings
      * @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU
      * and the optional prorationMode.
-     * @returns {Promise<{ productIdentifier: string, purchaserInfo: PurchaserInfo }>} A promise of an object containing
-     * a purchaser info object and a product identifier. Rejections return an error code, a boolean indicating if the
+     * @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
      * has not been called yet.
      */
@@ -252,19 +219,19 @@ export default class Purchases {
      * iOS only. Purchase a package applying a given discount.
      *
      * @param {PurchasesPackage} aPackage The Package you wish to purchase. You can get the Packages by calling getOfferings
-     * @param {PurchasesPaymentDiscount} discount Discount to apply to this package. Retrieve this discount using getPaymentDiscount.
-     * @returns {Promise<{ productIdentifier: string, purchaserInfo: PurchaserInfo }>} A promise of an object containing
-     * a purchaser info object and a product identifier. Rejections return an error code, a boolean indicating if the
+     * @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
      * has not been called yet.
      */
-    static purchaseDiscountedPackage(aPackage: PurchasesPackage, discount: PurchasesPaymentDiscount): Promise<MakePurchaseResult>;
+    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<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and an
+     * @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.
      */
-    static restoreTransactions(): Promise<PurchaserInfo>;
+    static restoreTransactions(): Promise<CustomerInfo>;
     /**
      * Get the appUserID
      * @returns {Promise<string>} The app user id in a promise
@@ -274,59 +241,30 @@ export default class Purchases {
      * This function will logIn the current user with an appUserID. Typically this would be used after a log in
      * to identify a user without calling configure.
      * @param {String} appUserID The appUserID that should be linked to the currently user
-     * @returns {Promise<LogInResult>} A promise of an object that contains the purchaserInfo after logging in, as well
+     * @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.
      */
     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<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code,
+     * @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
      * there's an issue logging out.
      */
-    static logOut(): Promise<PurchaserInfo>;
-    /**
-     * @deprecated, use logIn instead.
-     * This function will alias two appUserIDs together.
-     * @param {String} newAppUserID The new appUserID that should be linked to the currently identified appUserID.
-     * Needs to be a string.
-     * @returns {Promise<PurchaserInfo>} A promise of a purchaser 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
-     * there's an issue creating the alias.
-     */
-    static createAlias(newAppUserID: string): Promise<PurchaserInfo>;
-    /**
-     * @deprecated, use logIn instead.
-     * This function will identify the current user with an appUserID. Typically this would be used after a logout to
-     * identify a new user without calling configure
-     * @param {String} newAppUserID The appUserID that should be linked to the currently user
-     * @returns {Promise<PurchaserInfo>} A promise of a purchaser 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
-     * there's an issue identifying the user.
-     */
-    static identify(newAppUserID: string): Promise<PurchaserInfo>;
-    /**
-     * @deprecated, use logOut instead.
-     * Resets the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the
-     *  cache.
-     * @returns {Promise<PurchaserInfo>} A promise of a purchaser 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
-     * there's an issue resetting the user.
-     */
-    static reset(): Promise<PurchaserInfo>;
+    static logOut(): Promise<CustomerInfo>;
     /**
      * Enables/Disables debugs logs
      * @param {boolean} enabled Enable or not debug logs
      */
     static setDebugLogsEnabled(enabled: boolean): Promise<void>;
     /**
-     * Gets current purchaser info
-     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and an
+     * 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
-     * there's an issue getting the purchaser information.
+     * there's an issue getting the customer information.
      */
-    static getPurchaserInfo(): Promise<PurchaserInfo>;
+    static getCustomerInfo(): Promise<CustomerInfo>;
     /**
      * This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation
      * for subscriptions anytime a sync is needed, like after a successful purchase.
@@ -366,28 +304,28 @@ export default class Purchases {
         [productId: string]: IntroEligibility;
     }>;
     /**
-     * iOS only. Use this function to retrieve the `PurchasesPaymentDiscount` for a given `PurchasesPackage`.
+     * 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.
-     * @returns { Promise<PurchasesPaymentDiscount> } Returns when the `PurchasesPaymentDiscount` is returned.
+     * @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
      * called yet or if there's an error getting the payment discount.
      */
-    static getPaymentDiscount(product: PurchasesProduct, discount: PurchasesDiscount): Promise<PurchasesPaymentDiscount | undefined>;
+    static getPromotionalOffer(product: PurchasesStoreProduct, discount: PurchasesStoreProductDiscount): Promise<PurchasesPromotionalOffer | undefined>;
     /**
-     * Invalidates the cache for purchaser information.
+     * Invalidates the cache for customer information.
      *
      * Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state.
-     * Refer to https://docs.revenuecat.com/docs/purchaserinfo#section-get-user-information for more information on
+     * Refer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on
      * using the cache properly.
      *
-     * This is useful for cases where purchaser information might have been updated outside of the app, like if a
+     * 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
-     * invalidating the purchaser info cache.
+     * invalidating the customer info cache.
      */
-    static invalidatePurchaserInfoCache(): Promise<void>;
+    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
@@ -565,9 +503,9 @@ export default class Purchases {
      * Note: Billing features are only relevant to Google Play Android users.
      * For other stores and platforms, billing features won't be checked.
      *
-     * @param feature An array of feature types to check for support. Feature types must be one of
+     * @param features An array of feature types to check for support. Feature types must be one of
      *       [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked.
-     * @returns {Promise<Boolean>} promise with boolean response. True if billing is supported, false otherwise.
+     * @returns {Promise<boolean>} promise with boolean response. True if billing is supported, false otherwise.
      */
     static canMakePayments(features?: BILLING_FEATURE[]): Promise<boolean>;
     /**