Search SDK 2.12.0 (#331)

* Versions bump

* Support multiple retrieve for the Detail API

* Support category IDs and bounding box for PlaceAutocomplete

* Update changelog and version bump

* Remove old tests suppresions

* Update Firebase device model

Author: DzmitryFomchyn

.circleci/config.yml

@@ -170,7 +170,7 @@ commands:
             gcloud firebase test android run \
             	--type robo --app MapboxSearch/sample/build/outputs/apk/release/sample-release.apk \
             	--device model=panther,version=33,locale=en,orientation=portrait \
-            	--device model=Nexus6,version=24,locale=en,orientation=portrait \
+            	--device model=MediumPhone.arm,version=26,locale=en,orientation=portrait \
             	--timeout 900s \
             	--project mapbox-search-android
 
@@ -182,8 +182,8 @@ commands:
           command: |
             gcloud firebase test android run \
             	--type instrumentation --app MapboxSearch/sample/build/outputs/apk/debug/sample-debug.apk --test MapboxSearch/sample/build/outputs/apk/androidTest/debug/sample-debug-androidTest.apk \
-            	--device model=Pixel2,version=30,locale=en,orientation=portrait \
-            	--device model=Nexus6,version=24,locale=en,orientation=portrait \
+            	--device model=Pixel2.arm,version=30,locale=en,orientation=portrait \
+            	--device model=MediumPhone.arm,version=26,locale=en,orientation=portrait \
             	--timeout 900s \
             	--project mapbox-search-android
 
@@ -204,8 +204,8 @@ commands:
             ./gradlew :<< parameters.module_name >>:assembleDebugAndroidTest -Pcoverage
             gcloud firebase test android run \
               --type instrumentation --app sample/build/outputs/apk/debug/sample-debug.apk --test << parameters.module_name >>/build/outputs/apk/androidTest/debug/<< parameters.archives_base_name >>-debug-androidTest.apk --environment-variables coverage=true,coverageFile=/sdcard/coverage.ec --directories-to-pull /sdcard --results-dir=$CIRCLE_BUILD_NUM \
-              --device model=Pixel2,version=30,locale=en,orientation=portrait \
-              --device model=Nexus6,version=24,locale=en,orientation=portrait \
+              --device model=Pixel2.arm,version=30,locale=en,orientation=portrait \
+              --device model=MediumPhone.arm,version=26,locale=en,orientation=portrait \
               --timeout 900s \
               --project mapbox-search-android
 

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog for the Mapbox Search SDK for Android
 
+## 2.12.0
+
+### New features
+- Added support for retrieving multiple search results at once in the `DetailsApi`.
+- Added new properties `PlaceAutocompleteSuggestion.categoryIds`, `PlaceAutocompleteResult.categoryIds`, and `PlaceAutocompleteResult.boundingBox`.
+
+### Mapbox dependencies
+- Search Native SDK `2.12.0`
+- Common SDK `24.12.0`
+
+
+
 ## 2.12.0-rc.1
 
 ### Mapbox dependencies

MapboxSearch/gradle.properties

@@ -21,7 +21,7 @@ android.enableJetifier=false
 kotlin.code.style=official
 
 # SDK version attributes
-VERSION_NAME=2.12.0-rc.1
+VERSION_NAME=2.12.0
 
 # Artifact attributes
 mapboxArtifactUserOrg=mapbox

MapboxSearch/gradle/versions.gradle

@@ -41,13 +41,13 @@ ext {
 
     pitest_version = '1.6.7'
 
-    mapbox_maps_version = '11.12.0-beta.1'
+    mapbox_maps_version = '11.12.0'
     mapbox_turf_version = '6.15.0'
 
-    common_sdk_version = '24.12.0-rc.1'
+    common_sdk_version = '24.12.0'
     mapbox_base_version = '0.8.0'
 
-    search_native_version = '2.12.0-rc.1'
+    search_native_version = '2.12.0'
 
     detekt_version = '1.19.0'
 

MapboxSearch/place-autocomplete/api/api-metalava.txt

@@ -63,7 +63,9 @@ package com.mapbox.search.autocomplete {
   @kotlinx.parcelize.Parcelize public final class PlaceAutocompleteResult implements android.os.Parcelable {
     method public com.mapbox.search.autocomplete.PlaceAutocompleteAddress? getAddress();
     method public Double? getAverageRating();
+    method public com.mapbox.geojson.BoundingBox? getBoundingBox();
     method public java.util.List<java.lang.String>? getCategories();
+    method public java.util.List<java.lang.String>? getCategoryIds();
     method public com.mapbox.geojson.Point getCoordinate();
     method public Double? getDistanceMeters();
     method public Double? getEtaMinutes();
@@ -81,7 +83,9 @@ package com.mapbox.search.autocomplete {
     method public String? getWebsite();
     property public final com.mapbox.search.autocomplete.PlaceAutocompleteAddress? address;
     property public final Double? averageRating;
+    property public final com.mapbox.geojson.BoundingBox? boundingBox;
     property public final java.util.List<java.lang.String>? categories;
+    property public final java.util.List<java.lang.String>? categoryIds;
     property public final com.mapbox.geojson.Point coordinate;
     property public final Double? distanceMeters;
     property public final Double? etaMinutes;
@@ -101,6 +105,7 @@ package com.mapbox.search.autocomplete {
 
   @kotlinx.parcelize.Parcelize public final class PlaceAutocompleteSuggestion implements android.os.Parcelable {
     method public java.util.List<java.lang.String>? getCategories();
+    method public java.util.List<java.lang.String>? getCategoryIds();
     method public com.mapbox.geojson.Point? getCoordinate();
     method public Double? getDistanceMeters();
     method public Double? getEtaMinutes();
@@ -110,6 +115,7 @@ package com.mapbox.search.autocomplete {
     method public java.util.List<com.mapbox.search.common.RoutablePoint>? getRoutablePoints();
     method public com.mapbox.search.autocomplete.PlaceAutocompleteType getType();
     property public final java.util.List<java.lang.String>? categories;
+    property public final java.util.List<java.lang.String>? categoryIds;
     property public final com.mapbox.geojson.Point? coordinate;
     property public final Double? distanceMeters;
     property public final Double? etaMinutes;

MapboxSearch/place-autocomplete/api/place-autocomplete.api

@@ -90,7 +90,9 @@ public final class com/mapbox/search/autocomplete/PlaceAutocompleteResult : andr
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getAddress ()Lcom/mapbox/search/autocomplete/PlaceAutocompleteAddress;
 	public final fun getAverageRating ()Ljava/lang/Double;
+	public final fun getBoundingBox ()Lcom/mapbox/geojson/BoundingBox;
 	public final fun getCategories ()Ljava/util/List;
+	public final fun getCategoryIds ()Ljava/util/List;
 	public final fun getCoordinate ()Lcom/mapbox/geojson/Point;
 	public final fun getDistanceMeters ()Ljava/lang/Double;
 	public final fun getEtaMinutes ()Ljava/lang/Double;
@@ -124,6 +126,7 @@ public final class com/mapbox/search/autocomplete/PlaceAutocompleteSuggestion :
 	public fun describeContents ()I
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getCategories ()Ljava/util/List;
+	public final fun getCategoryIds ()Ljava/util/List;
 	public final fun getCoordinate ()Lcom/mapbox/geojson/Point;
 	public final fun getDistanceMeters ()Ljava/lang/Double;
 	public final fun getEtaMinutes ()Ljava/lang/Double;

MapboxSearch/place-autocomplete/src/androidTest/java/com/mapbox/search/autocomplete/PlaceAutocompleteIntegrationTest.kt

@@ -188,7 +188,22 @@ internal class PlaceAutocompleteIntegrationTest {
         )
         assertEquals("restaurant", suggestion.makiIcon)
         assertEquals(PlaceAutocompleteType.Poi, suggestion.type)
-        assertEquals(listOf("food", "food and drink", "coffee shop", "coffee", "cafe", "bakery", "teahouse"), suggestion.categories)
+        assertEquals(
+            listOf("food", "food and drink", "coffee shop", "coffee", "cafe", "bakery", "teahouse"),
+            suggestion.categories,
+        )
+        assertEquals(
+            listOf(
+                "food",
+                "food_and_drink",
+                "coffee_shop",
+                "coffee",
+                "cafe",
+                "bakery",
+                "teahouse"
+            ),
+            suggestion.categoryIds
+        )
 
         val selectResponse = runBlocking {
             placeAutocomplete.select(suggestion)

MapboxSearch/place-autocomplete/src/main/java/com/mapbox/search/autocomplete/PlaceAutocompleteResult.kt

@@ -1,6 +1,7 @@
 package com.mapbox.search.autocomplete
 
 import android.os.Parcelable
+import com.mapbox.geojson.BoundingBox
 import com.mapbox.geojson.Point
 import com.mapbox.search.base.utils.extension.safeCompareTo
 import com.mapbox.search.common.RoutablePoint
@@ -39,6 +40,12 @@ public class PlaceAutocompleteResult internal constructor(
      */
     public val routablePoints: List<RoutablePoint>?,
 
+    /**
+     * Optional bounding box that represents the geographical boundaries of a location,
+     * e.g., a building.
+     */
+    public val boundingBox: BoundingBox?,
+
     /**
      * [Maki](https://github.com/mapbox/maki/) icon name for the place.
      */
@@ -70,6 +77,12 @@ public class PlaceAutocompleteResult internal constructor(
      */
     public val categories: List<String>?,
 
+    /**
+     * Canonical POI category IDs. Always empty for non-POI suggestions.
+     * @see type
+     */
+    public val categoryIds: List<String>?,
+
     /**
      * Business phone number.
      */
@@ -120,12 +133,14 @@ public class PlaceAutocompleteResult internal constructor(
         if (name != other.name) return false
         if (coordinate != other.coordinate) return false
         if (routablePoints != other.routablePoints) return false
+        if (boundingBox != other.boundingBox) return false
         if (makiIcon != other.makiIcon) return false
         if (!distanceMeters.safeCompareTo(other.distanceMeters)) return false
         if (!etaMinutes.safeCompareTo(other.etaMinutes)) return false
         if (address != other.address) return false
         if (type != other.type) return false
         if (categories != other.categories) return false
+        if (categoryIds != other.categoryIds) return false
         if (phone != other.phone) return false
         if (website != other.website) return false
         if (reviewCount != other.reviewCount) return false
@@ -146,12 +161,14 @@ public class PlaceAutocompleteResult internal constructor(
         result = 31 * result + name.hashCode()
         result = 31 * result + coordinate.hashCode()
         result = 31 * result + (routablePoints?.hashCode() ?: 0)
+        result = 31 * result + (boundingBox?.hashCode() ?: 0)
         result = 31 * result + (makiIcon?.hashCode() ?: 0)
         result = 31 * result + (distanceMeters?.hashCode() ?: 0)
         result = 31 * result + (etaMinutes?.hashCode() ?: 0)
         result = 31 * result + (address?.hashCode() ?: 0)
         result = 31 * result + type.hashCode()
         result = 31 * result + (categories?.hashCode() ?: 0)
+        result = 31 * result + (categoryIds?.hashCode() ?: 0)
         result = 31 * result + (phone?.hashCode() ?: 0)
         result = 31 * result + (website?.hashCode() ?: 0)
         result = 31 * result + (reviewCount ?: 0)
@@ -172,12 +189,14 @@ public class PlaceAutocompleteResult internal constructor(
                 "name='$name', " +
                 "coordinate=$coordinate, " +
                 "routablePoints=$routablePoints, " +
+                "boundingBox=$boundingBox, " +
                 "makiIcon=$makiIcon, " +
                 "distanceMeters=$distanceMeters, " +
                 "etaMinutes=$etaMinutes, " +
                 "address=$address, " +
                 "type=$type, " +
                 "categories=$categories, " +
+                "categoryIds=$categoryIds, " +
                 "phone=$phone, " +
                 "website=$website, " +
                 "reviewCount=$reviewCount, " +

MapboxSearch/place-autocomplete/src/main/java/com/mapbox/search/autocomplete/PlaceAutocompleteResultFactory.kt

@@ -28,6 +28,7 @@ internal class PlaceAutocompleteResultFactory {
                 etaMinutes = etaMinutes,
                 type = type,
                 categories = categories,
+                categoryIds = categoryIds,
                 underlying = PlaceAutocompleteSuggestion.Underlying.Suggestion(suggestion)
             )
         }
@@ -48,6 +49,7 @@ internal class PlaceAutocompleteResultFactory {
                 etaMinutes = etaMinutes,
                 type = type,
                 categories = categories,
+                categoryIds = categoryIds,
                 underlying = PlaceAutocompleteSuggestion.Underlying.Result(result)
             )
         }
@@ -81,12 +83,14 @@ internal class PlaceAutocompleteResultFactory {
                 name = name,
                 coordinate = coordinate,
                 routablePoints = routablePoints?.map { it.mapToPlatform() },
+                boundingBox = bbox,
                 makiIcon = makiIcon,
                 distanceMeters = distanceMeters,
                 etaMinutes = etaMinutes,
                 address = createPlaceAutocompleteAddress(this),
                 type = type,
                 categories = categories,
+                categoryIds = categoryIds,
                 phone = metadata?.phone,
                 website = metadata?.website,
                 reviewCount = metadata?.reviewCount,

MapboxSearch/place-autocomplete/src/main/java/com/mapbox/search/autocomplete/PlaceAutocompleteSuggestion.kt

@@ -60,6 +60,12 @@ public class PlaceAutocompleteSuggestion internal constructor(
      */
     public val categories: List<String>?,
 
+    /**
+     * Canonical POI category IDs. Always empty for non-POI suggestions.
+     * @see type
+     */
+    public val categoryIds: List<String>?,
+
     /**
      * Underlying data on which this [PlaceAutocompleteSuggestion] is based.
      */
@@ -85,6 +91,7 @@ public class PlaceAutocompleteSuggestion internal constructor(
         if (!etaMinutes.safeCompareTo(other.etaMinutes)) return false
         if (type != other.type) return false
         if (categories != other.categories) return false
+        if (categoryIds != other.categoryIds) return false
 
         return true
     }
@@ -102,6 +109,7 @@ public class PlaceAutocompleteSuggestion internal constructor(
         result = 31 * result + (etaMinutes?.hashCode() ?: 0)
         result = 31 * result + type.hashCode()
         result = 31 * result + (categories?.hashCode() ?: 0)
+        result = 31 * result + (categoryIds?.hashCode() ?: 0)
         return result
     }
 
@@ -118,7 +126,8 @@ public class PlaceAutocompleteSuggestion internal constructor(
                 "distanceMeters=$distanceMeters, " +
                 "etaMinutes=$etaMinutes, " +
                 "type=$type, " +
-                "categories=$categories" +
+                "categories=$categories, " +
+                "categoryIds=$categoryIds" +
                 ")"
     }