Release 1.12.0

Author: aallam

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.12.0
+
+### Added
+- Add custom request (#302)
+
+### Fix
+- Add `facetQuery` parameter to `FacetIndexQuery` (#297)
+- Optimize `SimpleDateFormat` instantiations (#301)
+- `ResponseMultiSearch` generic `results` type (#303)
+
 # 1.11.0
 
 ### Added

build.gradle.kts

@@ -8,6 +8,7 @@ buildscript {
         classpath(kotlin("serialization", version = kotlinVersion))
         classpath("com.vanniktech:gradle-maven-publish-plugin:0.18.0")
         classpath("com.diffplug.spotless:spotless-plugin-gradle:5.15.0")
+        classpath("org.jetbrains.kotlinx:binary-compatibility-validator:0.7.1")
     }
 }
 

client/api/client.api

@@ -6,6 +6,7 @@ plugins {
     kotlin("plugin.serialization")
     id("com.vanniktech.maven.publish")
     id("com.diffplug.spotless")
+    id("binary-compatibility-validator")
 }
 
 kotlin {

client/build.gradle.kts

@@ -13,13 +13,14 @@ import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
 import com.algolia.search.model.analytics.ABTest
 import com.algolia.search.model.response.ResponseABTests
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.RequestOptions
 import com.algolia.search.transport.internal.Transport
 
 /**
  * Client to manage [ABTest] for analytics purposes.
  */
-public interface ClientAnalytics : EndpointAnalytics, Configuration, Credentials {
+public interface ClientAnalytics : EndpointAnalytics, Configuration, Credentials, CustomRequester {
 
     /**
      * Browse every [ABTest] on the index and return them as a list.

client/src/commonMain/kotlin/com/algolia/search/client/ClientAnalytics.kt

@@ -14,15 +14,13 @@ import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
 import com.algolia.search.model.insights.InsightsEvent
 import com.algolia.search.model.insights.UserToken
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.internal.Transport
 
 /**
  * Client to manage [InsightsEvent].
  */
-public interface ClientInsights :
-    EndpointInsights,
-    Configuration,
-    Credentials {
+public interface ClientInsights : EndpointInsights, Configuration, Credentials, CustomRequester {
 
     /**
      * Create a [User] instance.

client/src/commonMain/kotlin/com/algolia/search/client/ClientInsights.kt

@@ -13,12 +13,13 @@ import com.algolia.search.configuration.internal.extension.toPersonalization
 import com.algolia.search.endpoint.EndpointPersonalization
 import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.internal.Transport
 
 /**
  * Client for the personalization API.
  */
-public interface ClientPersonalization : EndpointPersonalization, Configuration, Credentials {
+public interface ClientPersonalization : EndpointPersonalization, Configuration, Credentials, CustomRequester {
 
     public companion object
 }

client/src/commonMain/kotlin/com/algolia/search/client/ClientPersonalization.kt

@@ -10,12 +10,13 @@ import com.algolia.search.configuration.internal.Credentials
 import com.algolia.search.endpoint.EndpointPlaces
 import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.internal.Transport
 
 /**
  * Client for the places API.
  */
-public interface ClientPlaces : EndpointPlaces, Configuration {
+public interface ClientPlaces : EndpointPlaces, Configuration, CustomRequester {
 
     public companion object
 }

client/src/commonMain/kotlin/com/algolia/search/client/ClientPlaces.kt

@@ -11,10 +11,11 @@ import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.endpoint.EndpointRecommend
 import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.internal.Transport
 import io.ktor.client.features.logging.LogLevel
 
-public interface ClientRecommend : Configuration, EndpointRecommend, Credentials {
+public interface ClientRecommend : Configuration, EndpointRecommend, Credentials, CustomRequester {
 
     public companion object
 }

client/src/commonMain/kotlin/com/algolia/search/client/ClientRecommend.kt

@@ -30,6 +30,7 @@ import com.algolia.search.model.task.AppTaskID
 import com.algolia.search.model.task.TaskIndex
 import com.algolia.search.model.task.TaskInfo
 import com.algolia.search.model.task.TaskStatus
+import com.algolia.search.transport.CustomRequester
 import com.algolia.search.transport.RequestOptions
 import com.algolia.search.transport.internal.Transport
 import com.algolia.search.util.internal.decodeBase64String
@@ -45,7 +46,8 @@ public interface ClientSearch :
     EndpointMultiCluster,
     EndpointDictionary,
     Configuration,
-    Credentials {
+    Credentials,
+    CustomRequester {
 
     /**
      *  Initialize an [Index] configured with [ConfigurationSearch].