Publish reframed Annotations on Current Step

Package.swift

@@ -16,11 +16,12 @@ if useLocalFramework {
         path: "./common/target/ios/libferrostar-rs.xcframework"
     )
 } else {
-    let releaseTag = "0.15.0"
+    let releaseTag = "0.16.0"
     let releaseChecksum = "c44d86ae31e1fccde4a9e42fdb8474504dfee40338a341e3131f894208e3b7b2"
     binaryTarget = .binaryTarget(
         name: "FerrostarCoreRS",
-        url: "https://github.com/stadiamaps/ferrostar/releases/download/\(releaseTag)/libferrostar-rs.xcframework.zip",
+        url:
+        "https://github.com/stadiamaps/ferrostar/releases/download/\(releaseTag)/libferrostar-rs.xcframework.zip",
         checksum: releaseChecksum
     )
 }
@@ -48,8 +49,10 @@ let package = Package(
         ),
         .library(
             name: "FerrostarMapLibreUI",
-            targets: ["FerrostarMapLibreUI",
-                      "FerrostarSwiftUI"] // TODO: Remove FerrostarSwiftUI from FerrostarMapLibreUI once we can fix the demo app swift package config (broken in Xcode 15.3)
+            targets: [
+                "FerrostarMapLibreUI",
+                "FerrostarSwiftUI",
+            ] // TODO: Remove FerrostarSwiftUI from FerrostarMapLibreUI once we can fix the demo app swift package config (broken in Xcode 15.3)
         ),
         .library(
             name: "FerrostarSwiftUI",

android/build.gradle

@@ -8,9 +8,10 @@ plugins {
     alias libs.plugins.paparazzi apply false
     alias libs.plugins.compose.compiler apply false
     alias libs.plugins.mavenPublish apply false
+    alias libs.plugins.kotlinSerialization apply false
 }
 
 allprojects {
     group = "com.stadiamaps.ferrostar"
-    version = "0.15.0"
+    version = "0.16.0"
 }

android/core/build.gradle

@@ -7,6 +7,7 @@ plugins {
     alias libs.plugins.cargo.ndk
     alias libs.plugins.ktfmt
     alias libs.plugins.mavenPublish
+    alias libs.plugins.kotlinSerialization
 }
 
 android {
@@ -53,6 +54,7 @@ dependencies {
     implementation(platform(libs.okhttp.bom))
     implementation(libs.okhttp.core)
     implementation libs.moshi
+    implementation libs.moshi.kotlin
 
     // TODO: Migrate version to TOML (doesn't work). Likely related issue: https://github.com/gradle/gradle/issues/21267
     //noinspection UseTomlInstead

android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt

@@ -119,7 +119,8 @@ class FerrostarCoreTest {
                                   secondaryContent = null,
                                   triggerDistanceBeforeManeuver = 42.0)),
                       spokenInstructions = listOf(),
-                      duration = 0.0)))
+                      duration = 0.0,
+                      annotations = null)))
 
   @Test
   fun test401UnauthorizedRouteResponse() = runTest {

android/core/src/main/java/com/stadiamaps/ferrostar/core/mock/MockNavigationState.kt

@@ -54,7 +54,8 @@ fun NavigationState.Companion.pedestrianExample(): NavigationState {
                       secondaryContent = null,
                       triggerDistanceBeforeManeuver = 0.0,
                   ),
-              spokenInstruction = null),
+              spokenInstruction = null,
+              annotationJson = null),
       routeGeometry = listOf(),
       isCalculatingNewRoute = false)
 }

android/gradle/libs.versions.toml

@@ -53,6 +53,7 @@ androidx-compose-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-
 okhttp-bom = { group = "com.squareup.okhttp3", name = "okhttp-bom", version.ref = "okhttp" }
 okhttp-core = { group = "com.squareup.okhttp3", name = "okhttp" }
 moshi = { group = "com.squareup.moshi", name = "moshi", version.ref = "moshi" }
