Release 2.4.0 (#35)

Release 2.4.0

Author: uc-leo

CHANGELOG.md

@@ -1,5 +1,21 @@
 [Release Notes](https://docs.usercentrics.com/cmp_in_app_sdk/latest/about/history/)
 
+# 2.4.0
+
+## Features
+
+- **[Customization]** You now have full control over the appearance of the First & Second Layer via our Admin Interface Style options and our Programmatic API. We have updated and extended our Programmatic API to simplify banner customization.
+- **[UI]** Legal links are now added to our the First Layer, and can be hidden or shown as desired via programmatic API.
+- **[CCPA]** Consent button can now be customized via the Admin Interface.
+
+## Improvements
+
+- Improve initialization flow for stability and avoid edge case crashes.
+
+## Resolved Issues
+
+- Solve stability issues and bug fixes.
+
 # 2.3.0
 
 ## Features
@@ -55,4 +71,4 @@
 
 # 2.0.1
 
-- Initial version of the library.
+- Initial version of the library.

android/build.gradle

@@ -1,4 +1,4 @@
-def usercentrics_version = "2.3.0"
+def usercentrics_version = "2.4.0"
 version usercentrics_version
 
 buildscript {

android/src/androidTest/java/com/usercentrics/reactnativemodule/RNUsercentricsModuleTest.kt

@@ -19,6 +19,7 @@ import com.usercentrics.sdk.models.common.UsercentricsLoggerLevel
 import com.usercentrics.sdk.models.common.UsercentricsVariant
 import com.usercentrics.sdk.models.settings.UsercentricsConsentType
 import com.usercentrics.sdk.services.tcf.TCFDecisionUILayer
+import com.usercentrics.sdk.services.tcf.interfaces.TCFData
 import io.mockk.every
 import io.mockk.mockk
 import io.mockk.verify
@@ -207,15 +208,17 @@ class RNUsercentricsModuleTest {
     @Test
     fun testGetTCString() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.getTCString() }.returns("abc")
+        every { usercentricsSDK.getTCString(any()) }.answers {
+            firstArg<(String) -> Unit>().invoke("abc")
+        }
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
         val module = RNUsercentricsModule(contextMock, usercentricsProxy)
         val promise = FakePromise()
 
         module.getTCFString(promise)
 
-        verify(exactly = 1) { usercentricsSDK.getTCString() }
+        verify(exactly = 1) { usercentricsSDK.getTCString(any()) }
         assertEquals("abc", promise.resolveValue)
     }
 
@@ -306,7 +309,9 @@ class RNUsercentricsModuleTest {
     @Test
     fun testGetTCFData() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.getTCFData() }.returns(GetTCFDataMock.fake)
+        every { usercentricsSDK.getTCFData(any()) }.answers {
+            firstArg<(TCFData) -> Unit>().invoke(GetTCFDataMock.fake)
+        }
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
@@ -317,7 +322,7 @@ class RNUsercentricsModuleTest {
 
         val result = promise.resolveValue
 
-        verify(exactly = 1) { usercentricsSDK.getTCFData() }
+        verify(exactly = 1) { usercentricsSDK.getTCFData(any()) }
         assertEquals(GetTCFDataMock.expected.toWritableMap(), result)
     }
 
@@ -563,7 +568,6 @@ class RNUsercentricsModuleTest {
             GetConsentsMock.fakeWithData
         )
 
-
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
         val module = RNUsercentricsModule(contextMock, usercentricsProxy)
@@ -590,4 +594,4 @@ class RNUsercentricsModuleTest {
 
         assertEquals(1, usercentricsProxy.resetCount)
     }
-}
+}

android/src/androidTest/java/com/usercentrics/reactnativemodule/api/FakeUsercentricsProxy.kt

@@ -53,19 +53,12 @@ internal class FakeUsercentricsProxy(
     var showFirstLayerBannerSettings: BannerSettings? = null
     var showFirstLayerStyle: FirstLayerStyleSettings? = null
 
-    override fun showFirstLayer(
-        activity: Activity,
-        layout: UsercentricsLayout,
-        bannerSettings: BannerSettings?,
-        firstLayerStyleSettings: FirstLayerStyleSettings?,
-        promise: Promise
-    ) {
+    override fun showFirstLayer(activity: Activity, layout: UsercentricsLayout, bannerSettings: BannerSettings?, promise: Promise) {
         this.showFirstLayerLayout = layout
         this.showFirstLayerBannerSettings = bannerSettings
-        this.showFirstLayerStyle = firstLayerStyleSettings
+        this.showFirstLayerStyle = bannerSettings?.firstLayerSettings
     }
 
-    override fun showSecondLayer() {
-
+    override fun showSecondLayer(activity: Activity, bannerSettings: BannerSettings?, promise: Promise) {
     }
-}
+}

android/src/androidTest/java/com/usercentrics/reactnativemodule/mock/GetTCFDataMock.kt

@@ -95,6 +95,7 @@ internal class GetTCFDataMock {
                     dataSharedOutsideEU = false
                 )
             ),
