Merge pull request #110 from algolia/feature/settings-indexLanguages

Settings indexLanguages

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/model/settings/Settings.kt

@@ -357,11 +357,18 @@ public data class Settings(
     /**
      *  Lets you store custom data in your indices.
      */
-    @SerialName(KeyUserData) var userData: JsonObject? = null
+    @SerialName(KeyUserData) var userData: JsonObject? = null,
+    /**
+     * This parameter configures the segmentation of text at indexing time.
+     * Accepted value: [Language.Japanese]
+     * Input data to index is treated as the given language(s) for segmentation.
+     */
+    @SerialName(KeyIndexLanguages) var indexLanguages: List<Language>? = null
 ) {
 
     /**
      *  This parameter keeps track of which primary index (if any) a replica is connected to.
      */
-    @SerialName(KeyPrimary) val primary: IndexName? = null
-}
+    @SerialName(KeyPrimary)
+    val primary: IndexName? = null
+}

src/commonMain/kotlin/com/algolia/search/model/settings/SettingsKey.kt

@@ -104,5 +104,9 @@ public sealed class SettingsKey(override val raw: String) : Raw<String> {
 
     public object MaxFacetHits : SettingsKey(KeyMaxFacetHits)
 
+    public object UserData: SettingsKey(KeyUserData)
+
+    public object IndexLanguages: SettingsKey(KeyIndexLanguages)
+
     public data class Other(override val raw: String) : SettingsKey(raw)
 }

src/commonMain/kotlin/com/algolia/search/serialize/Keys.kt

@@ -361,4 +361,5 @@ public const val KeyGeoPoint = "geoPoint"
 public const val KeySuburb = "suburb"
 public const val KeyVillage = "village"
 public const val KeySimilarQuery = "similarQuery"
-public const val KeyEnableABTest = "enableABTest"
+public const val KeyEnableABTest = "enableABTest"
+public const val KeyIndexLanguages = "indexLanguages"

src/commonTest/kotlin/model/settings/TestSettingsKey.kt

@@ -57,5 +57,7 @@ internal class TestSettingsKey {
         MinProximity.raw shouldEqual KeyMinProximity
         ResponseFields.raw shouldEqual KeyResponseFields
         MaxFacetHits.raw shouldEqual KeyMaxFacetHits
+        IndexLanguages.raw shouldEqual KeyIndexLanguages
+        UserData.raw shouldEqual KeyUserData
     }
 }

src/commonTest/kotlin/serialize/TestKeys.kt

@@ -353,5 +353,6 @@ internal class TestKeys {
         KeyVillage shouldEqual "village"
         KeySimilarQuery shouldEqual "similarQuery"
         KeyEnableABTest shouldEqual "enableABTest"
+        KeyIndexLanguages shouldEqual "indexLanguages"
     }
 }

src/commonTest/kotlin/serialize/settings/TestSettings.kt

@@ -84,7 +84,8 @@ internal class TestSettings : TestSerializer<Settings>(Settings.serializer()) {
             maxFacetHits = int,
             version = int,
             advancedSyntaxFeatures = listOf(AdvancedSyntaxFeatures.ExcludeWords, AdvancedSyntaxFeatures.ExactPhrase),
-            userData = json { unknown to unknown }
+            userData = json { unknown to unknown },
+            indexLanguages = listOf(Language.Japanese)
         ) to json {
             // Attributes
             KeySearchableAttributes to attributesJson
@@ -154,6 +155,7 @@ internal class TestSettings : TestSerializer<Settings>(Settings.serializer()) {
             KeyVersion to int
             KeyUserData to json { unknown to unknown }
             KeyPrimary to JsonNull
+            KeyIndexLanguages to jsonArray { +Language.Japanese.raw }
         }
     )
 

src/commonTest/resources/settings.json

@@ -113,5 +113,8 @@
     "hitsPerPage"
   ],
   "maxFacetHits": 100,
-  "version": 1
+  "version": 1,
+  "indexLanguages": [
+    "ja"
+  ]
 }