Skip to content

CHANGELOG.md

Latest commit

 

History

History
402 lines (265 loc) · 15.6 KB

CHANGELOG.md

File metadata and controls

402 lines (265 loc) · 15.6 KB

Changelog

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

4.0.5 - 2025-09-30

Changed

  • Updated HyperTrack SDK Android to 7.12.0

4.0.4 - 2025-07-23

Changed

  • Migrated to Capacitor 7
  • Updated HyperTrack SDK iOS to 5.11.3
  • Updated HyperTrack SDK Android to 7.11.4

4.0.3 - 2025-03-06

Changed

  • Updated HyperTrack SDK iOS to 5.11.2
  • Updated HyperTrack SDK Android to 7.11.3

4.0.2 - 2025-03-04

Changed

  • Updated HyperTrack SDK iOS to 5.11.1
  • Updated HyperTrack SDK Android to 7.11.2

4.0.1 - 2025-02-05

Fixed

  • Error on HyperTrack.getOrders()/HyperTrack.subscribeToOrders() on Android when assigning multiple orders to the worker

4.0.0 - 2025-02-03

Changed

  • Order.isInsideGeofence is now an async fuction that returns the value at the moment when it called (instead of the constant value at the time of getOrders being called)
  • Updated HyperTrack SDK iOS to 5.11.0
  • Updated HyperTrack SDK Android to 7.11.0

Fixed

  • Wrong order of Orders in HyperTrack.getOrders() on iOS

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 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
  • Updated HyperTrack SDK Android to 7.10.0

3.7.1 - 2024-12-05

Changed

  • Updated HyperTrack SDK iOS to 5.9.1
  • Updated HyperTrack SDK Android to 7.9.1

3.7.0 - 2024-11-22

Changed

  • Updated HyperTrack SDK iOS to 5.9.0
  • Updated HyperTrack SDK Android to 7.9.0

3.6.3 - 2024-11-13

Changed

  • Updated HyperTrack SDK iOS to 5.8.1
  • Updated HyperTrack SDK Android to 7.8.4

3.6.2 - 2024-09-24

Changed

  • Updated HyperTrack SDK Android to 7.8.3

3.6.1 - 2024-09-18

Changed

  • Updated HyperTrack SDK Android to 7.8.2

3.6.0 - 2024-09-04

Added

  • Support for Motion & Activity detection
    • If your app asks for the Motion & Activity permission (for iOS) or the Activity Recognition permission (for Android) and the user grants it, you will have better activity detection in polylines

Changed

  • Updated HyperTrack SDK iOS to 5.8.0
  • Updated HyperTrack SDK Android to 7.8.0

3.5.1 - 2024-08-28

Fixed

  • Serialization bug for Order.isInsideGeofence success case on iOS

3.5.0 - 2024-08-22

Added

  • Support for on-device geofencing via new HyperTrack.orders.get("my_order_handle").isInsideGeofence property

Example use for worker clock in:

// check worker presence synchronously
let activeOrders = await HyperTrack.getOrders()
let currentOrder = activeOrders.get("current_order")
if (currentOrder !== undefined) { handlePresence(currentOrder) }
else { console.log("'current_order' not found") }

// or subscribe to the changes in orders to get the status updates
HyperTrack.subscribeToOrders(orders => {
  let let currentOrder = activeOrders.get("current_order")
  if (currentOrder !== undefined) { handlePresence(currentOrder) }
  else { console.log("'current_order' not found") }
})

// handle worker presence inside the order destination geofence
function handlePresence(isInsideGeofence: Result<boolean, LocationError>) {
  switch (isInsideGeofence.type) {
    case 'success':
      if (isInsideGeofence.value) {
        // allow worker to clock in for the shift
      } else {
        // "to clock in you must be at order destination"
      }
      break;
    case 'failure':
      // resolve errors to check for presence
      break;
  }
}

Changed

  • Updated HyperTrack SDK iOS to 5.7.0
  • Updated HyperTrack SDK Android to 7.7.0

3.4.0 - 2024-06-13

Added

  • New setWorkerHandle and getWorkerHandle can be used to identify workers
    • We observed our customers identify worker devices via HyperTrack.metadata, so we decided to make it a first class citizen in our API.
    • If you previously used metadata to identify workers, we suggest using workerHandle for this purpose instead.

Changed

  • Updated HyperTrack SDK iOS to 5.6.0
  • Updated HyperTrack SDK Android to 7.6.0

3.3.1 - 2024-05-24

Changed

  • Updated HyperTrack SDK Android to 7.5.5

3.3.0 - 2024-05-13

Added

  • Now the plugin takes into account project's kotlin_version to align Kotlin versions.

Changed

  • Default Kotlin version is updated to 1.9.10
  • Updated HyperTrack SDK iOS to 5.5.4
  • Updated HyperTrack SDK Android to 7.5.4

Removed

  • @capacitor/core item in peerDependencies

3.2.2 - 2024-05-03

