改进 send forward msg 相关API

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/api/GetMsgApi.kt

@@ -1,18 +1,24 @@
 /*
- * Copyright (c) 2024. ForteScarlet.
+ *  Copyright (c) 2024-2025. ForteScarlet.
  *
- * This file is part of simbot-component-onebot.
+ * Project https://github.com/simple-robot/simbot-component-onebot
+ * Email ForteScarlet@163.com
  *
- * simbot-component-onebot is free software: you can redistribute it and/or modify it under the terms
- * of the GNU Lesser General Public License as published by the Free Software Foundation,
- * either version 3 of the License, or (at your option) any later version.
+ * This project and this file are part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
  *
- * simbot-component-onebot is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
- * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Lesser General Public License for more details.
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Lesser GNU General Public License for more details.
+ *
+ * You should have received a copy of the Lesser GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
  *
- * You should have received a copy of the GNU Lesser General Public License along with simbot-component-onebot.
- * If not, see <https://www.gnu.org/licenses/>.
  */
 
 package love.forte.simbot.component.onebot.v11.core.api
@@ -87,9 +93,9 @@ public data class GetMsgResult @ApiResultConstructor constructor(
  @SerialName("message_type")
  public val messageType: String,
  @SerialName("message_id")
- public val messageId: IntID,
+ public val messageId: IntID, // TODO to LongID?
  @SerialName("real_id")
- public val realId: IntID,
+ public val realId: IntID, // TODO to LongID?
  @property:ExperimentalSimbotAPI
  public val sender: JsonObject, // Any = TODO("sender?"),
  public val message: List<OneBotMessageSegment> = emptyList(), // Any = ("message?"),

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/api/SendMsgApi.kt

@@ -1,18 +1,24 @@
 /*
- * Copyright (c) 2024. ForteScarlet.
+ *  Copyright (c) 2024-2025. ForteScarlet.
  *
- * This file is part of simbot-component-onebot.
+ * Project https://github.com/simple-robot/simbot-component-onebot
+ * Email ForteScarlet@163.com
  *
- * simbot-component-onebot is free software: you can redistribute it and/or modify it under the terms
- * of the GNU Lesser General Public License as published by the Free Software Foundation,
- * either version 3 of the License, or (at your option) any later version.
+ * This project and this file are part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
  *
- * simbot-component-onebot is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
- * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Lesser General Public License for more details.
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Lesser GNU General Public License for more details.
+ *
+ * You should have received a copy of the Lesser GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
  *
- * You should have received a copy of the GNU Lesser General Public License along with simbot-component-onebot.
- * If not, see <https://www.gnu.org/licenses/>.
  */
 
 package love.forte.simbot.component.onebot.v11.core.api
@@ -144,5 +150,5 @@ public class SendMsgApi private constructor(
 @Serializable
 public data class SendMsgResult @ApiResultConstructor constructor(
  @SerialName("message_id")
- public val messageId: IntID,
+ public val messageId: IntID, // TODO to LongID?
 )

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/api/nonstandard/SendGroupForwardMsgApi.kt

@@ -27,12 +27,14 @@ import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import love.forte.simbot.common.id.ID
-import love.forte.simbot.common.id.IntID
+import love.forte.simbot.common.id.LongID
+import love.forte.simbot.common.id.NumericalID
 import love.forte.simbot.common.id.literal
 import love.forte.simbot.component.onebot.common.annotations.ApiResultConstructor
 import love.forte.simbot.component.onebot.v11.core.api.OneBotApi
 import love.forte.simbot.component.onebot.v11.core.api.OneBotApiResult
 import love.forte.simbot.component.onebot.v11.message.segment.OneBotForwardNode
+import love.forte.simbot.component.onebot.v11.message.segment.OneBotMessageSegment
 import kotlin.jvm.JvmStatic
 
 /**
@@ -69,7 +71,12 @@ public class SendGroupForwardMsgApi private constructor(
  public fun create(
  groupId: ID,
  messages: List<OneBotForwardNode>,
- ): SendGroupForwardMsgApi = SendGroupForwardMsgApi(Body(groupId.literal, messages))
+ ): SendGroupForwardMsgApi = SendGroupForwardMsgApi(
+ Body(
+ groupId.literal,
+ messages
+ )
+ )
  }
 
  /**
@@ -80,7 +87,10 @@ public class SendGroupForwardMsgApi private constructor(
  internal data class Body(
  @SerialName("group_id")
  val groupId: String,
- val messages: List<OneBotForwardNode>,
+ /**
+ * node 元素列表。使用 [OneBotMessageSegment] 为了确保序列化使用多态。
+ */
+ val messages: List<OneBotMessageSegment>,
  )
 }
 
