Release 1.7.0

Author: aallam

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,22 @@
-<!-- Thanks for submitting a pull request! Please provide enough information
-so that others can review your pull request. -->
+| Q                 | A
+| ----------------- | ----------
+| Bug fix?          | yes/no
+| New feature?      | yes/no    <!-- please update the /CHANGELOG.md file -->
+| BC breaks?        | no
+| Related Issue     | Fix #...  <!-- will close issue automatically, if any -->
+| Need Doc update   | yes/no
 
-# Summary
-<!-- Explain the **motivation** for making this change. What existing problem
-does the pull request solve? Are there any linked issues? -->
 
-# Result
-<!-- Demonstrate the code is solid.
-Example: The exact commands you ran and their output,
-screenshots / videos if the pull request changes UI. -->
+## Describe your change
+
+<!-- 
+    Please describe your change, add as much detail as 
+    necessary to understand your code.
+-->
+
+## What problem is this fixing?
+
+<!-- 
+    Please include everything needed to understand the problem, 
+    its context and consequences, and, if possible, how to recreate it.
+-->

CHANGELOG.md

@@ -1,10 +1,24 @@
+# 1.7.0
+
+### Added
+- Query/Settings: `relevancyStrictness` and `decompoundQuery` parameters (#248)
+- ResponseSearch: `appliedRelevancyStrictness` and `nbSortedHits` parameters
+- Settings: `attributesToTransliterate` parameter (#249)
+- Custom dictionaries: stop words, plurals and compounds
+- Rules condition: `filters` parameter (#250)
+
+### Changed
+- Update Kotlin to 1.4.30
+- Update Ktor 1.5.1
+
 # 1.6.2
 
 ### Added
 - Settings: `attributeCriteriaComputedByMinProximity` parameter
 
 ### Changed
-- Update Kotlin to 1.4.2
+- Update Kotlin to 1.4.20
+- Update Ktor 1.5.0
 
 ### Experimental
 - AnswersQuery: `queryLanguages` required (non-nullable)

README.md

@@ -6,7 +6,7 @@
   <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Kotlin project</h4>
 
   <p align="center">
-    <a href="https://bintray.com/algolia/maven/algoliasearch-client-kotlin/_latestVersion"><img src="https://api.bintray.com/packages/algolia/maven/algoliasearch-client-kotlin/images/download.svg" alt="Latest version"></img></a>
+    <a href="https://search.maven.org/search?q=a:algoliasearch-client-kotlin"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch-client-kotlin?label=Download" alt="Latest version"></img></a>
     <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Licence"></img></a>
   </p>
 </p>
@@ -38,7 +38,7 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
 
   ```gradle
   repositories {
-     maven { url "https://dl.bintray.com/algolia/maven" }
+     mavenCentral()
   }
   
   dependencies {

build.gradle.kts

@@ -1,6 +1,5 @@
 import com.diffplug.gradle.spotless.SpotlessExtension
 import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
-import java.net.URI
 
 buildscript {
     repositories {
@@ -13,20 +12,17 @@ buildscript {
 }
 
 plugins {
-    kotlin("multiplatform") version "1.4.21"
-    kotlin("plugin.serialization") version "1.4.21"
+    kotlin("multiplatform") version "1.4.30"
+    kotlin("plugin.serialization") version "1.4.30"
     id("maven-publish")
+    id("signing")
 }
 
 apply(plugin = "com.diffplug.spotless")
 
 repositories {
-    jcenter()
-    google()
     mavenCentral()
-    maven { url = URI("https://dl.bintray.com/kotlin/ktor") }
-    maven { url = URI("https://kotlin.bintray.com/kotlinx") }
-    maven { url = URI("https://oss.sonatype.org/content/repositories/snapshots") }
+    google()
 }
 
 version = Library.version
@@ -74,10 +70,6 @@ kotlin {
     }
 }
 
-val javadocJar by tasks.creating(Jar::class) {
-    archiveClassifier.value("javadoc")
-}
-
 tasks {
 
     withType<KotlinCompile<*>>().configureEach {
@@ -100,24 +92,29 @@ tasks {
 configure<SpotlessExtension> {
     kotlin {
         target("**/*.kt")
-        ktlint("0.39.0")
+        ktlint("0.40.0")
         trimTrailingWhitespace()
         endWithNewline()
     }
 }
 
 //** Publish **//
+val emptyJar by tasks.creating(Jar::class) {
+    archiveAppendix.set("empty")
+}
 
 publishing {
     repositories {
         maven {
-            url = uri("https://api.bintray.com/maven/algolia/maven/algoliasearch-client-kotlin/;publish=0")
+            name = "MavenCentral"
+            url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2")
             credentials {
-                username = System.getenv("BINTRAY_USER")
-                password = System.getenv("BINTRAY_KEY")
+                username = System.getenv("SONATYPE_USER")
+                password = System.getenv("SONATYPE_KEY")
             }
         }
     }
+
     publications.withType<MavenPublication>().all {
         groupId = Library.group
         version = Library.version
@@ -126,32 +123,45 @@ publishing {
             else -> "${Library.artifact}-$name"
         }
 
+        artifact(emptyJar) { classifier = "javadoc" }
+
         pom.withXml {
             asNode().apply {
+                appendNode("name", "Algolia Search API Client for Kotlin")
                 appendNode("description",
                     "Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries," +
                         "and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search" +
                         "REST API from your JVM project, such as Android or backend implementations.")
                 appendNode("url", "https://github.com/algolia/algoliasearch-client-kotlin")
-                appendNode("licenses").appendNode("license").apply {
-                    appendNode("name", "MIT")
-                    appendNode("url", "http://www.opensource.org/licenses/mit-license.php")
-                    appendNode("distribution", "repo")
-                }
-                appendNode("developers").appendNode("developer").apply {
-                    appendNode("id", "algolia")
-                    appendNode("name", "The Algolia Team")
-                    appendNode("email", "[email protected]")
-                }
+                appendNode("licenses")
+                    .appendNode("license").apply {
+                        appendNode("name", "MIT")
+                        appendNode("url", "http://www.opensource.org/licenses/mit-license.php")
+                        appendNode("distribution", "repo")
+                    }
+                appendNode("developers")
+                    .appendNode("developer").apply {
+                        appendNode("id", "algolia")
+                        appendNode("name", "The Algolia Team")
+                        appendNode("email", "[email protected]")
+                        appendNode("organization", "Algolia")
+                        appendNode("organizationUrl", "https://algolia.com")
+                    }
                 appendNode("scm").apply {
-                    appendNode("url", "https://github.com/algolia/algoliasearch-client-kotlin.git")
+                    appendNode("url", "https://github.com/algolia/algoliasearch-client-kotlin")
+                    appendNode("connection", "scm:git:git://github.com/algolia/algoliasearch-client-kotlin.git")
+                    appendNode("developerConnection",
+                        "scm:git:ssh://github.com:algolia/algoliasearch-client-kotlin.git")
                 }
             }
         }
     }
+}
 
-    kotlin.targets.forEach { target ->
-        val targetPublication = publications.withType<MavenPublication>().findByName(target.name)
-        targetPublication?.artifact(javadocJar)
-    }
+signing {
+    val signingKeyId = System.getenv("SIGNING_KEY_ID")
+    val signingKey = System.getenv("SIGNING_KEY")
+    val signingPassword = System.getenv("SIGNING_PASSWORD")
+    useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
+    sign(publishing.publications)
 }

buildSrc/build.gradle.kts

@@ -1,22 +1,7 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     `kotlin-dsl`
-    kotlin("jvm") version "1.3.71"
 }
 
 repositories {
-    jcenter()
-    maven { setUrl("https://dl.bintray.com/kotlin/kotlin-eap") }
-}
-dependencies {
-    implementation(kotlin("stdlib-jdk8"))
-}
-val compileKotlin: KotlinCompile by tasks
-compileKotlin.kotlinOptions {
-    jvmTarget = "1.8"
-}
-val compileTestKotlin: KotlinCompile by tasks
-compileTestKotlin.kotlinOptions {
-    jvmTarget = "1.8"
+    mavenCentral()
 }

buildSrc/src/main/kotlin/Ktor.kt

@@ -2,5 +2,5 @@ object Ktor : Dependency {
 
     override val group = "io.ktor"
     override val artifact = "ktor"
-    override val version = "1.5.0"
+    override val version = "1.5.1"
 }

buildSrc/src/main/kotlin/Library.kt

@@ -2,5 +2,5 @@ object Library : Dependency {
 
     override val group = "com.algolia"
     override val artifact = "algoliasearch-client-kotlin"
-    override val version = "1.6.2"
+    override val version = "1.7.0"
 }

buildSrc/src/main/kotlin/plugin/Spotless.kt

@@ -6,5 +6,5 @@ object Spotless : Dependency {
 
     override val group = "com.diffplug.spotless"
     override val artifact = "spotless-plugin-gradle"
-    override val version = "5.1.1"
+    override val version = "5.9.0"
 }

gradle.properties

@@ -3,8 +3,6 @@ org.gradle.parallel=true
 android.useAndroidX=true
 
 # Workaround for Bintray treating .sha512 files as artifacts
-# https://github.com/gradle/gradle/issues/11412
-systemProp.org.gradle.internal.publish.checksums.insecure=true
 kotlin.mpp.enableGranularSourceSetsMetadata=true
 
 # Kotlin MPP

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

@@ -9,6 +9,7 @@ import com.algolia.search.configuration.Credentials
 import com.algolia.search.configuration.internal.Credentials
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.endpoint.EndpointAPIKey
+import com.algolia.search.endpoint.EndpointDictionary
 import com.algolia.search.endpoint.EndpointMultiCluster
 import com.algolia.search.endpoint.EndpointMultipleIndex
 import com.algolia.search.helper.internal.sha256
@@ -21,10 +22,13 @@ import com.algolia.search.model.apikey.SecuredAPIKeyRestriction
 import com.algolia.search.model.internal.Time
 import com.algolia.search.model.response.ResponseAPIKey
 import com.algolia.search.model.response.ResponseBatches
+import com.algolia.search.model.response.ResponseDictionary
 import com.algolia.search.model.response.ResponseLogs
 import com.algolia.search.model.response.creation.CreationAPIKey
 import com.algolia.search.model.response.deletion.DeletionAPIKey
+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.RequestOptions
 import com.algolia.search.transport.internal.Transport
@@ -39,6 +43,7 @@ public interface ClientSearch :
     EndpointMultipleIndex,
     EndpointAPIKey,
     EndpointMultiCluster,
+    EndpointDictionary,
     Configuration,
     Credentials {
 
@@ -76,6 +81,42 @@ public interface ClientSearch :
      */
     public suspend fun DeletionAPIKey.wait(timeout: Long? = null): Boolean
 
+    /**
+     * Wait on a [ResponseDictionary] operation.
+     *
+     * @param timeout If a value is specified, the method will throw [TimeoutCancellationException] after waiting for
+     * the allotted time in milliseconds.
+     */
+    public suspend fun ResponseDictionary.wait(
+        timeout: Long? = null,
+        requestOptions: RequestOptions? = null,
+    ): TaskStatus
+
+    /**
+     * Wait for a task at application level to complete before executing the next line of code.
+     *
+     * @param taskID ID of the task to wait for.
+     * @param timeout If a value is specified, the method will throw [TimeoutCancellationException] after waiting for
+     * the allotted time in milliseconds.
+     * @param requestOptions Configure request locally with [RequestOptions]
+     */
+    public suspend fun waitTask(
+        taskID: AppTaskID,
+        timeout: Long? = null,
+        requestOptions: RequestOptions? = null,
+    ): TaskStatus
+
+    /**
+     * Check the current [TaskStatus] of a given application level task.
+     *
+     * @param taskID ID of the task to get its info.
+     * @param requestOptions Configure request locally with [RequestOptions]
+     */
+    public suspend fun getTask(
+        taskID: AppTaskID,
+        requestOptions: RequestOptions? = null,
+    ): TaskInfo
+
     /**
      * Convenience methods to get the logs directly from the [ClientSearch] without instantiating an [Index].
      *