Feature/sup 7038

UPGRADE.md

@@ -40,16 +40,15 @@ In this file we share a way to upgrade previous versions of react-native-situm-p
 ```js
 // your imports
 
-const SITUM_EMAIL = "YOUR_EMAIL_HERE";
 const SITUM_API_KEY = "YOUR_APIKEY_HERE";
-const SITUM_BUILDING_ID = "YOUR_BUILDING_ID_HERE";
+const BUILDING_IDENTIFIER = "YOUR_BUILDING_IDENTIFIER_HERE";
 
 const App: React.FC = () => {
     return (
         <View>
             <SitumProvider email={SITUM_EMAIL} apiKey={SITUM_API_KEY}>
                 <MapView
-                    buildingId={SITUM_BUILDING_ID}
+                    buildingId={BUILDING_IDENTIFIER}
                     // other props
                 />
             </SitumProvider>

example/README.md

@@ -62,16 +62,13 @@ pod install
 ### Step 2: Set your credentials <a name="config"/>
 
 For this step you must create a situm account, so [setup your account](../README.md#setup-your-account) before continuing.
-After creating your situm account, you can set your credentials on the properties of [`src/situm.tsx`](./src/situm.tsx), like so:
+After creating your situm account, you can set your [credentials](https://situm.com/docs/built-in-wayfinding-ui/#prepare-viewer) on the properties of [`src/situm.tsx`](./src/situm.tsx), like so:
 
 ```js
-export const SITUM_EMAIL = '';
 export const SITUM_API_KEY = '';
