CHANGELOG.md

Changelog for the Mapbox Search SDK for Android

2.6.0

Mapbox dependencies

• Search Native SDK 2.6.0
• Common SDK 24.8.0

2.6.0-rc.1

Other

• The SearchEngine.createSearchEngine() and SearchEngine.createSearchEngineWithBuiltInDataProviders() functions, which do not accept ApiType as a parameter, have been deprecated. Please use functions that explicitly accept an ApiType instead.
• The SearchEngine.select() function, which allows selecting multiple suggestions, has been deprecated. From now on, you should select only one search suggestion at a time.
• The ApiType.SBS has been deprecated. Please use other ApiType values that better suit your use case.
• The PlaceAutocomplete.create(LocationProvider?, ApiType) function has been deprecated. Please use the function with the default api type.

Mapbox dependencies

• Search Native SDK 2.6.0-rc.1
• Common SDK 24.8.0-rc.1

2.6.0-beta.1

Mapbox dependencies

• Search Native SDK v2.6.0-beta.2
• Common SDK v24.8.0-beta.1

2.5.1

Bug fixes

• Passing language parameter on subsequent retrieve calls for SearchBox

Mapbox dependencies

• Search Native SDK v2.5.1

2.5.0

Bug fixes

• Fixed a copy and paste issue in the documentation for the OfflineSearchEngine.retrieve method

Mapbox dependencies

• Search Native SDK v2.5.0
• Common SDK v24.7.0

2.5.0-rc.2

New features

• Adding a toBuilder method to SearchResultMetadata class

Mapbox dependencies

• Search Native SDK v2.5.0-rc.2
• Common SDK v24.7.0-rc.1

2.5.0-beta.2

New features

• Adding Builder class to SearchResultMetadata class
• Adding CompletionCallback<Unit> to the AnalyticsService methods

2.5.0-beta.1

Mapbox dependencies

• Search Native SDK v2.5.0-beta.1
• Common SDK v24.7.0-beta.1

✨ New Features

• Introduced aliases translations and other improvements for offline category search

⚠️ Breaking changes

• This version of search-sdk is not binary compatible with old index and vice versa, old search-sdk is not compatible with new index

💫️ Other

• Deprecating avRating field
• Error handling for old datasets loading
• Upgrading MapboxCommon to v24.7.0-beta.1

2.4.0

Mapbox dependencies

• Search Native SDK 2.3.0

2.4.0-rc.3

New features

• Aligning SearchOptions to Search Native SDK
• Adding List<AttributeSet> to SelectOptions to support retrieving distinct attribute sets on SEARCH_BOX retrieve calls

Mapbox dependencies

• Search Native SDK 2.3.0-rc.3
• Common SDK v24.6.0

2.4.0-rc.2

Bug fixes

• Updating to the version of Common SDK v24.6.0-rc.1

Mapbox dependencies

• Common SDK v24.6.0-rc.1

2.4.0-rc.1

New features

• Adding support for AttributeSets when performing a retrieve
• Adding additional fields to SearchResultMetaData

Mapbox dependencies

• Search Native SDK 2.3.0-rc.4
• Common SDK v24.6.0-rc1

2.3.1

Mapbox dependencies

• Search Native SDK v2.2.1
• Common SDK v24.5.0

💫️ Other

• Performance improvements for short queries for offline search

2.3.0

Mapbox dependencies

• Search Native SDK v2.2.0
• Common SDK v24.5.0

2.3.0-rc.1

New features

• Updating SDK Intitialization
• Adding Debouncing to Sample Application
• feat(sample): loading offline tiles for sample activity
• fix(sample): Adding cleanup to the debouncer

Mapbox dependencies

• Search Native SDK v2.2.0-rc.1
• Common SDK v24.5.0-rc.1

2.3.0-beta.1

Mapbox dependencies

• Search Native SDK v2.2.0-beta.1
• Common SDK v24.5.0-beta.4

2.2.1

Bug fixes

• Fixes #197 clicking a "Recent Search" that is a favorite doesn't show as a favorite in the SearchPlaceBottomSheetView

2.2.0

New features

• Adding support for ApiType.SEARCH_BOX

Mapbox dependencies

• Search Native SDK v2.1.0
• Common SDK v24.4.0

2.2.0-rc.1

New features

• Adding support for ApiType.SEARCH_BOX

Mapbox dependencies

• Search Native SDK 2.1.0
• Common SDK 24.4.0

2.1.0

New features

• Location observer timeout can be configured now
• Updated default sample activity to default to ApiType.SBS
• Fixed a synchronization issue in OfflineSearchAlongRouteExampleActivity
• Fixed a bug in the default sample activity that crashed the activity when clicking on the map

2.0.0

New features

• [Online search] Add method to retrieve a POI by Mapbox ID
• [Offline search] Add optional language parameter to OfflineSearchEngine.createTilesetDescriptor and OfflineSearchEngine.createPlacesTilesetDescriptor functions.
• [UI] Added supports to select a single map feature to support map click events

Breaking changes

• [CORE] Undo renaming of all Discover-related terms to Category
• [Address Autofill, Place Autocomplete] Added a separate function reverse for coordinate-based searches.

2.0.0-beta.4

New features

• [Offline search] Offline Search Along Route
• [Offline search] Added bounding box filter for offline search functions
• [CORE] Added a new field called mapboxId to BaseSearchResult, SearchResult, CategoryResult and OfflineSearchResult
• [Address Autofill, Place Autocomplete] Added new fields called id and mapboxId to AddressAutofillResult and PlaceAutocompleteResult

Breaking changes

• [CORE] Access token needs to be assigned via MapboxOptions.accessToken now
• [CORE] Renamed all Discover-related terms to Category
• [Address Autofill, Place Autocomplete] Search is now a two-step action. It returns Suggestions (without the geo coordinate and routable points) at the first step and Result (with the geo coordinate and routable points) after the suggestion is selected. Thus, the coordinate field is no longer available in Suggestion.

Mapbox dependencies

• Search Native SDK 2.0.0-alpha.13
• Common SDK 24.0.0
• Maps SDK 11.0.0
• Kotlin 1.7.20

1.0.0-rc.8

New features

• [AUTOFILL] Improved AddressAutofill search output.

Bug fixes

• [CORE] Fixed empty SearchSuggestionType.Brand.brandName and SearchSuggestionType.Brand.brandId.
• [UI] Fixed a crash that could happen in SearchEngineUiAdapter when network connectivity status change.

Mapbox dependencies

• Search Native SDK 0.72.0
• Common SDK 23.7.0
• Kotlin 1.5.31

1.0.0-rc.7

Bug fixes

• [ALL] Fixed street name capitalization for names with numbers.
• [ALL] Fixed indexable records matching where a record with lower cased street wasn't matched correctly.

Mapbox dependencies

• Search Native SDK 0.71.0
• Common SDK 23.6.0
• Kotlin 1.5.31

1.0.0-rc.6

Breaking changes

• [CORE] SearchSuggestionType.IndexableRecordItem.type field has been replaced with record field which provides IndexableRecord instance.

Bug fixes

• [CORE] Now search suggestions and search results that are matched with IndexableRecords provide data from the backend which is likely to be up-to-date than data from IndexableRecord. Original IndexableRecord instance can be obtained from SearchSuggestionType.IndexableRecordItem.record and SearchResult.indexableRecord.
• [ALL] Fixed an issue where SBS backend doesn't always capitilized street names for POI results.
• [ALL] Fixed an issue where some POI results from SBS backend were missing "Ave/St/Avenue/Street" words in street names.

Mapbox dependencies

• Search Native SDK 0.70.0
• Common SDK 23.6.0
• Kotlin 1.5.31

1.0.0-rc.5

New features

• [CORE] Now SearchSuggestion might return suggestions with type SearchSuggestionType.Brand.

Breaking changes

• [CORE] Function SearchSelectionCallback.onCategoryResult() has been renamed to onResults(). Now this function is called when brand search suggestion is resolved.
• [UI] Similarly, function SearchEngineUiAdapter.onCategoryResultsShown() has been renamed to onSearchResultsShown().

Bug fixes

• [ALL] Fixed an issue with truncated formatted address.
• [ALL] Fixed an issue with excessive normalization of category names in request's url.

Mapbox dependencies

