feat(MSDK-3781): Add notifySubscriptionLapsed to Flutter bridge

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

@@ -81,6 +81,7 @@ class UsercentricsPlugin : FlutterPlugin,
             GetDpsMetadataBridge(),
             NotifyLoginSuccessBridge(),
             NotifySubscribeSuccessBridge(),
+            NotifySubscriptionLapsedBridge(),
         ).associateBy { it.name }
     }
 

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

@@ -0,0 +1,35 @@
+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 NotifySubscriptionLapsedBridge(
+    private val usercentrics: UsercentricsProxy = UsercentricsProxySingleton
+) : MethodBridge {
+
+    companion object {
+        private const val notifySubscriptionLapsedErrorCode =
+            "usercentrics_flutter_notifySubscriptionLapsed_error"
+    }
+
+    override val name: String
+        get() = "notifySubscriptionLapsed"
+
+    override fun invoke(call: FlutterMethodCall, result: FlutterResult) {
+        assert(name == call.method)
+        usercentrics.instance.notifySubscriptionLapsed(
+            onSuccess = {
+                result.success(null)
+            },
+            onError = {
+                result.error(
+                    notifySubscriptionLapsedErrorCode,
+                    it.message,
+                    it
+                )
+            },
+        )
+    }
+}

example/lib/main.dart

@@ -258,6 +258,17 @@ class HomePageState extends State<HomePage> {
               ),
               child: const Text("GPP Testing"),
             ),
+            ElevatedButton(
+              onPressed: isSdkReady
+                  ? () async {
+                      await Usercentrics.notifySubscriptionLapsed();
+                      setState(() {
+                        _statusMessage = 'notifySubscriptionLapsed() called';
+                      });
+                    }
+                  : null,
+              child: const Text("Notify Subscription Lapsed"),
+            ),
           ],
         ),
       ),

example/test/fake_usercentrics.dart

@@ -201,4 +201,9 @@ class FakeUsercentrics extends UsercentricsPlatform {
   Future<void> notifySubscribeSuccess() {
     throw UnimplementedError();
   }
+
+  @override
+  Future<void> notifySubscriptionLapsed() {
+    throw UnimplementedError();
+  }
 }

ios/usercentrics_sdk/Sources/usercentrics_sdk/Bridge/NotifySubscriptionLapsedBridge.swift

@@ -0,0 +1,20 @@
+import Flutter
+import Foundation
+
+struct NotifySubscriptionLapsedBridge : MethodBridge {
+
+    let name: String = "notifySubscriptionLapsed"
+    let usercentrics: UsercentricsProxyProtocol
+
+    func invoke(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
+        assert(call.method == name)
+
+        usercentrics.shared.notifySubscriptionLapsed(onSuccess: {
+            result(nil)
+        }, onError: { error in
+            result(FlutterError(code: "usercentrics_flutter_notifySubscriptionLapsed_error",
+                                message: error.localizedDescription,
+                                details: nil))
+        })
+    }
+}

ios/usercentrics_sdk/Sources/usercentrics_sdk/UsercentricsPlugin.swift

@@ -84,7 +84,8 @@ public class UsercentricsPlugin: NSObject, FlutterPlugin {
             SetGPPConsentBridge(usercentrics: usercentrics),
             GetDpsMetadataBridge(usercentrics: usercentrics),
             NotifyLoginSuccessBridge(usercentrics: usercentrics),
-            NotifySubscribeSuccessBridge(usercentrics: usercentrics)
+            NotifySubscribeSuccessBridge(usercentrics: usercentrics),
+            NotifySubscriptionLapsedBridge(usercentrics: usercentrics)
         ]
         return bridges.reduce([String : MethodBridge]()) { dict, value in
             var dict = dict

lib/src/internal/bridge/bridge.dart

@@ -29,3 +29,4 @@ export 'set_gpp_consent_bridge.dart';
 export 'get_dps_metadata_bridge.dart';
 export 'notify_login_success_bridge.dart';
 export 'notify_subscribe_success_bridge.dart';
+export 'notify_subscription_lapsed_bridge.dart';

lib/src/internal/bridge/notify_subscription_lapsed_bridge.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/services.dart';
+
+abstract class NotifySubscriptionLapsedBridge {
+  const NotifySubscriptionLapsedBridge();
+
+  Future<void> invoke({required MethodChannel channel});
+}
+
+class MethodChannelNotifySubscriptionLapsed
+    extends NotifySubscriptionLapsedBridge {
+  const MethodChannelNotifySubscriptionLapsed();
+
+  static const String _name = 'notifySubscriptionLapsed';
+
+  @override
+  Future<void> invoke({required MethodChannel channel}) async {
+    await channel.invokeMethod(_name);
+  }
+}

lib/src/internal/platform/method_channel_usercentrics.dart

@@ -41,7 +41,9 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
       this.getDpsMetadataBridge = const MethodChannelGetDpsMetadata(),
       this.notifyLoginSuccessBridge = const MethodChannelNotifyLoginSuccess(),
       this.notifySubscribeSuccessBridge =
-          const MethodChannelNotifySubscribeSuccess()});
+          const MethodChannelNotifySubscribeSuccess(),
+      this.notifySubscriptionLapsedBridge =
+          const MethodChannelNotifySubscriptionLapsed()});
 
   static const MethodChannel _channel = MethodChannel('usercentrics');
   static const EventChannel _gppSectionChangeEventChannel =
@@ -82,6 +84,7 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
   final GetDpsMetadataBridge getDpsMetadataBridge;
   final NotifyLoginSuccessBridge notifyLoginSuccessBridge;
   final NotifySubscribeSuccessBridge notifySubscribeSuccessBridge;
