Initial module setup

modules/fts-client/src/main/scala/docspell/ftsclient/FtsBasicResult.scala

@@ -0,0 +1,19 @@
+package docspell.ftsclient
+
+import cats.data.NonEmptyList
+import cats.implicits._
+import docspell.common._
+
+import FtsBasicResult.AttachmentMatch
+
+final case class FtsBasicResult(item: Ident, attachments: NonEmptyList[AttachmentMatch]) {
+
+  def score: Double =
+    attachments.map(_.score).toList.max
+}
+
+object FtsBasicResult {
+
+  case class AttachmentMatch(id: Ident, score: Double)
+
+}

modules/fts-client/src/main/scala/docspell/ftsclient/FtsClient.scala

@@ -0,0 +1,18 @@
+package docspell.ftsclient
+
+import fs2.Stream
+
+/** The fts client is the interface for docspell to a fulltext search
+  * engine.
+  *
+  * It defines all operations required for integration into docspell.
+  * It uses data structures and terms of docspell. Implementation
+  * modules need to translate it to the engine that provides the
+  * features.
+  */
+trait FtsClient[F[_]] {
+
+  def searchBasic(q: FtsQuery): Stream[F, FtsBasicResult]
+
+  def indexData(data: TextData): F[Unit]
+}

modules/fts-client/src/main/scala/docspell/ftsclient/FtsQuery.scala

@@ -0,0 +1,10 @@
+package docspell.ftsclient
+
+import docspell.common._
+
+/** A fulltext query.
+  *
+  * The query itself is a raw string. Each implementation may
+  * interpret it according to the system in use.
+  */
+final case class FtsQuery(q: String, collective: Ident, limit: Int, offset: Int)

modules/fts-client/src/main/scala/docspell/ftsclient/TextData.scala

@@ -0,0 +1,5 @@
+package docspell.ftsclient
+
+import docspell.common._
+
+final case class TextData(item: Ident, attachment: Ident, collective: Ident, text: String)