-export const SITUM_BUILDING_ID = ''; // Identifier of the building
-export const SITUM_DASHBOARD_URL = 'https://dashboard.situm.com';
+export const BUILDING_IDENTIFIER = '';
 ```
 
-**NOTE**: You should also fill the [SITUM_BUILDING_ID](https://situm.com/docs/sdk-cartography/#building-identifier) and [SITUM_FLOOR_ID](https://situm.com/docs/sdk-cartography/#floor-identifier) variables so all the examples are able to work as expected. In case you haven't created POIs or paths yet, learn [how to create these cartography elements](https://situm.com/docs/sdk-cartography/#sdk-a-basic-complete-cartography-example).
 
 ### Step 3: Run the app <a name="runapplication"></a>
 

example/azure-pipelines.yml

@@ -20,9 +20,6 @@ parameters:
   - name: BUILDINGID
     type: string
     default: "1"
-  - name: FLOORID
-    type: string
-    default: "1"
   - name: DASHBOARD_URL
     type: string
     default: "https://dashboard.situm.com"
@@ -53,7 +50,6 @@ jobs:
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo $(XAPIKEY_EXAMPLES))"
            echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo $(XAPIEMAIL_EXAMPLES))"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo $(BUILDING_ID_EXAMPLES))"
-           echo "##vso[task.setvariable variable=FLOORID]$(echo $(FLOOR_ID_EXAMPLES))"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo 'https://dashboard.situm.com')"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
 
@@ -65,7 +61,6 @@ jobs:
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo ${{parameters.XAPIKEY}})"
            echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo ${{ parameters.XAPIEMAIL}})"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo ${{ parameters.BUILDINGID}})"
-           echo "##vso[task.setvariable variable=FLOORID]$(echo ${{ parameters.FLOORID}})"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo ${{ parameters.DASHBOARD_URL }})"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
 
@@ -77,7 +72,6 @@ jobs:
         XAPIKEY: $(XAPIKEY)
         XAPIEMAIL: $(XAPIEMAIL)
         BUILDINGID: $(BUILDINGID)
-        FLOORID: $(FLOORID)
         DASHBOARD_URL: $(DASHBOARD_URL)
         system: $(ubuntuVersion)
 
@@ -110,7 +104,6 @@ jobs:
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo $(XAPIKEY_EXAMPLES))"
            echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo $(XAPIEMAIL_EXAMPLES))"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo $(BUILDING_ID_EXAMPLES))"
-           echo "##vso[task.setvariable variable=FLOORID]$(echo $(FLOOR_ID_EXAMPLES))"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo 'https://dashboard.situm.com')"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
 
@@ -122,7 +115,6 @@ jobs:
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo ${{parameters.XAPIKEY}})"
            echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo ${{ parameters.XAPIEMAIL}})"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo ${{ parameters.BUILDINGID}})"
-           echo "##vso[task.setvariable variable=FLOORID]$(echo ${{ parameters.FLOORID}})"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo ${{ parameters.DASHBOARD_URL }})"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
 
@@ -141,7 +133,6 @@ jobs:
         XAPIKEY: $(XAPIKEY)
         XAPIEMAIL: $(XAPIEMAIL)
         BUILDINGID: $(BUILDINGID)
-        FLOORID: $(FLOORID)
         DASHBOARD_URL: $(DASHBOARD_URL)
         system: $(macOSVersion)
         BUILDNUMBER: $(BUILDNUMBER)

example/azure/common-steps.yaml

@@ -7,8 +7,6 @@ parameters:
     type: string
   - name: BUILDINGID
     type: string
-  - name: FLOORID
-    type: string
   - name: DASHBOARD_URL
     type: string
   - name: BUILDNUMBER
@@ -50,15 +48,12 @@ steps:
       echo -e "\n[+] Variables to set:"
       echo -e "\t[+] X-API-EMAIL: ${{ parameters.XAPIEMAIL }}"
       echo -e "\t[+] BUILDINGID: ${{ parameters.BUILDINGID }}"
-      echo -e "\t[+] FLOORID: ${{ parameters.FLOORID }}"
       echo -e "\t[+] DASHBOARD_URL: ${{ parameters.DASHBOARD_URL }}"
       echo -e "\t[+] BUILDNUMBER: ${{ parameters.BUILDNUMBER }}"
       echo -e "\t[+] Plugin Version used: $pluginVersion"
 
-      echo "export const SITUM_EMAIL = '${{ parameters.XAPIEMAIL }}';" > example/src/situm.tsx
-      echo "export const SITUM_API_KEY = '${{ parameters.XAPIKEY }}';" >> example/src/situm.tsx
-      echo "export const SITUM_BUILDING_ID = '${{ parameters.BUILDINGID }}';" >> example/src/situm.tsx
-      echo "export const SITUM_FLOOR_ID = '${{ parameters.FLOORID }}';" >> example/src/situm.tsx
+      echo "export const SITUM_API_KEY = '${{ parameters.XAPIKEY }}';" > example/src/situm.tsx
+      echo "export const BUILDING_IDENTIFIER = '${{ parameters.BUILDINGID }}';" >> example/src/situm.tsx
       echo "export const SITUM_DASHBOARD_URL = '${{ parameters.DASHBOARD_URL }}';"  >> example/src/situm.tsx
 
     displayName: Configure credentials

example/src/examples/sdk/BuildingFullInfo.tsx

@@ -3,7 +3,7 @@ import {ScrollView} from 'react-native';
 import SitumPlugin from '@situm/react-native';
 import type {Building, Floor, Poi} from '@situm/react-native';
 
-import {SITUM_BUILDING_ID} from '../../situm';
+import {BUILDING_IDENTIFIER} from '../../situm';
 import styles from '../styles/styles';
 import {fetchBuilding} from '../Utils/CommonFetchs';
 import {Card, Text} from 'react-native-paper';
@@ -41,7 +41,7 @@ export const BuildingFullInfo = () => {
   };
 
   useEffect(() => {
-    fetchBuilding(SITUM_BUILDING_ID)
+    fetchBuilding(BUILDING_IDENTIFIER)
       .then(setBuilding)
       .catch(error => {
         console.error(`Situm > example > Failed to fetch building: ${error}`);
@@ -56,7 +56,7 @@ export const BuildingFullInfo = () => {
 
   return (
     <ScrollView style={{...styles.screenWrapper}}>
-      {!SITUM_BUILDING_ID && (
+      {!BUILDING_IDENTIFIER && (
         <Text>No building id provided, please edit your situm.tsx file</Text>
       )}
       <Card mode="contained" style={styles.margin}>

example/src/examples/sdk/InfoFromBuilding.tsx

@@ -2,7 +2,7 @@ import React, {useEffect, useState} from 'react';
 import {Text, ScrollView} from 'react-native';
 
 import SitumPlugin, {BuildingInfo} from '@situm/react-native';
-import {SITUM_BUILDING_ID} from '../../situm';
+import {BUILDING_IDENTIFIER} from '../../situm';
 import styles from '../styles/styles';
 import {fetchBuilding} from '../Utils/CommonFetchs';
 import {Card} from 'react-native-paper';
@@ -23,7 +23,7 @@ export const InfoFromBuilding = () => {
   };
 
   useEffect(() => {
-    fetchBuilding(SITUM_BUILDING_ID)
+    fetchBuilding(BUILDING_IDENTIFIER)
       .then(myBuilding => getInfoFromBuilding(myBuilding))
       .catch(e => {
         console.error(`Situm > example > Could not fetch building: ${e}`);

example/src/examples/sdk/RouteBetweenPOIs.tsx

@@ -2,7 +2,7 @@ import React, {useEffect, useState} from 'react';
 import {ScrollView, Text} from 'react-native';
 import SitumPlugin, {Building, Poi} from '@situm/react-native';
 
-import {SITUM_BUILDING_ID} from '../../situm';
+import {BUILDING_IDENTIFIER} from '../../situm';
 import styles from '../styles/styles';
 import {fetchBuilding} from '../Utils/CommonFetchs';
 import {Card} from 'react-native-paper';
@@ -51,7 +51,7 @@ export const RouteBetweenPOIs = () => {
 
   useEffect(() => {
     // first load the building
-    fetchBuilding(SITUM_BUILDING_ID)
+    fetchBuilding(BUILDING_IDENTIFIER)
       .then(setBuilding)
       .catch(e => {
         console.error(`Situm > example > Coult not fetch building ${e}`);

example/src/examples/wayfinding/NavigateToPoi.tsx

@@ -8,7 +8,12 @@ import SitumPlugin, {
   requestPermission,
 } from '@situm/react-native';
 import type {MapViewRef} from '@situm/react-native';
-import {SITUM_API_KEY, SITUM_BUILDING_ID} from '../../situm';
+import {
+  SITUM_API_KEY,
+  BUILDING_IDENTIFIER,
+  LANGUAGE,
+  REMOTE_IDENTIFIER,
+} from '../../situm';
 import {Button, TextInput} from 'react-native-paper';
 
 const styles = StyleSheet.create({
@@ -88,8 +93,10 @@ const Screen: React.FC = () => {
         <MapView
           ref={mapViewRef}
           configuration={{
-            buildingIdentifier: SITUM_BUILDING_ID,
+            buildingIdentifier: BUILDING_IDENTIFIER,
             situmApiKey: SITUM_API_KEY,
+            remoteIdentifier: REMOTE_IDENTIFIER,
+            language: LANGUAGE,
           }}
           onPoiSelected={evt => {
             setSelectedPoiIdentifier(evt?.identifier.toString());

example/src/examples/wayfinding/SelectPoi.tsx

@@ -8,7 +8,12 @@ import SitumPlugin, {
   requestPermission,
 } from '@situm/react-native';
 import type {MapViewRef} from '@situm/react-native';
-import {SITUM_API_KEY, SITUM_BUILDING_ID} from '../../situm';
+import {
+  SITUM_API_KEY,
+  BUILDING_IDENTIFIER,
+  LANGUAGE,
+  REMOTE_IDENTIFIER,
+} from '../../situm';
 import {Button, TextInput} from 'react-native-paper';
 
 const styles = StyleSheet.create({
@@ -88,8 +93,10 @@ const Screen: React.FC = () => {
         <MapView
           ref={mapViewRef}
           configuration={{
-            buildingIdentifier: SITUM_BUILDING_ID,
+            buildingIdentifier: BUILDING_IDENTIFIER,
             situmApiKey: SITUM_API_KEY,
+            remoteIdentifier: REMOTE_IDENTIFIER,
+            language: LANGUAGE,
           }}
         />
       </SafeAreaView>

example/src/examples/wayfinding/SelectPoiCategory.tsx

@@ -8,7 +8,12 @@ import SitumPlugin, {
   requestPermission,
 } from '@situm/react-native';
 import type {MapViewRef} from '@situm/react-native';
-import {SITUM_API_KEY, SITUM_BUILDING_ID} from '../../situm';
+import {
+  SITUM_API_KEY,
+  BUILDING_IDENTIFIER,
+  LANGUAGE,
+  REMOTE_IDENTIFIER,
+} from '../../situm';
 import {Button, TextInput} from 'react-native-paper';
 
 const styles = StyleSheet.create({
@@ -90,8 +95,10 @@ const Screen: React.FC = () => {
         <MapView
           ref={mapViewRef}
           configuration={{
-            buildingIdentifier: SITUM_BUILDING_ID,
+            buildingIdentifier: BUILDING_IDENTIFIER,
             situmApiKey: SITUM_API_KEY,
+            remoteIdentifier: REMOTE_IDENTIFIER,
+            language: LANGUAGE,
           }}
         />
       </SafeAreaView>

example/src/examples/wayfinding/SetFavoritePois.tsx

@@ -9,7 +9,12 @@ import SitumPlugin, {
 } from '@situm/react-native';
 import type {MapViewRef} from '@situm/react-native';
 import type {OnFavoritePoisUpdatedResult} from '@situm/react-native';
-import {SITUM_API_KEY, SITUM_BUILDING_ID} from '../../situm';
+import {
+  SITUM_API_KEY,
+  BUILDING_IDENTIFIER,
+  LANGUAGE,
+  REMOTE_IDENTIFIER,
+} from '../../situm';
 import {Button, TextInput} from 'react-native-paper';
 
 const styles = StyleSheet.create({
@@ -104,8 +109,10 @@ const Screen: React.FC = () => {
           ref={mapViewRef}
           onFavoritePoisUpdated={onFavoritePoisUpdated}
           configuration={{
-            buildingIdentifier: SITUM_BUILDING_ID,
+            buildingIdentifier: BUILDING_IDENTIFIER,
             situmApiKey: SITUM_API_KEY,
+            remoteIdentifier: REMOTE_IDENTIFIER,
+            language: LANGUAGE,
           }}
         />
       </SafeAreaView>

example/src/examples/wayfinding/Wayfinding.tsx

@@ -20,7 +20,12 @@ import type {
   OnExternalLinkClickedResult,
   MapViewRef,
 } from '@situm/react-native';
-import {SITUM_API_KEY, SITUM_BUILDING_ID} from '../../situm';
+import {
+  SITUM_API_KEY,
+  BUILDING_IDENTIFIER,
+  LANGUAGE,
+  REMOTE_IDENTIFIER,
+} from '../../situm';
 
 const styles = StyleSheet.create({
   container: {
@@ -137,8 +142,10 @@ const Screen: React.FC = () => {
     <MapView
       ref={mapViewRef}
       configuration={{
-        buildingIdentifier: SITUM_BUILDING_ID,
+        buildingIdentifier: BUILDING_IDENTIFIER,
         situmApiKey: SITUM_API_KEY,
+        remoteIdentifier: REMOTE_IDENTIFIER,
+        language: LANGUAGE,
       }}
       onLoad={onLoad}
       onPoiSelected={onPoiSelected}

example/src/situm.tsx

@@ -1,4 +1,22 @@
-export const SITUM_API_KEY = '';
-export const SITUM_BUILDING_ID = ''; // Identifier of the building
-export const SITUM_FLOOR_ID = ''; // Identifier of the floor
-export const SITUM_DASHBOARD_URL = 'https://dashboard.situm.com';
+// Your Situm API Key (positioning).
+export const SITUM_API_KEY = 'YOUR-SITUM-API-KEY';
+
+// Set here the building identifier you want on the map.
+export const BUILDING_IDENTIFIER = 'YOUR-BUILDING-IDENTIFIER';
+
+// Alternatively, you can set an identifier that allows you to remotely configure all map settings.
+//For now, you need to contact Situm to obtain yours.
+export const REMOTE_IDENTIFIER = '';
+
+// You can also specify the language in which you want the UX of the viewer to be displayed.
+export const LANGUAGE = '';
+
+// A String parameter that allows you to specify which domain will be displayed inside our webview.
+export const API_DOMAIN = 'https://dashboard.situm.com';
+
+// Supporting documentation
+`
+╔═══════════════════════════════════════════════════════════════════════════════════════════╗
+║ Visit https://situm.com/docs/built-in-wayfinding-ui/#prepare-viewer for more information. ║
+╚═══════════════════════════════════════════════════════════════════════════════════════════╝
+`;

src/wayfinding/components/MapView.tsx

@@ -270,7 +270,7 @@ const MapView = React.forwardRef<MapViewRef, MapViewProps>(
      * <MapView
      *    ref={(ref: MapViewRef) => ref.selectPoi(122)}
      *    configuration={{
-     *      buildingIdentifier: SITUM_BUILDING_ID,
+     *      buildingIdentifier: BUILDING_IDENTIFIER,
      *    }}
      *    onLoad={onLoad} />
      */

yarn.lock

@@ -9531,4 +9531,4 @@ [email protected]:
 yocto-queue@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b"
-  integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==
+  integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==