• Search Native SDK 0.69.0
• Common SDK 23.6.0-rc.1
• Kotlin 1.5.31

1.0.0-rc.4

New features

• [Place Autocomplete] Now PlaceAutocompleteSuggestion and PlaceAutocompleteResult provide new property etaMinutes.
• [Place Autocomplete] Now PlaceAutocompleteOptions accepts an additional parameter navigationProfile that determines how the distance and time of arrival (ETA) will be calculated.

Breaking changes

• [CORE] SearchNavigationProfile type has been renamed to NavigationProfile and moved to com.mapbox.search.common package.
• [Address Autofill] AddressAutofillSuggestion.result() function has been removed. Use AddressAutofill.select(AddressAutofillSuggestion) instead. Note that developers must call this function when user selects a search suggestion in the UI.

Bug fixes

• [Place Autocomplete] Fixed a bug with missing PlaceAutocompleteSuggestion.distanceMeters.

Mapbox dependencies

• Search Native SDK 0.68.0
• Common SDK 23.3.1
• Kotlin 1.5.31

1.0.0-rc.3

New features

• [Place Autocomplete] Now PlaceAutocompleteSuggestion provides additional property PlaceAutocompleteSuggestion.routablePoints.

Breaking changes

• [Place Autocomplete] PlaceAutocompleteSuggestion.result() function has been removed. Use PlaceAutocomplete.select(PlaceAutocompleteSuggestion) instead. Note that developers must call this function when user selects a search suggestion in the UI.

Mapbox dependencies

• Search Native SDK 0.68.0
• Common SDK 23.3.1
• Kotlin 1.5.31

1.0.0-rc.2

Bug fixes

• [CORE] Partially fixed a bug when indexable records couldn't be matched with corresponding search results which caused duplicated search results.
• [UI] Fixed a crash in SearchEngineUiAdapter that could happen during history records removing.

Mapbox dependencies

• Search Native SDK 0.67.2
• Common SDK 23.3.1
• Kotlin 1.5.31

1.0.0-rc.1

Breaking changes

• [CORE] Deprecated functions AnalyticsService.createRawFeedbackEvent() have been removed.

Mapbox dependencies

• Search Native SDK 0.67.1
• Common SDK 23.3.1
• Kotlin 1.5.31

1.0.0-beta.46

New features

• [CORE] Now SearchSuggestion and SearchResult types provide a new field fullAddress which contains formatted text address from backend.
• [DISCOVER] Now Discover SDK provides callback-based alternatives for Kotlin suspend functions.
• [DISCOVER] Now DiscoverResult provides a new field formattedAddress.
• [PLACE AUTOCOMPLETE] Place Autocomplete SDK is available now. See docs for more information.
• [UI] PlaceAutocompleteUiAdapter type is available. It's a helper class for connecting Place Autocomple SDK with the SearchResultsView.
• [UI] A new SearchPlace.createFromPlaceAutocompleteResult() function is available.

Breaking changes

• [CORE] com.mapbox.search.CompletionCallback has been moved to com.mapbox.search.common.CompletionCallback.
• [CORE] com.mapbox.search.ImageInfo has been moved to com.mapbox.search.common.metadata.ImageInfo.

Bug fixes

• [CORE] Fixed SearchSuggestion.name and SearchResult.name formatting for address types.
• [AUTOFILL] Fixed address formatting for AddressAutofillSuggestion.formattedAddress.

Mapbox dependencies

• Search Native SDK 0.67.1
• Common SDK 23.3.1
• Kotlin 1.5.31

1.0.0-beta.45

New features

• [UI] Now SearchResultsView will use mapboxSearchSdkBackgroundColor as a background color if background is not specified explicitly.

Breaking changes

• [Discover] Discover API has been renamed to Discover. Also, DiscoverApiAddress, DiscoverApiOptions, DiscoverApiQuery, DiscoverApiResult have been renamed to DiscoverAddress, DiscoverOptions, DiscoverQuery, DiscoverResult respectively.

Bug fixes

• [CORE] Fix a crash that could happen during unexpected backend metadata response.
• [OFFLINE] Update default tiles dataset name.

Mapbox dependencies

• Search Native SDK 0.66.0
• Common SDK 23.2.1
• Kotlin 1.5.31

1.0.0-beta.44

New features

• [Discover API] Discover API preview is available.
• [Autofill] Now AddressComponents provides new properties AddressComponents.countryIso1 and AddressComponents.countryIso2.

Breaking changes

• [CORE] OpenHours, OpenPeriod, WeekDay, WeekTimestamp, ParkingData classes have been moved to com.mapbox.search.common.metadata package.
• [CORE] Language has been renamed to IsoLanguageCode and moved to com.mapbox.search.common package.
• [CORE] Country has been renamed to IsoCountryCode and moved to com.mapbox.search.common package.
• [CORE] DistanceCalculator has been moved to com.mapbox.search.common package. ServiceProvider.distanceCalculator(latitude: Double) function is not available anymore, instead use DistanceCalculator.instance(latitude: Double).
• [CORE] HighlightsCalculator has been moved to com.mapbox.search.common package. ServiceProvider.higlightsCalculator() function is not available anymore, instead use HighlightsCalculator.INSTANCE.
• [Autofill] AddressAutofillOptions.Country and AddressAutofillOptions.Language have been removed and replaced by IsoCountryCode and IsoLanguageCode.
• [Autofill] AddressAutofillResponse type has been removed. Now AddressAutofill functions return Expected<Exception, List<AddressAutofillSuggestion>>.

Mapbox dependencies

• Search Native SDK 0.66.0
• Common SDK 23.2.1
• Kotlin 1.5.31

1.0.0-beta.43

Bug fixes

• [CORE] Search SDK does not longer implicitly set origin and proximity points in SearchOptions and CategorySearchOptions for SBS Api Type if either origin or proximity point is provided by a user.

Mapbox dependencies

• Search Native SDK 0.66.0
• Common SDK 23.2.1
• Kotlin 1.5.31

1.0.0-beta.42

Bug fixes

• [AUTOFILL] Fixed a bug in address autofill reverse geocoding.

Mapbox dependencies

• Search Native SDK 0.65.0
• Common SDK 23.2.0
• Kotlin 1.5.31

1.0.0-beta.41

Breaking changes

• [CORE] SearchAddress.FormatStyle.Custom has been removed because it can't guarantee correct formatting behavior. SearchAddress provides all the address components with the existing public API and customers still can format address according to needed formatting rules.
• [UI] SearchResultsView.defaultSearchOptions was not used and was removed from the API.

Bug fixes

• [CORE] Fixed a bug with SearchAddress formatting when address house number is empty.
• [CORE] Added a proguard rule that prevents DAO classes constructors from being removed.
• [UI] Fixed a bug in SearchResultsView when incorrect search options was used for request retry.

Mapbox dependencies

• Search Native SDK 0.64.0
• Common SDK 23.2.0-rc.3
• Kotlin 1.5.31
• Removed mapbox-android-core dependency, it is now part of Mapbox Common library. NOTE: You need to remove any explicit dependency declaration to com.mapbox.mapboxsdk:mapbox-android-core:<version> from the project to avoid duplicated class definition errors related to location APIs.

1.0.0-beta.40

Mapbox dependencies

• Search Native SDK 0.63.0
• Common SDK 23.2.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.39

New features

• [Autofill] Now AutofillSuggestion provides a new property name.
• [Autofill] Minimal allowed query name has been changed from 3 to 2.

Mapbox dependencies

• Search Native SDK 0.62.0
• Common SDK 23.1.0
• Kotlin 1.5.31

1.0.0-beta.38.1

Bug fixes

• [UI] Fixed a bug in SearchEngineUiAdapter where SearchListener.onPopulateQueryClick() was not called when user clicked the query populate button.

Mapbox dependencies

• Search Native SDK 0.61.0
• Common SDK 23.1.0-rc.1
• Kotlin 1.5.31

1.0.0-beta.38

Breaking changes

• [UI] SearchResultsView became a generic view that can work with any SearchEngine or Use case. Its API has been changed. Use SearchEngineUiAdapter to adapt search engines for the view. See MainActivity for usage sample.

New features

