build: add automatic linking to external libraries in scaladoc

build.sbt

@@ -29,7 +29,7 @@ ThisBuild / developers := List(
     url = url("https://github.com/cake-lier")
   )
 )
-ThisBuild / description := ""
+ThisBuild / description := "A client for accessing a remote tuple space server, part of a tuple space middleware."
 ThisBuild / licenses := List(
   "MIT" -> new URL("https://opensource.org/licenses/MIT")
 )
@@ -42,6 +42,8 @@ ThisBuild / versionScheme := Some("semver-spec")
 ThisBuild / publishTo := sonatypePublishToBundle.value
 ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org"
 
+ThisBuild / autoAPIMappings := true
+
 lazy val root = project
   .in(file("."))
   .enablePlugins(AutomateHeaderPlugin)

src/main/scala/tuples/space/request/Request.scala → src/main/scala/tuples/space/client/request/Request.scala

@@ -41,10 +41,10 @@ import tuples.space.*
   * used for carrying metadata from the client to the server, for example for managing the [[UUID]] that the server has given to
   * the client.
   */
-sealed trait Request
+private[client] sealed trait Request
 
 /** Companion object to the [[Request]] trait, containing its implementations. */
-object Request {
+private[client] object Request {
 
   /** A [[Request]] which content is a single [[JsonTuple]].
     *

src/main/scala/tuples/space/request/RequestSerializer.scala → src/main/scala/tuples/space/client/request/RequestSerializer.scala

@@ -31,7 +31,7 @@ import tuples.space.JsonSerializable.given
 import AnyOps.*
 
 /** This object contains all serializers for the [[Request]] sub-types. */
-object RequestSerializer {
+private[client] object RequestSerializer {
 
   /* The Encoder given instance for the TupleRequest trait. */
   private given Encoder[TupleRequest] = r =>
@@ -40,14 +40,14 @@ object RequestSerializer {
       "type" -> "out".asJson
     )
 
-    /* The Encoder given instance for the SeqTupleRequest trait. */
+  /* The Encoder given instance for the SeqTupleRequest trait. */
   private given Encoder[SeqTupleRequest] = r =>
     Json.obj(
       "content" -> r.content.asJson,
       "type" -> "outAll".asJson
     )
 
-    /* The Encoder given instance for the TemplateRequest trait. */
+  /* The Encoder given instance for the TemplateRequest trait. */
   private given Encoder[TemplateRequest] = r =>
     Json.obj(
       "content" -> r.content.asJson,
@@ -63,14 +63,14 @@ object RequestSerializer {
       }).asJson
     )
 
-    /* The Encoder given instance for the MergeRequest trait. */
+  /* The Encoder given instance for the MergeRequest trait. */
   private given Encoder[MergeRequest] = r =>
     Json.obj(
       "clientId" -> r.clientId.asJson,
       "oldClientId" -> r.oldClientId.asJson
     )
 
-    /** The [[Encoder]] given instance for the general [[Request]] trait, working for all of its sub-types. */
+  /** The [[Encoder]] given instance for the general [[Request]] trait, working for all of its sub-types. */
   given Encoder[Request] = {
     case r: TupleRequest => r.asJson
     case r: TemplateRequest => r.asJson

src/main/scala/tuples/space/request/TemplateRequestType.scala → src/main/scala/tuples/space/client/request/TemplateRequestType.scala

@@ -23,7 +23,7 @@ package io.github.cakelier
 package tuples.space.request
 
 /** The enum representing all the different types of operations that can be carried on using a [[TemplateRequest]]. */
-enum TemplateRequestType {
+private[client] enum TemplateRequestType {
 
   /** The enum instance representing the "in" operation. */
   case In extends TemplateRequestType

src/main/scala/tuples/space/response/Response.scala → src/main/scala/tuples/space/client/response/Response.scala

@@ -37,10 +37,10 @@ import tuples.space.*
   * client, for example for signalling that the connection has been established with success and a new id is provided to the
   * client or that the client wants to use another id instead.
   */
-sealed trait Response
+private[response] sealed trait Response
 
 /** Companion object to the [[Response]] trait, containing its implementations. */
-object Response {
+private[response] object Response {
 
   /** A [[Response]] which associated request has as content a single [[JsonTuple]].
     *

src/main/scala/tuples/space/response/ResponseDeserializer.scala → src/main/scala/tuples/space/client/response/ResponseDeserializer.scala

@@ -31,7 +31,7 @@ import tuples.space.*
 import tuples.space.JsonSerializable.given
 
 /** This object contains all deserializers for the [[Response]] sub-types. */
-object ResponseDeserializer {
+private[space] object ResponseDeserializer {
 
   /* The Decoder given instance for the TupleResponse trait. */
   private given Decoder[TupleResponse] = c =>

src/main/scala/tuples/space/response/TemplateMaybeTupleResponseType.scala → src/main/scala/tuples/space/client/response/TemplateMaybeTupleResponseType.scala

@@ -24,7 +24,7 @@ package tuples.space.response
 
 /** The enum representing all the different types of operations that can receive a result using a [[TemplateMaybeTupleResponse]].
   */
-enum TemplateMaybeTupleResponseType {
+private[response] enum TemplateMaybeTupleResponseType {
 
   /** The enum instance representing the "inp" operation. */
   case Inp extends TemplateMaybeTupleResponseType

src/main/scala/tuples/space/response/TemplateSeqTupleResponseType.scala → src/main/scala/tuples/space/client/response/TemplateSeqTupleResponseType.scala

@@ -23,7 +23,7 @@ package io.github.cakelier
 package tuples.space.response
 
 /** The enum representing all the different types of operations that can receive a result using a [[TemplateSeqTupleResponse]]. */
-enum TemplateSeqTupleResponseType {
+private[response] enum TemplateSeqTupleResponseType {
 
   /** The enum instance representing the "inAll" operation. */
   case InAll extends TemplateSeqTupleResponseType

src/main/scala/tuples/space/response/TemplateTupleResponseType.scala → src/main/scala/tuples/space/client/response/TemplateTupleResponseType.scala

@@ -23,7 +23,7 @@ package io.github.cakelier
 package tuples.space.response
 
 /** The enum representing all the different types of operations that can receive a result using a [[TemplateTupleResponse]]. */
-enum TemplateTupleResponseType {
+private[response] enum TemplateTupleResponseType {
 
   /** The enum instance representing the "in" operation. */
   case In extends TemplateTupleResponseType

src/test/scala/tuples/space/response/ResponseSerializer.scala → src/test/scala/tuples/space/client/response/ResponseSerializer.scala

@@ -25,9 +25,10 @@ package tuples.space.response
 import io.circe.Encoder
 import io.circe.Json
 import io.circe.syntax.EncoderOps
-
 import tuples.space.JsonSerializable.given
 
+import io.github.cakelier.tuples.space.client.response.{TemplateMaybeTupleResponseType, TemplateSeqTupleResponseType, TemplateTupleResponseType}
+
 object ResponseSerializer {
 
   given Encoder[TupleResponse] = r =>