Merge pull request #747 from InsanusMokrassar/7.1.0

7.1.0
InsanusMokrassar · Apr 22, 2023 · 60d2425 · 60d2425
2 parents 6fe8e73 + 8e6b3b7
commit 60d2425
Show file tree

Hide file tree

Showing 28 changed files with 650 additions and 28 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # TelegramBotAPI changelog
 
+## 7.1.0
+
+**This update contains changes according to the [Telegram Bot API 6.7](https://core.telegram.org/bots/api-changelog#april-21-2023)**
+
+* `API`:
+    * Rename `editMessageCaption` to `editMessageMedia` due to wrong old naming
+    * Add `edit` extensions for `InlineMessageIdentifier`s
+* `BehaviourBuilder`:
+    * `BehaviourContext` extensions `onDeepLink` and `waitDeepLinks` now can be used with `Regex` or `String` as first parameters
+
 ## 7.0.2
 
 _This update brings experimental support of `linuxX64` and `mingwX64` platforms_

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# TelegramBotAPI [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi) [![Supported version](https://img.shields.io/badge/Telegram%20Bot%20API-6.6-blue)](https://core.telegram.org/bots/api-changelog#march-9-2023)
+# TelegramBotAPI [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi) [![Supported version](https://img.shields.io/badge/Telegram%20Bot%20API-6.7-blue)](https://core.telegram.org/bots/api-changelog#april-21-2023)
 
 |          Docs          |                                   [![KDocs](https://img.shields.io/static/v1?label=Dokka&message=KDocs&color=blue&logo=kotlin)](https://tgbotapi.inmo.dev/index.html) [![Mini tutorial](https://img.shields.io/static/v1?label=Bookstack&message=Tutorial&color=blue&logo=bookstack)](https://bookstack.inmo.dev/books/telegrambotapi/chapter/introduction-tutorial)                                    |
 |:----------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

diff --git a/gradle.properties b/gradle.properties
@@ -6,4 +6,4 @@ kotlin.incremental=true
 kotlin.incremental.js=true
 
 library_group=dev.inmo
-library_version=7.0.2
+library_version=7.1.0
diff --git a/...i.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/answers/AnswerInlineQuery.kt b/...i.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/answers/AnswerInlineQuery.kt
@@ -2,6 +2,7 @@ package dev.inmo.tgbotapi.extensions.api.answers
 
 import dev.inmo.tgbotapi.bot.TelegramBot
 import dev.inmo.tgbotapi.requests.answers.AnswerInlineQuery
+import dev.inmo.tgbotapi.requests.answers.InlineQueryResultsButton
 import dev.inmo.tgbotapi.types.InlineQueries.InlineQueryResult.abstracts.InlineQueryResult
 import dev.inmo.tgbotapi.types.InlineQueries.query.InlineQuery
 import dev.inmo.tgbotapi.types.InlineQueryIdentifier
@@ -12,8 +13,37 @@ suspend fun TelegramBot.answerInlineQuery(
     cachedTime: Int? = null,
     isPersonal: Boolean? = null,
     nextOffset: String? = null,
-    switchPmText: String? = null,
-    switchPmParameter: String? = null
+    button: InlineQueryResultsButton? = null
+) = execute(
+    AnswerInlineQuery(inlineQueryID, results, cachedTime, isPersonal, nextOffset, button)
+)
+
+suspend fun TelegramBot.answerInlineQuery(
+    inlineQuery: InlineQuery,
+    results: List<InlineQueryResult> = emptyList(),
+    cachedTime: Int? = null,
+    isPersonal: Boolean? = null,
+    nextOffset: String? = null,
+    button: InlineQueryResultsButton? = null
+) = answerInlineQuery(inlineQuery.id, results, cachedTime, isPersonal, nextOffset, button)
+
+suspend fun TelegramBot.answer(
+    inlineQuery: InlineQuery,
+    results: List<InlineQueryResult> = emptyList(),
+    cachedTime: Int? = null,
+    isPersonal: Boolean? = null,
+    nextOffset: String? = null,
+    button: InlineQueryResultsButton? = null
+) = answerInlineQuery(inlineQuery.id, results, cachedTime, isPersonal, nextOffset, button)
+
+suspend fun TelegramBot.answerInlineQuery(
+    inlineQueryID: InlineQueryIdentifier,
+    results: List<InlineQueryResult> = emptyList(),
+    cachedTime: Int? = null,
+    isPersonal: Boolean? = null,
+    nextOffset: String? = null,
+    switchPmText: String?,
+    switchPmParameter: String?
 ) = execute(
     AnswerInlineQuery(inlineQueryID, results, cachedTime, isPersonal, nextOffset, switchPmText, switchPmParameter)
 )
@@ -24,8 +54,8 @@ suspend fun TelegramBot.answerInlineQuery(
     cachedTime: Int? = null,
     isPersonal: Boolean? = null,
     nextOffset: String? = null,
-    switchPmText: String? = null,
-    switchPmParameter: String? = null
+    switchPmText: String?,
+    switchPmParameter: String?
 ) = answerInlineQuery(inlineQuery.id, results, cachedTime, isPersonal, nextOffset, switchPmText, switchPmParameter)
 
 suspend fun TelegramBot.answer(
@@ -34,6 +64,6 @@ suspend fun TelegramBot.answer(
     cachedTime: Int? = null,
     isPersonal: Boolean? = null,
     nextOffset: String? = null,
-    switchPmText: String? = null,
-    switchPmParameter: String? = null
+    switchPmText: String?,
+    switchPmParameter: String?
 ) = answerInlineQuery(inlineQuery.id, results, cachedTime, isPersonal, nextOffset, switchPmText, switchPmParameter)
diff --git a/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/bot/GetMyName.kt b/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/bot/GetMyName.kt
@@ -0,0 +1,16 @@
+package dev.inmo.tgbotapi.extensions.api.bot
+
+import dev.inmo.micro_utils.language_codes.IetfLanguageCode
+import dev.inmo.tgbotapi.bot.TelegramBot
+import dev.inmo.tgbotapi.requests.bot.GetMyCommands
+import dev.inmo.tgbotapi.requests.bot.GetMyName
+import dev.inmo.tgbotapi.types.commands.BotCommandScope
+import dev.inmo.tgbotapi.types.commands.BotCommandScopeDefault
+
+suspend fun TelegramBot.getMyName(
+    languageCode: IetfLanguageCode? = null
+) = execute(GetMyName(languageCode))
+
+suspend fun TelegramBot.getMyName(
+    languageCode: String?
+) = getMyName(languageCode ?.let(::IetfLanguageCode))
diff --git a/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/bot/SetMyName.kt b/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/bot/SetMyName.kt
@@ -0,0 +1,19 @@
+package dev.inmo.tgbotapi.extensions.api.bot
+
+import dev.inmo.micro_utils.language_codes.IetfLanguageCode
+import dev.inmo.tgbotapi.bot.TelegramBot
+import dev.inmo.tgbotapi.requests.bot.GetMyCommands
+import dev.inmo.tgbotapi.requests.bot.GetMyName
+import dev.inmo.tgbotapi.requests.bot.SetMyName
+import dev.inmo.tgbotapi.types.commands.BotCommandScope
+import dev.inmo.tgbotapi.types.commands.BotCommandScopeDefault
+
+suspend fun TelegramBot.setMyName(
+    name: String? = null,
+    languageCode: IetfLanguageCode? = null
+) = execute(SetMyName(name, languageCode))
+
+suspend fun TelegramBot.setMyName(
+    name: String?,
+    languageCode: String?
+) = setMyName(name, languageCode ?.let(::IetfLanguageCode))
diff --git a/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/InlineEdits.kt b/tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/InlineEdits.kt
@@ -0,0 +1,114 @@
+package dev.inmo.tgbotapi.extensions.api.edit
+
+import dev.inmo.tgbotapi.abstracts.TextedWithTextSources
+import dev.inmo.tgbotapi.bot.TelegramBot
+import dev.inmo.tgbotapi.extensions.api.edit.caption.editMessageCaption
+import dev.inmo.tgbotapi.extensions.api.edit.location.live.editLiveLocation
+import dev.inmo.tgbotapi.extensions.api.edit.media.editMessageMedia
+import dev.inmo.tgbotapi.extensions.api.edit.reply_markup.editMessageReplyMarkup
+import dev.inmo.tgbotapi.extensions.api.edit.text.editMessageText
+import dev.inmo.tgbotapi.types.*
+import dev.inmo.tgbotapi.types.buttons.InlineKeyboardMarkup
+import dev.inmo.tgbotapi.types.chat.Chat
+import dev.inmo.tgbotapi.types.location.LiveLocation
+import dev.inmo.tgbotapi.types.media.TelegramMedia
+import dev.inmo.tgbotapi.types.message.ParseMode
+import dev.inmo.tgbotapi.types.message.abstracts.ContentMessage
+import dev.inmo.tgbotapi.types.message.abstracts.Message
+import dev.inmo.tgbotapi.types.message.content.*
+import dev.inmo.tgbotapi.types.message.textsources.TextSource
+import dev.inmo.tgbotapi.types.message.textsources.TextSourcesList
+import dev.inmo.tgbotapi.utils.EntitiesBuilderBody
+import dev.inmo.tgbotapi.utils.buildEntities
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    latitude: Double,
+    longitude: Double,
+    horizontalAccuracy: Meters? = null,
+    heading: Degrees? = null,
+    proximityAlertRadius: Meters? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(messageId, latitude, longitude, horizontalAccuracy, heading, proximityAlertRadius, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    location: LiveLocation,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editLiveLocation(
+    messageId, location, replyMarkup
+)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    media: TelegramMedia,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageMedia(messageId, media, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageReplyMarkup(messageId, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    text: String,
+    parseMode: ParseMode? = null,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageText(messageId, text, parseMode, disableWebPagePreview, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    entities: TextSourcesList,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = editMessageText(messageId, entities, disableWebPagePreview, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    separator: TextSource? = null,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null,
+    builderBody: EntitiesBuilderBody
+) = edit(messageId, buildEntities(separator, builderBody), disableWebPagePreview, replyMarkup)
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+suspend fun TelegramBot.edit(
+    messageId: InlineMessageIdentifier,
+    separator: String,
+    disableWebPagePreview: Boolean? = null,
+    replyMarkup: InlineKeyboardMarkup? = null,
+    builderBody: EntitiesBuilderBody
+) = edit(messageId, buildEntities(separator, builderBody), disableWebPagePreview, replyMarkup)
diff --git a/...c/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/media/EditInlineMessageMedia.kt b/...c/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/edit/media/EditInlineMessageMedia.kt
@@ -10,6 +10,17 @@ import dev.inmo.tgbotapi.types.buttons.InlineKeyboardMarkup
  * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
  * as a builder for that
  */
+suspend fun TelegramBot.editMessageMedia(
+    inlineMessageId: InlineMessageIdentifier,
+    media: TelegramMedia,
+    replyMarkup: InlineKeyboardMarkup? = null
+) = execute(EditInlineMessageMedia(inlineMessageId, media, replyMarkup))
+
+/**
+ * @param replyMarkup Some [InlineKeyboardMarkup]. See [dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard]
+ * as a builder for that
+ */
+@Deprecated("Renamed", ReplaceWith("this.editMessageMedia(inlineMessageId, media, replyMarkup)", "dev.inmo.tgbotapi.extensions.api.edit.media.editMessageMedia"))
 suspend fun TelegramBot.editMessageCaption(
     inlineMessageId: InlineMessageIdentifier,
     media: TelegramMedia,

diff --git a/...nMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitDeepLinks.kt b/...nMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitDeepLinks.kt
@@ -21,3 +21,17 @@ suspend fun BehaviourContext.waitDeepLinks(
     .flattenCommandsWithParams().mapNotNull {
         it.first to (it.second.second.singleOrNull() ?.regularTextSourceOrNull() ?.source ?.removePrefix(" ") ?: return@mapNotNull null)
     }
+
+suspend fun BehaviourContext.waitDeepLinks(
+    regex: Regex,
+    initRequest: Request<*>? = null,
+    errorFactory: NullableRequestBuilder<*> = { null },
+): Flow<Pair<CommonMessage<TextContent>, String>> = waitDeepLinks(initRequest, errorFactory).filter {
+    regex.matches(it.second)
+}
+
+suspend fun BehaviourContext.waitDeepLinks(
+    deepLink: String,
+    initRequest: Request<*>? = null,
+    errorFactory: NullableRequestBuilder<*> = { null },
+): Flow<Pair<CommonMessage<TextContent>, String>> = waitDeepLinks(Regex("^$deepLink$"), initRequest, errorFactory)
diff --git a/...tlin/dev/inmo/tgbotapi/extensions/behaviour_builder/triggers_handling/DeepLinkHandling.kt b/...tlin/dev/inmo/tgbotapi/extensions/behaviour_builder/triggers_handling/DeepLinkHandling.kt
@@ -46,3 +46,24 @@ suspend fun <BC : BehaviourContext> BC.onDeepLink(
         this@onDeepLink.launchSafelyWithoutExceptions { triggersHolder.handleableCommandsHolder.unregisterHandleable(startRegex) }
     }
 }
+
+suspend fun <BC : BehaviourContext> BC.onDeepLink(
+    regex: Regex,
+    initialFilter: SimpleFilter<Pair<TextMessage, String>>? = null,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, Pair<TextMessage, String>, Update> = { (message, _), update -> MessageFilterByChat(this, message, update) },
+    markerFactory: MarkerFactory<Pair<TextMessage, String>, Any> = MarkerFactory { (message, _) -> ByChatMessageMarkerFactory(message) },
+    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, Pair<TextMessage, String>>
+): Job {
+    val internalFilter = SimpleFilter<Pair<TextMessage, String>> {
+        regex.matches(it.second)
+    }
+    return onDeepLink(initialFilter ?.let { internalFilter * it } ?: internalFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
+}
+
+suspend fun <BC : BehaviourContext> BC.onDeepLink(
+    deepLink: String,
+    initialFilter: SimpleFilter<Pair<TextMessage, String>>? = null,
+    subcontextUpdatesFilter: CustomBehaviourContextAndTwoTypesReceiver<BC, Boolean, Pair<TextMessage, String>, Update> = { (message, _), update -> MessageFilterByChat(this, message, update) },
+    markerFactory: MarkerFactory<Pair<TextMessage, String>, Any> = MarkerFactory { (message, _) -> ByChatMessageMarkerFactory(message) },
+    scenarioReceiver: CustomBehaviourContextAndTypeReceiver<BC, Unit, Pair<TextMessage, String>>
+): Job = onDeepLink(Regex("^$deepLink$"), initialFilter, subcontextUpdatesFilter, markerFactory, scenarioReceiver)
diff --git a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/answers/AnswerInlineQuery.kt b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/answers/AnswerInlineQuery.kt
@@ -23,11 +23,30 @@ data class AnswerInlineQuery(
     val isPersonal: Boolean? = null,
     @SerialName(nextOffsetField)
     val nextOffset: String? = null,
-    @SerialName(switchPmTextField)
-    val switchPmText: String? = null,
-    @SerialName(switchPmParameterField)
-    val switchPmParameter: String? = null
+    @SerialName(buttonField)
+    val button: InlineQueryResultsButton? = null,
 ) : SimpleRequest<Boolean> {
+    constructor(
+        inlineQueryID: InlineQueryIdentifier,
+        results: List<InlineQueryResult> = emptyList(),
+        cachedTime: Int? = null,
+        isPersonal: Boolean? = null,
+        nextOffset: String? = null,
+        switchPmText: String?,
+        switchPmParameter: String?
+    ) : this(
+        inlineQueryID,
+        results,
+        cachedTime,
+        isPersonal,
+        nextOffset,
+        switchPmText ?.let {
+            switchPmParameter ?.let {
+                InlineQueryResultsButton.Start(switchPmText, switchPmParameter)
+            }
+        }
+    )
+
     override fun method(): String = "answerInlineQuery"
     override val resultDeserializer: DeserializationStrategy<Boolean>
         get() = Boolean.serializer()
@@ -40,8 +59,23 @@ fun InlineQuery.createAnswer(
     cachedTime: Int? = null,
     isPersonal: Boolean? = null,
     nextOffset: String? = null,
-    switchPmText: String? = null,
-    switchPmParameter: String? = null
+    button: InlineQueryResultsButton? = null,
+) = AnswerInlineQuery(
+    id,
+    results,
+    cachedTime,
+    isPersonal,
+    nextOffset,
+    button
+)
+
+fun InlineQuery.createAnswer(
+    results: List<InlineQueryResult> = emptyList(),
+    cachedTime: Int? = null,
+    isPersonal: Boolean? = null,
+    nextOffset: String? = null,
+    switchPmText: String?,
+    switchPmParameter: String?
 ) = AnswerInlineQuery(
     id,
     results,