breaking: DuitDataSource

.github/workflows/post-merge.yaml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        flutter-version: [ '3.22.3', '3.24.3', '3.27.3' ]
+        flutter-version: [ '3.24.3', '3.27.3' ]
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/pr.yaml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        flutter-version: [ '3.22.3', '3.24.3', '3.27.3' ]
+        flutter-version: [ '3.24.3', '3.27.3' ]
     steps:
       - uses: actions/checkout@v3
 

.gitignore

@@ -9,6 +9,7 @@
 .history
 .svn/
 migrate_working_dir/
+coverage/
 
 # IntelliJ related
 *.iml

lib/src/action_api/action.dart

@@ -103,12 +103,12 @@ final class TransportAction extends ServerAction implements DependentAction {
         );
 
   factory TransportAction.fromJson(Map<String, dynamic> json) {
-    final view = ServerActionJsonView(json);
+    final source = DuitDataSource(json);
 
     return TransportAction(
-      eventName: view.eventName,
-      dependsOn: view.dependsOn,
-      meta: view.meta,
+      eventName: source.getString(key: "event"),
+      dependsOn: source.getActionDependencies(),
+      meta: source.meta,
     );
   }
 }
@@ -131,11 +131,11 @@ final class ScriptAction extends ServerAction implements DependentAction {
         );
 
   factory ScriptAction.fromJson(Map<String, dynamic> json) {
-    final view = ServerActionJsonView(json);
+    final source = DuitDataSource(json);
 
     return ScriptAction(
-      script: view.script!,
-      dependsOn: view.dependsOn,
+      script: source.script,
+      dependsOn: source.getActionDependencies(),
     );
   }
 }

lib/src/action_api/action_parser.dart

