Feature/prd 504 Remove routing bridge between MapView and native SDK

CHANGELOG_UNRELEASED.md

@@ -8,4 +8,14 @@
 
 - `SitumProvider.apiKey` is now optional. If no credentials are available when the MapView loads, it waits until authentication is provided.
 - Updated the example application React Native from 0.79.1 to 0.83.10 to fix an issue that prevented the app from compiling on iOS.
-- Updated Android example application targetSdkVersion from 35 to 37.
+- Updated Android example application targetSdkVersion from 35 to 37.
+
+### Removed
+
+- Removed routing and navigation bridge between MapView and native SDK as the MapView now always uses its own routing and navigation library.
+
+### Fixed
+
+- AccessibilityMode documentation now mentions DirectionsOptions instead of DirectionsRequest.
+- Fixed removeNavigationUpdates never resolving when navigation was not running.
+- Fixed navigationRunning remaining active after reaching the destination.

plugin/src/sdk/index.ts

@@ -100,8 +100,8 @@ let exitGeofencesCallback = (_: any) => {};
 
 // Internal callbacks:
 // These callback functions will be added as listeners to SitumPluginEventEmitter as soon as possible and will be
-// listening events for all the plugin lifecycle. They will forward calls to both client callbacks and the MapView
-// internal callback.
+// listening events for all the plugin lifecycle. Location and geofence events will forward calls to both client
+// callbacks and the MapView internal callback. Navigation events are forwarded only to the client callbacks.
 
 const _internalLocationCallback = (loc: Location) => {
   DelegatedStateManager.getInstance().updateLocation(loc);
@@ -143,56 +143,6 @@ const _internalLocationErrorCallback = (error: Error) => {
   locationErrorCallback?.(adaptedError);
 };
 
-const _internalNavigationStartedCallback = (route: Route) => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_START, route),
-  );
-  navigationStartedCallback?.(route);
-};
-
-const _internalNavigationProgressCallback = (progress: NavigationProgress) => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_PROGRESS, progress),
-  );
-  navigationProgressCallback?.(progress);
-};
-
-const _internalNavigationDestinationReachedCallback = (route: Route) => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_DESTINATION_REACHED, route),
-  );
-  navigationDestinationReachedCallback?.(route);
-};
-
-const _internalNavigationOutOfRouteCallback = () => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_OUT_OF_ROUTE, undefined),
-  );
-  navigationOutOfRouteCallback?.();
-};
-
-const _internalNavigationFinishedCallback = () => {
-  // Deprecated!
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined),
-  );
-  navigationFinishedCallback?.();
-};
-
-const _internalNavigationCancellationCallback = () => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined),
-  );
-  navigationCancellationCallback?.();
-};
-
-const _internalNavigationErrorCallback = (error: any) => {
-  internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_ERROR, error),
-  );
-  navigationErrorCallback?.(error);
-};
-
 const _internalEnterGeofencesCallback = (data: any) => {
   internalMethodCallMapDelegate(
     new InternalCall(InternalCallType.GEOFENCES_ENTER, data),
@@ -213,16 +163,30 @@ const _registerCallbacks = () => {
     statusChanged: _internalLocationStatusCallback,
     locationStopped: _internalLocationStoppedCallback,
     locationError: _internalLocationErrorCallback,
-    [SdkNavigationUpdateType.START]: _internalNavigationStartedCallback,
-    [SdkNavigationUpdateType.PROGRESS]: _internalNavigationProgressCallback,
-    [SdkNavigationUpdateType.DESTINATION_REACHED]:
-      _internalNavigationDestinationReachedCallback,
-    [SdkNavigationUpdateType.OUTSIDE_ROUTE]:
-      _internalNavigationOutOfRouteCallback,
-    [SdkNavigationUpdateType.FINISHED]: _internalNavigationFinishedCallback,
-    [SdkNavigationUpdateType.CANCELLATION]:
-      _internalNavigationCancellationCallback,
-    [SdkNavigationUpdateType.ERROR]: _internalNavigationErrorCallback,
+    [SdkNavigationUpdateType.START]: (route: Route) => {
+      navigationStartedCallback(route);
+    },
+    [SdkNavigationUpdateType.PROGRESS]: (progress: NavigationProgress) => {
+      navigationProgressCallback(progress);
+    },
+    [SdkNavigationUpdateType.DESTINATION_REACHED]: (route: Route) => {
+      navigationDestinationReachedCallback(route);
+      navigationRunning = false;
+    },
+    [SdkNavigationUpdateType.OUTSIDE_ROUTE]: () => {
+      navigationOutOfRouteCallback();
+    },
+    [SdkNavigationUpdateType.FINISHED]: () => {
+      navigationFinishedCallback();
+      navigationRunning = false;
+    },
+    [SdkNavigationUpdateType.CANCELLATION]: () => {
+      navigationCancellationCallback();
+      navigationRunning = false;
+    },
+    [SdkNavigationUpdateType.ERROR]: (error: any) => {
+      navigationErrorCallback(error);
+    },
     onEnterGeofences: _internalEnterGeofencesCallback,
     onExitGeofences: _internalExitGeofencesCallback,
   };
@@ -685,8 +649,11 @@ export default class SitumPlugin {
    *
    */
   static removeNavigationUpdates = () => {
-    return promiseWrapper<void>(({ onCallback }) => {
-      if (!SitumPlugin.navigationIsRunning()) return;
+    return promiseWrapper<void>(({ resolve, onCallback }) => {
+      if (!SitumPlugin.navigationIsRunning()) {
+        resolve();
+        return;
+      }
 
       navigationRunning = false;
       RNCSitumPlugin.removeNavigationUpdates((response) => {

plugin/src/sdk/types/constants.ts

@@ -1,10 +1,20 @@
+/**
+ * @deprecated This enum was used by the legacy navigation bridge between the native SDK and the MapView.
+ * That bridge has been removed.
+ * It is kept for backward compatibility and is no longer used or emitted by the plugin.
+ */
 export enum NavigationStatus {
   START = "start",
   STOP = "stop",
   OUT_OF_ROUTE = "outOfRoute",
   UPDATE = "update",
 }
 
+/**
+ * @deprecated This enum was used by the legacy navigation bridge between the native SDK and the MapView.
+ * That bridge has been removed.
+ * It is kept for backward compatibility and is no longer used or emitted by the plugin.
+ */
 export enum NavigationUpdateType {
   PROGRESS = "PROGRESS",
   OUT_OF_ROUTE = "OUT_OF_ROUTE",
@@ -33,7 +43,7 @@ export enum LocationStatusName {
 }
 
 /**
- * Available accessibility modes used in the {@link DirectionsRequest}.
+ * Available accessibility modes used in the {@link DirectionsOptions}.
  *
  * @property CHOOSE_SHORTEST The route should choose the best route, without taking into account if it is accessible or not.
  * This option is the default so you don't have to do anything in order to use it
@@ -51,12 +61,6 @@ export enum InternalCallType {
   LOCATION_STATUS = "LOCATION_STATUS",
   LOCATION_ERROR = "LOCATION_ERROR",
   LOCATION_STOPPED = "LOCATION_STOPPED", // TODO: Exists only in RN, delete!
-  NAVIGATION_START = "NAVIGATION_START",
-  NAVIGATION_DESTINATION_REACHED = "NAVIGATION_DESTINATION_REACHED",
-  NAVIGATION_PROGRESS = "NAVIGATION_PROGRESS",
-  NAVIGATION_OUT_OF_ROUTE = "NAVIGATION_OUT_OF_ROUTE",
-  NAVIGATION_CANCELLATION = "NAVIGATION_CANCELLATION",
-  NAVIGATION_ERROR = "NAVIGATION_ERROR",
   GEOFENCES_ENTER = "GEOFENCES_ENTER",
   GEOFENCES_EXIT = "GEOFENCES_EXIT",
 }

plugin/src/wayfinding/components/MapView.tsx

@@ -26,7 +26,6 @@ import SitumPlugin from "../../sdk";
 import useSitum from "../hooks";
 import {
   selectApiDomain,
-  selectUser,
   setError,
   setLocationStatus,
 } from "../store";
@@ -40,7 +39,6 @@ import {
   type NavigateToCarPayload,
   type NavigateToPointPayload,
   type NavigateToPoiPayload,
-  type OnDirectionsRequestInterceptor,
   type OnExternalLinkClickedResult,
   type OnFavoritePoisUpdatedResult,
   type OnFloorChangedResult,
@@ -53,7 +51,7 @@ import {
 import { ErrorName } from "../types/constants";
 import { sendMessageToViewer } from "../utils";
 import ViewerMapper from "../utils/mapper";
-import { areSameAuth, authStore, SitumAuth } from "../../sdk/authStore";
+import { authStore, SitumAuth } from "../../sdk/authStore";
 const SITUM_BASE_DOMAIN = "https://maps.situm.com";
 
 const NETWORK_ERROR_CODE = {
@@ -183,8 +181,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
     ref,
   ) => {
     const webViewRef = useRef<WebView>(null);
-    const [_onDirectionsRequestInterceptor, setInterceptor] =
-      useState<OnDirectionsRequestInterceptor>();
     const internalMessageCallbackRef =
       useRef<OnInternalMapViewMessageCallback>();
 
@@ -203,11 +199,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       init,
       location,
       locationStatus,
-      directions,
-      navigation,
-      calculateRoute,
-      startNavigation,
-      stopNavigation,
       error,
     } = useSitum();
 
@@ -282,12 +273,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       if (!webViewRef.current) {
         return;
       }
-      if (SitumPlugin.navigationIsRunning()) {
-        console.error(
-          "Situm > hook > Navigation on course, poi category selection is unavailable",
-        );
-        return;
-      }
       sendMessageToViewer(
         webViewRef.current,
         ViewerMapper.selectPoiCategory(categoryId),
@@ -299,12 +284,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
         if (!webViewRef.current) {
           return;
         }
-        if (SitumPlugin.navigationIsRunning()) {
-          console.error(
-            "Situm > hook > Navigation on course, floor selection is unavailable",
-          );
-          return;
-        }
         sendMessageToViewer(
           webViewRef.current,
           ViewerMapper.selectFloor(floorId, options),
@@ -412,7 +391,7 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
           webViewRef.current &&
             sendMessageToViewer(
               webViewRef.current,
-              ViewerMapper.selectPoi(null),
+              ViewerMapper.deselectPoi(),
             );
         },
         navigateToPoi(payload): void {
@@ -424,12 +403,8 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
         navigateToPoint(payload: NavigateToPointPayload): void {
           _navigateToPoint(payload);
         },
-        setOnDirectionsRequestInterceptor(directionRequestInterceptor): void {
-          setInterceptor(() => directionRequestInterceptor);
-        },
         cancelNavigation(): void {
           if (!webViewRef.current) return;
-          stopNavigation();
           sendMessageToViewer(
             webViewRef.current,
             ViewerMapper.cancelNavigation(),
@@ -450,7 +425,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
         },
       };
     }, [
-      stopNavigation,
       _navigateToPoi,
       _followUser,
       _navigateToCar,
@@ -516,23 +490,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       setError(null);
     }, [error, mapLoaded]);
 
-    // Updated SDK navigation
-    useEffect(() => {
-      if (!webViewRef.current || !navigation || !mapLoaded) return;
-
-      sendMessageToViewer(
-        webViewRef.current,
-        ViewerMapper.navigation(navigation),
-      );
-    }, [navigation, mapLoaded]);
-
-    // Updated SDK route
-    useEffect(() => {
-      if (!webViewRef.current || !directions || !mapLoaded) return;
-
-      sendMessageToViewer(webViewRef.current, ViewerMapper.route(directions));
-    }, [directions, mapLoaded]);
-
     // Update language
     useEffect(() => {
       if (!webViewRef.current || !configuration.language || !mapLoaded) return;
@@ -580,15 +537,6 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
         case "app.ready_for_auth":
           sendEffectiveAuth();
           break;
-        case "directions.requested":
-          calculateRoute(payload, _onDirectionsRequestInterceptor);
-          break;
-        case "navigation.requested":
-          startNavigation(payload, _onDirectionsRequestInterceptor);
-          break;
-        case "navigation.stopped":
-          stopNavigation();
-          break;
         case "cartography.poi_selected":
           onPoiSelected(payload);
           break;
@@ -620,6 +568,10 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
         case "viewer.navigation.started":
         case "viewer.navigation.updated":
         case "viewer.navigation.stopped":
+          // Forward Viewer navigation events to the existing SDK callbacks.
+          // This avoids introducing a separate set of callbacks just for the Viewer.
+          // Warning: running SDK and MapView navigations at the same time may mix
+          // events because both navigations use the same public SDK callbacks.
           SitumPlugin.updateNavigationState(payload);
           break;
         case "share_location.uploading_locations_started":