Merge branch 'mapbox:main' into main

Author: tranhuongk

.circleci/config.yml

@@ -54,8 +54,8 @@ jobs:
           working_directory: example/android
           command: |
             flutter build apk
-            ./gradlew app:assembleAndroidTest
-            ./gradlew app:assembleDebug -Ptarget=integration_test/all_test.dart -Pdart-defines="$(echo -n "ACCESS_TOKEN=$MAPBOX_ACCESS_TOKEN" | base64 -w 0)"
+            ./gradlew app:assembleAndroidTest --stacktrace
+            ./gradlew app:assembleDebug -Ptarget=integration_test/all_test.dart -Pdart-defines="$(echo -n "ACCESS_TOKEN=$MAPBOX_ACCESS_TOKEN" | base64 -w 0)" --stacktrace
       - persist_to_workspace:
           root: << parameters.workspace-path >>
           paths:
@@ -121,6 +121,7 @@ jobs:
 
             popd # to repo root
 
+            bundle install
             bundle exec fastlane build_examples_tests
       - persist_to_workspace:
           root: << parameters.workspace-path >>

.fastlane/Fastfile

@@ -14,15 +14,15 @@ platform :ios do
       team_id: "GJZR2MEM28", # Developer Portal Team ID,
       profile_name: lane_context[SharedValues::MATCH_PROVISIONING_PROFILE_MAPPING]["com.mapbox.maps.FlutterMapsExample"],
       targets: ["Runner"],
