update microutils

0.33.1

.github/workflows/kdocs.yml

@@ -0,0 +1,21 @@
+name: Publish KDocs
+on:
+  push:
+    branches:
+      - master
+jobs:
+  publishing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Build
+        run: ./gradlew dokkaHtml
+      - name: Publish KDocs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/dokka/html
+          publish_branch: kdocs

.github/workflows/packages_publishing.yml

@@ -1,4 +1,3 @@
-
 name: Publish package to GitHub Packages
 on: [push]
 jobs:
@@ -15,8 +14,10 @@ jobs:
           cat gradle.properties | sed -e "s/^library_version=\([0-9\.]*\)/library_version=\1-branch_$branch-build${{ github.run_number }}/" > gradle.properties.tmp
           rm gradle.properties
           mv gradle.properties.tmp gradle.properties
-      - name: Build and publish
-        run: ./gradlew clean build publishAllPublicationsToGithubPackagesRepository -x signJsPublication -x signJvmPublication -x signKotlinMultiplatformPublication -x signMetadataPublication
+      - name: Build
+        run: ./gradlew build
+      - name: Publish
+        run: ./gradlew publishAllPublicationsToGithubPackagesRepository --no-parallel -x signJsPublication -x signJvmPublication -x signKotlinMultiplatformPublication -x signMetadataPublication
         env:
           GITHUBPACKAGES_USER: ${{ github.actor }}
           GITHUBPACKAGES_PASSWORD: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,5 +1,28 @@
 # TelegramBotAPI changelog
 
+## 0.33.2
+
+* `Common`:
+    * `Version`:
+        * `MicroUtils`: `0.4.30` -> `0.4.32`
+* `Behaviour Builder`:
+    * New typealias `MediaGroupFilter` has been added for `MediaGroup` expectators
+    * Several typealiases became `suspend`:
+        * `CallbackQueryMapper`
+        * `ChatMemberUpdatedMapper`
+        * `InlineQueryMapper`
+    * Commands got an additional parameter - `additionalFilter`. It will be called when all command filters were passed
+
+## 0.33.1
+
+* `Common`:
+    * `Version`:
+        * `Kotlin`: `1.4.31` -> `1.4.32`
+        * `MicroUtils`: `0.4.29` -> `0.4.30`
+        * `Klocks`: `2.0.6` -> `2.0.7`
+* `Utils Extensions`:
+    * Add extensions `parseCommandsWithParams`
+
 ## 0.33.0
 
 **UPDATE UP TO Telegram Bot API 5.1**

docs/build.gradle