• [UI] Now UI module provides AddressAutofillUiAdapter that helps to display AddressAutofill suggestions on the SearchResultsView.
• [Autofill] Now customers can provide own implementation of the LocationEngine.
• [Autofill] AddressAutofill returns up to 10 suggestions instead of 5.
• [Search SDK COMMON] AsyncOperationTask provides AsyncOperationTask.COMPLETED field which represents completed task.

Mapbox dependencies

• Search Native SDK 0.61.0
• Common SDK 23.1.0-rc.1
• Kotlin 1.5.31

1.0.0-beta.37

Breaking changes

• [OFFLINE] OfflineSearchEngine's functions createTilesetDescriptor() and createPlacesTilesetDescriptor() are static now.
• [CORE] SearchSuggestion.categories, and SearchResult.categories are nullable properties now. These properties are null for non-POI search results.
• [CORE] ApiType.AUTOFILL has been removed. Use Autofill SDK instead.
• [CORE] MapboxSearcSdk.createSearchEngine(), and MapboxSearcSdk.createSearchEngineWithBuiltInDataProviders() functions have been moved to SearchEngine.createSearchEngine(), and SearchEngine.createSearchEngineWithBuiltInDataProviders().
• [CORE] MapboxSearcSdk.serviceProvider property has been removed, call ServiceProvider.INSTANCE instead.
• [CORE] MapboxSearchSdk class is not publicly available anymore.
• [CORE] IndexableRecord.coordinate is a non-null property now. Accordingly, HistoryRecord.coordinate is also a non-null property. This also makes SearchResult.coordinate a non-null property.
• [CORE] SearchResult is a class now. Functions signature of SearchCallback, SearchSelectionCallback, SearchMultipleSelectionCallback have been changed for Java users.
• [CORE] Subtypes ServerSearchResult, IndexableRecordSearchResult have been removed. Call SearchResult.IndexableRecord to check if a SearchResult is based on a IndexableRecord and access the record.
• [UI] Function signature of SearchResultsView.SearchListener have been changed for Java users.
• [UI] SearchPlace factory functions createFromSearchResult(), createFromIndexableRecord() no longer accept coordinate: Point arguments. Instead, coordinate will be taken from provided SearchResult, and IndexableRecord objects.

Mapbox dependencies

• Search Native SDK 0.60.0
• Common SDK 23.1.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.36

Breaking changes

• [CORE] AsyncOperationTask, SearchCancellationException, SearchRequestException, RoutablePoint have been moved to com.mapbox.search.common package. MainThreadWorker, and SearchSdkMainThreadWorker have been moved to com.mapbox.search.common.concurrent.
• [CORE] SearchRequestTask has been replaced with AsyncOperationTask
• [CORE] SearchSuggestion is a class now. Functions signature of SearchSuggestionsCallback, SearchSelectionCallback, SearchMultipleSelectionCallback have been changed for Java users.
• [CORE, UI] Offline functionality has been moved to a separate dependency which can be resolved via com.mapbox.search:offline:$version. Package name for offline functionality is com.mapbox.search.offline. At the moment Offline SDK version is the same as the main Search SDK version. OfflineSearchEngine instance can be retrieved via OfflineSearchEngine.create(OfflineSearchEngineSettings).
• [UI] SearchResultsView.SearchListener.onOfflineSearchResults() signature has been changed to onOfflineSearchResults(List<OfflineSearchResult>m OfflineResponseInfo). Also, a new function SearchResultsView.SearchListener.onOfflineSearchResult() has been added.

New features

• [CORE] FeedbackEvent.FeedbackReason now has few more reasons that can be used in the feedback: INCORRECT_PHONE_NUMBER, and INCORRECT_RESULT_RANK.
• [UI] A new function SearchPlace.createFromOfflineSearchResult() is available.

Bug fixes

• [UI] Now created in the SearchPlaceBottomSheetView FavoriteRecord will be saved with id from SearchPlace.id

Mapbox dependencies

• Search Native SDK 0.59.0
• Common SDK 23.0.0
• Kotlin 1.5.31

1.0.0-beta.35

Breaking changes

• [UI] Now SearchPlace constructor requires additional property id. copy() function's signature has also been changed.

New features

• [CORE] SearchResultType provides a new value - BLOCK which represents the block number. Available specifically for Japan.

Mapbox dependencies

• Search Native SDK 0.58.0
• Common SDK 23.0.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.34

Breaking changes

• [CORE] Undocumented system property used to enable SBS API Type is deprecated. Use MapboxSearchSdk.createSearchEngine(ApiType, SearchEngineSettings), and MapboxSearchSdk.createSearchEngineWithBuiltInDataProviders(ApiType, SearchEngineSettings) instead. Note that SBS Api Type is still in beta and not available publicly.
• [AUTOFILL] AddressAutofill.suggestions(String, AddressAutofillOptions) has been replaced with AddressAutofill.suggestions(Query, AddressAutofillOptions). Call Query.create() to create an instance of Query.

New features

• [CORE] MapboxSearchSdk.createSearchEngine(ApiType, SearchEngineSettings), and MapboxSearchSdk.createSearchEngineWithBuiltInDataProviders(ApiType, SearchEngineSettings) functions are available that allow to choose API Type. Note that ApiType.GEOCODING is the only API Type available publicly.
• [UI] SearchResultsView.Configuration accepts a new optional argument apiType used for the SearchEngine initialization.

Mapbox dependencies

• Search Native SDK 0.57.0
• Common SDK 22.1.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.33.1

New features

• [CORE] Now RequestOptions provides new fields endpoint and sessionID.

Bug fixes

• [CORE] Now SearchAddress.formattedAddress(FormatStyle.Medium) for address with country United States includes region.

Mapbox dependencies

• Search Native SDK 0.57.0
• Common SDK 22.1.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.33

Breaking changes

• [CORE] ServiceProvider.analyticsService() function has been removed. Now AnalyticsService instance is associated with SearchEngine, and OfflineSearchEngine. AnalyticsService can be retrieved from SearchEngine.analyticsService, and OfflineSearchEngine.analyticsService.
• [CORE] ServiceProvider.locationEngine() function has been removed. Now LocationEngine instance can be retrieved from settings used for search engines instantiation.
• [CORE] SearchSdkSettings class has been removed. Now default max number of history records is always 100.
• [CORE] Now SearchEngineSettings and OfflineSearchEngineSettings accept new constructor parameters. OfflineSearchEngineSettings.copy() function's signature and OfflineSearchEngineSettings.Builder have also been changed. SearchEngineSettings provides SearchEngineSettings.Builder type and new copy() and toBuilder() functions.
• [CORE] MapboxSearchSdk.initialize() function has been removed. Now it's not needed to initialize Search SDK explicitly.
• [CORE] MapboxSearchSdk.setAccessToken() function has been removed. Now in case of changed token a new instance of SearchEngine or OfflineSearchEngine should be created.
• [CORE] MapboxSearchSdk.getSearchEngine() function has been removed, call MapboxSearchSdk.createSearchEngine() function instead.
• [CORE] MapboxSearchSdk.createSearchEngine() function without parameters has been removed. Now SearchEngineSettings should always be provided as an argument.
• [CORE] MapboxSearchSdk.getOfflineSearchEngine() function has been removed, call MapboxSearchSdk.createOfflineSearchEngine() function instead.
• [CORE] OfflineSearchEngine.tileStore property has been removed, call OfflineSearchEngine.settings.tileStore instead.
• [CORE] Now ApiType has a new AUTOFILL constant.
• [UI] SearchResultsView.initialize() now accepts SearchResultsView.Configuration object.
• [UI] SearchBottomSheetView, SearchCategoriesBottomSheetView, SearchFeedbackBottomSheetView views are not supported anymore. These views and their nested types have been removed from the Search SDK. Also, unused types such as IncorrectSearchPlaceFeedback, FavoriteTemplate, Category are not available either.
• [UI] IncorrectSearchPlaceFeedback has been moved to com.mapbox.search.ui.view.place package.
• [AUTOFILL] AddressAutofill.create(searchEngine: SearchEngine) has been replaced with AddressAutofill.create(context: Context, accessToken: String).
• [AUTOFILL] AddressAutofillOptions.countries now is a list of AddressAutofillOptions.Country values and AddressAutofillOptions.language is AddressAutofillOptions.Language value.
• [AUTOFILL] AddressAutofillResult.address now is an instance of AddressAutofillResult.Address type.

