Add HyperTrack.allowMockLocation (#47)

Update HyperTrack SDK iOS to 5.10.0 and Android to 7.10.0

Author: pavel-kuznetsov-hypertrack

CHANGELOG.md

@@ -5,6 +5,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.8.0] - 2025-01-17
+
+### Added
+
+- New `HyperTrack.getAllowMockLocation()` 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.
+
+### 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)
+
 ## [3.7.1] - 2024-12-05
 
 ### Changed
@@ -333,3 +347,4 @@ We are excited to announce the release of HyperTrack Ionic Capacitor SDK 2.0.0,
 [3.6.3]: https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/3.6.3
 [3.7.0]: https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/3.7.0
 [3.7.1]: https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/3.7.1
+[3.8.0]: https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/3.8.0

HypertrackSdkIonicCapacitor.podspec

@@ -14,5 +14,5 @@ Pod::Spec.new do |s|
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
-  s.dependency 'HyperTrack','5.9.1'
+  s.dependency 'HyperTrack','5.10.0'
 end

README.md

@@ -2,8 +2,8 @@
 
 [![GitHub](https://img.shields.io/github/license/hypertrack/sdk-ionic-capacitor.svg?color=orange)](./LICENSE)
 [![npm](https://img.shields.io/npm/v/hypertrack-sdk-ionic-capacitor.svg)](https://www.npmjs.com/package/hypertrack-sdk-ionic-capacitor)
-[![iOS SDK](https://img.shields.io/badge/iOS%20SDK-5.9.1-brightgreen.svg)](https://github.com/hypertrack/sdk-ios)
-[![Android SDK](https://img.shields.io/badge/Android%20SDK-7.9.1-brightgreen.svg)](https://github.com/hypertrack/sdk-android)
+[![iOS SDK](https://img.shields.io/badge/iOS%20SDK-5.10.0-brightgreen.svg)](https://github.com/hypertrack/sdk-ios)
+[![Android SDK](https://img.shields.io/badge/Android%20SDK-7.10.0-brightgreen.svg)](https://github.com/hypertrack/sdk-android)
 
 [HyperTrack](https://www.hypertrack.com) lets you add live location tracking to your mobile app. Live location is made available along with ongoing activity, tracking controls and tracking outage with reasons.
 

android/build.gradle

@@ -7,7 +7,7 @@ ext {
 
 buildscript {
     ext.kotlin_version = project.hasProperty('kotlin_version') ? rootProject.ext.kotlin_version : '1.9.10'
-    ext.hypertrack_sdk_version = "7.9.1"
+    ext.hypertrack_sdk_version = "7.10.0"
     ext.firebase_messaging_version = "23.1.1"
 
     repositories {

android/src/main/java/com/hypertrack/sdk/capacitor/HyperTrackCapacitorPlugin.kt

@@ -25,6 +25,11 @@ class HyperTrackCapacitorPlugin : Plugin() {
         invokeSdkMethod(SdkMethod.addGeotag, call).toPluginCall(call)
     }
 
+    @PluginMethod
+    fun getAllowMockLocation(call: PluginCall) {
+        invokeSdkMethod(SdkMethod.getAllowMockLocation, call).toPluginCall(call)
+    }
+
     @PluginMethod
     fun getDeviceId(call: PluginCall) {
         invokeSdkMethod(SdkMethod.getDeviceID, call).toPluginCall(call)
@@ -70,6 +75,11 @@ class HyperTrackCapacitorPlugin : Plugin() {
         invokeSdkMethod(SdkMethod.getWorkerHandle, call).toPluginCall(call)
     }
 
+    @PluginMethod
+    fun setAllowMockLocation(call: PluginCall) {
+        invokeSdkMethod(SdkMethod.setAllowMockLocation, call).toPluginCall(call)
+    }
+
     @PluginMethod
     fun setIsAvailable(call: PluginCall) {
         invokeSdkMethod(SdkMethod.setIsAvailable, call).toPluginCall(call)
@@ -205,6 +215,10 @@ class HyperTrackCapacitorPlugin : Plugin() {
                 }
             }
 
+            SdkMethod.getAllowMockLocation -> {
+                HyperTrackSdkWrapper.getAllowMockLocation()
+            }
+
             SdkMethod.getDeviceID -> {
                 HyperTrackSdkWrapper.getDeviceId()
             }
@@ -254,6 +268,12 @@ class HyperTrackCapacitorPlugin : Plugin() {
                 throw NotImplementedError("Locate is implemented in different way")
             }
 
+            SdkMethod.setAllowMockLocation -> {
+                withArgs<Map<String, Any?>, Unit>(argsJson) { args ->
+                    HyperTrackSdkWrapper.setAllowMockLocation(args)
+                }
+            }
+
             SdkMethod.setDynamicPublishableKey -> {
                 throw Error("Not implemented")
             }

android/src/main/java/com/hypertrack/sdk/capacitor/common/HyperTrackSdkWrapper.kt

@@ -3,13 +3,15 @@ package com.hypertrack.sdk.capacitor.common
 import com.hypertrack.sdk.android.HyperTrack
 import com.hypertrack.sdk.android.Json
 import com.hypertrack.sdk.android.Result
+import com.hypertrack.sdk.capacitor.common.Serialization.deserializeAllowMockLocation
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeDynamicPublishableKey
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeGeotagData
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeIsAvailable
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeIsTracking
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeMetadata
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeName
 import com.hypertrack.sdk.capacitor.common.Serialization.deserializeWorkerHandle
+import com.hypertrack.sdk.capacitor.common.Serialization.serializeAllowMockLocation
 import com.hypertrack.sdk.capacitor.common.Serialization.serializeDeviceId
 import com.hypertrack.sdk.capacitor.common.Serialization.serializeDynamicPublishableKey
 import com.hypertrack.sdk.capacitor.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/java/com/hypertrack/sdk/capacitor/common/SdkMethod.kt

@@ -8,6 +8,7 @@ package com.hypertrack.sdk.capacitor.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/java/com/hypertrack/sdk/capacitor/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,
@@ -405,6 +419,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"