Merge pull request #665 from InsanusMokrassar/3.3.0

3.3.0
2024-12-22 16:47:13 +00:00 · 2022-10-22 18:00:02 +06:00 · 2022-10-22 18:00:02 +06:00 · d9846f27c9
commit d9846f27c9
parent 4f75bc792d c10da2a10a
8 changed files with 100 additions and 7 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,5 +1,23 @@
 # TelegramBotAPI changelog

+## 3.3.0
+
+**THIS VERSION CONTAINS UPGRADE KOTLIN (AND ALL RELATED LIBRARIES) UP TO 1.7.20**
+
+* `Versions`:
+    * `Kotlin`: `1.7.10` -> `1.7.20`
+    * `Kotlin Serialization`: `1.4.0` -> `1.4.1`
+    * `Korlibs`: `3.1.0` -> `3.2.0`
+    * `MicroUtils`: `0.12.17` -> `0.13.1`
+* `Core`:
+    * Add opportunity to create command text source and add command in entities builder
+      via `BotCommamd` (thanks to [d1shin](https://github.com/InsanusMokrassar/TelegramBotAPI/pull/664))
+* `API`:
+    * New extensions `TelegramBot#getStickerSetOrNull` and `TelegramBot#getStickerSetOrThrow`
+        * Old `TelegramBot#getStickerSet` has been deprecated
+* `Behaviour Builder`:
+    * Add opportunity to use triggers and waiters with `BotCommand` (thanks to [d1shin](https://github.com/InsanusMokrassar/TelegramBotAPI/pull/664))
+
 ## 3.2.7

 * `Versions`:
--- a/gradle.properties
+++ b/gradle.properties
@ -6,4 +6,4 @@ kotlin.incremental=true
 kotlin.incremental.js=true

 library_group=dev.inmo
-library_version=3.2.7
+library_version=3.3.0
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@ -1,19 +1,19 @@
 [versions]

-kotlin = "1.7.10"
-kotlin-serialization = "1.4.0"
+kotlin = "1.7.20"
+kotlin-serialization = "1.4.1"
 kotlin-coroutines = "1.6.4"

 javax-activation = "1.1.1"

-korlibs = "3.1.0"
+korlibs = "3.2.0"
 uuid = "0.5.0"
 ktor = "2.1.2"

-ksp = "1.7.10-1.0.6"
+ksp = "1.7.20-1.0.7"
 kotlin-poet = "1.12.0"

-microutils = "0.12.17"
+microutils = "0.13.1"

 github-release-plugin = "2.4.1"

--- a/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/get/GetStickerSet.kt
+++ b/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/get/GetStickerSet.kt
@ -10,8 +10,21 @@ suspend fun TelegramBot.getStickerSet(
    GetStickerSet(name)
 )

+@Deprecated("Renamed", ReplaceWith("getStickerSetOrThrow(sticker)", "dev.inmo.tgbotapi.extensions.api.get.getStickerSetOrThrow"))
 suspend fun TelegramBot.getStickerSet(
    sticker: Sticker
 ) = getStickerSet(
    sticker.stickerSetName ?: error("Sticker must contains stickerSetName to be correctly used in getStickerSet method")
 )
+
+suspend fun TelegramBot.getStickerSetOrNull(
+    sticker: Sticker
+) = sticker.stickerSetName ?.let {
+    getStickerSet(it)
+}
+
+suspend fun TelegramBot.getStickerSetOrThrow(
+    sticker: Sticker
+) = getStickerSet(
+    sticker.stickerSetName ?: error("Sticker must contains stickerSetName to be correctly used in getStickerSet method")
+)
--- a/tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitCommandsMessages.kt
+++ b/tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitCommandsMessages.kt
@ -4,6 +4,7 @@ import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
 import dev.inmo.tgbotapi.extensions.behaviour_builder.utils.handlers_registrar.doWithRegistration
 import dev.inmo.tgbotapi.extensions.utils.*
 import dev.inmo.tgbotapi.requests.abstracts.Request
+import dev.inmo.tgbotapi.types.BotCommand
 import dev.inmo.tgbotapi.types.message.abstracts.CommonMessage
 import dev.inmo.tgbotapi.types.message.content.TextContent
 import dev.inmo.tgbotapi.types.message.textsources.BotCommandTextSource
@ -39,6 +40,12 @@ suspend fun BehaviourContext.waitCommandMessage(
    errorFactory: NullableRequestBuilder<*> = { null }
 ) = waitCommandMessage(Regex(command), initRequest, errorFactory)

+suspend fun BehaviourContext.waitCommandMessage(
+    botCommand: BotCommand,
+    initRequest: Request<*>? = null,
+    errorFactory: NullableRequestBuilder<*> = { null }
+) = waitCommandMessage(botCommand.command, initRequest, errorFactory)
+
 fun Flow<CommonMessage<TextContent>>.requireCommandAtStart() = filter {
    it.content.textSources.firstOrNull() is BotCommandTextSource
 }
--- a/tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/triggers_handling/CommandHandling.kt
+++ b/tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/triggers_handling/CommandHandling.kt
@ -12,6 +12,7 @@ import dev.inmo.tgbotapi.extensions.behaviour_builder.utils.marker_factories.Mar
 import dev.inmo.tgbotapi.extensions.behaviour_builder.utils.times
 import dev.inmo.tgbotapi.extensions.utils.botCommandTextSourceOrNull
 import dev.inmo.tgbotapi.extensions.utils.extensions.parseCommandsWithParams
+import dev.inmo.tgbotapi.types.BotCommand
 import dev.inmo.tgbotapi.types.message.content.TextContent
 import dev.inmo.tgbotapi.types.message.content.TextMessage
 import dev.inmo.tgbotapi.types.update.abstracts.Update
@ -82,6 +83,15 @@ suspend fun <BC : BehaviourContext> BC.command(
    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, TextMessage>
 ) = command(command.toRegex(), requireOnlyCommandInMessage, initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)

+suspend fun <BC : BehaviourContext> BC.command(
+    botCommand: BotCommand,
+    requireOnlyCommandInMessage: Boolean = true,
+    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, TextMessage, Update> = MessageFilterByChat,
+    markerFactory: MarkerFactory<in TextMessage, Any> = ByChatMessageMarkerFactory,
+    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, TextMessage>
+) = command(botCommand.command, requireOnlyCommandInMessage, initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
+
 suspend fun <BC : BehaviourContext> BC.onCommand(
    commandRegex: Regex,
    requireOnlyCommandInMessage: Boolean = true,
@ -100,6 +110,15 @@ suspend fun <BC : BehaviourContext> BC.onCommand(
    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, TextMessage>
 ): Job = onCommand(command.toRegex(), requireOnlyCommandInMessage, initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)

+suspend fun <BC : BehaviourContext> BC.onCommand(
+    botCommand: BotCommand,
+    requireOnlyCommandInMessage: Boolean = true,
+    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, TextMessage, Update> = MessageFilterByChat,
+    markerFactory: MarkerFactory<in TextMessage, Any> = ByChatMessageMarkerFactory,
+    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, TextMessage>
+): Job = onCommand(botCommand.command, requireOnlyCommandInMessage, initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
+
 suspend fun <BC : BehaviourContext> BC.commandWithArgs(
    commandRegex: Regex,
    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
@ -134,6 +153,20 @@ suspend fun <BC : BehaviourContext> BC.commandWithArgs(
    scenarioReceiver = scenarioReceiver
 )

+suspend fun <BC : BehaviourContext> BC.commandWithArgs(
+    botCommand: BotCommand,
+    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, TextMessage, Update> = MessageFilterByChat,
+    markerFactory: MarkerFactory<in TextMessage, Any> = ByChatMessageMarkerFactory,
+    scenarioReceiver: CustomBehaviourContextAndTwoTypesReceiver<BC, Unit, TextMessage, Array<String>>
+) = commandWithArgs(
+    botCommand.command,
+    initialFilter = initialFilter,
+    subcontextUpdatesFilter = subcontextUpdatesFilter,
+    markerFactory = markerFactory,
+    scenarioReceiver = scenarioReceiver
+)
+
 suspend fun <BC : BehaviourContext> BC.onCommandWithArgs(
    commandRegex: Regex,
    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
@ -149,3 +182,11 @@ suspend fun <BC : BehaviourContext> BC.onCommandWithArgs(
    markerFactory: MarkerFactory<in TextMessage, Any> = ByChatMessageMarkerFactory,
    scenarioReceiver: CustomBehaviourContextAndTwoTypesReceiver<BC, Unit, TextMessage, Array<String>>
 ): Job = onCommandWithArgs(command.toRegex(), initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
+
+suspend fun <BC : BehaviourContext> BC.onCommandWithArgs(
+    botCommand: BotCommand,
+    initialFilter: CommonMessageFilter<TextContent>? = CommonMessageFilterExcludeMediaGroups,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, TextMessage, Update> = MessageFilterByChat,
+    markerFactory: MarkerFactory<in TextMessage, Any> = ByChatMessageMarkerFactory,
+    scenarioReceiver: CustomBehaviourContextAndTwoTypesReceiver<BC, Unit, TextMessage, Array<String>>
+): Job = onCommandWithArgs(botCommand.command, initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/textsources/BotCommandTextSource.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/textsources/BotCommandTextSource.kt
@ -1,7 +1,8 @@
 package dev.inmo.tgbotapi.types.message.textsources

-import dev.inmo.tgbotapi.types.usernameRegex
+import dev.inmo.tgbotapi.types.BotCommand
 import dev.inmo.tgbotapi.types.Username
+import dev.inmo.tgbotapi.types.usernameRegex
 import dev.inmo.tgbotapi.utils.RiskFeature
 import dev.inmo.tgbotapi.utils.internal.*
 import kotlinx.serialization.Serializable
@ -32,3 +33,6 @@ data class BotCommandTextSource @RiskFeature(DirectInvocationOfTextSourceConstru
 */
@Suppress("NOTHING_TO_INLINE")
 inline fun botCommand(command: String) = BotCommandTextSource("/$command")
+
+@Suppress("NOTHING_TO_INLINE")
+inline fun botCommand(botCommand: BotCommand) = botCommand(botCommand.command)
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/utils/EntitiesBuilder.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/utils/EntitiesBuilder.kt
@ -3,6 +3,7 @@
 package dev.inmo.tgbotapi.utils

 import dev.inmo.micro_utils.common.joinTo
+import dev.inmo.tgbotapi.types.BotCommand
 import dev.inmo.tgbotapi.types.CustomEmojiId
 import dev.inmo.tgbotapi.types.chat.User
 import dev.inmo.tgbotapi.types.message.textsources.*
@ -148,6 +149,15 @@ inline fun EntitiesBuilder.botCommand(command: String) = add(dev.inmo.tgbotapi.t
 * Version of [EntitiesBuilder.botCommand] with new line at the end
 */
 inline fun EntitiesBuilder.botCommandln(command: String) = botCommand(command) + newLine
+/**
+ * Add botCommand using [EntitiesBuilder.add] with [dev.inmo.tgbotapi.types.message.textsources.botCommand]
+ */
+inline fun EntitiesBuilder.botCommand(botCommand: BotCommand) = add(dev.inmo.tgbotapi.types.message.textsources.botCommand(botCommand))
+/**
+ * Version of [EntitiesBuilder.botCommand] with new line at the end
+ */
+inline fun EntitiesBuilder.botCommandln(botCommand: BotCommand) = botCommand(botCommand) + newLine
+


 /**