[google_maps_flutter_platform_interface] Add editable polyline and polygon API

packages/google_maps_flutter/google_maps_flutter/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.18.0
+
+* Adds support for editable polylines and polygons on web.
+
 ## 2.17.1
 
 * Updates README to link to implementation packages for platform-specific

packages/google_maps_flutter/google_maps_flutter/example/pubspec.yaml

@@ -32,3 +32,8 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}
+  google_maps_flutter_web: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_web}

packages/google_maps_flutter/google_maps_flutter/lib/src/controller.dart

@@ -91,11 +91,23 @@ class GoogleMapController {
           .onPolylineTap(mapId: mapId)
           .listen((PolylineTapEvent e) => _googleMapState.onPolylineTap(e.value)),
     );
+    _streamSubscriptions.add(
+      GoogleMapsFlutterPlatform.instance
+          .onPolylineEdited(mapId: mapId)
+          .listen((PolylineEditEvent e) => _googleMapState.onPolylineEdited(e.value, e.points)),
+    );
     _streamSubscriptions.add(
       GoogleMapsFlutterPlatform.instance
           .onPolygonTap(mapId: mapId)
           .listen((PolygonTapEvent e) => _googleMapState.onPolygonTap(e.value)),
     );
+    _streamSubscriptions.add(
+      GoogleMapsFlutterPlatform.instance
+          .onPolygonEdited(mapId: mapId)
+          .listen(
+            (PolygonEditEvent e) => _googleMapState.onPolygonEdited(e.value, e.points, e.holes),
+          ),
+    );
     _streamSubscriptions.add(
       GoogleMapsFlutterPlatform.instance
           .onCircleTap(mapId: mapId)

packages/google_maps_flutter/google_maps_flutter/lib/src/google_map.dart

@@ -641,6 +641,14 @@ class _GoogleMapState extends State<GoogleMap> {
     }
   }
 