+            tcString = "abc"
         )
 
         // From the debugger
@@ -186,6 +187,7 @@ internal class GetTCFDataMock {
                     "dataSharedOutsideEU" to false
                 ),
             ),
+            "tcString" to "abc"
         )
     }
-}
+}

android/src/main/java/com/usercentrics/reactnativeusercentrics/RNUsercentricsModule.kt

@@ -17,17 +17,8 @@ internal class RNUsercentricsModule(
 
     @ReactMethod
     fun configure(options: ReadableMap) {
-        var alreadyConfigured = false
-        usercentricsProxy.isReady({
-            alreadyConfigured = true
-        }, {
-            alreadyConfigured = true
-        })
-
-        if (!alreadyConfigured) {
-            val usercentricsOptions = options.usercentricsOptionsFromMap() ?: return
-            usercentricsProxy.initialize(reactApplicationContext, usercentricsOptions)
-        }
+        val usercentricsOptions = options.usercentricsOptionsFromMap() ?: return
+        usercentricsProxy.initialize(reactApplicationContext, usercentricsOptions)
     }
 
     @ReactMethod
@@ -46,18 +37,8 @@ internal class RNUsercentricsModule(
                 val assetManager = currentActivity!!.assets
 
                 val layout = options.getString("layout")!!.usercentricsLayoutFromEnumString()
-                val bannerSettings =
-                    options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
-                val styleSettings =
-                    options.getMap("styleSettings")?.firstLayerStyleSettingsFromMap(assetManager)
-
-                usercentricsProxy.showFirstLayer(
-                    currentActivity!!,
-                    layout,
-                    bannerSettings,
-                    styleSettings,
-                    promise
-                )
+                val bannerSettings = options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
+                usercentricsProxy.showFirstLayer(currentActivity!!, layout, bannerSettings, promise)
 
             } catch (e: Exception) {
                 promise.reject(e)
@@ -71,17 +52,8 @@ internal class RNUsercentricsModule(
             try {
                 val assetManager = currentActivity!!.assets
 
-                val bannerSettings =
-                    options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
-                val showCloseButton = options.getBoolean("showCloseButton")
-
-
-                UsercentricsBanner(currentActivity!!, bannerSettings).showSecondLayer(
-                    showCloseButton
-                ) {
-                    promise.resolve(it?.toWritableMap())
-                }
-
+                val bannerSettings = options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
+                usercentricsProxy.showSecondLayer(currentActivity!!, bannerSettings, promise)
             } catch (e: Exception) {
                 promise.reject(e)
             }
@@ -98,8 +70,11 @@ internal class RNUsercentricsModule(
     }
 
     @ReactMethod
+    @Deprecated("Please, call getTCFData() to get the 'tcString' from that model")
     fun getTCFString(promise: Promise) {
-        promise.resolve(usercentricsProxy.instance.getTCString())
+        usercentricsProxy.instance.getTCString {
+            promise.resolve(it)
+        }
     }
 
     @ReactMethod
@@ -124,7 +99,9 @@ internal class RNUsercentricsModule(
 
     @ReactMethod
     fun getTCFData(promise: Promise) {
-        promise.resolve(usercentricsProxy.instance.getTCFData().serialize())
+        usercentricsProxy.instance.getTCFData {
+            promise.resolve(it.serialize())
+        }
     }
 
     @ReactMethod
@@ -226,4 +203,4 @@ internal class RNUsercentricsModule(
     fun reset() {
         usercentricsProxy.reset()
     }
-}
+}

android/src/main/java/com/usercentrics/reactnativeusercentrics/api/UsercentricsProxy.kt

@@ -2,38 +2,19 @@ package com.usercentrics.reactnativeusercentrics.api
 
 import android.app.Activity
 import android.content.Context
-import android.content.Intent
-import android.util.Log
 import com.facebook.react.bridge.Promise
-import com.facebook.react.bridge.ReadableMap
-import com.usercentrics.reactnativeusercentrics.extensions.bannerSettingsFromMap
-import com.usercentrics.reactnativeusercentrics.extensions.firstLayerStyleSettingsFromMap
 import com.usercentrics.reactnativeusercentrics.extensions.toWritableMap
-import com.usercentrics.reactnativeusercentrics.extensions.usercentricsLayoutFromEnumString
 import com.usercentrics.sdk.*
 import com.usercentrics.sdk.errors.UsercentricsError
-import java.lang.Exception
 
 interface UsercentricsProxy {
+
     val instance: UsercentricsSDK
 
     fun initialize(context: Context, options: UsercentricsOptions)
-
-    fun isReady(
-        onSuccess: (UsercentricsReadyStatus) -> Unit,
-        onFailure: (UsercentricsError) -> Unit
-    )
-
-    fun showFirstLayer(
-        activity: Activity,
-        layout: UsercentricsLayout,
-        bannerSettings: BannerSettings?,
-        firstLayerStyleSettings: FirstLayerStyleSettings?,
-        promise: Promise
-    )
-
-    fun showSecondLayer()
-
+    fun isReady(onSuccess: (UsercentricsReadyStatus) -> Unit, onFailure: (UsercentricsError) -> Unit)
+    fun showFirstLayer(activity: Activity, layout: UsercentricsLayout, bannerSettings: BannerSettings?, promise: Promise)
+    fun showSecondLayer(activity: Activity, bannerSettings: BannerSettings?, promise: Promise)
     fun reset()
 }
 
@@ -50,30 +31,19 @@ internal class UsercentricsProxyImpl : UsercentricsProxy {
         }
     }
 
-    override fun isReady(
-        onSuccess: (UsercentricsReadyStatus) -> Unit,
-        onFailure: (UsercentricsError) -> Unit
-    ) = Usercentrics.isReady(onSuccess, onFailure)
+    override fun isReady(onSuccess: (UsercentricsReadyStatus) -> Unit, onFailure: (UsercentricsError) -> Unit) = Usercentrics.isReady(onSuccess, onFailure)
 
-    override fun showFirstLayer(
-        activity: Activity,
-        layout: UsercentricsLayout,
-        bannerSettings: BannerSettings?,
-        firstLayerStyleSettings: FirstLayerStyleSettings?,
-        promise: Promise
-    ) {
-        UsercentricsBanner(activity, bannerSettings).showFirstLayer(
-            layout,
-            firstLayerStyleSettings
-        ) {
+    override fun showFirstLayer(activity: Activity, layout: UsercentricsLayout, bannerSettings: BannerSettings?, promise: Promise) {
+        UsercentricsBanner(activity, bannerSettings).showFirstLayer(layout) {
             promise.resolve(it?.toWritableMap())
         }
     }
 
-    override fun showSecondLayer() {
-
+    override fun showSecondLayer(activity: Activity, bannerSettings: BannerSettings?, promise: Promise) {
+        UsercentricsBanner(activity, bannerSettings).showSecondLayer {
+            promise.resolve(it?.toWritableMap())
+        }
     }
 
     override fun reset() = Usercentrics.reset()
-
-}
+}

android/src/main/java/com/usercentrics/reactnativeusercentrics/extensions/FirstLayerOptionsExtensions.kt

@@ -20,9 +20,16 @@ internal fun ReadableMap.bannerSettingsFromMap(assetManager: AssetManager): Bann
     val customFont = getMap("font")
     val customLogo = getMap("logo")
 
+    val rawFirstLayerStyleSettings = getMap("firstLayerSettings")
+    val rawSecondLayerStyleSettings = getMap("secondLayerSettings")
+    val rawLegalLinkSettings = getString("links")
+
     return BannerSettings(
-        customFont?.bannerFontFromMap(assetManager),
-        customLogo?.bannerLogoFromMap()
+        font = customFont?.bannerFontFromMap(assetManager),
+        logo = customLogo?.bannerLogoFromMap(),
+        firstLayerSettings = rawFirstLayerStyleSettings?.firstLayerStyleSettingsFromMap(assetManager),
+        secondLayerSettings = rawSecondLayerStyleSettings?.secondLayerStyleSettingsFromMap(assetManager),
+        links = rawLegalLinkSettings?.legalLinksFromEnumString()
     )
 }
 
@@ -146,6 +153,23 @@ internal fun String.deserializeButtonType(): ButtonType {
     return ButtonType.valueOf(this)
 }
 
+internal fun ReadableMap.secondLayerStyleSettingsFromMap(assetManager: AssetManager): SecondLayerStyleSettings {
+    return SecondLayerStyleSettings(
+        buttonLayout = getMap("buttonLayout")?.buttonLayoutFromMap(assetManager),
+        showCloseButton = getBoolean("showCloseButton"),
+    )
+}
+
+internal fun String?.legalLinksFromEnumString(): LegalLinksSettings? {
+    return when (this) {
+        "BOTH" -> LegalLinksSettings.BOTH
+        "NONE" -> LegalLinksSettings.NONE
+        "FIRST_LAYER_ONLY" -> LegalLinksSettings.FIRST_LAYER_ONLY
+        "SECOND_LAYER_ONLY" -> LegalLinksSettings.SECOND_LAYER_ONLY
+        else -> null
+    }
+}
+
 @ColorInt
 internal fun String.deserializeColor(): Int? {
     val colorString: String =

android/src/main/java/com/usercentrics/reactnativeusercentrics/extensions/TCFDataExtensions.kt

@@ -10,7 +10,8 @@ internal fun TCFData.serialize(): WritableMap {
         "specialFeatures" to specialFeatures.map { it.serialize() },
         "specialPurposes" to specialPurposes.map { it.serialize() },
         "stacks" to stacks.map { it.serialize() },
-        "vendors" to vendors.map { it.serialize() }
+        "vendors" to vendors.map { it.serialize() },
+        "tcString" to tcString
     ).toWritableMap()
 }