@usercentrics/react-native-sdk 2.23.0 → 2.23.3

package/README.md

@@ -22,12 +22,36 @@ The Usercentrics Apps SDK is a native Consent Management Platform solution for m
 <img src="https://docs.usercentrics.com/cmp_in_app_sdk/latest/assets/media/predefinedUI.png" alt="Usercentrics UI" />
 </p>
 
-### Requirements
-* Android 5.0 (API 21) or higher with Kotlin 1.5 or higher
-* iOS 11 or higher
-* React 17.0 or higher
-* React Native 0.65 or higher
-* Node 14
+## 📋 Requirements
+
+### Mobile Platforms
+* **Android 5.0 (API 21)** or higher
+* **iOS 11** or higher
+
+### Development Environment
+* **Node.js 18.0+** (LTS recommended)
+* **npm 9.0+** or **Yarn 1.22+**
+* **TypeScript 5.1+**
+* **React 18.2+**
+* **React Native 0.74.3+** (with Fabric support)
+
+### Android Development
+* **Java 17+** (OpenJDK or Oracle JDK)
+* **Android SDK** with API 33+ platforms
+* **Android NDK 25+**
+* **Gradle 8.2+**
+* **Kotlin 1.9.22+**
+* **Android Gradle Plugin 8.2+**
+
+### iOS Development (macOS only)
+* **Xcode 15.0+** with iOS SDK
+* **CocoaPods 1.12+**
+* **iOS Simulators** (recommended)
+
+### Optional but Recommended
+* **Watchman** (for better file watching)
+* **Git** (for version control)
+* **SDKMan** (for Java version management)
 
 ## Get started!
 
