Merge branch 'master' into prod

Author: cybex-dev

lib/interop/js_notification/js_notification.dart

@@ -10,7 +10,21 @@ class JSNotification implements Serializable {
   /// See: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#options
   final JSNotificationOptions? options;
 
-  JSNotification(this.title, [this.options]);
+  const JSNotification(this.title, [this.options]);
+
+  JSNotification copyWithSelf(JSNotification other) {
+    return JSNotification(
+      other.title,
+      other.options,
+    );
+  }
+
+  JSNotification copyWith({String? title, JSNotificationOptions? options}) {
+    return JSNotification(
+      title ?? this.title,
+      options ?? this.options,
+    );
+  }
 
   @override
   Map<String, dynamic> toMap() {

lib/interop/js_notification/js_notification_action.dart

@@ -14,19 +14,35 @@ class JSNotificationAction implements Serializable {
 
   const JSNotificationAction({required this.action, required this.title, this.icon});
 
-  factory JSNotificationAction.fromTitle(String title, {bool actionToLowerCase = true}) {
-    final action = actionToLowerCase ? title.toLowerCase() : title;
+  factory JSNotificationAction.fromTitle(String title, {bool transformToLowerCase = true}) {
+    final action = transformToLowerCase ? title.toLowerCase() : title;
     return JSNotificationAction(action: action, title: title);
   }
 
-  factory JSNotificationAction.fromAction(String action, {bool capatlizeTitle = true}) {
-    final title = capatlizeTitle ? action.capitalize() : action;
+  factory JSNotificationAction.fromAction(String action, {bool capitalize = true}) {
+    final title = capitalize ? action.capitalize() : action;
     return JSNotificationAction(action: action, title: title);
   }
 
   factory JSNotificationAction.simpleWithIcon(String title, String icon) =>
       JSNotificationAction(action: title, title: title, icon: icon);
 
+  JSNotificationAction copyWithSelf(JSNotificationAction other) {
+    return JSNotificationAction(
+      action: other.action,
+      title: other.title,
+      icon: other.icon,
+    );
+  }
+
+  JSNotificationAction copyWith({String? action, String? title, String? icon}) {
+    return JSNotificationAction(
+      action: action ?? this.action,
+      title: title ?? this.title,
+      icon: icon ?? this.icon,
+    );
+  }
+
   @override
   Map<String, dynamic> toMap() {
     final map = {

lib/interop/js_notification/js_notification_options.dart

@@ -68,6 +68,59 @@ class JSNotificationOptions implements Serializable {
     this.vibrate,
   });
 
+  JSNotificationOptions copyWithSelf({JSNotificationOptions? options}) {
+    return JSNotificationOptions(
+      actions: options?.actions ?? actions,
+      badge: options?.badge ?? badge,
+      body: options?.body ?? body,
+      data: options?.data ?? data,
+      dir: options?.dir ?? dir,
+      icon: options?.icon ?? icon,
+      image: options?.image ?? image,
+      lang: options?.lang ?? lang,
+      renotify: options?.renotify ?? renotify,
+      requireInteraction: options?.requireInteraction ?? requireInteraction,
+      silent: options?.silent ?? silent,
+      tag: options?.tag ?? tag,
+      timestamp: options?.timestamp ?? timestamp,
+      vibrate: options?.vibrate ?? vibrate,
+    );
+  }
+
+  JSNotificationOptions copyWith({
+    List<JSNotificationAction>? actions,
+    int? badge,
+    String? body,
+    Map<String, dynamic>? data,
+    JSNotificationDirection? dir,
+    String? icon,
+    String? image,
+    String? lang,
+    bool? renotify,
+    bool? requireInteraction,
+    bool? silent,
+    String? tag,
+    int? timestamp,
+    VibratePattern? vibrate,
+  }) {
+    return JSNotificationOptions(
+      actions: actions ?? this.actions,
+      badge: badge ?? this.badge,
+      body: body ?? this.body,
+      data: data ?? this.data,
+      dir: dir ?? this.dir,
+      icon: icon ?? this.icon,
+      image: image ?? this.image,
+      lang: lang ?? this.lang,
+      renotify: renotify ?? this.renotify,
+      requireInteraction: requireInteraction ?? this.requireInteraction,
+      silent: silent ?? this.silent,
+      tag: tag ?? this.tag,
+      timestamp: timestamp ?? this.timestamp,
+      vibrate: vibrate ?? this.vibrate,
+    );
+  }
+
   @override
   Map<String, dynamic> toMap() {
     final Map<String, dynamic> map = {};

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;
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: js_notifications
 description: "An extended NotificationsAPI for Dart Web notifications."
-version: 0.0.1
+version: 0.0.2
 homepage: https://github.com/cybex-dev/js_notifications
 
 environment:

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