@situm/react-native 3.5.16 → 3.7.0

package/src/wayfinding/types/index.ts

@@ -10,6 +10,11 @@ export interface MapViewError {
 }
 
 export interface MapViewRef {
+  /**
+   * Sets the list of favoritePois that will appear in the mapView. This method removes any previous pois from the favorite list.
+   * @param poiIds Ids of the pois you want to set as favorites. 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).
+   */
+  setFavoritePois: (poiIds: number[]) => void;
   /**
    * Selects the given POI in the map.
    * @param poiId 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).
@@ -57,6 +62,13 @@ export interface MapViewRef {
   setOnDirectionsRequestInterceptor: (params: {
     onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor;
   }) => void;
+
+  /**
+   * Performs a search with the given SearchFilter.
+   *
+   * This action will have the same effect as the user searching in the searchbar.
+   */
+  search: (searchFilter: SearchFilter) => void;
 }
 
 export interface WayfindingResult {
@@ -106,6 +118,16 @@ export interface OnExternalLinkClickedResult {
   url: string;
 }
 
+/**
+ * Result that will be returned when the list of favoritePois is updated
+ */
+export interface OnFavoritePoisUpdatedResult {
+  /**
+   * Array containing the list of ids of all the pois that are currently stored as favorites.
+   */
+  currentPoisIdentifiers: number[];
+}
+
 export interface Destination {
   category: string;
   identifier?: string;
@@ -144,3 +166,18 @@ export type DirectionsMessage = {
   destinationCategory: string;
   identifier: string;
 };
+
+export interface SearchFilter {
+  /**
+   * Text used in the searchbar to filter and display the search results whose name or description matches the filter.
+   *
+   * An empty string will clear the current text filter (if any). A null value will apply no change.
+   */
+  text?: string | null;
+  /**
+   * A [PoiCategory](https://developers.situm.com/sdk_documentation/react-native/typedoc/types/poicategory) identifier used to filter and display the POIs that belong to the given category.
+   *
+   * An empty string will clear the current category filter (if any). A null value will apply no change.
+   */
+  poiCategoryIdentifier?: string | null;
+}

package/src/wayfinding/utils/mapper.ts

@@ -15,6 +15,7 @@ import type {
   NavigateToPoiPayload,
   Navigation,
   OnNavigationResult,
+  SearchFilter,
 } from "../types";
 
 export const createPoint = (payload: any): Point => {
@@ -86,6 +87,9 @@ const ViewerMapper = {
   setLanguage: (lang: string) => {
     return mapperWrapper("ui.set_language", lang);
   },
+  setFavoritePois: (poiIds: number[]) => {
+    return mapperWrapper("ui.set_favorite_pois", poiIds);
+  },
   initialConfiguration: (style: any) => {
     return mapperWrapper("ui.initial_configuration", {
       ...(style && {
@@ -103,10 +107,10 @@ const ViewerMapper = {
     });
   },
   setDirectionsOptions: (directionsOptions: MapViewDirectionsOptions) => {
-      return mapperWrapper(`directions.set_options`,  {
-        includedTags: directionsOptions.includedTags,
-        excludedTags: directionsOptions.excludedTags
-      })
+    return mapperWrapper(`directions.set_options`, {
+      includedTags: directionsOptions.includedTags,
+      excludedTags: directionsOptions.excludedTags,
+    });
   },
   // Location
   location: (location: Location) => {
@@ -182,6 +186,12 @@ const ViewerMapper = {
       },
     };
   },
+  search: (searchFilter: SearchFilter) => {
+    return mapperWrapper(`ui.set_search_filter`, {
+      text: searchFilter.text,
+      poiCategoryIdentifier: searchFilter.poiCategoryIdentifier,
+    });
+  },
 };
 
 export default ViewerMapper;