feat: update driver and navigation sdk dependencies (#27)

* feat: update driver and navigation sdk dependencies

* chore: fix LMFS backend by downgrading fleetengine package

Author: jokerttu

.gitignore

@@ -29,6 +29,7 @@ DerivedData
 *.xcuserstate
 project.xcworkspace
 .xcode.env.local
+Keys.plist
 
 # Android/IJ
 #

CHANGELOG.md

@@ -0,0 +1,11 @@
+## [0.3.0](https://github.com/googlemaps/react-native-driver-sdk/compare/0.2.0-beta...0.3.0) (2024-11-04)
+
+- feat: support latest navigation sdk library and Driver SDK's
+
+## [0.2.0-beta](https://github.com/googlemaps/react-native-driver-sdk/compare/0.1.0-beta...0.2.0-beta) (2024-08-21)
+
+- feat: support latest navigation sdk library
+
+## [0.1.0-beta](https://github.com/googlemaps/react-native-driver-sdk/releases/tag/0.1.0-beta) (2024-05-17)
+
+- Initial release

README.md

@@ -6,9 +6,9 @@ This is the beta release of the Google Driver SDK package for React Native. It i
 
 ## Requirements
 
-|             | Android | iOS       |
-| ----------- | ------- | --------- |
-| **Support** | SDK 23+ | iOS 14.0+ |
+|                                 | Android | iOS       |
+| ------------------------------- | ------- | --------- |
+| **Minimum mobile OS supported** | SDK 23+ | iOS 15.0+ |
 
 * A React Native project
 * A Google Cloud project with the [Navigation SDK enabled](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project) and the [Maps SDK for iOS enabled](https://developers.google.com/maps/documentation/navigation/ios-sdk/config)

android/build.gradle

@@ -15,13 +15,15 @@
 import groovy.json.JsonSlurper
 
 buildscript {
+    ext.kotlin_version = '2.0.0'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath("com.android.tools.build:gradle:7.2.1")
+        classpath("com.android.tools.build:gradle:8.4.0")
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
 
@@ -83,7 +85,7 @@ repositories {
 }
 
 dependencies {
-  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-driver:5.0.0'
+  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-driver:5.99.0'
   implementation 'com.facebook.react:react-native:+'
   implementation 'com.android.support:multidex:1.0.3'
   implementation 'androidx.constraintlayout:constraintlayout:2.1.4'

example/LMFS/README.md

@@ -6,27 +6,49 @@ This is a sample application that show cases developers how to integrate with th
 
 ## Prerequisites
 
-1. This library depends on the LMFS backend available in https://github.com/googlemaps/last-mile-fleet-solution-samples/tree/main/backend.
-This package provides docker-compose files to run the backend services at `/example/tools/backend` folder. For more information, please refer to the [README](../tools/backend/README.md) file in the tools/backend folder of the example app.
+1. This library depends on the LMFS backend available in https://github.com/googlemaps/last-mile-fleet-solution-samples/tree/main/backend. This package provides docker-compose files to run the backend services at `/example/tools/backend` folder. For more information, please refer to the [README](../tools/backend/README.md) file in the tools/backend folder of the example app.
+2. Once the backend is setup, create a delivery vehicle and keep the vehicleId handy. In order to make it easier to create vehicles with tasks, you can use the `/upload-delivery-config.html` endpoint on the backend. [example json](https://raw.githubusercontent.com/googlemaps/last-mile-fleet-solution-samples/main/backend/src/test/resources/test.json)
+3. Go to the [App.tsx](/example/LMFS/src/App.tsx) file and update the VEHICLE_ID from the endpoint response.
 
-1. Once the backend is setup, create a delivery vehicle and keep the vehicleId handy. In order to make it easier to create vehicles with tasks, you can use the `/upload-delivery-config.html` endpoint on the backend. [example json](https://raw.githubusercontent.com/googlemaps/last-mile-fleet-solution-samples/main/backend/src/test/resources/test.json)
-2. Go to the [App.tsx](/example/LMFS/App.tsx) file and update the VEHICLE_ID from the endpoint response.
+## Setup
 
-## How to run application
+### Android
 
-1. Run `yarn install` from the current directory.
+1. Run `yarn install` in repository root directory.
+2. Open the `example/LMFS/android` folder in Android Studio and add your api key in local.properties by adding a line like this:
 
-1. Go to the [ios](./ios) folder and run `pod install`.
+   - `MAPS_API_KEY=YOUR_API_KEY` - make sure that this key is pointing to a Google Cloud project which had Nav SDK enabled.
+   - To enable Nav SDK in your Android project follow this guide: https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project
 
-1. Come back to the current directory.
+### iOS
 
-1. Then you can use `yarn run react-native run-android` or `yarn run react-native run-ios` depending the platform.
+1. Run `yarn install` in repository root directory.
+2. To enable Nav SDK in your iOS project follow this guide: https://developers.google.com/maps/documentation/navigation/ios-sdk/config
+3. Go to the [ios](./ios) folder and run `pod install`.
+4. Copy the `Keys.plist.sample` file located in `example/LMFS/ios/SampleApp/` to a new file named `Keys.plist`. This file is git ignored and won't be accidentally committed. In your Google cloud console, add the Google API key to the project and add this newly created API key to the `Keys.plist` file.
+
+   ```xml
+   <key>API_KEY</key>
+   <string>Your API KEY</string>
+   ```
+
+## Running the app
+
+Use `yarn run react-native run-android` or `yarn run react-native run-ios` depending the platform.
 
 ## Debugging Fleet engine logs
 
+### Fetch fleet engine logs via the console
+
 To make sure that location updates are propagating properly, you can use Fleet Engine logs.
 
 1. Go to https://console.cloud.google.com/ and select the relevant project.
 1. Open the "Logs Explorer".
 1. Run Query `jsonPayload.request.deliveryVehicleId="vehicle_id"` and `jsonPayload.@type="type.googleapis.com/maps.fleetengine.v1.UpdateDeliveryVehicleLog"`.
-1. This will show the location updates sent through the library.
+1. This will show the location updates sent through the library.
+
+### Use fleet tracking at the sample backend
+
+1. Make sure the backend is running by following steps at [README](../tools/backend/README.md).
+2. Open Fleet Tracking at http://localhost:8091/fleet_tracking.html (or the port you have configured in your .env file).
+3. Enter the vehicleId and see the location updates on the map.

example/LMFS/ios/Podfile

@@ -10,7 +10,7 @@ end
 node_require('react-native/scripts/react_native_pods.rb')
 node_require('react-native-permissions/scripts/setup.rb')
 
-platform :ios, "14.0"
+platform :ios, "15.0"
 prepare_react_native_project!
 
 setup_permissions([

example/LMFS/ios/SampleApp.xcodeproj/project.pbxproj

@@ -12,6 +12,7 @@
 		13B07FBC1A68108700A75B9A /* AppDelegate.mm in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB01A68108700A75B9A /* AppDelegate.mm */; };
 		13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 13B07FB51A68108700A75B9A /* Images.xcassets */; };
 		13B07FC11A68108700A75B9A /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB71A68108700A75B9A /* main.m */; };
+		52D1CA992CD4ED8D0020709E /* Keys.plist in Resources */ = {isa = PBXBuildFile; fileRef = 52D1CA982CD4ED8D0020709E /* Keys.plist */; };
 		7699B88040F8A987B510C191 /* libPods-SampleApp-SampleAppTests.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 19F6CBCC0A4E27FBF8BF4A61 /* libPods-SampleApp-SampleAppTests.a */; };
 		81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 81AB9BB72411601600AC10FF /* LaunchScreen.storyboard */; };
 		E72EC806AB287A94E8141AD5 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = E049A7A79160D0D74CDA8CD1 /* PrivacyInfo.xcprivacy */; };
@@ -40,6 +41,7 @@
 		13B07FB81A68108700A75B9A /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = PrivacyInfo.xcprivacy; path = SampleApp/PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		19F6CBCC0A4E27FBF8BF4A61 /* libPods-SampleApp-SampleAppTests.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-SampleApp-SampleAppTests.a"; sourceTree = BUILT_PRODUCTS_DIR; };
 		3B4392A12AC88292D35C810B /* Pods-SampleApp.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleApp.debug.xcconfig"; path = "Target Support Files/Pods-SampleApp/Pods-SampleApp.debug.xcconfig"; sourceTree = "<group>"; };
+		52D1CA982CD4ED8D0020709E /* Keys.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Keys.plist; sourceTree = "<group>"; };
 		5709B34CF0A7D63546082F79 /* Pods-SampleApp.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleApp.release.xcconfig"; path = "Target Support Files/Pods-SampleApp/Pods-SampleApp.release.xcconfig"; sourceTree = "<group>"; };
 		5B7EB9410499542E8C5724F5 /* Pods-SampleApp-SampleAppTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleApp-SampleAppTests.debug.xcconfig"; path = "Target Support Files/Pods-SampleApp-SampleAppTests/Pods-SampleApp-SampleAppTests.debug.xcconfig"; sourceTree = "<group>"; };
 		5DCACB8F33CDC322A6C60F78 /* libPods-SampleApp.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-SampleApp.a"; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -93,6 +95,7 @@
 				13B07FB01A68108700A75B9A /* AppDelegate.mm */,
 				13B07FB51A68108700A75B9A /* Images.xcassets */,
 				13B07FB61A68108700A75B9A /* Info.plist */,
+				52D1CA982CD4ED8D0020709E /* Keys.plist */,
 				81AB9BB72411601600AC10FF /* LaunchScreen.storyboard */,
 				13B07FB71A68108700A75B9A /* main.m */,
 				13B07FB81A68108700A75B9A /* PrivacyInfo.xcprivacy */,
@@ -246,6 +249,7 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				52D1CA992CD4ED8D0020709E /* Keys.plist in Resources */,
 				81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */,
 				13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */,
 				E72EC806AB287A94E8141AD5 /* PrivacyInfo.xcprivacy in Resources */,

example/LMFS/ios/SampleApp/AppDelegate.mm

@@ -26,10 +26,16 @@ - (BOOL)application:(UIApplication *)application
   // You can add your custom initial props in the dictionary below.
   // They will be passed down to the ViewController used by React Native.
   self.initialProps = @{};
-  NSString *api_key =
-      [[NSBundle mainBundle] objectForInfoDictionaryKey:@"API_KEY"];
+  
+  // Note: Ensure that you have copied the Keys.plist.sample to Keys.plist
+  // and have added the correct API_KEY value to the file.
+  //
+  // Get the path for the Keys.plist file in the main bundle and read API_KEY.
+  NSString *path = [[NSBundle mainBundle] pathForResource:@"Keys" ofType:@"plist"];
+  NSDictionary *keysDictionary = [NSDictionary dictionaryWithContentsOfFile:path];
+  NSString *api_key = [keysDictionary objectForKey:@"API_KEY"];
+
   [GMSServices provideAPIKey:api_key];
-  [GMSServices setMetalRendererEnabled:YES];
   return [super application:application
       didFinishLaunchingWithOptions:launchOptions];
 }

example/LMFS/ios/SampleApp/Info.plist

@@ -2,8 +2,6 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-	<key>API_KEY</key>
-	<string>[Add your key]</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleDisplayName</key>

example/LMFS/ios/SampleApp/Keys.plist.sample

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>API_KEY</key>
+	<string>[Add your key]</string>
+</dict>
+</plist>