@didomi/react-native 1.0.0 → 1.4.0

package/README.md

@@ -1,6 +1,6 @@
 # Didomi React Native
 
-Didomi is a leading Consent Management Platform that allows companies to collect, store, and leverage user consent under GDPR, CCPA, and other data privacy regulations. This plugin enables Flutter developers to get in compliance and optimize their consent rate and monetization on native mobile apps.
+Didomi is a leading Consent Management Platform that allows companies to collect, store, and leverage user consent under GDPR, CCPA, and other data privacy regulations. This plugin enables React Native developers to get in compliance and optimize their consent rate and monetization on native mobile apps.
 
 This repository contains the source code and a sample app for the Didomi React Native plugin. This plugin enables React Native developers to easily use Didomi's Consent Management Platform on Android and iOS apps.
 
@@ -18,12 +18,26 @@ As Didomi requires Swift runtime for iOS, you may need to add an empty Swift fil
 
 ```js
 import { Didomi, DidomiEventType } from '@didomi/react-native';
+import { useEffect } from 'react';
 
 // ...
+function App() {
+  useEffect(() => {
+    // Initialize and setup UI
+    // The initialize function need to be called only once and as early as possible to give time for the SDK initialization
+    Didomi.initialize('YOUR_API_KEY', undefined, undefined, undefined, false, undefined, 'YOUR_NOTICE_ID');
+
+    // The setupUI displays the popup and is only available once the SDK sent the onReady events
+    Didomi.setupUI();
+  }, [])
+  return (
+    <SafeAreaView style={{ flex: 1 }}>
+      // ...
+    </SafeAreaView>
+  );
+}
 
-// Initialize and setup UI
-Didomi.initialize('YOUR_API_KEY', undefined, undefined, undefined, true, undefined, 'YOUR_NOTICE_ID');
-Didomi.setupUI();
+//...
 
 // Retrieve data
 const purposes = await Didomi.getEnabledPurposes();
@@ -40,7 +54,7 @@ Didomi.addEventListener(DidomiEventType.SHOW_NOTICE, () => {
 
 ```
 