+  void onPolygonEdited(PolygonId polygonId, List<LatLng> points, List<List<LatLng>> holes) {
+    final Polygon? polygon = _polygons[polygonId];
+    if (polygon == null) {
+      throw UnknownMapObjectIdError('polygon', polygonId, 'onEdited');
+    }
+    polygon.onEdited?.call(points, holes);
+  }
+
   void onPolylineTap(PolylineId polylineId) {
     final Polyline? polyline = _polylines[polylineId];
     if (polyline == null) {
@@ -652,6 +660,14 @@ class _GoogleMapState extends State<GoogleMap> {
     }
   }
 
+  void onPolylineEdited(PolylineId polylineId, List<LatLng> points) {
+    final Polyline? polyline = _polylines[polylineId];
+    if (polyline == null) {
+      throw UnknownMapObjectIdError('polyline', polylineId, 'onEdited');
+    }
+    polyline.onEdited?.call(points);
+  }
+
   void onCircleTap(CircleId circleId) {
     final Circle? circle = _circles[circleId];
     if (circle == null) {

packages/google_maps_flutter/google_maps_flutter/pubspec.yaml

@@ -2,7 +2,7 @@ name: google_maps_flutter
 description: A Flutter plugin for integrating Google Maps in iOS and Android applications.
 repository: https://github.com/flutter/packages/tree/main/packages/google_maps_flutter/google_maps_flutter
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+maps%22
-version: 2.17.1
+version: 2.18.0
 
 environment:
   sdk: ^3.10.0
@@ -23,8 +23,8 @@ dependencies:
     sdk: flutter
   google_maps_flutter_android: ^2.19.1
   google_maps_flutter_ios: ^2.18.0
-  google_maps_flutter_platform_interface: ^2.15.0
-  google_maps_flutter_web: ^0.6.2
+  google_maps_flutter_platform_interface: ^2.16.0
+  google_maps_flutter_web: ^0.7.0
 
 dev_dependencies:
   flutter_test:
@@ -41,3 +41,8 @@ topics:
 # The example deliberately includes limited-use secrets.
 false_secrets:
   - /example/web/index.html
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}
+  google_maps_flutter_web: {path: ../../../packages/google_maps_flutter/google_maps_flutter_web}

packages/google_maps_flutter/google_maps_flutter/test/fake_google_maps_flutter_platform.dart

@@ -217,11 +217,21 @@ class FakeGoogleMapsFlutterPlatform extends GoogleMapsFlutterPlatform {
     return mapEventStreamController.stream.whereType<PolylineTapEvent>();
   }
 
+  @override
+  Stream<PolylineEditEvent> onPolylineEdited({required int mapId}) {
+    return mapEventStreamController.stream.whereType<PolylineEditEvent>();
+  }
+
   @override
   Stream<PolygonTapEvent> onPolygonTap({required int mapId}) {
     return mapEventStreamController.stream.whereType<PolygonTapEvent>();
   }
 
+  @override
+  Stream<PolygonEditEvent> onPolygonEdited({required int mapId}) {
+    return mapEventStreamController.stream.whereType<PolygonEditEvent>();
+  }
+
   @override
   Stream<CircleTapEvent> onCircleTap({required int mapId}) {
     return mapEventStreamController.stream.whereType<CircleTapEvent>();

packages/google_maps_flutter/google_maps_flutter/test/polygon_updates_test.dart

@@ -364,6 +364,37 @@ void main() {
     expect(map.polygonUpdates.last.polygonsToAdd.isEmpty, true);
   });
 
+  testWidgets('Setting editable triggers change', (WidgetTester tester) async {
+    const p1 = Polygon(polygonId: PolygonId('polygon_1'));
+    const p1Editable = Polygon(polygonId: PolygonId('polygon_1'), editable: true);
+
+    await tester.pumpWidget(_mapWithPolygons(<Polygon>{p1}));
+    await tester.pumpWidget(_mapWithPolygons(<Polygon>{p1Editable}));
+
+    final PlatformMapStateRecorder map = platform.lastCreatedMap;
+    expect(map.polygonUpdates.last.polygonsToChange.length, 1);
+    expect(map.polygonUpdates.last.polygonsToChange.first.editable, equals(true));
+    expect(map.polygonUpdates.last.polygonIdsToRemove.isEmpty, true);
+    expect(map.polygonUpdates.last.polygonsToAdd.isEmpty, true);
+  });
+
+  testWidgets('Update onEdited does not trigger platform change', (WidgetTester tester) async {
+    var p1 = const Polygon(polygonId: PolygonId('polygon_1'), editable: true);
+    await tester.pumpWidget(_mapWithPolygons(<Polygon>{p1}));
+
+    p1 = Polygon(
+      polygonId: const PolygonId('polygon_1'),
+      editable: true,
+      onEdited: (List<LatLng> points, List<List<LatLng>> holes) {},
+    );
+    await tester.pumpWidget(_mapWithPolygons(<Polygon>{p1}));
+
+    final PlatformMapStateRecorder map = platform.lastCreatedMap;
+    expect(map.polygonUpdates.last.polygonsToChange.isEmpty, true);
+    expect(map.polygonUpdates.last.polygonIdsToRemove.isEmpty, true);
+    expect(map.polygonUpdates.last.polygonsToAdd.isEmpty, true);
+  });
+
   testWidgets('multi-update with delays', (WidgetTester tester) async {
     platform.simulatePlatformDelay = true;
 

packages/google_maps_flutter/google_maps_flutter/test/polyline_updates_test.dart

@@ -194,6 +194,37 @@ void main() {
     expect(map.polylineUpdates.last.polylinesToAdd.isEmpty, true);
   });
 
+  testWidgets('Setting editable triggers change', (WidgetTester tester) async {
+    const p1 = Polyline(polylineId: PolylineId('polyline_1'));
+    const p1Editable = Polyline(polylineId: PolylineId('polyline_1'), editable: true);
+
+    await tester.pumpWidget(_mapWithPolylines(<Polyline>{p1}));
+    await tester.pumpWidget(_mapWithPolylines(<Polyline>{p1Editable}));
+
+    final PlatformMapStateRecorder map = platform.lastCreatedMap;
+    expect(map.polylineUpdates.last.polylinesToChange.length, 1);
+    expect(map.polylineUpdates.last.polylinesToChange.first.editable, equals(true));
+    expect(map.polylineUpdates.last.polylineIdsToRemove.isEmpty, true);
+    expect(map.polylineUpdates.last.polylinesToAdd.isEmpty, true);
+  });
+
+  testWidgets('Update onEdited does not trigger platform change', (WidgetTester tester) async {
+    var p1 = const Polyline(polylineId: PolylineId('polyline_1'), editable: true);
+    await tester.pumpWidget(_mapWithPolylines(<Polyline>{p1}));
+
+    p1 = Polyline(
+      polylineId: const PolylineId('polyline_1'),
+      editable: true,
+      onEdited: (List<LatLng> points) {},
+    );
+    await tester.pumpWidget(_mapWithPolylines(<Polyline>{p1}));
+
+    final PlatformMapStateRecorder map = platform.lastCreatedMap;
+    expect(map.polylineUpdates.last.polylinesToChange.isEmpty, true);
+    expect(map.polylineUpdates.last.polylineIdsToRemove.isEmpty, true);
+    expect(map.polylineUpdates.last.polylinesToAdd.isEmpty, true);
+  });
+
   testWidgets('multi-update with delays', (WidgetTester tester) async {
     platform.simulatePlatformDelay = true;
 

packages/google_maps_flutter/google_maps_flutter_android/example/pubspec.yaml

@@ -33,3 +33,7 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_android/pubspec.yaml

@@ -38,3 +38,7 @@ topics:
   - google-maps
   - google-maps-flutter
   - map
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios/example/pubspec.yaml

@@ -31,3 +31,7 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios/pubspec.yaml

@@ -37,3 +37,7 @@ topics:
   - google-maps
   - google-maps-flutter
   - map
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios_sdk10/example/pubspec.yaml

@@ -31,3 +31,7 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios_sdk10/pubspec.yaml

@@ -37,3 +37,7 @@ topics:
   - google-maps
   - google-maps-flutter
   - map
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios_sdk9/example/pubspec.yaml

@@ -31,3 +31,7 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_ios_sdk9/pubspec.yaml

@@ -37,3 +37,7 @@ topics:
   - google-maps
   - google-maps-flutter
   - map
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  google_maps_flutter_platform_interface: {path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}

packages/google_maps_flutter/google_maps_flutter_platform_interface/CHANGELOG.md

@@ -1,5 +1,11 @@
-## NEXT
-
+## 2.16.0
+
+* Adds `editable` property and `onEdited` callback to `Polyline` and `Polygon`.
+* Adds `PolylineEditEvent` and `PolygonEditEvent` event types.
+* Adds `onPolylineEdited` and `onPolygonEdited` streams to platform interface.
+  These default to an empty stream rather than throwing, so the app-facing
+  package can subscribe on every platform without a per-platform implementation
+  (editing remains web-only).
 * Updates minimum supported SDK version to Flutter 3.38/Dart 3.10.
 
 ## 2.15.0

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/events/map_event.dart

@@ -136,6 +136,18 @@ class PolylineTapEvent extends MapEvent<PolylineId> {
   PolylineTapEvent(super.mapId, super.polylineId);
 }
 
+/// An event fired when a [Polyline] path is edited by the user.
+class PolylineEditEvent extends MapEvent<PolylineId> {
+  /// Build a PolylineEdit Event triggered from the map represented by `mapId`.
+  ///
+  /// The `value` of this event is a [PolylineId] object that represents the edited Polyline.
+  /// [points] contains the updated path after the edit.
+  PolylineEditEvent(super.mapId, super.polylineId, this.points);
+
+  /// The updated list of points after the edit.
+  final List<LatLng> points;
+}
+
 /// An event fired when a [Polygon] is tapped.
 class PolygonTapEvent extends MapEvent<PolygonId> {
   /// Build an PolygonTap Event triggered from the map represented by `mapId`.
@@ -144,6 +156,22 @@ class PolygonTapEvent extends MapEvent<PolygonId> {
   PolygonTapEvent(super.mapId, super.polygonId);
 }
 
+/// An event fired when a [Polygon] path is edited by the user.
+class PolygonEditEvent extends MapEvent<PolygonId> {
+  /// Build a PolygonEdit Event triggered from the map represented by `mapId`.
+  ///
+  /// The `value` of this event is a [PolygonId] object that represents the edited Polygon.
+  /// [points] contains the updated outer boundary after the edit.
+  /// [holes] contains the updated holes after the edit.
+  PolygonEditEvent(super.mapId, super.polygonId, this.points, this.holes);
+
+  /// The updated outer boundary points after the edit.
+  final List<LatLng> points;
+
+  /// The updated list of holes after the edit.
+  final List<List<LatLng>> holes;
+}
+
 /// An event fired when a [Circle] is tapped.
 class CircleTapEvent extends MapEvent<CircleId> {
   /// Build an CircleTap Event triggered from the map represented by `mapId`.

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/platform_interface/google_maps_flutter_platform.dart

@@ -327,11 +327,29 @@ abstract class GoogleMapsFlutterPlatform extends PlatformInterface {
     throw UnimplementedError('onPolylineTap() has not been implemented.');
   }
 
+  /// A [Polyline] path has been edited by the user.
+  ///
+  /// Polyline editing is currently only supported on web; platforms that do not
+  /// support it return an empty stream by default rather than throwing, so the
+  /// app-facing package can subscribe unconditionally on every platform.
+  Stream<PolylineEditEvent> onPolylineEdited({required int mapId}) {
+    return const Stream<PolylineEditEvent>.empty();
+  }
+
   /// A [Polygon] has been tapped.
   Stream<PolygonTapEvent> onPolygonTap({required int mapId}) {
     throw UnimplementedError('onPolygonTap() has not been implemented.');
   }
 
+  /// A [Polygon] path has been edited by the user.
+  ///
+  /// Polygon editing is currently only supported on web; platforms that do not
+  /// support it return an empty stream by default rather than throwing, so the
+  /// app-facing package can subscribe unconditionally on every platform.
+  Stream<PolygonEditEvent> onPolygonEdited({required int mapId}) {
+    return const Stream<PolygonEditEvent>.empty();
+  }
+
   /// A [Circle] has been tapped.
   Stream<CircleTapEvent> onCircleTap({required int mapId}) {
     throw UnimplementedError('onCircleTap() has not been implemented.');