libraries: Add the OneBot v11 channel

app/build.gradle.kts

@@ -9,6 +9,7 @@ dependencies {
     implementation(project(":libraries:agent"))
     implementation(project(":libraries:tools"))
     implementation(project(":libraries:channels:telegram"))
+    implementation(project(":libraries:channels:onebot"))
     implementation(project(":libraries:providers:openai-compatible"))
     implementation(project(":libraries:providers:deepseek"))
     implementation(project(":libraries:providers:openrouter"))

app/src/dist/config/alexandrite.example.json

@@ -5,5 +5,21 @@
     "shutdownGraceSeconds": 15,
     "startTimeoutSeconds": 30,
     "plugins": []
+  },
+  "channels": {
+    "onebot": {
+      "enabled": false,
+      "settings": {
+        "eventQueueCapacity": 1024,
+        "rateLimitIntervalMillis": 500
+      },
+      "instances": {
+        "main": {
+          "transport": "ws_reverse",
+          "listenHost": "127.0.0.1",
+          "listenPort": 8080
+        }
+      }
+    }
   }
 }

gradle/libs.versions.toml

@@ -11,6 +11,7 @@ logback = "1.6.5"
 junit = "6.1.3"
 kctfork = "0.14.0"
 poko = "0.23.2"
+java-websocket = "1.6.0"
 
 [libraries]
 kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
@@ -32,6 +33,7 @@ logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "lo
 junit-bom = { module = "org.junit:junit-bom", version.ref = "junit" }
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter" }
 junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher" }
+java-websocket = { module = "org.java-websocket:Java-WebSocket", version.ref = "java-websocket" }
 
 [plugins]
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }

libraries/channels/onebot/build.gradle.kts

@@ -0,0 +1,15 @@
+plugins {
+    id("alexandrite.kotlin-library")
+    id("alexandrite.kotlin-serialization")
+}
+
+dependencies {
+    implementation(project(":libraries:plugin-sdk"))
+    implementation(project(":libraries:internal"))
+
+    // The client and the server of the Websocket transports, of which the JDK offers a client only.
+    implementation(libs.java.websocket)
+
+    testImplementation(project(":libraries:testkit"))
+    testRuntimeOnly(libs.logback.classic)
+}

libraries/channels/onebot/src/main/kotlin/org/foedusprogramme/alexandrite/channel/onebot/OneBotPlugin.kt

@@ -0,0 +1,7 @@
+package org.foedusprogramme.alexandrite.channel.onebot
+
+import org.foedusprogramme.alexandrite.sdk.plugin.Plugin
+
+/** The OneBot v11 channel plugin, which talks to an external OneBot implementation such as NapCat. */
+@Plugin(name = "OneBot", description = "OneBot v11 channel")
+public class OneBotPlugin

libraries/channels/onebot/src/main/kotlin/org/foedusprogramme/alexandrite/channel/onebot/api/OneBotApi.kt