-      code_sign_identity: "Apple Development: Machiney McMachineface",
+      code_sign_identity: "Apple Development: Created via API",
     )
     update_code_signing_settings(
       use_automatic_signing: false,
       path: "example/ios/Runner.xcodeproj",
       team_id: "GJZR2MEM28", # Developer Portal Team ID,
       profile_name: lane_context[SharedValues::MATCH_PROVISIONING_PROFILE_MAPPING]["com.mapbox.maps.FlutterRunnerTests"],
       targets: ["RunnerTests"],
-      code_sign_identity: "Apple Development: Machiney McMachineface",
+      code_sign_identity: "Apple Development: Created via API",
     )
     # build tests archive in the `output_directory` to launch on firebase
     run_tests(

CHANGELOG.md

@@ -1,3 +1,50 @@
+### main
+
+* Expose `MapboxStyles.STANDARD_SATELLITE` style.
+
+### 2.2.0-beta.1
+
+* Support local assets for 3D puck and `ModelLayer`. To use a local assets, please specify it with `asset://` scheme in the uri.
+* Fix map view crashing upon host activity destruction when using a cached Flutter engine.
+* Fix a rare crash happening when map widget is being disposed.
+
+### 2.1.0
+
+* Add ModelLayer API.
+* Support for offline map, allowing users to download and store map data on their devices for use in environments with limited or no internet connectivity.
+* Layer expressions support. Specify expressions when constructing a layer with all new expression support for layers.
+*Before:*
+```dart
+mapboxMap.style.setStyleLayerProperty("layer", "line-gradient",
+    '["interpolate",["linear"],["line-progress"],0.0,["rgb",255,0,0],0.4,["rgb",0,255,0],1.0,["rgb",0,0,255]]');
+
+```
+*After:*
+```dart
+LineLayer(
+  ...
+  lineGradientExpression: [
+    "interpolate",
+    ["linear"],
+    ["line-progress"],
+    0.0,
+    ["rgb", 255, 0, 0],
+    0.4,
+    ["rgb", 0, 255, 0],
+    1.0,
+    ["rgb", 0, 0, 255]
+  ],
+);
+```
+* Expose `text-occlusion-opacity`, `icon-occlusion-opacity`, `line-occlusion-opacity`, `model-front-cutoff`, `lineZOffset` as experimental.
+* Add min/max/default values for most of the style properties.
+* Expose `clusterMinPoints` property for `GeoJSONSource`.
+* Expose `SlotLayer` and `RasterParticleLayer`.
+* Expose `LocationComponentSettings.slot`.
+* Add `@experimental` annotation to relevant APIs.
+* Expose `LineJoin.NONE`.
+* Bump Maps SDK to 11.5.0 for Android and 11.5.1 for iOS.
+
 ### 2.1.0-rc.1
 
 * Bump Maps SDK to 11.5.0-rc.1

Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "fastlane"
+gem "fastlane", "~> 2.221.1"
 
 plugins_path = File.join(File.dirname(__FILE__), '.fastlane', 'Pluginfile')
 eval_gemfile(plugins_path) if File.exist?(plugins_path)

LICENSE

@@ -1,12 +1,12 @@
 ### License
 
-Mapbox Maps Flutter Plugin
+Mapbox Maps Flutter SDK
 
 Copyright © 2022 - 2023 Mapbox, Inc. All rights reserved.
 
 The software and files in this repository (collectively, “Software”) are licensed under the Mapbox TOS for use only with the relevant Mapbox product(s) listed at www.mapbox.com/pricing. This license allows developers with a current active Mapbox account to use and modify the authorized portions of the Software as needed for use only with the relevant Mapbox product(s) through their Mapbox account in accordance with the Mapbox TOS.  This license terminates automatically if a developer no longer has a Mapbox account in good standing or breaches the Mapbox TOS. For the license terms, please see the Mapbox TOS at https://www.mapbox.com/legal/tos/ which incorporates the Mapbox Product Terms at www.mapbox.com/legal/service-terms.  If this Software is a SDK, modifications that change or interfere with marked portions of the code related to billing, accounting, or data collection are not authorized and the SDK sends limited de-identified location and usage data which is used in accordance with the Mapbox TOS. [Updated 2023-01]
 
-## Additional Mapbox Maps Flutter Plugin licenses
+## Additional Mapbox Maps Flutter SDK licenses
 
 [enum_to_string](https://pub.dev/packages/enum_to_string).
 

README.md

@@ -1,6 +1,6 @@
-# Mapbox Maps SDK Flutter Plugin
+# Mapbox Maps SDK Flutter SDK
 
-The Mapbox Maps SDK Flutter Plugin is an officially developed solution from Mapbox that enables use of our latest Maps SDK product (v11.5.0). The plugin allows developers to embed highly customized maps using a Flutter widget on Android and iOS.
+The Mapbox Maps SDK Flutter SDK is an officially developed solution from Mapbox that enables use of our latest Maps SDK product (v11.6.0-beta.1). The SDK allows developers to embed highly customized maps using a Flutter widget on Android and iOS.
 
 Web and desktop are not supported. 
 
@@ -44,7 +44,7 @@ Contributions welcome!
 
 ## Requirements
 
-The Maps Flutter Plugin is compatible with applications:
+The Maps Flutter SDK is compatible with applications:
 
 - Deployed on iOS 12 or higher
 - Built using the Android SDK 21 or higher
@@ -53,7 +53,7 @@ The Maps Flutter Plugin is compatible with applications:
 ## Installation
 
 ### Configure credentials
-To run the Maps Flutter Plugin you will need to configure the Mapbox Access Tokens. 
+To run the Maps Flutter SDK you will need to configure the Mapbox Access Tokens. 
 Read more about access tokens and public/secret scopes at the platform [Android](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) or [iOS](https://docs.mapbox.com/ios/maps/guides/install/#configure-credentials) docs.
 
 #### Secret token
@@ -70,7 +70,7 @@ To access platform SDKs you will need to create a secret access token with the `
 ```
 
 #### Public token
-You can set the access token for Mapbox Maps Flutter Plugin(as well as for every Mapbox SDK) via `MapboxOptions`:
+You can set the access token for Mapbox Maps Flutter SDK(as well as for every Mapbox SDK) via `MapboxOptions`:
 ```
   MapboxOptions.setAccessToken(ACCESS_TOKEN);
 ```
@@ -107,15 +107,15 @@ String ACCESS_TOKEN = String.fromEnvironment("ACCESS_TOKEN");
 ```
 
 ### Add the dependency
-To use the Maps Flutter Plugin add the git dependency to the pubspec.yaml:
+To use the Maps Flutter SDK add the git dependency to the pubspec.yaml:
 
 ```
 dependencies:
-  mapbox_maps_flutter: ^2.1.0-rc.1
+  mapbox_maps_flutter: ^2.2.0-beta.1
 ```
 
 ### Configure permissions
-You will need to grant location permission in order to use the location component of the Maps Flutter Plugin.
+You will need to grant location permission in order to use the location component of the Maps Flutter SDK.
 
 You can use an existing library to request location permission, e.g. with [permission_handler](https://pub.dev/packages/permission_handler) `await Permission.locationWhenInUse.request();` will trigger permission request. 
 
@@ -155,10 +155,10 @@ It also allows or add listeners for various events - related to style loading, m
 #### MapboxMap controller
 The `MapboxMap` controller instance is provided with `MapWidget.onMapCreated` callback.
 
-`MapboxMap` exposes an entry point to the most of the APIs Maps Flutter Plugin provides. It allows to control the map, camera, styles, observe map events, 
+`MapboxMap` exposes an entry point to the most of the APIs Maps Flutter SDK provides. It allows to control the map, camera, styles, observe map events, 
 query rendered features, etc.
 
-It's organized similarly to the [Android](https://docs.mapbox.com/android/maps/api/11.2.0/mapbox-maps-android/com.mapbox.maps/-mapbox-map/) and [iOS](https://docs.mapbox.com/ios/maps/api/11.2.0/documentation/mapboxmaps/mapboxmap) counterparts.
+It's organized similarly to the [Android](https://docs.mapbox.com/android/maps/api/11.5.0/mapbox-maps-android/com.mapbox.maps/-mapbox-map/) and [iOS](https://docs.mapbox.com/ios/maps/api/11.5.0/documentation/mapboxmaps/mapboxmap) counterparts.
 
 To interact with the map after it's created store the MapboxMap object somewhere : 
 ```
@@ -237,7 +237,7 @@ You can find more examples of the AnnotationManagers usage in the sample app : [
 ## Map styles
 Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/styles/), [iOS](https://docs.mapbox.com/ios/maps/guides/styles/).
 
-The Mapbox Maps Flutter Plugin allows full customization of the look of the map used in your application. 
+The Mapbox Maps Flutter SDK allows full customization of the look of the map used in your application. 
 
 ### Set a style
 You can specify the initial style uri at `MapWidget.styleUri`, or load it at runtime using `MapboxMap.loadStyleURI` / `MapboxMap.loadStyleJson` : 
@@ -276,7 +276,7 @@ To apply an expression to interpolate gradient color to a line layer:
 
 ## Camera and animations
 Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/camera-and-animation/), [iOS](https://docs.mapbox.com/ios/maps/guides/camera-and-animation/). 
-The camera is the user's viewpoint above the map. The Maps Flutter Plugin provides you with options to set and adjust the camera position, listen for camera changes, get the camera position, and restrict the camera position to set bounds.
+The camera is the user's viewpoint above the map. The Maps Flutter SDK provides you with options to set and adjust the camera position, listen for camera changes, get the camera position, and restrict the camera position to set bounds.
 
 ### Camera position
 You can set the starting camera position using `MapWidget.cameraOptions` :

android/build.gradle

@@ -78,7 +78,7 @@ if (file("$rootDir/gradle/ktlint.gradle").exists() && file("$rootDir/gradle/lint
 }
 
 dependencies {
-    implementation "com.mapbox.maps:android:11.5.0-rc.1"
+    implementation "com.mapbox.maps:android:11.6.0-beta.1"
 
     implementation "androidx.annotation:annotation:1.7.1"
     implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.3.0"

android/gradle.properties

@@ -1,3 +1,3 @@
-org.gradle.jvmargs=-Xmx1536M
+org.gradle.jvmargs=-Xmx4096M
 android.useAndroidX=true
 android.enableJetifier=true

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/LocationComponentController.kt

@@ -8,8 +8,10 @@ import com.mapbox.maps.mapbox_maps.pigeons.*
 import com.mapbox.maps.plugin.locationcomponent.createDefault2DPuck
 import com.mapbox.maps.plugin.locationcomponent.location
 
-class LocationComponentController(private val mapView: MapView, private val context: Context) :
-  _LocationComponentSettingsInterface {
+class LocationComponentController(
+  private val mapView: MapView,
+  private val context: Context
+) : _LocationComponentSettingsInterface {
   override fun getSettings(): LocationComponentSettings = mapView.location.toFLT(context)
 
   override fun updateSettings(settings: LocationComponentSettings, useDefaultPuck2DIfNeeded: Boolean) {

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapController.kt

@@ -26,6 +26,7 @@ import com.mapbox.maps.mapbox_maps.pigeons._AnimationManager
 import com.mapbox.maps.mapbox_maps.pigeons._CameraManager
 import com.mapbox.maps.mapbox_maps.pigeons._LocationComponentSettingsInterface
 import com.mapbox.maps.mapbox_maps.pigeons._MapInterface
+import io.flutter.embedding.android.FlutterActivity
 import io.flutter.plugin.common.BinaryMessenger
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
@@ -71,6 +72,7 @@ class MapboxMapController(
   */
   private class LifecycleHelper(
     val parentLifecycle: Lifecycle,
+    val shouldDestroyOnDestroy: Boolean,
   ) : LifecycleOwner, DefaultLifecycleObserver {
 
     val lifecycleRegistry: LifecycleRegistry = LifecycleRegistry(this)
@@ -103,20 +105,22 @@ class MapboxMapController(
       lifecycleRegistry.currentState = Lifecycle.State.CREATED
     }
 
-    override fun onDestroy(owner: LifecycleOwner) {
-      lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
-    }
+    override fun onDestroy(owner: LifecycleOwner) = propagateDestroyEvent()
 
     fun dispose() {
       parentLifecycle.removeObserver(this)
-      // fires MapView.onStop
-      lifecycleRegistry.currentState = Lifecycle.State.CREATED
-      // fires MapView.onDestroy
-      lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
+      propagateDestroyEvent()
+    }
+
+    private fun propagateDestroyEvent() {
+      lifecycleRegistry.currentState = when (shouldDestroyOnDestroy) {
+        true -> Lifecycle.State.DESTROYED
+        false -> Lifecycle.State.CREATED
+      }
     }
   }
 
-  private val lifecycleHelper: LifecycleHelper
+  private var lifecycleHelper: LifecycleHelper? = null
 
   init {
     val mapView = MapView(context, mapInitOptions)
@@ -139,9 +143,6 @@ class MapboxMapController(
 
     changeUserAgent(pluginVersion)
 
-    lifecycleHelper = LifecycleHelper(lifecycleProvider.getLifecycle()!!)
-    ViewTreeLifecycleOwner.set(mapView, lifecycleHelper)
-
     StyleManager.setUp(proxyBinaryMessenger, styleController)
     _CameraManager.setUp(proxyBinaryMessenger, cameraController)
     Projection.setUp(proxyBinaryMessenger, projectionController)
@@ -163,11 +164,31 @@ class MapboxMapController(
     return mapView
   }
 
+  override fun onFlutterViewAttached(flutterView: View) {
+    super.onFlutterViewAttached(flutterView)
+    val context = flutterView.context
+    val shouldDestroyOnDestroy = when (context is FlutterActivity) {
+      true -> context.shouldDestroyEngineWithHost()
+      false -> true
+    }
+    lifecycleHelper = LifecycleHelper(lifecycleProvider.getLifecycle()!!, shouldDestroyOnDestroy)
+
+    mapView?.let { ViewTreeLifecycleOwner.set(it, lifecycleHelper) }
+  }
+
+  override fun onFlutterViewDetached() {
+    super.onFlutterViewDetached()
+    lifecycleHelper?.dispose()
+    lifecycleHelper = null
+    ViewTreeLifecycleOwner.set(mapView!!, null)
+  }
+
   override fun dispose() {
     if (mapView == null) {
       return
     }
-    lifecycleHelper.dispose()
+    lifecycleHelper?.dispose()
+    lifecycleHelper = null
     mapView = null
     mapboxMap = null
     methodChannel.setMethodCallHandler(null)

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapFactory.kt

@@ -18,13 +18,15 @@ import com.mapbox.maps.Style
 import com.mapbox.maps.ViewportMode
 import com.mapbox.maps.applyDefaultParams
 import com.mapbox.maps.mapbox_maps.mapping.turf.PointDecoder
+import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.BinaryMessenger
 import io.flutter.plugin.common.StandardMessageCodec
 import io.flutter.plugin.platform.PlatformView
 import io.flutter.plugin.platform.PlatformViewFactory
 
 class MapboxMapFactory(
   private val messenger: BinaryMessenger,
+  private val flutterAssets: FlutterPlugin.FlutterAssets,
   private val lifecycleProvider: MapboxMapsPlugin.LifecycleProvider
 ) : PlatformViewFactory(StandardMessageCodec.INSTANCE) {
 

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapsPlugin.kt

@@ -12,6 +12,7 @@ import com.mapbox.maps.mapbox_maps.pigeons._SnapshotterInstanceManager
 import com.mapbox.maps.mapbox_maps.pigeons._TileStoreInstanceManager
 import com.mapbox.maps.mapbox_maps.snapshot.SnapshotterInstanceManager
 import io.flutter.embedding.engine.plugins.FlutterPlugin
+import io.flutter.embedding.engine.plugins.FlutterPlugin.FlutterAssets
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
 import io.flutter.embedding.engine.plugins.lifecycle.FlutterLifecycleAdapter
@@ -28,19 +29,19 @@ class MapboxMapsPlugin : FlutterPlugin, ActivityAware {
         "plugins.flutter.io/mapbox_maps",
         MapboxMapFactory(
           flutterPluginBinding.binaryMessenger,
+          flutterPluginBinding.flutterAssets,
           object : LifecycleProvider {
             override fun getLifecycle(): Lifecycle? {
               return lifecycle
             }
           }
         )
       )
-
-    setupStaticChannels(flutterPluginBinding.applicationContext, flutterPluginBinding.binaryMessenger)
+    setupStaticChannels(flutterPluginBinding.applicationContext, flutterPluginBinding.binaryMessenger, flutterPluginBinding.flutterAssets)
   }
 
-  private fun setupStaticChannels(context: Context, binaryMessenger: BinaryMessenger) {
-    val optionsController = MapboxOptionsController()
+  private fun setupStaticChannels(context: Context, binaryMessenger: BinaryMessenger, flutterAssets: FlutterAssets) {
+    val optionsController = MapboxOptionsController(flutterAssets)
     val snapshotterInstanceManager = SnapshotterInstanceManager(context, binaryMessenger)
     val offlineMapInstanceManager = OfflineMapInstanceManager(context, binaryMessenger)
     val offlineSwitch = OfflineSwitch()

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxOptionsController.kt

@@ -7,8 +7,11 @@ import com.mapbox.common.SettingsServiceFactory
 import com.mapbox.common.SettingsServiceStorageType
 import com.mapbox.maps.MapboxMapsOptions
 import com.mapbox.maps.mapbox_maps.pigeons.*
+import io.flutter.embedding.engine.plugins.FlutterPlugin.FlutterAssets
 
-class MapboxOptionsController : _MapboxMapsOptions, _MapboxOptions {
+class MapboxOptionsController(
+  private val flutterAssets: FlutterAssets
+) : _MapboxMapsOptions, _MapboxOptions {
   private val settingsService = SettingsServiceFactory.getInstance(SettingsServiceStorageType.PERSISTENT)
 
   override fun getAccessToken(): String {
@@ -39,6 +42,10 @@ class MapboxOptionsController : _MapboxMapsOptions, _MapboxOptions {
     return ""
   }
 
+  override fun getFlutterAssetPath(flutterAssetUri: String?): String? {
+    return flutterAssetUri?.replace("""^asset://(.+)""".toRegex(), "asset://${flutterAssets.getAssetFilePathBySubpath("$1")}")
+  }
+
   override fun setAssetPath(path: String) {
     // ignored on Android
   }