feat(MSDK-3172): Consume and expose DPS metadata in AppSDK

Author: uc-christiansousa

android/src/main/kotlin/com/usercentrics/sdk/flutter/UsercentricsPlugin.kt

@@ -72,7 +72,8 @@ class UsercentricsPlugin : FlutterPlugin,
             ClearUserSessionBridge(),
             GetGPPDataBridge(),
             GetGPPStringBridge(),
-            SetGPPConsentBridge()
+            SetGPPConsentBridge(),
+            GetDpsMetadataBridge()
         ).associateBy { it.name }
     }
 

android/src/main/kotlin/com/usercentrics/sdk/flutter/bridge/GetDpsMetadataBridge.kt

@@ -0,0 +1,20 @@
+package com.usercentrics.sdk.flutter.bridge
+
+import com.usercentrics.sdk.flutter.api.FlutterMethodCall
+import com.usercentrics.sdk.flutter.api.FlutterResult
+import com.usercentrics.sdk.flutter.api.UsercentricsProxy
+import com.usercentrics.sdk.flutter.api.UsercentricsProxySingleton
+
+internal class GetDpsMetadataBridge(
+    private val usercentrics: UsercentricsProxy = UsercentricsProxySingleton
+) : MethodBridge {
+
+    override val name: String
+        get() = "getDpsMetadata"
+
+    override fun invoke(call: FlutterMethodCall, result: FlutterResult) {
+        assert(name == call.method)
+        val templateId = call.arguments as String
+        result.success(usercentrics.instance.getDpsMetadata(templateId))
+    }
+}

android/src/test/java/com/usercentrics/sdk/flutter/bridge/GetDpsMetadataBridgeTest.kt

@@ -0,0 +1,65 @@
+package com.usercentrics.sdk.flutter.bridge
+
+import com.usercentrics.sdk.UsercentricsSDK
+import com.usercentrics.sdk.flutter.api.FakeFlutterMethodCall
+import com.usercentrics.sdk.flutter.api.FakeFlutterResult
+import com.usercentrics.sdk.flutter.api.FakeUsercentricsProxy
+import com.usercentrics.sdk.flutter.mock.GetDpsMetadataMock
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertThrows
+import org.junit.Test
+
+class GetDpsMetadataBridgeTest {
+
+    @Test
+    fun testName() {
+        val instance = GetDpsMetadataBridge(FakeUsercentricsProxy())
+        assertEquals("getDpsMetadata", instance.name)
+    }
+
+    @Test
+    fun testInvokeWithOtherName() {
+        val instance = GetDpsMetadataBridge(FakeUsercentricsProxy())
+        val call = FakeFlutterMethodCall(method = "otherName", arguments = null)
+
+        assertThrows(AssertionError::class.java) {
+            instance.invoke(call, FakeFlutterResult())
+        }
+    }
+
+    @Test
+    fun testInvoke() {
+        val usercentricsSDK = mockk<UsercentricsSDK>()
+        every { usercentricsSDK.getDpsMetadata(GetDpsMetadataMock.templateId) }.returns(GetDpsMetadataMock.fake)
+        val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
+        val instance = GetDpsMetadataBridge(usercentricsProxy)
+        val result = FakeFlutterResult()
+
+        instance.invoke(GetDpsMetadataMock.call, result)
+
+        verify(exactly = 1) { usercentricsSDK.getDpsMetadata(GetDpsMetadataMock.templateId) }
+
+        assertEquals(1, result.successCount)
+        assertEquals(GetDpsMetadataMock.expected, result.successResultArgument)
+    }
+
+    @Test
+    fun testInvokeReturnsNull() {
+        val usercentricsSDK = mockk<UsercentricsSDK>()
+        every { usercentricsSDK.getDpsMetadata(any()) }.returns(null)
+        val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
+        val instance = GetDpsMetadataBridge(usercentricsProxy)
+        val result = FakeFlutterResult()
+        val call = FakeFlutterMethodCall(method = "getDpsMetadata", arguments = "unknownTemplate")
+
+        instance.invoke(call, result)
+
+        verify(exactly = 1) { usercentricsSDK.getDpsMetadata("unknownTemplate") }
+
+        assertEquals(1, result.successCount)
+        assertEquals(null, result.successResultArgument)
+    }
+}

android/src/test/java/com/usercentrics/sdk/flutter/mock/GetDpsMetadataMock.kt

@@ -0,0 +1,19 @@
+package com.usercentrics.sdk.flutter.mock
+
+import com.usercentrics.sdk.flutter.api.FakeFlutterMethodCall
+
+internal object GetDpsMetadataMock {
+
+    const val templateId = "templateId123"
+
+    val fake: Map<String, Any> = mapOf(
+        "key" to "value",
+        "count" to 42
+    )
+
+    val call = FakeFlutterMethodCall(method = "getDpsMetadata", arguments = templateId)
+    val expected: Map<String, Any> = mapOf(
+        "key" to "value",
+        "count" to 42
+    )
+}