@@ -0,0 +1,168 @@
+package org.foedusprogramme.alexandrite.channel.onebot.api
+
+import kotlinx.serialization.json.JsonElement
+import kotlinx.serialization.json.JsonObject
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.DeleteMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetCookies
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetCredentials
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetForwardMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetGroupHonorInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetGroupInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetGroupMemberInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetGroupMemberList
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetImage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetRecord
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.GetStrangerInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.HandleQuickOperation
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotCallSuffix
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotCookies
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotCredentials
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotCsrfToken
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotFile
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotForwardMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotFriend
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotGroupHonorInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotGroupInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotGroupMemberInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotLoginInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotMessageInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotMessageSent
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotRequest
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotStatusInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotStrangerInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotVersionInfo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.OneBotYesNo
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SendGroupMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SendLike
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SendMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SendPrivateMessage
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetFriendAddRequest
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupAddRequest
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupAdmin
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupAnonymous
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupAnonymousBan
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupBan
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupCard
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupKick
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupLeave
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupName
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupSpecialTitle
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetGroupWholeBan
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.api.SetRestart
+import org.foedusprogramme.alexandrite.channel.onebot.protocol.result.OneBotResult
+
+/**
+ * The actions of the OneBot v11 API, as the types of the standard.
+ *
+ * One instance of this interface belongs to one channel instance and lives as long as its connection, so a plugin
+ * that holds it calls the implementation that instance talks to, and no other. The calls an implementation answers
+ * with data return the parsed type; the rest answer with nothing, and a call this version does not model goes
+ * through [raw].
+ *
+ * Every call returns a [OneBotResult], which keeps the difference between an implementation that refused the call, a
+ * peer that could not be reached and a call that worked.
+ */
+public interface OneBotApi {
+    // Messages
+
+    public suspend fun sendPrivateMsg(request: SendPrivateMessage): OneBotResult<OneBotMessageSent>
+
+    public suspend fun sendGroupMsg(request: SendGroupMessage): OneBotResult<OneBotMessageSent>
+
+    public suspend fun sendMsg(request: SendMessage): OneBotResult<OneBotMessageSent>
+
+    public suspend fun deleteMsg(request: DeleteMessage): OneBotResult<Unit>
+
+    public suspend fun getMsg(request: GetMessage): OneBotResult<OneBotMessageInfo>
+
+    public suspend fun getForwardMsg(request: GetForwardMessage): OneBotResult<OneBotForwardMessage>
+
+    // Groups and friends
+
+    public suspend fun sendLike(request: SendLike): OneBotResult<Unit>
+
+    public suspend fun setGroupKick(request: SetGroupKick): OneBotResult<Unit>
+
+    public suspend fun setGroupBan(request: SetGroupBan): OneBotResult<Unit>
+
+    public suspend fun setGroupAnonymousBan(request: SetGroupAnonymousBan): OneBotResult<Unit>
+
+    public suspend fun setGroupWholeBan(request: SetGroupWholeBan): OneBotResult<Unit>
+
+    public suspend fun setGroupAdmin(request: SetGroupAdmin): OneBotResult<Unit>
+
+    public suspend fun setGroupAnonymous(request: SetGroupAnonymous): OneBotResult<Unit>
+
+    public suspend fun setGroupCard(request: SetGroupCard): OneBotResult<Unit>
+
+    public suspend fun setGroupName(request: SetGroupName): OneBotResult<Unit>
+
+    public suspend fun setGroupLeave(request: SetGroupLeave): OneBotResult<Unit>
+
+    public suspend fun setGroupSpecialTitle(request: SetGroupSpecialTitle): OneBotResult<Unit>
+
+    public suspend fun setFriendAddRequest(request: SetFriendAddRequest): OneBotResult<Unit>
+
+    public suspend fun setGroupAddRequest(request: SetGroupAddRequest): OneBotResult<Unit>
+
+    public suspend fun getLoginInfo(): OneBotResult<OneBotLoginInfo>
+
+    public suspend fun getStrangerInfo(request: GetStrangerInfo): OneBotResult<OneBotStrangerInfo>
+
+    public suspend fun getFriendList(): OneBotResult<List<OneBotFriend>>
+
+    public suspend fun getGroupInfo(request: GetGroupInfo): OneBotResult<OneBotGroupInfo>
+
+    public suspend fun getGroupList(): OneBotResult<List<OneBotGroupInfo>>
+
+    public suspend fun getGroupMemberInfo(request: GetGroupMemberInfo): OneBotResult<OneBotGroupMemberInfo>
+
+    public suspend fun getGroupMemberList(request: GetGroupMemberList): OneBotResult<List<OneBotGroupMemberInfo>>
+
+    public suspend fun getGroupHonorInfo(request: GetGroupHonorInfo): OneBotResult<OneBotGroupHonorInfo>
+
+    // The account and its files
+
+    public suspend fun getCookies(request: GetCookies): OneBotResult<OneBotCookies>
+
+    public suspend fun getCsrfToken(): OneBotResult<OneBotCsrfToken>
+
+    public suspend fun getCredentials(request: GetCredentials): OneBotResult<OneBotCredentials>
+
+    public suspend fun getRecord(request: GetRecord): OneBotResult<OneBotFile>
+
+    public suspend fun getImage(request: GetImage): OneBotResult<OneBotFile>
+
+    public suspend fun canSendImage(): OneBotResult<OneBotYesNo>
+
+    public suspend fun canSendRecord(): OneBotResult<OneBotYesNo>
+
+    // The implementation itself
+
+    public suspend fun getStatus(): OneBotResult<OneBotStatusInfo>
+
+    public suspend fun getVersionInfo(): OneBotResult<OneBotVersionInfo>
+
+    public suspend fun setRestart(request: SetRestart): OneBotResult<Unit>
+
+    public suspend fun cleanCache(): OneBotResult<Unit>
+
+    public suspend fun handleQuickOperation(request: HandleQuickOperation): OneBotResult<Unit>
+
+    /** Calls an action of the implementation that this version does not model, with its answer untouched. */
+    public suspend fun raw(action: String, params: JsonObject = JsonObject(emptyMap())): OneBotResult<JsonElement>
+
+    /**
+     * Calls one action through this version's own request type, under [suffix].
+     *
+     * The typed methods above call the plain shape of an action. This is the way to a derived one, such as
+     * `send_group_msg_async` or `send_group_msg_rate_limited`, without giving up the request type or the answer's
+     * `raw` object.
+     */
+    public suspend fun call(
+        action: String,
+        request: OneBotRequest,
+        suffix: OneBotCallSuffix = OneBotCallSuffix.NONE,
+    ): OneBotResult<JsonElement>
+}