New features

• [CORE] SearchEngine and OfflineSearchEngine provide settings property that return settings object used for engine initialization.
• [UI] Now clicked by a user in SearchResultsView search results will be automatically added to the search history.
• [AUTOFILL] Now autofill works on top of the special-purpose version of the Geocoding V5 API.

Mapbox dependencies

• Search Native SDK 0.57.0
• Common SDK 22.1.0-beta.1
• Kotlin 1.5.31

1.0.0-beta.32

Same release as 1.0.0-beta.31 but with Common SDK 22.0.0.

Mapbox dependencies

• Search Native SDK 0.56.0
• Common SDK 22.0.0
• Kotlin 1.5.31

1.0.0-beta.31

Breaking changes

• [CORE] OfflineSearchEngine is a 1-step search now, which means that SearchResult's returned in the first step without SearchSuggestion selection. OfflineSearchEngine.select() function has been removed. OfflineSearchEngine.search() accepts SearchCallback callback type.
• [CORE] Now automatically cancelled by the Search SDK search requests made to the SearchEngine and OfflineSearchEngine will be passing SearchCancellationException to the corresponding callbacks of SearchCallback, SearchSuggestionsCallback, and SearchSelectionCallback.
• [UI] Now SearchResultsView.SearchListener has a new function onOfflineSearchResults().

New features

• [CORE] Autofill SDK prototype is available now.
• [CORE] Now SearchResult provides a new accuracy field which is a point accuracy metric for the returned address.

Bug fixes

• [CORE] Fixed a bug in the previous version of the Search SDK which didn't include http service implementation by default.

Mapbox dependencies

• Search Native SDK 0.55.0
• Common SDK 21.3.0
• Kotlin 1.5.31

1.0.0-beta.30

Breaking changes

• [CORE] IndexableDataProvider.add(), and IndexableDataProvider.update() have been replaced with a new function IndexableDataProvider.upsert().
• [CORE] IndexableDataProvider.addAll() has been renamed to IndexableDataProvider.upsertAll().
• [CORE] IndexableDataProviderEngine.add(), and IndexableDataProviderEngine.update() have been replaced with a new function IndexableDataProviderEngine.upsert().
• [CORE] IndexableDataProviderEngine.addAll() has been renamed to IndexableDataProviderEngine.upsertAll().
• [CORE] IndexableDataProviderEngine.executeBatchUpdate() has been removed along with IndexableDataProviderEngine.BatchUpdateOperation. Now IndexableDataProviderEngine is a thread-safe entity. If you need multiple operations to be executed one after another, call them in a needed order on the same thread.
• [CORE] AnalyticsService.sendRawFeedbackEvent() has been removed. Events should be sent immediately.
• [CORE] AnalyticsService.createRawFeedbackEvent() functions have been made asynchronous and marked as deprecated. These functions return raw events in a very specific format and should not be used.

Mapbox dependencies

• Search Native SDK 0.54.1
• Common SDK 21.3.0
• Kotlin 1.5.31

1.0.0-beta.29.1

New features

• [CORE] SearchResult and SearchSuggestion now provide externalIDs property.

Mapbox dependencies

• Search Native SDK 0.52.0
• Common SDK 21.3.0-rc.2
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.29

Breaking changes

• [CORE] ServiceProvider.globalDataProvidersRegistry() has been removed. Now customers should use SearchEngine.registerDataProvider() for the data providers registration. Interface IndexableDataProvidersRegistry and its internal classes are not available anymore either.
• [CORE] Now IndexableDataProviders should provide priority field which affects IndexableRecord's ranking in case of multiple data providers added to a search engine.
• [CORE] IndexableDataProviderEngineLayer has been renamed to IndexableDataProviderEngine. Also, functions registerIndexableDataProviderEngineLayer() and unregisterIndexableDataProviderEngineLayer() of IndexableDataProvider have been renamed to registerIndexableDataProviderEngine() and unregisterIndexableDataProviderEngine().
• [CORE] Functionality of CategorySearchEngine, and ReverseGeocodingSearchEngine have been merged into SearchEngine. Also, functions MapboxSearchSdk.getCategorySearchEngine(), MapboxSearchSdk.getReverseGeocodingSearchEngine() have been removed, call MapboxSearchSdk.getSearchEngine() or MapboxSearchSdk.createSearchEngine() instead.
• [CORE] Constants MapboxSearchSdk.LAYER_PRIORITY_HISTORY, MapboxSearchSdk.LAYER_PRIORITY_FAVORITES have been moved HistoryDataProvider.PROVIDER_PRIORITY, and FavoritesDataProvider.PROVIDER_PRIORITY.
• [CORE] MapboxSearchSdk.addDataProviderInitializationCallback() and MapboxSearchSdk.removeDataProviderInitializationCallback() have been removed along with DataProviderInitializationCallback interface. Use HistoryDataProvider.OnDataProviderEngineRegisterListener(), and FavoritesDataProvider.OnDataProviderEngineRegisterListener() instead.
• [CORE] Fields SearchSdkSettings.geocodingEndpointBaseUrl, and SearchSdkSettings.singleBoxSearchBaseUrl have been removed. Now you can configure search engine endpoints with SearchEngineSettings. SearchSdkSettings.Builder and corresponding functions have also been removed. MapboxSearchSdk.initialize() now can accept SearchEngineSettings.
• [CORE] Class OfflineSearchSettings has been renamed to OfflineSearchEngineSettings. MapboxSearchSdk.initialize() argument offlineSearchSettings has also been renamed to offlineSearchEngineSettings.

New features

• [CORE] Now customers can create several independent from each other SearchEngines. See MapboxSearchSdk.createSearchEngine().
• [CORE] Now SearchRequestTask provides isDone, and isCancelled properties.

Mapbox dependencies

• Search Native SDK 0.52.0
• Common SDK 21.3.0-rc.2
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.28

New features

• [UI] Now SearchBottomSheetView shows all the available search history records along with their addresses.
• [UI] Now users can swipe history records left to remove a record from the the recent searches.

Bug fixes

• [UI] Now keyboard is hidden automatically when user navigates back from the feedback card or closes it.

Mapbox dependencies

• Search Native SDK 0.51.0
• Common SDK 21.2.0
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.27

New features

• [CORE] Now SearchSuggestion has a new categories property.
• [UI] SearchBottomSheetView has a new callback SearchBottomSheetView.OnSearchViewStateChangeListener that notifies subscribers when the "Main search view" changes it's state.

Breaking changes

• [CORE] Search SDK doesn't implicitly request android.permission.ACCESS_COARSE_LOCATION permission anymore. Default LocationEngine that's passed to MapboxSearchSdk.initialize() needs location access in order to work properly.
• [UI] SearchResultsView.SearchListener now has more callback functions: SearchListener.onSuggestions(), SearchListener.onCategoryResult(), and SearchListener.onError().

Mapbox dependencies

• Search Native SDK 0.50.0
• Common SDK 21.2.0-beta.1
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.26

New features

• [CORE] New properties are available SearchSuggestion.matchingName, SearchSuggestion.serverIndex, SearchResult.matchingName, SearchResult.serverIndex, ResponseInfo.responseUuid.
• [CORE] Now customers can provide their own feedback IDs in FeedbackEvent.feedbackId and MissingResultFeedbackEvent.feedbackId.
• [CORE] Now SearchSuggestion provides optional metadata property.
• [CORE] Now SearchResultMetadata provides optional countryIso1 and countryIso2 properties that provide country codes in ISO 3166-1 and ISO 3166-2. These properties are available for both SearchResult and SearchSuggestion types, in SBS and V5 APIs.

Bug fixes

• [CORE] Fixed GSON serialization for SearchResult and SearchSuggestion

Mapbox dependencies

• Search Native SDK 0.49.0
• Common SDK 21.1.0
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.25

Breaking changes

• [CORE] Public interfaces SearchResult, ServerSearchResult, IndexableRecordSearchResult, SearchSuggestion have been marked as sealed as they were not supposed to be implemented by external code.
• [UI] Now SearchCategoriesBottomSheetView.CategoryLoadingStateListener.onLoadingError() callback provides one more parameter - Exception occurred during the request.
• [UI] Now SearchCategoriesBottomSheetView.CategoryLoadingStateListener.onCategoryResultsLoaded() callback provides one more parameter - ResponseInfo which contains response information.

