cordova-plugin-onetrust-cmp 202602.1.2 → 202604.1.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 202604.1.0
+* Adds support for OneTrust 202604.1.0
+* Added renameProfile, fetchBannerCmpApiData, fetchPreferencesCmpApiData, fetchVendorsCmpApiData methods
+
+## 202603.1.0
+* Exposed OTConsentUpdated event
+* Adds support for OneTrust 202603.1.0
+
 ## 202602.1.2
 * Adds support for OneTrust 202602.1.2
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-onetrust-cmp",
-  "version": "202602.1.2",
+  "version": "202604.1.0",
   "description": "OneTrust is the leading Consent Management solution provider. This plugin exposes OneTrust's native CMP functionality to Cordova and Ionic environments.",
   "main": "index.js",
   "scripts": {  

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="cordova-plugin-onetrust-cmp" version="202602.1.2"
+<plugin id="cordova-plugin-onetrust-cmp" version="202604.1.0"
     xmlns="http://apache.org/cordova/ns/plugins/1.0"
     xmlns:android="http://schemas.android.com/apk/res/android">
     <name>OneTrust</name>
@@ -18,12 +18,12 @@
         <config>
         </config>
         <pods use-frameworks="true">
-            <pod name="OneTrust-CMP-XCFramework" spec="~> 202602.1.2.0" />
+            <pod name="OneTrust-CMP-XCFramework" spec="~> 202604.1.0.0" />
         </pods>
     </podspec>
     </platform>
     <platform name="android">
-        <framework src="com.onetrust.cmp:native-sdk:202602.1.2.0" />
+        <framework src="com.onetrust.cmp:native-sdk:202604.1.0.0" />
         <framework src="androidx.appcompat:appcompat:1.2.0" />
         <config-file parent="/*" target="res/xml/config.xml">
             <feature name="OneTrust">

package/src/android/OneTrust.java

@@ -5,6 +5,7 @@ import android.content.Context;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.os.Build;
+import androidx.annotation.NonNull;
 
 import com.onetrust.otpublishers.headless.Public.DataModel.OTProfileSyncParams;
 import com.onetrust.otpublishers.headless.Public.Keys.OTBroadcastServiceKeys;
@@ -71,6 +72,9 @@ public class OneTrust extends CordovaPlugin{
                 String catId = args.getString(0);
                 observeChanges(catId);
                 return true;
+            case "stopObservingChanges":
+                stopObservingChanges();
+                return true;
             case "addCustomStyles":
                 callbackContext.error("Deprecated Method. Add your JSON as androidUXParams in the params object of startSDK.");
             case "getCachedIdentifier":
@@ -90,7 +94,21 @@ public class OneTrust extends CordovaPlugin{
                 return true;
             case "getOTGoogleConsentModeData":
                 getOTGoogleConsentModeData(callbackContext);
-                return true;   
+                return true;
+            case "fetchBannerCmpApiData":
+                fetchBannerCmpApiData(callbackContext);
+                return true;
+            case "fetchPreferencesCmpApiData":
+                fetchPreferencesCmpApiData(callbackContext);
+                return true;
+            case "fetchVendorsCmpApiData":
+                fetchVendorsCmpApiData(callbackContext);
+                return true;
+            case "renameProfile":
+                String fromIdentifier = args.optString(0, "");
+                String toIdentifier = args.getString(1);
+                renameProfile(fromIdentifier, toIdentifier, callbackContext);
+                return true;
             default:
                 callbackContext.error("Unimplemented method called");
                 break;
@@ -232,6 +250,14 @@ public class OneTrust extends CordovaPlugin{
     }
 
     private void observeChanges(String catId){
+        if (catId.equals("OTConsentUpdated")) {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+                cordova.getActivity().registerReceiver(otConsentUpdated, new IntentFilter(OTBroadcastServiceKeys.OT_CONSENT_UPDATED), Context.RECEIVER_NOT_EXPORTED);
+            } else {
+                cordova.getActivity().registerReceiver(otConsentUpdated, new IntentFilter(OTBroadcastServiceKeys.OT_CONSENT_UPDATED));
+            }
+            return;
+        }
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
             cordova.getActivity().registerReceiver(consentStatusChanged, new IntentFilter(catId), Context.RECEIVER_NOT_EXPORTED);
           } else {
@@ -240,6 +266,15 @@ public class OneTrust extends CordovaPlugin{
 
     }
 
+    private void stopObservingChanges(){
+        try{
+            cordova.getActivity().unregisterReceiver(consentStatusChanged);
+            cordova.getActivity().unregisterReceiver(otConsentUpdated);
+        } catch (Exception e) {
+            Log.e("ot_log", "Error when trying to unregister receiver.");
+        }
+    }
+
     private void getCachedIdentifier(CallbackContext callbackContext){
         Runnable runnable = new Runnable() {
             @Override
@@ -325,6 +360,14 @@ public class OneTrust extends CordovaPlugin{
         }
     };
 
+    BroadcastReceiver otConsentUpdated = new BroadcastReceiver() {
+        @Override
+        public void onReceive(Context context, Intent intent) {
+            String category = intent.getAction();
+            emit(category, "{}");
+        }
+    };
+
     private void startCMPActivity(int uiType){
         Intent intent = new Intent(cordova.getContext(), CMPActivity.class);
         intent.putExtra("UIType", uiType);
@@ -365,4 +408,84 @@ public class OneTrust extends CordovaPlugin{
         };
         runInThreadPool(runnable);
     }
+
+    private void fetchBannerCmpApiData(CallbackContext callbackContext) {
+        Runnable runnable = new Runnable() {
+            @Override
+            public void run() {
+                new OTPublishersHeadlessSDK(cordova.getContext()).fetchBannerCmpApiData(new OTCallback() {
+                    @Override
+                    public void onSuccess(@NonNull OTResponse otSuccessResponse) {
+                        callbackContext.success(otSuccessResponse.getResponseData());
+                    }
+
+                    @Override
+                    public void onFailure(@NonNull OTResponse otErrorResponse) {
+                        callbackContext.error(otErrorResponse.getResponseMessage());
+                    }
+                });
+            }
+        };
+        runInThreadPool(runnable);
+    }
+
+    private void fetchPreferencesCmpApiData(CallbackContext callbackContext) {
+        Runnable runnable = new Runnable() {
+            @Override
+            public void run() {
+                new OTPublishersHeadlessSDK(cordova.getContext()).fetchPreferencesCmpApiData(new OTCallback() {
+                    @Override
+                    public void onSuccess(@NonNull OTResponse otSuccessResponse) {
+                        callbackContext.success(otSuccessResponse.getResponseData());
+                    }
+
+                    @Override
+                    public void onFailure(@NonNull OTResponse otErrorResponse) {
+                        callbackContext.error(otErrorResponse.getResponseMessage());
+                    }
+                });
+            }
+        };
+        runInThreadPool(runnable);
+    }
+
+    private void fetchVendorsCmpApiData(CallbackContext callbackContext) {
+        Runnable runnable = new Runnable() {
+            @Override
+            public void run() {
+                new OTPublishersHeadlessSDK(cordova.getContext()).fetchVendorsCmpApiData(new OTCallback() {
+                    @Override
+                    public void onSuccess(@NonNull OTResponse otSuccessResponse) {
+                        callbackContext.success(otSuccessResponse.getResponseData());
+                    }
+
+                    @Override
+                    public void onFailure(@NonNull OTResponse otErrorResponse) {
+                        callbackContext.error(otErrorResponse.getResponseMessage());
+                    }
+                });
+            }
+        };
+        runInThreadPool(runnable);
+    }
+
+    private void renameProfile(String fromIdentifier, String toIdentifier, CallbackContext callbackContext) {
+        Runnable runnable = new Runnable() {
+            @Override
+            public void run() {
+                ot.renameProfile(fromIdentifier, toIdentifier, new OTCallback() {
+                    @Override
+                    public void onSuccess(@NonNull OTResponse otResponse) {
+                        callbackContext.success(1);
+                    }
+
+                    @Override
+                    public void onFailure(@NonNull OTResponse otResponse) {
+                        callbackContext.error(otResponse.getResponseMessage());
+                    }
+                });
+            }
+        };
+        runInThreadPool(runnable);
+    }
 }

package/src/ios/OneTrust.swift

@@ -155,7 +155,11 @@ import AppTrackingTransparency
     func observeChanges(_ command:CDVInvokedUrlCommand){
         var pluginResult = CDVPluginResult(status: CDVCommandStatus_ERROR)
         if let category = command.argument(at: 0) as? String{
-            NotificationCenter.default.addObserver(self, selector: #selector(consentChanged(_:)), name: Notification.Name(category), object: nil)
+            if category == "OTConsentUpdated" {
+                NotificationCenter.default.addObserver(self, selector: #selector(otConsentUpdated(_:)), name: Notification.Name(category), object: nil)
+            } else {
+                NotificationCenter.default.addObserver(self, selector: #selector(consentChanged(_:)), name: Notification.Name(category), object: nil)
+            }
             pluginResult = CDVPluginResult(status: CDVCommandStatus_OK)
         }
         self.returnToCordova(pluginResult: pluginResult, command: command)
@@ -264,6 +268,13 @@ import AppTrackingTransparency
         
     }
     
+    @objc private func otConsentUpdated(_ notification:Notification){
+        let ex = "cordova.fireDocumentEvent('OTConsentUpdated',{});"
+        DispatchQueue.main.async{
+            self.webViewEngine.evaluateJavaScript(ex, completionHandler: nil)
+        }
+    }
+    
     private func getATTStatusAsString() -> String?{
             guard #available(iOS 14, *) else {return nil}
             let statusMap:[ATTrackingManager.AuthorizationStatus:String] = [.authorized:"authorized", .denied:"denied", .notDetermined:"notDetermined", .restricted:"restricted"]
@@ -276,7 +287,72 @@ import AppTrackingTransparency
             self.commandDelegate!.send(pluginResult, callbackId: command.callbackId)
         }
     }
-    
+
+    // Add this private helper method
+    private func fetchCmpApiData(
+        fetcher: (@escaping ([String: Any]?) -> Void) -> Void,
+        command: CDVInvokedUrlCommand,
+        errorMessage: String
+    ) {
+        fetcher { response in
+            let pluginResult: CDVPluginResult
+            if let data = response,
+            let jsonData = try? JSONSerialization.data(withJSONObject: data),
+            let jsonString = String(data: jsonData, encoding: .utf8) {
+                pluginResult = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: jsonString)
+            } else {
+                pluginResult = CDVPluginResult(status: CDVCommandStatus_ERROR, messageAs: errorMessage)
+            }
+            self.returnToCordova(pluginResult: pluginResult, command: command)
+        }
+    }
+
+    @objc(fetchBannerCmpApiData:)
+    func fetchBannerCmpApiData(_ command: CDVInvokedUrlCommand) {
+        fetchCmpApiData(
+            fetcher: OTPublishersHeadlessSDK.shared.fetchBannerCmpApiData,
+            command: command,
+            errorMessage: "No response from fetchBannerCmpApiData"
+        )
+    }
+
+    @objc(fetchPreferencesCmpApiData:)
+    func fetchPreferencesCmpApiData(_ command: CDVInvokedUrlCommand) {
+        fetchCmpApiData(
+            fetcher: OTPublishersHeadlessSDK.shared.fetchPreferencesCmpApiData,
+            command: command,
+            errorMessage: "No response from fetchPreferencesCmpApiData"
+        )
+    }
+
+    @objc(fetchVendorsCmpApiData:)
+    func fetchVendorsCmpApiData(_ command: CDVInvokedUrlCommand) {
+        fetchCmpApiData(
+            fetcher: OTPublishersHeadlessSDK.shared.fetchVendorsCmpApiData,
+            command: command,
+            errorMessage: "No response from fetchVendorsCmpApiData"
+        )
+    }
+
+    @objc(renameProfile:)
+    func renameProfile(_ command: CDVInvokedUrlCommand) {
+        let fromIdentifier = command.argument(at: 0) as? String
+        guard let toIdentifier = command.argument(at: 1) as? String else {
+            let pluginResult = CDVPluginResult(status: CDVCommandStatus_ERROR, messageAs: "toIdentifier is required")
+            self.returnToCordova(pluginResult: pluginResult, command: command)
+            return
+        }
+        
+        OTPublishersHeadlessSDK.shared.renameProfile(from: fromIdentifier, to: toIdentifier) { success in
+            let pluginResult: CDVPluginResult
+            if success {
+                pluginResult = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: true)
+            } else {
+                pluginResult = CDVPluginResult(status: CDVCommandStatus_ERROR, messageAs: "Error renaming profile")
+            }
+            self.returnToCordova(pluginResult: pluginResult, command: command)
+        }
+    }
 }
 
 extension OneTrust:OTEventListener{

package/www/OneTrust.js

@@ -59,6 +59,22 @@ var exports = {
       exec(success,error, pluginName, 'getOTGoogleConsentModeData')
     },
 
+    fetchBannerCmpApiData: (success, error) => {
+      exec(success, error, pluginName, 'fetchBannerCmpApiData')
+    },
+
+    fetchPreferencesCmpApiData: (success, error) => {
+      exec(success, error, pluginName, 'fetchPreferencesCmpApiData')
+    },
+
+    fetchVendorsCmpApiData: (success, error) => {
+      exec(success, error, pluginName, 'fetchVendorsCmpApiData')
+    },
+
+    renameProfile: (fromIdentifier, toIdentifier, success, error) => {
+      exec(success, error, pluginName, 'renameProfile', [fromIdentifier, toIdentifier])
+    },
+
     devicePermission: Object.freeze({idfa:0})
   }