+  final NotifySubscriptionLapsedBridge notifySubscriptionLapsedBridge;
 
   @visibleForTesting
   Completer<Object?>? isReadyCompleter;
@@ -436,4 +439,10 @@ class MethodChannelUsercentrics extends UsercentricsPlatform {
     await _ensureIsReady();
     await notifySubscribeSuccessBridge.invoke(channel: _channel);
   }
+
+  @override
+  Future<void> notifySubscriptionLapsed() async {
+    await _ensureIsReady();
+    await notifySubscriptionLapsedBridge.invoke(channel: _channel);
+  }
 }

lib/src/platform/usercentrics_platform.dart

@@ -136,4 +136,10 @@ abstract class UsercentricsPlatform {
 
   /// Clears stored TCF consent data after a successful Consent-or-Pay subscription.
   Future<void> notifySubscribeSuccess();
+
+  /// Notifies the SDK that the host app's user is no longer an active Consent-or-Pay
+  /// subscriber (e.g. their subscription lapsed or was cancelled). Resets the subscriber
+  /// flag and clears TCF consent storage, so the user is presented a fresh consent banner
+  /// next time, exactly as a new user would see it.
+  Future<void> notifySubscriptionLapsed();
 }

lib/src/usercentrics.dart

@@ -272,4 +272,11 @@ class Usercentrics {
   /// Clears stored TCF consent data after a successful Consent-or-Pay subscription.
   static Future<void> notifySubscribeSuccess() =>
       _delegate.notifySubscribeSuccess();
+
+  /// Notifies the SDK that the host app's user is no longer an active Consent-or-Pay
+  /// subscriber (e.g. their subscription lapsed or was cancelled). Resets the subscriber
+  /// flag so the host app can re-surface the Consent-or-Pay banner; does not alter any
+  /// existing consent data, which remains accurate.
+  static Future<void> notifySubscriptionLapsed() =>
+      _delegate.notifySubscriptionLapsed();
 }

test/internal/bridge/fake_notify_subscription_lapsed_bridge.dart

@@ -0,0 +1,15 @@
+import 'package:flutter/src/services/platform_channel.dart';
+import 'package:usercentrics_sdk/src/internal/bridge/notify_subscription_lapsed_bridge.dart';
+
+class FakeNotifySubscriptionLapsedBridge
+    extends NotifySubscriptionLapsedBridge {
+  var invokeCount = 0;
+  MethodChannel? invokeChannelArgument;
+
+  @override
+  Future<void> invoke({required MethodChannel channel}) {
+    invokeCount++;
+    invokeChannelArgument = channel;
+    return Future.value(null);
+  }
+}

test/internal/platform/method_channel_usercentrics_test.dart

@@ -13,6 +13,7 @@ import '../bridge/fake_restore_user_session_bridge.dart';
 import '../bridge/fake_clear_user_session_bridge.dart';
 import '../bridge/fake_show_first_layer_bridge.dart';
 import '../bridge/fake_show_second_layer_bridge.dart';
+import '../bridge/fake_notify_subscription_lapsed_bridge.dart';
 import '../bridge/get_cmp_data_bridge_test.dart';
 
 void main() {
@@ -530,4 +531,40 @@ void main() {
       );
     });
   });
+
+  group('notifySubscriptionLapsed', () {
+    test('default', () {
+      final instance = MethodChannelUsercentrics();
+      expect(instance.notifySubscriptionLapsedBridge,
+          const TypeMatcher<MethodChannelNotifySubscriptionLapsed>());
+    });
+
+    test('success', () async {
+      final notifySubscriptionLapsedBridge =
+          FakeNotifySubscriptionLapsedBridge();
+
+      final instance = MethodChannelUsercentrics(
+        notifySubscriptionLapsedBridge: notifySubscriptionLapsedBridge,
+      );
+
+      instance.isReadyCompleter = Completer();
+      instance.isReadyCompleter?.complete();
+
+      await instance.notifySubscriptionLapsed();
+
+      expect(notifySubscriptionLapsedBridge.invokeCount, 1);
+      expect(notifySubscriptionLapsedBridge.invokeChannelArgument?.name,
+          "usercentrics");
+    });
+
+    test('when it is not ready', () {
+      final instance = MethodChannelUsercentrics();
+      instance.isReadyCompleter = null;
+
+      expect(
+        () => instance.notifySubscriptionLapsed(),
+        throwsA(const TypeMatcher<NotInitializedException>()),
+      );
+    });
+  });
 }

test/platform/fake_usercentrics_platform.dart

@@ -420,14 +420,10 @@ class FakeUsercentricsPlatform extends UsercentricsPlatform {
   }
 
   @override
-  Stream<String?> get onLoginClicked {
-    return const Stream.empty();
-  }
+  Stream<String?> get onLoginClicked => const Stream.empty();
 
   @override
-  Stream<String?> get onSubscribeClicked {
-    return const Stream.empty();
-  }
+  Stream<String?> get onSubscribeClicked => const Stream.empty();
 
   var notifyLoginSuccessCount = 0;
 
@@ -444,4 +440,12 @@ class FakeUsercentricsPlatform extends UsercentricsPlatform {
     notifySubscribeSuccessCount++;
     return Future.value(null);
   }
+
+  var notifySubscriptionLapsedCount = 0;
+
+  @override
+  Future<void> notifySubscriptionLapsed() {
+    notifySubscriptionLapsedCount++;
+    return Future.value(null);
+  }
 }