New features

• [CORE, UI] Now Search SDK documentation and source code is visible in Android Studio.

Bug fixes

• [CORE] Now SearchRequestException contains original detail error message returned from the backend.

Mapbox dependencies

• Search Native SDK 0.47.0
• Common SDK 21.1.0-rc.1
• Telemetry SDK 8.1.1
• Kotlin 1.5.31

1.0.0-beta.24

Breaking changes

• [UI] Now initialization methods SearchPlaceBottomSheetView.initialize(), SearchCategoriesBottomSheetView.initialize(), SearchResultsView.initialize() have to be called in order to make these views work properly.

New features

• [UI] Now you can provide distance unit type (imperial or metric) used for views visual information via initialization methods of the views: SearchBottomSheetView.initializeSearch(), SearchPlaceBottomSheetView.initialize(), SearchCategoriesBottomSheetView.initialize(), SearchResultsView.initialize().

Bug fixes

• [UI] Fixed a bug with uninitialized properties in created from SearchBottomSheetView favorite record.

Mapbox dependencies

• Search Native SDK 0.46.1
• Common SDK 21.0.1
• Telemetry SDK 8.1.0
• Kotlin 1.4.21

1.0.0-beta.23

Breaking changes

• [CORE] Signature of OfflineSearchEngine.select(SearchSuggestion, Executor, SearchSelectionCallback): SearchRequestTask function has been changed, now it also accepts SelectOptions.
• [CORE] Functions MapboxSearchSdk.createCategorySearchEngine(), MapboxSearchSdk.createReverseGeocodingSearchEngine() and MapboxSearchSdk.createSearchEngine() have been replaced with MapboxSearchSdk.getCategorySearchEngine(), MapboxSearchSdk.getReverseGeocodingSearchEngine() and MapboxSearchSdk.getSearchEngine() functions accordingly. Now SDK consumers can access only single instance of each search engine.
• [CORE] MapboxSearchSdk.initialize() now accepts com.mapbox.android.core.location.LocationEngine instead of com.mapbox.search.location.LocationProvider, argument name has also been changed from locationProvider to locationEngine. com.mapbox.search.location.LocationProvider, com.mapbox.search.location.DefaultLocationProvider, com.mapbox.search.location.PointLocationProvider have been removed. Now you can use com.mapbox.android.core.location.LocationEngineProvider.getBestLocationEngine(Context) to get a default implementation of LocationEngine.
• [CORE] Function com.mapbox.search.ServiceProvider.locationProvider() has been removed, now ServiceProvider.locationEngine() is available which returns instance of com.mapbox.android.core.location.LocationEngine.
• [CORE] OfflineSearchEngine.createBoundariesTilesetDescriptor() has been renamed to createPlacesTilesetDescriptor().
• [UI] SearchPlace has a new property feedback, constructor and copy function signature have been changed.
• [UI] Now SearchPlace.createFromSearchResult() requires ResponseInfo as an additional argument.
• [UI] SearchBottomSheetView.OnSearchResultClickListener.onSearchResultClick() and SearchCategoriesBottomSheetView.OnSearchResultClickListener.onSearchResultClick() receive ResponseInfo as an additional argument.
• [UI] SearchResultsView.SearchListener's functions onSearchResult() and onPopulateQueryClicked() now receive ResponseInfo as an additional argument.

New features

• [CORE] IndexableDataProviderEngineLayer class now can be called from any thread.
• [CORE] Now selected search suggestions from OfflineSarchEngine are added to HistoryDataProvider by default. You can manage this behavior by passing custom SelectOptions to select() function.
• [CORE] New functions IndexableDataProviderEngineLayer.removeAll() and IndexableDataProviderEngineLayer.executeBatchUpdate() and new interface IndexableDataProviderEngineLayer.BatchUpdateOperation have been introduced. Now user can remove several records in one go and also specify several operations that should be executed atomically for a given engine layer.
• [CORE] Now OfflineSearchEngine has a new functions for selecting preferable tileset - selectTileset().
• [CORE] Also, OfflineSearchEngine can notify users of index change events. Add a listener via addOnIndexChangeListener() to get these events.
• [UI] Now SearchPlaceBottomSheetView class notifies users about adding specific SearchPlace to favorites via SearchPlaceBottomSheetView.OnSearchPlaceAddedToFavoritesListener.
• [UI] SearchPlaceBottomSheetView has a new Feedback button that enables users to report issues and send feedback on search quality. With this functionality also come OnFeedbackClickListener and functions to add/remove feedback listeners. Customers have to use SearchFeedbackBottomSheetView or implement feedback UI on their own.
• [UI] Now a new view SearchFeedbackBottomSheetView which implements feedback workflow is available. Customers can add their own listener via addOnFeedbackSubmitClickListener() to hook feedback sending to define their own behavior.
• [UI] Now SearchBottomSheetView has new interfaces OnFeedbackClickListener, and OnFeedbackSubmitClickListener. Customers can add their own listeners via addOnFeedbackClickListener, and addOnFeedbackSubmitClickListener() to hook feedback sending and define custom behavior.

Bug fixes

• [CORE] Fixed bug related to unexpected cancellation of scheduled SearchEngine request when another search request was fired from CategorySearchEngine or from another SearchEngine.
• [CORE] Fixed bug in HistoryDataProvider when records weren't removed from IndexableDataProviderEngineLayer during the trimming of obsolete records.
• [UI] Fixed several bugs related to state restoration, keyboard showing and UI lagginess.

Mapbox dependencies

• Search Native SDK 0.44.1
• Common SDK 20.1.1
• Telemetry SDK 8.1.0

1.0.0-beta.22

Breaking changes

• [UI] SearchMode now has a new value AUTO. If search mode set to AUTO, UI will determine online/offline mode automatically based on the device's network reachability.
• [CORE] OfflineSearchEngine functions getTileRegions(), getGroupInfo(), loadTileRegion(), updateTilesGroup(), removeTilesGroup() have been removed. Now you should use TileStore directly to work with offline data.
• [CORE] Signature of EngineReadyCallback.onEngineReady() has been changed. Now this function has no arguments.
• [CORE] Properties OfflineSearchSettings.tilesDataset and OfflineSearchSettings.tilesVersion and their corresponding Builder properties have been remove. Now dataset and version parameters can be specified during TilesetDescriptor creation.
• [CORE] OfflineSearchEngine.addOflineRegion() function and AddRegionCallback interface have been removed. Now you can use TileStore to manage offline data.

New features

• [CORE] DefaultLocationProvider class now can be called from any thread.
• [CORE] A new property OfflineSearchEngine.tileStore is available. It returns TileStore object used for offline tiles management.

Mapbox dependencies

• Common SDK 20.1.0
• Telemetry SDK 8.1.0

1.0.0-beta.21

Breaking changes

• [CORE] Enum QueryType has a new type - CATEGORY. Now users can receive category-only search results. Please note: this type is restricted for internal or special use.
• [CORE] SearchEngine.select(SearchSuggestion, Executor, SearchSelectionCallback) method signature has been changed to SearchEngine.select(SearchSuggestion, SelectOptions, Executor, SearchSelectionCallback): now user can control whether SearchEngine should automatically add final result to the history or not.

New features

• [CORE] @Deprecated annotations for Geocoding-specific search options have been removed.
• [CORE] New function SearchEngine.select(SearchSuggestion, SelectOptions, SearchSelectionCallback) is available.
• [CORE] SelectOptions class has been introduced.

Bug fixes

• [CORE] Fixed a bug in OfflineSearchEngine when tiles modifying functions such as loadTileRegion(), updateTilesGroup(), removeTilesGroup() were called before engine got initialized.

Mapbox dependencies

• Common SDK 20.0.0
• Telemetry SDK 8.1.0

1.0.0-beta.20

Breaking changes

• [CORE] MainThreadWorker has a new property mainExecutor that returns an executor working on the main thread. All the subclasses now have to implement this property.
• [CORE] Similarly to search engines, asynchronous functions of IndexableDataProvider may accept optional parameter Executor. All the subclasses now have to implement these functions.
• [CORE] OfflineTileRegion's constructor has been made internal. Also, its copy function has been removed.
• [CORE] Signature of the function OfflineSearchEngine.loadTileRegion() has been changed, now it accepts additional progressCallback parameter. callback parameter has been renamed to completionCallback.

