feat(scala): more guides

Author: Fluf22

templates/scala/guides/search/enableFilterPromote.mustache

@@ -0,0 +1,21 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+
+{{> snippets/import}}
+import algoliasearch.search.{Anchoring, Condition, Consequence, Rule}
+
+def enableFilterPromote(): Unit = {
+  val condition = Condition(
+    pattern = Some("{facet:brand}"),
+    anchoring = Some(Anchoring.Is)
+  )
+
+  val consequence = Consequence(
+    filterPromotes = Some(true)
+  )
+
+  val rule = Rule(
+    objectID = "rule_with_filterPromotes",
+    conditions = Some(Seq(condition)),
+    consequence = consequence
+  )
+}

templates/scala/guides/search/searchInReplicaIndex.mustache

@@ -0,0 +1,25 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.{Await, Future}
+import scala.concurrent.duration.Duration
+
+{{> snippets/import}}
+import algoliasearch.search.SearchParamsObject
+
+def searchInReplicaIndex(): Future[Unit] = {
+  {{> snippets/init}}
+
+  // 1. Change the sort dynamically based on the UI events
+  val sortByPrice = false
+
+  // 2. Get the index name based on sortByPrice
+  val indexName = if sortByPrice then "products_price_desc" else "products"
+
+  // 3. Search on dynamic index name (primary or replica)
+  {{#dynamicSnippet}}searchWithIndexNameVar{{/dynamicSnippet}}
+      .map { response =>
+    println(response)
+  }.recover {
+    case ex: Exception =>
+      println(s"An error occurred: ${ex.getMessage}")
+  }
+}

templates/scala/guides/search/saveRecentlyPublishedBooks.mustache renamed to templates/scala/guides/search/searchRecentlyPublishedBooks.mustache

@@ -0,0 +1,29 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.Future
+
+{{> snippets/import}}
+import algoliasearch.search.SearchParamsObject
+
+def searchWithAnalyticsAndHeader(): Future[Unit] = {
+  {{> snippets/init}}
+
+  /*
+  '94.228.178.246' should be replaced with your user's IP address.
+  Depending on your stack there are multiple ways to get this information.
+  */
+  val ip = "94.228.178.246"
+  val query = "query"
+
+  val searchParams = SearchParamsObject(
+    query = Some(query),
+    analytics = Some(true)
+  )
+
+  {{#dynamicSnippet}}searchWithSearchParamsAndForwardedHeader{{/dynamicSnippet}}.map { response =>
+    println(response)
+  }.recover {
+    case ex: Exception =>
+      println(s"An error occurred: ${ex.getMessage}")
+  }
+}
+

templates/scala/guides/search/searchWithAnalyticsAndHeader.mustache

@@ -0,0 +1,21 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.Future
+
+{{> snippets/import}}
+import algoliasearch.search.{OptionalWords, SearchParamsObject}
+
+def searchWithLogicalOr(): Future[Unit] = {
+    {{> snippets/init}}
+    val query = "the query"
+    val optionalWords = Seq("the", "query")
+    val searchParams = SearchParamsObject(
+      query = Some(query),
+      optionalWords = Some(OptionalWords.SeqOfString(optionalWords)),
+    )
+    {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}.map { response =>
+      println(response)
+    }.recover {
+      case ex: Exception =>
+        println(s"An error occurred: ${ex.getMessage}")
+    }
+}

templates/scala/guides/search/searchWithLogicalOr.mustache

@@ -0,0 +1,32 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.Future
+
+{{> snippets/import}}
+import algoliasearch.search.{Consequence, Rule, TimeRange}
+
+def useConditionlessRule(): Future[Unit] = {
+  {{> snippets/init}}
+
+  val objectID = "a-rule-id";
+
+  val rule = Rule(
+      objectID = objectID,
+      consequence = Consequence(
+          // Set relevant consequence
+      ),
+      // Set validity (optional)
+      validity = Some(Seq(
+        TimeRange(
+              from = 1_688_774_400,
+              until = 1_738_972_800
+          )
+      ))
+  )
+
+  {{#dynamicSnippet}}saveRule{{/dynamicSnippet}}.map { response =>
+    println(response)
+  }.recover {
+    case ex: Exception =>
+      println(s"An error occurred: ${ex.getMessage}")
+  }
+}