@usercentrics/react-native-sdk 2.9.0 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 [Release Notes](https://docs.usercentrics.com/cmp_in_app_sdk/latest/about/history/)
 
+### 2.10.0 - November 16, 2023
+
+## Improvements
+
+* Accessibility: Various issues have been addressed to enhance accessibility.
+  * Resolved banner compatibility issues with iOS VoiceOver.
+  * Resolved banner compatibility issues with Android TalkBack.
+  * Adjusted font sizes to comply with Accessibility requirements on both iOS and Android.
+
+* Added Ukrainian support language for TCF.
+
+## Resolved Issues
+
+* Fixed the issue of not disclosing the setting "showCloseButton" has been addressed, preventing errors on Android.
+* Fixed the crash on Android when passing an invalid controller id to restore the user session.
+* Fixed The issue of the remote variant configuration not being used in first layer on Unity.
+
 ### 2.9.0 - October 6, 2023
 
 ## Features

package/README.md

@@ -6,50 +6,36 @@
             alt="follow on Twitter">
 </a>
 
-## Overview
+# Welcome!
 
-The Usercentrics Apps SDK is a Consent Management Platform framework for mobile, TV, Web, and Unity applications, that enables the collection, documentation, and management of your user's privacy settings, in order to ensure legal compliance for different legal frameworks around the world.
+You are now one step closer from making **privacy** a core feature in your application. We are very happy that you decided to make this a priority. We are here to help you **build trust** with your users.
+
+## The Usercentrics Apps SDK
+
+The Usercentrics Apps SDK is a native Consent Management Platform solution for mobile apps, mobile games & TV applications, that enables the collection, documentation, and management of your user's privacy choices, in order to ensure legal compliance for legal regulations around the world.
 
 <p align="center">
 <img src="https://docs.usercentrics.com/cmp_in_app_sdk/latest/assets/media/predefinedUI.png" alt="Usercentrics UI" />
 </p>
 
-### Supported Legal Frameworks
-
-* 🇪🇺 GDPR - European Union's General Data Protection Regulation
-* 🇺🇸 CCPA - California's Consumer Privacy Act
-* 🇧🇷 LGPD - Brazil’s Lei Geral de Proteção de Dados
-* 🌎 TCF 2.0 - Transparency & Consent Framework 2.0
-
-### Supported Platforms
-
-| Android | iOS |  Web  | tvOS | MacOS |
-|:-------:|:---:|:-----:|:----:|:-----:|
-|    ✅   |  ✅  |   ❌   |  ❌  |  ❌  |
-
 ### 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 
+* Node 14
 
-## Installation
+## Get started!
 
-Install the library from npm:
+In order to use and test the SDK, you will need a Usercentrics Account. Get [started with a free trial](https://usercentrics.com/in-app-sdk/).
 
-```sh
-npm install @usercentrics/react-native-sdk
-```
+## Integration
 
-For iOS, after installing the package, you will need to install the Usercentrics dependency by running from your project folder, in this repository go to example/ and run:
-```sh
-npx pod-install
-```
-Or running from example/ios/ folder:
-```sh
-pod install
-```
+Continue to our [documentation](https://usercentrics.com/docs/apps/intro/) for a step by step integration guide.
+
+## Example
+
+See the [example](https://github.com/Usercentrics/react-native/tree/master/example) directory for a complete sample app using Usercentrics.
 
 ## Sample Project
 
@@ -79,16 +65,5 @@ To run the sample project, you will need to run npm install from both root and e
     npx react-native run-android
     ``` 
 
-## Integration
-
-Continue to our [documentation](https://docs.usercentrics.com/cmp_in_app_sdk/) for a step by step integration guide.
-
-## Example
-
-See the [example](https://github.com/Usercentrics/react-native/tree/master/example) directory for a complete sample app using Usercentrics.
-
-## Get an Account
-First step to get started with our SDK, is to create a Usercentrics Account, [get started with a free account](https://usercentrics.com/pricing/#mobile) or [request a quote](https://usercentrics.com/in-app-sdk/#in-app-demo) for your organization.
-
 ## Maintainers
 - [Usercentrics](https://github.com/Usercentrics)

package/android/build.gradle

@@ -1,4 +1,4 @@
-def usercentrics_version = "2.9.0"
+def usercentrics_version = "2.10.0"
 version usercentrics_version
 
 buildscript {

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

@@ -105,14 +105,18 @@ class RNUsercentricsModuleTest {
     fun testConfigure() {
         val usercentricsProxy = FakeUsercentricsProxy()
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.configure(usercentricsOptions)
 
         assertEquals(1, usercentricsProxy.initializeCount)
         assertEquals("AAAAA", usercentricsProxy.initializeOptionsArgument?.settingsId)
         assertEquals("BBBBB", usercentricsProxy.initializeOptionsArgument?.ruleSetId)
-        assertEquals(UsercentricsLoggerLevel.NONE, usercentricsProxy.initializeOptionsArgument?.loggerLevel)
+        assertEquals(
+            UsercentricsLoggerLevel.NONE,
+            usercentricsProxy.initializeOptionsArgument?.loggerLevel
+        )
         assertEquals(1000L, usercentricsProxy.initializeOptionsArgument?.timeoutMillis)
         assertEquals("1.2.3", usercentricsProxy.initializeOptionsArgument?.version)
         assertEquals(NetworkMode.EU, usercentricsProxy.initializeOptionsArgument?.networkMode)
@@ -122,7 +126,8 @@ class RNUsercentricsModuleTest {
     fun testConfigureWithWrongValues() {
         val usercentricsProxy = FakeUsercentricsProxy()
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.configure(JavaOnlyMap())
         assertEquals(UsercentricsOptions(), usercentricsProxy.initializeOptionsArgument)
@@ -132,7 +137,8 @@ class RNUsercentricsModuleTest {
     fun testIsReady() {
         val usercentricsProxy = FakeUsercentricsProxy(isReadyAnswer = usercentricsReadyStatus)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.isReady(promise)
@@ -155,7 +161,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(isReadyAnswer = error)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.isReady(promise)
@@ -174,7 +181,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(instanceAnswer = usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.restoreUserSession("abc", promise)
@@ -202,7 +210,8 @@ class RNUsercentricsModuleTest {
             }
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.restoreUserSession("abc", promise)
@@ -217,7 +226,8 @@ class RNUsercentricsModuleTest {
         every { usercentricsSDK.getControllerId() }.returns("abc")
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.getControllerId(promise)
@@ -232,7 +242,8 @@ class RNUsercentricsModuleTest {
         every { usercentricsSDK.getABTestingVariant() }.returns("variantA")
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.getABTestingVariant(promise)
@@ -248,7 +259,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
 
@@ -280,7 +292,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
 
@@ -318,7 +331,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.setCMPId(123)
 
@@ -332,7 +346,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.setABTestingVariant("variantA")
 
@@ -348,7 +363,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.getTCFData(promise)
@@ -365,7 +381,8 @@ class RNUsercentricsModuleTest {
         every { usercentricsSDK.getUserSessionData() }.returns(GetUserSessionDataMock.fake)
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.getUserSessionData(promise)
@@ -380,7 +397,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.getUSPData(promise)
@@ -399,7 +417,8 @@ class RNUsercentricsModuleTest {
             }
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.changeLanguage("abc", promise)
@@ -426,7 +445,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
 
         module.changeLanguage("abc", promise)
@@ -454,7 +474,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.acceptAllForTCF(0, 0, promise)
@@ -482,7 +503,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.denyAllForTCF(0, 0, promise)
@@ -509,7 +531,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.acceptAll(0, promise)
@@ -530,7 +553,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.denyAll(0, promise)
@@ -552,7 +576,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.saveDecisions(SaveDecisionsMock.callDecisions.serialize(), 0, promise)
@@ -576,7 +601,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.saveDecisionsForTCF(
@@ -603,7 +629,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         val promise = FakePromise()
         module.saveOptOutForCCPA(
@@ -628,7 +655,8 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSdk)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.track(UsercentricsAnalyticsEventType.ACCEPT_ALL_FIRST_LAYER.ordinal)
 
@@ -640,7 +668,8 @@ class RNUsercentricsModuleTest {
     fun testResetMethod() {
         val usercentricsProxy = FakeUsercentricsProxy()
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
 
         module.reset()
 
@@ -651,7 +680,8 @@ class RNUsercentricsModuleTest {
     fun testShowFirstLayer() {
         val usercentricsProxy = FakeUsercentricsProxy()
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
         module.showFirstLayer(bannerSettingsMap.toWritableMap(), promise)
         promise.await()
@@ -662,7 +692,8 @@ class RNUsercentricsModuleTest {
     fun testShowSecondLayer() {
         val usercentricsProxy = FakeUsercentricsProxy()
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
         val promise = FakePromise()
         module.showSecondLayer(bannerSettingsMap.toWritableMap(), promise)
         promise.await()
@@ -672,7 +703,7 @@ class RNUsercentricsModuleTest {
     @Test
     fun testShowFirstLayerWithCustomLocalLogo() {
         val context = InstrumentationRegistry.getInstrumentation().context
-        val reactContextProviderMock = object: ReactContextProviderMock() {
+        val reactContextProviderMock = object : ReactContextProviderMock() {
 
             override fun context(): Context {
                 return context
@@ -681,7 +712,11 @@ class RNUsercentricsModuleTest {
 
         val usercentricsProxy = FakeUsercentricsProxy()
         val reactApplicationContext = mockk<ReactApplicationContext>(relaxed = true)
-        val module = RNUsercentricsModule(reactApplicationContext, usercentricsProxy, reactContextProviderMock)
+        val module = RNUsercentricsModule(
+            reactApplicationContext,
+            usercentricsProxy,
+            reactContextProviderMock
+        )
 
         val bannerSettingsMap = mapOf(
             "variant" to null,
@@ -702,7 +737,8 @@ class RNUsercentricsModuleTest {
         module.showFirstLayer(bannerSettingsMap.toWritableMap(), promise)
         promise.await()
 
-        val someLocalImageDrawableId = context.resources.getIdentifier("some_local_image", "drawable", context.packageName)
+        val someLocalImageDrawableId =
+            context.resources.getIdentifier("some_local_image", "drawable", context.packageName)
         val expectedBannerSettings = BannerSettings(
             firstLayerStyleSettings = FirstLayerStyleSettings(
                 layout = UsercentricsLayout.Popup(
@@ -716,4 +752,28 @@ class RNUsercentricsModuleTest {
         )
         assertEquals(expectedBannerSettings, usercentricsProxy.showFirstLayerBannerSettings)
     }
+
+    @Test
+    fun testShowFirstLayerWhenShowCloseButtonIsNull() {
+        val usercentricsProxy = FakeUsercentricsProxy()
+        val contextMock = mockk<ReactApplicationContext>(relaxed = true)
+        val module =
+            RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val bannerSettingsMap = mapOf(
+            "secondLayerStyleSettings" to mapOf(
+                "showCloseButton" to null
+            ),
+        )
+        val promise = FakePromise()
+        module.showFirstLayer(bannerSettingsMap.toWritableMap(), promise)
+        promise.await()
+
+        val expectedBannerSettings = BannerSettings(
+            secondLayerStyleSettings = SecondLayerStyleSettings(
+                showCloseButton = null
+            )
+        )
+
+        assertEquals(expectedBannerSettings, usercentricsProxy.showFirstLayerBannerSettings)
+    }
 }

package/android/src/main/java/com/usercentrics/reactnativeusercentrics/extensions/BannerSettingsExtensions.kt

@@ -155,7 +155,7 @@ internal fun String.deserializeButtonType(): ButtonType {
 internal fun ReadableMap.secondLayerStyleSettingsFromMap(context: Context): SecondLayerStyleSettings {
     return SecondLayerStyleSettings(
         buttonLayout = getMap("buttonLayout")?.buttonLayoutFromMap(context),
-        showCloseButton = getBoolean("showCloseButton"),
+        showCloseButton = getBooleanOrNull("showCloseButton"),
     )
 }
 

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@usercentrics/react-native-sdk",
-    "version": "2.9.0",
+    "version": "2.10.0",
     "description": "Usercentrics SDK",
     "homepage": "https://usercentrics.com",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
     "author": "Usercentrics <developer@usercentrics.com>",
     "iosPackageName": "react-native-usercentrics",
-    "iosPackageVersion": "2.9.0",
+    "iosPackageVersion": "2.10.0",
     "license": "SEE LICENSE IN LICENSE",
     "files": [
         "android",