New features

• [CORE] Now you can pass OfflineSearchSettings to MapboxSearchSdk.initialize() to override offline search settings.
• [CORE] Now asynchronous functions of SearchEngine, ReverseGeocodingSearchEngine, CategorySearchEngine, OfflineSearchEngine, IndexableDataProvider, IndexableDataProvidersRegistry may accept optional parameter Executor used for events dispatching. By default events are still dispatched on the main thread.
• [CORE] New function OfflineSearchEngine.getGroupInfo() is available. This function provides group meta info.
• [CORE] New function OfflineSearchEngine.updateTilesGroup() is available. This function updates the existing tiles group.

Mapbox dependencies

• Common SDK 19.0.0
• Telemetry SDK 8.1.0

1.0.0-beta.19.1

Mapbox dependencies

• Common SDK 19.0.0
• Telemetry SDK 8.1.0

1.0.0-beta.19

Breaking changes

• [CORE] IndexableDataProvider.CompletionCallback has been moved to upper level package com.mapbox.search.

New features

• [CORE] Now customers can override logger. See Mapbox Android Modularization for more information.
• [CORE] A new functionality to work with offline data has been added to OfflineSearchEngine.
• [CORE] Now customers can add custom data providers. As a result, new classes (IndexableDataProvidersRegistry and IndexableDataProviderEngineLayer) have been added and also few extra methods and properties have been added to exisitng API. Take a look at new samples for more information.
• [CORE] New functions MapboxSearchSdk.addDataProviderInitializationCallback() and MapboxSearchSdk.removeDataProviderInitializationCallback() have been introduced. Now users can receive notifications about default data providers (history and favorites) successful or failed initialization.

Bug fixes

• [CORE] Fix failed Search SDK requests for cases, when application label contains non-ASCII symbols.

Mapbox dependencies

• Common SDK 18.0.0
• Telemetry SDK 8.1.0

1.0.0-beta.18

Breaking changes

• [CORE] Now OfflineSearchEngine.addOfflineRegion() doesn't implicitly add .cont extensions for offline data files.

New features

• [CORE] Now customers can override native library loader. See Mapbox Android Modularization for more information.

Mapbox dependencies

• Common SDK 17.0.0
• Telemetry SDK 8.1.0

v1.0.0-beta.17

Breaking changes

• [CORE] MapboxSearchSdk.initialize() function's signature has been changed: geocodingEndpointBaseUrl and singleBoxSearchBaseUrl parameters have been removed and new parameter searchSdkSettings: SearchSdkSettings has been added. With new SearchSdkSettings class user can specify not only search endpoints, but also maximum allowed HistoryRecords amount in HistoryDataProvider.
• [CORE] SearchSuggestionType.IndexableRecordItem's constructor has been changed: new parameter type: SearchResultType has been added. Now user can get the type of resolved IndexableRecord before the selection of SearchSuggestion, associated with given IndexableRecordItem.
• [CORE] SearchSuggestionType.SearchResultSuggestion, SearchSuggestionType.Category and SearchSuggestionType.IndexableRecordItem constructors visibility have been reduced to internal.

New features

• [CORE] MainThreadWorker and SearchSdkMainThreadWorker classes are now public, they can be used to override main thread job handler which can be useful for testing.
• [UI] Now history records matched with saved favorites will be marked as favorites in the search history view.

Bug fixes

• [UI] Fix for suggestion clicks processing.

Mapbox dependencies

• Common SDK 16.2.0
• Telemetry SDK 8.1.0

v1.0.0-beta.16

Breaking changes

• [UI] Functions Category.findBySBSName() and Category.findByName() have been removed, now you can use Category.findByCanonicalName() which looks up for a Category by any of SBS or geocoding canonical names.

New features

• [UI] Now com.mapbox.search.ui.view.category.Category's constructor and properties are public, you can instantiate a new category to be used in the UI Search SDK.
• [UI] Expose maxWidth layout parameter for SearchSdkFrameLayout class and its subclasses in public API.

Mapbox dependencies

• Common SDK 16.0.0
• Telemetry SDK 8.1.0

v1.0.0-beta.15

Breaking changes

• [CORE] Async functions in IndexableDataProvider and OfflineSearchEngine.addOfflineRegion() now return AsyncOperationTask object instead of Future.
• [CORE] Function DistanceCalculator.squareDistance() has been removed.
• [UI] Property SearchBottomSheetView.Configuration.searchOptions and corresponding Configuration.Builder function have been removed. Now you can provide SearchOptions through SearchBottomSheetView.searchOptions and override them for each new request.
• [UI] New distanceMeters property has been added to SearchPlace. Therefore, copy(), createFromSearchResult() and createFromIndexableRecord() methods and SearchPlace constructor accept distanceMeters parameter now.

New features

• [CORE] New distanceMeters property has been added to SearchResult.
• [CORE] Now SearchOptions.indexableRecordsDistanceThresholdMeters and CategorySearchOptions.indexableRecordsDistanceThresholdMeters options are available that allow to look up for indexable records only within specified distance threshold.
• [UI] Now user can edit name and can delete favorite, created from template (e.g. Work template).
• [UI] Now you can provide CategorySearchOptions that will be used for search request in SearchCategoriesBottomSheetView. Options can be provided via fun open(category: Category, searchOptions: CategorySearchOptions).
• [UI] New updateDistance() method has been added to SearchPlaceBottomSheetView.

Bug fixes

• [CORE] Fixed a bug with uninitialized in some cases SearchResultMetadata properties.

Mapbox dependencies

• Common SDK 14.2.0
• Telemetry SDK 8.1.0

v1.0.0-beta.14

Breaking changes

• [CORE] All operations in IndexableDataProvider classes now are asynchronous.
• [CORE] Property LocalDataProvider.size has been removed, now it's recommended to get size of the provider by calling IndexableDataProvider.getAll().
• [CORE] Now OfflineSearchEngine.addOfflineRegion() returns a Future<Boolean> representing pending completion of the task. This change may break existing code in rare cases.

New features

• [CORE] OfflineSearchEngine has a new function fun searchAddressesNearby(street: String, proximity: Point, radiusMeters: Double, callback: SearchCallback) that searches for addresses nearby.

v1.0.0-beta.13

Breaking changes

• [CORE] Offline data format has been changed, you'll need to obtain new offline data to work with offline.
• [CORE] In the previous versions, some internal classes were available publicly, they had the internal keyword in the package name. Now such classes are not available anymore. Normally, external customers shouldn't have accessed internal classes in their projects, however, this change may break customer's code.

New features

• [UI] Landscape support.
• [UI] SearchBottomSheetView, SearchCategoriesBottomSheetView and SearchPlaceBottomSheetView classes extend from SearchSdkFrameLayout class now. This new class allows users to specify maxWidth of the view.

Bug fixes

• [CORE] Fixed a bug with uninitialized properties in search suggestions and search results based on indexable records.

v1.0.0-beta.12

New features

• [UI] Dark Mode support.
• [UI] Color palette customization has been added. Take a look at new sample for more information.
• [UI] Now SearchBottomSheetView returns clicked HistoryRecords via SearchBottomSheetView.OnHistoryClickListener. In the previous SDK versions when a user clicked on a HistoryRecords, a new search started using the record's name as a query.

Breaking changes

• [UI] SearchPlace.createFromUserFavorite(FavoriteRecord) removed, use SearchPlace.createFromIndexableRecord(IndexableRecord, Point) instead.

v1.0.0-beta.11

Breaking changes

• [CORE] The following methods now require extra responseInfo: ResponseInfo parameter:
  • AnalyticsService.createRawFeedbackEvent(searchResult: SearchResult)
  • AnalyticsService.createRawFeedbackEvent(searchSuggestion: SearchSuggestion)
  • AnalyticsService.sendFeedback(searchResult: SearchResult)
  • AnalyticsService.sendFeedback(searchSuggestion: SearchSuggestion)

New features

