@situm/react-native 3.9.2 → 3.10.0

package/src/sdk/nativeInterface.ts

@@ -94,6 +94,7 @@ interface NavigationAPI {
     onSuccess: (response: void) => void,
     onError: (error: Error) => void
   ) => void;
+  updateNavigationState: (externalNavigation: Map<string, any>) => void;
 }
 
 interface DirectionsAPI {

package/src/sdk/types/constants.ts

@@ -8,13 +8,18 @@ export enum NavigationStatus {
 export enum NavigationUpdateType {
   PROGRESS = "PROGRESS",
   OUT_OF_ROUTE = "OUT_OF_ROUTE",
-  FINISHED = "DESTINATION_REACHED",
+  DESTINATION_REACHED = "DESTINATION_REACHED",
+  CANCELLED = "CANCELLED",
 }
 
 export enum SdkNavigationUpdateType {
-  PROGRESS = "progress",
-  OUT_OF_ROUTE = "userOutsideRoute",
-  FINISHED = "destinationReached",
+  START = "onNavigationStart",
+  PROGRESS = "onNavigationProgress",
+  FINISHED = "onNavigationFinished",
+  DESTINATION_REACHED = "onNavigationDestinationReached",
+  OUTSIDE_ROUTE = "onUserOutsideRoute",
+  CANCELLATION = "onNavigationCancellation",
+  ERROR = "onNavigationError",
 }
 
 export enum LocationStatusName {

package/src/sdk/types/index.ts

@@ -236,6 +236,7 @@ export type Point = {
  * @name Route
  * @description Route between two points.
  *
+ * @property {Poi} poiTo - The destination Poi the user is currently navigating to.
  * @property {RouteStep[]} edges - Ordered list of steps to go to the goal point
  * @property {RouteStep} firstStep - First step
  * @property {Point} from - Point where the route starts.
@@ -248,6 +249,7 @@ export type Point = {
  * @property {RouteSegment[]} segments - List of segments formed by consecutive points and a floor identifier
  */
 export type Route = {
+  poiTo?: Poi;
   edges: RouteStep[];
   firstStep: RouteStep;
   from: Point;

package/src/wayfinding/components/MapView.tsx

@@ -30,6 +30,7 @@ import {
   type MapViewDirectionsOptions,
   type MapViewError,
   type MapViewRef,
+  type NavigateToCarPayload,
   type NavigateToPointPayload,
   type NavigateToPoiPayload,
   type OnDirectionsRequestInterceptor,
@@ -200,6 +201,15 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       );
     }, []);
 
+    const _navigateToCar = useCallback((payload?: NavigateToCarPayload) => {
+      if (!webViewRef.current) return;
+
+      sendMessageToViewer(
+        webViewRef.current,
+        ViewerMapper.navigateToCar(payload)
+      );
+    }, []);
+
     const _navigateToPoint = useCallback((payload: NavigateToPointPayload) => {
       if (
         !webViewRef.current ||
@@ -218,13 +228,16 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       if (!webViewRef.current) {
         return;
       }
-      if (SitumPlugin.navigationIsRunning()) {
-        console.error(
-          "Situm > hook > Navigation on course, poi selection is unavailable"
-        );
+
+      sendMessageToViewer(webViewRef.current, ViewerMapper.selectPoi(poiId));
+    }, []);
+
+    const _selectCar = useCallback(() => {
+      if (!webViewRef.current) {
         return;
       }
-      sendMessageToViewer(webViewRef.current, ViewerMapper.selectPoi(poiId));
+
+      sendMessageToViewer(webViewRef.current, ViewerMapper.selectCar());
     }, []);
 
     const _selectPoiCategory = useCallback((categoryId: number) => {
@@ -321,6 +334,9 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
           selectPoi(poiId: number) {
             _selectPoi(poiId);
           },
+          selectCar() {
+            _selectCar();
+          },
           selectPoiCategory(poiId: number) {
             _selectPoiCategory(poiId);
           },
@@ -340,6 +356,9 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
           navigateToPoi(payload): void {
             _navigateToPoi(payload);
           },
+          navigateToCar(payload): void {
+            _navigateToCar(payload);
+          },
           navigateToPoint(payload: NavigateToPointPayload): void {
             _navigateToPoint(payload);
           },
@@ -362,8 +381,10 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
       [
         stopNavigation,
         _navigateToPoi,
+        _navigateToCar,
         _navigateToPoint,
         _selectPoi,
+        _selectCar,
         _selectPoiCategory,
         _setDirectionsOptions,
         _setFavoritePois,
@@ -523,6 +544,11 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
             setBuildingIdentifier(eventParsed.payload.identifier.toString());
           }
           break;
+        case "viewer.navigation.started":
+        case "viewer.navigation.updated":
+        case "viewer.navigation.stopped":
+          SitumPlugin.updateNavigationState(eventParsed.payload);
+          break;
         default:
           break;
       }

package/src/wayfinding/hooks/index.ts

@@ -81,8 +81,25 @@ export const useSitumInternal = () => {
       dispatch(resetLocation());
     });
 
+    SitumPlugin.onNavigationStart((route) => {
+      console.debug(
+        `Situm > hook > navigation started to ${route.poiTo?.poiName}`
+      );
+
+      dispatch(
+        setNavigation({
+          type: NavigationUpdateType.PROGRESS,
+          status: NavigationStatus.START,
+        })
+      );
+    });
+
     SitumPlugin.onNavigationProgress((progress: NavigationProgress) => {
-      console.debug("Situm > hook > NavigationProgress");
+      console.debug(
+        `Situm > hook > navigation progress, remanining distance to goal ${progress.distanceToGoal.toFixed(
+          2
+        )} m.`
+      );
 
       dispatch(
         setNavigation({
@@ -98,28 +115,45 @@ export const useSitumInternal = () => {
     });
 
     SitumPlugin.onNavigationOutOfRoute(() => {
+      console.debug("Situm > hook > user went out of route, recalculating ...");
+
       dispatch(
         setNavigation({
           type: NavigationUpdateType.OUT_OF_ROUTE,
           status: NavigationStatus.UPDATE,
         })
       );
-
-      console.debug("Situm > hook > NavigationOutOfRoute");
     });
 
-    SitumPlugin.onNavigationFinished(() => {
+    SitumPlugin.onNavigationDestinationReached((route) => {
+      console.debug(
+        `Situm > hook > destination ${route.poiTo?.poiName} was reached.`
+      );
+
       dispatch(
         setNavigation({
-          type: NavigationUpdateType.FINISHED,
+          type: NavigationUpdateType.DESTINATION_REACHED,
           status: NavigationStatus.UPDATE,
         })
       );
-      console.debug("Situm > hook > NavigationFinished");
     });
 
-    SitumPlugin.onNavigationError((progress: NavigationProgress) => {
-      console.debug("Situm > hook > NavigationProgress: ", progress);
+    SitumPlugin.onNavigationCancellation(() => {
+      console.debug("Situm > hook > navigation was cancelled by the user.");
+
+      dispatch(
+        setNavigation({
+          type: NavigationUpdateType.CANCELLED,
+          status: NavigationStatus.STOP,
+        })
+      );
+    });
+
+    SitumPlugin.onNavigationError((navigationError: any) => {
+      console.error(
+        "Situm > hook > ERROR while navigating: ",
+        JSON.stringify(navigationError)
+      );
     });
   }
 
@@ -235,7 +269,9 @@ export const useSitumInternal = () => {
       })
       .catch((e) => {
         console.error(
-          `Situm > hook > Could not compute route for navigation ${e}`
+          `Situm > hook > Could not compute route for navigation ${JSON.stringify(
+            e
+          )}`
         );
       });
   };
@@ -253,7 +289,11 @@ export const useSitumInternal = () => {
         dispatch(setNavigation({ status: NavigationStatus.STOP }));
       })
       .catch((e) => {
-        console.warn(`Situm > hook > Could not remove navigation updates ${e}`);
+        console.warn(
+          `Situm > hook > Could not remove navigation updates ${JSON.stringify(
+            e
+          )}`
+        );
       });
   };
 

package/src/wayfinding/types/index.ts

@@ -34,7 +34,7 @@ export interface MapViewRef {
   /**
    * Starts navigating to the given POI.
    * @param params.identifier You can obtain the identifiers of your POIs by retrieving them with [SitumPlugin.fetchIndoorPOIsFromBuilding()](https://developers.situm.com/sdk_documentation/react-native/typedoc/classes/default.html#fetchIndoorPOIsFromBuilding).
-   * @param params.accessibilityMode You can optionally choose the desired [AccessibilityMode](https://developers.situm.com/sdk_documentation/react-native/typedoc/enums/accessibilitymode) used to calculate the route.
+   * @param params.accessibilityMode You can optionally choose the desired [AccessibilityMode](https://developers.situm.com/sdk_documentation/react-native/typedoc/enums/AccessibilityMode.html) used to calculate the route.
    */
   navigateToPoi: (params: {
     identifier: number;
@@ -46,7 +46,7 @@ export interface MapViewRef {
    * @param params.lng The longitude of the destination point.
    * @param params.floorIdentifier The floorIndetifier of the destination point.
    * @param params.navigationName You can optionally set the name of the destination to be displayed on the MapView.
-   * @param params.accessibilityMode You can optionally choose the desired [AccessibilityMode](https://developers.situm.com/sdk_documentation/react-native/typedoc/enums/accessibilitymode) used to calculate the route.
+   * @param params.accessibilityMode You can optionally choose the desired [AccessibilityMode](https://developers.situm.com/sdk_documentation/react-native/typedoc/enums/AccessibilityMode.html) used to calculate the route.
    */
   navigateToPoint: (params: {
     lat: number;
@@ -69,6 +69,21 @@ export interface MapViewRef {
    * This action will have the same effect as the user searching in the searchbar.
    */
   search: (searchFilter: SearchFilter) => void;
+
+  /**
+   * Selects a point saved as Find My Car on the map.
+   *
+   * To use it, the feature 'Find My Car' must be enabled.
+   */
+  selectCar: () => void;
+
+  /**
+   * Starts navigating to a point saved as find my car.
+   * @param params.accessibilityMode You can optionally choose the desired [AccessibilityMode](https://developers.situm.com/sdk_documentation/react-native/typedoc/enums/AccessibilityMode.html) used to calculate the route.
+   *
+   * To use it, the feature 'Find My Car' must be enabled.
+   */
+  navigateToCar: (params?: NavigateToCarPayload) => void;
 }
 
 export interface WayfindingResult {
@@ -150,6 +165,10 @@ export type NavigateToPoiPayload = {
   accessibilityMode?: AccessibilityMode;
 };
 
+export type NavigateToCarPayload = {
+  accessibilityMode?: AccessibilityMode;
+};
+
 export type NavigateToPointPayload = {
   lat: number;
   lng: number;

package/src/wayfinding/utils/mapper.ts

@@ -11,6 +11,7 @@ import type {
 import type {
   DirectionsMessage,
   MapViewDirectionsOptions,
+  NavigateToCarPayload,
   NavigateToPointPayload,
   NavigateToPoiPayload,
   Navigation,
@@ -75,8 +76,8 @@ export const createNavigationRequest = (payload: any): NavigationRequest => {
   );
 };
 
-const mapperWrapper = (type: string, payload: unknown) => {
-  return JSON.stringify({ type, payload });
+const mapperWrapper = (type: string, payload?: unknown) => {
+  return JSON.stringify({ type, payload: payload ?? {} });
 };
 
 const ViewerMapper = {
@@ -101,6 +102,9 @@ const ViewerMapper = {
   selectPoi: (poiId: number | null) => {
     return mapperWrapper(`cartography.select_poi`, { identifier: poiId });
   },
+  selectCar: () => {
+    return mapperWrapper(`cartography.select_car`);
+  },
   selectPoiCategory: (categoryId: number) => {
     return mapperWrapper(`cartography.select_poi_category`, {
       identifier: categoryId,
@@ -163,6 +167,11 @@ const ViewerMapper = {
       type: navigate.accessibilityMode,
     });
   },
+  navigateToCar: (params?: NavigateToCarPayload) => {
+    return mapperWrapper(`navigation.start.to_car`, {
+      type: params?.accessibilityMode,
+    });
+  },
   navigateToPoint: ({
     lat,
     lng,

package/android/src/main/java/com/situm/plugin/utils/ReactNativeJson.java

@@ -1,122 +0,0 @@
-package com.situm.plugin.utils;
-
-import com.facebook.react.bridge.ReadableArray;
-import com.facebook.react.bridge.ReadableMap;
-import com.facebook.react.bridge.ReadableMapKeySetIterator;
-import com.facebook.react.bridge.WritableArray;
-import com.facebook.react.bridge.WritableMap;
-import com.facebook.react.bridge.WritableNativeArray;
-import com.facebook.react.bridge.WritableNativeMap;
-
-import org.json.JSONArray;
-import org.json.JSONException;
-import org.json.JSONObject;
-
-import java.util.Iterator;
-
-public class ReactNativeJson {
-    public static WritableMap convertJsonToMap(JSONObject jsonObject) throws JSONException {
-        WritableMap map = new WritableNativeMap();
-
-        Iterator<String> iterator = jsonObject.keys();
-        while (iterator.hasNext()) {
-            String key = iterator.next();
-            Object value = jsonObject.get(key);
-            if (value instanceof JSONObject) {
-                map.putMap(key, convertJsonToMap((JSONObject) value));
-            } else if (value instanceof JSONArray) {
-                map.putArray(key, convertJsonToArray((JSONArray) value));
-            } else if (value instanceof Boolean) {
-                map.putBoolean(key, (Boolean) value);
-            } else if (value instanceof Integer) {
-                map.putInt(key, (Integer) value);
-            } else if (value instanceof Double) {
-                map.putDouble(key, (Double) value);
-            } else if (value instanceof String) {
-                map.putString(key, (String) value);
-            } else {
-                map.putString(key, value.toString());
-            }
-        }
-        return map;
-    }
-
-    public static WritableArray convertJsonToArray(JSONArray jsonArray) throws JSONException {
-        WritableArray array = new WritableNativeArray();
-
-        for (int i = 0; i < jsonArray.length(); i++) {
-            Object value = jsonArray.get(i);
-            if (value instanceof JSONObject) {
-                array.pushMap(convertJsonToMap((JSONObject) value));
-            } else if (value instanceof JSONArray) {
-                array.pushArray(convertJsonToArray((JSONArray) value));
-            } else if (value instanceof Boolean) {
-                array.pushBoolean((Boolean) value);
-            } else if (value instanceof Integer) {
-                array.pushInt((Integer) value);
-            } else if (value instanceof Double) {
-                array.pushDouble((Double) value);
-            } else if (value instanceof String) {
-                array.pushString((String) value);
-            } else {
-                array.pushString(value.toString());
-            }
-        }
-        return array;
-    }
-
-    public static JSONObject convertMapToJson(ReadableMap readableMap) throws JSONException {
-        JSONObject object = new JSONObject();
-        ReadableMapKeySetIterator iterator = readableMap.keySetIterator();
-        while (iterator.hasNextKey()) {
-            String key = iterator.nextKey();
-            switch (readableMap.getType(key)) {
-                case Null:
-                    object.put(key, JSONObject.NULL);
-                    break;
-                case Boolean:
-                    object.put(key, readableMap.getBoolean(key));
-                    break;
-                case Number:
-                    object.put(key, readableMap.getDouble(key));
-                    break;
-                case String:
-                    object.put(key, readableMap.getString(key));
-                    break;
-                case Map:
-                    object.put(key, convertMapToJson(readableMap.getMap(key)));
-                    break;
-                case Array:
-                    object.put(key, convertArrayToJson(readableMap.getArray(key)));
-                    break;
-            }
-        }
-        return object;
-    }
-
-    public static JSONArray convertArrayToJson(ReadableArray readableArray) throws JSONException {
-        JSONArray array = new JSONArray();
-        for (int i = 0; i < readableArray.size(); i++) {
-            switch (readableArray.getType(i)) {
-                case Null:
-                    break;
-                case Boolean:
-                    array.put(readableArray.getBoolean(i));
-                    break;
-                case Number:
-                    array.put(readableArray.getDouble(i));
-                    break;
-                case String:
-                    array.put(readableArray.getString(i));
-                    break;
-                case Map:
-                    array.put(convertMapToJson(readableArray.getMap(i)));
-                    break;
-                case Array:
-                    array.put(convertArrayToJson(readableArray.getArray(i)));
-                    break;
-            }
-        }
-        return array;
-    }
-}