+moshi-kotlin = { group = "com.squareup.moshi", name = "moshi-kotlin", version.ref = "moshi" }
 okhttp-mock = { group = "com.github.gmazzo", name = "okhttp-mock", version.ref = "okhttp-mock" }
 # MapLibre
 maplibre-compose = { group = "io.github.rallista", name = "maplibre-compose", version.ref = "maplibre-compose" }
@@ -74,4 +75,5 @@ cargo-ndk = { id = "com.github.willir.rust.cargo-ndk-android", version.ref = "ca
 ktfmt = { id = "com.ncorti.ktfmt.gradle", version.ref = "ktfmt" }
 paparazzi = { id = "app.cash.paparazzi", version.ref = "paparazzi" }
 mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
-mapsplatform-secrets-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
+kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
+mapsplatform-secrets-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }

apple/Sources/FerrostarCore/FerrostarCore.swift

@@ -282,7 +282,8 @@ public protocol FerrostarCoreDelegate: AnyObject {
                 progress: _,
                 deviation: deviation,
                 visualInstruction: _,
-                spokenInstruction: spokenInstruction
+                spokenInstruction: spokenInstruction,
+                annotationJson: _
             ):
                 switch deviation {
                 case .noDeviation:

apple/Sources/FerrostarCore/Mock/MockNavigationState.swift

@@ -25,7 +25,8 @@ public extension NavigationState {
             ),
             deviation: .noDeviation,
             visualInstruction: nil,
-            spokenInstruction: nil
+            spokenInstruction: nil,
+            annotationJson: nil
         ),
         routeGeometry: samplePedestrianWaypoints,
         isCalculatingNewRoute: false
@@ -63,7 +64,8 @@ public extension NavigationState {
                                 secondaryContent: nil, triggerDistanceBeforeManeuver: 42.0
                             ),
                         ],
-                        spokenInstructions: []
+                        spokenInstructions: [],
+                        annotations: nil
                     ),
                 ],
                 remainingWaypoints: [],
@@ -74,7 +76,8 @@ public extension NavigationState {
                 ),
                 deviation: .noDeviation,
                 visualInstruction: nil,
-                spokenInstruction: nil
+                spokenInstruction: nil,
+                annotationJson: nil
             ),
             routeGeometry: samplePedestrianWaypoints,
             isCalculatingNewRoute: false

apple/Sources/FerrostarCore/NavigationState.swift

@@ -20,4 +20,30 @@ public struct NavigationState: Hashable {
         self.routeGeometry = routeGeometry
         self.isCalculatingNewRoute = isCalculatingNewRoute
     }
+
+    public var currentProgress: TripProgress? {
+        guard case let .navigating(_, _, _, _, progress: progress, _, _,
+                                   _, _) = tripState
+        else {
+            return nil
+        }
+
+        return progress
+    }
+
+    public var currentVisualInstruction: VisualInstruction? {
+        guard case let .navigating(_, _, _, _, _, _, visualInstruction: visualInstruction, _, _) = tripState else {
+            return nil
+        }
+
+        return visualInstruction
+    }
+
+    public var currentAnnotationJSON: String? {
+        guard case let .navigating(_, _, _, _, _, _, _, _, annotationJson: annotationJson) = tripState else {
+            return nil
+        }
+
+        return annotationJson
+    }
 }

apple/Sources/FerrostarMapLibreUI/Views/DynamicallyOrientingNavigationView.swift

@@ -139,7 +139,7 @@ public struct DynamicallyOrientingNavigationView: View, CustomizableNavigatingIn
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .imperial
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 
@@ -158,7 +158,7 @@ public struct DynamicallyOrientingNavigationView: View, CustomizableNavigatingIn
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .metric
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 

apple/Sources/FerrostarMapLibreUI/Views/LandscapeNavigationView.swift

