Promote interactions API to be stable. (#3640)

GitOrigin-RevId: d5f471a8c3e31320e9d923dcd7ddce380849dd3f

Author: pengdev

CHANGELOG.md

@@ -7,6 +7,8 @@ Mapbox welcomes participation and contributions from everyone.
 * Expose `RenderThreadStatsRecorder` as experimental API.
 * Expose an experimental API to define a non-rectangular screen culling shape(`MapboxMap.get/setScreenCullingShape`)
 * Expose new experimental properties: `CircleLayer.circleElevationReference`, `FillLayer.fillConstructBridgeGuardRail`, `FillLayer.fillBridgeGuardRailColor`, `FillLayer.fillTunnelStructureColor`.
+* Promote `MapInteraction` APIs to stable, remove experimental `Style.STANDARD_EXPERIMENTAL` constant, as `Style.STANDARD` supports featuresets and map interactions by default.
+* [compose] Rename experimental `ExperimentalStandardStyleState` to `StandardStyleState`, rename experimental `MapboxStandardStyleExperimental` to `MapboxStandardStyle(styleImportsContent, topSlot, middleSlot, bottomSlot, standardStyleState)`, and deprecate previous `MapboxStandardStyle` composable functions.
 
 ## Bug fixes 🐞
 * Fix registering camera change listener every time `mapView.scalebar.enabled` is called with value `true` and it was already enabled.

app/src/main/java/com/mapbox/maps/testapp/examples/JavaInterfaceChecker.java

@@ -702,7 +702,7 @@ private void interactions(final MapboxMap mapboxMap) {
             )
     );
 
