feat: add API to enable background location updates on iOS (#61)

Fixes #26
Creates an API to Allow background location updates on iOS

Author: ArturoSalazarB16

SampleApp/ios/Podfile.lock

@@ -70,6 +70,13 @@ PODS:
     - FlipperKit/FlipperKitNetworkPlugin
   - fmt (6.2.1)
   - glog (0.3.5)
+  - GoogleMaps (7.4.0):
+    - GoogleMaps/Maps (= 7.4.0)
+  - GoogleMaps/Base (7.4.0)
+  - GoogleMaps/Maps (7.4.0):
+    - GoogleMaps/Base
+  - GoogleNavigation (4.4.0):
+    - GoogleMaps (= 7.4.0)
   - hermes-engine (0.72.6):
     - hermes-engine/Pre-built (= 0.72.6)
   - hermes-engine/Pre-built (0.72.6)
@@ -375,6 +382,9 @@ PODS:
   - React-jsinspector (0.72.6)
   - React-logger (0.72.6):
     - glog
+  - react-native-navigation-sdk (0.1.4-beta):
+    - GoogleNavigation (= 4.4.0)
+    - React-Core
   - React-NativeModulesApple (0.72.6):
     - hermes-engine
     - React-callinvoker
@@ -542,6 +552,7 @@ DEPENDENCIES:
   - React-jsiexecutor (from `../node_modules/react-native/ReactCommon/jsiexecutor`)
   - React-jsinspector (from `../node_modules/react-native/ReactCommon/jsinspector`)
   - React-logger (from `../node_modules/react-native/ReactCommon/logger`)
+  - react-native-navigation-sdk (from `../node_modules/react-native-navigation-sdk`)
   - React-NativeModulesApple (from `../node_modules/react-native/ReactCommon/react/nativemodule/core/platform/ios`)
   - React-perflogger (from `../node_modules/react-native/ReactCommon/reactperflogger`)
   - React-RCTActionSheet (from `../node_modules/react-native/Libraries/ActionSheetIOS`)
@@ -576,6 +587,8 @@ SPEC REPOS:
     - Flipper-PeerTalk
     - FlipperKit
     - fmt
+    - GoogleMaps
+    - GoogleNavigation
     - libevent
     - OpenSSL-Universal
     - SocketRocket
@@ -625,6 +638,8 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native/ReactCommon/jsinspector"
   React-logger:
     :path: "../node_modules/react-native/ReactCommon/logger"
+  react-native-navigation-sdk:
+    :path: "../node_modules/react-native-navigation-sdk"
   React-NativeModulesApple:
     :path: "../node_modules/react-native/ReactCommon/react/nativemodule/core/platform/ios"
   React-perflogger:
@@ -684,6 +699,8 @@ SPEC CHECKSUMS:
   FlipperKit: 2efad7007d6745a3f95e4034d547be637f89d3f6
   fmt: ff9d55029c625d3757ed641535fd4a75fedc7ce9
   glog: 04b94705f318337d7ead9e6d17c019bd9b1f6b1b
+  GoogleMaps: 032f676450ba0779bd8ce16840690915f84e57ac
+  GoogleNavigation: c07206bab1e1d483003a4d95ae58ecfa8d29fd21
   hermes-engine: 8057e75cfc1437b178ac86c8654b24e7fead7f60
   libevent: 4049cae6c81cdb3654a443be001fb9bdceff7913
   OpenSSL-Universal: ebc357f1e6bc71fa463ccb2fe676756aff50e88c
@@ -702,6 +719,7 @@ SPEC CHECKSUMS:
   React-jsiexecutor: 3bf18ff7cb03cd8dfdce08fbbc0d15058c1d71ae
   React-jsinspector: 194e32c6aab382d88713ad3dd0025c5f5c4ee072
   React-logger: cebf22b6cf43434e471dc561e5911b40ac01d289
+  react-native-navigation-sdk: 6b584b850424c800a06d51f055b24b30c6fde91b
   React-NativeModulesApple: 02e35e9a51e10c6422f04f5e4076a7c02243fff2
   React-perflogger: e3596db7e753f51766bceadc061936ef1472edc3
   React-RCTActionSheet: 17ab132c748b4471012abbcdcf5befe860660485

SampleApp/package-lock.json

@@ -14,6 +14,7 @@
     "react": "18.2.0",
     "react-native": "^0.72.4",
     "react-native-eject": "^0.2.0",
+    "react-native-navigation-sdk": "github:googlemaps/react-native-navigation-sdk",
     "react-native-permissions": "^3.10.1",
     "react-native-select-dropdown": "^3.4.0",
     "react-native-snackbar": "^2.6.2"

SampleApp/package.json

@@ -55,6 +55,9 @@ const NavigationControls: React.FC<NavigationControlsProps> = ({
   const [speedometerEnabled, setSpeedometerEnabled] = useState(false);
   const [trafficIncidentsCardEnabled, setTrafficIncidentsCardEnabled] =
     useState(false);
+  const [backgroundLocationUpdatesEnabled, setBackgroundLocationUpdatesEnabled] =
+    useState(false);
+
   const [latitude, onLatChanged] = useState('');
   const [longitude, onLngChanged] = useState('');
 
@@ -178,6 +181,12 @@ const NavigationControls: React.FC<NavigationControlsProps> = ({
     navigationViewController.setTrafficIncidentCardsEnabled(isOn);
   };
 
+  const toggleBackgroundLocationUpdatesEnabled = (isOn: boolean) => {
+    console.log('toggleBackgroundLocationUpdatesEnabled:', isOn);
+    setBackgroundLocationUpdatesEnabled(isOn);
+    navigationViewController.setBackgroundLocationUpdatesEnabled(isOn);
+  };
+
   const showRouteOverview = () => {
     console.log('showRouteOverview');
     navigationViewController.showRouteOverview();
@@ -342,6 +351,15 @@ const NavigationControls: React.FC<NavigationControlsProps> = ({
           }}
         />
       </View>
+      <View style={styles.rowContainer}>
+        <Text>Background location updates</Text>
+        <Switch
+          value={backgroundLocationUpdatesEnabled}
+          onValueChange={() => {
+            toggleBackgroundLocationUpdatesEnabled(!backgroundLocationUpdatesEnabled);
+          }}
+        />
+      </View>
       <View style={styles.rowContainer}>
         <Text>Night mode </Text>
         <SelectDropdown

SampleApp/src/navigationControls.tsx

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import {NativeModules} from 'react-native';
+import {NativeModules, Platform} from 'react-native';
 import {LatLng} from '../../shared/types';
 import {commands, sendCommand} from '../../shared/viewManager';
 import {AudioGuidance, RouteSegment, TimeAndDistance, Waypoint} from '../types';
@@ -112,6 +112,14 @@ export const getNavigationViewController = (
       sendCommand(viewId, commands.setAudioGuidanceType, [index]);
     },
 
+    setBackgroundLocationUpdatesEnabled: (isEnabled: boolean) => {
+      if (Platform.OS == "ios") {
+        sendCommand(viewId, commands.setBackgroundLocationUpdatesEnabled,
+          [isEnabled]
+        );
+      }
+    },
+
     areTermsAccepted: async (): Promise<boolean> => {
       return await NavViewModule.areTermsAccepted();
     },

components/navigation/navigationView/navigationViewController.ts

@@ -452,6 +452,14 @@ export interface NavigationViewController {
    */
   setFollowingPerspective(perspective: CameraPerspective): void;
 
+  /**
+   * Enables location updates when the application is on the background. 
+   * Only available in iOS, it's a NO-OP for Android.
+   * 
+   * @param isEnabled - Determines whether the updates should be enabled or disabled.
+   */
+  setBackgroundLocationUpdatesEnabled(isEnabled: boolean): void;
+
   /**
    * Simulator to be used in navigation.
    */

components/navigation/navigationView/types.ts

@@ -83,6 +83,7 @@ typedef void (^OnArrayResult)(NSArray *result);
 - (void)setZoomGesturesEnabled:(BOOL)isEnabled;
 - (void)setBuildingsEnabled:(BOOL)isEnabled;
 - (void)setTrafficIncidentCardsEnabled:(BOOL)isEnabled;
+- (void)setBackgroundLocationUpdatesEnabled:(BOOL)isEnabled;
 - (void)resetMinMaxZoomLevel;
 - (void)animateCamera:(GMSCameraUpdate *)update;
 - (void)setMapStyle:(GMSMapStyle *)mapStyle;

ios/react-native-navigation-sdk/NavViewController.h

@@ -657,6 +657,10 @@ - (void)setTrafficIncidentCardsEnabled:(BOOL)isEnabled {
   _mapView.settings.showsIncidentCards = isEnabled;
 }
 
+- (void)setBackgroundLocationUpdatesEnabled:(BOOL)isEnabled {
+  _mapView.roadSnappedLocationProvider.allowsBackgroundLocationUpdates = isEnabled;
+}
+
 - (void)resetMinMaxZoomLevel {
   [_mapView setMinZoom:kGMSMinZoomLevel maxZoom:kGMSMaxZoomLevel];
 }

ios/react-native-navigation-sdk/NavViewController.m

@@ -146,6 +146,12 @@ + (BOOL)requiresMainQueueSetup {
   });
 }
 
+RCT_EXPORT_METHOD(setBackgroundLocationUpdatesEnabled : (nonnull NSNumber *)reactTag isEnabled : (BOOL)isEnabled) {
+  dispatch_async(dispatch_get_main_queue(), ^{
+    [viewController setBackgroundLocationUpdatesEnabled:isEnabled];
+  });
+}
+
 RCT_EXPORT_METHOD(startGuidance : (nonnull NSNumber *)reactTag) {
   dispatch_async(dispatch_get_main_queue(), ^{
     [viewController startGuidance];