-For a complete overview of available methods and events, have a look at the [online documentation](https://developers.didomi.io/cmp/react-native).
+For a complete overview of available methods and events, have a look at the [online documentation](https://developers.didomi.io/cmp/mobile-sdk/react-native).
 
 ## Configuration with local file
 
@@ -49,7 +63,7 @@ In case you need to use a local configuration. The ``didomi_config.json`` must b
 
 On iOS, drag and drop the file to Xcode files.
 
-On Android, copy it to the ``src/main/assets` folder.
+On Android, copy it to the ``src/main/assets`` folder.
 
 ## Documentation
 
@@ -61,13 +75,13 @@ For complete instructions on installing and using the plugin, please read our do
 
 ## Example applications
 
-Sources contain 2 applications: ``/example`` (an app designed mostly for UI testing ) and ``/example2`` (more human friendly app).
+Sources contain 2 applications: ``/testApp`` (an app designed mostly for UI testing ) and ``/sampleApp`` (more human friendly app).
 
 They can be run with:
 
 ```bash
-# example or example2
-cd example
+# testApp or sampleApp
+cd testApp
 cd ios && pod install
 yarn ios
 # or yarn android

package/android/build.gradle

@@ -34,6 +34,8 @@ android {
         versionCode 1
         versionName "1.0"
 
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        multiDexEnabled = true
     }
 
     buildTypes {
@@ -128,5 +130,5 @@ dependencies {
     api "com.facebook.react:react-native:+"
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-    implementation "io.didomi.sdk:android:1.40.0"
+    implementation "io.didomi.sdk:android:1.54.0"
 }

package/android/src/main/java/com/reactnativedidomi/DidomiModule.kt

@@ -36,12 +36,12 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
         override fun consentChanged(event: ConsentChangedEvent) = prepareEvent(EventTypes.CONSENT_CHANGED.event, null)
 
         /**
-         * The notice is being hidden
+         * The notice screen is being hidden
          */
         override fun hideNotice(event: HideNoticeEvent) = prepareEvent(EventTypes.HIDE_NOTICE.event, null)
 
         /**
-         * The notice is being shown
+         * The notice screen is being shown
          */
         override fun showNotice(event: ShowNoticeEvent) = prepareEvent(EventTypes.SHOW_NOTICE.event, null)
 
@@ -70,6 +70,16 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
          */
         override fun noticeClickPrivacyPolicy(event: NoticeClickPrivacyPolicyEvent) = prepareEvent(EventTypes.NOTICE_CLICK_PRIVACY_POLICY.event, null)
 
+        /**
+         * The preferences screen is being hidden
+         */
+        override fun hidePreferences(event: HidePreferencesEvent) = prepareEvent(EventTypes.HIDE_PREFERENCES.event, null)
+
+        /**
+         * The preferences screen is being shown
+         */
+        override fun showPreferences(event: ShowPreferencesEvent) = prepareEvent(EventTypes.SHOW_PREFERENCES.event, null)
+
         /**
          * Click on agree to all on preferences popup
          */
@@ -242,6 +252,10 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
                     languageCode,
                     noticeId
             )
+
+            Didomi.getInstance().onReady { prepareEvent(EventTypes.READY_CALLBACK.event, null) }
+            Didomi.getInstance().onError { prepareEvent(EventTypes.ERROR_CALLBACK.event, null) }
+
             promise.resolve(0)
 
         } catch (e: Exception) {
@@ -349,9 +363,14 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
     }
 
     @ReactMethod
-    fun getJavaScriptForWebView(promise: Promise) {
+    fun getJavaScriptForWebView(extra: String?, promise: Promise) {
         try {
-            promise.resolve(Didomi.getInstance().javaScriptForWebView)
+            extra?.let {
+                promise.resolve(Didomi.getInstance().getJavaScriptForWebView(extra))
+            } ?: run {
+                promise.resolve(Didomi.getInstance().getJavaScriptForWebView())
+            }
+
         } catch (e: DidomiNotReadyException) {
             promise.reject(e)
         }
@@ -490,6 +509,15 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
         }
     }
 
+    @ReactMethod
+    fun getUserStatus(promise: Promise) {
+        try {
+            promise.resolve(objectToWritableMap(Didomi.getInstance().getUserStatus()))
+        } catch (e: DidomiNotReadyException) {
+            promise.reject(e)
+        }
+    }
+
     @ReactMethod
     fun getUserStatusForVendor(vendorId: String, promise: Promise) {
         try {
@@ -743,6 +771,7 @@ class DidomiModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
     }
 
     private fun prepareEvent(eventName: String, params: String?) {
+        Log.d("prepareEvent", "Sending $eventName")
         reactContext
                 .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)
                 .emit(eventName, params)

package/android/src/main/java/com/reactnativedidomi/EventTypes.kt

@@ -2,7 +2,9 @@ package com.reactnativedidomi
 
 enum class EventTypes(val event: String) {
     READY("on_ready"),
+    READY_CALLBACK("on_ready_callback"),
     ERROR("on_error"),
+    ERROR_CALLBACK("on_error_callback"),
     CONSENT_CHANGED("on_consent_changed"),
     HIDE_NOTICE("on_hide_notice"),
     SHOW_NOTICE("on_show_notice"),
@@ -11,6 +13,8 @@ enum class EventTypes(val event: String) {
     NOTICE_CLICK_MORE_INFO("on_notice_click_more_info"),
     NOTICE_CLICK_VIEW_VENDORS("on_notice_click_view_vendors"),
     NOTICE_CLICK_PRIVACY_POLICY("on_notice_click_privacy_policy"),
+    HIDE_PREFERENCES("on_hide_preferences"),
+    SHOW_PREFERENCES("on_show_preferences"),
     PREFERENCES_CLICK_AGREE_TO_ALL("on_preferences_click_agree_to_all"),
     PREFERENCES_CLICK_DISAGREE_TO_ALL("on_preferences_click_disagree_to_all"),
     PREFERENCES_CLICK_PURPOSE_AGREE("on_preferences_click_purpose_agree"),

package/ios/Didomi.m

@@ -21,6 +21,13 @@ RCT_EXTERN_METHOD(initialize:(NSString *)apikey
                   languageCode:(nullable NSString *)languageCode
                   noticeId:(nullable NSString *)noticeId)
 
+RCT_EXTERN_METHOD(onReady)
+
+RCT_EXTERN_METHOD(onError)
+
+RCT_EXTERN_METHOD(getQueryStringForWebView:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(setUserAgent:(NSString *)name
                   version:(NSString *)version)
 
@@ -45,6 +52,9 @@ RCT_EXTERN_METHOD(getUserLegitimateInterestStatusForPurpose:(NSString *)purposeI
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(getUserStatus:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(getUserStatusForVendor:(NSString *)vendorId
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)

package/ios/RNDidomi.swift

@@ -5,7 +5,7 @@ import AppTrackingTransparency
 @objc(Didomi)
 class RNDidomi: RCTEventEmitter {
     
-    var initialized = false
+    public static var initialized = false
     let didomiEventListener = EventListener()
     
     override static func requiresMainQueueSetup() -> Bool {
@@ -14,12 +14,31 @@ class RNDidomi: RCTEventEmitter {
     
     @objc(initialize:localConfigurationPath:remoteConfigurationURL:providerId:disableDidomiRemoteConfig:languageCode:noticeId:)
     func initialize(apiKey: String, localConfigurationPath: String?, remoteConfigurationURL: String?, providerId: String?, disableDidomiRemoteConfig: Bool = false, languageCode: String? = nil, noticeId: String? = nil) {
-        if !initialized {
+        onReady()
+        onError()
+        if !RNDidomi.initialized {
             initEventListener()
             let newLanguageCode = Locale.current.languageCode ?? ""
             Didomi.shared.initialize(apiKey: apiKey, localConfigurationPath: localConfigurationPath, remoteConfigurationURL: remoteConfigurationURL, providerId: providerId, disableDidomiRemoteConfig: disableDidomiRemoteConfig, languageCode: languageCode != nil ? languageCode : newLanguageCode, noticeId: noticeId)
         }
-        initialized = true
+        RNDidomi.initialized = true
+    }
+    
+    private func onReady() {
+        Didomi.shared.onReady {
+            self.sendEvent(withName: "on_ready_callback", body: nil)
+        }
+    }
+    
+    private func onError() {
+        Didomi.shared.onError { error in
+            self.sendEvent(withName: "on_error_callback", body: error.descriptionText)
+        }
+    }
+    
+    @objc(getQueryStringForWebView:reject:)
+    func getQueryStringForWebView(resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
+        resolve(Didomi.shared.getQueryStringForWebView())
     }
     
     @objc(setUserAgent:version:)
@@ -50,43 +69,50 @@ class RNDidomi: RCTEventEmitter {
     @objc(getUserConsentStatusForPurpose:resolve:reject:)
     func getUserConsentStatusForPurpose(purposeId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserConsentStatusForPurpose(purposeId: purposeId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
     }
     
     @objc(getUserLegitimateInterestStatusForPurpose:resolve:reject:)
     func getUserLegitimateInterestStatusForPurpose(purposeId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserLegitimateInterestStatusForPurpose(purposeId: purposeId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
+    }
+    
+    @objc(getUserStatus:reject:)
+    func getUserStatus(resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
+        let encoder = JSONEncoder()
+        let userStatus = try? JSONSerialization.jsonObject(with: encoder.encode(Didomi.shared.getUserStatus())) as? [String: Any]
+        resolve(userStatus)
     }
     
     @objc(getUserStatusForVendor:resolve:reject:)
     func getUserStatusForVendor(vendorId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let userStatus = Didomi.shared.getUserStatusForVendor(vendorId: vendorId)
-        resolve(userStatus)
+        resolve(userStatus.rawValue.consentStatusBool)
     }
     
     @objc(getUserConsentStatusForVendor:resolve:reject:)
     func getUserConsentStatusForVendor(vendorId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserConsentStatusForVendor(vendorId: vendorId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
     }
     
     @objc(getUserLegitimateInterestStatusForVendor:resolve:reject:)
     func getUserLegitimateInterestStatusForPurpose(vendorId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserLegitimateInterestStatusForVendor(vendorId: vendorId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
     }
     
     @objc(getUserConsentStatusForVendorAndRequiredPurposes:resolve:reject:)
     func getUserConsentStatusForVendorAndRequiredPurposes(vendorId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserConsentStatusForVendorAndRequiredPurposes(vendorId: vendorId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
     }
     
     @objc(getUserLegitimateInterestStatusForVendorAndRequiredPurposes:resolve:reject:)
     func getUserLegitimateInterestStatusForVendorAndRequiredPurposes(vendorId: String, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
         let consentStatus = Didomi.shared.getUserLegitimateInterestStatusForVendorAndRequiredPurposes(vendorId: vendorId)
-        resolve(consentStatus)
+        resolve(consentStatus.rawValue.consentStatusBool)
     }
     
     @objc(setUserStatus:purposesLIStatus:vendorsConsentStatus:vendorsLIStatus:resolve:reject:)
@@ -210,8 +236,12 @@ class RNDidomi: RCTEventEmitter {
     }
     
     @objc(getJavaScriptForWebView:resolve:reject:)
-    func getJavaScriptForWebView(extra: String = "", resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
-        resolve(Didomi.shared.getJavaScriptForWebView(extra: extra))
+    func getJavaScriptForWebView(_ extra: String? = "", resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) {
+        if let extra = extra {
+            resolve(Didomi.shared.getJavaScriptForWebView(extra: extra))
+        } else {
+            resolve(Didomi.shared.getJavaScriptForWebView())
+        }
     }
     
     @objc(updateSelectedLanguage:)
@@ -423,16 +453,20 @@ extension RNDidomi {
     
     @objc(supportedEvents)
     override func supportedEvents() -> [String]! {
-        return ["on_consent_changed",
-                "on_hide_notice",
+        return ["on_ready_callback",
+                "on_error_callback",
+                "on_consent_changed",
                 "on_ready",
                 "on_error",
+                "on_hide_notice",
                 "on_show_notice",
                 "on_notice_click_agree",
                 "on_notice_click_disagree",
                 "on_notice_click_more_info",
                 "on_notice_click_view_vendors",
                 "on_notice_click_privacy_policy",
+                "on_hide_preferences",
+                "on_show_preferences",
                 "on_preferences_click_agree_to_all",
                 "on_preferences_click_disagree_to_all",
                 "on_preferences_click_agree_to_all_purposes",
@@ -461,10 +495,6 @@ extension RNDidomi {
             self.sendEvent(withName: "on_consent_changed", body:"")
         }
         
-        didomiEventListener.onHideNotice = { event in
-            self.sendEvent(withName: "on_hide_notice", body: "")
-        }
-        
         didomiEventListener.onReady = { event in
             self.sendEvent(withName: "on_ready", body: "")
         }
@@ -477,6 +507,10 @@ extension RNDidomi {
             self.sendEvent(withName: "on_show_notice", body: "")
         }
         
+        didomiEventListener.onHideNotice = { event in
+            self.sendEvent(withName: "on_hide_notice", body: "")
+        }
+        
         didomiEventListener.onNoticeClickAgree = { event in
             self.sendEvent(withName: "on_notice_click_agree", body: "")
         }
@@ -497,6 +531,14 @@ extension RNDidomi {
             self.sendEvent(withName: "on_notice_click_privacy_policy", body: "")
         }
         
+        didomiEventListener.onShowPreferences = { event in
+            self.sendEvent(withName: "on_show_preferences", body: "")
+        }
+        
+        didomiEventListener.onHidePreferences = { event in
+            self.sendEvent(withName: "on_hide_preferences", body: "")
+        }
+        
         didomiEventListener.onPreferencesClickAgreeToAll = { event in
             self.sendEvent(withName: "on_preferences_click_agree_to_all", body: "")
         }
@@ -573,3 +615,12 @@ extension RNDidomi {
     }
 }
 
+extension Int {
+    var consentStatusBool: Bool? {
+        if self == 2 {
+            return nil
+        } else {
+            return self == 0
+        }
+    }
+}