Merge pull request #141 from algolia/feature/custom-normalization

Add custom normalization parameter in Settings

Author: q-litzler

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

@@ -363,7 +363,11 @@ public data class Settings(
      * Accepted value: [Language.Japanese]
      * Input data to index is treated as the given language(s) for segmentation.
      */
-    @SerialName(KeyIndexLanguages) var indexLanguages: List<Language>? = null
+    @SerialName(KeyIndexLanguages) var indexLanguages: List<Language>? = null,
+    /**
+     * Override the custom normalization handled by the engine.
+     */
+    @SerialName(KeyCustomNormalization) var customNormalization: Map<String, Map<String, String>>? = null
 ) {
 
     /**

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

@@ -364,5 +364,6 @@ public const val KeySimilarQuery = "similarQuery"
 public const val KeyEnableABTest = "enableABTest"
 public const val KeyAlternatives = "alternatives"
 public const val KeyIndexLanguages = "indexLanguages"
+public const val KeyCustomNormalization = "customNormalization"
 public const val KeyFilterPromotes = "filterPromotes"
 public const val KeyUsers = "users"

src/commonTest/kotlin/documentation/parameters/advanced/DocCustomNormalization.kt

@@ -0,0 +1,36 @@
+package documentation.parameters.advanced
+
+import com.algolia.search.dsl.query
+import com.algolia.search.dsl.settings
+import documentation.index
+import runBlocking
+import kotlin.test.Ignore
+import kotlin.test.Test
+
+
+@Ignore
+class DocCustomNormalization {
+
+//    customNormalization: Map<String, Map<String, String>> = mapOf(
+//        "default" to mapOf(
+//            "ä" to "ae",
+//            "ü" to "ue"
+//        )
+//    )
+
+    @Test
+    fun snippet1() {
+        runBlocking {
+            val settings = settings {
+                customNormalization = mapOf(
+                    "default" to mapOf(
+                        "ä" to "ae",
+                        "ü" to "ue"
+                    )
+                )
+            }
+
+            index.setSettings(settings)
+        }
+    }
+}

src/commonTest/kotlin/serialize/TestKeys.kt

@@ -355,6 +355,7 @@ internal class TestKeys {
         KeyEnableABTest shouldEqual "enableABTest"
         KeyAlternatives shouldEqual "alternatives"
         KeyIndexLanguages shouldEqual "indexLanguages"
+        KeyCustomNormalization shouldEqual "customNormalization"
         KeyFilterPromotes shouldEqual "filterPromotes"
         KeyUsers shouldEqual "users"
     }

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

@@ -85,7 +85,8 @@ internal class TestSettings : TestSerializer<Settings>(Settings.serializer()) {
             version = int,
             advancedSyntaxFeatures = listOf(AdvancedSyntaxFeatures.ExcludeWords, AdvancedSyntaxFeatures.ExactPhrase),
             userData = json { unknown to unknown },
-            indexLanguages = listOf(Language.Japanese)
+            indexLanguages = listOf(Language.Japanese),
+            customNormalization = mapOf(unknown to mapOf(unknown to unknown))
         ) to json {
             // Attributes
             KeySearchableAttributes to attributesJson
@@ -156,6 +157,9 @@ internal class TestSettings : TestSerializer<Settings>(Settings.serializer()) {
             KeyUserData to json { unknown to unknown }
             KeyPrimary to JsonNull
             KeyIndexLanguages to jsonArray { +Language.Japanese.raw }
+            KeyCustomNormalization to json {
+                unknown to json { unknown to unknown }
+            }
         }
     )
 

src/commonTest/resources/settings.json

@@ -116,5 +116,11 @@
   "version": 1,
   "indexLanguages": [
     "ja"
-  ]
+  ],
+  "customNormalization": {
+    "default": {
+      "ä": "ae",
+      "ü": "ue"
+    }
+  }
 }