@@ -94,7 +104,10 @@ public class SendGroupForwardMsgApi private constructor(
 @OneBotNonStandardApi
 public data class SendGroupForwardMsgResult @ApiResultConstructor constructor(
  @SerialName("message_id")
- public val messageId: IntID,
+ private val longMessageId: LongID,
  @SerialName("forward_id")
  public val forwardId: ID
-)
+) {
+ public val messageId: NumericalID
+ get() = longMessageId
+}

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/api/nonstandard/SendPrivateForwardMsgApi.kt

@@ -32,6 +32,7 @@ import love.forte.simbot.component.onebot.v11.core.api.OneBotApi
 import love.forte.simbot.component.onebot.v11.core.api.OneBotApiResult
 import love.forte.simbot.component.onebot.v11.core.api.SendMsgResult
 import love.forte.simbot.component.onebot.v11.message.segment.OneBotForwardNode
+import love.forte.simbot.component.onebot.v11.message.segment.OneBotMessageSegment
 import kotlin.jvm.JvmStatic
 
 /**
@@ -67,7 +68,12 @@ public class SendPrivateForwardMsgApi private constructor(
  public fun create(
  userId: ID,
  messages: List<OneBotForwardNode>,
- ): SendPrivateForwardMsgApi = SendPrivateForwardMsgApi(Body(userId.literal, messages))
+ ): SendPrivateForwardMsgApi = SendPrivateForwardMsgApi(
+ Body(
+ userId.literal,
+ messages
+ )
+ )
  }
 
  /**
@@ -78,6 +84,9 @@ public class SendPrivateForwardMsgApi private constructor(
  internal data class Body(
  @SerialName("user_id")
  val userId: String,
- val messages: List<OneBotForwardNode>,
+ /**
+ * node 元素列表。使用 [OneBotMessageSegment] 为了确保序列化使用多态。
+ */
+ val messages: List<OneBotMessageSegment>,
  )
 }

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonTest/kotlin/love/forte/simbot/component/onebot/v11/core/api/SendGroupForwardMsgTests.kt

