Add Allow mock location methods (#66)

Update HyperTrack SDK iOS to 5.10.0 and Android to 7.10.0.
Adapt project to Gradle 8.

Author: pavel-kuznetsov-hypertrack

CHANGELOG.md

@@ -5,6 +5,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.7.0] - 2025-01-21
+
+### Added
+
+- New `HyperTrack.allowMockLocation` and `HyperTrack.setAllowMockLocation()` methods which can be used to allow mocking location data.
+  - Check the [Test with mock locations](https://hypertrack.com/docs/mock-location) guide for more information.
+    - Note: To avoid issues related to race conditions in your code use this API **only if** modifying the compiled `HyperTrackAllowMockLocation` AndroidManifest.xml/Info.plist value is insufficient for your needs.
+      - Example: if for some reason you aren't able to recompile with `HyperTrackAllowMockLocation` set to `YES`/`true` for your prod app QA mock location tests and need to set up the value in runtime.
+- Gradle 8 support
+
+### Changed
+
+- Updated HyperTrack SDK iOS to [5.10.0](https://github.com/hypertrack/sdk-ios/releases/tag/5.10.0)
+- Updated HyperTrack SDK Android to [7.10.0](https://github.com/hypertrack/sdk-android/releases/tag/7.10.0)
+
 ## [2.6.1] - 2024-12-05
 
 ### Changed
@@ -486,3 +501,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [2.5.2]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.5.2
 [2.6.0]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.6.0
 [2.6.1]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.6.1
+[2.7.0]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.7.0

android/build.gradle

@@ -31,6 +31,7 @@ apply plugin: 'kotlin-android'
 
 android {
     compileSdkVersion 31
+    namespace "com.hypertrack.sdk.flutter"
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -43,7 +44,7 @@ android {
         disable 'InvalidPackage'
     }
     dependencies {
-        def hyperTrackVersion = "7.9.1"
+        def hyperTrackVersion = "7.10.0"
         implementation "com.hypertrack:sdk-android:${hyperTrackVersion}"
         implementation "com.hypertrack:activity-service-google:${hyperTrackVersion}"
         implementation "com.hypertrack:location-services-google:${hyperTrackVersion}"

android/src/main/kotlin/com/hypertrack/sdk/flutter/HyperTrackPlugin.kt

@@ -100,6 +100,10 @@ public class HyperTrackPlugin :
                 }
             }
 
+            SdkMethod.getAllowMockLocation -> {
+                HyperTrackSdkWrapper.getAllowMockLocation()
+            }
+
             SdkMethod.getDeviceID -> {
                 HyperTrackSdkWrapper.getDeviceId()
             }
@@ -145,6 +149,12 @@ public class HyperTrackPlugin :
                 Success(NotImplemented)
             }
 
+            SdkMethod.setAllowMockLocation -> {
+                withArgs<Unit>(call) { args ->
+                    HyperTrackSdkWrapper.setAllowMockLocation(args)
+                }
+            }
+
             SdkMethod.setDynamicPublishableKey -> {
                 throw NotImplementedError("setDynamicPublishableKey is not implemented")
             }

android/src/main/kotlin/com/hypertrack/sdk/flutter/common/HyperTrackSdkWrapper.kt

@@ -3,13 +3,15 @@ package com.hypertrack.sdk.flutter.common
 import com.hypertrack.sdk.android.HyperTrack
 import com.hypertrack.sdk.android.Json
 import com.hypertrack.sdk.android.Result
+import com.hypertrack.sdk.flutter.common.Serialization.deserializeAllowMockLocation
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeDynamicPublishableKey
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeGeotagData
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeIsAvailable
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeIsTracking
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeMetadata
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeName
 import com.hypertrack.sdk.flutter.common.Serialization.deserializeWorkerHandle
+import com.hypertrack.sdk.flutter.common.Serialization.serializeAllowMockLocation
 import com.hypertrack.sdk.flutter.common.Serialization.serializeDeviceId
 import com.hypertrack.sdk.flutter.common.Serialization.serializeDynamicPublishableKey
 import com.hypertrack.sdk.flutter.common.Serialization.serializeErrors
@@ -89,6 +91,8 @@ internal object HyperTrackSdkWrapper {
                 }
             }
 
+    fun getAllowMockLocation(): WrapperResult<Serialized> = Success(serializeAllowMockLocation(HyperTrack.allowMockLocation))
+
     fun getDeviceId(): WrapperResult<Serialized> = Success(serializeDeviceId(HyperTrack.deviceID))
 
     fun getDynamicPublishableKey(): WrapperResult<Serialized> = Success(serializeDynamicPublishableKey(HyperTrack.dynamicPublishableKey))
@@ -135,6 +139,12 @@ internal object HyperTrackSdkWrapper {
             serializeWorkerHandle(HyperTrack.workerHandle),
         )
 
+    fun setAllowMockLocation(args: Serialized): WrapperResult<Unit> =
+        deserializeAllowMockLocation(args)
+            .mapSuccess { allowMockLocation ->
+                HyperTrack.allowMockLocation = allowMockLocation
+            }
+
     fun setDynamicPublishableKey(args: Serialized): WrapperResult<Unit> =
         deserializeDynamicPublishableKey(args)
             .mapSuccess { publishableKey ->

android/src/main/kotlin/com/hypertrack/sdk/flutter/common/SdkMethod.kt

@@ -8,6 +8,7 @@ package com.hypertrack.sdk.flutter.common
  */
 internal enum class SdkMethod {
     addGeotag,
+    getAllowMockLocation,
     getDeviceID,
     getDynamicPublishableKey,
     getErrors,
@@ -19,6 +20,7 @@ internal enum class SdkMethod {
     getOrders,
     getWorkerHandle,
     locate,
+    setAllowMockLocation,
     setDynamicPublishableKey,
     setIsAvailable,
     setIsTracking,

android/src/main/kotlin/com/hypertrack/sdk/flutter/common/Serialization.kt

@@ -9,6 +9,14 @@ import com.hypertrack.sdk.android.Result
  * to Map<String, T> or List<T> where T is any JSON-compatible type
  */
 internal object Serialization {
+    fun deserializeAllowMockLocation(allowMockLocation: Serialized): WrapperResult<Boolean> =
+        parse(allowMockLocation) {
+            it.assertValue<String>(key = KEY_TYPE, value = TYPE_ALLOW_MOCK_LOCATION)
+            it
+                .get<Boolean>(KEY_VALUE)
+                .getOrThrow()
+        }
+
     fun deserializeDynamicPublishableKey(args: Serialized): WrapperResult<String> =
         parse(args) {
             it.assertValue<String>(key = KEY_TYPE, value = TYPE_DYNAMIC_PUBLISHABLE_KEY)
@@ -89,6 +97,12 @@ internal object Serialization {
                 .getOrThrow()
         }
 
+    fun serializeAllowMockLocation(allowMockLocation: Boolean): Serialized =
+        mapOf(
+            KEY_TYPE to TYPE_ALLOW_MOCK_LOCATION,
+            KEY_VALUE to allowMockLocation,
+        )
+
     fun serializeDeviceId(deviceId: String): Serialized =
         mapOf(
             KEY_TYPE to TYPE_DEVICE_ID,
@@ -159,8 +173,7 @@ internal object Serialization {
             }
         }
 
-    fun serializeLocationErrorFailure(locationError: HyperTrack.LocationError): Serialized =
-        serializeFailure(serializeLocationError(locationError))
+    fun serializeLocationErrorFailure(locationError: HyperTrack.LocationError): Serialized = serializeFailure(serializeLocationError(locationError))
 
     fun serializeLocationSuccess(location: HyperTrack.Location): Serialized = serializeSuccess(serializeLocation(location))
 
@@ -405,6 +418,7 @@ internal object Serialization {
     private const val TYPE_RESULT_FAILURE = "failure"
     private const val TYPE_RESULT_SUCCESS = "success"
 
+    private const val TYPE_ALLOW_MOCK_LOCATION = "allowMockLocation"
     private const val TYPE_DEVICE_ID = "deviceID"
     private const val TYPE_DYNAMIC_PUBLISHABLE_KEY = "dynamicPublishableKey"
     private const val TYPE_ERROR = "error"

docs/__404error.html

@@ -4,15 +4,14 @@
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
-  <meta name="generator" content="made with love by dartdoc 6.0.0">
   <meta name="description" content="hypertrack_plugin API docs, for the Dart programming language.">
   <title>hypertrack_plugin - Dart API docs</title>
 
 
 
   <link rel="preconnect" href="https://fonts.gstatic.com">
   <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
 
   <link rel="stylesheet" href="static-assets/github.css?v1">
   <link rel="stylesheet" href="static-assets/styles.css?v1">
@@ -22,24 +21,33 @@
 </head>
 
 
-<body data-base-href="" data-using-base-href="false">
+<body data-base-href="" data-using-base-href="false" class="light-theme">
 
 <div id="overlay-under-drawer"></div>
 
 <header id="title">
-  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="https://www.hypertrack.com/">hypertrack_plugin package</a></li>
   </ol>
   <div class="self-name">hypertrack_plugin</div>
   <form class="search navbar-right" role="search">
     <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
   </form>
+  <div class="toggle" id="theme-button" title="Toggle brightness">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span id="dark-theme-button" class="material-symbols-outlined">
+        dark_mode
+      </span>
+      <span id="light-theme-button" class="material-symbols-outlined">
+        light_mode
+      </span>
+    </label>
+  </div>
 </header>
-
 <main>
 
-
   <div id="dartdoc-main-content" class="main-content">
     <h1>404: Something's gone wrong :-(</h1>
 
@@ -56,29 +64,30 @@ <h1>404: Something's gone wrong :-(</h1>
   </div> <!-- /.main-content -->
 
   <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
-    <header id="header-search-sidebar" class="hidden-l">
+    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
+<header id="header-search-sidebar" class="hidden-l">
   <form class="search-sidebar" role="search">
     <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
   </form>
 </header>
 
 <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
-  <li><a href="https://www.hypertrack.com/">hypertrack_plugin package</a></li>
+    <li><a href="https://www.hypertrack.com/">hypertrack_plugin package</a></li>
 </ol>
 
 
     <h5><span class="package-name">hypertrack_plugin</span> <span class="package-kind">package</span></h5>
     <ol>
       <li class="section-title">Libraries</li>
+      <li><a href="data_types_hypertrack_error/data_types_hypertrack_error-library.html">data_types/hypertrack_error</a></li>
+      <li><a href="data_types_json/data_types_json-library.html">data_types/json</a></li>
+      <li><a href="data_types_location/data_types_location-library.html">data_types/location</a></li>
+      <li><a href="data_types_location_error/data_types_location_error-library.html">data_types/location_error</a></li>
+      <li><a href="data_types_location_with_deviation/data_types_location_with_deviation-library.html">data_types/location_with_deviation</a></li>
+      <li><a href="data_types_order/data_types_order-library.html">data_types/order</a></li>
+      <li><a href="data_types_order_status/data_types_order_status-library.html">data_types/order_status</a></li>
+      <li><a href="data_types_result/data_types_result-library.html">data_types/result</a></li>
       <li><a href="hypertrack/hypertrack-library.html">hypertrack</a></li>
-      <li><a href="data_types_hypertrack_error/data_types_hypertrack_error-library.html">hypertrack_error</a></li>
-      <li><a href="data_types_json/data_types_json-library.html">json</a></li>
-      <li><a href="data_types_location/data_types_location-library.html">location</a></li>
-      <li><a href="data_types_location_error/data_types_location_error-library.html">location_error</a></li>
-      <li><a href="data_types_location_with_deviation/data_types_location_with_deviation-library.html">location_with_deviation</a></li>
-      <li><a href="data_types_order/data_types_order-library.html">order</a></li>
-      <li><a href="data_types_order_status/data_types_order_status-library.html">order_status</a></li>
-      <li><a href="data_types_result/data_types_result-library.html">result</a></li>
 </ol>
 
   </div>
@@ -91,7 +100,7 @@ <h5><span class="package-name">hypertrack_plugin</span> <span class="package-kin
 <footer>
   <span class="no-break">
     hypertrack_plugin
-      2.6.1
+      2.7.0
   </span>