feat(settings): Add attributesToTransliterate settings parameter (#723)

Author: VladislavFitz

Sources/AlgoliaSearchClient/Models/Settings/SettingsParameters.swift

@@ -81,6 +81,15 @@ public protocol SettingsParameters: CommonParameters {
   var separatorsToIndex: String? { get set }
 
   // MARK: - Languages
+  
+  /**
+   Specify on which attributes to apply transliteration.
+   
+   Transliteration refers to the ability of finding results in a given alphabet with a query in another alphabet. For example, in Japanese, transliteration enables users to find results indexed in Kanji or Katakana with a query in Hiragana.
+   - Engine default: [*]
+   - [Documentation](https://www.algolia.com/doc/api-reference/api-parameters/attributesToTransliterate/?language=swift)
+   */
+  var attributesToTransliterate: [Attribute]? { get set }
 
   /**
    List of [Attribute] on which to do a decomposition of camel case words.

Sources/AlgoliaSearchClient/Models/Settings/SettingsParametersCodingKeys.swift

@@ -34,6 +34,7 @@ public enum SettingsParametersCodingKeys: String, CodingKey {
   case separatorsToIndex
   case ignorePlurals
   case removeStopWords
+  case attributesToTransliterate
   case camelCaseAttributes
   case decompoundedAttributes
   case keepDiacriticsOnCharacters

Sources/AlgoliaSearchClient/Models/Settings/SettingsParametersStorage.swift

@@ -34,6 +34,7 @@ struct SettingsParametersStorage: SettingsParameters {
   var separatorsToIndex: String?
   var ignorePlurals: LanguageFeature?
   var removeStopWords: LanguageFeature?
+  var attributesToTransliterate: [Attribute]?
   var camelCaseAttributes: [Attribute]?
   var decompoundedAttributes: DecompoundedAttributes?
   var keepDiacriticsOnCharacters: String?
@@ -180,6 +181,10 @@ extension SettingsParametersStorageContainer {
     get { settingsParametersStorage.removeStopWords }
     set { settingsParametersStorage.removeStopWords = newValue }
   }
+  public var attributesToTransliterate: [Attribute]? {
+    get { settingsParametersStorage.attributesToTransliterate }
+    set { settingsParametersStorage.attributesToTransliterate = newValue }
+  }
   public var camelCaseAttributes: [Attribute]? {
     get { settingsParametersStorage.camelCaseAttributes }
     set { settingsParametersStorage.camelCaseAttributes = newValue }

Tests/AlgoliaSearchClientTests/Doc/APIParameters/APIParameters+Languages.swift

@@ -246,7 +246,21 @@ extension APIParameters {
         }
       }
     }
-    
+    func attributesToTransliterate() {
+      /*
+       attributesToTransliterate = ["name", "description"]
+       */
+      func set_attributes_to_transliterate() {
+        let settings = Settings()
+          .set(\.attributesToTransliterate, to: ["name", "description"])
+
+        index.setSettings(settings) { result in
+          if case .success(let response) = result {
+            print("Response: \(response)")
+          }
+        }
+      }
+    }
     func decompoundQuery() {
       /*
        decompoundQuery = true

Tests/AlgoliaSearchClientTests/Misc/Settings.json

@@ -17,6 +17,7 @@
   "attributesToHighlight": null,
   "paginationLimitedTo": 1000,
   "attributeForDistinct": null,
+  "attributesToTransliterate": ["a", "b", "c"],
   "exactOnSingleWordQuery": "attribute",
   "enablePersonalization": true,
   "decompoundQuery": true,

Tests/AlgoliaSearchClientTests/Unit/Settings/SettingsTests.swift

@@ -26,6 +26,7 @@ class SettingsTests: XCTestCase {
     let settings = try decoder.decode(Settings.self, from: data)
     XCTAssertEqual(settings.attributeCriteriaComputedByMinProximity, false)
     XCTAssertEqual(settings.enablePersonalization, true)
+    XCTAssertEqual(settings.attributesToTransliterate, ["a", "b", "c"])
     XCTAssertEqual(settings.decompoundQuery, true)
   }
 }