@@ -36,7 +36,7 @@ kotlin {
             dependencies {
                 implementation kotlin('stdlib')
 
-                project.parent.subprojects.forEach {
+                rootProject.subprojects.forEach {
                     if (it != project) {
                         api it
                     }
@@ -56,7 +56,7 @@ private List<SourceDirectorySet> findSourcesWithName(String... approximateNames)
         }.collect { it.kotlin }
 }
 
-tasks.dokkaHtml {
+Object callback = {
     switch (true) {
         case project.hasProperty("DOKKA_PATH"):
             outputDirectory = project.property("DOKKA_PATH").toString()
@@ -82,11 +82,14 @@ tasks.dokkaHtml {
         }
 
         named("jsMain") {
-            sourceRoots.setFrom(findSourcesWithName("jsMain", "commonMain"))
+            sourceRoots.setFrom(findSourcesWithName("jsMain"))
         }
 
         named("jvmMain") {
-            sourceRoots.setFrom(findSourcesWithName("jvmMain", "commonMain"))
+            sourceRoots.setFrom(findSourcesWithName("jvmMain"))
         }
     }
 }
+
+tasks.dokkaGfm(callback)
+tasks.dokkaHtml(callback)

docs/gradle.properties

@@ -1,3 +1,3 @@
-dokka_version=1.4.20
+dokka_version=1.4.30
 
 org.gradle.jvmargs=-Xmx1024m

gradle.properties

@@ -5,18 +5,18 @@ kotlin.js.generate.externals=true
 kotlin.incremental=true
 kotlin.incremental.js=true
 
-kotlin_version=1.4.31
+kotlin_version=1.4.32
 kotlin_coroutines_version=1.4.3
 kotlin_serialisation_runtime_version=1.1.0
-klock_version=2.0.6
+klock_version=2.0.7
 uuid_version=0.2.3
 ktor_version=1.5.2
 
-micro_utils_version=0.4.29
+micro_utils_version=0.4.32
 
 javax_activation_version=1.1.1
 
 library_group=dev.inmo
-library_version=0.33.0
+library_version=0.33.2
 
 github_release_plugin_version=2.2.12

settings.gradle

@@ -1,4 +1,11 @@
 pluginManagement {
+    resolutionStrategy {
+        eachPlugin {
+            if (requested.id.id == "org.jetbrains.dokka") {
+                useModule("org.jetbrains.dokka:dokka-gradle-plugin:${requested.version}")
+            }
+        }
+    }
     repositories {
         gradlePluginPortal()
         jcenter()

tgbotapi.core/README.md

@@ -10,7 +10,7 @@ moments are describing by official [Telegram Bot API](https://core.telegram.org/
 
 ## Compatibility
 
-This version compatible with [9th of March 2021 update of TelegramBotAPI (version 5.1)](https://core.telegram.org/bots/api#march-9-2021).
+This version compatible with [9th of March 2021 update of TelegramBotAPI (version 5.1)](https://core.telegram.org/bots/api-changelog#march-9-2021).
 
 ## How to implement library?
 

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/CommonAbstracts/Captioned.kt

@@ -6,6 +6,7 @@ interface Captioned {
     val caption: String?
 }
 
+@Deprecated("This interface is not used in library and will be removed soon")
 interface CaptionedOutput : Captioned {
     val parseMode: ParseMode?
 }

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/bot/exceptions/RequestException.kt

@@ -12,7 +12,7 @@ fun newRequestException(
     cause: Throwable? = null
 ) = response.description ?.let { description ->
     when {
-        description == "Bad Request: reply message not found" -> ReplyMessageNotFoundException(response, plainAnswer, message, cause)
+        description == "Bad Request: reply message not found" || description == "Bad Request: replied message not found" -> ReplyMessageNotFoundException(response, plainAnswer, message, cause)
         description == "Bad Request: message to edit not found" -> MessageToEditNotFoundException(response, plainAnswer, message, cause)
         description.contains("Bad Request: message is not modified") -> MessageIsNotModifiedException(response, plainAnswer, message, cause)
         description == "Unauthorized" -> UnauthorizedException(response, plainAnswer, message, cause)

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/BehaviourContext.kt

@@ -57,10 +57,10 @@ suspend fun <T> BehaviourContext.doInSubContextWithUpdatesFilter(
 ) = doInSubContextWithFlowsUpdatesFilterSetup(
     newFlowsUpdatesFilterSetUp = updatesFilter ?.let {
         { oldOne ->
-            oldOne.allUpdatesFlow.filter { updatesFilter(it) }.subscribeSafelyWithoutExceptions(scope, asUpdateReceiver)
+            oldOne.allUpdatesFlow.filter { updatesFilter(it) }.subscribeSafelyWithoutExceptions(this, asUpdateReceiver)
         }
     } ?: { oldOne ->
-         oldOne.allUpdatesFlow.subscribeSafelyWithoutExceptions(scope, asUpdateReceiver)
+        oldOne.allUpdatesFlow.subscribeSafelyWithoutExceptions(this, asUpdateReceiver)
     },
     stopOnCompletion,
     behaviourContextReceiver

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitCallbackQuery.kt

@@ -8,7 +8,7 @@ import dev.inmo.tgbotapi.requests.abstracts.Request
 import dev.inmo.tgbotapi.types.CallbackQuery.*
 import kotlinx.coroutines.flow.toList
 
-typealias CallbackQueryMapper<T> = T.() -> T?
+typealias CallbackQueryMapper<T> = suspend T.() -> T?
 
 private suspend fun <O> BehaviourContext.waitCallbackQueries(
     count: Int = 1,

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitChatMemberUpdated.kt

@@ -11,7 +11,7 @@ import dev.inmo.tgbotapi.types.update.MyChatMemberUpdatedUpdate
 import dev.inmo.tgbotapi.types.update.abstracts.ChatMemberUpdatedUpdate
 import kotlinx.coroutines.flow.toList
 
-typealias ChatMemberUpdatedMapper<T> = T.() -> T?
+typealias ChatMemberUpdatedMapper<T> = suspend T.() -> T?
 
 private suspend inline fun <reified T : ChatMemberUpdatedUpdate> BehaviourContext.waitChatMemberUpdated(
     count: Int = 1,

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitInlineQuery.kt

@@ -8,7 +8,7 @@ import dev.inmo.tgbotapi.types.InlineQueries.query.BaseInlineQuery
 import dev.inmo.tgbotapi.types.InlineQueries.query.LocationInlineQuery
 import kotlinx.coroutines.flow.toList
 
-typealias InlineQueryMapper<T> = T.() -> T?
+typealias InlineQueryMapper<T> = suspend T.() -> T?
 
 private suspend fun <O> BehaviourContext.waitInlineQueries(
     count: Int = 1,

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/expectations/WaitMediaGroup.kt

@@ -11,12 +11,14 @@ import dev.inmo.tgbotapi.utils.PreviewFeature
 import kotlinx.coroutines.flow.take
 import kotlinx.coroutines.flow.toList
 
+typealias MediaGroupFilter<T> = suspend List<MediaGroupMessage<T>>.() -> Boolean
+
 @PreviewFeature
 internal suspend inline fun <reified T : MediaGroupContent> BehaviourContext.buildMediaGroupWaiter(
     count: Int = 1,
     initRequest: Request<*>? = null,
     noinline errorFactory: NullableRequestBuilder<*> = { null },
-    noinline filter: (suspend (List<MediaGroupMessage<T>>) -> Boolean)? = null
+    noinline filter: MediaGroupFilter<T>? = null
 ) = flowsUpdatesFilter.expectFlow(bot, initRequest, count, errorFactory) { update ->
     update.asSentMediaGroupUpdate() ?.data ?.let { mediaGroup ->
         if (mediaGroup.all { message -> message.content is T } && (filter == null || filter(mediaGroup as List<MediaGroupMessage<T>>))) {
@@ -33,35 +35,35 @@ suspend fun BehaviourContext.waitMediaGroup(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<MediaGroupContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<MediaGroupContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)
 suspend fun BehaviourContext.waitPlaylist(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<AudioMediaGroupContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<AudioMediaGroupContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)
 suspend fun BehaviourContext.waitDocumentsGroup(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<DocumentMediaGroupContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<DocumentMediaGroupContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)
 suspend fun BehaviourContext.waitVisualGallery(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<VisualMediaGroupContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<VisualMediaGroupContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)
 suspend fun BehaviourContext.waitPhotoGallery(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<PhotoContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<PhotoContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)
 suspend fun BehaviourContext.waitVideoGallery(
     initRequest: Request<*>? = null,
     errorFactory: NullableRequestBuilder<*> = { null },
     count: Int = 1,
-    filter: (suspend (List<MediaGroupMessage<VideoContent>>) -> Boolean)? = null
+    filter: MediaGroupFilter<VideoContent>? = null
 ) = buildMediaGroupWaiter(count, initRequest, errorFactory, filter)

tgbotapi.extensions.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/triggers_handling/CommandHandling.kt

@@ -11,6 +11,7 @@ suspend fun BehaviourContext.command(
     commandRegex: Regex,
     requireOnlyCommandInMessage: Boolean = true,
     includeFilterByChatInBehaviourSubContext: Boolean = true,
+    additionalFilter: CommonMessageFilter<TextContent>? = null,
     scenarioReceiver: BehaviourContextAndTypeReceiver<Unit, CommonMessage<TextContent>>
 ): Job = onText(
     includeFilterByChatInBehaviourSubContext,
@@ -22,7 +23,9 @@ suspend fun BehaviourContext.command(
         } else {
             true
         }
-        sizeRequirement && textSources.any { commandRegex.matches(it.asBotCommandTextSource() ?.command ?: return@any false) }
+        sizeRequirement && textSources.any {
+            commandRegex.matches(it.asBotCommandTextSource() ?.command ?: return@any false)
+        } && (additionalFilter ?.invoke(message) != false)
     },
     scenarioReceiver
 )
@@ -30,19 +33,22 @@ suspend fun BehaviourContext.command(
     command: String,
     requireOnlyCommandInMessage: Boolean = true,
     includeFilterByChatInBehaviourSubContext: Boolean = true,
+    additionalFilter: CommonMessageFilter<TextContent>? = null,
     scenarioReceiver: BehaviourContextAndTypeReceiver<Unit, CommonMessage<TextContent>>
-) = command(command.toRegex(), requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, scenarioReceiver)
+) = command(command.toRegex(), requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, additionalFilter, scenarioReceiver)
 
 suspend inline fun BehaviourContext.onCommand(
     commandRegex: Regex,
     requireOnlyCommandInMessage: Boolean = true,
     includeFilterByChatInBehaviourSubContext: Boolean = true,
+    noinline additionalFilter: CommonMessageFilter<TextContent>? = null,
     noinline scenarioReceiver: BehaviourContextAndTypeReceiver<Unit, CommonMessage<TextContent>>
-): Job = command(commandRegex, requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, scenarioReceiver)
+): Job = command(commandRegex, requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, additionalFilter, scenarioReceiver)
 
 suspend inline fun BehaviourContext.onCommand(
     command: String,
     requireOnlyCommandInMessage: Boolean = true,
     includeFilterByChatInBehaviourSubContext: Boolean = true,
+    noinline additionalFilter: CommonMessageFilter<TextContent>? = null,
     noinline scenarioReceiver: BehaviourContextAndTypeReceiver<Unit, CommonMessage<TextContent>>
-): Job = onCommand(command.toRegex(), requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, scenarioReceiver)
+): Job = onCommand(command.toRegex(), requireOnlyCommandInMessage, includeFilterByChatInBehaviourSubContext, additionalFilter, scenarioReceiver)

tgbotapi.extensions.utils/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/utils/extensions/TextCaptionBotCommandsParser.kt

@@ -0,0 +1,62 @@
+package dev.inmo.tgbotapi.extensions.utils.extensions
+
+import dev.inmo.tgbotapi.CommonAbstracts.*
+import dev.inmo.tgbotapi.types.MessageEntity.textsources.BotCommandTextSource
+import dev.inmo.tgbotapi.types.message.abstracts.ContentMessage
+import dev.inmo.tgbotapi.types.message.content.TextContent
+import dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent
+
+
+val defaultArgsSeparator = Regex(" ")
+/**
+ * Parse commands and their args. Logic will find command, get all subsequent data as args until new command
+ */
+fun List<TextSource>.parseCommandsWithParams(
+    argsSeparator: Regex = defaultArgsSeparator
+): MutableMap<String, Array<String>> {
+    val result = mutableMapOf<String, Array<String>>()
+    var currentBotCommandSource: BotCommandTextSource? = null
+    var currentArgs = ""
+    fun includeCurrent() = currentBotCommandSource ?.let {
+        result[it.command] = currentArgs.split(argsSeparator).toTypedArray()
+        currentArgs = ""
+    }
+    for (textSource in this) {
+        if (textSource is BotCommandTextSource) {
+            includeCurrent()
+            currentBotCommandSource = textSource
+        } else {
+            currentArgs += textSource.source
+        }
+    }
+    includeCurrent()
+    return result
+}
+
+/**
+ * Parse commands and their args. Logic will find command, get all subsequent data as args until new command
+ */
+fun TextedInput.parseCommandsWithParams(
+    argsSeparator: Regex = defaultArgsSeparator
+) = textSources.parseCommandsWithParams(argsSeparator)
+
+/**
+ * Parse commands and their args. Logic will find command, get all subsequent data as args until new command
+ */
+fun TextedOutput.parseCommandsWithParams(
+    argsSeparator: Regex = defaultArgsSeparator
+) = entities ?.parseCommandsWithParams(argsSeparator) ?: emptyMap()
+
+/**
+ * Parse commands and their args. Logic will find command, get all subsequent data as args until new command
+ */
+fun CaptionedInput.parseCommandsWithParams(
+    argsSeparator: Regex = defaultArgsSeparator
+) = textSources.parseCommandsWithParams(argsSeparator)
+
+/**
+ * Parse commands and their args. Logic will find command, get all subsequent data as args until new command
+ */
+fun ContentMessage<TextContent>.parseCommandsWithParams(
+    argsSeparator: Regex = defaultArgsSeparator
+) = content.parseCommandsWithParams(argsSeparator)