Update HyperTrack SDK iOS to 5.5.1 and Android to 7.5.2 (#51)

Add new Geotag api with `order_handle` and `order_status`.
Add opening Github release page on release.
Run `build` recipe before the release.
Add `open-docs` and `format` recipes.

Author: pavel-kuznetsov-hypertrack

CHANGELOG.md

@@ -3,6 +3,14 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2024-04-22
+
+### Changed
+
+- New `addGeotag` and `addGeotagWithExpectedLocation` methods signature that have `orderHandle` and `orderStatus` parameters. You can use this API when users need to clock in/out of work in your app to honor their work time (see [Clock in/out Tagging](https://hypertrack.com/docs/clock-inout-tracking#add-clock-inout-events-to-a-shift-timeline) guide for more info)
+- Updated HyperTrack SDK iOS to [5.5.1](https://github.com/hypertrack/sdk-ios/releases/tag/5.5.1)
+- Updated HyperTrack SDK Android to [7.5.2](https://github.com/hypertrack/sdk-android/releases/tag/7.5.2)
+
 ## [2.1.2] - 2024-02-27
 
 ### Changed
@@ -326,3 +334,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [2.1.0]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.1.0
 [2.1.1]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.1.1
 [2.1.2]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.1.2
+[2.2.0]: https://github.com/hypertrack/sdk-flutter/releases/tag/2.2.0

android/build.gradle

@@ -43,7 +43,7 @@ android {
         disable 'InvalidPackage'
     }
     dependencies {
-        def hyperTrackVersion = "7.4.3"
+        def hyperTrackVersion = "7.5.2"
         implementation "com.hypertrack:sdk-android:${hyperTrackVersion}"
         implementation "com.hypertrack:location-services-google:${hyperTrackVersion}"
         implementation "com.hypertrack:push-service-firebase:${hyperTrackVersion}"

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

@@ -96,6 +96,10 @@ public class HyperTrackPlugin : FlutterPlugin, MethodCallHandler {
                 HyperTrackSdkWrapper.getDeviceId()
             }
 
+            SdkMethod.getDynamicPublishableKey -> {
+                throw NotImplementedError("getDynamicPublishableKey is not implemented")
+            }
+
             SdkMethod.getErrors -> {
                 HyperTrackSdkWrapper.getErrors()
             }
@@ -125,6 +129,10 @@ public class HyperTrackPlugin : FlutterPlugin, MethodCallHandler {
                 Success(NotImplemented)
             }
 
+            SdkMethod.setDynamicPublishableKey -> {
+                throw NotImplementedError("setDynamicPublishableKey is not implemented")
+            }
+
             SdkMethod.setIsAvailable -> {
                 withArgs<Unit>(call) { args ->
                     HyperTrackSdkWrapper.setIsAvailable(args)

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

@@ -1,6 +1,7 @@
 package com.hypertrack.sdk.flutter.common
 
 import android.location.Location
+import com.hypertrack.sdk.android.HyperTrack
 
 /**
  * The data that represents geotag to create
@@ -10,4 +11,6 @@ import android.location.Location
 internal data class GeotagData(
     val data: Map<String, Any?>,
     val expectedLocation: Location?,
+    val orderHandle: String?,
+    val orderStatus: HyperTrack.OrderStatus?,
 )

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

@@ -1,16 +1,16 @@
 package com.hypertrack.sdk.flutter.common
 
-import com.hypertrack.sdk.*
 import com.hypertrack.sdk.android.HyperTrack
-import com.hypertrack.sdk.android.HyperTrack.metadata
 import com.hypertrack.sdk.android.Json
 import com.hypertrack.sdk.android.Result
+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.serializeDeviceId
+import com.hypertrack.sdk.flutter.common.Serialization.serializeDynamicPublishableKey
 import com.hypertrack.sdk.flutter.common.Serialization.serializeErrors
 import com.hypertrack.sdk.flutter.common.Serialization.serializeIsAvailable
 import com.hypertrack.sdk.flutter.common.Serialization.serializeIsTracking
@@ -42,9 +42,22 @@ internal object HyperTrackSdkWrapper {
                                 longitude = it.longitude,
                             )
                         }
+                val orderHandle = geotag.orderHandle
+                val orderStatus = geotag.orderStatus
                 if (expectedLocation != null) {
-                    HyperTrack
-                        .addGeotag(geotagMetadata, expectedLocation)
+                    if (orderHandle != null || orderStatus != null) {
+                        if (orderHandle == null || orderStatus == null) {
+                            throw Error("orderHandle and orderStatus must be provided")
+                        }
+                        HyperTrack.addGeotag(
+                            orderHandle = orderHandle,
+                            orderStatus = orderStatus,
+                            expectedLocation = expectedLocation,
+                            metadata = geotagMetadata,
+                        )
+                    } else {
+                        HyperTrack.addGeotag(geotagMetadata, expectedLocation)
+                    }
                         .let {
                             when (it) {
                                 is Result.Failure -> {
@@ -57,8 +70,18 @@ internal object HyperTrackSdkWrapper {
                             }
                         }
                 } else {
-                    HyperTrack
-                        .addGeotag(geotagMetadata)
+                    if (orderHandle != null || orderStatus != null) {
+                        if (orderHandle == null || orderStatus == null) {
+                            throw Error("orderHandle and orderStatus must be provided")
+                        }
+                        HyperTrack.addGeotag(
+                            orderHandle = orderHandle,
+                            orderStatus = orderStatus,
+                            metadata = geotagMetadata,
+                        )
+                    } else {
+                        HyperTrack.addGeotag(geotagMetadata)
+                    }
                         .let { serializeLocationResult(it) }
                 }.let {
                     Success(it)
@@ -70,6 +93,10 @@ internal object HyperTrackSdkWrapper {
         return Success(serializeDeviceId(HyperTrack.deviceID))
     }
 
+    fun getDynamicPublishableKey(): WrapperResult<Serialized> {
+        return Success(serializeDynamicPublishableKey(HyperTrack.dynamicPublishableKey))
+    }
+
     fun getErrors(): WrapperResult<List<Serialized>> {
         return Success(serializeErrors(HyperTrack.errors))
     }
@@ -110,6 +137,13 @@ internal object HyperTrackSdkWrapper {
         )
     }
 
+    fun setDynamicPublishableKey(args: Serialized): WrapperResult<Unit> {
+        return deserializeDynamicPublishableKey(args)
+            .mapSuccess { publishableKey ->
+                HyperTrack.dynamicPublishableKey = publishableKey
+            }
+    }
+
     fun setIsAvailable(args: Serialized): WrapperResult<Unit> {
         return deserializeIsAvailable(args)
             .mapSuccess { isAvailable ->

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

@@ -9,13 +9,15 @@ package com.hypertrack.sdk.flutter.common
 internal enum class SdkMethod {
     addGeotag,
     getDeviceID,
+    getDynamicPublishableKey,
     getErrors,
     getIsAvailable,
     getIsTracking,
     getLocation,
     getMetadata,
     getName,
     locate,
+    setDynamicPublishableKey,
     setIsAvailable,
     setIsTracking,
     setMetadata,