From d7d7556502a6b63f67c1d400c5050dfd422a1f43 Mon Sep 17 00:00:00 2001
From: "dmitrii.samarian" <dmitrii.samarian@mapbox.com>
Date: Thu, 21 Mar 2024 11:00:07 +0300
Subject: [PATCH] deprecate MapboxModuleType.NavigationRouter

---
 .../annotation/module/MapboxModuleType.kt     |  1 +
 .../com/mapbox/common/examples/MyRouter.kt    | 28 -------------------
 .../common/examples/ModuleProviderTest.kt     |  7 -----
 3 files changed, 1 insertion(+), 35 deletions(-)
 delete mode 100644 examples/src/main/java/com/mapbox/common/examples/MyRouter.kt

diff --git a/annotations/src/main/java/com/mapbox/annotation/module/MapboxModuleType.kt b/annotations/src/main/java/com/mapbox/annotation/module/MapboxModuleType.kt
index 8146dd8..7f8a526 100644
--- a/annotations/src/main/java/com/mapbox/annotation/module/MapboxModuleType.kt
+++ b/annotations/src/main/java/com/mapbox/annotation/module/MapboxModuleType.kt
@@ -52,6 +52,7 @@ enum class MapboxModuleType(
   /**
    * Main router used by the Navigation SDK.
    */
+  @Deprecated("Core Navigation Framework doesn't use a custom router implementation so it will not overwrite the built-in router in Core Navigation Framework anymore")
   NavigationRouter("Router", "com.mapbox.navigation.base.route", "Router"),
 
   /**
diff --git a/examples/src/main/java/com/mapbox/common/examples/MyRouter.kt b/examples/src/main/java/com/mapbox/common/examples/MyRouter.kt
deleted file mode 100644
index 29b5a0c..0000000
--- a/examples/src/main/java/com/mapbox/common/examples/MyRouter.kt
+++ /dev/null
@@ -1,28 +0,0 @@
-package com.mapbox.common.examples
-
-import com.mapbox.annotation.module.MapboxModule
-import com.mapbox.annotation.module.MapboxModuleType
-import com.mapbox.api.directions.v5.models.DirectionsRoute
-import com.mapbox.api.directions.v5.models.RouteOptions
-import com.mapbox.common.module.LibraryLoader
-import com.mapbox.navigation.base.route.RouteRefreshCallback
-import com.mapbox.navigation.base.route.Router
-
-@MapboxModule(MapboxModuleType.NavigationRouter)
-class MyRouter(libraryLoader: LibraryLoader) : Router {
-  override fun cancel() {
-    // not implemented
-  }
-
-  override fun getRoute(routeOptions: RouteOptions, callback: Router.Callback) {
-    // not implemented
-  }
-
-  override fun getRouteRefresh(route: DirectionsRoute, legIndex: Int, callback: RouteRefreshCallback) {
-    // not implemented
-  }
-
-  override fun shutdown() {
-    // not implemented
-  }
-}
\ No newline at end of file
diff --git a/examples/src/test/java/com/mapbox/common/examples/ModuleProviderTest.kt b/examples/src/test/java/com/mapbox/common/examples/ModuleProviderTest.kt
index 3fc37ad..14e9295 100644
--- a/examples/src/test/java/com/mapbox/common/examples/ModuleProviderTest.kt
+++ b/examples/src/test/java/com/mapbox/common/examples/ModuleProviderTest.kt
@@ -8,7 +8,6 @@ import com.mapbox.common.module.provider.MapboxModuleProvider
 import com.mapbox.common.module.provider.ModuleProviderArgument
 import com.mapbox.maps.module.MapTelemetry
 import com.mapbox.module.Mapbox_MapTelemetryModuleConfiguration
-import com.mapbox.navigation.base.route.Router
 import com.mapbox.navigation.base.trip.notification.TripNotification
 import io.mockk.mockk
 import org.hamcrest.core.IsEqual
@@ -34,12 +33,6 @@ class ModuleProviderTest {
     assertNotNull(logger)
   }
 
-  @Test
-  fun nested_module_dependencies() {
-    val router: Router = MapboxModuleProvider.createModule(MapboxModuleType.NavigationRouter, ::paramsProvider)
-    assertNotNull(router)
-  }
-
   @Test
   fun generate_configuration() {
     Mapbox_MapTelemetryModuleConfiguration.moduleProvider = object : Mapbox_MapTelemetryModuleConfiguration.ModuleProvider {