feat: add new converters for BoxConstraints, Alignment, and Matrix4

Author: helightdev

docs/flutter/converters.md

@@ -2,4 +2,5 @@ The dogs package for Flutter provides a set of sdk specific converters for commo
 is a comprehensive list of all converters provided by the package:
 
 - `Color` as a hex string in the format `#RRGGBB` or `#AARRGGBB`
-- `Offset`, `Size`, `Rect`, `RRect`, `EdgeInsets`, `Radius`, `BorderRadius`
+- `Offset`, `Size`, `Rect`, `RRect`, `EdgeInsets`, `Radius`, `BorderRadius`
+- `LogicalKeyboardKey`, `SingleActivator`

docs/flutter/index.md

@@ -2,4 +2,9 @@
 icon: simple/flutter
 ---
 
-# Flutter
+# Flutter ![Static Badge](https://img.shields.io/badge/experimental-orange)
+
+This package provides Flutter specific functionality for the Dogs serialization library, including: 
+
+- [Databinding](binding) and Form Generation
+- [Converters](converters) for Flutter specific types

packages/dogs_flutter/lib/converters/geometric.dart

@@ -1,6 +1,7 @@
 import 'package:dogs_core/dogs_converter_utils.dart';
 import 'package:dogs_core/dogs_core.dart';
-import 'package:flutter/painting.dart';
+import 'package:dogs_core/dogs_schema.dart';
+import 'package:flutter/material.dart';
 
 List<double> _parseDoubleTuple4(dynamic value, DogEngine engine, DogConverter converter) {
   var list = converter.expects<List>(value, engine);
@@ -32,6 +33,10 @@ class FlutterOffsetConverter extends SimpleDogConverter<Offset> {
   serialize(Offset value, DogEngine engine) {
     return <String, dynamic>{"dx": value.dx, "dy": value.dy};
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) =>
+      object({"dx": number(), "dy": number()});
 }
 
 @linkSerializer
@@ -48,6 +53,10 @@ class FlutterSizeConverter extends SimpleDogConverter<Size> {
   serialize(Size value, DogEngine engine) {
     return <String, dynamic>{"width": value.width, "height": value.height};
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) =>
+      object({"width": number(), "height": number()});
 }
 
 @linkSerializer
@@ -64,6 +73,9 @@ class FlutterRectConverter extends SimpleDogConverter<Rect> {
   serialize(Rect value, DogEngine engine) {
     return [value.left, value.top, value.right, value.bottom];
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number().array().length(4);
 }
 
 @linkSerializer
@@ -80,6 +92,9 @@ class FlutterEdgeInsetsConverter extends SimpleDogConverter<EdgeInsets> {
   serialize(EdgeInsets value, DogEngine engine) {
     return [value.left, value.top, value.right, value.bottom];
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number().array().length(4);
 }
 
 @linkSerializer
@@ -105,6 +120,9 @@ class FlutterRadiusConverter extends SimpleDogConverter<Radius> {
     }
     throw DogSerializerException(message: "Invalid radius value");
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number();
 }
 
 @linkSerializer
@@ -126,6 +144,9 @@ class FlutterBorderRadiusConverter extends SimpleDogConverter<BorderRadius> {
   serialize(BorderRadius value, DogEngine engine) {
     return [value.topLeft.x, value.topRight.x, value.bottomLeft.x, value.bottomRight.x];
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number().array().length(4);
 }
 
 @linkSerializer
@@ -160,4 +181,74 @@ class FlutterRRectConverter extends SimpleDogConverter<RRect> {
       ),
     };
   }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) =>
