@situm/cordova 3.14.14 → 3.15.1

package/example/package-lock.json

@@ -68,7 +68,7 @@
     },
     "..": {
       "name": "@situm/cordova",
-      "version": "3.6.11",
+      "version": "3.14.12",
       "engines": [
         {
           "name": "cordova-android",

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

@@ -24,7 +24,6 @@ import { NgFor, NgIf } from '@angular/common';
 import { locate, cloudDownload, map } from 'ionicons/icons';
 import { addIcons } from 'ionicons';
 
-import { requestPermissions } from '../utils/request.permissions';
 import * as Constants from '../../constants';
 
 // Declare a cordova variable to avoid typescript errors
@@ -81,6 +80,10 @@ export class SDKPage {
     // See all the parameters you can modify in https://dashboard.situm.com/settings.
     cordova.plugins.Situm.setUseRemoteConfig(true);
 
+    // Tell the native SDK to automatically request permissions and manage
+    // sensor (BLE/Location) issues.
+    cordova.plugins.Situm.enableUserHelper();
+
     // Wait until receive the MapViewController of our map and
     // be able to send actions and receive events that occur inside it.
     cordova.plugins.MapView.onLoad((controller: any) => {
@@ -114,22 +117,7 @@ export class SDKPage {
       return;
     }
     this._setInfo('');
-    // You might want to know how we ask the all the permissions,
-    // so take a look at /src/app/utils/request.permission.ts
-    requestPermissions(
-      () => {
-        this.doStartPositioning();
-      },
-      (errorMessage: any) => {
-        this._setInfo(
-          'Something did happen while asking for permission: ' + errorMessage
-        );
-      },
-      this.platform
-    );
-  }
 
-  private doStartPositioning() {
     cordova.plugins.Situm.onLocationUpdate((location: any) => {
       this._setStatus('POSITIONING');
       this._setInfo(location);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/cordova",
-  "version": "3.14.14",
+  "version": "3.15.1",
   "description": "Situm Wayfinding for Capacitor and Cordova. Integrate plug&play indoor navigation experience with floorplans, POIs, routes and turn-by-turn directions in no time. With the power of Situm.",
   "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.14.14">
+    version="3.15.1">
     <name>Situm Cordova plugin Official</name>
     <description>This is the stable branch.</description>
     <license>MIT</license>
@@ -93,7 +93,7 @@
             <config>
             </config>
             <pods use-frameworks="false">
-                <pod name="SitumSDK" spec="~> 3.28.1"/>
+                <pod name="SitumSDK" spec="~> 3.29.0"/>
             </pods>
         </podspec>
 

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

@@ -47,6 +47,7 @@ import es.situm.sdk.realtime.RealTimeListener;
 import es.situm.sdk.realtime.RealTimeManager;
 import es.situm.sdk.realtime.RealTimeRequest;
 import es.situm.sdk.utils.Handler;
+import es.situm.sdk.userhelper.UserHelperColorScheme;
 import es.situm.sdk.v1.SitumEvent;
 
 public class PluginHelper {
@@ -546,16 +547,6 @@ public class PluginHelper {
                     PluginResult result = new PluginResult(Status.ERROR, error.getMessage());
                     result.setKeepCallback(true);
                     callbackContext.sendPluginResult(result);
-                    switch (error.getCode()) {
-                        case 8001:
-                            requestLocationPermission(cordova);
-                            return;
-                        case 8002:
-                            showLocationSettings(cordova);
-                            return;
-                        default:
-                            return;
-                    }
                 }
             };
             try {
@@ -631,16 +622,6 @@ public class PluginHelper {
         callbackContext.sendPluginResult(pluginResult);
     }
 
-    private void showLocationSettings(CordovaInterface cordova) {
-        Toast.makeText(cordova.getActivity(), "You must enable location", Toast.LENGTH_LONG).show();
-        cordova.getActivity().startActivityForResult(new Intent("android.settings.LOCATION_SOURCE_SETTINGS"), 0);
-    }
-
-    private void requestLocationPermission(CordovaInterface cordova) {
-        ActivityCompat.requestPermissions(cordova.getActivity(),
-                new String[] { "android.permission.ACCESS_FINE_LOCATION" }, 0);
-    }
-
     public void returnDefaultResponse(CallbackContext callbackContext) {
         String message = "Error function name not found";
         Log.e(TAG, message);
@@ -899,6 +880,34 @@ public class PluginHelper {
         getRealtimeManagerInstance().removeRealTimeUpdates(); // TODO: Incorporate sending a result to the exterior
     }
 
+    public void configureUserHelper(
+        CordovaInterface cordova,
+        CordovaWebView webView,
+        JSONArray args,
+        final CallbackContext callbackContext
+    ) {
+        try {
+            JSONObject jsonUserHelperOptions = args.getJSONObject(0);
+            boolean enabled = false;
+            if (jsonUserHelperOptions.has("enabled")) {
+                enabled = jsonUserHelperOptions.getBoolean("enabled");
+            }
+            if (jsonUserHelperOptions.has("colorScheme")) {
+                JSONObject jsonColorScheme = jsonUserHelperOptions.getJSONObject("colorScheme");
+                UserHelperColorScheme colorScheme = SitumMapper.jsonObjectToUserHelperColorScheme(jsonColorScheme);
+                SitumSdk.userHelperManager().setColorScheme(colorScheme);
+            }
+            SitumSdk.userHelperManager().autoManage(enabled);
+
+            callbackContext.sendPluginResult(new PluginResult(Status.OK, "User helper configured"));
+          } catch (Exception e) {
+            Log.d(TAG, "exception: " + e);
+  
+            e.printStackTrace();
+            callbackContext.sendPluginResult(new PluginResult(Status.ERROR, e.getMessage()));
+          }
+    }
+
     // Initialize Navigation Component 
 
     public void updateNavigationWithLocation(CordovaInterface cordova,

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

@@ -58,6 +58,7 @@ import es.situm.sdk.v1.SitumConversionArea;
 import es.situm.sdk.v1.SitumEvent;
 import es.situm.sdk.realtime.RealTimeRequest;
 import es.situm.sdk.model.realtime.RealTimeData;
+import es.situm.sdk.userhelper.UserHelperColorScheme;
 
 
 class SitumMapper {
@@ -980,4 +981,24 @@ static JSONObject buildingInfoToJsonObject(BuildingInfo buildingInfo) throws JSO
     }
     return new DirectionsRequest.Builder().from(from, Angle.fromDegrees(startingAngle)).to(to).accessibilityMode(accessibilityMode).minimizeFloorChanges(minimizeFloorChanges).includedTags(includedTags).excludedTags(excludedTags).build();
   }
+
+  static UserHelperColorScheme jsonObjectToUserHelperColorScheme(JSONObject args) throws JSONException {
+    UserHelperColorScheme.Builder builder = new UserHelperColorScheme.Builder();
+
+    if (args.has("primaryColor")) {
+      String primaryColor = args.getString("primaryColor");
+      if (primaryColor != null) {
+        builder.setPrimaryColor(primaryColor);
+      }
+    }
+
+    if (args.has("secondaryColor")) {
+      String secondaryColor = args.getString("secondaryColor");
+      if (secondaryColor != null) {
+        builder.setSecondaryColor(secondaryColor);
+      }
+    }
+
+    return builder.build();
+  }
 }

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

@@ -92,18 +92,20 @@ public class SitumPlugin extends CordovaPlugin {
       getPluginInstance().invalidateCache(callbackContext);
     } else if (action.equalsIgnoreCase("requestDirections")) {
       getPluginInstance().requestDirections(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("requestNavigationUpdates")) {
+    } else if(action.equalsIgnoreCase("requestNavigationUpdates")) {
       getPluginInstance().requestNavigationUpdates(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("updateNavigationWithLocation")) {
+    } else if(action.equalsIgnoreCase("updateNavigationWithLocation")) {
       getPluginInstance().updateNavigationWithLocation(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("removeNavigationUpdates")) {
+    } else if(action.equalsIgnoreCase("removeNavigationUpdates")) {
       getPluginInstance().removeNavigationUpdates(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("requestRealTimeUpdates")) {
+    } else if(action.equalsIgnoreCase("requestRealTimeUpdates")) {
       getPluginInstance().requestRealTimeUpdates(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("removeRealTimeUpdates")) {
+    } else if(action.equalsIgnoreCase("removeRealTimeUpdates")) {
       getPluginInstance().removeRealTimeUpdates(cordova, webView, args, callbackContext);
-    } else  if(action.equalsIgnoreCase("updateNavigationState")) {
+    } else if(action.equalsIgnoreCase("updateNavigationState")) {
       getPluginInstance().updateNavigationState(cordova, webView, args, callbackContext);
+    } else if(action.equalsIgnoreCase("configureUserHelper")) {
+      getPluginInstance().configureUserHelper(cordova, webView, args, callbackContext);
     } else {
       getPluginInstance().returnDefaultResponse(callbackContext);
     }

package/src/ios/Podfile

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

package/src/ios/situmcordovaplugin/SitumPlugin.m

@@ -782,4 +782,38 @@ destinationReachedOnRoute:(SITRoute *)route {
     [self.commandDelegate sendPluginResult:pluginResult callbackId:callbackId];
 }
 
+- (void)configureUserHelper:(CDVInvokedUrlCommand *)command {
+    NSDictionary *options = [command.arguments objectAtIndex:0];
+    BOOL enabled = NO;
+    
+    if ([options objectForKey:@"enabled"]) {
+        enabled = [[options objectForKey:@"enabled"] boolValue];
+    }
+    
+    [[SITUserHelperManager sharedInstance] autoManage:enabled];
+    
+    if ([options objectForKey:@"colorScheme"]) {
+        id colorSchemeValue = [options objectForKey:@"colorScheme"];
+        if ([colorSchemeValue isKindOfClass:[NSDictionary class]]) {
+            NSDictionary *colorScheme = [options objectForKey:@"colorScheme"];
+            NSString *primaryColor = [colorScheme objectForKey:@"primaryColor"];
+            NSString *secondaryColor = [colorScheme objectForKey:@"secondaryColor"];
+
+            SITUserHelperColorScheme *helperColorScheme = [[SITUserHelperColorScheme alloc] init];
+            if (primaryColor) {
+                helperColorScheme.primaryColor = primaryColor;
+            }
+            if (secondaryColor) {
+                helperColorScheme.secondaryColor = secondaryColor;
+            }
+
+            [[SITUserHelperManager sharedInstance] setColorScheme:helperColorScheme];
+        }
+    }
+    
+    CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"User helper configured"];
+    [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+}
+
+
 @end

package/www/Interfaces.js

@@ -817,3 +817,35 @@ var PoiDeselectedResult = {
 };
 
 module.exports = PoiDeselectedResult;
+
+/**
+ * @name
+ * UserHelperColorScheme
+ * @description
+ * Color scheme for the user helper UI.
+ * @property {string} primaryColor - Primary color for the user helper UI. Use HEX color code (e.g. "#ff5733").
+ * @property {string} secondaryColor - Secondary color for the user helper UI. Use HEX color code (e.g. "#ff5733").
+ */
+
+var UserHelperColorScheme = {
+  primaryColor,
+  secondaryColor
+};
+
+module.exports = UserHelperColorScheme;
+
+/**
+ * @name
+ * UserHelperOptions
+ * @description
+ * Configuration options for the user helper.
+ * @property {boolean} enabled - Whether the user helper is enabled. Equivalent to the underlying native SitumSdk.userHelperManager#autoManage(true).
+ * @property {UserHelperColorScheme} colorScheme - Color scheme for the user helper UI.
+ */
+
+var UserHelperOptions = {
+  enabled,
+  colorScheme
+};
+
+module.exports = UserHelperOptions;

package/www/situm.js

@@ -449,6 +449,52 @@ var Situm = {
    */
   removeRealTimeUpdates: function (cb, error) {
     exec(cb, error, PLUGIN_NAME, 'removeRealTimeUpdates', []);
+  },
+  /**
+   * Automatically assists users in resolving app-related permission and sensor issues.
+   *
+   * This method tells the native SDKs to present a user interface that explains detected 
+   * configuration issues and guides users through the required steps to resolve them, 
+   * following best practices for runtime permission requests.
+   *
+   * Issues addressed include:
+   * - Missing permissions for Location or Bluetooth.
+   * - Disabled Location or Bluetooth sensors.
+   *
+   * Use the <code>userHelperOptions</code> parameter to configure the available options.
+   * Call {@link enableUserHelper} as a shortcut to enable the user helper with default configuration.
+   * Call {@link disableUserHelper} as a shortcut to disable the user helper.
+   *
+   * @param {UserHelperOptions} userHelperOptions - Options for the user helper.
+   * @param {function} cb - Cordova native callback to receive data.
+   * @param {function} error - Cordova native callback to receive errors.
+   */
+  configureUserHelper: function (userHelperOptions, cb, error) {
+    exec(cb, error, PLUGIN_NAME, 'configureUserHelper', [userHelperOptions]);
+  },
+
+  /**
+   * Enables the user helper.
+   *
+   * Shortcut for {@link configureUserHelper} with <code>{enabled: true}</code>.
+   *
+   * @param {function} cb - Cordova native callback to receive data.
+   * @param {function} error - Cordova native callback to receive errors.
+   */
+  enableUserHelper: function (cb, error) {
+    this.configureUserHelper({enabled: true}, cb, error);
+  },
+
+  /**
+   * Disables the user helper.
+   *
+   * Shortcut for {@link configureUserHelper} with <code>{enabled: false}</code>.
+   *
+   * @param {function} cb - Cordova native callback to receive data.
+   * @param {function} error - Cordova native callback to receive errors.
+   */
+  disableUserHelper: function (cb, error) {
+    this.configureUserHelper({enabled: false}, cb, error);
   }
 };
 module.exports = Situm;

package/example/src/app/utils/request.permissions.ts

@@ -1,68 +0,0 @@
-import { Platform } from '@ionic/angular/standalone';
-
-declare let cordova: any;
-
-export function requestPermissions(
-  successCb: Function,
-  errorCb: Function,
-  platform: Platform
-) {
-  if (platform.is('android')) {
-    cordova.plugins.diagnostic.requestRuntimePermissions(
-      function (permissions: Map<string, string>) {
-        console.log('EXAMPLE> permissions statuses: ', permissions);
-        successCb();
-      },
-      function (error: any) {
-        errorCb(JSON.stringify(error));
-      },
-      [
-        // Android
-        // We ask this permission to obtain the GPS data of the user and paint it on our map.
-        cordova.plugins.diagnostic.permission.ACCESS_FINE_LOCATION,
-        // We ask this last 2 permissions to improve the accuracy of our SDK when locating the user.
-        cordova.plugins.diagnostic.permission.BLUETOOTH_CONNECT,
-        cordova.plugins.diagnostic.permission.BLUETOOTH_SCAN,
-      ]
-    );
-  } else if (platform.is('ios')) {
-    cordova.plugins.diagnostic.getLocationAuthorizationStatus(
-      (status: string) => {
-        if (status == 'authorized') {
-          successCb();
-          return;
-        }
-      },
-      () => {
-        // Do nothing
-      }
-    );
-
-    // iOS
-    // We just need to ask for the location permission.
-    cordova.plugins.diagnostic.requestLocationAuthorization(
-      function (status: string) {
-        switch (status) {
-          case cordova.plugins.diagnostic.permissionStatus.NOT_REQUESTED:
-            errorCb('Permission not requested');
-            break;
-          case cordova.plugins.diagnostic.permissionStatus.DENIED_ALWAYS:
-            errorCb('Permission denied');
-            break;
-          case cordova.plugins.diagnostic.permissionStatus.GRANTED:
-            console.log('Permission granted always');
-            successCb();
-            break;
-          case cordova.plugins.diagnostic.permissionStatus.GRANTED_WHEN_IN_USE:
-            console.log('Permission granted only when in use');
-            successCb();
-            break;
-        }
-      },
-      function (error: any) {
-        errorCb(JSON.stringify(error));
-      },
-      cordova.plugins.diagnostic.locationAuthorizationMode.ALWAYS
-    );
-  }
-}