@usercentrics/react-native-sdk 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 [Release Notes](https://docs.usercentrics.com/cmp_in_app_sdk/latest/about/history/)
 
+### 2.11.0 - December 22, 2023
+
+## Features
+
+* Google Consent Mode V2 Support - Seamlessly integrate with the latest Google Consent Mode, ensuring enhanced privacy compliance and meeting Google requirements.
+* Google Additional Consent Mode V2 - Integrate with the latest Google Additional Consent, allowing you to collect and signal additional consent for ad tech providers not covered by the IAB TCF V2.2.
+* Display Number of Vendors for Each Purpose on TCF - Easily view the number of vendors associated with each purpose in the Transparency and Consent Framework.
+* Chartboost SDK in Consent Mediation - Optimize revenue by effortlessly managing the Chartboost SDK within Usercentrics Consent Mediation.
+
+## Improvements
+
+* TCFUserDecisions API update - All properties have been changed from variables to constants. The adTechProviders field has been added which represent consents for Google Additional Consent Mode. On iOS this is a required argument, so if this is irrelevant for your configuration, just set an empty list, when needed.
+* Location is only cached by the SDK for offline mode.
+
+## Android Resolved Issues
+
+* Avoid fetching any image resource after the banner has been closed.
+
+## iOS Resolved Issues
+
+* Prevent Long Privacy Legal Links from Being Truncated.
+* Enable Scaled Fonts resources when using Custom UI.
+
+## Other Resolved Issues
+
+* Third-Party Vendors Count misalignment in some configurations.
+* Fix the bug causing the banner to reappear for users outside the European Union, despite configurations being specifically set to enforce GDPR compliance exclusively for EU users.
+* Update Link to Report Issues on Zendesk.
+
+### 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.11.0"
 version usercentrics_version
 
 buildscript {

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

@@ -64,8 +64,8 @@ class RNUsercentricsModuleTest {
         private val usercentricsConsentHistoryEntries = listOf(
             UsercentricsConsentHistoryEntry(
                 status = false,
-                UsercentricsConsentType.EXPLICIT,
-                123
+                type = UsercentricsConsentType.EXPLICIT,
+                timestampInMillis = 123
             )
         )
 
@@ -88,16 +88,14 @@ class RNUsercentricsModuleTest {
     @Before
     fun before() {
         SoLoader.init(
-            InstrumentationRegistry.getInstrumentation().context,
-            SoLoader.SOLOADER_ALLOW_ASYNC_INIT
+            InstrumentationRegistry.getInstrumentation().context, SoLoader.SOLOADER_ALLOW_ASYNC_INIT
         )
     }
 
     @Test
     fun testModuleName() {
         assertEquals(
-            "RNUsercentricsModule",
-            RNUsercentricsModule(mockk(relaxed = true), mockk(), ReactContextProviderMock()).name
+            "RNUsercentricsModule", RNUsercentricsModule(mockk(relaxed = true), mockk(), ReactContextProviderMock()).name
         )
     }
 
@@ -112,7 +110,9 @@ class RNUsercentricsModuleTest {
         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)
@@ -167,10 +167,9 @@ class RNUsercentricsModuleTest {
     @Test
     fun testRestoreUserSession() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.restoreUserSession(any(), any(), any()) }
-            .answers {
-                (arg(1) as (UsercentricsReadyStatus) -> Unit)(usercentricsReadyStatus)
-            }
+        every { usercentricsSDK.restoreUserSession(any(), any(), any()) }.answers {
+            (arg(1) as (UsercentricsReadyStatus) -> Unit)(usercentricsReadyStatus)
+        }
 
         val usercentricsProxy = FakeUsercentricsProxy(instanceAnswer = usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
@@ -196,10 +195,9 @@ class RNUsercentricsModuleTest {
     fun testRestoreUserSessionWithError() {
         val error = mockk<UsercentricsError>(relaxed = true)
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.restoreUserSession(any(), any(), any()) }
-            .answers {
-                (arg(2) as (UsercentricsError) -> Unit)(error)
-            }
+        every { usercentricsSDK.restoreUserSession(any(), any(), any()) }.answers {
+            (arg(2) as (UsercentricsError) -> Unit)(error)
+        }
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
         val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
@@ -294,18 +292,15 @@ class RNUsercentricsModuleTest {
         assertEquals(2, resultMap.getInt("activeVariant"))
 
         assertEquals(
-            GetCMPDataMock.expectedSettings.toWritableMap(),
-            resultMap.getMap("settings")
+            GetCMPDataMock.expectedSettings.toWritableMap(), resultMap.getMap("settings")
         )
 
         assertEquals(
-            GetCMPDataMock.expectedCategories.serialize(),
-            resultMap.getArray("categories")
+            GetCMPDataMock.expectedCategories.serialize(), resultMap.getArray("categories")
         )
 
         assertEquals(
-            GetCMPDataMock.expectedUserLocation.toWritableMap(),
-            resultMap.getMap("userLocation")
+            GetCMPDataMock.expectedUserLocation.toWritableMap(), resultMap.getMap("userLocation")
         )
 
         assertEquals(GetCMPDataMock.expectedServices.serialize(), resultMap.getArray("services")!!)
@@ -393,10 +388,9 @@ class RNUsercentricsModuleTest {
     @Test
     fun testChangeLanguage() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.changeLanguage(any(), any(), any()) }
-            .answers {
-                (arg(1) as () -> Unit)()
-            }
+        every { usercentricsSDK.changeLanguage(any(), any(), any()) }.answers {
+            (arg(1) as () -> Unit)()
+        }
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
         val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
@@ -406,9 +400,7 @@ class RNUsercentricsModuleTest {
 
         verify(exactly = 1) {
             usercentricsSDK.changeLanguage(
-                "abc",
-                any(),
-                any()
+                "abc", any(), any()
             )
         }
 
@@ -419,10 +411,9 @@ class RNUsercentricsModuleTest {
     fun testChangeLanguageWithError() {
         val error = mockk<UsercentricsError>(relaxed = true)
         val usercentricsSDK = mockk<UsercentricsSDK>()
-        every { usercentricsSDK.changeLanguage(any(), any(), any()) }
-            .answers {
-                (arg(2) as (UsercentricsError) -> Unit)(error)
-            }
+        every { usercentricsSDK.changeLanguage(any(), any(), any()) }.answers {
+            (arg(2) as (UsercentricsError) -> Unit)(error)
+        }
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
         val contextMock = mockk<ReactApplicationContext>(relaxed = true)
@@ -434,9 +425,7 @@ class RNUsercentricsModuleTest {
 
         verify(exactly = 1) {
             usercentricsSDK.changeLanguage(
-                "abc",
-                any(),
-                any()
+                "abc", any(), any()
             )
         }
         assertEquals(error, promise.rejectThrowable)
@@ -447,8 +436,7 @@ class RNUsercentricsModuleTest {
         val usercentricsSDK = mockk<UsercentricsSDK>()
         every {
             usercentricsSDK.acceptAllForTCF(
-                any(),
-                any()
+                any(), any()
             )
         }.returns(GetConsentsMock.fakeWithData)
 
@@ -475,8 +463,7 @@ class RNUsercentricsModuleTest {
         val usercentricsSDK = mockk<UsercentricsSDK>()
         every {
             usercentricsSDK.denyAllForTCF(
-                any(),
-                any()
+                any(), any()
             )
         }.returns(GetConsentsMock.fakeWithData)
 
@@ -545,8 +532,7 @@ class RNUsercentricsModuleTest {
         val usercentricsSDK = mockk<UsercentricsSDK>()
         every {
             usercentricsSDK.saveDecisions(
-                any(),
-                any()
+                any(), any()
             )
         }.returns(GetConsentsMock.fakeWithData)
 
@@ -566,12 +552,7 @@ class RNUsercentricsModuleTest {
     fun testSaveDecisionsForTCF() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
         every {
-            usercentricsSDK.saveDecisionsForTCF(
-                any(),
-                any(),
-                any(),
-                any()
-            )
+            usercentricsSDK.saveDecisionsForTCF(any(), any(), any(), any())
         }.returns(SaveDecisionsForTCFMock.fake)
 
         val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
@@ -580,15 +561,14 @@ class RNUsercentricsModuleTest {
 
         val promise = FakePromise()
         module.saveDecisionsForTCF(
-            SaveDecisionsForTCFMock.call,
-            0,
-            SaveDecisionsMock.callDecisions.serialize(),
-            0,
-            promise
+            tcfDecisions = SaveDecisionsForTCFMock.call,
+            fromLayer = 0,
+            saveDecisions = SaveDecisionsMock.callDecisions.serialize(),
+            consentType = 0,
+            promise = promise
         )
 
         val result = promise.resolveValue as WritableArray
-
         assertEquals(SaveDecisionsForTCFMock.expected.serialize(), result)
     }
 
@@ -607,9 +587,7 @@ class RNUsercentricsModuleTest {
 
         val promise = FakePromise()
         module.saveOptOutForCCPA(
-            false,
-            0,
-            promise
+            false, 0, promise
         )
 
         val result = promise.resolveValue as WritableArray
@@ -672,7 +650,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 +659,9 @@ 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,
@@ -708,12 +688,53 @@ class RNUsercentricsModuleTest {
                 layout = UsercentricsLayout.Popup(
                     PopupPosition.CENTER
                 )
-            ),
-            secondLayerStyleSettings = SecondLayerStyleSettings(showCloseButton = true),
-            generalStyleSettings = GeneralStyleSettings(
+            ), secondLayerStyleSettings = SecondLayerStyleSettings(showCloseButton = true), generalStyleSettings = GeneralStyleSettings(
                 logo = UsercentricsImage.ImageDrawableId(someLocalImageDrawableId)
             )
         )
         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)
+    }
+
+    @Test
+    fun testGetAdditionalConsentModeData() {
+        val usercentricsSDK = mockk<UsercentricsSDK>()
+        every { usercentricsSDK.getAdditionalConsentModeData() }.answers {
+            GetCMPDataMock.fakeAdditionalConsentModeData
+        }
+
+        val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
+        val contextMock = mockk<ReactApplicationContext>(relaxed = true)
+        val module = RNUsercentricsModule(contextMock, usercentricsProxy, ReactContextProviderMock())
+        val promise = FakePromise()
+
+        module.getAdditionalConsentModeData(promise)
+
+        val result = promise.resolveValue
+
+        verify(exactly = 1) { usercentricsSDK.getAdditionalConsentModeData() }
+        assertEquals(GetCMPDataMock.expectedAdditionalConsentModeData.toWritableMap(), result)
+    }
 }