Update dependencies for 2.8.0-beta.1 release (#354)

Author: kried

CHANGELOG.md

@@ -6,8 +6,18 @@ Guide: https://keepachangelog.com/en/1.0.0/
 
 ## Unreleased
 
+<!-- Add changes for active work here -->
+
+## 2.8.0-beta.1
+
+- [Core] Update dependencies.
+
+**MapboxCommon**: v24.10.0-beta.2
+**MapboxCoreSearch**: v2.8.0-beta.1
+
 - [Details] Add `SearchEngine.retrieve(mapboxID: String, options: DetailsOptions)` function.
 - [SearchOptions] Add `SearchOptions.attributeSets` option. It allows to request of additional metadata attributes besides the basic ones in category search requests.
+- [SearchSuggestion] Add `SearchSuggestion.namePreferred` field to represent the preferred display name for the result.
 
 ## 2.7.1
 

Cartfile

@@ -1,2 +1,2 @@
-binary "https://api.mapbox.com/downloads/v2/carthage/search-core-sdk/MapboxCoreSearch.xcframework.json" == 2.7.0
-binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" == 24.9.0
+binary "https://api.mapbox.com/downloads/v2/carthage/search-core-sdk/MapboxCoreSearch.xcframework.json" == 2.8.0-beta.2
+binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" == 24.10.0-beta.2

Cartfile.resolved

@@ -1,2 +1,2 @@
-binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" "24.9.0"
-binary "https://api.mapbox.com/downloads/v2/carthage/search-core-sdk/MapboxCoreSearch.xcframework.json" "2.7.0"
+binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" "24.10.0-beta.2"
+binary "https://api.mapbox.com/downloads/v2/carthage/search-core-sdk/MapboxCoreSearch.xcframework.json" "2.8.0-beta.2"

LICENSE.md

@@ -1,8 +1,8 @@
 ## License
 
-Mapbox Search for iOS version 2.7.0
+Mapbox Search for iOS version 2.8.0-beta.1
 Mapbox Search iOS SDK
 
-Copyright © 2021 - 2024 Mapbox, Inc. All rights reserved.
+Copyright © 2021 - 2025 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]

MapboxSearch.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'MapboxSearch'
-  s.version          = '2.7.0'
+  s.version          = '2.8.0-beta.1'
   s.summary          = 'Search SDK for Mapbox Search API'
 
 # This description is used to generate tags and improve search results.
@@ -24,6 +24,6 @@ Some iOS platform specifics applies.
 
   s.vendored_frameworks = "**/#{s.name}.xcframework"
 
-  s.dependency "MapboxCoreSearch", '2.7.0'
-  s.dependency "MapboxCommon", '24.9.0'
+  s.dependency "MapboxCoreSearch", '2.8.0-beta.2'
+  s.dependency "MapboxCommon", '24.10.0-beta.2'
 end

MapboxSearch.xcodeproj/project.pbxproj

