Merge pull request #612 from AppsFlyerSDK/dev/DELIVERY-82509/6.16.2-consent-update

Update to 6.16.2 & AppsFlyerConsent update

Author: al-af

Docs/RN_CMP.md

@@ -59,81 +59,123 @@ A CMP compatible with TCF v2.2 collects DMA consent data and stores it in NSUser
     }
  },[])
 ```
-## Manually collect consent data
-If your app does not use a CMP compatible with TCF v2.2, use the SDK API detailed below to provide the consent data directly to the SDK.
-
-### When GDPR applies to the user
-If GDPR applies to the user, perform the following:
-
-1. Given that GDPR is applicable to the user, determine whether the consent data is already stored for this session.
-    1. If there is no consent data stored, show the consent dialog to capture the user consent decision.
-    2. If there is consent data stored continue to the next step.
-2. To transfer the consent data to the SDK create an AppsFlyerConsent object using `forGDPRUser` method that accepts the following parameters:<br>
-    `hasConsentForDataUsage: boolean` - Indicates whether the user has consented to use their data for advertising purposes.<br>
-    `hasConsentForAdsPersonalization: boolean` - Indicates whether the user has consented to use their data for personalized advertising.
-3. Call `appsFlyer.setConsentData(consentData)` with the AppsFlyerConsent object.
-4. Call `appsFlyer.initSdk()`.
+
+### Manually Collecting Consent Data
+
+If your app does not use a TCF v2.2-compatible CMP, you must manually provide the consent data using the SDK API.
+
+How to Set Consent Data: </br>
+1.	Determine GDPR Applicability:
+    *	If GDPR applies, check whether consent data is already stored.
+    *	If not stored, show a consent dialog to obtain user consent.
+2.	Create an AppsFlyerConsent object with the relevant parameters.
+3.	Pass the consent data to the SDK using appsFlyer.setConsentData(consentData).
+4.	Initialize the SDK with appsFlyer.initSdk().
+
+#### Setting Consent Data for Users
+
+<b>When GDPR Applies</b>
+
+If GDPR applies to the user, create an AppsFlyerConsent object with the user’s preferences.
 ```javascript
-import appsFlyer, {AppsFlyerConsent} from 'react-native-appsflyer';
+import appsFlyer, { AppsFlyerConsent } from 'react-native-appsflyer';
 
 useEffect(() => {
     const option = {
-    isDebug: true,
-    devKey: 'UxXxXxXxXd',
-    onInstallConversionDataListener: true,
-    onDeepLinkListener: true,
-    timeToWaitForATTUserAuthorization: 10,
+        isDebug: true,
+        devKey: 'UxXxXxXxXd',
+        onInstallConversionDataListener: true,
+        onDeepLinkListener: true,
+        timeToWaitForATTUserAuthorization: 10,
     };
 
-    // user consent data
-    let consentData = AppsFlyerConsent.forGDPRUser(true, false);
+    // User has given consent
+    const consentData = new AppsFlyerConsent(true, true, true, true);
 
+    // Send consent data to the SDK
     appsFlyer.setConsentData(consentData);
 
-    //start appsflyer
+    // Start AppsFlyer SDK
     appsFlyer.initSdk(
-      option,
-      res => {
-        console.log(res);
-      },
-      err => {
-        console.log(err);
-      },
+        option,
+        res => console.log(res),
+        err => console.log(err)
     );
- },[])
+}, []);
 ```
-### When GDPR does not apply to the user
 
-If GDPR doesn’t apply to the user perform the following:
-1. Create an AppsFlyerConsent object using `forNonGDPRUser` method that doesn't accepts any parameters
-2. Call `appsFlyer.setConsentData(consentData)` with the AppsFlyerConsent object.
-3. Call `appsFlyer.initSdk()`.
+<b>When GDPR Does Not Apply</b>
+
+If GDPR does not apply to the user, simply mark it as such in the AppsFlyerConsent object.
 ```javascript
