[go_router_builder] Fixed the return value of the generated push method (#3650)

Starting from version 6.5.0 [[reference](https://github.com/flutter/packages/blob/main/packages/go_router/CHANGELOG.md#650)] of the **go_router** package, the method **push** is able to return a Future value.
The generator was not updated to take that into account.

This PR fixes that.

The PR resolves the reported issue: flutter/flutter#124487

Author: vlazdra

packages/go_router_builder/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.2
+
+* Supports returning value in generated `push` method. [go_router CHANGELOG](https://github.com/flutter/packages/blob/main/packages/go_router/CHANGELOG.md#650)
+
 ## 1.2.1
 
 * Supports opt-in required extra parameters. [#117261](https://github.com/flutter/flutter/issues/117261)

packages/go_router_builder/README.md

@@ -165,6 +165,17 @@ void _tap() => PersonRoute(pid: 'p1').go(context);
 
 This is the point of typed routing: the error is found statically.
 
+## Return value
+
+Starting from `go_router` 6.5.0, pushing a route and subsequently popping it, can produce
+a return value. The generated routes also follow this functionality.
+
+```dart
+void _tap() async {
+  final result = await PersonRoute(pid: 'p1').go(context);
+}
+```
+
 ## Query parameters
 
 Optional parameters (named or positional) indicate query parameters:

packages/go_router_builder/example/lib/all_types.g.dart

@@ -76,7 +76,8 @@ class App extends StatelessWidget {
           ],
         ),
       ],
-    )
+    ),
+    TypedGoRoute<FamilyCountRoute>(path: 'family-count/:count'),
   ],
 )
 class HomeRoute extends GoRouteData {
@@ -149,6 +150,17 @@ class PersonDetailsRoute extends GoRouteData {
   }
 }
 
+class FamilyCountRoute extends GoRouteData {
+  const FamilyCountRoute(this.count);
+
+  final int count;
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) => FamilyCountScreen(
+        count: count,
+      );
+}
+
 class HomeScreen extends StatelessWidget {
   const HomeScreen({super.key});
 
@@ -161,14 +173,38 @@ class HomeScreen extends StatelessWidget {
         title: const Text(App.title),
         centerTitle: true,
         actions: <Widget>[
-          ElevatedButton(
-            onPressed: () => const PersonRoute('f1', 1).push(context),
-            child: const Text('Push a route'),
-          ),
-          IconButton(
-            onPressed: info.logout,
-            tooltip: 'Logout: ${info.userName}',
-            icon: const Icon(Icons.logout),
+          PopupMenuButton<String>(
+            itemBuilder: (BuildContext context) {
+              return <PopupMenuItem<String>>[
+                PopupMenuItem<String>(
+                  value: '1',
+                  child: const Text('Push w/o return value'),
+                  onTap: () => const PersonRoute('f1', 1).push(context),
+                ),
+                PopupMenuItem<String>(
+                  value: '2',
+                  child: const Text('Push w/ return value'),
+                  onTap: () async {
+                    FamilyCountRoute(familyData.length)
+                        .push<int>(context)
+                        .then((int? value) {
+                      if (value != null) {
+                        ScaffoldMessenger.of(context).showSnackBar(
+                          SnackBar(
+                            content: Text('Age was: $value'),
+                          ),
+                        );
+                      }
+                    });
+                  },
+                ),
+                PopupMenuItem<String>(
+                  value: '3',
+                  child: Text('Logout: ${info.userName}'),
+                  onTap: () => info.logout(),
+                ),
+              ];
+            },
           ),
         ],
       ),
@@ -277,6 +313,35 @@ class PersonDetailsPage extends StatelessWidget {
       );
 }
 
+class FamilyCountScreen extends StatelessWidget {
+  const FamilyCountScreen({super.key, required this.count});
+
+  final int count;
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+        appBar: AppBar(title: const Text('Family Count')),
+        body: Padding(
+          padding: const EdgeInsets.all(16.0),
+          child: Column(
+            crossAxisAlignment: CrossAxisAlignment.stretch,
+            children: <Widget>[
+              Center(
+                child: Text(
+                  'There are $count families',
+                  style: Theme.of(context).textTheme.headlineSmall,
+                ),
+              ),
+              ElevatedButton(
+                onPressed: () => context.pop(count),
+                child: Text('Pop with return value $count'),
+              ),
+            ],
+          ),
+        ),
+      );
+}
+
 class LoginScreen extends StatelessWidget {
   const LoginScreen({this.from, super.key});
   final String? from;