@@ -3716,15 +3716,15 @@
 			repositoryURL = "https://github.com/mapbox/mapbox-common-ios.git";
 			requirement = {
 				kind = exactVersion;
-				version = 24.9.0;
+				version = "24.10.0-beta.2";
 			};
 		};
 		042BEB182C2DE30E0004CD7B /* XCRemoteSwiftPackageReference "mapbox-maps-ios" */ = {
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/mapbox/mapbox-maps-ios.git";
 			requirement = {
 				kind = exactVersion;
-				version = 11.9.0;
+				version = "11.10.0-beta.1";
 			};
 		};
 		043339CB2C61295D001650FA /* XCRemoteSwiftPackageReference "atlantis" */ = {

MapboxSearchUI.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'MapboxSearchUI'
-  s.version          = '2.7.0'
+  s.version          = '2.8.0-beta.1'
   s.summary          = 'Search UI for Mapbox Search API'
 
 # This description is used to generate tags and improve search results.
@@ -23,5 +23,5 @@ Card style custom UI with full search functionality powered by Mapbox Search API
 
   s.vendored_frameworks = "**/#{s.name}.xcframework"
 
-  s.dependency 'MapboxSearch', "2.7.0"
+  s.dependency 'MapboxSearch', "2.8.0-beta.1"
 end

Package.swift

@@ -4,9 +4,9 @@
 import PackageDescription
 import Foundation
 
-let (coreSearchVersion, coreSearchVersionHash) = ("2.7.0", "ffb6e9f75e80e08c16d0fb0754a3f534f2231de537c792422af34b053d700960")
+let (coreSearchVersion, coreSearchVersionHash) = ("2.8.0-beta.2", "4300248e04ea446f24c7010f6710505eff82e2c55e19abaabe5431799b2b9adf")
 
-let mapboxCommonSDKVersion = Version("24.9.0")
+let mapboxCommonSDKVersion = Version("24.10.0-beta.2")
 
 let package = Package(
     name: "MapboxSearch",

README.md

@@ -86,13 +86,13 @@ dependencies: [
 ##### MapboxSearch
 To integrate latest pre-release version of `MapboxSearch` into your Xcode project using CocoaPods, specify it in your `Podfile`:
 ```
-pod 'MapboxSearch', ">= 2.7.0", "< 3.0"
+pod 'MapboxSearch', ">= 2.8.0-beta.1", "< 3.0"
 ```
 
 ##### MapboxSearchUI
 To integrate latest pre-release version of `MapboxSearchUI` into your Xcode project using CocoaPods, specify it in your `Podfile`:
 ```
-pod 'MapboxSearchUI', ">= 2.7.0", "< 3.0"
+pod 'MapboxSearchUI', ">= 2.8.0-beta.1", "< 3.0"
 ```
 
 ### Carthage
@@ -109,7 +109,7 @@ pod 'MapboxSearchUI', ">= 2.7.0", "< 3.0"
 2. Follow the [Carthage Quick Start](https://github.com/Carthage/Carthage?tab=readme-ov-file#quick-start) and specificy the MapboxSearch dependency in your `Cartfile`:
 
 ```
-github "Mapbox/mapbox-search-ios" ~> 2.7.0
+github "Mapbox/mapbox-search-ios" ~> 2.8.0-beta.1
 ```
 
 ## Contributing

Search Documentation.docc/Installation.md

@@ -59,7 +59,7 @@ To add the Mapbox Search SDK dependency with CocoaPods, you will need to configu
     ```ruby
     use_frameworks!
     target "TargetNameForYourApp" do
-      pod 'MapboxSearchUI', ">= 2.7.0", "< 3.0"
+      pod 'MapboxSearchUI', ">= 2.8.0-beta.1", "< 3.0"
     end
     ```
 
@@ -68,7 +68,7 @@ To add the Mapbox Search SDK dependency with CocoaPods, you will need to configu
     ```ruby
     use_frameworks!
     target "TargetNameForYourApp" do
-      pod 'MapboxSearch', ">= 2.7.0", "< 3.0"
+      pod 'MapboxSearch', ">= 2.8.0-beta.1", "< 3.0"
     end
     ```
 

Sources/MapboxSearch/InternalAPI/CoreSearchResultProtocol.swift

@@ -13,6 +13,9 @@ protocol CoreSearchResultProtocol {
      */
     var names: [String] { get }
 
+    /// The preferred name of the feature, if different than name.
+    var namePreferred: String? { get }
+
     var resultAccuracy: CoreAccuracy? { get }
 
     var languages: [String] { get }

Sources/MapboxSearch/PublicAPI/FavoriteRecord.swift

@@ -78,13 +78,21 @@ public struct FavoriteRecord: IndexableRecord, SearchResult, Codable, Equatable
     /// Favorite record constructor
     /// - Parameters:
     ///   - id: UUID used by default
+    ///   - mapboxId: Unique record identifier
     ///   - name: Favorite name
+    ///   - matchingName: The feature name, as matched by the search algorithm
     ///   - coordinate: Favorite coordinate
+    ///   - distance: An approximate distance to the origin location, in meters
     ///   - address: Favorite address
     ///   - makiIcon:Favorite  icon name
+    ///   - serverIndex: The index in response from server
+    ///   - accuracy: A point accuracy metric for the returned address
     ///   - categories: Favorite categories list
+    ///   - routablePoints: Coordinates of building entries
     ///   - searchRequest: original search request
+    ///   - metadata: Associated metadata
     ///   - resultType: Favorite result type
+    ///   - descriptionText: Address formatted with the medium style
     public init(
         id: String? = nil,
         mapboxId: String? = nil,

Sources/MapboxSearch/PublicAPI/HistoryRecord.swift

@@ -91,15 +91,22 @@ public struct HistoryRecord: IndexableRecord, SearchResult, Codable, Hashable {
     /// History record constructor
     /// - Parameters:
     ///   - id: UUID used by default
+    ///   - mapboxId: Unique record identifier
     ///   - name: History name
+    ///   - matchingName: The feature name, as matched by the search algorithm
+    ///   - serverIndex: The index in response from server
+    ///   - accuracy: A point accuracy metric for the returned address
     ///   - coordinate: History coordinate
+    ///   - distance: An approximate distance to the origin location, in meters
     ///   - timestamp: History timestamp
     ///   - historyType: History type
     ///   - type: History type
     ///   - address: History address
     ///   - metadata: Associated metadata
     ///   - categories: Categories of original object
+    ///   - searchRequest: The original search request
     ///   - routablePoints: Coordinates of building entries
+    ///   - descriptionText: Address formatted with the medium style
     public init(
         id: String = UUID().uuidString,
         mapboxId: String?,

Sources/MapboxSearch/PublicAPI/MapboxSearchVersion.swift

@@ -1,2 +1,2 @@
 /// Mapbox Search SDK version variable
-public let mapboxSearchSDKVersion = "2.7.0"
+public let mapboxSearchSDKVersion = "2.8.0-beta.1"

Sources/MapboxSearch/PublicAPI/Search Results/ExternalRecordPlaceholder.swift

@@ -12,6 +12,8 @@ class ExternalRecordPlaceholder: SearchResultSuggestion, CoreResponseProvider {
 
     var name: String
 
+    var namePreferred: String?
+
     var address: Address?
 
     var descriptionText: String?
@@ -39,7 +41,8 @@ class ExternalRecordPlaceholder: SearchResultSuggestion, CoreResponseProvider {
 
         self.id = coreResult.userRecordID ?? coreResult.id
         self.mapboxId = coreResult.mapboxId
-        self.name = coreResult.names[0]
+        self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.address = coreResult.addresses?.first.map(Address.init)
         self.dataLayerIdentifier = layerIdentifier
         self.distance = coreResult.distanceToProximity

Sources/MapboxSearch/PublicAPI/Search Results/SearchBrandSuggestionImpl.swift

@@ -16,6 +16,8 @@ class SearchBrandSuggestionImpl: SearchBrandSuggestion, CoreResponseProvider {
 
     var name: String
 
+    var namePreferred: String?
+
     var address: Address?
 
     var descriptionText: String?
@@ -48,7 +50,8 @@ class SearchBrandSuggestionImpl: SearchBrandSuggestion, CoreResponseProvider {
         self.id = coreResult.id
         self.mapboxId = coreResult.mapboxId
         self.suggestionType = .brand
-        self.name = coreResult.names[0]
+        self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.address = coreResult.addresses?.first.map(Address.init)
         self.iconName = coreResult.icon
         self.serverIndex = coreResult.serverIndex?.intValue

Sources/MapboxSearch/PublicAPI/Search Results/SearchCategorySuggestionImpl.swift

@@ -10,6 +10,8 @@ class SearchCategorySuggestionImpl: SearchCategorySuggestion, CoreResponseProvid
 
     var name: String
 
+    var namePreferred: String?
+
     var address: Address?
 
     var descriptionText: String?
@@ -44,7 +46,8 @@ class SearchCategorySuggestionImpl: SearchCategorySuggestion, CoreResponseProvid
         self.id = coreResult.id
         self.mapboxId = coreResult.mapboxId
         self.suggestionType = .category
-        self.name = coreResult.names[0]
+        self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.address = coreResult.addresses?.first.map(Address.init)
         self.iconName = nil // Categories should use it's special icon
         self.serverIndex = coreResult.serverIndex?.intValue

Sources/MapboxSearch/PublicAPI/Search Results/SearchQuerySuggestionImpl.swift

@@ -10,6 +10,8 @@ class SearchQuerySuggestionImpl: SearchQuerySuggestion, CoreResponseProvider {
 
     var name: String
 
+    var namePreferred: String?
+
     var address: Address?
 
     var descriptionText: String?
@@ -40,7 +42,8 @@ class SearchQuerySuggestionImpl: SearchQuerySuggestion, CoreResponseProvider {
         self.id = coreResult.id
         self.mapboxId = coreResult.mapboxId
         self.suggestionType = .query
-        self.name = coreResult.names[0]
+        self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.address = coreResult.addresses?.first.map(Address.init)
         self.iconName = nil // Queries should use it's special icon
         self.originalResponse = CoreSearchResultResponse(coreResult: coreResult, response: response)

Sources/MapboxSearch/PublicAPI/Search Results/SearchResultSuggestionImpl.swift

@@ -12,6 +12,8 @@ class SearchResultSuggestionImpl: SearchResultSuggestion, CoreResponseProvider {
 
     var name: String
 
+    var namePreferred: String?
+
     var address: Address?
 
     var iconName: String?
@@ -54,6 +56,7 @@ class SearchResultSuggestionImpl: SearchResultSuggestion, CoreResponseProvider {
         self.id = coreResult.id
         self.mapboxId = coreResult.mapboxId
         self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.address = coreResult.addresses?.first.map(Address.init)
         self.iconName = coreResult.icon
         self.serverIndex = coreResult.serverIndex?.intValue

Sources/MapboxSearch/PublicAPI/Search Results/SearchSuggestion.swift

@@ -16,6 +16,9 @@ public protocol SearchSuggestion {
     /// Suggestion name.
     var name: String { get }
 
+    /// The preferred name of the feature, if different than name.
+    var namePreferred: String? { get }
+
     /// Index in response from server.
     var serverIndex: Int? { get }
 

Sources/MapboxSearch/PublicAPI/Search Results/ServerSearchResult.swift

@@ -39,6 +39,8 @@ class ServerSearchResult: SearchResult, SearchResultSuggestion, CoreResponseProv
 
     var name: String
 
+    var namePreferred: String?
+
     var matchingName: String?
 
     var descriptionText: String?
@@ -69,6 +71,7 @@ class ServerSearchResult: SearchResult, SearchResultSuggestion, CoreResponseProv
         self.id = coreResult.id
         self.mapboxId = coreResult.mapboxId
         self.name = coreResult.names.first ?? ""
+        self.namePreferred = coreResult.namePreferred
         self.matchingName = coreResult.matchingName
         self.iconName = coreResult.icon
         self.estimatedTime = coreResult.estimatedTime

Tests/MapboxSearchTests/Common/Models/Search Result/SearchResultSuggestionImplTests.swift

@@ -5,37 +5,45 @@ import XCTest
 
 class SearchResultSuggestionImplTests: XCTestCase {
     func testSuccessfulInitForAddressType() throws {
+        let coreResult = CoreSearchResultStub(
+            id: "sample-2",
+            mapboxId: "sample-2",
+            type: .address,
+            namePreferred: "Preferred name",
+            centerLocation: nil
+        )
         let suggestionImpl = try XCTUnwrap(SearchResultSuggestionImpl(
-            coreResult: CoreSearchResultStub(
-                id: "sample-2",
-                mapboxId: "sample-2",
-                type: .address,
-                centerLocation: nil
-            ),
+            coreResult: coreResult,
             response: CoreSearchResponseStub(
                 id: 42,
                 options: .sample1,
                 result: .success([])
             )
         ))
         XCTAssertEqual(suggestionImpl.suggestionType, .address(subtypes: [.address]))
+        XCTAssertEqual(suggestionImpl.name, coreResult.names.first)
+        XCTAssertEqual(suggestionImpl.namePreferred, coreResult.namePreferred)
     }
 
     func testSuccessfulInitForPOIType() throws {
+        let coreResult = CoreSearchResultStub(
+            id: "sample-2",
+            mapboxId: "sample-2",
+            type: .poi,
+            namePreferred: "Preferred name",
+            centerLocation: nil
+        )
         let suggestionImpl = try XCTUnwrap(SearchResultSuggestionImpl(
-            coreResult: CoreSearchResultStub(
-                id: "sample-2",
-                mapboxId: "sample-2",
-                type: .poi,
-                centerLocation: nil
-            ),
+            coreResult: coreResult,
             response: CoreSearchResponseStub(
                 id: 42,
                 options: .sample1,
                 result: .success([])
             )
         ))
         XCTAssertEqual(suggestionImpl.suggestionType, .POI)
+        XCTAssertEqual(suggestionImpl.name, coreResult.names.first)
+        XCTAssertEqual(suggestionImpl.namePreferred, coreResult.namePreferred)
     }
 
     func testFailedInit() throws {