feat: add notification tap stream

Author: cybex-dev

lib/js_notifications_web.dart

@@ -23,6 +23,7 @@ class JsNotificationsWeb extends JsNotificationsPlatform {
 
   StreamController<NotificationActionResult>? _dismissStream;
   StreamController<NotificationActionResult>? _actionStream;
+  StreamController<NotificationActionResult>? _tapStream;
 
   static String _scopeUrl = defaultScope;
 
@@ -37,11 +38,16 @@ class JsNotificationsWeb extends JsNotificationsPlatform {
 
   void _setup() {
     serviceWorkerManager = ServiceWorkerManager(
+        onNotificationTap: _onNotificationTap,
         onNotificationAction: _onNotificationAction,
         onNotificationDismiss: (t) => _onNotificationDismiss,
         scopeUrl: _scopeUrl);
   }
 
+  void _onNotificationTap(NotificationActionResult e) {
+    _tapStream?.add(e);
+  }
+
   void _onNotificationAction(NotificationActionResult e) {
     _actionStream?.add(e);
   }
@@ -146,4 +152,10 @@ class JsNotificationsWeb extends JsNotificationsPlatform {
     _dismissStream ??= StreamController<NotificationActionResult>.broadcast();
     return _dismissStream!.stream;
   }
+
+  @override
+  Stream<NotificationActionResult> get tapStream {
+    _tapStream ??= StreamController<NotificationActionResult>.broadcast();
+    return _tapStream!.stream;
+  }
 }

lib/managers/service_worker_manager.dart

@@ -19,14 +19,15 @@ class ServiceWorkerManager {
 
   late final String _scope;
 
-  ServiceWorkerManager({this.onNotificationAction, this.onNotificationDismiss, required String scopeUrl}){
+  ServiceWorkerManager({this.onNotificationTap, this.onNotificationAction, this.onNotificationDismiss, required String scopeUrl}){
     _scope = scopeUrl;
     _notificationApi = interop.NotificationsAPI.instance;
     _setupServiceWorker();
   }
 
   Consumer<NotificationActionResult>? onNotificationAction;
   Consumer<NotificationActionResult>? onNotificationDismiss;
+  Consumer<NotificationActionResult>? onNotificationTap;
 
   html.ServiceWorkerContainer? _webServiceWorkerContainerDelegate;
 
@@ -162,12 +163,30 @@ class ServiceWorkerManager {
   void _onServiceWorkerContainerMessageEvent(html.MessageEvent event) {
     printDebug("Service worker container message event: $event", tag);
     final map = Map<String, dynamic>.from(event.data);
-    final action = NotificationActionResult.fromJson(map);
+    final result = NotificationActionResult.fromJson(map);
     final type = map["type"];
     if(type == SWEvents.click) {
-      onNotificationAction?.call(action);
+      /// Custom notification event, not part of the standard Notification API.
+      /// Used to describe clicking on a notification.
+      /// This may be confused with an empty notification action event.
+      /// Sample:
+      /// ```js
+      /// notification.actions = [
+      ///    { action: "", title: "Open Window" },
+      ///    { action: "click", title: "Clicked me" },
+      /// ];
+      /// ```
+      ///
+      /// The above action with title "Open Window" will be considered a tap action as the service worker does not
+      /// distinguish between a normal notification click and a notification action with an empty action string
+      /// (see "Open Window" action above).
+      if(result.action == null || result.action!.isEmpty) {
+        onNotificationTap?.call(result);
+      } else {
+        onNotificationAction?.call(result);
+      }
     } else if (type == SWEvents.close) {
-      onNotificationDismiss?.call(action);
+      onNotificationDismiss?.call(result);
     } else {
       throw Exception("Unknown NotificationActionResult type $type");
     }

lib/method_channel/js_notifications_method_channel.dart

@@ -68,6 +68,9 @@ class MethodChannelJsNotifications extends JsNotificationsPlatform {
   @override
   Stream<NotificationActionResult> get dismissStream => throw UnimplementedError();
 
+  @override
+  Stream<NotificationActionResult> get tapStream => throw UnimplementedError();
+
   @override
   set scopeUrl(String value) {
     // TODO: implement scopeUrl

lib/platform_interface/js_notifications_platform_interface.dart

@@ -83,4 +83,7 @@ abstract class JsNotificationsPlatform extends PlatformInterface {
 
   /// Stream broadcasting notification close events with associated data
   Stream<NotificationActionResult> get dismissStream;
+
+  /// Stream broadcasting notification tap events with associated data
+  Stream<NotificationActionResult> get tapStream;
 }

test/js_notifications_test.dart

@@ -66,6 +66,10 @@ class MockJsNotificationsPlatform
   // TODO: implement notificationClose
   Stream<NotificationActionResult> get dismissStream => throw UnimplementedError();
 
+  @override
+  // TODO: implement notificationTap
+  Stream<NotificationActionResult> get tapStream => throw UnimplementedError();
+
   @override
   set scopeUrl(String value) {
     // TODO: implement scopeUrl