-import appsFlyer, {AppsFlyerConsent} from 'react-native-appsflyer';
+import appsFlyer, { AppsFlyerConsent } from 'react-native-appsflyer';
 
 useEffect(() => {
     const option = {
-    isDebug: true,
-    devKey: 'UxXxXxXxXd',
-    onInstallConversionDataListener: true,
-    onDeepLinkListener: true,
-    timeToWaitForATTUserAuthorization: 10,
+        isDebug: true,
+        devKey: 'UxXxXxXxXd',
+        onInstallConversionDataListener: true,
+        onDeepLinkListener: true,
+        timeToWaitForATTUserAuthorization: 10,
     };
 
     // GDPR does not apply to the user
-   let consentData = AppsFlyerConsent.forNonGDPRUser();
+    const consentData = new AppsFlyerConsent(false);
 
-   appsFlyer.setConsentData(consentData);
+    // Send consent data to the SDK
+    appsFlyer.setConsentData(consentData);
 
-    //start appsflyer
+    // Start AppsFlyer SDK
     appsFlyer.initSdk(
-      option,
-      res => {
-        console.log(res);
-      },
-      err => {
-        console.log(err);
-      },
+        option,
+        res => console.log(res),
+        err => console.log(err)
     );
- },[])
-```
+}, []);
+```
+
+### Consent Object API
+
+```javascript
+//AppsFlyerConsent Constructor:
+
+new AppsFlyerConsent(
+    isUserSubjectToGDPR,          // Boolean (optional) - Whether GDPR applies to the user
+    hasConsentForDataUsage,       // Boolean (optional) - Consent for data usage
+    hasConsentForAdsPersonalization, // Boolean (optional) - Consent for ads personalization
+    hasConsentForAdStorage        // Boolean (optional) - Consent for ad storage
+);
+
+//Example Cases:
+
+// Full consent for GDPR user
+const consent1 = new AppsFlyerConsent(true, true, true, true);
+
+// No consent for GDPR user
+const consent2 = new AppsFlyerConsent(true, false, false, false);
+
+// Non-GDPR user
+const consent3 = new AppsFlyerConsent(false);
+
+// AppsFlyerConsent object support the following cases if they are needed.
+const consent4 = new AppsFlyerConsent(true);
+const consent5 = new AppsFlyerConsent(true, true);
+const consent6 = new AppsFlyerConsent(null, true, true, true);
+const consent7 = new AppsFlyerConsent(true, null, true, true);
+const consent8 = new AppsFlyerConsent(true, true, null, true);
+const consent9 = new AppsFlyerConsent(true, true, true, null);
+const consent10 = new AppsFlyerConsent(true, true, false, true);
+const consent11 = new AppsFlyerConsent(false, true, false, false);
+const consent12 = new AppsFlyerConsent(null, null, null, null);
+const consent13 = new AppsFlyerConsent();
+```
+
+### Deprecation Notice
+
+The following methods have been deprecated since SDK version 6.16.2 and should no longer be used:
+```javascript
+// Deprecated since 6.16.2
+AppsFlyerConsent.forGDPRUser(true, false);
+AppsFlyerConsent.forNonGDPRUser();
+```
+Instead, use the new AppsFlyerConsent constructor.

Docs/RN_Installation.md

