Merge pull request #45 from emanuel-braz/develop

add onRouteNotRegistered callback

Author: emanuel-braz

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.12.0
+[2022-08-28]
+#### Added
+- Add OnRouteNotRegistered callback
+
 ## 0.11.0
 [2022-08-13]
 #### Added

README.md

@@ -21,9 +21,22 @@
       nativeNavigationLogEnabled: true,
       pathSeparator: MicroAppPathSeparator.slash // It joins the routes segments using slash "/" automatically
 
-      // the [MicroPageTransitionType.platform] is a dynamic transition type, 
+      // The [MicroPageTransitionType.platform] is a dynamic transition type, 
       // for iOS it will use Cupertino, and for others it will use Material.
-      pageTransitionType: MicroPageTransitionType.platform 
+      pageTransitionType: MicroPageTransitionType.platform,
+
+      // When pushing routes, if the route is not registered, this will be triggered,
+      // and it will abort the navigation
+      // 
+      // [onUnknownRoute] will not be dispatched, since the navigation was aborted.
+      //
+      // To makes this works, do:
+      // - Use root navigator(from MaterialApp) call NavigatorInstance.push...() without context
+      // - Use MicroAppNavigatorWidget as your nested navigators
+      // - Use RouterGenerator.onGenerateRoute mixin in your custom navigators
+      onRouteNotRegistered: (route, {arguments, type, context}) {
+        print('[OnRouteNotRegistered] Route not found: $route, $arguments, $type');
+      },
     )
   );
 ```

example/app2/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   dart_log:
     dependency: transitive
     description:
@@ -70,7 +70,7 @@ packages:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.0"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -89,7 +89,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.8.0"
+    version: "0.11.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -109,6 +109,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.12.11"
+  material_color_utilities:
+    dependency: transitive
+    description:
+      name: material_color_utilities
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.4"
   meta:
     dependency: transitive
     description:
@@ -122,7 +129,7 @@ packages:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -134,7 +141,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.1"
+    version: "1.8.2"
   stack_trace:
     dependency: transitive
     description:
@@ -169,21 +176,14 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.3"
-  typed_data:
-    dependency: transitive
-    description:
-      name: typed_data
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.3.0"
+    version: "0.4.9"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
 sdks:
-  dart: ">=2.15.1 <3.0.0"
+  dart: ">=2.17.0-0 <3.0.0"
   flutter: ">=1.17.0"

example/example_host/lib/main.dart

@@ -14,11 +14,19 @@ import 'example_micro_app.dart';
 void main() {
   // Define micro app configurations here
   final isAndroid = Platform.isAndroid;
-  MicroAppPreferences.update(MicroAppConfig(
+  MicroAppPreferences.update(
+    MicroAppConfig(
       nativeEventsEnabled: isAndroid,
       nativeNavigationCommandEnabled: isAndroid,
       nativeNavigationLogEnabled: isAndroid,
-      pageTransitionType: MicroPageTransitionType.platform));
+      pageTransitionType: MicroPageTransitionType.platform,
+      onRouteNotRegistered: (route, {arguments, type, context}) {
+        // ignore: avoid_print
+        print(
+            'CALLBACK:[OnRouteNotRegistered] Route not found: $route, $arguments, $type');
+      },
+    ),
+  );
 
   // Listen to navigation events
   final internalNavigationSubs =

example/example_host/lib/pages/material_app_page_initial.dart

@@ -142,19 +142,23 @@ class _MaterialAppPageInitialState extends State<MaterialAppPageInitial>
                 },
               ),
               ElevatedButton(
-                child: const Text('Try open a page that only exists in Native'),
+                child: const Text(
+                    'Try to open a page that is not registered, OnRouteNotRegistered will be called'),
                 onPressed: () {
-                  // If `onGenerateRoute.routeNativeOnError` is enabled, when there is no flutter page registered,
+                  // If this route is not registered, and OnRouteNotRegistered is not null, it will be called, and finish the execution here
+
+                  // If `onGenerateRoute.routeNativeOnError` is enabled, and the route is not registered,
                   // it will try to open the page in Native(Android/iOS) automatically
                   context.maNav.pushNamed('only_native_page',
                       arguments: 'some_arguments');
                 },
               ),
               ElevatedButton(
-                child: const Text('Try open Page - not exists'),
+                child: const Text(
+                    'There is no route on current Navigator, but there is a route on the root Navigator'),
                 onPressed: () {
                   context.maNav.pushNamed(Application1Routes()
-                      .pageExample); // There is no [pageExample] inside current MaterialApp
+                      .pageExample); // There is no [pageExample] inside current MaterialApp, but it exists in global MicroPage
                 },
               ),
               ElevatedButton(

example/example_host/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -84,7 +84,7 @@ packages:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.0"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -103,7 +103,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.8.0"
+    version: "0.11.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -123,6 +123,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.12.11"
+  material_color_utilities:
+    dependency: transitive
+    description:
+      name: material_color_utilities
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.4"
   meta:
     dependency: transitive
     description:
@@ -136,7 +143,7 @@ packages:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -148,7 +155,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.1"
+    version: "1.8.2"
   stack_trace:
     dependency: transitive
     description:
@@ -183,21 +190,14 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.3"
-  typed_data:
-    dependency: transitive
-    description:
-      name: typed_data
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.3.0"
+    version: "0.4.9"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
 sdks:
-  dart: ">=2.15.1 <3.0.0"
+  dart: ">=2.17.0-0 <3.0.0"
   flutter: ">=1.17.0"

example/example_routes/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   dart_log:
     dependency: transitive
     description:
@@ -63,7 +63,7 @@ packages:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.0"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -82,7 +82,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.8.0"
+    version: "0.11.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -102,6 +102,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.12.11"
+  material_color_utilities:
+    dependency: transitive
+    description:
+      name: material_color_utilities
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.4"
   meta:
     dependency: transitive
     description:
@@ -115,7 +122,7 @@ packages:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -127,7 +134,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.1"
+    version: "1.8.2"
   stack_trace:
     dependency: transitive
     description:
@@ -162,21 +169,14 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.3"
-  typed_data:
-    dependency: transitive
-    description:
-      name: typed_data
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.3.0"
+    version: "0.4.9"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
 sdks:
-  dart: ">=2.15.1 <3.0.0"
+  dart: ">=2.17.0-0 <3.0.0"
   flutter: ">=1.17.0"

lib/flutter_micro_app.dart

@@ -23,4 +23,5 @@ export 'src/utils/enums/micro_page_transition_type.dart';
 export 'src/utils/extensions/context_extension.dart';
 export 'src/utils/extensions/list_extension.dart';
 export 'src/utils/mixins/handler_register_mixin.dart';
+export 'src/utils/mixins/router_generator_mixin.dart';
 export 'src/utils/typedefs.dart';