@@ -41,35 +65,92 @@ Continue to our [documentation](https://usercentrics.com/docs/apps/intro/) for a
 
 See the [example](https://github.com/Usercentrics/react-native/tree/master/example) directory for a complete sample app using Usercentrics.
 
-## Sample Project
+## Quick Start
 
-To run the sample project, you will need to run npm install from both root and example folders:
+### 🚀 Automated Setup (Recommended)
 
+The easiest way to get started is using our automated setup script:
+
+```sh
+# Check your development environment
+npm run check-requirements
+
+# Automatically install missing dependencies
+npm run auto-setup
+
+# Verify everything is ready
+npm run check-requirements
+```
+
+### 📱 Running the Sample Project
+
+### Option 1: Using Helper Scripts
+```sh
+# Install all dependencies
+npm run install-dependencies
+
+# Run Android app
+npm run run-android
+
+# Run iOS app (macOS only)
+npm run ios
+```
+
+### Option 2: Manual Setup
 * From root folder:
     ```sh
-    npm install
+    npm install --legacy-peer-deps
     ``` 
 * From example folder:
     ```sh
-    npm install
+    npm install --legacy-peer-deps
     ``` 
 
-    ### iOS
+### iOS (macOS only)
 
-    From example folder: 
-    ```sh
-    npx pod-install
-    npx react-native run-ios
-    ``` 
+From example folder: 
+```sh
+npx pod-install
+npx react-native run-ios
+``` 
 
-    ### Android
+### Android
 
-    Open the android folder using Android Studio in order to create essential files then run from example folder:
-    ```sh
-    npx react-native run-android
-    ``` 
+Make sure you have Android SDK configured, then from example folder:
+```sh
+npx react-native run-android
+```
+
+## 🛠️ Development Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run auto-setup` | 🤖 Automatically install all required dependencies |
+| `npm run check-requirements` | 🔍 Check development environment requirements |
+| `npm run clean-all-caches` | 🧹 Clean all project and system caches |
+| `npm run install-dependencies` | 📦 Install dependencies in root and example folders |
+| `npm run run-android` | 🤖 Kill conflicting ports and run Android app |
+
+### 🔧 Troubleshooting
+
+If you encounter issues:
+
+1. **Check Requirements**: `npm run check-requirements`
+2. **Clean & Reinstall**: `npm run clean-all-caches && npm run install-dependencies`
+3. **Auto Setup**: `npm run auto-setup` (installs missing tools)
+4. **Manual Setup**: Follow the detailed error messages from check-requirements
+
+### 📋 Environment Setup
+
+The project includes intelligent scripts that will:
+- ✅ Detect your operating system (macOS/Linux)
+- ✅ Check for required tools and versions
+- ✅ Install missing dependencies automatically
+- ✅ Configure environment variables
+- ✅ Apply necessary patches
+- ✅ Verify the setup works correctly
 
-### Consent Mediation
+## Consent Mediation
 
 You can enable and run the Consent Mediation example in this example by following the [documentation](https://usercentrics.com/docs/apps/features/consent-mediation/#enable-mediation).
 

package/android/{build.gradle → build-legacy.gradle}

@@ -1,4 +1,4 @@
-def usercentrics_version = "2.23.0"
+def usercentrics_version = "2.23.3"
 version usercentrics_version
 
 buildscript {
@@ -27,6 +27,7 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
+    namespace 'com.usercentrics.reactnative'
     compileSdkVersion 33
 
     compileOptions {
@@ -43,6 +44,22 @@ android {
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFile "proguard-rules.pro"
     }
+
+    buildTypes {
+        debug {
+            debuggable true
+        }
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    publishing {
+        singleVariant('release') {
+            withSourcesJar()
+        }
+    }
 }
 
 repositories {
@@ -61,4 +78,4 @@ dependencies {
     androidTestImplementation 'androidx.test.ext:junit-ktx:1.1.3'
     androidTestImplementation 'androidx.test:runner:1.4.0'
     androidTestImplementation 'androidx.test:rules:1.4.0'
-}
+}

package/android/build.gradle.kts

@@ -0,0 +1,76 @@
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+}
+
+val usercentricsVersion = "2.23.3"
+val reactNativeVersion = "0.79.6"
+
+android {
+    namespace = "com.usercentrics.reactnative"
+    compileSdk = 34
+
+    defaultConfig {
+        minSdk = 24
+        targetSdk = 34
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles("proguard-rules.pro")
+
+        val isNewArchEnabled = project.findProperty("newArchEnabled") == "true"
+        val isHermesEnabled = project.findProperty("hermesEnabled") == "true"
+        
+        buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchEnabled.toString())
+        buildConfigField("boolean", "IS_HERMES_ENABLED", isHermesEnabled.toString())
+        
+        ndk {
+            abiFilters += listOf("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = "17"
+    }
+    
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
+    sourceSets {
+        getByName("main").java.srcDirs("src/main/kotlin")
+    }
+
+    buildFeatures {
+        buildConfig = true
+    }
+
+    packaging {
+        jniLibs {
+            useLegacyPackaging = false
+        }
+    }
+}
+
+dependencies {
+    implementation("com.facebook.react:react-android:$reactNativeVersion")
+    implementation("com.usercentrics.sdk:usercentrics-ui:$usercentricsVersion")
+
+    // Unit tests (JVM)
+    testImplementation("junit:junit:4.13.2")
+    testImplementation("io.mockk:mockk:1.13.12")
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.9.0")
+    testImplementation("com.facebook.react:react-android:$reactNativeVersion")
+
+    // Instrumented tests (Android)
+    androidTestImplementation("com.facebook.react:react-android:$reactNativeVersion")
+    androidTestImplementation("io.mockk:mockk-android:1.12.0")
+    androidTestImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit-ktx:1.1.3")
+    androidTestImplementation("androidx.test:runner:1.4.0")
+    androidTestImplementation("androidx.test:rules:1.4.0")
+}

package/android/gradle.properties

@@ -1,3 +1,7 @@
-org.gradle.jvmargs=-Xmx1536M
+org.gradle.jvmargs=-Xmx2048M
 android.useAndroidX=true
-android.enableJetifier=true
+android.enableJetifier=true
+
+reactNativeArchitectures=armeabi-v7a,arm64-v8a,x86,x86_64
+
+hermesEnabled=true

package/android/settings.gradle.kts

@@ -0,0 +1,21 @@
+pluginManagement {
+    repositories {
+        google()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+    plugins {
+        id("org.jetbrains.kotlin.android") version "2.0.21"
+    }
+}
+
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
+    repositories {
+        google()
+        mavenCentral()
+        maven { url = uri("https://www.jitpack.io") }
+    }
+}
+
+rootProject.name = "usercentrics"

package/android/src/androidTest/java/com/usercentrics/{reactnativemodule → reactnative}/RNUsercentricsModuleTest.kt

@@ -290,11 +290,11 @@ class RNUsercentricsModuleTest {
         val result = promise.resolveValue as WritableArray
         val consent = result.getMap(0)
 
-        assertEquals(false, consent.getBoolean("status"))
-        assertEquals("ocv9HNX_g", consent.getString("templateId"))
-        assertEquals("Facebook SDK", consent.getString("dataProcessor"))
-        assertEquals(0, consent.getInt("type"))
-        assertEquals("1.0.1", consent.getString("version"))
+        assertEquals(false, consent?.getBoolean("status"))
+        assertEquals("ocv9HNX_g", consent?.getString("templateId"))
+        assertEquals("Facebook SDK", consent?.getString("dataProcessor"))
+        assertEquals(0, consent?.getInt("type"))
+        assertEquals("1.0.1", consent?.getString("version"))
     }
 
     @Test

package/android/src/androidTest/java/com/usercentrics/reactnative/fake/FakePromise.kt

@@ -0,0 +1,73 @@
+package com.usercentrics.reactnativemodule.fake
+
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.WritableMap
+import java.util.concurrent.CountDownLatch
+
+internal class FakePromise : Promise {
+
+    var resolveValue: Any? = null
+    var rejectThrowable: Throwable? = null
+
+    private val lock = CountDownLatch(1)
+
+    fun await() {
+        lock.await()
+    }
+
+    override fun resolve(value: Any?) {
+        resolveValue = value
+        lock.countDown()
+    }
+
+    override fun reject(code: String, message: String?) {
+        rejectThrowable = RuntimeException("$code: $message")
+        lock.countDown()
+    }
+
+    override fun reject(code: String, throwable: Throwable?) {
+        rejectThrowable = throwable ?: RuntimeException(code)
+        lock.countDown()
+    }
+
+    override fun reject(code: String, message: String?, throwable: Throwable?) {
+        rejectThrowable = throwable ?: RuntimeException("$code: $message")
+        lock.countDown()
+    }
+
+    override fun reject(throwable: Throwable) {
+        rejectThrowable = throwable
+        lock.countDown()
+    }
+
+    override fun reject(throwable: Throwable, userInfo: WritableMap) {
+        rejectThrowable = throwable
+        lock.countDown()
+    }
+
+    override fun reject(code: String, userInfo: WritableMap) {
+        rejectThrowable = RuntimeException("$code: $userInfo")
+        lock.countDown()
+    }
+
+    override fun reject(code: String, throwable: Throwable?, userInfo: WritableMap) {
+        rejectThrowable = throwable
+        lock.countDown()
+    }
+
+    override fun reject(code: String, message: String?, userInfo: WritableMap) {
+        rejectThrowable = RuntimeException("$code: $message")
+        lock.countDown()
+    }
+
+    override fun reject(code: String?, message: String?, throwable: Throwable?, userInfo: WritableMap?) {
+        rejectThrowable = throwable ?: RuntimeException("$code: $message")
+        lock.countDown()
+    }
+
+    @Deprecated("Use reject(code, message) instead")
+    override fun reject(message: String) {
+        rejectThrowable = RuntimeException(message)
+        lock.countDown()
+    }
+}

package/android/src/main/AndroidManifest.xml

@@ -1,2 +1 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.usercentrics.reactnativeusercentrics"></manifest>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"/>

package/android/src/main/java/com/usercentrics/{reactnativeusercentrics → reactnative}/RNUsercentricsModule.kt

@@ -1,8 +1,8 @@
-package com.usercentrics.reactnativeusercentrics
+package com.usercentrics.reactnative
 
 import com.facebook.react.bridge.*
-import com.usercentrics.reactnativeusercentrics.api.UsercentricsProxy
-import com.usercentrics.reactnativeusercentrics.extensions.*
+import com.usercentrics.reactnative.api.UsercentricsProxy
+import com.usercentrics.reactnative.extensions.*
 import com.usercentrics.sdk.UsercentricsAnalyticsEventType
 import com.usercentrics.sdk.models.settings.UsercentricsConsentType
 import com.usercentrics.sdk.services.tcf.TCFDecisionUILayer
@@ -11,18 +11,18 @@ internal class RNUsercentricsModule(
     reactContext: ReactApplicationContext,
     private val usercentricsProxy: UsercentricsProxy,
     private val reactContextProvider: ReactContextProvider,
-) : ReactContextBaseJavaModule(reactContext) {
+) : RNUsercentricsModuleSpec(reactContext) {
 
-    override fun getName() = "RNUsercentricsModule"
+    override fun getName() = NAME
 
     @ReactMethod
-    fun configure(options: ReadableMap) {
+    override fun configure(options: ReadableMap) {
         val usercentricsOptions = options.usercentricsOptionsFromMap()
         usercentricsProxy.initialize(reactApplicationContext, usercentricsOptions)
     }
 
     @ReactMethod
-    fun isReady(promise: Promise) {
+    override fun isReady(promise: Promise) {
         usercentricsProxy.isReady({
             promise.resolve(it.toWritableMap())
         }, {
@@ -31,7 +31,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun showFirstLayer(options: ReadableMap?, promise: Promise) {
+    override fun showFirstLayer(options: ReadableMap?, promise: Promise) {
         runOnUiThread {
             try {
                 val context = reactContextProvider.context()
@@ -46,7 +46,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun showSecondLayer(options: ReadableMap?, promise: Promise) {
+    override fun showSecondLayer(options: ReadableMap?, promise: Promise) {
         runOnUiThread {
             try {
                 val context = reactContextProvider.context()
@@ -61,7 +61,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun restoreUserSession(controllerId: String, promise: Promise) {
+    override fun restoreUserSession(controllerId: String, promise: Promise) {
         usercentricsProxy.instance.restoreUserSession(controllerId, {
             promise.resolve(it.toWritableMap())
         }, {
@@ -70,59 +70,59 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun getControllerId(promise: Promise) {
+    override fun getControllerId(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getControllerId())
     }
 
     @ReactMethod
-    fun getABTestingVariant(promise: Promise) {
+    override fun getABTestingVariant(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getABTestingVariant())
     }
 
     @ReactMethod
-    fun getConsents(promise: Promise) {
+    override fun getConsents(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getConsents().toWritableArray())
     }
 
     @ReactMethod
-    fun getCMPData(promise: Promise) {
+    override fun getCMPData(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getCMPData().serialize())
     }
 
     @ReactMethod
-    fun getAdditionalConsentModeData(promise: Promise) {
+    override fun getAdditionalConsentModeData(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getAdditionalConsentModeData().serialize())
     }
 
     @ReactMethod
-    fun setCMPId(id: Int) {
+    override fun setCMPId(id: Int) {
         usercentricsProxy.instance.setCMPId(id)
     }
 
     @ReactMethod
-    fun setABTestingVariant(variant: String) {
+    override fun setABTestingVariant(variant: String) {
         usercentricsProxy.instance.setABTestingVariant(variant)
     }
 
     @ReactMethod
-    fun getTCFData(promise: Promise) {
+    override fun getTCFData(promise: Promise) {
         usercentricsProxy.instance.getTCFData {
             promise.resolve(it.serialize())
         }
     }
 
     @ReactMethod
-    fun getUserSessionData(promise: Promise) {
+    override fun getUserSessionData(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getUserSessionData())
     }
 
     @ReactMethod
-    fun getUSPData(promise: Promise) {
+    override fun getUSPData(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getUSPData().serialize())
     }
 
     @ReactMethod
-    fun changeLanguage(language: String, promise: Promise) {
+    override fun changeLanguage(language: String, promise: Promise) {
         usercentricsProxy.instance.changeLanguage(language, {
             promise.resolve(null)
         }, {
@@ -131,7 +131,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun acceptAllForTCF(fromLayer: Int, consentType: Int, promise: Promise) {
+    override fun acceptAllForTCF(fromLayer: Int, consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.acceptAllForTCF(
                 TCFDecisionUILayer.values()[fromLayer], UsercentricsConsentType.values()[consentType]
@@ -140,7 +140,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun acceptAll(consentType: Int, promise: Promise) {
+    override fun acceptAll(consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.acceptAll(
                 UsercentricsConsentType.values()[consentType]
@@ -149,7 +149,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun denyAllForTCF(fromLayer: Int, consentType: Int, promise: Promise) {
+    override fun denyAllForTCF(fromLayer: Int, consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.denyAllForTCF(
                 TCFDecisionUILayer.values()[fromLayer], UsercentricsConsentType.values()[consentType]
@@ -158,7 +158,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun denyAll(consentType: Int, promise: Promise) {
+    override fun denyAll(consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.denyAll(
                 UsercentricsConsentType.values()[consentType]
@@ -167,7 +167,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun saveDecisionsForTCF(
+    override fun saveDecisionsForTCF(
         tcfDecisions: ReadableMap,
         fromLayer: Int,
         saveDecisions: ReadableArray,
@@ -185,7 +185,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun saveDecisions(decisions: ReadableArray, consentType: Int, promise: Promise) {
+    override fun saveDecisions(decisions: ReadableArray, consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.saveDecisions(
                 decisions.deserializeUserDecision(), UsercentricsConsentType.values()[consentType]
@@ -194,7 +194,7 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun saveOptOutForCCPA(isOptedOut: Boolean, consentType: Int, promise: Promise) {
+    override fun saveOptOutForCCPA(isOptedOut: Boolean, consentType: Int, promise: Promise) {
         promise.resolve(
             usercentricsProxy.instance.saveOptOutForCCPA(
                 isOptedOut, UsercentricsConsentType.values()[consentType]
@@ -203,12 +203,12 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
-    fun track(event: Int) {
+    override fun track(event: Int) {
         usercentricsProxy.instance.track(UsercentricsAnalyticsEventType.values()[event])
     }
 
     @ReactMethod
-    fun clearUserSession(promise: Promise) {
+    override fun clearUserSession(promise: Promise) {
         usercentricsProxy.instance.clearUserSession({
             promise.resolve(it.toWritableMap())
         }, {
@@ -219,4 +219,8 @@ internal class RNUsercentricsModule(
     private fun runOnUiThread(block: () -> Unit) {
         UiThreadUtil.runOnUiThread(block)
     }
+
+    companion object {
+        const val NAME = "RNUsercentricsModule"
+    }
 }