@@ -108,7 +108,7 @@ public struct LandscapeNavigationView: View, CustomizableNavigatingInnerGridView
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .imperial
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 
@@ -129,7 +129,7 @@ public struct LandscapeNavigationView: View, CustomizableNavigatingInnerGridView
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .metric
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 

apple/Sources/FerrostarMapLibreUI/Views/NavigationMapView.swift

@@ -83,7 +83,7 @@ public struct NavigationMapView: View {
     }
 
     private func updateCameraIfNeeded() {
-        if case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = navigationState?.tripState,
+        if case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = navigationState?.tripState,
            // There is no reason to push an update if the coordinate and heading are the same.
            // That's all that gets displayed, so it's all that MapLibre should care about.
            locationManager.lastLocation.coordinate != userLocation.coordinates
@@ -98,7 +98,7 @@ public struct NavigationMapView: View {
     // TODO: Make map URL configurable but gitignored
     let state = NavigationState.modifiedPedestrianExample(droppingNWaypoints: 4)
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 

apple/Sources/FerrostarMapLibreUI/Views/Overylays/LandscapeNavigationOverlayView.swift

@@ -47,9 +47,9 @@ struct LandscapeNavigationOverlayView: View, CustomizableNavigatingInnerGridView
     var body: some View {
         HStack {
             VStack {
-                if case let .navigating(_, _, _, _, progress: progress, _, visualInstruction: visualInstruction,
-                                        _) = navigationState?.tripState,
-                    let visualInstruction
+                if case .navigating = navigationState?.tripState,
+                   let visualInstruction = navigationState?.currentVisualInstruction,
+                   let progress = navigationState?.currentProgress
                 {
                     InstructionsView(
                         visualInstruction: visualInstruction,
@@ -60,7 +60,9 @@ struct LandscapeNavigationOverlayView: View, CustomizableNavigatingInnerGridView
 
                 Spacer()
 
-                if case let .navigating(_, _, _, _, progress: progress, _, _, _) = navigationState?.tripState {
+                if case .navigating = navigationState?.tripState,
+                   let progress = navigationState?.currentProgress
+                {
                     ArrivalView(
                         progress: progress,
                         onTapExit: onTapExit

apple/Sources/FerrostarMapLibreUI/Views/Overylays/PortraitNavigationOverlayView.swift

@@ -46,9 +46,9 @@ struct PortraitNavigationOverlayView: View, CustomizableNavigatingInnerGridView
 
     var body: some View {
         VStack {
-            if case let .navigating(_, _, _, _, progress: progress, _, visualInstruction: visualInstruction,
-                                    _) = navigationState?.tripState,
-                let visualInstruction
+            if case .navigating = navigationState?.tripState,
+               let visualInstruction = navigationState?.currentVisualInstruction,
+               let progress = navigationState?.currentProgress
             {
                 InstructionsView(
                     visualInstruction: visualInstruction,
@@ -79,7 +79,9 @@ struct PortraitNavigationOverlayView: View, CustomizableNavigatingInnerGridView
                 bottomTrailing?()
             }
 
-            if case let .navigating(_, _, _, _, progress: progress, _, _, _) = navigationState?.tripState {
+            if case .navigating = navigationState?.tripState,
+               let progress = navigationState?.currentProgress
+            {
                 ArrivalView(
                     progress: progress,
                     onTapExit: onTapExit

apple/Sources/FerrostarMapLibreUI/Views/PortraitNavigationView.swift

@@ -109,7 +109,7 @@ public struct PortraitNavigationView: View, CustomizableNavigatingInnerGridView
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .imperial
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }
 
@@ -129,7 +129,7 @@ public struct PortraitNavigationView: View, CustomizableNavigatingInnerGridView
     formatter.locale = Locale(identifier: "en-US")
     formatter.units = .metric
 
-    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _) = state.tripState else {
+    guard case let .navigating(_, snappedUserLocation: userLocation, _, _, _, _, _, _, _) = state.tripState else {
         return EmptyView()
     }