[go_router_builder] Add support for relative routes

packages/go_router/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 16.0.1
+
+- Adds `TypedRelativeGoRoute`
+
 ## 16.0.0
 
 - **BREAKING CHANGE**

packages/go_router/lib/src/route_data.dart

@@ -133,30 +133,6 @@ abstract class GoRouteData extends RouteData {
   static final Expando<GoRouteData> _stateObjectExpando = Expando<GoRouteData>(
     'GoRouteState to GoRouteData expando',
   );
-
-  /// The location of this route.
-  String get location => throw _shouldBeGeneratedError;
-
-  /// Navigate to the route.
-  void go(BuildContext context) => throw _shouldBeGeneratedError;
-
-  /// Push the route onto the page stack.
-  Future<T?> push<T>(BuildContext context) => throw _shouldBeGeneratedError;
-
-  /// Replaces the top-most page of the page stack with the route.
-  void pushReplacement(BuildContext context) => throw _shouldBeGeneratedError;
-
-  /// Replaces the top-most page of the page stack with the route but treats
-  /// it as the same page.
-  ///
-  /// The page key will be reused. This will preserve the state and not run any
-  /// page animation.
-  ///
-  void replace(BuildContext context) => throw _shouldBeGeneratedError;
-
-  static UnimplementedError get _shouldBeGeneratedError => UnimplementedError(
-        'Should be generated using [Type-safe routing](https://pub.dev/documentation/go_router/latest/topics/Type-safe%20routes-topic.html).',
-      );
 }
 
 /// A class to represent a [ShellRoute] in
@@ -430,6 +406,40 @@ class TypedGoRoute<T extends GoRouteData> extends TypedRoute<T> {
   final bool caseSensitive;
 }
 
+/// A superclass for each typed go route descendant
+@Target(<TargetKind>{TargetKind.library, TargetKind.classType})
+class TypedRelativeGoRoute<T extends GoRouteData> extends TypedRoute<T> {
+  /// Default const constructor
+  const TypedRelativeGoRoute({
+    required this.path,
+    this.routes = const <TypedRoute<RouteData>>[],
+    this.caseSensitive = true,
+  });
+
+  /// The relative path that corresponds to this route.
+  ///
+  /// See [GoRoute.path].
+  ///
+  ///
+  final String path;
+
+  /// Child route definitions.
+  ///
+  /// See [RouteBase.routes].
+  final List<TypedRoute<RouteData>> routes;
+
+  /// Determines whether the route matching is case sensitive.
+  ///
+  /// When `true`, the path must match the specified case. For example,
+  /// a route with `path: '/family/:fid'` will not match `/FaMiLy/f2`.
+  ///
+  /// When `false`, the path matching is case insensitive.  The route
+  /// with `path: '/family/:fid'` will match `/FaMiLy/f2`.
+  ///
+  /// Defaults to `true`.
+  final bool caseSensitive;
+}
+
 /// A superclass for each typed shell route descendant
 @Target(<TargetKind>{TargetKind.library, TargetKind.classType})
 class TypedShellRoute<T extends ShellRouteData> extends TypedRoute<T> {

packages/go_router/test/route_data_test.dart

@@ -280,76 +280,6 @@ void main() {
         expect(routeWithDefaultCaseSensitivity.caseSensitive, false);
       },
     );
-
-    testWidgets(
-      'It should throw beacuase there is no code generated',
-      (WidgetTester tester) async {
-        final List<FlutterErrorDetails> errors = <FlutterErrorDetails>[];
-
-        FlutterError.onError =
-            (FlutterErrorDetails details) => errors.add(details);
-
-        const String errorText = 'Should be generated';
-
-        Widget buildWidget(void Function(BuildContext) onTap) {
-          return MaterialApp(
-            home: Builder(
-              builder: (BuildContext context) => GestureDetector(
-                child: const Text('Tap'),
-                onTap: () => onTap(context),
-              ),
-            ),
-          );
-        }
-
-        final Widget pushThrower = buildWidget((BuildContext context) {
-          const _GoRouteDataBuild().push<void>(context);
-        });
-        await tester.pumpWidget(pushThrower);
-        await tester.tap(find.text('Tap'));
-
-        expect(errors.first.exception, isA<UnimplementedError>());
-        expect(errors.first.exception.toString(), contains(errorText));
-
-        errors.clear();
-
-        final Widget goThrower = buildWidget((BuildContext context) {
-          const _GoRouteDataBuild().go(context);
-        });
-        await tester.pumpWidget(goThrower);
-        await tester.tap(find.text('Tap'));
-
-        expect(errors.first.exception, isA<UnimplementedError>());
-        expect(errors.first.exception.toString(), contains(errorText));
-
-        errors.clear();
-
-        final Widget pushReplacementThrower =
-            buildWidget((BuildContext context) {
-          const _GoRouteDataBuild().pushReplacement(context);
-        });
-        await tester.pumpWidget(pushReplacementThrower);
-        await tester.tap(find.text('Tap'));
-
-        expect(errors.first.exception, isA<UnimplementedError>());
-        expect(errors.first.exception.toString(), contains(errorText));
-
-        errors.clear();
-
-        final Widget replaceThrower = buildWidget((BuildContext context) {
-          const _GoRouteDataBuild().pushReplacement(context);
-        });
-        await tester.pumpWidget(replaceThrower);
-        await tester.tap(find.text('Tap'));
-
-        expect(errors.first.exception, isA<UnimplementedError>());
-        expect(errors.first.exception.toString(), contains(errorText));
-
-        errors.clear();
-
-        FlutterError.onError = FlutterError.dumpErrorToConsole;
-      },
-    );
   });
 
   group('ShellRouteData', () {

packages/go_router_builder/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 - Restricts `build` to versions less than 2.5.0.
 
+## 3.0.2
+
+- Adds `TypedRelativeGoRoute` annotation which supports relative routes.
+
 ## 3.0.1
 
 - Updates README.md to use the mixin `with _$RouteName`.