@situm/cordova 3.4.0 → 3.4.2

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "always"
+}

package/README.md

@@ -77,7 +77,7 @@ Situm Cordova Plugin is licensed under [MIT License](https://opensource.org/lice
 Log in into your Situm Account. This key is generated in Situm Dashboard. Return true if apiKey was set successfully, otherwise false
 
 ```js
-cordova.plugins.Situm.setApiKey("SITUM_EMAIL", "SITUM_API_KEY");
+cordova.plugins.Situm.setApiKey('SITUM_EMAIL', 'SITUM_API_KEY');
 ```
 
 #### - setUserPass
@@ -85,7 +85,7 @@ cordova.plugins.Situm.setApiKey("SITUM_EMAIL", "SITUM_API_KEY");
 Provides user's email and password. Return true if apiKey was set successfully, otherwise false
 
 ```js
-cordova.plugins.Situm.setUserPass("SITUM_EMAIL", "SITUM_USER_PASS");
+cordova.plugins.Situm.setUserPass('SITUM_EMAIL', 'SITUM_USER_PASS');
 ```
 
 #### - setRemoteConfig
@@ -106,10 +106,13 @@ cordova.plugins.Situm.setCacheMaxAge(1 * 60 * 60); // 1 hour
 
 #### - startPositioning
 
+> [!WARNING]
+> This method is deprecated, instead use [requestLocationUpdates](#--requestLocationUpdates).
+
 Starts the positioning system. In the success callback it can return:
 
-- [Location](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Location)
-- [LocationStatus](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationStatus)
+- [Location](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Location).
+- [LocationStatus](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationStatus).
 
 ```js
   locationOptions = {
@@ -128,8 +131,72 @@ cordova.plugins.Situm.startPositioning(locationOptions, (res: any) => {
     });
 ```
 
+#### - requestLocationUpdates
+
+Starts the positioning system. You can customize the positioning system by specifying a [LocationRequest](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationRequest) in the method parameters.
+
+Use [onLocationUpdate()](#--onLocationUpdate) to receive updates of the user's location,
+[onLocationStatus()](#--onLocationStatus) to receive updates of the positioning status
+and [onLocationError()](#--onLocationError) to receive the possible errors that take place when positioning.
+
+```js
+cordova.plugins.Situm.requestLocationUpdates(
+  {
+      buildingIdentifier = "YOUR_BUILDING_IDENTIFIER"
+  });
+```
+
+#### - removeUpdates
+
+Stop the positioning system.
+This method returns a promise, so use the .then() and .catch() methods to know the result.
+
+```js
+cordova.plugins.Situm.removeUpdates()
+  .then(() => {
+    // Positioning system has stopped successfully.
+  })
+  .catch((err: any) => {
+    // Error while stopping the positioning system.
+  });
+```
+
+#### - onLocationUpdate
+
+Use this callback to stay aware about the user's [Location](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Location).
+
+```js
+cordova.plugins.Situm.onLocationUpdate((location: any) => {
+  console.log('The user has moved to: ' + location.position);
+});
+```
+
+#### - onLocationStatus
+
+Use this callback to stay aware about the [LocationStatus](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationStatus) of the positioning system.
+
+```js
+cordova.plugins.Situm.onLocationStatus((status: string) => {
+  console.log('New positioning status: ' + status);
+});
+```
+
+#### - onLocationError
+
+Use this callback to stay aware about the errors the user might face when the positioning system starts.
+See [onLocationError()](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/situm#.onLocationError).
+
+```js
+cordova.plugins.Situm.onLocationError((err: any) => {
+  console.log('Error received when positioning: ' + err);
+});
+```
+
 #### - stopPositioning
 
+> [!WARNING]
+> This method is deprecated, instead use [removeUpdates](#--removeUpdates).
+
 Stop the positioning system on current active listener.
 
 ```js
@@ -329,7 +396,7 @@ directionRequest = [
   building, // Building in which you're positioning
   from, // Point where you want to start the route. You can pass a Point or a Location
   to, // Point where you want to finish the route
-  {}, // Options to generate the route
+  {} // Options to generate the route
 ];
 
 cordova.plugins.Situm.requestDirections(
@@ -352,7 +419,7 @@ When you start feeding locations you can receive [NavigationProgress](https://de
 // Navigation request with example values
 navigationRequest = [
   (distanceToGoalThreshold = 10),
-  (distanceToFloorChangeThreshold = 5),
+  (distanceToFloorChangeThreshold = 5)
 ];
 cordova.plugins.Situm.requestNavigationUpdates(
   navigationRequest,
@@ -394,7 +461,7 @@ Emits the [real time](https://developers.situm.com/sdk_documentation/cordova/jsd
 ```js
 const request = {
   building: building, //Building in which you want to be notified
-  pollTime: 3000, // time in milliseconds
+  pollTime: 3000 // time in milliseconds
 };
 cordova.plugins.Situm.SitumPlugin.requestRealTimeUpdates(
   request,
@@ -462,11 +529,11 @@ cordova.plugins.MapView.onLoad((controller: any) => {
 
   // 2. Listen to events that take place inside our map like a poi being selected or deselected:
   controller.onPoiSelected((poiSelectedResult: any) => {
-    console.log("EXAMPLE> onPoiSelected -> ", poiSelectedResult);
+    console.log('EXAMPLE> onPoiSelected -> ', poiSelectedResult);
   });
 
   controller.onPoiDeselected((poiDeselectedResult: any) => {
-    console.log("EXAMPLE> onPoiDeselected -> ", poiDeselectedResult);
+    console.log('EXAMPLE> onPoiDeselected -> ', poiDeselectedResult);
   });
 });
 ```
@@ -482,7 +549,7 @@ Select a POI in the map.
 ```js
 cordova.plugins.MapView.onLoad((controller: any) => {
   // Once the MapView was loaded you can select a POI in our map by calling:
-  controller.selectPoi("YOUR_POI_IDENTIFIER");
+  controller.selectPoi('YOUR_POI_IDENTIFIER');
 });
 ```
 
@@ -497,7 +564,7 @@ cordova.plugins.MapView.onLoad((controller: any) => {
   // Once the MapView was loaded you can navigate to a POI in our map.
   // Make sure to call this method once the user is positioning indoors in your building,
   // otherwise this method will have no effect.
-  controller.navigateToPoi("YOUR_POI_IDENTIFIER");
+  controller.navigateToPoi('YOUR_POI_IDENTIFIER');
 
   // controller.navigateToPoi("YOUR_POI_IDENTIFIER", "CHOOSE_SHORTEST");
 });
@@ -514,7 +581,7 @@ Listen to the selection event of a POI.
 cordova.plugins.MapView.onLoad((controller: any) => {
   // Once the MapView was loaded you can listen to a POI being selected.
   controller.onPoiSelected((poiSelectedResult: any) => {
-    console.log("EXAMPLE> onPoiSelected -> ", poiSelectedResult);
+    console.log('EXAMPLE> onPoiSelected -> ', poiSelectedResult);
   });
 });
 ```
@@ -529,7 +596,7 @@ Listen to listen to a POI being deselected.
 cordova.plugins.MapView.onLoad((controller: any) => {
   // Once the MapView was loaded you can listen to a POI being deselected.
   controller.onPoiDeselected((poiDeselectedResult: any) => {
-    console.log("EXAMPLE> onPoiDeselected -> ", poiDeselectedResult);
+    console.log('EXAMPLE> onPoiDeselected -> ', poiDeselectedResult);
   });
 });
 ```

package/example/ios/App/App.xcodeproj/xcshareddata/xcschemes/App.xcscheme

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1420"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "504EC3031FED79650016851F"
+               BuildableName = "App.app"
+               BlueprintName = "App"
+               ReferencedContainer = "container:App.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "504EC3031FED79650016851F"
+            BuildableName = "App.app"
+            BlueprintName = "App"
+            ReferencedContainer = "container:App.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "504EC3031FED79650016851F"
+            BuildableName = "App.app"
+            BlueprintName = "App"
+            ReferencedContainer = "container:App.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

package/example/src/app/sdk/sdk.page.html

@@ -20,17 +20,17 @@
       <ion-row>
         <ion-button
           size="small"
-          (click)="startPositioning()"
+          (click)="requestLocationUpdates()"
           [disabled]="positioning"
         >
-          startPositioning()
+          requestLocationUpdates()
         </ion-button>
         <ion-button
           size="small"
-          (click)="stopPositioning()"
+          (click)="removeUpdates()"
           [disabled]="!positioning"
         >
-          stopPositioning()
+          removeUpdates()
         </ion-button>
       </ion-row>
     </ion-card-content>

package/example/src/app/sdk/sdk.page.ts

@@ -18,7 +18,7 @@ import {
   IonPicker,
   IonThumbnail,
   NavController,
-  Platform,
+  Platform
 } from '@ionic/angular/standalone';
 import { NgFor, NgIf } from '@angular/common';
 import { locate, cloudDownload, map } from 'ionicons/icons';
@@ -54,8 +54,8 @@ declare let cordova: any;
     IonTextarea,
     IonPicker,
     NgFor,
-    NgIf,
-  ],
+    NgIf
+  ]
 })
 export class SDKPage {
   buildings: Array<any> | undefined;
@@ -109,7 +109,7 @@ export class SDKPage {
   // =                                    POSITIONING                                             =
   // ==============================================================================================
 
-  async startPositioning() {
+  async requestLocationUpdates() {
     if (this.positioning) {
       return;
     }
@@ -130,44 +130,43 @@ export class SDKPage {
   }
 
   private doStartPositioning() {
+    cordova.plugins.Situm.onLocationUpdate((location: any) => {
+      this._setStatus('POSITIONING');
+      this._setInfo(location);
+    });
+    cordova.plugins.Situm.onLocationStatus((status: string) => {
+      this._setStatus(status);
+      if (status == 'STARTING') {
+        this._setPositioning(true);
+      }
+    });
+    cordova.plugins.Situm.onLocationError((err: any) => {
+      this._setPositioning(false);
+      this._setStatus('ERROR WHILE POSITIONING');
+      this._setInfo(err);
+    });
     // Start positioning in the building specified in the /src/constants.ts you created before:
-    cordova.plugins.Situm.startPositioning(
+    cordova.plugins.Situm.requestLocationUpdates(
       // In case you have multiple buildings that the user could visit,
       // you might want to start positioning in all your buildings using global mode
       // by specifying an empty identifier:
       //
       // buildingIdentifier: ''
-      [{ buildingIdentifier: Constants.BUILDING_IDENTIFIER }],
-      (res: any) => {
-        if (res && res.statusName) {
-          this._setStatus(res.statusName);
-        }
-        if (res && res.position) {
-          this._setStatus('POSITIONING');
-          this._setInfo(res);
-        }
-        this._setPositioning(true);
-      },
-      (err: any) => {
-        this._setPositioning(false);
-        this._setStatus('ERROR WHILE POSITIONING');
-        this._setInfo(err);
-      }
+      { buildingIdentifier: Constants.BUILDING_IDENTIFIER }
     );
   }
 
-  async stopPositioning() {
-    cordova.plugins.Situm.stopPositioning(
-      () => {
+  async removeUpdates() {
+    cordova.plugins.Situm.removeUpdates()
+      .then(() => {
         this._setPositioning(false);
         this._setStatus('STOPPED');
         this._setInfo('');
-      },
-      (err: any) => {
+      })
+      .catch((err: any) => {
         this._setStatus('ERROR');
         this._setInfo(err);
-      }
-    );
+      });
   }
 
   // ==============================================================================================
@@ -373,16 +372,16 @@ export class SDKPage {
       options: [
         {
           text: 'Do fetchPois() before selecting a POI',
-          value: 'empty',
-        },
-      ],
-    },
+          value: 'empty'
+        }
+      ]
+    }
   ];
 
   public pickerButtons = [
     {
       text: 'Cancel',
-      role: 'cancel',
+      role: 'cancel'
     },
     {
       text: 'Confirm',
@@ -391,8 +390,8 @@ export class SDKPage {
         this.ngZone.run(() => {
           this.currentPoi = value.pois.value;
         });
-      },
-    },
+      }
+    }
   ];
 
   private _populatePOIPicker(pois: any) {
@@ -400,7 +399,7 @@ export class SDKPage {
     for (let poi of pois) {
       this.pickerColumns[0].options.push({
         text: poi.poiName,
-        value: poi,
+        value: poi
       });
     }
     this.pickerColumns[0].options.sort((a, b) => {

package/example/src/app/wyf/wyf.page.html

@@ -13,7 +13,6 @@
   <!-- Follow this guide (https://situm.com/docs/sdk-cartography/#building-identifier)
     to find out the identifier of the building you want to display -->
   <map-view
-    viewer-domain="https://map-viewer.situm.com"
     situm-api-key="YOUR_SITUM_API_KEY"
     building-identifier="YOUR_BUILDING_IDENTIFIER"
     remote-identifier="YOUR_REMOTE_IDENTIFIER"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/cordova",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "description": "Set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system.",
   "private": false,
   "repository": "https://github.com/situmtech/cordova",

package/plugin.xml

@@ -2,7 +2,7 @@
 
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
     id="@situm/cordova"
-    version="3.4.0">
+    version="3.4.2">
     <name>Situm Cordova plugin Official</name>
     <description>This is the stable branch.</description>
     <license>MIT</license>

package/src/android/app/src/main/java/es/situm/plugin/SitumMapper.java

@@ -758,6 +758,9 @@ static JSONObject buildingInfoToJsonObject(BuildingInfo buildingInfo) throws JSO
     JSONObject request = args.getJSONObject(0);
     if (request.has(SitumMapper.BUILDING_IDENTIFIER)) {
       String buildingIdentifier = String.valueOf(request.get(SitumMapper.BUILDING_IDENTIFIER));
+      if (buildingIdentifier.isEmpty()) {
+        buildingIdentifier = "-1";
+      }
       locationBuilder.buildingIdentifier(buildingIdentifier);
       Log.i(TAG, "buildingIdentifier: " + buildingIdentifier);
     }

package/src/ios/Podfile

@@ -1,5 +1,5 @@
 target 'SitumCordovaPlugin' do
   use_frameworks!
   platform :ios, '9.0'
-  pod 'SitumSDK', '3.8.4'
+  pod 'SitumSDK', '3.8.5'
 end

package/src/ios/situmcordovaplugin/SitumLocationWrapper.m

@@ -568,6 +568,9 @@ static SitumLocationWrapper *singletonSitumLocationWrapperObj;
 }
 
 - (SITLocation *) locationJsonObjectToLocation:(NSDictionary *) jo {
+    if ([jo isKindOfClass:[NSArray class]] && [jo count] > 0) {
+        jo = [[jo objectEnumerator] nextObject];
+    }
     NSTimeInterval timestamp = [(NSNumber*)[jo valueForKey:@"timestamp"] doubleValue];
     SITPoint *position;
     // TODO: the map-viewer is not wrapping the position info into a position object.

package/www/map-view.js

@@ -57,7 +57,7 @@ const MapViewController = require('./map-view-controller')
  * @namespace MapView
  */
 class MapView extends HTMLElement {
-  _viewerDomain
+  _viewerDomain = 'https://map-viewer.situm.com'
 
   constructor() {
     super()

package/www/situm.js

@@ -8,7 +8,7 @@ let _clientLocationUpdateCallback;
 let _clientLocationStatusCallback;
 let _clientLocationErrorCallback;
 
-let _internalPositioningCallback = function(res) {
+let _internalPositioningCallback = function (res) {
   if (!res) {
     return;
   }
@@ -23,13 +23,13 @@ let _internalPositioningCallback = function(res) {
   }
 };
 
-let _internalErrorCallback = function(error) {
+let _internalErrorCallback = function (error) {
   if (_clientLocationErrorCallback) {
     _clientLocationErrorCallback(error);
   }
-}
+};
 
-/** 
+/**
  * @namespace Situm
  */
 var Situm = {
@@ -101,7 +101,13 @@ var Situm = {
       error(err);
     };
     let compatRequest = common.standarizeRequest(request);
-    exec(legacyCallback, legacyErrorCallback, PLUGIN_NAME, 'startPositioning', compatRequest);
+    exec(
+      legacyCallback,
+      legacyErrorCallback,
+      PLUGIN_NAME,
+      'startPositioning',
+      compatRequest
+    );
   },
 
   /**
@@ -111,9 +117,15 @@ var Situm = {
    * @see {@link onLocationStatus}
    * @see {@link onLocationError}
    */
-  requestLocationUpdates: function(request) {
+  requestLocationUpdates: function (request) {
     let compatRequest = common.standarizeRequest(request);
-    exec(_internalPositioningCallback, _internalErrorCallback, PLUGIN_NAME, 'startPositioning', compatRequest);
+    exec(
+      _internalPositioningCallback,
+      _internalErrorCallback,
+      PLUGIN_NAME,
+      'startPositioning',
+      compatRequest
+    );
   },
 
   // TODO: move to TypeScript:
@@ -142,7 +154,7 @@ var Situm = {
    * @param {OnLocationUpdateCallback} callback Callback.
    * @see {@link requestLocationUpdates}
    */
-  onLocationUpdate: function(callback) {
+  onLocationUpdate: function (callback) {
     if (!callback || typeof callback === 'function') {
       _clientLocationUpdateCallback = callback;
     }
@@ -153,7 +165,7 @@ var Situm = {
    * @param {OnLocationStatusCallback} callback Callback.
    * @see {@link requestLocationUpdates}
    */
-  onLocationStatus: function(callback) {
+  onLocationStatus: function (callback) {
     if (!callback || typeof callback === 'function') {
       _clientLocationStatusCallback = callback;
     }
@@ -164,7 +176,7 @@ var Situm = {
    * @param {OnLocationErrorCallback} callback Callback.
    * @see {@link requestLocationUpdates}
    */
-  onLocationError: function(callback) {
+  onLocationError: function (callback) {
     if (!callback || typeof callback === 'function') {
       _clientLocationErrorCallback = callback;
     }
@@ -186,9 +198,19 @@ var Situm = {
    * Stops positioning.
    * @returns {Promise} Get notified when the native SDK actually stops positioning.
    */
-  removeUpdates: function() {
+  removeUpdates: function () {
     return new Promise((res, rej) => {
-      exec(() => { res(true) }, (err) => { rej(err) }, PLUGIN_NAME, 'stopPositioning', []);
+      exec(
+        () => {
+          res(true);
+        },
+        (err) => {
+          rej(err);
+        },
+        PLUGIN_NAME,
+        'stopPositioning',
+        []
+      );
     });
   },
 
@@ -374,11 +396,6 @@ var Situm = {
    * @return {boolean} success True if there is a listener to which notify progress update. False if there isn't, so this method do nothing.
    */
   updateNavigationWithLocation: function (location, cb, error) {
-    if (!args) {
-      args = []
-    } else if (!Array.isArray(args)) {
-      args = [args]
-    }
     exec(cb, error, PLUGIN_NAME, 'updateNavigationWithLocation', [location]);
   },
   /**
@@ -408,7 +425,7 @@ var Situm = {
    * @param {function} cb Cordova native callback to recive data.
    * @param {function} error Cordova native callback to recive errors.
    */
-  removeRealTimeUpdates: function(cb, error) {
+  removeRealTimeUpdates: function (cb, error) {
     exec(cb, error, PLUGIN_NAME, 'removeRealTimeUpdates', []);
   }
 };