@@ -0,0 +1,217 @@
+/*
+ * Copyright (c) 2025. ForteScarlet.
+ *
+ * Project https://github.com/simple-robot/simbot-component-onebot
+ * Email ForteScarlet@163.com
+ *
+ * This project and this file are part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Lesser GNU General Public License for more details.
+ *
+ * You should have received a copy of the Lesser GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package love.forte.simbot.component.onebot.v11.core.api
+
+import io.ktor.client.*
+import io.ktor.client.engine.mock.*
+import kotlinx.coroutines.test.runTest
+import kotlinx.serialization.json.jsonArray
+import kotlinx.serialization.json.jsonObject
+import kotlinx.serialization.json.jsonPrimitive
+import love.forte.simbot.common.id.IntID.Companion.ID
+import love.forte.simbot.common.id.literal
+import love.forte.simbot.component.onebot.v11.core.OneBot11
+import love.forte.simbot.component.onebot.v11.core.api.nonstandard.OneBotNonStandardApi
+import love.forte.simbot.component.onebot.v11.core.api.nonstandard.SendGroupForwardMsgApi
+import love.forte.simbot.component.onebot.v11.message.segment.OneBotForwardNode
+import love.forte.simbot.component.onebot.v11.message.segment.OneBotText
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+
+/**
+ * 测试 API [SendGroupForwardMsgApi]
+ * @author ForteScarlet
+ */
+@OptIn(OneBotNonStandardApi::class)
+class SendGroupForwardMsgTests {
+
+ private val json = OneBot11.DefaultJson
+
+ /**
+ * 测试 llonebot 供应商的群聊合并转发消息
+ *
+ * 参考 .local/send_group_forward_msg_api_llonebot.md 的实现
+ */
+ @Test
+ fun testLLOneBotApi() = runTest {
+ val groupId = 12345.ID
+ val userId = 379450326.ID
+ val nickname = "测试昵称"
+
+ // 创建一个消息节点
+ val node = OneBotForwardNode.create(
+ userId = userId,
+ nickname = nickname,
+ content = listOf(OneBotText.create("测试消息"))
+ )
+
+ // 创建 API
+ val api = SendGroupForwardMsgApi.create(groupId, listOf(node))
+
+ val mockEngine = MockEngine { request ->
+ // 验证请求 URL
+ assertEquals("send_group_forward_msg", request.url.pathSegments.last())
+
+ // 解析请求体，验证序列化结果
+ val requestBody = request.body.toByteArray().decodeToString()
+ println("requestBody: $requestBody")
+
+ val requestJson = json.parseToJsonElement(requestBody).jsonObject
+
+ // 验证 group_id
+ val groupIdValue = requestJson["group_id"]?.jsonPrimitive?.content
+ assertEquals(groupId.toString(), groupIdValue)
+
+ // 验证 messages 结构
+ val messages = requestJson["messages"]?.jsonArray
+ assertNotNull(messages)
+ assertEquals(1, messages.size)
+
+ val nodeJson = messages[0].jsonObject
+ assertEquals("node", nodeJson["type"]?.jsonPrimitive?.content)
+
+ val nodeData = nodeJson["data"]?.jsonObject
+ assertNotNull(nodeData)
+
+ val nodeContent = nodeData["content"]?.jsonArray
+ assertNotNull(nodeContent)
+ assertEquals(1, nodeContent.size)
+
+ val textSegment = nodeContent[0].jsonObject
+ assertEquals("text", textSegment["type"]?.jsonPrimitive?.content)
+ assertEquals("测试消息", textSegment["data"]?.jsonObject?.get("text")?.jsonPrimitive?.content)
+
+ // 返回 llonebot 格式的响应
+ respondOk(
+ """
+ {
+ "status": "ok",
+ "retcode": 0,
+ "data": {
+ "message_id": 2026505362,
+ "forward_id": "zUfJpEhzJgXxJID2cIwUoiRk7dMLSgnbhwb8yPrPz8iK6IsBn2uUQArcosp4WrNH"
+ },
+ "message": "",
+ "wording": ""
+ }
+ """.trimIndent()
+ )
+ }
+
+ val client = HttpClient(mockEngine)
+
+ // 执行请求并验证结果
+ val result = api.requestData(client, "http://127.0.0.1:8080/")
+
+ assertEquals(2026505362L, result.messageId.toLong())
+ assertEquals("zUfJpEhzJgXxJID2cIwUoiRk7dMLSgnbhwb8yPrPz8iK6IsBn2uUQArcosp4WrNH", result.forwardId.literal)
+ }
+
+ /**
+ * 测试 language-onebot 供应商的群聊合并转发消息
+ *
+ * 参考 .local/send_group_forward_msg_api_languageonebot.md 的实现
+ */
+ @Test
+ fun testLanguageOneBotApi() = runTest {
+ val groupId = 12345.ID
+ val userId = 379450326.ID
+ val nickname = "测试昵称"
+
+ // 创建一个消息节点
+ val node = OneBotForwardNode.create(
+ userId = userId,
+ nickname = nickname,
+ content = listOf(OneBotText.create("测试消息"))
+ )
+
+ // 创建 API
+ val api = SendGroupForwardMsgApi.create(groupId, listOf(node))
+
+ val mockEngine = MockEngine { request ->
+ // 验证请求 URL
+ assertEquals("send_group_forward_msg", request.url.pathSegments.last())
+
+ // 解析请求体，验证序列化结果
+ val requestBody = request.body.toByteArray().decodeToString()
+ println("requestBody: $requestBody")
+
+ val requestJson = json.parseToJsonElement(requestBody).jsonObject
+
+
+ // 验证 group_id
+ val groupIdValue = requestJson["group_id"]?.jsonPrimitive?.content
+ assertEquals(groupId.toString(), groupIdValue)
+
+ // 验证 messages 结构
+ val messages = requestJson["messages"]?.jsonArray
+ assertNotNull(messages)
+ assertEquals(1, messages.size)
+
+ val nodeJson = messages[0].jsonObject
+ assertEquals("node", nodeJson["type"]?.jsonPrimitive?.content)
+
+ val nodeData = nodeJson["data"]?.jsonObject
+ assertNotNull(nodeData)
+
+ // language-onebot 使用 user_id 和 nickname
+ val userIdValue = nodeData["user_id"]?.jsonPrimitive?.content
+ assertEquals(userId.toString(), userIdValue)
+
+ val nicknameValue = nodeData["nickname"]?.jsonPrimitive?.content
+ assertEquals(nickname, nicknameValue)
+
+ val nodeContent = nodeData["content"]?.jsonArray
+ assertNotNull(nodeContent)
+ assertEquals(1, nodeContent.size)
+
+ val textSegment = nodeContent[0].jsonObject
+ assertEquals("text", textSegment["type"]?.jsonPrimitive?.content)
+ assertEquals("测试消息", textSegment["data"]?.jsonObject?.get("text")?.jsonPrimitive?.content)
+
+ // 返回 language-onebot 格式的响应
+ respondOk(
+ """
+ {
+ "status": "ok",
+ "retcode": 0,
+ "data": {
+ "message_id": 1234567890,
+ "forward_id": "abcdefghijklmnopqrstuvwxyz"
+ }
+ }
+ """.trimIndent()
+ )
+ }
+
+ val client = HttpClient(mockEngine)
+
+ // 执行请求并验证结果
+ val result = api.requestData(client, "http://127.0.0.1:8080/")
+
+ assertEquals(1234567890L, result.messageId.toLong())
+ assertEquals("abcdefghijklmnopqrstuvwxyz", result.forwardId.literal)
+ }
+}