• [CORE] FeedbackEvent.FeedbackReason annotation class has been added which helps us to enforce developers to use one of predefined constants for FeedbackEvent.reason property. Currently available constants are:
  • FeedbackReason.INCORRECT_NAME
  • FeedbackReason.INCORRECT_ADDRESS
  • FeedbackReason.INCORRECT_LOCATION
  • FeedbackReason.OTHER

v1.0.0-beta.10

Breaking changes

• [CORE] OfflineSearchEngine.addOfflineRegion() function's signature has been changed, now it accepts callback to be invoked when the region has been added.
• [UI] Data classes SearchPlace and FavoriteTemplate have been replaced with regular classes. As a result, all componentN() methods have been removed and FavoriteTemplate.copy() method has been removed.
• [UI] Enum class Category has been replaced with a regular class. All predefined Category values can be retrieved with Category.PREDEFINED_CATEGORY_VALUES property.
• [UI] Enum classes SearchBottomSheetView.BottomSheetState, SearchCategoriesBottomSheetView.BottomSheetState, SearchPlaceBottomSheetView.BottomSheetState have been replaced with annotation classes, annotated with @IntDef.

v1.0.0-beta.9

Breaking changes

• [CORE] Almost all public data classes, sealed classes and enum classes API have been changed.

New features

• [CORE, UI] OfflineSearchEngine has been added which provides offline search functionality. Contact our team to get more information on how to use it and where to get offline data.

Bug fixes

• [CORE] Fixed NPE that could be thrown on some specific Android devices.

v1.0.0-beta.8

Breaking changes

• [CORE, UI] Minimum Android SDK version 21, OkHttp 4.9.0.
• [CORE] SearchResultType enum types order have been changed. Now all types are sorted in descending order by the size of the associated geofeature.

New features

Bug fixes

• [CORE] Fixed a bug with SearchSuggestionType.Category() where property canonicalName was incorrect.
• [UI] Functions findByName() and findBySBSName() from Category class now work properly: findByName() finds categories for names associated with Geocoding endpoint, findBySBSName() - for names associated with SBS endpoints.

v1.0.0-beta.7

Breaking changes

• [CORE] WeekTimestamp class API has been changed:
  • hour and minute properties type has been changed from Byte to Int.
  • day property type has been changed from Byte to WeekDay. Also, new WeekDay enum class has been added. This class represents one of days of the week (Monday, ..., Sunday).
• [CORE] HistoryRecord and FavoriteRecord constructor signatures have been changed.
• [CORE] FavoriteRecord.categories property now is nullable.
• [UI] SearchPlace.categories property now is nullable.

New features

• [CORE] Now IndexableRecord interface provides new properties: routablePoints, metadata, descriptionText, categories, makiIcon. Their semantic is the same as in the corresponding fields of the SearchResult.

v1.0.0-beta.6.1

New features

• [CORE] New AnalyticsService.createRawFeedbackEvent() methods have been added. This methods allow users to create raw feedback event, that can be cached and used later. Also, AnalyticsService.sendRawFeedbackEvent() method has been added, so users could send feedback event, based on provided raw feedback event.

v1.0.0-beta.6

Breaking changes

• [CORE] SearchCallback.onResults(), SearchSuggestionsCallback.onSuggestions(), SearchSelectionCallback.onResult(), SearchMultipleSelectionCallback.onResult() function signatures have been changed: now each function accepts ResponseInfo parameter, the information about search response and associated search request.
• [CORE] Batch retrieve method SearchEngine.select(List<SearchSuggestion>,SearchMultipleSelectionCallback): SearchRequestTask now requires provided list of suggestions to be non-empty and also each SearchSuggestion should have same RequestOptions, so request will be processed correctly.
• [CORE] CategorySearchOptions.types property and its corresponding builder field and functions have been removed.
• [CORE] Enum QueryType has a new type - STREET.
• [CORE] SearchResultSuggestion property type: SearchResultType has been replaced with property types: List<SearchResultType>. Also, SearchResult property type: SearchResultType has been replaced with property types: List<SearchResultType> and SearchPlace property resultType: SearchResultType has been replaced with property resultTypes: List<SearchResultType>.
• [CORE] Now RouteOptions.Deviation.Time constructor requires extra sarType: SarType? parameter.
• [CORE] SearchOptions.navigationProfile: SearchNavigationProfile property and its corresponding builder field and function have been removed. Instead, new SearchOptions.navigationOptions: SearchNavigationOptions property and corresponding SearchOptions.Builder.navigationOptions builder field and SearchOptions.Builder.navigationOptions() function have been added.
• [UI] Now SearchPlace also provides descriptionText field. SearchPlace's constructor signature has been changed.

New features

• [CORE] New AnalyticsService.sendMissingResultFeedback() method has been added. This method allows users to send feedback for use cases, when expected POI / place wasn't found in search results. Also new MissingResultFeedbackEvent class has been added.
• [CORE] New sessionId property has been added to FeedbackEvent.
• [CORE] New EtaType, SearchNavigationOptions, RouteOptions.Deviation.SarType classes have been added. Also, RouteOptions.Deviation and its subclasses has new sarType: SarType? property.
• [CORE] Similarly to the SearchSuggestion type, now SearchResult also provides descriptionText field.
• [UI] All types of SearchSuggestion/SearchResult will be shown in the description label (previously only first was shown).

v1.0.0-beta.5

Breaking changes

• [CORE] RequestOptions primary constructor visibility has been reduced to internal. Now you can not create RequestOptions objects.
• [CORE] com.mapbox.search.NavProfile has been renamed to com.mapbox.search.SearchNavigationProfile. Consequently, com.mapbox.search.SearchOptions.navProfile and com.mapbox.search.SearchOptions.Builder.navProfile properties have been renamed to navigationProfile. Also, com.mapbox.search.SearchOptions.Builder.navProfile() function have been renamed to navigationProfile() and accepts SearchNavigationProfile instead of the old type.
• [CORE] Property searchResultType in com.mapbox.search.record.HistoryRecord and com.mapbox.search.record.FavoriteRecord classes has been renamed to type. Now type became common property for all the Indexable Records.
• [CORE] CategorySearchEngine function signature has been changed: now search() accepts options parameter of CategorySearchOptions type. Class CategorySearchOptions contains search options, used for category search (previously those options were stored inside SearchOptions). Both CategorySearchOptions and SearchOptions class signatures are identical.
• [CORE] ReverseGeoOptions.countries and ReverseGeoOptions.reverseMode options have been marked as deprecated along with ReverseMode enum. These entities will be removed in the future updates.

New features

• [CORE] New AnalyticsService and FeedbackEvent classes have been added. AnalyticsService helps users track analytics events. For now only feedback events can be tracked. User should provide SearchResult / SearchSuggestion / IndexableRecord object and FeedbackEvent object, describing user's feedback.
• [CORE] NewServiceProvider.analyticsService() method has been added, which returns instance of AnalyticsService.
• [CORE] New unsafeParameters property has been added to SearchOptions. The corresponding unsafeParameters property and unsafeParameters() method have been added to SearchOptions.Builder.
• [CORE] openHours, parking, cpsJson properties have been added to SearchResultMetadata. Also OpenHours, OpenPeriod, WeekTimestamp, ParkingData classes have been added.
• [CORE] New ignoreIndexableRecords property now available in SearchOptions, and CategorySearchOptions. This property specifies whether to ignore IndexableRecord results or not, default is false. Semantic is the same for both SearchOptions, and CategorySearchOptions.

Bug fixes

• [CORE] Fixed a bug due to which search results based on Indexable Records could be with types not specified in SearchOptions.

v1.0.0-beta.4.1

Bug fixes

• [CORE] Fixed a bug that caused to fail in some cases search request with IndexableRecords included.
• [UI] Category canonical name updated.

v1.0.0-beta.4

Breaking changes

• [CORE] New SearchSuggestionType subtype has been added, which may break existing code in some cases.
• [CORE] proximity, origin and navProfile properties have been removed from RequestOptions.
• [CORE] SearchResultMetadata's API has been significantly changed.
  • Function SearchResultMetadata.getAllData() has been removed. Instead extraData property is available. This property provides the data that is not available via the other properties of the class.
  • Constants KEY_PHONE, KEY_WEBSITE, KEY_REVIEW_COUNT, KEY_AVERAGE_RATING were removed. Instead, use phone, website, reviewCount, averageRating properties directly.

New features