-    mapboxMap.loadStyle(Style.STANDARD_EXPERIMENTAL);
+    mapboxMap.loadStyle(Style.STANDARD);
     mapboxMap.addInteraction(
             StandardInteractions.standardBuildings(
                     ClickInteraction.Companion,

app/src/main/java/com/mapbox/maps/testapp/examples/StandardStyleInteractionsActivity.kt

@@ -53,7 +53,7 @@ class StandardStyleInteractionsActivity : AppCompatActivity() {
     val map = mapView.mapboxMap
     val selectedPoiList = mutableListOf<StandardPoiFeature>()
 
-    map.loadStyle(Style.STANDARD_EXPERIMENTAL)
+    map.loadStyle(Style.STANDARD)
 
     // the most basic use-case to highlight clicked building
     map.addInteraction(

compose-app/src/main/java/com/mapbox/maps/compose/testapp/examples/style/StandardStyleActivity.kt

@@ -23,7 +23,6 @@ import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.unit.dp
-import com.mapbox.maps.MapboxExperimental
 import com.mapbox.maps.compose.testapp.ExampleScaffold
 import com.mapbox.maps.compose.testapp.examples.utils.CityLocations
 import com.mapbox.maps.compose.testapp.ui.theme.MapboxMapComposeTheme
@@ -33,16 +32,15 @@ import com.mapbox.maps.extension.compose.style.BooleanValue
 import com.mapbox.maps.extension.compose.style.StringValue
 import com.mapbox.maps.extension.compose.style.standard.LightPresetValue
 import com.mapbox.maps.extension.compose.style.standard.MapboxStandardSatelliteStyle
-import com.mapbox.maps.extension.compose.style.standard.MapboxStandardStyleExperimental
+import com.mapbox.maps.extension.compose.style.standard.MapboxStandardStyle
 import com.mapbox.maps.extension.compose.style.standard.ThemeValue
-import com.mapbox.maps.extension.compose.style.standard.rememberExperimentalStandardStyleState
+import com.mapbox.maps.extension.compose.style.standard.rememberStandardStyleState
 import com.mapbox.maps.extension.style.utils.transition
 
 /**
  * Example to showcase usage of the configs of `MapboxStandardStyle`.
  */
 public class StandardStyleActivity : ComponentActivity() {
-  @OptIn(MapboxExperimental::class)
   override fun onCreate(savedInstanceState: Bundle?) {
     super.onCreate(savedInstanceState)
     setContent {
@@ -353,8 +351,8 @@ public class StandardStyleActivity : ComponentActivity() {
                   showPedestrianRoads = BooleanValue(enablePedestrianRoads)
                 }
               } else {
-                MapboxStandardStyleExperimental(
-                  experimentalStandardStyleState = rememberExperimentalStandardStyleState {
+                MapboxStandardStyle(
+                  standardStyleState = rememberStandardStyleState {
                     interactionsState.onBuildingsClicked { clickedBuilding, _ ->
                       clickedBuilding.setStandardBuildingsState {
                         highlight(true)

extension-compose/api/Release/metalava.txt

@@ -4267,18 +4267,6 @@ public abstract class com/mapbox/maps/extension/compose/style/standard/BaseStyle
 	public final fun setShowTransitLabels (Lcom/mapbox/maps/extension/compose/style/BooleanValue;)V
 }
 
-public final class com/mapbox/maps/extension/compose/style/standard/ExperimentalStandardStyleState : com/mapbox/maps/extension/compose/style/standard/BaseStandardStyleState {
-	public fun <init> ()V
-	public final fun getConfigurationsState ()Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleConfigurationState;
-	public final fun getInteractionsState ()Lcom/mapbox/maps/extension/compose/style/standard/generated/StandardStyleInteractionsState;
-	public final fun setConfigurationsState (Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleConfigurationState;)V
-	public final fun setInteractionsState (Lcom/mapbox/maps/extension/compose/style/standard/generated/StandardStyleInteractionsState;)V
-}
-
-public final class com/mapbox/maps/extension/compose/style/standard/ExperimentalStandardStyleStateKt {
-	public static final fun rememberExperimentalStandardStyleState (Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)Lcom/mapbox/maps/extension/compose/style/standard/ExperimentalStandardStyleState;
-}
-
 public final class com/mapbox/maps/extension/compose/style/standard/LightPresetValue {
 	public static final field Companion Lcom/mapbox/maps/extension/compose/style/standard/LightPresetValue$Companion;
 	public static final field DAWN Lcom/mapbox/maps/extension/compose/style/standard/LightPresetValue;
@@ -4307,13 +4295,10 @@ public final class com/mapbox/maps/extension/compose/style/standard/MapboxStanda
 	public static final fun MapboxStandardSatelliteStyle (Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lcom/mapbox/maps/extension/compose/style/projection/generated/Projection;Lcom/mapbox/maps/extension/compose/style/atmosphere/generated/AtmosphereState;Lcom/mapbox/maps/extension/compose/style/terrain/generated/TerrainState;Lcom/mapbox/maps/extension/compose/style/lights/LightsState;Lcom/mapbox/maps/TransitionOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)V
 }
 
-public final class com/mapbox/maps/extension/compose/style/standard/MapboxStandardStyleExperimentalKt {
-	public static final fun MapboxStandardStyleExperimental (Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lcom/mapbox/maps/extension/compose/style/standard/ExperimentalStandardStyleState;Landroidx/compose/runtime/Composer;II)V
-}
-
 public final class com/mapbox/maps/extension/compose/style/standard/MapboxStandardStyleKt {
 	public static final fun MapboxStandardStyle (Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lcom/mapbox/maps/extension/compose/style/projection/generated/Projection;Lcom/mapbox/maps/extension/compose/style/atmosphere/generated/AtmosphereState;Lcom/mapbox/maps/extension/compose/style/terrain/generated/TerrainState;Lcom/mapbox/maps/extension/compose/style/lights/LightsState;Lcom/mapbox/maps/TransitionOptions;Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleConfigurationState;Landroidx/compose/runtime/Composer;II)V
 	public static final fun MapboxStandardStyle (Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lcom/mapbox/maps/extension/compose/style/projection/generated/Projection;Lcom/mapbox/maps/extension/compose/style/atmosphere/generated/AtmosphereState;Lcom/mapbox/maps/extension/compose/style/terrain/generated/TerrainState;Lcom/mapbox/maps/extension/compose/style/lights/LightsState;Lcom/mapbox/maps/TransitionOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)V
+	public static final fun MapboxStandardStyle (Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleState;Landroidx/compose/runtime/Composer;II)V
 }
 
 public final class com/mapbox/maps/extension/compose/style/standard/StandardSatelliteStyleConfigurationState : com/mapbox/maps/extension/compose/style/standard/BaseStyleConfigurationState {
@@ -4332,6 +4317,18 @@ public final class com/mapbox/maps/extension/compose/style/standard/StandardStyl
 	public final fun setTheme (Lcom/mapbox/maps/extension/compose/style/standard/ThemeValue;)V
 }
 
+public final class com/mapbox/maps/extension/compose/style/standard/StandardStyleState : com/mapbox/maps/extension/compose/style/standard/BaseStandardStyleState {
+	public fun <init> ()V
+	public final fun getConfigurationsState ()Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleConfigurationState;
+	public final fun getInteractionsState ()Lcom/mapbox/maps/extension/compose/style/standard/generated/StandardStyleInteractionsState;
+	public final fun setConfigurationsState (Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleConfigurationState;)V
+	public final fun setInteractionsState (Lcom/mapbox/maps/extension/compose/style/standard/generated/StandardStyleInteractionsState;)V
+}
+
+public final class com/mapbox/maps/extension/compose/style/standard/StandardStyleStateKt {
+	public static final fun rememberStandardStyleState (Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)Lcom/mapbox/maps/extension/compose/style/standard/StandardStyleState;
+}
+
 public final class com/mapbox/maps/extension/compose/style/standard/ThemeValue {
 	public static final field Companion Lcom/mapbox/maps/extension/compose/style/standard/ThemeValue$Companion;
 	public static final field DEFAULT Lcom/mapbox/maps/extension/compose/style/standard/ThemeValue;

extension-compose/api/extension-compose.api

@@ -9,7 +9,6 @@ import com.mapbox.maps.ClickInteraction
 import com.mapbox.maps.InteractionContext
 import com.mapbox.maps.LongClickInteraction
 import com.mapbox.maps.MapInteraction
-import com.mapbox.maps.MapboxExperimental
 import com.mapbox.maps.MapboxMap
 import com.mapbox.maps.extension.compose.style.interactions.generated.FeaturesetFeatureScope
 import com.mapbox.maps.extension.compose.style.interactions.generated.FeaturesetFeatureScopeImpl
@@ -22,7 +21,6 @@ import com.mapbox.maps.interactions.FeaturesetFeature
  *
  * Note this is a generic implementation with no public API exposed.
  */
-@MapboxExperimental
 public abstract class BasicStyleInteractions {
   // map interaction builder entries that will be built and added to the map when the state is bind to the map.
   // this property is used directly by generated Standard interactions and then lambda represents (importId? -> MapInteraction)

extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/interactions/BasicStyleInteractions.kt

@@ -16,8 +16,8 @@ import com.mapbox.maps.extension.compose.style.terrain.generated.TerrainState
 /**
  * The base state holder for the Standard Style.
  */
+@OptIn(MapboxExperimental::class)
 @Stable
-@MapboxExperimental
 public open class BaseStandardStyleState protected constructor(
   initialProjection: Projection,
   initialAtmosphereState: AtmosphereState,

extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/interactions/generated/FeaturesetFeatureScope.kt

@@ -1,10 +1,13 @@
 package com.mapbox.maps.extension.compose.style.standard
 
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.currentComposer
+import androidx.compose.runtime.key
 import androidx.compose.runtime.remember
 import com.mapbox.maps.Style
 import com.mapbox.maps.TransitionOptions
 import com.mapbox.maps.extension.compose.MapboxMapComposable
+import com.mapbox.maps.extension.compose.internal.MapApplier
 import com.mapbox.maps.extension.compose.style.GenericStyle
 import com.mapbox.maps.extension.compose.style.MapboxStyleComposable
 import com.mapbox.maps.extension.compose.style.atmosphere.generated.AtmosphereState
@@ -35,6 +38,7 @@ import com.mapbox.maps.extension.style.utils.transition
  */
 @Composable
 @MapboxStyleComposable
+@Deprecated(message = "Use MapboxStandardStyle with StandardStyleState instead.", replaceWith = ReplaceWith("MapboxStandardStyle(styleImportsContent, topSlot, middleSlot, bottomSlot, standardStyleState)"))
 public fun MapboxStandardStyle(
   styleImportsContent: (@Composable @MapboxStyleImportComposable StyleImportsScope.() -> Unit)? = null,
   topSlot: (@Composable @MapboxMapComposable () -> Unit)? = null,
@@ -120,6 +124,7 @@ public fun MapboxStandardStyle(
  */
 @Composable
 @MapboxStyleComposable
+@Deprecated(message = "Use MapboxStandardStyle with StandardStyleState instead", replaceWith = ReplaceWith("MapboxStandardStyle(styleImportsContent, topSlot, middleSlot, bottomSlot, standardStyleState)"))
 public fun MapboxStandardStyle(
   styleImportsContent: (@Composable @MapboxStyleImportComposable StyleImportsScope.() -> Unit)? = null,
   topSlot: (@Composable @MapboxMapComposable () -> Unit)? = null,
@@ -146,4 +151,82 @@ public fun MapboxStandardStyle(
       StandardStyleConfigurationState()
     }.apply(init)
   )
+}
+
+/**
+ * The convenient composable function to set a Mapbox Standard style to the map, with available slots
+ * and config options.
+ *
+ * @param styleImportsContent The style imports to be added to the current style, note layers and annotations shouldn't be added to this block.
+ * @param topSlot The content to be set to the top slot of the Mapbox Standard style.
+ * @param middleSlot The content to be set to the middle slot of the Mapbox Standard style.
+ * @param bottomSlot The content to be set to the bottom slot of the Mapbox Standard style.
+ * @param standardStyleState The state holder for the experimental Mapbox Standard Style.
+ */
+@Composable
+@MapboxStyleComposable
+public fun MapboxStandardStyle(
+  styleImportsContent: (@Composable @MapboxStyleImportComposable StyleImportsScope.() -> Unit)? = null,
+  topSlot: (@Composable @MapboxMapComposable () -> Unit)? = null,
+  middleSlot: (@Composable @MapboxMapComposable () -> Unit)? = null,
+  bottomSlot: (@Composable @MapboxMapComposable () -> Unit)? = null,
+  standardStyleState: StandardStyleState = rememberStandardStyleState(),
+) {
+  GenericStyle(
+    style = Style.STANDARD,
+    styleImportsContent = styleImportsContent,
+    slotsContent = slotsContent {
+      topSlot?.let { slot("top", it) }
+      middleSlot?.let { slot("middle", it) }
+      bottomSlot?.let { slot("bottom", it) }
+    },
+    styleState = rememberStyleState {
+      styleImportsConfig = styleImportsConfig {
+        importConfig(importId = "basemap") {
+          with(standardStyleState.configurationsState) {
+            if (showPlaceLabels.isNotInitial()) {
+              config(BaseStyleConfigurationState.CONFIG_SHOW_PLACE_LABELS, showPlaceLabels.value)
+            }
+            if (showRoadLabels.isNotInitial()) {
+              config(BaseStyleConfigurationState.CONFIG_SHOW_ROAD_LABELS, showRoadLabels.value)
+            }
+            if (showPointOfInterestLabels.isNotInitial()) {
+              config(
+                BaseStyleConfigurationState.CONFIG_SHOW_POINT_OF_INTEREST_LABELS,
+                showPointOfInterestLabels.value
+              )
+            }
+            if (showTransitLabels.isNotInitial()) {
+              config(
+                BaseStyleConfigurationState.CONFIG_SHOW_TRANSIT_LABELS,
+                showTransitLabels.value
+              )
+            }
+            if (lightPreset.notInitial) {
+              config(BaseStyleConfigurationState.CONFIG_LIGHT_PRESET, lightPreset.value)
+            }
+            if (font.isNotInitial()) {
+              config(BaseStyleConfigurationState.CONFIG_FONT, font.value)
+            }
+            if (show3dObjects.isNotInitial()) {
+              config(StandardStyleConfigurationState.CONFIG_SHOW_3D_OBJECTS, show3dObjects.value)
+            }
+            if (theme.notInitial) {
+              config(StandardStyleConfigurationState.CONFIG_THEME, theme.value)
+            }
+          }
+        }
+      }
+      this.projection = standardStyleState.projection
+      this.atmosphereState = standardStyleState.atmosphereState
+      this.terrainState = standardStyleState.terrainState
+      this.lightsState = standardStyleState.lightsState
+      this.styleTransition = standardStyleState.styleTransition
+    }
+  )
+  val mapApplier = currentComposer.applier as? MapApplier
+    ?: throw IllegalStateException("Illegal use of Style composable outside of MapboxMapComposable")
+  key(standardStyleState.interactionsState) {
+    standardStyleState.interactionsState.BindTo(mapboxMap = mapApplier.mapView.mapboxMap)
+  }
 }