+      object({"dimensions": engine.describe<Rect>(), "radii": engine.describe<BorderRadius>()});
+}
+
+@linkSerializer
+class FlutterBoxConstraintsConverter extends SimpleDogConverter<BoxConstraints> {
+  FlutterBoxConstraintsConverter() : super(serialName: "FLBoxConstraints");
+
+  @override
+  BoxConstraints deserialize(value, DogEngine engine) {
+    final [minWidth, maxWidth, minHeight, maxHeight] = _parseDoubleTuple4(value, engine, this);
+    return BoxConstraints(
+      minWidth: minWidth,
+      maxWidth: maxWidth,
+      minHeight: minHeight,
+      maxHeight: maxHeight,
+    );
+  }
+
+  @override
+  serialize(BoxConstraints value, DogEngine engine) {
+    return [value.minWidth, value.maxWidth, value.minHeight, value.maxHeight];
+  }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number().array().length(4);
+}
+
+@linkSerializer
+class FlutterAlignmentConverter extends SimpleDogConverter<Alignment> {
+  FlutterAlignmentConverter() : super(serialName: "FLAlignment");
+
+  @override
+  Alignment deserialize(value, DogEngine engine) {
+    var map = readAsMap(value, engine);
+    return Alignment(map.read<double>("x"), map.read<double>("y"));
+  }
+
+  @override
+  serialize(Alignment value, DogEngine engine) {
+    return <String, dynamic>{"x": value.x, "y": value.y};
+  }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) =>
+      object({"x": number(), "y": number()});
+}
+
+@linkSerializer
+class FlutterMatrix4Converter extends SimpleDogConverter<Matrix4> {
+  FlutterMatrix4Converter() : super(serialName: "FLMatrix4");
+
+  @override
+  Matrix4 deserialize(value, DogEngine engine) {
+    var list = expects<List>(value, engine);
+    if (list.length != 16) {
+      throw DogSerializerException(message: "Expected list of 16 numeric values", converter: this);
+    }
+    return Matrix4.fromList(list.map((e) => readAs<double>(e, engine)).toList());
+  }
+
+  @override
+  serialize(Matrix4 value, DogEngine engine) {
+    return value.storage;
+  }
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => number().array().length(16);
 }

packages/dogs_flutter/lib/converters/various.dart

@@ -1,5 +1,6 @@
 import 'package:dogs_core/dogs_converter_utils.dart';
 import 'package:dogs_core/dogs_core.dart';
+import 'package:dogs_core/dogs_schema.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 
@@ -66,9 +67,14 @@ class FlutterLogicalKeyConverter extends SimpleDogConverter<LogicalKeyboardKey>
   }
 
   @override
-  serialize(LogicalKeyboardKey value, DogEngine engine) {
-    return {"id": value.keyId, "label": value.keyLabel};
-  }
+  serialize(LogicalKeyboardKey value, DogEngine engine) => {
+    "id": value.keyId,
+    "label": value.keyLabel,
+  };
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) =>
+      object({"id": integer(), "label": string()});
 }
 
 @linkSerializer
@@ -90,15 +96,24 @@ class FlutterSingleActivatorConverter extends SimpleDogConverter<SingleActivator
   }
 
   @override
-  serialize(SingleActivator value, DogEngine engine) {
-    return {
-      "k": engine.toNative<LogicalKeyboardKey>(value.trigger),
-      "c": value.control,
-      "s": value.shift,
-      "a": value.alt,
-      "m": value.meta,
-      "r": value.includeRepeats,
-      "n": value.numLock.index,
-    };
-  }
+  serialize(SingleActivator value, DogEngine engine) => {
+    "k": engine.toNative<LogicalKeyboardKey>(value.trigger),
+    "c": value.control,
+    "s": value.shift,
+    "a": value.alt,
+    "m": value.meta,
+    "r": value.includeRepeats,
+    "n": value.numLock.index,
+  };
+
+  @override
+  SchemaType describeOutput(DogEngine engine, SchemaConfig config) => object({
+    "k": engine.describe<LogicalKeyboardKey>(),
+    "c": boolean(),
+    "s": boolean(),
+    "a": boolean(),
+    "m": boolean(),
+    "r": boolean(),
+    "n": integer(),
+  });
 }