• [CORE] New SearchSuggestionType subtype has been added. Now SearchSuggestion can have Query type, which means that selection of this suggestion type will result in new suggestions.
• [CORE] Now you can search along a route, pass RouteOptions to SearchOptions to configure route parameters.
• [CORE] Now SearchResultMetadata provides associated with search result photos and also provides a new description property.
• [CORE] Now SearchSuggestion has an optional address property.
• [CORE] Now RequestOptions has new options property and additional proximityRewritten and originRewritten flags that denote whether options have been modified by the Search SDK.

Bug fixes

• [CORE] Fixed a bug that happened when backend sent suggestion with POSTCODE type.
• [UI] Now UI SDK always shows address if it's available.

v1.0.0-beta.3

Breaking changes

• [CORE] SearchSelectionCallback functions signatures have been changed, now onResult and onCategoryResult accept SearchSuggestion parameter, the suggestion from which the result was resolved.
• [CORE] New fields have been added to HistoryRecord and FavoriteRecord data classes which may break existing code.
• [CORE] String resource app_name has been removed from the core SDK. This resource was public by mistake and external modules normally shouldn't have used this.

New features

• [CORE] Batch retrieve for search suggestions has been added. Call SearchEngine.select(List<SearchSuggestion>,SearchMultipleSelectionCallback): SearchRequestTask to resolve multiple suggestions at once.
• [CORE] Now if you have a token with special permissions, you'll be receiving POI metadata if it's available. Metadata is available in SearchResult, also, it can be stored in HistoryRecord and FavoriteRecord.
• [CORE] Now you can request ETA to search suggestions and results for forward geocoding. Specify origin point and navProfile type in SearchOptions to request ETA. ETA for reverse geocoding is to be added.
• [CORE] Now routable points are available for search results, also, it can be stored in HistoryRecord and FavoriteRecord.

Bug fixes

• [CORE] Fixed a crash that happened after consecutive selection of SearchSuggestion within one session.
• [UI] Now recent search history view doesn't show duplicating history entries.
• [UI] Prevent SearchCategoriesBottomSheetView and SearchResultsView from leaking, when used by Fragment.

v1.0.0-beta.2

Breaking changes

• [CORE] Parameter endpointBaseUrl of the MapboxSearchSdk.initialize() method has been renamed to geocodingEndpointBaseUrl. In addition, new parameter named singleBoxSearchBaseUrl has been added to specify Single Box Search API endpoint.
• [CORE] Enum SearchResultType now has two more types - PLACE and STREET.
• [CORE] SearchSuggestion.TypeDescription has been transformed to a new type called SearchSuggestionType. See documentation of SearchSuggestionType for more details. Also property typeDescription of the SearchSuggestion type has been renamed to type.
• [CORE] SearchCategorySuggestion type has been removed. Use SearchSuggestion.type to check if a suggestion is a category.
• [CORE] SearchSelectionCallback.onCategoryResult(results: List<SearchResult>) callback has been added.
• [UI] From SearchBottomSheetView, SearchPlaceBottomSheetView, SearchCategoriesBottomSheetView classes removed functions that were available to simplify interaction with Kotlin functional interfaces. With Kotlin 1.4.0 SAM conversions for Kotlin interfaces are available and these functions are not needed anymore. Removing these functions from the SDK may bring breaking changes if you were accessing those functions from Java code (which is usually pointless) or if you are using older versions of Kotlin.

New features

• [ALL] Support of the new search backend (will be announced soon).
• [ALL] Bump Kotlin version to 1.4.0.

Bug fixes

We are bug-free 😉 (almost).

v1.0.0-beta.1

No changes, the code is the same as v0.7.1.

v0.7.1

New features

Bug fixes

• [CORE] Fixed serialization bug that caused history and favorites data loss.
• [CORE] Now it's possible for external customers to instantiate HistoryRecord instance.

Breaking changes

• [CORE] SearchRequestException constructor arguments order changed.

v0.7.0

New features

• [UI] Now if SearchCategoriesBottomSheetView.open(Category) is called with the latest set category, listeners will be notified about loaded results if they already loaded or loading will be initiated if the card's state is error.
• [UI] New properties isNavigateButtonVisible, isShareButtonVisible, isFavoriteButtonVisible for SearchPlaceBottomSheetView are available that manage buttons visible to user.
• [UI] Now it's allowed to set any number of items for hot categories section including zero. Hot categories section will be hidden in case of an empty list. However, to ensure the best behavior for the view, we recommend setting at most four items. Hot categories section does not support scrolling, if items don't fit into the view width, they will be flattened.
• [UI] Now SearchResultsView has defaultSearchOptions property which defines default options for search. To override these options, use search(query: String, options: SearchOptions) function.
• [UI] Now you can specify collapsed state anchor for SearchBottomSheetView. Desired anchor can be provided with SearchBottomSheetView.Configuration.

Bug fixes

• [UI] Fixed a bug with SearchBottomSheetView when new configuration was ignored after activity recreation.

Breaking changes

• [CORE] Some classes that used to be available in external modules have been moved to com.mapbox.search.internal package. These files should not be accessed in the customer's code and we do not guarantee their availability in the future.
• [CORE] Core SDK has been fully refactored, see new samples for more information.
• [UI] Removed HotCategory class. Now it's allowed to choose any category for hot categories section.
• [UI] Removed SearchBottomSheetView.Configuration.categorySearchResultsLimit property and its corresponding builder fields.
• [UI] We do not longer guarantee that returned by SearchBottomSheetBehavior, SearchPlaceBottomSheetView, and SearchCategoriesBottomSheetView's getBehavior() function returns an instance of com.google.android.material.bottomsheet.BottomSheetBehavior. Use addOnBottomSheetStateChangedListener functions for watching card state changes and state property for getting current state.
• [UI] SearchViewBottomSheetsMediator is no longer part of the UI SDK and has been moved to the sample app.
• [UI] SearchResultsView.initialize() function has been removed. Now view can work without explicit initialization call. To provide search options, including results limit, use search(query: String, options: SearchOptions) function.
• [UI] SearchBottomSheetView.Configuration.searchResultsLimit property and its corresponding builder functions have been removed. Now you can provide SearchOptions that includes results limit.

v0.6.1

Bug fixes

• [UI] Fixed a bug with SearchBottomSheetView when it reset its state after hide() function call.

v0.6.0

New features

• [UI] Added SearchBottomSheetView.isHideableByDrag property that sets whether the bottom sheet can hide when it is swiped down.

Bug fixes

• [UI] Fixed a bug with BottomSheetBehavior when it came to the incorrect state after state restoration in some cases.

Breaking changes

• [CORE] SearchError has been renamed to SearchNetworkRequestException. Now it extends RuntimeException() and contains error cause.
• [UI] SearchPlaceBottomSheetView.addOnNavigateClickListener() and SearchPlaceBottomSheetView.addOnShareClickListener() functions now accept lambdas which take argument of type SearchPlace.

v0.5.0

New features

• [UI] Added SearchPlaceBottomSheetView.
• [UI] Added SearchCategoriesBottomSheetView.
• [UI] Added auxiliary functions for SearchBottomSheet state management: open(), expand(), hide(), restorePreviousNonHiddenState().
• [UI] Miles support. Now UI SDK detects measurement system from current device locale and formats distances in corresponding distance unit.
• [CORE] Added SearchEngine.setAccessToken(String) function.

Bug fixes

• [CORE] In some cases SDK couldn't get last known location.

Breaking changes

• [UI] Removed SearchResultListener, use SearchBottomSheetView.OnSearchResultClickListener and SearchBottomSheetView.OnCategoryClickListener instead. Category search functionality has been removed from SearchBottomSheetView, instead now SearchCategoriesBottomSheetView implements category search.
• [UI] Removed UserFavoriteOnClickListener, use SearchBottomSheetView.OnFavoriteClickListener instead.
• [UI] Removed SearchCloseListener. Now SearchBottomSheetView does not have close button, instead the card resets its state when it collapses.
• [CORE] Removed SearchResult.distance() function, instead DistanceCalculator class is available, also you can use LatLng.distanceTo(LatLng) function.
• [CORE] Removed SearchEngine.destroy() function. Now SearchEngine must be initialized only once, in case of reinitialization attempt IllegalStateException will be thrown.