ios/Classes/Bridge/GetDpsMetadataBridge.swift

@@ -0,0 +1,19 @@
+import Usercentrics
+
+struct GetDpsMetadataBridge : MethodBridge {
+
+    let name: String = "getDpsMetadata"
+    let usercentrics: UsercentricsProxyProtocol
+
+    func invoke(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
+        assert(call.method == name)
+        guard let templateId = call.arguments as? String else {
+            result(FlutterError(code: "usercentrics_flutter_getDpsMetadata_error",
+                                message: "Invalid Parameter",
+                                details: nil ))
+            return
+        }
+
+        result(usercentrics.shared.getDpsMetadata(templateId: templateId))
+    }
+}

ios/Classes/SwiftUsercentricsPlugin.swift

@@ -54,7 +54,8 @@ public class SwiftUsercentricsPlugin: NSObject, FlutterPlugin {
             ClearUserSessionBridge(usercentrics: usercentrics),
             GetGPPDataBridge(usercentrics: usercentrics),
             GetGPPStringBridge(usercentrics: usercentrics),
-            SetGPPConsentBridge(usercentrics: usercentrics)
+            SetGPPConsentBridge(usercentrics: usercentrics),
+            GetDpsMetadataBridge(usercentrics: usercentrics)
         ]
         return bridges.reduce([String : MethodBridge]()) { dict, value in
             var dict = dict

lib/src/internal/bridge/bridge.dart

@@ -26,3 +26,4 @@ export 'clear_user_session_bridge.dart';
 export 'get_gpp_data_bridge.dart';
 export 'get_gpp_string_bridge.dart';
 export 'set_gpp_consent_bridge.dart';
+export 'get_dps_metadata_bridge.dart';

lib/src/internal/bridge/get_dps_metadata_bridge.dart

@@ -0,0 +1,25 @@
+import 'package:flutter/services.dart';
+
+abstract class GetDpsMetadataBridge {
+  const GetDpsMetadataBridge();
+
+  Future<Map<String, dynamic>?> invoke({
+    required MethodChannel channel,
+    required String templateId,
+  });
+}
+
+class MethodChannelGetDpsMetadata extends GetDpsMetadataBridge {
+  const MethodChannelGetDpsMetadata();
+
+  static const String _name = 'getDpsMetadata';
+
+  @override
+  Future<Map<String, dynamic>?> invoke({
+    required MethodChannel channel,
+    required String templateId,
+  }) async {
+    final result = await channel.invokeMethod<Map?>(_name, templateId);
+    return result?.cast<String, dynamic>();
+  }
+}

lib/src/internal/platform/method_channel_usercentrics.dart

@@ -37,7 +37,8 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
       this.clearUserSessionBridge = const MethodChannelClearUserSession(),
       this.getGPPDataBridge = const MethodChannelGetGPPData(),
       this.getGPPStringBridge = const MethodChannelGetGPPString(),
-      this.setGPPConsentBridge = const MethodChannelSetGPPConsent()});
+      this.setGPPConsentBridge = const MethodChannelSetGPPConsent(),
+      this.getDpsMetadataBridge = const MethodChannelGetDpsMetadata()});
 
   static const MethodChannel _channel = MethodChannel('usercentrics');
   static const EventChannel _gppSectionChangeEventChannel =
@@ -71,6 +72,7 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
   final GetGPPDataBridge getGPPDataBridge;
   final GetGPPStringBridge getGPPStringBridge;
   final SetGPPConsentBridge setGPPConsentBridge;
+  final GetDpsMetadataBridge getDpsMetadataBridge;
 
   @visibleForTesting
   Completer<Object?>? isReadyCompleter;
@@ -379,6 +381,17 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
     );
   }
 
+  @override
+  Future<Map<String, dynamic>?> getDpsMetadata({
+    required String templateId,
+  }) async {
+    await _ensureIsReady();
+    return await getDpsMetadataBridge.invoke(
+      channel: _channel,
+      templateId: templateId,
+    );
+  }
+
   @override
   Stream<GppSectionChangePayload> get onGppSectionChange {
     return _gppSectionChangeEventChannel

lib/src/platform/usercentrics_platform.dart

@@ -114,4 +114,8 @@ abstract class UsercentricsPlatform {
   });
 
   Stream<GppSectionChangePayload> get onGppSectionChange;
+
+  Future<Map<String, dynamic>?> getDpsMetadata({
+    required String templateId,
+  });
 }