Adds checkTrialOrIntroductoryPriceEligibility (#100)

vegaro · web-flow · commit 17543165d0be · 2019-12-17T15:35:54.000-08:00
* Adds checkTrialOrIntroductoryPriceEligibility and upgrades the native versions

* adds test

* updates npmignore

* Updates version

* tslint
diff --git a/.npmignore b/.npmignore
@@ -7,4 +7,8 @@ local.properties
 .vscode
 src/
 tsconfig.json
-
+*.iml
+android/build
+.DS_Store
+.circleci/config.yml
+RELEASING.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 3.0.3
+
+- Adds `Purchases.checkTrialOrIntroductoryPriceEligibility`. Note that Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.
+- Updates iOS to 3.0.1 and Android to 3.0.4
+
 ## 3.0.2
 
 - Adds `Purchases.addShouldPurchasePromoProduct` to be able to handle purchases started from the Apple App Store.
diff --git a/RNPurchases.podspec b/RNPurchases.podspec
@@ -19,5 +19,5 @@ Pod::Spec.new do |spec|
   spec.exclude_files = "ios/Purchases.framework"
 
   spec.dependency   "React"
-  spec.dependency   "Purchases", "~> 3.0.0"
+  spec.dependency   "Purchases", "~> 3.0.1"
 end
diff --git a/VERSIONS.md b/VERSIONS.md
@@ -1,5 +1,6 @@
 | Version | iOS version | Android version | Common files version |
 |---------|-------------|-----------------|----------------------|
+| 3.0.3   | 3.0.1       | 3.0.4           | 1.0.4                |
 | 3.0.2   | 3.0.0       | 3.0.3           | 1.0.3                |
 | 3.0.1   | 3.0.0       | 3.0.3           | 1.0.1                |
 | 3.0.0   | 3.0.0       | 3.0.2           | 1.0.1                |
diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -518,6 +518,14 @@ describe("Purchases", () => {
     expect(NativeModules.RNPurchases.setFinishTransactions).toBeCalledTimes(2);
   })
 
+  it("checkTrialOrIntroductoryPriceEligibility works", () => {
+    const Purchases = require("../index").default;
+
+    Purchases.checkTrialOrIntroductoryPriceEligibility(["monthly"])
+
+    expect(NativeModules.RNPurchases.checkTrialOrIntroductoryPriceEligibility).toBeCalledWith(["monthly"]);
+  })
+
   const mockPlatform = OS => {
     jest.resetModules();
     jest.doMock("Platform", () => ({OS, select: objs => objs[OS]}));
diff --git a/android/build.gradle b/android/build.gradle
@@ -38,6 +38,6 @@ repositories {
 dependencies {
     //noinspection GradleDynamicVersion
     api 'com.facebook.react:react-native:+'
-    implementation 'com.revenuecat.purchases:purchases:3.0.3'
+    implementation 'com.revenuecat.purchases:purchases:3.0.4'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 }
diff --git a/android/common/build.gradle b/android/common/build.gradle
diff --git a/android/common/common-release.aar b/android/common/common-release.aar
diff --git a/android/src/main/java/com/reactlibrary/RNPurchasesModule.java b/android/src/main/java/com/reactlibrary/RNPurchasesModule.java
@@ -5,7 +5,6 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
-import com.android.billingclient.api.SkuDetails;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
@@ -188,6 +187,15 @@ public void isAnonymous(final Promise promise) {
         promise.resolve(CommonKt.isAnonymous());
     }
 
+    @ReactMethod
+    public void checkTrialOrIntroductoryPriceEligibility(ReadableArray productIDs, final Promise promise) {
+        ArrayList<String> productIDList = new ArrayList<>();
+        for (int i = 0; i < productIDs.size(); i++) {
+            productIDList.add(productIDs.getString(i));
+        }
+        promise.resolve(convertMapToWriteableMap(CommonKt.checkTrialOrIntroductoryPriceEligibility(productIDList)));
+    }
+
     @Override
     public void onReceived(@NonNull PurchaserInfo purchaserInfo) {
         reactContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
diff --git a/android/src/main/java/com/revenuecat/purchases/common/common.kt b/android/src/main/java/com/revenuecat/purchases/common/common.kt
@@ -256,6 +256,16 @@ fun setFinishTransactions(
     Purchases.sharedInstance.finishTransactions = enabled
 }
 
+// Returns Unknown for all since it's not available in Android
+fun checkTrialOrIntroductoryPriceEligibility(
+    productIdentifiers: List<String>
+): Map<String, Map<String, Any>> {
+    // INTRO_ELIGIBILITY_STATUS_UNKNOWN = 0
+    return productIdentifiers.map {
+        it to mapOf("status" to 0, "description" to "Status indeterminate.")
+    }.toMap()
+}
+
 private fun getMakePurchaseErrorFunction(onResult: OnResult): (PurchasesError, Boolean) -> Unit {
     return { error, userCancelled -> onResult.onError(error.map(mapOf("userCancelled" to userCancelled))) }
 }
diff --git a/build.js b/build.js
@@ -5,11 +5,11 @@ if (os.type() === "Linux") {
   console.log("Skipping iOS Dependencies");
 } else if (os.type() === "Darwin") {
   const downloadProcess = exec(
-    "./scripts/download-purchases-framework.sh 3.0.0"
+    "./scripts/download-purchases-framework.sh 3.0.1"
   );
   downloadProcess.stdout.pipe(process.stdout);
   const downloadProcessCommon = exec(
-    "./scripts/download-purchases-common.sh 1.0.3"
+    "./scripts/download-purchases-common.sh 1.0.4"
   );
   downloadProcessCommon.stdout.pipe(process.stdout);
 } else if (os.type() === "Windows_NT") {
diff --git a/index.d.ts b/index.d.ts
@@ -78,6 +78,20 @@ declare enum PACKAGE_TYPE {
      */
     WEEKLY = "WEEKLY"
 }
+declare enum INTRO_ELIGIBILITY_STATUS {
+    /**
+     * RevenueCat doesn't have enough information to determine eligibility.
+     */
+    INTRO_ELIGIBILITY_STATUS_UNKNOWN = 0,
+    /**
+     * The user is not eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS_INELIGIBLE = 1,
+    /**
+     * The user is eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS_ELIGIBLE = 2
+}
 /**
  * The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.
  */
@@ -354,6 +368,19 @@ interface UpgradeInfo {
      */
     readonly prorationMode?: PRORATION_MODE;
 }
+/**
+ * Holds the introductory price status
+ */
+interface IntroEligibility {
+    /**
+     * The introductory price eligibility status
+     */
+    readonly introEligibilityStatus: INTRO_ELIGIBILITY_STATUS;
+    /**
+     * Description of the status
+     */
+    readonly description: string;
+}
 /**
  * Listener used on updated purchaser info
  * @callback PurchaserInfoUpdateListener
@@ -399,6 +426,12 @@ export default class Purchases {
      * @enum {string}
      */
     static PACKAGE_TYPE: typeof PACKAGE_TYPE;
+    /**
+     * Enum of different possible states for intro price eligibility status.
+     * @readonly
+     * @enum {number}
+     */
+    static INTRO_ELIGIBILITY_STATUS: typeof INTRO_ELIGIBILITY_STATUS;
     /**
      * Sets up Purchases with your API key and an app user id.
      * @param {string} apiKey RevenueCat API Key. Needs to be a String
@@ -429,12 +462,12 @@ export default class Purchases {
      */
     static removePurchaserInfoUpdateListener(listenerToRemove: PurchaserInfoUpdateListener): boolean;
     /**
-     * Sets a function to be called on purchases initiated on the App Store
+     * 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
      * promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run
-     * the deferredPurchase function. If the app is not in a state to make a purchase: cache the defermentPurchase, then
-     * call the defermentPurchase when the app is ready to make the promotional purchase.
-     * If the purchase should never be made, you don't need to ever call the defermentPurchase and the app will not
+     * the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then
+     * call the deferredPurchase when the app is ready to make the promotional purchase.
+     * If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not
      * proceed with promotional purchases.
      */
     static addShouldPurchasePromoProductListener(shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener): void;
@@ -521,12 +554,12 @@ export default class Purchases {
     /**
      * 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<Object>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     static identify(newAppUserID: string): Promise<PurchaserInfo>;
     /**
      * Resets the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.
-     * @returns {Promise<Object>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     static reset(): Promise<PurchaserInfo>;
     /**
@@ -536,7 +569,7 @@ export default class Purchases {
     static setDebugLogsEnabled(enabled: boolean): Promise<void>;
     /**
      * Gets current purchaser info
-     * @return {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     static getPurchaserInfo(): Promise<PurchaserInfo>;
     /**
@@ -552,8 +585,25 @@ export default class Purchases {
      */
     static setAutomaticAppleSearchAdsAttributionCollection(enabled: boolean): void;
     /**
-     * @return {Promise<boolean>} If the `appUserID` has been generated by RevenueCat or not.
+     * @returns {Promise<boolean>} If the `appUserID` has been generated by RevenueCat or not.
      */
     static isAnonymous(): Promise<boolean>;
+    /**
+     *  iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product.
+     *  You should use this method to determine whether or not you show the user the normal product price or the
+     *  introductory price. This also applies to trials (trials are considered a type of introductory pricing).
+     *
+     *  @note Subscription groups are automatically collected for determining eligibility. If RevenueCat can't
+     *  definitively compute the eligibility, most likely because of missing group information, it will return
+     *  `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro
+     *  pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of
+     *  iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.
+     *
+     *  @param productIdentifiers Array of product identifiers for which you want to compute eligibility
+     *  @returns { [productId: string]: IntroEligibility } A map of IntroEligility per productId
+     */
+    static checkTrialOrIntroductoryPriceEligibility(productIdentifiers: string[]): Promise<{
+        [productId: string]: IntroEligibility;
+    }>;
 }
 export {};
diff --git a/index.js b/index.js
@@ -88,6 +88,21 @@ var PACKAGE_TYPE;
      */
     PACKAGE_TYPE["WEEKLY"] = "WEEKLY";
 })(PACKAGE_TYPE || (PACKAGE_TYPE = {}));
+var INTRO_ELIGIBILITY_STATUS;
+(function (INTRO_ELIGIBILITY_STATUS) {
+    /**
+     * RevenueCat doesn't have enough information to determine eligibility.
+     */
+    INTRO_ELIGIBILITY_STATUS[INTRO_ELIGIBILITY_STATUS["INTRO_ELIGIBILITY_STATUS_UNKNOWN"] = 0] = "INTRO_ELIGIBILITY_STATUS_UNKNOWN";
+    /**
+     * The user is not eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS[INTRO_ELIGIBILITY_STATUS["INTRO_ELIGIBILITY_STATUS_INELIGIBLE"] = 1] = "INTRO_ELIGIBILITY_STATUS_INELIGIBLE";
+    /**
+     * The user is eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS[INTRO_ELIGIBILITY_STATUS["INTRO_ELIGIBILITY_STATUS_ELIGIBLE"] = 2] = "INTRO_ELIGIBILITY_STATUS_ELIGIBLE";
+})(INTRO_ELIGIBILITY_STATUS || (INTRO_ELIGIBILITY_STATUS = {}));
 var purchaserInfoUpdateListeners = [];
 var shouldPurchasePromoProductListeners = [];
 exports.isUTCDateStringFuture = function (dateString) {
@@ -160,12 +175,12 @@ var Purchases = /** @class */ (function () {
         return false;
     };
     /**
-     * Sets a function to be called on purchases initiated on the App Store
+     * 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
      * promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run
-     * the deferredPurchase function. If the app is not in a state to make a purchase: cache the defermentPurchase, then
-     * call the defermentPurchase when the app is ready to make the promotional purchase.
-     * If the purchase should never be made, you don't need to ever call the defermentPurchase and the app will not
+     * the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then
+     * call the deferredPurchase when the app is ready to make the promotional purchase.
+     * If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not
      * proceed with promotional purchases.
      */
     Purchases.addShouldPurchasePromoProductListener = function (shouldPurchasePromoProductListener) {
@@ -306,7 +321,7 @@ var Purchases = /** @class */ (function () {
     /**
      * 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<Object>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     Purchases.identify = function (newAppUserID) {
         // noinspection SuspiciousTypeOfGuard
@@ -317,7 +332,7 @@ var Purchases = /** @class */ (function () {
     };
     /**
      * Resets the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.
-     * @returns {Promise<Object>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     Purchases.reset = function () {
         return RNPurchases.reset();
@@ -331,7 +346,7 @@ var Purchases = /** @class */ (function () {
     };
     /**
      * Gets current purchaser info
-     * @return {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
+     * @returns {Promise<PurchaserInfo>} A promise of a purchaser info object. Rejections return an error code, and a userInfo object with more information.
      */
     Purchases.getPurchaserInfo = function () {
         return RNPurchases.getPurchaserInfo();
@@ -357,11 +372,28 @@ var Purchases = /** @class */ (function () {
         }
     };
     /**
-     * @return {Promise<boolean>} If the `appUserID` has been generated by RevenueCat or not.
+     * @returns {Promise<boolean>} If the `appUserID` has been generated by RevenueCat or not.
      */
     Purchases.isAnonymous = function () {
         return RNPurchases.isAnonymous();
     };
+    /**
+     *  iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product.
+     *  You should use this method to determine whether or not you show the user the normal product price or the
+     *  introductory price. This also applies to trials (trials are considered a type of introductory pricing).
+     *
+     *  @note Subscription groups are automatically collected for determining eligibility. If RevenueCat can't
+     *  definitively compute the eligibility, most likely because of missing group information, it will return
+     *  `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro
+     *  pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of
+     *  iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.
+     *
+     *  @param productIdentifiers Array of product identifiers for which you want to compute eligibility
+     *  @returns { [productId: string]: IntroEligibility } A map of IntroEligility per productId
+     */
+    Purchases.checkTrialOrIntroductoryPriceEligibility = function (productIdentifiers) {
+        return RNPurchases.checkTrialOrIntroductoryPriceEligibility(productIdentifiers);
+    };
     /**
      * Enum for attribution networks
      * @readonly
@@ -394,6 +426,12 @@ var Purchases = /** @class */ (function () {
      * @enum {string}
      */
     Purchases.PACKAGE_TYPE = PACKAGE_TYPE;
+    /**
+     * Enum of different possible states for intro price eligibility status.
+     * @readonly
+     * @enum {number}
+     */
+    Purchases.INTRO_ELIGIBILITY_STATUS = INTRO_ELIGIBILITY_STATUS;
     return Purchases;
 }());
 exports.default = Purchases;
diff --git a/ios/RNPurchases.m b/ios/RNPurchases.m
@@ -165,6 +165,15 @@ - (dispatch_queue_t)methodQueue
     [RCCommonFunctionality makeDeferredPurchase:defermentBlock completionBlock:[self getResponseCompletionBlockWithResolve:resolve reject:reject]];
 }
 
+RCT_EXPORT_METHOD(checkTrialOrIntroductoryPriceEligibility:(NSArray *)products
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+    [RCCommonFunctionality checkTrialOrIntroductoryPriceEligibility:products completionBlock:^(NSDictionary<NSString *,RCIntroEligibility *> * _Nonnull responseDictionary) {
+        resolve([NSDictionary dictionaryWithDictionary:responseDictionary]);
+    }];
+}
+
     
 #pragma mark -
 #pragma mark Delegate Methods
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-native-purchases",
   "title": "React Native Purchases",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "",
   "main": "index.js",
   "scripts": {
diff --git a/setupJest.js b/setupJest.js
@@ -670,6 +670,7 @@ NativeModules.RNPurchases = {
   purchasePackage: jest.fn(),
   isAnonymous: jest.fn(),
   makeDeferredPurchase: jest.fn(),
+  checkTrialOrIntroductoryPriceEligibility: jest.fn(),
 };
 
 jest.mock('NativeEventEmitter');
diff --git a/src/index.ts b/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,6 @@ repositories {`
`38`	`38`	`dependencies {`
`39`	`39`	`//noinspection GradleDynamicVersion`
`40`	`40`	`api 'com.facebook.react:react-native:+'`
`41`		`- implementation 'com.revenuecat.purchases:purchases:3.0.3'`
	`41`	`+ implementation 'com.revenuecat.purchases:purchases:3.0.4'`
`42`	`42`	`implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"`
`43`	`43`	`}`