Changed

  • Updated HyperTrack SDK iOS to 5.5.3

3.2.1 - 2024-04-23

Changed

  • Updated HyperTrack SDK iOS to 5.5.2
  • Updated HyperTrack SDK Android to 7.5.3

3.2.0 - 2024-04-19

Added

  • New addGeotag method 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 guide for more info)

Fixed

  • Added kotlinOptions.jvmTarget to fix the build error when updating to Gradle 8 and setting compileOptions.targetCompatibility to 17

Changed

  • Updated HyperTrack SDK iOS to 5.5.1
  • Updated HyperTrack SDK Android to 7.5.2

3.1.3 - 2024-02-26

Changed

  • Updated HyperTrack SDK Android to 7.4.3

3.1.2 - 2024-02-15

Changed

  • Updated HyperTrack SDK iOS to 5.4.1
  • Updated HyperTrack SDK Android to 7.4.2

3.1.1 - 2024-02-12

Changed

  • Updated HyperTrack SDK iOS to 5.4.1
  • Updated HyperTrack SDK Android to 7.4.1

3.1.0 - 2024-01-31

Changed

  • Updated HyperTrack SDK iOS to 5.4.0
  • Updated HyperTrack SDK Android to 7.4.0

3.0.2 - 2024-01-18

Changed

  • Updated HyperTrack SDK Android to 7.2.0
  • Updated HyperTrack SDK iOS to 5.2.0

Fixed

  • Set @capacitor/core version to ^5.0.0 in peerDependencies to fix compatibility with older 5.x.x versions

3.0.1 - 2023-12-20

Fixed

  • Wrong @capacitor/core version in peerDependencies

3.0.0 - 2023-12-20

Changed

  • Updated Ionic to v5
  • Updated HyperTrack SDK Android to 7.0.11
  • Updated HyperTrack SDK iOS to 5.0.8

2.0.2 - 2023-11-23

Changed

  • Updated HyperTrack SDK Android to 7.0.9
  • Updated HyperTrack SDK iOS to 5.0.7

2.0.1 - 2023-11-10

Changed

  • Updated HyperTrack SDK Android to 7.0.8
  • Updated HyperTrack SDK iOS to 5.0.6

2.0.0 - 2023-10-27

We are excited to announce the release of HyperTrack Ionic Capacitor SDK 2.0.0, a major update to our location tracking SDK. This release ensures highest tracking performance, reduces deployed app sizes and comes with an improved API to simplify the integrations. We highly recommend upgrading, but please note that there are a few breaking changes.

Changed

  • Updated HyperTrack SDK Android to 7.0.6
  • Added Android SDK plugins (location-services-google and push-service-firebase)
  • Updated HyperTrack SDK iOS to 5.0.4
  • The whole HyperTrack API is now static
  • Changed the way to provide publishableKey (you need to add HyperTrackPublishableKey meta-data item to your AndroidManifest.xml)
  • Renamed HyperTrackError types:
    • gpsSignalLost to locationSignalLost
    • locationPermissionsDenied to permissionsLocationDenied
    • locationPermissionsInsufficientForBackground to permissionsLocationInsufficientForBackground
    • locationPermissionsNotDetermined to permissionsLocationNotDetermined
    • locationPermissionsProvisional to locationPermissionsProvisional
    • locationPermissionsReducedAccuracy to permissionsLocationReducedAccuracy
    • locationPermissionsRestricted to permissionsLocationRestricted
  • Renamed isAvailable() to getIsAvailable()
  • Renamed isTracking() to getIsTracking()
  • Renamed setAvailability() to setIsAvailable(boolean)
  • Changed startTracking() and stopTracking() to setIsTracking(boolean)
  • Renamed subscribeToTracking() to subscribeToIsTracking()
  • Renamed subscribeToAvailability() to subscribeToIsAvailable()
  • Changed getLocation() response to Result<Location, LocationError>

Added

  • locate() to ask for one-time user location
  • subscribeToLocation() to subscribe to user location updates
  • getErrors()
  • getName()
  • getMetadata()
  • HyperTrackError types:
    • noExemptionFromBackgroundStartRestrictions
    • permissionsNotificationsDenied

Removed

  • initialize() method (the API is now static)
  • SdkInitParams (the config now should be done with the AndroidManifest metadata and Info.plist)
  • Motion Activity permissions are not required for tracking anymore
  • HyperTrackError types:
    • motionActivityPermissionsDenied
    • motionActivityServicesDisabled
    • motionActivityServicesUnavailable
    • motionActivityPermissionsRestricted
    • networkConnectionUnavailable
  • sync() method

1.0.3 - 2023-06-16

Changed

  • Updated HyperTrack SDK iOS to 4.16.1

1.0.2 - 2023-06-15

Changed

  • HyperTrack SDK Android updated to 6.4.2

1.0.1 - 2023-06-01

Changed

  • HyperTrack SDK iOS updated to 4.16.0

1.0.0 - 2023-02-10

Added

  • Initial release