@@ -9,12 +9,12 @@ final class DefaultActionParser implements Parser<ServerAction> {
 
   @override
   ServerAction parse(Map<String, dynamic> json) {
-    final view = ServerActionJsonView(json);
+    final source = DuitDataSource(json);
 
-    return switch (view.executionType) {
-      0 => TransportAction.fromJson(json),
-      1 => LocalAction.fromJson(json),
-      2 => ScriptAction.fromJson(json),
+    return switch (source.executionType) {
+      0 => TransportAction.fromJson(source),
+      1 => LocalAction.fromJson(source),
+      2 => ScriptAction.fromJson(source),
       _ => UnknownAction(),
     };
   }

lib/src/action_api/command.dart

@@ -0,0 +1,14 @@
+/// A command that is sent to control an action by interacting with an
+/// action controller identified by [controllerId]. The command specifies
+/// the [type] of action to be executed.
+base class RemoteCommand {
+  final String controllerId;
+  final String type;
+  final Map<String, dynamic> payload;
+
+  const RemoteCommand({
+    required this.controllerId,
+    required this.type,
+    required this.payload,
+  });
+}

lib/src/action_api/event.dart

@@ -1,4 +1,5 @@
 import 'package:duit_kernel/duit_kernel.dart';
+import 'package:duit_kernel/src/action_api/command.dart';
 
 /// The [ServerEvent] class represents an event that was sent by the server.
 ///
@@ -15,7 +16,7 @@ base class ServerEvent {
 
   final String type;
 
-  ServerEvent({
+  const ServerEvent({
     required this.type,
   });
 
@@ -45,13 +46,14 @@ final class UpdateEvent extends ServerEvent {
   /// The [json] parameter is a JSON object representing the update event.
   /// Returns an [UpdateEvent] object if the JSON object is valid, otherwise throws an exception.
   factory UpdateEvent.fromJson(Map<String, dynamic> json) {
-    return UpdateEvent(updates: json["updates"]);
+    return UpdateEvent(
+      updates: json["updates"] ?? const <String, dynamic>{},
+    );
   }
 }
 
 final class NavigationEvent extends ServerEvent {
   final String path;
-
   final Map<String, dynamic> extra;
 
   NavigationEvent({
@@ -60,9 +62,10 @@ final class NavigationEvent extends ServerEvent {
   }) : super(type: "navigation");
 
   factory NavigationEvent.fromJson(Map<String, dynamic> json) {
+    final source = DuitDataSource(json);
     return NavigationEvent(
-      path: json["path"] ?? "",
-      extra: json["extra"] ?? {},
+      path: source.getString(key: "path"),
+      extra: source["extra"] ?? const <String, dynamic>{},
     );
   }
 }
@@ -76,14 +79,13 @@ final class OpenUrlEvent extends ServerEvent {
 
   factory OpenUrlEvent.fromJson(Map<String, dynamic> json) {
     return OpenUrlEvent(
-      url: json["url"] ?? "",
+      url: DuitDataSource(json).getString(key: "url"),
     );
   }
 }
 
 final class CustomEvent extends ServerEvent {
   final String key;
-
   final Map<String, dynamic> extra;
 
   CustomEvent({
@@ -92,9 +94,10 @@ final class CustomEvent extends ServerEvent {
   }) : super(type: "custom");
 
   factory CustomEvent.fromJson(Map<String, dynamic> json) {
+    final source = DuitDataSource(json);
     return CustomEvent(
-      key: json["key"] ?? "",
-      extra: json["extra"] ?? {},
+      key: source.getString(key: "key"),
+      extra: source["extra"] ?? const <String, dynamic>{},
     );
   }
 }
@@ -124,10 +127,16 @@ final class CommonEventGroup extends ServerEvent {
   }) : super(type: "grouped");
 
   factory CommonEventGroup.fromJson(Map<String, dynamic> json) {
-    final list = List.from(json["events"] ?? []);
+    final list = List<Map<String, dynamic>>.from(json["events"] ?? []);
 
     final events = list.map(
-      (model) => GroupMember(event: ServerEvent.parseEvent(model)),
+      (model) {
+        return GroupMember(
+          event: ServerEvent.parseEvent(
+            model["event"],
+          ),
+        );
+      },
     );
     return CommonEventGroup(events: events.toList());
   }
@@ -141,41 +150,20 @@ final class SequencedEventGroup extends ServerEvent {
   }) : super(type: "sequenced");
 
   factory SequencedEventGroup.fromJson(Map<String, dynamic> json) {
-    final list = List.from(json["events"] ?? []);
-
-    final events = list.map((model) {
-      final delay = Duration(milliseconds: model["delay"] ?? 0);
-
-      return SequencedGroupMember(
-        event: ServerEvent.parseEvent(model["event"]),
-        delay: delay,
-      );
-    });
-    return SequencedEventGroup(events: events.toList());
-  }
-}
+    final list = List<Map<String, dynamic>>.from(json["events"] ?? []);
 
-final class AnimationTriggerEvent extends ServerEvent {
-  final AnimationCommand command;
-
-  AnimationTriggerEvent({
-    required this.command,
-  }) : super(type: "animationTrigger");
-
-  factory AnimationTriggerEvent.fromJson(Map<String, dynamic> json) {
-    return AnimationTriggerEvent(
-      command: AnimationCommand(
-        method: switch (json["method"]) {
-          0 => AnimationMethod.forward,
-          1 => AnimationMethod.repeat,
-          2 => AnimationMethod.reverse,
-          3 => AnimationMethod.toggle,
-          Object() || null => AnimationMethod.forward,
-        },
-        controllerId: json["controllerId"],
-        animatedPropKey: json["animatedPropKey"],
-      ),
+    final events = list.map(
+      (model) {
+        final source = DuitDataSource(model);
+        final delay = source.duration(key: "delay");
+
+        return SequencedGroupMember(
+          event: ServerEvent.parseEvent(source["event"]),
+          delay: delay,
+        );
+      },
     );
+    return SequencedEventGroup(events: events.toList());
   }
 }
 
@@ -189,9 +177,29 @@ final class TimerEvent extends ServerEvent {
   }) : super(type: "timer");
 
   factory TimerEvent.fromJson(Map<String, dynamic> json) {
+    final source = DuitDataSource(json);
     return TimerEvent(
-      timerDelay: Duration(milliseconds: json["timerDelay"] ?? 0),
-      payload: ServerEvent.parseEvent(json["event"]),
+      timerDelay: source.duration(key: "timerDelay"),
+      payload: ServerEvent.parseEvent(source["event"]),
+    );
+  }
+}
+
+final class CommandEvent extends ServerEvent {
+  final RemoteCommand command;
+
+  const CommandEvent({
+    required this.command,
+  }) : super(type: "command");
+
+  factory CommandEvent.fromJson(Map<String, dynamic> json) {
+    final source = DuitDataSource(json);
+    return CommandEvent(
+      command: RemoteCommand(
+        controllerId: source.getString(key: "controllerId"),
+        type: source.getString(key: "type"),
+        payload: source["payload"] ?? const <String, dynamic>{},
+      ),
     );
   }
 }

lib/src/action_api/event_parser.dart

@@ -21,8 +21,8 @@ final class DefaultEventParser implements Parser<ServerEvent> {
       "custom" => CustomEvent.fromJson(json),
       "sequenced" => SequencedEventGroup.fromJson(json),
       "grouped" => CommonEventGroup.fromJson(json),
-      "animationTrigger" => AnimationTriggerEvent.fromJson(json),
       "timer" => TimerEvent.fromJson(json),
+      "command" => CommandEvent.fromJson(json),
       String() || Object() || null => NullEvent(),
     };
   }

lib/src/action_api/event_resolver.dart

@@ -79,7 +79,7 @@ final class DefaultEventResolver extends EventResolver {
             await resolveEvent(context, entry.event);
           }
           break;
-        case AnimationTriggerEvent():
+        case CommandEvent():
           final c = driver.getController(event.command.controllerId);
           await c?.emitCommand(event.command);
           break;
@@ -92,6 +92,8 @@ final class DefaultEventResolver extends EventResolver {
             },
           );
           break;
+        default:
+          break;
       }
     } catch (e, s) {
       logger?.error(

lib/src/action_api/index.dart

@@ -3,6 +3,5 @@ export 'action_executor.dart';
 export 'event.dart';
 export 'event_resolver.dart';
 export 'external_event_handler.dart';
-export 'server_action_view.dart';
 export 'event_parser.dart';
 export 'action_parser.dart';

lib/src/animation_api/index.dart

@@ -3,3 +3,5 @@ export 'method.dart';
 export 'interval.dart';
 export 'trigger.dart';
 export 'command.dart';
+export 'tween_description.dart';
+export 'tween_type.dart';