@@ -137,45 +137,6 @@ So `getPackages()` should look like:
     }
 ```
 
-## Android Build Error Due to AGP Version
-
-If you encounter the following error while building your project:
-```
-Execution failed for task ':app:mergeExtDexDebug'.
-> Could not resolve all files for configuration ':app:debugRuntimeClasspath'.
-   > Failed to transform af-android-sdk-6.16.0.aar (com.appsflyer:af-android-sdk:6.16.0) to match attributes {artifactType=android-dex, asm-transformed-variant=NONE, dexing-enable-desugaring=true, dexing-is-debuggable=true, dexing-min-sdk=21, org.gradle.category=library, org.gradle.dependency.bundling=external, org.gradle.libraryelements=aar, org.gradle.status=release, org.gradle.usage=java-runtime}.
-      > Execution failed for DexingWithClasspathTransform: /Users/amit.levy/.gradle/caches/transforms-3/fb46dcab411d99e4e97f01029413cab1/transformed/jetified-af-android-sdk-6.16.0-runtime.jar.
-         > Error while dexing.
-```
-
-This error occurs if you are using Android Gradle Plugin (AGP) below 8.2.0 due to a known bug in R8.
-Google has already resolved this issue
-[see Google Issue Tracker](https://issuetracker.google.com/issues/290412574?pli=1).
-
-
-### Solutions
-
-To fix this issue, you have two options:
-1. Upgrade AGP to 8.2.0+ (Recommended):
-  <br/>Updating AGP to 8.2.0 or later ensures compatibility with the latest R8 version.<br/>Sync and rebuild your project
-
-2. Manually Override the R8 Version
-<br/>If upgrading AGP is not an option, you can manually set an external newer R8 version to override the bundled one.
-<br/> Open android/build.gradle and add this inside the buildscript {} block then sync and rebuild your project:
-```
-buildscript {
-    repositories {
-        mavenCentral()
-        maven {
-            url = uri("https://storage.googleapis.com/r8-releases/raw")
-        }
-    }
-    dependencies {
-        classpath("com.android.tools:r8:8.2.26")
-    }
-}
-```
-
 ## Add strict-mode for App-kids
 Starting from version **6.1.10** iOS SDK comes in two variants: **Strict** mode and **Regular** mode. Please read more [here](https://dev.appsflyer.com/hc/docs/install-ios-sdk#strict-mode-sdk)
 

README.md

@@ -17,9 +17,7 @@
 - Tested with React-Native **v0.62.0** (older versions might be supported)
 
 ## <a id="breaking-changes"> ❗❗ Breaking changes when updating to v6.x.x❗❗
-- Starting from version `6.16.0`, Android minimum SDK version is 21. 
-<br/>Potential Build Issues: If you are using Android Gradle Plugin (AGP) below 8.2.0, you may encounter build errors on Android.
-<br/>To resolve this, refer to the [Android Build Error Due to AGP Version](./Docs/RN_Installation.md#android-build-error-due-to-agp-version).
+- From version `6.16.2`, `AppsFlyerConsent.forGDPRUser` and `AppsFlyerConsent.forNonGDPRUser` have been **deprecated**. Use the new `AppsFlyerConsent` constructor instead. See [Deprecation Notice](/Docs/RN_CMP.md#deprecation-notice).
 
 - From version `6.15.1`, upgraded to targetSDKVersion 34, Java 17, and Gradle 8.7 in [AppsFlyer Android SDK v6.15.1](https://support.appsflyer.com/hc/en-us/articles/115001256006-AppsFlyer-Android-SDK-release-notes).
 

android/build.gradle

@@ -55,5 +55,5 @@ repositories {
 dependencies {
     implementation "com.facebook.react:react-native:${safeExtGet('reactNativeVersion', '+')}"
     implementation "com.android.installreferrer:installreferrer:${safeExtGet('installReferrerVersion', '2.1')}"
-    api "com.appsflyer:af-android-sdk:${safeExtGet('appsflyerVersion', '6.16.0')}"
+    api "com.appsflyer:af-android-sdk:${safeExtGet('appsflyerVersion', '6.16.2')}"
 }

android/src/main/java/com/appsflyer/reactnative/RNAppsFlyerConstants.java

@@ -6,7 +6,7 @@
 
 public class RNAppsFlyerConstants {
 
-    final static String PLUGIN_VERSION = "6.16.0";
+    final static String PLUGIN_VERSION = "6.16.2";
     final static String NO_DEVKEY_FOUND = "No 'devKey' found or its empty";
     final static String UNKNOWN_ERROR = "AF Unknown Error";
     final static String SUCCESS = "Success";

android/src/main/java/com/appsflyer/reactnative/RNAppsFlyerModule.java

@@ -8,6 +8,7 @@
 import android.os.Bundle;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import android.util.Log;
 
@@ -876,17 +877,41 @@ public void enableTCFDataCollection(Boolean enabled) {
     }
 
     @ReactMethod
-    public void setConsentData(ReadableMap consentData) {
+    public void setConsentData(@Nullable ReadableMap consentData) {
+        if (consentData == null) {
+            Log.e("AppsFlyer", "consentData is null");
+            return;
+        }
+
         JSONObject JSONConsentData = RNUtil.readableMapToJson(consentData);
-        boolean isUserSubjectToGDPR = JSONConsentData.optBoolean("isUserSubjectToGDPR");
-        boolean hasConsentForDataUsage = JSONConsentData.optBoolean("hasConsentForDataUsage");
-        boolean hasConsentForAdsPersonalization = JSONConsentData.optBoolean("hasConsentForAdsPersonalization");
-        AppsFlyerConsent consentObject;
-        if (isUserSubjectToGDPR) {
-            consentObject = AppsFlyerConsent.forGDPRUser(hasConsentForDataUsage, hasConsentForAdsPersonalization);
-        } else {
-            consentObject = AppsFlyerConsent.forNonGDPRUser();
+        if (JSONConsentData == null) {
+            Log.e("AppsFlyer", "Failed to convert consentData to JSON");
+            return;
         }
+
+        Boolean isUserSubjectToGDPR = JSONConsentData.has("isUserSubjectToGDPR") && !JSONConsentData.isNull("isUserSubjectToGDPR")
+                ? JSONConsentData.optBoolean("isUserSubjectToGDPR")
+                : null;
+
+        Boolean hasConsentForDataUsage = JSONConsentData.has("hasConsentForDataUsage") && !JSONConsentData.isNull("hasConsentForDataUsage")
+                ? JSONConsentData.optBoolean("hasConsentForDataUsage")
+                : null;
+
+        Boolean hasConsentForAdsPersonalization = JSONConsentData.has("hasConsentForAdsPersonalization") && !JSONConsentData.isNull("hasConsentForAdsPersonalization")
+                ? JSONConsentData.optBoolean("hasConsentForAdsPersonalization")
+                : null;
+
+        Boolean hasConsentForAdStorage = JSONConsentData.has("hasConsentForAdStorage") && !JSONConsentData.isNull("hasConsentForAdStorage")
+                ? JSONConsentData.optBoolean("hasConsentForAdStorage")
+                : null;
+
+        AppsFlyerConsent consentObject = new AppsFlyerConsent(
+                isUserSubjectToGDPR,
+                hasConsentForDataUsage,
+                hasConsentForAdsPersonalization,
+                hasConsentForAdStorage
+        );
+
         AppsFlyerLib.getInstance().setConsentData(consentObject);
     }
 

babel.config.js

@@ -0,0 +1,4 @@
+// babel.config.js
+module.exports = {
+    presets: ['module:metro-react-native-babel-preset'],
+  };

index.d.ts

@@ -114,11 +114,44 @@ declare module "react-native-appsflyer" {
         brandDomain?: string;
     }
 
-    export const AppsFlyerConsent: {
-        forGDPRUser: (hasConsentForDataUsage: boolean, hasConsentForAdsPersonalization: boolean) => AppsFlyerConsentType;
-        forNonGDPRUser: () => AppsFlyerConsentType;
+    export class AppsFlyerConsent {
+        isUserSubjectToGDPR?: boolean;
+        hasConsentForDataUsage?: boolean;
+        hasConsentForAdsPersonalization?: boolean;
+        hasConsentForAdStorage?: boolean;
+
+        /**
+         * Creates an instance of AppsFlyerConsent.
+         * @param isUserSubjectToGDPR - Indicates whether GDPR applies to the user.
+         * @param hasConsentForDataUsage - Indicates whether the user has consented to data usage.
+         * @param hasConsentForAdsPersonalization - Indicates whether the user has consented to ads personalization.
+         * @param hasConsentForAdStorage - Indicates whether the user has consented to ad storage.
+         */
+        constructor(
+            isUserSubjectToGDPR?: boolean,
+            hasConsentForDataUsage?: boolean,
+            hasConsentForAdsPersonalization?: boolean,
+            hasConsentForAdStorage?: boolean
+        ) {}
+
+        /**
+         * @deprecated since version 6.16.2. Use the AppsFlyerConsent constructor instead for more flexibility with optional booleans.
+         */
+        static forGDPRUser(hasConsentForDataUsage: boolean, hasConsentForAdsPersonalization: boolean): AppsFlyerConsent {
+            return new AppsFlyerConsent(true, hasConsentForDataUsage, hasConsentForAdsPersonalization);
+        }
+
+        /**
+         * @deprecated since version 6.16.2. Use the AppsFlyerConsent constructor instead for more flexibility with optional booleans.
+         */
+        static forNonGDPRUser(): AppsFlyerConsent {
+            return new AppsFlyerConsent(false);
+        }
     }
 
+    /**
+     * @deprecated since version 6.16.2. Use the AppsFlyerConsent class instead for a more integrated approach to consent management.
+     */
     export interface AppsFlyerConsentType {
         isUserSubjectToGDPR: boolean;
         hasConsentForDataUsage?: boolean;
@@ -190,7 +223,7 @@ declare module "react-native-appsflyer" {
         appendParametersToDeepLinkingURL(contains: string, parameters: object): void
         startSdk(): void
         enableTCFDataCollection(enabled: boolean): void
-        setConsentData(consentData: AppsFlyerConsentType): void
+        setConsentData(consentData: AppsFlyerConsent): void;
         logAdRevenue(adRevenueData: AFAdRevenueData) : void
         /**
          * For iOS Only